src/Pure/PIDE/document.ML
author wenzelm
Mon, 22 Aug 2011 21:42:02 +0200
changeset 44384 8f6054a63f96
parent 44338 700008399ee5
child 44385 e7fdb008aa7d
permissions -rw-r--r--
some support for editor perspective;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
38150
67fc24df3721 simplified/refined document model: collection of named nodes, without proper dependencies yet;
wenzelm
parents:
diff changeset
     1
(*  Title:      Pure/PIDE/document.ML
67fc24df3721 simplified/refined document model: collection of named nodes, without proper dependencies yet;
wenzelm
parents:
diff changeset
     2
    Author:     Makarius
67fc24df3721 simplified/refined document model: collection of named nodes, without proper dependencies yet;
wenzelm
parents:
diff changeset
     3
67fc24df3721 simplified/refined document model: collection of named nodes, without proper dependencies yet;
wenzelm
parents:
diff changeset
     4
Document as collection of named nodes, each consisting of an editable
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
     5
list of commands, associated with asynchronous execution process.
38150
67fc24df3721 simplified/refined document model: collection of named nodes, without proper dependencies yet;
wenzelm
parents:
diff changeset
     6
*)
67fc24df3721 simplified/refined document model: collection of named nodes, without proper dependencies yet;
wenzelm
parents:
diff changeset
     7
67fc24df3721 simplified/refined document model: collection of named nodes, without proper dependencies yet;
wenzelm
parents:
diff changeset
     8
signature DOCUMENT =
67fc24df3721 simplified/refined document model: collection of named nodes, without proper dependencies yet;
wenzelm
parents:
diff changeset
     9
sig
38363
af7f41a8a0a8 clarified "state" (accumulated data) vs. "exec" (execution that produces data);
wenzelm
parents: 38355
diff changeset
    10
  type id = int
38373
wenzelm
parents: 38363
diff changeset
    11
  type version_id = id
38363
af7f41a8a0a8 clarified "state" (accumulated data) vs. "exec" (execution that produces data);
wenzelm
parents: 38355
diff changeset
    12
  type command_id = id
38373
wenzelm
parents: 38363
diff changeset
    13
  type exec_id = id
38363
af7f41a8a0a8 clarified "state" (accumulated data) vs. "exec" (execution that produces data);
wenzelm
parents: 38355
diff changeset
    14
  val no_id: id
38419
f9dc924e54f8 renamed create_id to new_id;
wenzelm
parents: 38418
diff changeset
    15
  val new_id: unit -> id
38363
af7f41a8a0a8 clarified "state" (accumulated data) vs. "exec" (execution that produces data);
wenzelm
parents: 38355
diff changeset
    16
  val parse_id: string -> id
af7f41a8a0a8 clarified "state" (accumulated data) vs. "exec" (execution that produces data);
wenzelm
parents: 38355
diff changeset
    17
  val print_id: id -> string
44185
05641edb5d30 provide node header via Scala layer;
wenzelm
parents: 44182
diff changeset
    18
  type node_header = (string * string list * (string * bool) list) Exn.result
44157
a21d3e1e64fd uniform treatment of header edits as document edits;
wenzelm
parents: 44156
diff changeset
    19
  datatype node_edit =
44185
05641edb5d30 provide node header via Scala layer;
wenzelm
parents: 44182
diff changeset
    20
    Clear |
44157
a21d3e1e64fd uniform treatment of header edits as document edits;
wenzelm
parents: 44156
diff changeset
    21
    Edits of (command_id option * command_id option) list |
44384
8f6054a63f96 some support for editor perspective;
wenzelm
parents: 44338
diff changeset
    22
    Header of node_header |
8f6054a63f96 some support for editor perspective;
wenzelm
parents: 44338
diff changeset
    23
    Perspective of id list
44156
6aa25b80e1a5 explicit datatypes for document node edits;
wenzelm
parents: 44113
diff changeset
    24
  type edit = string * node_edit
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
    25
  type state
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
    26
  val init_state: state
44197
458573968568 refined Document.edit: less stateful update via Graph.schedule;
wenzelm
parents: 44196
diff changeset
    27
  val join_commands: state -> unit
44301
65f60d9ac4bf tuned signature (again);
wenzelm
parents: 44300
diff changeset
    28
  val cancel_execution: state -> Future.task list
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
    29
  val define_command: command_id -> string -> state -> state
44157
a21d3e1e64fd uniform treatment of header edits as document edits;
wenzelm
parents: 44156
diff changeset
    30
  val edit: version_id -> version_id -> edit list -> state -> (command_id * exec_id) list * state
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
    31
  val execute: version_id -> state -> state
43713
1ba5331b4623 moved global state to structure Document (again);
wenzelm
parents: 43668
diff changeset
    32
  val state: unit -> state
1ba5331b4623 moved global state to structure Document (again);
wenzelm
parents: 43668
diff changeset
    33
  val change_state: (state -> state) -> unit
38150
67fc24df3721 simplified/refined document model: collection of named nodes, without proper dependencies yet;
wenzelm
parents:
diff changeset
    34
end;
67fc24df3721 simplified/refined document model: collection of named nodes, without proper dependencies yet;
wenzelm
parents:
diff changeset
    35
67fc24df3721 simplified/refined document model: collection of named nodes, without proper dependencies yet;
wenzelm
parents:
diff changeset
    36
structure Document: DOCUMENT =
67fc24df3721 simplified/refined document model: collection of named nodes, without proper dependencies yet;
wenzelm
parents:
diff changeset
    37
struct
67fc24df3721 simplified/refined document model: collection of named nodes, without proper dependencies yet;
wenzelm
parents:
diff changeset
    38
67fc24df3721 simplified/refined document model: collection of named nodes, without proper dependencies yet;
wenzelm
parents:
diff changeset
    39
(* unique identifiers *)
67fc24df3721 simplified/refined document model: collection of named nodes, without proper dependencies yet;
wenzelm
parents:
diff changeset
    40
38363
af7f41a8a0a8 clarified "state" (accumulated data) vs. "exec" (execution that produces data);
wenzelm
parents: 38355
diff changeset
    41
type id = int;
38373
wenzelm
parents: 38363
diff changeset
    42
type version_id = id;
38363
af7f41a8a0a8 clarified "state" (accumulated data) vs. "exec" (execution that produces data);
wenzelm
parents: 38355
diff changeset
    43
type command_id = id;
38373
wenzelm
parents: 38363
diff changeset
    44
type exec_id = id;
38355
8cb265fb12fe represent document ids by (long) int, to benefit from the somewhat faster Inttab in ML (LinearSet in Scala is invariably indexed by native object ids);
wenzelm
parents: 38150
diff changeset
    45
