src/Pure/PIDE/document.ML
author wenzelm
Mon Aug 15 16:38:42 2011 +0200 (2011-08-15)
changeset 44197 458573968568
parent 44196 3588f71abb50
child 44198 a41ea419de68
permissions -rw-r--r--
refined Document.edit: less stateful update via Graph.schedule;
clarified node result -- more direct get_theory;
clarified Document.joint_commands;
     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.force 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 update_node name f = Graph.default_node (name, empty_node) #> Graph.map_node name f;
    91 
    92 
    93 (* node edits and associated executions *)
    94 
    95 datatype node_edit =
    96   Clear |
    97   Edits of (command_id option * command_id option) list |
    98   Header of node_header;
    99 
   100 type edit = string * node_edit;
   101 
   102 fun the_entry (Node {entries, ...}) id =
   103   (case Entries.lookup entries id of
   104     NONE => err_undef "command entry" id
   105   | SOME entry => entry);
   106 
   107 fun update_entry (id, exec_id) =
   108   map_entries (Entries.update (id, SOME exec_id));
   109 
   110 fun reset_after id entries =
   111   (case Entries.get_after entries id of
   112     NONE => entries
   113   | SOME next => Entries.update (next, NONE) entries);
   114 
   115 val edit_node = map_entries o fold
   116   (fn (id, SOME id2) => Entries.insert_after id (id2, NONE)
   117     | (id, NONE) => Entries.delete_after id #> reset_after id);
   118 
   119 
   120 (* version operations *)
   121 
   122 val empty_version = Version Graph.empty;
   123 
   124 fun nodes_of (Version nodes) = nodes;
   125 val node_of = get_node o nodes_of;
   126 val node_names_of = Graph.keys o nodes_of;
   127 
   128 fun cycle_msg names = "Cyclic dependency of " ^ space_implode " via " (map quote names);
   129 
   130 fun edit_nodes (name, node_edit) (Version nodes) =
   131   Version
   132     (case node_edit of
   133       Clear => update_node name clear_node nodes
   134     | Edits edits => update_node name (edit_node edits) nodes
   135     | Header header =>
   136         let
   137           val node = get_node nodes name;
   138           val nodes' = Graph.new_node (name, node) (remove_node name nodes);
   139           val parents =
   140             (case header of Exn.Res (_, parents, _) => parents | _ => [])
   141             |> filter (can (Graph.get_node nodes'));
   142           val (header', nodes'') =
   143             (header, Graph.add_deps_acyclic (name, parents) nodes')
   144               handle Graph.CYCLES cs => (Exn.Exn (ERROR (cat_lines (map cycle_msg cs))), nodes');
   145         in Graph.map_node name (set_header header') nodes'' end);
   146 
   147 fun put_node (name, node) (Version nodes) =
   148   Version (nodes
   149     |> Graph.default_node (name, empty_node)
   150     |> Graph.map_node name (K node));
   151 
   152 end;
   153 
   154 
   155 
   156 (** global state -- document structure and execution process **)
   157 
   158 abstype state = State of
   159  {versions: version Inttab.table,  (*version_id -> document content*)
   160   commands: Toplevel.transition future Inttab.table,  (*command_id -> transition (future parsing)*)
   161   execs: Toplevel.state lazy Inttab.table,  (*exec_id -> execution process*)
   162   execution: unit future list}  (*global execution process*)
   163 with
   164 
   165 fun make_state (versions, commands, execs, execution) =
   166   State {versions = versions, commands = commands, execs = execs, execution = execution};
   167 
   168 fun map_state f (State {versions, commands, execs, execution}) =
   169   make_state (f (versions, commands, execs, execution));
   170 
   171 val init_state =
   172   make_state (Inttab.make [(no_id, empty_version)],
   173     Inttab.make [(no_id, Future.value Toplevel.empty)],
   174     Inttab.make [(no_id, empty_exec)],
   175     []);
   176 
   177 
   178 (* document versions *)
   179 
   180 fun define_version (id: version_id) version =
   181   map_state (fn (versions, commands, execs, execution) =>
   182     let val versions' = Inttab.update_new (id, version) versions
   183       handle Inttab.DUP dup => err_dup "document version" dup
   184     in (versions', commands, execs, execution) end);
   185 
   186 fun the_version (State {versions, ...}) (id: version_id) =
   187   (case Inttab.lookup versions id of
   188     NONE => err_undef "document version" id
   189   | SOME version => version);
   190 
   191 
   192 (* commands *)
   193 
   194 fun define_command (id: command_id) text =
   195   map_state (fn (versions, commands, execs, execution) =>
   196     let
   197       val id_string = print_id id;
   198       val tr = Future.fork_pri 2 (fn () =>
   199         Position.setmp_thread_data (Position.id_only id_string)
   200           (fn () => Outer_Syntax.prepare_command (Position.id id_string) text) ());
   201       val commands' =
   202         Inttab.update_new (id, tr) commands
   203           handle Inttab.DUP dup => err_dup "command" dup;
   204     in (versions, commands', execs, execution) end);
   205 
   206 fun the_command (State {commands, ...}) (id: command_id) =
   207   (case Inttab.lookup commands id of
   208     NONE => err_undef "command" id
   209   | SOME tr => tr);
   210 
   211 fun join_commands (State {commands, ...}) =
   212   Inttab.fold (fn (_, tr) => fn () => ignore (Future.join_result tr)) commands ();
   213 
   214 
   215 (* command executions *)
   216 
   217 fun define_exec (exec_id, exec) =
   218   map_state (fn (versions, commands, execs, execution) =>
   219     let val execs' = Inttab.update_new (exec_id, exec) execs
   220       handle Inttab.DUP dup => err_dup "command execution" dup
   221     in (versions, commands, execs', execution) end);
   222 
   223 fun the_exec (State {execs, ...}) exec_id =
   224   (case Inttab.lookup execs exec_id of
   225     NONE => err_undef "command execution" exec_id
   226   | SOME exec => exec);
   227 
   228 
   229 (* document execution *)
   230 
   231 fun cancel_execution (State {execution, ...}) =
   232   (List.app Future.cancel execution;
   233     fn () => ignore (Future.join_results execution));
   234 
   235 end;
   236 
   237 
   238 
   239 (* toplevel transactions *)
   240 
   241 local
   242 
   243 fun timing tr t = Toplevel.status tr (Markup.timing t);
   244 
   245 fun proof_status tr st =
   246   (case try Toplevel.proof_of st of
   247     SOME prf => Toplevel.status tr (Proof.status_markup prf)
   248   | NONE => ());
   249 
   250 fun async_state tr st =
   251   ignore
   252     (singleton
   253       (Future.forks {name = "Document.async_state",
   254         group = SOME (Task_Queue.new_group NONE), deps = [], pri = 0, interrupts = true})
   255       (fn () =>
   256         Toplevel.setmp_thread_position tr
   257           (fn () => Toplevel.print_state false st) ()));
   258 
   259 fun run int tr st =
   260   (case Toplevel.transition int tr st of
   261     SOME (st', NONE) => ([], SOME st')
   262   | SOME (_, SOME exn_info) =>
   263       (case ML_Compiler.exn_messages (Runtime.EXCURSION_FAIL exn_info) of
   264         [] => Exn.interrupt ()
   265       | errs => (errs, NONE))
   266   | NONE => ([ML_Compiler.exn_message Runtime.TERMINATE], NONE));
   267 
   268 in
   269 
   270 fun run_command (node_name, node_header) raw_tr st =
   271   let
   272     val is_init = Toplevel.is_init raw_tr;
   273     val tr =
   274       if is_init then
   275         raw_tr |> Toplevel.modify_init (fn () =>
   276           let
   277             (* FIXME get theories from document state *)
   278             (* FIXME provide files via Scala layer *)
   279             val (name, imports, uses) = Exn.release node_header;
   280             val master = Path.dir (Path.explode node_name);
   281           in Thy_Info.toplevel_begin_theory master name imports (map (apfst Path.explode) uses) end)
   282       else raw_tr;
   283 
   284     val is_proof = Keyword.is_proof (Toplevel.name_of tr);
   285     val do_print = not is_init andalso (Toplevel.print_of tr orelse is_proof);
   286 
   287     val start = Timing.start ();
   288     val (errs, result) =
   289       if Toplevel.is_toplevel st andalso not is_init then ([], SOME st)
   290       else run (is_init orelse is_proof) (Toplevel.set_print false tr) st;
   291     val _ = timing tr (Timing.result start);
   292     val _ = List.app (Toplevel.error_msg tr) errs;
   293   in
   294     (case result of
   295       NONE => (Toplevel.status tr Markup.failed; st)
   296     | SOME st' =>
   297        (Toplevel.status tr Markup.finished;
   298         proof_status tr st';
   299         if do_print then async_state tr st' else ();
   300         st'))
   301   end;
   302 
   303 end;
   304 
   305 
   306 
   307 
   308 (** editing **)
   309 
   310 (* edit *)
   311 
   312 local
   313 
   314 fun is_changed node' ((_, id), exec) =
   315   (case try (the_entry node') id of
   316     NONE => true
   317   | SOME exec' => exec' <> exec);
   318 
   319 fun new_exec node_info (command, command_id) (assigns, execs, exec) =
   320   let
   321     val exec_id' = new_id ();
   322     val exec' =
   323       Lazy.lazy (fn () =>
   324         let
   325           val tr = Toplevel.put_id (print_id exec_id') (Future.join command); (* FIXME Future.join_finished !? *)
   326           val st = Lazy.force exec;  (* FIXME Lazy.force_finished !? *)
   327         in run_command node_info tr st end);
   328   in ((command_id, exec_id') :: assigns, (exec_id', exec') :: execs, exec') end;
   329 
   330 in
   331 
   332 fun edit (old_id: version_id) (new_id: version_id) edits state =
   333   let
   334     val old_version = the_version state old_id;
   335     val _ = Time.now ();  (* FIXME odd workaround for polyml-5.4.0/x86_64 *)
   336     val new_version = fold edit_nodes edits old_version;
   337 
   338     (* FIXME futures *)
   339     val updates =
   340       nodes_of new_version |> Graph.schedule
   341         (fn _ => fn (name, node) =>
   342           (case first_entry NONE (is_changed (node_of old_version name)) node of
   343             NONE => (([], [], []), node)
   344           | SOME ((prev, id), _) =>
   345               let
   346                 val prev_exec =
   347                   (case prev of
   348                     NONE => no_id
   349                   | SOME prev_id => the_default no_id (the_entry node prev_id));
   350                 val (assigns, execs, result) =
   351                   fold_entries (SOME id)
   352                     (new_exec (name, get_header node) o `(the_command state) o #2 o #1)
   353                       node ([], [], the_exec state prev_exec);
   354                 val node' = node |> fold update_entry assigns |> set_result result;
   355               in ((assigns, execs, [(name, node')]), node') end))
   356       |> map #1;
   357 
   358     val state' = state
   359       |> fold (fold define_exec o #2) updates
   360       |> define_version new_id (fold (fold put_node o #3) updates new_version);
   361 
   362   in (maps #1 (rev updates), state') end;
   363 
   364 end;
   365 
   366 
   367 (* execute *)
   368 
   369 fun execute version_id state =
   370   state |> map_state (fn (versions, commands, execs, _) =>
   371     let
   372       val version = the_version state version_id;
   373 
   374       fun force_exec NONE = ()
   375         | force_exec (SOME exec_id) = ignore (Lazy.force (the_exec state exec_id));
   376 
   377       val execution' = (* FIXME Graph.schedule *)
   378         Future.forks
   379           {name = "Document.execute", group = NONE, deps = [], pri = 1, interrupts = true}
   380           [fn () =>
   381             node_names_of version |> List.app (fn name =>
   382               fold_entries NONE (fn (_, exec) => fn () => force_exec exec)
   383                   (node_of version name) ())];
   384 
   385     in (versions, commands, execs, execution') end);
   386 
   387 
   388 
   389 (** global state **)
   390 
   391 val global_state = Synchronized.var "Document" init_state;
   392 
   393 fun state () = Synchronized.value global_state;
   394 val change_state = Synchronized.change global_state;
   395 
   396 end;
   397