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