src/Tools/code/code_printer.ML
author haftmann
Tue Jun 16 14:56:59 2009 +0200 (2009-06-16)
changeset 31665 a1f4d3b3f6c8
parent 31056 01ac77eb660b
permissions -rw-r--r--
tuned brackets for let expressions etc.
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@31056
    26
  type literals
haftmann@31056
    27
  val Literals: { literal_char: string -> string, literal_string: string -> string,
haftmann@31056
    28
        literal_numeral: bool -> int -> string,
haftmann@31056
    29
        literal_list: Pretty.T list -> Pretty.T, infix_cons: int * string }
haftmann@31056
    30
    -> literals
haftmann@31056
    31
  val literal_char: literals -> string -> string
haftmann@31056
    32
  val literal_string: literals -> string -> string
haftmann@31056
    33
  val literal_numeral: literals -> bool -> int -> string
haftmann@31056
    34
  val literal_list: literals -> Pretty.T list -> Pretty.T
haftmann@31056
    35
  val infix_cons: literals -> int * string
haftmann@31056
    36
haftmann@28060
    37
  type lrx
haftmann@28060
    38
  val L: lrx
haftmann@28060
    39
  val R: lrx
haftmann@28060
    40
  val X: lrx
haftmann@28060
    41
  type fixity
haftmann@28060
    42
  val BR: fixity
haftmann@28060
    43
  val NOBR: fixity
haftmann@28060
    44
  val INFX: int * lrx -> fixity
haftmann@28060
    45
  val APP: fixity
haftmann@28060
    46
  val brackify: fixity -> Pretty.T list -> Pretty.T
haftmann@28060
    47
  val brackify_infix: int * lrx -> fixity -> Pretty.T list -> Pretty.T
haftmann@31665
    48
  val brackify_block: fixity -> Pretty.T -> Pretty.T list -> Pretty.T -> Pretty.T
haftmann@28060
    49
haftmann@28060
    50
  type itype = Code_Thingol.itype
haftmann@28060
    51
  type iterm = Code_Thingol.iterm
haftmann@28060
    52
  type const = Code_Thingol.const
haftmann@28060
    53
  type dict = Code_Thingol.dict
haftmann@28060
    54
  type tyco_syntax
haftmann@28060
    55
  type const_syntax
haftmann@31056
    56
  type proto_const_syntax
haftmann@28060
    57
  val parse_infix: ('a -> 'b) -> lrx * int -> string
