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