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