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