src/Tools/Code/code_printer.ML
author haftmann
Fri Dec 04 18:51:15 2009 +0100 (2009-12-04)
changeset 33994 fc8af744f63c
parent 33957 e9afca2118d4
parent 33989 cb136b5f6050
child 34071 93bfbb557e2e
permissions -rw-r--r--
merged, resolving minor conflicts
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@32908
     9
  type itype = Code_Thingol.itype
haftmann@32908
    10
  type iterm = Code_Thingol.iterm
haftmann@32908
    11
  type const = Code_Thingol.const
haftmann@32908
    12
  type dict = Code_Thingol.dict
haftmann@32908
    13
haftmann@33989
    14
  val eqn_error: thm -> string -> 'a
haftmann@28060
    15
haftmann@28060
    16
  val @@ : 'a * 'a -> 'a list
haftmann@28060
    17
  val @| : 'a list * 'a -> 'a list
haftmann@28060
    18
  val str: string -> Pretty.T
haftmann@28060
    19
  val concat: Pretty.T list -> Pretty.T
haftmann@28060
    20
  val brackets: Pretty.T list -> Pretty.T
haftmann@28060
    21
  val semicolon: Pretty.T list -> Pretty.T
haftmann@33989
    22
  val doublesemicolon: Pretty.T list -> Pretty.T
haftmann@28060
    23
  val enum_default: string -> string -> string -> string -> Pretty.T list -> Pretty.T
haftmann@28060
    24
haftmann@30648
    25
  val first_upper: string -> string
haftmann@30648
    26
  val first_lower: string -> string
haftmann@30648
    27
  type var_ctxt
haftmann@30648
    28
  val make_vars: string list -> var_ctxt
haftmann@30648
    29
  val intro_vars: string list -> var_ctxt -> var_ctxt
haftmann@30648
    30
  val lookup_var: var_ctxt -> string -> string
haftmann@32913
    31
  val intro_base_names: (string -> bool) -> (string -> string)
haftmann@32913
    32
    -> string list -> var_ctxt -> var_ctxt
haftmann@32908
    33
  val aux_params: var_ctxt -> iterm list list -> string list
haftmann@30648
    34
haftmann@31056
    35
  type literals
haftmann@31056
    36
  val Literals: { literal_char: string -> string, literal_string: string -> string,
haftmann@31056
    37
        literal_numeral: bool -> int -> string,
haftmann@31056
    38
        literal_list: Pretty.T list -> Pretty.T, infix_cons: int * string }
haftmann@31056
    39
    -> literals
haftmann@31056
    40
  val literal_char: literals -> string -> string
haftmann@31056
    41
  val literal_string: literals -> string -> string
haftmann@31056
    42
  val literal_numeral: literals -> bool -> int -> string
haftmann@31056
    43
  val literal_list: literals -> Pretty.T list -> Pretty.T
haftmann@31056
    44
  val infix_cons: literals -> int * string
haftmann@31056
    45
haftmann@28060
    46
  type lrx
haftmann@28060
    47
  val L: lrx
haftmann@28060
    48
  val R: lrx
haftmann@28060
    49
  val X: lrx
haftmann@28060
    50
  type fixity
haftmann@28060
    51
  val BR: fixity
haftmann@28060
    52
  val NOBR: fixity
haftmann@28060
    53
  val INFX: int * lrx -> fixity
haftmann@28060
    54
  val APP: fixity
haftmann@28060
    55
  val brackify: fixity -> Pretty.T list -> Pretty.T
haftmann@28060
    56
  val brackify_infix: int * lrx -> fixity -> Pretty.T list -> Pretty.T
haftmann@31665
    57
  val brackify_block: fixity -> Pretty.T -> Pretty.T list -> Pretty.T -> Pretty.T
haftmann@28060
    58
haftmann@28060
    59
  type tyco_syntax
haftmann@28060
    60
  type const_syntax
