src/Pure/Isar/args.ML
author wenzelm
Mon Nov 16 11:02:07 1998 +0100 (1998-11-16)
changeset 5878 769abc29bb8e
parent 5822 3f824514ad88
child 5911 7da8033264fa
permissions -rw-r--r--
several args parsers;
include positions;
misc tuning;
wenzelm@5822
     1
(*  Title:      Pure/Isar/args.ML
wenzelm@5822
     2
    ID:         $Id$
wenzelm@5822
     3
    Author:     Markus Wenzel, TU Muenchen
wenzelm@5822
     4
wenzelm@5878
     5
Concrete argument syntax (of attributes and methods).
wenzelm@5822
     6
*)
wenzelm@5822
     7
wenzelm@5822
     8
signature ARGS =
wenzelm@5822
     9
sig
wenzelm@5822
    10
  type T
wenzelm@5822
    11
  val val_of: T -> string
wenzelm@5878
    12
  val pos_of: T -> Position.T
wenzelm@5878
    13
  val str_of: T -> string
wenzelm@5878
    14
  val ident: string * Position.T -> T
wenzelm@5878
    15
  val string: string * Position.T -> T
wenzelm@5878
    16
  val keyword: string * Position.T -> T
wenzelm@5822
    17
  val stopper: T * (T -> bool)
wenzelm@5822
    18
  val not_eof: T -> bool
