]> matita.cs.unibo.it Git - helm.git/blob - helm/matita/matitaScript.mli
added utility to dump some tables of the db on mowgli
[helm.git] / helm / matita / matitaScript.mli
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 class type script =
27 object
28
29   (** @return current status *)
30   method status: MatitaTypes.status
31     
32   (** {2 Observers} *)
33
34   method addObserver : (MatitaTypes.status -> unit) -> unit
35
36   (** {2 History} *)
37
38   method advance : ?statement:string -> unit -> unit
39   method retract : unit -> unit
40   method goto: [`Top | `Bottom | `Cursor] -> unit -> unit
41   method reset: unit -> unit
42
43   (** {2 Load/save} *)
44
45   method loadFrom : string -> unit
46   method saveTo : string -> unit
47
48   (** {2 Current proof} (if any) *)
49
50   (** @return true if there is an ongoing proof, false otherise *)
51   method onGoingProof: unit -> bool
52
53   method proofStatus: ProofEngineTypes.status (** @raise Statement_error *)
54   method proofMetasenv: Cic.metasenv          (** @raise Statement_error *)
55   method proofContext: Cic.context            (** @raise Statement_error *)
56
57   method setGoal: int -> unit
58
59   (* debug *)
60   method dump : unit -> unit
61
62 end
63
64 val script: 
65   buffer:GText.buffer -> 
66   init:MatitaTypes.status -> 
67   mathviewer: MatitaTypes.mathViewer-> 
68   urichooser: (string list -> string list) -> 
69   unit -> 
70     script
71
72 (* each time script above is called an internal ref is set, instance will return
73  * the value of this ref *)
74 (* TODO Zack: orrible solution until we found a better one for having a single
75  * access point for the script *)
76 val instance: unit -> script
77