src/Pure/ProofGeneral/proof_general_pgip.ML
author aspinall
Mon Dec 04 22:12:08 2006 +0100 (2006-12-04)
changeset 21642 54b00ca67e0e
parent 21637 a7b156c404e2
child 21646 c07b5b0e8492
permissions -rw-r--r--
Add separate PG Emacs configuration
aspinall@21637
     1
(*  Title:      Pure/ProofGeneral/proof_general_pgip.ML
aspinall@21637
     2
    ID:         $Id$
aspinall@21637
     3
    Author:     David Aspinall and Markus Wenzel
aspinall@21637
     4
aspinall@21637
     5
Isabelle configuration for Proof General using PGIP protocol.
aspinall@21637
     6
See http://proofgeneral.inf.ed.ac.uk/kit  
aspinall@21637
     7
*)
aspinall@21637
     8
aspinall@21637
     9
aspinall@21637
    10
signature PROOF_GENERAL_PGIP =
aspinall@21637
    11
sig
aspinall@21642
    12
  val init_pgip: bool -> unit		  (* main PGIP loop with true; fail with false *)
aspinall@21642
    13
aspinall@21642
    14
  val process_pgip: string -> unit        (* process a command; only good for preferences *)
aspinall@21642
    15
  val init_pgip_session_id: unit -> unit  (* call before using process_pgip *)
aspinall@21637
    16
end
aspinall@21637
    17
aspinall@21637
    18
structure ProofGeneralPgip : PROOF_GENERAL_PGIP  =
aspinall@21637
    19
struct
aspinall@21637
    20
aspinall@21637
    21
structure P = OuterParse;
aspinall@21637
    22
aspinall@21637
    23
open Pgip;
aspinall@21637
    24
aspinall@21637
    25
(* print modes *)
aspinall@21637
    26
aspinall@21637
    27
val proof_generalN = "ProofGeneral";  (*token markup (colouring vars, etc.)*)
aspinall@21637
    28
val xsymbolsN = Symbol.xsymbolsN;     (*X-Symbol symbols*)
aspinall@21637
    29
val pgmlN = "PGML";                   (*XML escapes and PGML symbol elements*)
aspinall@21637
    30
val pgmlatomsN = "PGMLatoms";         (*variable kind decorations*)
aspinall@21637
    31
val thm_depsN = "thm_deps";           (*meta-information about theorem deps*)
aspinall@21637
    32
aspinall@21637
    33
aspinall@21637
    34
(* text output: print modes for xsymbol and PGML *)
aspinall@21637
    35
aspinall@21637
    36
local
aspinall@21637
    37
aspinall@21637
    38
fun xsym_output "\\" = "\\\\"
aspinall@21637
    39
  | xsym_output s = if Symbol.is_raw s then Symbol.decode_raw s else s;
aspinall@21637
    40
aspinall@21637
    41
fun xsymbols_output s =
aspinall@21637
    42
  if Output.has_mode xsymbolsN andalso exists_string (equal "\\") s then
aspinall@21637
    43
    let val syms = Symbol.explode s
aspinall@21637
    44
    in (implode (map xsym_output syms), real (Symbol.length syms)) end
aspinall@21637
    45
  else Symbol.default_output s;
aspinall@21637
    46
aspinall@21637
    47
(* XML immediately rendered pretty printer. Take care not to double escape *)
aspinall@21637
    48
fun pgml_sym s =
aspinall@21637
    49
  (case Symbol.decode s of
aspinall@21637
    50
    Symbol.Char s => XML.text s
aspinall@21637
    51
  | Symbol.Sym sn => XML.element "sym" [("name", sn)] [XML.text s] 
aspinall@21637
    52
  | Symbol.Ctrl sn => XML.element "ctrl" [("name", sn)] [XML.text s] (* FIXME: no such PGML! *)
aspinall@21637
    53
  | Symbol.Raw s => s);
aspinall@21637
    54
aspinall@21637
    55
fun pgml_output str =
aspinall@21637
    56
  let val syms = Symbol.explode str
aspinall@21637
    57
  in (implode (map pgml_sym syms), real (Symbol.length syms)) end;
aspinall@21637
    58
aspinall@21637
    59
in
aspinall@21637
    60
aspinall@21637
    61
fun setup_xsymbols_output () =
aspinall@21637
    62
  Output.add_mode xsymbolsN
aspinall@21637
    63
    (xsymbols_output, K xsymbols_output, Symbol.default_indent, Symbol.encode_raw);
aspinall@21637
    64
aspinall@21637
    65
fun setup_pgml_output () =
aspinall@21637
    66
  Output.add_mode pgmlN
aspinall@21637
    67
    (pgml_output, K pgml_output, Symbol.default_indent, Symbol.encode_raw);
aspinall@21637
    68
aspinall@21637
    69
end;
aspinall@21637
    70
aspinall@21637
    71
aspinall@21637
    72
(* token translations *)
aspinall@21637
    73
aspinall@21637
    74
local
aspinall@21637
    75
aspinall@21637
    76
val class_tag = "class"
aspinall@21637
    77
val tfree_tag = "tfree"
aspinall@21637
    78
val tvar_tag = "tvar"
aspinall@21637
    79
val free_tag = "free"
aspinall@21637
    80
val bound_tag = "bound"
aspinall@21637
    81
val var_tag = "var"
aspinall@21637
    82
val skolem_tag = "skolem"
aspinall@21637
    83
aspinall@21637
    84
fun xml_atom kind x = XML.element "atom" [("kind", kind)] [XML.text x];
aspinall@21637
    85
aspinall@21637
    86
fun tagit kind x = 
aspinall@21637
    87
 (xml_atom kind x, real (Symbol.length (Symbol.explode x)));
aspinall@21637
    88
aspinall@21637
    89
fun free_or_skolem x =
aspinall@21637
    90
  (case try Name.dest_skolem x of
aspinall@21637
    91
    NONE => tagit free_tag x
aspinall@21637
    92
  | SOME x' => tagit skolem_tag x');
aspinall@21637
    93
aspinall@21637
    94
