1 (* Copyright (C) 2004-2005, HELM Team.
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.
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.
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.
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,
22 * For details, see the HELM World-Wide-Web page,
23 * http://helm.cs.unibo.it/
26 val is_dir: string -> bool (** @return true if file is a directory *)
27 val is_regular: string -> bool (** @return true if file is a regular file *)
29 val input_file: string -> string (** read all the contents of file to string *)
31 (** @return true if file is a (textual) proof script *)
32 val is_proof_script: string -> bool
34 (** @return true if file is a (binary) proof object *)
35 val is_proof_object: string -> bool
37 (** given a phrase, if it doesn't end with BuildTimeConf.phrase_sep, append
39 val append_phrase_sep: string -> string
41 val strip_trailing_blanks: string -> string
44 val unopt: 'a option -> 'a
46 (** Gdome.element of a MathML document whose rendering should be blank. Used
47 * by cicBrowser to render "about:blank" document *)
48 val empty_mathml: unit -> Gdome.document
49 val empty_boxml: unit -> Gdome.document
51 exception History_failure
55 class type ['a] history =
57 method add : 'a -> unit
58 method next : 'a (** @raise History_failure *)
59 method previous : 'a (** @raise History_failure *)
60 method load: 'a memento -> unit
61 method save: 'a memento
66 (** shell like history: new items added at the end of the history
67 * @param size maximum history size *)
68 class shell_history : int -> [string] history
70 (** browser like history: new items added at the current point of the history
71 * @param size maximum history size
72 * @param first element in history (this history is never empty) *)
73 class ['a] browser_history: ?memento:'a memento -> int -> 'a -> ['a] history
75 (** create a singleton from a given function. Given function is invoked the
76 * first time it gets called. Next invocation will return first value *)
77 val singleton: (unit -> 'a) -> (unit -> 'a)
79 (** create a directory, building also parents if needed
80 * @raise Failure when unable to create some directory *)
81 val mkdir: string -> unit
83 val qualify: MatitaTypes.status -> string -> string
85 val get_proof_status: MatitaTypes.status -> ProofEngineTypes.status
86 val get_proof_metasenv: MatitaTypes.status -> Cic.metasenv
87 val get_proof_context: MatitaTypes.status -> Cic.context
88 val get_proof_aliases: MatitaTypes.status -> DisambiguateTypes.environment
90 (** given the base name of an image, returns its full path *)
91 val image_path: string -> string