src/Pure/Isar/outer_syntax.ML
author wenzelm
Tue Apr 10 21:31:05 2012 +0200 (2012-04-10 ago)
changeset 47416 df8fc0567a3d
parent 47014 e203b7d7e08d
child 48191 c1def7433a72
permissions -rw-r--r--
static relevance of proof via syntax keywords;
wenzelm@5829
     1
(*  Title:      Pure/Isar/outer_syntax.ML
wenzelm@5829
     2
    Author:     Markus Wenzel, TU Muenchen
wenzelm@5829
     3
wenzelm@27353
     4
The global Isabelle/Isar outer syntax.
wenzelm@27353
     5
wenzelm@27353
     6
Note: the syntax for files is statically determined at the very
wenzelm@27353
     7
beginning; for interactive processing it may change dynamically.
wenzelm@5829
     8
*)
wenzelm@5829
     9
wenzelm@5829
    10
signature OUTER_SYNTAX =
wenzelm@5829
    11
sig
wenzelm@43711
    12
  type outer_syntax
wenzelm@43712
    13
  val is_markup: outer_syntax -> Thy_Output.markup -> string -> bool
wenzelm@43711
    14
  val get_syntax: unit -> (Scan.lexicon * Scan.lexicon) * outer_syntax
wenzelm@46970
    15
  val check_syntax: unit -> unit
wenzelm@46961
    16
  type command_spec = string * Keyword.T
wenzelm@46961
    17
  val command: command_spec -> string ->
wenzelm@29311
    18
    (Toplevel.transition -> Toplevel.transition) parser -> unit
wenzelm@46961
    19
  val markup_command: Thy_Output.markup -> command_spec -> string ->
wenzelm@29311
    20
    (Toplevel.transition -> Toplevel.transition) parser -> unit
wenzelm@46961
    21
  val improper_command: command_spec -> string ->
wenzelm@43711
    22
    (Toplevel.transition -> Toplevel.transition) parser -> unit
wenzelm@46961
    23
  val local_theory': command_spec -> string ->
wenzelm@29380
    24
    (bool -> local_theory -> local_theory) parser -> unit
wenzelm@46961
    25
  val local_theory: command_spec -> string ->
wenzelm@29311
    26
    (local_theory -> local_theory) parser -> unit
wenzelm@46961
    27
  val local_theory_to_proof': command_spec -> string ->
wenzelm@29311
    28
    (bool -> local_theory -> Proof.state) parser -> unit
wenzelm@46961
    29
  val local_theory_to_proof: command_spec -> string ->
wenzelm@29311
    30
    (local_theory -> Proof.state) parser -> unit
wenzelm@5883
    31
  val print_outer_syntax: unit -> unit
wenzelm@36959
    32
  val scan: Position.T -> string -> Token.T list
wenzelm@25580
    33
  val parse: Position.T -> string -> Toplevel.transition list
wenzelm@26431
    34
  val process_file: Path.T -> theory -> theory
wenzelm@26600
    35
  type isar
wenzelm@38253
    36
  val isar: TextIO.instream -> bool -> isar
wenzelm@46876
    37
  val read_span: outer_syntax -> Token.T list -> Toplevel.transition * bool
wenzelm@44478
    38
  val read_element: outer_syntax -> (unit -> theory) -> Thy_Syntax.element ->
wenzelm@43712
    39
    (Toplevel.transition * Toplevel.transition list) list
wenzelm@5829
    40
end;
wenzelm@5829
    41
wenzelm@36953
    42
structure Outer_Syntax: OUTER_SYNTAX =
wenzelm@5829
    43
struct
wenzelm@5829
    44
wenzelm@5829
    45
(** outer syntax **)
wenzelm@5829
    46
wenzelm@29311
    47
(* command parsers *)
wenzelm@5829
    48
wenzelm@29311
    49
datatype command = Command of
wenzelm@24868
    50
 {comment: string,
wenzelm@37216
    51
  markup: Thy_Output.markup option,
wenzelm@24868
    52
  int_only: bool,
wenzelm@29311
    53
  parse: (Toplevel.transition -> Toplevel.transition) parser};
wenzelm@5829
    54
