src/Pure/PIDE/document.ML
author wenzelm
Tue Aug 16 21:13:52 2011 +0200 (2011-08-16)
changeset 44222 9d5ef6cd4ee1
parent 44202 44c4ae5c5ce2
child 44223 cac52579f2c2
permissions -rw-r--r--
use full .thy file name as node name, which makes MiscUtilities.resolveSymlinks/File.getCanonicalPath more predictable;
more robust treatment of node dependencies;
misc tuning;
     1 (*  Title:      Pure/PIDE/document.ML
     2     Author:     Makarius
     3 
     4 Document as collection of named nodes, each consisting of an editable
     5 list of commands, associated with asynchronous execution process.
     6 *)
     7 
     8 signature DOCUMENT =
     9 sig
    10   type id = int
    11   type version_id = id
    12   type command_id = id
    13   type exec_id = id
    14   val no_id: id
    15   val new_id: unit -> id
    16   val parse_id: string -> id
    17   val print_id: id -> string
    18   type node_header = (string * string list * (string * bool) list) Exn.result
    19   datatype node_edit =
    20     Clear |
    21     Edits of (command_id option * command_id option) list |
    22     Header of node_header
    23   type edit = string * node_edit
    24   type state
    25   val init_state: state
    26   val join_commands: state -> unit
    27   val cancel_execution: state -> unit -> unit
    28   val define_command: command_id -> string -> state -> state
    29   val edit: version_id -> version_id -> edit list -> state -> (command_id * exec_id) list * state
    30   val execute: version_id -> state -> state
    31   val state: unit -> state
    32   val change_state: (state -> state) -> unit
    33 end;
    34 
    35 structure Document: DOCUMENT =
    36 struct
    37 
    38 (* unique identifiers *)
    39 
    40 type id = int;
    41 type version_id = id;
    42 type command_id = id;
    43 type exec_id = id;
    44 
    45 val no_id = 0;
    46 val new_id = Synchronized.counter ();
    47 
    48 val parse_id = Markup.parse_int;
    49 val print_id = Markup.print_int;
    50 
    51 fun err_dup kind id = error ("Duplicate " ^ kind ^ ": " ^ print_id id);
    52 fun err_undef kind id = error ("Undefined " ^ kind ^ ": " ^ print_id id);
    53 
    54 
    55 
    56 (** document structure **)
    57 
    58 type node_header = (string * string list * (string * bool) list) Exn.result;
    59 structure Entries = Linear_Set(type key = command_id val ord = int_ord);
    60 
    61 abstype node = Node of
    62  {header: node_header,
    63   entries: exec_id option Entries.T,  (*command entries with excecutions*)
    64   result: Toplevel.state lazy}
    65 and version = Version of node Graph.T  (*development graph wrt. static imports*)
    66 with
    67 
    68 fun make_node (header, entries, result) =
    69   Node {header = header, entries = entries, result = result};
    70 
    71 fun map_node f (Node {header, entries, result}) =
    72   make_node (f (header, entries, result));
    73 
    74 fun get_header (Node {header, ...}) = header;
    75 fun set_header header = map_node (fn (_, entries, result) => (header, entries, result));
    76 
    77 fun map_entries f (Node {header, entries, result}) = make_node (header, f entries, result);
    78 fun fold_entries start f (Node {entries, ...}) = Entries.fold start f entries;
    79 fun first_entry start P (Node {entries, ...}) = Entries.get_first start P entries;
    80 
    81 fun get_theory pos (Node {result, ...}) = Toplevel.end_theory pos (Lazy.get_finished result);
    82 fun set_result result = map_node (fn (header, entries, _) => (header, entries, result));
    83 
    84 val empty_exec = Lazy.value Toplevel.toplevel;
    85 val empty_node = make_node (Exn.Exn (ERROR "Bad theory header"), Entries.empty, empty_exec);
    86 val clear_node = map_node (fn (header, _, _) => (header, Entries.empty, empty_exec));
    87 
    88 fun get_node nodes name = Graph.get_node nodes name handle Graph.UNDEF _ => empty_node;
    89 fun remove_node name nodes = Graph.del_node name nodes handle Graph.UNDEF _ => nodes;
    90 fun default_node name = Graph.default_node (name, empty_node);
    91 fun update_node name f = default_node name #> Graph.map_node name f;
    92 
    93 
    94 (* node edits and associated executions *)
    95 
    96 datatype node_edit =
    97   Clear |
    98   Edits of (command_id option * command_id option) list |
    99   Header of node_header;
   100 
   101 type edit = string * node_edit;
   102 
   103 fun the_entry (Node {entries, ...}) id =
   104   (case Entries.lookup entries id of
   105     NONE => err_undef "command entry" id
   106   | SOME entry => entry);
   107 
   108 fun update_entry (id, exec_id) =
   109   map_entries (Entries.update (id, SOME exec_id));
   110 
   111 fun reset_after id entries =
   112   (case Entries.get_after entries id of
   113     NONE => entries
   114   | SOME next => Entries.update (next, NONE) entries);
   115 
   116 val edit_node = map_entries o fold
   117   (fn (id, SOME id2) => Entries.insert_after id (id2, NONE)
   118     | (id, NONE) => Entries.delete_after id #> reset_after id);
   119 
   120 
   121 (* version operations *)
   122 
   123 val empty_version = Version Graph.empty;
   124 
   125 fun nodes_of (Version nodes) = nodes;
   126 val node_of = get_node o nodes_of;
   127 
   128 fun cycle_msg names = "Cyclic dependency of " ^ space_implode " via " (map quote names);
   129 
   130 fun touch_descendants name nodes =
   131   fold (fn desc => desc <> name ? update_node desc (map_entries (reset_after NONE)))
   132     (Graph.all_succs nodes [name]) nodes;
   133 
   134 fun edit_nodes (name, node_edit) (Version nodes) =
   135   Version
   136     (touch_descendants name
   137       (case node_edit of
   138         Clear => update_node name clear_node nodes
   139       | Edits edits =>
   140           nodes
   141           |> update_node name (edit_node edits)
   142       | Header header =>
   143           let
   144             val node = get_node nodes name;
   145             val nodes1 = Graph.new_node (name, node) (remove_node name nodes);
   146             val parents = (case header of Exn.Res (_, parents, _) => parents | _ => []);
   147             val nodes2 = fold default_node parents nodes1;
   148             val (header', nodes3) =
   149               (header, Graph.add_deps_acyclic (name, parents) nodes2)
   150                 handle Graph.CYCLES cs => (Exn.Exn (ERROR (cat_lines (map cycle_msg cs))), nodes2);
   151           in Graph.map_node name (set_header header') nodes3 end));
   152 
   153 fun put_node (name, node) (Version nodes) =
   154   Version (update_node name (K node) nodes);
   155 
   156 end;
   157 
   158 
   159 
   160 (** global state -- document structure and execution process **)
   161 
   162 abstype state = State of
   163  {versions: version Inttab.table,  (*version_id -> document content*)
   164   commands: Toplevel.transition future Inttab.table,  (*command_id -> transition (future parsing)*)
   165   execs: Toplevel.state lazy Inttab.table,  (*exec_id -> execution process*)
   166   execution: unit future list}  (*global execution process*)
   167 with
   168 
   169 fun make_state (versions, commands, execs, execution) =
   170   State {versions = versions, commands = commands, execs = execs, execution = execution};
   171 
   172 fun map_state f (State {versions, commands, execs, execution}) =
   173   make_state (f (versions, commands, execs, execution));
   174 
   175 val init_state =
   176   make_state (Inttab.make [(no_id, empty_version)],
   177     Inttab.make [(no_id, Future.value Toplevel.empty)],
   178     Inttab.make [(no_id, empty_exec)],
   179     []);
   180 
   181 
   182 (* document versions *)
   183 
   184 fun define_version (id: version_id) version =
   185   map_state (fn (versions, commands, execs, execution) =>
   186     let val versions' = Inttab.update_new (id, version) versions
   187       handle Inttab.DUP dup => err_dup "document version" dup
   188     in (versions', commands, execs, execution) end);
   189 
   190 fun the_version (State {versions, ...}) (id: version_id) =
   191   (case Inttab.lookup versions id of
   192     NONE => err_undef "document version" id
   193   | SOME version => version);
   194 
   195 
   196 (* commands *)
   197 
   198 fun define_command (id: command_id) text =
   199   map_state (fn (versions, commands, execs, execution) =>
   200     let
   201       val id_string = print_id id;
   202       val tr = Future.fork_pri 2 (fn () =>
   203         Position.setmp_thread_data (Position.id_only id_string)
   204           (fn () => Outer_Syntax.prepare_command (Position.id id_string) text) ());
   205       val commands' =
   206         Inttab.update_new (id, tr) commands
   207           handle Inttab.DUP dup => err_dup "command" dup;
   208     in (versions, commands', execs, execution) end);
   209 
   210 fun the_command (State {commands, ...}) (id: command_id) =
   211   (case Inttab.lookup commands id of
   212     NONE => err_undef "command" id
   213   | SOME tr => tr);
   214 
   215 fun join_commands (State {commands, ...}) =
   216   Inttab.fold (fn (_, tr) => fn () => ignore (Future.join_result tr)) commands ();
   217 
   218 
   219 (* command executions *)
   220 
   221 fun define_exec (exec_id, exec) =
   222   map_state (fn (versions, commands, execs, execution) =>
   223     let val execs' = Inttab.update_new (exec_id, exec) execs
   224       handle Inttab.DUP dup => err_dup "command execution" dup
   225     in (versions, commands, execs', execution) end);
   226 
   227 fun the_exec (State {execs, ...}) exec_id =
   228   (case Inttab.lookup execs exec_id of
   229     NONE => err_undef "command execution" exec_id
   230   | SOME exec => exec);
   231 
   232 
   233 (* document execution *)
   234 
   235 fun cancel_execution (State {execution, ...}) =
   236   (List.app Future.cancel execution;
   237     fn () => ignore (Future.join_results execution));
   238 
   239 end;
   240 
   241 
   242 
   243 (* toplevel transactions *)
   244 
   245 local
   246 
   247 fun timing tr t = Toplevel.status tr (Markup.timing t);
   248 
   249 fun proof_status tr st =
   250   (case try Toplevel.proof_of st of
   251     SOME prf => Toplevel.status tr (Proof.status_markup prf)
   252   | NONE => ());
   253 
   254 fun async_state tr st =
   255   ignore
   256     (singleton
   257       (Future.forks {name = "Document.async_state",
   258         group = SOME (Task_Queue.new_group NONE), deps = [], pri = 0, interrupts = true})
   259       (fn () =>
   260         Toplevel.setmp_thread_position tr
   261           (fn () => Toplevel.print_state false st) ()));
   262 
   263 fun run int tr st =
   264   (case Toplevel.transition int tr st of
   265     SOME (st', NONE) => ([], SOME st')
   266   | SOME (_, SOME exn_info) =>
   267       (case ML_Compiler.exn_messages (Runtime.EXCURSION_FAIL exn_info) of
   268         [] => Exn.interrupt ()
   269       | errs => (errs, NONE))
   270   | NONE => ([ML_Compiler.exn_message Runtime.TERMINATE], NONE));
   271 
   272 in
   273 
   274 fun run_command tr st =
   275   let
   276     val is_init = Toplevel.is_init tr;
   277     val is_proof = Keyword.is_proof (Toplevel.name_of tr);
   278     val do_print = not is_init andalso (Toplevel.print_of tr orelse is_proof);
   279 
   280     val start = Timing.start ();
   281     val (errs, result) =
   282       if Toplevel.is_toplevel st andalso not is_init then ([], SOME st)
   283       else run (is_init orelse is_proof) (Toplevel.set_print false tr) st;
   284     val _ = timing tr (Timing.result start);
   285     val _ = List.app (Toplevel.error_msg tr) errs;
   286   in
   287     (case result of
   288       NONE => (Toplevel.status tr Markup.failed; st)
   289     | SOME st' =>
   290        (Toplevel.status tr Markup.finished;
   291         proof_status tr st';
   292         if do_print then async_state tr st' else ();
   293         st'))
   294   end;
   295 
   296 end;
   297 
   298 
   299 
   300 
   301 (** editing **)
   302 
   303 (* edit *)
   304 
   305 local
   306 
   307 fun is_changed node' ((_, id), exec) =
   308   (case try (the_entry node') id of
   309     NONE => true
   310   | SOME exec' => exec' <> exec);
   311 
   312 fun new_exec (command_id, command) (assigns, execs, exec) =
   313   let
   314     val exec_id' = new_id ();
   315     val exec' =
   316       Lazy.lazy (fn () =>
   317         let
   318           val tr = Toplevel.put_id (print_id exec_id') (Future.get_finished command);
   319           val st = Lazy.get_finished exec;
   320         in run_command tr st end);
   321   in ((command_id, exec_id') :: assigns, (exec_id', exec') :: execs, exec') end;
   322 
   323 in
   324 
   325 fun edit (old_id: version_id) (new_id: version_id) edits state =
   326   let
   327     val old_version = the_version state old_id;
   328     val _ = Time.now ();  (* FIXME odd workaround for polyml-5.4.0/x86_64 *)
   329     val new_version = fold edit_nodes edits old_version;
   330 
   331     val updates =
   332       nodes_of new_version |> Graph.schedule
   333         (fn deps => fn (name, node) =>
   334           (case first_entry NONE (is_changed (node_of old_version name)) node of
   335             NONE => Future.value (([], [], []), node)
   336           | SOME ((prev, id), _) =>
   337               let
   338                 fun init () =
   339                   let
   340                     val (thy_name, imports, uses) = Exn.release (get_header node);
   341                     (* FIXME provide files via Scala layer *)
   342                     val dir = Path.dir (Path.explode name);
   343                     val files = map (apfst Path.explode) uses;
   344 
   345                     val parents =
   346                       imports |> map (fn import =>
   347                         (case Thy_Info.lookup_theory import of
   348                           SOME thy => thy
   349                         | NONE =>
   350                             get_theory (Position.file_only import)
   351                               (#2 (Future.join (the (AList.lookup (op =) deps import))))));
   352                   in Thy_Load.begin_theory dir thy_name imports files parents end
   353                 fun get_command id =
   354                   (id, the_command state id |> Future.map (Toplevel.modify_init init));
   355               in
   356                 singleton
   357                   (Future.forks {name = "Document.edit", group = NONE,
   358                     deps = map (Future.task_of o #2) deps, pri = 2, interrupts = false})
   359                   (fn () =>
   360                     let
   361                       val prev_exec =
   362                         (case prev of
   363                           NONE => no_id
   364                         | SOME prev_id => the_default no_id (the_entry node prev_id));
   365                       val (assigns, execs, result) =
   366                         fold_entries (SOME id) (new_exec o get_command o #2 o #1)
   367                           node ([], [], the_exec state prev_exec);
   368                       val node' = node
   369                         |> fold update_entry assigns
   370                         |> set_result result;
   371                     in ((assigns, execs, [(name, node')]), node') end)
   372               end))
   373       |> Future.join_results |> Exn.release_all |> map #1;
   374 
   375     val state' = state
   376       |> fold (fold define_exec o #2) updates
   377       |> define_version new_id (fold (fold put_node o #3) updates new_version);
   378 
   379   in (maps #1 (rev updates), state') end;
   380 
   381 end;
   382 
   383 
   384 (* execute *)
   385 
   386 fun execute version_id state =
   387   state |> map_state (fn (versions, commands, execs, _) =>
   388     let
   389       val version = the_version state version_id;
   390 
   391       fun force_exec NONE = ()
   392         | force_exec (SOME exec_id) = ignore (Lazy.force (the_exec state exec_id));
   393 
   394       val execution' =
   395         nodes_of version |> Graph.schedule
   396           (fn deps => fn (name, node) =>
   397             singleton
   398               (Future.forks
   399                 {name = "theory:" ^ name, group = NONE,
   400                   deps = map (Future.task_of o #2) deps,
   401                   pri = 1, interrupts = true})
   402               (fold_entries NONE (fn (_, exec) => fn () => force_exec exec) node));
   403 
   404     in (versions, commands, execs, execution') end);
   405 
   406 
   407 
   408 (** global state **)
   409 
   410 val global_state = Synchronized.var "Document" init_state;
   411 
   412 fun state () = Synchronized.value global_state;
   413 val change_state = Synchronized.change global_state;
   414 
   415 end;
   416