helm/matita/matitaTypes.ml

   1 (* Copyright (C) 2004, 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://helm.cs.unibo.it/
  24  *)
  25
  26 exception Not_implemented of string
  27 let not_implemented feature = raise (Not_implemented feature)
  28
  29   (** exceptions whose content should be presented to the user *)
  30 exception Failure of string
  31 let error s = raise (Failure s)
  32 let warning s = prerr_endline ("MATITA WARNING:\t" ^ s)
  33 let debug_print s =
  34   if BuildTimeConf.debug then prerr_endline ("MATITA DEBUG:\t" ^ s)
  35
  36 exception No_proof  (** no current proof is available *)
  37
  38 exception Cancel
  39
  40 (*
  41 let untitled_con_uri = UriManager.uri_of_string "cic:/untitled.con"
  42 let untitled_def_uri = UriManager.uri_of_string "cic:/untitled.ind"
  43
  44 let unopt_uri ?(kind = `Con) = function
  45   | Some uri -> uri
  46   | None ->
  47       (match kind with `Con -> untitled_con_uri | `Def -> untitled_def_uri)
  48 *)
  49 let unopt_uri = function Some uri -> uri | None -> assert false
  50
  51 class type parserr =  (* "parser" is a keyword :-( *)
  52   object
  53     method parseTerm:     char Stream.t -> DisambiguateTypes.term
  54     method parseTactical: char Stream.t -> DisambiguateTypes.tactical
  55   end
  56
  57 class type disambiguator =
  58   object
  59     method parserr: parserr
  60     method setParserr: parserr -> unit
  61
  62     method env: DisambiguateTypes.environment
  63     method setEnv: DisambiguateTypes.environment -> unit
  64
  65       (* TODO Zack: as long as matita doesn't support MDI inteface,
  66       * disambiguateTerm will return a single term *)
  67       (** @param env disambiguation environment. If this parameter is given the
  68       * disambiguator act statelessly, that is internal disambiguation status
  69       * want be changed but only returned. If this parameter is not given the
  70       * internal one will be used and updated with the disambiguation status
  71       * resulting from the disambiguation *)
  72     method disambiguateTerm:
  73       ?context:Cic.context -> ?metasenv:Cic.metasenv ->
  74       ?env:DisambiguateTypes.environment ->
  75         char Stream.t ->
  76           (DisambiguateTypes.environment * Cic.metasenv * Cic.term)
  77       (** @param env @see disambiguateTerm above *)
  78     method disambiguateTermAst:
  79       ?context:Cic.context -> ?metasenv:Cic.metasenv ->
  80       ?env:DisambiguateTypes.environment ->
  81         DisambiguateTypes.term ->
  82           (DisambiguateTypes.environment * Cic.metasenv * Cic.term)
  83   end
  84
  85 (*
  86 type sequents_metadata =
  87   (int *                                  (** sequent (meta) index *)
  88     (Cic.annconjecture *                    (** annotated conjecture *)
  89     (Cic.id, Cic.term) Hashtbl.t *          (** ids_to_terms *)
  90     (Cic.id, Cic.id option) Hashtbl.t *     (** ids_to_father_ids *)
  91     (Cic.id, string) Hashtbl.t *            (** ids_to_inner_sorts *)
  92     (Cic.id, Cic.hypothesis) Hashtbl.t))    (** ids_to_hypotheses *)
  93       list
  94 type proof_metadata =
  95   Cic.annobj *                             (** annotated object    *)
  96   (Cic.id, Cic.term) Hashtbl.t *            (** ids_to_terms        *)
  97   (Cic.id, Cic.id option) Hashtbl.t *       (** ids_to_father_ids   *)
  98   (Cic.id, string) Hashtbl.t *              (** ids_to_inner_sorts  *)
  99   (Cic.id, Cic2acic.anntypes) Hashtbl.t *   (** ids_to_inner_types  *)
 100   (Cic.id, Cic.conjecture) Hashtbl.t *      (** ids_to_conjectures  *)
 101   (Cic.id, Cic.hypothesis) Hashtbl.t        (** ids_to_hypotheses   *)
 102 type hist_metadata = proof_metadata * sequents_metadata
 103 *)
 104
 105 class type proof =
 106   object
 107     inherit [unit] StatefulProofEngine.status
 108
 109     (** return a pair of "xml" (as defined in Xml module) representing the *
 110      * current proof type and body, respectively *)
 111     method toXml: Xml.token Stream.t * Xml.token Stream.t
 112     method toString: string
 113   end
 114
 115 type proof_handler =
 116   { get_proof: unit -> proof; (* return current proof or fail *)
 117     set_proof: proof option -> unit;
 118     abort_proof: unit -> unit;(* abort current proof, cleaning up garbage *)
 119     has_proof: unit -> bool;  (* check if a current proof is available or not *)
 120     new_proof: proof -> unit; (* as a set_proof but takes care also to register
 121                               observers *)
 122     quit: unit -> unit
 123   }
 124
 125   (** interpreter for toplevel phrases given via console *)
 126 class type interpreter =
 127   object
 128     method reset: unit  (** return the interpreter to the initial state *)
 129
 130       (** parse a single phrase contained in the input string. Additional
 131       * garbage at the end of the phrase is ignored
 132       * @param transparent per default the interpreter catch all exceptions ans
 133       * prints them in the console. When transparent is set to true exceptions
 134       * are flow through. Defaults to false
 135       *)
 136     method evalPhrase: ?transparent:bool -> string -> unit
 137
 138       (** offset from the starting of the last string parser by evalPhrase where
 139       * parsing stop.
 140       * @raise Failure when no offset has been recorded *)
 141     method endOffset: int
 142
 143 (*
 144       (** undo last steps phrases.
 145       * @param steps number of phrases to undo; defaults to 1 *)
 146     method undo: ?steps:int -> unit -> unit
 147 *)
 148
 149   end
 150
 151 (** {2 MathML widgets} *)
 152
 153 type mml_of_cic_sequent =
 154   Cic.metasenv -> Cic.conjecture ->
 155     Gdome.document *
 156     ((Cic.id, Cic.term) Hashtbl.t *
 157     (Cic.id, Cic.id option) Hashtbl.t *
 158     (string, Cic.hypothesis) Hashtbl.t)
 159
 160 type mml_of_cic_object =
 161   explode_all:bool -> UriManager.uri -> Cic.annobj ->
 162   (string, string) Hashtbl.t -> (string, Cic2acic.anntypes) Hashtbl.t ->
 163     Gdome.document
 164
 165 class type proof_viewer =
 166   object
 167     inherit GMathViewAux.single_selection_math_view
 168
 169     method load_proof: StatefulProofEngine.proof_status -> unit
 170   end
 171
 172 class type sequent_viewer =
 173   object
 174     inherit GMathViewAux.multi_selection_math_view
 175
 176       (** @return the list of selected terms. Selections which are not terms are
 177       * ignored *)
 178     method get_selected_terms: Cic.term list
 179
 180       (** @return the list of selected hypothese. Selections which are not
 181       * hypotheses are ignored *)
 182     method get_selected_hypotheses: Cic.hypothesis list
 183
 184       (** load a sequent and render it into parent widget *)
 185     method load_sequent: Cic.metasenv -> int -> unit
 186   end
 187
 188 class type sequents_viewer =
 189   object
 190     method reset: unit
 191     method load_sequents: Cic.metasenv -> unit
 192     method goto_sequent: int -> unit  (* to be called _after_ load_sequents *)
 193   end
 194
 195 (** {2 shorthands} *)
 196
 197 type namer = ProofEngineTypes.mk_fresh_name_type
 198
 199 type choose_uris_callback =
 200   selection_mode:[`MULTIPLE|`SINGLE] ->
 201   ?title:string -> ?msg:string -> ?nonvars_button:bool ->
 202   string list ->
 203     string list
 204
 205 type choose_interp_callback = (string * string) list list -> int list
 206