haftmann@37744: (*  Title:      Tools/Code/code_printer.ML
haftmann@28060:     Author:     Florian Haftmann, TU Muenchen
haftmann@28060: 
haftmann@28060: Generic operations for pretty printing of target language code.
haftmann@28060: *)
haftmann@28060: 
haftmann@28060: signature CODE_PRINTER =
haftmann@28060: sig
haftmann@32908:   type itype = Code_Thingol.itype
haftmann@32908:   type iterm = Code_Thingol.iterm
haftmann@32908:   type const = Code_Thingol.const
haftmann@32908:   type dict = Code_Thingol.dict
haftmann@32908: 
haftmann@35228:   val eqn_error: thm option -> string -> 'a
haftmann@28060: 
haftmann@28060:   val @@ : 'a * 'a -> 'a list
haftmann@28060:   val @| : 'a list * 'a -> 'a list
haftmann@28060:   val str: string -> Pretty.T
haftmann@28060:   val concat: Pretty.T list -> Pretty.T
haftmann@28060:   val brackets: Pretty.T list -> Pretty.T
haftmann@34178:   val enclose: string -> string -> Pretty.T list -> Pretty.T
haftmann@34178:   val enum: string -> string -> string -> Pretty.T list -> Pretty.T
haftmann@34178:   val enum_default: string -> string -> string -> string -> Pretty.T list -> Pretty.T
haftmann@28060:   val semicolon: Pretty.T list -> Pretty.T
haftmann@33989:   val doublesemicolon: Pretty.T list -> Pretty.T
haftmann@34178:   val indent: int -> Pretty.T -> Pretty.T
haftmann@34071:   val string_of_pretty: int -> Pretty.T -> string
haftmann@34071:   val writeln_pretty: int -> Pretty.T -> unit
haftmann@28060: 
haftmann@30648:   val first_upper: string -> string
haftmann@30648:   val first_lower: string -> string
haftmann@30648:   type var_ctxt
haftmann@30648:   val make_vars: string list -> var_ctxt
haftmann@30648:   val intro_vars: string list -> var_ctxt -> var_ctxt
haftmann@30648:   val lookup_var: var_ctxt -> string -> string
haftmann@32913:   val intro_base_names: (string -> bool) -> (string -> string)
haftmann@32913:     -> string list -> var_ctxt -> var_ctxt
haftmann@32908:   val aux_params: var_ctxt -> iterm list list -> string list
haftmann@30648: 
haftmann@31056:   type literals
haftmann@31056:   val Literals: { literal_char: string -> string, literal_string: string -> string,
haftmann@34944:         literal_numeral: int -> string, literal_positive_numeral: int -> string,
haftmann@34944:         literal_naive_numeral: int -> string,
haftmann@31056:         literal_list: Pretty.T list -> Pretty.T, infix_cons: int * string }
haftmann@31056:     -> literals
haftmann@31056:   val literal_char: literals -> string -> string
haftmann@31056:   val literal_string: literals -> string -> string
haftmann@34944:   val literal_numeral: literals -> int -> string
haftmann@34944:   val literal_positive_numeral: literals -> int -> string
haftmann@34944:   val literal_naive_numeral: literals -> int -> string
haftmann@31056:   val literal_list: literals -> Pretty.T list -> Pretty.T
haftmann@31056:   val infix_cons: literals -> int * string
haftmann@31056: 
haftmann@28060:   type lrx
haftmann@28060:   val L: lrx
haftmann@28060:   val R: lrx
haftmann@28060:   val X: lrx
haftmann@28060:   type fixity
haftmann@28060:   val BR: fixity
haftmann@28060:   val NOBR: fixity
haftmann@28060:   val INFX: int * lrx -> fixity
haftmann@28060:   val APP: fixity
haftmann@28060:   val brackify: fixity -> Pretty.T list -> Pretty.T
haftmann@37242:   val brackify_infix: int * lrx -> fixity -> Pretty.T * Pretty.T * Pretty.T -> Pretty.T
haftmann@31665:   val brackify_block: fixity -> Pretty.T -> Pretty.T list -> Pretty.T -> Pretty.T
haftmann@37638:   val applify: string -> string -> ('a -> Pretty.T) -> fixity -> Pretty.T -> 'a list -> Pretty.T
haftmann@28060: 
haftmann@28060:   type tyco_syntax
haftmann@34152:   type simple_const_syntax
haftmann@37881:   type complex_const_syntax
haftmann@28060:   type const_syntax
haftmann@37881:   type activated_complex_const_syntax
haftmann@37881:   datatype activated_const_syntax = Plain_const_syntax of int * string
haftmann@37881:     | Complex_const_syntax of activated_complex_const_syntax
haftmann@37881:   val requires_args: const_syntax -> int
haftmann@37881:   val parse_const_syntax: Token.T list -> const_syntax option * Token.T list
haftmann@37881:   val parse_tyco_syntax: Token.T list -> tyco_syntax option * Token.T list
haftmann@37881:   val plain_const_syntax: string -> const_syntax
haftmann@37876:   val simple_const_syntax: simple_const_syntax -> const_syntax
haftmann@37881:   val complex_const_syntax: complex_const_syntax -> const_syntax
haftmann@31056:   val activate_const_syntax: theory -> literals
haftmann@37881:     -> string -> const_syntax -> Code_Thingol.naming -> activated_const_syntax * Code_Thingol.naming
haftmann@35228:   val gen_print_app: (thm option -> var_ctxt -> const * iterm list -> Pretty.T list)
haftmann@35228:     -> (thm option -> var_ctxt -> fixity -> iterm -> Pretty.T)
haftmann@37876:     -> (string -> activated_const_syntax option)
haftmann@35228:     -> thm option -> var_ctxt -> fixity -> const * iterm list -> Pretty.T
haftmann@35228:   val gen_print_bind: (thm option -> var_ctxt -> fixity -> iterm -> Pretty.T)
haftmann@35228:     -> thm option -> fixity
haftmann@31889:     -> iterm -> var_ctxt -> Pretty.T * var_ctxt
haftmann@28060: 
haftmann@30648:   val mk_name_module: Name.context -> string option -> (string -> string option)
haftmann@30648:     -> 'a Graph.T -> string -> string
haftmann@30648:   val dest_name: string -> string * string
haftmann@28060: end;
haftmann@28060: 
haftmann@28060: structure Code_Printer : CODE_PRINTER =
haftmann@28060: struct
haftmann@28060: 
haftmann@28060: open Code_Thingol;
haftmann@28060: 
haftmann@35228: fun eqn_error (SOME thm) s = error (s ^ ",\nin equation " ^ Display.string_of_thm_without_context thm)
haftmann@35228:   | eqn_error NONE s = error s;
haftmann@28060: 
haftmann@34071: (** assembling and printing text pieces **)
haftmann@28060: 
haftmann@28060: infixr 5 @@;
haftmann@28060: infixr 5 @|;
haftmann@28060: fun x @@ y = [x, y];
haftmann@28060: fun xs @| y = xs @ [y];
wenzelm@37146: val str = Print_Mode.setmp [] Pretty.str;
haftmann@28060: val concat = Pretty.block o Pretty.breaks;
wenzelm@37146: fun enclose l r = Print_Mode.setmp [] (Pretty.enclose l r);
haftmann@34178: val brackets = enclose "(" ")" o Pretty.breaks;
wenzelm@37146: fun enum sep l r = Print_Mode.setmp [] (Pretty.enum sep l r);
haftmann@34178: fun enum_default default sep l r [] = str default
haftmann@34178:   | enum_default default sep l r xs = enum sep l r xs;
haftmann@28060: fun semicolon ps = Pretty.block [concat ps, str ";"];
haftmann@33989: fun doublesemicolon ps = Pretty.block [concat ps, str ";;"];
wenzelm@37146: fun indent i = Print_Mode.setmp [] (Pretty.indent i);
haftmann@28060: 
wenzelm@37146: fun string_of_pretty width p = Print_Mode.setmp [] (Pretty.string_of_margin width) p ^ "\n";
wenzelm@37146: fun writeln_pretty width p = writeln (Print_Mode.setmp [] (Pretty.string_of_margin width) p);
haftmann@34071: 
haftmann@28060: 
haftmann@30648: (** names and variable name contexts **)
haftmann@30648: 
haftmann@30648: type var_ctxt = string Symtab.table * Name.context;
haftmann@30648: 
haftmann@30648: fun make_vars names = (fold (fn name => Symtab.update_new (name, name)) names Symtab.empty,
haftmann@30648:   Name.make_context names);
haftmann@30648: 
haftmann@30648: fun intro_vars names (namemap, namectxt) =
haftmann@30648:   let
haftmann@30648:     val (names', namectxt') = Name.variants names namectxt;
haftmann@30648:     val namemap' = fold2 (curry Symtab.update) names names' namemap;
haftmann@30648:   in (namemap', namectxt') end;
haftmann@30648: 
haftmann@30648: fun lookup_var (namemap, _) name = case Symtab.lookup namemap name
haftmann@30648:  of SOME name' => name'
haftmann@30648:   | NONE => error ("Invalid name in context: " ^ quote name);
haftmann@30648: 
haftmann@30648: val first_upper = implode o nth_map 0 Symbol.to_ascii_upper o explode;
haftmann@30648: val first_lower = implode o nth_map 0 Symbol.to_ascii_lower o explode;
haftmann@30648: 
haftmann@32908: fun aux_params vars lhss =
haftmann@32908:   let
haftmann@32908:     fun fish_param _ (w as SOME _) = w
haftmann@32908:       | fish_param (IVar (SOME v)) NONE = SOME v
haftmann@32908:       | fish_param _ NONE = NONE;
haftmann@32908:     fun fillup_param _ (_, SOME v) = v
haftmann@32908:       | fillup_param x (i, NONE) = x ^ string_of_int i;
haftmann@32908:     val fished1 = fold (map2 fish_param) lhss (replicate (length (hd lhss)) NONE);
haftmann@32908:     val x = Name.variant (map_filter I fished1) "x";
haftmann@32908:     val fished2 = map_index (fillup_param x) fished1;
haftmann@32908:     val (fished3, _) = Name.variants fished2 Name.context;
haftmann@32908:     val vars' = intro_vars fished3 vars;
haftmann@32908:   in map (lookup_var vars') fished3 end;
haftmann@32908: 
haftmann@32913: fun intro_base_names no_syntax deresolve names = names 
haftmann@32913:   |> map_filter (fn name => if no_syntax name then
haftmann@32913:       let val name' = deresolve name in
haftmann@32913:         if Long_Name.is_qualified name' then NONE else SOME name'
haftmann@32913:       end else NONE)
haftmann@32913:   |> intro_vars;
haftmann@32913: 
haftmann@30648: 
haftmann@31056: (** pretty literals **)
haftmann@31056: 
haftmann@31056: datatype literals = Literals of {
haftmann@31056:   literal_char: string -> string,
haftmann@31056:   literal_string: string -> string,
haftmann@34944:   literal_numeral: int -> string,
haftmann@34944:   literal_positive_numeral: int -> string,
haftmann@34944:   literal_naive_numeral: int -> string,
haftmann@31056:   literal_list: Pretty.T list -> Pretty.T,
haftmann@31056:   infix_cons: int * string
haftmann@31056: };
haftmann@31056: 
haftmann@31056: fun dest_Literals (Literals lits) = lits;
haftmann@31056: 
haftmann@31056: val literal_char = #literal_char o dest_Literals;
haftmann@31056: val literal_string = #literal_string o dest_Literals;
haftmann@31056: val literal_numeral = #literal_numeral o dest_Literals;
haftmann@34944: val literal_positive_numeral = #literal_positive_numeral o dest_Literals;
haftmann@34944: val literal_naive_numeral = #literal_naive_numeral o dest_Literals;
haftmann@31056: val literal_list = #literal_list o dest_Literals;
haftmann@31056: val infix_cons = #infix_cons o dest_Literals;
haftmann@31056: 
haftmann@31056: 
haftmann@28060: (** syntax printer **)
haftmann@28060: 
haftmann@28060: (* binding priorities *)
haftmann@28060: 
haftmann@28060: datatype lrx = L | R | X;
haftmann@28060: 
haftmann@28060: datatype fixity =
haftmann@28060:     BR
haftmann@28060:   | NOBR
haftmann@28060:   | INFX of (int * lrx);
haftmann@28060: 
haftmann@28060: val APP = INFX (~1, L);
haftmann@28060: 
haftmann@28060: fun fixity_lrx L L = false
haftmann@28060:   | fixity_lrx R R = false
haftmann@28060:   | fixity_lrx _ _ = true;
haftmann@28060: 
haftmann@28060: fun fixity NOBR _ = false
haftmann@28060:   | fixity _ NOBR = false
haftmann@33989:   | fixity (INFX (pr, lr)) (INFX (print_ctxt, lr_ctxt)) =
haftmann@33989:       pr < print_ctxt
haftmann@33989:       orelse pr = print_ctxt
haftmann@28060:         andalso fixity_lrx lr lr_ctxt
haftmann@33989:       orelse print_ctxt = ~1
haftmann@28060:   | fixity BR (INFX _) = false
haftmann@28060:   | fixity _ _ = true;
haftmann@28060: 
haftmann@28060: fun gen_brackify _ [p] = p
haftmann@34178:   | gen_brackify true (ps as _::_) = enclose "(" ")" ps
haftmann@28060:   | gen_brackify false (ps as _::_) = Pretty.block ps;
haftmann@28060: 
haftmann@28060: fun brackify fxy_ctxt =
haftmann@28060:   gen_brackify (fixity BR fxy_ctxt) o Pretty.breaks;
haftmann@28060: 
haftmann@37242: fun brackify_infix infx fxy_ctxt (l, m, r) =
haftmann@37242:   (if fixity (INFX infx) fxy_ctxt then enclose "(" ")" else Pretty.block)
haftmann@37242:     ([l, str " ", m, Pretty.brk 1, r]);
haftmann@28060: 
haftmann@31665: fun brackify_block fxy_ctxt p1 ps p2 =
haftmann@31665:   let val p = Pretty.block_enclose (p1, p2) ps
haftmann@31665:   in if fixity BR fxy_ctxt
haftmann@34178:     then enclose "(" ")" [p]
haftmann@31665:     else p
haftmann@31665:   end;
haftmann@31665: 
haftmann@37638: fun applify opn cls f fxy_ctxt p [] = p
haftmann@37638:   | applify opn cls f fxy_ctxt p ps =
haftmann@34247:       (if (fixity BR fxy_ctxt) then enclose "(" ")" else Pretty.block)
haftmann@37638:         (p @@ enum "," opn cls (map f ps));
haftmann@34247: 
haftmann@28060: 
haftmann@28060: (* generic syntax *)
haftmann@28060: 
haftmann@28060: type tyco_syntax = int * ((fixity -> itype -> Pretty.T)
haftmann@28060:   -> fixity -> itype list -> Pretty.T);
haftmann@34152: 
haftmann@34152: type simple_const_syntax = int * ((fixity -> iterm -> Pretty.T)
haftmann@34152:   -> fixity -> (iterm * itype) list -> Pretty.T);
haftmann@37881: 
haftmann@37881: type complex_const_syntax = int * (string list * (literals -> string list
haftmann@31056:   -> (var_ctxt -> fixity -> iterm -> Pretty.T)
haftmann@35228:     -> thm option -> var_ctxt -> fixity -> (iterm * itype) list -> Pretty.T));
haftmann@37881: 
haftmann@37881: datatype const_syntax = plain_const_syntax of string
haftmann@37881:   | complex_const_syntax of complex_const_syntax;
haftmann@37881: 
haftmann@37881: fun requires_args (plain_const_syntax _) = 0
haftmann@37881:   | requires_args (complex_const_syntax (k, _)) = k;
haftmann@28060: 
haftmann@34176: fun simple_const_syntax syn =
haftmann@37881:   complex_const_syntax (apsnd (fn f => ([], (fn _ => fn _ => fn print => fn _ => fn vars => f (print vars)))) syn);
haftmann@28060: 
haftmann@37881: type activated_complex_const_syntax = int * ((var_ctxt -> fixity -> iterm -> Pretty.T)
haftmann@37881:   -> thm option -> var_ctxt -> fixity -> (iterm * itype) list -> Pretty.T)
haftmann@37881: 
haftmann@37881: datatype activated_const_syntax = Plain_const_syntax of int * string
haftmann@37881:   | Complex_const_syntax of activated_complex_const_syntax;
haftmann@31056: 
haftmann@37881: fun activate_const_syntax thy literals c (plain_const_syntax s) naming =
haftmann@37881:       (Plain_const_syntax (Code.args_number thy c, s), naming)
haftmann@37881:   | activate_const_syntax thy literals c (complex_const_syntax (n, (cs, f))) naming =
haftmann@37881:       fold_map (Code_Thingol.ensure_declared_const thy) cs naming
haftmann@37881:       |-> (fn cs' => pair (Complex_const_syntax (n, f literals cs')));
haftmann@37881: 
haftmann@37881: fun gen_print_app print_app_expr print_term syntax_const some_thm vars fxy (app as ((c, (_, function_typs)), ts)) =
haftmann@28060:   case syntax_const c
haftmann@37881:    of NONE => brackify fxy (print_app_expr some_thm vars app)
haftmann@37881:     | SOME (Plain_const_syntax (_, s)) => brackify fxy (str s :: map (print_term some_thm vars BR) ts)
haftmann@37881:     | SOME (Complex_const_syntax (k, print)) =>
haftmann@28060:         let
haftmann@37881:           fun print' fxy ts = print (print_term some_thm) some_thm vars fxy (ts ~~ take k function_typs);
haftmann@28060:         in if k = length ts
haftmann@33989:           then print' fxy ts
haftmann@28060:         else if k < length ts
haftmann@28060:           then case chop k ts of (ts1, ts2) =>
haftmann@37881:             brackify fxy (print' APP ts1 :: map (print_term some_thm vars BR) ts2)
haftmann@37881:           else print_term some_thm vars fxy (Code_Thingol.eta_expand k app)
haftmann@28060:         end;
haftmann@28060: 
haftmann@33989: fun gen_print_bind print_term thm (fxy : fixity) pat vars =
haftmann@28060:   let
haftmann@31889:     val vs = Code_Thingol.fold_varnames (insert (op =)) pat [];
haftmann@31874:     val vars' = intro_vars vs vars;
haftmann@33989:   in (print_term thm vars' fxy pat, vars') end;
haftmann@28060: 
haftmann@28060: 
haftmann@28060: (* mixfix syntax *)
haftmann@28060: 
haftmann@28060: datatype 'a mixfix =
haftmann@28060:     Arg of fixity
haftmann@37881:   | String of string
haftmann@37881:   | Break;
haftmann@28060: 
haftmann@28060: fun mk_mixfix prep_arg (fixity_this, mfx) =
haftmann@28060:   let
haftmann@28060:     fun is_arg (Arg _) = true
haftmann@28060:       | is_arg _ = false;
haftmann@28060:     val i = (length o filter is_arg) mfx;
haftmann@28060:     fun fillin _ [] [] =
haftmann@28060:           []
haftmann@33989:       | fillin print (Arg fxy :: mfx) (a :: args) =
haftmann@33989:           (print fxy o prep_arg) a :: fillin print mfx args
haftmann@37881:       | fillin print (String s :: mfx) args =
haftmann@37881:           str s :: fillin print mfx args
haftmann@37881:       | fillin print (Break :: mfx) args =
haftmann@37881:           Pretty.brk 1 :: fillin print mfx args;
haftmann@28060:   in
haftmann@33989:     (i, fn print => fn fixity_ctxt => fn args =>
haftmann@33989:       gen_brackify (fixity fixity_this fixity_ctxt) (fillin print mfx args))
haftmann@28060:   end;
haftmann@28060: 
haftmann@28060: fun parse_infix prep_arg (x, i) s =
haftmann@28060:   let
haftmann@28060:     val l = case x of L => INFX (i, L) | _ => INFX (i, X);
haftmann@28060:     val r = case x of R => INFX (i, R) | _ => INFX (i, X);
haftmann@28060:   in
haftmann@37881:     mk_mixfix prep_arg (INFX (i, x), [Arg l, String " ", String s, Break, Arg r])
haftmann@28060:   end;
haftmann@28060: 
haftmann@37881: fun parse_mixfix mk_plain mk_complex prep_arg s =
haftmann@28060:   let
haftmann@28060:     val sym_any = Scan.one Symbol.is_regular;
haftmann@28060:     val parse = Scan.optional ($$ "!" >> K true) false -- Scan.repeat (
haftmann@28060:          ($$ "(" -- $$ "_" -- $$ ")" >> K (Arg NOBR))
haftmann@28060:       || ($$ "_" >> K (Arg BR))
haftmann@37881:       || ($$ "/" |-- Scan.repeat ($$ " ") >> (K Break))
haftmann@28060:       || (Scan.repeat1
haftmann@28060:            (   $$ "'" |-- sym_any
haftmann@28060:             || Scan.unless ($$ "_" || $$ "/" || $$ "(" |-- $$ "_" |-- $$ ")")
haftmann@37881:                  sym_any) >> (String o implode)));
haftmann@28060:   in case Scan.finite Symbol.stopper parse (Symbol.explode s)
haftmann@37881:    of ((false, [String s]), []) => mk_plain s
haftmann@37881:     | ((_, p as [_]), []) => mk_complex (mk_mixfix prep_arg (NOBR, p))
haftmann@37881:     | ((b, p as _ :: _ :: _), []) => mk_complex (mk_mixfix prep_arg (if b then NOBR else BR, p))
haftmann@28060:     | _ => Scan.!!
haftmann@28060:         (the_default ("malformed mixfix annotation: " ^ quote s) o snd) Scan.fail ()
haftmann@28060:   end;
haftmann@28060: 
haftmann@28060: val (infixK, infixlK, infixrK) = ("infix", "infixl", "infixr");
haftmann@28060: 
haftmann@37881: fun parse_syntax mk_plain mk_complex prep_arg =
haftmann@37881:   Scan.option (
wenzelm@36960:       ((Parse.$$$ infixK >> K X)
wenzelm@36960:         || (Parse.$$$ infixlK >> K L)
wenzelm@36960:         || (Parse.$$$ infixrK >> K R))
haftmann@37881:         -- Parse.nat -- Parse.string
haftmann@37881:         >> (fn ((x, i), s) => mk_complex (parse_infix prep_arg (x, i) s))
haftmann@37881:       || Parse.string >> (fn s => (parse_mixfix mk_plain mk_complex prep_arg s)));
haftmann@28060: 
wenzelm@36960: val _ = List.app Keyword.keyword [infixK, infixlK, infixrK];
haftmann@28060: 
haftmann@37881: val parse_tyco_syntax = parse_syntax (fn s => (0, (K o K o K o str) s)) I I;
haftmann@37881: 
haftmann@37881: val parse_const_syntax = parse_syntax plain_const_syntax simple_const_syntax fst;
haftmann@37881: 
haftmann@28064: 
haftmann@30648: (** module name spaces **)
haftmann@30648: 
haftmann@30648: val dest_name =
haftmann@30648:   apfst Long_Name.implode o split_last o fst o split_last o Long_Name.explode;
haftmann@30648: 
haftmann@32924: fun mk_name_module reserved module_prefix module_alias program =
haftmann@30648:   let
haftmann@30648:     fun mk_alias name = case module_alias name
haftmann@30648:      of SOME name' => name'
haftmann@30648:       | NONE => name
haftmann@30648:           |> Long_Name.explode
haftmann@32924:           |> map (fn name => (the_single o fst) (Name.variants [name] reserved))
haftmann@30648:           |> Long_Name.implode;
haftmann@30648:     fun mk_prefix name = case module_prefix
haftmann@30648:      of SOME module_prefix => Long_Name.append module_prefix name
haftmann@30648:       | NONE => name;
haftmann@30648:     val tab =
haftmann@30648:       Symtab.empty
haftmann@30648:       |> Graph.fold ((fn name => Symtab.default (name, (mk_alias #> mk_prefix) name))
haftmann@30648:            o fst o dest_name o fst)
haftmann@30648:              program
haftmann@30648:   in the o Symtab.lookup tab end;
haftmann@30648: 
haftmann@28060: end; (*struct*)