src/Pure/PIDE/document.ML
author wenzelm
Tue Sep 01 23:10:23 2015 +0200 (2015-09-01)
changeset 61077 06cca32aa519
parent 60937 51425cbe8ce9
child 62505 9e2a65912111
permissions -rw-r--r--
thread context for exceptions from forks, e.g. relevant when printing errors;
tuned signature;
wenzelm@38150
     1
(*  Title:      Pure/PIDE/document.ML
wenzelm@38150
     2
    Author:     Makarius
wenzelm@38150
     3
wenzelm@38150
     4
Document as collection of named nodes, each consisting of an editable
wenzelm@52536
     5
list of commands, associated with asynchronous execution process.
wenzelm@38150
     6
*)
wenzelm@38150
     7
wenzelm@38150
     8
signature DOCUMENT =
wenzelm@38150
     9
sig
wenzelm@52796
    10
  val timing: bool Unsynchronized.ref
wenzelm@59715
    11
  type node_header = {master: string, header: Thy_Header.header, errors: string list}
wenzelm@52862
    12
  type overlay = Document_ID.command * (string * string list)
wenzelm@44157
    13
  datatype node_edit =
wenzelm@52530
    14
    Edits of (Document_ID.command option * Document_ID.command option) list |
wenzelm@48707
    15
    Deps of node_header |
wenzelm@52849
    16
    Perspective of bool * Document_ID.command list * overlay list
wenzelm@44156
    17
  type edit = string * node_edit
wenzelm@38418
    18
  type state
wenzelm@38418
    19
  val init_state: state
wenzelm@54519
    20
  val define_blob: string -> string -> state -> state
wenzelm@56458
    21
  type blob_digest = (string * string option) Exn.result
wenzelm@59685
    22
  val define_command: Document_ID.command -> string -> blob_digest list -> int ->
wenzelm@59085
    23
    ((int * int) * string) list -> state -> state
wenzelm@60880
    24
  val command_exec: state -> string -> Document_ID.command -> Command.exec option
wenzelm@52530
    25
  val remove_versions: Document_ID.version list -> state -> state
wenzelm@52774
    26
  val start_execution: state -> state
wenzelm@52530
    27
  val update: Document_ID.version -> Document_ID.version -> edit list -> state ->
wenzelm@52655
    28
    Document_ID.exec list * (Document_ID.command * Document_ID.exec list) list * state
wenzelm@43713
    29
  val state: unit -> state
wenzelm@43713
    30
  val change_state: (state -> state) -> unit
wenzelm@38150
    31
end;
wenzelm@38150
    32
wenzelm@38150
    33
structure Document: DOCUMENT =
wenzelm@38150
    34
struct
wenzelm@38150
    35
wenzelm@52796
    36
val timing = Unsynchronized.ref false;
wenzelm@52796
    37
fun timeit msg e = cond_timeit (! timing) msg e;
wenzelm@52796
    38
wenzelm@52796
    39
wenzelm@52796
    40
wenzelm@38418
    41
(** document structure **)
wenzelm@38418
    42
wenzelm@52530
    43
fun err_dup kind id = error ("Duplicate " ^ kind ^ ": " ^ Document_ID.print id);
wenzelm@52530
    44
fun err_undef kind id = error ("Undefined " ^ kind ^ ": " ^ Document_ID.print id);
wenzelm@52530
    45
wenzelm@59715
    46
type node_header =
wenzelm@59715
    47
  {master: string, header: Thy_Header.header, errors: string list};
wenzelm@52849
    48
wenzelm@52849
    49
type perspective =
wenzelm@52849
    50
 {required: bool,  (*required node*)
wenzelm@52849
    51
  visible: Inttab.set,  (*visible commands*)
wenzelm@52849
    52
  visible_last: Document_ID.command option,  (*last visible command*)
wenzelm@57874
    53
  overlays: (string * string list) list Inttab.table};  (*command id -> print functions with args*)
wenzelm@52849
    54
wenzelm@52530
    55
structure Entries = Linear_Set(type key = Document_ID.command val ord = int_ord);
wenzelm@38448
    56
wenzelm@43668
    57
abstype node = Node of
wenzelm@48707
    58
 {header: node_header,  (*master directory, theory header, errors*)
wenzelm@59086
    59
  keywords: Keyword.keywords option,  (*outer syntax keywords*)
wenzelm@52849
    60
  perspective: perspective,  (*command perspective*)
wenzelm@52761
    61
  entries: Command.exec option Entries.T,  (*command entries with excecutions*)
wenzelm@52526
    62
  result: Command.eval option}  (*result of last execution*)
wenzelm@50862
    63
and version = Version of node String_Graph.T  (*development graph wrt. static imports*)
wenzelm@38418
    64
with
wenzelm@38418
    65
wenzelm@59086
    66
fun make_node (header, keywords, perspective, entries, result) =
wenzelm@59086
    67
  Node {header = header, keywords = keywords, perspective = perspective,
wenzelm@59086
    68
    entries = entries, result = result};
wenzelm@43668
    69
wenzelm@59086
    70
fun map_node f (Node {header, keywords, perspective, entries, result}) =
wenzelm@59086
    71
  make_node (f (header, keywords, perspective, entries, result));
wenzelm@38418
    72
wenzelm@52849
    73
fun make_perspective (required, command_ids, overlays) : perspective =
wenzelm@52849
    74
 {required = required,
wenzelm@52849
    75
  visible = Inttab.make_set command_ids,
wenzelm@52849
    76
  visible_last = try List.last command_ids,
wenzelm@52862
    77
  overlays = Inttab.make_list overlays};
wenzelm@44441
    78
wenzelm@59715
    79
val no_header: node_header =
wenzelm@59715
    80
  {master = "", header = Thy_Header.make ("", Position.none) [] [], errors = []};
wenzelm@52849
    81
val no_perspective = make_perspective (false, [], []);
wenzelm@44386
    82
wenzelm@59086
    83
val empty_node = make_node (no_header, NONE, no_perspective, Entries.empty, NONE);
wenzelm@44386
    84
