helm/matita/matitaMathView.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://cs.unibo.it/helm/.
  24  *)
  25
  26 open Printf
  27
  28 open MatitaTypes
  29
  30 let list_map_fail f =
  31   let rec aux = function
  32     | [] -> []
  33     | he::tl ->
  34         try
  35           let he' = f he in
  36           he'::(aux tl)
  37         with Exit ->
  38           (aux tl)
  39   in
  40   aux
  41
  42 (** inherit from this class if you want to access current script *)
  43 class scriptAccessor =
  44 object (self)
  45   method private script = MatitaScript.instance ()
  46 end
  47
  48 class clickableMathView obj =
  49   let href = Gdome.domString "href" in
  50   let xref = Gdome.domString "xref" in
  51   object (self)
  52     inherit GMathViewAux.multi_selection_math_view obj
  53
  54     val mutable href_callback: (string -> unit) option = None
  55     method set_href_callback f = href_callback <- f
  56
  57     initializer
  58       ignore (self#connect#selection_changed self#choose_selection);
  59       ignore (self#connect#click (fun (gdome_elt, _, _, _) ->
  60         match gdome_elt with
  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
  64             | None -> ()
  65             | Some f ->
  66                 let uri =
  67                   elt#getAttributeNS ~namespaceURI:Misc.xlink_ns ~localName:href
  68                 in
  69                 f (uri#to_string))
  70         | Some elt -> ignore (self#action_toggle elt)
  71         | None -> ()))
  72     method private choose_selection gdome_elt =
  73       let rec aux elt =
  74         if elt#hasAttributeNS ~namespaceURI:Misc.helm_ns ~localName:xref then
  75           self#set_selection (Some elt)
  76         else
  77           try
  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" *)
  83       in
  84       match gdome_elt with
  85       | Some elt -> aux elt
  86       | None   -> self#set_selection None
  87   end
  88
  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))
  95     []
  96
  97 class sequentViewer obj =
  98   object(self)
  99
 100     inherit clickableMathView obj
 101
 102     val mutable current_infos = None
 103
 104     method get_selected_terms =
 105       let selections = self#get_selections in
 106       list_map_fail
 107         (fun node ->
 108           let xpath =
 109             ((node : Gdome.element)#getAttributeNS
 110               ~namespaceURI:Misc.helm_ns
 111               ~localName:(Gdome.domString "xref"))#to_string
 112           in
 113           if xpath = "" then assert false (* "ERROR: No xref found!!!" *)
 114           else
 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!!!" *)
 119         selections
 120
 121     method get_selected_hypotheses =
 122       let selections = self#get_selections in
 123       list_map_fail
 124         (fun node ->
 125           let xpath =
 126             ((node : Gdome.element)#getAttributeNS
 127               ~namespaceURI:Misc.helm_ns
 128               ~localName:(Gdome.domString "xref"))#to_string
 129           in
 130           if xpath = "" then assert false (* "ERROR: No xref found!!!" *)
 131           else
 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!!!" *)
 136         selections
 137
 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
 142     in
 143     current_infos <- Some (ids_to_terms, ids_to_father_ids, ids_to_hypotheses);
 144 (*
 145     debug_print "load_sequent: dumping MathML to ./prova";
 146     ignore (Misc.domImpl#saveDocumentToFile ~name:"./prova" ~doc:mathml ());
 147 *)
 148     self#load_root ~root:mathml#get_documentElement
 149  end
 150
 151 class sequentsViewer ~(notebook:GPack.notebook)
 152   ~(sequentViewer:sequentViewer) ()
 153 =
 154   object (self)
 155     inherit scriptAccessor
 156
 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 *)
 165
 166     method private tab_label metano =
 167       (GMisc.label ~text:(sprintf "?%d" metano) ~show:true ())#coerce
 168
 169     method reset =
 170       (match scrolledWin with
 171       | Some w ->
 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;
 175           scrolledWin <- None
 176       | None -> ());
 177       for i = 1 to pages do notebook#remove_page 0 done;
 178       pages <- 0;
 179       page2goal <- [];
 180       goal2page <- [];
 181       goal2win <- [];
 182       _metasenv <- [];
 183       self#script#setGoal ~-1;
 184       (match switch_page_callback with
 185       | Some id ->
 186           GtkSignal.disconnect notebook#as_widget id;
 187           switch_page_callback <- None
 188       | None -> ())
 189
 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;
 196       let win metano =
 197         let w =
 198           GBin.scrolled_window ~hpolicy:`AUTOMATIC ~vpolicy:`AUTOMATIC
 199             ~shadow_type:`IN ~show:true ()
 200         in
 201         let reparent () =
 202           scrolledWin <- Some w;
 203           match sequentViewer#misc#parent with
 204           | None -> w#add sequentViewer#coerce
 205           | Some _ -> sequentViewer#misc#reparent w#coerce
 206         in
 207         goal2win <- (metano, reparent) :: goal2win;
 208         w#coerce
 209       in
 210       let page = ref 0 in
 211       List.iter
 212         (fun (metano, _, _) ->
 213           page2goal <- (!page, metano) :: page2goal;
 214           goal2page <- (metano, !page) :: goal2page;
 215           incr page;
 216           notebook#append_page ~tab_label:(self#tab_label metano) (win metano))
 217         metasenv;
 218       switch_page_callback <-
 219         Some (notebook#connect#switch_page ~callback:(fun page ->
 220           let goal =
 221             try
 222               List.assoc page page2goal
 223             with Not_found -> assert false
 224           in
 225           self#script#setGoal goal;
 226           self#render_page ~page ~goal))
 227
 228     method private render_page ~page ~goal =
 229       sequentViewer#load_sequent _metasenv goal;
 230       try
 231         List.assoc goal goal2win ();
 232         sequentViewer#set_selection None
 233       with Not_found -> assert false
 234
 235     method goto_sequent goal =
 236       let page =
 237         try
 238           List.assoc goal goal2page
 239         with Not_found -> assert false
 240       in
 241       notebook#goto_page page;
 242       self#render_page page goal
 243
 244   end
 245
 246  (** constructors *)
 247
 248 type 'widget constructor =
 249   ?hadjustment:GData.adjustment ->
 250   ?vadjustment:GData.adjustment ->
 251   ?font_size:int ->
 252   ?log_verbosity:int ->
 253   ?width:int ->
 254   ?height:int ->
 255   ?packing:(GObj.widget -> unit) ->
 256   ?show:bool ->
 257   unit ->
 258     'widget
 259
 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))
 266     []
 267
 268 let blank_uri = BuildTimeConf.blank_uri
 269 let current_proof_uri = BuildTimeConf.current_proof_uri
 270
 271 type term_source =
 272   [ `Ast of DisambiguateTypes.term
 273   | `Cic of Cic.term * Cic.metasenv
 274   | `String of string
 275   ]
 276
 277 exception Browser_failure of string
 278
 279 let cicBrowsers = ref []
 280
 281 class type cicBrowser =
 282 object
 283   method load: MatitaTypes.mathViewer_entry -> unit
 284   method loadList: string list -> MatitaTypes.mathViewer_entry-> unit
 285   method loadInput: string -> unit
 286 end
 287
 288 class cicBrowser_impl ~(history:MatitaTypes.mathViewer_entry MatitaMisc.history)
 289   ()
 290 =
 291   let term_RE = Pcre.regexp "^term:(.*)" in
 292   let trailing_slash_RE = Pcre.regexp "/$" in
 293   let gui = MatitaGui.instance () in
 294   let win = gui#newBrowserWin () in
 295   let toplevel = win#toplevel in
 296   let mathView = sequentViewer ~packing:win#scrolledBrowser#add () in
 297   let fail msg =
 298     ignore (MatitaGtkMisc.ask_confirmation ~gui:(MatitaGui.instance ())
 299       ~title:"Cic browser" ~msg ~cancel:false ());
 300   in
 301   let handle_error f =
 302     try
 303       f ()
 304     with exn ->
 305       fail (sprintf "Uncaught exception:\n%s" (Printexc.to_string exn))
 306   in
 307   let handle_error' f = fun () -> handle_error f in  (* used in callbacks *)
 308   object (self)
 309     inherit scriptAccessor
 310
 311     initializer
 312       win#browserForwardButton#misc#set_sensitive false;
 313       win#browserBackButton#misc#set_sensitive false;
 314       ignore (win#browserUri#connect#activate (handle_error' (fun () ->
 315         self#loadInput win#browserUri#text)));
 316       ignore (win#browserHomeButton#connect#clicked (handle_error' (fun () ->
 317         self#_load (`About `Current_proof))));
 318       ignore (win#browserRefreshButton#connect#clicked
 319         (handle_error' self#refresh));
 320       ignore (win#browserBackButton#connect#clicked (handle_error' self#back));
 321       ignore (win#browserForwardButton#connect#clicked
 322         (handle_error' self#forward));
 323       ignore (win#toplevel#event#connect#delete (fun _ ->
 324         let my_id = Oo.id self in
 325         cicBrowsers := List.filter (fun b -> Oo.id b <> my_id) !cicBrowsers;
 326         if !cicBrowsers = [] &&
 327           Helm_registry.get "matita.mode" = "cicbrowser"
 328         then
 329           GMain.quit ();
 330         false));
 331       ignore(win#whelpResultTreeview#connect#row_activated
 332         ~callback:(fun _ _ ->
 333           let old = win#browserUri#text in
 334           self#loadInput (old ^ self#_getWhelpResultTreeviewSelection ())));
 335       mathView#set_href_callback (Some (fun uri ->
 336         handle_error (fun () -> self#_load (`Uri uri))));
 337       self#_load (`About `Blank);
 338       toplevel#show ()
 339
 340     val mutable current_entry = `About `Blank
 341     val mutable current_infos = None
 342     val mutable current_mathml = None
 343
 344     val model = new MatitaGtkMisc.stringListModel win#whelpResultTreeview
 345
 346     method private _getWhelpResultTreeviewSelection () =
 347       match model#easy_selection () with
 348           | [u] -> u
 349           | _ -> assert false
 350
 351     (** history RATIONALE
 352      *
 353      * all operations about history are done using _historyFoo
 354      *
 355      * only toplevel function like load loadList loadInput can call
 356      * _historyAdd
 357      *)
 358
 359     method private _historyAdd item =
 360       history#add item;
 361       win#browserBackButton#misc#set_sensitive true;
 362       win#browserForwardButton#misc#set_sensitive false
 363
 364     method private _historyPrev () =
 365       let item = history#previous in
 366       if history#is_begin then win#browserBackButton#misc#set_sensitive false;
 367       win#browserForwardButton#misc#set_sensitive true;
 368       item
 369
 370     method private _historyNext () =
 371       let item = history#next in
 372       if history#is_end then win#browserForwardButton#misc#set_sensitive false;
 373       win#browserBackButton#misc#set_sensitive true;
 374       item
 375
 376     (** notebook RATIONALE
 377      *
 378      * Use only these functions to switch between the tabs
 379      *)
 380     method private _showList = win#mathOrListNotebook#goto_page 1
 381     method private _showMath = win#mathOrListNotebook#goto_page 0
 382
 383
 384
 385     method private back () =
 386       try
 387         self#_load (self#_historyPrev ())
 388       with MatitaMisc.History_failure -> ()
 389
 390     method private forward () =
 391       try
 392         self#_load (self#_historyNext ())
 393       with MatitaMisc.History_failure -> ()
 394
 395       (* loads a uri which can be a cic uri or an about:* uri
 396       * @param uri string *)
 397     method private _load entry =
 398       try
 399           if entry <> current_entry || entry = `About `Current_proof then begin
 400             (match entry with
 401             | `About `Current_proof -> self#home ()
 402             | `About `Blank -> self#blank ()
 403             | `About `Us -> () (* TODO implement easter egg here :-] *)
 404             | `Check term -> self#_loadCheck term
 405             | `Cic (term, metasenv) -> self#_loadTermCic term metasenv
 406             | `Dir dir -> self#_loadDir dir
 407             | `Uri uri -> self#_loadUriManagerUri (UriManager.uri_of_string uri)
 408             | `Whelp (query, results) -> self#loadList results entry);
 409             self#setEntry entry
 410           end
 411       with
 412       | UriManager.IllFormedUri uri -> fail (sprintf "invalid uri: %s" uri)
 413       | CicEnvironment.Object_not_found uri ->
 414           fail (sprintf "object not found: %s" (UriManager.string_of_uri uri))
 415       | Browser_failure msg -> fail msg
 416
 417
 418     method private blank () =
 419       mathView#load_root (MatitaMisc.empty_mathml ())#get_documentElement;
 420       self#_showMath
 421
 422     method private _loadCheck term =
 423       failwith "not implemented _loadCheck";
 424       self#_showMath
 425
 426     method private home () =
 427       self#_showMath;
 428       match self#script#status.proof_status with
 429       | Proof  (uri, metasenv, bo, ty) ->
 430           let name = UriManager.name_of_uri (MatitaMisc.unopt uri) in
 431           let obj = Cic.CurrentProof (name, metasenv, bo, ty, [], []) in
 432           self#_loadObj obj
 433       | Incomplete_proof ((uri, metasenv, bo, ty), _) ->
 434           let name = UriManager.name_of_uri (MatitaMisc.unopt uri) in
 435           let obj = Cic.CurrentProof (name, metasenv, bo, ty, [], []) in
 436           self#_loadObj obj
 437       | _ -> self#blank ()
 438
 439       (** loads a cic uri from the environment
 440       * @param uri UriManager.uri *)
 441     method private _loadUriManagerUri uri =
 442       let uri = UriManager.strip_xpointer uri in
 443       let (obj, _) = CicEnvironment.get_obj CicUniv.empty_ugraph uri in
 444       self#_loadObj obj
 445
 446     method private _loadDir dir =
 447       let content = Http_getter.ls dir in
 448       let l = List.map (function
 449         | Http_getter_types.Ls_section sec -> sec
 450         | Http_getter_types.Ls_object obj -> obj.Http_getter_types.uri
 451         ) content
 452       in
 453       self#_loadList l
 454
 455     method private setEntry entry =
 456         win#browserUri#set_text (string_of_entry entry);
 457         current_entry <- entry
 458
 459     method private _loadObj obj =
 460       self#_showMath;
 461       (* this must be _before_ loading the document, since
 462        * if the widget is not mapped (hidden by the notebook)
 463        * the document is not rendered *)
 464       let use_diff = false in (* ZACK TODO use XmlDiff when re-rendering? *)
 465       let (mathml, (_,(ids_to_terms, ids_to_father_ids, ids_to_conjectures,
 466            ids_to_hypotheses,_,_))) =
 467         ApplyTransformation.mml_of_cic_object obj
 468       in
 469       current_infos <- Some (ids_to_terms, ids_to_father_ids,
 470         ids_to_conjectures, ids_to_hypotheses);
 471       (match current_mathml with
 472       | Some current_mathml when use_diff ->
 473           mathView#freeze;
 474           XmlDiff.update_dom ~from:current_mathml mathml;
 475           mathView#thaw
 476       |  _ ->
 477           mathView#load_root ~root:mathml#get_documentElement;
 478           current_mathml <- Some mathml);
 479
 480     method private _loadTermCic term metasenv =
 481       let context = self#script#proofContext in
 482       let dummyno = CicMkImplicit.new_meta metasenv [] in
 483       let sequent = (dummyno, context, term) in
 484       mathView#load_sequent (sequent :: metasenv) dummyno;
 485       self#_showMath
 486
 487     method private _loadList l =
 488       model#list_store#clear ();
 489       List.iter model#easy_append l;
 490       self#_showList
 491
 492     (** { public methods } *)
 493
 494     method load uri =
 495       handle_error (fun () -> self#_load uri);
 496       self#_historyAdd uri
 497
 498     method loadList l entry =
 499       self#_loadList l;
 500       self#_historyAdd entry
 501
 502     method loadInput txt =
 503       let add_terminating_slash s =
 504         if s.[String.length s - 1] <> '/' then s^"/" else s
 505       in
 506       let is_uri =
 507         try
 508           ignore(Http_getter.resolve txt); true
 509         with
 510         | Http_getter_types.Key_not_found _
 511         | Http_getter_types.Unresolvable_URI _ -> false
 512       in
 513       let entry =
 514         if is_uri then
 515           (`Uri txt)
 516         else
 517           (`Dir (add_terminating_slash txt))
 518       in
 519       self#_load entry;
 520       self#_historyAdd entry
 521
 522
 523       (** {2 methods used by constructor only} *)
 524
 525     method win = win
 526     method history = history
 527     method currentEntry = current_entry
 528     method refresh () =
 529       if current_entry = `About `Current_proof then
 530       self#_load (`About `Current_proof)
 531   end
 532
 533
 534 let sequentsViewer ~(notebook:GPack.notebook)
 535   ~(sequentViewer:sequentViewer) ()
 536 =
 537   new sequentsViewer ~notebook ~sequentViewer ()
 538
 539 let cicBrowser () =
 540   let size = BuildTimeConf.browser_history_size in
 541   let rec aux history =
 542     let browser = new cicBrowser_impl ~history () in
 543     let win = browser#win in
 544     ignore (win#browserNewButton#connect#clicked (fun () ->
 545       let history =
 546         new MatitaMisc.browser_history ~memento:history#save size
 547           (`About `Blank)
 548       in
 549       let newBrowser = aux history in
 550       newBrowser#load browser#currentEntry));
 551 (*
 552       (* attempt (failed) to close windows on CTRL-W ... *)
 553     MatitaGtkMisc.connect_key win#browserWinEventBox#event ~modifiers:[`CONTROL]
 554       GdkKeysyms._W (fun () -> win#toplevel#destroy ());
 555 *)
 556     cicBrowsers := browser :: !cicBrowsers;
 557     (browser :> cicBrowser)
 558   in
 559   let history = new MatitaMisc.browser_history size (`About `Blank) in
 560   aux history
 561
 562 let refresh_all_browsers () = List.iter (fun b -> b#refresh ()) !cicBrowsers
 563
 564 let default_sequentViewer () = sequentViewer ~show:true ()
 565 let sequentViewer_instance = MatitaMisc.singleton default_sequentViewer
 566
 567 let default_sequentsViewer () =
 568   let gui = MatitaGui.instance () in
 569   let sequentViewer = sequentViewer_instance () in
 570   sequentsViewer ~notebook:gui#main#sequentsNotebook ~sequentViewer ()
 571 let sequentsViewer_instance = MatitaMisc.singleton default_sequentsViewer
 572
 573 let mathViewer () =
 574   object(self)
 575     method private get_browser reuse =
 576       if reuse then
 577         (match !cicBrowsers with
 578         | [] -> cicBrowser ()
 579         | b :: _ -> (b :> cicBrowser))
 580       else
 581         (cicBrowser ())
 582
 583     method show_entry ?(reuse=false) t = (self#get_browser reuse)#load t
 584
 585     method show_uri_list ?(reuse=false) ~entry l =
 586       (self#get_browser reuse)#loadList l entry
 587   end