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