helm/matita/matitaMisc.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 open MatitaTypes
  28
  29 let is_dir fname =
  30   try
  31     (Unix.stat fname).Unix.st_kind = Unix.S_DIR
  32   with Unix.Unix_error _ -> false
  33
  34 let is_regular fname =
  35   try
  36     (Unix.stat fname).Unix.st_kind = Unix.S_REG
  37   with Unix.Unix_error _ -> false
  38
  39 let input_file fname =
  40   let size = (Unix.stat fname).Unix.st_size in
  41   let buf = Buffer.create size in
  42   let ic = open_in fname in
  43   Buffer.add_channel buf ic size;
  44   close_in ic;
  45   Buffer.contents buf
  46
  47 let is_proof_script fname = true  (** TODO Zack *)
  48 let is_proof_object fname = true  (** TODO Zack *)
  49
  50 let append_phrase_sep s =
  51   if not (Pcre.pmatch ~pat:(sprintf "%s$" BuildTimeConf.phrase_sep) s) then
  52     s ^ BuildTimeConf.phrase_sep
  53   else
  54     s
  55
  56 let strip_trailing_blanks =
  57   let rex = Pcre.regexp "\\s*$" in
  58   fun s -> Pcre.replace ~rex s
  59
  60 let empty_mathml () =
  61   Misc.domImpl#createDocument ~namespaceURI:(Some Misc.mathml_ns)
  62     ~qualifiedName:(Gdome.domString "math") ~doctype:None
  63
  64 let empty_boxml () =
  65   Misc.domImpl#createDocument ~namespaceURI:(Some Misc.boxml_ns)
  66     ~qualifiedName:(Gdome.domString "box") ~doctype:None
  67
  68 exception History_failure
  69
  70 type 'a memento = 'a array * int * int * int  (* data, hd, tl, cur *)
  71
  72 class type ['a] history =
  73   object
  74     method add : 'a -> unit
  75     method next : 'a
  76     method previous : 'a
  77     method load: 'a memento -> unit
  78     method save: 'a memento
  79     method is_begin: bool
  80     method is_end: bool
  81   end
  82
  83 class basic_history (head, tail, cur) =
  84   object
  85     val mutable hd = head  (* insertion point *)
  86     val mutable tl = tail (* oldest inserted item *)
  87     val mutable cur = cur  (* current item for the history *)
  88
  89     method is_begin = cur <= tl
  90     method is_end = cur >= hd
  91   end
  92
  93
  94 class shell_history size =
  95   let size = size + 1 in
  96   let decr x = let x' = x - 1 in if x' < 0 then size + x' else x' in
  97   let incr x = (x + 1) mod size in
  98   object (self)
  99     val data = Array.create size ""
 100
 101     inherit basic_history (0, -1 , -1)
 102
 103     method add s =
 104       data.(hd) <- s;
 105       if tl = -1 then tl <- hd;
 106       hd <- incr hd;
 107       if hd = tl then tl <- incr tl;
 108       cur <- hd
 109     method previous =
 110       if cur = tl then raise History_failure;
 111       cur <- decr cur;
 112       data.(cur)
 113     method next =
 114       if cur = hd then raise History_failure;
 115       cur <- incr cur;
 116       if cur = hd then "" else data.(cur)
 117     method load (data', hd', tl', cur') =
 118       assert (Array.length data = Array.length data');
 119       hd <- hd'; tl <- tl'; cur <- cur';
 120       Array.blit data' 0 data 0 (Array.length data')
 121     method save = (Array.copy data, hd, tl, cur)
 122   end
 123
 124 class ['a] browser_history ?memento size init =
 125   object (self)
 126     initializer match memento with Some m -> self#load m | _ -> ()
 127     val data = Array.create size init
 128
 129     inherit basic_history (0, 0, 0)
 130
 131     method previous =
 132       if cur = tl then raise History_failure;
 133       cur <- cur - 1;
 134       if cur = ~-1 then cur <- size - 1;
 135       data.(cur)
 136     method next =
 137       if cur = hd then raise History_failure;
 138       cur <- cur + 1;
 139       if cur = size then cur <- 0;
 140       data.(cur)
 141     method add (e:'a) =
 142       if e <> data.(cur) then
 143         begin
 144           cur <- cur + 1;
 145           if cur = size then cur <- 0;
 146           if cur = tl then tl <- tl + 1;
 147           if tl = size then tl <- 0;
 148           hd <- cur;
 149           data.(cur) <- e
 150         end
 151     method load (data', hd', tl', cur') =
 152       assert (Array.length data = Array.length data');
 153       hd <- hd'; tl <- tl'; cur <- cur';
 154       Array.blit data' 0 data 0 (Array.length data')
 155     method save = (Array.copy data, hd, tl, cur)
 156   end
 157
 158 let singleton f =
 159   let instance = lazy (f ()) in
 160   fun () -> Lazy.force instance
 161
 162 let mkdir d =
 163   let errmsg = sprintf "Unable to create directory \"%s\"" d in
 164   try
 165     (match Unix.system ("mkdir -p " ^ d) with
 166     | Unix.WEXITED 0 -> ()
 167     | _ -> failwith errmsg)
 168   with Unix.Unix_error _ -> failwith errmsg
 169
 170 let get_proof_status status =
 171   match status.proof_status with
 172   | Incomplete_proof s -> s
 173   | _ -> statement_error "no ongoing proof"
 174
 175 let get_proof_metasenv status =
 176   match status.proof_status with
 177   | No_proof -> []
 178   | Incomplete_proof ((_, metasenv, _, _), _) -> metasenv
 179   | Proof (_, metasenv, _, _) -> metasenv
 180   | Intermediate m -> m
 181
 182 let get_proof_context status =
 183   match status.proof_status with
 184   | Incomplete_proof ((_, metasenv, _, _), goal) ->
 185       let (_, context, _) = CicUtil.lookup_meta goal metasenv in
 186       context
 187   | _ -> []
 188
 189 let get_proof_aliases status = status.aliases
 190
 191 let qualify status name = get_string_option status "baseuri" ^ "/" ^ name
 192
 193 let unopt = function None -> failwith "unopt: None" | Some v -> v
 194
 195 let image_path n = sprintf "%s/%s" BuildTimeConf.images_dir n
 196