]> matita.cs.unibo.it Git - helm.git/blob - matita/matita/matitaScript.ml
6a03e3538652c379234d31e76197627ab8d51a1a
[helm.git] / matita / matita / matitaScript.ml
1 (* Copyright (C) 2004-2005, HELM Team.
2  * 
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.
6  * 
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.
11  * 
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.
16  *
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,
20  * MA  02111-1307, USA.
21  * 
22  * For details, see the HELM World-Wide-Web page,
23  * http://helm.cs.unibo.it/
24  *)
25
26 (* $Id$ *)
27
28 open Printf
29 open GrafiteTypes
30
31 module TA = GrafiteAst
32
33 let debug = false
34 let debug_print = if debug then prerr_endline else ignore
35
36   (** raised when one of the script margins (top or bottom) is reached *)
37 exception Margin
38 exception NoUnfinishedProof
39 exception ActionCancelled of string
40
41 let safe_substring s i j =
42   try String.sub s i j with Invalid_argument _ -> assert false
43
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]
50  
51 let comment str =
52   if Pcre.pmatch ~rex:multiline_RE str then
53     "\n(** " ^ (Pcre.replace ~rex:newline_RE str) ^ " *)"
54   else
55     "\n(**\n" ^ str ^ "\n*)"
56
57 let strip_comments str =
58   Pcre.qreplace ~templ:"\n" ~pat:"\n\n" (Pcre.qreplace ~rex:comment_RE str)
59 ;;
60                      
61 let first_line s =
62   let s = Pcre.replace ~rex:heading_nl_RE s in
63   try
64     let nl_pos = String.index s '\n' in
65     String.sub s 0 nl_pos
66   with Not_found -> s
67
68 let eval_with_engine include_paths status skipped_txt nonskipped_txt st
69 =
70   let parsed_text_length =
71     String.length skipped_txt + String.length nonskipped_txt 
72   in
73   let text = skipped_txt ^ nonskipped_txt in
74   let prefix_len = MatitaGtkMisc.utf8_string_length skipped_txt in
75   let enriched_history_fragment =
76    MatitaEngine.eval_ast ~include_paths ~do_heavy_checks:(Helm_registry.get_bool
77      "matita.do_heavy_checks")
78     status (text,prefix_len,st)
79   in
80   let enriched_history_fragment = List.rev enriched_history_fragment in
81   (* really fragile *)
82   let res,_ = 
83     List.fold_left 
84       (fun (acc, to_prepend) (status,alias) ->
85        match alias with
86        | None -> (status,to_prepend ^ nonskipped_txt)::acc,""
87        | Some (k,value) ->
88             let newtxt = GrafiteAstPp.pp_alias value in
89             (status,to_prepend ^ newtxt ^ "\n")::acc, "")
90       ([],skipped_txt) enriched_history_fragment
91   in
92   res,"",parsed_text_length
93 ;;
94
95 let pp_eager_statement_ast = GrafiteAstPp.pp_statement 
96
97 let eval_nmacro include_paths (buffer : GText.buffer) status unparsed_text parsed_text script mac =
98   let parsed_text_length = String.length parsed_text in
99   match mac with
100   | TA.Screenshot (_,name) -> 
101        let status = script#status in
102        let _,_,menv,subst,_ = status#obj in
103        let name = Filename.dirname (script#filename) ^ "/" ^ name in
104        let sequents = 
105          let selected = Continuationals.Stack.head_goals status#stack in
106          List.filter (fun x,_ -> List.mem x selected) menv         
107        in
108        CicMathView.screenshot status sequents menv subst name;
109        [status, parsed_text], "", parsed_text_length
110   | TA.NCheck (_,t) ->
111       let status = script#status in
112       let _,_,menv,subst,_ = status#obj in
113       let ctx = 
114        match Continuationals.Stack.head_goals status#stack with
115           [] -> []
116         | g::tl ->
117            if tl <> [] then
118             HLog.warn
119              "Many goals focused. Using the context of the first one\n";
120            let ctx = try
121              let _, ctx, _ = NCicUtils.lookup_meta g menv in ctx
122              with NCicUtils.Meta_not_found _ -> 
123                HLog.warn "Current goal is closed. Using empty context.";
124                [ ]
125            in ctx
126       in
127       let m, s, status, t = 
128         GrafiteDisambiguate.disambiguate_nterm 
129           status `XTNone ctx menv subst (parsed_text,parsed_text_length,
130             NotationPt.Cast (t,NotationPt.Implicit `JustOne))  
131           (* XXX use the metasenv, if possible *)
132       in
133       MatitaMathView.cicBrowser (Some (`NCic (t,ctx,m,s)));
134       [status, parsed_text], "", parsed_text_length
135   | TA.NIntroGuess _loc ->
136       let names_ref = ref [] in
137       let s = NTactics.intros_tac ~names_ref [] script#status in
138       let rex = Pcre.regexp ~flags:[`MULTILINE] "\\A([\\n\\t\\r ]*).*\\Z" in
139       let nl = Pcre.replace ~rex ~templ:"$1" parsed_text in
140       [s, nl ^ "#" ^ String.concat " #" !names_ref], "", parsed_text_length
141   | TA.NAutoInteractive (_loc, (None,a)) -> 
142       let trace_ref = ref [] in
143       let s = NnAuto.auto_tac ~params:(None,a) ~trace_ref script#status in
144       let depth = 
145         try List.assoc "depth" a
146         with Not_found -> ""
147       in
148       let trace = "/"^(if int_of_string depth > 1 then depth else "")^" by " in
149       let thms = 
150         match !trace_ref with
151         | [] -> ""
152         | thms -> 
153            String.concat ", "  
154              (HExtlib.filter_map (function 
155                | NotationPt.NRef r -> Some (NCicPp.r2s status true r) 
156                | _ -> None) 
157              thms)
158       in
159       let rex = Pcre.regexp ~flags:[`MULTILINE] "\\A([\\n\\t\\r ]*).*\\Z" in
160       let nl = Pcre.replace ~rex ~templ:"$1" parsed_text in
161       [s, nl ^ trace ^ thms ^ "/"], "", parsed_text_length
162   | TA.NAutoInteractive (_, (Some _,_)) -> assert false
163
164 let rec eval_executable include_paths (buffer : GText.buffer)
165 status unparsed_text skipped_txt nonskipped_txt script ex loc
166 =
167   try
168    ignore (buffer#move_mark (`NAME "beginning_of_statement")
169     ~where:((buffer#get_iter_at_mark (`NAME "locked"))#forward_chars
170        (Glib.Utf8.length skipped_txt))) ;
171    eval_with_engine include_paths status skipped_txt nonskipped_txt
172     (TA.Executable (loc, ex))
173   with
174      MatitaTypes.Cancel -> [], "", 0
175    | GrafiteEngine.NMacro (_loc,macro) ->
176        eval_nmacro include_paths buffer status
177         unparsed_text (skipped_txt ^ nonskipped_txt) script macro
178
179
180 and eval_statement include_paths (buffer : GText.buffer) status script
181  statement
182 =
183   let st,unparsed_text =
184     match statement with
185     | `Raw text ->
186         if Pcre.pmatch ~rex:only_dust_RE text then raise Margin;
187         let strm =
188          GrafiteParser.parsable_statement status
189           (Ulexing.from_utf8_string text) in
190         let ast = MatitaEngine.get_ast status include_paths strm in
191          ast, text
192     | `Ast (st, text) -> st, text
193   in
194   let text_of_loc floc = 
195     let nonskipped_txt,_ = MatitaGtkMisc.utf8_parsed_text unparsed_text floc in
196     let start, stop = HExtlib.loc_of_floc floc in 
197     let floc = HExtlib.floc_of_loc (0, start) in
198     let skipped_txt,_ = MatitaGtkMisc.utf8_parsed_text unparsed_text floc in
199     let floc = HExtlib.floc_of_loc (0, stop) in
200     let txt,len = MatitaGtkMisc.utf8_parsed_text unparsed_text floc in
201     txt,nonskipped_txt,skipped_txt,len
202   in 
203   match st with
204   | GrafiteAst.Executable (loc, ex) ->
205      let _, nonskipped, skipped, parsed_text_length = text_of_loc loc in
206       eval_executable include_paths buffer status unparsed_text
207        skipped nonskipped script ex loc
208   | GrafiteAst.Comment (loc, GrafiteAst.Code (_, ex))
209     when Helm_registry.get_bool "matita.execcomments" ->
210      let _, nonskipped, skipped, parsed_text_length = text_of_loc loc in
211       eval_executable include_paths buffer status unparsed_text
212        skipped nonskipped script ex loc
213   | GrafiteAst.Comment (loc, _) -> 
214       let parsed_text, _, _, parsed_text_length = text_of_loc loc in
215       let remain_len = String.length unparsed_text - parsed_text_length in
216       let s = String.sub unparsed_text parsed_text_length remain_len in
217       let s,text,len = 
218        try
219         eval_statement include_paths buffer status script (`Raw s)
220        with
221           HExtlib.Localized (floc, exn) ->
222            HExtlib.raise_localized_exception 
223              ~offset:(MatitaGtkMisc.utf8_string_length parsed_text) floc exn
224         | MultiPassDisambiguator.DisambiguationError (offset,errorll) ->
225            raise
226             (MultiPassDisambiguator.DisambiguationError
227               (offset+parsed_text_length, errorll))
228       in
229       assert (text=""); (* no macros inside comments, please! *)
230       (match s with
231       | (statuses,text)::tl ->
232          (statuses,parsed_text ^ text)::tl,"",parsed_text_length + len
233       | [] -> [], "", 0)
234   
235 let fresh_script_id =
236   let i = ref 0 in
237   fun () -> incr i; !i
238
239 (** Selection handling
240  * Two clipboards are used: "clipboard" and "primary".
241  * "primary" is used by X, when you hit the middle button mouse is content is
242  *    pasted between applications. In Matita this selection always contain the
243  *    textual version of the selected term.
244  * "clipboard" is used inside Matita only and support ATM two different targets:
245  *    "TERM" and "PATTERN", in the future other targets like "MATHMLCONTENT" may
246  *    be added
247  *)
248 class script ~(parent:GBin.scrolled_window) ~tab_label () =
249 let source_view =
250   GSourceView2.source_view
251     ~auto_indent:true
252     ~insert_spaces_instead_of_tabs:true ~tab_width:2
253     ~right_margin_position:80 ~show_right_margin:true
254     ~smart_home_end:`AFTER
255     ~packing:parent#add
256     () in
257 let buffer = source_view#buffer in
258 let source_buffer = source_view#source_buffer in
259 let similarsymbols_tag_name = "similarsymbolos" in
260 let similarsymbols_tag = `NAME similarsymbols_tag_name in
261 let initial_statuses current baseuri =
262  let status = new MatitaEngine.status baseuri in
263  (match current with
264      Some current -> NCicLibrary.time_travel status;
265 (*
266       (* MATITA 1.0: there is a known bug in invalidation; temporary fix here *)
267       NCicEnvironment.invalidate () *)
268    | None -> ());
269   status
270 in
271 let default_buri = "cic:/matita/tests" in
272 let default_fname = ".unnamed.ma" in
273 object (self)
274   val mutable include_paths_ = []
275   val clipboard = GData.clipboard Gdk.Atom.clipboard
276   (*val primary = GData.clipboard Gdk.Atom.primary*)
277   val mutable similarsymbols = []
278   val mutable similarsymbols_orig = []
279   val similar_memory = Hashtbl.create 97
280   val mutable old_used_memory = false
281
282   val scriptId = fresh_script_id ()
283
284   val mutable filename_ = (None : string option)
285
286   method has_name = filename_ <> None
287
288   method source_view = source_view
289   
290   method include_paths =
291     include_paths_ @ 
292     Helm_registry.get_list Helm_registry.string "matita.includes"
293
294   method private curdir =
295     try
296      let root, _buri, _fname, _tgt = 
297       Librarian.baseuri_of_script ~include_paths:self#include_paths
298        self#filename 
299      in 
300      root
301     with Librarian.NoRootFor _ -> Sys.getcwd ()
302
303   method buri_of_current_file =
304     match filename_ with
305     | None -> default_buri 
306     | Some f ->
307         try 
308           let _root, buri, _fname, _tgt = 
309             Librarian.baseuri_of_script ~include_paths:self#include_paths f 
310           in 
311           buri
312         with Librarian.NoRootFor _ | Librarian.FileNotFound _ -> default_buri
313
314   method filename = match filename_ with None -> default_fname | Some f -> f
315
316   initializer 
317     ignore
318      (source_view#source_buffer#begin_not_undoable_action ();
319       self#reset (); 
320       self#template (); 
321       source_view#source_buffer#end_not_undoable_action ());
322     MatitaMisc.observe_font_size (fun font_size ->
323      source_view#misc#modify_font_by_name
324         (sprintf "%s %d" BuildTimeConf.script_font font_size));
325     source_view#misc#grab_focus ();
326     ignore(source_view#source_buffer#set_language
327      (Some MatitaGtkMisc.matita_lang));
328     ignore(source_view#source_buffer#set_highlight_syntax true);
329     ignore(source_view#connect#after#paste_clipboard 
330         ~callback:(fun () -> self#clean_dirty_lock));
331     ignore (GMain.Timeout.add ~ms:300000 
332        ~callback:(fun _ -> self#_saveToBackupFile ();true));
333     ignore (buffer#connect#modified_changed 
334       (fun _ -> self#set_star buffer#modified));
335     (* clean_locked is set to true only "during" a PRIMARY paste
336        operation (i.e. by clicking with the second mouse button) *)
337     let clean_locked = ref false in
338     ignore(source_view#event#connect#button_press
339       ~callback:
340         (fun button ->
341           if GdkEvent.Button.button button = 2 then
342            clean_locked := true;
343           false
344         ));
345     ignore(source_view#event#connect#button_release
346       ~callback:(fun button -> clean_locked := false; false));
347     ignore(source_view#buffer#connect#after#apply_tag
348      ~callback:(
349        fun tag ~start:_ ~stop:_ ->
350         if !clean_locked &&
351            tag#get_oid = self#locked_tag#get_oid
352         then
353          begin
354           clean_locked := false;
355           self#clean_dirty_lock;
356           clean_locked := true
357          end));
358     ignore(source_view#source_buffer#connect#after#insert_text 
359      ~callback:(fun iter str -> 
360         if (MatitaMisc.get_gui ())#main#menuitemAutoAltL#active && (str = " " || str = "\n") then 
361           ignore(self#expand_virtual_if_any iter str)));
362     ignore(source_view#connect#after#populate_popup
363      ~callback:(fun pre_menu ->
364        let menu = new GMenu.menu pre_menu in
365        let menuItems = menu#children in
366        let undoMenuItem, redoMenuItem =
367         match menuItems with
368            [undo;redo;sep1;cut;copy;paste;delete;sep2;
369             selectall;sep3;inputmethod;insertunicodecharacter] ->
370               List.iter menu#remove [ copy; cut; delete; paste ];
371               undo,redo
372          | _ -> assert false in
373        let add_menu_item =
374          let i = ref 2 in (* last occupied position *)
375          fun ?label ?stock () ->
376            incr i;
377            GMenu.image_menu_item ?label ?stock ~packing:(menu#insert ~pos:!i)
378             ()
379        in
380        let copy = add_menu_item ~stock:`COPY () in
381        let cut = add_menu_item ~stock:`CUT () in
382        let delete = add_menu_item ~stock:`DELETE () in
383        let paste = add_menu_item ~stock:`PASTE () in
384        let paste_pattern = add_menu_item ~label:"Paste as pattern" () in
385        copy#misc#set_sensitive self#canCopy;
386        cut#misc#set_sensitive self#canCut;
387        delete#misc#set_sensitive self#canDelete;
388        paste#misc#set_sensitive self#canPaste;
389        paste_pattern#misc#set_sensitive self#canPastePattern;
390        MatitaGtkMisc.connect_menu_item copy self#copy;
391        MatitaGtkMisc.connect_menu_item cut self#cut;
392        MatitaGtkMisc.connect_menu_item delete self#delete;
393        MatitaGtkMisc.connect_menu_item paste self#paste;
394        MatitaGtkMisc.connect_menu_item paste_pattern self#pastePattern;
395        let new_undoMenuItem =
396         GMenu.image_menu_item
397          ~image:(GMisc.image ~stock:`UNDO ())
398          ~use_mnemonic:true
399          ~label:"_Undo"
400          ~packing:(menu#insert ~pos:0) () in
401        new_undoMenuItem#misc#set_sensitive
402         (undoMenuItem#misc#get_flag `SENSITIVE);
403        menu#remove (undoMenuItem :> GMenu.menu_item);
404        MatitaGtkMisc.connect_menu_item new_undoMenuItem
405         (fun () -> self#safe_undo);
406        let new_redoMenuItem =
407         GMenu.image_menu_item
408          ~image:(GMisc.image ~stock:`REDO ())
409          ~use_mnemonic:true
410          ~label:"_Redo"
411          ~packing:(menu#insert ~pos:1) () in
412        new_redoMenuItem#misc#set_sensitive
413         (redoMenuItem#misc#get_flag `SENSITIVE);
414         menu#remove (redoMenuItem :> GMenu.menu_item);
415         MatitaGtkMisc.connect_menu_item new_redoMenuItem
416          (fun () -> self#safe_redo)));
417
418   val mutable statements = []    (** executed statements *)
419
420   val mutable history = [ initial_statuses None default_buri ]
421     (** list of states before having executed statements. Head element of this
422       * list is the current state, last element is the state at the beginning of
423       * the script.
424       * Invariant: this list length is 1 + length of statements *)
425
426   (** text mark and tag representing locked part of a script *)
427   val locked_mark =
428     buffer#create_mark ~name:"locked" ~left_gravity:true buffer#start_iter
429   val beginning_of_statement_mark =
430     buffer#create_mark ~name:"beginning_of_statement"
431      ~left_gravity:true buffer#start_iter
432   val locked_tag = buffer#create_tag [`BACKGROUND "lightblue"; `EDITABLE false]
433   val error_tag = buffer#create_tag [`UNDERLINE `SINGLE; `FOREGROUND "red"]
434
435   (** unicode handling *)
436   method nextSimilarSymbol = 
437     let write_similarsymbol s =
438       let s = Glib.Utf8.from_unichar s in
439       let iter = source_view#source_buffer#get_iter_at_mark `INSERT in
440       assert(Glib.Utf8.validate s);
441       source_view#source_buffer#delete ~start:iter ~stop:(iter#copy#backward_chars 1);
442       source_view#source_buffer#insert ~iter:(source_view#source_buffer#get_iter_at_mark `INSERT) s;
443       (try source_view#source_buffer#delete_mark similarsymbols_tag
444        with GText.No_such_mark _ -> ());
445       ignore(source_view#source_buffer#create_mark ~name:similarsymbols_tag_name
446         (source_view#source_buffer#get_iter_at_mark `INSERT));
447     in
448     let new_similarsymbol =
449       try
450         let iter_ins = source_view#source_buffer#get_iter_at_mark `INSERT in
451         let iter_lig = source_view#source_buffer#get_iter_at_mark similarsymbols_tag in
452         not (iter_ins#equal iter_lig)
453       with GText.No_such_mark _ -> true
454     in
455     if new_similarsymbol then
456       (if not(self#expand_virtual_if_any (source_view#source_buffer#get_iter_at_mark `INSERT) "")then
457         let last_symbol = 
458           let i = source_view#source_buffer#get_iter_at_mark `INSERT in
459           Glib.Utf8.first_char (i#get_slice ~stop:(i#copy#backward_chars 1))
460         in
461         (match Virtuals.similar_symbols last_symbol with
462         | [] ->  ()
463         | eqclass ->
464             similarsymbols_orig <- eqclass;
465             let is_used = 
466               try Hashtbl.find similar_memory similarsymbols_orig  
467               with Not_found -> 
468                 let is_used = List.map (fun x -> x,false) eqclass in
469                 Hashtbl.add similar_memory eqclass is_used; 
470                 is_used
471             in
472             let hd, next, tl = 
473               let used, unused = 
474                 List.partition (fun s -> List.assoc s is_used) eqclass 
475               in
476               match used @ unused with a::b::c -> a,b,c | _ -> assert false
477             in
478             let hd, tl = 
479               if hd = last_symbol then next, tl @ [hd] else hd, (next::tl)
480             in
481             old_used_memory <- List.assoc hd is_used;
482             let is_used = 
483               (hd,true) :: List.filter (fun (x,_) -> x <> hd) is_used
484             in
485             Hashtbl.replace similar_memory similarsymbols_orig is_used;
486             write_similarsymbol hd;
487             similarsymbols <- tl @ [ hd ]))
488     else 
489       match similarsymbols with
490       | [] -> ()
491       | hd :: tl ->
492           let is_used = Hashtbl.find similar_memory similarsymbols_orig in
493           let last = HExtlib.list_last tl in
494           let old_used_for_last = old_used_memory in
495           old_used_memory <- List.assoc hd is_used;
496           let is_used = 
497             (hd, true) :: (last,old_used_for_last) ::
498               List.filter (fun (x,_) -> x <> last && x <> hd) is_used 
499           in
500           Hashtbl.replace similar_memory similarsymbols_orig is_used;
501           similarsymbols <- tl @ [ hd ];
502           write_similarsymbol hd
503
504   method private reset_similarsymbols =
505    similarsymbols <- []; 
506    similarsymbols_orig <- []; 
507    try source_view#source_buffer#delete_mark similarsymbols_tag
508    with GText.No_such_mark _ -> ()
509  
510   method private expand_virtual_if_any iter tok =
511     try
512      let len = MatitaGtkMisc.utf8_string_length tok in
513      let last_word =
514       let prev = iter#copy#backward_chars len in
515        prev#get_slice ~stop:(prev#copy#backward_find_char 
516         (fun x -> Glib.Unichar.isspace x || x = Glib.Utf8.first_char "\\"))
517      in
518      let inplaceof, symb = Virtuals.symbol_of_virtual last_word in
519      self#reset_similarsymbols;
520      let s = Glib.Utf8.from_unichar symb in
521      assert(Glib.Utf8.validate s);
522      source_view#source_buffer#delete ~start:iter 
523        ~stop:(iter#copy#backward_chars
524          (MatitaGtkMisc.utf8_string_length inplaceof + len));
525      source_view#source_buffer#insert ~iter
526        (if inplaceof.[0] = '\\' then s else (s ^ tok));
527      true
528     with Virtuals.Not_a_virtual -> false
529     
530   (** selections / clipboards handling *)
531
532   method markupSelected = MatitaMathView.has_selection ()
533   method private textSelected =
534     (source_view#source_buffer#get_iter_at_mark `INSERT)#compare
535       (source_view#source_buffer#get_iter_at_mark `SEL_BOUND) <> 0
536   method private markupStored = MatitaMathView.has_clipboard ()
537   method private textStored = clipboard#text <> None
538   method canCopy = self#textSelected
539   method canCut = self#textSelected
540   method canDelete = self#textSelected
541   (*CSC: WRONG CODE: we should look in the clipboard instead! *)
542   method canPaste = self#markupStored || self#textStored
543   method canPastePattern = self#markupStored
544
545   method safe_undo =
546    (* phase 1: we save the actual status of the marks and we undo *)
547    let locked_mark = `MARK (self#locked_mark) in
548    let locked_iter = source_view#buffer#get_iter_at_mark locked_mark in
549    let locked_iter_offset = locked_iter#offset in
550    let mark2 =
551     `MARK
552       (source_view#buffer#create_mark ~name:"lock_point"
553         ~left_gravity:true locked_iter) in
554    source_view#source_buffer#undo ();
555    (* phase 2: we save the cursor position and we redo, restoring
556       the previous status of all the marks *)
557    let cursor_iter = source_view#buffer#get_iter_at_mark `INSERT in
558    let mark =
559     `MARK
560       (source_view#buffer#create_mark ~name:"undo_point"
561         ~left_gravity:true cursor_iter)
562    in
563     source_view#source_buffer#redo ();
564     let mark_iter = source_view#buffer#get_iter_at_mark mark in
565     let mark2_iter = source_view#buffer#get_iter_at_mark mark2 in
566     let mark2_iter = mark2_iter#set_offset locked_iter_offset in
567      source_view#buffer#move_mark locked_mark ~where:mark2_iter;
568      source_view#buffer#delete_mark mark;
569      source_view#buffer#delete_mark mark2;
570      (* phase 3: if after the undo the cursor was in the locked area,
571         then we move it there again and we perform a goto *)
572      if mark_iter#offset < locked_iter_offset then
573       begin
574        source_view#buffer#move_mark `INSERT ~where:mark_iter;
575        self#goto `Cursor ();
576       end;
577      (* phase 4: we perform again the undo. This time we are sure that
578         the text to undo is not locked *)
579      source_view#source_buffer#undo ();
580      source_view#misc#grab_focus ()
581
582   method safe_redo =
583    (* phase 1: we save the actual status of the marks, we redo and
584       we undo *)
585    let locked_mark = `MARK (self#locked_mark) in
586    let locked_iter = source_view#buffer#get_iter_at_mark locked_mark in
587    let locked_iter_offset = locked_iter#offset in
588    let mark2 =
589     `MARK
590       (source_view#buffer#create_mark ~name:"lock_point"
591         ~left_gravity:true locked_iter) in
592    source_view#source_buffer#redo ();
593    source_view#source_buffer#undo ();
594    (* phase 2: we save the cursor position and we restore
595       the previous status of all the marks *)
596    let cursor_iter = source_view#buffer#get_iter_at_mark `INSERT in
597    let mark =
598     `MARK
599       (source_view#buffer#create_mark ~name:"undo_point"
600         ~left_gravity:true cursor_iter)
601    in
602     let mark_iter = source_view#buffer#get_iter_at_mark mark in
603     let mark2_iter = source_view#buffer#get_iter_at_mark mark2 in
604     let mark2_iter = mark2_iter#set_offset locked_iter_offset in
605      source_view#buffer#move_mark locked_mark ~where:mark2_iter;
606      source_view#buffer#delete_mark mark;
607      source_view#buffer#delete_mark mark2;
608      (* phase 3: if after the undo the cursor is in the locked area,
609         then we move it there again and we perform a goto *)
610      if mark_iter#offset < locked_iter_offset then
611       begin
612        source_view#buffer#move_mark `INSERT ~where:mark_iter;
613        self#goto `Cursor ();
614       end;
615      (* phase 4: we perform again the redo. This time we are sure that
616         the text to redo is not locked *)
617      source_view#source_buffer#redo ();
618      source_view#misc#grab_focus ()
619    
620
621   method copy () =
622    if self#textSelected
623    then begin
624      MatitaMathView.empty_clipboard ();
625      source_view#buffer#copy_clipboard clipboard;
626    end else
627      MatitaMathView.copy_selection ()
628
629   method cut () =
630    source_view#buffer#cut_clipboard clipboard;
631    MatitaMathView.empty_clipboard ()
632
633   method delete () =
634    ignore (source_view#buffer#delete_selection ())
635
636   method paste () =
637     if MatitaMathView.has_clipboard ()
638     then source_view#buffer#insert (MatitaMathView.paste_clipboard `Term)
639     else source_view#buffer#paste_clipboard clipboard;
640     self#clean_dirty_lock
641
642   method pastePattern () =
643     source_view#buffer#insert (MatitaMathView.paste_clipboard `Pattern)
644
645   method locked_mark = locked_mark
646   method locked_tag = locked_tag
647   method error_tag = error_tag
648
649     (* history can't be empty, the invariant above grant that it contains at
650      * least the init grafite_status *)
651   method status = match history with s::_ -> s | _ -> assert false
652
653   method private _advance ?statement () =
654    let s = match statement with Some s -> s | None -> self#getFuture in
655    if self#bos then LibraryClean.clean_baseuris [self#buri_of_current_file];
656    HLog.debug ("evaluating: " ^ first_line s ^ " ...");
657    let time1 = Unix.gettimeofday () in
658    let entries, newtext, parsed_len = 
659     try
660      eval_statement self#include_paths buffer self#status self (`Raw s)
661     with End_of_file -> raise Margin
662    in
663    let time2 = Unix.gettimeofday () in
664    HLog.debug ("... done in " ^ string_of_float (time2 -. time1) ^ "s");
665    let new_statuses, new_statements =
666      let statuses, texts = List.split entries in
667      statuses, texts
668    in
669    history <- new_statuses @ history;
670    statements <- new_statements @ statements;
671    let start = buffer#get_iter_at_mark (`MARK locked_mark) in
672    let new_text = String.concat "" (List.rev new_statements) in
673    if statement <> None then
674      buffer#insert ~iter:start new_text
675    else begin
676      let parsed_text = String.sub s 0 parsed_len in
677      if new_text <> parsed_text then begin
678        let stop = start#copy#forward_chars (Glib.Utf8.length parsed_text) in
679        buffer#delete ~start ~stop;
680        buffer#insert ~iter:start new_text;
681      end;
682    end;
683    self#moveMark (Glib.Utf8.length new_text);
684    buffer#insert ~iter:(buffer#get_iter_at_mark (`MARK locked_mark)) newtext
685
686   method private _retract offset status new_statements new_history =
687     NCicLibrary.time_travel status;
688     statements <- new_statements;
689     history <- new_history;
690     self#moveMark (- offset)
691
692   method advance ?statement () =
693     try
694       self#_advance ?statement ();
695       self#notify
696     with 
697     | Margin -> self#notify
698     | Not_found -> assert false
699     | Invalid_argument "Array.make" -> HLog.error "The script is too big!\n"
700     | exc -> self#notify; raise exc
701
702   method retract () =
703     try
704       let cmp,new_statements,new_history,status =
705        match statements,history with
706           stat::statements, _::(status::_ as history) ->
707            assert (Glib.Utf8.validate stat);
708            Glib.Utf8.length stat, statements, history, status
709        | [],[_] -> raise Margin
710        | _,_ -> assert false
711       in
712        self#_retract cmp status new_statements new_history;
713        self#notify
714     with 
715     | Margin -> self#notify
716     | Invalid_argument "Array.make" -> HLog.error "The script is too big!\n"
717     | exc -> self#notify; raise exc
718
719   method private getFuture =
720     let lock = buffer#get_iter_at_mark (`MARK locked_mark) in
721     let text = buffer#get_text ~start:lock ~stop:buffer#end_iter () in
722     text
723
724   method expandAllVirtuals =
725     let lock = buffer#get_iter_at_mark (`MARK locked_mark) in
726     let text = buffer#get_text ~start:lock ~stop:buffer#end_iter () in
727     buffer#delete ~start:lock ~stop:buffer#end_iter;
728     let text = Pcre.replace ~pat:":=" ~templ:"\\def" text in
729     let text = Pcre.replace ~pat:"->" ~templ:"\\to" text in
730     let text = Pcre.replace ~pat:"=>" ~templ:"\\Rightarrow" text in
731     let text = 
732       Pcre.substitute_substrings 
733         ~subst:(fun str -> 
734            let pristine = Pcre.get_substring str 0 in
735            let input = 
736              if pristine.[0] = ' ' then
737                String.sub pristine 1 (String.length pristine -1) 
738              else pristine 
739            in
740            let input = 
741              if input.[String.length input-1] = ' ' then
742                String.sub input 0 (String.length input -1) 
743              else input
744            in
745            let before, after =  
746              if input = "\\forall" || 
747                 input = "\\lambda" || 
748                 input = "\\exists" then "","" else " ", " " 
749            in
750            try 
751              before ^ Glib.Utf8.from_unichar 
752                (snd (Virtuals.symbol_of_virtual input)) ^ after
753            with Virtuals.Not_a_virtual -> pristine) 
754         ~pat:" ?\\\\[a-zA-Z]+ ?" text
755     in
756     buffer#insert ~iter:lock text
757       
758   (** @param rel_offset relative offset from current position of locked_mark *)
759   method private moveMark rel_offset =
760     let mark = `MARK locked_mark in
761     let old_insert = buffer#get_iter_at_mark `INSERT in
762     buffer#remove_tag locked_tag ~start:buffer#start_iter ~stop:buffer#end_iter;
763     let current_mark_pos = buffer#get_iter_at_mark mark in
764     let new_mark_pos =
765       match rel_offset with
766       | 0 -> current_mark_pos
767       | n when n > 0 -> current_mark_pos#forward_chars n
768       | n (* when n < 0 *) -> current_mark_pos#backward_chars (abs n)
769     in
770     buffer#move_mark mark ~where:new_mark_pos;
771     buffer#apply_tag locked_tag ~start:buffer#start_iter ~stop:new_mark_pos;
772     buffer#move_mark `INSERT old_insert;
773     let mark_position = buffer#get_iter_at_mark mark in
774     if source_view#move_mark_onscreen mark then
775      begin
776       buffer#move_mark mark mark_position;
777       source_view#scroll_to_mark ~use_align:true ~xalign:1.0 ~yalign:0.1 mark;
778      end;
779     while Glib.Main.pending () do ignore(Glib.Main.iteration false); done
780
781   method clean_dirty_lock =
782     let lock_mark_iter = buffer#get_iter_at_mark (`MARK locked_mark) in
783     buffer#remove_tag locked_tag ~start:buffer#start_iter ~stop:buffer#end_iter;
784     buffer#apply_tag locked_tag ~start:buffer#start_iter ~stop:lock_mark_iter
785
786   val mutable observers = []
787
788   method addObserver (o: GrafiteTypes.status -> unit) =
789     observers <- o :: observers
790
791   method private notify =
792     let status = self#status in
793     List.iter (fun o -> o status) observers
794
795   method activate =
796     NCicLibrary.replace self#status;
797     self#notify
798
799   method loadFromFile f =
800     buffer#set_text (HExtlib.input_file f);
801     self#reset_buffer;
802     buffer#set_modified false
803
804   method assignFileName file =
805    match file with
806       None ->
807        tab_label#set_text default_fname;
808        filename_ <- None;
809        include_paths_ <- [];
810        self#reset_buffer
811     | Some file ->
812        let f = Librarian.absolutize file in
813         tab_label#set_text (Filename.basename f);
814         filename_ <- Some f;
815         include_paths_ <- MatitaEngine.read_include_paths ~include_paths:[] f;
816         self#reset_buffer
817
818   method set_star b =
819    tab_label#set_text ((if b then "*" else "")^Filename.basename self#filename);
820    tab_label#misc#set_tooltip_text
821     ("URI: " ^ self#buri_of_current_file ^ "\nPATH: " ^ self#filename);
822     
823   method saveToFile () =
824     if self#has_name then
825       let oc = open_out self#filename in
826       output_string oc (buffer#get_text ~start:buffer#start_iter
827                         ~stop:buffer#end_iter ());
828       close_out oc;
829       self#set_star false;
830       buffer#set_modified false
831     else
832       HLog.error "Can't save, no filename selected"
833   
834   method private _saveToBackupFile () =
835     if buffer#modified then
836       begin
837         let f = self#filename ^ "~" in
838         let oc = open_out f in
839         output_string oc (buffer#get_text ~start:buffer#start_iter
840                             ~stop:buffer#end_iter ());
841         close_out oc;
842         HLog.debug ("backup " ^ f ^ " saved")
843       end
844   
845   method private reset_buffer = 
846     statements <- [];
847     history <- [ initial_statuses (Some self#status) self#buri_of_current_file ];
848     self#notify;
849     buffer#remove_tag locked_tag ~start:buffer#start_iter ~stop:buffer#end_iter;
850     buffer#move_mark (`MARK locked_mark) ~where:buffer#start_iter
851
852   method reset () =
853     self#reset_buffer;
854     source_buffer#begin_not_undoable_action ();
855     buffer#delete ~start:buffer#start_iter ~stop:buffer#end_iter;
856     source_buffer#end_not_undoable_action ();
857     buffer#set_modified false;
858   
859   method template () =
860     let template = HExtlib.input_file BuildTimeConf.script_template in 
861     buffer#insert ~iter:(buffer#get_iter `START) template;
862     buffer#set_modified false;
863     self#set_star false;
864
865   method goto (pos: [`Top | `Bottom | `Cursor]) () =
866   try  
867     let old_locked_mark =
868      `MARK
869        (buffer#create_mark ~name:"old_locked_mark"
870          ~left_gravity:true (buffer#get_iter_at_mark (`MARK locked_mark))) in
871     let getpos _ = buffer#get_iter_at_mark (`MARK locked_mark) in 
872     let getoldpos _ = buffer#get_iter_at_mark old_locked_mark in 
873     let dispose_old_locked_mark () = buffer#delete_mark old_locked_mark in
874     match pos with
875     | `Top -> 
876         dispose_old_locked_mark (); 
877         self#reset_buffer;
878         self#notify
879     | `Bottom ->
880         (try 
881           let rec dowhile () =
882             self#_advance ();
883             let newpos = getpos () in
884             if (getoldpos ())#compare newpos < 0 then
885               begin
886                 buffer#move_mark old_locked_mark newpos;
887                 dowhile ()
888               end
889           in
890           dowhile ();
891           dispose_old_locked_mark ();
892           self#notify 
893         with 
894         | Margin -> dispose_old_locked_mark (); self#notify
895         | exc -> dispose_old_locked_mark (); self#notify; raise exc)
896     | `Cursor ->
897         let locked_iter () = buffer#get_iter_at_mark (`NAME "locked") in
898         let cursor_iter () = buffer#get_iter_at_mark `INSERT in
899         let remember =
900          `MARK
901            (buffer#create_mark ~name:"initial_insert"
902              ~left_gravity:true (cursor_iter ())) in
903         let dispose_remember () = buffer#delete_mark remember in
904         let remember_iter () =
905          buffer#get_iter_at_mark (`NAME "initial_insert") in
906         let cmp () = (locked_iter ())#offset - (remember_iter ())#offset in
907         let icmp = cmp () in
908         let forward_until_cursor () = (* go forward until locked > cursor *)
909           let rec aux () =
910             self#_advance ();
911             if cmp () < 0 && (getoldpos ())#compare (getpos ()) < 0 
912             then
913              begin
914               buffer#move_mark old_locked_mark (getpos ());
915               aux ()
916              end
917           in
918           aux ()
919         in
920         let rec back_until_cursor len = (* go backward until locked < cursor *)
921          function
922             statements, ((status)::_ as history)
923             when len <= 0 ->
924              self#_retract (icmp - len) status statements
925               history
926           | statement::tl1, _::tl2 ->
927              back_until_cursor (len - MatitaGtkMisc.utf8_string_length statement) (tl1,tl2)
928           | _,_ -> assert false
929         in
930         (try
931           begin
932            if icmp < 0 then       (* locked < cursor *)
933              (forward_until_cursor (); self#notify)
934            else if icmp > 0 then  (* locked > cursor *)
935              (back_until_cursor icmp (statements,history); self#notify)
936            else                  (* cursor = locked *)
937                ()
938           end ;
939           dispose_remember ();
940           dispose_old_locked_mark ();
941         with 
942         | Margin -> dispose_remember (); dispose_old_locked_mark (); self#notify
943         | exc -> dispose_remember (); dispose_old_locked_mark ();
944                  self#notify; raise exc)
945   with Invalid_argument "Array.make" ->
946      HLog.error "The script is too big!\n"
947   
948   method bos = 
949     match history with
950     | _::[] -> true
951     | _ -> false
952
953   method eos = 
954     let rec is_there_only_comments status s = 
955       if Pcre.pmatch ~rex:only_dust_RE s then raise Margin;
956       let strm =
957        GrafiteParser.parsable_statement status
958         (Ulexing.from_utf8_string s)in
959       match GrafiteParser.parse_statement status strm with
960       | GrafiteAst.Comment (loc,_) -> 
961           let _,parsed_text_length = MatitaGtkMisc.utf8_parsed_text s loc in
962           (* CSC: why +1 in the following lines ???? *)
963           let parsed_text_length = parsed_text_length + 1 in
964           let remain_len = String.length s - parsed_text_length in
965           let next = String.sub s parsed_text_length remain_len in
966           is_there_only_comments status next
967       | GrafiteAst.Executable _ -> false
968     in
969     try is_there_only_comments self#status self#getFuture
970     with 
971     | NCicLibrary.IncludedFileNotCompiled _
972     | HExtlib.Localized _
973     | CicNotationParser.Parse_error _ -> false
974     | Margin | End_of_file -> true
975     | Invalid_argument "Array.make" -> false
976
977   (* debug *)
978   method dump () =
979     HLog.debug "script status:";
980     HLog.debug ("history size: " ^ string_of_int (List.length history));
981     HLog.debug (sprintf "%d statements:" (List.length statements));
982     List.iter HLog.debug statements;
983     HLog.debug ("Current file name: " ^ self#filename);
984
985   method has_parent (p : GObj.widget) = parent#coerce#misc#get_oid = p#misc#get_oid
986 end
987
988 let _script = ref []
989
990 let script ~parent ~tab_label ()
991 =
992   let s = new script ~parent ~tab_label () in
993   _script := s::!_script;
994   s
995
996 let at_page page =
997  let notebook = (MatitaMisc.get_gui ())#main#scriptNotebook in
998  let parent = notebook#get_nth_page page in
999   try
1000    List.find (fun s -> s#has_parent parent) !_script
1001   with
1002    Not_found -> assert false
1003 ;;
1004
1005 let current () =
1006  at_page ((MatitaMisc.get_gui ())#main#scriptNotebook#current_page)
1007
1008 let destroy page =
1009  let s = at_page page in
1010   _script := List.filter ((<>) s) !_script
1011 ;;
1012
1013 let iter_scripts f = List.iter f !_script;;
1014
1015 let _ =
1016  CicMathView.register_matita_script_current (current :> unit -> < advance: ?statement:string -> unit -> unit; status: GrafiteTypes.status >)
1017 ;;