1 (* Title: Pure/PIDE/command.ML
4 Prover command execution: read -- eval -- print.
10 type eval = {exec_id: Document_ID.exec, eval_process: eval_process}
11 val eval_result_state: eval -> Toplevel.state
12 val eval_same: eval * eval -> bool
15 {name: string, pri: int, persistent: bool,
16 exec_id: Document_ID.exec, print_process: print_process}
17 type exec = eval * print list
19 val exec_ids: exec option -> Document_ID.exec list
20 val read: (unit -> theory) -> Token.T list -> Toplevel.transition
21 val eval: (unit -> theory) -> Token.T list -> eval -> eval
22 val print: bool -> string -> eval -> print list -> print list option
23 type print_fn = Toplevel.transition -> Toplevel.state -> unit
24 val print_function: {name: string, pri: int, persistent: bool} ->
25 ({command_name: string} -> print_fn option) -> unit
26 val no_print_function: string -> unit
27 val execute: exec -> unit
30 structure Command: COMMAND =
33 (** memo results -- including physical interrupts! **)
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 Result res => Exn.release res
48 | _ => raise Fail "Unfinished memo result");
50 fun memo_exec (Memo v) =
51 (case Synchronized.value v of
54 Synchronized.guarded_access v
55 (fn Result res => SOME (res, Result res)
56 | Expr (exec_id, e) =>
57 uninterruptible (fn restore_attributes => fn () =>
59 val _ = Exec.running exec_id;
60 val res = Exn.capture (restore_attributes e) ();
62 if Exn.is_interrupt_exn res
63 then Exec.canceled exec_id
64 else Exec.finished exec_id;
65 in SOME (res, Result res) end) ()))
68 fun memo_fork params (Memo v) =
69 (case Synchronized.value v of
71 | _ => ignore ((singleton o Future.forks) params (fn () => memo_exec (Memo v))));
77 (** main phases of execution **)
79 (* type definitions *)
82 {failed: bool, malformed: bool, command: Toplevel.transition, state: Toplevel.state};
84 {failed = false, malformed = false, command = Toplevel.empty, state = Toplevel.toplevel};
86 type eval_process = eval_state memo;
87 type eval = {exec_id: Document_ID.exec, eval_process: eval_process};
89 fun eval_result ({eval_process, ...}: eval) = memo_result eval_process;
90 val eval_result_state = #state o eval_result;
92 fun eval_same ({exec_id, ...}: eval, {exec_id = exec_id', ...}: eval) =
93 exec_id = exec_id' andalso Exec.is_stable exec_id;
95 type print_process = unit memo;
97 {name: string, pri: int, persistent: bool,
98 exec_id: Document_ID.exec, print_process: print_process};
100 type exec = eval * print list;
101 val no_exec: exec = ({exec_id = Document_ID.none, eval_process = memo_value init_eval_state}, []);
103 fun exec_ids (NONE: exec option) = []
104 | exec_ids (SOME ({exec_id, ...}, prints)) = exec_id :: map #exec_id prints;
111 val outer_syntax = #2 (Outer_Syntax.get_syntax ());
112 val command_reports = Outer_Syntax.command_reports outer_syntax;
115 Position.set_range (Token.position_range_of (#1 (take_suffix Token.is_improper span)));
117 (case find_first Token.is_command span of
118 SOME tok => Token.position_of tok
119 | NONE => proper_range);
121 val (is_malformed, token_reports) = Thy_Syntax.reports_of_tokens span;
122 val _ = Position.reports_text (token_reports @ maps command_reports span);
124 if is_malformed then Toplevel.malformed pos "Malformed command syntax"
126 (case Outer_Syntax.read_spans outer_syntax span of
128 if Keyword.is_control (Toplevel.name_of tr) then
129 Toplevel.malformed pos "Illegal control command"
130 else Toplevel.modify_init init tr
131 | [] => Toplevel.ignored (Position.set_range (Token.position_range_of span))
132 | _ => Toplevel.malformed proper_range "Exactly one command expected")
133 handle ERROR msg => Toplevel.malformed proper_range msg
142 if Goal.future_enabled () andalso Keyword.is_diag (Toplevel.name_of tr) then
143 (Goal.fork_params {name = "Toplevel.diag", pos = Toplevel.pos_of tr, pri = ~1}
144 (fn () => Toplevel.command_exception int tr st); ([], SOME st))
145 else Toplevel.command_errors int tr st;
147 fun check_cmts span tr st' =
148 Toplevel.setmp_thread_position tr
150 Outer_Syntax.side_comments span |> maps (fn cmt =>
151 (Thy_Output.check_text (Token.source_position_of cmt) st'; [])
152 handle exn => ML_Compiler.exn_messages_ids exn)) ();
154 fun proof_status tr st =
155 (case try Toplevel.proof_of st of
156 SOME prf => Toplevel.status tr (Proof.status_markup prf)
159 fun eval_state span tr ({malformed, state = st, ...}: eval_state) =
161 {failed = true, malformed = malformed, command = tr, state = Toplevel.toplevel}
164 val malformed' = Toplevel.is_malformed tr;
165 val is_init = Toplevel.is_init tr;
166 val is_proof = Keyword.is_proof (Toplevel.name_of tr);
168 val _ = Multithreading.interrupted ();
169 val _ = Toplevel.status tr Markup.running;
170 val (errs1, result) = run (is_init orelse is_proof) (Toplevel.set_print false tr) st;
171 val errs2 = (case result of NONE => [] | SOME st' => check_cmts span tr st');
172 val errs = errs1 @ errs2;
173 val _ = Toplevel.status tr Markup.finished;
174 val _ = List.app (Future.error_msg (Toplevel.pos_of tr)) errs;
179 val _ = if null errs then Exn.interrupt () else ();
180 val _ = Toplevel.status tr Markup.failed;
181 in {failed = true, malformed = malformed', command = tr, state = st} end
184 val _ = proof_status tr st';
185 in {failed = false, malformed = malformed', command = tr, state = st'} end)
190 fun eval init span eval0 =
192 val exec_id = Document_ID.make ();
196 Position.setmp_thread_data (Position.id_only (Document_ID.print exec_id))
197 (fn () => read init span |> Toplevel.exec_id exec_id) ();
198 in eval_state span tr (eval_result eval0) end;
199 in {exec_id = exec_id, eval_process = memo exec_id process} end;
206 type print_fn = Toplevel.transition -> Toplevel.state -> unit;
210 type print_function = string * (int * bool * ({command_name: string} -> print_fn option));
211 val print_functions = Synchronized.var "Command.print_functions" ([]: print_function list);
213 fun print_error tr e =
214 (Toplevel.setmp_thread_position tr o Runtime.controlled_execution) e () handle exn =>
215 List.app (Future.error_msg (Toplevel.pos_of tr)) (ML_Compiler.exn_messages_ids exn);
217 fun print_stable (print: print) = Exec.is_stable (#exec_id print);
221 fun print command_visible command_name eval old_prints =
223 fun new_print (name, (pri, persistent, get_fn)) =
225 fun make_print strict print_fn =
227 val exec_id = Document_ID.make ();
230 val {failed, command, state = st', ...} = eval_result eval;
231 val tr = Toplevel.exec_id exec_id command;
233 if failed andalso not strict then ()
234 else print_error tr (fn () => print_fn tr st')
237 {name = name, pri = pri, persistent = persistent,
238 exec_id = exec_id, print_process = memo exec_id process}
241 (case Exn.capture (Runtime.controlled_execution get_fn) {command_name = command_name} of
243 | Exn.Res (SOME print_fn) => SOME (make_print false print_fn)
244 | Exn.Exn exn => SOME (make_print true (fn _ => fn _ => reraise exn)))
248 if command_visible then
249 rev (Synchronized.value print_functions) |> map_filter (fn pr =>
250 (case find_first (equal (fst pr) o #name) old_prints of
251 SOME print => if print_stable print then SOME print else new_print pr
252 | NONE => new_print pr))
253 else filter (fn print => #persistent print andalso print_stable print) old_prints;
255 if eq_list (op = o pairself #exec_id) (old_prints, new_prints) then NONE
259 fun print_function {name, pri, persistent} f =
260 Synchronized.change print_functions (fn funs =>
261 (if not (AList.defined (op =) funs name) then ()
262 else warning ("Redefining command print function: " ^ quote name);
263 AList.update (op =) (name, (pri, persistent, f)) funs));
265 fun no_print_function name =
266 Synchronized.change print_functions (filter_out (equal name o #1));
271 print_function {name = "print_state", pri = 0, persistent = true}
272 (fn {command_name} => SOME (fn tr => fn st' =>
274 val is_init = Keyword.is_theory_begin command_name;
275 val is_proof = Keyword.is_proof command_name;
278 (Toplevel.print_of tr orelse (is_proof andalso Toplevel.is_proof st'));
279 in if do_print then Toplevel.print_state false st' else () end));
282 (* combined execution process *)
284 fun run_print ({name, pri, print_process, ...}: print) =
285 (if Multithreading.enabled () then
286 memo_fork {name = name, group = NONE, deps = [], pri = pri, interrupts = true}
287 else memo_exec) print_process;
289 fun execute (({eval_process, ...}, prints): exec) =
290 (memo_exec eval_process; List.app run_print prints);