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 loadUri: string -> unit
 284   method loadTerm: term_source -> unit
 285 end
 286
 287 class cicBrowser_impl ~(history:string MatitaMisc.history) () =
 288   let term_RE = Pcre.regexp "^term:(.*)" in
 289   let trailing_slash_RE = Pcre.regexp "/$" in
 290   let gui = MatitaGui.instance () in
 291   let win = gui#newBrowserWin () in
 292   let toplevel = win#toplevel in
 293   let mathView = sequentViewer ~packing:win#scrolledBrowser#add () in
 294   let fail msg =
 295     ignore (MatitaGtkMisc.ask_confirmation ~gui:(MatitaGui.instance ())
 296       ~title:"Cic browser" ~msg ~cancel:false ());
 297   in
 298   let handle_error f =
 299     try
 300       f ()
 301     with exn ->
 302       fail (sprintf "Uncaught exception:\n%s" (Printexc.to_string exn))
 303   in
 304   let handle_error' f = fun () -> handle_error f in  (* used in callbacks *)
 305   object (self)
 306     inherit scriptAccessor
 307
 308     initializer
 309       ignore (win#browserUri#connect#activate (handle_error' (fun () ->
 310         self#_loadUri win#browserUri#text)));
 311       ignore (win#browserHomeButton#connect#clicked (handle_error' (fun () ->
 312         self#_loadUri current_proof_uri)));
 313       ignore (win#browserRefreshButton#connect#clicked
 314         (handle_error' self#refresh));
 315       ignore (win#browserBackButton#connect#clicked (handle_error' self#back));
 316       ignore (win#browserForwardButton#connect#clicked
 317         (handle_error' self#forward));
 318       ignore (win#toplevel#event#connect#delete (fun _ ->
 319         let my_id = Oo.id self in
 320         cicBrowsers := List.filter (fun b -> Oo.id b <> my_id) !cicBrowsers;
 321         if !cicBrowsers = [] &&
 322           Helm_registry.get "matita.mode" = "cicbrowser"
 323         then
 324           GMain.quit ();
 325         false));
 326       mathView#set_href_callback (Some (fun uri ->
 327         handle_error (fun () -> self#_loadUri uri)));
 328       self#_loadUri ~add_to_history:false blank_uri;
 329       toplevel#show ();
 330
 331     val mutable current_uri = ""
 332     val mutable current_infos = None
 333     val mutable current_mathml = None
 334
 335     method private back () =
 336       try
 337         self#_loadUri ~add_to_history:false history#previous
 338       with MatitaMisc.History_failure -> ()
 339
 340     method private forward () =
 341       try
 342         self#_loadUri ~add_to_history:false history#next
 343       with MatitaMisc.History_failure -> ()
 344
 345       (* loads a uri which can be a cic uri or an about:* uri
 346       * @param uri string *)
 347     method private _loadUri ?(add_to_history = true) uri =
 348       try
 349         if current_uri <> uri || uri = current_proof_uri then begin
 350           (match uri with
 351           | uri when uri = blank_uri -> self#blank ()
 352           | uri when uri = current_proof_uri -> self#home ()
 353           | uri when Pcre.pmatch ~rex:term_RE uri ->
 354               self#loadTerm (`String (Pcre.extract ~rex:term_RE uri).(1))
 355           | uri when Pcre.pmatch ~rex:trailing_slash_RE uri -> self#loadDir uri
 356           | _ -> self#loadUriManagerUri (UriManager.uri_of_string uri));
 357           self#setUri uri;
 358           if add_to_history then history#add uri
 359         end
 360       with
 361       | UriManager.IllFormedUri _ -> fail (sprintf "invalid uri: %s" uri)
 362       | CicEnvironment.Object_not_found _ ->
 363           fail (sprintf "object not found: %s" uri)
 364       | Browser_failure msg -> fail msg
 365
 366     method loadUri uri =
 367       handle_error (fun () -> self#_loadUri ~add_to_history:true uri)
 368
 369     method private blank () =
 370       mathView#load_root (MatitaMisc.empty_mathml ())#get_documentElement
 371
 372     method private home () =
 373       if self#script#onGoingProof () then
 374         let ((uri, metasenv, bo, ty), _) = self#script#proofStatus in
 375         let name = UriManager.name_of_uri (MatitaMisc.unopt uri) in
 376         let obj = Cic.CurrentProof (name, metasenv, bo, ty, [], []) in
 377         self#loadObj obj
 378       else
 379         self#blank ()
 380
 381       (** loads a cic uri from the environment
 382       * @param uri UriManager.uri *)
 383     method private loadUriManagerUri uri =
 384       let uri = UriManager.strip_xpointer uri in
 385       let (obj, _) = CicEnvironment.get_obj CicUniv.empty_ugraph uri in
 386       self#loadObj obj
 387
 388     method private loadDir dir =
 389       let mathml = MatitaMisc.empty_boxml () in
 390       let content = Http_getter.ls dir in
 391       let root = mathml#get_documentElement in
 392       let new_box_elt name =
 393         mathml#createElementNS ~namespaceURI:(Some Misc.boxml_ns)
 394           ~qualifiedName:(Gdome.domString ("b:" ^ name))
 395       in
 396       let new_text content = mathml#createTextNode (Gdome.domString content) in
 397       let b_v = new_box_elt "v" in
 398       List.iter
 399         (fun item ->
 400           let b_text = new_box_elt "text" in
 401           let uri, elt =
 402             match item with
 403             | Http_getter_types.Ls_section subdir ->
 404                 (dir ^ subdir ^ "/"), (new_text (subdir ^ "/"))
 405             | Http_getter_types.Ls_object obj ->
 406                 (dir ^ obj.Http_getter_types.uri),
 407                 (new_text obj.Http_getter_types.uri)
 408           in
 409           b_text#setAttributeNS ~namespaceURI:(Some Misc.xlink_ns)
 410             ~qualifiedName:(Gdome.domString "xlink:href")
 411             ~value:(Gdome.domString uri);
 412           ignore (b_v#appendChild ~newChild:(b_text :> Gdome.node));
 413           ignore (b_text#appendChild ~newChild:(elt :> Gdome.node)))
 414         content;
 415       ignore (root#appendChild ~newChild:(b_v :> Gdome.node));
 416 (*       Misc.domImpl#saveDocumentToFile ~doc:mathml ~name:"pippo" (); *)
 417       mathView#load_root ~root:root
 418
 419     method private setUri uri =
 420         win#browserUri#set_text uri;
 421         current_uri <- uri
 422
 423     method private loadObj obj =
 424       let use_diff = false in (* ZACK TODO use XmlDiff when re-rendering? *)
 425       let (mathml, (_,(ids_to_terms, ids_to_father_ids, ids_to_conjectures,
 426            ids_to_hypotheses,_,_))) =
 427         ApplyTransformation.mml_of_cic_object obj
 428       in
 429       current_infos <- Some (ids_to_terms, ids_to_father_ids,
 430         ids_to_conjectures, ids_to_hypotheses);
 431       match current_mathml with
 432       | Some current_mathml when use_diff ->
 433           mathView#freeze;
 434           XmlDiff.update_dom ~from:current_mathml mathml;
 435           mathView#thaw
 436       |  _ ->
 437           mathView#load_root ~root:mathml#get_documentElement;
 438           current_mathml <- Some mathml
 439
 440     method private _loadTerm s = failwith "not implemented _loadTerm"
 441 (* TODO  self#_loadTermAst (disambiguator#parserr#parseTerm (Stream.of_string s)) *)
 442
 443     method private _loadTermAst ast = failwith "not implemented _loadTermAst"
 444 (* TODO
 445       let (_, metasenv, term, _) =
 446         MatitaCicMisc.disambiguate ~disambiguator ~currentProof ast
 447       in
 448       self#_loadTermCic term metasenv
 449 *)
 450
 451     method private _loadTermCic term metasenv =
 452       let context = self#script#proofContext in
 453       let dummyno = CicMkImplicit.new_meta metasenv [] in
 454       let sequent = (dummyno, context, term) in
 455       mathView#load_sequent (sequent :: metasenv) dummyno
 456
 457     method loadTerm (src:term_source) =
 458       handle_error (fun () ->
 459         (match src with
 460         | `Ast ast -> self#_loadTermAst ast
 461         | `Cic (cic, metasenv) -> self#_loadTermCic cic metasenv
 462         | `String s -> self#_loadTerm s);
 463         self#setUri "check")
 464
 465       (** {2 methods used by constructor only} *)
 466
 467     method win = win
 468     method history = history
 469     method currentUri = current_uri
 470     method refresh () =
 471       if current_uri = current_proof_uri then
 472       self#_loadUri ~add_to_history:false current_proof_uri
 473
 474   end
 475
 476 let sequentsViewer ~(notebook:GPack.notebook)
 477   ~(sequentViewer:sequentViewer) ()
 478 =
 479   new sequentsViewer ~notebook ~sequentViewer ()
 480
 481 let cicBrowser () =
 482   let size = BuildTimeConf.browser_history_size in
 483   let rec aux history =
 484     let browser = new cicBrowser_impl ~history () in
 485     let win = browser#win in
 486     ignore (win#browserNewButton#connect#clicked (fun () ->
 487       let history =
 488         new MatitaMisc.browser_history ~memento:history#save size ""
 489       in
 490       let newBrowser = aux history in
 491       newBrowser#loadUri browser#currentUri));
 492 (*
 493       (* attempt (failed) to close windows on CTRL-W ... *)
 494     MatitaGtkMisc.connect_key win#browserWinEventBox#event ~modifiers:[`CONTROL]
 495       GdkKeysyms._W (fun () -> win#toplevel#destroy ());
 496 *)
 497     cicBrowsers := browser :: !cicBrowsers;
 498     (browser :> cicBrowser)
 499   in
 500   let history = new MatitaMisc.browser_history size blank_uri in
 501   aux history
 502
 503 let refresh_all_browsers () = List.iter (fun b -> b#refresh ()) !cicBrowsers
 504
 505 let default_sequentViewer () = sequentViewer ~show:true ()
 506 let sequentViewer_instance = MatitaMisc.singleton default_sequentViewer
 507
 508 let default_sequentsViewer () =
 509   let gui = MatitaGui.instance () in
 510   let sequentViewer = sequentViewer_instance () in
 511   sequentsViewer ~notebook:gui#main#sequentsNotebook ~sequentViewer ()
 512 let sequentsViewer_instance = MatitaMisc.singleton default_sequentsViewer
 513
 514
 515 let mathViewer () =
 516   object
 517     method show_term t = (cicBrowser ()) # loadTerm t
 518   end