haftmann@28663
    58
    -> int * ((fixity -> 'b -> Pretty.T)
haftmann@28663
    59
    -> fixity -> 'a list -> Pretty.T)
haftmann@28060
    60
  val parse_syntax: ('a -> 'b) -> OuterParse.token list
haftmann@28663
    61
    -> (int * ((fixity -> 'b -> Pretty.T)
haftmann@28663
    62
    -> fixity -> 'a list -> Pretty.T)) option * OuterParse.token list
haftmann@28663
    63
  val simple_const_syntax: (int * ((fixity -> iterm -> Pretty.T)
haftmann@31056
    64
    -> fixity -> (iterm * itype) list -> Pretty.T)) option -> proto_const_syntax option
haftmann@31056
    65
  val activate_const_syntax: theory -> literals
haftmann@31056
    66
    -> proto_const_syntax -> Code_Thingol.naming -> const_syntax * Code_Thingol.naming
haftmann@30648
    67
  val gen_pr_app: (thm -> var_ctxt -> const * iterm list -> Pretty.T list)
haftmann@30648
    68
    -> (thm -> var_ctxt -> fixity -> iterm -> Pretty.T)
haftmann@31056
    69
    -> (string -> const_syntax option)
haftmann@30648
    70
    -> thm -> var_ctxt -> fixity -> const * iterm list -> Pretty.T
haftmann@28060
    71
  val gen_pr_bind: ((string option * Pretty.T option) * itype -> Pretty.T)
haftmann@30648
    72
    -> (thm -> var_ctxt -> fixity -> iterm -> Pretty.T)
haftmann@28663
    73
    -> thm -> fixity
haftmann@30648
    74
    -> (string option * iterm option) * itype -> var_ctxt -> Pretty.T * var_ctxt
haftmann@28060
    75
haftmann@30648
    76
  val mk_name_module: Name.context -> string option -> (string -> string option)
haftmann@30648
    77
    -> 'a Graph.T -> string -> string
haftmann@30648
    78
  val dest_name: string -> string * string
haftmann@28060
    79
end;
haftmann@28060
    80
haftmann@28060
    81
structure Code_Printer : CODE_PRINTER =
haftmann@28060
    82
struct
haftmann@28060
    83
haftmann@28060
    84
open Code_Thingol;
haftmann@28060
    85
haftmann@28060
    86
fun nerror thm s = error (s ^ ",\nin equation " ^ Display.string_of_thm thm);
haftmann@28060
    87
haftmann@28060
    88
(** assembling text pieces **)
haftmann@28060
    89
haftmann@28060
    90
infixr 5 @@;
haftmann@28060
    91
infixr 5 @|;
haftmann@28060
    92
fun x @@ y = [x, y];
haftmann@28060
    93
fun xs @| y = xs @ [y];
haftmann@28060
    94
val str = PrintMode.setmp [] Pretty.str;
haftmann@28060
    95
val concat = Pretty.block o Pretty.breaks;
haftmann@28060
    96
val brackets = Pretty.enclose "(" ")" o Pretty.breaks;
haftmann@28060
    97
fun semicolon ps = Pretty.block [concat ps, str ";"];
haftmann@28060
    98
fun enum_default default sep opn cls [] = str default
haftmann@28060
    99
  | enum_default default sep opn cls xs = Pretty.enum sep opn cls xs;
haftmann@28060
   100
haftmann@28060
   101
haftmann@30648
   102
(** names and variable name contexts **)
haftmann@30648
   103
haftmann@30648
   104
type var_ctxt = string Symtab.table * Name.context;
haftmann@30648
   105
haftmann@30648
   106
fun make_vars names = (fold (fn name => Symtab.update_new (name, name)) names Symtab.empty,
haftmann@30648
   107
  Name.make_context names);
haftmann@30648
   108
haftmann@30648
   109
fun intro_vars names (namemap, namectxt) =
haftmann@30648
   110
  let
haftmann@30648
   111
    val (names', namectxt') = Name.variants names namectxt;
haftmann@30648
   112
    val namemap' = fold2 (curry Symtab.update) names names' namemap;
haftmann@30648
   113
  in (namemap', namectxt') end;
haftmann@30648
   114
haftmann@30648
   115
fun lookup_var (namemap, _) name = case Symtab.lookup namemap name
haftmann@30648
   116
 of SOME name' => name'
haftmann@30648
   117
  | NONE => error ("Invalid name in context: " ^ quote name);
haftmann@30648
   118
haftmann@30648
   119
val first_upper = implode o nth_map 0 Symbol.to_ascii_upper o explode;
haftmann@30648
   120
val first_lower = implode o nth_map 0 Symbol.to_ascii_lower o explode;
haftmann@30648
   121
haftmann@30648
   122
haftmann@31056
   123
(** pretty literals **)
haftmann@31056
   124
haftmann@31056
   125
datatype literals = Literals of {
haftmann@31056
   126
  literal_char: string -> string,
haftmann@31056
   127
  literal_string: string -> string,
haftmann@31056
   128
  literal_numeral: bool -> int -> string,
haftmann@31056
   129
  literal_list: Pretty.T list -> Pretty.T,
haftmann@31056
   130
  infix_cons: int * string
haftmann@31056
   131
};
haftmann@31056
   132
haftmann@31056
   133
fun dest_Literals (Literals lits) = lits;
haftmann@31056
   134
haftmann@31056
   135
val literal_char = #literal_char o dest_Literals;
haftmann@31056
   136
val literal_string = #literal_string o dest_Literals;
haftmann@31056
   137
val literal_numeral = #literal_numeral o dest_Literals;
haftmann@31056
   138
val literal_list = #literal_list o dest_Literals;
haftmann@31056
   139
val infix_cons = #infix_cons o dest_Literals;
haftmann@31056
   140
haftmann@31056
   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@31665
   179
fun brackify_block fxy_ctxt p1 ps p2 =
haftmann@31665
   180
  let val p = Pretty.block_enclose (p1, p2) ps
haftmann@31665
   181
  in if fixity BR fxy_ctxt
haftmann@31665
   182
    then Pretty.enclose "(" ")" [p]
haftmann@31665
   183
    else p
haftmann@31665
   184
  end;
haftmann@31665
   185
haftmann@28060
   186
haftmann@28060
   187
(* generic syntax *)
haftmann@28060
   188
haftmann@28060
   189
type tyco_syntax = int * ((fixity -> itype -> Pretty.T)
haftmann@28060
   190
  -> fixity -> itype list -> Pretty.T);
haftmann@30648
   191
type const_syntax = int * ((var_ctxt -> fixity -> iterm -> Pretty.T)
haftmann@31056
   192
  -> thm -> var_ctxt -> fixity -> (iterm * itype) list -> Pretty.T);
haftmann@31056
   193
type proto_const_syntax = int * (string list * (literals -> string list
haftmann@31056
   194
  -> (var_ctxt -> fixity -> iterm -> Pretty.T)
haftmann@31056
   195
    -> thm -> var_ctxt -> fixity -> (iterm * itype) list -> Pretty.T));
haftmann@28060
   196
haftmann@31056
   197
fun simple_const_syntax (SOME (n, f)) = SOME (n,
haftmann@31056
   198
      ([], (fn _ => fn _ => fn pr => fn thm => fn vars => f (pr vars))))
haftmann@31056
   199
  | simple_const_syntax NONE = NONE;
haftmann@28060
   200
haftmann@31056
   201
fun activate_const_syntax thy literals (n, (cs, f)) naming =
haftmann@31056
   202
  fold_map (Code_Thingol.ensure_declared_const thy) cs naming
haftmann@31056
   203
  |-> (fn cs' => pair (n, f literals cs'));
haftmann@31056
   204
haftmann@31056
   205
fun gen_pr_app pr_app pr_term syntax_const thm vars fxy (app as ((c, (_, tys)), ts)) =
haftmann@28060
   206
  case syntax_const c
haftmann@28708
   207
   of NONE => brackify fxy (pr_app thm vars app)
haftmann@28060
   208
    | SOME (k, pr) =>
haftmann@28060
   209
        let
haftmann@31056
   210
          fun pr' fxy ts = pr (pr_term thm) thm vars fxy (ts ~~ curry Library.take k tys);
haftmann@28060
   211
        in if k = length ts
haftmann@28060
   212
          then pr' fxy ts
haftmann@28060
   213
        else if k < length ts
haftmann@28060
   214
          then case chop k ts of (ts1, ts2) =>
haftmann@28708
   215
            brackify fxy (pr' APP ts1 :: map (pr_term thm vars BR) ts2)
haftmann@28708
   216
          else pr_term thm vars fxy (Code_Thingol.eta_expand k app)
haftmann@28060
   217
        end;
haftmann@28060
   218
haftmann@28060
   219
fun gen_pr_bind pr_bind pr_term thm (fxy : fixity) ((v, pat), ty : itype) vars =
haftmann@28060
   220
  let
haftmann@28060
   221
    val vs = case pat
haftmann@28060
   222
     of SOME pat => Code_Thingol.fold_varnames (insert (op =)) pat []
haftmann@28060
   223
      | NONE => [];
haftmann@30648
   224
    val vars' = intro_vars (the_list v) vars;
haftmann@30648
   225
    val vars'' = intro_vars vs vars';
haftmann@30648
   226
    val v' = Option.map (lookup_var vars') v;
haftmann@28708
   227
    val pat' = Option.map (pr_term thm vars'' fxy) pat;
haftmann@28060
   228
  in (pr_bind ((v', pat'), ty), vars'') end;
haftmann@28060
   229
haftmann@28060
   230
haftmann@28060
   231
(* mixfix syntax *)
haftmann@28060
   232
haftmann@28060
   233
datatype 'a mixfix =
haftmann@28060
   234
    Arg of fixity
haftmann@28060
   235
  | Pretty of Pretty.T;
haftmann@28060
   236
haftmann@28060
   237
fun mk_mixfix prep_arg (fixity_this, mfx) =
haftmann@28060
   238
  let
haftmann@28060
   239
    fun is_arg (Arg _) = true
haftmann@28060
   240
      | is_arg _ = false;
haftmann@28060
   241
    val i = (length o filter is_arg) mfx;
haftmann@28060
   242
    fun fillin _ [] [] =
haftmann@28060
   243
          []
haftmann@28060
   244
      | fillin pr (Arg fxy :: mfx) (a :: args) =
haftmann@28060
   245
          (pr fxy o prep_arg) a :: fillin pr mfx args
haftmann@28060
   246
      | fillin pr (Pretty p :: mfx) args =
haftmann@28060
   247
          p :: fillin pr mfx args;
haftmann@28060
   248
  in
haftmann@28060
   249
    (i, fn pr => fn fixity_ctxt => fn args =>
haftmann@28060
   250
      gen_brackify (fixity fixity_this fixity_ctxt) (fillin pr mfx args))
haftmann@28060
   251
  end;
haftmann@28060
   252
haftmann@28060
   253
fun parse_infix prep_arg (x, i) s =
haftmann@28060
   254
  let
haftmann@28060
   255
    val l = case x of L => INFX (i, L) | _ => INFX (i, X);
haftmann@28060
   256
    val r = case x of R => INFX (i, R) | _ => INFX (i, X);
haftmann@28060
   257
  in
haftmann@28060
   258
    mk_mixfix prep_arg (INFX (i, x),
haftmann@28060
   259
      [Arg l, (Pretty o Pretty.brk) 1, (Pretty o str) s, (Pretty o Pretty.brk) 1, Arg r])
haftmann@28060
   260
  end;
haftmann@28060
   261
haftmann@28060
   262
fun parse_mixfix prep_arg s =
haftmann@28060
   263
  let
haftmann@28060
   264
    val sym_any = Scan.one Symbol.is_regular;
haftmann@28060
   265
    val parse = Scan.optional ($$ "!" >> K true) false -- Scan.repeat (
haftmann@28060
   266
         ($$ "(" -- $$ "_" -- $$ ")" >> K (Arg NOBR))
haftmann@28060
   267
      || ($$ "_" >> K (Arg BR))
haftmann@28060
   268
      || ($$ "/" |-- Scan.repeat ($$ " ") >> (Pretty o Pretty.brk o length))
haftmann@28060
   269
      || (Scan.repeat1
haftmann@28060
   270
           (   $$ "'" |-- sym_any
haftmann@28060
   271
            || Scan.unless ($$ "_" || $$ "/" || $$ "(" |-- $$ "_" |-- $$ ")")
haftmann@28060
   272
                 sym_any) >> (Pretty o str o implode)));
haftmann@28060
   273
  in case Scan.finite Symbol.stopper parse (Symbol.explode s)
haftmann@28060
   274
   of ((_, p as [_]), []) => mk_mixfix prep_arg (NOBR, p)
haftmann@28060
   275
    | ((b, p as _ :: _ :: _), []) => mk_mixfix prep_arg (if b then NOBR else BR, p)
haftmann@28060
   276
    | _ => Scan.!!
haftmann@28060
   277
        (the_default ("malformed mixfix annotation: " ^ quote s) o snd) Scan.fail ()
haftmann@28060
   278
  end;
haftmann@28060
   279
haftmann@28060
   280
val (infixK, infixlK, infixrK) = ("infix", "infixl", "infixr");
haftmann@28060
   281
haftmann@28060
   282
fun parse_syntax prep_arg xs =
haftmann@28060
   283
  Scan.option ((
haftmann@28060
   284
      ((OuterParse.$$$ infixK  >> K X)
haftmann@28060
   285
        || (OuterParse.$$$ infixlK >> K L)
haftmann@28060
   286
        || (OuterParse.$$$ infixrK >> K R))
haftmann@28060
   287
        -- OuterParse.nat >> parse_infix prep_arg
haftmann@28060
   288
      || Scan.succeed (parse_mixfix prep_arg))
haftmann@28060
   289
      -- OuterParse.string
haftmann@28060
   290
      >> (fn (parse, s) => parse s)) xs;
haftmann@28060
   291
haftmann@28060
   292
val _ = List.app OuterKeyword.keyword [infixK, infixlK, infixrK];
haftmann@28060
   293
haftmann@28064
   294
haftmann@30648
   295
(** module name spaces **)
haftmann@30648
   296
haftmann@30648
   297
val dest_name =
haftmann@30648
   298
  apfst Long_Name.implode o split_last o fst o split_last o Long_Name.explode;
haftmann@30648
   299
haftmann@30648
   300
fun mk_name_module reserved_names module_prefix module_alias program =
haftmann@30648
   301
  let
haftmann@30648
   302
    fun mk_alias name = case module_alias name
haftmann@30648
   303
     of SOME name' => name'
haftmann@30648
   304
      | NONE => name
haftmann@30648
   305
          |> Long_Name.explode
haftmann@30648
   306
          |> map (fn name => (the_single o fst) (Name.variants [name] reserved_names))
haftmann@30648
   307
          |> Long_Name.implode;
haftmann@30648
   308
    fun mk_prefix name = case module_prefix
haftmann@30648
   309
     of SOME module_prefix => Long_Name.append module_prefix name
haftmann@30648
   310
      | NONE => name;
haftmann@30648
   311
    val tab =
haftmann@30648
   312
      Symtab.empty
haftmann@30648
   313
      |> Graph.fold ((fn name => Symtab.default (name, (mk_alias #> mk_prefix) name))
haftmann@30648
   314
           o fst o dest_name o fst)
haftmann@30648
   315
             program
haftmann@30648
   316
  in the o Symtab.lookup tab end;
haftmann@30648
   317
haftmann@28060
   318
end; (*struct*)