1 (* Title: Pure/PIDE/command.ML
4 Prover command execution: read -- eval -- print.
9 type blob = (string * (SHA1.digest * string list) option) Exn.result
10 val read_file: Path.T -> Position.T -> Path.T -> Token.file
11 val read: (unit -> theory) -> Path.T -> blob list -> Token.T list -> Toplevel.transition
13 val eval_eq: eval * eval -> bool
14 val eval_running: eval -> bool
15 val eval_finished: eval -> bool
16 val eval_result_state: eval -> Toplevel.state
17 val eval: (unit -> theory) -> Path.T -> blob list -> Token.T list -> eval -> eval
19 val print: bool -> (string * string list) list -> string ->
20 eval -> print list -> print list option
21 type print_fn = Toplevel.transition -> Toplevel.state -> unit
23 {command_name: string, args: string list, exec_id: Document_ID.exec} ->
24 {delay: Time.time option, pri: int, persistent: bool, strict: bool, print_fn: print_fn} option
25 val print_function: string -> print_function -> unit
26 val no_print_function: string -> unit
27 type exec = eval * print list
29 val exec_ids: exec option -> Document_ID.exec list
30 val exec: Document_ID.execution -> exec -> unit
33 structure Command: COMMAND =
39 Expr of Document_ID.exec * (unit -> 'a) |
40 Result of 'a Exn.result;
42 abstype 'a memo = Memo of 'a expr Synchronized.var
45 fun memo exec_id e = Memo (Synchronized.var "Command.memo" (Expr (exec_id, e)));
46 fun memo_value a = Memo (Synchronized.var "Command.memo" (Result (Exn.Res a)));
48 fun memo_result (Memo v) =
49 (case Synchronized.value v of
50 Expr (exec_id, _) => error ("Unfinished execution result: " ^ Document_ID.print exec_id)
51 | Result res => Exn.release res);
53 fun memo_finished (Memo v) =
54 (case Synchronized.value v of Expr _ => false | Result _ => true);
56 fun memo_exec execution_id (Memo v) =
57 Synchronized.timed_access v (K (SOME Time.zeroTime))
60 Expr (exec_id, body) =>
61 uninterruptible (fn restore_attributes => fn () =>
62 let val group = Future.worker_subgroup () in
63 if Execution.running execution_id exec_id [group] then
68 |> Future.task_context "Command.memo_exec" group
69 |> Exn.interruptible_capture) ();
70 in SOME ((), Result res) end
73 | Result _ => SOME ((), expr)))
74 |> (fn NONE => error "Conflicting command execution" | _ => ());
76 fun memo_fork params execution_id (Memo v) =
77 (case Synchronized.value v of
79 | _ => ignore ((singleton o Future.forks) params (fn () => memo_exec execution_id (Memo v))));
85 (** main phases of execution **)
90 (string * (SHA1.digest * string list) option) Exn.result; (*file node name, digest, lines*)
92 fun read_file_node file_node master_dir pos src_path =
94 val _ = Position.report pos Markup.language_path;
96 (case try Url.explode file_node of
98 | SOME (Url.File _) => ()
100 (Position.report pos (Markup.path file_node);
101 error ("Prover cannot load remote file " ^
102 Markup.markup (Markup.path file_node) (quote file_node) ^ Position.here pos)));
103 val full_path = File.check_file (File.full_path master_dir src_path);
104 val _ = Position.report pos (Markup.path (Path.implode full_path));
105 val text = File.read full_path;
106 val lines = split_lines text;
107 val digest = SHA1.digest text;
108 in {src_path = src_path, lines = lines, digest = digest, pos = Path.position full_path} end;
110 val read_file = read_file_node "";
114 fun blob_file src_path lines digest file_node =
117 Position.file file_node |>
118 (case Position.get_id (Position.thread_data ()) of
120 | SOME exec_id => Position.put_id exec_id);
121 in {src_path = src_path, lines = lines, digest = digest, pos = file_pos} end
123 fun resolve_files master_dir blobs toks =
124 (case Thy_Syntax.parse_spans toks of
126 |> Thy_Syntax.resolve_files (fn cmd => fn (path, pos) =>
128 fun make_file src_path (Exn.Res (file_node, NONE)) =
129 Exn.interruptible_capture (fn () =>
130 read_file_node file_node master_dir pos src_path) ()
131 | make_file src_path (Exn.Res (file_node, SOME (digest, lines))) =
132 (Position.reports [(pos, Markup.language_path), (pos, Markup.path file_node)];
133 Exn.Res (blob_file src_path lines digest file_node))
134 | make_file _ (Exn.Exn e) = Exn.Exn e;
135 val src_paths = Keyword.command_files cmd path;
138 map2 make_file src_paths (map (K (Exn.Res ("", NONE))) src_paths)
139 else if length src_paths = length blobs then
140 map2 make_file src_paths blobs
141 else error ("Misalignment of inlined files" ^ Position.here pos)
143 |> Thy_Syntax.span_content
148 fun read init master_dir blobs span =
150 val outer_syntax = #2 (Outer_Syntax.get_syntax ());
151 val command_reports = Outer_Syntax.command_reports outer_syntax;
153 val proper_range = Token.range_of (#1 (take_suffix Token.is_improper span));
155 (case find_first Token.is_command span of
156 SOME tok => Token.pos_of tok
157 | NONE => #1 proper_range);
159 val (is_malformed, token_reports) = Thy_Syntax.reports_of_tokens span;
160 val _ = Position.reports_text (token_reports @ maps command_reports span);
162 if is_malformed then Toplevel.malformed pos "Malformed command syntax"
164 (case Outer_Syntax.read_spans outer_syntax (resolve_files master_dir blobs span) of
166 if Keyword.is_control (Toplevel.name_of tr) then
167 Toplevel.malformed pos "Illegal control command"
168 else Toplevel.modify_init init tr
169 | [] => Toplevel.ignored (#1 (Token.range_of span))
170 | _ => Toplevel.malformed (#1 proper_range) "Exactly one command expected")
171 handle ERROR msg => Toplevel.malformed (#1 proper_range) msg
180 {failed: bool, malformed: bool, command: Toplevel.transition, state: Toplevel.state};
181 val init_eval_state =
182 {failed = false, malformed = false, command = Toplevel.empty, state = Toplevel.toplevel};
184 datatype eval = Eval of {exec_id: Document_ID.exec, eval_process: eval_state memo};
186 fun eval_exec_id (Eval {exec_id, ...}) = exec_id;
187 val eval_eq = op = o pairself eval_exec_id;
189 val eval_running = Execution.is_running_exec o eval_exec_id;
190 fun eval_finished (Eval {eval_process, ...}) = memo_finished eval_process;
192 fun eval_result (Eval {eval_process, ...}) = memo_result eval_process;
193 val eval_result_state = #state o eval_result;
197 fun reset_state tr st0 = Toplevel.setmp_thread_position tr (fn () =>
199 val name = Toplevel.name_of tr;
201 if Keyword.is_theory_body name then Toplevel.reset_theory st0
202 else if Keyword.is_proof name then Toplevel.reset_proof st0
207 | SOME st => (Output.error_message (Toplevel.type_error tr st0 ^ " -- using reset state"); st))
211 if Goal.future_enabled 1 andalso Keyword.is_diag (Toplevel.name_of tr) then
212 (Execution.fork {name = "Toplevel.diag", pos = Toplevel.pos_of tr, pri = ~1}
213 (fn () => Toplevel.command_exception int tr st); ([], SOME st))
214 else Toplevel.command_errors int tr st;
216 fun check_cmts span tr st' =
217 Toplevel.setmp_thread_position tr
219 Outer_Syntax.side_comments span |> maps (fn cmt =>
220 (Thy_Output.check_text (Token.source_position_of cmt) st'; [])
222 if Exn.is_interrupt exn then reraise exn
223 else Runtime.exn_messages_ids exn)) ();
226 Toplevel.setmp_thread_position tr (fn () => Output.report [Markup.markup_only m]) ();
229 Toplevel.setmp_thread_position tr (fn () => Output.status (Markup.markup_only m)) ();
231 fun proof_status tr st =
232 (case try Toplevel.proof_of st of
233 SOME prf => status tr (Proof.status_markup prf)
236 fun eval_state span tr ({malformed, state, ...}: eval_state) =
238 {failed = true, malformed = malformed, command = tr, state = Toplevel.toplevel}
241 val _ = Multithreading.interrupted ();
243 val malformed' = Toplevel.is_malformed tr;
244 val st = reset_state tr state;
246 val _ = status tr Markup.running;
247 val (errs1, result) = run true tr st;
248 val errs2 = (case result of NONE => [] | SOME st' => check_cmts span tr st');
249 val errs = errs1 @ errs2;
250 val _ = List.app (Future.error_message (Toplevel.pos_of tr)) errs;
255 val _ = status tr Markup.failed;
256 val _ = status tr Markup.finished;
257 val _ = if null errs then (report tr Markup.bad; Exn.interrupt ()) else ();
258 in {failed = true, malformed = malformed', command = tr, state = st} end
261 val _ = proof_status tr st';
262 val _ = status tr Markup.finished;
263 in {failed = false, malformed = malformed', command = tr, state = st'} end)
268 fun eval init master_dir blobs span eval0 =
270 val exec_id = Document_ID.make ();
274 Position.setmp_thread_data (Position.id_only (Document_ID.print exec_id))
275 (fn () => read init master_dir blobs span |> Toplevel.exec_id exec_id) ();
276 in eval_state span tr (eval_result eval0) end;
277 in Eval {exec_id = exec_id, eval_process = memo exec_id process} end;
284 datatype print = Print of
285 {name: string, args: string list, delay: Time.time option, pri: int, persistent: bool,
286 exec_id: Document_ID.exec, print_process: unit memo};
288 fun print_exec_id (Print {exec_id, ...}) = exec_id;
289 val print_eq = op = o pairself print_exec_id;
291 type print_fn = Toplevel.transition -> Toplevel.state -> unit;
293 type print_function =
294 {command_name: string, args: string list, exec_id: Document_ID.exec} ->
295 {delay: Time.time option, pri: int, persistent: bool, strict: bool, print_fn: print_fn} option;
299 val print_functions =
300 Synchronized.var "Command.print_functions" ([]: (string * print_function) list);
302 fun print_error tr opt_context e =
303 (Toplevel.setmp_thread_position tr o Runtime.controlled_execution opt_context) e ()
305 if Exn.is_interrupt exn then reraise exn
306 else List.app (Future.error_message (Toplevel.pos_of tr)) (Runtime.exn_messages_ids exn);
308 fun print_finished (Print {print_process, ...}) = memo_finished print_process;
310 fun print_persistent (Print {persistent, ...}) = persistent;
312 val overlay_ord = prod_ord string_ord (list_ord string_ord);
316 fun print command_visible command_overlays command_name eval old_prints =
318 val print_functions = Synchronized.value print_functions;
320 fun make_print name args {delay, pri, persistent, strict, print_fn} =
322 val exec_id = Document_ID.make ();
325 val {failed, command, state = st', ...} = eval_result eval;
326 val tr = Toplevel.exec_id exec_id command;
327 val opt_context = try Toplevel.generic_theory_of st';
329 if failed andalso strict then ()
330 else print_error tr opt_context (fn () => print_fn tr st')
334 name = name, args = args, delay = delay, pri = pri, persistent = persistent,
335 exec_id = exec_id, print_process = memo exec_id process}
338 fun bad_print name args exn =
339 make_print name args {delay = NONE, pri = 0, persistent = false,
340 strict = false, print_fn = fn _ => fn _ => reraise exn};
342 fun new_print name args get_pr =
344 val params = {command_name = command_name, args = args, exec_id = eval_exec_id eval};
346 (case Exn.capture (Runtime.controlled_execution NONE get_pr) params of
348 | Exn.Res (SOME pr) => SOME (make_print name args pr)
349 | Exn.Exn exn => SOME (bad_print name args exn))
352 fun get_print (a, b) =
353 (case find_first (fn Print {name, args, ...} => name = a andalso args = b) old_prints of
355 (case AList.lookup (op =) print_functions a of
356 NONE => SOME (bad_print a b (ERROR ("Missing print function " ^ quote a)))
357 | SOME get_pr => new_print a b get_pr)
361 if command_visible then
362 fold (fn (a, _) => cons (a, [])) print_functions command_overlays
363 |> sort_distinct overlay_ord
364 |> map_filter get_print
365 else filter (fn print => print_finished print andalso print_persistent print) old_prints;
367 if eq_list print_eq (old_prints, new_prints) then NONE else SOME new_prints
370 fun print_function name f =
371 Synchronized.change print_functions (fn funs =>
372 (if not (AList.defined (op =) funs name) then ()
373 else warning ("Redefining command print function: " ^ quote name);
374 AList.update (op =) (name, f) funs));
376 fun no_print_function name =
377 Synchronized.change print_functions (filter_out (equal name o #1));
382 print_function "Execution.print"
383 (fn {args, exec_id, ...} =>
385 SOME {delay = NONE, pri = 1, persistent = false, strict = false,
386 print_fn = fn _ => fn _ => Execution.fork_prints exec_id}
390 print_function "print_state"
391 (fn {command_name, ...} =>
392 if Keyword.is_printed command_name then
393 SOME {delay = NONE, pri = 1, persistent = false, strict = true,
394 print_fn = fn _ => fn st => if Toplevel.is_proof st then Toplevel.print_state st else ()}
398 (* combined execution *)
400 type exec = eval * print list;
402 (Eval {exec_id = Document_ID.none, eval_process = memo_value init_eval_state}, []);
404 fun exec_ids NONE = []
405 | exec_ids (SOME (eval, prints)) = eval_exec_id eval :: map print_exec_id prints;
409 fun run_print execution_id (Print {name, delay, pri, print_process, ...}) =
410 if pri <= 0 orelse (Multithreading.enabled () andalso Options.default_bool "parallel_print")
413 val group = Future.worker_subgroup ();
415 memo_fork {name = name, group = SOME group, deps = [], pri = pri, interrupts = true}
416 execution_id print_process;
420 | SOME d => ignore (Event_Timer.request (Time.+ (Time.now (), d)) fork))
422 else memo_exec execution_id print_process;
426 fun exec execution_id (Eval {eval_process, ...}, prints) =
427 (memo_exec execution_id eval_process; List.app (run_print execution_id) prints);