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