helm/matita/matitaTypes.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://helm.cs.unibo.it/
  24  *)
  25
  26 open Printf
  27
  28   (** user hit the cancel button *)
  29 exception Cancel
  30
  31   (** statement invoked in the wrong context (e.g. tactic with no ongoing proof)
  32    *)
  33 exception Statement_error of string
  34 let statement_error msg = raise (Statement_error msg)
  35
  36 exception Command_error of string
  37 let command_error msg = raise (Command_error msg)
  38
  39   (** parameters are: option name, error message *)
  40 exception Option_error of string * string
  41
  42 exception Unbound_identifier of string
  43
  44 type proof_status =
  45   | No_proof
  46   | Incomplete_proof of ProofEngineTypes.status
  47   | Proof of ProofEngineTypes.proof
  48   | Intermediate of Cic.metasenv
  49       (* Status in which the proof could be while it is being processed by the
  50       * engine. No status entering/exiting the engine could be in it. *)
  51
  52 module StringMap = Map.Make (String)
  53
  54 type option_value =
  55   | String of string
  56   | Int of int
  57 type options = option_value StringMap.t
  58 let no_options = StringMap.empty
  59
  60 type status = {
  61   aliases: DisambiguateTypes.environment;   (** disambiguation aliases *)
  62   moo_content_rev: string list; (*CSC: a TacticAst.command list would be better *)
  63   proof_status: proof_status;
  64   options: options;
  65   objects: (UriManager.uri * string) list;
  66     (** in-scope objects, with their paths *)
  67 }
  68
  69 let dump_status status =
  70   MatitaLog.message "status.aliases:\n";
  71   MatitaLog.message
  72   (CicTextualParser2.EnvironmentP3.to_string status.aliases ^ "\n");
  73   MatitaLog.message "status.proof_status:";
  74   MatitaLog.message
  75     (match status.proof_status with
  76     | No_proof -> "no proof\n"
  77     | Incomplete_proof _ -> "incomplete proof\n"
  78     | Proof _ -> "proof\n"
  79     | Intermediate _ -> "Intermediate\n");
  80   MatitaLog.message "status.options\n";
  81   StringMap.iter (fun k v ->
  82     let v =
  83       match v with
  84       | String s -> s
  85       | Int i -> string_of_int i
  86     in
  87     MatitaLog.message (k ^ "::=" ^ v)) status.options;
  88   MatitaLog.message "status.coercions\n";
  89   MatitaLog.message "status.objects:\n";
  90   List.iter
  91     (fun (u,_) ->
  92       MatitaLog.message (UriManager.string_of_uri u)) status.objects
  93
  94
  95 let get_option status name =
  96   try
  97     StringMap.find name status.options
  98   with Not_found -> raise (Option_error (name, "not found"))
  99
 100 let get_string_option status name =
 101   match get_option status name with
 102   | String s -> s
 103   | _ -> raise (Option_error (name, "not a string value"))
 104
 105 let set_option status name value =
 106   let mangle_dir s =
 107     let s = Str.global_replace (Str.regexp "//+") "/" s in
 108     let s = Str.global_replace (Str.regexp "/$") "" s in
 109     s
 110   in
 111   let types =
 112     [ "baseuri", (`String, mangle_dir);
 113       "basedir", (`String, mangle_dir);
 114     ]
 115   in
 116   let ty_and_mangler =
 117     try
 118       List.assoc name types
 119     with Not_found -> command_error (sprintf "Unknown option \"%s\"" name)
 120   in
 121   let value =
 122     match ty_and_mangler with
 123     | `String, f -> String (f value)
 124     | `Int, f ->
 125         (try
 126           Int (int_of_string (f value))
 127         with Failure _ ->
 128           command_error (sprintf "Not an integer value \"%s\"" value))
 129   in
 130   if StringMap.mem name status.options && name = "baseuri" then
 131     command_error "Redefinition of 'baseuri' is forbidden."
 132   else
 133     { status with options = StringMap.add name value status.options }
 134
 135   (* subset of MatitaConsole.console methods needed by MatitaInterpreter *)
 136 class type console =
 137   object
 138     method clear : unit -> unit
 139     method echo_error : string -> unit
 140     method echo_message : string -> unit
 141     method wrap_exn : 'a. (unit -> 'a) -> 'a option
 142     method choose_uri : string list -> string
 143     method show : ?msg:string -> unit -> unit
 144   end
 145
 146 type abouts =
 147   [ `Blank
 148   | `Current_proof
 149   | `Us
 150   ]
 151
 152 type mathViewer_entry =
 153   [ `About of abouts  (* current proof *)
 154   | `Check of string (* term *)
 155   | `Cic of Cic.term * Cic.metasenv
 156   | `Dir of string (* "directory" in cic uris namespace *)
 157   | `Uri of UriManager.uri (* cic object uri *)
 158   | `Whelp of string * UriManager.uri list (* query and results *)
 159   ]
 160
 161 let string_of_entry = function
 162   | `About `Blank -> "about:blank"
 163   | `About `Current_proof -> "about:proof"
 164   | `About `Us -> "about:us"
 165   | `Check _ -> "check:"
 166   | `Cic (_, _) -> "term:"
 167   | `Dir uri -> uri
 168   | `Uri uri -> UriManager.string_of_uri uri
 169   | `Whelp (query, _) -> query
 170
 171 let entry_of_string = function
 172   | "about:blank" -> `About `Blank
 173   | "about:proof" -> `About `Current_proof
 174   | "about:us"    -> `About `Us
 175   | _ ->  (* only about entries supported ATM *)
 176       raise (Invalid_argument "entry_of_string")
 177
 178 class type mathViewer =
 179   object
 180     (** @param reuse if set reused last opened cic browser otherwise
 181      *  opens a new one. default is false
 182      *)
 183     method show_entry: ?reuse:bool -> mathViewer_entry -> unit
 184     method show_uri_list:
 185       ?reuse:bool -> entry:mathViewer_entry -> UriManager.uri list -> unit
 186   end
 187