1 (* Copyright (C) 2004-2005, HELM Team.
3 * This file is part of HELM, an Hypertextual, Electronic
4 * Library of Mathematics, developed at the Computer Science
5 * Department, University of Bologna, Italy.
7 * HELM is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
12 * HELM is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with HELM; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
22 * For details, see the HELM World-Wide-Web page,
23 * http://helm.cs.unibo.it/
30 let debug_print = if debug then prerr_endline else ignore
32 (** raised when one of the script margins (top or bottom) is reached *)
35 let safe_substring s i j =
36 try String.sub s i j with Invalid_argument _ -> assert false
38 let heading_nl_RE = Pcre.regexp "^\\s*\n\\s*"
39 let only_dust_RE = Pcre.regexp "^(\\s|\n|%%[^\n]*\n)*$"
40 let multiline_RE = Pcre.regexp "^\n[^\n]+$"
41 let newline_RE = Pcre.regexp "\n"
44 if Pcre.pmatch ~rex:multiline_RE str then
45 "\n(** " ^ (Pcre.replace ~rex:newline_RE str) ^ " **)"
47 "\n(**\n" ^ str ^ "\n**)"
50 let s = Pcre.replace ~rex:heading_nl_RE s in
52 let nl_pos = String.index s '\n' in
56 let prepend_text header base =
57 if Pcre.pmatch ~rex:heading_nl_RE base then
58 sprintf "\n%s%s" header base
60 sprintf "%s\n%s" header base
62 (** creates a statement AST for the Goal tactic, e.g. "goal 7" *)
64 let module A = TacticAst in
65 let loc = CicAst.dummy_floc in
66 A.Executable (loc, A.Tactical (loc, A.Tactic (loc, A.Goal (loc, n))))
68 let eval_with_engine status user_goal parsed_text st =
69 let module TA = TacticAst in
70 let module TAPp = TacticAstPp in
71 let parsed_text_length = String.length parsed_text in
73 match st with TA.Executable (loc,ex) -> loc, ex | _ -> assert false
75 let goal_changed = ref false in
77 match status.proof_status with
78 | Incomplete_proof (_, goal) when goal <> user_goal ->
81 ~do_heavy_checks:true status (goal_ast user_goal)
84 let new_status = MatitaEngine.eval_ast ~do_heavy_checks:true status st in
87 | TA.Command (_, TA.Alias _)
88 | TA.Command (_, TA.Include _) -> DisambiguateTypes.Environment.empty
89 | _ -> MatitaSync.alias_diff ~from:status new_status
91 (* we remove the defined object since we consider them "automathic aliases" *)
93 let module DTE = DisambiguateTypes.Environment in
94 let module UM = UriManager in
96 fun k ((v,_) as value) acc ->
99 let v = UM.strip_xpointer (UM.uri_of_string v) in
100 List.exists (fun (s,_) -> s = v) new_status.objects
101 with UM.IllFormedUri _ -> false
107 ) new_aliases DTE.empty
110 if DisambiguateTypes.Environment.is_empty new_aliases then
113 prepend_text (CicTextualParser2.EnvironmentP3.to_string new_aliases)
117 if !goal_changed then
119 (TAPp.pp_tactic (TA.Goal (loc, user_goal))(* ^ "\n"*))
124 [ new_status, new_text ], parsed_text_length
126 let disambiguate term status =
127 let module MD = MatitaDisambiguator in
128 let dbd = MatitaDb.instance () in
129 let metasenv = MatitaMisc.get_proof_metasenv status in
130 let context = MatitaMisc.get_proof_context status in
131 let aliases = MatitaMisc.get_proof_aliases status in
132 let interps = MD.disambiguate_term dbd context metasenv aliases term in
137 let eval_macro status (mathviewer:MatitaTypes.mathViewer) urichooser
138 parsed_text script mac
140 let module TA = TacticAst in
141 let module TAPp = TacticAstPp in
142 let module MQ = MetadataQuery in
143 let module MDB = MatitaDb in
144 let module CTC = CicTypeChecker in
145 let module CU = CicUniv in
146 (* no idea why ocaml wants this *)
147 let advance ?statement () = script#advance ?statement () in
148 let parsed_text_length = String.length parsed_text in
149 let dbd = MatitaDb.instance () in
152 | TA.WMatch (loc, term) ->
153 let term = disambiguate term status in
154 let l = MQ.match_term ~dbd term in
155 let entry = `Whelp (TAPp.pp_macro_cic (TA.WMatch (loc, term)), l) in
156 mathviewer#show_uri_list ~reuse:true ~entry l;
157 [], parsed_text_length
158 | TA.WInstance (loc, term) ->
159 let term = disambiguate term status in
160 let l = MQ.instance ~dbd term in
161 let entry = `Whelp (TAPp.pp_macro_cic (TA.WInstance (loc, term)), l) in
162 mathviewer#show_uri_list ~reuse:true ~entry l;
163 [], parsed_text_length
164 | TA.WLocate (loc, s) ->
165 let l = MQ.locate ~dbd s in
166 let entry = `Whelp (TAPp.pp_macro_cic (TA.WLocate (loc, s)), l) in
167 mathviewer#show_uri_list ~reuse:true ~entry l;
168 [], parsed_text_length
169 | TA.WElim (loc, term) ->
170 let term = disambiguate term status in
173 | Cic.MutInd (uri,n,_) -> UriManager.uri_of_uriref uri n None
174 | _ -> failwith "Not a MutInd"
176 let l = MQ.elim ~dbd uri in
177 let entry = `Whelp (TAPp.pp_macro_cic (TA.WElim (loc, term)), l) in
178 mathviewer#show_uri_list ~reuse:true ~entry l;
179 [], parsed_text_length
180 | TA.WHint (loc, term) ->
181 let term = disambiguate term status in
182 let s = ((None,[0,[],term], Cic.Meta (0,[]) ,term),0) in
183 let l = List.map fst (MQ.experimental_hint ~dbd s) in
184 let entry = `Whelp (TAPp.pp_macro_cic (TA.WHint (loc, term)), l) in
185 mathviewer#show_uri_list ~reuse:true ~entry l;
186 [], parsed_text_length
189 let s = MatitaMisc.get_proof_status status in
190 let l = List.map fst (MQ.experimental_hint ~dbd s) in
191 let selected = urichooser l in
193 | [] -> [], parsed_text_length
199 TA.Apply (loc, CicAst.Uri (UriManager.string_of_uri uri,None))))))
201 let new_status = MatitaEngine.eval_ast status ast in
203 comment parsed_text ^
204 "\n" ^ TAPp.pp_statement ast
206 [ new_status , extra_text ], parsed_text_length
209 "The result of the urichooser should be only 1 uri, not:\n";
211 fun u -> MatitaLog.error (UriManager.string_of_uri u ^ "\n")
214 | TA.Check (_,term) ->
215 let metasenv = MatitaMisc.get_proof_metasenv status in
216 let context = MatitaMisc.get_proof_context status in
217 let aliases = MatitaMisc.get_proof_aliases status in
219 MatitaDisambiguator.disambiguate_term
220 dbd context metasenv aliases term
222 let _, metasenv , term, ugraph =
227 let ty,_ = CTC.type_of_aux' metasenv context term ugraph in
228 let t_and_ty = Cic.Cast (term,ty) in
229 mathviewer#show_entry (`Cic (t_and_ty,metasenv));
230 [], parsed_text_length
233 let status = script#status.proof_status in
236 | _ -> script#retract ();go_back()
238 [], parsed_text_length, Some go_back
239 | TA.Redo (_, Some i) -> [], parsed_text_length,
240 Some (fun () -> for j = 1 to i do advance () done)
241 | TA.Redo (_, None) -> [], parsed_text_length,
242 Some (fun () -> advance ())
243 | TA.Undo (_, Some i) -> [], parsed_text_length,
244 Some (fun () -> for j = 1 to i do script#retract () done)
245 | TA.Undo (_, None) -> [], parsed_text_length,
246 Some (fun () -> script#retract ()) *)
248 | TA.Quit _ -> failwith "not implemented"
249 | TA.Print (_,kind) -> failwith "not implemented"
250 | TA.Search_pat (_, search_kind, str) -> failwith "not implemented"
251 | TA.Search_term (_, search_kind, term) -> failwith "not implemented"
254 let eval_executable status (mathviewer:MatitaTypes.mathViewer) urichooser
255 ask_confirmation user_goal parsed_text script ex =
256 let module TA = TacticAst in
257 let module TAPp = TacticAstPp in
258 let module MD = MatitaDisambiguator in
259 let module ML = MatitacleanLib in
260 let parsed_text_length = String.length parsed_text in
262 | TA.Command (loc, _) | TA.Tactical (loc, _) ->
264 (match ML.baseuri_of_baseuri_decl (TA.Executable (loc,ex)) with
267 if not (MatitacleanLib.is_empty u) then
270 ~title:"Baseuri redefinition"
272 "Baseuri " ^ u ^ " already exists.\n" ^
273 "Do you want to redefine the corresponding "^
274 "part of the library?")
276 | `YES -> MatitacleanLib.clean_baseuris [u]
278 | `CANCEL -> raise MatitaTypes.Cancel);
279 eval_with_engine status user_goal parsed_text (TA.Executable (loc, ex))
280 with MatitaTypes.Cancel -> [], 0)
281 | TA.Macro (_,mac) ->
282 eval_macro status mathviewer urichooser parsed_text script mac
284 let rec eval_statement status (mathviewer:MatitaTypes.mathViewer) urichooser
285 ask_confirmation user_goal script s =
286 if Pcre.pmatch ~rex:only_dust_RE s then raise Margin;
287 let st = CicTextualParser2.parse_statement (Stream.of_string s) in
288 let text_of_loc loc =
289 let parsed_text_length = snd (CicAst.loc_of_floc loc) in
290 let parsed_text = safe_substring s 0 parsed_text_length in
291 parsed_text, parsed_text_length
294 | TacticAst.Comment (loc,_)->
295 let parsed_text, parsed_text_length = text_of_loc loc in
296 let remain_len = String.length s - parsed_text_length in
297 let s = String.sub s parsed_text_length remain_len in
299 eval_statement status
300 mathviewer urichooser ask_confirmation user_goal script s
303 | (status, text) :: tl ->
304 ((status, parsed_text ^ text)::tl), (parsed_text_length + len)
306 | TacticAst.Executable (loc, ex) ->
307 let parsed_text, parsed_text_length = text_of_loc loc in
309 status mathviewer urichooser ask_confirmation
310 user_goal parsed_text script ex
312 let fresh_script_id =
316 class script ~(buffer: GText.buffer) ~(init: MatitaTypes.status)
317 ~(mathviewer: MatitaTypes.mathViewer)
322 val mutable filename = None
323 val scriptId = fresh_script_id ()
324 method private getFilename =
325 match filename with Some f -> f | _ -> assert false
326 method private ppFilename =
327 match filename with Some f -> f | None -> sprintf ".unnamed%d.ma" scriptId
330 ignore(GMain.Timeout.add ~ms:300000
331 ~callback:(fun _ -> self#_saveToBackuptFile ();true));
332 ignore(buffer#connect#modified_changed
333 (fun _ -> if buffer#modified then
334 set_star self#ppFilename true
336 set_star self#ppFilename false));
340 val mutable statements = []; (** executed statements *)
341 val mutable history = [ init ];
342 (** list of states before having executed statements. Head element of this
343 * list is the current state, last element is the state at the beginning of
345 * Invariant: this list length is 1 + length of statements *)
347 (** goal as seen by the user (i.e. metano corresponding to current tab) *)
348 val mutable userGoal = ~-1
349 val mutable lock_mark_pos = 0
351 (** text mark and tag representing locked part of a script *)
353 buffer#create_mark ~name:"locked" ~left_gravity:true buffer#start_iter
354 val locked_tag = buffer#create_tag [`BACKGROUND "lightblue"; `EDITABLE false]
356 (* history can't be empty, the invariant above grant that it contains at
357 * least the init status *)
358 method status = match history with hd :: _ -> hd | _ -> assert false
360 method private _advance ?statement () =
361 let s = match statement with Some s -> s | None -> self#getFuture in
362 MatitaLog.debug ("evaluating: " ^ first_line s ^ " ...");
363 let (entries, parsed_len) =
364 eval_statement self#status
365 mathviewer urichooser ask_confirmation userGoal self s
367 let (new_statuses, new_statements) = List.split entries in
369 prerr_endline "evalStatement returned";
370 List.iter (fun s -> prerr_endline ("'" ^ s ^ "'")) new_statements;
372 history <- List.rev new_statuses @ history;
373 statements <- List.rev new_statements @ statements;
374 let start = buffer#get_iter_at_mark (`MARK locked_mark) in
375 let new_text = String.concat "" new_statements in
376 if new_text <> String.sub s 0 parsed_len then
378 (* prerr_endline ("new:" ^ new_text); *)
379 (* prerr_endline ("s:" ^ String.sub s 0 parsed_len); *)
380 let stop = start#copy#forward_chars parsed_len in
381 buffer#delete ~start ~stop;
382 buffer#insert ~iter:start new_text;
383 (* prerr_endline "AUTOMATICALLY MODIFIED!!!!!" *)
385 self#moveMark (String.length new_text)
387 method private _retract () =
388 match statements, history with
389 | last_statement :: _, cur_status :: prev_status :: _ ->
390 MatitaSync.time_travel ~present:cur_status ~past:prev_status;
391 statements <- List.tl statements;
392 history <- List.tl history;
393 self#moveMark (- (String.length last_statement));
396 method advance ?statement () =
398 self#_advance ?statement ();
401 | Margin -> self#notify
402 | exc -> self#notify; raise exc
409 | Margin -> self#notify
410 | exc -> self#notify; raise exc
412 method private getFuture =
413 buffer#get_text ~start:(buffer#get_iter_at_mark (`MARK locked_mark))
414 ~stop:buffer#end_iter ()
417 (** @param rel_offset relative offset from current position of locked_mark *)
418 method private moveMark rel_offset =
419 let mark = `MARK locked_mark in
420 let old_insert = buffer#get_iter_at_mark `INSERT in
421 buffer#remove_tag locked_tag ~start:buffer#start_iter ~stop:buffer#end_iter;
422 let current_mark_pos = buffer#get_iter_at_mark mark in
424 match rel_offset with
425 | 0 -> current_mark_pos
426 | n when n > 0 -> current_mark_pos#forward_chars n
427 | n (* when n < 0 *) -> current_mark_pos#backward_chars (abs n)
429 buffer#move_mark mark ~where:new_mark_pos;
430 buffer#apply_tag locked_tag ~start:buffer#start_iter ~stop:new_mark_pos;
431 lock_mark_pos <- new_mark_pos#offset;
432 buffer#move_mark `INSERT old_insert;
434 match self#status.proof_status with
435 Incomplete_proof (_,goal) -> self#setGoal goal
438 while Glib.Main.pending () do ignore(Glib.Main.iteration false); done
440 method clean_dirty_lock =
441 let lock_mark_iter = buffer#get_iter (`OFFSET lock_mark_pos) in
442 buffer#remove_tag locked_tag ~start:buffer#start_iter ~stop:buffer#end_iter;
443 buffer#apply_tag locked_tag ~start:buffer#start_iter ~stop:lock_mark_iter
445 val mutable observers = []
447 method addObserver (o: MatitaTypes.status -> unit) =
448 observers <- o :: observers
450 method private notify =
451 let status = self#status in
452 List.iter (fun o -> o status) observers
454 method loadFromFile () =
455 buffer#set_text (MatitaMisc.input_file self#getFilename);
457 buffer#set_modified false
459 method assignFileName file =
460 filename <- Some file;
462 method saveToFile () =
463 let oc = open_out self#getFilename in
464 output_string oc (buffer#get_text ~start:buffer#start_iter
465 ~stop:buffer#end_iter ());
467 buffer#set_modified false
469 method private _saveToBackuptFile () =
470 if buffer#modified then
472 let f = self#ppFilename ^ "~" in
473 let oc = open_out f in
474 output_string oc (buffer#get_text ~start:buffer#start_iter
475 ~stop:buffer#end_iter ());
477 MatitaLog.debug ("backup " ^ f ^ " saved")
480 method private goto_top =
481 MatitaSync.time_travel ~present:self#status ~past:init;
485 buffer#remove_tag locked_tag ~start:buffer#start_iter ~stop:buffer#end_iter;
486 buffer#move_mark (`MARK locked_mark) ~where:buffer#start_iter
490 buffer#delete ~start:buffer#start_iter ~stop:buffer#end_iter;
492 buffer#set_modified false
495 let template = MatitaMisc.input_file BuildTimeConf.script_template in
496 buffer#insert ~iter:(buffer#get_iter `START) template;
498 buffer#set_modified false;
499 set_star self#ppFilename false
501 method goto (pos: [`Top | `Bottom | `Cursor]) () =
503 | `Top -> self#goto_top; self#notify
506 let getpos _ = buffer#get_iter_at_mark (`MARK locked_mark) in
507 let rec dowhile pos =
509 if pos#compare (getpos ()) < 0 then
515 | Margin -> self#notify
516 | exc -> self#notify; raise exc)
518 let locked_iter () = buffer#get_iter_at_mark (`NAME "locked") in
519 let cursor_iter () = buffer#get_iter_at_mark `INSERT in
520 let rec forward_until_cursor () = (* go forward until locked > cursor *)
522 if (locked_iter ())#compare (cursor_iter ()) < 0 then
523 forward_until_cursor ()
525 let rec back_until_cursor () = (* go backward until locked < cursor *)
527 if (locked_iter ())#compare (cursor_iter ()) > 0 then
530 let cmp = (locked_iter ())#compare (cursor_iter ()) in
532 if cmp < 0 then (* locked < cursor *)
533 (forward_until_cursor (); self#notify)
534 else if cmp > 0 then (* locked > cursor *)
535 (back_until_cursor (); self#notify)
536 else (* cursor = locked *)
539 | Margin -> self#notify
540 | exc -> self#notify; raise exc)
542 method onGoingProof () =
543 match self#status.proof_status with
544 | No_proof | Proof _ -> false
545 | Incomplete_proof _ -> true
546 | Intermediate _ -> assert false
548 method proofStatus = MatitaMisc.get_proof_status self#status
549 method proofMetasenv = MatitaMisc.get_proof_metasenv self#status
550 method proofContext = MatitaMisc.get_proof_context self#status
551 method setGoal n = userGoal <- n
554 let s = self#getFuture in
555 let rec is_there_and_executable s =
556 if Pcre.pmatch ~rex:only_dust_RE s then raise Margin;
557 let st = CicTextualParser2.parse_statement (Stream.of_string s) in
559 | TacticAst.Comment (loc,_)->
560 let parsed_text_length = snd (CicAst.loc_of_floc loc) in
561 let remain_len = String.length s - parsed_text_length in
562 let next = String.sub s parsed_text_length remain_len in
563 is_there_and_executable next
564 | TacticAst.Executable (loc, ex) -> false
567 is_there_and_executable s
569 | CicTextualParser2.Parse_error _ -> false
576 MatitaLog.debug "script status:";
577 MatitaLog.debug ("history size: " ^ string_of_int (List.length history));
578 MatitaLog.debug (sprintf "%d statements:" (List.length statements));
579 List.iter MatitaLog.debug statements;
580 MatitaLog.debug ("Current file name: " ^
581 (match filename with None -> "[ no name ]" | Some f -> f));
585 let _script = ref None
587 let script ~buffer ~init ~mathviewer ~urichooser ~ask_confirmation ~set_star ()
590 ~buffer ~init ~mathviewer ~ask_confirmation ~urichooser ~set_star ()
595 let instance () = match !_script with None -> assert false | Some s -> s