helm/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 open Printf
  27 open MatitaTypes
  28
  29 let debug = true
  30 let debug_print = if  debug then prerr_endline else ignore
  31
  32   (** raised when one of the script margins (top or bottom) is reached *)
  33 exception Margin
  34
  35 let safe_substring s i j =
  36   try String.sub s i j with Invalid_argument _ -> assert false
  37
  38 let heading_nl_RE = Pcre.regexp "^\\s*\n\\s*"
  39 let only_dust_RE = Pcre.regexp "^(\\s|\n|%%[^\n]*\n)*$"
  40 let multiline_RE = Pcre.regexp "^\n[^\n]+$"
  41 let newline_RE = Pcre.regexp "\n"
  42
  43 let comment str =
  44   if Pcre.pmatch ~rex:multiline_RE str then
  45     "\n(** " ^ (Pcre.replace ~rex:newline_RE str) ^ " **)"
  46   else
  47     "\n(**\n" ^ str ^ "\n**)"
  48
  49 let first_line s =
  50   let s = Pcre.replace ~rex:heading_nl_RE s in
  51   try
  52     let nl_pos = String.index s '\n' in
  53     String.sub s 0 nl_pos
  54   with Not_found -> s
  55
  56 let prepend_text header base =
  57   if Pcre.pmatch ~rex:heading_nl_RE base then
  58     sprintf "\n%s%s" header base
  59   else
  60     sprintf "%s\n%s" header base
  61
  62   (** creates a statement AST for the Goal tactic, e.g. "goal 7" *)
  63 let goal_ast n =
  64   let module A = GrafiteAst in
  65   let loc = Disambiguate.dummy_floc in
  66   A.Executable (loc, A.Tactical (loc, A.Tactic (loc, A.Goal (loc, n))))
  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   develcreator: containing:string option -> unit;
  73   mutable filenamedata: string option * MatitamakeLib.development option
  74 }
  75
  76 let eval_with_engine guistuff status user_goal parsed_text st =
  77   let module TA = GrafiteAst in
  78   let module TAPp = GrafiteAstPp in
  79   let include_ =
  80     match guistuff.filenamedata with
  81     | None,None -> []
  82     | None,Some devel -> [MatitamakeLib.root_for_development devel ]
  83     | Some f,_ ->
  84         match MatitamakeLib.development_for_dir (Filename.dirname f) with
  85         | None -> []
  86         | Some devel -> [MatitamakeLib.root_for_development devel ]
  87   in
  88   let parsed_text_length = String.length parsed_text in
  89   let loc, ex =
  90     match st with TA.Executable (loc,ex) -> loc, ex | _ -> assert false
  91   in
  92   let goal_changed = ref false in
  93   let status =
  94     match status.proof_status with
  95       | Incomplete_proof (_, goal) when goal <> user_goal ->
  96           goal_changed := true;
  97           MatitaEngine.eval_ast ~include_paths:include_
  98             ~do_heavy_checks:true status (goal_ast user_goal)
  99       | _ -> status
 100   in
 101   let new_status =
 102     MatitaEngine.eval_ast
 103       ~include_paths:include_ ~do_heavy_checks:true status st
 104   in
 105   let new_aliases =
 106     match ex with
 107       | TA.Command (_, TA.Alias _)
 108       | TA.Command (_, TA.Include _) -> DisambiguateTypes.Environment.empty
 109       | _ -> MatitaSync.alias_diff ~from:status new_status
 110   in
 111   (* we remove the defined object since we consider them "automathic aliases" *)
 112   let new_aliases =
 113     let module DTE = DisambiguateTypes.Environment in
 114     let module UM = UriManager in
 115     DTE.fold (
 116       fun k ((v,_) as value) acc ->
 117         let b =
 118           try
 119             let v = UM.strip_xpointer (UM.uri_of_string v) in
 120             List.exists (fun (s,_) -> s = v) new_status.objects
 121           with UM.IllFormedUri _ -> false
 122         in
 123         if b then
 124           acc
 125         else
 126           DTE.add k value acc
 127     ) new_aliases DTE.empty
 128   in
 129   let new_text =
 130     if DisambiguateTypes.Environment.is_empty new_aliases then
 131       parsed_text
 132     else
 133       prepend_text (DisambiguatePp.pp_environment new_aliases)
 134         parsed_text
 135   in
 136   let new_text =
 137     if !goal_changed then
 138       prepend_text
 139         (TAPp.pp_tactic (TA.Goal (loc, user_goal))(* ^ "\n"*))
 140         new_text
 141     else
 142       new_text
 143   in
 144     [ new_status, new_text ], parsed_text_length
 145
 146 let eval_with_engine guistuff status user_goal parsed_text st =
 147   try
 148     eval_with_engine guistuff status user_goal parsed_text st
 149   with
 150     MatitaEngine.UnableToInclude what as exc ->
 151       let compile_needed_and_go_on d =
 152         let root = MatitamakeLib.root_for_development d in
 153         let target = root ^ "/" ^ what in
 154         let refresh_cb () =
 155           while Glib.Main.pending () do ignore(Glib.Main.iteration false); done
 156         in
 157         if not(MatitamakeLib.build_development_in_bg ~target refresh_cb d) then
 158           raise exc
 159         else
 160           eval_with_engine guistuff status user_goal parsed_text st
 161       in
 162       let do_nothing () = [], 0 in
 163       let handle_with_devel d =
 164         let name = MatitamakeLib.name_for_development d in
 165         let title = "Unable to include " ^ what in
 166         let message =
 167           what ^ " is handled by development <b>" ^ name ^ "</b>.\n\n" ^
 168           "<i>Should I compile it and Its dependencies?</i>"
 169         in
 170         (match guistuff.ask_confirmation ~title ~message with
 171         | `YES -> compile_needed_and_go_on d
 172         | `NO -> raise exc
 173         | `CANCEL -> do_nothing ())
 174       in
 175       let handle_withoud_devel filename =
 176         let title = "Unable to include " ^ what in
 177         let message =
 178          what ^ " is <b>not</b> handled by a development.\n" ^
 179          "All dependencies are authomatically solved for a development.\n\n" ^
 180          "<i>Do you want to set up a development?</i>"
 181         in
 182         (match guistuff.ask_confirmation ~title ~message with
 183         | `YES ->
 184             (match filename with
 185             | Some f ->
 186                 guistuff.develcreator ~containing:(Some (Filename.dirname f))
 187             | None -> guistuff.develcreator ~containing:None);
 188             do_nothing ()
 189         | `NO -> raise exc
 190         | `CANCEL -> do_nothing())
 191       in
 192       match guistuff.filenamedata with
 193       | None,None -> handle_withoud_devel None
 194       | None,Some d -> handle_with_devel d
 195       | Some f,_ ->
 196           match MatitamakeLib.development_for_dir (Filename.dirname f) with
 197           | None -> handle_withoud_devel (Some f)
 198           | Some d -> handle_with_devel d
 199 ;;
 200
 201 let disambiguate term status =
 202   let module MD = MatitaDisambiguator in
 203   let dbd = MatitaDb.instance () in
 204   let metasenv = MatitaMisc.get_proof_metasenv status in
 205   let context = MatitaMisc.get_proof_context status in
 206   let aliases = MatitaMisc.get_proof_aliases status in
 207   let interps = MD.disambiguate_term dbd context metasenv aliases term in
 208   match interps with
 209   | [_,_,x,_] -> x
 210   | _ -> assert false
 211
 212 let eval_macro guistuff status parsed_text script mac
 213 =
 214   let module TA = GrafiteAst in
 215   let module TAPp = GrafiteAstPp in
 216   let module MQ = MetadataQuery in
 217   let module MDB = MatitaDb in
 218   let module CTC = CicTypeChecker in
 219   let module CU = CicUniv in
 220   (* no idea why ocaml wants this *)
 221   let advance ?statement () = script#advance ?statement () in
 222   let parsed_text_length = String.length parsed_text in
 223   let dbd = MatitaDb.instance () in
 224   match mac with
 225   (* WHELP's stuff *)
 226   | TA.WMatch (loc, term) ->
 227       let term = disambiguate term status in
 228       let l =  MQ.match_term ~dbd term in
 229       let entry = `Whelp (TAPp.pp_macro_cic (TA.WMatch (loc, term)), l) in
 230       guistuff.mathviewer#show_uri_list ~reuse:true ~entry l;
 231       [], parsed_text_length
 232   | TA.WInstance (loc, term) ->
 233       let term = disambiguate term status in
 234       let l = MQ.instance ~dbd term in
 235       let entry = `Whelp (TAPp.pp_macro_cic (TA.WInstance (loc, term)), l) in
 236       guistuff.mathviewer#show_uri_list ~reuse:true ~entry l;
 237       [], parsed_text_length
 238   | TA.WLocate (loc, s) ->
 239       let l = MQ.locate ~dbd s in
 240       let entry = `Whelp (TAPp.pp_macro_cic (TA.WLocate (loc, s)), l) in
 241       guistuff.mathviewer#show_uri_list ~reuse:true ~entry l;
 242       [], parsed_text_length
 243   | TA.WElim (loc, term) ->
 244       let term = disambiguate term status in
 245       let uri =
 246         match term with
 247         | Cic.MutInd (uri,n,_) -> UriManager.uri_of_uriref uri n None
 248         | _ -> failwith "Not a MutInd"
 249       in
 250       let l = MQ.elim ~dbd uri in
 251       let entry = `Whelp (TAPp.pp_macro_cic (TA.WElim (loc, term)), l) in
 252       guistuff.mathviewer#show_uri_list ~reuse:true ~entry l;
 253       [], parsed_text_length
 254   | TA.WHint (loc, term) ->
 255       let term = disambiguate term status in
 256       let s = ((None,[0,[],term], Cic.Meta (0,[]) ,term),0) in
 257       let l = List.map fst (MQ.experimental_hint ~dbd s) in
 258       let entry = `Whelp (TAPp.pp_macro_cic (TA.WHint (loc, term)), l) in
 259       guistuff.mathviewer#show_uri_list ~reuse:true ~entry l;
 260       [], parsed_text_length
 261   (* REAL macro *)
 262   | TA.Hint loc ->
 263       let s = MatitaMisc.get_proof_status status in
 264       let l = List.map fst (MQ.experimental_hint ~dbd s) in
 265       let selected = guistuff.urichooser l in
 266       (match selected with
 267       | [] -> [], parsed_text_length
 268       | [uri] ->
 269         let ast =
 270          TA.Executable (loc,
 271           (TA.Tactical (loc,
 272             TA.Tactic (loc,
 273              TA.Apply (loc, CicNotationPt.Uri (UriManager.string_of_uri uri,None))))))
 274         in
 275         let new_status = MatitaEngine.eval_ast status ast in
 276         let extra_text =
 277           comment parsed_text ^
 278           "\n" ^ TAPp.pp_statement ast
 279         in
 280         [ new_status , extra_text ], parsed_text_length
 281       | _ ->
 282           MatitaLog.error
 283             "The result of the urichooser should be only 1 uri, not:\n";
 284           List.iter (
 285             fun u -> MatitaLog.error (UriManager.string_of_uri u ^ "\n")
 286           ) selected;
 287           assert false)
 288   | TA.Check (_,term) ->
 289       let metasenv = MatitaMisc.get_proof_metasenv status in
 290       let context = MatitaMisc.get_proof_context status in
 291       let aliases = MatitaMisc.get_proof_aliases status in
 292       let interps =
 293         MatitaDisambiguator.disambiguate_term
 294           dbd context metasenv aliases term
 295       in
 296       let _, metasenv , term, ugraph =
 297         match interps with
 298         | [x] -> x
 299         | _ -> assert false
 300       in
 301       let ty,_ = CTC.type_of_aux' metasenv context term ugraph in
 302       let t_and_ty = Cic.Cast (term,ty) in
 303       guistuff.mathviewer#show_entry (`Cic (t_and_ty,metasenv));
 304       [], parsed_text_length
 305 (*   | TA.Abort _ ->
 306       let rec go_back () =
 307         let status = script#status.proof_status in
 308         match status with
 309         | No_proof -> ()
 310         | _ -> script#retract ();go_back()
 311       in
 312       [], parsed_text_length, Some go_back
 313   | TA.Redo (_, Some i) ->  [], parsed_text_length,
 314       Some (fun () -> for j = 1 to i do advance () done)
 315   | TA.Redo (_, None) ->   [], parsed_text_length,
 316       Some (fun () -> advance ())
 317   | TA.Undo (_, Some i) ->  [], parsed_text_length,
 318       Some (fun () -> for j = 1 to i do script#retract () done)
 319   | TA.Undo (_, None) -> [], parsed_text_length,
 320       Some (fun () -> script#retract ()) *)
 321   (* TODO *)
 322   | TA.Quit _ -> failwith "not implemented"
 323   | TA.Print (_,kind) -> failwith "not implemented"
 324   | TA.Search_pat (_, search_kind, str) -> failwith "not implemented"
 325   | TA.Search_term (_, search_kind, term) -> failwith "not implemented"
 326
 327
 328 let eval_executable guistuff status user_goal parsed_text script ex =
 329   let module TA = GrafiteAst in
 330   let module TAPp = GrafiteAstPp in
 331   let module MD = MatitaDisambiguator in
 332   let module ML = MatitacleanLib in
 333   let parsed_text_length = String.length parsed_text in
 334   match ex with
 335   | TA.Command (loc, _) | TA.Tactical (loc, _) ->
 336       (try
 337         (match ML.baseuri_of_baseuri_decl (TA.Executable (loc,ex)) with
 338         | None -> ()
 339         | Some u ->
 340             if not (MatitacleanLib.is_empty u) then
 341               match
 342                 guistuff.ask_confirmation
 343                   ~title:"Baseuri redefinition"
 344                   ~message:(
 345                     "Baseuri " ^ u ^ " already exists.\n" ^
 346                     "Do you want to redefine the corresponding "^
 347                     "part of the library?")
 348               with
 349               | `YES -> MatitacleanLib.clean_baseuris [u]
 350               | `NO -> ()
 351               | `CANCEL -> raise MatitaTypes.Cancel);
 352         eval_with_engine
 353           guistuff status user_goal parsed_text (TA.Executable (loc, ex))
 354       with MatitaTypes.Cancel -> [], 0)
 355   | TA.Macro (_,mac) ->
 356       eval_macro guistuff status parsed_text script mac
 357
 358 let rec eval_statement guistuff status user_goal script s =
 359   if Pcre.pmatch ~rex:only_dust_RE s then raise Margin;
 360   let st = GrafiteParser.parse_statement (Stream.of_string s) in
 361   let text_of_loc loc =
 362     let parsed_text_length = snd (CicNotationPt.loc_of_floc loc) in
 363     let parsed_text = safe_substring s 0 parsed_text_length in
 364     parsed_text, parsed_text_length
 365   in
 366   match st with
 367   | GrafiteAst.Comment (loc,_)->
 368       let parsed_text, parsed_text_length = text_of_loc loc in
 369       let remain_len = String.length s - parsed_text_length in
 370       let s = String.sub s parsed_text_length remain_len in
 371       let s,len =
 372         eval_statement guistuff status user_goal script s
 373       in
 374       (match s with
 375       | (status, text) :: tl ->
 376         ((status, parsed_text ^ text)::tl), (parsed_text_length + len)
 377       | [] -> [], 0)
 378   | GrafiteAst.Executable (loc, ex) ->
 379       let parsed_text, parsed_text_length = text_of_loc loc in
 380       eval_executable guistuff  status user_goal parsed_text script ex
 381
 382 let fresh_script_id =
 383   let i = ref 0 in
 384   fun () -> incr i; !i
 385
 386 class script ~(buffer: GText.buffer) ~(init: MatitaTypes.status)
 387               ~(mathviewer: MatitaTypes.mathViewer)
 388               ~set_star
 389               ~ask_confirmation
 390               ~urichooser
 391               ~develcreator
 392               () =
 393 object (self)
 394   val scriptId = fresh_script_id ()
 395
 396   val guistuff = {
 397     mathviewer = mathviewer;
 398     urichooser = urichooser;
 399     ask_confirmation = ask_confirmation;
 400     develcreator = develcreator;
 401     filenamedata = (None, None)}
 402
 403   method private getFilename =
 404     match guistuff.filenamedata with Some f,_ -> f | _ -> assert false
 405
 406   method private ppFilename =
 407     match guistuff.filenamedata with
 408     | Some f,_ -> f
 409     | None,_ -> sprintf ".unnamed%d.ma" scriptId
 410
 411   initializer
 412     ignore(GMain.Timeout.add ~ms:300000
 413        ~callback:(fun _ -> self#_saveToBackuptFile ();true));
 414     ignore(buffer#connect#modified_changed
 415        (fun _ -> if buffer#modified then
 416           set_star self#ppFilename true
 417         else
 418           set_star self#ppFilename false));
 419     self#reset ();
 420     self#template ()
 421
 422   val mutable statements = [];    (** executed statements *)
 423   val mutable history = [ init ];
 424     (** list of states before having executed statements. Head element of this
 425       * list is the current state, last element is the state at the beginning of
 426       * the script.
 427       * Invariant: this list length is 1 + length of statements *)
 428
 429   (** goal as seen by the user (i.e. metano corresponding to current tab) *)
 430   val mutable userGoal = ~-1
 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 locked_tag = buffer#create_tag [`BACKGROUND "lightblue"; `EDITABLE false]
 436
 437     (* history can't be empty, the invariant above grant that it contains at
 438      * least the init status *)
 439   method status = match history with hd :: _ -> hd | _ -> assert false
 440
 441   method private _advance ?statement () =
 442     let s = match statement with Some s -> s | None -> self#getFuture in
 443     MatitaLog.debug ("evaluating: " ^ first_line s ^ " ...");
 444     let (entries, parsed_len) =
 445       eval_statement guistuff self#status userGoal self s
 446     in
 447     let (new_statuses, new_statements) = List.split entries in
 448 (*
 449 prerr_endline "evalStatement returned";
 450 List.iter (fun s -> prerr_endline ("'" ^ s ^ "'")) new_statements;
 451 *)
 452     history <- List.rev new_statuses @ history;
 453     statements <- List.rev new_statements @ statements;
 454     let start = buffer#get_iter_at_mark (`MARK locked_mark) in
 455     let new_text = String.concat "" new_statements in
 456     if new_text <> String.sub s 0 parsed_len then
 457       begin
 458 (*       prerr_endline ("new:" ^ new_text); *)
 459 (*       prerr_endline ("s:" ^ String.sub s 0 parsed_len); *)
 460       let stop = start#copy#forward_chars parsed_len in
 461       buffer#delete ~start ~stop;
 462       buffer#insert ~iter:start new_text;
 463 (*       prerr_endline "AUTOMATICALLY MODIFIED!!!!!" *)
 464       end;
 465     self#moveMark (String.length new_text)
 466
 467   method private _retract () =
 468     match statements, history with
 469     | last_statement :: _, cur_status :: prev_status :: _ ->
 470         MatitaSync.time_travel ~present:cur_status ~past:prev_status;
 471         statements <- List.tl statements;
 472         history <- List.tl history;
 473         self#moveMark (- (String.length last_statement));
 474     | _ -> raise Margin
 475
 476   method advance ?statement () =
 477     try
 478       self#_advance ?statement ();
 479       self#notify
 480     with
 481     | Margin -> self#notify
 482     | exc -> self#notify; raise exc
 483
 484   method retract () =
 485     try
 486       self#_retract ();
 487       self#notify
 488     with
 489     | Margin -> self#notify
 490     | exc -> self#notify; raise exc
 491
 492   method private getFuture =
 493     buffer#get_text ~start:(buffer#get_iter_at_mark (`MARK locked_mark))
 494       ~stop:buffer#end_iter ()
 495
 496
 497   (** @param rel_offset relative offset from current position of locked_mark *)
 498   method private moveMark rel_offset =
 499     let mark = `MARK locked_mark in
 500     let old_insert = buffer#get_iter_at_mark `INSERT in
 501     buffer#remove_tag locked_tag ~start:buffer#start_iter ~stop:buffer#end_iter;
 502     let current_mark_pos = buffer#get_iter_at_mark mark in
 503     let new_mark_pos =
 504       match rel_offset with
 505       | 0 -> current_mark_pos
 506       | n when n > 0 -> current_mark_pos#forward_chars n
 507       | n (* when n < 0 *) -> current_mark_pos#backward_chars (abs n)
 508     in
 509     buffer#move_mark mark ~where:new_mark_pos;
 510     buffer#apply_tag locked_tag ~start:buffer#start_iter ~stop:new_mark_pos;
 511     buffer#move_mark `INSERT old_insert;
 512     begin
 513      match self#status.proof_status with
 514         Incomplete_proof (_,goal) -> self#setGoal goal
 515       | _ -> ()
 516     end ;
 517     while Glib.Main.pending () do ignore(Glib.Main.iteration false); done
 518
 519   method clean_dirty_lock =
 520     let lock_mark_iter = buffer#get_iter_at_mark (`MARK locked_mark) in
 521     buffer#remove_tag locked_tag ~start:buffer#start_iter ~stop:buffer#end_iter;
 522     buffer#apply_tag locked_tag ~start:buffer#start_iter ~stop:lock_mark_iter
 523
 524   val mutable observers = []
 525
 526   method addObserver (o: MatitaTypes.status -> unit) =
 527     observers <- o :: observers
 528
 529   method private notify =
 530     let status = self#status in
 531     List.iter (fun o -> o status) observers
 532
 533   method loadFromFile () =
 534     buffer#set_text (MatitaMisc.input_file self#getFilename);
 535     self#goto_top;
 536     buffer#set_modified false
 537
 538   method assignFileName file =
 539     let abspath = MatitaMisc.absolute_path file in
 540     let devel = MatitamakeLib.development_for_dir (Filename.dirname abspath) in
 541     guistuff.filenamedata <- Some abspath, devel
 542
 543   method saveToFile () =
 544     let oc = open_out self#getFilename in
 545     output_string oc (buffer#get_text ~start:buffer#start_iter
 546                         ~stop:buffer#end_iter ());
 547     close_out oc;
 548     buffer#set_modified false
 549
 550   method private _saveToBackuptFile () =
 551     if buffer#modified then
 552       begin
 553         let f = self#ppFilename ^ "~" in
 554         let oc = open_out f in
 555         output_string oc (buffer#get_text ~start:buffer#start_iter
 556                             ~stop:buffer#end_iter ());
 557         close_out oc;
 558         MatitaLog.debug ("backup " ^ f ^ " saved")
 559       end
 560
 561   method private goto_top =
 562     MatitaSync.time_travel ~present:self#status ~past:init;
 563     statements <- [];
 564     history <- [ init ];
 565     userGoal <- ~-1;
 566     buffer#remove_tag locked_tag ~start:buffer#start_iter ~stop:buffer#end_iter;
 567     buffer#move_mark (`MARK locked_mark) ~where:buffer#start_iter
 568
 569   method reset () =
 570     self#goto_top;
 571     buffer#delete ~start:buffer#start_iter ~stop:buffer#end_iter;
 572     self#notify;
 573     buffer#set_modified false
 574
 575   method template () =
 576     let template = MatitaMisc.input_file BuildTimeConf.script_template in
 577     buffer#insert ~iter:(buffer#get_iter `START) template;
 578     guistuff.filenamedata <-
 579       (None,MatitamakeLib.development_for_dir (Unix.getcwd ()));
 580     buffer#set_modified false;
 581     set_star self#ppFilename false
 582
 583   method goto (pos: [`Top | `Bottom | `Cursor]) () =
 584     let getpos _ = buffer#get_iter_at_mark (`MARK locked_mark) in
 585     match pos with
 586     | `Top -> self#goto_top; self#notify
 587     | `Bottom ->
 588         (try
 589           let rec dowhile pos =
 590             self#_advance ();
 591             if pos#compare (getpos ()) < 0 then
 592               dowhile (getpos ())
 593           in
 594           dowhile (getpos ());
 595           self#notify
 596         with
 597         | Margin -> self#notify
 598         | exc -> self#notify; raise exc)
 599     | `Cursor ->
 600         let locked_iter () = buffer#get_iter_at_mark (`NAME "locked") in
 601         let cursor_iter () = buffer#get_iter_at_mark `INSERT in
 602         let forward_until_cursor () = (* go forward until locked > cursor *)
 603           let rec aux oldpos =
 604             self#_advance ();
 605             if (locked_iter ())#compare (cursor_iter ()) < 0 &&
 606                oldpos#compare (getpos ()) < 0
 607             then
 608               aux (getpos ())
 609           in
 610           aux (getpos ())
 611         in
 612         let rec back_until_cursor () = (* go backward until locked < cursor *)
 613           self#_retract ();
 614           if (locked_iter ())#compare (cursor_iter ()) > 0 then
 615             back_until_cursor ()
 616         in
 617         let cmp = (locked_iter ())#compare (cursor_iter ()) in
 618         (try
 619           if cmp < 0 then       (* locked < cursor *)
 620             (forward_until_cursor (); self#notify)
 621           else if cmp > 0 then  (* locked > cursor *)
 622             (back_until_cursor (); self#notify)
 623           else                  (* cursor = locked *)
 624               ()
 625         with
 626         | Margin -> self#notify
 627         | exc -> self#notify; raise exc)
 628
 629   method onGoingProof () =
 630     match self#status.proof_status with
 631     | No_proof | Proof _ -> false
 632     | Incomplete_proof _ -> true
 633     | Intermediate _ -> assert false
 634
 635   method proofStatus = MatitaMisc.get_proof_status self#status
 636   method proofMetasenv = MatitaMisc.get_proof_metasenv self#status
 637   method proofContext = MatitaMisc.get_proof_context self#status
 638   method setGoal n = userGoal <- n
 639
 640   method eos =
 641     let s = self#getFuture in
 642     let rec is_there_and_executable s =
 643       if Pcre.pmatch ~rex:only_dust_RE s then raise Margin;
 644       let st = GrafiteParser.parse_statement (Stream.of_string s) in
 645       match st with
 646       | GrafiteAst.Comment (loc,_)->
 647           let parsed_text_length = snd (CicNotationPt.loc_of_floc loc) in
 648           let remain_len = String.length s - parsed_text_length in
 649           let next = String.sub s parsed_text_length remain_len in
 650           is_there_and_executable next
 651       | GrafiteAst.Executable (loc, ex) -> false
 652     in
 653     try
 654       is_there_and_executable s
 655     with
 656     | CicNotationParser.Parse_error _ -> false
 657     | Margin -> true
 658
 659
 660
 661   (* debug *)
 662   method dump () =
 663     MatitaLog.debug "script status:";
 664     MatitaLog.debug ("history size: " ^ string_of_int (List.length history));
 665     MatitaLog.debug (sprintf "%d statements:" (List.length statements));
 666     List.iter MatitaLog.debug statements;
 667     MatitaLog.debug ("Current file name: " ^
 668       (match guistuff.filenamedata with
 669       |None,_ -> "[ no name ]"
 670       | Some f,_ -> f));
 671
 672 end
 673
 674 let _script = ref None
 675
 676 let script ~buffer ~init ~mathviewer ~urichooser ~develcreator ~ask_confirmation ~set_star ()
 677 =
 678   let s = new script
 679     ~buffer ~init ~mathviewer ~ask_confirmation ~urichooser ~develcreator ~set_star ()
 680   in
 681   _script := Some s;
 682   s
 683
 684 let instance () = match !_script with None -> assert false | Some s -> s
 685
 686