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