wenzelm@29311
    55
fun make_command comment markup int_only parse =
wenzelm@29311
    56
  Command {comment = comment, markup = markup, int_only = int_only, parse = parse};
wenzelm@5829
    57
wenzelm@5829
    58
wenzelm@5829
    59
(* parse command *)
wenzelm@5829
    60
wenzelm@6860
    61
local
wenzelm@6199
    62
wenzelm@14925
    63
fun terminate false = Scan.succeed ()
wenzelm@44357
    64
  | terminate true =
wenzelm@44357
    65
      Parse.group (fn () => "end of input")
wenzelm@44357
    66
        (Scan.option Parse.sync -- Parse.semicolon >> K ());
wenzelm@14925
    67
wenzelm@26620
    68
fun body cmd (name, _) =
wenzelm@7026
    69
  (case cmd name of
wenzelm@29311
    70
    SOME (Command {int_only, parse, ...}) =>
wenzelm@36950
    71
      Parse.!!! (Scan.prompt (name ^ "# ") (Parse.tags |-- parse >> pair int_only))
wenzelm@37852
    72
  | NONE => raise Fail ("No parser for outer syntax command " ^ quote name));
wenzelm@6860
    73
wenzelm@6860
    74
in
wenzelm@5829
    75
wenzelm@26620
    76
fun parse_command do_terminate cmd =
wenzelm@36950
    77
  Parse.semicolon >> K NONE ||
wenzelm@36950
    78
  Parse.sync >> K NONE ||
wenzelm@36950
    79
  (Parse.position Parse.command :-- body cmd) --| terminate do_terminate
wenzelm@6860
    80
    >> (fn ((name, pos), (int_only, f)) =>
skalberg@15531
    81
      SOME (Toplevel.empty |> Toplevel.name name |> Toplevel.position pos |>
wenzelm@6860
    82
        Toplevel.interactive int_only |> f));
wenzelm@5829
    83
wenzelm@6199
    84
end;
wenzelm@6199
    85
wenzelm@5829
    86
wenzelm@43711
    87
(* type outer_syntax *)
wenzelm@43711
    88
wenzelm@43711
    89
datatype outer_syntax = Outer_Syntax of
wenzelm@43711
    90
 {commands: command Symtab.table,
wenzelm@43711
    91
  markups: (string * Thy_Output.markup) list};
wenzelm@43711
    92
wenzelm@43711
    93
fun make_outer_syntax commands markups =
wenzelm@43711
    94
  Outer_Syntax {commands = commands, markups = markups};
wenzelm@43711
    95
wenzelm@43711
    96
val empty_outer_syntax = make_outer_syntax Symtab.empty [];
wenzelm@43711
    97
wenzelm@43711
    98
wenzelm@43711
    99
fun map_commands f (Outer_Syntax {commands, ...}) =
wenzelm@43711
   100
  let
wenzelm@43711
   101
    val commands' = f commands;
wenzelm@43711
   102
    val markups' =
wenzelm@43711
   103
      Symtab.fold (fn (name, Command {markup = SOME m, ...}) => cons (name, m) | _ => I)
wenzelm@43711
   104
        commands' [];
wenzelm@43711
   105
  in make_outer_syntax commands' markups' end;
wenzelm@43711
   106
wenzelm@43711
   107
fun dest_commands (Outer_Syntax {commands, ...}) =
wenzelm@43711
   108
  commands |> Symtab.dest |> sort_wrt #1
wenzelm@43711
   109
  |> map (fn (name, Command {comment, int_only, ...}) => (name, comment, int_only));
wenzelm@43711
   110
wenzelm@43711
   111
fun lookup_commands (Outer_Syntax {commands, ...}) = Symtab.lookup commands;
wenzelm@43711
   112
wenzelm@43711
   113
fun is_markup (Outer_Syntax {markups, ...}) kind name =
wenzelm@43711
   114
  AList.lookup (op =) markups name = SOME kind;
wenzelm@43711
   115
wenzelm@43711
   116
wenzelm@5829
   117
wenzelm@9132
   118
(** global outer syntax **)
wenzelm@5829
   119
wenzelm@46961
   120
type command_spec = string * Keyword.T;
wenzelm@46961
   121