8cb265fb12fe represent document ids by (long) int, to benefit from the somewhat faster Inttab in ML (LinearSet in Scala is invariably indexed by native object ids);
wenzelm
parents: 38150
diff changeset
    46
val no_id = 0;
40449
9c390868d255 added general Synchronized.counter convenience;
wenzelm
parents: 40398
diff changeset
    47
val new_id = Synchronized.counter ();
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
    48
38414
49f1f657adc2 more basic Markup.parse_int/print_int (using signed_string_of_int) (ML);
wenzelm
parents: 38373
diff changeset
    49
val parse_id = Markup.parse_int;
49f1f657adc2 more basic Markup.parse_int/print_int (using signed_string_of_int) (ML);
wenzelm
parents: 38373
diff changeset
    50
val print_id = Markup.print_int;
38150
67fc24df3721 simplified/refined document model: collection of named nodes, without proper dependencies yet;
wenzelm
parents:
diff changeset
    51
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
    52
fun err_dup kind id = error ("Duplicate " ^ kind ^ ": " ^ print_id id);
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
    53
fun err_undef kind id = error ("Undefined " ^ kind ^ ": " ^ print_id id);
38150
67fc24df3721 simplified/refined document model: collection of named nodes, without proper dependencies yet;
wenzelm
parents:
diff changeset
    54
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
    55
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
    56
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
    57
(** document structure **)
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
    58
44185
05641edb5d30 provide node header via Scala layer;
wenzelm
parents: 44182
diff changeset
    59
type node_header = (string * string list * (string * bool) list) Exn.result;
38448
62d16c415019 added functor Linear_Set, based on former adhoc structures in document.ML;
wenzelm
parents: 38421
diff changeset
    60
structure Entries = Linear_Set(type key = command_id val ord = int_ord);
62d16c415019 added functor Linear_Set, based on former adhoc structures in document.ML;
wenzelm
parents: 38421
diff changeset
    61
43668
aad4f1956098 get theory from last executation state;
wenzelm
parents: 43666
diff changeset
    62
abstype node = Node of
44182
ecb51b457064 clarified node header -- exclude master_dir;
wenzelm
parents: 44180
diff changeset
    63
 {header: node_header,
44180
a6dc270d3edb maintain node header;
wenzelm
parents: 44160
diff changeset
    64
  entries: exec_id option Entries.T,  (*command entries with excecutions*)
44197
458573968568 refined Document.edit: less stateful update via Graph.schedule;
wenzelm
parents: 44196
diff changeset
    65
  result: Toplevel.state lazy}
43668
aad4f1956098 get theory from last executation state;
wenzelm
parents: 43666
diff changeset
    66
and version = Version of node Graph.T  (*development graph wrt. static imports*)
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
    67
with
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
    68
44197
458573968568 refined Document.edit: less stateful update via Graph.schedule;
wenzelm
parents: 44196
diff changeset
    69
fun make_node (header, entries, result) =
458573968568 refined Document.edit: less stateful update via Graph.schedule;
wenzelm
parents: 44196
diff changeset
    70
  Node {header = header, entries = entries, result = result};
43668
aad4f1956098 get theory from last executation state;
wenzelm
parents: 43666
diff changeset
    71
44197
458573968568 refined Document.edit: less stateful update via Graph.schedule;
wenzelm
parents: 44196
diff changeset
    72
fun map_node f (Node {header, entries, result}) =
458573968568 refined Document.edit: less stateful update via Graph.schedule;
wenzelm
parents: 44196
diff changeset
    73
  make_node (f (header, entries, result));
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
    74
44180
a6dc270d3edb maintain node header;
wenzelm
parents: 44160
diff changeset
    75
fun get_header (Node {header, ...}) = header;
44197
458573968568 refined Document.edit: less stateful update via Graph.schedule;
wenzelm
parents: 44196
diff changeset
    76
fun set_header header = map_node (fn (_, entries, result) => (header, entries, result));
44180
a6dc270d3edb maintain node header;
wenzelm
parents: 44160
diff changeset
    77
44197
458573968568 refined Document.edit: less stateful update via Graph.schedule;
wenzelm
parents: 44196
diff changeset
    78
fun map_entries f (Node {header, entries, result}) = make_node (header, f entries, result);
43668
aad4f1956098 get theory from last executation state;
wenzelm
parents: 43666
diff changeset
    79
fun fold_entries start f (Node {entries, ...}) = Entries.fold start f entries;
aad4f1956098 get theory from last executation state;
wenzelm
parents: 43666
diff changeset
    80
fun first_entry start P (Node {entries, ...}) = Entries.get_first start P entries;
aad4f1956098 get theory from last executation state;
wenzelm
parents: 43666
diff changeset
    81
44200
ce0112e26b3b tuned error message;
wenzelm
parents: 44199
diff changeset
    82
fun get_theory pos (Node {result, ...}) = Toplevel.end_theory pos (Lazy.get_finished result);
44197
458573968568 refined Document.edit: less stateful update via Graph.schedule;
wenzelm
parents: 44196
diff changeset
    83
fun set_result result = map_node (fn (header, entries, _) => (header, entries, result));
44180
a6dc270d3edb maintain node header;
wenzelm
parents: 44160
diff changeset
    84
44197
458573968568 refined Document.edit: less stateful update via Graph.schedule;
wenzelm
parents: 44196
diff changeset
    85
val empty_exec = Lazy.value Toplevel.toplevel;
458573968568 refined Document.edit: less stateful update via Graph.schedule;
wenzelm
parents: 44196
diff changeset
    86
val empty_node = make_node (Exn.Exn (ERROR "Bad theory header"), Entries.empty, empty_exec);
458573968568 refined Document.edit: less stateful update via Graph.schedule;
wenzelm
parents: 44196
diff changeset
    87
val clear_node = map_node (fn (header, _, _) => (header, Entries.empty, empty_exec));
44185
05641edb5d30 provide node header via Scala layer;
wenzelm
parents: 44182
diff changeset
    88
05641edb5d30 provide node header via Scala layer;
wenzelm
parents: 44182
diff changeset
    89
fun get_node nodes name = Graph.get_node nodes name handle Graph.UNDEF _ => empty_node;
44202
44c4ae5c5ce2 touch descendants of edited nodes;
wenzelm
parents: 44201
diff changeset
    90
fun default_node name = Graph.default_node (name, empty_node);
44c4ae5c5ce2 touch descendants of edited nodes;
wenzelm
parents: 44201
diff changeset
    91
fun update_node name f = default_node name #> Graph.map_node name f;
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
    92
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
    93
