1 (* Title: Pure/PIDE/command.ML
4 Prover command execution: read -- eval -- print.
9 type blob = (string * string) Exn.result
10 val read: (unit -> theory) -> blob list -> Token.T list -> Toplevel.transition
12 val eval_eq: eval * eval -> bool
13 val eval_running: eval -> bool
14 val eval_finished: eval -> bool
15 val eval_result_state: eval -> Toplevel.state
16 val eval: (unit -> theory) -> blob list -> Token.T list -> eval -> eval
18 val print: bool -> (string * string list) list -> string ->
19 eval -> print list -> print list option
20 type print_fn = Toplevel.transition -> Toplevel.state -> unit
22 {command_name: string, args: string list} ->
23 {delay: Time.time option, pri: int, persistent: bool, strict: bool, print_fn: print_fn} option
24 val print_function: string -> print_function -> unit
25 val no_print_function: string -> unit
26 type exec = eval * print list
28 val exec_ids: exec option -> Document_ID.exec list
29 val exec: Document_ID.execution -> exec -> unit
32 structure Command: COMMAND =
38 Expr of Document_ID.exec * (unit -> 'a) |
39 Result of 'a Exn.result;
41 abstype 'a memo = Memo of 'a expr Synchronized.var
44 fun memo exec_id e = Memo (Synchronized.var "Command.memo" (Expr (exec_id, e)));
45 fun memo_value a = Memo (Synchronized.var "Command.memo" (Result (Exn.Res a)));
47 fun memo_result (Memo v) =
48 (case Synchronized.value v of
49 Expr (exec_id, _) => error ("Unfinished execution result: " ^ Document_ID.print exec_id)
50 | Result res => Exn.release res);
52 fun memo_finished (Memo v) =
53 (case Synchronized.value v of Expr _ => false | Result _ => true);
55 fun memo_exec execution_id (Memo v) =
56 Synchronized.timed_access v (K (SOME Time.zeroTime))
59 Expr (exec_id, body) =>
60 uninterruptible (fn restore_attributes => fn () =>
61 if Execution.running execution_id exec_id [Future.the_worker_group ()] then
66 |> Future.worker_nest "Command.memo_exec"
67 |> Exn.interruptible_capture) ();
68 in SOME ((), Result res) end
69 else SOME ((), expr)) ()
70 | Result _ => SOME ((), expr)))
71 |> (fn NONE => error "Conflicting command execution" | _ => ());
73 fun memo_fork params execution_id (Memo v) =
74 (case Synchronized.value v of
76 | _ => ignore ((singleton o Future.forks) params (fn () => memo_exec execution_id (Memo v))));
82 (** main phases of execution **)
86 type blob = (string * string) Exn.result; (*file node name, digest or text*)
88 fun resolve_files blobs toks =
89 (case Thy_Syntax.parse_spans toks of
91 |> Thy_Syntax.resolve_files (fn cmd => fn (path, pos) =>
93 fun make_file src_path (Exn.Res (file, text)) =
94 let val _ = Position.report pos (Markup.path file);
95 in Exn.Res {src_path = src_path, text = text, pos = Position.file file} end
96 | make_file _ (Exn.Exn e) = Exn.Exn e;
98 val src_paths = Keyword.command_files cmd path;
100 if null blobs then []
101 else if length src_paths <> length blobs then
102 error ("Misalignment of inlined files" ^ Position.here pos)
103 else map2 make_file src_paths blobs
105 |> Thy_Syntax.span_content
108 fun read init blobs span =
110 val outer_syntax = #2 (Outer_Syntax.get_syntax ());
111 val command_reports = Outer_Syntax.command_reports outer_syntax;
114 Position.set_range (Token.position_range_of (#1 (take_suffix Token.is_improper span)));
116 (case find_first Token.is_command span of
117 SOME tok => Token.position_of tok
118 | NONE => proper_range);
120 val (is_malformed, token_reports) = Thy_Syntax.reports_of_tokens span;
121 val _ = Position.reports_text (token_reports @ maps command_reports span);
123 if is_malformed then Toplevel.malformed pos "Malformed command syntax"
125 (case Outer_Syntax.read_spans outer_syntax (resolve_files blobs span) of
127 if Keyword.is_control (Toplevel.name_of tr) then
128 Toplevel.malformed pos "Illegal control command"
129 else Toplevel.modify_init init tr
130 | [] => Toplevel.ignored (Position.set_range (Token.position_range_of span))
131 | _ => Toplevel.malformed proper_range "Exactly one command expected")
132 handle ERROR msg => Toplevel.malformed proper_range msg
139 {failed: bool, malformed: bool, command: Toplevel.transition, state: Toplevel.state};
140 val init_eval_state =
141 {failed = false, malformed = false, command = Toplevel.empty, state = Toplevel.toplevel};
143 datatype eval = Eval of {exec_id: Document_ID.exec, eval_process: eval_state memo};
145 fun eval_eq (Eval {exec_id, ...}, Eval {exec_id = exec_id', ...}) = exec_id = exec_id';
147 fun eval_running (Eval {exec_id, ...}) = Execution.is_running_exec exec_id;
148 fun eval_finished (Eval {eval_process, ...}) = memo_finished eval_process;
150 fun eval_result (Eval {eval_process, ...}) = memo_result eval_process;
151 val eval_result_state = #state o eval_result;
156 if Goal.future_enabled 1 andalso Keyword.is_diag (Toplevel.name_of tr) then
157 (Execution.fork {name = "Toplevel.diag", pos = Toplevel.pos_of tr, pri = ~1}
158 (fn () => Toplevel.command_exception int tr st); ([], SOME st))
159 else Toplevel.command_errors int tr st;
161 fun check_cmts span tr st' =
162 Toplevel.setmp_thread_position tr
164 Outer_Syntax.side_comments span |> maps (fn cmt =>
165 (Thy_Output.check_text (Token.source_position_of cmt) st'; [])
167 if Exn.is_interrupt exn then reraise exn
168 else ML_Compiler.exn_messages_ids exn)) ();
170 fun proof_status tr st =
171 (case try Toplevel.proof_of st of
172 SOME prf => Toplevel.status tr (Proof.status_markup prf)
175 fun eval_state span tr ({malformed, state = st, ...}: eval_state) =
177 {failed = true, malformed = malformed, command = tr, state = Toplevel.toplevel}
180 val malformed' = Toplevel.is_malformed tr;
181 val is_init = Toplevel.is_init tr;
182 val is_proof = Keyword.is_proof (Toplevel.name_of tr);
184 val _ = Multithreading.interrupted ();
185 val _ = Toplevel.status tr Markup.running;
186 val (errs1, result) = run (is_init orelse is_proof) (Toplevel.set_print false tr) st;
187 val errs2 = (case result of NONE => [] | SOME st' => check_cmts span tr st');
188 val errs = errs1 @ errs2;
189 val _ = Toplevel.status tr Markup.finished;
190 val _ = List.app (Future.error_msg (Toplevel.pos_of tr)) errs;
195 val _ = if null errs then Exn.interrupt () else ();
196 val _ = Toplevel.status tr Markup.failed;
197 in {failed = true, malformed = malformed', command = tr, state = st} end
200 val _ = proof_status tr st';
201 in {failed = false, malformed = malformed', command = tr, state = st'} end)
206 fun eval init blobs span eval0 =
208 val exec_id = Document_ID.make ();
212 Position.setmp_thread_data (Position.id_only (Document_ID.print exec_id))
213 (fn () => read init blobs span |> Toplevel.exec_id exec_id) ();
214 in eval_state span tr (eval_result eval0) end;
215 in Eval {exec_id = exec_id, eval_process = memo exec_id process} end;
222 datatype print = Print of
223 {name: string, args: string list, delay: Time.time option, pri: int, persistent: bool,
224 exec_id: Document_ID.exec, print_process: unit memo};
226 type print_fn = Toplevel.transition -> Toplevel.state -> unit;
228 type print_function =
229 {command_name: string, args: string list} ->
230 {delay: Time.time option, pri: int, persistent: bool, strict: bool, print_fn: print_fn} option;
234 val print_functions =
235 Synchronized.var "Command.print_functions" ([]: (string * print_function) list);
237 fun print_error tr e =
238 (Toplevel.setmp_thread_position tr o Toplevel.controlled_execution) e ()
240 if Exn.is_interrupt exn then reraise exn
241 else List.app (Future.error_msg (Toplevel.pos_of tr)) (ML_Compiler.exn_messages_ids exn);
243 fun print_eq (Print {exec_id, ...}, Print {exec_id = exec_id', ...}) = exec_id = exec_id';
245 fun print_finished (Print {print_process, ...}) = memo_finished print_process;
247 fun print_persistent (Print {persistent, ...}) = persistent;
249 val overlay_ord = prod_ord string_ord (list_ord string_ord);
253 fun print command_visible command_overlays command_name eval old_prints =
255 val print_functions = Synchronized.value print_functions;
257 fun make_print name args {delay, pri, persistent, strict, print_fn} =
259 val exec_id = Document_ID.make ();
262 val {failed, command, state = st', ...} = eval_result eval;
263 val tr = Toplevel.exec_id exec_id command;
265 if failed andalso strict then ()
266 else print_error tr (fn () => print_fn tr st')
270 name = name, args = args, delay = delay, pri = pri, persistent = persistent,
271 exec_id = exec_id, print_process = memo exec_id process}
274 fun bad_print name args exn =
275 make_print name args {delay = NONE, pri = 0, persistent = false,
276 strict = false, print_fn = fn _ => fn _ => reraise exn};
278 fun new_print name args get_pr =
280 val params = {command_name = command_name, args = args};
282 (case Exn.capture (Toplevel.controlled_execution get_pr) params of
284 | Exn.Res (SOME pr) => SOME (make_print name args pr)
285 | Exn.Exn exn => SOME (bad_print name args exn))
288 fun get_print (a, b) =
289 (case find_first (fn Print {name, args, ...} => name = a andalso args = b) old_prints of
291 (case AList.lookup (op =) print_functions a of
292 NONE => SOME (bad_print a b (ERROR ("Missing print function " ^ quote a)))
293 | SOME get_pr => new_print a b get_pr)
297 if command_visible then
298 fold (fn (a, _) => cons (a, [])) print_functions command_overlays
299 |> sort_distinct overlay_ord
300 |> map_filter get_print
301 else filter (fn print => print_finished print andalso print_persistent print) old_prints;
303 if eq_list print_eq (old_prints, new_prints) then NONE else SOME new_prints
306 fun print_function name f =
307 Synchronized.change print_functions (fn funs =>
308 (if not (AList.defined (op =) funs name) then ()
309 else warning ("Redefining command print function: " ^ quote name);
310 AList.update (op =) (name, f) funs));
312 fun no_print_function name =
313 Synchronized.change print_functions (filter_out (equal name o #1));
318 print_function "print_state"
319 (fn {command_name, ...} =>
320 SOME {delay = NONE, pri = 1, persistent = false, strict = true,
321 print_fn = fn tr => fn st' =>
323 val is_init = Keyword.is_theory_begin command_name;
324 val is_proof = Keyword.is_proof command_name;
327 (Toplevel.print_of tr orelse (is_proof andalso Toplevel.is_proof st'));
328 in if do_print then Toplevel.print_state false st' else () end});
331 (* combined execution *)
333 type exec = eval * print list;
335 (Eval {exec_id = Document_ID.none, eval_process = memo_value init_eval_state}, []);
337 fun exec_ids NONE = []
338 | exec_ids (SOME (Eval {exec_id, ...}, prints)) =
339 exec_id :: map (fn Print {exec_id, ...} => exec_id) prints;
343 fun run_print execution_id (Print {name, delay, pri, print_process, ...}) =
344 if Multithreading.enabled () orelse pri <= 0 then
346 val group = Future.worker_subgroup ();
348 memo_fork {name = name, group = SOME group, deps = [], pri = pri, interrupts = true}
349 execution_id print_process;
353 | SOME d => ignore (Event_Timer.request (Time.+ (Time.now (), d)) fork))
355 else memo_exec execution_id print_process;
359 fun exec execution_id (Eval {eval_process, ...}, prints) =
360 (memo_exec execution_id eval_process; List.app (run_print execution_id) prints);