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://cs.unibo.it/helm/.
31 let rec aux = function
42 let add_trailing_slash =
43 let rex = Pcre.regexp "/$" in
45 if Pcre.pmatch ~rex s then s
49 let rex = Pcre.regexp "^\\s*([^\\s]*)\\s*$" in
51 (Pcre.extract ~rex s).(1)
53 (** inherit from this class if you want to access current script *)
54 class scriptAccessor =
56 method private script = MatitaScript.instance ()
59 let cicBrowsers = ref []
61 let default_font_size () =
62 Helm_registry.get_opt_default Helm_registry.int
63 ~default:BuildTimeConf.default_font_size "matita.font_size"
64 let current_font_size = ref ~-1
65 let increase_font_size () = incr current_font_size
66 let decrease_font_size () = decr current_font_size
67 let reset_font_size () = current_font_size := default_font_size ()
69 class clickableMathView obj =
70 let href = Gdome.domString "href" in
71 let xref = Gdome.domString "xref" in
73 inherit GMathViewAux.multi_selection_math_view obj
75 val mutable href_callback: (string -> unit) option = None
76 method set_href_callback f = href_callback <- f
79 self#set_font_size !current_font_size;
80 ignore (self#connect#selection_changed self#choose_selection);
81 ignore (self#connect#click (fun (gdome_elt, _, _, _) ->
83 | Some elt (* element is an hyperlink, use href_callback on it *)
84 when elt#hasAttributeNS ~namespaceURI:Misc.xlink_ns ~localName:href ->
85 (match href_callback with
89 elt#getAttributeNS ~namespaceURI:Misc.xlink_ns ~localName:href
92 | Some elt -> ignore (self#action_toggle elt)
94 method private choose_selection gdome_elt =
96 if elt#hasAttributeNS ~namespaceURI:Misc.helm_ns ~localName:xref then
97 self#set_selection (Some elt)
100 (match elt#get_parentNode with
101 | None -> assert false
102 | Some p -> aux (new Gdome.element_of_node p))
103 with GdomeInit.DOMCastException _ -> ()
104 (* debug_print "trying to select above the document root" *)
107 | Some elt -> aux elt
108 | None -> self#set_selection None
110 method update_font_size =
111 self#set_font_size !current_font_size
115 let clickableMathView ?hadjustment ?vadjustment ?font_size ?log_verbosity =
116 GtkBase.Widget.size_params
117 ~cont:(OgtkMathViewProps.pack_return (fun p ->
118 OgtkMathViewProps.set_params
119 (new clickableMathView (GtkMathViewProps.MathView_GMetaDOM.create p))
120 ~font_size:None ~log_verbosity:None))
123 class sequentViewer obj =
126 inherit clickableMathView obj
128 val mutable current_infos = None
130 method get_selected_terms =
131 let selections = self#get_selections in
135 ((node : Gdome.element)#getAttributeNS
136 ~namespaceURI:Misc.helm_ns
137 ~localName:(Gdome.domString "xref"))#to_string
139 if xpath = "" then assert false (* "ERROR: No xref found!!!" *)
141 match current_infos with
142 | Some (ids_to_terms,_,_) ->
143 (try Hashtbl.find ids_to_terms xpath with _ -> raise Exit)
144 | None -> assert false) (* "ERROR: No current term!!!" *)
147 method get_selected_hypotheses =
148 let selections = self#get_selections in
152 ((node : Gdome.element)#getAttributeNS
153 ~namespaceURI:Misc.helm_ns
154 ~localName:(Gdome.domString "xref"))#to_string
156 if xpath = "" then assert false (* "ERROR: No xref found!!!" *)
158 match current_infos with
159 | Some (_,_,ids_to_hypotheses) ->
160 (try Hashtbl.find ids_to_hypotheses xpath with _ -> raise Exit)
161 | None -> assert false) (* "ERROR: No current term!!!" *)
164 method load_sequent metasenv metano =
165 let sequent = CicUtil.lookup_meta metano metasenv in
166 let (mathml,(_,(ids_to_terms, ids_to_father_ids, ids_to_hypotheses,_))) =
167 ApplyTransformation.mml_of_cic_sequent metasenv sequent
169 current_infos <- Some (ids_to_terms, ids_to_father_ids, ids_to_hypotheses);
171 debug_print "load_sequent: dumping MathML to ./prova";
172 ignore (Misc.domImpl#saveDocumentToFile ~name:"./prova" ~doc:mathml ());
174 self#load_root ~root:mathml#get_documentElement
177 class sequentsViewer ~(notebook:GPack.notebook)
178 ~(sequentViewer:sequentViewer) ()
181 inherit scriptAccessor
183 val mutable pages = 0
184 val mutable switch_page_callback = None
185 val mutable page2goal = [] (* associative list: page no -> goal no *)
186 val mutable goal2page = [] (* the other way round *)
187 val mutable goal2win = [] (* associative list: goal no -> scrolled win *)
188 val mutable _metasenv = []
189 val mutable scrolledWin: GBin.scrolled_window option = None
190 (* scrolled window to which the sequentViewer is currently attached *)
192 method private tab_label metano =
193 (GMisc.label ~text:(sprintf "?%d" metano) ~show:true ())#coerce
196 (match scrolledWin with
198 (* removing page from the notebook will destroy all contained widget,
199 * we do not want the sequentViewer to be destroyed as well *)
200 w#remove sequentViewer#coerce;
203 for i = 1 to pages do notebook#remove_page 0 done;
209 self#script#setGoal ~-1;
210 (match switch_page_callback with
212 GtkSignal.disconnect notebook#as_widget id;
213 switch_page_callback <- None
216 method load_sequents (status: ProofEngineTypes.status) =
217 let ((_, metasenv, _, _), goal) = status in
218 let sequents_no = List.length metasenv in
219 _metasenv <- metasenv;
220 pages <- sequents_no;
221 self#script#setGoal goal;
224 GBin.scrolled_window ~hpolicy:`AUTOMATIC ~vpolicy:`AUTOMATIC
225 ~shadow_type:`IN ~show:true ()
228 scrolledWin <- Some w;
229 match sequentViewer#misc#parent with
230 | None -> w#add sequentViewer#coerce
231 | Some _ -> sequentViewer#misc#reparent w#coerce
233 goal2win <- (metano, reparent) :: goal2win;
238 (fun (metano, _, _) ->
239 page2goal <- (!page, metano) :: page2goal;
240 goal2page <- (metano, !page) :: goal2page;
242 notebook#append_page ~tab_label:(self#tab_label metano) (win metano))
244 switch_page_callback <-
245 Some (notebook#connect#switch_page ~callback:(fun page ->
248 List.assoc page page2goal
249 with Not_found -> assert false
251 self#script#setGoal goal;
252 self#render_page ~page ~goal))
254 method private render_page ~page ~goal =
255 sequentViewer#load_sequent _metasenv goal;
257 List.assoc goal goal2win ();
258 sequentViewer#set_selection None
259 with Not_found -> assert false
261 method goto_sequent goal =
264 List.assoc goal goal2page
265 with Not_found -> assert false
267 notebook#goto_page page;
268 self#render_page page goal
274 type 'widget constructor =
275 ?hadjustment:GData.adjustment ->
276 ?vadjustment:GData.adjustment ->
278 ?log_verbosity:int ->
281 ?packing:(GObj.widget -> unit) ->
286 let sequentViewer ?hadjustment ?vadjustment ?font_size ?log_verbosity =
287 GtkBase.Widget.size_params
288 ~cont:(OgtkMathViewProps.pack_return (fun p ->
289 OgtkMathViewProps.set_params
290 (new sequentViewer (GtkMathViewProps.MathView_GMetaDOM.create p))
291 ~font_size ~log_verbosity))
294 let blank_uri = BuildTimeConf.blank_uri
295 let current_proof_uri = BuildTimeConf.current_proof_uri
298 [ `Ast of DisambiguateTypes.term
299 | `Cic of Cic.term * Cic.metasenv
303 exception Browser_failure of string
305 class type cicBrowser =
307 method load: MatitaTypes.mathViewer_entry -> unit
308 (* method loadList: string list -> MatitaTypes.mathViewer_entry-> unit *)
309 method loadInput: string -> unit
312 class cicBrowser_impl ~(history:MatitaTypes.mathViewer_entry MatitaMisc.history)
315 let term_RE = Pcre.regexp "^term:(.*)" in
316 let whelp_RE = Pcre.regexp "^\\s*whelp" in
319 "^cic:/(\\w+/)*\\w+\\.(con|ind|var)(#xpointer\\(\\d+(/\\d+)+\\))?$"
321 let dir_RE = Pcre.regexp "^cic:((/(\\w+/)*\\w+(/)?)|/|)$" in
322 let whelp_query_RE = Pcre.regexp "^\\s*whelp\\s+([^\\s]+)\\s+(.*)$" in
323 let trailing_slash_RE = Pcre.regexp "/$" in
324 let has_xpointer_RE = Pcre.regexp "#xpointer\\(\\d+/\\d+(/\\d+)?\\)$" in
325 let is_whelp txt = Pcre.pmatch ~rex:whelp_RE txt in
326 let is_uri txt = Pcre.pmatch ~rex:uri_RE txt in
327 let is_dir txt = Pcre.pmatch ~rex:dir_RE txt in
328 let gui = MatitaGui.instance () in
329 let win = gui#newBrowserWin () in
330 let queries = ["Locate";"Hint";"Match";"Elim";"Instance"] in
331 let combo,_ = GEdit.combo_box_text ~strings:queries () in
332 let activate_combo_query input q =
333 let q' = String.lowercase q in
334 let rec aux i = function
335 | [] -> failwith ("Whelp query '" ^ q ^ "' not found")
336 | h::_ when String.lowercase h = q' -> i
337 | _::tl -> aux (i+1) tl
339 combo#set_active (aux 0 queries);
340 win#queryInputText#set_text input
342 let set_whelp_query txt =
345 let q = Pcre.extract ~rex:whelp_query_RE txt in
347 with Invalid_argument _ -> failwith "Malformed Whelp query"
349 activate_combo_query arg query
351 let toplevel = win#toplevel in
352 let mathView = sequentViewer ~packing:win#scrolledBrowser#add () in
354 ignore (MatitaGtkMisc.ask_confirmation ~gui:(MatitaGui.instance ())
355 ~title:"Cic browser" ~msg ~cancel:false ());
358 [ "dir", GdkPixbuf.from_file (MatitaMisc.image_path "matita-folder.png");
359 "obj", GdkPixbuf.from_file (MatitaMisc.image_path "matita-object.png") ]
365 fail (sprintf "Uncaught exception:\n%s" (Printexc.to_string exn))
367 let handle_error' f = (fun () -> handle_error (fun () -> f ())) in
369 inherit scriptAccessor
371 (* Whelp bar queries *)
374 activate_combo_query "" "locate";
375 win#whelpBarComboVbox#add combo#coerce;
377 let query = String.lowercase (List.nth queries combo#active) in
378 let input = win#queryInputText#text in
379 let statement = "whelp " ^ query ^ " " ^ input ^ "." in
380 (MatitaScript.instance ())#advance ~statement ()
382 ignore(win#queryInputText#connect#activate ~callback:start_query);
383 ignore(combo#connect#changed ~callback:start_query);
384 win#whelpBarImage#set_file (MatitaMisc.image_path "whelp.png");
385 win#mathOrListNotebook#set_show_tabs false;
387 win#browserForwardButton#misc#set_sensitive false;
388 win#browserBackButton#misc#set_sensitive false;
389 ignore (win#browserUri#entry#connect#activate (handle_error' (fun () ->
390 self#loadInput win#browserUri#entry#text)));
391 ignore (win#browserHomeButton#connect#clicked (handle_error' (fun () ->
392 self#load (`About `Current_proof))));
393 ignore (win#browserRefreshButton#connect#clicked
394 (handle_error' self#refresh));
395 ignore (win#browserBackButton#connect#clicked (handle_error' self#back));
396 ignore (win#browserForwardButton#connect#clicked
397 (handle_error' self#forward));
398 ignore (win#toplevel#event#connect#delete (fun _ ->
399 let my_id = Oo.id self in
400 cicBrowsers := List.filter (fun b -> Oo.id b <> my_id) !cicBrowsers;
401 if !cicBrowsers = [] &&
402 Helm_registry.get "matita.mode" = "cicbrowser"
406 ignore(win#whelpResultTreeview#connect#row_activated
407 ~callback:(fun _ _ -> self#loadInput (self#_getSelectedUri ())));
408 mathView#set_href_callback (Some (fun uri ->
409 handle_error (fun () -> self#load (`Uri (UriManager.uri_of_string uri)))));
410 self#_load (`About `Blank);
413 val mutable current_entry = `About `Blank
414 val mutable current_infos = None
415 val mutable current_mathml = None
418 new MatitaGtkMisc.taggedStringListModel tags win#whelpResultTreeview
420 method private _getSelectedUri () =
421 match model#easy_selection () with
422 | [sel] when is_uri sel -> sel (* absolute URI selected *)
423 | [sel] -> win#browserUri#entry#text ^ sel (* relative URI selected *)
426 (** history RATIONALE
428 * All operations about history are done using _historyFoo.
429 * Only toplevel functions (ATM load and loadInput) call _historyAdd.
432 method private _historyAdd item =
434 win#browserBackButton#misc#set_sensitive true;
435 win#browserForwardButton#misc#set_sensitive false
437 method private _historyPrev () =
438 let item = history#previous in
439 if history#is_begin then win#browserBackButton#misc#set_sensitive false;
440 win#browserForwardButton#misc#set_sensitive true;
443 method private _historyNext () =
444 let item = history#next in
445 if history#is_end then win#browserForwardButton#misc#set_sensitive false;
446 win#browserBackButton#misc#set_sensitive true;
449 (** notebook RATIONALE
451 * Use only these functions to switch between the tabs
453 method private _showList = win#mathOrListNotebook#goto_page 1
454 method private _showMath = win#mathOrListNotebook#goto_page 0
456 method private back () =
458 self#_load (self#_historyPrev ())
459 with MatitaMisc.History_failure -> ()
461 method private forward () =
463 self#_load (self#_historyNext ())
464 with MatitaMisc.History_failure -> ()
466 (* loads a uri which can be a cic uri or an about:* uri
467 * @param uri string *)
468 method private _load entry =
470 if entry <> current_entry || entry = `About `Current_proof then begin
472 | `About `Current_proof -> self#home ()
473 | `About `Blank -> self#blank ()
474 | `About `Us -> () (* TODO implement easter egg here :-] *)
475 | `Check term -> self#_loadCheck term
476 | `Cic (term, metasenv) -> self#_loadTermCic term metasenv
477 | `Dir dir -> self#_loadDir dir
478 | `Uri uri -> self#_loadUriManagerUri uri
479 | `Whelp (query, results) ->
480 set_whelp_query query;
481 self#_loadList (List.map (fun r -> "obj", UriManager.string_of_uri r) results));
485 | UriManager.IllFormedUri uri -> fail (sprintf "invalid uri: %s" uri)
486 | CicEnvironment.Object_not_found uri ->
487 fail (sprintf "object not found: %s" (UriManager.string_of_uri uri))
488 | Browser_failure msg -> fail msg
490 method private blank () =
492 mathView#load_root (MatitaMisc.empty_mathml ())#get_documentElement
494 method private _loadCheck term =
495 failwith "not implemented _loadCheck";
498 method private home () =
500 match self#script#status.proof_status with
501 | Proof (uri, metasenv, bo, ty) ->
502 let name = UriManager.name_of_uri (MatitaMisc.unopt uri) in
503 let obj = Cic.CurrentProof (name, metasenv, bo, ty, [], []) in
505 | Incomplete_proof ((uri, metasenv, bo, ty), _) ->
506 let name = UriManager.name_of_uri (MatitaMisc.unopt uri) in
507 let obj = Cic.CurrentProof (name, metasenv, bo, ty, [], []) in
511 (** loads a cic uri from the environment
512 * @param uri UriManager.uri *)
513 method private _loadUriManagerUri uri =
514 let uri = UriManager.strip_xpointer uri in
515 let (obj, _) = CicEnvironment.get_obj CicUniv.empty_ugraph uri in
518 method private _loadDir dir =
519 let content = Http_getter.ls dir in
523 | Http_getter_types.Ls_section s -> "dir", s
524 | Http_getter_types.Ls_object o -> "obj", o.Http_getter_types.uri)
527 if l = [] then raise (Browser_failure "no such directory");
530 method private setEntry entry =
531 win#browserUri#entry#set_text (string_of_entry entry);
532 current_entry <- entry
534 method private _loadObj obj =
536 (* this must be _before_ loading the document, since
537 * if the widget is not mapped (hidden by the notebook)
538 * the document is not rendered *)
539 let use_diff = false in (* ZACK TODO use XmlDiff when re-rendering? *)
540 let (mathml, (_,(ids_to_terms, ids_to_father_ids, ids_to_conjectures,
541 ids_to_hypotheses,_,_))) =
542 ApplyTransformation.mml_of_cic_object obj
544 current_infos <- Some (ids_to_terms, ids_to_father_ids,
545 ids_to_conjectures, ids_to_hypotheses);
546 (match current_mathml with
547 | Some current_mathml when use_diff ->
549 XmlDiff.update_dom ~from:current_mathml mathml;
552 mathView#load_root ~root:mathml#get_documentElement;
553 current_mathml <- Some mathml);
555 method private _loadTermCic term metasenv =
556 let context = self#script#proofContext in
557 let dummyno = CicMkImplicit.new_meta metasenv [] in
558 let sequent = (dummyno, context, term) in
559 mathView#load_sequent (sequent :: metasenv) dummyno;
562 method private _loadList l =
563 model#list_store#clear ();
564 List.iter (fun (tag, s) -> model#easy_append ~tag s) l;
567 (** { public methods, all must call _load!! } *)
570 handle_error (fun () -> self#_load entry; self#_historyAdd entry)
572 (** this is what the browser does when you enter a string an hit enter *)
573 method loadInput txt =
574 let txt = strip_blanks txt in
576 UriManager.string_of_uri
577 (UriManager.strip_xpointer (UriManager.uri_of_string txt))
579 if is_whelp txt then begin
581 (MatitaScript.instance ())#advance ~statement:(txt ^ ".") ()
585 | txt when is_uri txt -> `Uri (UriManager.uri_of_string (fix_uri txt))
586 | txt when is_dir txt -> `Dir (add_trailing_slash txt)
590 with Invalid_argument _ ->
591 raise (Browser_failure (sprintf "unsupported uri: %s" txt)))
594 self#_historyAdd entry
597 (** {2 methods accessing underlying GtkMathView} *)
599 method updateFontSize = mathView#set_font_size !current_font_size
601 (** {2 methods used by constructor only} *)
604 method history = history
605 method currentEntry = current_entry
607 if current_entry = `About `Current_proof then
608 self#_load (`About `Current_proof)
612 let sequentsViewer ~(notebook:GPack.notebook)
613 ~(sequentViewer:sequentViewer) ()
615 new sequentsViewer ~notebook ~sequentViewer ()
618 let size = BuildTimeConf.browser_history_size in
619 let rec aux history =
620 let browser = new cicBrowser_impl ~history () in
621 let win = browser#win in
622 ignore (win#browserNewButton#connect#clicked (fun () ->
624 new MatitaMisc.browser_history ~memento:history#save size
627 let newBrowser = aux history in
628 newBrowser#load browser#currentEntry));
630 (* attempt (failed) to close windows on CTRL-W ... *)
631 MatitaGtkMisc.connect_key win#browserWinEventBox#event ~modifiers:[`CONTROL]
632 GdkKeysyms._W (fun () -> win#toplevel#destroy ());
634 cicBrowsers := browser :: !cicBrowsers;
635 (browser :> cicBrowser)
637 let history = new MatitaMisc.browser_history size (`About `Blank) in
640 let default_sequentViewer () = sequentViewer ~show:true ()
641 let sequentViewer_instance = MatitaMisc.singleton default_sequentViewer
643 let default_sequentsViewer () =
644 let gui = MatitaGui.instance () in
645 let sequentViewer = sequentViewer_instance () in
646 sequentsViewer ~notebook:gui#main#sequentsNotebook ~sequentViewer ()
647 let sequentsViewer_instance = MatitaMisc.singleton default_sequentsViewer
651 method private get_browser reuse =
653 (match !cicBrowsers with
654 | [] -> cicBrowser ()
655 | b :: _ -> (b :> cicBrowser))
659 method show_entry ?(reuse=false) t = (self#get_browser reuse)#load t
661 method show_uri_list ?(reuse=false) ~entry l =
662 (self#get_browser reuse)#load entry
665 let refresh_all_browsers () = List.iter (fun b -> b#refresh ()) !cicBrowsers
667 let update_font_sizes () =
668 List.iter (fun b -> b#updateFontSize) !cicBrowsers;
669 (sequentViewer_instance ())#update_font_size