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 (* $Id$ *)
  27
  28 open Printf
  29
  30 open GrafiteTypes
  31 open MatitaGtkMisc
  32 open MatitaGuiTypes
  33
  34 module Stack = Continuationals.Stack
  35
  36 (** inherit from this class if you want to access current script *)
  37 class scriptAccessor =
  38 object (self)
  39   method private script = MatitaScript.current ()
  40 end
  41
  42 let cicBrowsers = ref []
  43 let gui_instance = ref None
  44 let set_gui gui = gui_instance := Some gui
  45 let get_gui () =
  46   match !gui_instance with
  47   | None -> assert false
  48   | Some gui -> gui
  49
  50 let default_font_size () =
  51   Helm_registry.get_opt_default Helm_registry.int
  52     ~default:BuildTimeConf.default_font_size "matita.font_size"
  53 let current_font_size = ref ~-1
  54 let increase_font_size () = incr current_font_size
  55 let decrease_font_size () = decr current_font_size
  56 let reset_font_size () = current_font_size := default_font_size ()
  57
  58   (* is there any lablgtk2 constant corresponding to the various mouse
  59    * buttons??? *)
  60 let left_button = 1
  61 let middle_button = 2
  62 let right_button = 3
  63
  64 let near (x1, y1) (x2, y2) =
  65   let distance = sqrt (((x2 -. x1) ** 2.) +. ((y2 -. y1) ** 2.)) in
  66   (distance < 4.)
  67
  68 let xlink_ns = Gdome.domString "http://www.w3.org/1999/xlink"
  69 let helm_ns = Gdome.domString "http://www.cs.unibo.it/helm"
  70 let href_ds = Gdome.domString "href"
  71 let xref_ds = Gdome.domString "xref"
  72
  73 let domImpl = Gdome.domImplementation ()
  74
  75   (** Gdome.element of a MathML document whose rendering should be blank. Used
  76   * by cicBrowser to render "about:blank" document *)
  77 let empty_mathml = lazy (
  78   domImpl#createDocument ~namespaceURI:(Some DomMisc.mathml_ns)
  79     ~qualifiedName:(Gdome.domString "math") ~doctype:None)
  80
  81 let empty_boxml = lazy (
  82   domImpl#createDocument ~namespaceURI:(Some DomMisc.boxml_ns)
  83     ~qualifiedName:(Gdome.domString "box") ~doctype:None)
  84
  85   (** shown for goals closed by side effects *)
  86 let closed_goal_mathml = lazy (
  87   domImpl#createDocumentFromURI ~uri:BuildTimeConf.closed_xml ())
  88
  89 (* ids_to_terms should not be passed here, is just for debugging *)
  90 let find_root_id annobj id ids_to_father_ids ids_to_terms ids_to_inner_types =
  91   let find_parent id ids =
  92     let rec aux id =
  93 (*       (prerr_endline (sprintf "id %s = %s" id
  94         (try
  95           CicPp.ppterm (Hashtbl.find ids_to_terms id)
  96         with Not_found -> "NONE"))); *)
  97       if List.mem id ids then Some id
  98       else
  99         (match
 100           (try Hashtbl.find ids_to_father_ids id with Not_found -> None)
 101         with
 102         | None -> None
 103         | Some id' -> aux id')
 104     in
 105     aux id
 106   in
 107   let return_father id ids =
 108     match find_parent id ids with
 109     | None -> assert false
 110     | Some parent_id -> parent_id
 111   in
 112   let mk_ids terms = List.map CicUtil.id_of_annterm terms in
 113   let inner_types =
 114    Hashtbl.fold
 115     (fun _ types acc ->
 116       match types.Cic2acic.annexpected with
 117          None -> types.Cic2acic.annsynthesized :: acc
 118        | Some ty -> ty :: types.Cic2acic.annsynthesized :: acc
 119     ) ids_to_inner_types [] in
 120   match annobj with
 121   | Cic.AConstant (_, _, _, Some bo, ty, _, _)
 122   | Cic.AVariable (_, _, Some bo, ty, _, _)
 123   | Cic.ACurrentProof (_, _, _, _, bo, ty, _, _) ->
 124       return_father id (mk_ids (ty :: bo :: inner_types))
 125   | Cic.AConstant (_, _, _, None, ty, _, _)
 126   | Cic.AVariable (_, _, None, ty, _, _) ->
 127       return_father id (mk_ids (ty::inner_types))
 128   | Cic.AInductiveDefinition _ ->
 129       assert false  (* TODO *)
 130
 131   (** @return string content of a dom node having a single text child node, e.g.
 132    * <m:mi xlink:href="...">bool</m:mi> *)
 133 let string_of_dom_node node =
 134   match node#get_firstChild with
 135   | None -> ""
 136   | Some node ->
 137       (try
 138         let text = new Gdome.text_of_node node in
 139         text#get_data#to_string
 140       with GdomeInit.DOMCastException _ -> "")
 141
 142 let name_of_hypothesis = function
 143   | Some (Cic.Name s, _) -> s
 144   | _ -> assert false
 145
 146 let id_of_node (node: Gdome.element) =
 147   let xref_attr =
 148     node#getAttributeNS ~namespaceURI:helm_ns ~localName:xref_ds in
 149   try
 150     List.hd (HExtlib.split ~sep:' ' xref_attr#to_string)
 151   with Failure _ -> assert false
 152
 153 type selected_term =
 154   | SelTerm of Cic.term * string option (* term, parent hypothesis (if any) *)
 155   | SelHyp of string * Cic.context (* hypothesis, context *)
 156
 157 class clickableMathView obj =
 158 let text_width = 80 in
 159 object (self)
 160   inherit GMathViewAux.multi_selection_math_view obj
 161
 162   val mutable href_callback: (string -> unit) option = None
 163   method set_href_callback f = href_callback <- f
 164
 165   val mutable _cic_info = None
 166   method private set_cic_info info = _cic_info <- info
 167   method private cic_info = _cic_info
 168
 169   initializer
 170     self#set_font_size !current_font_size;
 171     ignore (self#connect#selection_changed self#choose_selection_cb);
 172     ignore (self#event#connect#button_press self#button_press_cb);
 173     ignore (self#event#connect#button_release self#button_release_cb);
 174     ignore (self#event#connect#selection_clear self#selection_clear_cb);
 175     ignore (self#coerce#misc#connect#selection_get self#selection_get_cb)
 176
 177   val mutable button_press_x = -1.
 178   val mutable button_press_y = -1.
 179   val mutable selection_changed = false
 180
 181   method private selection_get_cb ctxt ~info ~time =
 182     let text =
 183       match ctxt#target with
 184       | "PATTERN" -> self#text_of_selection `Pattern
 185       | "TERM" | _ -> self#text_of_selection `Term
 186     in
 187     match text with
 188     | None -> ()
 189     | Some s -> ctxt#return s
 190
 191   method private text_of_selection fmt =
 192     match self#get_selections with
 193     | [] -> None
 194     | node :: _ -> Some (self#string_of_node ~paste_kind:fmt node)
 195
 196   method private selection_clear_cb sel_event =
 197     self#remove_selections;
 198     (GData.clipboard Gdk.Atom.clipboard)#clear ();
 199     false
 200
 201   method private button_press_cb gdk_button =
 202     let button = GdkEvent.Button.button gdk_button in
 203     if  button = left_button then begin
 204       button_press_x <- GdkEvent.Button.x gdk_button;
 205       button_press_y <- GdkEvent.Button.y gdk_button;
 206       selection_changed <- false
 207     end else if button = right_button then
 208       self#popup_contextual_menu (GdkEvent.Button.time gdk_button);
 209     false
 210
 211     (** @return a pattern structure which contains pretty printed terms *)
 212   method private tactic_text_pattern_of_selection =
 213     match self#get_selections with
 214     | [] -> assert false (* this method is invoked only if there's a sel. *)
 215     | node :: _ ->
 216         let id = id_of_node node in
 217         let cic_info, unsh_sequent = self#get_cic_info id in
 218         match self#get_term_by_id cic_info id with
 219         | SelTerm (t, father_hyp) ->
 220             let sequent = self#sequent_of_id ~paste_kind:`Pattern id in
 221             let text = self#string_of_cic_sequent sequent in
 222             (match father_hyp with
 223             | None -> None, [], Some text
 224             | Some hyp_name -> None, [ hyp_name, text ], None)
 225         | SelHyp (hyp_name, _ctxt) -> None, [ hyp_name, "%" ], None
 226
 227   method private popup_contextual_menu time =
 228     let menu = GMenu.menu () in
 229     let add_menu_item ?(menu = menu) ?stock ?label () =
 230       GMenu.image_menu_item ?stock ?label ~packing:menu#append () in
 231     let check = add_menu_item ~label:"Check" () in
 232     let reductions_menu_item = GMenu.menu_item ~label:"βδιζ-reduce" () in
 233     menu#append reductions_menu_item;
 234     let reductions = GMenu.menu () in
 235     reductions_menu_item#set_submenu reductions;
 236     let normalize = add_menu_item ~menu:reductions ~label:"Normalize" () in
 237     let reduce = add_menu_item ~menu:reductions ~label:"Reduce" () in
 238     let simplify = add_menu_item ~menu:reductions ~label:"Simplify" () in
 239     let whd = add_menu_item ~menu:reductions ~label:"Weak head" () in
 240     menu#append (GMenu.separator_item ());
 241     let copy = add_menu_item ~stock:`COPY () in
 242     let gui = get_gui () in
 243     List.iter (fun item -> item#misc#set_sensitive gui#canCopy)
 244       [ copy; check; normalize; reduce; simplify; whd ];
 245     let reduction_action kind () =
 246       let pat = self#tactic_text_pattern_of_selection in
 247       let statement =
 248         let loc = HExtlib.dummy_floc in
 249         "\n" ^
 250         GrafiteAstPp.pp_executable ~term_pp:(fun s -> s)
 251           ~lazy_term_pp:(fun _ -> assert false) ~obj_pp:(fun _ -> assert false)
 252           (GrafiteAst.Tactical (loc,
 253             GrafiteAst.Tactic (loc, GrafiteAst.Reduce (loc, kind, pat)),
 254             Some (GrafiteAst.Semicolon loc))) in
 255       (MatitaScript.current ())#advance ~statement () in
 256     connect_menu_item copy gui#copy;
 257     connect_menu_item normalize (reduction_action `Normalize);
 258     connect_menu_item reduce (reduction_action `Reduce);
 259     connect_menu_item simplify (reduction_action `Simpl);
 260     connect_menu_item whd (reduction_action `Whd);
 261     menu#popup ~button:right_button ~time
 262
 263   method private button_release_cb gdk_button =
 264     if GdkEvent.Button.button gdk_button = left_button then begin
 265       let button_release_x = GdkEvent.Button.x gdk_button in
 266       let button_release_y = GdkEvent.Button.y gdk_button in
 267       if selection_changed then
 268         ()
 269       else  (* selection _not_ changed *)
 270         if near (button_press_x, button_press_y)
 271           (button_release_x, button_release_y)
 272         then
 273           let x = int_of_float button_press_x in
 274           let y = int_of_float button_press_y in
 275           (match self#get_element_at x y with
 276           | None -> ()
 277           | Some elt ->
 278               let localName = href_ds in
 279               if elt#hasAttributeNS ~namespaceURI:xlink_ns ~localName then
 280                 self#invoke_href_callback
 281                   (elt#getAttributeNS ~namespaceURI:xlink_ns
 282                     ~localName)#to_string
 283                   gdk_button
 284               else
 285                 ignore (self#action_toggle elt));
 286     end;
 287     false
 288
 289   method private invoke_href_callback href_value gdk_button =
 290     let button = GdkEvent.Button.button gdk_button in
 291     if button = left_button then
 292       let time = GdkEvent.Button.time gdk_button in
 293       match href_callback with
 294       | None -> ()
 295       | Some f ->
 296           (match HExtlib.split href_value with
 297           | [ uri ] ->  f uri
 298           | uris ->
 299               let menu = GMenu.menu () in
 300               List.iter
 301                 (fun uri ->
 302                   let menu_item =
 303                     GMenu.menu_item ~label:uri ~packing:menu#append () in
 304                   connect_menu_item menu_item (fun () -> f uri))
 305                 uris;
 306               menu#popup ~button ~time)
 307
 308   method private choose_selection_cb gdome_elt =
 309     let set_selection elt =
 310       let misc = self#coerce#misc in
 311       self#set_selection (Some elt);
 312       misc#add_selection_target ~target:"STRING" Gdk.Atom.primary;
 313       ignore (misc#grab_selection Gdk.Atom.primary);
 314     in
 315     let rec aux elt =
 316       if (elt#getAttributeNS ~namespaceURI:helm_ns
 317             ~localName:xref_ds)#to_string <> ""
 318       then
 319         set_selection elt
 320       else
 321         try
 322           (match elt#get_parentNode with
 323           | None -> assert false
 324           | Some p -> aux (new Gdome.element_of_node p))
 325         with GdomeInit.DOMCastException _ -> ()
 326     in
 327     (match gdome_elt with
 328     | Some elt when (elt#getAttributeNS ~namespaceURI:xlink_ns
 329         ~localName:href_ds)#to_string <> "" ->
 330           set_selection elt
 331     | Some elt -> aux elt
 332     | None -> self#set_selection None);
 333     selection_changed <- true
 334
 335   method update_font_size = self#set_font_size !current_font_size
 336
 337     (** find a term by id from stored CIC infos @return either `Hyp if the id
 338      * correspond to an hypothesis or `Term (cic, hyp) if the id correspond to a
 339      * term. In the latter case hyp is either None (if the term is a subterm of
 340      * the sequent conclusion) or Some hyp_name if the term belongs to an
 341      * hypothesis *)
 342   method private get_term_by_id cic_info id =
 343     let unsh_item, ids_to_terms, ids_to_hypotheses, ids_to_father_ids, _, _ =
 344       cic_info in
 345     let rec find_father_hyp id =
 346       if Hashtbl.mem ids_to_hypotheses id
 347       then Some (name_of_hypothesis (Hashtbl.find ids_to_hypotheses id))
 348       else
 349         let father_id =
 350           try Hashtbl.find ids_to_father_ids id
 351           with Not_found -> assert false in
 352         match father_id with
 353         | Some id -> find_father_hyp id
 354         | None -> None
 355     in
 356     try
 357       let term = Hashtbl.find ids_to_terms id in
 358       let father_hyp = find_father_hyp id in
 359       SelTerm (term, father_hyp)
 360     with Not_found ->
 361       try
 362         let hyp = Hashtbl.find ids_to_hypotheses id in
 363         let _, context, _ =
 364           match unsh_item with Some seq -> seq | None -> assert false in
 365         let context' = MatitaMisc.list_tl_at hyp context in
 366         SelHyp (name_of_hypothesis hyp, context')
 367       with Not_found -> assert false
 368
 369   method private find_obj_conclusion id =
 370     match self#cic_info with
 371     | None
 372     | Some (_, _, _, _, _, None) -> assert false
 373     | Some (_, ids_to_terms, _, ids_to_father_ids, ids_to_inner_types, Some annobj) ->
 374         let id =
 375          find_root_id annobj id ids_to_father_ids ids_to_terms ids_to_inner_types
 376         in
 377          (try Hashtbl.find ids_to_terms id with Not_found -> assert false)
 378
 379   method private string_of_node ~(paste_kind:paste_kind) node =
 380     if node#hasAttributeNS ~namespaceURI:helm_ns ~localName:xref_ds
 381     then
 382       let id = id_of_node node in
 383       self#string_of_cic_sequent (self#sequent_of_id ~paste_kind id)
 384     else string_of_dom_node node
 385
 386   method private string_of_cic_sequent cic_sequent =
 387     let script = MatitaScript.current () in
 388     let metasenv =
 389       if script#onGoingProof () then script#proofMetasenv else [] in
 390     let _, (acic_sequent, _, _, ids_to_inner_sorts, _) =
 391       Cic2acic.asequent_of_sequent metasenv cic_sequent in
 392     let _, _, _, annterm = acic_sequent in
 393     let ast, ids_to_uris =
 394       TermAcicContent.ast_of_acic ids_to_inner_sorts annterm in
 395     let pped_ast = TermContentPres.pp_ast ast in
 396     let markup = CicNotationPres.render ids_to_uris pped_ast in
 397     BoxPp.render_to_string text_width markup
 398
 399   method private pattern_of term context unsh_sequent =
 400     let context_len = List.length context in
 401     let _, unsh_context, conclusion = unsh_sequent in
 402     try
 403       (match
 404         List.nth unsh_context (List.length unsh_context - context_len - 1)
 405       with
 406       | None -> assert false (* can't select a restricted hypothesis *)
 407       | Some (name, Cic.Decl ty) ->
 408           ProofEngineHelpers.pattern_of ~term:ty [term]
 409       | Some (name, Cic.Def (bo, _)) ->
 410           ProofEngineHelpers.pattern_of ~term:bo [term])
 411     with Failure _ | Invalid_argument _ ->
 412       ProofEngineHelpers.pattern_of ~term:conclusion [term]
 413
 414   method private get_cic_info id =
 415     match self#cic_info with
 416     | Some ((Some unsh_sequent, _, _, _, _, _) as info) -> info, unsh_sequent
 417     | Some ((None, _, _, _, _, _) as info) ->
 418         let t = self#find_obj_conclusion id in
 419         info, (~-1, [], t) (* dummy sequent for obj *)
 420     | None -> assert false
 421
 422   method private sequent_of_id ~(paste_kind:paste_kind) id =
 423     let cic_info, unsh_sequent = self#get_cic_info id in
 424     let cic_sequent =
 425       match self#get_term_by_id cic_info id with
 426       | SelTerm (t, _father_hyp) ->
 427           let occurrences =
 428             ProofEngineHelpers.locate_in_conjecture t unsh_sequent in
 429           (match occurrences with
 430           | [ context, _t ] ->
 431               (match paste_kind with
 432               | `Term -> ~-1, context, t
 433               | `Pattern -> ~-1, [], self#pattern_of t context unsh_sequent)
 434           | _ ->
 435               HLog.error (sprintf "found %d occurrences while 1 was expected"
 436                 (List.length occurrences));
 437               assert false) (* since it uses physical equality *)
 438       | SelHyp (_name, context) -> ~-1, context, Cic.Rel 1 in
 439     cic_sequent
 440
 441   method private string_of_selection ~(paste_kind:paste_kind) =
 442     match self#get_selections with
 443     | [] -> None
 444     | node :: _ -> Some (self#string_of_node ~paste_kind node)
 445
 446   method has_selection = self#get_selections <> []
 447
 448     (** @return an associative list format -> string with all possible selection
 449      * formats. Rationale: in order to convert the selection to TERM or PATTERN
 450      * format we need the sequent, the metasenv, ... keeping all of them in a
 451      * closure would be more expensive than keeping their already converted
 452      * forms *)
 453   method strings_of_selection =
 454     try
 455       let misc = self#coerce#misc in
 456       List.iter
 457         (fun target -> misc#add_selection_target ~target Gdk.Atom.clipboard)
 458         [ "TERM"; "PATTERN"; "STRING" ];
 459       ignore (misc#grab_selection Gdk.Atom.clipboard);
 460       List.map
 461         (fun paste_kind ->
 462           paste_kind, HExtlib.unopt (self#string_of_selection ~paste_kind))
 463         [ `Term; `Pattern ]
 464     with Failure _ -> failwith "no selection"
 465
 466 end
 467
 468 let clickableMathView ?hadjustment ?vadjustment ?font_size ?log_verbosity =
 469   GtkBase.Widget.size_params
 470     ~cont:(OgtkMathViewProps.pack_return (fun p ->
 471       OgtkMathViewProps.set_params
 472         (new clickableMathView (GtkMathViewProps.MathView_GMetaDOM.create p))
 473         ~font_size:None ~log_verbosity:None))
 474     []
 475
 476 class cicMathView obj =
 477 object (self)
 478   inherit clickableMathView obj
 479
 480   val mutable current_mathml = None
 481
 482   method load_sequent metasenv metano =
 483     let sequent = CicUtil.lookup_meta metano metasenv in
 484     let (mathml, unsh_sequent,
 485       (_, (ids_to_terms, ids_to_father_ids, ids_to_hypotheses,_ )))
 486     =
 487       ApplyTransformation.mml_of_cic_sequent metasenv sequent
 488     in
 489     self#set_cic_info
 490       (Some (Some unsh_sequent,
 491         ids_to_terms, ids_to_hypotheses, ids_to_father_ids,
 492         Hashtbl.create 1, None));
 493     let name = "sequent_viewer.xml" in
 494     HLog.debug ("load_sequent: dumping MathML to ./" ^ name);
 495     ignore (domImpl#saveDocumentToFile ~name ~doc:mathml ());
 496     self#load_root ~root:mathml#get_documentElement
 497
 498   method load_object obj =
 499     let use_diff = false in (* ZACK TODO use XmlDiff when re-rendering? *)
 500     let (mathml,
 501       (annobj, (ids_to_terms, ids_to_father_ids, _, ids_to_hypotheses, _, ids_to_inner_types)))
 502     =
 503       ApplyTransformation.mml_of_cic_object obj
 504     in
 505     self#set_cic_info
 506       (Some (None, ids_to_terms, ids_to_hypotheses, ids_to_father_ids, ids_to_inner_types, Some annobj));
 507     (match current_mathml with
 508     | Some current_mathml when use_diff ->
 509         self#freeze;
 510         XmlDiff.update_dom ~from:current_mathml mathml;
 511         self#thaw
 512     |  _ ->
 513         let name = "cic_browser.xml" in
 514         HLog.debug ("cic_browser: dumping MathML to ./" ^ name);
 515         ignore (domImpl#saveDocumentToFile ~name ~doc:mathml ());
 516         self#load_root ~root:mathml#get_documentElement;
 517         current_mathml <- Some mathml);
 518 end
 519
 520 let tab_label meta_markup =
 521   let rec aux =
 522     function
 523     | `Current m -> sprintf "<b>%s</b>" (aux m)
 524     | `Closed m -> sprintf "<s>%s</s>" (aux m)
 525     | `Shift (pos, m) -> sprintf "|<sub>%d</sub>: %s" pos (aux m)
 526     | `Meta n -> sprintf "?%d" n
 527   in
 528   let markup = aux meta_markup in
 529   (GMisc.label ~markup ~show:true ())#coerce
 530
 531 let goal_of_switch = function Stack.Open g | Stack.Closed g -> g
 532
 533 class sequentsViewer ~(notebook:GPack.notebook) ~(cicMathView:cicMathView) () =
 534   object (self)
 535     inherit scriptAccessor
 536
 537     val mutable pages = 0
 538     val mutable switch_page_callback = None
 539     val mutable page2goal = []  (* associative list: page no -> goal no *)
 540     val mutable goal2page = []  (* the other way round *)
 541     val mutable goal2win = []   (* associative list: goal no -> scrolled win *)
 542     val mutable _metasenv = []
 543     val mutable scrolledWin: GBin.scrolled_window option = None
 544       (* scrolled window to which the sequentViewer is currently attached *)
 545     val logo = (GMisc.image
 546       ~file:(MatitaMisc.image_path "matita_medium.png") ()
 547       :> GObj.widget)
 548
 549     val logo_with_qed = (GMisc.image
 550       ~file:(MatitaMisc.image_path "matita_small.png") ()
 551       :> GObj.widget)
 552
 553     method load_logo =
 554      notebook#set_show_tabs false;
 555      notebook#append_page logo
 556
 557     method load_logo_with_qed =
 558      notebook#set_show_tabs false;
 559      notebook#append_page logo_with_qed
 560
 561     method reset =
 562       cicMathView#remove_selections;
 563       (match scrolledWin with
 564       | Some w ->
 565           (* removing page from the notebook will destroy all contained widget,
 566           * we do not want the cicMathView to be destroyed as well *)
 567           w#remove cicMathView#coerce;
 568           scrolledWin <- None
 569       | None -> ());
 570       (match switch_page_callback with
 571       | Some id ->
 572           GtkSignal.disconnect notebook#as_widget id;
 573           switch_page_callback <- None
 574       | None -> ());
 575       for i = 0 to pages do notebook#remove_page 0 done;
 576       notebook#set_show_tabs true;
 577       pages <- 0;
 578       page2goal <- [];
 579       goal2page <- [];
 580       goal2win <- [];
 581       _metasenv <- [];
 582       self#script#setGoal None
 583
 584     method load_sequents { proof = (_,metasenv,_,_) as proof; stack = stack } =
 585       _metasenv <- metasenv;
 586       pages <- 0;
 587       let win goal_switch =
 588         let w =
 589           GBin.scrolled_window ~hpolicy:`AUTOMATIC ~vpolicy:`ALWAYS
 590             ~shadow_type:`IN ~show:true ()
 591         in
 592         let reparent () =
 593           scrolledWin <- Some w;
 594           match cicMathView#misc#parent with
 595           | None -> w#add cicMathView#coerce
 596           | Some parent ->
 597              let parent =
 598               match cicMathView#misc#parent with
 599                  None -> assert false
 600                | Some p -> GContainer.cast_container p
 601              in
 602               parent#remove cicMathView#coerce;
 603               w#add cicMathView#coerce
 604         in
 605         goal2win <- (goal_switch, reparent) :: goal2win;
 606         w#coerce
 607       in
 608       assert (
 609         let stack_goals = Stack.open_goals stack in
 610         let proof_goals = ProofEngineTypes.goals_of_proof proof in
 611         if
 612           HExtlib.list_uniq (List.sort Pervasives.compare stack_goals)
 613           <> List.sort Pervasives.compare proof_goals
 614         then begin
 615           prerr_endline ("STACK GOALS = " ^ String.concat " " (List.map string_of_int stack_goals));
 616           prerr_endline ("PROOF GOALS = " ^ String.concat " " (List.map string_of_int proof_goals));
 617           false
 618         end
 619         else true
 620       );
 621       let render_switch =
 622         function Stack.Open i ->`Meta i | Stack.Closed i ->`Closed (`Meta i)
 623       in
 624       let page = ref 0 in
 625       let added_goals = ref [] in
 626         (* goals can be duplicated on the tack due to focus, but we should avoid
 627          * multiple labels in the user interface *)
 628       let add_tab markup goal_switch =
 629         let goal = Stack.goal_of_switch goal_switch in
 630         if not (List.mem goal !added_goals) then begin
 631           notebook#append_page ~tab_label:(tab_label markup) (win goal_switch);
 632           page2goal <- (!page, goal_switch) :: page2goal;
 633           goal2page <- (goal_switch, !page) :: goal2page;
 634           incr page;
 635           pages <- pages + 1;
 636           added_goals := goal :: !added_goals
 637         end
 638       in
 639       let add_switch _ _ (_, sw) = add_tab (render_switch sw) sw in
 640       Stack.iter  (** populate notebook with tabs *)
 641         ~env:(fun depth tag (pos, sw) ->
 642           let markup =
 643             match depth, pos with
 644             | 0, _ -> `Current (render_switch sw)
 645             | 1, pos when Stack.head_tag stack = `BranchTag ->
 646                 `Shift (pos, render_switch sw)
 647             | _ -> render_switch sw
 648           in
 649           add_tab markup sw)
 650         ~cont:add_switch ~todo:add_switch
 651         stack;
 652       switch_page_callback <-
 653         Some (notebook#connect#switch_page ~callback:(fun page ->
 654           let goal_switch =
 655             try List.assoc page page2goal with Not_found -> assert false
 656           in
 657           self#script#setGoal (Some (goal_of_switch goal_switch));
 658           self#render_page ~page ~goal_switch))
 659
 660     method private render_page ~page ~goal_switch =
 661       (match goal_switch with
 662       | Stack.Open goal -> cicMathView#load_sequent _metasenv goal
 663       | Stack.Closed goal ->
 664           let doc = Lazy.force closed_goal_mathml in
 665           cicMathView#load_root ~root:doc#get_documentElement);
 666       (try
 667         cicMathView#set_selection None;
 668         List.assoc goal_switch goal2win ()
 669       with Not_found -> assert false)
 670
 671     method goto_sequent goal =
 672       let goal_switch, page =
 673         try
 674           List.find
 675             (function Stack.Open g, _ | Stack.Closed g, _ -> g = goal)
 676             goal2page
 677         with Not_found -> assert false
 678       in
 679       notebook#goto_page page;
 680       self#render_page page goal_switch
 681
 682   end
 683
 684  (** constructors *)
 685
 686 type 'widget constructor =
 687   ?hadjustment:GData.adjustment ->
 688   ?vadjustment:GData.adjustment ->
 689   ?font_size:int ->
 690   ?log_verbosity:int ->
 691   ?width:int ->
 692   ?height:int ->
 693   ?packing:(GObj.widget -> unit) ->
 694   ?show:bool ->
 695   unit ->
 696     'widget
 697
 698 let cicMathView ?hadjustment ?vadjustment ?font_size ?log_verbosity =
 699   GtkBase.Widget.size_params
 700     ~cont:(OgtkMathViewProps.pack_return (fun p ->
 701       OgtkMathViewProps.set_params
 702         (new cicMathView (GtkMathViewProps.MathView_GMetaDOM.create p))
 703         ~font_size ~log_verbosity))
 704     []
 705
 706 let blank_uri = BuildTimeConf.blank_uri
 707 let current_proof_uri = BuildTimeConf.current_proof_uri
 708
 709 type term_source =
 710   [ `Ast of CicNotationPt.term
 711   | `Cic of Cic.term * Cic.metasenv
 712   | `String of string
 713   ]
 714
 715 class cicBrowser_impl ~(history:MatitaTypes.mathViewer_entry MatitaMisc.history)
 716   ()
 717 =
 718   let whelp_RE = Pcre.regexp "^\\s*whelp" in
 719   let uri_RE =
 720     Pcre.regexp
 721       "^cic:/([^/]+/)*[^/]+\\.(con|ind|var)(#xpointer\\(\\d+(/\\d+)+\\))?$"
 722   in
 723   let dir_RE = Pcre.regexp "^cic:((/([^/]+/)*[^/]+(/)?)|/|)$" in
 724   let whelp_query_RE = Pcre.regexp "^\\s*whelp\\s+([^\\s]+)\\s+(.*)$" in
 725   let is_whelp txt = Pcre.pmatch ~rex:whelp_RE txt in
 726   let is_uri txt = Pcre.pmatch ~rex:uri_RE txt in
 727   let is_dir txt = Pcre.pmatch ~rex:dir_RE txt in
 728   let gui = get_gui () in
 729   let (win: MatitaGuiTypes.browserWin) = gui#newBrowserWin () in
 730   let queries = ["Locate";"Hint";"Match";"Elim";"Instance"] in
 731   let combo,_ = GEdit.combo_box_text ~strings:queries () in
 732   let activate_combo_query input q =
 733     let q' = String.lowercase q in
 734     let rec aux i = function
 735       | [] -> failwith ("Whelp query '" ^ q ^ "' not found")
 736       | h::_ when String.lowercase h = q' -> i
 737       | _::tl -> aux (i+1) tl
 738     in
 739     combo#set_active (aux 0 queries);
 740     win#queryInputText#set_text input
 741   in
 742   let set_whelp_query txt =
 743     let query, arg =
 744       try
 745         let q = Pcre.extract ~rex:whelp_query_RE txt in
 746         q.(1), q.(2)
 747       with Invalid_argument _ -> failwith "Malformed Whelp query"
 748     in
 749     activate_combo_query arg query
 750   in
 751   let toplevel = win#toplevel in
 752   let mathView = cicMathView ~packing:win#scrolledBrowser#add () in
 753   let fail message =
 754     MatitaGtkMisc.report_error ~title:"Cic browser" ~message
 755       ~parent:toplevel ()
 756   in
 757   let tags =
 758     [ "dir", GdkPixbuf.from_file (MatitaMisc.image_path "matita-folder.png");
 759       "obj", GdkPixbuf.from_file (MatitaMisc.image_path "matita-object.png") ]
 760   in
 761   let handle_error f =
 762     try
 763       f ()
 764     with exn ->
 765       if not (Helm_registry.get_bool "matita.debug") then
 766         fail (snd (MatitaExcPp.to_string exn))
 767       else raise exn
 768   in
 769   let handle_error' f = (fun () -> handle_error (fun () -> f ())) in
 770   let load_easter_egg = lazy (
 771     win#easterEggImage#set_file (MatitaMisc.image_path "meegg.png"))
 772   in
 773   object (self)
 774     inherit scriptAccessor
 775
 776     (* Whelp bar queries *)
 777
 778     initializer
 779       activate_combo_query "" "locate";
 780       win#whelpBarComboVbox#add combo#coerce;
 781       let start_query () =
 782         let query = String.lowercase (List.nth queries combo#active) in
 783         let input = win#queryInputText#text in
 784         let statement = "whelp " ^ query ^ " " ^ input ^ "." in
 785         (MatitaScript.current ())#advance ~statement ()
 786       in
 787       ignore(win#queryInputText#connect#activate ~callback:start_query);
 788       ignore(combo#connect#changed ~callback:start_query);
 789       win#whelpBarImage#set_file (MatitaMisc.image_path "whelp.png");
 790       win#mathOrListNotebook#set_show_tabs false;
 791       win#browserForwardButton#misc#set_sensitive false;
 792       win#browserBackButton#misc#set_sensitive false;
 793       ignore (win#browserUri#entry#connect#activate (handle_error' (fun () ->
 794         self#loadInput win#browserUri#entry#text)));
 795       ignore (win#browserHomeButton#connect#clicked (handle_error' (fun () ->
 796         self#load (`About `Current_proof))));
 797       ignore (win#browserRefreshButton#connect#clicked
 798         (handle_error' (self#refresh ~force:true)));
 799       ignore (win#browserBackButton#connect#clicked (handle_error' self#back));
 800       ignore (win#browserForwardButton#connect#clicked
 801         (handle_error' self#forward));
 802       ignore (win#toplevel#event#connect#delete (fun _ ->
 803         let my_id = Oo.id self in
 804         cicBrowsers := List.filter (fun b -> Oo.id b <> my_id) !cicBrowsers;
 805         if !cicBrowsers = [] &&
 806           Helm_registry.get "matita.mode" = "cicbrowser"
 807         then
 808           GMain.quit ();
 809         false));
 810       ignore(win#whelpResultTreeview#connect#row_activated
 811         ~callback:(fun _ _ ->
 812           handle_error (fun () -> self#loadInput (self#_getSelectedUri ()))));
 813       mathView#set_href_callback (Some (fun uri ->
 814         handle_error (fun () ->
 815           self#load (`Uri (UriManager.uri_of_string uri)))));
 816       self#_load (`About `Blank);
 817       toplevel#show ()
 818
 819     val mutable current_entry = `About `Blank
 820
 821     val model =
 822       new MatitaGtkMisc.taggedStringListModel tags win#whelpResultTreeview
 823
 824     val mutable lastDir = ""  (* last loaded "directory" *)
 825
 826     method mathView = (mathView :> MatitaGuiTypes.clickableMathView)
 827
 828     method private _getSelectedUri () =
 829       match model#easy_selection () with
 830       | [sel] when is_uri sel -> sel  (* absolute URI selected *)
 831 (*       | [sel] -> win#browserUri#entry#text ^ sel  |+ relative URI selected +| *)
 832       | [sel] -> lastDir ^ sel
 833       | _ -> assert false
 834
 835     (** history RATIONALE
 836      *
 837      * All operations about history are done using _historyFoo.
 838      * Only toplevel functions (ATM load and loadInput) call _historyAdd.
 839      *)
 840
 841     method private _historyAdd item =
 842       history#add item;
 843       win#browserBackButton#misc#set_sensitive true;
 844       win#browserForwardButton#misc#set_sensitive false
 845
 846     method private _historyPrev () =
 847       let item = history#previous in
 848       if history#is_begin then win#browserBackButton#misc#set_sensitive false;
 849       win#browserForwardButton#misc#set_sensitive true;
 850       item
 851
 852     method private _historyNext () =
 853       let item = history#next in
 854       if history#is_end then win#browserForwardButton#misc#set_sensitive false;
 855       win#browserBackButton#misc#set_sensitive true;
 856       item
 857
 858     (** notebook RATIONALE
 859      *
 860      * Use only these functions to switch between the tabs
 861      *)
 862     method private _showMath = win#mathOrListNotebook#goto_page 0
 863     method private _showList = win#mathOrListNotebook#goto_page 1
 864
 865     method private back () =
 866       try
 867         self#_load (self#_historyPrev ())
 868       with MatitaMisc.History_failure -> ()
 869
 870     method private forward () =
 871       try
 872         self#_load (self#_historyNext ())
 873       with MatitaMisc.History_failure -> ()
 874
 875       (* loads a uri which can be a cic uri or an about:* uri
 876       * @param uri string *)
 877     method private _load ?(force=false) entry =
 878       handle_error (fun () ->
 879        if entry <> current_entry || entry = `About `Current_proof || force then
 880         begin
 881           (match entry with
 882           | `About `Current_proof -> self#home ()
 883           | `About `Blank -> self#blank ()
 884           | `About `Us -> self#egg ()
 885           | `Check term -> self#_loadCheck term
 886           | `Cic (term, metasenv) -> self#_loadTermCic term metasenv
 887           | `Dir dir -> self#_loadDir dir
 888           | `Uri uri -> self#_loadUriManagerUri uri
 889           | `Whelp (query, results) ->
 890               set_whelp_query query;
 891               self#_loadList (List.map (fun r -> "obj",
 892                 UriManager.string_of_uri r) results));
 893           self#setEntry entry
 894         end)
 895
 896     method private blank () =
 897       self#_showMath;
 898       mathView#load_root (Lazy.force empty_mathml)#get_documentElement
 899
 900     method private _loadCheck term =
 901       failwith "not implemented _loadCheck";
 902 (*       self#_showMath *)
 903
 904     method private egg () =
 905       win#mathOrListNotebook#goto_page 2;
 906       Lazy.force load_easter_egg
 907
 908     method private home () =
 909       self#_showMath;
 910       match self#script#grafite_status.proof_status with
 911       | Proof  (uri, metasenv, bo, ty) ->
 912           let name = UriManager.name_of_uri (HExtlib.unopt uri) in
 913           let obj = Cic.CurrentProof (name, metasenv, bo, ty, [], []) in
 914           self#_loadObj obj
 915       | Incomplete_proof { proof = (uri, metasenv, bo, ty) } ->
 916           let name = UriManager.name_of_uri (HExtlib.unopt uri) in
 917           let obj = Cic.CurrentProof (name, metasenv, bo, ty, [], []) in
 918           self#_loadObj obj
 919       | _ -> self#blank ()
 920
 921       (** loads a cic uri from the environment
 922       * @param uri UriManager.uri *)
 923     method private _loadUriManagerUri uri =
 924       let uri = UriManager.strip_xpointer uri in
 925       let (obj, _) = CicEnvironment.get_obj CicUniv.empty_ugraph uri in
 926       self#_loadObj obj
 927
 928     method private _loadDir dir =
 929       let content = Http_getter.ls dir in
 930       let l =
 931         List.fast_sort
 932           Pervasives.compare
 933           (List.map
 934             (function
 935               | Http_getter_types.Ls_section s -> "dir", s
 936               | Http_getter_types.Ls_object o -> "obj", o.Http_getter_types.uri)
 937             content)
 938       in
 939       lastDir <- dir;
 940       self#_loadList l
 941
 942     method private setEntry entry =
 943       win#browserUri#entry#set_text (MatitaTypes.string_of_entry entry);
 944       current_entry <- entry
 945
 946     method private _loadObj obj =
 947       (* showMath must be done _before_ loading the document, since if the
 948        * widget is not mapped (hidden by the notebook) the document is not
 949        * rendered *)
 950       self#_showMath;
 951       mathView#load_object obj
 952
 953     method private _loadTermCic term metasenv =
 954       let context = self#script#proofContext in
 955       let dummyno = CicMkImplicit.new_meta metasenv [] in
 956       let sequent = (dummyno, context, term) in
 957       mathView#load_sequent (sequent :: metasenv) dummyno;
 958       self#_showMath
 959
 960     method private _loadList l =
 961       model#list_store#clear ();
 962       List.iter (fun (tag, s) -> model#easy_append ~tag s) l;
 963       self#_showList
 964
 965     (** { public methods, all must call _load!! } *)
 966
 967     method load entry =
 968       handle_error (fun () -> self#_load entry; self#_historyAdd entry)
 969
 970     (**  this is what the browser does when you enter a string an hit enter *)
 971     method loadInput txt =
 972       let txt = HExtlib.trim_blanks txt in
 973       let fix_uri txt =
 974         UriManager.string_of_uri
 975           (UriManager.strip_xpointer (UriManager.uri_of_string txt))
 976       in
 977       if is_whelp txt then begin
 978         set_whelp_query txt;
 979         (MatitaScript.current ())#advance ~statement:(txt ^ ".") ()
 980       end else begin
 981         let entry =
 982           match txt with
 983           | txt when is_uri txt -> `Uri (UriManager.uri_of_string (fix_uri txt))
 984           | txt when is_dir txt -> `Dir (MatitaMisc.normalize_dir txt)
 985           | txt ->
 986              (try
 987                MatitaTypes.entry_of_string txt
 988               with Invalid_argument _ ->
 989                raise
 990                 (GrafiteTypes.Command_error(sprintf "unsupported uri: %s" txt)))
 991         in
 992         self#_load entry;
 993         self#_historyAdd entry
 994       end
 995
 996       (** {2 methods accessing underlying GtkMathView} *)
 997
 998     method updateFontSize = mathView#set_font_size !current_font_size
 999
1000       (** {2 methods used by constructor only} *)
1001
1002     method win = win
1003     method history = history
1004     method currentEntry = current_entry
1005     method refresh ~force () = self#_load ~force current_entry
1006
1007   end
1008
1009 let sequentsViewer ~(notebook:GPack.notebook) ~(cicMathView:cicMathView) ():
1010   MatitaGuiTypes.sequentsViewer
1011 =
1012   new sequentsViewer ~notebook ~cicMathView ()
1013
1014 let cicBrowser () =
1015   let size = BuildTimeConf.browser_history_size in
1016   let rec aux history =
1017     let browser = new cicBrowser_impl ~history () in
1018     let win = browser#win in
1019     ignore (win#browserNewButton#connect#clicked (fun () ->
1020       let history =
1021         new MatitaMisc.browser_history ~memento:history#save size
1022           (`About `Blank)
1023       in
1024       let newBrowser = aux history in
1025       newBrowser#load browser#currentEntry));
1026 (*
1027       (* attempt (failed) to close windows on CTRL-W ... *)
1028     MatitaGtkMisc.connect_key win#browserWinEventBox#event ~modifiers:[`CONTROL]
1029       GdkKeysyms._W (fun () -> win#toplevel#destroy ());
1030 *)
1031     cicBrowsers := browser :: !cicBrowsers;
1032     (browser :> MatitaGuiTypes.cicBrowser)
1033   in
1034   let history = new MatitaMisc.browser_history size (`About `Blank) in
1035   aux history
1036
1037 let default_cicMathView () = cicMathView ~show:true ()
1038 let cicMathView_instance = MatitaMisc.singleton default_cicMathView
1039
1040 let default_sequentsViewer () =
1041   let gui = get_gui () in
1042   let cicMathView = cicMathView_instance () in
1043   sequentsViewer ~notebook:gui#main#sequentsNotebook ~cicMathView ()
1044 let sequentsViewer_instance = MatitaMisc.singleton default_sequentsViewer
1045
1046 let mathViewer () =
1047   object(self)
1048     method private get_browser reuse =
1049       if reuse then
1050         (match !cicBrowsers with
1051         | [] -> cicBrowser ()
1052         | b :: _ -> (b :> MatitaGuiTypes.cicBrowser))
1053       else
1054         (cicBrowser ())
1055
1056     method show_entry ?(reuse=false) t = (self#get_browser reuse)#load t
1057
1058     method show_uri_list ?(reuse=false) ~entry l =
1059       (self#get_browser reuse)#load entry
1060   end
1061
1062 let refresh_all_browsers () =
1063   List.iter (fun b -> b#refresh ~force:false ()) !cicBrowsers
1064
1065 let update_font_sizes () =
1066   List.iter (fun b -> b#updateFontSize) !cicBrowsers;
1067   (cicMathView_instance ())#update_font_size
1068
1069 let get_math_views () =
1070   ((cicMathView_instance ()) :> MatitaGuiTypes.clickableMathView)
1071   :: (List.map (fun b -> b#mathView) !cicBrowsers)
1072
1073 let find_selection_owner () =
1074   let rec aux =
1075     function
1076     | [] -> raise Not_found
1077     | mv :: tl ->
1078         (match mv#get_selections with
1079         | [] -> aux tl
1080         | sel :: _ -> mv)
1081   in
1082   aux (get_math_views ())
1083
1084 let has_selection () =
1085   try ignore (find_selection_owner ()); true
1086   with Not_found -> false
1087
1088 let math_view_clipboard = ref None (* associative list target -> string *)
1089 let has_clipboard () = !math_view_clipboard <> None
1090 let empty_clipboard () = math_view_clipboard := None
1091
1092 let copy_selection () =
1093   try
1094     math_view_clipboard :=
1095       Some ((find_selection_owner ())#strings_of_selection)
1096   with Not_found -> failwith "no selection"
1097
1098 let paste_clipboard paste_kind =
1099   match !math_view_clipboard with
1100   | None -> failwith "empty clipboard"
1101   | Some cb ->
1102       (try List.assoc paste_kind cb with Not_found -> assert false)
1103