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 baseuri_of_file : string -> string
28 val baseuri_of_baseuri_decl:
29 ('a, 'b, 'c, 'd, 'e) GrafiteAst.statement -> string option
31 (** check whether no objects are defined below a given baseuri *)
32 val is_empty: string -> bool
34 (** removes a file if it exists *)
35 val safe_remove: string -> unit
36 (** removes a dir if it exists and is empty *)
37 val safe_rmdir: string -> unit
38 (** checks if the dir is empty *)
39 val is_dir_empty: string -> bool
40 (** removes a directory and recursively the father (if empty) *)
41 val rmdir_descend: string -> unit
43 val absolute_path: string -> string
45 (** @return true if file is a (textual) proof script *)
46 val is_proof_script: string -> bool
48 (** @return true if file is a (binary) proof object *)
49 val is_proof_object: string -> bool
51 (** given a phrase, if it doesn't end with BuildTimeConf.phrase_sep, append
53 val append_phrase_sep: string -> string
55 val strip_trailing_slash: string -> string
56 val normalize_dir: string -> string (** add trailing "/" if missing *)
57 val strip_suffix: suffix:string -> string -> string
59 (** @return tl tail of a list starting at a given element
60 * @param eq equality to be used, defaults to physical equality (==)
62 val list_tl_at: ?equality:('a -> 'a -> bool) -> 'a -> 'a list -> 'a list
64 (** Gdome.element of a MathML document whose rendering should be blank. Used
65 * by cicBrowser to render "about:blank" document *)
66 val empty_mathml: unit -> Gdome.document
67 val empty_boxml: unit -> Gdome.document
69 exception History_failure
73 class type ['a] history =
75 method add : 'a -> unit
76 method next : 'a (** @raise History_failure *)
77 method previous : 'a (** @raise History_failure *)
78 method load: 'a memento -> unit
79 method save: 'a memento
84 (** shell like history: new items added at the end of the history
85 * @param size maximum history size *)
86 class shell_history : int -> [string] history
88 (** browser like history: new items added at the current point of the history
89 * @param size maximum history size
90 * @param first element in history (this history is never empty) *)
91 class ['a] browser_history: ?memento:'a memento -> int -> 'a -> ['a] history
93 (** create a singleton from a given function. Given function is invoked the
94 * first time it gets called. Next invocation will return first value *)
95 val singleton: (unit -> 'a) -> (unit -> 'a)
97 val qualify: MatitaTypes.status -> string -> string
99 val get_proof_status: MatitaTypes.status -> ProofEngineTypes.status
100 val get_proof_metasenv: MatitaTypes.status -> Cic.metasenv
101 val get_proof_context: MatitaTypes.status -> Cic.context
102 val get_proof_conclusion: MatitaTypes.status -> Cic.term
104 (** given the base name of an image, returns its full path *)
105 val image_path: string -> string
106 val obj_file_of_baseuri: string -> string
107 val obj_file_of_script: string -> string