disallow concurrent execution attempt explicitly -- it should never happen due to management of singleton execution;
tuned error messages: prefer plain "error" as in document.ML;
1 (* Title: Pure/PIDE/command.ML
4 Prover command execution: read -- eval -- print.
10 type eval = {exec_id: Document_ID.exec, eval_process: eval_process}
11 val eval_result_state: eval -> Toplevel.state
12 val eval_same: eval * eval -> bool
15 {name: string, pri: int, persistent: bool,
16 exec_id: Document_ID.exec, print_process: print_process}
17 type exec = eval * print list
19 val exec_ids: exec option -> Document_ID.exec list
20 val read: (unit -> theory) -> Token.T list -> Toplevel.transition
21 val eval: (unit -> theory) -> Token.T list -> eval -> eval
22 val print: bool -> string -> eval -> print list -> print list option
23 type print_fn = Toplevel.transition -> Toplevel.state -> unit
24 val print_function: {name: string, pri: int, persistent: bool} ->
25 ({command_name: string} -> print_fn option) -> unit
26 val no_print_function: string -> unit
27 val execute: exec -> unit
30 structure Command: COMMAND =
33 (** memo results -- including physical interrupts! **)
36 Expr of Document_ID.exec * (unit -> 'a) |
37 Result of 'a Exn.result;
39 abstype 'a memo = Memo of 'a expr Synchronized.var
42 fun memo exec_id e = Memo (Synchronized.var "Command.memo" (Expr (exec_id, e)));
43 fun memo_value a = Memo (Synchronized.var "Command.memo" (Result (Exn.Res a)));
45 fun memo_result (Memo v) =
46 (case Synchronized.value v of
47 Result res => Exn.release res
48 | Expr (exec_id, _) => error ("Unfinished execution result: " ^ Document_ID.print exec_id));
50 fun memo_exec (Memo v) =
51 (case Synchronized.value v of
53 | Expr (exec_id, _) =>
54 Synchronized.timed_access v (fn _ => SOME Time.zeroTime)
55 (fn Result res => SOME (res, Result res)
56 | Expr (exec_id, e) =>
57 uninterruptible (fn restore_attributes => fn () =>
59 val _ = Exec.running exec_id;
60 val res = Exn.capture (restore_attributes e) ();
62 if Exn.is_interrupt_exn res
63 then Exec.canceled exec_id
64 else Exec.finished exec_id;
65 in SOME (res, Result res) end) ())
66 |> (fn NONE => error ("Concurrent execution attempt: " ^ Document_ID.print exec_id)
70 fun memo_fork params (Memo v) =
71 (case Synchronized.value v of
73 | _ => ignore ((singleton o Future.forks) params (fn () => memo_exec (Memo v))));
79 (** main phases of execution **)
81 (* type definitions *)
84 {failed: bool, malformed: bool, command: Toplevel.transition, state: Toplevel.state};
86 {failed = false, malformed = false, command = Toplevel.empty, state = Toplevel.toplevel};
88 type eval_process = eval_state memo;
89 type eval = {exec_id: Document_ID.exec, eval_process: eval_process};
91 fun eval_result ({eval_process, ...}: eval) = memo_result eval_process;
92 val eval_result_state = #state o eval_result;
94 fun eval_same ({exec_id, ...}: eval, {exec_id = exec_id', ...}: eval) =
95 exec_id = exec_id' andalso Exec.is_stable exec_id;
97 type print_process = unit memo;
99 {name: string, pri: int, persistent: bool,
100 exec_id: Document_ID.exec, print_process: print_process};
102 type exec = eval * print list;
103 val no_exec: exec = ({exec_id = Document_ID.none, eval_process = memo_value init_eval_state}, []);
105 fun exec_ids (NONE: exec option) = []
106 | exec_ids (SOME ({exec_id, ...}, prints)) = exec_id :: map #exec_id prints;
113 val outer_syntax = #2 (Outer_Syntax.get_syntax ());
114 val command_reports = Outer_Syntax.command_reports outer_syntax;
117 Position.set_range (Token.position_range_of (#1 (take_suffix Token.is_improper span)));
119 (case find_first Token.is_command span of
120 SOME tok => Token.position_of tok
121 | NONE => proper_range);
123 val (is_malformed, token_reports) = Thy_Syntax.reports_of_tokens span;
124 val _ = Position.reports_text (token_reports @ maps command_reports span);
126 if is_malformed then Toplevel.malformed pos "Malformed command syntax"
128 (case Outer_Syntax.read_spans outer_syntax span of
130 if Keyword.is_control (Toplevel.name_of tr) then
131 Toplevel.malformed pos "Illegal control command"
132 else Toplevel.modify_init init tr
133 | [] => Toplevel.ignored (Position.set_range (Token.position_range_of span))
134 | _ => Toplevel.malformed proper_range "Exactly one command expected")
135 handle ERROR msg => Toplevel.malformed proper_range msg
144 if Goal.future_enabled () andalso Keyword.is_diag (Toplevel.name_of tr) then
145 (Goal.fork_params {name = "Toplevel.diag", pos = Toplevel.pos_of tr, pri = ~1}
146 (fn () => Toplevel.command_exception int tr st); ([], SOME st))
147 else Toplevel.command_errors int tr st;
149 fun check_cmts span tr st' =
150 Toplevel.setmp_thread_position tr
152 Outer_Syntax.side_comments span |> maps (fn cmt =>
153 (Thy_Output.check_text (Token.source_position_of cmt) st'; [])
154 handle exn => ML_Compiler.exn_messages_ids exn)) ();
156 fun proof_status tr st =
157 (case try Toplevel.proof_of st of
158 SOME prf => Toplevel.status tr (Proof.status_markup prf)
161 fun eval_state span tr ({malformed, state = st, ...}: eval_state) =
163 {failed = true, malformed = malformed, command = tr, state = Toplevel.toplevel}
166 val malformed' = Toplevel.is_malformed tr;
167 val is_init = Toplevel.is_init tr;
168 val is_proof = Keyword.is_proof (Toplevel.name_of tr);
170 val _ = Multithreading.interrupted ();
171 val _ = Toplevel.status tr Markup.running;
172 val (errs1, result) = run (is_init orelse is_proof) (Toplevel.set_print false tr) st;
173 val errs2 = (case result of NONE => [] | SOME st' => check_cmts span tr st');
174 val errs = errs1 @ errs2;
175 val _ = Toplevel.status tr Markup.finished;
176 val _ = List.app (Future.error_msg (Toplevel.pos_of tr)) errs;
181 val _ = if null errs then Exn.interrupt () else ();
182 val _ = Toplevel.status tr Markup.failed;
183 in {failed = true, malformed = malformed', command = tr, state = st} end
186 val _ = proof_status tr st';
187 in {failed = false, malformed = malformed', command = tr, state = st'} end)
192 fun eval init span eval0 =
194 val exec_id = Document_ID.make ();
198 Position.setmp_thread_data (Position.id_only (Document_ID.print exec_id))
199 (fn () => read init span |> Toplevel.exec_id exec_id) ();
200 in eval_state span tr (eval_result eval0) end;
201 in {exec_id = exec_id, eval_process = memo exec_id process} end;
208 type print_fn = Toplevel.transition -> Toplevel.state -> unit;
212 type print_function = string * (int * bool * ({command_name: string} -> print_fn option));
213 val print_functions = Synchronized.var "Command.print_functions" ([]: print_function list);
215 fun print_error tr e =
216 (Toplevel.setmp_thread_position tr o Runtime.controlled_execution) e () handle exn =>
217 List.app (Future.error_msg (Toplevel.pos_of tr)) (ML_Compiler.exn_messages_ids exn);
219 fun print_stable (print: print) = Exec.is_stable (#exec_id print);
223 fun print command_visible command_name eval old_prints =
225 fun new_print (name, (pri, persistent, get_fn)) =
227 fun make_print strict print_fn =
229 val exec_id = Document_ID.make ();
232 val {failed, command, state = st', ...} = eval_result eval;
233 val tr = Toplevel.exec_id exec_id command;
235 if failed andalso not strict then ()
236 else print_error tr (fn () => print_fn tr st')
239 {name = name, pri = pri, persistent = persistent,
240 exec_id = exec_id, print_process = memo exec_id process}
243 (case Exn.capture (Runtime.controlled_execution get_fn) {command_name = command_name} of
245 | Exn.Res (SOME print_fn) => SOME (make_print false print_fn)
246 | Exn.Exn exn => SOME (make_print true (fn _ => fn _ => reraise exn)))
250 if command_visible then
251 rev (Synchronized.value print_functions) |> map_filter (fn pr =>
252 (case find_first (equal (fst pr) o #name) old_prints of
253 SOME print => if print_stable print then SOME print else new_print pr
254 | NONE => new_print pr))
255 else filter (fn print => #persistent print andalso print_stable print) old_prints;
257 if eq_list (op = o pairself #exec_id) (old_prints, new_prints) then NONE
261 fun print_function {name, pri, persistent} f =
262 Synchronized.change print_functions (fn funs =>
263 (if not (AList.defined (op =) funs name) then ()
264 else warning ("Redefining command print function: " ^ quote name);
265 AList.update (op =) (name, (pri, persistent, f)) funs));
267 fun no_print_function name =
268 Synchronized.change print_functions (filter_out (equal name o #1));
273 print_function {name = "print_state", pri = 0, persistent = true}
274 (fn {command_name} => SOME (fn tr => fn st' =>
276 val is_init = Keyword.is_theory_begin command_name;
277 val is_proof = Keyword.is_proof command_name;
280 (Toplevel.print_of tr orelse (is_proof andalso Toplevel.is_proof st'));
281 in if do_print then Toplevel.print_state false st' else () end));
284 (* combined execution process *)
286 fun run_print ({name, pri, print_process, ...}: print) =
287 (if Multithreading.enabled () then
288 memo_fork {name = name, group = NONE, deps = [], pri = pri, interrupts = true}
289 else memo_exec) print_process;
291 fun execute (({eval_process, ...}, prints): exec) =
292 (memo_exec eval_process; List.app run_print prints);