more official task context via Task_Queue.enroll, which is required to participate in group cancellation (e.g. to terminate command exec);
tuned signature;
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
21 {command_name: string, args: string list} ->
22 {delay: Time.time option, pri: int, persistent: bool, strict: bool, print_fn: print_fn} option
23 val print_function: string -> print_function -> unit
24 val no_print_function: string -> unit
25 type exec = eval * print list
27 val exec_ids: exec option -> Document_ID.exec list
28 val exec: Document_ID.execution -> exec -> unit
31 structure Command: COMMAND =
37 Expr of Document_ID.exec * (unit -> 'a) |
38 Result of 'a Exn.result;
40 abstype 'a memo = Memo of 'a expr Synchronized.var
43 fun memo exec_id e = Memo (Synchronized.var "Command.memo" (Expr (exec_id, e)));
44 fun memo_value a = Memo (Synchronized.var "Command.memo" (Result (Exn.Res a)));
46 fun memo_result (Memo v) =
47 (case Synchronized.value v of
48 Expr (exec_id, _) => error ("Unfinished execution result: " ^ Document_ID.print exec_id)
49 | Result res => Exn.release res);
51 fun memo_finished (Memo v) =
52 (case Synchronized.value v of Expr _ => false | Result _ => true);
54 fun memo_exec execution_id (Memo v) =
55 Synchronized.timed_access v (K (SOME Time.zeroTime))
58 Expr (exec_id, body) =>
59 uninterruptible (fn restore_attributes => fn () =>
60 let val group = Future.worker_subgroup () in
61 if Execution.running execution_id exec_id [group] then
66 |> Future.task_context "Command.memo_exec" group
67 |> Exn.interruptible_capture) ();
68 in SOME ((), Result res) end
71 | Result _ => SOME ((), expr)))
72 |> (fn NONE => error "Conflicting command execution" | _ => ());
74 fun memo_fork params execution_id (Memo v) =
75 (case Synchronized.value v of
77 | _ => ignore ((singleton o Future.forks) params (fn () => memo_exec execution_id (Memo v))));
83 (** main phases of execution **)
89 val outer_syntax = #2 (Outer_Syntax.get_syntax ());
90 val command_reports = Outer_Syntax.command_reports outer_syntax;
93 Position.set_range (Token.position_range_of (#1 (take_suffix Token.is_improper span)));
95 (case find_first Token.is_command span of
96 SOME tok => Token.position_of tok
97 | NONE => proper_range);
99 val (is_malformed, token_reports) = Thy_Syntax.reports_of_tokens span;
100 val _ = Position.reports_text (token_reports @ maps command_reports span);
102 if is_malformed then Toplevel.malformed pos "Malformed command syntax"
104 (case Outer_Syntax.read_spans outer_syntax span of
106 if Keyword.is_control (Toplevel.name_of tr) then
107 Toplevel.malformed pos "Illegal control command"
108 else Toplevel.modify_init init tr
109 | [] => Toplevel.ignored (Position.set_range (Token.position_range_of span))
110 | _ => Toplevel.malformed proper_range "Exactly one command expected")
111 handle ERROR msg => Toplevel.malformed proper_range msg
118 {failed: bool, malformed: bool, command: Toplevel.transition, state: Toplevel.state};
119 val init_eval_state =
120 {failed = false, malformed = false, command = Toplevel.empty, state = Toplevel.toplevel};
122 datatype eval = Eval of {exec_id: Document_ID.exec, eval_process: eval_state memo};
124 fun eval_eq (Eval {exec_id, ...}, Eval {exec_id = exec_id', ...}) = exec_id = exec_id';
126 fun eval_running (Eval {exec_id, ...}) = Execution.is_running_exec exec_id;
127 fun eval_finished (Eval {eval_process, ...}) = memo_finished eval_process;
129 fun eval_result (Eval {eval_process, ...}) = memo_result eval_process;
130 val eval_result_state = #state o eval_result;
135 if Goal.future_enabled 1 andalso Keyword.is_diag (Toplevel.name_of tr) then
136 (Execution.fork {name = "Toplevel.diag", pos = Toplevel.pos_of tr, pri = ~1}
137 (fn () => Toplevel.command_exception int tr st); ([], SOME st))
138 else Toplevel.command_errors int tr st;
140 fun check_cmts span tr st' =
141 Toplevel.setmp_thread_position tr
143 Outer_Syntax.side_comments span |> maps (fn cmt =>
144 (Thy_Output.check_text (Token.source_position_of cmt) st'; [])
146 if Exn.is_interrupt exn then reraise exn
147 else ML_Compiler.exn_messages_ids exn)) ();
149 fun proof_status tr st =
150 (case try Toplevel.proof_of st of
151 SOME prf => Toplevel.status tr (Proof.status_markup prf)
154 fun eval_state span tr ({malformed, state = st, ...}: eval_state) =
156 {failed = true, malformed = malformed, command = tr, state = Toplevel.toplevel}
159 val malformed' = Toplevel.is_malformed tr;
160 val is_init = Toplevel.is_init tr;
161 val is_proof = Keyword.is_proof (Toplevel.name_of tr);
163 val _ = Multithreading.interrupted ();
164 val _ = Toplevel.status tr Markup.running;
165 val (errs1, result) = run (is_init orelse is_proof) (Toplevel.set_print false tr) st;
166 val errs2 = (case result of NONE => [] | SOME st' => check_cmts span tr st');
167 val errs = errs1 @ errs2;
168 val _ = List.app (Future.error_msg (Toplevel.pos_of tr)) errs;
173 val _ = Toplevel.status tr Markup.failed;
174 val _ = Toplevel.status tr Markup.finished;
175 val _ = if null errs then Exn.interrupt () else ();
176 in {failed = true, malformed = malformed', command = tr, state = st} end
179 val _ = proof_status tr st';
180 val _ = Toplevel.status tr Markup.finished;
181 in {failed = false, malformed = malformed', command = tr, state = st'} end)
186 fun eval init span eval0 =
188 val exec_id = Document_ID.make ();
192 Position.setmp_thread_data (Position.id_only (Document_ID.print exec_id))
193 (fn () => read init span |> Toplevel.exec_id exec_id) ();
194 in eval_state span tr (eval_result eval0) end;
195 in Eval {exec_id = exec_id, eval_process = memo exec_id process} end;
202 datatype print = Print of
203 {name: string, args: string list, delay: Time.time option, pri: int, persistent: bool,
204 exec_id: Document_ID.exec, print_process: unit memo};
206 type print_fn = Toplevel.transition -> Toplevel.state -> unit;
208 type print_function =
209 {command_name: string, args: string list} ->
210 {delay: Time.time option, pri: int, persistent: bool, strict: bool, print_fn: print_fn} option;
214 val print_functions =
215 Synchronized.var "Command.print_functions" ([]: (string * print_function) list);
217 fun print_error tr e =
218 (Toplevel.setmp_thread_position tr o Toplevel.controlled_execution) e ()
220 if Exn.is_interrupt exn then reraise exn
221 else List.app (Future.error_msg (Toplevel.pos_of tr)) (ML_Compiler.exn_messages_ids exn);
223 fun print_eq (Print {exec_id, ...}, Print {exec_id = exec_id', ...}) = exec_id = exec_id';
225 fun print_finished (Print {print_process, ...}) = memo_finished print_process;
227 fun print_persistent (Print {persistent, ...}) = persistent;
229 val overlay_ord = prod_ord string_ord (list_ord string_ord);
233 fun print command_visible command_overlays command_name eval old_prints =
235 val print_functions = Synchronized.value print_functions;
237 fun make_print name args {delay, pri, persistent, strict, print_fn} =
239 val exec_id = Document_ID.make ();
242 val {failed, command, state = st', ...} = eval_result eval;
243 val tr = Toplevel.exec_id exec_id command;
245 if failed andalso strict then ()
246 else print_error tr (fn () => print_fn tr st')
250 name = name, args = args, delay = delay, pri = pri, persistent = persistent,
251 exec_id = exec_id, print_process = memo exec_id process}
254 fun bad_print name args exn =
255 make_print name args {delay = NONE, pri = 0, persistent = false,
256 strict = false, print_fn = fn _ => fn _ => reraise exn};
258 fun new_print name args get_pr =
260 val params = {command_name = command_name, args = args};
262 (case Exn.capture (Toplevel.controlled_execution get_pr) params of
264 | Exn.Res (SOME pr) => SOME (make_print name args pr)
265 | Exn.Exn exn => SOME (bad_print name args exn))
268 fun get_print (a, b) =
269 (case find_first (fn Print {name, args, ...} => name = a andalso args = b) old_prints of
271 (case AList.lookup (op =) print_functions a of
272 NONE => SOME (bad_print a b (ERROR ("Missing print function " ^ quote a)))
273 | SOME get_pr => new_print a b get_pr)
277 if command_visible then
278 fold (fn (a, _) => cons (a, [])) print_functions command_overlays
279 |> sort_distinct overlay_ord
280 |> map_filter get_print
281 else filter (fn print => print_finished print andalso print_persistent print) old_prints;
283 if eq_list print_eq (old_prints, new_prints) then NONE else SOME new_prints
286 fun print_function name f =
287 Synchronized.change print_functions (fn funs =>
288 (if not (AList.defined (op =) funs name) then ()
289 else warning ("Redefining command print function: " ^ quote name);
290 AList.update (op =) (name, f) funs));
292 fun no_print_function name =
293 Synchronized.change print_functions (filter_out (equal name o #1));
298 print_function "print_state"
299 (fn {command_name, ...} =>
300 SOME {delay = NONE, pri = 1, persistent = false, strict = true,
301 print_fn = fn tr => fn st' =>
303 val is_init = Keyword.is_theory_begin command_name;
304 val is_proof = Keyword.is_proof command_name;
307 (Toplevel.print_of tr orelse (is_proof andalso Toplevel.is_proof st'));
308 in if do_print then Toplevel.print_state false st' else () end});
311 (* combined execution *)
313 type exec = eval * print list;
315 (Eval {exec_id = Document_ID.none, eval_process = memo_value init_eval_state}, []);
317 fun exec_ids NONE = []
318 | exec_ids (SOME (Eval {exec_id, ...}, prints)) =
319 exec_id :: map (fn Print {exec_id, ...} => exec_id) prints;
323 fun run_print execution_id (Print {name, delay, pri, print_process, ...}) =
324 if Multithreading.enabled () orelse pri <= 0 then
326 val group = Future.worker_subgroup ();
328 memo_fork {name = name, group = SOME group, deps = [], pri = pri, interrupts = true}
329 execution_id print_process;
333 | SOME d => ignore (Event_Timer.request (Time.+ (Time.now (), d)) fork))
335 else memo_exec execution_id print_process;
339 fun exec execution_id (Eval {eval_process, ...}, prints) =
340 (memo_exec execution_id eval_process; List.app (run_print execution_id) prints);