author | wenzelm |
Tue, 15 Jul 2008 11:50:04 +0200 | |
changeset 27602 | 86cf8f2493ca |
parent 27592 | 6d81c734f7af |
child 27604 | 6c347b96d941 |
permissions | -rw-r--r-- |
21642 | 1 |
(* Title: Pure/ProofGeneral/proof_general_emacs.ML |
2 |
ID: $Id$ |
|
3 |
Author: David Aspinall and Markus Wenzel |
|
4 |
||
5 |
Isabelle/Isar configuration for Emacs Proof General. |
|
26549 | 6 |
See also http://proofgeneral.inf.ed.ac.uk |
21642 | 7 |
*) |
8 |
||
9 |
signature PROOF_GENERAL = |
|
10 |
sig |
|
26549 | 11 |
val test_markupN: string |
21642 | 12 |
val init: bool -> unit |
24874 | 13 |
val init_outer_syntax: unit -> unit |
24289 | 14 |
val sendback: string -> Pretty.T list -> unit |
21642 | 15 |
end; |
16 |
||
17 |
structure ProofGeneral: PROOF_GENERAL = |
|
18 |
struct |
|
19 |
||
21945 | 20 |
|
21642 | 21 |
(* print modes *) |
22 |
||
23 |
val proof_generalN = "ProofGeneralEmacs"; (*token markup (colouring vars, etc.)*) |
|
24 |
val pgasciiN = "PGASCII"; (*plain 7-bit ASCII communication*) |
|
25 |
val thm_depsN = "thm_deps"; (*meta-information about theorem deps*) |
|
26549 | 26 |
val test_markupN = "test_markup"; (*XML markup for everything*) |
27 |
||
27592
6d81c734f7af
print_mode "test_markup": do not change prompt, otherwise Proof General will not work;
wenzelm
parents:
27591
diff
changeset
|
28 |
val _ = Markup.add_mode test_markupN (fn (name, props) => |
6d81c734f7af
print_mode "test_markup": do not change prompt, otherwise Proof General will not work;
wenzelm
parents:
27591
diff
changeset
|
29 |
if name = Markup.promptN then ("", "") else XML.output_markup (name, props)); |
21642 | 30 |
|
31 |
fun special oct = |
|
26526 | 32 |
if print_mode_active pgasciiN then Symbol.SOH ^ chr (ord (oct_char oct) - 167) |
21642 | 33 |
else oct_char oct; |
34 |
||
35 |
||
36 |
(* text output: print modes for xsymbol *) |
|
37 |
||
38 |
local |
|
39 |
||
40 |
fun xsym_output "\\" = "\\\\" |
|
41 |
| xsym_output s = if Symbol.is_raw s then Symbol.decode_raw s else s; |
|
42 |
||
43 |
fun xsymbols_output s = |
|
22590 | 44 |
if print_mode_active Symbol.xsymbolsN andalso exists_string (equal "\\") s then |
21642 | 45 |
let val syms = Symbol.explode s |
23621 | 46 |
in (implode (map xsym_output syms), Symbol.length syms) end |
47 |
else Output.default_output s; |
|
21642 | 48 |
|
49 |
in |
|
50 |
||
51 |
fun setup_xsymbols_output () = |
|
23641
d6f9d3acffaa
toplevel prompt/print_state: proper markup, removed hooks;
wenzelm
parents:
23621
diff
changeset
|
52 |
Output.add_mode Symbol.xsymbolsN xsymbols_output Symbol.encode_raw; |
21642 | 53 |
|
54 |
end; |
|
55 |
||
56 |
||
23641
d6f9d3acffaa
toplevel prompt/print_state: proper markup, removed hooks;
wenzelm
parents:
23621
diff
changeset
|
57 |
(* common markup *) |
d6f9d3acffaa
toplevel prompt/print_state: proper markup, removed hooks;
wenzelm
parents:
23621
diff
changeset
|
58 |
|
26706 | 59 |
val _ = Markup.add_mode proof_generalN (fn (name, props) => |
25630 | 60 |
let |
61 |
val (bg1, en1) = |
|
25848 | 62 |
if name = Markup.stateN then (special "366" ^ "\n", "\n" ^ special "367") |
25630 | 63 |
else if name = Markup.sendbackN then (special "376", special "377") |
64 |
else if name = Markup.hiliteN then (special "327", special "330") |
|
26706 | 65 |
else if name = Markup.classN then (special "351", special "350") |
66 |
else if name = Markup.tfreeN then (special "352", special "350") |
|
67 |
else if name = Markup.tvarN then (special "353", special "350") |
|
68 |
else if name = Markup.freeN then (special "354", special "350") |
|
69 |
else if name = Markup.boundN then (special "355", special "350") |
|
70 |
else if name = Markup.varN then (special "356", special "350") |
|
71 |
else if name = Markup.skolemN then (special "357", special "350") |
|
25630 | 72 |
else ("", ""); |
73 |
val (bg2, en2) = |
|
27592
6d81c734f7af
print_mode "test_markup": do not change prompt, otherwise Proof General will not work;
wenzelm
parents:
27591
diff
changeset
|
74 |
if name <> Markup.promptN andalso print_mode_active test_markupN |
26542 | 75 |
then XML.output_markup (name, props) |
25630 | 76 |
else ("", ""); |
26706 | 77 |
in (bg1 ^ bg2, en2 ^ en1) end); |
23641
d6f9d3acffaa
toplevel prompt/print_state: proper markup, removed hooks;
wenzelm
parents:
23621
diff
changeset
|
78 |
|
d6f9d3acffaa
toplevel prompt/print_state: proper markup, removed hooks;
wenzelm
parents:
23621
diff
changeset
|
79 |
|
21642 | 80 |
(* messages and notification *) |
81 |
||
82 |
fun decorate bg en prfx = |
|
22590 | 83 |
Output.writeln_default o enclose bg en o prefix_lines prfx; |
21642 | 84 |
|
85 |
fun setup_messages () = |
|
23662 | 86 |
(Output.writeln_fn := Output.writeln_default; |
22590 | 87 |
Output.priority_fn := (fn s => decorate (special "360") (special "361") "" s); |
88 |
Output.tracing_fn := (fn s => decorate (special "360" ^ special "375") (special "361") "" s); |
|
89 |
Output.debug_fn := (fn s => decorate (special "362") (special "363") "+++ " s); |
|
90 |
Output.warning_fn := (fn s => decorate (special "362") (special "363") "### " s); |
|
25848 | 91 |
Output.error_fn := (fn s => decorate (special "364") (special "365") "*** " s); |
92 |
Output.prompt_fn := (fn s => Output.std_output (s ^ special "372"))); |
|
21642 | 93 |
|
22699
938c1011ac94
removed unused Output.panic hook -- internal to PG wrapper;
wenzelm
parents:
22678
diff
changeset
|
94 |
fun panic s = |
938c1011ac94
removed unused Output.panic hook -- internal to PG wrapper;
wenzelm
parents:
22678
diff
changeset
|
95 |
(decorate (special "364") (special "365") "!!! " ("## SYSTEM EXIT ##\n" ^ s); exit 1); |
21642 | 96 |
|
97 |
fun emacs_notify s = decorate (special "360") (special "361") "" s; |
|
98 |
||
99 |
fun tell_clear_goals () = |
|
21940 | 100 |
emacs_notify "Proof General, please clear the goals buffer."; |
21642 | 101 |
|
102 |
fun tell_clear_response () = |
|
21940 | 103 |
emacs_notify "Proof General, please clear the response buffer."; |
21642 | 104 |
|
105 |
fun tell_file_loaded path = |
|
21940 | 106 |
emacs_notify ("Proof General, this file is loaded: " ^ quote (File.platform_path path)); |
21642 | 107 |
|
108 |
fun tell_file_retracted path = |
|
21940 | 109 |
emacs_notify ("Proof General, you can unlock the file " ^ quote (File.platform_path path)); |
21642 | 110 |
|
24289 | 111 |
fun sendback heading prts = |
112 |
Pretty.writeln (Pretty.big_list heading [Pretty.markup Markup.sendback prts]); |
|
113 |
||
21642 | 114 |
|
115 |
(* theory loader actions *) |
|
116 |
||
117 |
local |
|
118 |
||
119 |
fun trace_action action name = |
|
120 |
if action = ThyInfo.Update then |
|
121 |
List.app tell_file_loaded (ThyInfo.loaded_files name) |
|
122 |
else if action = ThyInfo.Outdate orelse action = ThyInfo.Remove then |
|
123 |
List.app tell_file_retracted (ThyInfo.loaded_files name) |
|
124 |
else (); |
|
125 |
||
126 |
in |
|
127 |
fun setup_thy_loader () = ThyInfo.add_hook trace_action; |
|
26613 | 128 |
fun sync_thy_loader () = List.app (trace_action ThyInfo.Update) (ThyInfo.get_names ()); |
21642 | 129 |
end; |
130 |
||
131 |
||
21948 | 132 |
(* get informed about files *) |
21642 | 133 |
|
25442 | 134 |
(*liberal low-level version*) |
135 |
val thy_name = perhaps (try (unsuffix ".thy")) o List.last o space_explode "/"; |
|
136 |
||
137 |
val inform_file_retracted = ThyInfo.if_known_thy ThyInfo.remove_thy o thy_name; |
|
138 |
||
27577
7c7a9a343ca5
proper_inform_file_processed: new implementation based on global Isar state (cf. isar.ML);
wenzelm
parents:
27537
diff
changeset
|
139 |
fun inform_file_processed file = |
7c7a9a343ca5
proper_inform_file_processed: new implementation based on global Isar state (cf. isar.ML);
wenzelm
parents:
27537
diff
changeset
|
140 |
let |
7c7a9a343ca5
proper_inform_file_processed: new implementation based on global Isar state (cf. isar.ML);
wenzelm
parents:
27537
diff
changeset
|
141 |
val name = thy_name file; |
7c7a9a343ca5
proper_inform_file_processed: new implementation based on global Isar state (cf. isar.ML);
wenzelm
parents:
27537
diff
changeset
|
142 |
val _ = name = "" andalso error ("Bad file name: " ^ quote file); |
7c7a9a343ca5
proper_inform_file_processed: new implementation based on global Isar state (cf. isar.ML);
wenzelm
parents:
27537
diff
changeset
|
143 |
val _ = |
7c7a9a343ca5
proper_inform_file_processed: new implementation based on global Isar state (cf. isar.ML);
wenzelm
parents:
27537
diff
changeset
|
144 |
if ThyInfo.check_known_thy name then |
27602 | 145 |
(Isar.>> Toplevel.commit_exit; ThyInfo.touch_child_thys name; ThyInfo.register_thy name) |
27585
2234ace5b538
inform_file_processed: try harder not to fail, ensure
wenzelm
parents:
27577
diff
changeset
|
146 |
handle ERROR msg => |
27591 | 147 |
(warning (cat_lines ["Failed to register theory: " ^ quote name, msg]); |
27585
2234ace5b538
inform_file_processed: try harder not to fail, ensure
wenzelm
parents:
27577
diff
changeset
|
148 |
tell_file_retracted (ThyLoad.thy_path name)) |
27577
7c7a9a343ca5
proper_inform_file_processed: new implementation based on global Isar state (cf. isar.ML);
wenzelm
parents:
27537
diff
changeset
|
149 |
else (); |
27589 | 150 |
val _ = Isar.init_point (); |
27577
7c7a9a343ca5
proper_inform_file_processed: new implementation based on global Isar state (cf. isar.ML);
wenzelm
parents:
27537
diff
changeset
|
151 |
in () end; |
21642 | 152 |
|
153 |
||
154 |
(* restart top-level loop (keeps most state information) *) |
|
155 |
||
156 |
val welcome = priority o Session.welcome; |
|
157 |
||
158 |
fun restart () = |
|
21940 | 159 |
(sync_thy_loader (); |
160 |
tell_clear_goals (); |
|
161 |
tell_clear_response (); |
|
27537 | 162 |
Isar.init_point (); |
27577
7c7a9a343ca5
proper_inform_file_processed: new implementation based on global Isar state (cf. isar.ML);
wenzelm
parents:
27537
diff
changeset
|
163 |
welcome ()); |
21642 | 164 |
|
165 |
||
166 |
(* theorem dependency output *) |
|
167 |
||
168 |
local |
|
169 |
||
170 |
val spaces_quote = space_implode " " o map quote; |
|
171 |
||
172 |
fun thm_deps_message (thms, deps) = |
|
21948 | 173 |
emacs_notify ("Proof General, theorem dependencies of " ^ thms ^ " are " ^ deps); |
21642 | 174 |
|
21968 | 175 |
fun tell_thm_deps ths = |
22590 | 176 |
if print_mode_active thm_depsN then |
21968 | 177 |
let |
22228
7c27195a4afc
proper use of PureThy.has_name_hint instead of hard-wired string'';
wenzelm
parents:
22225
diff
changeset
|
178 |
val names = map PureThy.get_name_hint (filter PureThy.has_name_hint ths); |
22225 | 179 |
val deps = Symtab.keys (fold Proofterm.thms_of_proof' |
180 |
(map Thm.proof_of ths) Symtab.empty); |
|
21968 | 181 |
in |
182 |
if null names orelse null deps then () |
|
183 |
else thm_deps_message (spaces_quote names, spaces_quote deps) |
|
184 |
end |
|
185 |
else (); |
|
21642 | 186 |
|
187 |
in |
|
188 |
||
189 |
fun setup_present_hook () = |
|
190 |
Present.add_hook (fn _ => fn res => tell_thm_deps (maps #2 res)); |
|
191 |
||
192 |
end; |
|
193 |
||
194 |
||
195 |
(* additional outer syntax for Isar *) |
|
196 |
||
197 |
local structure P = OuterParse and K = OuterKeyword in |
|
198 |
||
25192
b568f8c5d5ca
made command 'undo' silent ('ProofGeneral.undo' becomes a historical relic);
wenzelm
parents:
24882
diff
changeset
|
199 |
fun undoP () = (*undo without output -- historical*) |
21642 | 200 |
OuterSyntax.improper_command "ProofGeneral.undo" "(internal)" K.control |
27535 | 201 |
(Scan.succeed (Toplevel.no_timing o Toplevel.imperative (fn () => Isar.undo 1))); |
21642 | 202 |
|
24867 | 203 |
fun restartP () = |
21642 | 204 |
OuterSyntax.improper_command "ProofGeneral.restart" "(internal)" K.control |
205 |
(P.opt_unit >> (Toplevel.no_timing oo K (Toplevel.imperative restart))); |
|
206 |
||
24867 | 207 |
fun kill_proofP () = |
21642 | 208 |
OuterSyntax.improper_command "ProofGeneral.kill_proof" "(internal)" K.control |
27532 | 209 |
(Scan.succeed (Toplevel.no_timing o |
210 |
Toplevel.imperative (fn () => (Isar.kill_proof (); tell_clear_goals ())))); |
|
211 |
||
24867 | 212 |
fun inform_file_processedP () = |
21642 | 213 |
OuterSyntax.improper_command "ProofGeneral.inform_file_processed" "(internal)" K.control |
27577
7c7a9a343ca5
proper_inform_file_processed: new implementation based on global Isar state (cf. isar.ML);
wenzelm
parents:
27537
diff
changeset
|
214 |
(P.name >> (fn file => |
7c7a9a343ca5
proper_inform_file_processed: new implementation based on global Isar state (cf. isar.ML);
wenzelm
parents:
27537
diff
changeset
|
215 |
Toplevel.no_timing o Toplevel.imperative (fn () => inform_file_processed file))); |
21642 | 216 |
|
24867 | 217 |
fun inform_file_retractedP () = |
21642 | 218 |
OuterSyntax.improper_command "ProofGeneral.inform_file_retracted" "(internal)" K.control |
219 |
(P.name >> (Toplevel.no_timing oo |
|
220 |
(fn file => Toplevel.imperative (fn () => inform_file_retracted file)))); |
|
221 |
||
24867 | 222 |
fun process_pgipP () = |
21642 | 223 |
OuterSyntax.improper_command "ProofGeneral.process_pgip" "(internal)" K.control |
224 |
(P.text >> (Toplevel.no_timing oo |
|
225 |
(fn txt => Toplevel.imperative (fn () => ProofGeneralPgip.process_pgip txt)))); |
|
226 |
||
24867 | 227 |
fun init_outer_syntax () = List.app (fn f => f ()) |
27535 | 228 |
[undoP, restartP, kill_proofP, inform_file_processedP, inform_file_retractedP, process_pgipP]; |
21642 | 229 |
|
230 |
end; |
|
231 |
||
232 |
||
233 |
(* init *) |
|
234 |
||
235 |
val initialized = ref false; |
|
236 |
||
22699
938c1011ac94
removed unused Output.panic hook -- internal to PG wrapper;
wenzelm
parents:
22678
diff
changeset
|
237 |
fun init false = panic "No Proof General interface support for Isabelle/classic mode." |
21940 | 238 |
| init true = |
21968 | 239 |
(! initialized orelse |
22590 | 240 |
(Output.no_warnings init_outer_syntax (); |
21968 | 241 |
setup_xsymbols_output (); |
242 |
setup_messages (); |
|
22590 | 243 |
ProofGeneralPgip.init_pgip_channel (! Output.priority_fn); |
21968 | 244 |
setup_thy_loader (); |
245 |
setup_present_hook (); |
|
246 |
set initialized); |
|
247 |
sync_thy_loader (); |
|
25749 | 248 |
change print_mode (update (op =) proof_generalN); |
26643 | 249 |
Isar.toplevel_loop {init = true, welcome = true, sync = true, secure = Secure.is_secure ()}); |
21642 | 250 |
|
251 |
end; |