src/Pure/proof_general.ML
author haftmann
Tue Sep 06 08:30:43 2005 +0200 (2005-09-06)
changeset 17271 2756a73f63a5
parent 17221 6cd180204582
child 17314 04e21a27c0ad
permissions -rw-r--r--
introduced some new-style AList operations
wenzelm@12780
     1
(*  Title:      Pure/proof_general.ML
wenzelm@12778
     2
    ID:         $Id$
wenzelm@14675
     3
    Author:     David Aspinall and Markus Wenzel
wenzelm@12778
     4
aspinall@15134
     5
Isabelle configuration for Proof General (see http://proofgeneral.inf.ed.ac.uk)
aspinall@15134
     6
Includes support for PGIP control language for Isabelle/Isar.
aspinall@15134
     7
aspinall@15134
     8
===========================================================================
aspinall@15134
     9
NOTE: With this version you will lose support for the Isabelle
aspinall@15173
    10
settings menu in the currently released version of Proof General (3.5).
aspinall@15134
    11
No other changes should be visible in the Emacs interface.
aspinall@15134
    12
wenzelm@16534
    13
The 3.6pre pre-release versions of Emacs Proof General now support the
wenzelm@16534
    14
new PGIP format for preferences and restore the settings menu.
aspinall@15173
    15
Please visit http://proofgeneral.inf.ed.ac.uk/develdownload
aspinall@15134
    16
===========================================================================
aspinall@15134
    17
aspinall@15145
    18
STATUS: this version is an experimental version that supports PGIP 2.X.
wenzelm@12778
    19
*)
wenzelm@12778
    20
wenzelm@12778
    21
signature PROOF_GENERAL =
wenzelm@12778
    22
sig
wenzelm@12778
    23
  val update_thy_only: string -> unit
wenzelm@12778
    24
  val try_update_thy_only: string -> unit
wenzelm@13391
    25
  val inform_file_retracted: string -> unit
wenzelm@12778
    26
  val inform_file_processed: string -> unit
wenzelm@16534
    27
  val preferences:
wenzelm@16534
    28
      (string *
wenzelm@16534
    29
        (string *
wenzelm@16534
    30
         (string *
wenzelm@16534
    31
          (string * (string * (unit -> string)) *
wenzelm@16534
    32
           (string -> unit)))) list) list ref
berghofe@13728
    33
  val process_pgip: string -> unit
wenzelm@12778
    34
  val thms_containing: string list -> unit
wenzelm@12778
    35
  val help: unit -> unit
wenzelm@12778
    36
  val show_context: unit -> theory
wenzelm@12778
    37
  val kill_goal: unit -> unit
wenzelm@12778
    38
  val repeat_undo: int -> unit
wenzelm@12778
    39
  val isa_restart: unit -> unit
wenzelm@12833
    40
  val full_proofs: bool -> unit
aspinall@15134
    41
  val isarcmd: string -> unit
wenzelm@12778
    42
  val init: bool -> unit
aspinall@15134
    43
  val init_pgip: bool -> unit
wenzelm@12778
    44
  val write_keywords: string -> unit
wenzelm@16534
    45
  val xmls_of_str: string -> string list   (*temp for testing parser*)
wenzelm@12778
    46
end;
wenzelm@12778
    47
wenzelm@16534
    48
structure ProofGeneral: PROOF_GENERAL =
wenzelm@12778
    49
struct
wenzelm@12778
    50
wenzelm@16534
    51
structure P = OuterParse;
aspinall@15145
    52
aspinall@15191
    53
aspinall@15134
    54
(* PGIP messaging mode (independent of PGML output) *)
aspinall@15134
    55
aspinall@15134
    56
val pgip_active = ref false;
aspinall@15134
    57
val pgip_emacs_compatibility_flag = ref false;
aspinall@15134
    58
wenzelm@16534
    59
fun pgip () = (! pgip_active);
wenzelm@16534
    60
fun pgip_emacs_compatibility () = (! pgip_emacs_compatibility_flag);
aspinall@15134
    61
aspinall@15134
    62
wenzelm@12778
    63
(* print modes *)
wenzelm@12778
    64
wenzelm@16534
    65
val proof_generalN = "ProofGeneral";  (*token markup (colouring vars, etc.)*)
wenzelm@17217
    66
val pgasciiN = "PGASCII";             (*plain 7-bit ASCII communication*)
wenzelm@16534
    67
val xsymbolsN = Symbol.xsymbolsN;     (*X-Symbol symbols*)
wenzelm@16534
    68
val pgmlN = "PGML";                   (*XML escapes and PGML symbol elements*)
wenzelm@16534
    69
val pgmlatomsN = "PGMLatoms";         (*variable kind decorations*)
wenzelm@16534
    70
val thm_depsN = "thm_deps";           (*meta-information about theorem deps*)
wenzelm@12778
    71
wenzelm@16534
    72
fun pgml () = Output.has_mode pgmlN;
wenzelm@16534
    73
wenzelm@17217
    74
fun special oct =
wenzelm@17217
    75
  if Output.has_mode pgasciiN then chr 1 ^ chr (ord (oct_char oct) - 167)
wenzelm@17217
    76
  else oct_char oct;
wenzelm@17217
    77
wenzelm@12778
    78
aspinall@15134
    79
(* text output: print modes for xsymbol and PGML *)
wenzelm@12778
    80
wenzelm@12778
    81
local
wenzelm@12778
    82
wenzelm@14827
    83
fun xsym_output "\\" = "\\\\"
wenzelm@14827
    84
  | xsym_output s = if Symbol.is_raw s then Symbol.decode_raw s else s;
wenzelm@14827
    85
wenzelm@12778
    86
fun xsymbols_output s =
wenzelm@16534
    87
  if Output.has_mode xsymbolsN andalso exists_string (equal "\\") s then
wenzelm@12778
    88
    let val syms = Symbol.explode s
wenzelm@14827
    89
    in (implode (map xsym_output syms), real (Symbol.length syms)) end
aspinall@15134
    90
  else Symbol.default_output s;
aspinall@15134
    91
aspinall@15134
    92
fun pgml_sym s =
aspinall@15134
    93
  (case Symbol.decode s of
wenzelm@16534
    94
    (*NB: an alternative here would be to output the default print mode alternative
wenzelm@16534
    95
      in the element content, but unfortunately print modes are not that fine grained.*)
aspinall@15266
    96
    Symbol.Char s => XML.text s
aspinall@15403
    97
  | Symbol.Sym sn => XML.element "sym" [("name", sn)] [XML.text s]
wenzelm@16534
    98
  | Symbol.Ctrl sn => XML.element "ctrl" [("name", sn)] [XML.text s] (* FIXME: no such PGML! *)
aspinall@15266
    99
  | Symbol.Raw s => s);
wenzelm@12778
   100
aspinall@15134
   101
fun pgml_output str =
aspinall@15134
   102
  let val syms = Symbol.explode str
aspinall@15134
   103
  in (implode (map pgml_sym syms), real (Symbol.length syms)) end;
aspinall@15134
   104
wenzelm@16534
   105
in
wenzelm@12778
   106
wenzelm@16534
   107
fun setup_xsymbols_output () =
wenzelm@16534
   108
  Output.add_mode xsymbolsN
wenzelm@16534
   109
    (xsymbols_output, Symbol.default_indent, Symbol.encode_raw);
wenzelm@12778
   110
wenzelm@16534
   111
fun setup_pgml_output () =
wenzelm@16534
   112
  Output.add_mode pgmlN
wenzelm@16534
   113
    (pgml_output, Symbol.default_indent, Symbol.encode_raw);
wenzelm@12778
   114
wenzelm@12778
   115
end;
wenzelm@12778
   116
wenzelm@12778
   117
wenzelm@12778
   118
(* token translations *)
wenzelm@12778
   119
wenzelm@12778
   120
local
wenzelm@12778
   121
wenzelm@17217
   122
fun end_tag () = special "350";
wenzelm@17217
   123
val class_tag = ("class", fn () => special "351");
wenzelm@17217
   124
val tfree_tag = ("tfree", fn () => special "352");
wenzelm@17217
   125
val tvar_tag = ("tvar", fn () => special "353");
wenzelm@17217
   126
val free_tag = ("free", fn () => special "354");
wenzelm@17217
   127
val bound_tag = ("bound", fn () => special "355");
wenzelm@17217
   128
val var_tag = ("var", fn () => special "356");
wenzelm@17217
   129
val skolem_tag = ("skolem", fn () => special "357");
wenzelm@12778
   130
wenzelm@12778
   131
fun xml_atom kind x = XML.element "atom" [("kind", kind)] [XML.text x];
wenzelm@12778
   132
wenzelm@12778
   133
fun tagit (kind, bg_tag) x =
wenzelm@16534
   134
 (if Output.has_mode pgmlatomsN then xml_atom kind x
wenzelm@17217
   135
  else bg_tag () ^ x ^ end_tag (), real (Symbol.length (Symbol.explode x)));
wenzelm@12778
   136
wenzelm@12778
   137
fun free_or_skolem x =
wenzelm@12778
   138
  (case try Syntax.dest_skolem x of
skalberg@15531
   139
    NONE => tagit free_tag x
skalberg@15531
   140
  | SOME x' => tagit skolem_tag x');
wenzelm@12778
   141
wenzelm@12778
   142
fun var_or_skolem s =
wenzelm@15985
   143
  (case Syntax.read_variable s of
wenzelm@15985
   144
    SOME (x, i) =>
wenzelm@12778
   145
      (case try Syntax.dest_skolem x of
skalberg@15531
   146
        NONE => tagit var_tag s
wenzelm@15992
   147
      | SOME x' => tagit skolem_tag
wenzelm@15992
   148
          (setmp show_question_marks true Syntax.string_of_vname (x', i)))
wenzelm@15985
   149
  | NONE => tagit var_tag s);
wenzelm@12778
   150
wenzelm@12778
   151
val proof_general_trans =
wenzelm@12778
   152
 Syntax.tokentrans_mode proof_generalN
wenzelm@12778
   153
  [("class", tagit class_tag),
wenzelm@12778
   154
   ("tfree", tagit tfree_tag),
wenzelm@12778
   155
   ("tvar", tagit tvar_tag),
wenzelm@12778
   156
   ("free", free_or_skolem),
wenzelm@12778
   157
   ("bound", tagit bound_tag),
wenzelm@12778
   158
   ("var", var_or_skolem)];
wenzelm@12778
   159
wenzelm@15801
   160
in
wenzelm@15801
   161
wenzelm@15801
   162
val _ = Context.add_setup [Theory.add_tokentrfuns proof_general_trans];
wenzelm@15801
   163
wenzelm@15801
   164
end;
wenzelm@12778
   165
wenzelm@12778
   166
aspinall@15134
   167
(* assembling PGIP packets *)
aspinall@15134
   168
wenzelm@17217
   169
val pgip_refid  = ref NONE: string option ref;
wenzelm@16534
   170
val pgip_refseq = ref NONE: string option ref;
wenzelm@12778
   171
wenzelm@12778
   172
local
aspinall@16821
   173
  val pgip_class  = "pg"
aspinall@16821
   174
  val pgip_tag = "Isabelle/Isar"
aspinall@16821
   175
  val pgip_id = ref ""
aspinall@16821
   176
  val pgip_seq = ref 0
aspinall@16821
   177
  fun pgip_serial () = inc pgip_seq
wenzelm@12778
   178
wenzelm@16534
   179
  fun assemble_pgips pgips =
wenzelm@16534
   180
    XML.element
wenzelm@16534
   181
      "pgip"
aspinall@16821
   182
      ([("tag",    pgip_tag),
aspinall@16821
   183
        ("class",  pgip_class),
wenzelm@17217
   184
        ("seq",    string_of_int (pgip_serial())),
aspinall@16821
   185
        ("id",     !pgip_id)] @
aspinall@16821
   186
       if_none (Option.map (single o (pair "destid")) (! pgip_refid)) [] @
aspinall@16821
   187
       (* destid=refid since Isabelle only communicates back to sender,
aspinall@16821
   188
          so we may omit refid from attributes.
aspinall@16821
   189
       if_none (Option.map (single o (pair "refid"))  (! pgip_refid)) [] @
aspinall@16821
   190
       *)
aspinall@16821
   191
       if_none (Option.map (single o (pair "refseq")) (! pgip_refseq)) [])
wenzelm@16534
   192
      pgips;
aspinall@16821
   193
wenzelm@13526
   194
in
wenzelm@12778
   195
wenzelm@17217
   196
fun init_pgip_session_id () =
aspinall@16821
   197
    pgip_id := getenv "HOSTNAME" ^ "/" ^ getenv "USER" ^ "/" ^
aspinall@16821
   198
               getenv "ISABELLE_PID" ^ "/" ^ Time.toString (Time.now ())
wenzelm@17217
   199
aspinall@16821
   200
aspinall@16821
   201
fun matching_pgip_id id = (id = !pgip_id)
aspinall@16821
   202
wenzelm@16534
   203
fun decorated_output bg en prfx =
wenzelm@16534
   204
  writeln_default o enclose bg en o prefix_lines prfx;
aspinall@15134
   205
wenzelm@16534
   206
(* FIXME: see Rev 1.48 [PG CVS] for cleaner version of this which can be used
wenzelm@16534
   207
   for PG 4.0 which processes PGIP without needing special chars *)
wenzelm@16534
   208
fun issue_pgips ps =
wenzelm@16534
   209
  if pgip_emacs_compatibility() then
wenzelm@16534
   210
    decorated_output (*add urgent message annotation*)
wenzelm@17217
   211
      (special "360") (special "361") ""
wenzelm@16534
   212
      (assemble_pgips ps)
wenzelm@16534
   213
  else
wenzelm@16534
   214
    writeln_default (assemble_pgips ps);
aspinall@15134
   215
wenzelm@16534
   216
fun assemble_pgip resp attrs s = assemble_pgips [XML.element resp attrs [s]];
wenzelm@16534
   217
fun assemble_pgipe resp attrs = assemble_pgips [XML.element resp attrs []];
aspinall@15134
   218
wenzelm@16534
   219
(* FIXME: need to add stuff to gather PGIPs here *)
wenzelm@16534
   220
fun issue_pgip resp attrs txt =
wenzelm@16534
   221
  if pgip_emacs_compatibility () then
wenzelm@16534
   222
    decorated_output (*add urgent message annotation*)
wenzelm@17217
   223
      (special "360") (special "361") ""
wenzelm@16534
   224
      (assemble_pgip resp attrs txt)
wenzelm@16534
   225
  else
wenzelm@16534
   226
    writeln_default (assemble_pgip resp attrs txt);
aspinall@15134
   227
wenzelm@16534
   228
(* FIXME: temporarily to support PG 3.4 *)
wenzelm@16534
   229
fun issue_pgip_maybe_decorated bg en resp attrs s =
wenzelm@16534
   230
  if pgip_emacs_compatibility () then
wenzelm@16534
   231
    (*in PGIP mode, but using escape characters as well*)
wenzelm@16534
   232
    writeln_default (enclose bg en (assemble_pgip resp attrs s))
wenzelm@16534
   233
  else
wenzelm@16534
   234
    issue_pgip resp attrs s;
aspinall@15134
   235
wenzelm@16534
   236
fun issue_pgipe resp attrs = writeln_default (assemble_pgipe resp attrs);
wenzelm@16534
   237
wenzelm@16534
   238
end;
wenzelm@16534
   239
aspinall@15134
   240
aspinall@15134
   241
(* messages and notification *)
aspinall@15134
   242
aspinall@15173
   243
local
wenzelm@16534
   244
  val delay_msgs = ref false;   (*true: accumulate messages*)
wenzelm@16534
   245
  val delayed_msgs = ref [];
aspinall@15173
   246
in
aspinall@15134
   247
wenzelm@16534
   248
fun message resp attrs bg en prfx s =
wenzelm@16534
   249
  if pgip () then
wenzelm@16534
   250
   (if (! delay_msgs) then
wenzelm@16534
   251
      delayed_msgs := (resp, attrs, prefix_lines prfx s) :: ! delayed_msgs (*NB: no decs*)
wenzelm@16534
   252
    else
wenzelm@16534
   253
      issue_pgip_maybe_decorated bg en resp attrs
wenzelm@16534
   254
        (XML.element "pgmltext" [] [prefix_lines prfx s]))
wenzelm@16534
   255
  else decorated_output bg en prfx s;
aspinall@15173
   256
wenzelm@16534
   257
fun start_delay_msgs () = (set delay_msgs; delayed_msgs := []);
aspinall@15173
   258
wenzelm@16534
   259
fun end_delayed_msgs () = (reset delay_msgs;
wenzelm@16534
   260
  (! delayed_msgs) |> map (fn (resp, attrs, s) =>
wenzelm@16534
   261
    XML.element resp attrs [XML.element "pgmltext" [] [s]]));
wenzelm@16534
   262
wenzelm@16534
   263
end;
aspinall@15134
   264
aspinall@15134
   265
local
wenzelm@16534
   266
  val display_area = ("area", "display");
wenzelm@16534
   267
  val message_area = ("area", "message");
wenzelm@16534
   268
  val internal_category = ("messagecategory", "internal");
wenzelm@16534
   269
  val info_category = ("messagecategory", "information");
wenzelm@16534
   270
  val tracing_category = ("messagecategory", "tracing");
wenzelm@16534
   271
  val urgent_indication = ("urgent", "y");
wenzelm@16534
   272
  val nonfatal = ("fatality", "nonfatal");
wenzelm@16534
   273
  val fatal = ("fatality", "fatal");
wenzelm@16534
   274
  val panic = ("fatality", "panic");
aspinall@15134
   275
wenzelm@16534
   276
  val thyname_attr = pair "thyname";
wenzelm@16534
   277
  val url_attr = pair "url";
wenzelm@16534
   278
  fun localfile_url_attr path = url_attr ("file:///" ^ path);
wenzelm@16534
   279
in
wenzelm@12778
   280
wenzelm@12778
   281
fun setup_messages () =
wenzelm@17217
   282
 (writeln_fn := (fn s => message "normalresponse" [message_area] "" "" "" s);
wenzelm@17217
   283
  priority_fn := (fn s => message "normalresponse" [message_area, urgent_indication]
wenzelm@17217
   284
    (special "360") (special "361") "" s);
wenzelm@17217
   285
  tracing_fn := (fn s => message "normalresponse"  [message_area, tracing_category]
wenzelm@17217
   286
    (special "360" ^ special "375") (special "361") "" s);
wenzelm@17217
   287
  info_fn := (fn s => message "normalresponse" [message_area, info_category]
wenzelm@17217
   288
    (special "362") (special "363") "+++ " s);
wenzelm@17217
   289
  debug_fn := (fn s => message "normalresponse" [message_area, internal_category]
wenzelm@17217
   290
    (special "362") (special "363") "+++ " s);
wenzelm@17217
   291
  warning_fn := (fn s => message "errorresponse" [nonfatal]
wenzelm@17217
   292
    (special "362") (special "363") "### " s);
wenzelm@17217
   293
  error_fn := (fn s => message "errorresponse" [fatal]
wenzelm@17217
   294
    (special "364") (special "365") "*** " s);
wenzelm@17217
   295
  panic_fn := (fn s => message "errorresponse" [panic]
wenzelm@17217
   296
    (special "364") (special "365") "!!! " s));
aspinall@15134
   297
aspinall@15134
   298
aspinall@15400
   299
(* accumulate printed output in a single PGIP response (inside <pgmltext>) *)
aspinall@15134
   300
wenzelm@16534
   301
fun with_displaywrap (elt, attrs) dispfn =
wenzelm@16534
   302
  let
wenzelm@16534
   303
    val lines = ref ([]: string list);
wenzelm@16534
   304
    fun wlgrablines s = lines := s :: ! lines;
wenzelm@16534
   305
  in
wenzelm@16534
   306
    setmp writeln_fn wlgrablines dispfn ();
aspinall@16798
   307
    (* IMPORTANT FIXME: XML.element here too inefficient, should use stream output *)
wenzelm@16534
   308
    issue_pgip elt attrs (XML.element "pgmltext" [] (! lines))
wenzelm@16534
   309
  end;
wenzelm@12778
   310
wenzelm@17217
   311
fun emacs_notify s = decorated_output (special "360") (special "361") "" s;
aspinall@15134
   312
wenzelm@16534
   313
fun tell_clear_goals () =
wenzelm@16534
   314
  if pgip () then
wenzelm@16534
   315
    issue_pgipe "cleardisplay" [display_area]
wenzelm@16534
   316
  else
wenzelm@16534
   317
    emacs_notify "Proof General, please clear the goals buffer.";
wenzelm@16534
   318
wenzelm@16534
   319
fun tell_clear_response () =
wenzelm@16534
   320
  if pgip () then
wenzelm@16534
   321
    issue_pgipe "cleardisplay" [message_area]
wenzelm@16534
   322
  else
wenzelm@16534
   323
    emacs_notify "Proof General, please clear the response buffer.";
wenzelm@12778
   324
wenzelm@16534
   325
fun tell_file_loaded path =
wenzelm@16534
   326
  if pgip () then
aspinall@16788
   327
    issue_pgipe "informfileloaded"
aspinall@16788
   328
      [localfile_url_attr  (XML.text (File.platform_path path))]
wenzelm@16534
   329
  else
wenzelm@16534
   330
    emacs_notify ("Proof General, this file is loaded: " ^ quote (File.platform_path path));
aspinall@15134
   331
wenzelm@16534
   332
fun tell_file_retracted path =
wenzelm@16534
   333
  if pgip() then
aspinall@16788
   334
    issue_pgipe "informfileretracted"
aspinall@16788
   335
      [localfile_url_attr  (XML.text (File.platform_path path))]
wenzelm@16534
   336
  else
wenzelm@16534
   337
    emacs_notify ("Proof General, you can unlock the file " ^ quote (File.platform_path path));
wenzelm@12778
   338
wenzelm@12778
   339
wenzelm@12778
   340
(* theory / proof state output *)
wenzelm@12778
   341
wenzelm@12778
   342
local
wenzelm@12778
   343
wenzelm@16534
   344
fun tmp_markers f =
wenzelm@17217
   345
  setmp Display.current_goals_markers (special "366", special "367", "") f ();
wenzelm@12778
   346
wenzelm@16534
   347
fun statedisplay prts =
wenzelm@16534
   348
  issue_pgip "proofstate" []
wenzelm@16534
   349
    (XML.element "pgml" []
wenzelm@16534
   350
      [XML.element "statedisplay" [] [Pretty.output (Pretty.chunks prts)]]);
wenzelm@17217
   351
wenzelm@16534
   352
fun print_current_goals n m st =
wenzelm@16534
   353
  if pgml () then statedisplay (Display.pretty_current_goals n m st)
wenzelm@16534
   354
  else tmp_markers (fn () => Display.print_current_goals_default n m st);
wenzelm@13545
   355
wenzelm@16534
   356
fun print_state b st =
wenzelm@16534
   357
  if pgml () then statedisplay (Toplevel.pretty_state b st)
wenzelm@16534
   358
  else tmp_markers (fn () => Toplevel.print_state_default b st);
wenzelm@16534
   359
wenzelm@13526
   360
in
wenzelm@13526
   361
wenzelm@16534
   362
fun setup_state () =
wenzelm@16534
   363
  (Display.print_current_goals_fn := print_current_goals;
wenzelm@16534
   364
   Toplevel.print_state_fn := print_state;
wenzelm@16534
   365
   (* FIXME: check next octal char won't appear in pgip? *)
wenzelm@17217
   366
   Toplevel.prompt_state_fn := (fn s => suffix (special "372")
wenzelm@17217
   367
     (Toplevel.prompt_state_default s)));
berghofe@13728
   368
wenzelm@16534
   369
end;
wenzelm@16534
   370
wenzelm@16534
   371
end;
berghofe@13728
   372
wenzelm@16022
   373
wenzelm@12778
   374
(* misc commands for ProofGeneral/isa *)
wenzelm@12778
   375
wenzelm@12778
   376
fun thms_containing ss =
wenzelm@16534
   377
  FindTheorems.print_theorems (ProofContext.init (the_context ())) NONE NONE
wenzelm@16022
   378
    (map (fn s => (true, FindTheorems.Pattern s)) ss);
wenzelm@12778
   379
wenzelm@12778
   380
val welcome = priority o Session.welcome;
wenzelm@12778
   381
val help = welcome;
wenzelm@12778
   382
val show_context = Context.the_context;
wenzelm@12778
   383
wenzelm@12778
   384
fun kill_goal () = (Goals.reset_goals (); tell_clear_goals ());
wenzelm@12778
   385
wenzelm@12778
   386
fun no_print_goals f = setmp Display.print_current_goals_fn (fn _ => fn _ => fn _ => ()) f;
wenzelm@12778
   387
wenzelm@12778
   388
fun repeat_undo 0 = ()
wenzelm@12778
   389
  | repeat_undo 1 = undo ()
wenzelm@12778
   390
  | repeat_undo n = (no_print_goals undo (); repeat_undo (n - 1));
wenzelm@12778
   391
wenzelm@12778
   392
aspinall@15134
   393
(* theory loader actions *)
aspinall@15134
   394
aspinall@15134
   395
local
aspinall@15134
   396
aspinall@15134
   397
fun add_master_files name files =
aspinall@15134
   398
  let val masters = [ThyLoad.thy_path name, ThyLoad.ml_path name]
aspinall@15134
   399
  in masters @ gen_rems (op = o pairself Path.base) (files, masters) end;
aspinall@15134
   400
aspinall@15134
   401
fun trace_action action name =
aspinall@15134
   402
  if action = ThyInfo.Update then
skalberg@15570
   403
    List.app tell_file_loaded (ThyInfo.loaded_files name)
aspinall@15134
   404
  else if action = ThyInfo.Outdate orelse action = ThyInfo.Remove then
skalberg@15570
   405
    List.app tell_file_retracted (add_master_files name (ThyInfo.loaded_files name))
aspinall@15134
   406
  else ();
aspinall@15134
   407
aspinall@15134
   408
in
aspinall@15134
   409
  fun setup_thy_loader () = ThyInfo.add_hook trace_action;
skalberg@15570
   410
  fun sync_thy_loader () = List.app (trace_action ThyInfo.Update) (ThyInfo.names ());
aspinall@15134
   411
end;
aspinall@15134
   412
aspinall@15134
   413
aspinall@15134
   414
(* prepare theory context *)
aspinall@15134
   415
aspinall@15134
   416
val thy_name = Path.pack o #1 o Path.split_ext o Path.base o Path.unpack;
wenzelm@16534
   417
wenzelm@16534
   418
(* FIXME general treatment of tracing*)
wenzelm@16534
   419
val update_thy_only = setmp MetaSimplifier.trace_simp false ThyInfo.update_thy_only;
aspinall@15134
   420
wenzelm@16440
   421
fun dynamic_context () =
aspinall@15134
   422
  (case Context.get_context () of
wenzelm@16440
   423
    SOME thy => "  Using current (dynamic!) one: " ^ quote (Context.theory_name thy)
skalberg@15531
   424
  | NONE => "");
aspinall@15134
   425
aspinall@15134
   426
fun try_update_thy_only file =
aspinall@15134
   427
  ThyLoad.cond_add_path (Path.dir (Path.unpack file)) (fn () =>
aspinall@15134
   428
    let val name = thy_name file in
wenzelm@16534
   429
      if is_some (ThyLoad.check_file NONE (ThyLoad.thy_path name))
aspinall@15134
   430
      then update_thy_only name
wenzelm@16440
   431
      else warning ("Unkown theory context of ML file." ^ dynamic_context ())
aspinall@15134
   432
    end) ();
aspinall@15134
   433
aspinall@15134
   434
aspinall@15134
   435
(* get informed about files *)
aspinall@15134
   436
wenzelm@16534
   437
val inform_file_retracted = ThyInfo.if_known_thy ThyInfo.remove_thy o thy_name;
wenzelm@16534
   438
val inform_file_processed = ThyInfo.if_known_thy ThyInfo.touch_child_thys o thy_name;
wenzelm@16534
   439
val openfile_retract = Output.no_warnings (ThyInfo.if_known_thy ThyInfo.remove_thy) o thy_name;
aspinall@15629
   440
aspinall@15134
   441
fun proper_inform_file_processed file state =
aspinall@15134
   442
  let val name = thy_name file in
aspinall@15134
   443
    if Toplevel.is_toplevel state andalso ThyInfo.known_thy name then
aspinall@15134
   444
     (ThyInfo.touch_child_thys name;
aspinall@15134
   445
      transform_error ThyInfo.pretend_use_thy_only name handle ERROR_MESSAGE msg =>
aspinall@15134
   446
       (warning msg; warning ("Failed to register theory: " ^ quote name);
aspinall@15134
   447
        tell_file_retracted (Path.base (Path.unpack file))))
aspinall@15134
   448
    else raise Toplevel.UNDEF
aspinall@15134
   449
  end;
aspinall@15134
   450
aspinall@15134
   451
fun vacuous_inform_file_processed file state =
aspinall@15134
   452
 (warning ("No theory " ^ quote (thy_name file));
aspinall@15134
   453
  tell_file_retracted (Path.base (Path.unpack file)));
aspinall@15134
   454
aspinall@15134
   455
wenzelm@12778
   456
(* restart top-level loop (keeps most state information) *)
wenzelm@12778
   457
wenzelm@12778
   458
local
wenzelm@12778
   459
wenzelm@12778
   460
fun restart isar =
wenzelm@12778
   461
 (if isar then tell_clear_goals () else kill_goal ();
wenzelm@12778
   462
  tell_clear_response ();
wenzelm@12778
   463
  welcome ());
wenzelm@12778
   464
wenzelm@12778
   465
in
wenzelm@12778
   466
wenzelm@12778
   467
fun isa_restart () = restart false;
wenzelm@12778
   468
fun isar_restart () = (sync_thy_loader (); restart true; raise Toplevel.RESTART);
wenzelm@12778
   469
wenzelm@12778
   470
end;
wenzelm@12778
   471
wenzelm@12833
   472
fun full_proofs true = proofs := 2
wenzelm@12833
   473
  | full_proofs false = proofs := 1;
wenzelm@12833
   474
wenzelm@12833
   475
aspinall@15134
   476
(* theorem dependency output *)
aspinall@15134
   477
aspinall@15134
   478
local
aspinall@15134
   479
aspinall@15134
   480
val spaces_quote = space_implode " " o map quote;
aspinall@15134
   481
aspinall@16789
   482
(* FIXME: investigate why dependencies at the moment include themselves! *)
wenzelm@16534
   483
fun thm_deps_message (thms, deps) =
wenzelm@16534
   484
  if pgip() then
wenzelm@16534
   485
    issue_pgips
wenzelm@16534
   486
      [XML.element
wenzelm@16534
   487
        "metainforesponse"  (* FIXME: get thy name from info here? *)
wenzelm@16534
   488
        [("infotype", "isabelle_theorem_dependencies")]
wenzelm@16534
   489
        [XML.element "value" [("name", "thms")] [XML.text thms],
wenzelm@16534
   490
         XML.element "value" [("name", "deps")] [XML.text deps]]]
wenzelm@16534
   491
  else emacs_notify ("Proof General, theorem dependencies of " ^ thms ^ " are " ^ deps);
aspinall@15134
   492
wenzelm@16534
   493
fun tell_thm_deps ths = conditional (Output.has_mode thm_depsN) (fn () =>
wenzelm@16534
   494
  let
wenzelm@16534
   495
    val names = filter_out (equal "") (map Thm.name_of_thm ths);
wenzelm@16534
   496
    val deps = filter_out (equal "")
berghofe@17018
   497
      (Symtab.keys (fold Proofterm.thms_of_proof
berghofe@17018
   498
        (map Thm.proof_of ths) Symtab.empty));
wenzelm@16534
   499
  in
wenzelm@16534
   500
    if null names orelse null deps then ()
wenzelm@16534
   501
    else thm_deps_message (spaces_quote names, spaces_quote deps)
wenzelm@16534
   502
  end);
aspinall@15134
   503
aspinall@15134
   504
in
aspinall@15134
   505
aspinall@15134
   506
fun setup_present_hook () =
skalberg@15570
   507
  Present.add_hook (fn _ => fn res => tell_thm_deps (List.concat (map #2 res)));
aspinall@15134
   508
aspinall@15134
   509
end;
aspinall@15134
   510
aspinall@15134
   511
wenzelm@16534
   512
wenzelm@16534
   513
(** preferences **)
aspinall@15134
   514
aspinall@15134
   515
local
aspinall@15134
   516
wenzelm@16534
   517
val pgipnat = XML.element "pgipint" [("min", "0")] [];
wenzelm@16534
   518
fun pgipnatmax max = XML.element "pgipint" [("min", "0"), ("max", string_of_int max)] [];
wenzelm@16534
   519
val pgipbool = XML.element "pgipbool" [] [];
wenzelm@16534
   520
wenzelm@16534
   521
fun with_default f = (f (), f);
wenzelm@16534
   522
aspinall@15134
   523
in
aspinall@15134
   524
aspinall@15134
   525
fun nat_option r = (pgipnat,
wenzelm@16534
   526
  with_default (fn () => string_of_int (! r)),
aspinall@15134
   527
  (fn s => (case Syntax.read_nat s of
wenzelm@16534
   528
      NONE => error ("nat_option: illegal value: " ^ s)
wenzelm@16534
   529
    | SOME i => r := i)));
aspinall@15134
   530
aspinall@15134
   531
fun bool_option r = (pgipbool,
wenzelm@16534
   532
  with_default (fn () => Bool.toString (! r)),
aspinall@15134
   533
  (fn "false" => r := false | "true" => r := true
wenzelm@16534
   534
    | x => error ("bool_option: illegal value: " ^ x)));
aspinall@15134
   535
aspinall@15134
   536
val proof_option = (pgipbool,
wenzelm@16534
   537
  with_default (fn () => Bool.toString (! proofs >= 2)),
aspinall@15134
   538
  (fn "false" => proofs := 1 | "true" => proofs := 2
wenzelm@16534
   539
    | x => error ("proof_option: illegal value: " ^ x)));
aspinall@15134
   540
aspinall@15134
   541
val thm_deps_option = (pgipbool,
wenzelm@16534
   542
  with_default (fn () => Bool.toString (Output.has_mode thm_depsN)),
wenzelm@17217
   543
  (fn "false" => change print_mode (remove (op =) thm_depsN)
wenzelm@17217
   544
    | "true" => change print_mode (insert (op =) thm_depsN)
wenzelm@16534
   545
    | x => error ("thm_deps_option: illegal value: " ^ x)));
aspinall@15134
   546
wenzelm@16534
   547
local
wenzelm@16534
   548
  val pg_print_depth_val = ref 10;
wenzelm@16534
   549
  fun pg_print_depth n = (print_depth n; pg_print_depth_val := n)
aspinall@15134
   550
in
wenzelm@16534
   551
aspinall@15134
   552
val print_depth_option = (pgipnat,
wenzelm@16534
   553
  with_default (fn () => string_of_int (! pg_print_depth_val)),
aspinall@15134
   554
  (fn s => (case Syntax.read_nat s of
wenzelm@16534
   555
      NONE => error ("print_depth_option: illegal value: " ^ s)
wenzelm@16534
   556
    | SOME i => pg_print_depth i)));
wenzelm@16534
   557
end;
aspinall@15134
   558
wenzelm@16534
   559
val preferences = ref
aspinall@15134
   560
  [("Display",
wenzelm@16534
   561
    [("show-types",
wenzelm@16534
   562
      ("Include types in display of Isabelle terms",
aspinall@15134
   563
       bool_option show_types)),
wenzelm@16534
   564
     ("show-sorts",
wenzelm@16534
   565
      ("Include sorts in display of Isabelle terms",
aspinall@15134
   566
       bool_option show_sorts)),
wenzelm@16534
   567
     ("show-consts",
aspinall@15134
   568
      ("Show types of consts in Isabelle goal display",
aspinall@15134
   569
       bool_option show_consts)),
wenzelm@16534
   570
     ("long-names",
wenzelm@16534
   571
      ("Show fully qualified names in Isabelle terms",
wenzelm@16534
   572
       bool_option long_names)),
wenzelm@16534
   573
     ("show-brackets",
aspinall@15134
   574
      ("Show full bracketing in Isabelle terms",
aspinall@15134
   575
       bool_option show_brackets)),
wenzelm@16534
   576
     ("show-main-goal",
wenzelm@16534
   577
      ("Show main goal in proof state display",
wenzelm@16534
   578
       bool_option Proof.show_main_goal)),
wenzelm@16534
   579
     ("eta-contract",
aspinall@15134
   580
      ("Print terms eta-contracted",
aspinall@15134
   581
       bool_option Syntax.eta_contract))]),
aspinall@15134
   582
   ("Advanced Display",
wenzelm@16534
   583
    [("goals-limit",
aspinall@15134
   584
      ("Setting for maximum number of goals printed",
aspinall@15134
   585
       nat_option goals_limit)),
wenzelm@16534
   586
     ("prems-limit",
aspinall@15134
   587
      ("Setting for maximum number of premises printed",
aspinall@15134
   588
       nat_option ProofContext.prems_limit)),
wenzelm@16534
   589
     ("print-depth",
aspinall@15134
   590
      ("Setting for the ML print depth",
berghofe@15472
   591
       print_depth_option)),
wenzelm@15985
   592
     ("show-question-marks",
berghofe@15472
   593
      ("Show leading question mark of variable name",
wenzelm@15985
   594
       bool_option show_question_marks))]),
aspinall@15134
   595
   ("Tracing",
wenzelm@16534
   596
    [("trace-simplifier",
aspinall@15134
   597
      ("Trace simplification rules.",
aspinall@15134
   598
       bool_option trace_simp)),
wenzelm@16534
   599
     ("trace-rules",
wenzelm@16534
   600
      ("Trace application of the standard rules",
wenzelm@16534
   601
       bool_option trace_rules)),
wenzelm@16534
   602
     ("trace-unification",
aspinall@15134
   603
      ("Output error diagnostics during unification",
aspinall@15134
   604
       bool_option Pattern.trace_unify_fail)),
wenzelm@16534
   605
     ("global-timing",
aspinall@15134
   606
      ("Whether to enable timing in Isabelle.",
aspinall@15134
   607
       bool_option Output.timing))]),
wenzelm@16534
   608
   ("Proof",
wenzelm@16534
   609
    [("quick-and-dirty",
wenzelm@16534
   610
      ("Take a few short cuts",
aspinall@15134
   611
       bool_option quick_and_dirty)),
wenzelm@16534
   612
     ("full-proofs",
aspinall@15134
   613
      ("Record full proof objects internally",
aspinall@15134
   614
       proof_option)),
wenzelm@16534
   615
     ("theorem-dependencies",
aspinall@15134
   616
       ("Track theorem dependencies within Proof General",
wenzelm@16534
   617
        thm_deps_option)),
wenzelm@16534
   618
     ("skip-proofs",
wenzelm@16816
   619
      ("Ignore proof scripts (interactive-only)",
berghofe@15238
   620
       bool_option Toplevel.skip_proofs))])
aspinall@15134
   621
   ];
wenzelm@16534
   622
end;
wenzelm@16534
   623
aspinall@15134
   624
aspinall@15134
   625
(* Configuration: GUI config, proverinfo messages *)
aspinall@15134
   626
aspinall@15134
   627
local
aspinall@15134
   628
    val config_file = "~~/lib/ProofGeneral/pgip_isar.xml"
aspinall@15134
   629
    val name_attr = pair "name"
aspinall@15134
   630
    val version_attr = pair "version"
aspinall@15134
   631
    val isabelle_www = "http://isabelle.in.tum.de/"
aspinall@15134
   632
in
aspinall@15134
   633
fun send_pgip_config () =
wenzelm@16534
   634
    let
wenzelm@16534
   635
        val path = Path.unpack config_file
wenzelm@16534
   636
        val exists = File.exists path
wenzelm@16534
   637
        val proverinfo =
wenzelm@16534
   638
            XML.element "proverinfo"
aspinall@15134
   639
              [("name",Session.name()), ("version", version),
wenzelm@16534
   640
               ("url", isabelle_www), ("filenameextns", ".thy;")]
wenzelm@16534
   641
            [XML.element "welcomemsg" [] [XML.text (Session.welcome())],
wenzelm@16534
   642
             XML.element "helpdoc"
aspinall@15134
   643
         (* NB: would be nice to generate/display docs from isatool
aspinall@15134
   644
          doc, but that program may not be running on same machine;
aspinall@15134
   645
          front end should be responsible for launching viewer, etc. *)
wenzelm@16534
   646
                      [("name", "Isabelle/HOL Tutorial"),
wenzelm@16534
   647
                       ("descr", "A Gentle Introduction to Isabelle/HOL"),
wenzelm@16534
   648
                       ("url",  "http://isabelle.in.tum.de/dist/Isabelle2004/doc/tutorial.pdf")]
wenzelm@16534
   649
              []]
aspinall@15134
   650
    in
wenzelm@16534
   651
        if exists then
wenzelm@16534
   652
            (issue_pgips [proverinfo]; issue_pgips [File.read path])
wenzelm@16534
   653
        else panic ("PGIP configuration file " ^ config_file ^ " not found")
aspinall@15134
   654
    end;
aspinall@15134
   655
end
aspinall@15134
   656
aspinall@15134
   657
aspinall@15629
   658
(* Reveal some information about prover state *)
aspinall@15629
   659
fun send_informguise (openfile, opentheory, openproofpos) =
wenzelm@16534
   660
    let val guisefile =
wenzelm@16534
   661
            case openfile of SOME f => [XML.element "guisefile"
wenzelm@16534
   662
                                                    [("url",Url.pack (Url.File (Path.unpack f)))] []]
wenzelm@16534
   663
                           | _ => []
wenzelm@16534
   664
        val guisetheory =
wenzelm@16534
   665
            case opentheory of SOME t => [XML.element "guisetheory" [("thyname", t)] []]
wenzelm@16534
   666
                             | _ => []
wenzelm@16534
   667
        val guiseproof =
wenzelm@16534
   668
            case openproofpos of SOME i => [XML.element "guiseproof" [("proofpos", string_of_int i)] []]
wenzelm@16534
   669
                               | _ => []
wenzelm@16534
   670
    in
wenzelm@16534
   671
        issue_pgips [XML.element "informguise" [] (guisefile @ guisetheory @ guiseproof)]
wenzelm@16534
   672
    end
aspinall@15629
   673
aspinall@15629
   674
aspinall@15134
   675
(* PGIP identifier tables (prover objects). [incomplete] *)
aspinall@15134
   676
aspinall@15134
   677
local
aspinall@15134
   678
    val objtype_thy  = "theory"
aspinall@15134
   679
    val objtype_thm  = "theorem"
aspinall@15134
   680
    val objtype_term = "term"
aspinall@15134
   681
    val objtype_type = "type"
wenzelm@16534
   682
wenzelm@16534
   683
    fun xml_idtable ty ctx ids =
wenzelm@16534
   684
        let
skalberg@15531
   685
            fun ctx_attr (SOME c)= [("context", c)]
skalberg@15531
   686
              | ctx_attr NONE    = []
wenzelm@16534
   687
            fun xmlid x = XML.element "identifier" [] [XML.text x];
wenzelm@16534
   688
        in
wenzelm@16534
   689
            XML.element "idtable" (("objtype", ty)::ctx_attr ctx)
wenzelm@16534
   690
                                  (map xmlid ids)
wenzelm@16534
   691
        end
aspinall@15134
   692
in
aspinall@15134
   693
aspinall@15134
   694
fun setids t = issue_pgip "setids" [] t
aspinall@15134
   695
fun addids t = issue_pgip "addids" [] t
aspinall@15134
   696
fun delids t = issue_pgip "delids" [] t
aspinall@15134
   697
skalberg@15531
   698
fun delallids ty = setids (xml_idtable ty NONE [])
aspinall@15134
   699
aspinall@15134
   700
fun send_thy_idtable ctx thys = setids (xml_idtable objtype_thy ctx thys)
aspinall@15134
   701
fun clear_thy_idtable () = delallids objtype_thy
aspinall@15134
   702
wenzelm@16534
   703
fun send_thm_idtable ctx thy =
aspinall@15134
   704
    addids (xml_idtable objtype_thm ctx (map fst (PureThy.thms_of thy)));
aspinall@15134
   705
aspinall@15134
   706
fun clear_thm_idtable () = delallids objtype_thm
aspinall@15134
   707
aspinall@15134
   708
(* fun send_type_idtable thy = TODO, it's a bit low-level messy
aspinall@15134
   709
   & maybe not so useful anyway *)
wenzelm@16534
   710
aspinall@15134
   711
end
aspinall@15134
   712
aspinall@15134
   713
(* Response to interface queries about known objects *)
aspinall@15134
   714
aspinall@15134
   715
local
aspinall@15134
   716
 val topthy = Toplevel.theory_of o Toplevel.get_state
wenzelm@16486
   717
 fun pthm thy name = print_thm (get_thm thy (Name name))
aspinall@15134
   718
aspinall@15134
   719
 fun idvalue tp nm = ("idvalue",[("objtype",tp),("name",nm)])
aspinall@15134
   720
in
aspinall@16798
   721
(* FIXME: add askids for "file" here, which returns single theory with same name *)
skalberg@15531
   722
fun askids (NONE, SOME "theory")  = send_thy_idtable NONE (ThyInfo.names())
skalberg@15531
   723
  | askids (NONE, NONE) =  send_thy_idtable NONE (ThyInfo.names())
aspinall@15134
   724
                           (* only theories known in top context *)
skalberg@15531
   725
  | askids (SOME thy, SOME "theory") = send_thy_idtable (SOME thy) (ThyInfo.get_preds thy)
skalberg@15531
   726
  | askids (SOME thy, SOME "theorem") = send_thm_idtable (SOME thy) (ThyInfo.get_theory thy)
skalberg@15531
   727
  | askids (SOME thy, NONE) = (send_thy_idtable (SOME thy) (ThyInfo.get_preds thy);
wenzelm@16534
   728
                               send_thm_idtable (SOME thy) (ThyInfo.get_theory thy))
skalberg@15531
   729
  | askids (_, SOME ot) = error ("No objects of type "^(quote ot)^" are available here.")
aspinall@15134
   730
wenzelm@16534
   731
fun showid (_,        "theory", n) =
aspinall@15134
   732
    with_displaywrap (idvalue "theory" n) (fn ()=>(print_theory (ThyInfo.get_theory n)))
wenzelm@16534
   733
  | showid (SOME thy, "theorem", t) =
aspinall@15134
   734
    with_displaywrap (idvalue "theorem" t) (fn ()=>(pthm (ThyInfo.get_theory thy) t))
wenzelm@16534
   735
  | showid (NONE,     "theorem", t) =
aspinall@15134
   736
    with_displaywrap (idvalue "theorem" t) (fn ()=>pthm (topthy()) t)
aspinall@15134
   737
  | showid (_, ot, _) = error ("Cannot show objects of type "^ot)
aspinall@15134
   738
aspinall@15134
   739
end
aspinall@15629
   740
aspinall@15629
   741
aspinall@15134
   742
(** Parsing proof scripts without execution **)
aspinall@15134
   743
aspinall@15146
   744
(* Notes.
aspinall@15146
   745
   This is quite tricky, because 1) we need to put back whitespace which
aspinall@15146
   746
   was removed during parsing so we can provide markup around commands;
aspinall@15146
   747
   2) parsing is intertwined with execution in Isar so we have to repeat
aspinall@15146
   748
   the parsing to extract interesting parts of commands.  The trace of
aspinall@15254
   749
   tokens parsed which is now recorded in each transition (added by
aspinall@15254
   750
   Markus June '04) helps do this, but the mechanism is still a bad mess.
wenzelm@16534
   751
aspinall@15254
   752
   If we had proper parse trees it would be easy, although having a
aspinall@15254
   753
   fixed type of trees might be tricky with Isar's extensible parser.
aspinall@15146
   754
aspinall@15146
   755
   Probably the best solution is to produce the meta-information at
wenzelm@16534
   756
   the same time as the parse, for each command, e.g. by recording a
wenzelm@16534
   757
   list of (name,objtype) pairs which record the bindings created by
wenzelm@16534
   758
   a command.  This would require changing the interfaces in
wenzelm@16534
   759
   outer_syntax.ML (or providing new ones),
aspinall@15146
   760
aspinall@15146
   761
    datatype metainfo = Binding of string * string  (* name, objtype *)
aspinall@15146
   762
aspinall@15146
   763
    val command_withmetainfo: string -> string -> string ->
wenzelm@16534
   764
      (token list ->
wenzelm@16534
   765
       ((Toplevel.transition -> Toplevel.transition) * metainfo list) *
aspinall@15146
   766
       token list) -> parser
aspinall@15254
   767
aspinall@15254
   768
   We'd also like to render terms as they appear in output, but this
wenzelm@16534
   769
   will be difficult because inner syntax is extensible and we don't
aspinall@15254
   770
   have the correct syntax to hand when just doing outer parsing
wenzelm@16534
   771
   without execution.  A reasonable approximation could
aspinall@15254
   772
   perhaps be obtained by using the syntax of the current context.
wenzelm@16534
   773
   However, this would mean more mess trying to pick out terms,
aspinall@15254
   774
   so at this stage a more serious change to the Isar functions
aspinall@15254
   775
   seems necessary.
aspinall@15146
   776
*)
aspinall@15146
   777
aspinall@15134
   778
local
aspinall@15145
   779
    fun markup_text str elt = [XML.element elt [] [XML.text str]]
aspinall@15145
   780
    fun markup_text_attrs str elt attrs = [XML.element elt attrs [XML.text str]]
aspinall@15145
   781
    fun empty elt = [XML.element elt [] []]
aspinall@15145
   782
aspinall@15210
   783
    fun whitespace str = XML.element "whitespace" [] [XML.text str]
aspinall@15208
   784
aspinall@15146
   785
    (* an extra token is needed to terminate the command *)
aspinall@15146
   786
    val sync = OuterSyntax.scan "\\<^sync>";
aspinall@15146
   787
wenzelm@16534
   788
    fun named_item_elt_with nameattr toks str elt nameP objtyp =
wenzelm@16534
   789
        let
wenzelm@16534
   790
            val name = (fst (nameP (toks@sync)))
wenzelm@16534
   791
                        handle _ => (error ("Error occurred in name parser for " ^ elt ^
wenzelm@16534
   792
                                            "(objtype: " ^ objtyp ^ ")");
wenzelm@16534
   793
                                     "")
wenzelm@16534
   794
wenzelm@16534
   795
        in
wenzelm@16534
   796
            [XML.element elt
wenzelm@16534
   797
                         ((if name="" then [] else [(nameattr, name)])@
wenzelm@16534
   798
                          (if objtyp="" then [] else [("objtype", objtyp)]))
wenzelm@16534
   799
                         ([XML.text str])]
wenzelm@16534
   800
        end
aspinall@15145
   801
aspinall@15146
   802
    val named_item_elt = named_item_elt_with "name"
aspinall@15146
   803
    val thmnamed_item_elt = named_item_elt_with "thmname"
wenzelm@16534
   804
aspinall@15145
   805
    fun parse_warning msg = warning ("script->PGIP markup parser: " ^ msg)
aspinall@15145
   806
aspinall@15145
   807
    (* FIXME: allow dynamic extensions to language here: we need a hook in
aspinall@15145
   808
       outer_syntax.ML to reset this table. *)
aspinall@15145
   809
wenzelm@16534
   810
    val keywords_classification_table = ref (NONE: string Symtab.table option)
aspinall@15145
   811
wenzelm@16534
   812
    fun get_keywords_classification_table () =
wenzelm@16534
   813
        case (!keywords_classification_table) of
wenzelm@17221
   814
          SOME t => t
wenzelm@17221
   815
        | NONE => (let
wenzelm@17221
   816
                     val tab = fold (fn (c, _, k, _) => Symtab.curried_update (c, k))
wenzelm@17221
   817
                                    (OuterSyntax.dest_parsers ()) Symtab.empty;
wenzelm@17221
   818
                   in (keywords_classification_table := SOME tab; tab) end)
aspinall@15145
   819
aspinall@15145
   820
wenzelm@16534
   821
aspinall@15145
   822
    fun xmls_of_thy_begin (name,toks,str) = (* see isar_syn.ML/theoryP *)
wenzelm@16534
   823
        let
wenzelm@16534
   824
            val ((thyname,imports,files),_) = ThyHeader.args (toks@sync)
wenzelm@16534
   825
        in
wenzelm@16534
   826
            markup_text_attrs str "opentheory"
wenzelm@16534
   827
                              ([("thyname",thyname)] @
wenzelm@16534
   828
                               (if imports=[] then [] else
wenzelm@16534
   829
                                [("parentnames", (space_implode ";" imports) ^ ";")]))
wenzelm@16534
   830
        end
aspinall@15145
   831
aspinall@15145
   832
    fun xmls_of_thy_decl (name,toks,str) = (* see isar_syn.ML/thy_decl cases  *)
wenzelm@16534
   833
        let
wenzelm@16534
   834
            (* NB: PGIP only deals with single name bindings at the moment;
wenzelm@16534
   835
               potentially we could markup grouped definitions several times but
wenzelm@16534
   836
               that might suggest the wrong structure to the editor?
wenzelm@16534
   837
               Better alternative would be to put naming closer around text,
wenzelm@16534
   838
               but to do that we'd be much better off modifying the real parser
wenzelm@16534
   839
               instead of reconstructing it here. *)
aspinall@15134
   840
wenzelm@16534
   841
            val plain_items = (* no names, unimportant names, or too difficult *)
wenzelm@16534
   842
                ["defaultsort","arities","judgement","finalconsts",
wenzelm@16534
   843
                 "syntax", "nonterminals", "translations",
wenzelm@16534
   844
                 "global", "local", "hide",
wenzelm@16534
   845
                 "ML_setup", "setup", "method_setup",
wenzelm@16534
   846
                 "parse_ast_translation", "parse_translation", "print_translation",
wenzelm@16534
   847
                 "typed_print_translation", "print_ast_translation", "token_translation",
wenzelm@16534
   848
                 "oracle",
wenzelm@16534
   849
                 "declare"]
aspinall@15145
   850
wenzelm@16534
   851
            val plain_item   = markup_text str "theoryitem"
wenzelm@16534
   852
            val comment_item = markup_text str "litcomment"
wenzelm@16534
   853
            val named_item   = named_item_elt toks str "theoryitem"
aspinall@15145
   854
wenzelm@16534
   855
            val opt_overloaded = P.opt_keyword "overloaded";
aspinall@15145
   856
wenzelm@16534
   857
            val thmnameP = (* see isar_syn.ML/theoremsP *)
wenzelm@16534
   858
                let
wenzelm@16534
   859
                    val name_facts = P.and_list1 ((P.opt_thm_name "=" --| P.xthms1) >> #1)
wenzelm@16958
   860
                    val theoremsP = P.opt_locale_target |-- name_facts >> (fn [] => "" | x::_ => x)
wenzelm@16534
   861
                in
wenzelm@16534
   862
                    theoremsP
wenzelm@16534
   863
                end
wenzelm@16534
   864
        in
wenzelm@16534
   865
            (* TODO: ideally we would like to render terms properly, just as they are
wenzelm@16534
   866
               in output. This implies using PGML for symbols and variables/atoms.
wenzelm@16534
   867
               BUT it's rather tricky without having the correct concrete syntax to hand,
wenzelm@16534
   868
               and even if we did, we'd have to mess around here a whole lot more first
wenzelm@16534
   869
               to pick out the terms from the syntax. *)
aspinall@15254
   870
wenzelm@16534
   871
            if (name mem plain_items) then plain_item
wenzelm@16534
   872
            else case name of
wenzelm@16534
   873
                     "text"      => comment_item
wenzelm@16534
   874
                   | "text_raw"  => comment_item
wenzelm@16534
   875
                   | "typedecl"  => named_item (P.type_args |-- P.name) "type"
wenzelm@16534
   876
                   | "types"     => named_item (P.type_args |-- P.name) "type"
wenzelm@16534
   877
                   | "classes"   => named_item P.name "class"
wenzelm@16534
   878
                   | "classrel"  => named_item P.name "class"
wenzelm@16534
   879
                   | "consts"    => named_item (P.const >> #1) "term"
wenzelm@16534
   880
                   | "axioms"    => named_item (P.spec_name >> (#1 o #1)) "theorem"
wenzelm@16534
   881
                   | "defs"      => named_item (opt_overloaded |-- P.spec_name >> (#1 o #1)) "theorem"
wenzelm@16534
   882
                   | "constdefs" => named_item P.name (* FIXME: heavily simplified/wrong *) "term"
wenzelm@16534
   883
                   | "theorems"  => named_item thmnameP "thmset"
wenzelm@16534
   884
                   | "lemmas"    => named_item thmnameP "thmset"
wenzelm@16534
   885
                   | "oracle"    => named_item P.name "oracle"
wenzelm@16534
   886
                   | "locale"    => named_item ((P.opt_keyword "open" >> not) |-- P.name) "locale"
wenzelm@16534
   887
                   | _ => (parse_warning ("Unrecognized thy-decl command: " ^ name); plain_item)
wenzelm@16534
   888
        end
aspinall@15145
   889
wenzelm@16534
   890
    fun xmls_of_thy_goal (name,toks,str) =
wenzelm@16534
   891
        let
wenzelm@16534
   892
            (* see isar_syn.ML/gen_theorem *)
aspinall@15146
   893
         val statement = P.and_list1 (P.opt_thm_name ":" -- Scan.repeat1 P.propp);
wenzelm@16534
   894
         val general_statement =
wenzelm@16534
   895
            statement >> pair [] || Scan.repeat P.locale_elem_or_expr -- (P.$$$ "shows" |-- statement);
wenzelm@16534
   896
wenzelm@16534
   897
            val gen_theoremP =
wenzelm@16958
   898
                P.opt_locale_target -- Scan.optional (P.opt_thm_name ":" --|
aspinall@15146
   899
                 Scan.ahead (P.locale_keyword || P.$$$ "shows")) ("", []) --
wenzelm@16534
   900
                                 general_statement >> (fn ((locale, a), (elems, concl)) =>
wenzelm@16534
   901
                                                         fst a) (* a : (bstring * Args.src list) *)
aspinall@15146
   902
wenzelm@16958
   903
            val nameP = P.opt_locale_target |-- (Scan.optional ((P.opt_thm_name ":") >> #1) "")
wenzelm@16534
   904
            (* TODO: add preference values for attributes
wenzelm@16534
   905
               val prefval = XML.element "prefval" [("name","thm-kind"),("value",name)]
wenzelm@16534
   906
            *)
wenzelm@16534
   907
        in
wenzelm@16534
   908
            (thmnamed_item_elt toks str "opengoal" nameP "") @
wenzelm@16534
   909
            (empty "openblock")
wenzelm@16534
   910
        end
aspinall@15134
   911
wenzelm@17217
   912
    fun xmls_of_qed (name,markup) =
wenzelm@17217
   913
        let val qedmarkup  =
wenzelm@17217
   914
                (case name of
wenzelm@17217
   915
                     "sorry" => markup "postponegoal"
wenzelm@17217
   916
                   | "oops"  => markup "giveupgoal"
wenzelm@17217
   917
                   | "done"  => markup "closegoal"
wenzelm@17217
   918
                   | "by"    => markup "closegoal"  (* nested or toplevel *)
wenzelm@17217
   919
                   | "qed"   => markup "closegoal"  (* nested or toplevel *)
wenzelm@17217
   920
                   | "."     => markup "closegoal"  (* nested or toplevel *)
wenzelm@17217
   921
                   | ".."    => markup "closegoal"  (* nested or toplevel *)
wenzelm@17217
   922
                   | other => (* default to closegoal: may be wrong for extns *)
wenzelm@17217
   923
                                  (parse_warning
wenzelm@17217
   924
                                       ("Unrecognized qed command: " ^ quote other);
wenzelm@17217
   925
                                       markup "closegoal"))
wenzelm@17217
   926
        in qedmarkup @ (empty "closeblock") end
aspinall@15145
   927
wenzelm@16534
   928
    fun xmls_of_kind kind (name,toks,str) =
wenzelm@16534
   929
    let val markup = markup_text str in
aspinall@15145
   930
    case kind of
aspinall@15145
   931
      "control"        => markup "badcmd"
aspinall@15145
   932
    | "diag"           => markup "spuriouscmd"
aspinall@15145
   933
    (* theory/files *)
aspinall@15145
   934
    | "theory-begin"   => xmls_of_thy_begin (name,toks,str)
aspinall@15145
   935
    | "theory-decl"    => xmls_of_thy_decl (name,toks,str)
aspinall@15145
   936
    | "theory-heading" => markup "litcomment"
aspinall@15145
   937
    | "theory-script"  => markup "theorystep"
aspinall@15146
   938
    | "theory-end"     => markup "closetheory"
aspinall@15145
   939
    (* proof control *)
aspinall@15145
   940
    | "theory-goal"    => xmls_of_thy_goal (name,toks,str)
aspinall@15145
   941
    | "proof-heading"  => markup "litcomment"
aspinall@15225
   942
    | "proof-goal"     => (markup "opengoal") @ (empty "openblock")  (* nested proof: have, show, ... *)
aspinall@15145
   943
    | "proof-block"    => markup "proofstep" (* context-shift: proof, next; really "newgoal" *)
aspinall@15145
   944
    | "proof-open"     => (empty "openblock") @ (markup "proofstep")
aspinall@15145
   945
    | "proof-close"    => (markup "proofstep") @ (empty "closeblock")
aspinall@15145
   946
    | "proof-script"   => markup "proofstep"
aspinall@15145
   947
    | "proof-chain"    => markup "proofstep"
aspinall@15145
   948
    | "proof-decl"     => markup "proofstep"
aspinall@15145
   949
    | "proof-asm"      => markup "proofstep"
aspinall@15289
   950
    | "proof-asm-goal" => (markup "opengoal") @ (empty "openblock")  (* nested proof: obtain *)
aspinall@15145
   951
    | "qed"            => xmls_of_qed (name,markup)
aspinall@15145
   952
    | "qed-block"      => xmls_of_qed (name,markup)
aspinall@15145
   953
    | "qed-global"     => xmls_of_qed (name,markup)
aspinall@15145
   954
    | other => (* default for anything else is "spuriouscmd", ignored for undo. *)
aspinall@15145
   955
      (parse_warning ("Internal inconsistency, unrecognized keyword kind: " ^ quote other);
aspinall@15145
   956
       markup "spuriouscmd")
wenzelm@16534
   957
    end
aspinall@15134
   958
in
aspinall@15145
   959
wenzelm@16534
   960
fun xmls_of_transition (name,str,toks) =
wenzelm@16534
   961
   let
wenzelm@17221
   962
     val classification = Symtab.curried_lookup (get_keywords_classification_table ()) name
aspinall@15145
   963
   in case classification of
wenzelm@16534
   964
          SOME k => (xmls_of_kind k (name,toks,str))
wenzelm@16534
   965
        | NONE => (* an uncategorized keyword ignored for undo (maybe wrong) *)
wenzelm@16534
   966
          (parse_warning ("Uncategorized command found: " ^ name ^ " -- using spuriouscmd");
wenzelm@16534
   967
           markup_text str "spuriouscmd")
wenzelm@16534
   968
   end
aspinall@15145
   969
aspinall@15191
   970
fun markup_toks [] _ = []
aspinall@15191
   971
  | markup_toks toks x = markup_text (implode (map OuterLex.unparse toks)) x
aspinall@15191
   972
aspinall@15191
   973
fun markup_comment_whs [] = []
aspinall@15191
   974
  | markup_comment_whs (toks as t::ts) = (* this would be a lot neater if we could match on toks! *)
wenzelm@16534
   975
    let
wenzelm@16534
   976
        val (prewhs,rest) = take_prefix (OuterLex.is_kind OuterLex.Space) toks
wenzelm@16534
   977
    in
wenzelm@16534
   978
        if (prewhs <> []) then
wenzelm@16534
   979
            whitespace (implode (map OuterLex.unparse prewhs))
wenzelm@16534
   980
            :: (markup_comment_whs rest)
wenzelm@16534
   981
        else
wenzelm@16534
   982
            (markup_text (OuterLex.unparse t) "comment") @
wenzelm@16534
   983
            (markup_comment_whs ts)
aspinall@15191
   984
    end
aspinall@15191
   985
aspinall@15191
   986
fun xmls_pre_cmd [] = ([],[])
wenzelm@16534
   987
  | xmls_pre_cmd toks =
wenzelm@16534
   988
    let
wenzelm@16534
   989
        (* an extra token is needed to terminate the command *)
wenzelm@16534
   990
        val sync = OuterSyntax.scan "\\<^sync>";
wenzelm@16534
   991
        val spaceP = Scan.bulk (Scan.one (fn t =>not (OuterLex.is_proper t)) >> OuterLex.val_of) >> implode
wenzelm@16534
   992
        val text_with_whs =
wenzelm@16534
   993
            ((spaceP || Scan.succeed "") --
wenzelm@16534
   994
             (P.short_ident || P.long_ident || P.sym_ident || P.string || P.number || P.verbatim) >> op^)
wenzelm@16534
   995
             -- (spaceP || Scan.succeed "") >> op^
wenzelm@16534
   996
        val (prewhs,rest1) = take_prefix (not o OuterLex.is_proper) (toks@sync)
aspinall@15191
   997
        (* NB: this collapses  litcomment,(litcomment|whitespace)* to a single litcomment *)
wenzelm@16534
   998
        val (_,rest2) = (Scan.bulk (P.$$$ "--" |-- text_with_whs) >> implode || Scan.succeed "") rest1
wenzelm@16534
   999
        val (postwhs,rest3) = take_prefix (not o OuterLex.is_proper) rest2
aspinall@15145
  1000
    in
wenzelm@16534
  1001
        ((markup_comment_whs prewhs) @
wenzelm@16534
  1002
         (if (length rest2 = length rest1)  then []
wenzelm@16534
  1003
          else markup_text (implode
wenzelm@16534
  1004
                                (map OuterLex.unparse (Library.take (length rest1 - length rest2, rest1))))
wenzelm@16534
  1005
               "litcomment") @
wenzelm@16534
  1006
         (markup_comment_whs postwhs),
wenzelm@16534
  1007
         Library.take (length rest3 - 1,rest3))
aspinall@15191
  1008
    end
aspinall@15191
  1009
wenzelm@16534
  1010
fun xmls_of_impropers toks =
wenzelm@16534
  1011
    let
wenzelm@16534
  1012
        val (xmls,rest) = xmls_pre_cmd toks
aspinall@15191
  1013
    in
wenzelm@16534
  1014
        xmls @ (markup_toks rest "unparseable")
aspinall@15145
  1015
    end
wenzelm@16534
  1016
wenzelm@16534
  1017
fun markup_unparseable str = markup_text str "unparseable"
aspinall@15173
  1018
aspinall@15145
  1019
end
aspinall@15145
  1020
aspinall@15145
  1021
aspinall@15145
  1022
local
wenzelm@16534
  1023
    (* we have to weave together the whitespace/comments with proper tokens
aspinall@15145
  1024
       to reconstruct the input. *)
aspinall@15191
  1025
    (* TODO: see if duplicating isar_output/parse_thy can help here *)
aspinall@15134
  1026
aspinall@15145
  1027
    fun match_tokens ([],us,vs) = (rev vs,us)  (* used, unused *)
wenzelm@16534
  1028
      | match_tokens (t::ts,w::ws,vs) =
wenzelm@16534
  1029
        if (t = w) then match_tokens (ts,ws,w::vs)
wenzelm@16534
  1030
        else match_tokens (t::ts,ws,w::vs)
aspinall@15145
  1031
      | match_tokens _ = error ("match_tokens: mismatched input parse")
aspinall@15145
  1032
in
aspinall@15145
  1033
    fun xmls_of_str str =
wenzelm@16534
  1034
    let
aspinall@15145
  1035
       (* parsing:   See outer_syntax.ML/toplevel_source *)
aspinall@15145
  1036
       fun parse_loop ([],[],xmls) = xmls
wenzelm@16534
  1037
         | parse_loop ([],itoks,xmls) = xmls @ (xmls_of_impropers itoks)
wenzelm@16534
  1038
         | parse_loop ((nm,toks,_)::trs,itoks,xmls) =
wenzelm@16534
  1039
           let
wenzelm@16534
  1040
               (* first proper token after whitespace/litcomment/whitespace is command *)
wenzelm@16534
  1041
               val (xmls_pre_cmd,cmditoks') = xmls_pre_cmd itoks
wenzelm@16534
  1042
               val (cmdtok,itoks') = case cmditoks' of x::xs => (x,xs)
wenzelm@16534
  1043
                                                     | _ => error("proof_general/parse_loop impossible")
wenzelm@16534
  1044
               val (utoks,itoks'') = match_tokens (toks,itoks',[])
aspinall@15145
  1045
               (* FIXME: should take trailing [w/s+] semicolon too in utoks *)
aspinall@15145
  1046
wenzelm@16534
  1047
               val str = implode (map OuterLex.unparse (cmdtok::utoks))
aspinall@15145
  1048
wenzelm@16534
  1049
               val xmls_tr  = xmls_of_transition (nm,str,toks)
wenzelm@16534
  1050
           in
wenzelm@16534
  1051
               parse_loop(trs,itoks'',xmls @ xmls_pre_cmd @ xmls_tr)
wenzelm@16534
  1052
           end
aspinall@15134
  1053
    in
wenzelm@16534
  1054
        (let val toks = OuterSyntax.scan str
wenzelm@16534
  1055
         in
wenzelm@16534
  1056
             parse_loop (OuterSyntax.read toks, toks, [])
wenzelm@16534
  1057
         end)
wenzelm@16534
  1058
           handle _ => markup_unparseable str
aspinall@15134
  1059
    end
aspinall@15134
  1060
aspinall@15134
  1061
wenzelm@16534
  1062
fun parsescript str attrs =
wenzelm@16534
  1063
    let
wenzelm@16534
  1064
        val _ = start_delay_msgs ()  (* accumulate error messages to put inside parseresult *)
wenzelm@16534
  1065
        val xmls = xmls_of_str str
aspinall@15173
  1066
        val errs = end_delayed_msgs ()
wenzelm@16534
  1067
     in
wenzelm@16534
  1068
        issue_pgips [XML.element "parseresult" attrs (errs@xmls)]
aspinall@15173
  1069
    end
aspinall@15134
  1070
end
aspinall@15134
  1071
aspinall@15134
  1072
aspinall@15134
  1073
aspinall@15134
  1074
(**** PGIP:  Isabelle -> Interface ****)
aspinall@15134
  1075
wenzelm@16534
  1076
val isabelle_pgml_version_supported = "1.0";
aspinall@15145
  1077
val isabelle_pgip_version_supported = "2.0"
aspinall@15134
  1078
aspinall@16798
  1079
(* TODO: would be cleaner to define a datatype here for the accepted elements,
aspinall@16798
  1080
   and mapping functions to/from strings.  At the moment this list must
aspinall@16798
  1081
   coincide with the strings in the function process_pgip_element. *)
wenzelm@17217
  1082
val isabelle_acceptedpgipelems =
aspinall@16798
  1083
    ["askpgip","askpgml","askprefs","getpref","setpref",
aspinall@16798
  1084
     "proverinit","proverexit","startquiet","stopquiet",
aspinall@16798
  1085
     "pgmlsymbolson", "pgmlsymbolsoff",
aspinall@16798
  1086
     "dostep", "undostep", "redostep", "abortgoal", "forget", "restoregoal",
aspinall@16798
  1087
     "askids", "showid", "askguise",
aspinall@16798
  1088
     "parsescript",
aspinall@16798
  1089
     "showproofstate", "showctxt", "searchtheorems", "setlinewidth", "viewdoc",
aspinall@16798
  1090
     "doitem", "undoitem", "redoitem", "abortheory",
aspinall@16798
  1091
     "retracttheory", "loadfile", "openfile", "closefile",
aspinall@16798
  1092
     "abortfile", "changecwd", "systemcmd"];
aspinall@16798
  1093
wenzelm@16534
  1094
fun usespgip () =
wenzelm@17217
  1095
    issue_pgip
wenzelm@17217
  1096
        "usespgip"
wenzelm@17217
  1097
        [("version", isabelle_pgip_version_supported)]
wenzelm@17217
  1098
        (XML.element "acceptedpgipelems" []
wenzelm@17217
  1099
                     (map (fn s=>XML.element "pgipelem"
wenzelm@17217
  1100
                                             [] (* if threads: possibility to add async here *)
wenzelm@17217
  1101
                                             [s])
wenzelm@17217
  1102
                          isabelle_acceptedpgipelems))
aspinall@15134
  1103
wenzelm@16534
  1104
fun usespgml () =
aspinall@16798
  1105
    issue_pgipe "usespgml" [("version", isabelle_pgml_version_supported)]
aspinall@15134
  1106
wenzelm@16534
  1107
fun hasprefs () =
skalberg@15570
  1108
    List.app (fn (prefcat, prefs) =>
wenzelm@16534
  1109
            issue_pgips [XML.element "hasprefs" [("prefcategory",prefcat)]
wenzelm@16534
  1110
                 (map (fn (name, (descr, (ty, (default,_),_))) =>
wenzelm@16534
  1111
                       XML.element "haspref" [("name", name),
wenzelm@16534
  1112
                                              ("descr", descr),
wenzelm@16534
  1113
                                              ("default", default)]
aspinall@16798
  1114
                       [ty]) prefs)]) (!preferences)
aspinall@15134
  1115
skalberg@15570
  1116
fun allprefs () = Library.foldl (op @) ([], map snd (!preferences))
wenzelm@16534
  1117
wenzelm@16534
  1118
fun setpref name value =
aspinall@15134
  1119
    (case assoc (allprefs(), name) of
wenzelm@16534
  1120
         NONE => warning ("Unknown pref: " ^ quote name)
skalberg@15531
  1121
       | SOME (_, (_, _, set)) => set value);
aspinall@15134
  1122
wenzelm@16534
  1123
fun getpref name =
aspinall@15134
  1124
    (case assoc (allprefs(), name) of
wenzelm@16534
  1125
         NONE => warning ("Unknown pref: " ^ quote name)
wenzelm@16534
  1126
       | SOME (_, (_, (_,get), _)) =>
wenzelm@16534
  1127
           issue_pgip "prefval" [("name", name)] (get ()));
aspinall@15134
  1128
aspinall@15134
  1129
aspinall@15134
  1130
aspinall@15134
  1131
(**** PGIP:  Interface -> Isabelle/Isar ****)
aspinall@15134
  1132
aspinall@15134
  1133
exception PGIP of string;
aspinall@15134
  1134
exception PGIP_QUIT;
aspinall@15134
  1135
wenzelm@16534
  1136
aspinall@15134
  1137
(* Sending commands to Isar *)
aspinall@15134
  1138
wenzelm@16534
  1139
fun isarcmd s =
wenzelm@16534
  1140
    s |> OuterSyntax.scan |> OuterSyntax.read
aspinall@15145
  1141
      |> map (Toplevel.position (Position.name "PGIP message") o #3) |> Toplevel.>>>;
aspinall@15134
  1142
aspinall@15145
  1143
fun xmltext ((XML.Text text)::ts) = text ^ (xmltext ts)
aspinall@15145
  1144
  | xmltext [] = ""
aspinall@15145
  1145
  | xmltext _ = raise PGIP "Expected text (PCDATA/CDATA)"
wenzelm@16534
  1146
aspinall@15145
  1147
fun isarscript xmls = isarcmd (xmltext xmls)   (* send a script command *)
aspinall@15134
  1148
aspinall@15134
  1149
aspinall@16791
  1150
(* load an arbitrary file (must be .thy or .ML) *)
aspinall@15134
  1151
wenzelm@16534
  1152
fun use_thy_or_ml_file file =
aspinall@15134
  1153
    let
wenzelm@16534
  1154
        val (path,extn) = Path.split_ext (Path.unpack file)
aspinall@15134
  1155
    in
wenzelm@16534
  1156
        case extn of
wenzelm@16534
  1157
            "" => isarcmd ("use_thy " ^ (quote (Path.pack path)))
wenzelm@16534
  1158
          | "thy" => isarcmd ("use_thy " ^ (quote (Path.pack path)))
wenzelm@16534
  1159
          | "ML" => isarcmd ("use " ^ quote file)
wenzelm@16534
  1160
          | other => error ("Don't know how to read a file with extension " ^ other)
wenzelm@16534
  1161
    end
aspinall@15134
  1162
aspinall@15134
  1163
aspinall@15173
  1164
(* Proof control commands *)
aspinall@15134
  1165
aspinall@15173
  1166
local
aspinall@15173
  1167
  fun xmlattro attr attrs = assoc(attrs,attr)
aspinall@15134
  1168
wenzelm@16534
  1169
  fun xmlattr attr attrs =
wenzelm@16534
  1170
      (case xmlattro attr attrs of
wenzelm@16534
  1171
           SOME value => value
wenzelm@16534
  1172
         | NONE => raise PGIP ("Missing attribute: " ^ attr))
aspinall@15134
  1173
aspinall@15173
  1174
  val thyname_attro = xmlattro "thyname"
aspinall@15173
  1175
  val thyname_attr = xmlattr "thyname"
aspinall@15173
  1176
  val objtype_attro = xmlattro "objtype"
aspinall@15173
  1177
  val objtype_attr = xmlattr "objtype"
aspinall@15173
  1178
  val name_attr = xmlattr "name"
aspinall@15173
  1179
  val dirname_attr = xmlattr "dir"
aspinall@15134
  1180
  fun comment x = "(* " ^ x ^ " *)"
aspinall@15134
  1181
aspinall@15173
  1182
  fun localfile_of_url url = (* only handle file:/// or file://localhost/ *)
aspinall@15173
  1183
      case Url.unpack url of
wenzelm@16534
  1184
          (Url.File path) => File.platform_path path
wenzelm@16534
  1185
        | _ => error ("Cannot access non-local URL " ^ url)
aspinall@15134
  1186
aspinall@15173
  1187
  val fileurl_of = localfile_of_url o (xmlattr "url")
aspinall@15134
  1188
aspinall@15134
  1189
  val topthy = Toplevel.theory_of o Toplevel.get_state
wenzelm@16440
  1190
  val topthy_name = Context.theory_name o topthy
aspinall@15134
  1191
skalberg@15531
  1192
  val currently_open_file = ref (NONE : string option)
aspinall@15629
  1193
aspinall@16791
  1194
  (* Path management: we allow theory files to have dependencies
aspinall@16791
  1195
     in their own directory, but when we change directory for a new
aspinall@16791
  1196
     file we remove the path.  Leaving it there can cause confusion
aspinall@16791
  1197
     with difference in batch mode.a  NB: PGIP does not assume
aspinall@16791
  1198
     that the prover has a load path. *)
wenzelm@17217
  1199
  local
aspinall@16791
  1200
      val current_working_dir = ref (NONE : string option)
aspinall@16791
  1201
  in
wenzelm@17217
  1202
      fun changecwd dir =
wenzelm@17217
  1203
          (case (!current_working_dir) of
wenzelm@17217
  1204
               NONE => ()
aspinall@16791
  1205
             | SOME dir => ThyLoad.del_path dir;
wenzelm@17217
  1206
           ThyLoad.add_path dir;
wenzelm@17217
  1207
           current_working_dir := SOME dir)
aspinall@16791
  1208
  end
aspinall@16791
  1209
aspinall@15629
  1210
  val topnode = Toplevel.node_of o Toplevel.get_state
wenzelm@16534
  1211
  fun topproofpos () = (case topnode() of Toplevel.Proof ph => SOME(ProofHistory.position ph)
wenzelm@16534
  1212
                                        | _ => NONE) handle Toplevel.UNDEF => NONE
aspinall@15134
  1213
in
aspinall@15134
  1214
wenzelm@16534
  1215
fun process_pgip_element pgipxml = (case pgipxml of
aspinall@15145
  1216
  (XML.Text t) => warning ("Ignored text in PGIP packet: \n" ^ t)
wenzelm@16534
  1217
| (xml as (XML.Elem (elem, attrs, data))) =>
aspinall@15145
  1218
  (case elem of
aspinall@15145
  1219
       (* protocol config *)
wenzelm@16534
  1220
       "askpgip"        => (pgip_emacs_compatibility_flag:=false; (* PG>=3.6 or other PGIP interface *)
wenzelm@16534
  1221
                            usespgip (); send_pgip_config ())
wenzelm@16534
  1222
     | "askpgml"        => usespgml ()
aspinall@15145
  1223
     (* proverconfig *)
wenzelm@16534
  1224
     | "askprefs"       => hasprefs ()
wenzelm@16534
  1225
     | "getpref"        => getpref (name_attr attrs)
wenzelm@16534
  1226
     | "setpref"        => setpref (name_attr attrs) (xmltext data)
aspinall@15145
  1227
     (* provercontrol *)
wenzelm@16534
  1228
     | "proverinit"     => isar_restart ()
wenzelm@16534
  1229
     | "proverexit"     => isarcmd "quit"
wenzelm@16534
  1230
     | "startquiet"     => isarcmd "disable_pr"
wenzelm@16534
  1231
     | "stopquiet"      => isarcmd "enable_pr"
wenzelm@17217
  1232
     | "pgmlsymbolson"   => change print_mode (insert (op =) Symbol.xsymbolsN)
wenzelm@17217
  1233
     | "pgmlsymbolsoff"  => change print_mode (remove (op =) Symbol.xsymbolsN)
aspinall@15145
  1234
     (* properproofcmd: proper commands which belong in script *)
aspinall@15401
  1235
     (* FIXME: next ten are by Eclipse interface, can be removed in favour of dostep *)
aspinall@15629
  1236
     (* NB: Isar doesn't make lemma name of goal accessible during proof *)
aspinall@15145
  1237
     | "opengoal"       => isarscript data
aspinall@15145
  1238
     | "proofstep"      => isarscript data
aspinall@15145
  1239
     | "closegoal"      => isarscript data
aspinall@15145
  1240
     | "giveupgoal"     => isarscript data
aspinall@15145
  1241
     | "postponegoal"   => isarscript data
wenzelm@16534
  1242
     | "comment"        => isarscript data  (* NB: should be ignored, but process anyway *)
wenzelm@16534
  1243
     | "whitespace"     => isarscript data  (* NB: should be ignored, but process anyway *)
aspinall@15145
  1244
     | "litcomment"     => isarscript data
aspinall@15145
  1245
     | "spuriouscmd"    => isarscript data
wenzelm@16534
  1246
     | "badcmd"         => isarscript data
aspinall@15145
  1247
     (* improperproofcmd: improper commands which *do not* belong in script *)
aspinall@15401
  1248
     | "dostep"         => isarscript data
aspinall@15286
  1249
     | "undostep"       => isarcmd "undos_proof 1"
aspinall@15626
  1250
     | "redostep"       => isarcmd "redo"
wenzelm@16534
  1251
     | "abortgoal"      => isarcmd "ProofGeneral.kill_proof"
wenzelm@16534
  1252
     | "forget"         => error "Not implemented"
aspinall@15145
  1253
     | "restoregoal"    => error "Not implemented"  (* could just treat as forget? *)
aspinall@15145
  1254
     (* proofctxt: improper commands *)
aspinall@15173
  1255
     | "askids"         => askids (thyname_attro attrs, objtype_attro attrs)
wenzelm@16534
  1256
     | "showid"         => showid (thyname_attro attrs, objtype_attr attrs, name_attr attrs)
wenzelm@16534
  1257
     | "askguise"       => send_informguise (!currently_open_file,
wenzelm@16534
  1258
                                             SOME (topthy_name()) handle Toplevel.UNDEF => NONE,
wenzelm@16534
  1259
                                             topproofpos())
aspinall@15173
  1260
     | "parsescript"    => parsescript (xmltext data) attrs (* just pass back attrs unchanged *)
aspinall@15145
  1261
     | "showproofstate" => isarcmd "pr"
aspinall@15145
  1262
     | "showctxt"       => isarcmd "print_theory"   (* more useful than print_context *)
wenzelm@17217
  1263
     | "searchtheorems" => isarcmd ("thms_containing " ^ xmltext data)
wenzelm@17217
  1264
     | "setlinewidth"   => isarcmd ("pretty_setmargin " ^ xmltext data)
wenzelm@17217
  1265
     | "viewdoc"        => isarcmd ("print_" ^ xmltext data) (* FIXME: isatool doc? *)
aspinall@15145
  1266
     (* properfilecmd: proper theory-level script commands *)
aspinall@15401
  1267
     (* FIXME: next three are sent by Eclipse, can be removed in favour of doitem *)
aspinall@15145
  1268
     | "opentheory"     => isarscript data
aspinall@15145
  1269
     | "theoryitem"     => isarscript data
wenzelm@16534
  1270
     | "closetheory"    => let
wenzelm@16534
  1271
                              val thyname = topthy_name()
wenzelm@16534
  1272
                           in (isarscript data;
wenzelm@17217
  1273
                               writeln ("Theory " ^ quote thyname ^ " completed."))
wenzelm@16534
  1274
                           end
aspinall@15145
  1275
     (* improperfilecmd: theory-level commands not in script *)
aspinall@15401
  1276
     | "doitem"         => isarscript data
aspinall@15286
  1277
     | "undoitem"       => isarcmd "ProofGeneral.undo"
aspinall@15626
  1278
     | "redoitem"       => isarcmd "ProofGeneral.redo"
aspinall@15145
  1279
     | "aborttheory"    => isarcmd ("init_toplevel")
wenzelm@17217
  1280
     | "retracttheory"  => isarcmd ("kill_thy " ^ quote (thyname_attr attrs))
aspinall@15173
  1281
     | "loadfile"       => use_thy_or_ml_file (fileurl_of attrs)
aspinall@15629
  1282
     | "openfile"       => (openfile_retract (fileurl_of attrs);
wenzelm@16534
  1283
                            currently_open_file := SOME (fileurl_of attrs))
wenzelm@16534
  1284
     | "closefile"      => (case !currently_open_file of
wenzelm@16534
  1285
                                SOME f => (inform_file_processed f;
wenzelm@16534
  1286
                                           currently_open_file := NONE)
wenzelm@16534
  1287
                              | NONE => raise PGIP ("closefile when no file is open!"))
skalberg@15531
  1288
     | "abortfile"      => (currently_open_file := NONE) (* perhaps error for no file open *)
aspinall@16791
  1289
     | "changecwd"      => changecwd (dirname_attr attrs)
wenzelm@16534
  1290
     | "systemcmd"      => isarscript data
aspinall@15145
  1291
     (* unofficial command for debugging *)
wenzelm@16534
  1292
     | "quitpgip" => raise PGIP_QUIT
aspinall@15145
  1293
     | _ => raise PGIP ("Unrecognized PGIP element: " ^ elem)))
aspinall@15134
  1294
wenzelm@16534
  1295
fun process_pgip_tree xml =
aspinall@16821
  1296
    (pgip_refid := NONE;
aspinall@16821
  1297
     pgip_refseq := NONE;
aspinall@15173
  1298
     (case xml of
wenzelm@16534
  1299
          XML.Elem ("pgip", attrs, pgips) =>
wenzelm@16534
  1300
          (let
wenzelm@16534
  1301
               val class = xmlattr "class" attrs
wenzelm@17217
  1302
               val dest  = xmlattro "destid" attrs
aspinall@16821
  1303
               val _ = (pgip_refid :=  xmlattro "id" attrs;
wenzelm@17217
  1304
                        pgip_refseq := xmlattro "seq" attrs)
wenzelm@16534
  1305
           in
wenzelm@17217
  1306
               (* We respond to broadcast messages to provers, or
aspinall@16821
  1307
                  messages intended uniquely for us.  Silently ignore rest. *)
aspinall@16821
  1308
               case dest of
wenzelm@17217
  1309
                   NONE => if (class = "pa") then
wenzelm@17217
  1310
                               (List.app process_pgip_element pgips; true)
wenzelm@17217
  1311
                           else false
wenzelm@17217
  1312
                 | SOME id => if (matching_pgip_id id) then
wenzelm@17217
  1313
                                  (List.app process_pgip_element pgips; true)
wenzelm@17217
  1314
                              else false
wenzelm@16534
  1315
           end)
wenzelm@16534
  1316
        | _ => raise PGIP "Invalid PGIP packet received")
wenzelm@16534
  1317
     handle (PGIP msg) =>
wenzelm@16534
  1318
            (error (msg ^ "\nPGIP error occured in XML text below:\n" ^
wenzelm@16534
  1319
                    (XML.string_of_tree xml))))
aspinall@15134
  1320
aspinall@16821
  1321
val process_pgip = K () o process_pgip_tree o XML.tree_of_string
aspinall@15191
  1322
aspinall@15134
  1323
end
aspinall@15134
  1324
aspinall@15134
  1325
aspinall@15134
  1326
(* PGIP loop: process PGIP input only *)
aspinall@15134
  1327
wenzelm@16534
  1328
local
aspinall@15134
  1329
aspinall@15145
  1330
exception XML_PARSE
aspinall@15134
  1331
aspinall@16821
  1332
fun loop ready src =
wenzelm@16534
  1333
    let
aspinall@16821
  1334
        val _ = if ready then (issue_pgipe "ready" []) else ()
wenzelm@16534
  1335
        val pgipo = (Source.get_single src)
wenzelm@16534
  1336
                        handle e => raise XML_PARSE
aspinall@15134
  1337
    in
wenzelm@16534
  1338
        case pgipo of
wenzelm@16534
  1339
             NONE  => ()
wenzelm@16534
  1340
           | SOME (pgip,src') =>
wenzelm@17217
  1341
             let
wenzelm@17217
  1342
                 val ready' = (process_pgip_tree pgip) handle e => (handler (e,SOME src'); true)
wenzelm@17217
  1343
             in
wenzelm@17217
  1344
                 loop ready' src'
wenzelm@17217
  1345
             end
skalberg@15531
  1346
    end handle e => handler (e,SOME src)  (* i.e. error in ready/XML parse *)
aspinall@15134
  1347
wenzelm@16534
  1348
and handler (e,srco) =
aspinall@15145
  1349
    case (e,srco) of
wenzelm@16534
  1350
        (XML_PARSE,SOME src) =>
aspinall@16821
  1351
        panic "Invalid XML input, aborting" (* NB: loop OK for tty, but want exit on EOF *)
aspinall@15145
  1352
      | (PGIP_QUIT,_) => ()
aspinall@16821
  1353
      | (ERROR,SOME src) => loop true src (* message already given *)
aspinall@16821
  1354
      | (Interrupt,SOME src) => (!error_fn "Interrupt during PGIP processing"; loop true src)
aspinall@16821
  1355
      | (Toplevel.UNDEF,SOME src) => (error "No working context defined"; loop true src) (* usually *)
aspinall@16821
  1356
      | (e,SOME src) => (error (Toplevel.exn_message e); loop true src)
skalberg@15531
  1357
      | (_,NONE) => ()
aspinall@15134
  1358
in
aspinall@15145
  1359
  (* NB: simple tty for now; later might read from other tty-style sources (e.g. sockets). *)
aspinall@15145
  1360
aspinall@15145
  1361
  val xmlP = XML.scan_comment_whspc |-- XML.parse_elem >> single
aspinall@15145
  1362
skalberg@15531
  1363
  val tty_src = Source.set_prompt "" (Source.source Symbol.stopper xmlP NONE Source.tty)
aspinall@15145
  1364
haftmann@16824
  1365
  fun pgip_toplevel x = loop true x
aspinall@15134
  1366
end
aspinall@15134
  1367
aspinall@15134
  1368
aspinall@15134
  1369
(* additional outer syntax for Isar *)
wenzelm@12778
  1370
wenzelm@17057
  1371
local structure P = OuterParse and K = OuterKeyword in
wenzelm@12778
  1372
wenzelm@16534
  1373
val undoP = (*undo without output*)
wenzelm@12778
  1374
  OuterSyntax.improper_command "ProofGeneral.undo" "(internal)" K.control
wenzelm@12778
  1375
    (Scan.succeed (Toplevel.no_timing o IsarCmd.undo));
wenzelm@12778
  1376
wenzelm@16534
  1377
val redoP = (*redo without output*)
aspinall@15626
  1378
  OuterSyntax.improper_command "ProofGeneral.redo" "(internal)" K.control
aspinall@15626
  1379
    (Scan.succeed (Toplevel.no_timing o IsarCmd.redo));
aspinall@15626
  1380
wenzelm@12778
  1381
val context_thy_onlyP =
wenzelm@12778
  1382
  OuterSyntax.improper_command "ProofGeneral.context_thy_only" "(internal)" K.control
wenzelm@12778
  1383
    (P.name >> (Toplevel.no_timing oo IsarThy.init_context update_thy_only));
wenzelm@12778
  1384
wenzelm@12778
  1385
val try_context_thy_onlyP =
wenzelm@12778
  1386
  OuterSyntax.improper_command "ProofGeneral.try_context_thy_only" "(internal)" K.control
wenzelm@12778
  1387
    (P.name >> (Toplevel.no_timing oo
wenzelm@12778
  1388
      (Toplevel.imperative (K ()) oo IsarThy.init_context try_update_thy_only)));
wenzelm@12778
  1389
wenzelm@12778
  1390
val restartP =
wenzelm@12778
  1391
  OuterSyntax.improper_command "ProofGeneral.restart" "(internal)" K.control
wenzelm@12778
  1392
    (P.opt_unit >> (Toplevel.no_timing oo K (Toplevel.imperative isar_restart)));
wenzelm@12778
  1393
wenzelm@12778
  1394
val kill_proofP =
wenzelm@12778
  1395
  OuterSyntax.improper_command "ProofGeneral.kill_proof" "(internal)" K.control
wenzelm@12778
  1396
    (Scan.succeed (Toplevel.no_timing o IsarCmd.kill_proof_notify tell_clear_goals));
wenzelm@12778
  1397
wenzelm@12778
  1398
val inform_file_processedP =
wenzelm@12778
  1399
  OuterSyntax.improper_command "ProofGeneral.inform_file_processed" "(internal)" K.control
wenzelm@14902
  1400
    (P.name >> (fn file => Toplevel.no_timing o
wenzelm@14902
  1401
      Toplevel.keep (vacuous_inform_file_processed file) o
wenzelm@14902
  1402
      Toplevel.kill o
wenzelm@14902
  1403
      Toplevel.keep (proper_inform_file_processed file)));
wenzelm@12778
  1404
wenzelm@12778
  1405
val inform_file_retractedP =
wenzelm@12778
  1406
  OuterSyntax.improper_command "ProofGeneral.inform_file_retracted" "(internal)" K.control
wenzelm@12778
  1407
    (P.name >> (Toplevel.no_timing oo
wenzelm@14902
  1408
      (fn file => Toplevel.imperative (fn () => inform_file_retracted file))));
wenzelm@12778
  1409
wenzelm@14725
  1410
val process_pgipP =
wenzelm@14725
  1411
  OuterSyntax.improper_command "ProofGeneral.process_pgip" "(internal)" K.control
wenzelm@14725
  1412
    (P.text >> (Toplevel.no_timing oo
wenzelm@14725
  1413
      (fn txt => Toplevel.imperative (fn () => process_pgip txt))));
wenzelm@14725
  1414
wenzelm@12778
  1415
fun init_outer_syntax () = OuterSyntax.add_parsers
aspinall@15626
  1416
 [undoP, redoP, restartP, kill_proofP, context_thy_onlyP, try_context_thy_onlyP,
wenzelm@14725
  1417
  inform_file_processedP, inform_file_retractedP, process_pgipP];
wenzelm@12778
  1418
wenzelm@12778
  1419
end;
wenzelm@12778
  1420
wenzelm@12778
  1421
wenzelm@12778
  1422
(* init *)
wenzelm@12778
  1423
wenzelm@12778
  1424
val initialized = ref false;
wenzelm@12778
  1425
wenzelm@16534
  1426
fun set_prompts true _ = ml_prompts "ML> " "ML# "
aspinall@15134
  1427
  | set_prompts false true = ml_prompts "PGIP-ML>" "PGIP-ML# "
wenzelm@17217
  1428
  | set_prompts false false = ml_prompts ("> " ^ special "372") ("- " ^ special "373");
aspinall@15134
  1429
aspinall@15134
  1430
fun init_setup isar pgip =
wenzelm@16534
  1431
  (conditional (not (! initialized)) (fn () =>
wenzelm@12778
  1432
   (if isar then setmp warning_fn (K ()) init_outer_syntax () else ();
wenzelm@12778
  1433
    setup_xsymbols_output ();
aspinall@15134
  1434
    setup_pgml_output ();
wenzelm@12778
  1435
    setup_messages ();
wenzelm@12778
  1436
    setup_state ();
wenzelm@12778
  1437
    setup_thy_loader ();
wenzelm@13526
  1438
    setup_present_hook ();
wenzelm@12778
  1439
    set initialized; ()));
wenzelm@12778
  1440
  sync_thy_loader ();
wenzelm@17217
  1441
  change print_mode (cons proof_generalN o remove (op =) proof_generalN);
wenzelm@16534
  1442
  if pgip then
aspinall@16821
  1443
      (init_pgip_session_id();
wenzelm@17217
  1444
       change print_mode (append [pgmlN, pgmlatomsN] o fold (remove (op =)) [pgmlN, pgmlatomsN]))
wenzelm@16534
  1445
  else
wenzelm@16534
  1446
    pgip_emacs_compatibility_flag := true;  (* assume this for PG <3.6 compatibility *)
wenzelm@12778
  1447
  set quick_and_dirty;
wenzelm@12778
  1448
  ThmDeps.enable ();
aspinall@15134
  1449
  set_prompts isar pgip;
wenzelm@16534
  1450
  pgip_active := pgip);
aspinall@15134
  1451
wenzelm@16534
  1452
fun init isar =
wenzelm@16534
  1453
 (init_setup isar false;
wenzelm@16534
  1454
  if isar then Isar.sync_main () else isa_restart ());
aspinall@15134
  1455
wenzelm@16534
  1456
fun init_pgip false = panic "PGIP not supported for Isabelle/classic mode."
wenzelm@16534
  1457
  | init_pgip true = (init_setup true true; pgip_toplevel tty_src);
wenzelm@12778
  1458
wenzelm@12778
  1459
wenzelm@12778
  1460
wenzelm@16534
  1461
(** generate elisp file for keyword classification **)
wenzelm@12778
  1462
wenzelm@12778
  1463
local
wenzelm@12778
  1464
wenzelm@12778
  1465
val regexp_meta = explode ".*+?[]^$";
wenzelm@16534
  1466
val regexp_quote =
wenzelm@16534
  1467
  implode o map (fn c => if c mem_string regexp_meta then "\\\\" ^ c else c) o explode;
wenzelm@12778
  1468
wenzelm@12778
  1469
fun defconst name strs =
wenzelm@12778
  1470
  "\n(defconst isar-keywords-" ^ name ^
wenzelm@12778
  1471
  "\n  '(" ^ space_implode "\n    " (map (quote o regexp_quote) strs) ^ "))\n";
wenzelm@12778
  1472
wenzelm@16534
  1473
fun make_elisp_commands commands kind = defconst kind
wenzelm@16534
  1474
  (commands |> List.mapPartial (fn (c, _, k, _) => if k = kind then SOME c else NONE));
wenzelm@12778
  1475
wenzelm@12778
  1476
fun make_elisp_syntax (keywords, commands) =
wenzelm@12778
  1477
  ";;\n\
wenzelm@12778
  1478
  \;; Keyword classification tables for Isabelle/Isar.\n\
wenzelm@12778
  1479
  \;; This file was generated by " ^ Session.name () ^ " -- DO NOT EDIT!\n\
wenzelm@12778
  1480
  \;;\n\
wenzelm@12778
  1481
  \;; $" ^ "Id$\n\
wenzelm@12778
  1482
  \;;\n" ^
wenzelm@12778
  1483
  defconst "major" (map #1 commands) ^
skalberg@15570
  1484
  defconst "minor" (List.filter Syntax.is_identifier keywords) ^
wenzelm@17057
  1485
  implode (map (make_elisp_commands commands) OuterKeyword.kinds) ^
wenzelm@12778
  1486
  "\n(provide 'isar-keywords)\n";
wenzelm@12778
  1487
wenzelm@12778
  1488
in
wenzelm@12778
  1489
wenzelm@12778
  1490
fun write_keywords s =
wenzelm@16534
  1491
 (init_outer_syntax ();
wenzelm@16534
  1492
  File.write (Path.unpack ("isar-keywords" ^ (if s = "" then "" else "-" ^ s) ^".el"))
wenzelm@16534
  1493
    (make_elisp_syntax (OuterSyntax.dest_keywords (), OuterSyntax.dest_parsers ())));
wenzelm@12778
  1494
wenzelm@12778
  1495
end;
wenzelm@12778
  1496
wenzelm@16534
  1497
end;