src/Pure/General/symbol_pos.ML
author wenzelm
Wed Aug 27 12:32:42 2014 +0200 (2014-08-27)
changeset 58047 9f3826352b52
parent 55829 b7bdea5336dd
child 58850 1bb0ad7827b4
permissions -rw-r--r--
tuned signature -- prefer quasi-abstract Symbol_Pos.source;
wenzelm@27763
     1
(*  Title:      Pure/General/symbol_pos.ML
wenzelm@27763
     2
    Author:     Makarius
wenzelm@27763
     3
wenzelm@27763
     4
Symbols with explicit position information.
wenzelm@27763
     5
*)
wenzelm@27763
     6
wenzelm@36957
     7
signature SYMBOL_POS =
wenzelm@27763
     8
sig
wenzelm@27763
     9
  type T = Symbol.symbol * Position.T
wenzelm@27763
    10
  val symbol: T -> Symbol.symbol
wenzelm@55103
    11
  val $$ : Symbol.symbol -> T list -> T * T list
wenzelm@55107
    12
  val ~$$ : Symbol.symbol -> T list -> T * T list
wenzelm@27763
    13
  val $$$ : Symbol.symbol -> T list -> T list * T list
wenzelm@27763
    14
  val ~$$$ : Symbol.symbol -> T list -> T list * T list
wenzelm@27797
    15
  val content: T list -> string
wenzelm@55033
    16
  val range: T list -> Position.range
wenzelm@27763
    17
  val is_eof: T -> bool
wenzelm@27763
    18
  val stopper: T Scan.stopper