haftmann@31056
    61
  type proto_const_syntax
haftmann@28060
    62
  val parse_infix: ('a -> 'b) -> lrx * int -> string
haftmann@28663
    63
    -> int * ((fixity -> 'b -> Pretty.T)
haftmann@28663
    64
    -> fixity -> 'a list -> Pretty.T)
haftmann@28060
    65
  val parse_syntax: ('a -> 'b) -> OuterParse.token list
haftmann@28663
    66
    -> (int * ((fixity -> 'b -> Pretty.T)
haftmann@28663
    67
    -> fixity -> 'a list -> Pretty.T)) option * OuterParse.token list
haftmann@28663
    68
  val simple_const_syntax: (int * ((fixity -> iterm -> Pretty.T)
haftmann@31056
    69
    -> fixity -> (iterm * itype) list -> Pretty.T)) option -> proto_const_syntax option
haftmann@31056
    70
  val activate_const_syntax: theory -> literals
haftmann@31056
    71
    -> proto_const_syntax -> Code_Thingol.naming -> const_syntax * Code_Thingol.naming
haftmann@33989
    72
  val gen_print_app: (thm -> var_ctxt -> const * iterm list -> Pretty.T list)
haftmann@30648
    73
    -> (thm -> var_ctxt -> fixity -> iterm -> Pretty.T)
haftmann@31056
    74
    -> (string -> const_syntax option)
haftmann@30648
    75
    -> thm -> var_ctxt -> fixity -> const * iterm list -> Pretty.T
haftmann@33989
    76
  val gen_print_bind: (thm -> var_ctxt -> fixity -> iterm -> Pretty.T)
haftmann@28663
    77
    -> thm -> fixity
haftmann@31889
    78
    -> iterm -> var_ctxt -> Pretty.T * var_ctxt
haftmann@28060
    79
haftmann@30648
    80
  val mk_name_module: Name.context -> string option -> (string -> string option)
haftmann@30648
    81
    -> 'a Graph.T -> string -> string
haftmann@30648
    82
  val dest_name: string -> string * string
haftmann@28060
    83
end;
haftmann@28060
    84
haftmann@28060
    85
structure Code_Printer : CODE_PRINTER =
haftmann@28060
    86
struct
haftmann@28060
    87
haftmann@28060
    88
open Code_Thingol;
haftmann@28060
    89
haftmann@33989
    90
fun eqn_error thm s = error (s ^ ",\nin equation " ^ Display.string_of_thm_without_context thm);
haftmann@28060
    91
haftmann@28060
    92
(** assembling text pieces **)
haftmann@28060
    93
haftmann@28060
    94
infixr 5 @@;
haftmann@28060
    95
infixr 5 @|;
haftmann@28060
    96
fun x @@ y = [x, y];
haftmann@28060
    97
fun xs @| y = xs @ [y];
haftmann@28060
    98
val str = PrintMode.setmp [] Pretty.str;
haftmann@28060
    99
val concat = Pretty.block o Pretty.breaks;
haftmann@28060
   100
val brackets = Pretty.enclose "(" ")" o Pretty.breaks;
haftmann@28060
   101
fun semicolon ps = Pretty.block [concat ps, str ";"];
haftmann@33989
   102
fun doublesemicolon ps = Pretty.block [concat ps, str ";;"];
haftmann@28060
   103
fun enum_default default sep opn cls [] = str default
haftmann@28060
   104
  | enum_default default sep opn cls xs = Pretty.enum sep opn cls xs;
haftmann@28060
   105
haftmann@28060
   106
haftmann@30648
   107
(** names and variable name contexts **)
haftmann@30648
   108
haftmann@30648
   109
type var_ctxt = string Symtab.table * Name.context;
haftmann@30648
   110
haftmann@30648
   111
fun make_vars names = (fold (fn name => Symtab.update_new (name, name)) names Symtab.empty,
haftmann@30648
   112
  Name.make_context names);
haftmann@30648
   113
haftmann@30648
   114
fun intro_vars names (namemap, namectxt) =
haftmann@30648
   115
  let
haftmann@30648
   116
    val (names', namectxt') = Name.variants names namectxt;
haftmann@30648
   117
    val namemap' = fold2 (curry Symtab.update) names names' namemap;
haftmann@30648
   118
  in (namemap', namectxt') end;
haftmann@30648
   119
haftmann@30648
   120
fun lookup_var (namemap, _) name = case Symtab.lookup namemap name
haftmann@30648
   121
 of SOME name' => name'
haftmann@30648
   122
  | NONE => error ("Invalid name in context: " ^ quote name);
haftmann@30648
   123
haftmann@30648
   124
val first_upper = implode o nth_map 0 Symbol.to_ascii_upper o explode;
haftmann@30648
   125
val first_lower = implode o nth_map 0 Symbol.to_ascii_lower o explode;
haftmann@30648
   126
haftmann@32908
   127
fun aux_params vars lhss =
haftmann@32908
   128
  let
haftmann@32908
   129
    fun fish_param _ (w as SOME _) = w
haftmann@32908
   130
      | fish_param (IVar (SOME v)) NONE = SOME v
haftmann@32908
   131
      | fish_param _ NONE = NONE;
haftmann@32908
   132
    fun fillup_param _ (_, SOME v) = v
haftmann@32908
   133
      | fillup_param x (i, NONE) = x ^ string_of_int i;
haftmann@32908
   134
    val fished1 = fold (map2 fish_param) lhss (replicate (length (hd lhss)) NONE);
haftmann@32908
   135
    val x = Name.variant (map_filter I fished1) "x";
haftmann@32908
   136
    val fished2 = map_index (fillup_param x) fished1;
haftmann@32908
   137
    val (fished3, _) = Name.variants fished2 Name.context;
haftmann@32908
   138
    val vars' = intro_vars fished3 vars;
haftmann@32908
   139
  in map (lookup_var vars') fished3 end;
haftmann@32908
   140
haftmann@32913
   141
fun intro_base_names no_syntax deresolve names = names 
haftmann@32913
   142
  |> map_filter (fn name => if no_syntax name then
haftmann@32913
   143
      let val name' = deresolve name in
haftmann@32913
   144
        if Long_Name.is_qualified name' then NONE else SOME name'
haftmann@32913
   145
      end else NONE)
haftmann@32913
   146
  |> intro_vars;
haftmann@32913
   147
haftmann@30648
   148
haftmann@31056
   149
(** pretty literals **)
haftmann@31056
   150
haftmann@31056
   151
datatype literals = Literals of {
haftmann@31056
   152
  literal_char: string -> string,
haftmann@31056
   153
  literal_string: string -> string,
haftmann@31056
   154
  literal_numeral: bool -> int -> string,
haftmann@31056
   155
  literal_list: Pretty.T list -> Pretty.T,
haftmann@31056
   156
  infix_cons: int * string
haftmann@31056
   157
};
haftmann@31056
   158
haftmann@31056
   159
fun dest_Literals (Literals lits) = lits;
haftmann@31056
   160
haftmann@31056
   161
val literal_char = #literal_char o dest_Literals;
haftmann@31056
   162
val literal_string = #literal_string o dest_Literals;
haftmann@31056
   163
val literal_numeral = #literal_numeral o dest_Literals;
haftmann@31056
   164
val literal_list = #literal_list o dest_Literals;
haftmann@31056
   165
val infix_cons = #infix_cons o dest_Literals;
haftmann@31056
   166
haftmann@31056
   167
haftmann@28060
   168
(** syntax printer **)
haftmann@28060
   169
haftmann@28060
   170
(* binding priorities *)
haftmann@28060
   171
haftmann@28060
   172
datatype lrx = L | R | X;
haftmann@28060
   173
haftmann@28060
   174
datatype fixity =
haftmann@28060
   175
    BR
haftmann@28060
   176
  | NOBR
haftmann@28060
   177
  | INFX of (int * lrx);
haftmann@28060
   178
haftmann@28060
   179
val APP = INFX (~1, L);
haftmann@28060
   180
haftmann@28060
   181
fun fixity_lrx L L = false
haftmann@28060
   182
  | fixity_lrx R R = false
haftmann@28060
   183
  | fixity_lrx _ _ = true;
haftmann@28060
   184
haftmann@28060
   185
fun fixity NOBR _ = false
haftmann@28060
   186
  | fixity _ NOBR = false
haftmann@33989
   187
  | fixity (INFX (pr, lr)) (INFX (print_ctxt, lr_ctxt)) =
haftmann@33989
   188
      pr < print_ctxt
haftmann@33989
   189
      orelse pr = print_ctxt
haftmann@28060
   190
        andalso fixity_lrx lr lr_ctxt
haftmann@33989
   191
      orelse print_ctxt = ~1
haftmann@28060
   192
  | fixity BR (INFX _) = false
haftmann@28060
   193
  | fixity _ _ = true;
haftmann@28060
   194
haftmann@28060
   195
fun gen_brackify _ [p] = p
haftmann@28060
   196
  | gen_brackify true (ps as _::_) = Pretty.enclose "(" ")" ps
haftmann@28060
   197
  | gen_brackify false (ps as _::_) = Pretty.block ps;
haftmann@28060
   198
haftmann@28060
   199
fun brackify fxy_ctxt =
haftmann@28060
   200
  gen_brackify (fixity BR fxy_ctxt) o Pretty.breaks;
haftmann@28060
   201
haftmann@28060
   202
fun brackify_infix infx fxy_ctxt =
haftmann@28060
   203
  gen_brackify (fixity (INFX infx) fxy_ctxt) o Pretty.breaks;
haftmann@28060
   204
haftmann@31665
   205
fun brackify_block fxy_ctxt p1 ps p2 =
haftmann@31665
   206
  let val p = Pretty.block_enclose (p1, p2) ps
haftmann@31665
   207
  in if fixity BR fxy_ctxt
haftmann@31665
   208
    then Pretty.enclose "(" ")" [p]
haftmann@31665
   209
    else p
haftmann@31665
   210
  end;
haftmann@31665
   211
haftmann@28060
   212
haftmann@28060
   213
(* generic syntax *)
haftmann@28060
   214
haftmann@28060
   215
type tyco_syntax = int * ((fixity -> itype -> Pretty.T)
haftmann@28060
   216
  -> fixity -> itype list -> Pretty.T);
haftmann@30648
   217
type const_syntax = int * ((var_ctxt -> fixity -> iterm -> Pretty.T)
haftmann@31056
   218
  -> thm -> var_ctxt -> fixity -> (iterm * itype) list -> Pretty.T);
haftmann@31056
   219
type proto_const_syntax = int * (string list * (literals -> string list
haftmann@31056
   220
  -> (var_ctxt -> fixity -> iterm -> Pretty.T)
haftmann@31056
   221
    -> thm -> var_ctxt -> fixity -> (iterm * itype) list -> Pretty.T));
haftmann@28060
   222
haftmann@31056
   223
fun simple_const_syntax (SOME (n, f)) = SOME (n,
haftmann@33989
   224
      ([], (fn _ => fn _ => fn print => fn thm => fn vars => f (print vars))))
haftmann@31056
   225
  | simple_const_syntax NONE = NONE;
haftmann@28060
   226
haftmann@31056
   227
fun activate_const_syntax thy literals (n, (cs, f)) naming =
haftmann@31056
   228
  fold_map (Code_Thingol.ensure_declared_const thy) cs naming
haftmann@31056
   229
  |-> (fn cs' => pair (n, f literals cs'));
haftmann@31056
   230
haftmann@33989
   231
fun gen_print_app print_app_expr print_term syntax_const thm vars fxy (app as ((c, (_, tys)), ts)) =
haftmann@28060
   232
  case syntax_const c
haftmann@33989
   233
   of NONE => brackify fxy (print_app_expr thm vars app)
haftmann@33989
   234
    | SOME (k, print) =>
haftmann@28060
   235
        let
haftmann@33994
   236
          fun print' fxy ts = print (print_term thm) thm vars fxy (ts ~~ take k tys);
haftmann@28060
   237
        in if k = length ts
haftmann@33989
   238
          then print' fxy ts
haftmann@28060
   239
        else if k < length ts
haftmann@28060
   240
          then case chop k ts of (ts1, ts2) =>
haftmann@33989
   241
            brackify fxy (print' APP ts1 :: map (print_term thm vars BR) ts2)
haftmann@33989
   242
          else print_term thm vars fxy (Code_Thingol.eta_expand k app)
haftmann@28060
   243
        end;
haftmann@28060
   244
haftmann@33989
   245
fun gen_print_bind print_term thm (fxy : fixity) pat vars =
haftmann@28060
   246
  let
haftmann@31889
   247
    val vs = Code_Thingol.fold_varnames (insert (op =)) pat [];
haftmann@31874
   248
    val vars' = intro_vars vs vars;
haftmann@33989
   249
  in (print_term thm vars' fxy pat, vars') end;
haftmann@28060
   250
haftmann@28060
   251
haftmann@28060
   252
(* mixfix syntax *)
haftmann@28060
   253
haftmann@28060
   254
datatype 'a mixfix =
haftmann@28060
   255
    Arg of fixity
haftmann@28060
   256
  | Pretty of Pretty.T;
haftmann@28060
   257
haftmann@28060
   258
fun mk_mixfix prep_arg (fixity_this, mfx) =
haftmann@28060
   259
  let
haftmann@28060
   260
    fun is_arg (Arg _) = true
haftmann@28060
   261
      | is_arg _ = false;
haftmann@28060
   262
    val i = (length o filter is_arg) mfx;
haftmann@28060
   263
    fun fillin _ [] [] =
haftmann@28060
   264
          []
haftmann@33989
   265
      | fillin print (Arg fxy :: mfx) (a :: args) =
haftmann@33989
   266
          (print fxy o prep_arg) a :: fillin print mfx args
haftmann@33989
   267
      | fillin print (Pretty p :: mfx) args =
haftmann@33989
   268
          p :: fillin print mfx args;
haftmann@28060
   269
  in
haftmann@33989
   270
    (i, fn print => fn fixity_ctxt => fn args =>
haftmann@33989
   271
      gen_brackify (fixity fixity_this fixity_ctxt) (fillin print mfx args))
haftmann@28060
   272
  end;
haftmann@28060
   273
haftmann@28060
   274
fun parse_infix prep_arg (x, i) s =
haftmann@28060
   275
  let
haftmann@28060
   276
    val l = case x of L => INFX (i, L) | _ => INFX (i, X);
haftmann@28060
   277
    val r = case x of R => INFX (i, R) | _ => INFX (i, X);
haftmann@28060
   278
  in
haftmann@28060
   279
    mk_mixfix prep_arg (INFX (i, x),
haftmann@28060
   280
      [Arg l, (Pretty o Pretty.brk) 1, (Pretty o str) s, (Pretty o Pretty.brk) 1, Arg r])
haftmann@28060
   281
  end;
haftmann@28060
   282
haftmann@28060
   283
fun parse_mixfix prep_arg s =
haftmann@28060
   284
  let
haftmann@28060
   285
    val sym_any = Scan.one Symbol.is_regular;
haftmann@28060
   286
    val parse = Scan.optional ($$ "!" >> K true) false -- Scan.repeat (
haftmann@28060
   287
         ($$ "(" -- $$ "_" -- $$ ")" >> K (Arg NOBR))
haftmann@28060
   288
      || ($$ "_" >> K (Arg BR))
haftmann@28060
   289
      || ($$ "/" |-- Scan.repeat ($$ " ") >> (Pretty o Pretty.brk o length))
haftmann@28060
   290
      || (Scan.repeat1
haftmann@28060
   291
           (   $$ "'" |-- sym_any
haftmann@28060
   292
            || Scan.unless ($$ "_" || $$ "/" || $$ "(" |-- $$ "_" |-- $$ ")")
haftmann@28060
   293
                 sym_any) >> (Pretty o str o implode)));
haftmann@28060
   294
  in case Scan.finite Symbol.stopper parse (Symbol.explode s)
haftmann@28060
   295
   of ((_, p as [_]), []) => mk_mixfix prep_arg (NOBR, p)
haftmann@28060
   296
    | ((b, p as _ :: _ :: _), []) => mk_mixfix prep_arg (if b then NOBR else BR, p)
haftmann@28060
   297
    | _ => Scan.!!
haftmann@28060
   298
        (the_default ("malformed mixfix annotation: " ^ quote s) o snd) Scan.fail ()
haftmann@28060
   299
  end;
haftmann@28060
   300
haftmann@28060
   301
val (infixK, infixlK, infixrK) = ("infix", "infixl", "infixr");
haftmann@28060
   302
haftmann@28060
   303
fun parse_syntax prep_arg xs =
haftmann@28060
   304
  Scan.option ((
haftmann@28060
   305
      ((OuterParse.$$$ infixK  >> K X)
haftmann@28060
   306
        || (OuterParse.$$$ infixlK >> K L)
haftmann@28060
   307
        || (OuterParse.$$$ infixrK >> K R))
haftmann@28060
   308
        -- OuterParse.nat >> parse_infix prep_arg
haftmann@28060
   309
      || Scan.succeed (parse_mixfix prep_arg))
haftmann@28060
   310
      -- OuterParse.string
haftmann@28060
   311
      >> (fn (parse, s) => parse s)) xs;
haftmann@28060
   312
haftmann@28060
   313
val _ = List.app OuterKeyword.keyword [infixK, infixlK, infixrK];
haftmann@28060
   314
haftmann@28064
   315
haftmann@30648
   316
(** module name spaces **)
haftmann@30648
   317
haftmann@30648
   318
val dest_name =
haftmann@30648
   319
  apfst Long_Name.implode o split_last o fst o split_last o Long_Name.explode;
haftmann@30648
   320
haftmann@32924
   321
fun mk_name_module reserved module_prefix module_alias program =
haftmann@30648
   322
  let
haftmann@30648
   323
    fun mk_alias name = case module_alias name
haftmann@30648
   324
     of SOME name' => name'
haftmann@30648
   325
      | NONE => name
haftmann@30648
   326
          |> Long_Name.explode
haftmann@32924
   327
          |> map (fn name => (the_single o fst) (Name.variants [name] reserved))
haftmann@30648
   328
          |> Long_Name.implode;
haftmann@30648
   329
    fun mk_prefix name = case module_prefix
haftmann@30648
   330
     of SOME module_prefix => Long_Name.append module_prefix name
haftmann@30648
   331
      | NONE => name;
haftmann@30648
   332
    val tab =
haftmann@30648
   333
      Symtab.empty
haftmann@30648
   334
      |> Graph.fold ((fn name => Symtab.default (name, (mk_alias #> mk_prefix) name))
haftmann@30648
   335
           o fst o dest_name o fst)
haftmann@30648
   336
             program
haftmann@30648
   337
  in the o Symtab.lookup tab end;
haftmann@30648
   338
haftmann@28060
   339
end; (*struct*)