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@38448: type edit = string * ((command_id option * command_id option) list) option wenzelm@38418: type state wenzelm@38418: val init_state: state wenzelm@43668: val get_theory: state -> version_id -> Position.T -> string -> theory wenzelm@43666: val cancel_execution: state -> unit -> unit wenzelm@38418: val define_command: command_id -> string -> state -> state wenzelm@38418: val edit: version_id -> version_id -> edit list -> state -> (command_id * exec_id) list * state wenzelm@38418: val execute: version_id -> state -> state 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@38448: structure Entries = Linear_Set(type key = command_id val ord = int_ord); wenzelm@38448: wenzelm@43668: abstype node = Node of wenzelm@43668: {last: exec_id, entries: exec_id option Entries.T} (*command entries with excecutions*) wenzelm@43668: and version = Version of node Graph.T (*development graph wrt. static imports*) wenzelm@38418: with wenzelm@38418: wenzelm@43668: fun make_node (last, entries) = wenzelm@43668: Node {last = last, entries = entries}; wenzelm@43668: wenzelm@43668: fun get_last (Node {last, ...}) = last; wenzelm@43668: fun set_last last (Node {entries, ...}) = make_node (last, entries); wenzelm@38418: wenzelm@43668: fun map_entries f (Node {last, entries}) = make_node (last, f entries); 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@43668: val empty_node = make_node (no_id, Entries.empty); wenzelm@43668: val empty_version = Version Graph.empty; wenzelm@38418: wenzelm@38418: wenzelm@38448: (* node edits and associated executions *) wenzelm@38150: wenzelm@38150: type edit = wenzelm@38448: string * wenzelm@38448: (*NONE: remove node, SOME: insert/remove commands*) wenzelm@38448: ((command_id option * command_id option) list) option; 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@38418: fun nodes_of (Version nodes) = nodes; wenzelm@38418: val node_names_of = Graph.keys o nodes_of; wenzelm@38418: wenzelm@38448: fun get_node version name = Graph.get_node (nodes_of version) name wenzelm@38448: handle Graph.UNDEF _ => empty_node; wenzelm@38448: wenzelm@38418: fun edit_nodes (name, SOME edits) (Version nodes) = wenzelm@38418: Version (nodes wenzelm@38418: |> Graph.default_node (name, empty_node) wenzelm@43668: |> Graph.map_node name (edit_node edits)) wenzelm@38448: | edit_nodes (name, NONE) (Version nodes) = wenzelm@40481: Version (perhaps (try (Graph.del_node name)) nodes); wenzelm@38418: wenzelm@38418: 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@40398: execs: (bool * 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@40398: Inttab.make [(no_id, Lazy.value (true, Toplevel.toplevel))], 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@38418: fun define_exec (id: exec_id) exec = wenzelm@38418: map_state (fn (versions, commands, execs, execution) => wenzelm@38418: let val execs' = Inttab.update_new (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@38418: fun the_exec (State {execs, ...}) (id: exec_id) = wenzelm@38418: (case Inttab.lookup execs id of wenzelm@38418: NONE => err_undef "command execution" id wenzelm@38418: | SOME exec => exec); wenzelm@38418: wenzelm@43668: fun get_theory state version_id pos name = wenzelm@43668: let wenzelm@43668: val last = get_last (get_node (the_version state version_id) name); wenzelm@43668: val st = #2 (Lazy.force (the_exec state last)); wenzelm@43668: in Toplevel.end_theory pos st end; wenzelm@43668: 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@41673: group = SOME (Task_Queue.new_group NONE), deps = [], pri = 0}) 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@41537: fun run_command thy_name raw_tr st = wenzelm@38888: (case wenzelm@41537: (case Toplevel.init_of raw_tr of wenzelm@41537: SOME name => Exn.capture (fn () => wenzelm@41537: let wenzelm@41537: val path = Path.explode thy_name; wenzelm@41537: val _ = Thy_Header.consistent_name (Path.implode (Path.base path)) name; wenzelm@41537: in Toplevel.modify_master (SOME (Path.dir path)) raw_tr end) () wenzelm@41537: | NONE => Exn.Result raw_tr) of wenzelm@41537: Exn.Result tr => wenzelm@38888: let wenzelm@40534: val is_init = is_some (Toplevel.init_of tr); wenzelm@40534: val is_proof = Keyword.is_proof (Toplevel.name_of tr); wenzelm@40534: val do_print = not is_init andalso (Toplevel.print_of tr orelse is_proof); wenzelm@40534: wenzelm@42012: val start = Timing.start (); wenzelm@42328: val (errs, result) = wenzelm@42328: if Toplevel.is_toplevel st andalso not is_init then ([], SOME st) wenzelm@42328: else run (is_init orelse is_proof) (Toplevel.set_print false tr) st; wenzelm@42012: val _ = timing tr (Timing.result start); wenzelm@38888: val _ = List.app (Toplevel.error_msg tr) errs; wenzelm@40398: val res = wenzelm@38888: (case result of wenzelm@40398: NONE => (Toplevel.status tr Markup.failed; (false, st)) wenzelm@38888: | SOME st' => wenzelm@38888: (Toplevel.status tr Markup.finished; wenzelm@38888: proof_status tr st'; wenzelm@40534: if do_print then async_state tr st' else (); wenzelm@40398: (true, st'))); wenzelm@40398: in res end wenzelm@38888: | Exn.Exn exn => wenzelm@39238: if Exn.is_interrupt exn then reraise exn wenzelm@39238: else wenzelm@41537: (Toplevel.error_msg raw_tr (ML_Compiler.exn_message exn); wenzelm@41537: Toplevel.status raw_tr Markup.failed; wenzelm@40398: (false, Toplevel.toplevel))); 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@38418: fun new_exec name (id: command_id) (exec_id, updates, state) = wenzelm@38418: let wenzelm@38418: val exec = the_exec state exec_id; wenzelm@38419: val exec_id' = new_id (); wenzelm@38449: val future_tr = the_command state id; wenzelm@38418: val exec' = wenzelm@38418: Lazy.lazy (fn () => wenzelm@40398: let wenzelm@40398: val st = #2 (Lazy.force exec); wenzelm@40398: val exec_tr = Toplevel.put_id (print_id exec_id') (Future.join future_tr); wenzelm@40398: in run_command name exec_tr st end); wenzelm@38418: val state' = define_exec exec_id' exec' state; wenzelm@38418: in (exec_id', (id, exec_id') :: updates, state') end; wenzelm@38418: wenzelm@38418: in wenzelm@38418: wenzelm@38418: 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@41629: val _ = Time.now (); (* FIXME odd workaround *) wenzelm@38418: val new_version = fold edit_nodes edits old_version; wenzelm@38418: wenzelm@38418: fun update_node name (rev_updates, version, st) = wenzelm@38448: let val node = get_node version name in wenzelm@38448: (case first_entry NONE (is_changed (get_node old_version name)) node of wenzelm@38418: NONE => (rev_updates, version, st) wenzelm@38448: | SOME ((prev, id), _) => wenzelm@38418: let wenzelm@38448: val prev_exec = wenzelm@38448: (case prev of wenzelm@38448: NONE => no_id wenzelm@38448: | SOME prev_id => the_default no_id (the_entry node prev_id)); wenzelm@43668: val (last, rev_upds, st') = wenzelm@38448: fold_entries (SOME id) (new_exec name o #2 o #1) node (prev_exec, [], st); wenzelm@43668: val node' = node |> fold update_entry rev_upds |> set_last last; wenzelm@38418: in (rev_upds @ rev_updates, put_node name node' version, st') end) wenzelm@38418: end; wenzelm@38418: wenzelm@38418: (* FIXME proper node deps *) wenzelm@38418: val (rev_updates, new_version', state') = wenzelm@38418: fold update_node (node_names_of new_version) ([], new_version, state); wenzelm@38418: val state'' = define_version new_id new_version' state'; wenzelm@38421: wenzelm@38421: val _ = join_commands state''; (* FIXME async!? *) wenzelm@38418: in (rev 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@38418: val execution' = (* FIXME proper node deps *) wenzelm@41674: Future.forks {name = "Document.execute", group = NONE, deps = [], pri = 1} 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@43666: (get_node version name) ())]; wenzelm@40520: wenzelm@38418: in (versions, commands, execs, execution') end); wenzelm@38418: wenzelm@38418: end; wenzelm@38418: