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
13 type print = {name: string, pri: int, exec_id: Document_ID.exec, print_process: print_process}
14 type exec = eval * print list
16 val exec_ids: exec option -> Document_ID.exec list
17 val read: (unit -> theory) -> Token.T list -> Toplevel.transition
18 val eval: (unit -> theory) -> Token.T list -> eval -> eval
19 val print: bool -> string -> eval -> print list -> print list option
20 type print_fn = Toplevel.transition -> Toplevel.state -> unit
21 val print_function: {name: string, pri: int} -> (string -> print_fn option) -> unit
22 val execute: exec -> unit
23 val stable_eval: eval -> bool
24 val stable_print: print -> bool
27 structure Command: COMMAND =
30 (** memo results -- including physical interrupts! **)
34 Result of 'a Exn.result;
36 abstype 'a memo = Memo of 'a expr Synchronized.var
39 fun memo e = Memo (Synchronized.var "Command.memo" (Expr e));
40 fun memo_value a = Memo (Synchronized.var "Command.memo" (Result (Exn.Res a)));
42 fun memo_eval (Memo v) =
43 (case Synchronized.value v of
46 Synchronized.guarded_access v
47 (fn Result res => SOME (res, Result res)
49 let val res = Exn.capture e (); (*sic!*)
50 in SOME (res, Result res) end))
53 fun memo_fork params (Memo v) =
54 (case Synchronized.value v of
56 | _ => ignore ((singleton o Future.forks) params (fn () => memo_eval (Memo v))));
58 fun memo_result (Memo v) =
59 (case Synchronized.value v of
60 Result res => Exn.release res
61 | _ => raise Fail "Unfinished memo result");
63 fun memo_stable (Memo v) =
64 (case Synchronized.value v of
66 | Result res => not (Exn.is_interrupt_exn res));
72 (** main phases of execution **)
74 (* basic type definitions *)
77 {failed: bool, malformed: bool, command: Toplevel.transition, state: Toplevel.state};
79 {failed = false, malformed = false, command = Toplevel.empty, state = Toplevel.toplevel};
81 type eval_process = eval_state memo;
82 type eval = {exec_id: Document_ID.exec, eval_process: eval_process};
84 fun eval_result ({eval_process, ...}: eval) = memo_result eval_process;
85 val eval_result_state = #state o eval_result;
87 type print_process = unit memo;
88 type print = {name: string, pri: int, exec_id: Document_ID.exec, print_process: print_process};
90 type exec = eval * print list;
91 val no_exec: exec = ({exec_id = Document_ID.none, eval_process = memo_value init_eval_state}, []);
93 fun exec_ids (NONE: exec option) = []
94 | exec_ids (SOME ({exec_id, ...}, prints)) = exec_id :: map #exec_id prints;
99 fun stable_goals exec_id =
100 not (Par_Exn.is_interrupted (Future.join_results (Goal.peek_futures exec_id)));
102 fun stable_eval ({exec_id, eval_process}: eval) =
103 stable_goals exec_id andalso memo_stable eval_process;
105 fun stable_print ({exec_id, print_process, ...}: print) =
106 stable_goals exec_id andalso memo_stable print_process;
113 val outer_syntax = #2 (Outer_Syntax.get_syntax ());
114 val command_reports = Outer_Syntax.command_reports outer_syntax;
117 Position.set_range (Token.position_range_of (#1 (take_suffix Token.is_improper span)));
119 (case find_first Token.is_command span of
120 SOME tok => Token.position_of tok
121 | NONE => proper_range);
123 val (is_malformed, token_reports) = Thy_Syntax.reports_of_tokens span;
124 val _ = Position.reports_text (token_reports @ maps command_reports span);
126 if is_malformed then Toplevel.malformed pos "Malformed command syntax"
128 (case Outer_Syntax.read_spans outer_syntax span of
130 if Keyword.is_control (Toplevel.name_of tr) then
131 Toplevel.malformed pos "Illegal control command"
132 else Toplevel.modify_init init tr
133 | [] => Toplevel.ignored (Position.set_range (Token.position_range_of span))
134 | _ => Toplevel.malformed proper_range "Exactly one command expected")
135 handle ERROR msg => Toplevel.malformed proper_range msg
144 if Goal.future_enabled () andalso Keyword.is_diag (Toplevel.name_of tr) then
145 (Goal.fork_params {name = "Toplevel.diag", pos = Toplevel.pos_of tr, pri = ~1}
146 (fn () => Toplevel.command_exception int tr st); ([], SOME st))
147 else Toplevel.command_errors int tr st;
149 fun check_cmts span tr st' =
150 Toplevel.setmp_thread_position tr
152 Outer_Syntax.side_comments span |> maps (fn cmt =>
153 (Thy_Output.check_text (Token.source_position_of cmt) st'; [])
154 handle exn => ML_Compiler.exn_messages_ids exn)) ();
156 fun proof_status tr st =
157 (case try Toplevel.proof_of st of
158 SOME prf => Toplevel.status tr (Proof.status_markup prf)
161 fun eval_state span tr ({malformed, state = st, ...}: eval_state) =
163 {failed = true, malformed = malformed, command = tr, state = Toplevel.toplevel}
166 val malformed' = Toplevel.is_malformed tr;
167 val is_init = Toplevel.is_init tr;
168 val is_proof = Keyword.is_proof (Toplevel.name_of tr);
170 val _ = Multithreading.interrupted ();
171 val _ = Toplevel.status tr Markup.running;
172 val (errs1, result) = run (is_init orelse is_proof) (Toplevel.set_print false tr) st;
173 val errs2 = (case result of NONE => [] | SOME st' => check_cmts span tr st');
174 val errs = errs1 @ errs2;
175 val _ = Toplevel.status tr Markup.finished;
176 val _ = List.app (Future.error_msg (Toplevel.pos_of tr)) errs;
181 val _ = if null errs then Exn.interrupt () else ();
182 val _ = Toplevel.status tr Markup.failed;
183 in {failed = true, malformed = malformed', command = tr, state = st} end
186 val _ = proof_status tr st';
187 in {failed = false, malformed = malformed', command = tr, state = st'} end)
192 fun eval init span eval0 =
194 val exec_id = Document_ID.make ();
198 Position.setmp_thread_data (Position.id_only (Document_ID.print exec_id))
199 (fn () => read init span |> Toplevel.exec_id exec_id) ();
200 in eval_state span tr (eval_result eval0) end;
201 in {exec_id = exec_id, eval_process = memo process} end;
208 type print_fn = Toplevel.transition -> Toplevel.state -> unit;
212 type print_function = string * (int * (string -> print_fn option));
213 val print_functions = Synchronized.var "Command.print_functions" ([]: print_function list);
215 fun print_error tr e =
216 (Toplevel.setmp_thread_position tr o Runtime.controlled_execution) e () handle exn =>
217 List.app (Future.error_msg (Toplevel.pos_of tr)) (ML_Compiler.exn_messages_ids exn);
221 fun print command_visible command_name eval old_prints =
223 fun new_print (name, (pri, get_print_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')
236 in {name = name, pri = pri, exec_id = exec_id, print_process = memo process} end;
238 (case Exn.capture (Runtime.controlled_execution get_print_fn) command_name of
240 | Exn.Res (SOME print_fn) => SOME (make_print false print_fn)
241 | Exn.Exn exn => SOME (make_print true (fn _ => fn _ => reraise exn)))
245 if command_visible then
246 rev (Synchronized.value print_functions) |> map_filter (fn pr =>
247 (case find_first (equal (fst pr) o #name) old_prints of
248 SOME print => if stable_print print then SOME print else new_print pr
249 | NONE => new_print pr))
250 else filter stable_print old_prints;
252 if eq_list (op = o pairself #exec_id) (old_prints, new_prints) then NONE
256 fun print_function {name, pri} f =
257 Synchronized.change print_functions (fn funs =>
258 (if not (AList.defined (op =) funs name) then ()
259 else warning ("Redefining command print function: " ^ quote name);
260 AList.update (op =) (name, (pri, f)) funs));
265 print_function {name = "print_state", pri = 0} (fn command_name => SOME (fn tr => fn st' =>
267 val is_init = Keyword.is_theory_begin command_name;
268 val is_proof = Keyword.is_proof command_name;
271 (Toplevel.print_of tr orelse (is_proof andalso Toplevel.is_proof st'));
272 in if do_print then Toplevel.print_state false st' else () end));
275 (* overall execution process *)
277 fun run_print ({name, pri, print_process, ...}: print) =
278 (if Multithreading.enabled () then
279 memo_fork {name = name, group = NONE, deps = [], pri = pri, interrupts = true}
280 else memo_eval) print_process;
282 fun execute (({eval_process, ...}, prints): exec) =
283 (memo_eval eval_process; List.app run_print prints);