1 (* Copyright (C) 2004-2005, HELM Team.
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.
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.
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.
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,
22 * For details, see the HELM World-Wide-Web page,
23 * http://helm.cs.unibo.it/
30 let debug_print = if debug then prerr_endline else ignore
32 (** raised when one of the script margins (top or bottom) is reached *)
35 let safe_substring s i j =
36 try String.sub s i j with Invalid_argument _ -> assert false
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"
44 if Pcre.pmatch ~rex:multiline_RE str then
45 "\n(** " ^ (Pcre.replace ~rex:newline_RE str) ^ " **)"
47 "\n(**\n" ^ str ^ "\n**)"
50 let s = Pcre.replace ~rex:heading_nl_RE s in
52 let nl_pos = String.index s '\n' in
56 let prepend_text header base =
57 if Pcre.pmatch ~rex:heading_nl_RE base then
58 sprintf "\n%s%s" header base
60 sprintf "%s\n%s" header base
62 (** creates a statement AST for the Goal tactic, e.g. "goal 7" *)
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))))
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
76 let eval_with_engine guistuff status user_goal parsed_text st =
77 let module TA = GrafiteAst in
78 let module TAPp = GrafiteAstPp in
80 match guistuff.filenamedata with
82 | None,Some devel -> [MatitamakeLib.root_for_development devel ]
84 match MatitamakeLib.development_for_dir (Filename.dirname f) with
86 | Some devel -> [MatitamakeLib.root_for_development devel ]
88 let parsed_text_length = String.length parsed_text in
90 match st with TA.Executable (loc,ex) -> loc, ex | _ -> assert false
92 let goal_changed = ref false in
94 match status.proof_status with
95 | Incomplete_proof (_, goal) when goal <> user_goal ->
97 MatitaEngine.eval_ast ~include_paths:include_
98 ~do_heavy_checks:true status (goal_ast user_goal)
102 MatitaEngine.eval_ast
103 ~include_paths:include_ ~do_heavy_checks:true status st
107 | TA.Command (_, TA.Alias _)
108 | TA.Command (_, TA.Include _) -> DisambiguateTypes.Environment.empty
109 | _ -> MatitaSync.alias_diff ~from:status new_status
111 (* we remove the defined object since we consider them "automathic aliases" *)
113 let module DTE = DisambiguateTypes.Environment in
114 let module UM = UriManager in
116 fun k ((v,_) as value) acc ->
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
127 ) new_aliases DTE.empty
130 if DisambiguateTypes.Environment.is_empty new_aliases then
133 prepend_text (DisambiguatePp.pp_environment new_aliases)
137 if !goal_changed then
139 (TAPp.pp_tactic (TA.Goal (loc, user_goal))(* ^ "\n"*))
144 [ new_status, new_text ], parsed_text_length
146 let eval_with_engine guistuff status user_goal parsed_text st =
148 eval_with_engine guistuff status user_goal parsed_text st
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
155 while Glib.Main.pending () do ignore(Glib.Main.iteration false); done
157 if not(MatitamakeLib.build_development_in_bg ~target refresh_cb d) then
160 eval_with_engine guistuff status user_goal parsed_text st
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
167 what ^ " is handled by development <b>" ^ name ^ "</b>.\n\n" ^
168 "<i>Should I compile it and Its dependencies?</i>"
170 (match guistuff.ask_confirmation ~title ~message with
171 | `YES -> compile_needed_and_go_on d
173 | `CANCEL -> do_nothing ())
175 let handle_withoud_devel filename =
176 let title = "Unable to include " ^ what in
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>"
182 (match guistuff.ask_confirmation ~title ~message with
186 guistuff.develcreator ~containing:(Some (Filename.dirname f))
187 | None -> guistuff.develcreator ~containing:None);
190 | `CANCEL -> do_nothing())
192 match guistuff.filenamedata with
193 | None,None -> handle_withoud_devel None
194 | None,Some d -> handle_with_devel d
196 match MatitamakeLib.development_for_dir (Filename.dirname f) with
197 | None -> handle_withoud_devel (Some f)
198 | Some d -> handle_with_devel d
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
212 let eval_macro guistuff status parsed_text script mac
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
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
247 | Cic.MutInd (uri,n,_) -> UriManager.uri_of_uriref uri n None
248 | _ -> failwith "Not a MutInd"
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
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
267 | [] -> [], parsed_text_length
273 TA.Apply (loc, CicNotationPt.Uri (UriManager.string_of_uri uri,None))))))
275 let new_status = MatitaEngine.eval_ast status ast in
277 comment parsed_text ^
278 "\n" ^ TAPp.pp_statement ast
280 [ new_status , extra_text ], parsed_text_length
283 "The result of the urichooser should be only 1 uri, not:\n";
285 fun u -> MatitaLog.error (UriManager.string_of_uri u ^ "\n")
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
293 MatitaDisambiguator.disambiguate_term
294 dbd context metasenv aliases term
296 let _, metasenv , term, ugraph =
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
307 let status = script#status.proof_status in
310 | _ -> script#retract ();go_back()
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 ()) *)
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"
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
335 | TA.Command (loc, _) | TA.Tactical (loc, _) ->
337 (match ML.baseuri_of_baseuri_decl (TA.Executable (loc,ex)) with
340 if not (ML.is_empty u) then
342 guistuff.ask_confirmation
343 ~title:"Baseuri redefinition"
345 "Baseuri " ^ u ^ " already exists.\n" ^
346 "Do you want to redefine the corresponding "^
347 "part of the library?")
349 | `YES -> MatitacleanLib.clean_baseuris [u]
351 | `CANCEL -> raise MatitaTypes.Cancel);
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
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
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
372 eval_statement guistuff status user_goal script s
375 | (status, text) :: tl ->
376 ((status, parsed_text ^ text)::tl), (parsed_text_length + len)
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
382 let fresh_script_id =
386 class script ~(view: GText.view)
387 ~(init: MatitaTypes.status)
388 ~(mathviewer: MatitaTypes.mathViewer)
394 let buffer = view#buffer in
396 val scriptId = fresh_script_id ()
399 mathviewer = mathviewer;
400 urichooser = urichooser;
401 ask_confirmation = ask_confirmation;
402 develcreator = develcreator;
403 filenamedata = (None, None)}
405 method private getFilename =
406 match guistuff.filenamedata with Some f,_ -> f | _ -> assert false
408 method private ppFilename =
409 match guistuff.filenamedata with
411 | None,_ -> sprintf ".unnamed%d.ma" scriptId
414 ignore(GMain.Timeout.add ~ms:300000
415 ~callback:(fun _ -> self#_saveToBackuptFile ();true));
416 ignore(buffer#connect#modified_changed
417 (fun _ -> if buffer#modified then
418 set_star self#ppFilename true
420 set_star self#ppFilename false))
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
427 * Invariant: this list length is 1 + length of statements *)
429 (** goal as seen by the user (i.e. metano corresponding to current tab) *)
430 val mutable userGoal = ~-1
432 (** text mark and tag representing locked part of a script *)
434 buffer#create_mark ~name:"locked" ~left_gravity:true buffer#start_iter
435 val locked_tag = buffer#create_tag [`BACKGROUND "lightblue"; `EDITABLE false]
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
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
447 let (new_statuses, new_statements) = List.split entries in
449 prerr_endline "evalStatement returned";
450 List.iter (fun s -> prerr_endline ("'" ^ s ^ "'")) new_statements;
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
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!!!!!" *)
465 self#moveMark (String.length new_text)
467 method private _retract offset status new_statements new_history =
468 let cur_status = match history with s::_ -> s | [] -> assert false in
469 MatitaSync.time_travel ~present:cur_status ~past:status;
470 statements <- new_statements;
471 history <- new_history;
472 self#moveMark (- offset)
474 method advance ?statement () =
476 self#_advance ?statement ();
479 | Margin -> self#notify
480 | exc -> self#notify; raise exc
484 let cmp,new_statements,new_history,status =
485 match statements,history with
486 stat::statements, _::(status::_ as history) ->
487 String.length stat, statements, history, status
488 | [],[_] -> raise Margin
489 | _,_ -> assert false
491 self#_retract cmp status new_statements new_history;
494 | Margin -> self#notify
495 | exc -> self#notify; raise exc
497 method private getFuture =
498 buffer#get_text ~start:(buffer#get_iter_at_mark (`MARK locked_mark))
499 ~stop:buffer#end_iter ()
502 (** @param rel_offset relative offset from current position of locked_mark *)
503 method private moveMark rel_offset =
504 let mark = `MARK locked_mark in
505 let old_insert = buffer#get_iter_at_mark `INSERT in
506 buffer#remove_tag locked_tag ~start:buffer#start_iter ~stop:buffer#end_iter;
507 let current_mark_pos = buffer#get_iter_at_mark mark in
509 match rel_offset with
510 | 0 -> current_mark_pos
511 | n when n > 0 -> current_mark_pos#forward_chars n
512 | n (* when n < 0 *) -> current_mark_pos#backward_chars (abs n)
514 buffer#move_mark mark ~where:new_mark_pos;
515 buffer#apply_tag locked_tag ~start:buffer#start_iter ~stop:new_mark_pos;
516 buffer#move_mark `INSERT old_insert;
518 match self#status.proof_status with
519 Incomplete_proof (_,goal) -> self#setGoal goal
522 let mark_position = buffer#get_iter_at_mark mark in
523 if view#move_mark_onscreen mark then
525 buffer#move_mark mark mark_position;
526 view#scroll_to_mark ~use_align:true ~xalign:1.0 ~yalign:0.1 mark;
528 while Glib.Main.pending () do ignore(Glib.Main.iteration false); done
530 method clean_dirty_lock =
531 let lock_mark_iter = buffer#get_iter_at_mark (`MARK locked_mark) in
532 buffer#remove_tag locked_tag ~start:buffer#start_iter ~stop:buffer#end_iter;
533 buffer#apply_tag locked_tag ~start:buffer#start_iter ~stop:lock_mark_iter
535 val mutable observers = []
537 method addObserver (o: MatitaTypes.status -> unit) =
538 observers <- o :: observers
540 method private notify =
541 let status = self#status in
542 List.iter (fun o -> o status) observers
544 method loadFromFile () =
545 buffer#set_text (MatitaMisc.input_file self#getFilename);
547 buffer#set_modified false
549 method assignFileName file =
550 let abspath = MatitaMisc.absolute_path file in
551 let devel = MatitamakeLib.development_for_dir (Filename.dirname abspath) in
552 guistuff.filenamedata <- Some abspath, devel
554 method saveToFile () =
555 let oc = open_out self#getFilename in
556 output_string oc (buffer#get_text ~start:buffer#start_iter
557 ~stop:buffer#end_iter ());
559 buffer#set_modified false
561 method private _saveToBackuptFile () =
562 if buffer#modified then
564 let f = self#ppFilename ^ "~" in
565 let oc = open_out f in
566 output_string oc (buffer#get_text ~start:buffer#start_iter
567 ~stop:buffer#end_iter ());
569 MatitaLog.debug ("backup " ^ f ^ " saved")
572 method private goto_top =
573 MatitaSync.time_travel ~present:self#status ~past:init;
577 buffer#remove_tag locked_tag ~start:buffer#start_iter ~stop:buffer#end_iter;
578 buffer#move_mark (`MARK locked_mark) ~where:buffer#start_iter
582 buffer#delete ~start:buffer#start_iter ~stop:buffer#end_iter;
584 buffer#set_modified false
587 let template = MatitaMisc.input_file BuildTimeConf.script_template in
588 buffer#insert ~iter:(buffer#get_iter `START) template;
589 guistuff.filenamedata <-
590 (None,MatitamakeLib.development_for_dir (Unix.getcwd ()));
591 buffer#set_modified false;
592 set_star self#ppFilename false
594 method goto (pos: [`Top | `Bottom | `Cursor]) () =
595 let getpos _ = buffer#get_iter_at_mark (`MARK locked_mark) in
597 | `Top -> self#goto_top; self#notify
600 let rec dowhile pos =
602 if pos#compare (getpos ()) < 0 then
608 | Margin -> self#notify
609 | exc -> self#notify; raise exc)
611 let locked_iter () = buffer#get_iter_at_mark (`NAME "locked") in
612 let cursor_iter = buffer#get_iter_at_mark `INSERT in
613 let cmp = (locked_iter ())#offset - cursor_iter#offset in
614 let forward_until_cursor () = (* go forward until locked > cursor *)
617 if (locked_iter ())#compare cursor_iter < 0 &&
618 oldpos#compare (getpos ()) < 0
624 let rec back_until_cursor len = (* go backward until locked < cursor *)
626 statements, (status::_ as history) when len <= 0 ->
627 self#_retract (cmp - len) status statements history
628 | statement::tl1, _::tl2 ->
629 back_until_cursor (len - String.length statement) (tl1,tl2)
630 | _,_ -> assert false
633 if cmp < 0 then (* locked < cursor *)
634 (forward_until_cursor (); self#notify)
635 else if cmp > 0 then (* locked > cursor *)
636 (back_until_cursor cmp (statements,history); self#notify)
637 else (* cursor = locked *)
640 | Margin -> self#notify
641 | exc -> self#notify; raise exc)
643 method onGoingProof () =
644 match self#status.proof_status with
645 | No_proof | Proof _ -> false
646 | Incomplete_proof _ -> true
647 | Intermediate _ -> assert false
649 method proofStatus = MatitaMisc.get_proof_status self#status
650 method proofMetasenv = MatitaMisc.get_proof_metasenv self#status
651 method proofContext = MatitaMisc.get_proof_context self#status
652 method setGoal n = userGoal <- n
655 let s = self#getFuture in
656 let rec is_there_and_executable s =
657 if Pcre.pmatch ~rex:only_dust_RE s then raise Margin;
658 let st = GrafiteParser.parse_statement (Stream.of_string s) in
660 | GrafiteAst.Comment (loc,_)->
661 let parsed_text_length = snd (CicNotationPt.loc_of_floc loc) in
662 let remain_len = String.length s - parsed_text_length in
663 let next = String.sub s parsed_text_length remain_len in
664 is_there_and_executable next
665 | GrafiteAst.Executable (loc, ex) -> false
668 is_there_and_executable s
670 | CicNotationParser.Parse_error _ -> false
677 MatitaLog.debug "script status:";
678 MatitaLog.debug ("history size: " ^ string_of_int (List.length history));
679 MatitaLog.debug (sprintf "%d statements:" (List.length statements));
680 List.iter MatitaLog.debug statements;
681 MatitaLog.debug ("Current file name: " ^
682 (match guistuff.filenamedata with
683 |None,_ -> "[ no name ]"
688 let _script = ref None
690 let script ~view ~init ~mathviewer ~urichooser ~develcreator ~ask_confirmation ~set_star ()
693 ~view ~init ~mathviewer ~ask_confirmation ~urichooser ~develcreator ~set_star ()
698 let instance () = match !_script with None -> assert false | Some s -> s