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_result_state: eval -> Toplevel.state
13 val eval: (unit -> theory) -> Token.T list -> eval -> eval
15 val print: bool -> string -> eval -> print list -> print list option
16 type print_fn = Toplevel.transition -> Toplevel.state -> unit
17 val print_function: string ->
18 ({command_name: string} ->
19 {delay: Time.time, pri: int, persistent: bool, print_fn: print_fn} option) -> unit
20 val no_print_function: string -> unit
21 type exec = eval * print list
23 val exec_ids: exec option -> Document_ID.exec list
24 val exec: Document_ID.execution -> exec -> unit
27 structure Command: COMMAND =
30 (** memo results -- including physical interrupts **)
33 Expr of Document_ID.exec * (unit -> 'a) |
34 Result of 'a Exn.result;
36 abstype 'a memo = Memo of 'a expr Synchronized.var
39 fun memo exec_id e = Memo (Synchronized.var "Command.memo" (Expr (exec_id, e)));
40 fun memo_value a = Memo (Synchronized.var "Command.memo" (Result (Exn.Res a)));
42 fun memo_result (Memo v) =
43 (case Synchronized.value v of
44 Expr (exec_id, _) => error ("Unfinished execution result: " ^ Document_ID.print exec_id)
45 | Result res => Exn.release res);
47 fun memo_finished (Memo v) =
48 (case Synchronized.value v of
50 | Result res => not (Exn.is_interrupt_exn res));
52 fun memo_exec execution_id (Memo v) =
53 Synchronized.guarded_access v
57 uninterruptible (fn restore_attributes => fn () =>
58 if Execution.running execution_id exec_id then
60 val res = Exn.capture (restore_attributes e) ();
61 val _ = Execution.finished exec_id;
62 in SOME (Exn.is_interrupt_exn res, Result res) end
63 else SOME (true, expr)) ()
64 | Result _ => SOME (false, expr)))
65 |> (fn true => Exn.interrupt () | false => ());
67 fun memo_fork params execution_id (Memo v) =
68 (case Synchronized.value v of
70 | _ => ignore ((singleton o Future.forks) params (fn () => memo_exec execution_id (Memo v))));
76 (** main phases of execution **)
82 val outer_syntax = #2 (Outer_Syntax.get_syntax ());
83 val command_reports = Outer_Syntax.command_reports outer_syntax;
86 Position.set_range (Token.position_range_of (#1 (take_suffix Token.is_improper span)));
88 (case find_first Token.is_command span of
89 SOME tok => Token.position_of tok
90 | NONE => proper_range);
92 val (is_malformed, token_reports) = Thy_Syntax.reports_of_tokens span;
93 val _ = Position.reports_text (token_reports @ maps command_reports span);
95 if is_malformed then Toplevel.malformed pos "Malformed command syntax"
97 (case Outer_Syntax.read_spans outer_syntax span of
99 if Keyword.is_control (Toplevel.name_of tr) then
100 Toplevel.malformed pos "Illegal control command"
101 else Toplevel.modify_init init tr
102 | [] => Toplevel.ignored (Position.set_range (Token.position_range_of span))
103 | _ => Toplevel.malformed proper_range "Exactly one command expected")
104 handle ERROR msg => Toplevel.malformed proper_range msg
111 {failed: bool, malformed: bool, command: Toplevel.transition, state: Toplevel.state};
112 val init_eval_state =
113 {failed = false, malformed = false, command = Toplevel.empty, state = Toplevel.toplevel};
115 datatype eval = Eval of {exec_id: Document_ID.exec, eval_process: eval_state memo};
117 fun eval_eq (Eval {exec_id, ...}, Eval {exec_id = exec_id', ...}) = exec_id = exec_id';
119 fun eval_result (Eval {eval_process, ...}) = memo_result eval_process;
120 val eval_result_state = #state o eval_result;
125 if Goal.future_enabled () andalso Keyword.is_diag (Toplevel.name_of tr) then
126 (Goal.fork_params {name = "Toplevel.diag", pos = Toplevel.pos_of tr, pri = ~1}
127 (fn () => Toplevel.command_exception int tr st); ([], SOME st))
128 else Toplevel.command_errors int tr st;
130 fun check_cmts span tr st' =
131 Toplevel.setmp_thread_position tr
133 Outer_Syntax.side_comments span |> maps (fn cmt =>
134 (Thy_Output.check_text (Token.source_position_of cmt) st'; [])
136 if Exn.is_interrupt exn then reraise exn
137 else ML_Compiler.exn_messages_ids exn)) ();
139 fun proof_status tr st =
140 (case try Toplevel.proof_of st of
141 SOME prf => Toplevel.status tr (Proof.status_markup prf)
144 fun eval_state span tr ({malformed, state = st, ...}: eval_state) =
146 {failed = true, malformed = malformed, command = tr, state = Toplevel.toplevel}
149 val malformed' = Toplevel.is_malformed tr;
150 val is_init = Toplevel.is_init tr;
151 val is_proof = Keyword.is_proof (Toplevel.name_of tr);
153 val _ = Multithreading.interrupted ();
154 val _ = Toplevel.status tr Markup.running;
155 val (errs1, result) = run (is_init orelse is_proof) (Toplevel.set_print false tr) st;
156 val errs2 = (case result of NONE => [] | SOME st' => check_cmts span tr st');
157 val errs = errs1 @ errs2;
158 val _ = Toplevel.status tr Markup.finished;
159 val _ = List.app (Future.error_msg (Toplevel.pos_of tr)) errs;
164 val _ = if null errs then Exn.interrupt () else ();
165 val _ = Toplevel.status tr Markup.failed;
166 in {failed = true, malformed = malformed', command = tr, state = st} end
169 val _ = proof_status tr st';
170 in {failed = false, malformed = malformed', command = tr, state = st'} end)
175 fun eval init span eval0 =
177 val exec_id = Document_ID.make ();
181 Position.setmp_thread_data (Position.id_only (Document_ID.print exec_id))
182 (fn () => read init span |> Toplevel.exec_id exec_id) ();
183 in eval_state span tr (eval_result eval0) end;
184 in Eval {exec_id = exec_id, eval_process = memo exec_id process} end;
191 datatype print = Print of
192 {name: string, delay: Time.time, pri: int, persistent: bool,
193 exec_id: Document_ID.exec, print_process: unit memo};
195 type print_fn = Toplevel.transition -> Toplevel.state -> unit;
197 type print_function =
198 {command_name: string} ->
199 {delay: Time.time, pri: int, persistent: bool, print_fn: print_fn} option;
203 val print_functions =
204 Synchronized.var "Command.print_functions" ([]: (string * print_function) list);
206 fun print_error tr e =
207 (Toplevel.setmp_thread_position tr o Runtime.controlled_execution) e ()
209 if Exn.is_interrupt exn then reraise exn
210 else List.app (Future.error_msg (Toplevel.pos_of tr)) (ML_Compiler.exn_messages_ids exn);
212 fun print_eq (Print {exec_id, ...}, Print {exec_id = exec_id', ...}) = exec_id = exec_id';
214 fun print_finished (Print {exec_id, print_process, ...}) = memo_finished print_process;
216 fun print_persistent (Print {persistent, ...}) = persistent;
220 fun print command_visible command_name eval old_prints =
222 fun new_print (name, get_pr) =
224 fun make_print strict {delay, pri, persistent, print_fn} =
226 val exec_id = Document_ID.make ();
229 val {failed, command, state = st', ...} = eval_result eval;
230 val tr = Toplevel.exec_id exec_id command;
232 if failed andalso not strict then ()
233 else print_error tr (fn () => print_fn tr st')
237 name = name, delay = delay, pri = pri, persistent = persistent,
238 exec_id = exec_id, print_process = memo exec_id process}
241 (case Exn.capture (Runtime.controlled_execution get_pr) {command_name = command_name} of
243 | Exn.Res (SOME pr) => SOME (make_print false pr)
245 SOME (make_print true
246 {delay = Time.zeroTime, pri = 0, persistent = false,
247 print_fn = fn _ => fn _ => reraise exn}))
251 if command_visible then
252 rev (Synchronized.value print_functions) |> map_filter (fn pr =>
253 (case find_first (fn Print {name, ...} => name = fst pr) old_prints of
256 else filter (fn print => print_finished print andalso print_persistent print) old_prints;
258 if eq_list print_eq (old_prints, new_prints) then NONE else SOME new_prints
261 fun print_function name 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, f) funs));
267 fun no_print_function name =
268 Synchronized.change print_functions (filter_out (equal name o #1));
273 print_function "print_state"
274 (fn {command_name} =>
275 SOME {delay = Time.zeroTime, pri = 1, persistent = true,
276 print_fn = fn tr => fn st' =>
278 val is_init = Keyword.is_theory_begin command_name;
279 val is_proof = Keyword.is_proof command_name;
282 (Toplevel.print_of tr orelse (is_proof andalso Toplevel.is_proof st'));
283 in if do_print then Toplevel.print_state false st' else () end});
286 (* combined execution *)
288 type exec = eval * print list;
290 (Eval {exec_id = Document_ID.none, eval_process = memo_value init_eval_state}, []);
292 fun exec_ids NONE = []
293 | exec_ids (SOME (Eval {exec_id, ...}, prints)) =
294 exec_id :: map (fn Print {exec_id, ...} => exec_id) prints;
298 fun run_print execution_id (Print {name, delay, pri, print_process, ...}) =
299 if Multithreading.enabled () then
301 val group = Future.worker_subgroup ();
303 memo_fork {name = name, group = SOME group, deps = [], pri = pri, interrupts = true}
304 execution_id print_process;
306 if delay = Time.zeroTime then fork ()
307 else ignore (Event_Timer.request (Time.+ (Time.now (), delay)) fork)
309 else memo_exec execution_id print_process;
313 fun exec execution_id (Eval {eval_process, ...}, prints) =
314 (memo_exec execution_id eval_process; List.app (run_print execution_id) prints);