38448
62d16c415019 added functor Linear_Set, based on former adhoc structures in document.ML;
wenzelm
parents: 38421
diff changeset
    94
(* node edits and associated executions *)
38150
67fc24df3721 simplified/refined document model: collection of named nodes, without proper dependencies yet;
wenzelm
parents:
diff changeset
    95
44157
a21d3e1e64fd uniform treatment of header edits as document edits;
wenzelm
parents: 44156
diff changeset
    96
datatype node_edit =
44185
05641edb5d30 provide node header via Scala layer;
wenzelm
parents: 44182
diff changeset
    97
  Clear |
44157
a21d3e1e64fd uniform treatment of header edits as document edits;
wenzelm
parents: 44156
diff changeset
    98
  Edits of (command_id option * command_id option) list |
44384
8f6054a63f96 some support for editor perspective;
wenzelm
parents: 44338
diff changeset
    99
  Header of node_header |
8f6054a63f96 some support for editor perspective;
wenzelm
parents: 44338
diff changeset
   100
  Perspective of id list;
44157
a21d3e1e64fd uniform treatment of header edits as document edits;
wenzelm
parents: 44156
diff changeset
   101
44156
6aa25b80e1a5 explicit datatypes for document node edits;
wenzelm
parents: 44113
diff changeset
   102
type edit = string * node_edit;
38448
62d16c415019 added functor Linear_Set, based on former adhoc structures in document.ML;
wenzelm
parents: 38421
diff changeset
   103
43668
aad4f1956098 get theory from last executation state;
wenzelm
parents: 43666
diff changeset
   104
fun the_entry (Node {entries, ...}) id =
38448
62d16c415019 added functor Linear_Set, based on former adhoc structures in document.ML;
wenzelm
parents: 38421
diff changeset
   105
  (case Entries.lookup entries id of
62d16c415019 added functor Linear_Set, based on former adhoc structures in document.ML;
wenzelm
parents: 38421
diff changeset
   106
    NONE => err_undef "command entry" id
62d16c415019 added functor Linear_Set, based on former adhoc structures in document.ML;
wenzelm
parents: 38421
diff changeset
   107
  | SOME entry => entry);
38150
67fc24df3721 simplified/refined document model: collection of named nodes, without proper dependencies yet;
wenzelm
parents:
diff changeset
   108
43668
aad4f1956098 get theory from last executation state;
wenzelm
parents: 43666
diff changeset
   109
fun update_entry (id, exec_id) =
aad4f1956098 get theory from last executation state;
wenzelm
parents: 43666
diff changeset
   110
  map_entries (Entries.update (id, SOME exec_id));
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   111
38448
62d16c415019 added functor Linear_Set, based on former adhoc structures in document.ML;
wenzelm
parents: 38421
diff changeset
   112
fun reset_after id entries =
62d16c415019 added functor Linear_Set, based on former adhoc structures in document.ML;
wenzelm
parents: 38421
diff changeset
   113
  (case Entries.get_after entries id of
62d16c415019 added functor Linear_Set, based on former adhoc structures in document.ML;
wenzelm
parents: 38421
diff changeset
   114
    NONE => entries
62d16c415019 added functor Linear_Set, based on former adhoc structures in document.ML;
wenzelm
parents: 38421
diff changeset
   115
  | SOME next => Entries.update (next, NONE) entries);
62d16c415019 added functor Linear_Set, based on former adhoc structures in document.ML;
wenzelm
parents: 38421
diff changeset
   116
43668
aad4f1956098 get theory from last executation state;
wenzelm
parents: 43666
diff changeset
   117
