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