1(*  Title:      Tools/Code/code_printer.ML
2    Author:     Florian Haftmann, TU Muenchen
3
4Generic operations for pretty printing of target language code.
5*)
6
7signature CODE_PRINTER =
8sig
9  type itype = Code_Thingol.itype
10  type iterm = Code_Thingol.iterm
11  type const = Code_Thingol.const
12  type dict = Code_Thingol.dict
13
14  val eqn_error: theory -> thm option -> string -> 'a
15
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 commas: Pretty.T list -> Pretty.T list
23  val enum: string -> string -> string -> Pretty.T list -> Pretty.T
24  val enum_default: string -> string -> string -> string -> Pretty.T list -> Pretty.T
25  val semicolon: Pretty.T list -> Pretty.T
26  val doublesemicolon: Pretty.T list -> Pretty.T
27  val indent: int -> Pretty.T -> Pretty.T
28  val markup_stmt: Code_Symbol.T -> Pretty.T -> Pretty.T
29  val format: Code_Symbol.T list -> int -> Pretty.T -> string
30
31  type var_ctxt
32  val make_vars: string list -> var_ctxt
33  val intro_vars: string list -> var_ctxt -> var_ctxt
34  val lookup_var: var_ctxt -> string -> string
35  val intro_base_names: (string -> bool) -> (string -> string)
36    -> string list -> var_ctxt -> var_ctxt
37  val intro_base_names_for: (string -> bool) -> (Code_Symbol.T -> string)
38    -> iterm list -> var_ctxt -> var_ctxt
39  val aux_params: var_ctxt -> iterm list list -> string list
40
41  type literals
42  val Literals: { literal_string: string -> string,
43        literal_numeral: int -> string,
44        literal_list: Pretty.T list -> Pretty.T, infix_cons: int * string }
45    -> literals
46  val literal_string: literals -> string -> string
47  val literal_numeral: literals -> int -> string
48  val literal_list: literals -> Pretty.T list -> Pretty.T
49  val infix_cons: literals -> int * string
50
51  type lrx
52  val L: lrx
53  val R: lrx
54  val X: lrx
55  type fixity
56  val BR: fixity
57  val NOBR: fixity
58  val INFX: int * lrx -> fixity
59  val APP: fixity
60  val brackify: fixity -> Pretty.T list -> Pretty.T
61  val brackify_infix: int * lrx -> fixity -> Pretty.T * Pretty.T * Pretty.T -> Pretty.T
62  val brackify_block: fixity -> Pretty.T -> Pretty.T list -> Pretty.T -> Pretty.T
63  val gen_applify: bool -> string -> string -> ('a -> Pretty.T) -> fixity -> Pretty.T -> 'a list -> Pretty.T
64  val applify: string -> string -> ('a -> Pretty.T) -> fixity -> Pretty.T -> 'a list -> Pretty.T
65  val tuplify: (fixity -> 'a -> Pretty.T) -> fixity -> 'a list -> Pretty.T option
66
67  type raw_const_syntax
68  val plain_const_syntax: string -> raw_const_syntax
69  type simple_const_syntax
70  val simple_const_syntax: simple_const_syntax -> raw_const_syntax
71  type complex_const_syntax
72  val complex_const_syntax: complex_const_syntax -> raw_const_syntax
73  val parse_const_syntax: raw_const_syntax parser
74  val requires_args: raw_const_syntax -> int
75  datatype const_printer = Plain_printer of string
76    | Complex_printer of (var_ctxt -> fixity -> iterm -> Pretty.T)
77        -> thm option -> var_ctxt -> fixity -> (iterm * itype) list -> Pretty.T
78  type const_syntax = int * const_printer
79  val prep_const_syntax: theory -> literals
80    -> string -> raw_const_syntax -> const_syntax
81  type tyco_syntax
82  val parse_tyco_syntax: tyco_syntax parser
83  val gen_print_app: (thm option -> var_ctxt -> const * iterm list -> Pretty.T list)
84    -> (thm option -> var_ctxt -> fixity -> iterm -> Pretty.T)
85    -> (string -> const_syntax option)
86    -> thm option -> var_ctxt -> fixity -> const * iterm list -> Pretty.T
87  val gen_print_bind: (thm option -> var_ctxt -> fixity -> iterm -> Pretty.T)
88    -> thm option -> fixity
89    -> iterm -> var_ctxt -> Pretty.T * var_ctxt
90
91  type identifiers
92  type printings
93  type data
94  val empty_data: data
95  val map_data: (string list * identifiers * printings
96    -> string list * identifiers * printings)
97    -> data -> data
98  val merge_data: data * data -> data
99  val the_reserved: data -> string list;
100  val the_identifiers: data -> identifiers;
101  val the_printings: data -> printings;
102end;
103
104structure Code_Printer : CODE_PRINTER =
105struct
106
107open Basic_Code_Symbol;
108open Code_Thingol;
109
110(** generic nonsense *)
111
112fun eqn_error thy (SOME thm) s =
113      error (s ^ ",\nin equation " ^ Thm.string_of_thm_global thy thm)
114  | eqn_error _ NONE s = error s;
115
116val code_presentationN = "code_presentation";
117val stmt_nameN = "stmt_name";
118val _ = Markup.add_mode code_presentationN YXML.output_markup;
119
120
121(** assembling and printing text pieces **)
122
123infixr 5 @@;
124infixr 5 @|;
125fun x @@ y = [x, y];
126fun xs @| y = xs @ [y];
127val str = Print_Mode.setmp [] Pretty.str;
128val concat = Pretty.block o Pretty.breaks;
129val commas = Print_Mode.setmp [] Pretty.commas;
130fun enclose l r = Print_Mode.setmp [] (Pretty.enclose l r);
131val brackets = enclose "(" ")" o Pretty.breaks;
132fun enum sep l r = Print_Mode.setmp [] (Pretty.enum sep l r);
133fun enum_default default sep l r [] = str default
134  | enum_default default sep l r xs = enum sep l r xs;
135fun semicolon ps = Pretty.block [concat ps, str ";"];
136fun doublesemicolon ps = Pretty.block [concat ps, str ";;"];
137fun indent i = Print_Mode.setmp [] (Pretty.indent i);
138
139fun markup_stmt sym = Print_Mode.setmp [code_presentationN]
140  (Pretty.mark (code_presentationN, [(stmt_nameN, Code_Symbol.marker sym)]));
141
142fun filter_presentation [] tree =
143      Buffer.empty
144      |> fold XML.add_content tree
145  | filter_presentation presentation_syms tree =
146      let
147        val presentation_idents = map Code_Symbol.marker presentation_syms
148        fun is_selected (name, attrs) =
149          name = code_presentationN
150          andalso member (op =) presentation_idents (the (Properties.get attrs stmt_nameN));
151        fun add_content_with_space tree (is_first, buf) =
152          buf
153          |> not is_first ? Buffer.add "\n\n"
154          |> XML.add_content tree
155          |> pair false;
156        fun filter (XML.Elem (name_attrs, xs)) =
157              fold (if is_selected name_attrs then add_content_with_space else filter) xs
158          | filter (XML.Text _) = I;
159      in snd (fold filter tree (true, Buffer.empty)) end;
160
161fun format presentation_names width =
162  Print_Mode.setmp [code_presentationN] (Pretty.string_of_margin width)
163  #> YXML.parse_body
164  #> filter_presentation presentation_names
165  #> Buffer.add "\n"
166  #> Buffer.content;
167
168
169(** names and variable name contexts **)
170
171type var_ctxt = string Symtab.table * Name.context;
172
173fun make_vars names = (fold (fn name => Symtab.update_new (name, name)) names Symtab.empty,
174  Name.make_context names);
175
176fun intro_vars names (namemap, namectxt) =
177  let
178    val (names', namectxt') = fold_map Name.variant names namectxt;
179    val namemap' = fold2 (curry Symtab.update) names names' namemap;
180  in (namemap', namectxt') end;
181
182fun lookup_var (namemap, _) name =
183  case Symtab.lookup namemap name of
184    SOME name' => name'
185  | NONE => error ("Invalid name in context: " ^ quote name);
186
187fun aux_params vars lhss =
188  let
189    fun fish_param _ (w as SOME _) = w
190      | fish_param (IVar (SOME v)) NONE = SOME v
191      | fish_param _ NONE = NONE;
192    fun fillup_param _ (_, SOME v) = v
193      | fillup_param x (i, NONE) = x ^ string_of_int i;
194    val fished1 = fold (map2 fish_param) lhss (replicate (length (hd lhss)) NONE);
195    val x = singleton (Name.variant_list (map_filter I fished1)) "x";
196    val fished2 = map_index (fillup_param x) fished1;
197    val (fished3, _) = fold_map Name.variant fished2 Name.context;
198    val vars' = intro_vars fished3 vars;
199  in map (lookup_var vars') fished3 end;
200
201fun intro_base_names no_syntax deresolve =
202  map_filter (fn name => if no_syntax name then
203      let val name' = deresolve name in
204        if Long_Name.is_qualified name' then NONE else SOME name'
205      end else NONE)
206  #> intro_vars;
207
208fun intro_base_names_for no_syntax deresolve ts =
209  []
210  |> fold Code_Thingol.add_constsyms ts 
211  |> intro_base_names (fn Constant const => no_syntax const | _ => true) deresolve;
212
213
214(** pretty literals **)
215
216datatype literals = Literals of {
217  literal_string: string -> string,
218  literal_numeral: int -> string,
219  literal_list: Pretty.T list -> Pretty.T,
220  infix_cons: int * string
221};
222
223fun dest_Literals (Literals lits) = lits;
224
225val literal_string = #literal_string o dest_Literals;
226val literal_numeral = #literal_numeral o dest_Literals;
227val literal_list = #literal_list o dest_Literals;
228val infix_cons = #infix_cons o dest_Literals;
229
230
231(** syntax printer **)
232
233(* binding priorities *)
234
235datatype lrx = L | R | X;
236
237datatype fixity =
238    BR
239  | NOBR
240  | INFX of (int * lrx);
241
242val APP = INFX (~1, L);
243
244fun fixity_lrx L L = false
245  | fixity_lrx R R = false
246  | fixity_lrx _ _ = true;
247
248fun fixity NOBR _ = false
249  | fixity _ NOBR = false
250  | fixity (INFX (pr, lr)) (INFX (pr_ctxt, lr_ctxt)) =
251      pr < pr_ctxt
252      orelse pr = pr_ctxt
253        andalso fixity_lrx lr lr_ctxt
254      orelse pr_ctxt = ~1
255  | fixity BR (INFX _) = false
256  | fixity _ _ = true;
257
258fun gen_brackify _ [p] = p
259  | gen_brackify true (ps as _::_) = enclose "(" ")" ps
260  | gen_brackify false (ps as _::_) = Pretty.block ps;
261
262fun brackify fxy_ctxt =
263  gen_brackify (fixity BR fxy_ctxt) o Pretty.breaks;
264
265fun brackify_infix infx fxy_ctxt (l, m, r) =
266  gen_brackify (fixity (INFX infx) fxy_ctxt) [l, str " ", m, Pretty.brk 1, r];
267
268fun brackify_block fxy_ctxt p1 ps p2 =
269  let val p = Pretty.block_enclose (p1, p2) ps
270  in if fixity BR fxy_ctxt
271    then enclose "(" ")" [p]
272    else p
273  end;
274
275fun gen_applify strict opn cls f fxy_ctxt p [] =
276      if strict
277      then gen_brackify (fixity BR fxy_ctxt) [p, str (opn ^ cls)]
278      else p
279  | gen_applify strict opn cls f fxy_ctxt p ps =
280      gen_brackify (fixity BR fxy_ctxt) (p @@ enum "," opn cls (map f ps));
281
282fun applify opn = gen_applify false opn;
283
284fun tuplify _ _ [] = NONE
285  | tuplify print fxy [x] = SOME (print fxy x)
286  | tuplify print _ xs = SOME (enum "," "(" ")" (map (print NOBR) xs));
287
288
289(* generic syntax *)
290
291type simple_const_syntax = int * ((fixity -> iterm -> Pretty.T)
292  -> fixity -> (iterm * itype) list -> Pretty.T);
293
294type complex_const_syntax = int * (literals
295  -> (var_ctxt -> fixity -> iterm -> Pretty.T)
296    -> thm option -> var_ctxt -> fixity -> (iterm * itype) list -> Pretty.T);
297
298datatype raw_const_syntax = plain_const_syntax of string
299  | complex_const_syntax of complex_const_syntax;
300
301fun simple_const_syntax syn =
302  complex_const_syntax
303    (apsnd (fn f => fn _ => fn print => fn _ => fn vars => f (print vars)) syn);
304
305fun requires_args (plain_const_syntax _) = 0
306  | requires_args (complex_const_syntax (k, _)) = k;
307
308datatype const_printer = Plain_printer of string
309  | Complex_printer of (var_ctxt -> fixity -> iterm -> Pretty.T)
310      -> thm option -> var_ctxt -> fixity -> (iterm * itype) list -> Pretty.T;
311
312type const_syntax = int * const_printer;
313
314fun prep_const_syntax thy literals c (plain_const_syntax s) =
315      (Code.args_number thy c, Plain_printer s)
316  | prep_const_syntax thy literals c (complex_const_syntax (n, f))=
317      (n, Complex_printer (f literals));
318
319fun gen_print_app print_app_expr print_term const_syntax some_thm vars fxy
320    (app as ({ sym, dom, ... }, ts)) =
321  case sym of
322    Constant const => (case const_syntax const of
323      NONE => brackify fxy (print_app_expr some_thm vars app)
324    | SOME (_, Plain_printer s) =>
325        brackify fxy (str s :: map (print_term some_thm vars BR) ts)
326    | SOME (k, Complex_printer print) =>
327        let
328          fun print' fxy ts =
329            print (print_term some_thm) some_thm vars fxy (ts ~~ take k dom);
330        in
331          if k = length ts
332          then print' fxy ts
333          else if k < length ts
334          then case chop k ts of (ts1, ts2) =>
335            brackify fxy (print' APP ts1 :: map (print_term some_thm vars BR) ts2)
336          else print_term some_thm vars fxy (Code_Thingol.eta_expand k app)
337        end)
338  | _ => brackify fxy (print_app_expr some_thm vars app);
339
340fun gen_print_bind print_term thm (fxy : fixity) pat vars =
341  let
342    val vs = Code_Thingol.fold_varnames (insert (op =)) pat [];
343    val vars' = intro_vars vs vars;
344  in (print_term thm vars' fxy pat, vars') end;
345
346type tyco_syntax = int * ((fixity -> itype -> Pretty.T)
347  -> fixity -> itype list -> Pretty.T);
348
349
350(* mixfix syntax *)
351
352datatype 'a mixfix =
353    Arg of fixity
354  | String of string
355  | Break;
356
357fun printer_of_mixfix prep_arg (fixity_this, mfx) =
358  let
359    fun is_arg (Arg _) = true
360      | is_arg _ = false;
361    val i = (length o filter is_arg) mfx;
362    fun fillin _ [] [] =
363          []
364      | fillin print (Arg fxy :: mfx) (a :: args) =
365          (print fxy o prep_arg) a :: fillin print mfx args
366      | fillin print (String s :: mfx) args =
367          str s :: fillin print mfx args
368      | fillin print (Break :: mfx) args =
369          Pretty.brk 1 :: fillin print mfx args;
370  in
371    (i, fn print => fn fixity_ctxt => fn args =>
372      gen_brackify (fixity fixity_this fixity_ctxt) (fillin print mfx args))
373  end;
374
375fun read_infix (fixity_this, i) s =
376  let
377    val l = case fixity_this of L => INFX (i, L) | _ => INFX (i, X);
378    val r = case fixity_this of R => INFX (i, R) | _ => INFX (i, X);
379  in
380    (INFX (i, fixity_this), [Arg l, String " ", String s, Break, Arg r])
381  end;
382
383fun read_mixfix s =
384  let
385    val sym_any = Scan.one Symbol.not_eof;
386    val parse = Scan.optional ($$ "!" >> K NOBR) BR -- Scan.repeat (
387         ($$ "(" -- $$ "_" -- $$ ")" >> K (Arg NOBR))
388      || ($$ "_" >> K (Arg BR))
389      || ($$ "/" |-- Scan.repeat ($$ " ") >> (K Break))
390      || (Scan.repeat1
391           (   $$ "'" |-- sym_any
392            || Scan.unless ($$ "_" || $$ "/" || $$ "(" |-- $$ "_" |-- $$ ")")
393                 sym_any) >> (String o implode)));
394    fun err s (_, NONE) = (fn () => "malformed mixfix annotation: " ^ quote s)
395      | err _ (_, SOME msg) = msg;
396  in
397    case Scan.finite Symbol.stopper parse (Symbol.explode s) of
398        (fixity_mixfix, []) => fixity_mixfix
399      | _ => Scan.!! (err s) Scan.fail ()
400  end;
401
402val parse_fixity =
403  (@{keyword "infix"} >> K X) || (@{keyword "infixl"} >> K L) || (@{keyword "infixr"} >> K R)
404
405fun parse_mixfix x =
406  (Parse.string >> read_mixfix
407  || parse_fixity -- Parse.nat -- Parse.string
408     >> (fn ((fixity, i), s) => read_infix (fixity, i) s)) x;
409
410fun syntax_of_mixfix of_plain of_printer prep_arg (BR, [String s]) = of_plain s
411  | syntax_of_mixfix of_plain of_printer prep_arg (fixity, mfx) =
412      of_printer (printer_of_mixfix prep_arg (fixity, mfx));
413
414fun parse_tyco_syntax x =
415  (parse_mixfix >> syntax_of_mixfix (fn s => (0, (K o K o K o str) s)) I I) x;
416
417val parse_const_syntax =
418  parse_mixfix >> syntax_of_mixfix plain_const_syntax simple_const_syntax fst;
419
420
421(** custom data structure **)
422
423type identifiers = (string list * string, string list * string, string list * string, string list * string,
424  string list * string, string list * string) Code_Symbol.data;
425type printings = (const_syntax, tyco_syntax, string, unit, unit,
426    (Pretty.T * string list)) Code_Symbol.data;
427
428datatype data = Data of { reserved: string list, identifiers: identifiers,
429  printings: printings };
430
431fun make_data (reserved, identifiers, printings) =
432  Data { reserved = reserved, identifiers = identifiers, printings = printings };
433val empty_data = make_data ([], Code_Symbol.empty_data, Code_Symbol.empty_data);
434fun map_data f (Data { reserved, identifiers, printings }) =
435  make_data (f (reserved, identifiers, printings));
436fun merge_data (Data { reserved = reserved1, identifiers = identifiers1, printings = printings1 },
437    Data { reserved = reserved2, identifiers = identifiers2, printings = printings2 }) =
438  make_data (merge (op =) (reserved1, reserved2),
439    Code_Symbol.merge_data (identifiers1, identifiers2), Code_Symbol.merge_data (printings1, printings2));
440
441fun the_reserved (Data { reserved, ... }) = reserved;
442fun the_identifiers (Data { identifiers , ... }) = identifiers;
443fun the_printings (Data { printings, ... }) = printings;
444
445
446end; (*struct*)
447