src/Pure/PIDE/command.ML
author wenzelm
Fri Feb 28 11:46:54 2014 +0100 (2014-02-28)
changeset 55798 985bd3a325ab
parent 55788 67699e08e969
child 56034 1c59b555ac4a
permissions -rw-r--r--
tuned signature;
     1 (*  Title:      Pure/PIDE/command.ML
     2     Author:     Makarius
     3 
     4 Prover command execution: read -- eval -- print.
     5 *)
     6 
     7 signature COMMAND =
     8 sig
     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
    12   type eval
    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
    18   type print
    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
    22   type print_function =
    23     {command_name: string, args: string list} ->
    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
    28   val no_exec: exec
    29   val exec_ids: exec option -> Document_ID.exec list
    30   val exec: Document_ID.execution -> exec -> unit
    31 end;
    32 
    33 structure Command: COMMAND =
    34 struct
    35 
    36 (** memo results **)
    37 
    38 datatype 'a expr =
    39   Expr of Document_ID.exec * (unit -> 'a) |
    40   Result of 'a Exn.result;
    41 
    42 abstype 'a memo = Memo of 'a expr Synchronized.var
    43 with
    44 
    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)));
    47 
    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);
    52 
    53 fun memo_finished (Memo v) =
    54   (case Synchronized.value v of Expr _ => false | Result _ => true);
    55 
    56 fun memo_exec execution_id (Memo v) =
    57   Synchronized.timed_access v (K (SOME Time.zeroTime))
    58     (fn expr =>
    59       (case expr of
    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
    64                 let
    65                   val res =
    66                     (body
    67                       |> restore_attributes
    68                       |> Future.task_context "Command.memo_exec" group
    69                       |> Exn.interruptible_capture) ();
    70                 in SOME ((), Result res) end
    71               else SOME ((), expr)
    72             end) ()
    73       | Result _ => SOME ((), expr)))
    74   |> (fn NONE => error "Conflicting command execution" | _ => ());
    75 
    76 fun memo_fork params execution_id (Memo v) =
    77   (case Synchronized.value v of
    78     Result _ => ()
    79   | _ => ignore ((singleton o Future.forks) params (fn () => memo_exec execution_id (Memo v))));
    80 
    81 end;
    82 
    83 
    84 
    85 (** main phases of execution **)
    86 
    87 (* read *)
    88 
    89 type blob =
    90   (string * (SHA1.digest * string list) option) Exn.result;  (*file node name, digest, lines*)
    91 
    92 fun read_file master_dir pos src_path =
    93   let
    94     val full_path = File.check_file (File.full_path master_dir src_path);
    95     val _ = Position.report pos (Markup.path (Path.implode full_path));
    96     val text = File.read full_path;
    97     val lines = split_lines text;
    98     val digest = SHA1.digest text;
    99   in {src_path = src_path, lines = lines, digest = digest, pos = Path.position full_path} end;
   100 
   101 local
   102 
   103 fun blob_file src_path lines digest file =
   104   let
   105     val file_pos =
   106       Position.file file (*sic!*) |>
   107       (case Position.get_id (Position.thread_data ()) of
   108         NONE => I
   109       | SOME exec_id => Position.put_id exec_id);
   110   in {src_path = src_path, lines = lines, digest = digest, pos = file_pos} end
   111 
   112 fun resolve_files master_dir blobs toks =
   113   (case Thy_Syntax.parse_spans toks of
   114     [span] => span
   115       |> Thy_Syntax.resolve_files (fn cmd => fn (path, pos) =>
   116         let
   117           fun make_file src_path (Exn.Res (_, NONE)) =
   118                 Exn.interruptible_capture (fn () => read_file master_dir pos src_path) ()
   119             | make_file src_path (Exn.Res (file, SOME (digest, lines))) =
   120                (Position.report pos (Markup.path file);
   121                 Exn.Res (blob_file src_path lines digest file))
   122             | make_file _ (Exn.Exn e) = Exn.Exn e;
   123           val src_paths = Keyword.command_files cmd path;
   124         in
   125           if null blobs then
   126             map2 make_file src_paths (map (K (Exn.Res ("", NONE))) src_paths)
   127           else if length src_paths = length blobs then
   128             map2 make_file src_paths blobs
   129           else error ("Misalignment of inlined files" ^ Position.here pos)
   130         end)
   131       |> Thy_Syntax.span_content
   132   | _ => toks);
   133 
   134 in
   135 
   136 fun read init master_dir blobs span =
   137   let
   138     val outer_syntax = #2 (Outer_Syntax.get_syntax ());
   139     val command_reports = Outer_Syntax.command_reports outer_syntax;
   140 
   141     val proper_range = Token.range_of (#1 (take_suffix Token.is_improper span));
   142     val pos =
   143       (case find_first Token.is_command span of
   144         SOME tok => Token.pos_of tok
   145       | NONE => #1 proper_range);
   146 
   147     val (is_malformed, token_reports) = Thy_Syntax.reports_of_tokens span;
   148     val _ = Position.reports_text (token_reports @ maps command_reports span);
   149   in
   150     if is_malformed then Toplevel.malformed pos "Malformed command syntax"
   151     else
   152       (case Outer_Syntax.read_spans outer_syntax (resolve_files master_dir blobs span) of
   153         [tr] =>
   154           if Keyword.is_control (Toplevel.name_of tr) then
   155             Toplevel.malformed pos "Illegal control command"
   156           else Toplevel.modify_init init tr
   157       | [] => Toplevel.ignored (#1 (Token.range_of span))
   158       | _ => Toplevel.malformed (#1 proper_range) "Exactly one command expected")
   159       handle ERROR msg => Toplevel.malformed (#1 proper_range) msg
   160   end;
   161 
   162 end;
   163 
   164 
   165 (* eval *)
   166 
   167 type eval_state =
   168   {failed: bool, malformed: bool, command: Toplevel.transition, state: Toplevel.state};
   169 val init_eval_state =
   170   {failed = false, malformed = false, command = Toplevel.empty, state = Toplevel.toplevel};
   171 
   172 datatype eval = Eval of {exec_id: Document_ID.exec, eval_process: eval_state memo};
   173 
   174 fun eval_eq (Eval {exec_id, ...}, Eval {exec_id = exec_id', ...}) = exec_id = exec_id';
   175 
   176 fun eval_running (Eval {exec_id, ...}) = Execution.is_running_exec exec_id;
   177 fun eval_finished (Eval {eval_process, ...}) = memo_finished eval_process;
   178 
   179 fun eval_result (Eval {eval_process, ...}) = memo_result eval_process;
   180 val eval_result_state = #state o eval_result;
   181 
   182 local
   183 
   184 fun run int tr st =
   185   if Goal.future_enabled 1 andalso Keyword.is_diag (Toplevel.name_of tr) then
   186     (Execution.fork {name = "Toplevel.diag", pos = Toplevel.pos_of tr, pri = ~1}
   187       (fn () => Toplevel.command_exception int tr st); ([], SOME st))
   188   else Toplevel.command_errors int tr st;
   189 
   190 fun check_cmts span tr st' =
   191   Toplevel.setmp_thread_position tr
   192     (fn () =>
   193       Outer_Syntax.side_comments span |> maps (fn cmt =>
   194         (Thy_Output.check_text (Token.source_position_of cmt) st'; [])
   195           handle exn =>
   196             if Exn.is_interrupt exn then reraise exn
   197             else ML_Compiler.exn_messages_ids exn)) ();
   198 
   199 fun report tr m =
   200   Toplevel.setmp_thread_position tr (fn () => Output.report (Markup.markup_only m)) ();
   201 
   202 fun status tr m =
   203   Toplevel.setmp_thread_position tr (fn () => Output.status (Markup.markup_only m)) ();
   204 
   205 fun proof_status tr st =
   206   (case try Toplevel.proof_of st of
   207     SOME prf => status tr (Proof.status_markup prf)
   208   | NONE => ());
   209 
   210 fun eval_state span tr ({malformed, state = st, ...}: eval_state) =
   211   if malformed then
   212     {failed = true, malformed = malformed, command = tr, state = Toplevel.toplevel}
   213   else
   214     let
   215       val malformed' = Toplevel.is_malformed tr;
   216       val is_init = Toplevel.is_init tr;
   217       val is_proof = Keyword.is_proof (Toplevel.name_of tr);
   218 
   219       val _ = Multithreading.interrupted ();
   220       val _ = status tr Markup.running;
   221       val (errs1, result) = run (is_init orelse is_proof) (Toplevel.set_print false tr) st;
   222       val errs2 = (case result of NONE => [] | SOME st' => check_cmts span tr st');
   223       val errs = errs1 @ errs2;
   224       val _ = List.app (Future.error_msg (Toplevel.pos_of tr)) errs;
   225     in
   226       (case result of
   227         NONE =>
   228           let
   229             val _ = status tr Markup.failed;
   230             val _ = status tr Markup.finished;
   231             val _ = if null errs then (report tr Markup.bad; Exn.interrupt ()) else ();
   232           in {failed = true, malformed = malformed', command = tr, state = st} end
   233       | SOME st' =>
   234           let
   235             val _ = proof_status tr st';
   236             val _ = status tr Markup.finished;
   237           in {failed = false, malformed = malformed', command = tr, state = st'} end)
   238     end;
   239 
   240 in
   241 
   242 fun eval init master_dir blobs span eval0 =
   243   let
   244     val exec_id = Document_ID.make ();
   245     fun process () =
   246       let
   247         val tr =
   248           Position.setmp_thread_data (Position.id_only (Document_ID.print exec_id))
   249             (fn () => read init master_dir blobs span |> Toplevel.exec_id exec_id) ();
   250       in eval_state span tr (eval_result eval0) end;
   251   in Eval {exec_id = exec_id, eval_process = memo exec_id process} end;
   252 
   253 end;
   254 
   255 
   256 (* print *)
   257 
   258 datatype print = Print of
   259  {name: string, args: string list, delay: Time.time option, pri: int, persistent: bool,
   260   exec_id: Document_ID.exec, print_process: unit memo};
   261 
   262 type print_fn = Toplevel.transition -> Toplevel.state -> unit;
   263 
   264 type print_function =
   265   {command_name: string, args: string list} ->
   266     {delay: Time.time option, pri: int, persistent: bool, strict: bool, print_fn: print_fn} option;
   267 
   268 local
   269 
   270 val print_functions =
   271   Synchronized.var "Command.print_functions" ([]: (string * print_function) list);
   272 
   273 fun print_error tr e =
   274   (Toplevel.setmp_thread_position tr o Toplevel.controlled_execution) e ()
   275     handle exn =>
   276       if Exn.is_interrupt exn then reraise exn
   277       else List.app (Future.error_msg (Toplevel.pos_of tr)) (ML_Compiler.exn_messages_ids exn);
   278 
   279 fun print_eq (Print {exec_id, ...}, Print {exec_id = exec_id', ...}) = exec_id = exec_id';
   280 
   281 fun print_finished (Print {print_process, ...}) = memo_finished print_process;
   282 
   283 fun print_persistent (Print {persistent, ...}) = persistent;
   284 
   285 val overlay_ord = prod_ord string_ord (list_ord string_ord);
   286 
   287 in
   288 
   289 fun print command_visible command_overlays command_name eval old_prints =
   290   let
   291     val print_functions = Synchronized.value print_functions;
   292 
   293     fun make_print name args {delay, pri, persistent, strict, print_fn} =
   294       let
   295         val exec_id = Document_ID.make ();
   296         fun process () =
   297           let
   298             val {failed, command, state = st', ...} = eval_result eval;
   299             val tr = Toplevel.exec_id exec_id command;
   300           in
   301             if failed andalso strict then ()
   302             else print_error tr (fn () => print_fn tr st')
   303           end;
   304       in
   305         Print {
   306           name = name, args = args, delay = delay, pri = pri, persistent = persistent,
   307           exec_id = exec_id, print_process = memo exec_id process}
   308       end;
   309 
   310     fun bad_print name args exn =
   311       make_print name args {delay = NONE, pri = 0, persistent = false,
   312         strict = false, print_fn = fn _ => fn _ => reraise exn};
   313 
   314     fun new_print name args get_pr =
   315       let
   316         val params = {command_name = command_name, args = args};
   317       in
   318         (case Exn.capture (Toplevel.controlled_execution get_pr) params of
   319           Exn.Res NONE => NONE
   320         | Exn.Res (SOME pr) => SOME (make_print name args pr)
   321         | Exn.Exn exn => SOME (bad_print name args exn))
   322       end;
   323 
   324     fun get_print (a, b) =
   325       (case find_first (fn Print {name, args, ...} => name = a andalso args = b) old_prints of
   326         NONE =>
   327           (case AList.lookup (op =) print_functions a of
   328             NONE => SOME (bad_print a b (ERROR ("Missing print function " ^ quote a)))
   329           | SOME get_pr => new_print a b get_pr)
   330       | some => some);
   331 
   332     val new_prints =
   333       if command_visible then
   334         fold (fn (a, _) => cons (a, [])) print_functions command_overlays
   335         |> sort_distinct overlay_ord
   336         |> map_filter get_print
   337       else filter (fn print => print_finished print andalso print_persistent print) old_prints;
   338   in
   339     if eq_list print_eq (old_prints, new_prints) then NONE else SOME new_prints
   340   end;
   341 
   342 fun print_function name f =
   343   Synchronized.change print_functions (fn funs =>
   344    (if not (AList.defined (op =) funs name) then ()
   345     else warning ("Redefining command print function: " ^ quote name);
   346     AList.update (op =) (name, f) funs));
   347 
   348 fun no_print_function name =
   349   Synchronized.change print_functions (filter_out (equal name o #1));
   350 
   351 end;
   352 
   353 val _ =
   354   print_function "print_state"
   355     (fn {command_name, ...} =>
   356       SOME {delay = NONE, pri = 1, persistent = false, strict = true,
   357         print_fn = fn tr => fn st' =>
   358           let
   359             val is_init = Keyword.is_theory_begin command_name;
   360             val is_proof = Keyword.is_proof command_name;
   361             val do_print =
   362               not is_init andalso
   363                 (Toplevel.print_of tr orelse (is_proof andalso Toplevel.is_proof st'));
   364           in if do_print then Toplevel.print_state false st' else () end});
   365 
   366 
   367 (* combined execution *)
   368 
   369 type exec = eval * print list;
   370 val no_exec: exec =
   371   (Eval {exec_id = Document_ID.none, eval_process = memo_value init_eval_state}, []);
   372 
   373 fun exec_ids NONE = []
   374   | exec_ids (SOME (Eval {exec_id, ...}, prints)) =
   375       exec_id :: map (fn Print {exec_id, ...} => exec_id) prints;
   376 
   377 local
   378 
   379 fun run_print execution_id (Print {name, delay, pri, print_process, ...}) =
   380   if Multithreading.enabled () orelse pri <= 0 then
   381     let
   382       val group = Future.worker_subgroup ();
   383       fun fork () =
   384         memo_fork {name = name, group = SOME group, deps = [], pri = pri, interrupts = true}
   385           execution_id print_process;
   386     in
   387       (case delay of
   388         NONE => fork ()
   389       | SOME d => ignore (Event_Timer.request (Time.+ (Time.now (), d)) fork))
   390     end
   391   else memo_exec execution_id print_process;
   392 
   393 in
   394 
   395 fun exec execution_id (Eval {eval_process, ...}, prints) =
   396   (memo_exec execution_id eval_process; List.app (run_print execution_id) prints);
   397 
   398 end;
   399 
   400 end;
   401