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