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