author | wenzelm |
Sat, 06 Oct 2007 16:50:04 +0200 | |
changeset 24867 | e5b55d7be9bb |
parent 24712 | 64ed05609568 |
child 24873 | 9de439f51e3c |
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. |
|
6 |
See http://proofgeneral.inf.ed.ac.uk |
|
7 |
*) |
|
8 |
||
9 |
signature PROOF_GENERAL = |
|
10 |
sig |
|
11 |
val init: bool -> unit |
|
24289 | 12 |
val sendback: string -> Pretty.T list -> unit |
21642 | 13 |
val write_keywords: string -> unit |
14 |
end; |
|
15 |
||
16 |
structure ProofGeneral: PROOF_GENERAL = |
|
17 |
struct |
|
18 |
||
21945 | 19 |
|
21642 | 20 |
(* print modes *) |
21 |
||
22 |
val proof_generalN = "ProofGeneralEmacs"; (*token markup (colouring vars, etc.)*) |
|
23 |
val pgasciiN = "PGASCII"; (*plain 7-bit ASCII communication*) |
|
24 |
val thm_depsN = "thm_deps"; (*meta-information about theorem deps*) |
|
25 |
||
26 |
fun special oct = |
|
22590 | 27 |
if print_mode_active pgasciiN then chr 1 ^ chr (ord (oct_char oct) - 167) |
21642 | 28 |
else oct_char oct; |
29 |
||
30 |
||
31 |
(* text output: print modes for xsymbol *) |
|
32 |
||
33 |
local |
|
34 |
||
35 |
fun xsym_output "\\" = "\\\\" |
|
36 |
| xsym_output s = if Symbol.is_raw s then Symbol.decode_raw s else s; |
|
37 |
||
38 |
fun xsymbols_output s = |
|
22590 | 39 |
if print_mode_active Symbol.xsymbolsN andalso exists_string (equal "\\") s then |
21642 | 40 |
let val syms = Symbol.explode s |
23621 | 41 |
in (implode (map xsym_output syms), Symbol.length syms) end |
42 |
else Output.default_output s; |
|
21642 | 43 |
|
44 |
in |
|
45 |
||
46 |
fun setup_xsymbols_output () = |
|
23641
d6f9d3acffaa
toplevel prompt/print_state: proper markup, removed hooks;
wenzelm
parents:
23621
diff
changeset
|
47 |
Output.add_mode Symbol.xsymbolsN xsymbols_output Symbol.encode_raw; |
21642 | 48 |
|
49 |
end; |
|
50 |
||
51 |
||
52 |
(* token translations *) |
|
53 |
||
54 |
local |
|
55 |
||
56 |
fun end_tag () = special "350"; |
|
57 |
val class_tag = ("class", fn () => special "351"); |
|
58 |
val tfree_tag = ("tfree", fn () => special "352"); |
|
59 |
val tvar_tag = ("tvar", fn () => special "353"); |
|
60 |
val free_tag = ("free", fn () => special "354"); |
|
61 |
val bound_tag = ("bound", fn () => special "355"); |
|
62 |
val var_tag = ("var", fn () => special "356"); |
|
63 |
val skolem_tag = ("skolem", fn () => special "357"); |
|
64 |
||
65 |
fun xml_atom kind x = XML.element "atom" [("kind", kind)] [XML.text x]; |
|
66 |
||
67 |
fun tagit (kind, bg_tag) x = |
|
23621 | 68 |
(bg_tag () ^ x ^ end_tag (), Symbol.length (Symbol.explode x)); |
21642 | 69 |
|
70 |
fun free_or_skolem x = |
|
71 |
(case try Name.dest_skolem x of |
|
72 |
NONE => tagit free_tag x |
|
73 |
| SOME x' => tagit skolem_tag x'); |
|
74 |
||
75 |
fun var_or_skolem s = |
|
24244 | 76 |
(case Lexicon.read_variable s of |
21642 | 77 |
SOME (x, i) => |
78 |
(case try Name.dest_skolem x of |
|
79 |
NONE => tagit var_tag s |
|
80 |
| SOME x' => tagit skolem_tag |
|
22678 | 81 |
(setmp show_question_marks true Term.string_of_vname (x', i))) |
21642 | 82 |
| NONE => tagit var_tag s); |
83 |
||
84 |
val proof_general_trans = |
|
85 |
Syntax.tokentrans_mode proof_generalN |
|
86 |
[("class", tagit class_tag), |
|
87 |
("tfree", tagit tfree_tag), |
|
88 |
("tvar", tagit tvar_tag), |
|
89 |
("free", free_or_skolem), |
|
90 |
("bound", tagit bound_tag), |
|
91 |
("var", var_or_skolem)]; |
|
92 |
||
93 |
in |
|
94 |
||
24712
64ed05609568
proper Sign operations instead of Theory aliases;
wenzelm
parents:
24555
diff
changeset
|
95 |
val _ = Context.add_setup (Sign.add_tokentrfuns proof_general_trans); |
21642 | 96 |
|
97 |
end; |
|
98 |
||
99 |
||
23641
d6f9d3acffaa
toplevel prompt/print_state: proper markup, removed hooks;
wenzelm
parents:
23621
diff
changeset
|
100 |
(* common markup *) |
d6f9d3acffaa
toplevel prompt/print_state: proper markup, removed hooks;
wenzelm
parents:
23621
diff
changeset
|
101 |
|
d6f9d3acffaa
toplevel prompt/print_state: proper markup, removed hooks;
wenzelm
parents:
23621
diff
changeset
|
102 |
fun proof_general_markup (name, props) = |
d6f9d3acffaa
toplevel prompt/print_state: proper markup, removed hooks;
wenzelm
parents:
23621
diff
changeset
|
103 |
(if name = Markup.promptN then ("", special "372") |
23702 | 104 |
else if name = Markup.stateN then (special "366" ^ "\n", "\n" ^ special "367") |
24330 | 105 |
else if name = Markup.sendbackN then (special "376", special "377") |
24555 | 106 |
else if name = Markup.hiliteN then (special "327", special "330") |
23641
d6f9d3acffaa
toplevel prompt/print_state: proper markup, removed hooks;
wenzelm
parents:
23621
diff
changeset
|
107 |
else ("", "")) |
d6f9d3acffaa
toplevel prompt/print_state: proper markup, removed hooks;
wenzelm
parents:
23621
diff
changeset
|
108 |
|> (name <> Markup.promptN andalso print_mode_active "test_markup") ? |
d6f9d3acffaa
toplevel prompt/print_state: proper markup, removed hooks;
wenzelm
parents:
23621
diff
changeset
|
109 |
(fn (bg, en) => |
d6f9d3acffaa
toplevel prompt/print_state: proper markup, removed hooks;
wenzelm
parents:
23621
diff
changeset
|
110 |
(bg ^ enclose "<" ">" (space_implode " " (name :: map XML.attribute props)), |
d6f9d3acffaa
toplevel prompt/print_state: proper markup, removed hooks;
wenzelm
parents:
23621
diff
changeset
|
111 |
enclose "</" ">" name ^ en)); |
d6f9d3acffaa
toplevel prompt/print_state: proper markup, removed hooks;
wenzelm
parents:
23621
diff
changeset
|
112 |
|
23702 | 113 |
val _ = Markup.add_mode proof_generalN proof_general_markup; |
23641
d6f9d3acffaa
toplevel prompt/print_state: proper markup, removed hooks;
wenzelm
parents:
23621
diff
changeset
|
114 |
|
d6f9d3acffaa
toplevel prompt/print_state: proper markup, removed hooks;
wenzelm
parents:
23621
diff
changeset
|
115 |
|
21642 | 116 |
(* messages and notification *) |
117 |
||
118 |
fun decorate bg en prfx = |
|
22590 | 119 |
Output.writeln_default o enclose bg en o prefix_lines prfx; |
21642 | 120 |
|
121 |
fun setup_messages () = |
|
23662 | 122 |
(Output.writeln_fn := Output.writeln_default; |
22590 | 123 |
Output.priority_fn := (fn s => decorate (special "360") (special "361") "" s); |
124 |
Output.tracing_fn := (fn s => decorate (special "360" ^ special "375") (special "361") "" s); |
|
125 |
Output.debug_fn := (fn s => decorate (special "362") (special "363") "+++ " s); |
|
126 |
Output.warning_fn := (fn s => decorate (special "362") (special "363") "### " s); |
|
22699
938c1011ac94
removed unused Output.panic hook -- internal to PG wrapper;
wenzelm
parents:
22678
diff
changeset
|
127 |
Output.error_fn := (fn s => decorate (special "364") (special "365") "*** " s)); |
21642 | 128 |
|
22699
938c1011ac94
removed unused Output.panic hook -- internal to PG wrapper;
wenzelm
parents:
22678
diff
changeset
|
129 |
fun panic s = |
938c1011ac94
removed unused Output.panic hook -- internal to PG wrapper;
wenzelm
parents:
22678
diff
changeset
|
130 |
(decorate (special "364") (special "365") "!!! " ("## SYSTEM EXIT ##\n" ^ s); exit 1); |
21642 | 131 |
|
132 |
fun emacs_notify s = decorate (special "360") (special "361") "" s; |
|
133 |
||
134 |
fun tell_clear_goals () = |
|
21940 | 135 |
emacs_notify "Proof General, please clear the goals buffer."; |
21642 | 136 |
|
137 |
fun tell_clear_response () = |
|
21940 | 138 |
emacs_notify "Proof General, please clear the response buffer."; |
21642 | 139 |
|
140 |
fun tell_file_loaded path = |
|
21940 | 141 |
emacs_notify ("Proof General, this file is loaded: " ^ quote (File.platform_path path)); |
21642 | 142 |
|
143 |
fun tell_file_retracted path = |
|
21940 | 144 |
emacs_notify ("Proof General, you can unlock the file " ^ quote (File.platform_path path)); |
21642 | 145 |
|
24289 | 146 |
fun sendback heading prts = |
147 |
Pretty.writeln (Pretty.big_list heading [Pretty.markup Markup.sendback prts]); |
|
148 |
||
21642 | 149 |
|
150 |
(* theory loader actions *) |
|
151 |
||
152 |
local |
|
153 |
||
154 |
fun trace_action action name = |
|
155 |
if action = ThyInfo.Update then |
|
156 |
List.app tell_file_loaded (ThyInfo.loaded_files name) |
|
157 |
else if action = ThyInfo.Outdate orelse action = ThyInfo.Remove then |
|
158 |
List.app tell_file_retracted (ThyInfo.loaded_files name) |
|
159 |
else (); |
|
160 |
||
161 |
in |
|
162 |
fun setup_thy_loader () = ThyInfo.add_hook trace_action; |
|
163 |
fun sync_thy_loader () = List.app (trace_action ThyInfo.Update) (ThyInfo.names ()); |
|
164 |
end; |
|
165 |
||
166 |
||
21948 | 167 |
(* get informed about files *) |
21642 | 168 |
|
21858
05f57309170c
avoid conflict with Alice keywords: renamed pack -> implode, unpack -> explode, any -> many, avoided assert;
wenzelm
parents:
21649
diff
changeset
|
169 |
val thy_name = Path.implode o #1 o Path.split_ext o Path.base o Path.explode; |
21642 | 170 |
|
171 |
val inform_file_retracted = ThyInfo.if_known_thy ThyInfo.remove_thy o thy_name; |
|
172 |
val inform_file_processed = ThyInfo.if_known_thy ThyInfo.touch_child_thys o thy_name; |
|
173 |
||
23913 | 174 |
fun proper_inform_file_processed file () = |
21642 | 175 |
let val name = thy_name file in |
23913 | 176 |
if ThyInfo.known_thy name then |
21642 | 177 |
(ThyInfo.touch_child_thys name; |
24079 | 178 |
ThyInfo.register_thy name handle ERROR msg => |
23913 | 179 |
(warning (cat_lines [msg, "Failed to register theory: " ^ quote name]); |
21858
05f57309170c
avoid conflict with Alice keywords: renamed pack -> implode, unpack -> explode, any -> many, avoided assert;
wenzelm
parents:
21649
diff
changeset
|
180 |
tell_file_retracted (Path.base (Path.explode file)))) |
21642 | 181 |
else raise Toplevel.UNDEF |
182 |
end; |
|
183 |
||
23913 | 184 |
fun vacuous_inform_file_processed file () = |
21642 | 185 |
(warning ("No theory " ^ quote (thy_name file)); |
21858
05f57309170c
avoid conflict with Alice keywords: renamed pack -> implode, unpack -> explode, any -> many, avoided assert;
wenzelm
parents:
21649
diff
changeset
|
186 |
tell_file_retracted (Path.base (Path.explode file))); |
21642 | 187 |
|
188 |
||
189 |
(* restart top-level loop (keeps most state information) *) |
|
190 |
||
191 |
val welcome = priority o Session.welcome; |
|
192 |
||
193 |
fun restart () = |
|
21940 | 194 |
(sync_thy_loader (); |
195 |
tell_clear_goals (); |
|
196 |
tell_clear_response (); |
|
197 |
welcome (); |
|
198 |
raise Toplevel.RESTART); |
|
21642 | 199 |
|
200 |
||
201 |
(* theorem dependency output *) |
|
202 |
||
203 |
local |
|
204 |
||
205 |
val spaces_quote = space_implode " " o map quote; |
|
206 |
||
207 |
fun thm_deps_message (thms, deps) = |
|
21948 | 208 |
emacs_notify ("Proof General, theorem dependencies of " ^ thms ^ " are " ^ deps); |
21642 | 209 |
|
21968 | 210 |
fun tell_thm_deps ths = |
22590 | 211 |
if print_mode_active thm_depsN then |
21968 | 212 |
let |
22228
7c27195a4afc
proper use of PureThy.has_name_hint instead of hard-wired string'';
wenzelm
parents:
22225
diff
changeset
|
213 |
val names = map PureThy.get_name_hint (filter PureThy.has_name_hint ths); |
22225 | 214 |
val deps = Symtab.keys (fold Proofterm.thms_of_proof' |
215 |
(map Thm.proof_of ths) Symtab.empty); |
|
21968 | 216 |
in |
217 |
if null names orelse null deps then () |
|
218 |
else thm_deps_message (spaces_quote names, spaces_quote deps) |
|
219 |
end |
|
220 |
else (); |
|
21642 | 221 |
|
222 |
in |
|
223 |
||
224 |
fun setup_present_hook () = |
|
225 |
Present.add_hook (fn _ => fn res => tell_thm_deps (maps #2 res)); |
|
226 |
||
227 |
end; |
|
228 |
||
229 |
||
230 |
(* additional outer syntax for Isar *) |
|
231 |
||
232 |
local structure P = OuterParse and K = OuterKeyword in |
|
233 |
||
24867 | 234 |
fun undoP () = (*undo without output*) |
21642 | 235 |
OuterSyntax.improper_command "ProofGeneral.undo" "(internal)" K.control |
236 |
(Scan.succeed (Toplevel.no_timing o IsarCmd.undo)); |
|
237 |
||
24867 | 238 |
fun restartP () = |
21642 | 239 |
OuterSyntax.improper_command "ProofGeneral.restart" "(internal)" K.control |
240 |
(P.opt_unit >> (Toplevel.no_timing oo K (Toplevel.imperative restart))); |
|
241 |
||
24867 | 242 |
fun kill_proofP () = |
21642 | 243 |
OuterSyntax.improper_command "ProofGeneral.kill_proof" "(internal)" K.control |
244 |
(Scan.succeed (Toplevel.no_timing o IsarCmd.kill_proof_notify tell_clear_goals)); |
|
245 |
||
24867 | 246 |
fun inform_file_processedP () = |
21642 | 247 |
OuterSyntax.improper_command "ProofGeneral.inform_file_processed" "(internal)" K.control |
248 |
(P.name >> (fn file => Toplevel.no_timing o |
|
21959 | 249 |
Toplevel.init_empty (vacuous_inform_file_processed file) o |
21642 | 250 |
Toplevel.kill o |
21959 | 251 |
Toplevel.init_empty (proper_inform_file_processed file))); |
21642 | 252 |
|
24867 | 253 |
fun inform_file_retractedP () = |
21642 | 254 |
OuterSyntax.improper_command "ProofGeneral.inform_file_retracted" "(internal)" K.control |
255 |
(P.name >> (Toplevel.no_timing oo |
|
256 |
(fn file => Toplevel.imperative (fn () => inform_file_retracted file)))); |
|
257 |
||
24867 | 258 |
fun process_pgipP () = |
21642 | 259 |
OuterSyntax.improper_command "ProofGeneral.process_pgip" "(internal)" K.control |
260 |
(P.text >> (Toplevel.no_timing oo |
|
261 |
(fn txt => Toplevel.imperative (fn () => ProofGeneralPgip.process_pgip txt)))); |
|
262 |
||
24867 | 263 |
fun init_outer_syntax () = List.app (fn f => f ()) |
21948 | 264 |
[undoP, restartP, kill_proofP, inform_file_processedP, inform_file_retractedP, process_pgipP]; |
21642 | 265 |
|
266 |
end; |
|
267 |
||
268 |
||
269 |
(* init *) |
|
270 |
||
271 |
val initialized = ref false; |
|
272 |
||
22699
938c1011ac94
removed unused Output.panic hook -- internal to PG wrapper;
wenzelm
parents:
22678
diff
changeset
|
273 |
fun init false = panic "No Proof General interface support for Isabelle/classic mode." |
21940 | 274 |
| init true = |
21968 | 275 |
(! initialized orelse |
22590 | 276 |
(Output.no_warnings init_outer_syntax (); |
21968 | 277 |
setup_xsymbols_output (); |
278 |
setup_messages (); |
|
22590 | 279 |
ProofGeneralPgip.init_pgip_channel (! Output.priority_fn); |
21968 | 280 |
setup_thy_loader (); |
281 |
setup_present_hook (); |
|
282 |
set initialized); |
|
283 |
sync_thy_loader (); |
|
284 |
change print_mode (cons proof_generalN o remove (op =) proof_generalN); |
|
285 |
Isar.sync_main ()); |
|
21642 | 286 |
|
287 |
||
288 |
||
21968 | 289 |
(** generate elisp file for keyword classification **) |
21642 | 290 |
|
291 |
local |
|
292 |
||
293 |
val regexp_meta = member (op =) (explode ".*+?[]^$"); |
|
21940 | 294 |
val regexp_quote = translate_string (fn c => if regexp_meta c then "\\\\" ^ c else c); |
21642 | 295 |
|
296 |
fun defconst name strs = |
|
297 |
"\n(defconst isar-keywords-" ^ name ^ |
|
298 |
"\n '(" ^ space_implode "\n " (map (quote o regexp_quote) strs) ^ "))\n"; |
|
299 |
||
300 |
fun make_elisp_commands commands kind = defconst kind |
|
301 |
(commands |> map_filter (fn (c, _, k, _) => if k = kind then SOME c else NONE)); |
|
302 |
||
303 |
fun make_elisp_syntax (keywords, commands) = |
|
304 |
";;\n\ |
|
305 |
\;; Keyword classification tables for Isabelle/Isar.\n\ |
|
306 |
\;; This file was generated by " ^ Session.name () ^ " -- DO NOT EDIT!\n\ |
|
307 |
\;;\n\ |
|
308 |
\;; $" ^ "Id$\n\ |
|
309 |
\;;\n" ^ |
|
310 |
defconst "major" (map #1 commands) ^ |
|
21940 | 311 |
defconst "minor" (filter Syntax.is_identifier keywords) ^ |
21642 | 312 |
implode (map (make_elisp_commands commands) OuterKeyword.kinds) ^ |
313 |
"\n(provide 'isar-keywords)\n"; |
|
314 |
||
315 |
in |
|
316 |
||
317 |
fun write_keywords s = |
|
318 |
(init_outer_syntax (); |
|
21858
05f57309170c
avoid conflict with Alice keywords: renamed pack -> implode, unpack -> explode, any -> many, avoided assert;
wenzelm
parents:
21649
diff
changeset
|
319 |
File.write (Path.explode ("isar-keywords" ^ (if s = "" then "" else "-" ^ s) ^".el")) |
21642 | 320 |
(make_elisp_syntax (OuterSyntax.dest_keywords (), OuterSyntax.dest_parsers ()))); |
321 |
||
322 |
end; |
|
323 |
||
324 |
end; |