wenzelm@57615
    85
fun is_no_perspective ({required, visible, visible_last, overlays}: perspective) =
wenzelm@57615
    86
  not required andalso
wenzelm@57615
    87
  Inttab.is_empty visible andalso
wenzelm@57615
    88
  is_none visible_last andalso
wenzelm@57615
    89
  Inttab.is_empty overlays;
wenzelm@57615
    90
wenzelm@59086
    91
fun is_empty_node (Node {header, keywords, perspective, entries, result}) =
wenzelm@57615
    92
  header = no_header andalso
wenzelm@59086
    93
  is_none keywords andalso
wenzelm@57615
    94
  is_no_perspective perspective andalso
wenzelm@57615
    95
  Entries.is_empty entries andalso
wenzelm@57615
    96
  is_none result;
wenzelm@57615
    97
wenzelm@44386
    98
wenzelm@44386
    99
(* basic components *)
wenzelm@44386
   100
wenzelm@59715
   101
fun master_directory (Node {header = {master, ...}, ...}) =
wenzelm@54558
   102
  (case try Url.explode master of
wenzelm@54558
   103
    SOME (Url.File path) => path
wenzelm@54558
   104
  | _ => Path.current);
wenzelm@54558
   105
wenzelm@59715
   106
fun set_header master header errors =
wenzelm@59086
   107
  map_node (fn (_, keywords, perspective, entries, result) =>
wenzelm@59715
   108
    ({master = master, header = header, errors = errors}, keywords, perspective, entries, result));
wenzelm@59086
   109
wenzelm@59715
   110
fun get_header (Node {header, ...}) = header;
wenzelm@48707
   111
wenzelm@59086
   112
fun set_keywords keywords =
wenzelm@59086
   113
  map_node (fn (header, _, perspective, entries, result) =>
wenzelm@59086
   114
    (header, keywords, perspective, entries, result));
wenzelm@59086
   115
wenzelm@59086
   116
fun get_keywords (Node {keywords, ...}) = keywords;
wenzelm@59086
   117
wenzelm@48927
   118
fun read_header node span =
wenzelm@48927
   119
  let
wenzelm@59715
   120
    val {header, errors, ...} = get_header node;
wenzelm@59715
   121
    val _ =
wenzelm@59715
   122
      if null errors then ()
wenzelm@59715
   123
      else
wenzelm@59715
   124
        cat_lines errors |>
wenzelm@59715
   125
        (case Position.get_id (Position.thread_data ()) of
wenzelm@59715
   126
          NONE => I
wenzelm@59715
   127
        | SOME id => Protocol_Message.command_positions_yxml id)
wenzelm@59715
   128
        |> error;
wenzelm@59934
   129
    val {name = (name, _), imports, ...} = header;
