1 (* Title: Tools/code/code_printer.ML
2 Author: Florian Haftmann, TU Muenchen
4 Generic operations for pretty printing of target language code.
7 signature CODE_PRINTER =
9 type itype = Code_Thingol.itype
10 type iterm = Code_Thingol.iterm
11 type const = Code_Thingol.const
12 type dict = Code_Thingol.dict
14 val eqn_error: thm -> string -> 'a
16 val @@ : 'a * 'a -> 'a list
17 val @| : 'a list * 'a -> 'a list
18 val str: string -> Pretty.T
19 val concat: Pretty.T list -> Pretty.T
20 val brackets: Pretty.T list -> Pretty.T
21 val enclose: string -> string -> Pretty.T list -> Pretty.T
22 val enum: string -> string -> string -> Pretty.T list -> Pretty.T
23 val enum_default: string -> string -> string -> string -> Pretty.T list -> Pretty.T
24 val semicolon: Pretty.T list -> Pretty.T
25 val doublesemicolon: Pretty.T list -> Pretty.T
26 val indent: int -> Pretty.T -> Pretty.T
27 val string_of_pretty: int -> Pretty.T -> string
28 val writeln_pretty: int -> Pretty.T -> unit
30 val first_upper: string -> string
31 val first_lower: string -> string
33 val make_vars: string list -> var_ctxt
34 val intro_vars: string list -> var_ctxt -> var_ctxt
35 val lookup_var: var_ctxt -> string -> string
36 val intro_base_names: (string -> bool) -> (string -> string)
37 -> string list -> var_ctxt -> var_ctxt
38 val aux_params: var_ctxt -> iterm list list -> string list
41 val Literals: { literal_char: string -> string, literal_string: string -> string,
42 literal_numeral: bool -> int -> string,
43 literal_list: Pretty.T list -> Pretty.T, infix_cons: int * string }
45 val literal_char: literals -> string -> string
46 val literal_string: literals -> string -> string
47 val literal_numeral: literals -> bool -> int -> string
48 val literal_list: literals -> Pretty.T list -> Pretty.T
49 val infix_cons: literals -> int * string
58 val INFX: int * lrx -> fixity
60 val brackify: fixity -> Pretty.T list -> Pretty.T
61 val brackify_infix: int * lrx -> fixity -> Pretty.T list -> Pretty.T
62 val brackify_block: fixity -> Pretty.T -> Pretty.T list -> Pretty.T -> Pretty.T
63 val applify: string -> string -> fixity -> Pretty.T -> Pretty.T list -> Pretty.T
66 type simple_const_syntax
67 type proto_const_syntax
69 val parse_infix: ('a -> 'b) -> lrx * int -> string
70 -> int * ((fixity -> 'b -> Pretty.T)
71 -> fixity -> 'a list -> Pretty.T)
72 val parse_syntax: ('a -> 'b) -> OuterParse.token list
73 -> (int * ((fixity -> 'b -> Pretty.T)
74 -> fixity -> 'a list -> Pretty.T)) option * OuterParse.token list
75 val simple_const_syntax: simple_const_syntax -> proto_const_syntax
76 val activate_const_syntax: theory -> literals
77 -> proto_const_syntax -> Code_Thingol.naming -> const_syntax * Code_Thingol.naming
78 val gen_print_app: (thm -> var_ctxt -> const * iterm list -> Pretty.T list)
79 -> (thm -> var_ctxt -> fixity -> iterm -> Pretty.T)
80 -> (string -> const_syntax option)
81 -> thm -> var_ctxt -> fixity -> const * iterm list -> Pretty.T
82 val gen_print_bind: (thm -> var_ctxt -> fixity -> iterm -> Pretty.T)
84 -> iterm -> var_ctxt -> Pretty.T * var_ctxt
86 val mk_name_module: Name.context -> string option -> (string -> string option)
87 -> 'a Graph.T -> string -> string
88 val dest_name: string -> string * string
91 structure Code_Printer : CODE_PRINTER =
96 fun eqn_error thm s = error (s ^ ",\nin equation " ^ Display.string_of_thm_without_context thm);
98 (** assembling and printing text pieces **)
103 fun xs @| y = xs @ [y];
104 val str = PrintMode.setmp [] Pretty.str;
105 val concat = Pretty.block o Pretty.breaks;
106 fun enclose l r = PrintMode.setmp [] (Pretty.enclose l r);
107 val brackets = enclose "(" ")" o Pretty.breaks;
108 fun enum sep l r = PrintMode.setmp [] (Pretty.enum sep l r);
109 fun enum_default default sep l r [] = str default
110 | enum_default default sep l r xs = enum sep l r xs;
111 fun semicolon ps = Pretty.block [concat ps, str ";"];
112 fun doublesemicolon ps = Pretty.block [concat ps, str ";;"];
113 fun indent i = PrintMode.setmp [] (Pretty.indent i);
115 fun string_of_pretty width p = PrintMode.setmp [] (Pretty.setmp_margin_CRITICAL width Pretty.string_of) p ^ "\n";
116 fun writeln_pretty width p = PrintMode.setmp [] (Pretty.setmp_margin_CRITICAL width Pretty.writeln) p;
119 (** names and variable name contexts **)
121 type var_ctxt = string Symtab.table * Name.context;
123 fun make_vars names = (fold (fn name => Symtab.update_new (name, name)) names Symtab.empty,
124 Name.make_context names);
126 fun intro_vars names (namemap, namectxt) =
128 val (names', namectxt') = Name.variants names namectxt;
129 val namemap' = fold2 (curry Symtab.update) names names' namemap;
130 in (namemap', namectxt') end;
132 fun lookup_var (namemap, _) name = case Symtab.lookup namemap name
133 of SOME name' => name'
134 | NONE => error ("Invalid name in context: " ^ quote name);
136 val first_upper = implode o nth_map 0 Symbol.to_ascii_upper o explode;
137 val first_lower = implode o nth_map 0 Symbol.to_ascii_lower o explode;
139 fun aux_params vars lhss =
141 fun fish_param _ (w as SOME _) = w
142 | fish_param (IVar (SOME v)) NONE = SOME v
143 | fish_param _ NONE = NONE;
144 fun fillup_param _ (_, SOME v) = v
145 | fillup_param x (i, NONE) = x ^ string_of_int i;
146 val fished1 = fold (map2 fish_param) lhss (replicate (length (hd lhss)) NONE);
147 val x = Name.variant (map_filter I fished1) "x";
148 val fished2 = map_index (fillup_param x) fished1;
149 val (fished3, _) = Name.variants fished2 Name.context;
150 val vars' = intro_vars fished3 vars;
151 in map (lookup_var vars') fished3 end;
153 fun intro_base_names no_syntax deresolve names = names
154 |> map_filter (fn name => if no_syntax name then
155 let val name' = deresolve name in
156 if Long_Name.is_qualified name' then NONE else SOME name'
161 (** pretty literals **)
163 datatype literals = Literals of {
164 literal_char: string -> string,
165 literal_string: string -> string,
166 literal_numeral: bool -> int -> string,
167 literal_list: Pretty.T list -> Pretty.T,
168 infix_cons: int * string
171 fun dest_Literals (Literals lits) = lits;
173 val literal_char = #literal_char o dest_Literals;
174 val literal_string = #literal_string o dest_Literals;
175 val literal_numeral = #literal_numeral o dest_Literals;
176 val literal_list = #literal_list o dest_Literals;
177 val infix_cons = #infix_cons o dest_Literals;
180 (** syntax printer **)
182 (* binding priorities *)
184 datatype lrx = L | R | X;
189 | INFX of (int * lrx);
191 val APP = INFX (~1, L);
193 fun fixity_lrx L L = false
194 | fixity_lrx R R = false
195 | fixity_lrx _ _ = true;
197 fun fixity NOBR _ = false
198 | fixity _ NOBR = false
199 | fixity (INFX (pr, lr)) (INFX (print_ctxt, lr_ctxt)) =
201 orelse pr = print_ctxt
202 andalso fixity_lrx lr lr_ctxt
203 orelse print_ctxt = ~1
204 | fixity BR (INFX _) = false
207 fun gen_brackify _ [p] = p
208 | gen_brackify true (ps as _::_) = enclose "(" ")" ps
209 | gen_brackify false (ps as _::_) = Pretty.block ps;
211 fun brackify fxy_ctxt =
212 gen_brackify (fixity BR fxy_ctxt) o Pretty.breaks;
214 fun brackify_infix infx fxy_ctxt =
215 gen_brackify (fixity (INFX infx) fxy_ctxt) o Pretty.breaks;
217 fun brackify_block fxy_ctxt p1 ps p2 =
218 let val p = Pretty.block_enclose (p1, p2) ps
219 in if fixity BR fxy_ctxt
220 then enclose "(" ")" [p]
224 fun applify opn cls fxy_ctxt p [] = p
225 | applify opn cls fxy_ctxt p ps =
226 (if (fixity BR fxy_ctxt) then enclose "(" ")" else Pretty.block)
227 (p @@ enum "," opn cls ps);
232 type tyco_syntax = int * ((fixity -> itype -> Pretty.T)
233 -> fixity -> itype list -> Pretty.T);
235 type simple_const_syntax = int * ((fixity -> iterm -> Pretty.T)
236 -> fixity -> (iterm * itype) list -> Pretty.T);
237 type proto_const_syntax = int * (string list * (literals -> string list
238 -> (var_ctxt -> fixity -> iterm -> Pretty.T)
239 -> thm -> var_ctxt -> fixity -> (iterm * itype) list -> Pretty.T));
240 type const_syntax = int * ((var_ctxt -> fixity -> iterm -> Pretty.T)
241 -> thm -> var_ctxt -> fixity -> (iterm * itype) list -> Pretty.T);
243 fun simple_const_syntax syn =
244 apsnd (fn f => ([], (fn _ => fn _ => fn print => fn _ => fn vars => f (print vars)))) syn;
246 fun activate_const_syntax thy literals (n, (cs, f)) naming =
247 fold_map (Code_Thingol.ensure_declared_const thy) cs naming
248 |-> (fn cs' => pair (n, f literals cs'));
250 fun gen_print_app print_app_expr print_term syntax_const thm vars fxy (app as ((c, (_, tys)), ts)) =
252 of NONE => brackify fxy (print_app_expr thm vars app)
255 fun print' fxy ts = print (print_term thm) thm vars fxy (ts ~~ take k tys);
258 else if k < length ts
259 then case chop k ts of (ts1, ts2) =>
260 brackify fxy (print' APP ts1 :: map (print_term thm vars BR) ts2)
261 else print_term thm vars fxy (Code_Thingol.eta_expand k app)
264 fun gen_print_bind print_term thm (fxy : fixity) pat vars =
266 val vs = Code_Thingol.fold_varnames (insert (op =)) pat [];
267 val vars' = intro_vars vs vars;
268 in (print_term thm vars' fxy pat, vars') end;
275 | Pretty of Pretty.T;
277 fun mk_mixfix prep_arg (fixity_this, mfx) =
279 fun is_arg (Arg _) = true
281 val i = (length o filter is_arg) mfx;
284 | fillin print (Arg fxy :: mfx) (a :: args) =
285 (print fxy o prep_arg) a :: fillin print mfx args
286 | fillin print (Pretty p :: mfx) args =
287 p :: fillin print mfx args;
289 (i, fn print => fn fixity_ctxt => fn args =>
290 gen_brackify (fixity fixity_this fixity_ctxt) (fillin print mfx args))
293 fun parse_infix prep_arg (x, i) s =
295 val l = case x of L => INFX (i, L) | _ => INFX (i, X);
296 val r = case x of R => INFX (i, R) | _ => INFX (i, X);
298 mk_mixfix prep_arg (INFX (i, x),
299 [Arg l, (Pretty o Pretty.brk) 1, (Pretty o str) s, (Pretty o Pretty.brk) 1, Arg r])
302 fun parse_mixfix prep_arg s =
304 val sym_any = Scan.one Symbol.is_regular;
305 val parse = Scan.optional ($$ "!" >> K true) false -- Scan.repeat (
306 ($$ "(" -- $$ "_" -- $$ ")" >> K (Arg NOBR))
307 || ($$ "_" >> K (Arg BR))
308 || ($$ "/" |-- Scan.repeat ($$ " ") >> (Pretty o Pretty.brk o length))
311 || Scan.unless ($$ "_" || $$ "/" || $$ "(" |-- $$ "_" |-- $$ ")")
312 sym_any) >> (Pretty o str o implode)));
313 in case Scan.finite Symbol.stopper parse (Symbol.explode s)
314 of ((_, p as [_]), []) => mk_mixfix prep_arg (NOBR, p)
315 | ((b, p as _ :: _ :: _), []) => mk_mixfix prep_arg (if b then NOBR else BR, p)
317 (the_default ("malformed mixfix annotation: " ^ quote s) o snd) Scan.fail ()
320 val (infixK, infixlK, infixrK) = ("infix", "infixl", "infixr");
322 fun parse_syntax prep_arg xs =
324 ((OuterParse.$$$ infixK >> K X)
325 || (OuterParse.$$$ infixlK >> K L)
326 || (OuterParse.$$$ infixrK >> K R))
327 -- OuterParse.nat >> parse_infix prep_arg
328 || Scan.succeed (parse_mixfix prep_arg))
330 >> (fn (parse, s) => parse s)) xs;
332 val _ = List.app OuterKeyword.keyword [infixK, infixlK, infixrK];
335 (** module name spaces **)
338 apfst Long_Name.implode o split_last o fst o split_last o Long_Name.explode;
340 fun mk_name_module reserved module_prefix module_alias program =
342 fun mk_alias name = case module_alias name
343 of SOME name' => name'
346 |> map (fn name => (the_single o fst) (Name.variants [name] reserved))
347 |> Long_Name.implode;
348 fun mk_prefix name = case module_prefix
349 of SOME module_prefix => Long_Name.append module_prefix name
353 |> Graph.fold ((fn name => Symtab.default (name, (mk_alias #> mk_prefix) name))
354 o fst o dest_name o fst)
356 in the o Symtab.lookup tab end;