src/Tools/code/code_printer.ML
author haftmann
Mon Sep 01 10:18:37 2008 +0200 (2008-09-01)
changeset 28064 d4a6460c53d1
parent 28060 1ee2d3bc25db
child 28663 bd8438543bf2
permissions -rw-r--r--
restructured code generation of literals
haftmann@28060
     1
(*  Title:      Tools/code/code_printer.ML
haftmann@28060
     2
    ID:         $Id$
haftmann@28060
     3
    Author:     Florian Haftmann, TU Muenchen
haftmann@28060
     4
haftmann@28060
     5
Generic operations for pretty printing of target language code.
haftmann@28060
     6
*)
haftmann@28060
     7
haftmann@28060
     8
signature CODE_PRINTER =
haftmann@28060
     9
sig
haftmann@28060
    10
  val first_upper: string -> string
haftmann@28060
    11
  val first_lower: string -> string
haftmann@28060
    12
  val dest_name: string -> string * string
haftmann@28060
    13
  val mk_name_module: Name.context -> string option -> (string -> string option)
haftmann@28060
    14
    -> 'a Graph.T -> string -> string
haftmann@28060
    15
  type var_ctxt;
haftmann@28060
    16
  val make_vars: string list -> var_ctxt;
haftmann@28060
    17
  val intro_vars: string list -> var_ctxt -> var_ctxt;
haftmann@28060
    18
  val lookup_var: var_ctxt -> string -> string;
haftmann@28060
    19
haftmann@28060
    20
  val @@ : 'a * 'a -> 'a list
haftmann@28060
    21
  val @| : 'a list * 'a -> 'a list
haftmann@28060
    22
  val str: string -> Pretty.T
haftmann@28060
    23
  val concat: Pretty.T list -> Pretty.T
haftmann@28060
    24
  val brackets: Pretty.T list -> Pretty.T
haftmann@28060
    25
  val semicolon: Pretty.T list -> Pretty.T
haftmann@28060
    26
  val enum_default: string -> string -> string -> string -> Pretty.T list -> Pretty.T
haftmann@28060
    27
haftmann@28060
    28
  type lrx
haftmann@28060
    29
  val L: lrx
haftmann@28060
    30
  val R: lrx
haftmann@28060
    31
  val X: lrx
haftmann@28060
    32
  type fixity
haftmann@28060
    33
  val BR: fixity
haftmann@28060
    34
  val NOBR: fixity
haftmann@28060
    35
  val INFX: int * lrx -> fixity
haftmann@28060
    36
  val APP: fixity
haftmann@28060
    37
  val brackify: fixity -> Pretty.T list -> Pretty.T
haftmann@28060
    38
  val brackify_infix: int * lrx -> fixity -> Pretty.T list -> Pretty.T
haftmann@28060
    39
haftmann@28060
    40
  type itype = Code_Thingol.itype
haftmann@28060
    41
  type iterm = Code_Thingol.iterm
haftmann@28060
    42
  type const = Code_Thingol.const
haftmann@28060
    43
  type dict = Code_Thingol.dict
haftmann@28060
    44
  type class_syntax
haftmann@28060
    45
  type tyco_syntax
haftmann@28060
    46
  type const_syntax
haftmann@28060
    47
  val parse_infix: ('a -> 'b) -> lrx * int -> string
haftmann@28060
    48
  -> int * ((fixity -> 'b -> Pretty.T) -> fixity -> 'a list -> Pretty.T)
haftmann@28060
    49
  val parse_syntax: ('a -> 'b) -> OuterParse.token list
haftmann@28060
    50
    -> (int * ((fixity -> 'b -> Pretty.T) -> fixity -> 'a list -> Pretty.T)) option
haftmann@28060
    51
         * OuterParse.token list
haftmann@28060
    52
  val simple_const_syntax: (int * ((fixity -> iterm -> Pretty.T) -> fixity
haftmann@28060
    53
    -> (iterm * itype) list -> Pretty.T)) option -> const_syntax option
haftmann@28060
    54
  val gen_pr_app: (thm -> bool -> var_ctxt -> const * iterm list -> Pretty.T list)
haftmann@28060
    55
    -> (thm -> bool -> var_ctxt -> fixity -> iterm -> Pretty.T)
haftmann@28060
    56
    -> (string -> const_syntax option) -> (string -> bool)
haftmann@28060
    57
    -> thm -> bool -> var_ctxt -> fixity -> const * iterm list -> Pretty.T
haftmann@28060
    58
  val gen_pr_bind: ((string option * Pretty.T option) * itype -> Pretty.T)
haftmann@28060
    59
    -> (thm -> bool -> var_ctxt -> fixity -> iterm -> Pretty.T)
haftmann@28060
    60
    -> thm -> fixity -> (string option * iterm option) * itype -> var_ctxt -> Pretty.T * var_ctxt
haftmann@28060
    61
haftmann@28064
    62
  type literals
haftmann@28064
    63
  val Literals: { literal_char: string -> string, literal_string: string -> string,
haftmann@28064
    64
        literal_numeral: bool -> int -> string, literal_list: Pretty.T list -> Pretty.T, infix_cons: int * string }
haftmann@28064
    65
    -> literals
haftmann@28064
    66
  val literal_char: literals -> string -> string
haftmann@28064
    67
  val literal_string: literals -> string -> string
haftmann@28064
    68
  val literal_numeral: literals -> bool -> int -> string
haftmann@28064
    69
  val literal_list: literals -> Pretty.T list -> Pretty.T
haftmann@28064
    70
  val infix_cons: literals -> int * string
haftmann@28064
    71
haftmann@28060
    72
  val nerror: thm -> string -> 'a
haftmann@28060
    73
end;
haftmann@28060
    74
haftmann@28060
    75
structure Code_Printer : CODE_PRINTER =
haftmann@28060
    76
struct
haftmann@28060
    77
haftmann@28060
    78
open Code_Thingol;
haftmann@28060
    79
haftmann@28060
    80
fun nerror thm s = error (s ^ ",\nin equation " ^ Display.string_of_thm thm);
haftmann@28060
    81
haftmann@28060
    82
(** names and naming **)
haftmann@28060
    83
haftmann@28060
    84
(* auxiliary *)
haftmann@28060
    85
haftmann@28060
    86
val first_upper = implode o nth_map 0 Symbol.to_ascii_upper o explode;
haftmann@28060
    87
val first_lower = implode o nth_map 0 Symbol.to_ascii_lower o explode;
haftmann@28060
    88
haftmann@28060
    89
val dest_name =
haftmann@28060
    90
  apfst NameSpace.implode o split_last o fst o split_last o NameSpace.explode;
haftmann@28060
    91
haftmann@28060
    92
fun mk_name_module reserved_names module_prefix module_alias program =
haftmann@28060
    93
  let
haftmann@28060
    94
    fun mk_alias name = case module_alias name
haftmann@28060
    95
     of SOME name' => name'
haftmann@28060
    96
      | NONE => name
haftmann@28060
    97
          |> NameSpace.explode
haftmann@28060
    98
          |> map (fn name => (the_single o fst) (Name.variants [name] reserved_names))
haftmann@28060
    99
          |> NameSpace.implode;
haftmann@28060
   100
    fun mk_prefix name = case module_prefix
haftmann@28060
   101
     of SOME module_prefix => NameSpace.append module_prefix name
haftmann@28060
   102
      | NONE => name;
haftmann@28060
   103
    val tab =
haftmann@28060
   104
      Symtab.empty
haftmann@28060
   105
      |> Graph.fold ((fn name => Symtab.default (name, (mk_alias #> mk_prefix) name))
haftmann@28060
   106
           o fst o dest_name o fst)
haftmann@28060
   107
             program
haftmann@28060
   108
  in the o Symtab.lookup tab end;
haftmann@28060
   109
haftmann@28060
   110
(* variable name contexts *)
haftmann@28060
   111
haftmann@28060
   112
type var_ctxt = string Symtab.table * Name.context;
haftmann@28060
   113
haftmann@28060
   114
fun make_vars names = (fold (fn name => Symtab.update_new (name, name)) names Symtab.empty,
haftmann@28060
   115
  Name.make_context names);
haftmann@28060
   116
haftmann@28060
   117
fun intro_vars names (namemap, namectxt) =
haftmann@28060
   118
  let
haftmann@28060
   119
    val (names', namectxt') = Name.variants names namectxt;
haftmann@28060
   120
    val namemap' = fold2 (curry Symtab.update) names names' namemap;
haftmann@28060
   121
  in (namemap', namectxt') end;
haftmann@28060
   122
haftmann@28060
   123
fun lookup_var (namemap, _) name = case Symtab.lookup namemap name
haftmann@28060
   124
 of SOME name' => name'
haftmann@28060
   125
  | NONE => error ("Invalid name in context: " ^ quote name);
haftmann@28060
   126
haftmann@28060
   127
haftmann@28060
   128
(** assembling text pieces **)
haftmann@28060
   129
haftmann@28060
   130
infixr 5 @@;
haftmann@28060
   131
infixr 5 @|;
haftmann@28060
   132
fun x @@ y = [x, y];
haftmann@28060
   133
fun xs @| y = xs @ [y];
haftmann@28060
   134
val str = PrintMode.setmp [] Pretty.str;
haftmann@28060
   135
val concat = Pretty.block o Pretty.breaks;
haftmann@28060
   136
val brackets = Pretty.enclose "(" ")" o Pretty.breaks;
haftmann@28060
   137
fun semicolon ps = Pretty.block [concat ps, str ";"];
haftmann@28060
   138
fun enum_default default sep opn cls [] = str default
haftmann@28060
   139
  | enum_default default sep opn cls xs = Pretty.enum sep opn cls xs;
haftmann@28060
   140
haftmann@28060
   141
haftmann@28060
   142
(** syntax printer **)
haftmann@28060
   143
haftmann@28060
   144
(* binding priorities *)
haftmann@28060
   145
haftmann@28060
   146
datatype lrx = L | R | X;
haftmann@28060
   147
haftmann@28060
   148
datatype fixity =
haftmann@28060
   149
    BR
haftmann@28060
   150
  | NOBR
haftmann@28060
   151
  | INFX of (int * lrx);
haftmann@28060
   152
haftmann@28060
   153
val APP = INFX (~1, L);
haftmann@28060
   154
haftmann@28060
   155
fun fixity_lrx L L = false
haftmann@28060
   156
  | fixity_lrx R R = false
haftmann@28060
   157
  | fixity_lrx _ _ = true;
haftmann@28060
   158
haftmann@28060
   159
fun fixity NOBR _ = false
haftmann@28060
   160
  | fixity _ NOBR = false
haftmann@28060
   161
  | fixity (INFX (pr, lr)) (INFX (pr_ctxt, lr_ctxt)) =
haftmann@28060
   162
      pr < pr_ctxt
haftmann@28060
   163
      orelse pr = pr_ctxt
haftmann@28060
   164
        andalso fixity_lrx lr lr_ctxt
haftmann@28060
   165
      orelse pr_ctxt = ~1
haftmann@28060
   166
  | fixity BR (INFX _) = false
haftmann@28060
   167
  | fixity _ _ = true;
haftmann@28060
   168
haftmann@28060
   169
fun gen_brackify _ [p] = p
haftmann@28060
   170
  | gen_brackify true (ps as _::_) = Pretty.enclose "(" ")" ps
haftmann@28060
   171
  | gen_brackify false (ps as _::_) = Pretty.block ps;
haftmann@28060
   172
haftmann@28060
   173
fun brackify fxy_ctxt =
haftmann@28060
   174
  gen_brackify (fixity BR fxy_ctxt) o Pretty.breaks;
haftmann@28060
   175
haftmann@28060
   176
fun brackify_infix infx fxy_ctxt =
haftmann@28060
   177
  gen_brackify (fixity (INFX infx) fxy_ctxt) o Pretty.breaks;
haftmann@28060
   178
haftmann@28060
   179
haftmann@28060
   180
(* generic syntax *)
haftmann@28060
   181
haftmann@28060
   182
type class_syntax = string * (string -> string option);
haftmann@28060
   183
type tyco_syntax = int * ((fixity -> itype -> Pretty.T)
haftmann@28060
   184
  -> fixity -> itype list -> Pretty.T);
haftmann@28060
   185
type const_syntax = int * ((var_ctxt -> fixity -> iterm -> Pretty.T)
haftmann@28060
   186
  -> thm -> bool -> var_ctxt -> fixity -> (iterm * itype) list -> Pretty.T);
haftmann@28060
   187
haftmann@28060
   188
fun simple_const_syntax x = (Option.map o apsnd)
haftmann@28060
   189
  (fn pretty => fn pr => fn thm => fn pat => fn vars => pretty (pr vars)) x;
haftmann@28060
   190
haftmann@28060
   191
(*int * ((var_ctxt -> fixity -> iterm -> Pretty.T)
haftmann@28060
   192
  -> )
haftmann@28060
   193
haftmann@28060
   194
('a * ('b -> thm -> bool -> var_ctxt -> fixity -> (iterm * itype) list -> Pretty.T)) option
haftmann@28060
   195
***           -> ('a * (('d -> 'b) -> 'e -> 'f -> 'd -> 'c)) option*)
haftmann@28060
   196
haftmann@28060
   197
fun gen_pr_app pr_app pr_term syntax_const is_cons thm pat
haftmann@28060
   198
    vars fxy (app as ((c, (_, tys)), ts)) =
haftmann@28060
   199
  case syntax_const c
haftmann@28060
   200
   of NONE => if pat andalso not (is_cons c) then
haftmann@28060
   201
        nerror thm "Non-constructor in pattern"
haftmann@28060
   202
        else brackify fxy (pr_app thm pat vars app)
haftmann@28060
   203
    | SOME (k, pr) =>
haftmann@28060
   204
        let
haftmann@28060
   205
          fun pr' fxy ts = pr (pr_term thm pat) thm pat vars fxy (ts ~~ curry Library.take k tys);
haftmann@28060
   206
        in if k = length ts
haftmann@28060
   207
          then pr' fxy ts
haftmann@28060
   208
        else if k < length ts
haftmann@28060
   209
          then case chop k ts of (ts1, ts2) =>
haftmann@28060
   210
            brackify fxy (pr' APP ts1 :: map (pr_term thm pat vars BR) ts2)
haftmann@28060
   211
          else pr_term thm pat vars fxy (Code_Thingol.eta_expand k app)
haftmann@28060
   212
        end;
haftmann@28060
   213
haftmann@28060
   214
fun gen_pr_bind pr_bind pr_term thm (fxy : fixity) ((v, pat), ty : itype) vars =
haftmann@28060
   215
  let
haftmann@28060
   216
    val vs = case pat
haftmann@28060
   217
     of SOME pat => Code_Thingol.fold_varnames (insert (op =)) pat []
haftmann@28060
   218
      | NONE => [];
haftmann@28060
   219
    val vars' = intro_vars (the_list v) vars;
haftmann@28060
   220
    val vars'' = intro_vars vs vars';
haftmann@28060
   221
    val v' = Option.map (lookup_var vars') v;
haftmann@28060
   222
    val pat' = Option.map (pr_term thm true vars'' fxy) pat;
haftmann@28060
   223
  in (pr_bind ((v', pat'), ty), vars'') end;
haftmann@28060
   224
haftmann@28060
   225
haftmann@28060
   226
(* mixfix syntax *)
haftmann@28060
   227
haftmann@28060
   228
datatype 'a mixfix =
haftmann@28060
   229
    Arg of fixity
haftmann@28060
   230
  | Pretty of Pretty.T;
haftmann@28060
   231
haftmann@28060
   232
fun mk_mixfix prep_arg (fixity_this, mfx) =
haftmann@28060
   233
  let
haftmann@28060
   234
    fun is_arg (Arg _) = true
haftmann@28060
   235
      | is_arg _ = false;
haftmann@28060
   236
    val i = (length o filter is_arg) mfx;
haftmann@28060
   237
    fun fillin _ [] [] =
haftmann@28060
   238
          []
haftmann@28060
   239
      | fillin pr (Arg fxy :: mfx) (a :: args) =
haftmann@28060
   240
          (pr fxy o prep_arg) a :: fillin pr mfx args
haftmann@28060
   241
      | fillin pr (Pretty p :: mfx) args =
haftmann@28060
   242
          p :: fillin pr mfx args;
haftmann@28060
   243
  in
haftmann@28060
   244
    (i, fn pr => fn fixity_ctxt => fn args =>
haftmann@28060
   245
      gen_brackify (fixity fixity_this fixity_ctxt) (fillin pr mfx args))
haftmann@28060
   246
  end;
haftmann@28060
   247
haftmann@28060
   248
fun parse_infix prep_arg (x, i) s =
haftmann@28060
   249
  let
haftmann@28060
   250
    val l = case x of L => INFX (i, L) | _ => INFX (i, X);
haftmann@28060
   251
    val r = case x of R => INFX (i, R) | _ => INFX (i, X);
haftmann@28060
   252
  in
haftmann@28060
   253
    mk_mixfix prep_arg (INFX (i, x),
haftmann@28060
   254
      [Arg l, (Pretty o Pretty.brk) 1, (Pretty o str) s, (Pretty o Pretty.brk) 1, Arg r])
haftmann@28060
   255
  end;
haftmann@28060
   256
haftmann@28060
   257
fun parse_mixfix prep_arg s =
haftmann@28060
   258
  let
haftmann@28060
   259
    val sym_any = Scan.one Symbol.is_regular;
haftmann@28060
   260
    val parse = Scan.optional ($$ "!" >> K true) false -- Scan.repeat (
haftmann@28060
   261
         ($$ "(" -- $$ "_" -- $$ ")" >> K (Arg NOBR))
haftmann@28060
   262
      || ($$ "_" >> K (Arg BR))
haftmann@28060
   263
      || ($$ "/" |-- Scan.repeat ($$ " ") >> (Pretty o Pretty.brk o length))
haftmann@28060
   264
      || (Scan.repeat1
haftmann@28060
   265
           (   $$ "'" |-- sym_any
haftmann@28060
   266
            || Scan.unless ($$ "_" || $$ "/" || $$ "(" |-- $$ "_" |-- $$ ")")
haftmann@28060
   267
                 sym_any) >> (Pretty o str o implode)));
haftmann@28060
   268
  in case Scan.finite Symbol.stopper parse (Symbol.explode s)
haftmann@28060
   269
   of ((_, p as [_]), []) => mk_mixfix prep_arg (NOBR, p)
haftmann@28060
   270
    | ((b, p as _ :: _ :: _), []) => mk_mixfix prep_arg (if b then NOBR else BR, p)
haftmann@28060
   271
    | _ => Scan.!!
haftmann@28060
   272
        (the_default ("malformed mixfix annotation: " ^ quote s) o snd) Scan.fail ()
haftmann@28060
   273
  end;
haftmann@28060
   274
haftmann@28060
   275
val (infixK, infixlK, infixrK) = ("infix", "infixl", "infixr");
haftmann@28060
   276
haftmann@28060
   277
fun parse_syntax prep_arg xs =
haftmann@28060
   278
  Scan.option ((
haftmann@28060
   279
      ((OuterParse.$$$ infixK  >> K X)
haftmann@28060
   280
        || (OuterParse.$$$ infixlK >> K L)
haftmann@28060
   281
        || (OuterParse.$$$ infixrK >> K R))
haftmann@28060
   282
        -- OuterParse.nat >> parse_infix prep_arg
haftmann@28060
   283
      || Scan.succeed (parse_mixfix prep_arg))
haftmann@28060
   284
      -- OuterParse.string
haftmann@28060
   285
      >> (fn (parse, s) => parse s)) xs;
haftmann@28060
   286
haftmann@28060
   287
val _ = List.app OuterKeyword.keyword [infixK, infixlK, infixrK];
haftmann@28060
   288
haftmann@28064
   289
haftmann@28064
   290
(** pretty literals **)
haftmann@28064
   291
haftmann@28064
   292
datatype literals = Literals of {
haftmann@28064
   293
  literal_char: string -> string,
haftmann@28064
   294
  literal_string: string -> string,
haftmann@28064
   295
  literal_numeral: bool -> int -> string,
haftmann@28064
   296
  literal_list: Pretty.T list -> Pretty.T,
haftmann@28064
   297
  infix_cons: int * string
haftmann@28064
   298
};
haftmann@28064
   299
haftmann@28064
   300
fun dest_Literals (Literals lits) = lits;
haftmann@28064
   301
haftmann@28064
   302
val literal_char = #literal_char o dest_Literals;
haftmann@28064
   303
val literal_string = #literal_string o dest_Literals;
haftmann@28064
   304
val literal_numeral = #literal_numeral o dest_Literals;
haftmann@28064
   305
val literal_list = #literal_list o dest_Literals;
haftmann@28064
   306
val infix_cons = #infix_cons o dest_Literals;
haftmann@28064
   307
haftmann@28060
   308
end; (*struct*)