1 (* Title: Pure/PIDE/command.ML
4 Prover command execution: read -- eval -- print.
9 val read: (unit -> theory) -> Token.T list -> Toplevel.transition
11 val eval_eq: eval * eval -> bool
12 val eval_running: eval -> bool
13 val eval_finished: eval -> bool
14 val eval_result_state: eval -> Toplevel.state
15 val eval: (unit -> theory) -> Token.T list -> eval -> eval
17 val print: bool -> (string * string list) list -> string ->
18 eval -> print list -> print list option
19 type print_fn = Toplevel.transition -> Toplevel.state -> unit
20 val print_function: string ->
21 ({command_name: string, args: string list} ->
22 {delay: Time.time option, pri: int, persistent: bool, print_fn: print_fn} option) -> unit
23 val no_print_function: string -> unit
24 type exec = eval * print list
26 val exec_ids: exec option -> Document_ID.exec list
27 val exec: Document_ID.execution -> exec -> unit
30 structure Command: COMMAND =
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 Expr (exec_id, _) => error ("Unfinished execution result: " ^ Document_ID.print exec_id)
48 | Result res => Exn.release res);
50 fun memo_finished (Memo v) =
51 (case Synchronized.value v of Expr _ => false | Result _ => true);
53 fun memo_exec execution_id (Memo v) =
54 Synchronized.timed_access v (K (SOME Time.zeroTime))
57 Expr (exec_id, body) =>
58 uninterruptible (fn restore_attributes => fn () =>
59 if Execution.running execution_id exec_id then
64 |> Future.worker_nest "Command.memo_exec"
65 |> Exn.interruptible_capture) ();
66 in SOME ((), Result res) end
67 else SOME ((), expr)) ()
68 | Result _ => SOME ((), expr)))
69 |> (fn NONE => error "Conflicting command execution" | _ => ());
71 fun memo_fork params execution_id (Memo v) =
72 (case Synchronized.value v of
74 | _ => ignore ((singleton o Future.forks) params (fn () => memo_exec execution_id (Memo v))));
80 (** main phases of execution **)
86 val outer_syntax = #2 (Outer_Syntax.get_syntax ());
87 val command_reports = Outer_Syntax.command_reports outer_syntax;
90 Position.set_range (Token.position_range_of (#1 (take_suffix Token.is_improper span)));
92 (case find_first Token.is_command span of
93 SOME tok => Token.position_of tok
94 | NONE => proper_range);
96 val (is_malformed, token_reports) = Thy_Syntax.reports_of_tokens span;
97 val _ = Position.reports_text (token_reports @ maps command_reports span);
99 if is_malformed then Toplevel.malformed pos "Malformed command syntax"
101 (case Outer_Syntax.read_spans outer_syntax span of
103 if Keyword.is_control (Toplevel.name_of tr) then
104 Toplevel.malformed pos "Illegal control command"
105 else Toplevel.modify_init init tr
106 | [] => Toplevel.ignored (Position.set_range (Token.position_range_of span))
107 | _ => Toplevel.malformed proper_range "Exactly one command expected")
108 handle ERROR msg => Toplevel.malformed proper_range msg
115 {failed: bool, malformed: bool, command: Toplevel.transition, state: Toplevel.state};
116 val init_eval_state =
117 {failed = false, malformed = false, command = Toplevel.empty, state = Toplevel.toplevel};
119 datatype eval = Eval of {exec_id: Document_ID.exec, eval_process: eval_state memo};
121 fun eval_eq (Eval {exec_id, ...}, Eval {exec_id = exec_id', ...}) = exec_id = exec_id';
123 fun eval_running (Eval {exec_id, ...}) = Execution.is_running_exec exec_id;
124 fun eval_finished (Eval {eval_process, ...}) = memo_finished eval_process;
126 fun eval_result (Eval {eval_process, ...}) = memo_result eval_process;
127 val eval_result_state = #state o eval_result;
132 if Goal.future_enabled () andalso Keyword.is_diag (Toplevel.name_of tr) then
133 (Goal.fork_params {name = "Toplevel.diag", pos = Toplevel.pos_of tr, pri = ~1}
134 (fn () => Toplevel.command_exception int tr st); ([], SOME st))
135 else Toplevel.command_errors int tr st;
137 fun check_cmts span tr st' =
138 Toplevel.setmp_thread_position tr
140 Outer_Syntax.side_comments span |> maps (fn cmt =>
141 (Thy_Output.check_text (Token.source_position_of cmt) st'; [])
143 if Exn.is_interrupt exn then reraise exn
144 else ML_Compiler.exn_messages_ids exn)) ();
146 fun proof_status tr st =
147 (case try Toplevel.proof_of st of
148 SOME prf => Toplevel.status tr (Proof.status_markup prf)
151 fun eval_state span tr ({malformed, state = st, ...}: eval_state) =
153 {failed = true, malformed = malformed, command = tr, state = Toplevel.toplevel}
156 val malformed' = Toplevel.is_malformed tr;
157 val is_init = Toplevel.is_init tr;
158 val is_proof = Keyword.is_proof (Toplevel.name_of tr);
160 val _ = Multithreading.interrupted ();
161 val _ = Toplevel.status tr Markup.running;
162 val (errs1, result) = run (is_init orelse is_proof) (Toplevel.set_print false tr) st;
163 val errs2 = (case result of NONE => [] | SOME st' => check_cmts span tr st');
164 val errs = errs1 @ errs2;
165 val _ = Toplevel.status tr Markup.finished;
166 val _ = List.app (Future.error_msg (Toplevel.pos_of tr)) errs;
171 val _ = if null errs then Exn.interrupt () else ();
172 val _ = Toplevel.status tr Markup.failed;
173 in {failed = true, malformed = malformed', command = tr, state = st} end
176 val _ = proof_status tr st';
177 in {failed = false, malformed = malformed', command = tr, state = st'} end)
182 fun eval init span eval0 =
184 val exec_id = Document_ID.make ();
188 Position.setmp_thread_data (Position.id_only (Document_ID.print exec_id))
189 (fn () => read init span |> Toplevel.exec_id exec_id) ();
190 in eval_state span tr (eval_result eval0) end;
191 in Eval {exec_id = exec_id, eval_process = memo exec_id process} end;
198 datatype print = Print of
199 {name: string, args: string list, delay: Time.time option, pri: int, persistent: bool,
200 exec_id: Document_ID.exec, print_process: unit memo};
202 type print_fn = Toplevel.transition -> Toplevel.state -> unit;
204 type print_function =
205 {command_name: string, args: string list} ->
206 {delay: Time.time option, pri: int, persistent: bool, print_fn: print_fn} option;
210 val print_functions =
211 Synchronized.var "Command.print_functions" ([]: (string * print_function) list);
213 fun print_error tr e =
214 (Toplevel.setmp_thread_position tr o Runtime.controlled_execution) e ()
216 if Exn.is_interrupt exn then reraise exn
217 else List.app (Future.error_msg (Toplevel.pos_of tr)) (ML_Compiler.exn_messages_ids exn);
219 fun print_eq (Print {exec_id, ...}, Print {exec_id = exec_id', ...}) = exec_id = exec_id';
221 fun print_finished (Print {print_process, ...}) = memo_finished print_process;
223 fun print_persistent (Print {persistent, ...}) = persistent;
227 fun print command_visible command_overlays command_name eval old_prints =
229 val print_functions = Synchronized.value print_functions;
231 fun new_print name args get_pr =
233 fun make_print strict {delay, pri, persistent, print_fn} =
235 val exec_id = Document_ID.make ();
238 val {failed, command, state = st', ...} = eval_result eval;
239 val tr = Toplevel.exec_id exec_id command;
241 if failed andalso not strict then ()
242 else print_error tr (fn () => print_fn tr st')
246 name = name, args = args, delay = delay, pri = pri, persistent = persistent,
247 exec_id = exec_id, print_process = memo exec_id process}
249 val params = {command_name = command_name, args = args};
251 (case Exn.capture (Runtime.controlled_execution get_pr) params of
253 | Exn.Res (SOME pr) => SOME (make_print false pr)
255 SOME (make_print true
256 {delay = NONE, pri = 0, persistent = false, print_fn = fn _ => fn _ => reraise exn}))
259 fun get_print (a, b) =
260 (case find_first (fn Print {name, args, ...} => name = a andalso args = b) old_prints of
262 (case AList.lookup (op =) print_functions a of
264 | SOME get_pr => new_print a b get_pr)
268 if command_visible then
269 distinct (op =) (fold (fn (a, _) => cons (a, [])) print_functions command_overlays)
270 |> map_filter get_print
271 else filter (fn print => print_finished print andalso print_persistent print) old_prints;
273 if eq_list print_eq (old_prints, new_prints) then NONE else SOME new_prints
276 fun print_function name f =
277 Synchronized.change print_functions (fn funs =>
278 (if not (AList.defined (op =) funs name) then ()
279 else warning ("Redefining command print function: " ^ quote name);
280 AList.update (op =) (name, f) funs));
282 fun no_print_function name =
283 Synchronized.change print_functions (filter_out (equal name o #1));
288 print_function "print_state"
289 (fn {command_name, ...} =>
290 SOME {delay = NONE, pri = 1, persistent = true,
291 print_fn = fn tr => fn st' =>
293 val is_init = Keyword.is_theory_begin command_name;
294 val is_proof = Keyword.is_proof command_name;
297 (Toplevel.print_of tr orelse (is_proof andalso Toplevel.is_proof st'));
298 in if do_print then Toplevel.print_state false st' else () end});
301 (* combined execution *)
303 type exec = eval * print list;
305 (Eval {exec_id = Document_ID.none, eval_process = memo_value init_eval_state}, []);
307 fun exec_ids NONE = []
308 | exec_ids (SOME (Eval {exec_id, ...}, prints)) =
309 exec_id :: map (fn Print {exec_id, ...} => exec_id) prints;
313 fun run_print execution_id (Print {name, delay, pri, print_process, ...}) =
314 if Multithreading.enabled () then
316 val group = Future.worker_subgroup ();
318 memo_fork {name = name, group = SOME group, deps = [], pri = pri, interrupts = true}
319 execution_id print_process;
323 | SOME d => ignore (Event_Timer.request (Time.+ (Time.now (), d)) fork))
325 else memo_exec execution_id print_process;
329 fun exec execution_id (Eval {eval_process, ...}, prints) =
330 (memo_exec execution_id eval_process; List.app (run_print execution_id) prints);