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