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