val edit_node = map_entries o fold
aad4f1956098 get theory from last executation state;
wenzelm
parents: 43666
diff changeset
   118
  (fn (id, SOME id2) => Entries.insert_after id (id2, NONE)
aad4f1956098 get theory from last executation state;
wenzelm
parents: 43666
diff changeset
   119
    | (id, NONE) => Entries.delete_after id #> reset_after id);
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   120
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   121
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   122
(* version operations *)
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   123
44185
05641edb5d30 provide node header via Scala layer;
wenzelm
parents: 44182
diff changeset
   124
val empty_version = Version Graph.empty;
05641edb5d30 provide node header via Scala layer;
wenzelm
parents: 44182
diff changeset
   125
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   126
fun nodes_of (Version nodes) = nodes;
44185
05641edb5d30 provide node header via Scala layer;
wenzelm
parents: 44182
diff changeset
   127
val node_of = get_node o nodes_of;
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   128
44185
05641edb5d30 provide node header via Scala layer;
wenzelm
parents: 44182
diff changeset
   129
fun cycle_msg names = "Cyclic dependency of " ^ space_implode " via " (map quote names);
44180
a6dc270d3edb maintain node header;
wenzelm
parents: 44160
diff changeset
   130
44202
44c4ae5c5ce2 touch descendants of edited nodes;
wenzelm
parents: 44201
diff changeset
   131
fun touch_descendants name nodes =
44c4ae5c5ce2 touch descendants of edited nodes;
wenzelm
parents: 44201
diff changeset
   132
  fold (fn desc => desc <> name ? update_node desc (map_entries (reset_after NONE)))
44c4ae5c5ce2 touch descendants of edited nodes;
wenzelm
parents: 44201
diff changeset
   133
    (Graph.all_succs nodes [name]) nodes;
44c4ae5c5ce2 touch descendants of edited nodes;
wenzelm
parents: 44201
diff changeset
   134
44157
a21d3e1e64fd uniform treatment of header edits as document edits;
wenzelm
parents: 44156
diff changeset
   135
fun edit_nodes (name, node_edit) (Version nodes) =
a21d3e1e64fd uniform treatment of header edits as document edits;
wenzelm
parents: 44156
diff changeset
   136
  Version
44202
44c4ae5c5ce2 touch descendants of edited nodes;
wenzelm
parents: 44201
diff changeset
   137
    (touch_descendants name
44c4ae5c5ce2 touch descendants of edited nodes;
wenzelm
parents: 44201
diff changeset
   138
      (case node_edit of
44c4ae5c5ce2 touch descendants of edited nodes;
wenzelm
parents: 44201
diff changeset
   139
        Clear => update_node name clear_node nodes
44c4ae5c5ce2 touch descendants of edited nodes;
wenzelm
parents: 44201
diff changeset
   140
      | Edits edits =>
44c4ae5c5ce2 touch descendants of edited nodes;
wenzelm
parents: 44201
diff changeset
   141
          nodes
44c4ae5c5ce2 touch descendants of edited nodes;
wenzelm
parents: 44201
diff changeset
   142
          |> update_node name (edit_node edits)
44c4ae5c5ce2 touch descendants of edited nodes;
wenzelm
parents: 44201
diff changeset
   143
      | Header header =>
44c4ae5c5ce2 touch descendants of edited nodes;
wenzelm
parents: 44201
diff changeset
   144
          let
44222
9d5ef6cd4ee1 use full .thy file name as node name, which makes MiscUtilities.resolveSymlinks/File.getCanonicalPath more predictable;
wenzelm
parents: 44202
diff changeset
   145
            val parents = (case header of Exn.Res (_, parents, _) => parents | _ => []);
44223
cac52579f2c2 more robust treatment of node dependencies in incremental edits;
wenzelm
parents: 44222
diff changeset
   146
            val nodes1 = nodes
cac52579f2c2 more robust treatment of node dependencies in incremental edits;
wenzelm
parents: 44222
diff changeset
   147
              |> default_node name
cac52579f2c2 more robust treatment of node dependencies in incremental edits;
wenzelm
parents: 44222
diff changeset
   148
              |> fold default_node parents;
cac52579f2c2 more robust treatment of node dependencies in incremental edits;
wenzelm
parents: 44222
diff changeset
   149
            val nodes2 = nodes1
44338
700008399ee5 refined Graph implementation: more abstract/scalable Graph.Keys instead of plain lists -- order of adjacency is now standardized wrt. Key.ord;
wenzelm
parents: 44330
diff changeset
   150
              |> Graph.Keys.fold
700008399ee5 refined Graph implementation: more abstract/scalable Graph.Keys instead of plain lists -- order of adjacency is now standardized wrt. Key.ord;
wenzelm
parents: 44330
diff changeset
   151
                  (fn dep => Graph.del_edge (dep, name)) (Graph.imm_preds nodes1 name);
44222
9d5ef6cd4ee1 use full .thy file name as node name, which makes MiscUtilities.resolveSymlinks/File.getCanonicalPath more predictable;
wenzelm
parents: 44202
diff changeset
   152
            val (header', nodes3) =
9d5ef6cd4ee1 use full .thy file name as node name, which makes MiscUtilities.resolveSymlinks/File.getCanonicalPath more predictable;
wenzelm
parents: 44202
diff changeset
   153
              (header, Graph.add_deps_acyclic (name, parents) nodes2)
9d5ef6cd4ee1 use full .thy file name as node name, which makes MiscUtilities.resolveSymlinks/File.getCanonicalPath more predictable;
wenzelm
parents: 44202
diff changeset
   154
                handle Graph.CYCLES cs => (Exn.Exn (ERROR (cat_lines (map cycle_msg cs))), nodes2);
44384
8f6054a63f96 some support for editor perspective;
wenzelm
parents: 44338
diff changeset
   155
          in Graph.map_node name (set_header header') nodes3 end
8f6054a63f96 some support for editor perspective;
wenzelm
parents: 44338
diff changeset
   156
      | Perspective _ => nodes));  (* FIXME *)
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   157
44222
9d5ef6cd4ee1 use full .thy file name as node name, which makes MiscUtilities.resolveSymlinks/File.getCanonicalPath more predictable;
wenzelm
parents: 44202
diff changeset
   158
fun put_node (name, node) (Version nodes) =
9d5ef6cd4ee1 use full .thy file name as node name, which makes MiscUtilities.resolveSymlinks/File.getCanonicalPath more predictable;
wenzelm
parents: 44202
diff changeset
   159
  Version (update_node name (K node) nodes);
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   160
38150
67fc24df3721 simplified/refined document model: collection of named nodes, without proper dependencies yet;
wenzelm
parents:
diff changeset
   161
end;
67fc24df3721 simplified/refined document model: collection of named nodes, without proper dependencies yet;
wenzelm
parents:
diff changeset
   162
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   163
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   164
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   165
(** global state -- document structure and execution process **)
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   166
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   167
abstype state = State of
40398
cdda2847a91e continue after failed commands;
wenzelm
parents: 40391
diff changeset
   168
 {versions: version Inttab.table,  (*version_id -> document content*)
38421
6cfc6fce7bfb document commands: maintain transition as future (wrt. potentially slow Outer_Syntax.prepare_command), refrain from second Toplevel.put_id;
wenzelm
parents: 38419
diff changeset
   169
  commands: Toplevel.transition future Inttab.table,  (*command_id -> transition (future parsing)*)
44196
3588f71abb50 simplified exec: eliminated unused status flag;
wenzelm
parents: 44186
diff changeset
   170
  execs: Toplevel.state lazy Inttab.table,  (*exec_id -> execution process*)
44300
349cc426d929 tuned signature -- treat structure Task_Queue as private to implementation;
wenzelm
parents: 44299
diff changeset
   171
  execution: Future.group}  (*global execution process*)
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   172
with
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   173
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   174
fun make_state (versions, commands, execs, execution) =
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   175
  State {versions = versions, commands = commands, execs = execs, execution = execution};
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   176
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   177
fun map_state f (State {versions, commands, execs, execution}) =
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   178
  make_state (f (versions, commands, execs, execution));
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   179
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   180
val init_state =
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   181
  make_state (Inttab.make [(no_id, empty_version)],
38449
wenzelm
parents: 38448
diff changeset
   182
    Inttab.make [(no_id, Future.value Toplevel.empty)],
44197
458573968568 refined Document.edit: less stateful update via Graph.schedule;
wenzelm
parents: 44196
diff changeset
   183
    Inttab.make [(no_id, empty_exec)],
44300
349cc426d929 tuned signature -- treat structure Task_Queue as private to implementation;
wenzelm
parents: 44299
diff changeset
   184
    Future.new_group NONE);
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   185
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   186
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   187
(* document versions *)
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   188
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   189
fun define_version (id: version_id) version =
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   190
  map_state (fn (versions, commands, execs, execution) =>
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   191
    let val versions' = Inttab.update_new (id, version) versions
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   192
      handle Inttab.DUP dup => err_dup "document version" dup
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   193
    in (versions', commands, execs, execution) end);
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   194
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   195
fun the_version (State {versions, ...}) (id: version_id) =
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   196
  (case Inttab.lookup versions id of
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   197
    NONE => err_undef "document version" id
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   198
  | SOME version => version);
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   199
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   200
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   201
(* commands *)
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   202
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   203
fun define_command (id: command_id) text =
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   204
  map_state (fn (versions, commands, execs, execution) =>
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   205
    let
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   206
      val id_string = print_id id;
44302
wenzelm
parents: 44301
diff changeset
   207
      val tr =
wenzelm
parents: 44301
diff changeset
   208
        Future.fork_pri 2 (fn () =>
wenzelm
parents: 44301
diff changeset
   209
          Position.setmp_thread_data (Position.id_only id_string)
wenzelm
parents: 44301
diff changeset
   210
            (fn () => Outer_Syntax.prepare_command (Position.id id_string) text) ());
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   211
      val commands' =
38421
6cfc6fce7bfb document commands: maintain transition as future (wrt. potentially slow Outer_Syntax.prepare_command), refrain from second Toplevel.put_id;
wenzelm
parents: 38419
diff changeset
   212
        Inttab.update_new (id, tr) commands
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   213
          handle Inttab.DUP dup => err_dup "command" dup;
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   214
    in (versions, commands', execs, execution) end);
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   215
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   216
fun the_command (State {commands, ...}) (id: command_id) =
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   217
  (case Inttab.lookup commands id of
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   218
    NONE => err_undef "command" id
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   219
  | SOME tr => tr);
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   220
38421
6cfc6fce7bfb document commands: maintain transition as future (wrt. potentially slow Outer_Syntax.prepare_command), refrain from second Toplevel.put_id;
wenzelm
parents: 38419
diff changeset
   221
fun join_commands (State {commands, ...}) =
6cfc6fce7bfb document commands: maintain transition as future (wrt. potentially slow Outer_Syntax.prepare_command), refrain from second Toplevel.put_id;
wenzelm
parents: 38419
diff changeset
   222
  Inttab.fold (fn (_, tr) => fn () => ignore (Future.join_result tr)) commands ();
6cfc6fce7bfb document commands: maintain transition as future (wrt. potentially slow Outer_Syntax.prepare_command), refrain from second Toplevel.put_id;
wenzelm
parents: 38419
diff changeset
   223
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   224
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   225
(* command executions *)
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   226
44197
458573968568 refined Document.edit: less stateful update via Graph.schedule;
wenzelm
parents: 44196
diff changeset
   227
fun define_exec (exec_id, exec) =
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   228
  map_state (fn (versions, commands, execs, execution) =>
44197
458573968568 refined Document.edit: less stateful update via Graph.schedule;
wenzelm
parents: 44196
diff changeset
   229
    let val execs' = Inttab.update_new (exec_id, exec) execs
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   230
      handle Inttab.DUP dup => err_dup "command execution" dup
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   231
    in (versions, commands, execs', execution) end);
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   232
44197
458573968568 refined Document.edit: less stateful update via Graph.schedule;
wenzelm
parents: 44196
diff changeset
   233
fun the_exec (State {execs, ...}) exec_id =
458573968568 refined Document.edit: less stateful update via Graph.schedule;
wenzelm
parents: 44196
diff changeset
   234
  (case Inttab.lookup execs exec_id of
458573968568 refined Document.edit: less stateful update via Graph.schedule;
wenzelm
parents: 44196
diff changeset
   235
    NONE => err_undef "command execution" exec_id
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   236
  | SOME exec => exec);
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   237
41634
28d94383249c cancel document execution before editing, to improve reactivity on systems with few cores;
wenzelm
parents: 41630
diff changeset
   238
28d94383249c cancel document execution before editing, to improve reactivity on systems with few cores;
wenzelm
parents: 41630
diff changeset
   239
(* document execution *)
28d94383249c cancel document execution before editing, to improve reactivity on systems with few cores;
wenzelm
parents: 41630
diff changeset
   240
44299
061599cb6eb0 refined Future.cancel: explicit future allows to join actual cancellation;
wenzelm
parents: 44271
diff changeset
   241
fun cancel_execution (State {execution, ...}) = Future.cancel_group execution;
41634
28d94383249c cancel document execution before editing, to improve reactivity on systems with few cores;
wenzelm
parents: 41630
diff changeset
   242
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   243
end;
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   244
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   245
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   246
38888
8248cda328de moved Toplevel.run_command to Pure/PIDE/document.ML;
wenzelm
parents: 38873
diff changeset
   247
(* toplevel transactions *)
8248cda328de moved Toplevel.run_command to Pure/PIDE/document.ML;
wenzelm
parents: 38873
diff changeset
   248
8248cda328de moved Toplevel.run_command to Pure/PIDE/document.ML;
wenzelm
parents: 38873
diff changeset
   249
local
8248cda328de moved Toplevel.run_command to Pure/PIDE/document.ML;
wenzelm
parents: 38873
diff changeset
   250
40391
b0dafbfc05b7 explicit "timing" status for toplevel transactions;
wenzelm
parents: 40390
diff changeset
   251
fun timing tr t = Toplevel.status tr (Markup.timing t);
b0dafbfc05b7 explicit "timing" status for toplevel transactions;
wenzelm
parents: 40390
diff changeset
   252
38888
8248cda328de moved Toplevel.run_command to Pure/PIDE/document.ML;
wenzelm
parents: 38873
diff changeset
   253
fun proof_status tr st =
8248cda328de moved Toplevel.run_command to Pure/PIDE/document.ML;
wenzelm
parents: 38873
diff changeset
   254
  (case try Toplevel.proof_of st of
8248cda328de moved Toplevel.run_command to Pure/PIDE/document.ML;
wenzelm
parents: 38873
diff changeset
   255
    SOME prf => Toplevel.status tr (Proof.status_markup prf)
8248cda328de moved Toplevel.run_command to Pure/PIDE/document.ML;
wenzelm
parents: 38873
diff changeset
   256
  | NONE => ());
8248cda328de moved Toplevel.run_command to Pure/PIDE/document.ML;
wenzelm
parents: 38873
diff changeset
   257
8248cda328de moved Toplevel.run_command to Pure/PIDE/document.ML;
wenzelm
parents: 38873
diff changeset
   258
fun async_state tr st =
44302
wenzelm
parents: 44301
diff changeset
   259
  (singleton o Future.forks)
wenzelm
parents: 44301
diff changeset
   260
    {name = "Document.async_state", group = SOME (Future.new_group NONE),
wenzelm
parents: 44301
diff changeset
   261
      deps = [], pri = 0, interrupts = true}
wenzelm
parents: 44301
diff changeset
   262
    (fn () =>
wenzelm
parents: 44301
diff changeset
   263
      Toplevel.setmp_thread_position tr
wenzelm
parents: 44301
diff changeset
   264
        (fn () => Toplevel.print_state false st) ())
wenzelm
parents: 44301
diff changeset
   265
  |> ignore;
38888
8248cda328de moved Toplevel.run_command to Pure/PIDE/document.ML;
wenzelm
parents: 38873
diff changeset
   266
40390
wenzelm
parents: 39391
diff changeset
   267
fun run int tr st =
wenzelm
parents: 39391
diff changeset
   268
  (case Toplevel.transition int tr st of
wenzelm
parents: 39391
diff changeset
   269
    SOME (st', NONE) => ([], SOME st')
44271
89f40a5939b2 more precise treatment of exception nesting and serial numbers;
wenzelm
parents: 44270
diff changeset
   270
  | SOME (_, SOME (exn, _)) =>
89f40a5939b2 more precise treatment of exception nesting and serial numbers;
wenzelm
parents: 44270
diff changeset
   271
      (case ML_Compiler.exn_messages exn of
40390
wenzelm
parents: 39391
diff changeset
   272
        [] => Exn.interrupt ()
wenzelm
parents: 39391
diff changeset
   273
      | errs => (errs, NONE))
44270
3eaad39e520c more careful treatment of exception serial numbers, with propagation to message channel;
wenzelm
parents: 44247
diff changeset
   274
  | NONE => ([(serial (), ML_Compiler.exn_message Runtime.TERMINATE)], NONE));
40390
wenzelm
parents: 39391
diff changeset
   275
38888
8248cda328de moved Toplevel.run_command to Pure/PIDE/document.ML;
wenzelm
parents: 38873
diff changeset
   276
in
8248cda328de moved Toplevel.run_command to Pure/PIDE/document.ML;
wenzelm
parents: 38873
diff changeset
   277
44199
e38885e3ea60 retrieve imports from document state, with fall-back on theory loader for preloaded theories;
wenzelm
parents: 44198
diff changeset
   278
fun run_command tr st =
44185
05641edb5d30 provide node header via Scala layer;
wenzelm
parents: 44182
diff changeset
   279
  let
44199
e38885e3ea60 retrieve imports from document state, with fall-back on theory loader for preloaded theories;
wenzelm
parents: 44198
diff changeset
   280
    val is_init = Toplevel.is_init tr;
44185
05641edb5d30 provide node header via Scala layer;
wenzelm
parents: 44182
diff changeset
   281
    val is_proof = Keyword.is_proof (Toplevel.name_of tr);
05641edb5d30 provide node header via Scala layer;
wenzelm
parents: 44182
diff changeset
   282
    val do_print = not is_init andalso (Toplevel.print_of tr orelse is_proof);
05641edb5d30 provide node header via Scala layer;
wenzelm
parents: 44182
diff changeset
   283
05641edb5d30 provide node header via Scala layer;
wenzelm
parents: 44182
diff changeset
   284
    val start = Timing.start ();
05641edb5d30 provide node header via Scala layer;
wenzelm
parents: 44182
diff changeset
   285
    val (errs, result) =
05641edb5d30 provide node header via Scala layer;
wenzelm
parents: 44182
diff changeset
   286
      if Toplevel.is_toplevel st andalso not is_init then ([], SOME st)
05641edb5d30 provide node header via Scala layer;
wenzelm
parents: 44182
diff changeset
   287
      else run (is_init orelse is_proof) (Toplevel.set_print false tr) st;
05641edb5d30 provide node header via Scala layer;
wenzelm
parents: 44182
diff changeset
   288
    val _ = timing tr (Timing.result start);
05641edb5d30 provide node header via Scala layer;
wenzelm
parents: 44182
diff changeset
   289
    val _ = List.app (Toplevel.error_msg tr) errs;
05641edb5d30 provide node header via Scala layer;
wenzelm
parents: 44182
diff changeset
   290
  in
05641edb5d30 provide node header via Scala layer;
wenzelm
parents: 44182
diff changeset
   291
    (case result of
44196
3588f71abb50 simplified exec: eliminated unused status flag;
wenzelm
parents: 44186
diff changeset
   292
      NONE => (Toplevel.status tr Markup.failed; st)
44185
05641edb5d30 provide node header via Scala layer;
wenzelm
parents: 44182
diff changeset
   293
    | SOME st' =>
05641edb5d30 provide node header via Scala layer;
wenzelm
parents: 44182
diff changeset
   294
       (Toplevel.status tr Markup.finished;
05641edb5d30 provide node header via Scala layer;
wenzelm
parents: 44182
diff changeset
   295
        proof_status tr st';
05641edb5d30 provide node header via Scala layer;
wenzelm
parents: 44182
diff changeset
   296
        if do_print then async_state tr st' else ();
44196
3588f71abb50 simplified exec: eliminated unused status flag;
wenzelm
parents: 44186
diff changeset
   297
        st'))
44185
05641edb5d30 provide node header via Scala layer;
wenzelm
parents: 44182
diff changeset
   298
  end;
38888
8248cda328de moved Toplevel.run_command to Pure/PIDE/document.ML;
wenzelm
parents: 38873
diff changeset
   299
8248cda328de moved Toplevel.run_command to Pure/PIDE/document.ML;
wenzelm
parents: 38873
diff changeset
   300
end;
8248cda328de moved Toplevel.run_command to Pure/PIDE/document.ML;
wenzelm
parents: 38873
diff changeset
   301
8248cda328de moved Toplevel.run_command to Pure/PIDE/document.ML;
wenzelm
parents: 38873
diff changeset
   302
8248cda328de moved Toplevel.run_command to Pure/PIDE/document.ML;
wenzelm
parents: 38873
diff changeset
   303
8248cda328de moved Toplevel.run_command to Pure/PIDE/document.ML;
wenzelm
parents: 38873
diff changeset
   304
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   305
(** editing **)
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   306
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   307
(* edit *)
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   308
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   309
local
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   310
38448
62d16c415019 added functor Linear_Set, based on former adhoc structures in document.ML;
wenzelm
parents: 38421
diff changeset
   311
fun is_changed node' ((_, id), exec) =
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   312
  (case try (the_entry node') id of
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   313
    NONE => true
38448
62d16c415019 added functor Linear_Set, based on former adhoc structures in document.ML;
wenzelm
parents: 38421
diff changeset
   314
  | SOME exec' => exec' <> exec);
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   315
44199
e38885e3ea60 retrieve imports from document state, with fall-back on theory loader for preloaded theories;
wenzelm
parents: 44198
diff changeset
   316
fun new_exec (command_id, command) (assigns, execs, exec) =
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   317
  let
38419
f9dc924e54f8 renamed create_id to new_id;
wenzelm
parents: 38418
diff changeset
   318
    val exec_id' = new_id ();
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   319
    val exec' =
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   320
      Lazy.lazy (fn () =>
40398
cdda2847a91e continue after failed commands;
wenzelm
parents: 40391
diff changeset
   321
        let
44198
a41ea419de68 explicit check of finished evaluation;
wenzelm
parents: 44197
diff changeset
   322
          val tr = Toplevel.put_id (print_id exec_id') (Future.get_finished command);
a41ea419de68 explicit check of finished evaluation;
wenzelm
parents: 44197
diff changeset
   323
          val st = Lazy.get_finished exec;
44199
e38885e3ea60 retrieve imports from document state, with fall-back on theory loader for preloaded theories;
wenzelm
parents: 44198
diff changeset
   324
        in run_command tr st end);
44197
458573968568 refined Document.edit: less stateful update via Graph.schedule;
wenzelm
parents: 44196
diff changeset
   325
  in ((command_id, exec_id') :: assigns, (exec_id', exec') :: execs, exec') end;
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   326
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   327
in
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   328
44157
a21d3e1e64fd uniform treatment of header edits as document edits;
wenzelm
parents: 44156
diff changeset
   329
fun edit (old_id: version_id) (new_id: version_id) edits state =
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   330
  let
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   331
    val old_version = the_version state old_id;
44180
a6dc270d3edb maintain node header;
wenzelm
parents: 44160
diff changeset
   332
    val _ = Time.now ();  (* FIXME odd workaround for polyml-5.4.0/x86_64 *)
44222
9d5ef6cd4ee1 use full .thy file name as node name, which makes MiscUtilities.resolveSymlinks/File.getCanonicalPath more predictable;
wenzelm
parents: 44202
diff changeset
   333
    val new_version = fold edit_nodes edits old_version;
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   334
44197
458573968568 refined Document.edit: less stateful update via Graph.schedule;
wenzelm
parents: 44196
diff changeset
   335
    val updates =
458573968568 refined Document.edit: less stateful update via Graph.schedule;
wenzelm
parents: 44196
diff changeset
   336
      nodes_of new_version |> Graph.schedule
44199
e38885e3ea60 retrieve imports from document state, with fall-back on theory loader for preloaded theories;
wenzelm
parents: 44198
diff changeset
   337
        (fn deps => fn (name, node) =>
44197
458573968568 refined Document.edit: less stateful update via Graph.schedule;
wenzelm
parents: 44196
diff changeset
   338
          (case first_entry NONE (is_changed (node_of old_version name)) node of
44201
6429ab1b6883 parellel scheduling of node edits and execution;
wenzelm
parents: 44200
diff changeset
   339
            NONE => Future.value (([], [], []), node)
44197
458573968568 refined Document.edit: less stateful update via Graph.schedule;
wenzelm
parents: 44196
diff changeset
   340
          | SOME ((prev, id), _) =>
458573968568 refined Document.edit: less stateful update via Graph.schedule;
wenzelm
parents: 44196
diff changeset
   341
              let
44199
e38885e3ea60 retrieve imports from document state, with fall-back on theory loader for preloaded theories;
wenzelm
parents: 44198
diff changeset
   342
                fun init () =
e38885e3ea60 retrieve imports from document state, with fall-back on theory loader for preloaded theories;
wenzelm
parents: 44198
diff changeset
   343
                  let
e38885e3ea60 retrieve imports from document state, with fall-back on theory loader for preloaded theories;
wenzelm
parents: 44198
diff changeset
   344
                    val (thy_name, imports, uses) = Exn.release (get_header node);
e38885e3ea60 retrieve imports from document state, with fall-back on theory loader for preloaded theories;
wenzelm
parents: 44198
diff changeset
   345
                    (* FIXME provide files via Scala layer *)
44226
1ea760da0f2d workaround for Cygwin, to make it work in the important special case without extra files;
wenzelm
parents: 44223
diff changeset
   346
                    val (dir, files) =
1ea760da0f2d workaround for Cygwin, to make it work in the important special case without extra files;
wenzelm
parents: 44223
diff changeset
   347
                      if ML_System.platform_is_cygwin then (Path.current, [])
1ea760da0f2d workaround for Cygwin, to make it work in the important special case without extra files;
wenzelm
parents: 44223
diff changeset
   348
                      else (Path.dir (Path.explode name), map (apfst Path.explode) uses);
44199
e38885e3ea60 retrieve imports from document state, with fall-back on theory loader for preloaded theories;
wenzelm
parents: 44198
diff changeset
   349
e38885e3ea60 retrieve imports from document state, with fall-back on theory loader for preloaded theories;
wenzelm
parents: 44198
diff changeset
   350
                    val parents =
e38885e3ea60 retrieve imports from document state, with fall-back on theory loader for preloaded theories;
wenzelm
parents: 44198
diff changeset
   351
                      imports |> map (fn import =>
44222
9d5ef6cd4ee1 use full .thy file name as node name, which makes MiscUtilities.resolveSymlinks/File.getCanonicalPath more predictable;
wenzelm
parents: 44202
diff changeset
   352
                        (case Thy_Info.lookup_theory import of
9d5ef6cd4ee1 use full .thy file name as node name, which makes MiscUtilities.resolveSymlinks/File.getCanonicalPath more predictable;
wenzelm
parents: 44202
diff changeset
   353
                          SOME thy => thy
9d5ef6cd4ee1 use full .thy file name as node name, which makes MiscUtilities.resolveSymlinks/File.getCanonicalPath more predictable;
wenzelm
parents: 44202
diff changeset
   354
                        | NONE =>
9d5ef6cd4ee1 use full .thy file name as node name, which makes MiscUtilities.resolveSymlinks/File.getCanonicalPath more predictable;
wenzelm
parents: 44202
diff changeset
   355
                            get_theory (Position.file_only import)
9d5ef6cd4ee1 use full .thy file name as node name, which makes MiscUtilities.resolveSymlinks/File.getCanonicalPath more predictable;
wenzelm
parents: 44202
diff changeset
   356
                              (#2 (Future.join (the (AList.lookup (op =) deps import))))));
44199
e38885e3ea60 retrieve imports from document state, with fall-back on theory loader for preloaded theories;
wenzelm
parents: 44198
diff changeset
   357
                  in Thy_Load.begin_theory dir thy_name imports files parents end
e38885e3ea60 retrieve imports from document state, with fall-back on theory loader for preloaded theories;
wenzelm
parents: 44198
diff changeset
   358
                fun get_command id =
e38885e3ea60 retrieve imports from document state, with fall-back on theory loader for preloaded theories;
wenzelm
parents: 44198
diff changeset
   359
                  (id, the_command state id |> Future.map (Toplevel.modify_init init));
44201
6429ab1b6883 parellel scheduling of node edits and execution;
wenzelm
parents: 44200
diff changeset
   360
              in
44302
wenzelm
parents: 44301
diff changeset
   361
                (singleton o Future.forks)
wenzelm
parents: 44301
diff changeset
   362
                  {name = "Document.edit", group = NONE,
wenzelm
parents: 44301
diff changeset
   363
                    deps = map (Future.task_of o #2) deps, pri = 2, interrupts = false}
44201
6429ab1b6883 parellel scheduling of node edits and execution;
wenzelm
parents: 44200
diff changeset
   364
                  (fn () =>
6429ab1b6883 parellel scheduling of node edits and execution;
wenzelm
parents: 44200
diff changeset
   365
                    let
6429ab1b6883 parellel scheduling of node edits and execution;
wenzelm
parents: 44200
diff changeset
   366
                      val prev_exec =
6429ab1b6883 parellel scheduling of node edits and execution;
wenzelm
parents: 44200
diff changeset
   367
                        (case prev of
6429ab1b6883 parellel scheduling of node edits and execution;
wenzelm
parents: 44200
diff changeset
   368
                          NONE => no_id
6429ab1b6883 parellel scheduling of node edits and execution;
wenzelm
parents: 44200
diff changeset
   369
                        | SOME prev_id => the_default no_id (the_entry node prev_id));
6429ab1b6883 parellel scheduling of node edits and execution;
wenzelm
parents: 44200
diff changeset
   370
                      val (assigns, execs, result) =
6429ab1b6883 parellel scheduling of node edits and execution;
wenzelm
parents: 44200
diff changeset
   371
                        fold_entries (SOME id) (new_exec o get_command o #2 o #1)
6429ab1b6883 parellel scheduling of node edits and execution;
wenzelm
parents: 44200
diff changeset
   372
                          node ([], [], the_exec state prev_exec);
6429ab1b6883 parellel scheduling of node edits and execution;
wenzelm
parents: 44200
diff changeset
   373
                      val node' = node
6429ab1b6883 parellel scheduling of node edits and execution;
wenzelm
parents: 44200
diff changeset
   374
                        |> fold update_entry assigns
6429ab1b6883 parellel scheduling of node edits and execution;
wenzelm
parents: 44200
diff changeset
   375
                        |> set_result result;
6429ab1b6883 parellel scheduling of node edits and execution;
wenzelm
parents: 44200
diff changeset
   376
                    in ((assigns, execs, [(name, node')]), node') end)
6429ab1b6883 parellel scheduling of node edits and execution;
wenzelm
parents: 44200
diff changeset
   377
              end))
44330
b28e091f683a added Future.joins convenience;
wenzelm
parents: 44302
diff changeset
   378
      |> Future.joins |> map #1;
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   379
44197
458573968568 refined Document.edit: less stateful update via Graph.schedule;
wenzelm
parents: 44196
diff changeset
   380
    val state' = state
458573968568 refined Document.edit: less stateful update via Graph.schedule;
wenzelm
parents: 44196
diff changeset
   381
      |> fold (fold define_exec o #2) updates
458573968568 refined Document.edit: less stateful update via Graph.schedule;
wenzelm
parents: 44196
diff changeset
   382
      |> define_version new_id (fold (fold put_node o #3) updates new_version);
38421
6cfc6fce7bfb document commands: maintain transition as future (wrt. potentially slow Outer_Syntax.prepare_command), refrain from second Toplevel.put_id;
wenzelm
parents: 38419
diff changeset
   383
44197
458573968568 refined Document.edit: less stateful update via Graph.schedule;
wenzelm
parents: 44196
diff changeset
   384
  in (maps #1 (rev updates), state') end;
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   385
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   386
end;
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   387
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   388
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   389
(* execute *)
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   390
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   391
fun execute version_id state =
41673
1c191a39549f support named tasks, for improved tracing;
wenzelm
parents: 41672
diff changeset
   392
  state |> map_state (fn (versions, commands, execs, _) =>
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   393
    let
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   394
      val version = the_version state version_id;
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   395
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   396
      fun force_exec NONE = ()
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   397
        | force_exec (SOME exec_id) = ignore (Lazy.force (the_exec state exec_id));
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   398
44300
349cc426d929 tuned signature -- treat structure Task_Queue as private to implementation;
wenzelm
parents: 44299
diff changeset
   399
      val execution = Future.new_group NONE;
44299
061599cb6eb0 refined Future.cancel: explicit future allows to join actual cancellation;
wenzelm
parents: 44271
diff changeset
   400
      val _ =
44201
6429ab1b6883 parellel scheduling of node edits and execution;
wenzelm
parents: 44200
diff changeset
   401
        nodes_of version |> Graph.schedule
6429ab1b6883 parellel scheduling of node edits and execution;
wenzelm
parents: 44200
diff changeset
   402
          (fn deps => fn (name, node) =>
44302
wenzelm
parents: 44301
diff changeset
   403
            (singleton o Future.forks)
wenzelm
parents: 44301
diff changeset
   404
              {name = "theory:" ^ name, group = SOME (Future.new_group (SOME execution)),
wenzelm
parents: 44301
diff changeset
   405
                deps = map (Future.task_of o #2) deps, pri = 1, interrupts = true}
44201
6429ab1b6883 parellel scheduling of node edits and execution;
wenzelm
parents: 44200
diff changeset
   406
              (fold_entries NONE (fn (_, exec) => fn () => force_exec exec) node));
40520
77a7b0a7d4b1 await_cancellation in the main thread, independently of the execution futures, which might get interrupted or be absent after node deletetion;
wenzelm
parents: 40481
diff changeset
   407
44299
061599cb6eb0 refined Future.cancel: explicit future allows to join actual cancellation;
wenzelm
parents: 44271
diff changeset
   408
    in (versions, commands, execs, execution) end);
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   409
43713
1ba5331b4623 moved global state to structure Document (again);
wenzelm
parents: 43668
diff changeset
   410
1ba5331b4623 moved global state to structure Document (again);
wenzelm
parents: 43668
diff changeset
   411
1ba5331b4623 moved global state to structure Document (again);
wenzelm
parents: 43668
diff changeset
   412
(** global state **)
1ba5331b4623 moved global state to structure Document (again);
wenzelm
parents: 43668
diff changeset
   413
1ba5331b4623 moved global state to structure Document (again);
wenzelm
parents: 43668
diff changeset
   414
val global_state = Synchronized.var "Document" init_state;
1ba5331b4623 moved global state to structure Document (again);
wenzelm
parents: 43668
diff changeset
   415
1ba5331b4623 moved global state to structure Document (again);
wenzelm
parents: 43668
diff changeset
   416
fun state () = Synchronized.value global_state;
1ba5331b4623 moved global state to structure Document (again);
wenzelm
parents: 43668
diff changeset
   417
val change_state = Synchronized.change global_state;
1ba5331b4623 moved global state to structure Document (again);
wenzelm
parents: 43668
diff changeset
   418
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   419
end;
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38414
diff changeset
   420