]> matita.cs.unibo.it Git - helm.git/blob - helm/software/matita/matitaScript.mli
moved to pkg-ocaml-maint
[helm.git] / helm / software / 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 exception NoUnfinishedProof
27 exception ActionCancelled of string
28
29 class type script =
30 object
31
32   method locked_mark : Gtk.text_mark
33   method locked_tag : GText.tag
34   method error_tag : GText.tag
35
36   (** @return current status *)
37   method lexicon_status: LexiconEngine.status
38   method grafite_status: GrafiteTypes.status
39     
40   (** {2 Observers} *)
41
42   method addObserver :
43    (LexiconEngine.status -> GrafiteTypes.status -> unit) -> unit
44
45   (** {2 History} *)
46
47   method advance : ?statement:string -> unit -> unit
48   method retract : unit -> unit
49   method goto: [`Top | `Bottom | `Cursor] -> unit -> unit
50   method reset: unit -> unit
51   method template: unit -> unit
52
53   (** {2 Load/save} *)
54
55   method assignFileName : string -> unit (* to the current active file *)
56   method loadFromFile : string -> unit
57   method loadFromString : string -> unit
58   method saveToFile : unit -> unit
59   method filename : string
60
61   (** {2 Current proof} (if any) *)
62
63   (** @return true if there is an ongoing proof, false otherise *)
64   method onGoingProof: unit -> bool
65
66 (*   method proofStatus: ProofEngineTypes.status |+* @raise Statement_error +| *)
67   method proofMetasenv: Cic.metasenv          (** @raise Statement_error *)
68   method proofContext: Cic.context            (** @raise Statement_error *)
69   method proofConclusion: Cic.term            (** @raise Statement_error *)
70   method stack: Continuationals.Stack.t       (** @raise Statement_error *)
71
72   method setGoal: int option -> unit
73   method goal: int option
74
75   (** end of script, true if the whole script has been executed *)
76   method eos: bool
77
78   (** misc *)
79   method clean_dirty_lock: unit
80   
81   (* debug *)
82   method dump : unit -> unit
83
84 end
85
86   (** @param set_star callback used to set the modified symbol (usually a star
87    * "*") on the side of a script name *)
88 val script: 
89   source_view:GSourceView.source_view -> 
90   mathviewer: MatitaTypes.mathViewer-> 
91   urichooser: (UriManager.uri list -> UriManager.uri list) -> 
92   develcreator: (containing:string option -> unit) ->
93   ask_confirmation: 
94     (title:string -> message:string -> [`YES | `NO | `CANCEL]) -> 
95   set_star: (string -> bool -> unit) ->
96   unit -> 
97     script
98
99 (* each time script above is called an internal ref is set, instance will return
100  * the value of this ref *)
101 (* TODO Zack: orrible solution until we found a better one for having a single
102  * access point for the script *)
103 val current: unit -> script
104