wenzelm@43947
    19
  val !!! : Scan.message -> (T list -> 'a) -> T list -> 'a
wenzelm@30586
    20
  val change_prompt: ('a -> 'b) -> 'a -> 'b
wenzelm@27778
    21
  val scan_pos: T list -> Position.T * T list
wenzelm@48764
    22
  val scan_string_q: string -> T list -> (Position.T * (T list * Position.T)) * T list
wenzelm@48764
    23
  val scan_string_qq: string -> T list -> (Position.T * (T list * Position.T)) * T list
wenzelm@48764
    24
  val scan_string_bq: string -> T list -> (Position.T * (T list * Position.T)) * T list
wenzelm@48743
    25
  val recover_string_q: T list -> T list * T list
wenzelm@48743
    26
  val recover_string_qq: T list -> T list * T list
wenzelm@48743
    27
  val recover_string_bq: T list -> T list * T list
wenzelm@43773
    28
  val quote_string_q: string -> string
wenzelm@43773
    29
  val quote_string_qq: string -> string
wenzelm@43773
    30
  val quote_string_bq: string -> string
wenzelm@55105
    31
  val scan_cartouche: string -> T list -> T list * T list
wenzelm@55033
    32
  val recover_cartouche: T list -> T list * T list
wenzelm@55033
    33
  val cartouche_content: T list -> T list
wenzelm@55105
    34
  val scan_comment: string -> T list -> T list * T list
wenzelm@55105
    35
  val scan_comment_body: string -> T list -> T list * T list
wenzelm@48743
    36
  val recover_comment: T list -> T list * T list
wenzelm@27763
    37
  val source: Position.T -> (Symbol.symbol, 'a) Source.source ->
wenzelm@27763
    38
    (T, Position.T * (Symbol.symbol, 'a) Source.source) Source.source
wenzelm@27778
    39
  type text = string
wenzelm@27797
    40
  val implode: T list -> text
wenzelm@27797
    41
  val implode_range: Position.T -> Position.T -> T list -> text * Position.range
wenzelm@27778
    42
  val explode: text * Position.T -> T list
wenzelm@55829
    43
  type source = {delimited: bool, text: text, pos: Position.T}
wenzelm@58047
    44
  val source_explode: source -> T list
wenzelm@55829
    45
  val source_content: source -> string * Position.T
wenzelm@50239
    46
  val scan_ident: T list -> T list * T list
wenzelm@50239
    47
  val is_identifier: string -> bool
wenzelm@27763
    48
end;
wenzelm@27763
    49
wenzelm@30573
    50
structure Symbol_Pos: SYMBOL_POS =
wenzelm@27763
    51
struct
wenzelm@27763
    52
wenzelm@27763
    53
(* type T *)
wenzelm@27763
    54
wenzelm@27763
    55
type T = Symbol.symbol * Position.T;
wenzelm@27763
    56
wenzelm@27763
    57
fun symbol ((s, _): T) = s;
wenzelm@27852
    58
wenzelm@27797
    59
val content = implode o map symbol;
wenzelm@27763
    60
wenzelm@55033
    61
fun range (syms as (_, pos) :: _) =
wenzelm@55033
    62
      let val pos' = List.last syms |-> Position.advance
wenzelm@55033
    63
      in Position.range pos pos' end
wenzelm@55033
    64
  | range [] = Position.no_range;
wenzelm@55033
    65
wenzelm@27763
    66
wenzelm@27763
    67
(* stopper *)
wenzelm@27763
    68
wenzelm@27763
    69
fun mk_eof pos = (Symbol.eof, pos);
wenzelm@27763
    70
val eof = mk_eof Position.none;
wenzelm@27763
    71
wenzelm@27763
    72
val is_eof = Symbol.is_eof o symbol;
wenzelm@27763
    73
wenzelm@27763
    74
val stopper =
wenzelm@27763
    75
  Scan.stopper (fn [] => eof | inp => mk_eof (List.last inp |-> Position.advance)) is_eof;
wenzelm@27763
    76
wenzelm@27763
    77
wenzelm@27763
    78
(* basic scanners *)
wenzelm@27763
    79
wenzelm@27763
    80
fun !!! text scan =
wenzelm@27763
    81
  let
wenzelm@48911
    82
    fun get_pos [] = " (end-of-input)"
wenzelm@48992
    83
      | get_pos ((_, pos) :: _) = Position.here pos;
wenzelm@27763
    84
wenzelm@43947
    85
    fun err (syms, msg) = fn () =>
wenzelm@48770
    86
      text () ^ get_pos syms ^
wenzelm@50201
    87
      Markup.markup Markup.no_report (" at " ^ Symbol.beginning 10 (map symbol syms)) ^
wenzelm@43947
    88
      (case msg of NONE => "" | SOME m => "\n" ^ m ());
wenzelm@27763
    89
  in Scan.!! err scan end;
wenzelm@27763
    90
wenzelm@30586
    91
fun change_prompt scan = Scan.prompt "# " scan;
wenzelm@30586
    92
wenzelm@55033
    93
fun $$ s = Scan.one (fn x => symbol x = s);
wenzelm@55107
    94
fun ~$$ s = Scan.one (fn x => symbol x <> s);
wenzelm@55107
    95
wenzelm@27763
    96
fun $$$ s = Scan.one (fn x => symbol x = s) >> single;
wenzelm@27763
    97
fun ~$$$ s = Scan.one (fn x => symbol x <> s) >> single;
wenzelm@27763
    98
wenzelm@27778
    99
val scan_pos = Scan.ahead (Scan.one (K true)) >> (fn (_, pos): T => pos);
wenzelm@27763
   100
wenzelm@27763
   101
wenzelm@43773
   102
(* scan string literals *)
wenzelm@30586
   103
wenzelm@30586
   104
local
wenzelm@30586
   105
wenzelm@30586
   106
val char_code =
wenzelm@30586
   107
  Scan.one (Symbol.is_ascii_digit o symbol) --
wenzelm@30586
   108
  Scan.one (Symbol.is_ascii_digit o symbol) --
wenzelm@30586
   109
  Scan.one (Symbol.is_ascii_digit o symbol) :|--
wenzelm@30586
   110
  (fn (((a, pos), (b, _)), (c, _)) =>
wenzelm@30586
   111
    let val (n, _) = Library.read_int [a, b, c]
wenzelm@30586
   112
    in if n <= 255 then Scan.succeed [(chr n, pos)] else Scan.fail end);
wenzelm@30586
   113
wenzelm@48764
   114
fun scan_str q err_prefix =
wenzelm@48764
   115
  $$$ "\\" |-- !!! (fn () => err_prefix ^ "bad escape character in string")
wenzelm@48764
   116
    ($$$ q || $$$ "\\" || char_code) ||
wenzelm@30586
   117
  Scan.one (fn (s, _) => s <> q andalso s <> "\\" andalso Symbol.is_regular s) >> single;
wenzelm@30586
   118
wenzelm@48764
   119
fun scan_strs q err_prefix =
wenzelm@55103
   120
  Scan.ahead ($$ q) |--
wenzelm@55103
   121
    !!! (fn () => err_prefix ^ "unclosed string literal")
wenzelm@55103
   122
      ((scan_pos --| $$$ q) --
wenzelm@55103
   123
        (change_prompt ((Scan.repeat (scan_str q err_prefix) >> flat) -- ($$$ q |-- scan_pos))));
wenzelm@30586
   124
wenzelm@48743
   125
fun recover_strs q =
wenzelm@48764
   126
  $$$ q @@@ (Scan.repeat (Scan.permissive (scan_str q "")) >> flat);
wenzelm@48743
   127
wenzelm@30586
   128
in
wenzelm@30586
   129
wenzelm@42503
   130
val scan_string_q = scan_strs "'";
wenzelm@42503
   131
val scan_string_qq = scan_strs "\"";
wenzelm@42503
   132
val scan_string_bq = scan_strs "`";
wenzelm@30586
   133
wenzelm@48743
   134
val recover_string_q = recover_strs "'";
wenzelm@48743
   135
val recover_string_qq = recover_strs "\"";
wenzelm@48743
   136
val recover_string_bq = recover_strs "`";
wenzelm@48743
   137
wenzelm@30586
   138
end;
wenzelm@30586
   139
wenzelm@30586
   140
wenzelm@43773
   141
(* quote string literals *)
wenzelm@43773
   142
wenzelm@43773
   143
local
wenzelm@43773
   144
wenzelm@43773
   145
fun char_code i =
wenzelm@43773
   146
  (if i < 10 then "00" else if i < 100 then "0" else "") ^ string_of_int i;
wenzelm@43773
   147
wenzelm@43773
   148
fun quote_str q s =
wenzelm@43773
   149
  if Symbol.is_ascii_control s then "\\" ^ char_code (ord s)
wenzelm@43773
   150
  else if s = q orelse s = "\\" then "\\" ^ s
wenzelm@43773
   151
  else s;
wenzelm@43773
   152
wenzelm@43773
   153
fun quote_string q = enclose q q o implode o map (quote_str q) o Symbol.explode;
wenzelm@43773
   154
wenzelm@43773
   155
in
wenzelm@43773
   156
wenzelm@43773
   157
val quote_string_q = quote_string "'";
wenzelm@43773
   158
val quote_string_qq = quote_string "\"";
wenzelm@43773
   159
val quote_string_bq = quote_string "`";
wenzelm@43773
   160
wenzelm@43773
   161
end;
wenzelm@43773
   162
wenzelm@43773
   163
wenzelm@55033
   164
(* nested text cartouches *)
wenzelm@55033
   165
wenzelm@55104
   166
val scan_cartouche_depth =
wenzelm@55104
   167
  Scan.repeat1 (Scan.depend (fn (d: int) =>
wenzelm@55104
   168
    $$ "\\<open>" >> pair (d + 1) ||
wenzelm@55104
   169
      (if d > 0 then
wenzelm@55104
   170
        Scan.one (fn (s, _) => s <> "\\<close>" andalso Symbol.is_regular s) >> pair d ||
wenzelm@55104
   171
        $$ "\\<close>" >> pair (d - 1)
wenzelm@55104
   172
      else Scan.fail)));
wenzelm@55033
   173
wenzelm@55105
   174
fun scan_cartouche err_prefix =
wenzelm@55104
   175
  Scan.ahead ($$ "\\<open>") |--
wenzelm@55105
   176
    !!! (fn () => err_prefix ^ "unclosed text cartouche")
wenzelm@55104
   177
      (change_prompt (Scan.provide (fn d => d = 0) 0 scan_cartouche_depth));
wenzelm@55033
   178
wenzelm@55104
   179
val recover_cartouche = Scan.pass 0 scan_cartouche_depth;
wenzelm@55033
   180
wenzelm@55033
   181
fun cartouche_content syms =
wenzelm@55033
   182
  let
wenzelm@55033
   183
    fun err () =
wenzelm@55709
   184
      error ("Malformed text cartouche: "
wenzelm@55709
   185
        ^ quote (content syms) ^ Position.here (#1 (range syms)));
wenzelm@55033
   186
  in
wenzelm@55033
   187
    (case syms of
wenzelm@55033
   188
      ("\\<open>", _) :: rest =>
wenzelm@55033
   189
        (case rev rest of
wenzelm@55033
   190
          ("\\<close>", _) :: rrest => rev rrest
wenzelm@55033
   191
        | _ => err ())
wenzelm@55033
   192
    | _ => err ())
wenzelm@55033
   193
  end;
wenzelm@55033
   194
wenzelm@55033
   195
wenzelm@27763
   196
(* ML-style comments *)
wenzelm@27763
   197
wenzelm@27763
   198
local
wenzelm@27763
   199
wenzelm@27763
   200
val scan_cmt =
wenzelm@27763
   201
  Scan.depend (fn (d: int) => $$$ "(" @@@ $$$ "*" >> pair (d + 1)) ||
wenzelm@27763
   202
  Scan.depend (fn 0 => Scan.fail | d => $$$ "*" @@@ $$$ ")" >> pair (d - 1)) ||
wenzelm@27763
   203
  Scan.lift ($$$ "*" --| Scan.ahead (~$$$ ")")) ||
wenzelm@27763
   204
  Scan.lift (Scan.one (fn (s, _) => s <> "*" andalso Symbol.is_regular s)) >> single;
wenzelm@27763
   205
wenzelm@48743
   206
val scan_cmts = Scan.pass 0 (Scan.repeat scan_cmt >> flat);
wenzelm@48743
   207
wenzelm@48743
   208
val scan_body = change_prompt scan_cmts;
wenzelm@27763
   209
wenzelm@27763
   210
in
wenzelm@27763
   211
wenzelm@55105
   212
fun scan_comment err_prefix =
wenzelm@55106
   213
  Scan.ahead ($$ "(" -- $$ "*") |--
wenzelm@55106
   214
    !!! (fn () => err_prefix ^ "unclosed comment")
wenzelm@55106
   215
      ($$$ "(" @@@ $$$ "*" @@@ scan_body @@@ $$$ "*" @@@ $$$ ")");
wenzelm@27763
   216
wenzelm@55105
   217
fun scan_comment_body err_prefix =
wenzelm@55106
   218
  Scan.ahead ($$ "(" -- $$ "*") |--
wenzelm@55106
   219
    !!! (fn () => err_prefix ^ "unclosed comment")
wenzelm@55106
   220
      ($$ "(" |-- $$ "*" |-- scan_body --| $$ "*" --| $$ ")");
wenzelm@27763
   221
wenzelm@48743
   222
val recover_comment =
wenzelm@48743
   223
  $$$ "(" @@@ $$$ "*" @@@ scan_cmts;
wenzelm@48743
   224
wenzelm@27763
   225
end;
wenzelm@27763
   226
wenzelm@27763
   227
wenzelm@27763
   228
(* source *)
wenzelm@27763
   229
wenzelm@27763
   230
fun source pos =
wenzelm@27763
   231
  Source.source' pos Symbol.stopper (Scan.bulk (Scan.depend (fn pos =>
wenzelm@27763
   232
    Scan.one Symbol.not_eof >> (fn s => (Position.advance s pos, (s, pos)))))) NONE;
wenzelm@27763
   233
wenzelm@27763
   234
wenzelm@27763
   235
(* compact representation -- with Symbol.DEL padding *)
wenzelm@27763
   236
wenzelm@27778
   237
type text = string;
wenzelm@27778
   238
wenzelm@27763
   239
fun pad [] = []
wenzelm@27763
   240
  | pad [(s, _)] = [s]
wenzelm@32784
   241
  | pad ((s1, pos1) :: (rest as (_, pos2) :: _)) =
wenzelm@27763
   242
      let
wenzelm@27763
   243
        val end_pos1 = Position.advance s1 pos1;
wenzelm@27797
   244
        val d = Int.max (0, Position.distance_of end_pos1 pos2);
wenzelm@27763
   245
      in s1 :: replicate d Symbol.DEL @ pad rest end;
wenzelm@27763
   246
wenzelm@27797
   247
val implode = implode o pad;
wenzelm@27763
   248
wenzelm@27797
   249
fun implode_range pos1 pos2 syms =
wenzelm@27797
   250
  let val syms' = (("", pos1) :: syms @ [("", pos2)])
wenzelm@27797
   251
  in (implode syms', range syms') end;
wenzelm@27778
   252
wenzelm@27763
   253
fun explode (str, pos) =
wenzelm@41416
   254
  let
wenzelm@41416
   255
    val (res, _) =
wenzelm@41416
   256
      fold (fn s => fn (res, p) => ((s, p) :: res, Position.advance s p))
wenzelm@41416
   257
        (Symbol.explode str) ([], Position.reset_range pos);
wenzelm@41416
   258
  in fold (fn (s, p) => if s = Symbol.DEL then I else cons (s, p)) res [] end;
wenzelm@27763
   259
wenzelm@50239
   260
wenzelm@55829
   261
(* full source information *)
wenzelm@55829
   262
wenzelm@55829
   263
type source = {delimited: bool, text: text, pos: Position.T};
wenzelm@55829
   264
wenzelm@58047
   265
fun source_explode {delimited = _, text, pos} = explode (text, pos);
wenzelm@58047
   266
wenzelm@55829
   267
fun source_content {delimited = _, text, pos} =
wenzelm@55829
   268
  let val syms = explode (text, pos) in (content syms, pos) end;
wenzelm@55829
   269
wenzelm@55829
   270
wenzelm@50239
   271
(* identifiers *)
wenzelm@50239
   272
wenzelm@50242
   273
local
wenzelm@50242
   274
wenzelm@52616
   275
val letter = Scan.one (symbol #> Symbol.is_letter);
wenzelm@52616
   276
val letdigs1 = Scan.many1 (symbol #> Symbol.is_letdig);
wenzelm@53016
   277
wenzelm@54732
   278
val sub = Scan.one (symbol #> (fn s => s = "\\<^sub>"));
wenzelm@50242
   279
wenzelm@50242
   280
in
wenzelm@50242
   281
wenzelm@52920
   282
val scan_ident = letter ::: (Scan.repeat (letdigs1 || sub ::: letdigs1) >> flat);
wenzelm@50242
   283
wenzelm@50242
   284
end;
wenzelm@50242
   285
wenzelm@50239
   286
fun is_identifier s =
wenzelm@50295
   287
  Symbol.is_ascii_identifier s orelse
wenzelm@50295
   288
    (case try (Scan.finite stopper scan_ident) (explode (s, Position.none)) of
wenzelm@50295
   289
      SOME (_, []) => true
wenzelm@50295
   290
    | _ => false);
wenzelm@50239
   291
wenzelm@27763
   292
end;
wenzelm@27763
   293
wenzelm@36957
   294
structure Basic_Symbol_Pos =   (*not open by default*)
wenzelm@36957
   295
struct
wenzelm@55103
   296
  val $$ = Symbol_Pos.$$;
wenzelm@55107
   297
  val ~$$ = Symbol_Pos.~$$;
wenzelm@36957
   298
  val $$$ = Symbol_Pos.$$$;
wenzelm@36957
   299
  val ~$$$ = Symbol_Pos.~$$$;
wenzelm@36957
   300
end;
wenzelm@27763
   301