]> matita.cs.unibo.it Git - helm.git/blob - helm/matita/matita.txt
fixed some macros, added test_abort.ma
[helm.git] / helm / matita / matita.txt
1
2 (**********************************************************************)
3
4 TODO
5 - implementare macro in matitaScript.ml (check, hint, ..) -> Gares
6 - script outline                                          -> Zack
7 - cicBrowser: riagganciare(?) resa di termini scritti
8   nella URL(??)                                           ->
9 - menu contestuale (tasto dx) nel sequent viewer          ->
10 - controllo per script modificato o meno prima di uscire  ->
11 - riattaccare hbugs (brrr...)                             -> Zack
12
13 DONE
14 - history deve aggiornare anche la whelp bar              -> Gares
15 - commenti exeguibili (forse devono essere una lista e non 
16   un singolo executable e forse devono contenere anche Note 
17   e non solo Executable)                                  -> Gares
18 - spostare il codice di creazione delle tabelle da
19   MatitaDb, al momento quelle create da matita possono
20   andare out of sync con quelle create dai file .sql      -> Gares
21 - tree update in background                               -> Gares
22 - update del getter in background                         -> Zack
23 - agganciare href_callback del sequent_viewer             -> Zack
24 - shortcut varie per script handling                      -> Zack
25 - operazioni rimanenti su script (top, bottom, jump)      -> Zack
26 - lighting-ls-getter in matita                            -> Gares
27 - riagganciare toolbar                                    -> Zack
28 - evitare che n-mila tattiche Goal siano nello script
29   (una per ogni cambio di tab)                            -> Zack
30 - implementazione comandi rimanenti in matitaEngine.ml    -> Gares
31 - sintassi per gli alias                                  -> Gares
32 - implementazione script handling (sopra engine)          -> Zack
33 - matitaSync all'indietro                                 -> Gares
34 - riagganciare GUI                                        -> Zack
35
36 (**********************************************************************)
37
38 comandi:
39  - interattivi (solo da gui)
40    - Macro/Comandi (check, print, hint, undo, locate, match)
41      potrebbero anche non avere sintassi concreta, del tipo che 
42      check e' solo un bottone che apre una finetra in cui puoi 
43      scrivere un termine o selezionarlo dalla prova corrente
44  - batch (sono gli unici che stanno nel .ma)
45    - Tattiche, theorem, alias (cambiano la prova)
46
47
48           MOUSE
49 -------------------------------------------+
50  gui (macro: hint)                         |      SHELL 
51      (disambiguatore)                      | 
52          +-----------------+---------------+-----------------------------------
53          | matita (status) |               | matitac 
54          | (log) (sync)    |    but2log    | fold ( fun s l -> engine l s) file
55          +-----------------+---------------+-----------------------------------
56          |  lingua:/sintassi concreta non ambigua delle tattiche+Qed,Thm,alias/ 
57          +----------------------------------------------------------
58          |            engine: TacticAst (cic) -> status -> status
59          |               ma non usa il campo alias dello status
60 ---------+----------------------------------------------------------
61                             ocaml                
62 --------------------------------------------------------------------
63
64
65 engine: 
66  - accetta solo linee non ambigue
67  - alias: 
68      alias ident nat = "cic:/matita/gares/nat.ind#(1/1)".
69      alias number = (natural|real|positive|integer).
70      
71
72
73 matita:
74  - mantiene uno stack di stati
75  - mantiene un log sync con gli stati
76  - offre delle api per generare la sintassi concreta che puo' servire
77    alla gui (la gui fa una chiamata a funzione e matita genera "auto."
78    cosi' la sintassi la gui non la vede mai e la tratta al massimo come un 
79    testo semplice e basta (insomma, metterei in matita il generatore di
80    sintassi concreta) but2log
81  - ha il controllo... ovvero anche la gui viene usata da matita, o per sapere 
82    la prossima azione o per chidere di scegliere il termine tra una lista
83
84  (stato :: tl) (log , (start,end) :: tl) 
85
86  +----------+
87  |          |
88  +----------+
89
90 gui:
91  - step
92  - choose
93
94 stato:
95  - alias 
96  - proof status option
97  - metadati relativi allo script per il sync
98  - settings "baseuri/url/" eccc
99  - 
100
101 alias
102  - sintassi concreta 
103
104 engine prende in input 
105  - AST di Cic (tactic ast)
106  
107 sync:
108  - presi 2 stati fa il diff e lo somma/sottrae al DB
109
110 (**********************************************************************)
111
112 script handling
113 - ad ogni script sul quale l'utente sta lavorando corrispondono
114   - un modello (vedi sotto)
115   - un buffer di testo gtk + attributi (usati principalmente per distinguere la
116     parte di testo immodificabile da quella modificabile)
117   - una lista di observer che vengono notificati ad ogni cambiamento di stato
118 - un modello di script e' composto da:
119   - una lista di stringhe (inizialmente vuota) detta "statement list". Ogni
120     elemento della lista corrisponde ad uno statement (nel senso di
121     TacticAst.statement) gia' valutato dall'engine. La parte immodificabile del
122     buffer di testo corrisponde con le stringhe contenute nella lista
123   - una lista di stati (inizialmente contenente lo stato vuoto) detta "state
124     list". Si ha l'invariante che la lunghezza di tale lista e' uguale alla
125     lunghezza della statements list + 1. Lo stato i-esimo della lista di stati
126     e' lo stato di matita _prima_ dell'esecuzione dell i-esimo statement
127   - una stringa, detta "future text", corrispondente alla parte di testo dello
128     script non ancora valutata. L'ultimo stato della state list e' lo stato
129     corrente di matita
130 - relazione tra modello e buffer di testo gtk
131   - le modifiche al testo del buffer sono possibili solo nella parta non ancora
132     valutata. Ognuna di esse viene apportata _anche_ al future text
133   - invariante: e' sempre possibile riscrivere ("redraw") l'intero contenuto del
134     buffer di testo a partire dal modello, attributi compresi
135 - oggetto script
136   - metodi
137     - new: gtk_text_buffer -> script
138     - redraw: unit (* ridisegna il contenuto del buffer di testo *)
139     - advance: ?statement:string -> unit -> unit
140         (* valuta il primo statement del future text (usando eval_statement
141         (puo' fallire con una eccezione)), rimuove il testo corrispondente dal
142         future text, aggiunge alla statement list una entry per ogni statement
143         ritornato da eval_statement, aggiunge il nuovo stato alla state list,
144         invoka tutti gli observer
145         Se c'e' l'argomento opzionale statement, quello e' il testo che viene
146         passato ad eval_statement, se ha successo nessuna rimozione dal future
147         text viene effettuata *)
148     - retract: unit -> unit
149         (* sposta l'ultimo statement della statement list al future text, toglie
150         l'ultimo stato della state list, MatitaSync.time_travel
151         ~present:ultimo_stato ~past:stato_precedente *)
152     - private eval_statement: string -> MatitaTypes.status * string list
153         (* parsa lo statement
154         - se e' un Command o un Tactical (vedi TacticAst) invoca MatitaEngine
155           passando lo stato corrente
156         - se e' una Macro la gestisce (= tutte le Macro sono implementate qua)
157           Ritorna una lista di coppie <stato, statement>. La proiezione sulla
158           prima componente rappresenta gli stati da aggiungere alla state list;
159           quella sulla seconda gli statement da aggiungere alla statement list.
160         *)
161     (* gestione degli observer *)
162     - add_observer: (MatitaTypes.status -> unit) -> observer_id
163     - remove_observer: observer_id -> unit
164     (* gestione del salvataggio *)
165     - save_to: string -> unit   (* ridisegna su file *)
166     - load_from: string -> unit
167         (* retract fino allo stato zero, nuovo stato con future text pari al
168         contenuto del file passato *)
169