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/
31 module TA = GrafiteAst
34 let debug_print = if debug then prerr_endline else ignore
36 (** raised when one of the script margins (top or bottom) is reached *)
38 exception NoUnfinishedProof
39 exception ActionCancelled of string
41 let safe_substring s i j =
42 try String.sub s i j with Invalid_argument _ -> assert false
44 let heading_nl_RE = Pcre.regexp "^\\s*\n\\s*"
45 let heading_nl_RE' = Pcre.regexp "^(\\s*\n\\s*)"
46 let only_dust_RE = Pcre.regexp "^(\\s|\n|%%[^\n]*\n)*$"
47 let multiline_RE = Pcre.regexp "^\n[^\n]+$"
48 let newline_RE = Pcre.regexp "\n"
49 let comment_RE = Pcre.regexp "\\(\\*(.|\n)*\\*\\)\n?" ~flags:[`UNGREEDY]
52 if Pcre.pmatch ~rex:multiline_RE str then
53 "\n(** " ^ (Pcre.replace ~rex:newline_RE str) ^ " *)"
55 "\n(**\n" ^ str ^ "\n*)"
57 let strip_comments str =
58 Pcre.qreplace ~templ:"\n" ~pat:"\n\n" (Pcre.qreplace ~rex:comment_RE str)
62 let s = Pcre.replace ~rex:heading_nl_RE s in
64 let nl_pos = String.index s '\n' in
69 mathviewer:MatitaTypes.mathViewer;
70 urichooser: NReference.reference list -> NReference.reference list;
71 ask_confirmation: title:string -> message:string -> [`YES | `NO | `CANCEL];
74 let eval_with_engine include_paths guistuff grafite_status user_goal
75 skipped_txt nonskipped_txt st
77 let parsed_text_length =
78 String.length skipped_txt + String.length nonskipped_txt
80 let text = skipped_txt ^ nonskipped_txt in
81 let prefix_len = MatitaGtkMisc.utf8_string_length skipped_txt in
82 let enriched_history_fragment =
83 MatitaEngine.eval_ast ~include_paths ~do_heavy_checks:(Helm_registry.get_bool
84 "matita.do_heavy_checks")
85 grafite_status (text,prefix_len,st)
87 let enriched_history_fragment = List.rev enriched_history_fragment in
91 (fun (acc, to_prepend) (status,alias) ->
93 | None -> (status,to_prepend ^ nonskipped_txt)::acc,""
95 let newtxt = GrafiteAstPp.pp_alias value in
96 (status,to_prepend ^ newtxt ^ "\n")::acc, "")
97 ([],skipped_txt) enriched_history_fragment
99 res,"",parsed_text_length
102 let pp_eager_statement_ast = GrafiteAstPp.pp_statement
104 let eval_nmacro include_paths (buffer : GText.buffer) guistuff grafite_status user_goal unparsed_text parsed_text script mac =
105 let parsed_text_length = String.length parsed_text in
107 | TA.Screenshot (_,name) ->
108 let status = script#grafite_status in
109 let _,_,menv,subst,_ = status#obj in
110 let name = Filename.dirname (script#filename) ^ "/" ^ name in
112 let selected = Continuationals.Stack.head_goals status#stack in
113 List.filter (fun x,_ -> List.mem x selected) menv
115 guistuff.mathviewer#screenshot status sequents menv subst name;
116 [status, parsed_text], "", parsed_text_length
118 let status = script#grafite_status in
119 let _,_,menv,subst,_ = status#obj in
121 match Continuationals.Stack.head_goals status#stack with
126 "Many goals focused. Using the context of the first one\n";
127 let _, ctx, _ = NCicUtils.lookup_meta g menv in
129 let m, s, status, t =
130 GrafiteDisambiguate.disambiguate_nterm
131 status None ctx menv subst (parsed_text,parsed_text_length,
132 NotationPt.Cast (t,NotationPt.Implicit `JustOne))
133 (* XXX use the metasenv, if possible *)
135 guistuff.mathviewer#show_entry (`NCic (t,ctx,m,s));
136 [status, parsed_text], "", parsed_text_length
137 | TA.NIntroGuess _loc ->
138 let names_ref = ref [] in
140 NTactics.intros_tac ~names_ref [] script#grafite_status
142 let rex = Pcre.regexp ~flags:[`MULTILINE] "\\A([\\n\\t\\r ]*).*\\Z" in
143 let nl = Pcre.replace ~rex ~templ:"$1" parsed_text in
144 [s, nl ^ "#" ^ String.concat " " !names_ref ^ ";"], "", parsed_text_length
145 | TA.NAutoInteractive (_loc, (None,a)) ->
146 let trace_ref = ref [] in
149 ~params:(None,a) ~trace_ref script#grafite_status
152 try List.assoc "depth" a
155 let trace = "/"^(if int_of_string depth > 1 then depth else "")^"/ by " in
157 match !trace_ref with
161 (HExtlib.filter_map (function
162 | NotationPt.NRef r -> Some (NCicPp.r2s true r)
166 let rex = Pcre.regexp ~flags:[`MULTILINE] "\\A([\\n\\t\\r ]*).*\\Z" in
167 let nl = Pcre.replace ~rex ~templ:"$1" parsed_text in
168 [s, nl ^ trace ^ thms ^ ";"], "", parsed_text_length
169 | TA.NAutoInteractive (_, (Some _,_)) -> assert false
171 let rec eval_executable include_paths (buffer : GText.buffer) guistuff
172 grafite_status user_goal unparsed_text skipped_txt nonskipped_txt
176 ignore (buffer#move_mark (`NAME "beginning_of_statement")
177 ~where:((buffer#get_iter_at_mark (`NAME "locked"))#forward_chars
178 (Glib.Utf8.length skipped_txt))) ;
179 eval_with_engine include_paths
180 guistuff grafite_status user_goal skipped_txt nonskipped_txt
181 (TA.Executable (loc, ex))
183 MatitaTypes.Cancel -> [], "", 0
184 | GrafiteEngine.NMacro (_loc,macro) ->
185 eval_nmacro include_paths buffer guistuff grafite_status
186 user_goal unparsed_text (skipped_txt ^ nonskipped_txt) script macro
189 and eval_statement include_paths (buffer : GText.buffer) guistuff
190 grafite_status user_goal script statement
192 let st,unparsed_text =
195 if Pcre.pmatch ~rex:only_dust_RE text then raise Margin;
196 let grammar = CicNotationParser.level2_ast_grammar grafite_status in
198 Grammar.parsable grammar (Obj.magic(Ulexing.from_utf8_string text)) in
199 let ast = MatitaEngine.get_ast grafite_status include_paths strm in
201 | `Ast (st, text) -> st, text
203 let text_of_loc floc =
204 let nonskipped_txt,_ = MatitaGtkMisc.utf8_parsed_text unparsed_text floc in
205 let start, stop = HExtlib.loc_of_floc floc in
206 let floc = HExtlib.floc_of_loc (0, start) in
207 let skipped_txt,_ = MatitaGtkMisc.utf8_parsed_text unparsed_text floc in
208 let floc = HExtlib.floc_of_loc (0, stop) in
209 let txt,len = MatitaGtkMisc.utf8_parsed_text unparsed_text floc in
210 txt,nonskipped_txt,skipped_txt,len
213 | GrafiteAst.Executable (loc, ex) ->
214 let _, nonskipped, skipped, parsed_text_length = text_of_loc loc in
215 eval_executable include_paths buffer guistuff
216 grafite_status user_goal unparsed_text skipped nonskipped script ex loc
217 | GrafiteAst.Comment (loc, GrafiteAst.Code (_, ex))
218 when Helm_registry.get_bool "matita.execcomments" ->
219 let _, nonskipped, skipped, parsed_text_length = text_of_loc loc in
220 eval_executable include_paths buffer guistuff
221 grafite_status user_goal unparsed_text skipped nonskipped script ex loc
222 | GrafiteAst.Comment (loc, _) ->
223 let parsed_text, _, _, parsed_text_length = text_of_loc loc in
224 let remain_len = String.length unparsed_text - parsed_text_length in
225 let s = String.sub unparsed_text parsed_text_length remain_len in
228 eval_statement include_paths buffer guistuff
229 grafite_status user_goal script (`Raw s)
231 HExtlib.Localized (floc, exn) ->
232 HExtlib.raise_localized_exception
233 ~offset:(MatitaGtkMisc.utf8_string_length parsed_text) floc exn
234 | MultiPassDisambiguator.DisambiguationError (offset,errorll) ->
236 (MultiPassDisambiguator.DisambiguationError
237 (offset+parsed_text_length, errorll))
239 assert (text=""); (* no macros inside comments, please! *)
241 | (statuses,text)::tl ->
242 (statuses,parsed_text ^ text)::tl,"",parsed_text_length + len
245 let fresh_script_id =
249 class script ~(source_view: GSourceView2.source_view)
250 ~(mathviewer: MatitaTypes.mathViewer)
255 let buffer = source_view#buffer in
256 let source_buffer = source_view#source_buffer in
257 let initial_statuses current baseuri =
258 let empty_lstatus = new GrafiteDisambiguate.status in
261 NCicLibrary.time_travel
262 ((new GrafiteTypes.status current#baseuri)#set_disambiguate_db current#disambiguate_db);
263 (* CSC: there is a known bug in invalidation; temporary fix here *)
264 NCicEnvironment.invalidate ()
266 let lexicon_status = empty_lstatus in
267 let grafite_status = (new GrafiteTypes.status baseuri)#set_disambiguate_db lexicon_status#disambiguate_db in
270 let read_include_paths file =
272 let root, _buri, _fname, _tgt =
273 Librarian.baseuri_of_script ~include_paths:[] file
276 Str.split (Str.regexp " ")
277 (List.assoc "include_paths" (Librarian.load_root_file (root^"/root")))
279 List.iter (HLog.debug) rc; rc
280 with Librarian.NoRootFor _ | Not_found -> []
282 let default_buri = "cic:/matita/tests" in
283 let default_fname = ".unnamed.ma" in
285 val mutable include_paths_ = []
287 val scriptId = fresh_script_id ()
290 mathviewer = mathviewer;
291 urichooser = urichooser;
292 ask_confirmation = ask_confirmation;
295 val mutable filename_ = (None : string option)
297 method has_name = filename_ <> None
299 method include_paths =
301 Helm_registry.get_list Helm_registry.string "matita.includes"
303 method private curdir =
305 let root, _buri, _fname, _tgt =
306 Librarian.baseuri_of_script ~include_paths:self#include_paths
310 with Librarian.NoRootFor _ -> Sys.getcwd ()
312 method buri_of_current_file =
314 | None -> default_buri
317 let _root, buri, _fname, _tgt =
318 Librarian.baseuri_of_script ~include_paths:self#include_paths f
321 with Librarian.NoRootFor _ -> default_buri
323 method filename = match filename_ with None -> default_fname | Some f -> f
326 ignore (GMain.Timeout.add ~ms:300000
327 ~callback:(fun _ -> self#_saveToBackupFile ();true));
328 ignore (buffer#connect#modified_changed
329 (fun _ -> set_star buffer#modified))
331 val mutable statements = [] (** executed statements *)
333 val mutable history = [ initial_statuses None default_buri ]
334 (** list of states before having executed statements. Head element of this
335 * list is the current state, last element is the state at the beginning of
337 * Invariant: this list length is 1 + length of statements *)
339 (** goal as seen by the user (i.e. metano corresponding to current tab) *)
340 val mutable userGoal = (None : int option)
342 (** text mark and tag representing locked part of a script *)
344 buffer#create_mark ~name:"locked" ~left_gravity:true buffer#start_iter
345 val beginning_of_statement_mark =
346 buffer#create_mark ~name:"beginning_of_statement"
347 ~left_gravity:true buffer#start_iter
348 val locked_tag = buffer#create_tag [`BACKGROUND "lightblue"; `EDITABLE false]
349 val error_tag = buffer#create_tag [`UNDERLINE `SINGLE; `FOREGROUND "red"]
351 method locked_mark = locked_mark
352 method locked_tag = locked_tag
353 method error_tag = error_tag
355 (* history can't be empty, the invariant above grant that it contains at
356 * least the init grafite_status *)
357 method grafite_status = match history with s::_ -> s | _ -> assert false
359 method private _advance ?statement () =
360 let s = match statement with Some s -> s | None -> self#getFuture in
361 if self#bos then LibraryClean.clean_baseuris [self#buri_of_current_file];
362 HLog.debug ("evaluating: " ^ first_line s ^ " ...");
363 let time1 = Unix.gettimeofday () in
364 let entries, newtext, parsed_len =
366 eval_statement self#include_paths buffer guistuff
367 self#grafite_status userGoal self (`Raw s)
368 with End_of_file -> raise Margin
370 let time2 = Unix.gettimeofday () in
371 HLog.debug ("... done in " ^ string_of_float (time2 -. time1) ^ "s");
372 let new_statuses, new_statements =
373 let statuses, texts = List.split entries in
376 history <- new_statuses @ history;
377 statements <- new_statements @ statements;
378 let start = buffer#get_iter_at_mark (`MARK locked_mark) in
379 let new_text = String.concat "" (List.rev new_statements) in
380 if statement <> None then
381 buffer#insert ~iter:start new_text
383 let parsed_text = String.sub s 0 parsed_len in
384 if new_text <> parsed_text then begin
385 let stop = start#copy#forward_chars (Glib.Utf8.length parsed_text) in
386 buffer#delete ~start ~stop;
387 buffer#insert ~iter:start new_text;
390 self#moveMark (Glib.Utf8.length new_text);
391 buffer#insert ~iter:(buffer#get_iter_at_mark (`MARK locked_mark)) newtext;
392 (* here we need to set the Goal in case we are going to cursor (or to
393 bottom) and we will face a macro *)
396 method private _retract offset grafite_status new_statements new_history =
397 NCicLibrary.time_travel grafite_status;
398 statements <- new_statements;
399 history <- new_history;
400 self#moveMark (- offset)
402 method advance ?statement () =
404 self#_advance ?statement ();
407 | Margin -> self#notify
408 | Not_found -> assert false
409 | Invalid_argument "Array.make" -> HLog.error "The script is too big!\n"
410 | exc -> self#notify; raise exc
414 let cmp,new_statements,new_history,grafite_status =
415 match statements,history with
416 stat::statements, _::(status::_ as history) ->
417 assert (Glib.Utf8.validate stat);
418 Glib.Utf8.length stat, statements, history, status
419 | [],[_] -> raise Margin
420 | _,_ -> assert false
422 self#_retract cmp grafite_status new_statements
426 | Margin -> self#notify
427 | Invalid_argument "Array.make" -> HLog.error "The script is too big!\n"
428 | exc -> self#notify; raise exc
430 method private getFuture =
431 let lock = buffer#get_iter_at_mark (`MARK locked_mark) in
432 let text = buffer#get_text ~start:lock ~stop:buffer#end_iter () in
435 method expandAllVirtuals =
436 let lock = buffer#get_iter_at_mark (`MARK locked_mark) in
437 let text = buffer#get_text ~start:lock ~stop:buffer#end_iter () in
438 buffer#delete ~start:lock ~stop:buffer#end_iter;
439 let text = Pcre.replace ~pat:":=" ~templ:"\\def" text in
440 let text = Pcre.replace ~pat:"->" ~templ:"\\to" text in
441 let text = Pcre.replace ~pat:"=>" ~templ:"\\Rightarrow" text in
443 Pcre.substitute_substrings
445 let pristine = Pcre.get_substring str 0 in
447 if pristine.[0] = ' ' then
448 String.sub pristine 1 (String.length pristine -1)
452 if input.[String.length input-1] = ' ' then
453 String.sub input 0 (String.length input -1)
457 if input = "\\forall" ||
458 input = "\\lambda" ||
459 input = "\\exists" then "","" else " ", " "
462 before ^ Glib.Utf8.from_unichar
463 (snd (Virtuals.symbol_of_virtual input)) ^ after
464 with Virtuals.Not_a_virtual -> pristine)
465 ~pat:" ?\\\\[a-zA-Z]+ ?" text
467 buffer#insert ~iter:lock text
469 (** @param rel_offset relative offset from current position of locked_mark *)
470 method private moveMark rel_offset =
471 let mark = `MARK locked_mark in
472 let old_insert = buffer#get_iter_at_mark `INSERT in
473 buffer#remove_tag locked_tag ~start:buffer#start_iter ~stop:buffer#end_iter;
474 let current_mark_pos = buffer#get_iter_at_mark mark in
476 match rel_offset with
477 | 0 -> current_mark_pos
478 | n when n > 0 -> current_mark_pos#forward_chars n
479 | n (* when n < 0 *) -> current_mark_pos#backward_chars (abs n)
481 buffer#move_mark mark ~where:new_mark_pos;
482 buffer#apply_tag locked_tag ~start:buffer#start_iter ~stop:new_mark_pos;
483 buffer#move_mark `INSERT old_insert;
484 let mark_position = buffer#get_iter_at_mark mark in
485 if source_view#move_mark_onscreen mark then
487 buffer#move_mark mark mark_position;
488 source_view#scroll_to_mark ~use_align:true ~xalign:1.0 ~yalign:0.1 mark;
490 while Glib.Main.pending () do ignore(Glib.Main.iteration false); done
492 method clean_dirty_lock =
493 let lock_mark_iter = buffer#get_iter_at_mark (`MARK locked_mark) in
494 buffer#remove_tag locked_tag ~start:buffer#start_iter ~stop:buffer#end_iter;
495 buffer#apply_tag locked_tag ~start:buffer#start_iter ~stop:lock_mark_iter
497 val mutable observers = []
499 method addObserver (o: GrafiteTypes.status -> unit) =
500 observers <- o :: observers
502 method private notify =
503 let grafite_status = self#grafite_status in
504 List.iter (fun o -> o grafite_status) observers
506 method loadFromString s =
509 buffer#set_modified true
511 method loadFromFile f =
512 buffer#set_text (HExtlib.input_file f);
514 buffer#set_modified false
516 method assignFileName file =
519 | Some f -> Some (Librarian.absolutize f)
524 (match file with Some file -> read_include_paths file | None -> []);
526 Sys.chdir self#curdir;
527 HLog.debug ("Moving to " ^ Sys.getcwd ())
529 method saveToFile () =
530 if self#has_name then
531 let oc = open_out self#filename in
532 output_string oc (buffer#get_text ~start:buffer#start_iter
533 ~stop:buffer#end_iter ());
536 buffer#set_modified false
538 HLog.error "Can't save, no filename selected"
540 method private _saveToBackupFile () =
541 if buffer#modified then
543 let f = self#filename in
544 let oc = open_out f in
545 output_string oc (buffer#get_text ~start:buffer#start_iter
546 ~stop:buffer#end_iter ());
548 HLog.debug ("backup " ^ f ^ " saved")
551 method private reset_buffer =
553 history <- [ initial_statuses (Some self#grafite_status) self#buri_of_current_file ];
556 buffer#remove_tag locked_tag ~start:buffer#start_iter ~stop:buffer#end_iter;
557 buffer#move_mark (`MARK locked_mark) ~where:buffer#start_iter
561 source_buffer#begin_not_undoable_action ();
562 buffer#delete ~start:buffer#start_iter ~stop:buffer#end_iter;
563 source_buffer#end_not_undoable_action ();
564 buffer#set_modified false;
567 let template = HExtlib.input_file BuildTimeConf.script_template in
568 buffer#insert ~iter:(buffer#get_iter `START) template;
569 buffer#set_modified false;
572 method goto (pos: [`Top | `Bottom | `Cursor]) () =
574 let old_locked_mark =
576 (buffer#create_mark ~name:"old_locked_mark"
577 ~left_gravity:true (buffer#get_iter_at_mark (`MARK locked_mark))) in
578 let getpos _ = buffer#get_iter_at_mark (`MARK locked_mark) in
579 let getoldpos _ = buffer#get_iter_at_mark old_locked_mark in
580 let dispose_old_locked_mark () = buffer#delete_mark old_locked_mark in
583 dispose_old_locked_mark ();
590 let newpos = getpos () in
591 if (getoldpos ())#compare newpos < 0 then
593 buffer#move_mark old_locked_mark newpos;
598 dispose_old_locked_mark ();
601 | Margin -> dispose_old_locked_mark (); self#notify
602 | exc -> dispose_old_locked_mark (); self#notify; raise exc)
604 let locked_iter () = buffer#get_iter_at_mark (`NAME "locked") in
605 let cursor_iter () = buffer#get_iter_at_mark `INSERT in
608 (buffer#create_mark ~name:"initial_insert"
609 ~left_gravity:true (cursor_iter ())) in
610 let dispose_remember () = buffer#delete_mark remember in
611 let remember_iter () =
612 buffer#get_iter_at_mark (`NAME "initial_insert") in
613 let cmp () = (locked_iter ())#offset - (remember_iter ())#offset in
615 let forward_until_cursor () = (* go forward until locked > cursor *)
618 if cmp () < 0 && (getoldpos ())#compare (getpos ()) < 0
621 buffer#move_mark old_locked_mark (getpos ());
627 let rec back_until_cursor len = (* go backward until locked < cursor *)
629 statements, ((grafite_status)::_ as history)
631 self#_retract (icmp - len) grafite_status statements
633 | statement::tl1, _::tl2 ->
634 back_until_cursor (len - MatitaGtkMisc.utf8_string_length statement) (tl1,tl2)
635 | _,_ -> assert false
639 if icmp < 0 then (* locked < cursor *)
640 (forward_until_cursor (); self#notify)
641 else if icmp > 0 then (* locked > cursor *)
642 (back_until_cursor icmp (statements,history); self#notify)
643 else (* cursor = locked *)
647 dispose_old_locked_mark ();
649 | Margin -> dispose_remember (); dispose_old_locked_mark (); self#notify
650 | exc -> dispose_remember (); dispose_old_locked_mark ();
651 self#notify; raise exc)
652 with Invalid_argument "Array.make" ->
653 HLog.error "The script is too big!\n"
655 method stack = (assert false : Continuationals.Stack.t) (* MATITA 1.0 GrafiteTypes.get_stack
656 self#grafite_status *)
657 method setGoal n = userGoal <- n
658 method goal = userGoal
666 let rec is_there_only_comments lexicon_status s =
667 if Pcre.pmatch ~rex:only_dust_RE s then raise Margin;
668 let grammar = CicNotationParser.level2_ast_grammar lexicon_status in
670 Grammar.parsable grammar (Obj.magic(Ulexing.from_utf8_string s)) in
671 match GrafiteParser.parse_statement lexicon_status strm with
672 | GrafiteAst.Comment (loc,_) ->
673 let _,parsed_text_length = MatitaGtkMisc.utf8_parsed_text s loc in
674 (* CSC: why +1 in the following lines ???? *)
675 let parsed_text_length = parsed_text_length + 1 in
676 let remain_len = String.length s - parsed_text_length in
677 let next = String.sub s parsed_text_length remain_len in
678 is_there_only_comments lexicon_status next
679 | GrafiteAst.Executable _ -> false
681 try is_there_only_comments self#grafite_status self#getFuture
683 | NCicLibrary.IncludedFileNotCompiled _
684 | HExtlib.Localized _
685 | CicNotationParser.Parse_error _ -> false
686 | Margin | End_of_file -> true
687 | Invalid_argument "Array.make" -> false
691 HLog.debug "script status:";
692 HLog.debug ("history size: " ^ string_of_int (List.length history));
693 HLog.debug (sprintf "%d statements:" (List.length statements));
694 List.iter HLog.debug statements;
695 HLog.debug ("Current file name: " ^ self#filename);
698 let _script = ref None
700 let script ~source_view ~mathviewer ~urichooser ~ask_confirmation ~set_star ()
703 ~source_view ~mathviewer ~ask_confirmation ~urichooser ~set_star ()
708 let current () = match !_script with None -> assert false | Some s -> s