wenzelm@7026
   122
local
wenzelm@7026
   123
wenzelm@43711
   124
(*synchronized wrt. Keywords*)
wenzelm@43711
   125
val global_outer_syntax = Unsynchronized.ref empty_outer_syntax;
wenzelm@5952
   126
wenzelm@46961
   127
fun add_command (name, kind) cmd = CRITICAL (fn () =>
wenzelm@46950
   128
  let
wenzelm@46950
   129
    val thy = ML_Context.the_global_context ();
wenzelm@46950
   130
    val _ =
wenzelm@46950
   131
      (case try (Thy_Header.the_keyword thy) name of
wenzelm@46961
   132
        SOME spec =>
wenzelm@47014
   133
          if Option.map #1 spec = SOME (Keyword.kind_of kind) then ()
wenzelm@46950
   134
          else error ("Inconsistent outer syntax keyword declaration " ^ quote name)
wenzelm@46950
   135
      | NONE =>
wenzelm@46961
   136
          if Context.theory_name thy = Context.PureN
wenzelm@46961
   137
          then Keyword.define (name, SOME kind)
wenzelm@46957
   138
          else error ("Undeclared outer syntax command " ^ quote name));
wenzelm@46950
   139
  in
wenzelm@46950
   140
    Unsynchronized.change global_outer_syntax (map_commands (fn commands =>
wenzelm@46950
   141
     (if not (Symtab.defined commands name) then ()
wenzelm@46950
   142
      else warning ("Redefining outer syntax command " ^ quote name);
wenzelm@46950
   143
      Symtab.update (name, cmd) commands)))
wenzelm@46950
   144
  end);
wenzelm@6722
   145
wenzelm@7026
   146
in
wenzelm@7026
   147
wenzelm@43711
   148
fun get_syntax () = CRITICAL (fn () => (Keyword.get_lexicons (), ! global_outer_syntax));
wenzelm@7789
   149
wenzelm@46970
   150
fun check_syntax () =
wenzelm@46970
   151
  let
wenzelm@46970
   152
    val ((_, major), syntax) = CRITICAL (fn () => (Keyword.dest (), ! global_outer_syntax));
wenzelm@46970
   153
  in