wenzelm@59934
   130
    val {name = (_, pos), imports = imports', keywords} = Thy_Header.read_tokens span;
wenzelm@54526
   131
  in Thy_Header.make (name, pos) (map #1 imports ~~ map #2 imports') keywords end;
wenzelm@54526
   132
wenzelm@44385
   133
fun get_perspective (Node {perspective, ...}) = perspective;
wenzelm@59086
   134
wenzelm@52808
   135
fun set_perspective args =
wenzelm@59086
   136
  map_node (fn (header, keywords, _, entries, result) =>
wenzelm@59086
   137
    (header, keywords, make_perspective args, entries, result));
wenzelm@44385
   138
wenzelm@52849
   139
val required_node = #required o get_perspective;
wenzelm@52849
   140
val visible_command = Inttab.defined o #visible o get_perspective;
wenzelm@52849
   141
val visible_last = #visible_last o get_perspective;
wenzelm@47345
   142
val visible_node = is_some o visible_last
wenzelm@52850
   143
val overlays = Inttab.lookup_list o #overlays o get_perspective;
wenzelm@47345
   144
wenzelm@44444
   145
fun map_entries f =
wenzelm@59086
   146
  map_node (fn (header, keywords, perspective, entries, result) =>
wenzelm@59086
   147
    (header, keywords, perspective, f entries, result));
wenzelm@59086
   148
wenzelm@52761
   149
fun get_entries (Node {entries, ...}) = entries;
wenzelm@44645
   150
wenzelm@44645
   151
fun iterate_entries f = Entries.iterate NONE f o get_entries;
wenzelm@52761
   152
fun iterate_entries_after start f (Node {entries, ...}) =
wenzelm@44645
   153
  (case Entries.get_after entries start of
wenzelm@44645
   154
    NONE => I
wenzelm@44645
   155
  | SOME id => Entries.iterate (SOME id) f entries);
wenzelm@43668
   156
wenzelm@47339
   157
fun get_result (Node {result, ...}) = result;
wenzelm@59086
   158
wenzelm@44385
   159
fun set_result result =
wenzelm@59086
   160
  map_node (fn (header, keywords, perspective, entries, _) =>
wenzelm@59086
   161
    (header, keywords, perspective, entries, result));
wenzelm@44180
   162
wenzelm@52566
   163
fun changed_result node node' =
wenzelm@52566
   164
  (case (get_result node, get_result node') of
wenzelm@52607
   165
    (SOME eval, SOME eval') => not (Command.eval_eq (eval, eval'))
wenzelm@52566
   166
  | (NONE, NONE) => false
wenzelm@52566
   167
  | _ => true);
wenzelm@52566
   168
wenzelm@52772
   169
fun pending_result node =
wenzelm@52772
   170
  (case get_result node of
wenzelm@52772
   171
    SOME eval => not (Command.eval_finished eval)
wenzelm@52772
   172
  | NONE => false);
wenzelm@52533
   173
wenzelm@59198
   174
fun finished_result node =
wenzelm@59198
   175
  (case get_result node of
wenzelm@59198
   176
    SOME eval => Command.eval_finished eval
wenzelm@59198
   177
  | NONE => false);
wenzelm@59198
   178
wenzelm@59198
   179
fun loaded_theory name =
wenzelm@59198
   180
  (case try (unsuffix ".thy") name of
wenzelm@59198
   181
    SOME a => get_first Thy_Info.lookup_theory [a, Long_Name.base_name a]
wenzelm@59198
   182
  | NONE => NONE);
wenzelm@59198
   183
wenzelm@50862
   184
fun get_node nodes name = String_Graph.get_node nodes name
wenzelm@50862
   185
  handle String_Graph.UNDEF _ => empty_node;
wenzelm@50862
   186
fun default_node name = String_Graph.default_node (name, empty_node);
wenzelm@50862
   187
fun update_node name f = default_node name #> String_Graph.map_node name f;
wenzelm@38418
   188
wenzelm@38418
   189
wenzelm@38448
   190
(* node edits and associated executions *)
wenzelm@38150
   191
wenzelm@52862
   192
type overlay = Document_ID.command * (string * string list);
wenzelm@52849
   193
wenzelm@44157
   194
datatype node_edit =
wenzelm@52530
   195
  Edits of (Document_ID.command option * Document_ID.command option) list |
wenzelm@48707
   196
  Deps of node_header |
wenzelm@52849
   197
  Perspective of bool * Document_ID.command list * overlay list;
wenzelm@44157
   198
wenzelm@44156
   199
type edit = string * node_edit;
wenzelm@38448
   200
wenzelm@49064
   201
val after_entry = Entries.get_after o get_entries;
wenzelm@44479
   202
wenzelm@49064
   203
fun lookup_entry node id =
wenzelm@49064
   204
  (case Entries.lookup (get_entries node) id of
wenzelm@44480
   205
    NONE => NONE
wenzelm@44480
   206
  | SOME (exec, _) => exec);
wenzelm@44480
   207
wenzelm@49064
   208
fun the_entry node id =
wenzelm@49064
   209
  (case Entries.lookup (get_entries node) id of
wenzelm@38448
   210
    NONE => err_undef "command entry" id
wenzelm@44476
   211
  | SOME (exec, _) => exec);
wenzelm@38150
   212
wenzelm@52532
   213
fun the_default_entry node (SOME id) = (id, the_default Command.no_exec (the_entry node id))
wenzelm@52532
   214
  | the_default_entry _ NONE = (Document_ID.none, Command.no_exec);
wenzelm@44476
   215
wenzelm@52566
   216
fun assign_entry (command_id, exec) node =
wenzelm@52566
   217
  if is_none (Entries.lookup (get_entries node) command_id) then node
wenzelm@52566
   218
  else map_entries (Entries.update (command_id, exec)) node;
wenzelm@38418
   219
wenzelm@38448
   220
fun reset_after id entries =
wenzelm@38448
   221
  (case Entries.get_after entries id of
wenzelm@38448
   222
    NONE => entries
wenzelm@38448
   223
  | SOME next => Entries.update (next, NONE) entries);
wenzelm@38448
   224
wenzelm@43668
   225
val edit_node = map_entries o fold
wenzelm@43668
   226
  (fn (id, SOME id2) => Entries.insert_after id (id2, NONE)
wenzelm@43668
   227
    | (id, NONE) => Entries.delete_after id #> reset_after id);
wenzelm@38418
   228
wenzelm@38418
   229
wenzelm@38418
   230
(* version operations *)
wenzelm@38418
   231
wenzelm@50862
   232
val empty_version = Version String_Graph.empty;
wenzelm@44185
   233
wenzelm@38418
   234
fun nodes_of (Version nodes) = nodes;
wenzelm@44185
   235
val node_of = get_node o nodes_of;
wenzelm@38418
   236
wenzelm@44185
   237
fun cycle_msg names = "Cyclic dependency of " ^ space_implode " via " (map quote names);
wenzelm@44180
   238
wenzelm@44157
   239
fun edit_nodes (name, node_edit) (Version nodes) =
wenzelm@44157
   240
  Version
wenzelm@44436
   241
    (case node_edit of
wenzelm@54562
   242
      Edits edits => update_node name (edit_node edits) nodes
wenzelm@59715
   243
    | Deps {master, header, errors} =>
wenzelm@44436
   244
        let
wenzelm@48927
   245
          val imports = map fst (#imports header);
wenzelm@44436
   246
          val nodes1 = nodes
wenzelm@44436
   247
            |> default_node name
wenzelm@48927
   248
            |> fold default_node imports;
wenzelm@44436
   249
          val nodes2 = nodes1
wenzelm@50862
   250
            |> String_Graph.Keys.fold
wenzelm@50862
   251
                (fn dep => String_Graph.del_edge (dep, name)) (String_Graph.imm_preds nodes1 name);
wenzelm@59086
   252
          val (nodes3, errors1) =
wenzelm@59086
   253
            (String_Graph.add_deps_acyclic (name, imports) nodes2, errors)
wenzelm@59086
   254
              handle String_Graph.CYCLES cs => (nodes2, errors @ map cycle_msg cs);
wenzelm@59715
   255
        in String_Graph.map_node name (set_header master header errors1) nodes3 end
wenzelm@47406
   256
    | Perspective perspective => update_node name (set_perspective perspective) nodes);
wenzelm@44444
   257
wenzelm@59086
   258
fun update_keywords name nodes =
wenzelm@59086
   259
  nodes |> String_Graph.map_node name (fn node =>
wenzelm@59086
   260
    if is_empty_node node then node
wenzelm@59086
   261
    else
wenzelm@59086
   262
      let
wenzelm@59715
   263
        val {master, header, errors} = get_header node;
wenzelm@59086
   264
        val imports_keywords = map_filter (get_keywords o get_node nodes o #1) (#imports header);
wenzelm@59086
   265
        val keywords =
wenzelm@59086
   266
          Library.foldl Keyword.merge_keywords (Session.get_keywords (), imports_keywords);
wenzelm@59086
   267
        val (keywords', errors') =
wenzelm@59086
   268
          (Keyword.add_keywords (#keywords header) keywords, errors)
wenzelm@59086
   269
            handle ERROR msg =>
wenzelm@59086
   270
              (keywords, if member (op =) errors msg then errors else errors @ [msg]);
wenzelm@59086
   271
      in
wenzelm@59086
   272
        node
wenzelm@59715
   273
        |> set_header master header errors'
wenzelm@59086
   274
        |> set_keywords (SOME keywords')
wenzelm@59086
   275
      end);
wenzelm@59086
   276
wenzelm@59086
   277
fun edit_keywords edits (Version nodes) =
wenzelm@59086
   278
  Version
wenzelm@59086
   279
    (fold update_keywords
wenzelm@59086
   280
      (String_Graph.all_succs nodes (map_filter (fn (a, Deps _) => SOME a | _ => NONE) edits))
wenzelm@59086
   281
      nodes);
wenzelm@59086
   282
wenzelm@44222
   283
fun put_node (name, node) (Version nodes) =
wenzelm@57616
   284
  let
wenzelm@57616
   285
    val nodes1 = update_node name (K node) nodes;
wenzelm@57616
   286
    val nodes2 =
wenzelm@57616
   287
      if String_Graph.is_maximal nodes1 name andalso is_empty_node node
wenzelm@57616
   288
      then String_Graph.del_node name nodes1
wenzelm@57616
   289
      else nodes1;
wenzelm@57616
   290
  in Version nodes2 end;
wenzelm@38418
   291
wenzelm@38150
   292
end;
wenzelm@38150
   293
wenzelm@38418
   294
wenzelm@52595
   295
wenzelm@52595
   296
(** main state -- document structure and execution process **)
wenzelm@52536
   297
wenzelm@56458
   298
type blob_digest = (string * string option) Exn.result;  (*file node name, raw digest*)
wenzelm@55798
   299
wenzelm@52774
   300
type execution =
wenzelm@52774
   301
 {version_id: Document_ID.version,  (*static version id*)
wenzelm@52774
   302
  execution_id: Document_ID.execution,  (*dynamic execution id*)
wenzelm@59193
   303
  delay_request: unit future};  (*pending event timer request*)
wenzelm@52604
   304
wenzelm@52774
   305
val no_execution: execution =
wenzelm@59193
   306
  {version_id = Document_ID.none,
wenzelm@59193
   307
   execution_id = Document_ID.none,
wenzelm@59193
   308
   delay_request = Future.value ()};
wenzelm@52774
   309
wenzelm@59193
   310
fun new_execution version_id delay_request : execution =
wenzelm@59193
   311
  {version_id = version_id,
wenzelm@59193
   312
   execution_id = Execution.start (),
wenzelm@59193
   313
   delay_request = delay_request};
wenzelm@52604
   314
wenzelm@38418
   315
abstype state = State of
wenzelm@52536
   316
 {versions: version Inttab.table,  (*version id -> document content*)
wenzelm@55798
   317
  blobs: (SHA1.digest * string list) Symtab.table,  (*raw digest -> digest, lines*)
wenzelm@59689
   318
  commands: (string * blob_digest list * int * Token.T list lazy) Inttab.table,
wenzelm@59689
   319
    (*command id -> name, inlined files, token index of files, command span*)
wenzelm@52536
   320
  execution: execution}  (*current execution process*)
wenzelm@38418
   321
with
wenzelm@38418
   322
wenzelm@54519
   323
fun make_state (versions, blobs, commands, execution) =
wenzelm@54519
   324
  State {versions = versions, blobs = blobs, commands = commands, execution = execution};
wenzelm@38418
   325
wenzelm@54519
   326
fun map_state f (State {versions, blobs, commands, execution}) =
wenzelm@54519
   327
  make_state (f (versions, blobs, commands, execution));
wenzelm@38418
   328
wenzelm@38418
   329
val init_state =
wenzelm@54519
   330
  make_state (Inttab.make [(Document_ID.none, empty_version)],
wenzelm@54519
   331
    Symtab.empty, Inttab.empty, no_execution);
wenzelm@38418
   332
wenzelm@38418
   333
wenzelm@38418
   334
(* document versions *)
wenzelm@38418
   335
wenzelm@52536
   336
fun define_version version_id version =
wenzelm@59193
   337
  map_state (fn (versions, blobs, commands, {delay_request, ...}) =>
wenzelm@47420
   338
    let
wenzelm@52536
   339
      val versions' = Inttab.update_new (version_id, version) versions
wenzelm@47420
   340
        handle Inttab.DUP dup => err_dup "document version" dup;
wenzelm@59193
   341
      val execution' = new_execution version_id delay_request;
wenzelm@54519
   342
    in (versions', blobs, commands, execution') end);
wenzelm@38418
   343
wenzelm@52536
   344
fun the_version (State {versions, ...}) version_id =
wenzelm@52536
   345
  (case Inttab.lookup versions version_id of
wenzelm@52536
   346
    NONE => err_undef "document version" version_id
wenzelm@38418
   347
  | SOME version => version);
wenzelm@38418
   348
wenzelm@52536
   349
fun delete_version version_id versions =
wenzelm@52536
   350
  Inttab.delete version_id versions
wenzelm@52536
   351
    handle Inttab.UNDEF _ => err_undef "document version" version_id;
wenzelm@44673
   352
wenzelm@38418
   353
wenzelm@54519
   354
(* inlined files *)
wenzelm@54519
   355
wenzelm@54519
   356
fun define_blob digest text =
wenzelm@54519
   357
  map_state (fn (versions, blobs, commands, execution) =>
wenzelm@57638
   358
    let val blobs' = Symtab.update (digest, (SHA1.fake digest, split_lines text)) blobs
wenzelm@54519
   359
    in (versions, blobs', commands, execution) end);
wenzelm@54519
   360
wenzelm@54519
   361
fun the_blob (State {blobs, ...}) digest =
wenzelm@54519
   362
  (case Symtab.lookup blobs digest of
wenzelm@54519
   363
    NONE => error ("Undefined blob: " ^ digest)
wenzelm@55788
   364
  | SOME content => content);
wenzelm@54519
   365
wenzelm@56447
   366
fun resolve_blob state (blob_digest: blob_digest) =
wenzelm@61077
   367
  blob_digest |> Exn.map_res (fn (file_node, raw_digest) =>
wenzelm@56458
   368
    (file_node, Option.map (the_blob state) raw_digest));
wenzelm@56447
   369
wenzelm@59685
   370
fun blob_reports pos (blob_digest: blob_digest) =
wenzelm@59685
   371
  (case blob_digest of Exn.Res (file_node, _) => [(pos, Markup.path file_node)] | _ => []);
wenzelm@59685
   372
wenzelm@54519
   373
wenzelm@38418
   374
(* commands *)
wenzelm@38418
   375
wenzelm@59702
   376
fun define_command command_id name blobs_digests blobs_index toks =
wenzelm@54519
   377
  map_state (fn (versions, blobs, commands, execution) =>
wenzelm@38418
   378
    let
wenzelm@52536
   379
      val id = Document_ID.print command_id;
wenzelm@52536
   380
      val span =
wenzelm@52536
   381
        Lazy.lazy (fn () =>
wenzelm@52536
   382
          Position.setmp_thread_data (Position.id_only id)
wenzelm@59685
   383
            (fn () =>
wenzelm@59685
   384
              let
wenzelm@59685
   385
                val (tokens, _) = fold_map Token.make toks (Position.id id);
wenzelm@59685
   386
                val _ =
wenzelm@59702
   387
                  if blobs_index < 0
wenzelm@59702
   388
                  then (*inlined errors*)
wenzelm@59702
   389
                    map_filter Exn.get_exn blobs_digests
wenzelm@59702
   390
                    |> List.app (Output.error_message o Runtime.exn_message)
wenzelm@59702
   391
                  else (*auxiliary files*)
wenzelm@60027
   392
                    let val pos = Token.pos_of (nth tokens blobs_index)
wenzelm@60027
   393
                    in Position.reports (maps (blob_reports pos) blobs_digests) end;
wenzelm@59685
   394
              in tokens end) ());
wenzelm@59685
   395
      val commands' =
wenzelm@59702
   396
        Inttab.update_new (command_id, (name, blobs_digests, blobs_index, span)) commands
wenzelm@59685
   397
          handle Inttab.DUP dup => err_dup "command" dup;
wenzelm@47395
   398
      val _ =
wenzelm@52536
   399
        Position.setmp_thread_data (Position.id_only id)
wenzelm@50201
   400
          (fn () => Output.status (Markup.markup_only Markup.accepted)) ();
wenzelm@54519
   401
    in (versions, blobs, commands', execution) end);
wenzelm@38418
   402
wenzelm@52536
   403
fun the_command (State {commands, ...}) command_id =
wenzelm@52536
   404
  (case Inttab.lookup commands command_id of
wenzelm@52536
   405
    NONE => err_undef "command" command_id
wenzelm@44644
   406
  | SOME command => command);
wenzelm@38418
   407
wenzelm@52569
   408
val the_command_name = #1 oo the_command;
wenzelm@52569
   409
wenzelm@60880
   410
fun command_exec state node_name command_id =
wenzelm@60880
   411
  let
wenzelm@60880
   412
    val State {execution = {version_id, ...}, ...} = state;
wenzelm@60880
   413
    val node = get_node (nodes_of (the_version state version_id)) node_name;
wenzelm@60880
   414
  in the_entry node command_id end;
wenzelm@60880
   415
wenzelm@47420
   416
end;
wenzelm@38418
   417
wenzelm@52566
   418
wenzelm@52566
   419
(* remove_versions *)
wenzelm@52566
   420
wenzelm@54519
   421
fun remove_versions version_ids state = state |> map_state (fn (versions, _, _, execution) =>
wenzelm@47420
   422
  let
wenzelm@52536
   423
    val _ =
wenzelm@52536
   424
      member (op =) version_ids (#version_id execution) andalso
wenzelm@52536
   425
        error ("Attempt to remove execution version " ^ Document_ID.print (#version_id execution));
wenzelm@47343
   426
wenzelm@52536
   427
    val versions' = fold delete_version version_ids versions;
wenzelm@47420
   428
    val commands' =
wenzelm@47420
   429
      (versions', Inttab.empty) |->
wenzelm@47420
   430
        Inttab.fold (fn (_, version) => nodes_of version |>
wenzelm@50862
   431
          String_Graph.fold (fn (_, (node, _)) => node |>
wenzelm@52536
   432
            iterate_entries (fn ((_, command_id), _) =>
wenzelm@52536
   433
              SOME o Inttab.insert (K true) (command_id, the_command state command_id))));
wenzelm@54519
   434
    val blobs' =
wenzelm@54519
   435
      (commands', Symtab.empty) |->
wenzelm@59689
   436
        Inttab.fold (fn (_, (_, blobs, _, _)) => blobs |>
wenzelm@56458
   437
          fold (fn Exn.Res (_, SOME b) => Symtab.update (b, the_blob state b) | _ => I));
wenzelm@54519
   438
wenzelm@54519
   439
  in (versions', blobs', commands', execution) end);
wenzelm@38418
   440
wenzelm@38418
   441
wenzelm@52604
   442
(* document execution *)
wenzelm@47389
   443
wenzelm@60198
   444
fun make_required nodes =
wenzelm@60198
   445
  let
wenzelm@60198
   446
    fun all_preds P =
wenzelm@60198
   447
      String_Graph.fold (fn (a, (node, _)) => P node ? cons a) nodes []
wenzelm@60198
   448
      |> String_Graph.all_preds nodes
wenzelm@60198
   449
      |> Symtab.make_set;
wenzelm@60198
   450
wenzelm@60198
   451
    val all_visible = all_preds visible_node;
wenzelm@60198
   452
    val all_required = all_preds required_node;
wenzelm@60198
   453
  in
wenzelm@60198
   454
    Symtab.fold (fn (a, ()) =>
wenzelm@60198
   455
      exists (Symtab.defined all_visible) (String_Graph.immediate_succs nodes a) ?
wenzelm@60198
   456
        Symtab.update (a, ())) all_visible all_required
wenzelm@60198
   457
  end;
wenzelm@60198
   458
wenzelm@54519
   459
fun start_execution state = state |> map_state (fn (versions, blobs, commands, execution) =>
wenzelm@52796
   460
  timeit "Document.start_execution" (fn () =>
wenzelm@52796
   461
    let
wenzelm@59193
   462
      val {version_id, execution_id, delay_request} = execution;
wenzelm@52798
   463
wenzelm@52798
   464
      val delay = seconds (Options.default_real "editor_execution_delay");
wenzelm@52774
   465
wenzelm@52798
   466
      val _ = Future.cancel delay_request;
wenzelm@52798
   467
      val delay_request' = Event_Timer.future (Time.+ (Time.now (), delay));
wenzelm@52798
   468
wenzelm@59198
   469
      fun finished_import (name, (node, _)) =
wenzelm@59198
   470
        finished_result node orelse is_some (loaded_theory name);
wenzelm@60198
   471
wenzelm@60198
   472
      val nodes = nodes_of (the_version state version_id);
wenzelm@60198
   473
      val required = make_required nodes;
wenzelm@59193
   474
      val _ =
wenzelm@60198
   475
        nodes |> String_Graph.schedule
wenzelm@52573
   476
          (fn deps => fn (name, node) =>
wenzelm@60198
   477
            if Symtab.defined required name orelse visible_node node orelse pending_result node then
wenzelm@52774
   478
              let
wenzelm@52775
   479
                fun body () =
wenzelm@59347
   480
                  (if forall finished_import deps then
wenzelm@59198
   481
                    iterate_entries (fn (_, opt_exec) => fn () =>
wenzelm@59198
   482
                      (case opt_exec of
wenzelm@59198
   483
                        SOME exec =>
wenzelm@59198
   484
                          if Execution.is_running execution_id
wenzelm@59198
   485
                          then SOME (Command.exec execution_id exec)
wenzelm@59198
   486
                          else NONE
wenzelm@59198
   487
                      | NONE => NONE)) node ()
wenzelm@59347
   488
                   else ())
wenzelm@59347
   489
                   handle exn => (Output.system_message (Runtime.exn_message exn); reraise exn);
wenzelm@52774
   490
                val future =
wenzelm@52774
   491
                  (singleton o Future.forks)
wenzelm@59193
   492
                   {name = "theory:" ^ name,
wenzelm@59193
   493
                    group = SOME (Future.new_group NONE),
wenzelm@59198
   494
                    deps = Future.task_of delay_request' :: maps (the_list o #2 o #2) deps,
wenzelm@59193
   495
                    pri = 0, interrupts = false} body;
wenzelm@59198
   496
              in (node, SOME (Future.task_of future)) end
wenzelm@59198
   497
            else (node, NONE));
wenzelm@52798
   498
      val execution' =
wenzelm@59193
   499
        {version_id = version_id, execution_id = execution_id, delay_request = delay_request'};
wenzelm@54519
   500
    in (versions, blobs, commands, execution') end));
wenzelm@47345
   501
wenzelm@47345
   502
wenzelm@47420
   503
wenzelm@47420
   504
(** document update **)
wenzelm@38418
   505
wenzelm@52566
   506
(* exec state assignment *)
wenzelm@52566
   507
wenzelm@52566
   508
type assign_update = Command.exec option Inttab.table;  (*command id -> exec*)
wenzelm@52566
   509
wenzelm@52566
   510
val assign_update_empty: assign_update = Inttab.empty;
wenzelm@52566
   511
fun assign_update_defined (tab: assign_update) command_id = Inttab.defined tab command_id;
wenzelm@52566
   512
fun assign_update_apply (tab: assign_update) node = Inttab.fold assign_entry tab node;
wenzelm@52566
   513
wenzelm@52566
   514
fun assign_update_new upd (tab: assign_update) =
wenzelm@52566
   515
  Inttab.update_new upd tab
wenzelm@52566
   516
    handle Inttab.DUP dup => err_dup "exec state assignment" dup;
wenzelm@52566
   517
wenzelm@52566
   518
fun assign_update_result (tab: assign_update) =
wenzelm@52566
   519
  Inttab.fold (fn (command_id, exec) => cons (command_id, Command.exec_ids exec)) tab [];
wenzelm@52566
   520
wenzelm@52566
   521
wenzelm@52566
   522
(* update *)
wenzelm@52566
   523
wenzelm@38418
   524
local
wenzelm@38418
   525
wenzelm@48927
   526
fun init_theory deps node span =
wenzelm@47335
   527
  let
wenzelm@54526
   528
    val master_dir = master_directory node;
wenzelm@54526
   529
    val header = read_header node span;
wenzelm@48927
   530
    val imports = #imports header;
wenzelm@59716
   531
wenzelm@59716
   532
    fun maybe_end_theory pos st =
wenzelm@59716
   533
      SOME (Toplevel.end_theory pos st)
wenzelm@59716
   534
        handle ERROR msg => (Output.error_message msg; NONE);
wenzelm@59716
   535
    val parents_reports =
wenzelm@59716
   536
      imports |> map_filter (fn (import, pos) =>
wenzelm@54516
   537
        (case loaded_theory import of
wenzelm@59716
   538
          NONE =>
wenzelm@59716
   539
            maybe_end_theory pos
wenzelm@52536
   540
              (case get_result (snd (the (AList.lookup (op =) deps import))) of
wenzelm@52536
   541
                NONE => Toplevel.toplevel
wenzelm@59716
   542
              | SOME eval => Command.eval_result_state eval)
wenzelm@59716
   543
        | some => some)
wenzelm@59716
   544
        |> Option.map (fn thy => (thy, (pos, Theory.get_markup thy))));
wenzelm@59716
   545
wenzelm@59716
   546
    val parents =
wenzelm@60937
   547
      if null parents_reports then [Thy_Info.pure_theory ()] else map #1 parents_reports;
wenzelm@59716
   548
    val _ = Position.reports (map #2 parents_reports);
wenzelm@56208
   549
  in Resources.begin_theory master_dir header parents end;
wenzelm@47335
   550
wenzelm@47407
   551
fun check_theory full name node =
wenzelm@54516
   552
  is_some (loaded_theory name) orelse
wenzelm@59715
   553
  null (#errors (get_header node)) andalso (not full orelse is_some (get_result node));
wenzelm@47335
   554
wenzelm@58923
   555
fun last_common keywords state node_required node0 node =
wenzelm@44482
   556
  let
wenzelm@44645
   557
    fun update_flags prev (visible, initial) =
wenzelm@44645
   558
      let
wenzelm@52569
   559
        val visible' = visible andalso prev <> visible_last node;
wenzelm@44645
   560
        val initial' = initial andalso
wenzelm@44645
   561
          (case prev of
wenzelm@44645
   562
            NONE => true
wenzelm@59735
   563
          | SOME command_id => the_command_name state command_id <> Thy_Header.theoryN);
wenzelm@44645
   564
      in (visible', initial') end;
wenzelm@52569
   565
wenzelm@52784
   566
    fun get_common ((prev, command_id), opt_exec) (_, ok, flags, assign_update) =
wenzelm@52784
   567
      if ok then
wenzelm@47630
   568
        let
wenzelm@52784
   569
          val flags' as (visible', _) = update_flags prev flags;
wenzelm@52784
   570
          val ok' =
wenzelm@52586
   571
            (case (lookup_entry node0 command_id, opt_exec) of
wenzelm@52784
   572
              (SOME (eval0, _), SOME (eval, _)) =>
wenzelm@52784
   573
                Command.eval_eq (eval0, eval) andalso
wenzelm@52784
   574
                  (visible' orelse node_required orelse Command.eval_running eval)
wenzelm@52586
   575
            | _ => false);
wenzelm@52784
   576
          val assign_update' = assign_update |> ok' ?
wenzelm@52569
   577
            (case opt_exec of
wenzelm@52569
   578
              SOME (eval, prints) =>
wenzelm@52569
   579
                let
wenzelm@52569
   580
                  val command_visible = visible_command node command_id;
wenzelm@52850
   581
                  val command_overlays = overlays node command_id;
wenzelm@52569
   582
                  val command_name = the_command_name state command_id;
wenzelm@52569
   583
                in
wenzelm@58923
   584
                  (case
wenzelm@58923
   585
                    Command.print command_visible command_overlays keywords command_name eval prints
wenzelm@58923
   586
                   of
wenzelm@52569
   587
                    SOME prints' => assign_update_new (command_id, SOME (eval, prints'))
wenzelm@52569
   588
                  | NONE => I)
wenzelm@52569
   589
                end
wenzelm@52569
   590
            | NONE => I);
wenzelm@52784
   591
        in SOME (prev, ok', flags', assign_update') end
wenzelm@47630
   592
      else NONE;
wenzelm@52784
   593
    val (common, ok, flags, assign_update') =
wenzelm@52569
   594
      iterate_entries get_common node (NONE, true, (true, true), assign_update_empty);
wenzelm@52569
   595
    val (common', flags') =
wenzelm@52784
   596
      if ok then
wenzelm@52569
   597
        let val last = Entries.get_after (get_entries node) common
wenzelm@52569
   598
        in (last, update_flags last flags) end
wenzelm@52569
   599
      else (common, flags);
wenzelm@52569
   600
  in (assign_update', common', flags') end;
wenzelm@44645
   601
wenzelm@52534
   602
fun illegal_init _ = error "Illegal theory header after end of theory";
wenzelm@52534
   603
wenzelm@58923
   604
fun new_exec keywords state node proper_init command_id' (assign_update, command_exec, init) =
wenzelm@47407
   605
  if not proper_init andalso is_none init then NONE
wenzelm@44645
   606
  else
wenzelm@44645
   607
    let
wenzelm@52534
   608
      val (_, (eval, _)) = command_exec;
wenzelm@52850
   609
wenzelm@52850
   610
      val command_visible = visible_command node command_id';
wenzelm@52850
   611
      val command_overlays = overlays node command_id';
wenzelm@59689
   612
      val (command_name, blob_digests, blobs_index, span0) = the_command state command_id';
wenzelm@56447
   613
      val blobs = map (resolve_blob state) blob_digests;
wenzelm@54519
   614
      val span = Lazy.force span0;
wenzelm@52566
   615
wenzelm@54519
   616
      val eval' =
wenzelm@58934
   617
        Command.eval keywords (master_directory node)
wenzelm@59689
   618
          (fn () => the_default illegal_init init span) (blobs, blobs_index) span eval;
wenzelm@58923
   619
      val prints' =
wenzelm@58923
   620
        perhaps (Command.print command_visible command_overlays keywords command_name eval') [];
wenzelm@52566
   621
      val exec' = (eval', prints');
wenzelm@44482
   622
wenzelm@52566
   623
      val assign_update' = assign_update_new (command_id', SOME exec') assign_update;
wenzelm@59735
   624
      val init' = if command_name = Thy_Header.theoryN then NONE else init;
wenzelm@52566
   625
    in SOME (assign_update', (command_id', (eval', prints')), init') end;
wenzelm@52602
   626
wenzelm@52655
   627
fun removed_execs node0 (command_id, exec_ids) =
wenzelm@52655
   628
  subtract (op =) exec_ids (Command.exec_ids (lookup_entry node0 command_id));
wenzelm@52602
   629
wenzelm@38418
   630
in
wenzelm@38418
   631
wenzelm@59056
   632
fun update old_version_id new_version_id edits state = Runtime.exn_trace_system (fn () =>
wenzelm@38418
   633
  let
wenzelm@52536
   634
    val old_version = the_version state old_version_id;
wenzelm@59086
   635
    val new_version =
wenzelm@59086
   636
      timeit "Document.edit_nodes"
wenzelm@59086
   637
        (fn () => old_version |> fold edit_nodes edits |> edit_keywords edits);
wenzelm@38418
   638
wenzelm@44544
   639
    val nodes = nodes_of new_version;
wenzelm@52776
   640
    val required = make_required nodes;
wenzelm@52776
   641
    val required0 = make_required (nodes_of old_version);
wenzelm@52772
   642
    val edited = fold (fn (name, _) => Symtab.update (name, ())) edits Symtab.empty;
wenzelm@44544
   643
wenzelm@47628
   644
    val updated = timeit "Document.update" (fn () =>
wenzelm@50862
   645
      nodes |> String_Graph.schedule
wenzelm@44199
   646
        (fn deps => fn (name, node) =>
wenzelm@47406
   647
          (singleton o Future.forks)
wenzelm@47406
   648
            {name = "Document.update", group = NONE,
wenzelm@52716
   649
              deps = map (Future.task_of o #2) deps, pri = 1, interrupts = false}
wenzelm@59056
   650
            (fn () =>
wenzelm@59056
   651
              timeit ("Document.update " ^ name) (fn () =>
wenzelm@59056
   652
                Runtime.exn_trace_system (fn () =>
wenzelm@44482
   653
                  let
wenzelm@59086
   654
                    val keywords = the_default (Session.get_keywords ()) (get_keywords node);
wenzelm@59056
   655
                    val imports = map (apsnd Future.join) deps;
wenzelm@59056
   656
                    val imports_result_changed = exists (#4 o #1 o #2) imports;
wenzelm@59056
   657
                    val node_required = Symtab.defined required name;
wenzelm@59056
   658
                  in
wenzelm@59056
   659
                    if Symtab.defined edited name orelse visible_node node orelse
wenzelm@59056
   660
                      imports_result_changed orelse Symtab.defined required0 name <> node_required
wenzelm@59056
   661
                    then
wenzelm@59056
   662
                      let
wenzelm@59056
   663
                        val node0 = node_of old_version name;
wenzelm@59056
   664
                        val init = init_theory imports node;
wenzelm@59056
   665
                        val proper_init =
wenzelm@59056
   666
                          check_theory false name node andalso
wenzelm@59056
   667
                          forall (fn (name, (_, node)) => check_theory true name node) imports;
wenzelm@47406
   668
wenzelm@59056
   669
                        val (print_execs, common, (still_visible, initial)) =
wenzelm@59056
   670
                          if imports_result_changed then (assign_update_empty, NONE, (true, true))
wenzelm@59056
   671
                          else last_common keywords state node_required node0 node;
wenzelm@59056
   672
                        val common_command_exec = the_default_entry node common;
wenzelm@44479
   673
wenzelm@59056
   674
                        val (updated_execs, (command_id', (eval', _)), _) =
wenzelm@59056
   675
                          (print_execs, common_command_exec, if initial then SOME init else NONE)
wenzelm@59056
   676
                          |> (still_visible orelse node_required) ?
wenzelm@59056
   677
                            iterate_entries_after common
wenzelm@59056
   678
                              (fn ((prev, id), _) => fn res =>
wenzelm@59056
   679
                                if not node_required andalso prev = visible_last node then NONE
wenzelm@59056
   680
                                else new_exec keywords state node proper_init id res) node;
wenzelm@44479
   681
wenzelm@59056
   682
                        val assigned_execs =
wenzelm@59056
   683
                          (node0, updated_execs) |-> iterate_entries_after common
wenzelm@59056
   684
                            (fn ((_, command_id0), exec0) => fn res =>
wenzelm@59056
   685
                              if is_none exec0 then NONE
wenzelm@59056
   686
                              else if assign_update_defined updated_execs command_id0 then SOME res
wenzelm@59056
   687
                              else SOME (assign_update_new (command_id0, NONE) res));
wenzelm@44480
   688
wenzelm@59056
   689
                        val last_exec =
wenzelm@59056
   690
                          if command_id' = Document_ID.none then NONE else SOME command_id';
wenzelm@59056
   691
                        val result =
wenzelm@59056
   692
                          if is_none last_exec orelse is_some (after_entry node last_exec) then NONE
wenzelm@59056
   693
                          else SOME eval';
wenzelm@44480
   694
wenzelm@59056
   695
                        val assign_update = assign_update_result assigned_execs;
wenzelm@59056
   696
                        val removed = maps (removed_execs node0) assign_update;
wenzelm@59056
   697
                        val _ = List.app Execution.cancel removed;
wenzelm@52602
   698
wenzelm@59056
   699
                        val node' = node
wenzelm@59056
   700
                          |> assign_update_apply assigned_execs
wenzelm@59056
   701
                          |> set_result result;
wenzelm@59056
   702
                        val assigned_node = SOME (name, node');
wenzelm@59056
   703
                        val result_changed = changed_result node0 node';
wenzelm@59056
   704
                      in ((removed, assign_update, assigned_node, result_changed), node') end
wenzelm@59056
   705
                    else (([], [], NONE, false), node)
wenzelm@59056
   706
                  end))))
wenzelm@47628
   707
      |> Future.joins |> map #1);
wenzelm@44476
   708
wenzelm@52655
   709
    val removed = maps #1 updated;
wenzelm@52655
   710
    val assign_update = maps #2 updated;
wenzelm@52602
   711
    val assigned_nodes = map_filter #3 updated;
wenzelm@52602
   712
wenzelm@44197
   713
    val state' = state
wenzelm@52602
   714
      |> define_version new_version_id (fold put_node assigned_nodes new_version);
wenzelm@52602
   715
wenzelm@59056
   716
  in (removed, assign_update, state') end);
wenzelm@38418
   717
wenzelm@38418
   718
end;
wenzelm@38418
   719
wenzelm@38418
   720
wenzelm@43713
   721
wenzelm@43713
   722
(** global state **)
wenzelm@43713
   723
wenzelm@52508
   724
val global_state = Synchronized.var "Document.global_state" init_state;
wenzelm@43713
   725
wenzelm@43713
   726
fun state () = Synchronized.value global_state;
wenzelm@43713
   727
val change_state = Synchronized.change global_state;
wenzelm@43713
   728
wenzelm@38418
   729
end;
wenzelm@38418
   730