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 (** inherit from this class if you want to access current script *)
43 class scriptAccessor =
45 method private script = MatitaScript.instance ()
48 class clickableMathView obj =
49 let href = Gdome.domString "href" in
50 let xref = Gdome.domString "xref" in
52 inherit GMathViewAux.multi_selection_math_view obj
54 val mutable href_callback: (string -> unit) option = None
55 method set_href_callback f = href_callback <- f
58 ignore (self#connect#selection_changed self#choose_selection);
59 ignore (self#connect#click (fun (gdome_elt, _, _, _) ->
61 | Some elt (* element is an hyperlink, use href_callback on it *)
62 when elt#hasAttributeNS ~namespaceURI:Misc.xlink_ns ~localName:href ->
63 (match href_callback with
67 elt#getAttributeNS ~namespaceURI:Misc.xlink_ns ~localName:href
70 | Some elt -> ignore (self#action_toggle elt)
72 method private choose_selection gdome_elt =
74 if elt#hasAttributeNS ~namespaceURI:Misc.helm_ns ~localName:xref then
75 self#set_selection (Some elt)
78 (match elt#get_parentNode with
79 | None -> assert false
80 | Some p -> aux (new Gdome.element_of_node p))
81 with GdomeInit.DOMCastException _ -> ()
82 (* debug_print "trying to select above the document root" *)
86 | None -> self#set_selection None
89 let clickableMathView ?hadjustment ?vadjustment ?font_size ?log_verbosity =
90 GtkBase.Widget.size_params
91 ~cont:(OgtkMathViewProps.pack_return (fun p ->
92 OgtkMathViewProps.set_params
93 (new clickableMathView (GtkMathViewProps.MathView_GMetaDOM.create p))
94 ~font_size:None ~log_verbosity:None))
97 class sequentViewer obj =
100 inherit clickableMathView obj
102 val mutable current_infos = None
104 method get_selected_terms =
105 let selections = self#get_selections in
109 ((node : Gdome.element)#getAttributeNS
110 ~namespaceURI:Misc.helm_ns
111 ~localName:(Gdome.domString "xref"))#to_string
113 if xpath = "" then assert false (* "ERROR: No xref found!!!" *)
115 match current_infos with
116 | Some (ids_to_terms,_,_) ->
117 (try Hashtbl.find ids_to_terms xpath with _ -> raise Exit)
118 | None -> assert false) (* "ERROR: No current term!!!" *)
121 method get_selected_hypotheses =
122 let selections = self#get_selections in
126 ((node : Gdome.element)#getAttributeNS
127 ~namespaceURI:Misc.helm_ns
128 ~localName:(Gdome.domString "xref"))#to_string
130 if xpath = "" then assert false (* "ERROR: No xref found!!!" *)
132 match current_infos with
133 | Some (_,_,ids_to_hypotheses) ->
134 (try Hashtbl.find ids_to_hypotheses xpath with _ -> raise Exit)
135 | None -> assert false) (* "ERROR: No current term!!!" *)
138 method load_sequent metasenv metano =
139 let sequent = CicUtil.lookup_meta metano metasenv in
140 let (mathml,(_,(ids_to_terms, ids_to_father_ids, ids_to_hypotheses,_))) =
141 ApplyTransformation.mml_of_cic_sequent metasenv sequent
143 current_infos <- Some (ids_to_terms, ids_to_father_ids, ids_to_hypotheses);
145 debug_print "load_sequent: dumping MathML to ./prova";
146 ignore (Misc.domImpl#saveDocumentToFile ~name:"./prova" ~doc:mathml ());
148 self#load_root ~root:mathml#get_documentElement
151 class sequentsViewer ~(notebook:GPack.notebook)
152 ~(sequentViewer:sequentViewer) ()
155 inherit scriptAccessor
157 val mutable pages = 0
158 val mutable switch_page_callback = None
159 val mutable page2goal = [] (* associative list: page no -> goal no *)
160 val mutable goal2page = [] (* the other way round *)
161 val mutable goal2win = [] (* associative list: goal no -> scrolled win *)
162 val mutable _metasenv = []
163 val mutable scrolledWin: GBin.scrolled_window option = None
164 (* scrolled window to which the sequentViewer is currently attached *)
166 method private tab_label metano =
167 (GMisc.label ~text:(sprintf "?%d" metano) ~show:true ())#coerce
170 (match scrolledWin with
172 (* removing page from the notebook will destroy all contained widget,
173 * we do not want the sequentViewer to be destroyed as well *)
174 w#remove sequentViewer#coerce;
177 for i = 1 to pages do notebook#remove_page 0 done;
183 self#script#setGoal ~-1;
184 (match switch_page_callback with
186 GtkSignal.disconnect notebook#as_widget id;
187 switch_page_callback <- None
190 method load_sequents (status: ProofEngineTypes.status) =
191 let ((_, metasenv, _, _), goal) = status in
192 let sequents_no = List.length metasenv in
193 _metasenv <- metasenv;
194 pages <- sequents_no;
195 self#script#setGoal goal;
198 GBin.scrolled_window ~hpolicy:`AUTOMATIC ~vpolicy:`AUTOMATIC
199 ~shadow_type:`IN ~show:true ()
202 scrolledWin <- Some w;
203 match sequentViewer#misc#parent with
204 | None -> w#add sequentViewer#coerce
205 | Some _ -> sequentViewer#misc#reparent w#coerce
207 goal2win <- (metano, reparent) :: goal2win;
212 (fun (metano, _, _) ->
213 page2goal <- (!page, metano) :: page2goal;
214 goal2page <- (metano, !page) :: goal2page;
216 notebook#append_page ~tab_label:(self#tab_label metano) (win metano))
218 switch_page_callback <-
219 Some (notebook#connect#switch_page ~callback:(fun page ->
222 List.assoc page page2goal
223 with Not_found -> assert false
225 self#script#setGoal goal;
226 self#render_page ~page ~goal))
228 method private render_page ~page ~goal =
229 sequentViewer#load_sequent _metasenv goal;
231 List.assoc goal goal2win ();
232 sequentViewer#set_selection None
233 with Not_found -> assert false
235 method goto_sequent goal =
238 List.assoc goal goal2page
239 with Not_found -> assert false
241 notebook#goto_page page;
242 self#render_page page goal
248 type 'widget constructor =
249 ?hadjustment:GData.adjustment ->
250 ?vadjustment:GData.adjustment ->
252 ?log_verbosity:int ->
255 ?packing:(GObj.widget -> unit) ->
260 let sequentViewer ?hadjustment ?vadjustment ?font_size ?log_verbosity =
261 GtkBase.Widget.size_params
262 ~cont:(OgtkMathViewProps.pack_return (fun p ->
263 OgtkMathViewProps.set_params
264 (new sequentViewer (GtkMathViewProps.MathView_GMetaDOM.create p))
265 ~font_size ~log_verbosity))
268 let blank_uri = BuildTimeConf.blank_uri
269 let current_proof_uri = BuildTimeConf.current_proof_uri
272 [ `Ast of DisambiguateTypes.term
273 | `Cic of Cic.term * Cic.metasenv
277 exception Browser_failure of string
279 let cicBrowsers = ref []
281 class type cicBrowser =
283 method load: MatitaTypes.mathViewer_entry -> unit
284 (* method loadList: string list -> MatitaTypes.mathViewer_entry-> unit *)
285 method loadInput: string -> unit
288 class cicBrowser_impl ~(history:MatitaTypes.mathViewer_entry MatitaMisc.history)
291 let term_RE = Pcre.regexp "^term:(.*)" in
292 let whelp_RE = Pcre.regexp "^\\s*whelp" in
293 let whelp_query_RE = Pcre.regexp "^\\s*whelp\\s+([^\\s]+)\\s+(.*)$" in
294 let trailing_slash_RE = Pcre.regexp "/$" in
295 let has_xpointer_RE = Pcre.regexp "#xpointer\\(\\d+/\\d+(/\\d+)?\\)$" in
296 let gui = MatitaGui.instance () in
297 let win = gui#newBrowserWin () in
298 let queries = ["Locate";"Hint";"Match";"Elim";"Instance"] in
299 let combo,_ = GEdit.combo_box_text ~strings:queries () in
300 let activate_combo_query input q =
301 let q' = String.lowercase q in
302 let rec aux i = function
303 | [] -> failwith ("Whelp query '" ^ q ^ "' not found")
304 | h::_ when String.lowercase h = q' -> i
305 | _::tl -> aux (i+1) tl
307 combo#set_active (aux 0 queries);
308 win#queryInputText#set_text input
310 let toplevel = win#toplevel in
311 let mathView = sequentViewer ~packing:win#scrolledBrowser#add () in
313 ignore (MatitaGtkMisc.ask_confirmation ~gui:(MatitaGui.instance ())
314 ~title:"Cic browser" ~msg ~cancel:false ());
320 fail (sprintf "Uncaught exception:\n%s" (Printexc.to_string exn))
322 let handle_error' f = fun () -> handle_error f in (* used in callbacks *)
324 inherit scriptAccessor
326 (* Whelp bar queries *)
329 activate_combo_query "" "locate";
330 win#comboVbox#add (combo :> GObj.widget);
332 let query = String.lowercase (List.nth queries combo#active) in
333 let input = win#queryInputText#text in
334 let statement = "whelp " ^ query ^ " " ^ input ^ "." in
335 (MatitaScript.instance ())#advance ~statement ()
337 ignore(win#queryInputText#connect#activate ~callback:start_query);
338 ignore(combo#connect#changed ~callback:start_query);
339 win#whelpImage2#set_file "icons/whelp.png";
340 win#whelpBarToggleButton#set_active false;
341 win#whelpBarBox#misc#hide ();
342 win#mathOrListNotebook#set_show_tabs false;
343 MatitaGtkMisc.connect_toggle_button win#whelpBarToggleButton
345 if win#whelpBarToggleButton#active then
346 win#whelpBarBox#misc#show ()
348 win#whelpBarBox#misc#hide ());
350 win#browserForwardButton#misc#set_sensitive false;
351 win#browserBackButton#misc#set_sensitive false;
352 ignore (win#browserUri#connect#activate (handle_error' (fun () ->
353 self#loadInput win#browserUri#text)));
354 ignore (win#browserHomeButton#connect#clicked (handle_error' (fun () ->
355 self#_load (`About `Current_proof))));
356 ignore (win#browserRefreshButton#connect#clicked
357 (handle_error' self#refresh));
358 ignore (win#browserBackButton#connect#clicked (handle_error' self#back));
359 ignore (win#browserForwardButton#connect#clicked
360 (handle_error' self#forward));
361 ignore (win#toplevel#event#connect#delete (fun _ ->
362 let my_id = Oo.id self in
363 cicBrowsers := List.filter (fun b -> Oo.id b <> my_id) !cicBrowsers;
364 if !cicBrowsers = [] &&
365 Helm_registry.get "matita.mode" = "cicbrowser"
369 ignore(win#whelpResultTreeview#connect#row_activated
370 ~callback:(fun _ _ ->
371 let selection = self#_getWhelpResultTreeviewSelection () in
373 if String.sub selection 0 5 = "cic:/" then
376 win#browserUri#text ^ selection
378 self#loadInput txt));
379 mathView#set_href_callback (Some (fun uri ->
380 handle_error (fun () -> self#_load (`Uri uri))));
381 self#_load (`About `Blank);
384 val mutable current_entry = `About `Blank
385 val mutable current_infos = None
386 val mutable current_mathml = None
388 val model = new MatitaGtkMisc.stringListModel win#whelpResultTreeview
390 method private _getWhelpResultTreeviewSelection () =
391 match model#easy_selection () with
395 (** history RATIONALE
397 * all operations about history are done using _historyFoo
399 * only toplevel function like load loadInput can call
403 method private _historyAdd item =
405 win#browserBackButton#misc#set_sensitive true;
406 win#browserForwardButton#misc#set_sensitive false
408 method private _historyPrev () =
409 let item = history#previous in
410 if history#is_begin then win#browserBackButton#misc#set_sensitive false;
411 win#browserForwardButton#misc#set_sensitive true;
414 method private _historyNext () =
415 let item = history#next in
416 if history#is_end then win#browserForwardButton#misc#set_sensitive false;
417 win#browserBackButton#misc#set_sensitive true;
420 (** notebook RATIONALE
422 * Use only these functions to switch between the tabs
424 method private _showList = win#mathOrListNotebook#goto_page 1
425 method private _showMath = win#mathOrListNotebook#goto_page 0
429 method private back () =
431 self#_load (self#_historyPrev ())
432 with MatitaMisc.History_failure -> ()
434 method private forward () =
436 self#_load (self#_historyNext ())
437 with MatitaMisc.History_failure -> ()
439 (* loads a uri which can be a cic uri or an about:* uri
440 * @param uri string *)
441 method private _load entry =
443 if entry <> current_entry || entry = `About `Current_proof then begin
445 | `About `Current_proof -> self#home ()
446 | `About `Blank -> self#blank ()
447 | `About `Us -> () (* TODO implement easter egg here :-] *)
448 | `Check term -> self#_loadCheck term
449 | `Cic (term, metasenv) -> self#_loadTermCic term metasenv
450 | `Dir dir -> self#_loadDir dir
451 | `Uri uri -> self#_loadUriManagerUri (UriManager.uri_of_string uri)
452 | `Whelp (query, results) -> self#_loadList results);
456 | UriManager.IllFormedUri uri -> fail (sprintf "invalid uri: %s" uri)
457 | CicEnvironment.Object_not_found uri ->
458 fail (sprintf "object not found: %s" (UriManager.string_of_uri uri))
459 | Browser_failure msg -> fail msg
461 method private blank () =
463 mathView#load_root (MatitaMisc.empty_mathml ())#get_documentElement
465 method private _loadCheck term =
466 failwith "not implemented _loadCheck";
469 method private home () =
471 match self#script#status.proof_status with
472 | Proof (uri, metasenv, bo, ty) ->
473 let name = UriManager.name_of_uri (MatitaMisc.unopt uri) in
474 let obj = Cic.CurrentProof (name, metasenv, bo, ty, [], []) in
476 | Incomplete_proof ((uri, metasenv, bo, ty), _) ->
477 let name = UriManager.name_of_uri (MatitaMisc.unopt uri) in
478 let obj = Cic.CurrentProof (name, metasenv, bo, ty, [], []) in
482 (** loads a cic uri from the environment
483 * @param uri UriManager.uri *)
484 method private _loadUriManagerUri uri =
485 let uri = UriManager.strip_xpointer uri in
486 let (obj, _) = CicEnvironment.get_obj CicUniv.empty_ugraph uri in
489 method private _loadDir dir =
490 let content = Http_getter.ls dir in
491 let l = List.map (function
492 | Http_getter_types.Ls_section sec -> sec
493 | Http_getter_types.Ls_object obj -> obj.Http_getter_types.uri
498 method private setEntry entry =
499 win#browserUri#set_text (string_of_entry entry);
500 current_entry <- entry
502 method private _loadObj obj =
504 (* this must be _before_ loading the document, since
505 * if the widget is not mapped (hidden by the notebook)
506 * the document is not rendered *)
507 let use_diff = false in (* ZACK TODO use XmlDiff when re-rendering? *)
508 let (mathml, (_,(ids_to_terms, ids_to_father_ids, ids_to_conjectures,
509 ids_to_hypotheses,_,_))) =
510 ApplyTransformation.mml_of_cic_object obj
512 current_infos <- Some (ids_to_terms, ids_to_father_ids,
513 ids_to_conjectures, ids_to_hypotheses);
514 (match current_mathml with
515 | Some current_mathml when use_diff ->
517 XmlDiff.update_dom ~from:current_mathml mathml;
520 mathView#load_root ~root:mathml#get_documentElement;
521 current_mathml <- Some mathml);
523 method private _loadTermCic term metasenv =
524 let context = self#script#proofContext in
525 let dummyno = CicMkImplicit.new_meta metasenv [] in
526 let sequent = (dummyno, context, term) in
527 mathView#load_sequent (sequent :: metasenv) dummyno;
530 method private _loadList l =
531 model#list_store#clear ();
532 List.iter model#easy_append l;
535 (** { public methods, all must call _load!! } *)
538 handle_error (fun () -> self#_load uri);
541 (** this is what the browser does when you enter a string an hit enter *)
542 method loadInput txt =
543 let add_terminating_slash s =
544 if not(Pcre.pmatch ~rex:trailing_slash_RE s) &&
545 not(Pcre.pmatch ~rex:has_xpointer_RE s) then s^"/" else s
549 let u = UriManager.strip_xpointer (UriManager.uri_of_string txt) in
550 ignore(Http_getter.resolve' u); true
552 | Http_getter_types.Key_not_found _
553 | Http_getter_types.Unresolvable_URI _ -> false
554 | UriManager.IllFormedUri u -> failwith ("Malformed URI '" ^ u ^ "'")
556 let is_whelp txt = Pcre.pmatch ~rex:whelp_RE txt in
559 let q = Pcre.extract ~rex:whelp_query_RE txt in
563 with Invalid_argument _ -> failwith "Malformed Whelp query"
565 activate_combo_query arg query;
566 (MatitaScript.instance ())#advance ~statement:(txt^".") ()
574 (`Dir (add_terminating_slash txt))
577 self#_historyAdd entry
581 (** {2 methods used by constructor only} *)
584 method history = history
585 method currentEntry = current_entry
587 if current_entry = `About `Current_proof then
588 self#_load (`About `Current_proof)
592 let sequentsViewer ~(notebook:GPack.notebook)
593 ~(sequentViewer:sequentViewer) ()
595 new sequentsViewer ~notebook ~sequentViewer ()
598 let size = BuildTimeConf.browser_history_size in
599 let rec aux history =
600 let browser = new cicBrowser_impl ~history () in
601 let win = browser#win in
602 ignore (win#browserNewButton#connect#clicked (fun () ->
604 new MatitaMisc.browser_history ~memento:history#save size
607 let newBrowser = aux history in
608 newBrowser#load browser#currentEntry));
610 (* attempt (failed) to close windows on CTRL-W ... *)
611 MatitaGtkMisc.connect_key win#browserWinEventBox#event ~modifiers:[`CONTROL]
612 GdkKeysyms._W (fun () -> win#toplevel#destroy ());
614 cicBrowsers := browser :: !cicBrowsers;
615 (browser :> cicBrowser)
617 let history = new MatitaMisc.browser_history size (`About `Blank) in
620 let refresh_all_browsers () = List.iter (fun b -> b#refresh ()) !cicBrowsers
622 let default_sequentViewer () = sequentViewer ~show:true ()
623 let sequentViewer_instance = MatitaMisc.singleton default_sequentViewer
625 let default_sequentsViewer () =
626 let gui = MatitaGui.instance () in
627 let sequentViewer = sequentViewer_instance () in
628 sequentsViewer ~notebook:gui#main#sequentsNotebook ~sequentViewer ()
629 let sequentsViewer_instance = MatitaMisc.singleton default_sequentsViewer
633 method private get_browser reuse =
635 (match !cicBrowsers with
636 | [] -> cicBrowser ()
637 | b :: _ -> (b :> cicBrowser))
641 method show_entry ?(reuse=false) t = (self#get_browser reuse)#load t
643 method show_uri_list ?(reuse=false) ~entry l =
644 (self#get_browser reuse)#load entry