wenzelm@5878
    19
  val position: (T list -> 'a * 'b) -> T list -> ('a * Position.T) * 'b
wenzelm@5878
    20
  val !!! : (T list -> 'a) -> T list -> 'a
wenzelm@5822
    21
  val $$$ : string -> T list -> string * T list
wenzelm@5822
    22
  val name: T list -> string * T list
wenzelm@5878
    23
  val nat: T list -> int * T list
wenzelm@5878
    24
  val var: T list -> indexname * T list
wenzelm@5878
    25
  val enum1: string -> (T list -> 'a * T list) -> T list -> 'a list * T list
wenzelm@5878
    26
  val enum: string -> (T list -> 'a * T list) -> T list -> 'a list * T list
wenzelm@5878
    27
  val list1: (T list -> 'a * T list) -> T list -> 'a list * T list
wenzelm@5878
    28
  val list: (T list -> 'a * T list) -> T list -> 'a list * T list
wenzelm@5878
    29
  val global_typ: theory * T list -> typ * (theory * T list)
wenzelm@5878
    30
  val global_term: theory * T list -> term * (theory * T list)
wenzelm@5878
    31
  val global_prop: theory * T list -> term * (theory * T list)
wenzelm@5878
    32
  val global_pat: theory * T list -> term * (theory * T list)
wenzelm@5878
    33
  val local_typ: Proof.context * T list -> typ * (Proof.context * T list)
wenzelm@5878
    34
  val local_term: Proof.context * T list -> term * (Proof.context * T list)
wenzelm@5878
    35
  val local_prop: Proof.context * T list -> term * (Proof.context * T list)
wenzelm@5878
    36
  val local_pat: Proof.context * T list -> term * (Proof.context * T list)
wenzelm@5822
    37
  type src
wenzelm@5878
    38
  val src: (string * T list) * Position.T -> src
wenzelm@5878
    39
  val dest_src: src -> (string * T list) * Position.T
wenzelm@5878
    40
  val attribs: T list -> src list * T list
wenzelm@5878
    41
  val opt_attribs: T list -> src list * T list
wenzelm@5878
    42
  val syntax: string -> ('a * T list -> 'b * ('a * T list)) -> 'a -> src -> 'a * 'b
wenzelm@5822
    43
end;
wenzelm@5822
    44
wenzelm@5822
    45
structure Args: ARGS =
wenzelm@5822
    46
struct
wenzelm@5822
    47
wenzelm@5822
    48
wenzelm@5822
    49
(** datatype T **)
wenzelm@5822
    50
wenzelm@5822
    51
datatype kind = Ident | String | Keyword | EOF;
wenzelm@5878
    52
datatype T = Arg of kind * (string * Position.T);
wenzelm@5822
    53
wenzelm@5878
    54
fun val_of (Arg (_, (x, _))) = x;
wenzelm@5878
    55
fun pos_of (Arg (_, (_, pos))) = pos;
wenzelm@5822
    56
wenzelm@5878
    57
fun str_of (Arg (Ident, (x, _))) = enclose "'" "'" x
wenzelm@5878
    58
  | str_of (Arg (String, (x, _))) = quote x
wenzelm@5878
    59
  | str_of (Arg (Keyword, (x, _))) = x
wenzelm@5878
    60
  | str_of (Arg (EOF, _)) = "end-of-text";
wenzelm@5822
    61
wenzelm@5878
    62
fun arg kind x_pos = Arg (kind, x_pos);
wenzelm@5822
    63
val ident = arg Ident;
wenzelm@5822
    64
val string = arg String;
wenzelm@5822
    65
val keyword = arg Keyword;
wenzelm@5822
    66
wenzelm@5822
    67
wenzelm@5822
    68
(* eof *)
wenzelm@5822
    69
wenzelm@5878
    70
val eof = arg EOF ("", Position.none);
wenzelm@5822
    71
wenzelm@5822
    72
fun is_eof (Arg (EOF, _)) = true
wenzelm@5822
    73
  | is_eof _ = false;
wenzelm@5822
    74
wenzelm@5822
    75
val stopper = (eof, is_eof);
wenzelm@5822
    76
val not_eof = not o is_eof;
wenzelm@5822
    77
wenzelm@5822
    78
wenzelm@5822
    79
wenzelm@5822
    80
(** scanners **)
wenzelm@5822
    81
wenzelm@5878
    82
(* position *)
wenzelm@5878
    83
wenzelm@5878
    84
fun position scan = (Scan.ahead (Scan.one not_eof) >> pos_of) -- scan >> Library.swap;
wenzelm@5878
    85
wenzelm@5878
    86
wenzelm@5878
    87
(* cut *)
wenzelm@5878
    88
wenzelm@5878
    89
fun !!! scan =
wenzelm@5878
    90
  let
wenzelm@5878
    91
    fun get_pos [] = " (past end-of-text!)"
wenzelm@5878
    92
      | get_pos (Arg (_, (_, pos)) :: _) = Position.str_of pos;
wenzelm@5878
    93
wenzelm@5878
    94
    fun err (args, None) = "Argument syntax error" ^ get_pos args
wenzelm@5878
    95
      | err (args, Some msg) = "Argument syntax error" ^ get_pos args ^ ": " ^ msg;
wenzelm@5878
    96
  in Scan.!! err scan end;
wenzelm@5878
    97
wenzelm@5878
    98
wenzelm@5822
    99
(* basic *)
wenzelm@5822
   100
wenzelm@5878
   101
fun $$$$ x = Scan.one (fn Arg (k, (y, _)) => (k = Ident orelse k = Keyword) andalso x = y);
wenzelm@5878
   102
fun $$$ x = $$$$ x >> val_of;
wenzelm@5878
   103
wenzelm@5878
   104
val name = Scan.one (fn Arg (k, (x, _)) => k = Ident orelse k = String) >> val_of;
wenzelm@5878
   105
wenzelm@5878
   106
fun kind f = Scan.one (K true) :--
wenzelm@5878
   107
  (fn Arg (Ident, (x, _)) =>
wenzelm@5878
   108
    (case f x of Some y => Scan.succeed y | _ => Scan.fail)
wenzelm@5878
   109
  | _ => Scan.fail) >> #2;
wenzelm@5878
   110
wenzelm@5878
   111
val nat = kind Syntax.read_nat;
wenzelm@5878
   112
val var = kind (apsome #1 o try Term.dest_Var o Syntax.read_var);
wenzelm@5822
   113
wenzelm@5822
   114
wenzelm@5878
   115
(* enumerations *)
wenzelm@5878
   116
wenzelm@5878
   117
fun enum1 sep scan = scan -- Scan.repeat ($$$ sep |-- scan) >> op ::;
wenzelm@5878
   118
fun enum sep scan = enum1 sep scan || Scan.succeed [];
wenzelm@5878
   119
wenzelm@5878
   120
fun list1 scan = enum1 "," scan;
wenzelm@5878
   121
fun list scan = enum "," scan;
wenzelm@5878
   122
wenzelm@5822
   123
wenzelm@5878
   124
(* terms and types *)
wenzelm@5878
   125
wenzelm@5878
   126
fun gen_item read = Scan.depend (fn st => name >> (pair st o read st));
wenzelm@5878
   127
wenzelm@5878
   128
val global_typ = gen_item (ProofContext.read_typ o ProofContext.init);
wenzelm@5878
   129
val global_term = gen_item (ProofContext.read_term o ProofContext.init);
wenzelm@5878
   130
val global_prop = gen_item (ProofContext.read_prop o ProofContext.init);
wenzelm@5878
   131
val global_pat = gen_item (ProofContext.read_pat o ProofContext.init);
wenzelm@5822
   132
wenzelm@5878
   133
val local_typ = gen_item ProofContext.read_typ;
wenzelm@5878
   134
val local_term = gen_item ProofContext.read_term;
wenzelm@5878
   135
val local_prop = gen_item ProofContext.read_prop;
wenzelm@5878
   136
val local_pat = gen_item ProofContext.read_pat;
wenzelm@5878
   137
wenzelm@5878
   138
wenzelm@5878
   139
(* args *)
wenzelm@5878
   140
wenzelm@5878
   141
val exclude = explode "(){}[],";
wenzelm@5822
   142
wenzelm@5878
   143
fun atom_arg blk = Scan.one (fn Arg (k, (x, _)) =>
wenzelm@5878
   144
  k <> Keyword orelse not (x mem exclude) orelse blk andalso x = ",");
wenzelm@5878
   145
wenzelm@5878
   146
fun paren_args l r scan = $$$$ l -- !!! (scan true -- $$$$ r)
wenzelm@5878
   147
  >> (fn (x, (ys, z)) => x :: ys @ [z]);
wenzelm@5822
   148
wenzelm@5878
   149
fun args blk x = Scan.optional (args1 blk) [] x
wenzelm@5878
   150
and args1 blk x =
wenzelm@5878
   151
  ((Scan.repeat1
wenzelm@5878
   152
    (Scan.repeat1 (atom_arg blk) ||
wenzelm@5878
   153
      paren_args "(" ")" args ||
wenzelm@5878
   154
      paren_args "{" "}" args ||
wenzelm@5878
   155
      paren_args "[" "]" args)) >> flat) x;
wenzelm@5822
   156
wenzelm@5822
   157
wenzelm@5822
   158
wenzelm@5822
   159
(** type src **)
wenzelm@5822
   160
wenzelm@5878
   161
datatype src = Src of (string * T list) * Position.T;
wenzelm@5822
   162
wenzelm@5878
   163
val src = Src;
wenzelm@5878
   164
fun dest_src (Src src) = src;
wenzelm@5878
   165
wenzelm@5878
   166
fun err_in_src kind msg (Src ((s, args), pos)) =
wenzelm@5878
   167
  error (kind ^ " " ^ s ^ Position.str_of pos ^ ": " ^ msg ^ "\n  " ^
wenzelm@5878
   168
    space_implode " " (map str_of args));
wenzelm@5822
   169
wenzelm@5822
   170
wenzelm@5822
   171
(* argument syntax *)
wenzelm@5822
   172
wenzelm@5878
   173
(* FIXME *)
wenzelm@5878
   174
fun trace_src kind (Src ((s, args), pos)) =
wenzelm@5878
   175
  warning ("TRACE: " ^ space_implode " " (kind :: s :: map str_of args) ^ Position.str_of pos);
wenzelm@5878
   176
wenzelm@5878
   177
fun syntax kind scan st (src as Src ((s, args), pos)) =
wenzelm@5878
   178
  (trace_src kind src;
wenzelm@5878
   179
  (case handle_error (Scan.error (Scan.finite' stopper (Scan.option scan))) (st, args) of
wenzelm@5878
   180
    OK (Some x, (st', [])) => (st', x)
wenzelm@5878
   181
  | OK (_, (_, args')) => err_in_src kind "bad arguments" (Src ((s, args'), pos))
wenzelm@5878
   182
  | Error msg => err_in_src kind ("\n" ^ msg) src));
wenzelm@5878
   183
wenzelm@5878
   184
wenzelm@5878
   185
(* attribs *)
wenzelm@5878
   186
wenzelm@5878
   187
val attrib = position (name -- !!! (args false)) >> src;
wenzelm@5878
   188
val attribs = $$$ "[" |-- !!! (list attrib --| $$$ "]");
wenzelm@5878
   189
val opt_attribs = Scan.optional attribs [];
wenzelm@5822
   190
wenzelm@5822
   191
wenzelm@5822
   192
end;