wenzelm@46970
   154
    (case subtract (op =) (map #1 (dest_commands syntax)) major of
wenzelm@46970
   155
      [] => ()
wenzelm@46970
   156
    | missing => error ("Missing outer syntax command(s) " ^ commas_quote missing))
wenzelm@46970
   157
  end;
wenzelm@46970
   158
wenzelm@43711
   159
fun lookup_commands_dynamic () = lookup_commands (! global_outer_syntax);
wenzelm@5829
   160
wenzelm@46961
   161
fun command command_spec comment parse =
wenzelm@46961
   162
  add_command command_spec (make_command comment NONE false parse);
wenzelm@24868
   163
wenzelm@46961
   164
fun markup_command markup command_spec comment parse =
wenzelm@46961
   165
  add_command command_spec (make_command comment (SOME markup) false parse);
wenzelm@7026
   166
wenzelm@46961
   167
fun improper_command command_spec comment parse =
wenzelm@46961
   168
  add_command command_spec (make_command comment NONE true parse);
wenzelm@29311
   169
wenzelm@43711
   170
end;
wenzelm@43711
   171
wenzelm@5829
   172
wenzelm@26990
   173
(* local_theory commands *)
wenzelm@26990
   174
wenzelm@46961
   175
fun local_theory_command do_print trans command_spec comment parse =
wenzelm@46961
   176
  command command_spec comment (Parse.opt_target -- parse
wenzelm@26990
   177
    >> (fn (loc, f) => (if do_print then Toplevel.print else I) o trans loc f));
wenzelm@26990
   178
wenzelm@29380
   179
val local_theory' = local_theory_command false Toplevel.local_theory';
wenzelm@29311
   180
val local_theory = local_theory_command false Toplevel.local_theory;
wenzelm@26990
   181
val local_theory_to_proof' = local_theory_command true Toplevel.local_theory_to_proof';
wenzelm@29311
   182
val local_theory_to_proof = local_theory_command true Toplevel.local_theory_to_proof;
wenzelm@26990
   183
wenzelm@26990
   184
wenzelm@24872
   185
(* inspect syntax *)
wenzelm@7026
   186
wenzelm@9223
   187
fun print_outer_syntax () =
wenzelm@7026
   188
  let
wenzelm@46957
   189
    val ((keywords, _), outer_syntax) =
wenzelm@46957
   190
      CRITICAL (fn () => (Keyword.dest (), #2 (get_syntax ())));
wenzelm@27353
   191
    fun pretty_cmd (name, comment, _) =
wenzelm@7026
   192
      Pretty.block [Pretty.str (name ^ ":"), Pretty.brk 2, Pretty.str comment];
wenzelm@43711
   193
    val (int_cmds, cmds) = List.partition #3 (dest_commands outer_syntax);
wenzelm@7026
   194
  in
wenzelm@43711
   195
    [Pretty.strs ("syntax keywords:" :: map quote keywords),
wenzelm@18326
   196
      Pretty.big_list "commands:" (map pretty_cmd cmds),
wenzelm@18326
   197
      Pretty.big_list "interactive-only commands:" (map pretty_cmd int_cmds)]
wenzelm@9223
   198
    |> Pretty.chunks |> Pretty.writeln
wenzelm@7026
   199
  end;
wenzelm@5829
   200
wenzelm@5829
   201
wenzelm@5829
   202
wenzelm@9132
   203
(** toplevel parsing **)
wenzelm@5829
   204
wenzelm@9132
   205
(* basic sources *)
wenzelm@6860
   206
wenzelm@26620
   207
fun toplevel_source term do_recover cmd src =
wenzelm@9132
   208
  let
wenzelm@9132
   209
    val no_terminator =
wenzelm@36959
   210
      Scan.unless Parse.semicolon (Scan.one (Token.not_sync andf Token.not_eof));
wenzelm@23682
   211
    fun recover int =
wenzelm@23682
   212
      (int, fn _ => Scan.prompt "recover# " (Scan.repeat no_terminator) >> K [NONE]);
wenzelm@9132
   213
  in
wenzelm@9132
   214
    src
wenzelm@36959
   215
    |> Token.source_proper
wenzelm@36959
   216
    |> Source.source Token.stopper
wenzelm@36950
   217
      (Scan.bulk (Parse.$$$ "--" -- Parse.!!! Parse.doc_source >> K NONE || Parse.not_eof >> SOME))
wenzelm@23682
   218
        (Option.map recover do_recover)
wenzelm@19482
   219
    |> Source.map_filter I
wenzelm@36959
   220
    |> Source.source Token.stopper
wenzelm@36950
   221
        (Scan.bulk (fn xs => Parse.!!! (parse_command term (cmd ())) xs))
wenzelm@23682
   222
        (Option.map recover do_recover)
wenzelm@19482
   223
    |> Source.map_filter I
wenzelm@9132
   224
  end;
wenzelm@5829
   225
wenzelm@7746
   226
wenzelm@25580
   227
(* off-line scanning/parsing *)
wenzelm@14925
   228
wenzelm@27839
   229
fun scan pos str =
wenzelm@16195
   230
  Source.of_string str
wenzelm@40523
   231
  |> Symbol.source
wenzelm@36959
   232
  |> Token.source {do_recover = SOME false} Keyword.get_lexicons pos
wenzelm@16195
   233
  |> Source.exhaust;
wenzelm@16195
   234
wenzelm@25580
   235
fun parse pos str =
wenzelm@25580
   236
  Source.of_string str
wenzelm@40523
   237
  |> Symbol.source
wenzelm@36959
   238
  |> Token.source {do_recover = SOME false} Keyword.get_lexicons pos
wenzelm@43711
   239
  |> toplevel_source false NONE lookup_commands_dynamic
wenzelm@25580
   240
  |> Source.exhaust;
wenzelm@25580
   241
nipkow@14091
   242
wenzelm@26431
   243
(* process file *)
wenzelm@26431
   244
wenzelm@26431
   245
fun process_file path thy =
wenzelm@26431
   246
  let
wenzelm@26881
   247
    val trs = parse (Path.position path) (File.read path);
wenzelm@44187
   248
    val init = Toplevel.init_theory (K thy) Toplevel.empty;
wenzelm@28424
   249
    val result = fold Toplevel.command (init :: trs) Toplevel.toplevel;
wenzelm@28424
   250
  in
wenzelm@28424
   251
    (case (Toplevel.is_theory result, Toplevel.generic_theory_of result) of
wenzelm@28424
   252
      (true, Context.Theory thy') => thy'
wenzelm@28424
   253
    | _ => error "Bad result state: global theory expected")
wenzelm@28424
   254
  end;
wenzelm@26431
   255
wenzelm@26431
   256
wenzelm@24868
   257
(* interactive source of toplevel transformers *)
wenzelm@24868
   258
wenzelm@26600
   259
type isar =
wenzelm@26600
   260
  (Toplevel.transition, (Toplevel.transition option,
wenzelm@36959
   261
    (Token.T, (Token.T option, (Token.T, (Token.T,
wenzelm@30573
   262
      (Symbol_Pos.T, Position.T * (Symbol.symbol, (string, unit) Source.source)
wenzelm@27770
   263
  Source.source) Source.source) Source.source) Source.source)
wenzelm@27770
   264
  Source.source) Source.source) Source.source) Source.source;
wenzelm@26600
   265
wenzelm@38253
   266
fun isar in_stream term : isar =
wenzelm@38253
   267
  Source.tty in_stream
wenzelm@40523
   268
  |> Symbol.source
wenzelm@36959
   269
  |> Token.source {do_recover = SOME true} Keyword.get_lexicons Position.none
wenzelm@43711
   270
  |> toplevel_source term (SOME true) lookup_commands_dynamic;
wenzelm@24868
   271
wenzelm@24868
   272
wenzelm@44478
   273
(* read toplevel commands -- fail-safe *)
wenzelm@27839
   274
wenzelm@27839
   275
val not_singleton = "Exactly one command expected";
wenzelm@27839
   276
wenzelm@44658
   277
fun read_span outer_syntax toks =
wenzelm@27839
   278
  let
wenzelm@43711
   279
    val commands = lookup_commands outer_syntax;
wenzelm@44658
   280
    val range_pos = Position.set_range (Token.range toks);
wenzelm@44736
   281
    val _ = Position.reports (maps Thy_Syntax.reports_of_token toks);
wenzelm@27839
   282
  in
wenzelm@29311
   283
    (case Source.exhaust (toplevel_source false NONE (K commands) (Source.of_list toks)) of
wenzelm@37713
   284
      [tr] =>
wenzelm@37713
   285
        if Keyword.is_control (Toplevel.name_of tr) then
wenzelm@44658
   286
          (Toplevel.malformed (Toplevel.pos_of tr) "Illegal control command", true)
wenzelm@37713
   287
        else (tr, true)
wenzelm@27839
   288
    | [] => (Toplevel.ignored range_pos, false)
wenzelm@27839
   289
    | _ => (Toplevel.malformed range_pos not_singleton, true))
wenzelm@27839
   290
    handle ERROR msg => (Toplevel.malformed range_pos msg, true)
wenzelm@27839
   291
  end;
wenzelm@27839
   292
wenzelm@44478
   293
fun read_element outer_syntax init {head, proof, proper_proof} =
wenzelm@28436
   294
  let
wenzelm@44658
   295
    val read = read_span outer_syntax o Thy_Syntax.span_content;
wenzelm@44658
   296
    val (tr, proper_head) = read head |>> Toplevel.modify_init init;
wenzelm@44658
   297
    val proof_trs = map read proof |> filter #2 |> map #1;
wenzelm@28436
   298
  in
wenzelm@47416
   299
    if proper_head andalso proper_proof andalso
wenzelm@47416
   300
      not (Keyword.is_schematic_goal (Toplevel.name_of tr)) then [(tr, proof_trs)]
wenzelm@43621
   301
    else map (rpair []) (if proper_head then tr :: proof_trs else proof_trs)
wenzelm@28436
   302
  end;
wenzelm@28432
   303
wenzelm@5829
   304
end;
wenzelm@36953
   305