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/.
35 module Stack = Continuationals.Stack
37 let cicBrowsers = ref []
39 let tab_label meta_markup =
42 | `Closed m -> sprintf "<s>%s</s>" (aux m)
43 | `Current m -> sprintf "<b>%s</b>" (aux m)
44 | `Shift (pos, m) -> sprintf "|<sub>%d</sub>: %s" pos (aux m)
45 | `Meta n -> sprintf "?%d" n
47 let markup = aux meta_markup in
48 (GMisc.label ~markup ~show:true ())#coerce
50 let goal_of_switch = function Stack.Open g | Stack.Closed g -> g
52 class sequentsViewer ~(notebook:GPack.notebook) ~(cicMathView:cicMathView) () =
54 method cicMathView = cicMathView (** clickableMathView accessor *)
57 val mutable switch_page_callback = None
58 val mutable page2goal = [] (* associative list: page no -> goal no *)
59 val mutable goal2page = [] (* the other way round *)
60 val mutable goal2win = [] (* associative list: goal no -> scrolled win *)
61 val mutable _metasenv = [],[]
62 val mutable scrolledWin: GBin.scrolled_window option = None
63 (* scrolled window to which the sequentViewer is currently attached *)
64 val logo = (GMisc.image
65 ~file:(MatitaMisc.image_path "matita_medium.png") ()
68 val logo_with_qed = (GMisc.image
69 ~file:(MatitaMisc.image_path "matita_small.png") ()
73 notebook#set_show_tabs false;
74 ignore(notebook#append_page logo)
76 method load_logo_with_qed =
77 notebook#set_show_tabs false;
78 ignore(notebook#append_page logo_with_qed)
81 cicMathView#remove_selections;
82 (match scrolledWin with
84 (* removing page from the notebook will destroy all contained widget,
85 * we do not want the cicMathView to be destroyed as well *)
86 w#remove cicMathView#coerce;
89 (match switch_page_callback with
91 GtkSignal.disconnect notebook#as_widget id;
92 switch_page_callback <- None
94 for i = 0 to pages do notebook#remove_page 0 done;
95 notebook#set_show_tabs true;
102 method nload_sequents : 'status. #GrafiteTypes.status as 'status -> unit
103 = fun (status : #GrafiteTypes.status) ->
104 let _,_,metasenv,subst,_ = status#obj in
105 _metasenv <- metasenv,subst;
107 let win goal_switch =
109 GBin.scrolled_window ~hpolicy:`AUTOMATIC ~vpolicy:`ALWAYS
110 ~shadow_type:`IN ~show:true () in
112 scrolledWin <- Some w;
113 (match cicMathView#misc#parent with
117 match cicMathView#misc#parent with
119 | Some p -> GContainer.cast_container p
121 parent#remove cicMathView#coerce);
122 w#add cicMathView#coerce
124 goal2win <- (goal_switch, reparent) :: goal2win;
128 let stack_goals = Stack.open_goals status#stack in
129 let proof_goals = List.map fst metasenv in
131 HExtlib.list_uniq (List.sort Pervasives.compare stack_goals)
132 <> List.sort Pervasives.compare proof_goals
134 prerr_endline ("STACK GOALS = " ^ String.concat " " (List.map string_of_int stack_goals));
135 prerr_endline ("PROOF GOALS = " ^ String.concat " " (List.map string_of_int proof_goals));
141 function Stack.Open i ->`Meta i | Stack.Closed i ->`Closed (`Meta i)
144 let added_goals = ref [] in
145 (* goals can be duplicated on the tack due to focus, but we should avoid
146 * multiple labels in the user interface *)
147 let add_tab markup goal_switch =
148 let goal = Stack.goal_of_switch goal_switch in
149 if not (List.mem goal !added_goals) then begin
150 ignore(notebook#append_page
151 ~tab_label:(tab_label markup) (win goal_switch));
152 page2goal <- (!page, goal_switch) :: page2goal;
153 goal2page <- (goal_switch, !page) :: goal2page;
156 added_goals := goal :: !added_goals
159 let add_switch _ _ (_, sw) = add_tab (render_switch sw) sw in
160 Stack.iter (** populate notebook with tabs *)
161 ~env:(fun depth tag (pos, sw) ->
163 match depth, pos with
164 | 0, 0 -> `Current (render_switch sw)
165 | 0, _ -> `Shift (pos, `Current (render_switch sw))
166 | 1, pos when Stack.head_tag status#stack = `BranchTag ->
167 `Shift (pos, render_switch sw)
168 | _ -> render_switch sw
171 ~cont:add_switch ~todo:add_switch
173 switch_page_callback <-
174 Some (notebook#connect#switch_page ~callback:(fun page ->
176 try List.assoc page page2goal with Not_found -> assert false
178 self#render_page status ~page ~goal_switch))
180 method private render_page:
181 'status. #ApplyTransformation.status as 'status -> page:int ->
182 goal_switch:Stack.switch -> unit
183 = fun status ~page ~goal_switch ->
184 (match goal_switch with
186 let menv,subst = _metasenv in
187 cicMathView#nload_sequent status menv subst goal
188 | Stack.Closed goal ->
189 let root = Lazy.force closed_goal_mathml in
190 cicMathView#load_root ~root);
192 cicMathView#set_selection None;
193 List.assoc goal_switch goal2win ();
194 (match cicMathView#misc#parent with
197 (* The text widget dinamycally inserts the text in a separate
198 thread. We need to wait for it to terminate before we can
199 move the scrollbar to the end *)
200 while Glib.Main.pending()do ignore(Glib.Main.iteration false); done;
202 new GBin.scrolled_window
203 (Gobject.try_cast p#as_widget "GtkScrolledWindow") in
204 (* The double change upper/lower is to trigger the emission of
206 w#hadjustment#set_value w#hadjustment#upper;
207 w#hadjustment#set_value w#hadjustment#lower;
208 w#vadjustment#set_value w#vadjustment#lower;
209 w#vadjustment#set_value
210 (w#vadjustment#upper -. w#vadjustment#page_size));
211 with Not_found -> assert false)
213 method goto_sequent: 'status. #ApplyTransformation.status as 'status -> int -> unit
215 let goal_switch, page =
218 (function Stack.Open g, _ | Stack.Closed g, _ -> g = goal)
220 with Not_found -> assert false
222 notebook#goto_page page;
223 self#render_page status ~page ~goal_switch
226 let blank_uri = BuildTimeConf.blank_uri
227 let current_proof_uri = BuildTimeConf.current_proof_uri
230 [ `Ast of NotationPt.term
231 | `NCic of NCic.term * NCic.context * NCic.metasenv * NCic.substitution
235 class cicBrowser_impl ~(history:MatitaTypes.mathViewer_entry MatitaMisc.history)
240 "^cic:/([^/]+/)*[^/]+\\.(con|ind|var)(#xpointer\\(\\d+(/\\d+)+\\))?$"
242 let dir_RE = Pcre.regexp "^cic:((/([^/]+/)*[^/]+(/)?)|/|)$" in
243 let is_uri txt = Pcre.pmatch ~rex:uri_RE txt in
244 let is_dir txt = Pcre.pmatch ~rex:dir_RE txt in
245 let gui = MatitaMisc.get_gui () in
246 let win = new MatitaGeneratedGui.browserWin () in
247 let _ = win#browserUri#misc#grab_focus () in
248 let gviz = LablGraphviz.graphviz ~packing:win#graphScrolledWin#add () in
250 GSourceView2.source_view ~auto_indent:false ~editable:false ()
253 win#scrolledwinContent#add (searchText :> GObj.widget);
255 let text = win#entrySearch#text in
256 let highlight start end_ =
257 searchText#source_buffer#move_mark `INSERT ~where:start;
258 searchText#source_buffer#move_mark `SEL_BOUND ~where:end_;
259 searchText#scroll_mark_onscreen `INSERT
261 let iter = searchText#source_buffer#get_iter `SEL_BOUND in
262 match iter#forward_search text with
264 (match searchText#source_buffer#start_iter#forward_search text with
266 | Some (start,end_) -> highlight start end_)
267 | Some (start,end_) -> highlight start end_
269 ignore(win#entrySearch#connect#activate ~callback);
270 ignore(win#buttonSearch#connect#clicked ~callback);
272 let toplevel = win#toplevel in
273 let mathView = cicMathView ~packing:win#scrolledBrowser#add () in
275 MatitaGtkMisc.report_error ~title:"Cic browser" ~message
279 [ "dir", GdkPixbuf.from_file (MatitaMisc.image_path "matita-folder.png");
280 "obj", GdkPixbuf.from_file (MatitaMisc.image_path "matita-object.png") ]
282 let b = (not (Helm_registry.get_bool "matita.debug")) in
288 fail (snd (MatitaExcPp.to_string exn))
291 let handle_error' f = (fun () -> handle_error (fun () -> f ())) in
292 let load_easter_egg = lazy (
293 win#browserImage#set_file (MatitaMisc.image_path "meegg.png"))
296 let module Pp = GraphvizPp.Dot in
297 let filename, oc = Filename.open_temp_file "matita" ".dot" in
298 let fmt = Format.formatter_of_out_channel oc in
299 let status = (get_matita_script_current ())#status in
303 ~graph_attrs:["overlap", "false"]
304 ~node_attrs:["fontsize", "9"; "width", ".4";
305 "height", ".4"; "shape", "box"]
306 ~edge_attrs:["fontsize", "10"; "len", "2"] fmt;
307 NCicUnifHint.generate_dot_file status fmt;
311 gviz#load_graph_from_file ~gviz_cmd:"neato -Tpng" filename;
312 (*HExtlib.safe_remove filename*)
314 let load_coerchgraph tred () =
315 let module Pp = GraphvizPp.Dot in
316 let filename, oc = Filename.open_temp_file "matita" ".dot" in
317 let fmt = Format.formatter_of_out_channel oc in
320 ~node_attrs:["fontsize", "9"; "width", ".4"; "height", ".4"]
321 ~edge_attrs:["fontsize", "10"] fmt;
322 let status = (get_matita_script_current ())#status in
323 NCicCoercion.generate_dot_file status fmt;
328 gviz#load_graph_from_file
329 ~gviz_cmd:"dot -Txdot | tred |gvpack -gv | dot" filename
331 gviz#load_graph_from_file
332 ~gviz_cmd:"dot -Txdot | gvpack -gv | dot" filename;
333 HExtlib.safe_remove filename
336 val mutable gviz_uri =
337 let uri = NUri.uri_of_string "cic:/dummy/dec.con" in
338 NReference.reference_of_spec uri NReference.Decl;
340 val dep_contextual_menu = GMenu.menu ()
343 win#mathOrListNotebook#set_show_tabs false;
344 win#browserForwardButton#misc#set_sensitive false;
345 win#browserBackButton#misc#set_sensitive false;
346 ignore (win#browserUri#connect#activate (handle_error' (fun () ->
347 self#loadInput win#browserUri#text)));
348 ignore (win#browserHomeButton#connect#clicked (handle_error' (fun () ->
349 self#load (`About `Current_proof))));
350 ignore (win#browserRefreshButton#connect#clicked
351 (handle_error' (self#refresh ~force:true)));
352 ignore (win#browserBackButton#connect#clicked (handle_error' self#back));
353 ignore (win#browserForwardButton#connect#clicked
354 (handle_error' self#forward));
355 ignore (win#toplevel#event#connect#delete (fun _ ->
356 let my_id = Oo.id self in
357 cicBrowsers := List.filter (fun b -> Oo.id b <> my_id) !cicBrowsers;
359 ignore(win#whelpResultTreeview#connect#row_activated
360 ~callback:(fun _ _ ->
361 handle_error (fun () -> self#loadInput (self#_getSelectedUri ()))));
362 mathView#set_href_callback (Some (fun uri ->
363 handle_error (fun () ->
364 let uri = `NRef (NReference.reference_of_string uri) in
366 gviz#connect_href (fun button_ev attrs ->
367 let time = GdkEvent.Button.time button_ev in
368 let uri = List.assoc "href" attrs in
369 gviz_uri <- NReference.reference_of_string uri;
370 match GdkEvent.Button.button button_ev with
371 | button when button = MatitaMisc.left_button -> self#load (`NRef gviz_uri)
372 | button when button = MatitaMisc.right_button ->
373 dep_contextual_menu#popup ~button ~time
375 connect_menu_item win#browserCloseMenuItem (fun () ->
376 let my_id = Oo.id self in
377 cicBrowsers := List.filter (fun b -> Oo.id b <> my_id) !cicBrowsers;
378 win#toplevel#misc#hide(); win#toplevel#destroy ());
379 connect_menu_item win#browserUrlMenuItem (fun () ->
380 win#browserUri#misc#grab_focus ());
382 self#_load (`About `Blank);
385 val mutable current_entry = `About `Blank
387 (** @return None if no object uri can be built from the current entry *)
388 method private currentCicUri =
389 match current_entry with
390 | `NRef uri -> Some uri
394 new MatitaGtkMisc.taggedStringListModel tags win#whelpResultTreeview
396 val mutable lastDir = "" (* last loaded "directory" *)
398 method mathView = mathView
400 method private _getSelectedUri () =
401 match model#easy_selection () with
402 | [sel] when is_uri sel -> sel (* absolute URI selected *)
403 (* | [sel] -> win#browserUri#entry#text ^ sel |+ relative URI selected +| *)
404 | [sel] -> lastDir ^ sel
407 (** history RATIONALE
409 * All operations about history are done using _historyFoo.
410 * Only toplevel functions (ATM load and loadInput) call _historyAdd.
413 method private _historyAdd item =
415 win#browserBackButton#misc#set_sensitive true;
416 win#browserForwardButton#misc#set_sensitive false
418 method private _historyPrev () =
419 let item = history#previous in
420 if history#is_begin then win#browserBackButton#misc#set_sensitive false;
421 win#browserForwardButton#misc#set_sensitive true;
424 method private _historyNext () =
425 let item = history#next in
426 if history#is_end then win#browserForwardButton#misc#set_sensitive false;
427 win#browserBackButton#misc#set_sensitive true;
430 (** notebook RATIONALE
432 * Use only these functions to switch between the tabs
434 method private _showMath = win#mathOrListNotebook#goto_page 0
435 method private _showList = win#mathOrListNotebook#goto_page 1
436 method private _showEgg = win#mathOrListNotebook#goto_page 2
437 method private _showGviz = win#mathOrListNotebook#goto_page 3
438 method private _showSearch = win#mathOrListNotebook#goto_page 4
440 method private back () =
442 self#_load (self#_historyPrev ())
443 with MatitaMisc.History_failure -> ()
445 method private forward () =
447 self#_load (self#_historyNext ())
448 with MatitaMisc.History_failure -> ()
450 (* loads a uri which can be a cic uri or an about:* uri
451 * @param uri string *)
452 method private _load ?(force=false) entry =
453 handle_error (fun () ->
454 if entry <> current_entry || entry = `About `Current_proof || entry =
455 `About `Coercions || entry = `About `CoercionsFull || force then
458 | `About `Current_proof -> self#home ()
459 | `About `Blank -> self#blank ()
460 | `About `Us -> self#egg ()
461 | `About `CoercionsFull -> self#coerchgraph false ()
462 | `About `Coercions -> self#coerchgraph true ()
463 | `About `Hints -> self#hints ()
464 | `About `TeX -> self#tex ()
465 | `About `Grammar -> self#grammar ()
466 | `Check term -> self#_loadCheck term
467 | `NCic (term, ctx, metasenv, subst) ->
468 self#_loadTermNCic term metasenv subst ctx
469 | `Dir dir -> self#_loadDir dir
470 | `NRef nref -> self#_loadNReference nref);
474 method private blank () =
476 mathView#load_root (Lazy.force empty_mathml)
478 method private _loadCheck term =
479 failwith "not implemented _loadCheck";
482 method private egg () =
484 Lazy.force load_easter_egg
486 method private redraw_gviz ?center_on () =
487 if Sys.command "which dot" = 0 then
488 let tmpfile, oc = Filename.open_temp_file "matita" ".dot" in
489 let fmt = Format.formatter_of_out_channel oc in
490 (* MATITA 1.0 MetadataDeps.DepGraph.render fmt gviz_graph;*)
492 gviz#load_graph_from_file ~gviz_cmd:"tred | dot" tmpfile;
493 (match center_on with
495 | Some uri -> gviz#center_on_href (NReference.string_of_reference uri));
496 HExtlib.safe_remove tmpfile
498 MatitaGtkMisc.report_error ~title:"graphviz error"
499 ~message:("Graphviz is not installed but is necessary to render "^
500 "the graph of dependencies amoung objects. Please install it.")
501 ~parent:win#toplevel ()
503 method private dependencies direction uri () =
504 assert false (* MATITA 1.0
505 let dbd = LibraryDb.instance () in
508 | `Fwd -> MetadataDeps.DepGraph.direct_deps ~dbd uri
509 | `Back -> MetadataDeps.DepGraph.inverse_deps ~dbd uri in
510 gviz_graph <- graph; (** XXX check this for memory consuption *)
511 self#redraw_gviz ~center_on:uri ();
514 method private coerchgraph tred () =
515 load_coerchgraph tred ();
518 method private hints () =
522 method private tex () =
523 let b = Buffer.create 1000 in
524 Printf.bprintf b "UTF-8 equivalence classes (rotate with ALT-L):\n\n";
527 List.iter (fun sym ->
528 Printf.bprintf b " %s" (Glib.Utf8.from_unichar sym)
530 Printf.bprintf b "\n";
533 (fun l1 l2 -> compare (List.hd l1) (List.hd l2))
534 (Virtuals.get_all_eqclass ()));
535 Printf.bprintf b "\n\nVirtual keys (trigger with ALT-L):\n\n";
538 Printf.bprintf b " %s:\n" tag;
540 (fun names, symbol ->
541 Printf.bprintf b " \t%s\t%s\n"
542 (Glib.Utf8.from_unichar symbol)
543 (String.concat ", " names))
545 (fun (_,a) (_,b) -> compare a b)
547 Printf.bprintf b "\n")
549 (fun (a,_) (b,_) -> compare a b)
550 (Virtuals.get_all_virtuals ()));
551 self#_loadText (Buffer.contents b)
553 method private _loadText text =
554 searchText#source_buffer#set_text text;
555 win#entrySearch#misc#grab_focus ();
558 method private grammar () =
560 (Print_grammar.ebnf_of_term (get_matita_script_current ())#status);
562 method private home () =
564 let status = (get_matita_script_current ())#status in
565 match status#ng_mode with
566 `ProofMode -> self#_loadNObj status status#obj
569 method private _loadNReference (NReference.Ref (uri,_)) =
570 let status = (get_matita_script_current ())#status in
571 let obj = NCicEnvironment.get_checked_obj status uri in
572 self#_loadNObj status obj
574 method private _loadDir dir =
575 let content = Http_getter.ls ~local:false dir in
581 | Http_getter_types.Ls_section s -> "dir", s
582 | Http_getter_types.Ls_object o -> "obj", o.Http_getter_types.uri)
588 method private setEntry entry =
589 win#browserUri#set_text (MatitaTypes.string_of_entry entry);
590 current_entry <- entry
592 method private _loadNObj status obj =
593 (* showMath must be done _before_ loading the document, since if the
594 * widget is not mapped (hidden by the notebook) the document is not
597 mathView#load_nobject status obj
599 method private _loadTermNCic term m s c =
601 let m = (0,([],c,term))::m in
602 let status = (get_matita_script_current ())#status in
603 mathView#nload_sequent status m s d;
606 method private _loadList l =
607 model#list_store#clear ();
608 List.iter (fun (tag, s) -> model#easy_append ~tag s) l;
611 (** { public methods, all must call _load!! } *)
614 handle_error (fun () -> self#_load entry; self#_historyAdd entry)
616 (** this is what the browser does when you enter a string an hit enter *)
617 method loadInput txt =
618 let txt = HExtlib.trim_blanks txt in
619 (* (* ZACK: what the heck? *)
621 UriManager.string_of_uri
622 (UriManager.strip_xpointer (UriManager.uri_of_string txt))
627 | txt when is_uri txt ->
628 `NRef (NReference.reference_of_string ((*fix_uri*) txt))
629 | txt when is_dir txt -> `Dir (MatitaMisc.normalize_dir txt)
632 MatitaTypes.entry_of_string txt
633 with Invalid_argument _ ->
635 (GrafiteTypes.Command_error(sprintf "unsupported uri: %s" txt)))
638 self#_historyAdd entry
640 (** {2 methods used by constructor only} *)
643 method history = history
644 method currentEntry = current_entry
645 method refresh ~force () = self#_load ~force current_entry
649 let sequentsViewer ~(notebook:GPack.notebook) ~(cicMathView:cicMathView) ():
650 MatitaGuiTypes.sequentsViewer
652 (new sequentsViewer ~notebook ~cicMathView ():> MatitaGuiTypes.sequentsViewer)
654 let new_cicBrowser () =
655 let size = BuildTimeConf.browser_history_size in
656 let rec aux history =
657 let browser = new cicBrowser_impl ~history () in
658 let win = browser#win in
659 ignore (win#browserNewButton#connect#clicked (fun () ->
661 new MatitaMisc.browser_history ~memento:history#save size
664 let newBrowser = aux history in
665 newBrowser#load browser#currentEntry));
667 (* attempt (failed) to close windows on CTRL-W ... *)
668 MatitaGtkMisc.connect_key win#browserWinEventBox#event ~modifiers:[`CONTROL]
669 GdkKeysyms._W (fun () -> win#toplevel#destroy ());
671 cicBrowsers := browser :: !cicBrowsers;
674 let history = new MatitaMisc.browser_history size (`About `Blank) in
677 (** @param reuse if set reused last opened cic browser otherwise
678 * opens a new one. default is false *)
679 let cicBrowser ?(reuse=false) t =
682 (match !cicBrowsers with [] -> new_cicBrowser () | b :: _ -> b)
688 | Some t -> browser#load t
691 let default_cicMathView () =
692 let res = cicMathView ~show:true () in
693 res#set_href_callback
695 let uri = `NRef (NReference.reference_of_string uri) in
696 cicBrowser (Some uri)));
699 let cicMathView_instance =
700 MatitaMisc.singleton default_cicMathView
702 let default_sequentsViewer notebook =
703 let cicMathView = cicMathView_instance () in
704 sequentsViewer ~notebook ~cicMathView ()
706 let sequentsViewer_instance =
707 let already_used = ref false in
709 if !already_used then assert false
711 (already_used := true;
712 default_sequentsViewer notebook)
714 let refresh_all_browsers () =
715 List.iter (fun b -> b#refresh ~force:false ()) !cicBrowsers
717 let get_math_views () =
718 (cicMathView_instance ()) :: (List.map (fun b -> b#mathView) !cicBrowsers)
720 let find_selection_owner () =
723 | [] -> raise Not_found
725 (match mv#get_selections with
729 aux (get_math_views ())
731 let has_selection () =
732 try ignore (find_selection_owner ()); true
733 with Not_found -> false
735 let math_view_clipboard = ref None (* associative list target -> string *)
736 let has_clipboard () = !math_view_clipboard <> None
737 let empty_clipboard () = math_view_clipboard := None
739 let copy_selection () =
741 math_view_clipboard :=
742 Some ((find_selection_owner ())#strings_of_selection)
743 with Not_found -> failwith "no selection"
745 let paste_clipboard paste_kind =
746 match !math_view_clipboard with
747 | None -> failwith "empty clipboard"
749 (try List.assoc paste_kind cb with Not_found -> assert false)