fun var_or_skolem s =
aspinall@21637
    95
  (case Syntax.read_variable s of
aspinall@21637
    96
    SOME (x, i) =>
aspinall@21637
    97
      (case try Name.dest_skolem x of
aspinall@21637
    98
        NONE => tagit var_tag s
aspinall@21637
    99
      | SOME x' => tagit skolem_tag
aspinall@21637
   100
          (setmp show_question_marks true Syntax.string_of_vname (x', i)))
aspinall@21637
   101
  | NONE => tagit var_tag s);
aspinall@21637
   102
aspinall@21637
   103
val proof_general_trans =
aspinall@21637
   104
 Syntax.tokentrans_mode proof_generalN
aspinall@21637
   105
  [("class", tagit class_tag),
aspinall@21637
   106
   ("tfree", tagit tfree_tag),
aspinall@21637
   107
   ("tvar", tagit tvar_tag),
aspinall@21637
   108
   ("free", free_or_skolem),
aspinall@21637
   109
   ("bound", tagit bound_tag),
aspinall@21637
   110
   ("var", var_or_skolem)];
aspinall@21637
   111
aspinall@21637
   112
in
aspinall@21637
   113
aspinall@21637
   114
val _ = Context.add_setup (Theory.add_tokentrfuns proof_general_trans);
aspinall@21637
   115
aspinall@21637
   116
end;
aspinall@21637
   117
aspinall@21637
   118
aspinall@21637
   119
(** assembling and issuing PGIP packets **)
aspinall@21637
   120
aspinall@21637
   121
val pgip_refid  = ref NONE: string option ref;
aspinall@21637
   122
val pgip_refseq = ref NONE: int option ref;
aspinall@21637
   123
aspinall@21637
   124
local
aspinall@21637
   125
  val pgip_class  = "pg"
aspinall@21637
   126
  val pgip_tag = "Isabelle/Isar"
aspinall@21637
   127
  val pgip_id = ref ""
aspinall@21637
   128
  val pgip_seq = ref 0
aspinall@21637
   129
  fun pgip_serial () = inc pgip_seq
aspinall@21637
   130
aspinall@21637
   131
  fun assemble_pgips pgips =
aspinall@21637
   132
    Pgip { tag = SOME pgip_tag, 
aspinall@21637
   133
	   class = pgip_class,
aspinall@21637
   134
	   seq = pgip_serial(),
aspinall@21637
   135
	   id = !pgip_id,
aspinall@21637
   136
	   destid = !pgip_refid,
aspinall@21637
   137
	   (* destid=refid since Isabelle only communicates back to sender *)
aspinall@21637
   138
	   refid  = !pgip_refid,
aspinall@21637
   139
	   refseq = !pgip_refseq,
aspinall@21637
   140
	   content = pgips }
aspinall@21637
   141
in
aspinall@21637
   142
aspinall@21637
   143
fun init_pgip_session_id () =
aspinall@21637
   144
    pgip_id := getenv "HOSTNAME" ^ "/" ^ getenv "USER" ^ "/" ^
aspinall@21637
   145
               getenv "ISABELLE_PID" ^ "/" ^ Time.toString (Time.now ())
aspinall@21637
   146
aspinall@21637
   147
fun matching_pgip_id id = (id = !pgip_id)
aspinall@21637
   148
aspinall@21637
   149
val output_xml = writeln_default o XML.string_of_tree;  (* FIXME: use string buffer *)
aspinall@21637
   150
aspinall@21637
   151
fun issue_pgip_rawtext str = 
aspinall@21637
   152
    output_xml (PgipOutput.output (assemble_pgips [XML.Text str])) (* FIXME: don't escape!! *)
aspinall@21637
   153
aspinall@21637
   154
fun issue_pgips pgipops =
aspinall@21637
   155
    output_xml (PgipOutput.output (assemble_pgips (map PgipOutput.output pgipops)));
aspinall@21637
   156
aspinall@21637
   157
fun issue_pgip pgipop =
aspinall@21637
   158
    output_xml (PgipOutput.output (assemble_pgips [PgipOutput.output pgipop]));
aspinall@21637
   159
aspinall@21637
   160
end;
aspinall@21637
   161
aspinall@21637
   162
aspinall@21637
   163
(** messages and notification **)
aspinall@21637
   164
aspinall@21637
   165
local
aspinall@21637
   166
    val delay_msgs = ref false   (*true: accumulate messages*)
aspinall@21637
   167
    val delayed_msgs = ref []
aspinall@21637
   168
aspinall@21637
   169
    fun queue_or_issue pgip =
aspinall@21637
   170
	if (! delay_msgs) then
aspinall@21637
   171
	    delayed_msgs := pgip :: ! delayed_msgs
aspinall@21637
   172
	else issue_pgip pgip
aspinall@21637
   173
in
aspinall@21637
   174
    fun normalmsg area cat urgent prfx s = 
aspinall@21637
   175
	let 
aspinall@21637
   176
	    val content = 
aspinall@21637
   177
		(* NB: prefixing is obsolete, but let's keep it for a while for familiarity *)
aspinall@21637
   178
		    XML.Elem("pgmltext",[],[XML.Rawtext (prefix_lines prfx s)])
aspinall@21637
   179
	    val pgip = Normalresponse {area=area,messagecategory=cat,
aspinall@21637
   180
				       urgent=urgent,content=[content] }
aspinall@21637
   181
	in
aspinall@21637
   182
	    queue_or_issue pgip
aspinall@21637
   183
	end
aspinall@21637
   184
aspinall@21637
   185
    fun errormsg fatality prfx s =
aspinall@21637
   186
	let
aspinall@21637
   187
	    (* FIXME: need a way of passing in locations *)
aspinall@21637
   188
              val content =
aspinall@21637
   189
		  XML.Elem("pgmltext",[],[XML.Rawtext (prefix_lines prfx s)])
aspinall@21637
   190
	      val pgip = Errorresponse {area=NONE,fatality=fatality,
aspinall@21637
   191
					content=[content], location=NONE}
aspinall@21637
   192
	in 
aspinall@21637
   193
	    queue_or_issue pgip
aspinall@21637
   194
	end
aspinall@21637
   195
aspinall@21637
   196
    fun start_delay_msgs () = (set delay_msgs; delayed_msgs := [])
aspinall@21637
   197
    fun end_delayed_msgs () = (reset delay_msgs; ! delayed_msgs)
aspinall@21637
   198
end;
aspinall@21637
   199
aspinall@21637
   200
(* NB: all of the standard error/message functions now expect already-escaped text.
aspinall@21637
   201
   FIXME: this may cause us problems now we're generating trees; on the other
aspinall@21637
   202
   hand the output functions were tuned some time ago, so it ought to be 
aspinall@21637
   203
   enough to use Rawtext always above. *)
aspinall@21637
   204
aspinall@21637
   205
fun setup_messages () =
aspinall@21637
   206
 (writeln_fn := (fn s => normalmsg Message Normal false "" s);
aspinall@21637
   207
  priority_fn := (fn s => normalmsg Message Normal true "" s);
aspinall@21637
   208
  tracing_fn := (fn s => normalmsg  Message Tracing false "" s);
aspinall@21637
   209
  info_fn := (fn s => normalmsg Message Information false "+++ " s);
aspinall@21637
   210
  debug_fn := (fn s => normalmsg Message Internal false "+++ " s);
aspinall@21637
   211
  warning_fn := (fn s => errormsg Nonfatal "### " s);
aspinall@21637
   212
  error_fn := (fn s => errormsg Fatal "*** " s);
aspinall@21637
   213
  panic_fn := (fn s => errormsg Panic "!!! " s))
aspinall@21637
   214
aspinall@21637
   215
(* immediate messages *)
aspinall@21637
   216
aspinall@21637
   217
fun tell_clear_goals ()      = issue_pgip (Cleardisplay {area=Display})
aspinall@21637
   218
fun tell_clear_response ()   = issue_pgip (Cleardisplay {area=Message})
aspinall@21637
   219
fun tell_file_loaded path    = issue_pgip (Informfileloaded {url=PgipTypes.pgipurl_of_path path})
aspinall@21637
   220
fun tell_file_retracted path = issue_pgip (Informfileretracted {url=PgipTypes.pgipurl_of_path path})
aspinall@21637
   221
aspinall@21637
   222
aspinall@21637
   223
aspinall@21637
   224
(** theory / proof state output **)
aspinall@21637
   225
aspinall@21637
   226
local
aspinall@21637
   227
aspinall@21637
   228
fun statedisplay prts =
aspinall@21637
   229
    let
aspinall@21637
   230
	val display = Pretty.output (Pretty.chunks prts)
aspinall@21637
   231
	val statedisplay = XML.Elem("statedisplay",[], [XML.Rawtext display])
aspinall@21637
   232
    in
aspinall@21637
   233
	issue_pgip (Proofstate {pgml=[XML.Elem("pgml",[],[statedisplay])]})
aspinall@21637
   234
    end
aspinall@21637
   235
aspinall@21637
   236
fun print_current_goals n m st =
aspinall@21637
   237
  statedisplay (Display.pretty_current_goals n m st)
aspinall@21637
   238
aspinall@21637
   239
fun print_state b st =
aspinall@21637
   240
  statedisplay (Toplevel.pretty_state b st)
aspinall@21637
   241
aspinall@21637
   242
in
aspinall@21637
   243
aspinall@21637
   244
fun setup_state () =
aspinall@21637
   245
  (Display.print_current_goals_fn := print_current_goals;
aspinall@21637
   246
   Toplevel.print_state_fn := print_state);
aspinall@21637
   247
      (*    Toplevel.prompt_state_fn := (fn s => suffix (special "372")
aspinall@21637
   248
					(Toplevel.prompt_state_default s))); *)
aspinall@21637
   249
aspinall@21637
   250
end;
aspinall@21637
   251
aspinall@21637
   252
aspinall@21637
   253
(* theory loader actions *)
aspinall@21637
   254
aspinall@21637
   255
local
aspinall@21637
   256
aspinall@21637
   257
fun trace_action action name =
aspinall@21637
   258
  if action = ThyInfo.Update then
aspinall@21637
   259
    List.app tell_file_loaded (ThyInfo.loaded_files name)
aspinall@21637
   260
  else if action = ThyInfo.Outdate orelse action = ThyInfo.Remove then
aspinall@21637
   261
    List.app tell_file_retracted (ThyInfo.loaded_files name)
aspinall@21637
   262
  else ();
aspinall@21637
   263
aspinall@21637
   264
in
aspinall@21637
   265
  fun setup_thy_loader () = ThyInfo.add_hook trace_action;
aspinall@21637
   266
  fun sync_thy_loader () = List.app (trace_action ThyInfo.Update) (ThyInfo.names ());
aspinall@21637
   267
end;
aspinall@21637
   268
aspinall@21637
   269
aspinall@21637
   270
(* prepare theory context *)
aspinall@21637
   271
aspinall@21637
   272
val thy_name = Path.pack o #1 o Path.split_ext o Path.base o Path.unpack;
aspinall@21637
   273
aspinall@21637
   274
(* FIXME general treatment of tracing*)
aspinall@21637
   275
val update_thy_only = setmp MetaSimplifier.trace_simp false ThyInfo.update_thy_only;
aspinall@21637
   276
aspinall@21637
   277
fun dynamic_context () =
aspinall@21637
   278
  (case Context.get_context () of
aspinall@21637
   279
    SOME thy => "  Using current (dynamic!) one: " ^ quote (Context.theory_name thy)
aspinall@21637
   280
  | NONE => "");
aspinall@21637
   281
aspinall@21637
   282
fun try_update_thy_only file =
aspinall@21637
   283
  ThyLoad.cond_add_path (Path.dir (Path.unpack file)) (fn () =>
aspinall@21637
   284
    let val name = thy_name file in
aspinall@21637
   285
      if is_some (ThyLoad.check_file NONE (ThyLoad.thy_path name))
aspinall@21637
   286
      then update_thy_only name
aspinall@21637
   287
      else warning ("Unkown theory context of ML file." ^ dynamic_context ())
aspinall@21637
   288
    end) ();
aspinall@21637
   289
aspinall@21637
   290
aspinall@21637
   291
(* get informed about files *)
aspinall@21637
   292
aspinall@21637
   293
val inform_file_retracted = ThyInfo.if_known_thy ThyInfo.remove_thy o thy_name;
aspinall@21637
   294
val inform_file_processed = ThyInfo.if_known_thy ThyInfo.touch_child_thys o thy_name;
aspinall@21637
   295
val openfile_retract = Output.no_warnings (ThyInfo.if_known_thy ThyInfo.remove_thy) o thy_name;
aspinall@21637
   296
aspinall@21637
   297
fun proper_inform_file_processed file state =
aspinall@21637
   298
  let val name = thy_name file in
aspinall@21637
   299
    if Toplevel.is_toplevel state andalso ThyInfo.known_thy name then
aspinall@21637
   300
     (ThyInfo.touch_child_thys name;
aspinall@21637
   301
      ThyInfo.pretend_use_thy_only name handle ERROR msg =>
aspinall@21637
   302
       (warning msg; warning ("Failed to register theory: " ^ quote name);
aspinall@21637
   303
        tell_file_retracted (Path.base (Path.unpack file))))
aspinall@21637
   304
    else raise Toplevel.UNDEF
aspinall@21637
   305
  end;
aspinall@21637
   306
aspinall@21637
   307
fun vacuous_inform_file_processed file state =
aspinall@21637
   308
 (warning ("No theory " ^ quote (thy_name file));
aspinall@21637
   309
  tell_file_retracted (Path.base (Path.unpack file)));
aspinall@21637
   310
aspinall@21637
   311
aspinall@21637
   312
(* restart top-level loop (keeps most state information) *)
aspinall@21637
   313
aspinall@21637
   314
val welcome = priority o Session.welcome;
aspinall@21637
   315
aspinall@21637
   316
fun restart () =
aspinall@21637
   317
    (sync_thy_loader ();
aspinall@21637
   318
     tell_clear_goals ();
aspinall@21637
   319
     tell_clear_response ();
aspinall@21637
   320
     welcome ();
aspinall@21637
   321
     raise Toplevel.RESTART)
aspinall@21637
   322
aspinall@21637
   323
aspinall@21637
   324
(* theorem dependency output *)
aspinall@21637
   325
local
aspinall@21637
   326
aspinall@21637
   327
val spaces_quote = space_implode " " o map quote;
aspinall@21637
   328
aspinall@21637
   329
fun thm_deps_message (thms, deps) =
aspinall@21637
   330
    let 
aspinall@21637
   331
	val valuethms = XML.Elem("value",[("name", "thms")],[XML.Text thms])
aspinall@21637
   332
	val valuedeps = XML.Elem("value",[("name", "deps")],[XML.Text deps])
aspinall@21637
   333
    in
aspinall@21637
   334
	issue_pgip (Metainforesponse {attrs=[("infotype", "isabelle_theorem_dependencies")],
aspinall@21637
   335
				      content=[valuethms,valuedeps]})
aspinall@21637
   336
    end
aspinall@21637
   337
aspinall@21637
   338
(* FIXME: check this uses non-transitive closure function here *)
aspinall@21637
   339
fun tell_thm_deps ths = conditional (Output.has_mode thm_depsN) (fn () =>
aspinall@21637
   340
  let
aspinall@21637
   341
    val names = filter_out (equal "") (map Thm.name_of_thm ths);
aspinall@21637
   342
    val deps = filter_out (equal "")
aspinall@21637
   343
      (Symtab.keys (fold Proofterm.thms_of_proof
aspinall@21637
   344
        (map Thm.proof_of ths) Symtab.empty));
aspinall@21637
   345
  in
aspinall@21637
   346
    if null names orelse null deps then ()
aspinall@21637
   347
    else thm_deps_message (spaces_quote names, spaces_quote deps)
aspinall@21637
   348
  end);
aspinall@21637
   349
aspinall@21637
   350
in
aspinall@21637
   351
aspinall@21637
   352
fun setup_present_hook () =
aspinall@21637
   353
  Present.add_hook (fn _ => fn res => tell_thm_deps (maps #2 res));
aspinall@21637
   354
aspinall@21637
   355
end;
aspinall@21637
   356
aspinall@21637
   357
(** lexicalstructure element with keywords (PGIP version of elisp keywords file) **)
aspinall@21637
   358
aspinall@21637
   359
fun lexicalstructure_keywords () = 
aspinall@21637
   360
    let val commands = OuterSyntax.dest_keywords ()
aspinall@21637
   361
	fun category_of k = if (k mem commands) then "major" else "minor"
aspinall@21637
   362
         (* NB: we might filter to only include words like elisp case (OuterSyntax.is_keyword). *)
aspinall@21637
   363
    	fun keyword_elt (keyword,help,kind,_) = 
aspinall@21637
   364
  	    XML.Elem("keyword", [("word", keyword), ("category", category_of kind)],
aspinall@21637
   365
	  	     [XML.Elem("shorthelp", [], [XML.Text help])])
aspinall@21637
   366
        in 	    	    
aspinall@21637
   367
            (* Also, note we don't call init_outer_syntax here to add interface commands,
aspinall@21637
   368
            but they should never appear in scripts anyway so it shouldn't matter *)
aspinall@21637
   369
            Lexicalstructure {content = map keyword_elt (OuterSyntax.dest_parsers()) }
aspinall@21637
   370
        end
aspinall@21637
   371
aspinall@21637
   372
(* TODO: we can issue a lexicalstructure/keyword when the syntax gets extended dynamically;
aspinall@21637
   373
   hooks needed in outer_syntax.ML to do that. *)
aspinall@21637
   374
aspinall@21637
   375
aspinall@21637
   376
(* Configuration: GUI config, proverinfo messages *)
aspinall@21637
   377
aspinall@21637
   378
local
aspinall@21637
   379
    val isabellewww = "http://isabelle.in.tum.de/"
aspinall@21637
   380
    val staticconfig = "~~/lib/ProofGeneral/pgip_isar.xml"
aspinall@21637
   381
    fun orenv v d = case (getenv v) of "" => d  | s => s
aspinall@21637
   382
    fun config_file()  = orenv "ISABELLE_PGIPCONFIG" staticconfig
aspinall@21637
   383
    fun isabelle_www() = orenv "ISABELLE_HOMEPAGE" isabellewww
aspinall@21637
   384
in
aspinall@21637
   385
fun send_pgip_config () =
aspinall@21637
   386
    let
aspinall@21637
   387
        val path = Path.unpack (config_file())
aspinall@21637
   388
        val exists = File.exists path
aspinall@21637
   389
aspinall@21637
   390
	val wwwpage = 
aspinall@21637
   391
	    (Url.unpack (isabelle_www()))
aspinall@21637
   392
	    handle _ => 
aspinall@21637
   393
		   (Output.panic 
aspinall@21637
   394
			("Error in URL in environment variable ISABELLE_HOMEPAGE.");
aspinall@21637
   395
			Url.unpack isabellewww)
aspinall@21637
   396
		     
aspinall@21637
   397
	val proverinfo =
aspinall@21637
   398
            Proverinfo { name = "Isabelle",
aspinall@21637
   399
			 version = version,
aspinall@21637
   400
			 instance = Session.name(), 
aspinall@21637
   401
			 descr = "The Isabelle/Isar theorem prover",
aspinall@21637
   402
			 url = wwwpage,
aspinall@21637
   403
			 filenameextns = ".thy;" }
aspinall@21637
   404
    in
aspinall@21637
   405
        if exists then
aspinall@21637
   406
            (issue_pgip proverinfo; 
aspinall@21637
   407
	     issue_pgip_rawtext (File.read path);
aspinall@21637
   408
	     issue_pgip (lexicalstructure_keywords()))
aspinall@21637
   409
        else Output.panic ("PGIP configuration file \"" ^ config_file() ^ "\" not found")
aspinall@21637
   410
    end;
aspinall@21637
   411
end
aspinall@21637
   412
aspinall@21637
   413
aspinall@21637
   414
(* PGIP identifier tables (prover objects). [incomplete] *)
aspinall@21637
   415
aspinall@21637
   416
local
aspinall@21637
   417
    (* TODO: objtypes should be in pgip_types.ML *)
aspinall@21637
   418
    val objtype_thy  = "theory"
aspinall@21637
   419
    val objtype_thm  = "theorem"
aspinall@21637
   420
    val objtype_term = "term"
aspinall@21637
   421
    val objtype_type = "type"
aspinall@21637
   422
aspinall@21637
   423
    fun xml_idtable ty ctx ids =
aspinall@21637
   424
        PgipOutput.output (Idtable {objtype=ty,context=ctx,ids=ids})
aspinall@21637
   425
in
aspinall@21637
   426
aspinall@21637
   427
fun setids t = issue_pgip (Setids {idtables = [t]})
aspinall@21637
   428
fun addids t = issue_pgip (Addids {idtables = [t]})
aspinall@21637
   429
fun delids t = issue_pgip (Delids {idtables = [t]})
aspinall@21637
   430
aspinall@21637
   431
fun delallids ty = setids (xml_idtable ty NONE [])
aspinall@21637
   432
aspinall@21637
   433
fun send_thy_idtable ctx thys = setids (xml_idtable objtype_thy ctx thys)
aspinall@21637
   434
fun clear_thy_idtable () = delallids objtype_thy
aspinall@21637
   435
aspinall@21637
   436
fun send_thm_idtable ctx thy =
aspinall@21637
   437
    addids (xml_idtable objtype_thm ctx (map fst (PureThy.thms_of thy)));
aspinall@21637
   438
aspinall@21637
   439
fun clear_thm_idtable () = delallids objtype_thm
aspinall@21637
   440
aspinall@21637
   441
(* fun send_type_idtable thy = TODO, it's a bit low-level messy
aspinall@21637
   442
   & maybe not so useful anyway *)
aspinall@21637
   443
aspinall@21637
   444
end
aspinall@21637
   445
aspinall@21637
   446
aspinall@21637
   447
(* Sending commands to Isar *)
aspinall@21637
   448
aspinall@21637
   449
fun isarcmd s =
aspinall@21637
   450
    s |> OuterSyntax.scan |> OuterSyntax.read
aspinall@21637
   451
      |> map (Toplevel.position (Position.name "PGIP message") o #3) |> Toplevel.>>>;
aspinall@21637
   452
aspinall@21637
   453
(* how TODO: apply a command given a transition function, e.g. IsarCmd.undo *)
aspinall@21637
   454
aspinall@21637
   455
(* load an arbitrary file (must be .thy or .ML) *)
aspinall@21637
   456
aspinall@21637
   457
fun use_thy_or_ml_file file =
aspinall@21637
   458
    let
aspinall@21637
   459
        val (path,extn) = Path.split_ext (Path.unpack file)
aspinall@21637
   460
    in
aspinall@21637
   461
        case extn of
aspinall@21637
   462
            "" => isarcmd ("use_thy " ^ (quote (Path.pack path)))
aspinall@21637
   463
          | "thy" => isarcmd ("use_thy " ^ (quote (Path.pack path)))
aspinall@21637
   464
          | "ML" => isarcmd ("use " ^ quote file)
aspinall@21637
   465
          | other => error ("Don't know how to read a file with extension " ^ other)
aspinall@21637
   466
    end
aspinall@21637
   467
aspinall@21637
   468
aspinall@21637
   469
(**** PGIP actions ****)
aspinall@21637
   470
aspinall@21637
   471
aspinall@21637
   472
(* Responses to each of the PGIP input commands. 
aspinall@21637
   473
   These are programmed uniformly for extensibility. *)
aspinall@21637
   474
aspinall@21637
   475
fun askpgip vs = 
aspinall@21637
   476
    issue_pgip
aspinall@21637
   477
        (Usespgip { version = PgipIsabelle.isabelle_pgip_version_supported,
aspinall@21637
   478
		    pgipelems = PgipIsabelle.accepted_inputs })
aspinall@21637
   479
aspinall@21637
   480
fun askpgml vs = 
aspinall@21637
   481
    issue_pgip
aspinall@21637
   482
	(Usespgml { version = PgipIsabelle.isabelle_pgml_version_supported })
aspinall@21637
   483
aspinall@21637
   484
fun askprefs vs =
aspinall@21637
   485
    let 
aspinall@21637
   486
	fun preference_of {name, descr, default, pgiptype, get, set } = 
aspinall@21637
   487
	    { name = name, descr = SOME descr, default = SOME default, 
aspinall@21637
   488
	      pgiptype = pgiptype }
aspinall@21637
   489
    in
aspinall@21637
   490
	List.app (fn (prefcat, prefs) =>
aspinall@21637
   491
		     issue_pgip (Hasprefs {prefcategory=SOME prefcat, 
aspinall@21637
   492
					   prefs=map preference_of prefs}))
aspinall@21637
   493
                 Preferences.preferences
aspinall@21637
   494
    end 
aspinall@21637
   495
aspinall@21637
   496
fun askconfig vs = () (* TODO: add config response *)
aspinall@21637
   497
aspinall@21637
   498
local
aspinall@21637
   499
    fun lookuppref pref = 
aspinall@21637
   500
	case AList.lookup (op =) 
aspinall@21637
   501
			  (map (fn p => (#name p,p))
aspinall@21637
   502
			       (maps snd Preferences.preferences)) pref of
aspinall@21637
   503
	    NONE => error ("Unknown prover preference: " ^ quote pref)
aspinall@21637
   504
	  | SOME p => p
aspinall@21637
   505
in
aspinall@21637
   506
fun setpref vs = 
aspinall@21637
   507
    let 
aspinall@21637
   508
	val name = #name vs
aspinall@21637
   509
	val value = #value vs
aspinall@21637
   510
	val set = #set (lookuppref name)
aspinall@21637
   511
    in
aspinall@21637
   512
	set value
aspinall@21637
   513
    end
aspinall@21637
   514
aspinall@21637
   515
fun getpref vs =
aspinall@21637
   516
    let 
aspinall@21637
   517
	val name = #name vs
aspinall@21637
   518
	val get = #get (lookuppref name)
aspinall@21637
   519
    in 
aspinall@21637
   520
        issue_pgip (Prefval {name=name, value=get ()})
aspinall@21637
   521
    end
aspinall@21637
   522
end
aspinall@21637
   523
aspinall@21637
   524
fun proverinit vs = restart ()
aspinall@21637
   525
aspinall@21637
   526
fun proverexit vs = isarcmd "quit"
aspinall@21637
   527
aspinall@21637
   528
fun startquiet vs = isarcmd "disable_pr"
aspinall@21637
   529
aspinall@21637
   530
fun stopquiet vs = isarcmd "enable_pr"
aspinall@21637
   531
aspinall@21637
   532
fun pgmlsymbolson vs = 
aspinall@21637
   533
    change print_mode (fn mode =>
aspinall@21637
   534
			  remove (op =) Symbol.xsymbolsN mode @ [Symbol.xsymbolsN])
aspinall@21637
   535
aspinall@21637
   536
fun pgmlsymbolsoff vs =
aspinall@21637
   537
    change print_mode (remove (op =) Symbol.xsymbolsN)
aspinall@21637
   538
aspinall@21637
   539
fun dostep vs = 
aspinall@21637
   540
    let 
aspinall@21637
   541
	val text = #text vs
aspinall@21637
   542
    in 
aspinall@21637
   543
	isarcmd text
aspinall@21637
   544
    end
aspinall@21637
   545
aspinall@21637
   546
fun undostep vs =
aspinall@21637
   547
    let 
aspinall@21637
   548
	val times = #times vs
aspinall@21637
   549
    in 
aspinall@21637
   550
	isarcmd ("undos_proof " ^ (Int.toString times))
aspinall@21637
   551
    end
aspinall@21637
   552
aspinall@21637
   553
fun redostep vs = isarcmd "redo"
aspinall@21637
   554
    
aspinall@21637
   555
fun abortgoal vs = isarcmd "ProofGeneral.kill_proof" 
aspinall@21637
   556
aspinall@21637
   557
aspinall@21637
   558
fun askids vs = 
aspinall@21637
   559
    let
aspinall@21637
   560
	val thyname = #thyname vs
aspinall@21637
   561
	val objtype = #objtype vs
aspinall@21637
   562
    in 
aspinall@21637
   563
	(* TODO: add askids for "file" here, which returns single theory with same name *)
aspinall@21637
   564
	case (thyname,objtype) of 
aspinall@21637
   565
           (* only theories known in top context *)
aspinall@21637
   566
	   (NONE, NONE) =>  send_thy_idtable NONE (ThyInfo.names())
aspinall@21637
   567
	 | (NONE, SOME "theory")  => send_thy_idtable NONE (ThyInfo.names())
aspinall@21637
   568
	 | (SOME thy, SOME "theory") => send_thy_idtable (SOME thy) (ThyInfo.get_preds thy)
aspinall@21637
   569
	 | (SOME thy, SOME "theorem") => send_thm_idtable (SOME thy) (ThyInfo.get_theory thy)
aspinall@21637
   570
	 | (SOME thy, NONE) => (send_thy_idtable (SOME thy) (ThyInfo.get_preds thy);
aspinall@21637
   571
                               send_thm_idtable (SOME thy) (ThyInfo.get_theory thy))
aspinall@21637
   572
	 | (_, SOME ot) => error ("No objects of type "^(quote ot)^" are available here.")
aspinall@21637
   573
    end
aspinall@21637
   574
aspinall@21637
   575
local
aspinall@21637
   576
  (* accumulate printed output in a single PGIP response (inside <pgmltext>) *)
aspinall@21637
   577
  fun with_displaywrap pgipfn dispfn =
aspinall@21637
   578
      let
aspinall@21637
   579
	  val lines = ref ([]: string list);
aspinall@21637
   580
	  fun wlgrablines s = lines := s :: ! lines;
aspinall@21637
   581
      in
aspinall@21637
   582
	  setmp writeln_fn wlgrablines dispfn ();
aspinall@21637
   583
	  issue_pgip (pgipfn (!lines))
aspinall@21637
   584
      end;
aspinall@21637
   585
in
aspinall@21637
   586
fun showid vs = 
aspinall@21637
   587
    let
aspinall@21637
   588
	val thyname = #thyname vs
aspinall@21637
   589
	val objtype = #objtype vs
aspinall@21637
   590
	val name = #objtype vs
aspinall@21637
   591
	val topthy = Toplevel.theory_of o Toplevel.get_state
aspinall@21637
   592
aspinall@21637
   593
	fun idvalue objtype name strings =
aspinall@21637
   594
	    Idvalue { name=name, objtype=objtype,
aspinall@21637
   595
		      text=[XML.Elem("pgmltext",[],map XML.Text strings)] }
aspinall@21637
   596
aspinall@21637
   597
	fun pthm thy name = print_thm (get_thm thy (Name name))
aspinall@21637
   598
    in 
aspinall@21637
   599
	case (thyname, objtype) of 
aspinall@21637
   600
	    (_,"theory") =>
aspinall@21637
   601
	    with_displaywrap (idvalue "theory" name) 
aspinall@21637
   602
			     (fn ()=>(print_theory (ThyInfo.get_theory name)))
aspinall@21637
   603
	  | (SOME thy, "theorem") =>
aspinall@21637
   604
	    with_displaywrap (idvalue "theorem" name) 
aspinall@21637
   605
			     (fn ()=>(pthm (ThyInfo.get_theory thy) name))
aspinall@21637
   606
	  | (NONE, "theorem") =>
aspinall@21637
   607
	    with_displaywrap (idvalue "theorem" name) 
aspinall@21637
   608
			     (fn ()=>pthm (topthy()) name)
aspinall@21637
   609
	  | (_, ot) => error ("Cannot show objects of type "^ot)
aspinall@21637
   610
    end
aspinall@21637
   611
aspinall@21637
   612
(* The file which is currently being processed interactively.  
aspinall@21637
   613
   In the pre-PGIP code, this was informed to Isabelle and the theory loader
aspinall@21637
   614
   on completion, but that allows for circularity in case we read
aspinall@21637
   615
   ourselves.  So PGIP opens the filename at the start of a script.
aspinall@21637
   616
   We ought to prevent problems by modifying the theory loader to know
aspinall@21637
   617
   about this special status, but for now we just keep a local reference. 
aspinall@21637
   618
*) 
aspinall@21637
   619
aspinall@21637
   620
val currently_open_file = ref (NONE : pgipurl option)
aspinall@21637
   621
aspinall@21637
   622
fun askguise vs = 
aspinall@21637
   623
    (* The "guise" is the PGIP abstraction of the prover's state.
aspinall@21637
   624
       The <informguise> message is merely used for consistency checking. *)
aspinall@21637
   625
    let 
aspinall@21637
   626
	val openfile = !currently_open_file
aspinall@21637
   627
aspinall@21637
   628
	val topthy = Toplevel.theory_of o Toplevel.get_state
aspinall@21637
   629
	val topthy_name = Context.theory_name o topthy
aspinall@21637
   630
aspinall@21637
   631
	val opentheory = SOME (topthy_name()) handle Toplevel.UNDEF => NONE
aspinall@21637
   632
aspinall@21637
   633
	fun topproofpos () = try Toplevel.proof_position_of (Isar.state ());
aspinall@21637
   634
	val openproofpos = topproofpos()
aspinall@21637
   635
    in
aspinall@21637
   636
        issue_pgip (Informguise { file = openfile,
aspinall@21637
   637
				  theory = opentheory,
aspinall@21637
   638
				  (* would be nice to get thm name... *)
aspinall@21637
   639
				  theorem = NONE,
aspinall@21637
   640
				  proofpos = openproofpos })
aspinall@21637
   641
    end
aspinall@21637
   642
aspinall@21637
   643
fun parsescript vs =
aspinall@21637
   644
    let
aspinall@21637
   645
	val text = #text vs
aspinall@21637
   646
	val systemdata = #systemdata vs      
aspinall@21637
   647
	val location = #location vs   (* TODO: extract position *)
aspinall@21637
   648
aspinall@21637
   649
        val _ = start_delay_msgs ()  (* gather parsing messages *)
aspinall@21637
   650
        val xmls = PgipParser.xmls_of_str text
aspinall@21637
   651
        val errs = end_delayed_msgs ()
aspinall@21637
   652
aspinall@21637
   653
	val sysattrs = PgipTypes.opt_attr "systemdata" systemdata
aspinall@21637
   654
	val locattrs = PgipTypes.attrs_of_location location
aspinall@21637
   655
     in
aspinall@21637
   656
        issue_pgip (Parseresult { attrs= sysattrs@locattrs,
aspinall@21637
   657
				  content = (map PgipOutput.output errs)@xmls })
aspinall@21637
   658
    end
aspinall@21637
   659
aspinall@21637
   660
fun showproofstate vs = isarcmd "pr"
aspinall@21637
   661
aspinall@21637
   662
fun showctxt vs = isarcmd "print_theory"   (* more useful than print_context *)
aspinall@21637
   663
aspinall@21637
   664
fun searchtheorems vs =
aspinall@21637
   665
    let 
aspinall@21637
   666
	val arg = #arg vs
aspinall@21637
   667
    in
aspinall@21637
   668
	isarcmd ("thms_containing " ^ arg)
aspinall@21637
   669
    end
aspinall@21637
   670
aspinall@21637
   671
fun setlinewidth vs = 
aspinall@21637
   672
    let 
aspinall@21637
   673
	val width = #width vs
aspinall@21637
   674
    in
aspinall@21637
   675
	isarcmd ("pretty_setmargin " ^ (Int.toString width)) (* FIXME: conversion back/forth! *)
aspinall@21637
   676
    end
aspinall@21637
   677
aspinall@21637
   678
fun viewdoc vs =
aspinall@21637
   679
    let 
aspinall@21637
   680
	val arg = #arg vs
aspinall@21637
   681
    in 
aspinall@21637
   682
	isarcmd ("print_" ^ arg)   (* FIXME: isatool doc?.  Return URLs, maybe? *)
aspinall@21637
   683
    end
aspinall@21637
   684
aspinall@21637
   685
fun doitem vs =
aspinall@21637
   686
    let
aspinall@21637
   687
	val text = #text vs
aspinall@21637
   688
    in
aspinall@21637
   689
	isarcmd text
aspinall@21637
   690
    end
aspinall@21637
   691
aspinall@21637
   692
fun undoitem vs =
aspinall@21637
   693
    isarcmd "ProofGeneral.undo"
aspinall@21637
   694
aspinall@21637
   695
fun redoitem vs =
aspinall@21637
   696
    isarcmd "ProofGeneral.redo"
aspinall@21637
   697
aspinall@21637
   698
fun aborttheory vs = 
aspinall@21637
   699
    isarcmd "init_toplevel"
aspinall@21637
   700
aspinall@21637
   701
fun retracttheory vs =
aspinall@21637
   702
    let 
aspinall@21637
   703
	val thyname = #thyname vs
aspinall@21637
   704
    in
aspinall@21637
   705
	isarcmd ("kill_thy " ^ quote thyname)
aspinall@21637
   706
    end
aspinall@21637
   707
aspinall@21637
   708
fun loadfile vs = 
aspinall@21637
   709
    let 
aspinall@21637
   710
	val url = #url vs
aspinall@21637
   711
    in 
aspinall@21637
   712
	case !currently_open_file of
aspinall@21637
   713
            SOME f => raise PGIP ("<loadfile> when a file is open!")
aspinall@21637
   714
          | NONE => use_thy_or_ml_file (File.platform_path url)
aspinall@21637
   715
    end
aspinall@21637
   716
aspinall@21637
   717
fun openfile vs =
aspinall@21637
   718
  let 
aspinall@21637
   719
      val url = #url vs
aspinall@21637
   720
  in
aspinall@21637
   721
      case !currently_open_file of
aspinall@21637
   722
          SOME f => raise PGIP ("<openfile> when a file is already open! ")
aspinall@21637
   723
        | NONE => (openfile_retract (File.platform_path url);
aspinall@21637
   724
		   currently_open_file := SOME url) (*(File.platform_path url))*)
aspinall@21637
   725
  end
aspinall@21637
   726
aspinall@21637
   727
fun closefile vs =
aspinall@21637
   728
    case !currently_open_file of
aspinall@21637
   729
        SOME f => (proper_inform_file_processed (File.platform_path f) 
aspinall@21637
   730
						(Isar.state());
aspinall@21637
   731
                   currently_open_file := NONE)
aspinall@21637
   732
      | NONE => raise PGIP ("<closefile> when no file is open!")
aspinall@21637
   733
aspinall@21637
   734
fun abortfile vs =
aspinall@21637
   735
    case !currently_open_file of
aspinall@21637
   736
        SOME f => (isarcmd "init_toplevel";
aspinall@21637
   737
		   currently_open_file := NONE)
aspinall@21637
   738
      | NONE => raise PGIP ("<abortfile> when no file is open!")
aspinall@21637
   739
aspinall@21637
   740
fun retractfile vs = 
aspinall@21637
   741
    let 
aspinall@21637
   742
	val url = #url vs
aspinall@21637
   743
    in
aspinall@21637
   744
	case !currently_open_file of
aspinall@21637
   745
            SOME f => raise PGIP ("<retractfile> when a file is open!")
aspinall@21637
   746
          | NONE => inform_file_retracted (File.platform_path url)
aspinall@21637
   747
    end
aspinall@21637
   748
aspinall@21637
   749
(* Path management: we allow theory files to have dependencies in
aspinall@21637
   750
   their own directory, but when we change directory for a new file we
aspinall@21637
   751
   remove the path.  Leaving it there can cause confusion with
aspinall@21637
   752
   difference in batch mode.
aspinall@21637
   753
   NB: PGIP does not assume that the prover has a load path. 
aspinall@21637
   754
*)
aspinall@21637
   755
aspinall@21637
   756
local
aspinall@21637
   757
    val current_working_dir = ref (NONE : string option)
aspinall@21637
   758
in
aspinall@21637
   759
fun changecwd vs = 
aspinall@21637
   760
    let 
aspinall@21637
   761
	val url = #url vs
aspinall@21637
   762
	val newdir = File.platform_path url
aspinall@21637
   763
    in
aspinall@21637
   764
        (case (!current_working_dir) of
aspinall@21637
   765
             NONE => ()
aspinall@21637
   766
           | SOME dir => ThyLoad.del_path dir;
aspinall@21637
   767
         ThyLoad.add_path newdir;
aspinall@21637
   768
         current_working_dir := SOME newdir)
aspinall@21637
   769
    end
aspinall@21637
   770
end
aspinall@21637
   771
aspinall@21637
   772
aspinall@21637
   773
fun systemcmd vs =
aspinall@21637
   774
  let 
aspinall@21637
   775
      val arg = #arg vs
aspinall@21637
   776
  in
aspinall@21637
   777
      isarcmd arg
aspinall@21637
   778
  end
aspinall@21637
   779
aspinall@21637
   780
exception PGIP_QUIT;
aspinall@21637
   781
fun quitpgip vs = raise PGIP_QUIT
aspinall@21637
   782
aspinall@21637
   783
fun process_input inp = case inp of
aspinall@21637
   784
     Pgip.Askpgip vs         => askpgip vs
aspinall@21637
   785
   | Pgip.Askpgml vs         => askpgml vs
aspinall@21637
   786
   | Pgip.Askprefs vs        => askprefs vs 
aspinall@21637
   787
   | Pgip.Askconfig vs       => askconfig vs
aspinall@21637
   788
   | Pgip.Getpref vs         => getpref vs
aspinall@21637
   789
   | Pgip.Setpref vs         => setpref vs
aspinall@21637
   790
   | Pgip.Proverinit vs      => proverinit vs
aspinall@21637
   791
   | Pgip.Proverexit vs      => proverexit vs
aspinall@21637
   792
   | Pgip.Startquiet vs      => startquiet vs
aspinall@21637
   793
   | Pgip.Stopquiet vs       => stopquiet vs
aspinall@21637
   794
   | Pgip.Pgmlsymbolson vs   => pgmlsymbolson vs
aspinall@21637
   795
   | Pgip.Pgmlsymbolsoff vs  => pgmlsymbolsoff vs
aspinall@21637
   796
   | Pgip.Dostep vs          => dostep vs
aspinall@21637
   797
   | Pgip.Undostep vs        => undostep vs
aspinall@21637
   798
   | Pgip.Redostep vs        => redostep vs
aspinall@21637
   799
   | Pgip.Forget vs	     => (error "<forget> not implemented")
aspinall@21637
   800
   | Pgip.Restoregoal vs     => (error "<restoregoal> not implemented")
aspinall@21637
   801
   | Pgip.Abortgoal vs       => abortgoal vs
aspinall@21637
   802
   | Pgip.Askids vs          => askids vs
aspinall@21637
   803
   | Pgip.Showid vs          => showid vs
aspinall@21637
   804
   | Pgip.Askguise vs	     => askguise vs
aspinall@21637
   805
   | Pgip.Parsescript vs     => parsescript vs
aspinall@21637
   806
   | Pgip.Showproofstate vs  => showproofstate vs
aspinall@21637
   807
   | Pgip.Showctxt vs        => showctxt vs
aspinall@21637
   808
   | Pgip.Searchtheorems vs  => searchtheorems vs
aspinall@21637
   809
   | Pgip.Setlinewidth vs    => setlinewidth vs
aspinall@21637
   810
   | Pgip.Viewdoc vs         => viewdoc vs
aspinall@21637
   811
   | Pgip.Doitem vs          => doitem vs
aspinall@21637
   812
   | Pgip.Undoitem vs        => undoitem vs
aspinall@21637
   813
   | Pgip.Redoitem vs        => redoitem vs
aspinall@21637
   814
   | Pgip.Aborttheory vs     => aborttheory vs
aspinall@21637
   815
   | Pgip.Retracttheory vs   => retracttheory vs
aspinall@21637
   816
   | Pgip.Loadfile vs	     => loadfile vs
aspinall@21637
   817
   | Pgip.Openfile vs	     => openfile vs
aspinall@21637
   818
   | Pgip.Closefile vs	     => closefile vs
aspinall@21637
   819
   | Pgip.Abortfile vs	     => abortfile vs
aspinall@21637
   820
   | Pgip.Retractfile vs     => retractfile vs
aspinall@21637
   821
   | Pgip.Changecwd vs	     => changecwd vs
aspinall@21637
   822
   | Pgip.Systemcmd vs	     => systemcmd vs
aspinall@21637
   823
   | Pgip.Quitpgip vs        => quitpgip vs
aspinall@21637
   824
aspinall@21637
   825
aspinall@21637
   826
fun process_pgip_element pgipxml = 
aspinall@21637
   827
    case pgipxml of
aspinall@21637
   828
	(xml as (XML.Elem elem)) =>
aspinall@21637
   829
	(case Pgip.input elem of
aspinall@21637
   830
	     NONE => warning ("Unrecognized PGIP command, ignored: \n" ^
aspinall@21637
   831
			      (XML.string_of_tree xml))
aspinall@21637
   832
	   | SOME inp => (process_input inp)) (* errors later; packet discarded *)
aspinall@21637
   833
      | (XML.Text t) => ignored_text_warning t
aspinall@21637
   834
      |	(XML.Rawtext t) => ignored_text_warning t
aspinall@21637
   835
and ignored_text_warning t =
aspinall@21637
   836
    if (size (Symbol.strip_blanks t) > 0) then
aspinall@21637
   837
	   warning ("Ignored text in PGIP packet: \n" ^ t)
aspinall@21637
   838
    else ()
aspinall@21637
   839
aspinall@21637
   840
fun process_pgip_tree xml =
aspinall@21637
   841
    (pgip_refid := NONE;
aspinall@21637
   842
     pgip_refseq := NONE;
aspinall@21637
   843
     (case xml of
aspinall@21637
   844
          XML.Elem ("pgip", attrs, pgips) =>
aspinall@21637
   845
          (let
aspinall@21637
   846
               val class = PgipTypes.get_attr "class" attrs
aspinall@21637
   847
               val dest  = PgipTypes.get_attr_opt "destid" attrs
aspinall@21637
   848
               val _ = (pgip_refid :=  PgipTypes.get_attr_opt "id" attrs)
aspinall@21637
   849
	       val _ = (pgip_refseq := Option.join 
aspinall@21637
   850
					   (Option.map Int.fromString
aspinall@21637
   851
						  (PgipTypes.get_attr_opt "seq" attrs)))
aspinall@21637
   852
               (* Respond to prover broadcasts, or messages for us. Ignore rest *)
aspinall@21637
   853
	       val processit = 
aspinall@21637
   854
		   case dest of
aspinall@21637
   855
                       NONE =>    class = "pa"
aspinall@21637
   856
		     | SOME id => matching_pgip_id id
aspinall@21637
   857
           in
aspinall@21637
   858
               if processit then 
aspinall@21637
   859
		   (List.app process_pgip_element pgips; true) 
aspinall@21637
   860
	       else false
aspinall@21637
   861
           end)
aspinall@21637
   862
        | _ => raise PGIP "Invalid PGIP packet received")
aspinall@21637
   863
     handle PGIP msg =>
aspinall@21637
   864
            (Output.error_msg ((msg ^ "\nPGIP error occured in XML text below:\n") ^
aspinall@21637
   865
			       (XML.string_of_tree xml));
aspinall@21637
   866
	     true))
aspinall@21637
   867
aspinall@21637
   868
val process_pgip = K () o process_pgip_tree o XML.tree_of_string
aspinall@21637
   869
aspinall@21637
   870
end
aspinall@21637
   871
aspinall@21637
   872
aspinall@21637
   873
(* PGIP loop: process PGIP input only *)
aspinall@21637
   874
aspinall@21637
   875
local
aspinall@21637
   876
aspinall@21637
   877
exception XML_PARSE
aspinall@21637
   878
aspinall@21637
   879
fun loop ready src =
aspinall@21637
   880
    let
aspinall@21637
   881
        val _ = if ready then issue_pgip (Ready ()) else ()
aspinall@21637
   882
        val pgipo = (Source.get_single src)
aspinall@21637
   883
                        handle e => raise XML_PARSE
aspinall@21637
   884
    in
aspinall@21637
   885
        case pgipo of
aspinall@21637
   886
             NONE  => ()
aspinall@21637
   887
           | SOME (pgip,src') =>
aspinall@21637
   888
             let
aspinall@21637
   889
                 val ready' = (process_pgip_tree pgip) 
aspinall@21637
   890
				handle e => (handler (e,SOME src'); true)
aspinall@21637
   891
             in
aspinall@21637
   892
                 loop ready' src'
aspinall@21637
   893
             end
aspinall@21637
   894
    end handle e => handler (e,SOME src)  (* error in XML parse or Ready issue *)
aspinall@21637
   895
aspinall@21637
   896
and handler (e,srco) =
aspinall@21637
   897
    case (e,srco) of
aspinall@21637
   898
        (XML_PARSE,SOME src) =>
aspinall@21637
   899
        Output.panic "Invalid XML input, aborting"
aspinall@21637
   900
      | (PGIP_QUIT,_) => ()
aspinall@21637
   901
      | (Interrupt,SOME src) => 
aspinall@21637
   902
	(Output.error_msg "Interrupt during PGIP processing"; loop true src)
aspinall@21637
   903
      | (Toplevel.UNDEF,SOME src) => 
aspinall@21637
   904
	(Output.error_msg "No working context defined"; loop true src)
aspinall@21637
   905
      | (e,SOME src) => 
aspinall@21637
   906
	(Output.error_msg (Toplevel.exn_message e); loop true src)
aspinall@21637
   907
      | (_,NONE) => ()
aspinall@21637
   908
in
aspinall@21637
   909
  (* TODO: add socket interface *)
aspinall@21637
   910
aspinall@21637
   911
  val xmlP = XML.scan_comment_whspc |-- XML.parse_elem >> single
aspinall@21637
   912
aspinall@21637
   913
  val tty_src = Source.set_prompt "" (Source.source Symbol.stopper xmlP NONE Source.tty)
aspinall@21637
   914
aspinall@21637
   915
  fun pgip_toplevel x = loop true x
aspinall@21637
   916
end
aspinall@21637
   917
aspinall@21637
   918
aspinall@21637
   919
(* additional outer syntax for Isar *)  
aspinall@21637
   920
(* da: TODO: perhaps we can drop this superfluous syntax now??
aspinall@21637
   921
   Seems cleaner to support the operations directly above in the PGIP actions.
aspinall@21637
   922
 *)
aspinall@21637
   923
aspinall@21637
   924
local structure P = OuterParse and K = OuterKeyword in
aspinall@21637
   925
aspinall@21637
   926
val undoP = (*undo without output*)
aspinall@21637
   927
  OuterSyntax.improper_command "ProofGeneral.undo" "(internal)" K.control
aspinall@21637
   928
    (Scan.succeed (Toplevel.no_timing o IsarCmd.undo));
aspinall@21637
   929
aspinall@21637
   930
val redoP = (*redo without output*)
aspinall@21637
   931
  OuterSyntax.improper_command "ProofGeneral.redo" "(internal)" K.control
aspinall@21637
   932
    (Scan.succeed (Toplevel.no_timing o IsarCmd.redo));
aspinall@21637
   933
aspinall@21637
   934
(* da: what were these context commands ones for? *)
aspinall@21637
   935
val context_thy_onlyP =
aspinall@21637
   936
  OuterSyntax.improper_command "ProofGeneral.context_thy_only" "(internal)" K.control
aspinall@21637
   937
    (P.name >> (Toplevel.no_timing oo IsarCmd.init_context update_thy_only));
aspinall@21637
   938
aspinall@21637
   939
val try_context_thy_onlyP =
aspinall@21637
   940
  OuterSyntax.improper_command "ProofGeneral.try_context_thy_only" "(internal)" K.control
aspinall@21637
   941
    (P.name >> (Toplevel.no_timing oo
aspinall@21637
   942
      (Toplevel.imperative (K ()) oo IsarCmd.init_context try_update_thy_only)));
aspinall@21637
   943
aspinall@21637
   944
(* ProofGeneral.kill_proof still used above *)
aspinall@21637
   945
val kill_proofP =
aspinall@21637
   946
  OuterSyntax.improper_command "ProofGeneral.kill_proof" "(internal)" K.control
aspinall@21637
   947
    (Scan.succeed (Toplevel.no_timing o IsarCmd.kill_proof_notify tell_clear_goals));
aspinall@21637
   948
aspinall@21637
   949
(* FIXME: Not quite same as commands used above *)
aspinall@21637
   950
val inform_file_processedP =
aspinall@21637
   951
  OuterSyntax.improper_command "ProofGeneral.inform_file_processed" "(internal)" K.control
aspinall@21637
   952
    (P.name >> (fn file => Toplevel.no_timing o
aspinall@21637
   953
      Toplevel.keep (vacuous_inform_file_processed file) o
aspinall@21637
   954
      Toplevel.kill o
aspinall@21637
   955
      Toplevel.keep (proper_inform_file_processed file)));
aspinall@21637
   956
aspinall@21637
   957
val inform_file_retractedP =
aspinall@21637
   958
  OuterSyntax.improper_command "ProofGeneral.inform_file_retracted" "(internal)" K.control
aspinall@21637
   959
    (P.name >> (Toplevel.no_timing oo
aspinall@21637
   960
      (fn file => Toplevel.imperative (fn () => inform_file_retracted file))));
aspinall@21637
   961
aspinall@21637
   962
(* This one can actually be used for Daniel's interface scripting idea: generically!! *)
aspinall@21637
   963
val process_pgipP =
aspinall@21637
   964
  OuterSyntax.improper_command "ProofGeneral.process_pgip" "(internal)" K.control
aspinall@21637
   965
    (P.text >> (Toplevel.no_timing oo
aspinall@21637
   966
      (fn txt => Toplevel.imperative (fn () => process_pgip txt))));
aspinall@21637
   967
aspinall@21637
   968
fun init_outer_syntax () = OuterSyntax.add_parsers
aspinall@21637
   969
 [undoP, redoP, kill_proofP, context_thy_onlyP, try_context_thy_onlyP,
aspinall@21637
   970
  inform_file_processedP, inform_file_retractedP, process_pgipP];
aspinall@21637
   971
aspinall@21637
   972
end;
aspinall@21637
   973
aspinall@21637
   974
aspinall@21637
   975
(* init *)
aspinall@21637
   976
aspinall@21637
   977
val initialized = ref false;
aspinall@21637
   978
aspinall@21637
   979
(* ML top level only for testing, entered on <quitpgip> *)
aspinall@21637
   980
fun set_prompts () = ml_prompts "ML> " "ML# ";
aspinall@21637
   981
aspinall@21637
   982
fun init_setup () =
aspinall@21637
   983
  (conditional (not (! initialized)) (fn () =>
aspinall@21637
   984
   (setmp warning_fn (K ()) init_outer_syntax ();
aspinall@21637
   985
    setup_xsymbols_output ();
aspinall@21637
   986
    setup_pgml_output ();
aspinall@21637
   987
    setup_messages ();
aspinall@21637
   988
    setup_state ();
aspinall@21637
   989
    setup_thy_loader ();
aspinall@21637
   990
    setup_present_hook ();
aspinall@21637
   991
    init_pgip_session_id ();
aspinall@21637
   992
    welcome ();
aspinall@21637
   993
    set initialized; ()));
aspinall@21637
   994
  sync_thy_loader ();
aspinall@21637
   995
  change print_mode (cons proof_generalN o remove (op =) proof_generalN);
aspinall@21637
   996
  change print_mode (append [pgmlN, pgmlatomsN] o subtract (op =) [pgmlN, pgmlatomsN]);
aspinall@21637
   997
  set_prompts ());
aspinall@21637
   998
aspinall@21637
   999
fun init_pgip false = Output.panic "PGIP not supported for Isabelle/classic mode."
aspinall@21637
  1000
  | init_pgip true = (init_setup (); pgip_toplevel tty_src);
aspinall@21637
  1001
aspinall@21637
  1002
fun write_keywords s = ()  (* NB: do nothing *)
aspinall@21637
  1003
aspinall@21637
  1004
end;
aspinall@21637
  1005