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   mathviewer:MatitaTypes.mathViewer;
  70   urichooser: NReference.reference list -> NReference.reference list;
  71   ask_confirmation: title:string -> message:string -> [`YES | `NO | `CANCEL];
  72 }
  73
  74 let eval_with_engine include_paths guistuff grafite_status user_goal
  75  skipped_txt nonskipped_txt st
  76 =
  77   let parsed_text_length =
  78     String.length skipped_txt + String.length nonskipped_txt
  79   in
  80   let text = skipped_txt ^ nonskipped_txt in
  81   let prefix_len = MatitaGtkMisc.utf8_string_length skipped_txt in
  82   let enriched_history_fragment =
  83    MatitaEngine.eval_ast ~include_paths ~do_heavy_checks:(Helm_registry.get_bool
  84      "matita.do_heavy_checks")
  85     grafite_status (text,prefix_len,st)
  86   in
  87   let enriched_history_fragment = List.rev enriched_history_fragment in
  88   (* really fragile *)
  89   let res,_ =
  90     List.fold_left
  91       (fun (acc, to_prepend) (status,alias) ->
  92        match alias with
  93        | None -> (status,to_prepend ^ nonskipped_txt)::acc,""
  94        | Some (k,value) ->
  95             let newtxt = GrafiteAstPp.pp_alias value in
  96             (status,to_prepend ^ newtxt ^ "\n")::acc, "")
  97       ([],skipped_txt) enriched_history_fragment
  98   in
  99   res,"",parsed_text_length
 100 ;;
 101
 102 (* this function calls the parser in a way that it does not perform inclusions,
 103  * so that we can ensure the inclusion is performed after the included file
 104  * is compiled (if needed). matitac does not need that, since it compiles files
 105  * in the good order, here files may be compiled on demand. *)
 106 let wrap_with_make include_paths f x =
 107   match f x with
 108      (GrafiteAst.Executable
 109        (_,GrafiteAst.NCommand (_,GrafiteAst.Include (_,_,mafilename)))) as cmd
 110      ->
 111       let root, buri, _, tgt =
 112         try Librarian.baseuri_of_script ~include_paths mafilename
 113         with Librarian.NoRootFor _ ->
 114           HLog.error ("The included file '"^mafilename^"' has no root file,");
 115           HLog.error "please create it.";
 116           raise (Failure ("No root file for "^mafilename))
 117       in
 118       if MatitacLib.Make.make root [tgt] then
 119        cmd
 120       else raise (Failure ("Compiling: " ^ tgt))
 121    | cmd -> cmd
 122 ;;
 123
 124 let pp_eager_statement_ast = GrafiteAstPp.pp_statement
 125
 126 let eval_nmacro include_paths (buffer : GText.buffer) guistuff grafite_status user_goal unparsed_text parsed_text script mac =
 127   let parsed_text_length = String.length parsed_text in
 128   match mac with
 129   | TA.Screenshot (_,name) ->
 130        let status = script#grafite_status in
 131        let _,_,menv,subst,_ = status#obj in
 132        let name = Filename.dirname (script#filename) ^ "/" ^ name in
 133        let sequents =
 134          let selected = Continuationals.Stack.head_goals status#stack in
 135          List.filter (fun x,_ -> List.mem x selected) menv
 136        in
 137        guistuff.mathviewer#screenshot status sequents menv subst name;
 138        [status, parsed_text], "", parsed_text_length
 139   | TA.NCheck (_,t) ->
 140       let status = script#grafite_status in
 141       let _,_,menv,subst,_ = status#obj in
 142       let ctx =
 143         try let _,(_,ctx,_) = List.hd menv in ctx
 144         with Failure "hd" -> []
 145       in
 146       let m, s, status, t =
 147         GrafiteDisambiguate.disambiguate_nterm
 148           status None ctx menv subst (parsed_text,parsed_text_length,
 149             NotationPt.Cast (t,NotationPt.Implicit `JustOne))
 150           (* XXX use the metasenv, if possible *)
 151       in
 152       guistuff.mathviewer#show_entry (`NCic (t,ctx,m,s));
 153       [status, parsed_text], "", parsed_text_length
 154   | TA.NIntroGuess _loc ->
 155       let names_ref = ref [] in
 156       let s =
 157         NTactics.intros_tac ~names_ref [] script#grafite_status
 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 ^ "#" ^ String.concat " " !names_ref ^ ";"], "", parsed_text_length
 162   | TA.NAutoInteractive (_loc, (None,a)) ->
 163       let trace_ref = ref [] in
 164       let s =
 165         NnAuto.auto_tac
 166           ~params:(None,a) ~trace_ref script#grafite_status
 167       in
 168       let depth =
 169         try List.assoc "depth" a
 170         with Not_found -> ""
 171       in
 172       let trace = "/"^(if int_of_string depth > 1 then depth else "")^"/ by " in
 173       let thms =
 174         match !trace_ref with
 175         | [] -> "{}"
 176         | thms ->
 177            String.concat ", "
 178              (HExtlib.filter_map (function
 179                | NotationPt.NRef r -> Some (NCicPp.r2s true r)
 180                | _ -> None)
 181              thms)
 182       in
 183       let rex = Pcre.regexp ~flags:[`MULTILINE] "\\A([\\n\\t\\r ]*).*\\Z" in
 184       let nl = Pcre.replace ~rex ~templ:"$1" parsed_text in
 185       [s, nl ^ trace ^ thms ^ ";"], "", parsed_text_length
 186   | TA.NAutoInteractive (_, (Some _,_)) -> assert false
 187
 188 let rec eval_executable include_paths (buffer : GText.buffer) guistuff
 189 grafite_status user_goal unparsed_text skipped_txt nonskipped_txt
 190 script ex loc
 191 =
 192   try
 193    ignore (buffer#move_mark (`NAME "beginning_of_statement")
 194     ~where:((buffer#get_iter_at_mark (`NAME "locked"))#forward_chars
 195        (Glib.Utf8.length skipped_txt))) ;
 196    eval_with_engine include_paths
 197     guistuff grafite_status user_goal skipped_txt nonskipped_txt
 198      (TA.Executable (loc, ex))
 199   with
 200      MatitaTypes.Cancel -> [], "", 0
 201    | GrafiteEngine.NMacro (_loc,macro) ->
 202        eval_nmacro include_paths buffer guistuff grafite_status
 203         user_goal unparsed_text (skipped_txt ^ nonskipped_txt) script macro
 204
 205
 206 and eval_statement include_paths (buffer : GText.buffer) guistuff
 207  grafite_status user_goal script statement
 208 =
 209   let st,unparsed_text =
 210     match statement with
 211     | `Raw text ->
 212         if Pcre.pmatch ~rex:only_dust_RE text then raise Margin;
 213         let ast =
 214          wrap_with_make include_paths
 215           (GrafiteParser.parse_statement grafite_status)
 216             (Ulexing.from_utf8_string text)
 217         in
 218           ast, text
 219     | `Ast (st, text) -> st, text
 220   in
 221   let text_of_loc floc =
 222     let nonskipped_txt,_ = MatitaGtkMisc.utf8_parsed_text unparsed_text floc in
 223     let start, stop = HExtlib.loc_of_floc floc in
 224     let floc = HExtlib.floc_of_loc (0, start) in
 225     let skipped_txt,_ = MatitaGtkMisc.utf8_parsed_text unparsed_text floc in
 226     let floc = HExtlib.floc_of_loc (0, stop) in
 227     let txt,len = MatitaGtkMisc.utf8_parsed_text unparsed_text floc in
 228     txt,nonskipped_txt,skipped_txt,len
 229   in
 230   match st with
 231   | GrafiteAst.Executable (loc, ex) ->
 232      let _, nonskipped, skipped, parsed_text_length = text_of_loc loc in
 233       eval_executable include_paths buffer guistuff
 234        grafite_status user_goal unparsed_text skipped nonskipped script ex loc
 235   | GrafiteAst.Comment (loc, GrafiteAst.Code (_, ex))
 236     when Helm_registry.get_bool "matita.execcomments" ->
 237      let _, nonskipped, skipped, parsed_text_length = text_of_loc loc in
 238       eval_executable include_paths buffer guistuff
 239        grafite_status user_goal unparsed_text skipped nonskipped script ex loc
 240   | GrafiteAst.Comment (loc, _) ->
 241       let parsed_text, _, _, parsed_text_length = text_of_loc loc in
 242       let remain_len = String.length unparsed_text - parsed_text_length in
 243       let s = String.sub unparsed_text parsed_text_length remain_len in
 244       let s,text,len =
 245        try
 246         eval_statement include_paths buffer guistuff
 247          grafite_status user_goal script (`Raw s)
 248        with
 249           HExtlib.Localized (floc, exn) ->
 250            HExtlib.raise_localized_exception
 251              ~offset:(MatitaGtkMisc.utf8_string_length parsed_text) floc exn
 252         | MultiPassDisambiguator.DisambiguationError (offset,errorll) ->
 253            raise
 254             (MultiPassDisambiguator.DisambiguationError
 255               (offset+parsed_text_length, errorll))
 256       in
 257       assert (text=""); (* no macros inside comments, please! *)
 258       (match s with
 259       | (statuses,text)::tl ->
 260          (statuses,parsed_text ^ text)::tl,"",parsed_text_length + len
 261       | [] -> [], "", 0)
 262
 263 let fresh_script_id =
 264   let i = ref 0 in
 265   fun () -> incr i; !i
 266
 267 class script  ~(source_view: GSourceView2.source_view)
 268               ~(mathviewer: MatitaTypes.mathViewer)
 269               ~set_star
 270               ~ask_confirmation
 271               ~urichooser
 272               () =
 273 let buffer = source_view#buffer in
 274 let source_buffer = source_view#source_buffer in
 275 let initial_statuses current baseuri =
 276  let empty_lstatus = new GrafiteDisambiguate.status in
 277  (match current with
 278      Some current ->
 279       NCicLibrary.time_travel
 280        ((new GrafiteTypes.status current#baseuri)#set_disambiguate_db current#disambiguate_db);
 281       (* CSC: there is a known bug in invalidation; temporary fix here *)
 282       NCicEnvironment.invalidate ()
 283    | None -> ());
 284  let lexicon_status = empty_lstatus in
 285  let grafite_status = (new GrafiteTypes.status baseuri)#set_disambiguate_db lexicon_status#disambiguate_db in
 286   grafite_status
 287 in
 288 let read_include_paths file =
 289  try
 290    let root, _buri, _fname, _tgt =
 291      Librarian.baseuri_of_script ~include_paths:[] file
 292    in
 293    let rc =
 294     Str.split (Str.regexp " ")
 295      (List.assoc "include_paths" (Librarian.load_root_file (root^"/root")))
 296    in
 297    List.iter (HLog.debug) rc; rc
 298  with Librarian.NoRootFor _ | Not_found -> []
 299 in
 300 let default_buri = "cic:/matita/tests" in
 301 let default_fname = ".unnamed.ma" in
 302 object (self)
 303   val mutable include_paths_ = []
 304
 305   val scriptId = fresh_script_id ()
 306
 307   val guistuff = {
 308     mathviewer = mathviewer;
 309     urichooser = urichooser;
 310     ask_confirmation = ask_confirmation;
 311   }
 312
 313   val mutable filename_ = (None : string option)
 314
 315   method has_name = filename_ <> None
 316
 317   method include_paths =
 318     include_paths_ @
 319     Helm_registry.get_list Helm_registry.string "matita.includes"
 320
 321   method private curdir =
 322     try
 323      let root, _buri, _fname, _tgt =
 324        Librarian.baseuri_of_script ~include_paths:self#include_paths
 325        self#filename
 326      in
 327      root
 328     with Librarian.NoRootFor _ -> Sys.getcwd ()
 329
 330   method buri_of_current_file =
 331     match filename_ with
 332     | None -> default_buri
 333     | Some f ->
 334         try
 335           let _root, buri, _fname, _tgt =
 336             Librarian.baseuri_of_script ~include_paths:self#include_paths f
 337           in
 338           buri
 339         with Librarian.NoRootFor _ -> default_buri
 340
 341   method filename = match filename_ with None -> default_fname | Some f -> f
 342
 343   initializer
 344     ignore (GMain.Timeout.add ~ms:300000
 345        ~callback:(fun _ -> self#_saveToBackupFile ();true));
 346     ignore (buffer#connect#modified_changed
 347       (fun _ -> set_star buffer#modified))
 348
 349   val mutable statements = []    (** executed statements *)
 350
 351   val mutable history = [ initial_statuses None default_buri ]
 352     (** list of states before having executed statements. Head element of this
 353       * list is the current state, last element is the state at the beginning of
 354       * the script.
 355       * Invariant: this list length is 1 + length of statements *)
 356
 357   (** goal as seen by the user (i.e. metano corresponding to current tab) *)
 358   val mutable userGoal = (None : int option)
 359
 360   (** text mark and tag representing locked part of a script *)
 361   val locked_mark =
 362     buffer#create_mark ~name:"locked" ~left_gravity:true buffer#start_iter
 363   val beginning_of_statement_mark =
 364     buffer#create_mark ~name:"beginning_of_statement"
 365      ~left_gravity:true buffer#start_iter
 366   val locked_tag = buffer#create_tag [`BACKGROUND "lightblue"; `EDITABLE false]
 367   val error_tag = buffer#create_tag [`UNDERLINE `SINGLE; `FOREGROUND "red"]
 368
 369   method locked_mark = locked_mark
 370   method locked_tag = locked_tag
 371   method error_tag = error_tag
 372
 373     (* history can't be empty, the invariant above grant that it contains at
 374      * least the init grafite_status *)
 375   method grafite_status = match history with s::_ -> s | _ -> assert false
 376
 377   method private _advance ?statement () =
 378    let s = match statement with Some s -> s | None -> self#getFuture in
 379    if self#bos then LibraryClean.clean_baseuris [self#buri_of_current_file];
 380    HLog.debug ("evaluating: " ^ first_line s ^ " ...");
 381    let time1 = Unix.gettimeofday () in
 382    let entries, newtext, parsed_len =
 383     try
 384      eval_statement self#include_paths buffer guistuff
 385       self#grafite_status userGoal self (`Raw s)
 386     with End_of_file -> raise Margin
 387    in
 388    let time2 = Unix.gettimeofday () in
 389    HLog.debug ("... done in " ^ string_of_float (time2 -. time1) ^ "s");
 390    let new_statuses, new_statements =
 391      let statuses, texts = List.split entries in
 392      statuses, texts
 393    in
 394    history <- new_statuses @ history;
 395    statements <- new_statements @ statements;
 396    let start = buffer#get_iter_at_mark (`MARK locked_mark) in
 397    let new_text = String.concat "" (List.rev new_statements) in
 398    if statement <> None then
 399      buffer#insert ~iter:start new_text
 400    else begin
 401      let parsed_text = String.sub s 0 parsed_len in
 402      if new_text <> parsed_text then begin
 403        let stop = start#copy#forward_chars (Glib.Utf8.length parsed_text) in
 404        buffer#delete ~start ~stop;
 405        buffer#insert ~iter:start new_text;
 406      end;
 407    end;
 408    self#moveMark (Glib.Utf8.length new_text);
 409    buffer#insert ~iter:(buffer#get_iter_at_mark (`MARK locked_mark)) newtext;
 410    (* here we need to set the Goal in case we are going to cursor (or to
 411       bottom) and we will face a macro *)
 412     userGoal <- None
 413
 414   method private _retract offset grafite_status new_statements new_history =
 415     NCicLibrary.time_travel grafite_status;
 416     statements <- new_statements;
 417     history <- new_history;
 418     self#moveMark (- offset)
 419
 420   method advance ?statement () =
 421     try
 422       self#_advance ?statement ();
 423       self#notify
 424     with
 425     | Margin -> self#notify
 426     | Not_found -> assert false
 427     | Invalid_argument "Array.make" -> HLog.error "The script is too big!\n"
 428     | exc -> self#notify; raise exc
 429
 430   method retract () =
 431     try
 432       let cmp,new_statements,new_history,grafite_status =
 433        match statements,history with
 434           stat::statements, _::(status::_ as history) ->
 435            assert (Glib.Utf8.validate stat);
 436            Glib.Utf8.length stat, statements, history, status
 437        | [],[_] -> raise Margin
 438        | _,_ -> assert false
 439       in
 440        self#_retract cmp grafite_status new_statements
 441         new_history;
 442        self#notify
 443     with
 444     | Margin -> self#notify
 445     | Invalid_argument "Array.make" -> HLog.error "The script is too big!\n"
 446     | exc -> self#notify; raise exc
 447
 448   method private getFuture =
 449     let lock = buffer#get_iter_at_mark (`MARK locked_mark) in
 450     let text = buffer#get_text ~start:lock ~stop:buffer#end_iter () in
 451     text
 452
 453   method expandAllVirtuals =
 454     let lock = buffer#get_iter_at_mark (`MARK locked_mark) in
 455     let text = buffer#get_text ~start:lock ~stop:buffer#end_iter () in
 456     buffer#delete ~start:lock ~stop:buffer#end_iter;
 457     let text = Pcre.replace ~pat:":=" ~templ:"\\def" text in
 458     let text = Pcre.replace ~pat:"->" ~templ:"\\to" text in
 459     let text = Pcre.replace ~pat:"=>" ~templ:"\\Rightarrow" text in
 460     let text =
 461       Pcre.substitute_substrings
 462         ~subst:(fun str ->
 463            let pristine = Pcre.get_substring str 0 in
 464            let input =
 465              if pristine.[0] = ' ' then
 466                String.sub pristine 1 (String.length pristine -1)
 467              else pristine
 468            in
 469            let input =
 470              if input.[String.length input-1] = ' ' then
 471                String.sub input 0 (String.length input -1)
 472              else input
 473            in
 474            let before, after =
 475              if input = "\\forall" ||
 476                 input = "\\lambda" ||
 477                 input = "\\exists" then "","" else " ", " "
 478            in
 479            try
 480              before ^ Glib.Utf8.from_unichar
 481                (snd (Virtuals.symbol_of_virtual input)) ^ after
 482            with Virtuals.Not_a_virtual -> pristine)
 483         ~pat:" ?\\\\[a-zA-Z]+ ?" text
 484     in
 485     buffer#insert ~iter:lock text
 486
 487   (** @param rel_offset relative offset from current position of locked_mark *)
 488   method private moveMark rel_offset =
 489     let mark = `MARK locked_mark in
 490     let old_insert = buffer#get_iter_at_mark `INSERT in
 491     buffer#remove_tag locked_tag ~start:buffer#start_iter ~stop:buffer#end_iter;
 492     let current_mark_pos = buffer#get_iter_at_mark mark in
 493     let new_mark_pos =
 494       match rel_offset with
 495       | 0 -> current_mark_pos
 496       | n when n > 0 -> current_mark_pos#forward_chars n
 497       | n (* when n < 0 *) -> current_mark_pos#backward_chars (abs n)
 498     in
 499     buffer#move_mark mark ~where:new_mark_pos;
 500     buffer#apply_tag locked_tag ~start:buffer#start_iter ~stop:new_mark_pos;
 501     buffer#move_mark `INSERT old_insert;
 502     let mark_position = buffer#get_iter_at_mark mark in
 503     if source_view#move_mark_onscreen mark then
 504      begin
 505       buffer#move_mark mark mark_position;
 506       source_view#scroll_to_mark ~use_align:true ~xalign:1.0 ~yalign:0.1 mark;
 507      end;
 508     while Glib.Main.pending () do ignore(Glib.Main.iteration false); done
 509
 510   method clean_dirty_lock =
 511     let lock_mark_iter = buffer#get_iter_at_mark (`MARK locked_mark) in
 512     buffer#remove_tag locked_tag ~start:buffer#start_iter ~stop:buffer#end_iter;
 513     buffer#apply_tag locked_tag ~start:buffer#start_iter ~stop:lock_mark_iter
 514
 515   val mutable observers = []
 516
 517   method addObserver (o: GrafiteTypes.status -> unit) =
 518     observers <- o :: observers
 519
 520   method private notify =
 521     let grafite_status = self#grafite_status in
 522     List.iter (fun o -> o grafite_status) observers
 523
 524   method loadFromString s =
 525     buffer#set_text s;
 526     self#reset_buffer;
 527     buffer#set_modified true
 528
 529   method loadFromFile f =
 530     buffer#set_text (HExtlib.input_file f);
 531     self#reset_buffer;
 532     buffer#set_modified false
 533
 534   method assignFileName file =
 535     let file =
 536       match file with
 537       | Some f -> Some (Librarian.absolutize f)
 538       | None -> None
 539     in
 540     filename_ <- file;
 541     include_paths_ <-
 542       (match file with Some file -> read_include_paths file | None -> []);
 543     self#reset_buffer;
 544     Sys.chdir self#curdir;
 545     HLog.debug ("Moving to " ^ Sys.getcwd ())
 546
 547   method saveToFile () =
 548     if self#has_name then
 549       let oc = open_out self#filename in
 550       output_string oc (buffer#get_text ~start:buffer#start_iter
 551                         ~stop:buffer#end_iter ());
 552       close_out oc;
 553       set_star false;
 554       buffer#set_modified false
 555     else
 556       HLog.error "Can't save, no filename selected"
 557
 558   method private _saveToBackupFile () =
 559     if buffer#modified then
 560       begin
 561         let f = self#filename in
 562         let oc = open_out f in
 563         output_string oc (buffer#get_text ~start:buffer#start_iter
 564                             ~stop:buffer#end_iter ());
 565         close_out oc;
 566         HLog.debug ("backup " ^ f ^ " saved")
 567       end
 568
 569   method private reset_buffer =
 570     statements <- [];
 571     history <- [ initial_statuses (Some self#grafite_status) self#buri_of_current_file ];
 572     userGoal <- None;
 573     self#notify;
 574     buffer#remove_tag locked_tag ~start:buffer#start_iter ~stop:buffer#end_iter;
 575     buffer#move_mark (`MARK locked_mark) ~where:buffer#start_iter
 576
 577   method reset () =
 578     self#reset_buffer;
 579     source_buffer#begin_not_undoable_action ();
 580     buffer#delete ~start:buffer#start_iter ~stop:buffer#end_iter;
 581     source_buffer#end_not_undoable_action ();
 582     buffer#set_modified false;
 583
 584   method template () =
 585     let template = HExtlib.input_file BuildTimeConf.script_template in
 586     buffer#insert ~iter:(buffer#get_iter `START) template;
 587     buffer#set_modified false;
 588     set_star false
 589
 590   method goto (pos: [`Top | `Bottom | `Cursor]) () =
 591   try
 592     let old_locked_mark =
 593      `MARK
 594        (buffer#create_mark ~name:"old_locked_mark"
 595          ~left_gravity:true (buffer#get_iter_at_mark (`MARK locked_mark))) in
 596     let getpos _ = buffer#get_iter_at_mark (`MARK locked_mark) in
 597     let getoldpos _ = buffer#get_iter_at_mark old_locked_mark in
 598     let dispose_old_locked_mark () = buffer#delete_mark old_locked_mark in
 599     match pos with
 600     | `Top ->
 601         dispose_old_locked_mark ();
 602         self#reset_buffer;
 603         self#notify
 604     | `Bottom ->
 605         (try
 606           let rec dowhile () =
 607             self#_advance ();
 608             let newpos = getpos () in
 609             if (getoldpos ())#compare newpos < 0 then
 610               begin
 611                 buffer#move_mark old_locked_mark newpos;
 612                 dowhile ()
 613               end
 614           in
 615           dowhile ();
 616           dispose_old_locked_mark ();
 617           self#notify
 618         with
 619         | Margin -> dispose_old_locked_mark (); self#notify
 620         | exc -> dispose_old_locked_mark (); self#notify; raise exc)
 621     | `Cursor ->
 622         let locked_iter () = buffer#get_iter_at_mark (`NAME "locked") in
 623         let cursor_iter () = buffer#get_iter_at_mark `INSERT in
 624         let remember =
 625          `MARK
 626            (buffer#create_mark ~name:"initial_insert"
 627              ~left_gravity:true (cursor_iter ())) in
 628         let dispose_remember () = buffer#delete_mark remember in
 629         let remember_iter () =
 630          buffer#get_iter_at_mark (`NAME "initial_insert") in
 631         let cmp () = (locked_iter ())#offset - (remember_iter ())#offset in
 632         let icmp = cmp () in
 633         let forward_until_cursor () = (* go forward until locked > cursor *)
 634           let rec aux () =
 635             self#_advance ();
 636             if cmp () < 0 && (getoldpos ())#compare (getpos ()) < 0
 637             then
 638              begin
 639               buffer#move_mark old_locked_mark (getpos ());
 640               aux ()
 641              end
 642           in
 643           aux ()
 644         in
 645         let rec back_until_cursor len = (* go backward until locked < cursor *)
 646          function
 647             statements, ((grafite_status)::_ as history)
 648             when len <= 0 ->
 649              self#_retract (icmp - len) grafite_status statements
 650               history
 651           | statement::tl1, _::tl2 ->
 652              back_until_cursor (len - MatitaGtkMisc.utf8_string_length statement) (tl1,tl2)
 653           | _,_ -> assert false
 654         in
 655         (try
 656           begin
 657            if icmp < 0 then       (* locked < cursor *)
 658              (forward_until_cursor (); self#notify)
 659            else if icmp > 0 then  (* locked > cursor *)
 660              (back_until_cursor icmp (statements,history); self#notify)
 661            else                  (* cursor = locked *)
 662                ()
 663           end ;
 664           dispose_remember ();
 665           dispose_old_locked_mark ();
 666         with
 667         | Margin -> dispose_remember (); dispose_old_locked_mark (); self#notify
 668         | exc -> dispose_remember (); dispose_old_locked_mark ();
 669                  self#notify; raise exc)
 670   with Invalid_argument "Array.make" ->
 671      HLog.error "The script is too big!\n"
 672
 673   method stack = (assert false : Continuationals.Stack.t) (* MATITA 1.0 GrafiteTypes.get_stack
 674   self#grafite_status *)
 675   method setGoal n = userGoal <- n
 676   method goal = userGoal
 677
 678   method bos =
 679     match history with
 680     | _::[] -> true
 681     | _ -> false
 682
 683   method eos =
 684     let rec is_there_only_comments lexicon_status s =
 685       if Pcre.pmatch ~rex:only_dust_RE s then raise Margin;
 686       match
 687        GrafiteParser.parse_statement lexicon_status (Ulexing.from_utf8_string s)
 688       with
 689       | GrafiteAst.Comment (loc,_) ->
 690           let _,parsed_text_length = MatitaGtkMisc.utf8_parsed_text s loc in
 691           (* CSC: why +1 in the following lines ???? *)
 692           let parsed_text_length = parsed_text_length + 1 in
 693           let remain_len = String.length s - parsed_text_length in
 694           let next = String.sub s parsed_text_length remain_len in
 695           is_there_only_comments lexicon_status next
 696       | GrafiteAst.Executable _ -> false
 697     in
 698     try is_there_only_comments self#grafite_status self#getFuture
 699     with
 700     | NCicLibrary.IncludedFileNotCompiled _
 701     | HExtlib.Localized _
 702     | CicNotationParser.Parse_error _ -> false
 703     | Margin | End_of_file -> true
 704     | Invalid_argument "Array.make" -> false
 705
 706   (* debug *)
 707   method dump () =
 708     HLog.debug "script status:";
 709     HLog.debug ("history size: " ^ string_of_int (List.length history));
 710     HLog.debug (sprintf "%d statements:" (List.length statements));
 711     List.iter HLog.debug statements;
 712     HLog.debug ("Current file name: " ^ self#filename);
 713 end
 714
 715 let _script = ref None
 716
 717 let script ~source_view ~mathviewer ~urichooser ~ask_confirmation ~set_star ()
 718 =
 719   let s = new script
 720     ~source_view ~mathviewer ~ask_confirmation ~urichooser ~set_star ()
 721   in
 722   _script := Some s;
 723   s
 724
 725 let current () = match !_script with None -> assert false | Some s -> s
 726