wenzelm@38150: (* Title: Pure/PIDE/document.ML wenzelm@38150: Author: Makarius wenzelm@38150: wenzelm@38150: Document as collection of named nodes, each consisting of an editable wenzelm@38418: list of commands, associated with asynchronous execution process. wenzelm@38150: *) wenzelm@38150: wenzelm@38150: signature DOCUMENT = wenzelm@38150: sig wenzelm@38363: type id = int wenzelm@38373: type version_id = id wenzelm@38363: type command_id = id wenzelm@38373: type exec_id = id wenzelm@38363: val no_id: id wenzelm@38419: val new_id: unit -> id wenzelm@38363: val parse_id: string -> id wenzelm@38363: val print_id: id -> string wenzelm@44185: type node_header = (string * string list * (string * bool) list) Exn.result wenzelm@44157: datatype node_edit = wenzelm@44185: Clear | wenzelm@44157: Edits of (command_id option * command_id option) list | wenzelm@44182: Header of node_header wenzelm@44156: type edit = string * node_edit wenzelm@38418: type state wenzelm@38418: val init_state: state wenzelm@44197: val join_commands: state -> unit wenzelm@43666: val cancel_execution: state -> unit -> unit wenzelm@38418: val define_command: command_id -> string -> state -> state wenzelm@44157: val edit: version_id -> version_id -> edit list -> state -> (command_id * exec_id) list * state wenzelm@38418: val execute: version_id -> state -> state wenzelm@43713: val state: unit -> state wenzelm@43713: val change_state: (state -> state) -> unit wenzelm@38150: end; wenzelm@38150: wenzelm@38150: structure Document: DOCUMENT = wenzelm@38150: struct wenzelm@38150: wenzelm@38150: (* unique identifiers *) wenzelm@38150: wenzelm@38363: type id = int; wenzelm@38373: type version_id = id; wenzelm@38363: type command_id = id; wenzelm@38373: type exec_id = id; wenzelm@38355: wenzelm@38355: val no_id = 0; wenzelm@40449: val new_id = Synchronized.counter (); wenzelm@38418: wenzelm@38414: val parse_id = Markup.parse_int; wenzelm@38414: val print_id = Markup.print_int; wenzelm@38150: wenzelm@38418: fun err_dup kind id = error ("Duplicate " ^ kind ^ ": " ^ print_id id); wenzelm@38418: fun err_undef kind id = error ("Undefined " ^ kind ^ ": " ^ print_id id); wenzelm@38150: wenzelm@38418: wenzelm@38418: wenzelm@38418: (** document structure **) wenzelm@38418: wenzelm@44185: type node_header = (string * string list * (string * bool) list) Exn.result; wenzelm@38448: structure Entries = Linear_Set(type key = command_id val ord = int_ord); wenzelm@38448: wenzelm@43668: abstype node = Node of wenzelm@44182: {header: node_header, wenzelm@44180: entries: exec_id option Entries.T, (*command entries with excecutions*) wenzelm@44197: result: Toplevel.state lazy} wenzelm@43668: and version = Version of node Graph.T (*development graph wrt. static imports*) wenzelm@38418: with wenzelm@38418: wenzelm@44197: fun make_node (header, entries, result) = wenzelm@44197: Node {header = header, entries = entries, result = result}; wenzelm@43668: wenzelm@44197: fun map_node f (Node {header, entries, result}) = wenzelm@44197: make_node (f (header, entries, result)); wenzelm@38418: wenzelm@44180: fun get_header (Node {header, ...}) = header; wenzelm@44197: fun set_header header = map_node (fn (_, entries, result) => (header, entries, result)); wenzelm@44180: wenzelm@44197: fun map_entries f (Node {header, entries, result}) = make_node (header, f entries, result); wenzelm@43668: fun fold_entries start f (Node {entries, ...}) = Entries.fold start f entries; wenzelm@43668: fun first_entry start P (Node {entries, ...}) = Entries.get_first start P entries; wenzelm@43668: wenzelm@44199: fun get_theory (Node {result, ...}) = Toplevel.end_theory Position.none (Lazy.get_finished result); wenzelm@44197: fun set_result result = map_node (fn (header, entries, _) => (header, entries, result)); wenzelm@44180: wenzelm@44197: val empty_exec = Lazy.value Toplevel.toplevel; wenzelm@44197: val empty_node = make_node (Exn.Exn (ERROR "Bad theory header"), Entries.empty, empty_exec); wenzelm@44197: val clear_node = map_node (fn (header, _, _) => (header, Entries.empty, empty_exec)); wenzelm@44185: wenzelm@44185: fun get_node nodes name = Graph.get_node nodes name handle Graph.UNDEF _ => empty_node; wenzelm@44185: fun remove_node name nodes = Graph.del_node name nodes handle Graph.UNDEF _ => nodes; wenzelm@44185: fun update_node name f = Graph.default_node (name, empty_node) #> Graph.map_node name f; wenzelm@38418: wenzelm@38418: wenzelm@38448: (* node edits and associated executions *) wenzelm@38150: wenzelm@44157: datatype node_edit = wenzelm@44185: Clear | wenzelm@44157: Edits of (command_id option * command_id option) list | wenzelm@44182: Header of node_header; wenzelm@44157: wenzelm@44156: type edit = string * node_edit; wenzelm@38448: wenzelm@43668: fun the_entry (Node {entries, ...}) id = wenzelm@38448: (case Entries.lookup entries id of wenzelm@38448: NONE => err_undef "command entry" id wenzelm@38448: | SOME entry => entry); wenzelm@38150: wenzelm@43668: fun update_entry (id, exec_id) = wenzelm@43668: map_entries (Entries.update (id, SOME exec_id)); wenzelm@38418: wenzelm@38448: fun reset_after id entries = wenzelm@38448: (case Entries.get_after entries id of wenzelm@38448: NONE => entries wenzelm@38448: | SOME next => Entries.update (next, NONE) entries); wenzelm@38448: wenzelm@43668: val edit_node = map_entries o fold wenzelm@43668: (fn (id, SOME id2) => Entries.insert_after id (id2, NONE) wenzelm@43668: | (id, NONE) => Entries.delete_after id #> reset_after id); wenzelm@38418: wenzelm@38418: wenzelm@38418: (* version operations *) wenzelm@38418: wenzelm@44185: val empty_version = Version Graph.empty; wenzelm@44185: wenzelm@38418: fun nodes_of (Version nodes) = nodes; wenzelm@44185: val node_of = get_node o nodes_of; wenzelm@38418: val node_names_of = Graph.keys o nodes_of; wenzelm@38418: wenzelm@44185: fun cycle_msg names = "Cyclic dependency of " ^ space_implode " via " (map quote names); wenzelm@44180: wenzelm@44157: fun edit_nodes (name, node_edit) (Version nodes) = wenzelm@44157: Version wenzelm@44157: (case node_edit of wenzelm@44185: Clear => update_node name clear_node nodes wenzelm@44180: | Edits edits => update_node name (edit_node edits) nodes wenzelm@44185: | Header header => wenzelm@44185: let wenzelm@44185: val node = get_node nodes name; wenzelm@44185: val nodes' = Graph.new_node (name, node) (remove_node name nodes); wenzelm@44185: val parents = wenzelm@44185: (case header of Exn.Res (_, parents, _) => parents | _ => []) wenzelm@44185: |> filter (can (Graph.get_node nodes')); wenzelm@44185: val (header', nodes'') = wenzelm@44185: (header, Graph.add_deps_acyclic (name, parents) nodes') wenzelm@44185: handle Graph.CYCLES cs => (Exn.Exn (ERROR (cat_lines (map cycle_msg cs))), nodes'); wenzelm@44185: in Graph.map_node name (set_header header') nodes'' end); wenzelm@38418: wenzelm@44197: fun put_node (name, node) (Version nodes) = wenzelm@40481: Version (nodes wenzelm@40481: |> Graph.default_node (name, empty_node) wenzelm@40481: |> Graph.map_node name (K node)); wenzelm@38418: wenzelm@38150: end; wenzelm@38150: wenzelm@38418: wenzelm@38418: wenzelm@38418: (** global state -- document structure and execution process **) wenzelm@38418: wenzelm@38418: abstype state = State of wenzelm@40398: {versions: version Inttab.table, (*version_id -> document content*) wenzelm@38421: commands: Toplevel.transition future Inttab.table, (*command_id -> transition (future parsing)*) wenzelm@44196: execs: Toplevel.state lazy Inttab.table, (*exec_id -> execution process*) wenzelm@40398: execution: unit future list} (*global execution process*) wenzelm@38418: with wenzelm@38418: wenzelm@38418: fun make_state (versions, commands, execs, execution) = wenzelm@38418: State {versions = versions, commands = commands, execs = execs, execution = execution}; wenzelm@38418: wenzelm@38418: fun map_state f (State {versions, commands, execs, execution}) = wenzelm@38418: make_state (f (versions, commands, execs, execution)); wenzelm@38418: wenzelm@38418: val init_state = wenzelm@38418: make_state (Inttab.make [(no_id, empty_version)], wenzelm@38449: Inttab.make [(no_id, Future.value Toplevel.empty)], wenzelm@44197: Inttab.make [(no_id, empty_exec)], wenzelm@38418: []); wenzelm@38418: wenzelm@38418: wenzelm@38418: (* document versions *) wenzelm@38418: wenzelm@38418: fun define_version (id: version_id) version = wenzelm@38418: map_state (fn (versions, commands, execs, execution) => wenzelm@38418: let val versions' = Inttab.update_new (id, version) versions wenzelm@38418: handle Inttab.DUP dup => err_dup "document version" dup wenzelm@38418: in (versions', commands, execs, execution) end); wenzelm@38418: wenzelm@38418: fun the_version (State {versions, ...}) (id: version_id) = wenzelm@38418: (case Inttab.lookup versions id of wenzelm@38418: NONE => err_undef "document version" id wenzelm@38418: | SOME version => version); wenzelm@38418: wenzelm@38418: wenzelm@38418: (* commands *) wenzelm@38418: wenzelm@38418: fun define_command (id: command_id) text = wenzelm@38418: map_state (fn (versions, commands, execs, execution) => wenzelm@38418: let wenzelm@38418: val id_string = print_id id; wenzelm@38421: val tr = Future.fork_pri 2 (fn () => wenzelm@38418: Position.setmp_thread_data (Position.id_only id_string) wenzelm@38421: (fn () => Outer_Syntax.prepare_command (Position.id id_string) text) ()); wenzelm@38418: val commands' = wenzelm@38421: Inttab.update_new (id, tr) commands wenzelm@38418: handle Inttab.DUP dup => err_dup "command" dup; wenzelm@38418: in (versions, commands', execs, execution) end); wenzelm@38418: wenzelm@38418: fun the_command (State {commands, ...}) (id: command_id) = wenzelm@38418: (case Inttab.lookup commands id of wenzelm@38418: NONE => err_undef "command" id wenzelm@38418: | SOME tr => tr); wenzelm@38418: wenzelm@38421: fun join_commands (State {commands, ...}) = wenzelm@38421: Inttab.fold (fn (_, tr) => fn () => ignore (Future.join_result tr)) commands (); wenzelm@38421: wenzelm@38418: wenzelm@38418: (* command executions *) wenzelm@38418: wenzelm@44197: fun define_exec (exec_id, exec) = wenzelm@38418: map_state (fn (versions, commands, execs, execution) => wenzelm@44197: let val execs' = Inttab.update_new (exec_id, exec) execs wenzelm@38418: handle Inttab.DUP dup => err_dup "command execution" dup wenzelm@38418: in (versions, commands, execs', execution) end); wenzelm@38418: wenzelm@44197: fun the_exec (State {execs, ...}) exec_id = wenzelm@44197: (case Inttab.lookup execs exec_id of wenzelm@44197: NONE => err_undef "command execution" exec_id wenzelm@38418: | SOME exec => exec); wenzelm@38418: wenzelm@41634: wenzelm@41634: (* document execution *) wenzelm@41634: wenzelm@43666: fun cancel_execution (State {execution, ...}) = wenzelm@43666: (List.app Future.cancel execution; wenzelm@43666: fn () => ignore (Future.join_results execution)); wenzelm@41634: wenzelm@38418: end; wenzelm@38418: wenzelm@38418: wenzelm@38418: wenzelm@38888: (* toplevel transactions *) wenzelm@38888: wenzelm@38888: local wenzelm@38888: wenzelm@40391: fun timing tr t = Toplevel.status tr (Markup.timing t); wenzelm@40391: wenzelm@38888: fun proof_status tr st = wenzelm@38888: (case try Toplevel.proof_of st of wenzelm@38888: SOME prf => Toplevel.status tr (Proof.status_markup prf) wenzelm@38888: | NONE => ()); wenzelm@38888: wenzelm@38888: fun async_state tr st = wenzelm@40534: ignore wenzelm@41673: (singleton wenzelm@41674: (Future.forks {name = "Document.async_state", wenzelm@44113: group = SOME (Task_Queue.new_group NONE), deps = [], pri = 0, interrupts = true}) wenzelm@40534: (fn () => wenzelm@40534: Toplevel.setmp_thread_position tr wenzelm@40534: (fn () => Toplevel.print_state false st) ())); wenzelm@38888: wenzelm@40390: fun run int tr st = wenzelm@40390: (case Toplevel.transition int tr st of wenzelm@40390: SOME (st', NONE) => ([], SOME st') wenzelm@40390: | SOME (_, SOME exn_info) => wenzelm@40390: (case ML_Compiler.exn_messages (Runtime.EXCURSION_FAIL exn_info) of wenzelm@40390: [] => Exn.interrupt () wenzelm@40390: | errs => (errs, NONE)) wenzelm@40390: | NONE => ([ML_Compiler.exn_message Runtime.TERMINATE], NONE)); wenzelm@40390: wenzelm@38888: in wenzelm@38888: wenzelm@44199: fun run_command tr st = wenzelm@44185: let wenzelm@44199: val is_init = Toplevel.is_init tr; wenzelm@44185: val is_proof = Keyword.is_proof (Toplevel.name_of tr); wenzelm@44185: val do_print = not is_init andalso (Toplevel.print_of tr orelse is_proof); wenzelm@44185: wenzelm@44185: val start = Timing.start (); wenzelm@44185: val (errs, result) = wenzelm@44185: if Toplevel.is_toplevel st andalso not is_init then ([], SOME st) wenzelm@44185: else run (is_init orelse is_proof) (Toplevel.set_print false tr) st; wenzelm@44185: val _ = timing tr (Timing.result start); wenzelm@44185: val _ = List.app (Toplevel.error_msg tr) errs; wenzelm@44185: in wenzelm@44185: (case result of wenzelm@44196: NONE => (Toplevel.status tr Markup.failed; st) wenzelm@44185: | SOME st' => wenzelm@44185: (Toplevel.status tr Markup.finished; wenzelm@44185: proof_status tr st'; wenzelm@44185: if do_print then async_state tr st' else (); wenzelm@44196: st')) wenzelm@44185: end; wenzelm@38888: wenzelm@38888: end; wenzelm@38888: wenzelm@38888: wenzelm@38888: wenzelm@38888: wenzelm@38418: (** editing **) wenzelm@38418: wenzelm@38418: (* edit *) wenzelm@38418: wenzelm@38418: local wenzelm@38418: wenzelm@38448: fun is_changed node' ((_, id), exec) = wenzelm@38418: (case try (the_entry node') id of wenzelm@38418: NONE => true wenzelm@38448: | SOME exec' => exec' <> exec); wenzelm@38418: wenzelm@44199: fun new_exec (command_id, command) (assigns, execs, exec) = wenzelm@38418: let wenzelm@38419: val exec_id' = new_id (); wenzelm@38418: val exec' = wenzelm@38418: Lazy.lazy (fn () => wenzelm@40398: let wenzelm@44198: val tr = Toplevel.put_id (print_id exec_id') (Future.get_finished command); wenzelm@44198: val st = Lazy.get_finished exec; wenzelm@44199: in run_command tr st end); wenzelm@44197: in ((command_id, exec_id') :: assigns, (exec_id', exec') :: execs, exec') end; wenzelm@38418: wenzelm@38418: in wenzelm@38418: wenzelm@44157: fun edit (old_id: version_id) (new_id: version_id) edits state = wenzelm@38418: let wenzelm@38418: val old_version = the_version state old_id; wenzelm@44180: val _ = Time.now (); (* FIXME odd workaround for polyml-5.4.0/x86_64 *) wenzelm@38418: val new_version = fold edit_nodes edits old_version; wenzelm@38418: wenzelm@44197: (* FIXME futures *) wenzelm@44197: val updates = wenzelm@44197: nodes_of new_version |> Graph.schedule wenzelm@44199: (fn deps => fn (name, node) => wenzelm@44197: (case first_entry NONE (is_changed (node_of old_version name)) node of wenzelm@44197: NONE => (([], [], []), node) wenzelm@44197: | SOME ((prev, id), _) => wenzelm@44197: let wenzelm@44197: val prev_exec = wenzelm@44197: (case prev of wenzelm@44197: NONE => no_id wenzelm@44197: | SOME prev_id => the_default no_id (the_entry node prev_id)); wenzelm@44199: wenzelm@44199: fun init () = wenzelm@44199: let wenzelm@44199: val (thy_name, imports, uses) = Exn.release (get_header node); wenzelm@44199: (* FIXME provide files via Scala layer *) wenzelm@44199: val dir = Path.dir (Path.explode name); wenzelm@44199: val files = map (apfst Path.explode) uses; wenzelm@44199: wenzelm@44199: val parents = wenzelm@44199: imports |> map (fn import => wenzelm@44199: (case AList.lookup (op =) deps import of wenzelm@44199: SOME (_, parent_node) => get_theory parent_node wenzelm@44199: | NONE => Thy_Info.get_theory (Thy_Info.base_name import))); wenzelm@44199: in Thy_Load.begin_theory dir thy_name imports files parents end wenzelm@44199: fun get_command id = wenzelm@44199: (id, the_command state id |> Future.map (Toplevel.modify_init init)); wenzelm@44199: wenzelm@44197: val (assigns, execs, result) = wenzelm@44199: fold_entries (SOME id) (new_exec o get_command o #2 o #1) wenzelm@44199: node ([], [], the_exec state prev_exec); wenzelm@44199: val node' = node wenzelm@44199: |> fold update_entry assigns wenzelm@44199: |> set_result result; wenzelm@44197: in ((assigns, execs, [(name, node')]), node') end)) wenzelm@44197: |> map #1; wenzelm@38418: wenzelm@44197: val state' = state wenzelm@44197: |> fold (fold define_exec o #2) updates wenzelm@44197: |> define_version new_id (fold (fold put_node o #3) updates new_version); wenzelm@38421: wenzelm@44197: in (maps #1 (rev updates), state') end; wenzelm@38418: wenzelm@38418: end; wenzelm@38418: wenzelm@38418: wenzelm@38418: (* execute *) wenzelm@38418: wenzelm@38418: fun execute version_id state = wenzelm@41673: state |> map_state (fn (versions, commands, execs, _) => wenzelm@38418: let wenzelm@38418: val version = the_version state version_id; wenzelm@38418: wenzelm@38418: fun force_exec NONE = () wenzelm@38418: | force_exec (SOME exec_id) = ignore (Lazy.force (the_exec state exec_id)); wenzelm@38418: wenzelm@44180: val execution' = (* FIXME Graph.schedule *) wenzelm@44113: Future.forks wenzelm@44113: {name = "Document.execute", group = NONE, deps = [], pri = 1, interrupts = true} wenzelm@41673: [fn () => wenzelm@43666: node_names_of version |> List.app (fn name => wenzelm@43666: fold_entries NONE (fn (_, exec) => fn () => force_exec exec) wenzelm@44185: (node_of version name) ())]; wenzelm@40520: wenzelm@38418: in (versions, commands, execs, execution') end); wenzelm@38418: wenzelm@43713: wenzelm@43713: wenzelm@43713: (** global state **) wenzelm@43713: wenzelm@43713: val global_state = Synchronized.var "Document" init_state; wenzelm@43713: wenzelm@43713: fun state () = Synchronized.value global_state; wenzelm@43713: val change_state = Synchronized.change global_state; wenzelm@43713: wenzelm@38418: end; wenzelm@38418: