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