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 "\n%s\n%s" header base
62 (** creates a statement AST for the Goal tactic, e.g. "goal 7" *)
64 let module A = GrafiteAst in
65 let loc = Disambiguate.dummy_floc in
66 A.Executable (loc, A.Tactical (loc, A.Tactic (loc, A.Goal (loc, n))))
69 mathviewer:MatitaTypes.mathViewer;
70 urichooser: UriManager.uri list -> UriManager.uri list;
71 ask_confirmation: title:string -> message:string -> [`YES | `NO | `CANCEL];
72 develcreator: containing:string option -> unit;
73 mutable filenamedata: string option * MatitamakeLib.development option
76 let eval_with_engine guistuff status user_goal parsed_text st =
77 let module TA = GrafiteAst in
78 let module TAPp = GrafiteAstPp in
80 match guistuff.filenamedata with
82 | None,Some devel -> [MatitamakeLib.root_for_development devel ]
84 match MatitamakeLib.development_for_dir (Filename.dirname f) with
86 | Some devel -> [MatitamakeLib.root_for_development devel ]
88 let parsed_text_length = String.length parsed_text in
90 match st with TA.Executable (loc,ex) -> loc, ex | _ -> assert false
92 let goal_changed = ref false in
94 match status.proof_status with
95 | Incomplete_proof (_, goal) when goal <> user_goal ->
97 MatitaEngine.eval_ast ~include_paths:include_
98 ~do_heavy_checks:true status (goal_ast user_goal)
102 MatitaEngine.eval_ast
103 ~include_paths:include_ ~do_heavy_checks:true status st
107 | TA.Command (_, TA.Alias _)
108 | TA.Command (_, TA.Include _) -> DisambiguateTypes.Environment.empty
109 | _ -> MatitaSync.alias_diff ~from:status new_status
111 (* we remove the defined object since we consider them "automathic aliases" *)
113 let module DTE = DisambiguateTypes.Environment in
114 let module UM = UriManager in
116 fun k ((v,_) as value) acc ->
119 let v = UM.strip_xpointer (UM.uri_of_string v) in
120 List.exists (fun (s,_) -> s = v) new_status.objects
121 with UM.IllFormedUri _ -> false
127 ) new_aliases DTE.empty
130 if DisambiguateTypes.Environment.is_empty new_aliases then
133 prepend_text (DisambiguatePp.pp_environment new_aliases)
137 if !goal_changed then
139 (TAPp.pp_tactic (TA.Goal (loc, user_goal))(* ^ "\n"*))
144 [ new_status, new_text ], parsed_text_length
146 let eval_with_engine guistuff status user_goal parsed_text st =
148 eval_with_engine guistuff status user_goal parsed_text st
150 MatitaEngine.UnableToInclude what as exc ->
151 let compile_needed_and_go_on d =
154 while Glib.Main.pending () do ignore(Glib.Main.iteration false); done
156 if not(MatitamakeLib.build_development_in_bg ~target refresh_cb d) then
159 eval_with_engine guistuff status user_goal parsed_text st
161 let do_nothing () = [], 0 in
162 let handle_with_devel d =
163 let name = MatitamakeLib.name_for_development d in
164 let title = "Unable to include " ^ what in
166 what ^ " is handled by development <b>" ^ name ^ "</b>.\n\n" ^
167 "<i>Should I compile it and Its dependencies?</i>"
169 (match guistuff.ask_confirmation ~title ~message with
170 | `YES -> compile_needed_and_go_on d
172 | `CANCEL -> do_nothing ())
174 let handle_withoud_devel filename =
175 let title = "Unable to include " ^ what in
177 what ^ " is <b>not</b> handled by a development.\n" ^
178 "All dependencies are authomatically solved for a development.\n\n" ^
179 "<i>Do you want to set up a development?</i>"
181 (match guistuff.ask_confirmation ~title ~message with
185 guistuff.develcreator ~containing:(Some (Filename.dirname f))
186 | None -> guistuff.develcreator ~containing:None);
189 | `CANCEL -> do_nothing())
191 match guistuff.filenamedata with
192 | None,None -> handle_withoud_devel None
193 | None,Some d -> handle_with_devel d
195 match MatitamakeLib.development_for_dir (Filename.dirname f) with
196 | None -> handle_withoud_devel (Some f)
197 | Some d -> handle_with_devel d
200 let disambiguate term status =
201 let module MD = MatitaDisambiguator in
202 let dbd = MatitaDb.instance () in
203 let metasenv = MatitaMisc.get_proof_metasenv status in
204 let context = MatitaMisc.get_proof_context status in
205 let aliases = MatitaMisc.get_proof_aliases status in
206 let interps = MD.disambiguate_term dbd context metasenv aliases term in
211 let eval_macro guistuff status parsed_text script mac
213 let module TA = GrafiteAst in
214 let module TAPp = GrafiteAstPp in
215 let module MQ = MetadataQuery in
216 let module MDB = MatitaDb in
217 let module CTC = CicTypeChecker in
218 let module CU = CicUniv in
219 (* no idea why ocaml wants this *)
220 let advance ?statement () = script#advance ?statement () in
221 let parsed_text_length = String.length parsed_text in
222 let dbd = MatitaDb.instance () in
225 | TA.WMatch (loc, term) ->
226 let term = disambiguate term status in
227 let l = MQ.match_term ~dbd term in
228 let entry = `Whelp (TAPp.pp_macro_cic (TA.WMatch (loc, term)), l) in
229 guistuff.mathviewer#show_uri_list ~reuse:true ~entry l;
230 [], parsed_text_length
231 | TA.WInstance (loc, term) ->
232 let term = disambiguate term status in
233 let l = MQ.instance ~dbd term in
234 let entry = `Whelp (TAPp.pp_macro_cic (TA.WInstance (loc, term)), l) in
235 guistuff.mathviewer#show_uri_list ~reuse:true ~entry l;
236 [], parsed_text_length
237 | TA.WLocate (loc, s) ->
238 let l = MQ.locate ~dbd s in
239 let entry = `Whelp (TAPp.pp_macro_cic (TA.WLocate (loc, s)), l) in
240 guistuff.mathviewer#show_uri_list ~reuse:true ~entry l;
241 [], parsed_text_length
242 | TA.WElim (loc, term) ->
243 let term = disambiguate term status in
246 | Cic.MutInd (uri,n,_) -> UriManager.uri_of_uriref uri n None
247 | _ -> failwith "Not a MutInd"
249 let l = MQ.elim ~dbd uri in
250 let entry = `Whelp (TAPp.pp_macro_cic (TA.WElim (loc, term)), l) in
251 guistuff.mathviewer#show_uri_list ~reuse:true ~entry l;
252 [], parsed_text_length
253 | TA.WHint (loc, term) ->
254 let term = disambiguate term status in
255 let s = ((None,[0,[],term], Cic.Meta (0,[]) ,term),0) in
256 let l = List.map fst (MQ.experimental_hint ~dbd s) in
257 let entry = `Whelp (TAPp.pp_macro_cic (TA.WHint (loc, term)), l) in
258 guistuff.mathviewer#show_uri_list ~reuse:true ~entry l;
259 [], parsed_text_length
262 let s = MatitaMisc.get_proof_status status in
263 let l = List.map fst (MQ.experimental_hint ~dbd s) in
264 let selected = guistuff.urichooser l in
266 | [] -> [], parsed_text_length
272 TA.Apply (loc, CicNotationPt.Uri (UriManager.string_of_uri uri,None))))))
274 let new_status = MatitaEngine.eval_ast status ast in
276 comment parsed_text ^
277 "\n" ^ TAPp.pp_statement ast
279 [ new_status , extra_text ], parsed_text_length
282 "The result of the urichooser should be only 1 uri, not:\n";
284 fun u -> MatitaLog.error (UriManager.string_of_uri u ^ "\n")
287 | TA.Check (_,term) ->
288 let metasenv = MatitaMisc.get_proof_metasenv status in
289 let context = MatitaMisc.get_proof_context status in
290 let aliases = MatitaMisc.get_proof_aliases status in
292 MatitaDisambiguator.disambiguate_term
293 dbd context metasenv aliases term
295 let _, metasenv , term, ugraph =
300 let ty,_ = CTC.type_of_aux' metasenv context term ugraph in
301 let t_and_ty = Cic.Cast (term,ty) in
302 guistuff.mathviewer#show_entry (`Cic (t_and_ty,metasenv));
303 [], parsed_text_length
306 let status = script#status.proof_status in
309 | _ -> script#retract ();go_back()
311 [], parsed_text_length, Some go_back
312 | TA.Redo (_, Some i) -> [], parsed_text_length,
313 Some (fun () -> for j = 1 to i do advance () done)
314 | TA.Redo (_, None) -> [], parsed_text_length,
315 Some (fun () -> advance ())
316 | TA.Undo (_, Some i) -> [], parsed_text_length,
317 Some (fun () -> for j = 1 to i do script#retract () done)
318 | TA.Undo (_, None) -> [], parsed_text_length,
319 Some (fun () -> script#retract ()) *)
321 | TA.Quit _ -> failwith "not implemented"
322 | TA.Print (_,kind) -> failwith "not implemented"
323 | TA.Search_pat (_, search_kind, str) -> failwith "not implemented"
324 | TA.Search_term (_, search_kind, term) -> failwith "not implemented"
327 let eval_executable guistuff status user_goal parsed_text script ex =
328 let module TA = GrafiteAst in
329 let module TAPp = GrafiteAstPp in
330 let module MD = MatitaDisambiguator in
331 let module ML = MatitacleanLib in
332 let parsed_text_length = String.length parsed_text in
334 | TA.Command (loc, _) | TA.Tactical (loc, _) ->
336 (match MatitaMisc.baseuri_of_baseuri_decl (TA.Executable (loc,ex)) with
339 if not (MatitaMisc.is_empty u) then
341 guistuff.ask_confirmation
342 ~title:"Baseuri redefinition"
344 "Baseuri " ^ u ^ " already exists.\n" ^
345 "Do you want to redefine the corresponding "^
346 "part of the library?")
348 | `YES -> MatitacleanLib.clean_baseuris [u]
350 | `CANCEL -> raise MatitaTypes.Cancel);
352 guistuff status user_goal parsed_text (TA.Executable (loc, ex))
353 with MatitaTypes.Cancel -> [], 0)
354 | TA.Macro (_,mac) ->
355 eval_macro guistuff status parsed_text script mac
357 let rec eval_statement guistuff status user_goal script s =
358 if Pcre.pmatch ~rex:only_dust_RE s then raise Margin;
359 let st = GrafiteParser.parse_statement (Stream.of_string s) in
360 let text_of_loc loc =
361 let parsed_text_length = snd (CicNotationPt.loc_of_floc loc) in
362 let parsed_text = safe_substring s 0 parsed_text_length in
363 parsed_text, parsed_text_length
366 | GrafiteAst.Comment (loc,_)->
367 let parsed_text, parsed_text_length = text_of_loc loc in
368 let remain_len = String.length s - parsed_text_length in
369 let s = String.sub s parsed_text_length remain_len in
371 eval_statement guistuff status user_goal script s
374 | (status, text) :: tl ->
375 ((status, parsed_text ^ text)::tl), (parsed_text_length + len)
377 | GrafiteAst.Executable (loc, ex) ->
378 let parsed_text, parsed_text_length = text_of_loc loc in
379 eval_executable guistuff status user_goal parsed_text script ex
381 let fresh_script_id =
385 class script ~(view: GText.view)
386 ~(init: MatitaTypes.status)
387 ~(mathviewer: MatitaTypes.mathViewer)
393 let buffer = view#buffer in
395 val scriptId = fresh_script_id ()
398 mathviewer = mathviewer;
399 urichooser = urichooser;
400 ask_confirmation = ask_confirmation;
401 develcreator = develcreator;
402 filenamedata = (None, None)}
404 method private getFilename =
405 match guistuff.filenamedata with Some f,_ -> f | _ -> assert false
407 method private ppFilename =
408 match guistuff.filenamedata with
410 | None,_ -> sprintf ".unnamed%d.ma" scriptId
413 ignore(GMain.Timeout.add ~ms:300000
414 ~callback:(fun _ -> self#_saveToBackuptFile ();true));
415 ignore(buffer#connect#modified_changed
416 (fun _ -> if buffer#modified then
417 set_star self#ppFilename true
419 set_star self#ppFilename false))
421 val mutable statements = []; (** executed statements *)
422 val mutable history = [ init ];
423 (** list of states before having executed statements. Head element of this
424 * list is the current state, last element is the state at the beginning of
426 * Invariant: this list length is 1 + length of statements *)
428 (** goal as seen by the user (i.e. metano corresponding to current tab) *)
429 val mutable userGoal = ~-1
431 (** text mark and tag representing locked part of a script *)
433 buffer#create_mark ~name:"locked" ~left_gravity:true buffer#start_iter
434 val locked_tag = buffer#create_tag [`BACKGROUND "lightblue"; `EDITABLE false]
436 method locked_mark = locked_mark
438 (* history can't be empty, the invariant above grant that it contains at
439 * least the init status *)
440 method status = match history with hd :: _ -> hd | _ -> assert false
442 method private _advance ?statement () =
443 let s = match statement with Some s -> s | None -> self#getFuture in
444 MatitaLog.debug ("evaluating: " ^ first_line s ^ " ...");
445 let (entries, parsed_len) =
446 eval_statement guistuff self#status userGoal self s
448 let (new_statuses, new_statements) = List.split entries in
450 prerr_endline "evalStatement returned";
451 List.iter (fun s -> prerr_endline ("'" ^ s ^ "'")) new_statements;
453 history <- List.rev new_statuses @ history;
454 statements <- List.rev new_statements @ statements;
455 let start = buffer#get_iter_at_mark (`MARK locked_mark) in
456 let new_text = String.concat "" new_statements in
457 if new_text <> String.sub s 0 parsed_len then
459 (* prerr_endline ("new:" ^ new_text); *)
460 (* prerr_endline ("s:" ^ String.sub s 0 parsed_len); *)
461 let stop = start#copy#forward_chars parsed_len in
462 buffer#delete ~start ~stop;
463 buffer#insert ~iter:start new_text;
464 (* prerr_endline "AUTOMATICALLY MODIFIED!!!!!" *)
466 self#moveMark (String.length new_text)
468 method private _retract offset status new_statements new_history =
469 let cur_status = match history with s::_ -> s | [] -> assert false in
470 MatitaSync.time_travel ~present:cur_status ~past:status;
471 statements <- new_statements;
472 history <- new_history;
473 self#moveMark (- offset)
475 method advance ?statement () =
477 self#_advance ?statement ();
480 | Margin -> self#notify
481 | exc -> self#notify; raise exc
485 let cmp,new_statements,new_history,status =
486 match statements,history with
487 stat::statements, _::(status::_ as history) ->
488 String.length stat, statements, history, status
489 | [],[_] -> raise Margin
490 | _,_ -> assert false
492 self#_retract cmp status new_statements new_history;
495 | Margin -> self#notify
496 | exc -> self#notify; raise exc
498 method private getFuture =
499 buffer#get_text ~start:(buffer#get_iter_at_mark (`MARK locked_mark))
500 ~stop:buffer#end_iter ()
503 (** @param rel_offset relative offset from current position of locked_mark *)
504 method private moveMark rel_offset =
505 let mark = `MARK locked_mark in
506 let old_insert = buffer#get_iter_at_mark `INSERT in
507 buffer#remove_tag locked_tag ~start:buffer#start_iter ~stop:buffer#end_iter;
508 let current_mark_pos = buffer#get_iter_at_mark mark in
510 match rel_offset with
511 | 0 -> current_mark_pos
512 | n when n > 0 -> current_mark_pos#forward_chars n
513 | n (* when n < 0 *) -> current_mark_pos#backward_chars (abs n)
515 buffer#move_mark mark ~where:new_mark_pos;
516 buffer#apply_tag locked_tag ~start:buffer#start_iter ~stop:new_mark_pos;
517 buffer#move_mark `INSERT old_insert;
519 match self#status.proof_status with
520 Incomplete_proof (_,goal) -> self#setGoal goal
523 let mark_position = buffer#get_iter_at_mark mark in
524 if view#move_mark_onscreen mark then
526 buffer#move_mark mark mark_position;
527 view#scroll_to_mark ~use_align:true ~xalign:1.0 ~yalign:0.1 mark;
529 while Glib.Main.pending () do ignore(Glib.Main.iteration false); done
531 method clean_dirty_lock =
532 let lock_mark_iter = buffer#get_iter_at_mark (`MARK locked_mark) in
533 buffer#remove_tag locked_tag ~start:buffer#start_iter ~stop:buffer#end_iter;
534 buffer#apply_tag locked_tag ~start:buffer#start_iter ~stop:lock_mark_iter
536 val mutable observers = []
538 method addObserver (o: MatitaTypes.status -> unit) =
539 observers <- o :: observers
541 method private notify =
542 let status = self#status in
543 List.iter (fun o -> o status) observers
545 method loadFromFile () =
546 buffer#set_text (MatitaMisc.input_file self#getFilename);
548 buffer#set_modified false
550 method assignFileName file =
551 let abspath = MatitaMisc.absolute_path file in
552 let devel = MatitamakeLib.development_for_dir (Filename.dirname abspath) in
553 guistuff.filenamedata <- Some abspath, devel
555 method saveToFile () =
556 let oc = open_out self#getFilename in
557 output_string oc (buffer#get_text ~start:buffer#start_iter
558 ~stop:buffer#end_iter ());
560 buffer#set_modified false
562 method private _saveToBackuptFile () =
563 if buffer#modified then
565 let f = self#ppFilename ^ "~" in
566 let oc = open_out f in
567 output_string oc (buffer#get_text ~start:buffer#start_iter
568 ~stop:buffer#end_iter ());
570 MatitaLog.debug ("backup " ^ f ^ " saved")
573 method private goto_top =
574 MatitaSync.time_travel ~present:self#status ~past:init;
578 buffer#remove_tag locked_tag ~start:buffer#start_iter ~stop:buffer#end_iter;
579 buffer#move_mark (`MARK locked_mark) ~where:buffer#start_iter
583 buffer#delete ~start:buffer#start_iter ~stop:buffer#end_iter;
585 buffer#set_modified false
588 let template = MatitaMisc.input_file BuildTimeConf.script_template in
589 buffer#insert ~iter:(buffer#get_iter `START) template;
590 guistuff.filenamedata <-
591 (None,MatitamakeLib.development_for_dir (Unix.getcwd ()));
592 buffer#set_modified false;
593 set_star self#ppFilename false
595 method goto (pos: [`Top | `Bottom | `Cursor]) () =
596 let old_locked_mark =
598 (buffer#create_mark ~name:"old_locked_mark"
599 ~left_gravity:true (buffer#get_iter_at_mark (`MARK locked_mark))) in
600 let getpos _ = buffer#get_iter_at_mark (`MARK locked_mark) in
601 let getoldpos _ = buffer#get_iter_at_mark old_locked_mark in
602 let dispose_old_locked_mark () = buffer#delete_mark old_locked_mark in
604 | `Top -> dispose_old_locked_mark (); self#goto_top; self#notify
609 let newpos = getpos () in
610 if (getoldpos ())#compare newpos < 0 then
612 buffer#move_mark old_locked_mark newpos;
617 dispose_old_locked_mark ();
620 | Margin -> dispose_old_locked_mark (); self#notify
621 | exc -> dispose_old_locked_mark (); self#notify; raise exc)
623 let locked_iter () = buffer#get_iter_at_mark (`NAME "locked") in
624 let cursor_iter () = buffer#get_iter_at_mark `INSERT in
627 (buffer#create_mark ~name:"initial_insert"
628 ~left_gravity:true (cursor_iter ())) in
629 let dispose_remember () = buffer#delete_mark remember in
630 let remember_iter () =
631 buffer#get_iter_at_mark (`NAME "initial_insert") in
632 let cmp () = (locked_iter ())#offset - (remember_iter ())#offset in
634 let forward_until_cursor () = (* go forward until locked > cursor *)
637 if cmp () < 0 && (getoldpos ())#compare (getpos ()) < 0
640 buffer#move_mark old_locked_mark (getpos ());
646 let rec back_until_cursor len = (* go backward until locked < cursor *)
648 statements, (status::_ as history) when len <= 0 ->
649 self#_retract (icmp - len) status statements history
650 | statement::tl1, _::tl2 ->
651 back_until_cursor (len - String.length statement) (tl1,tl2)
652 | _,_ -> assert false
656 if icmp < 0 then (* locked < cursor *)
657 (forward_until_cursor (); self#notify)
658 else if icmp > 0 then (* locked > cursor *)
659 (back_until_cursor icmp (statements,history); self#notify)
660 else (* cursor = locked *)
664 dispose_old_locked_mark ();
666 | Margin -> dispose_remember (); dispose_old_locked_mark (); self#notify
667 | exc -> dispose_remember (); dispose_old_locked_mark ();
668 self#notify; raise exc)
670 method onGoingProof () =
671 match self#status.proof_status with
672 | No_proof | Proof _ -> false
673 | Incomplete_proof _ -> true
674 | Intermediate _ -> assert false
676 method proofStatus = MatitaMisc.get_proof_status self#status
677 method proofMetasenv = MatitaMisc.get_proof_metasenv self#status
678 method proofContext = MatitaMisc.get_proof_context self#status
679 method setGoal n = userGoal <- n
682 let s = self#getFuture in
683 let rec is_there_and_executable s =
684 if Pcre.pmatch ~rex:only_dust_RE s then raise Margin;
685 let st = GrafiteParser.parse_statement (Stream.of_string s) in
687 | GrafiteAst.Comment (loc,_)->
688 let parsed_text_length = snd (CicNotationPt.loc_of_floc loc) in
689 let remain_len = String.length s - parsed_text_length in
690 let next = String.sub s parsed_text_length remain_len in
691 is_there_and_executable next
692 | GrafiteAst.Executable (loc, ex) -> false
695 is_there_and_executable s
697 | CicNotationParser.Parse_error _ -> false
704 MatitaLog.debug "script status:";
705 MatitaLog.debug ("history size: " ^ string_of_int (List.length history));
706 MatitaLog.debug (sprintf "%d statements:" (List.length statements));
707 List.iter MatitaLog.debug statements;
708 MatitaLog.debug ("Current file name: " ^
709 (match guistuff.filenamedata with
710 |None,_ -> "[ no name ]"
715 let _script = ref None
717 let script ~view ~init ~mathviewer ~urichooser ~develcreator ~ask_confirmation ~set_star ()
720 ~view ~init ~mathviewer ~ask_confirmation ~urichooser ~develcreator ~set_star ()
725 let instance () = match !_script with None -> assert false | Some s -> s