src/Tools/Code/code_printer.ML
author haftmann
Thu Sep 02 13:58:16 2010 +0200 (2010-09-02)
changeset 39056 fa197571676b
parent 39055 81e0368812ad
child 39057 c6d146ed07ae
permissions -rw-r--r--
formal markup of generated code for statements
     1 (*  Title:      Tools/Code/code_printer.ML
     2     Author:     Florian Haftmann, TU Muenchen
     3 
     4 Generic operations for pretty printing of target language code.
     5 *)
     6 
     7 signature CODE_PRINTER =
     8 sig
     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: 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: string -> Pretty.T -> Pretty.T
    29   val format: string list -> int -> Pretty.T -> string
    30 
    31   val first_upper: string -> string
    32   val first_lower: string -> string
    33   type var_ctxt
    34   val make_vars: string list -> var_ctxt
    35   val intro_vars: string list -> var_ctxt -> var_ctxt
    36   val lookup_var: var_ctxt -> string -> string
    37   val intro_base_names: (string -> bool) -> (string -> string)
    38     -> string list -> var_ctxt -> var_ctxt
    39   val aux_params: var_ctxt -> iterm list list -> string list
    40 
    41   type literals
    42   val Literals: { literal_char: string -> string, literal_string: string -> string,
    43         literal_numeral: int -> string,
    44         literal_positive_numeral: int -> string,
    45         literal_alternative_numeral: int -> string,
    46         literal_naive_numeral: int -> string,
    47         literal_list: Pretty.T list -> Pretty.T, infix_cons: int * string }
    48     -> literals
    49   val literal_char: literals -> string -> string
    50   val literal_string: literals -> string -> string
    51   val literal_numeral: literals -> int -> string
    52   val literal_positive_numeral: literals -> int -> string
    53   val literal_alternative_numeral: literals -> int -> string
    54   val literal_naive_numeral: literals -> int -> string
    55   val literal_list: literals -> Pretty.T list -> Pretty.T
    56   val infix_cons: literals -> int * string
    57 
    58   type lrx
    59   val L: lrx
    60   val R: lrx
    61   val X: lrx
    62   type fixity
    63   val BR: fixity
    64   val NOBR: fixity
    65   val INFX: int * lrx -> fixity
    66   val APP: fixity
    67   val brackify: fixity -> Pretty.T list -> Pretty.T
    68   val brackify_infix: int * lrx -> fixity -> Pretty.T * Pretty.T * Pretty.T -> Pretty.T
    69   val brackify_block: fixity -> Pretty.T -> Pretty.T list -> Pretty.T -> Pretty.T
    70   val applify: string -> string -> ('a -> Pretty.T) -> fixity -> Pretty.T -> 'a list -> Pretty.T
    71   val tuplify: (fixity -> 'a -> Pretty.T) -> fixity -> 'a list -> Pretty.T option
    72 
    73   type tyco_syntax
    74   type simple_const_syntax
    75   type complex_const_syntax
    76   type const_syntax
    77   type activated_complex_const_syntax
    78   datatype activated_const_syntax = Plain_const_syntax of int * string
    79     | Complex_const_syntax of activated_complex_const_syntax
    80   val requires_args: const_syntax -> int
    81   val parse_const_syntax: Token.T list -> const_syntax option * Token.T list
    82   val parse_tyco_syntax: Token.T list -> tyco_syntax option * Token.T list
    83   val plain_const_syntax: string -> const_syntax
    84   val simple_const_syntax: simple_const_syntax -> const_syntax
    85   val complex_const_syntax: complex_const_syntax -> const_syntax
    86   val activate_const_syntax: theory -> literals
    87     -> string -> const_syntax -> Code_Thingol.naming -> activated_const_syntax * Code_Thingol.naming
    88   val gen_print_app: (thm option -> var_ctxt -> const * iterm list -> Pretty.T list)
    89     -> (thm option -> var_ctxt -> fixity -> iterm -> Pretty.T)
    90     -> (string -> activated_const_syntax option)
    91     -> thm option -> var_ctxt -> fixity -> const * iterm list -> Pretty.T
    92   val gen_print_bind: (thm option -> var_ctxt -> fixity -> iterm -> Pretty.T)
    93     -> thm option -> fixity
    94     -> iterm -> var_ctxt -> Pretty.T * var_ctxt
    95 end;
    96 
    97 structure Code_Printer : CODE_PRINTER =
    98 struct
    99 
   100 open Code_Thingol;
   101 
   102 (** generic nonsense *)
   103 
   104 fun eqn_error (SOME thm) s = error (s ^ ",\nin equation " ^ Display.string_of_thm_without_context thm)
   105   | eqn_error NONE s = error s;
   106 
   107 val code_presentationN = "code_presentation";
   108 val _ = Output.add_mode code_presentationN;
   109 val _ = Markup.add_mode code_presentationN YXML.output_markup;
   110 
   111 
   112 (** assembling and printing text pieces **)
   113 
   114 infixr 5 @@;
   115 infixr 5 @|;
   116 fun x @@ y = [x, y];
   117 fun xs @| y = xs @ [y];
   118 val str = Print_Mode.setmp [] Pretty.str;
   119 val concat = Pretty.block o Pretty.breaks;
   120 val commas = Print_Mode.setmp [] Pretty.commas;
   121 fun enclose l r = Print_Mode.setmp [] (Pretty.enclose l r);
   122 val brackets = enclose "(" ")" o Pretty.breaks;
   123 fun enum sep l r = Print_Mode.setmp [] (Pretty.enum sep l r);
   124 fun enum_default default sep l r [] = str default
   125   | enum_default default sep l r xs = enum sep l r xs;
   126 fun semicolon ps = Pretty.block [concat ps, str ";"];
   127 fun doublesemicolon ps = Pretty.block [concat ps, str ";;"];
   128 fun indent i = Print_Mode.setmp [] (Pretty.indent i);
   129 
   130 val stmt_nameN = "stmt_name";
   131 fun markup_stmt name = Pretty.mark (code_presentationN, [(stmt_nameN, name)]);
   132 fun filter_presentation presentation_names selected (XML.Elem ((name, attrs), xs)) =
   133       implode (map (filter_presentation presentation_names
   134         (selected orelse (name = code_presentationN
   135           andalso member (op =) presentation_names (the (Properties.get attrs stmt_nameN))))) xs)
   136   | filter_presentation presentation_names selected (XML.Text s) =
   137       if selected then s else "";
   138 
   139 fun format presentation_names width p =
   140   if null presentation_names then Print_Mode.setmp [] (Pretty.string_of_margin width) p ^ "\n"
   141   else Print_Mode.setmp [code_presentationN] (Pretty.string_of_margin width) p
   142     |> YXML.parse_body
   143     |> map (filter_presentation presentation_names false)
   144     |> implode
   145     |> suffix "\n"
   146 
   147 
   148 (** names and variable name contexts **)
   149 
   150 type var_ctxt = string Symtab.table * Name.context;
   151 
   152 fun make_vars names = (fold (fn name => Symtab.update_new (name, name)) names Symtab.empty,
   153   Name.make_context names);
   154 
   155 fun intro_vars names (namemap, namectxt) =
   156   let
   157     val (names', namectxt') = Name.variants names namectxt;
   158     val namemap' = fold2 (curry Symtab.update) names names' namemap;
   159   in (namemap', namectxt') end;
   160 
   161 fun lookup_var (namemap, _) name = case Symtab.lookup namemap name
   162  of SOME name' => name'
   163   | NONE => error ("Invalid name in context: " ^ quote name);
   164 
   165 val first_upper = implode o nth_map 0 Symbol.to_ascii_upper o explode;
   166 val first_lower = implode o nth_map 0 Symbol.to_ascii_lower o explode;
   167 
   168 fun aux_params vars lhss =
   169   let
   170     fun fish_param _ (w as SOME _) = w
   171       | fish_param (IVar (SOME v)) NONE = SOME v
   172       | fish_param _ NONE = NONE;
   173     fun fillup_param _ (_, SOME v) = v
   174       | fillup_param x (i, NONE) = x ^ string_of_int i;
   175     val fished1 = fold (map2 fish_param) lhss (replicate (length (hd lhss)) NONE);
   176     val x = Name.variant (map_filter I fished1) "x";
   177     val fished2 = map_index (fillup_param x) fished1;
   178     val (fished3, _) = Name.variants fished2 Name.context;
   179     val vars' = intro_vars fished3 vars;
   180   in map (lookup_var vars') fished3 end;
   181 
   182 fun intro_base_names no_syntax deresolve names = names 
   183   |> map_filter (fn name => if no_syntax name then
   184       let val name' = deresolve name in
   185         if Long_Name.is_qualified name' then NONE else SOME name'
   186       end else NONE)
   187   |> intro_vars;
   188 
   189 
   190 (** pretty literals **)
   191 
   192 datatype literals = Literals of {
   193   literal_char: string -> string,
   194   literal_string: string -> string,
   195   literal_numeral: int -> string,
   196   literal_positive_numeral: int -> string,
   197   literal_alternative_numeral: int -> string,
   198   literal_naive_numeral: int -> string,
   199   literal_list: Pretty.T list -> Pretty.T,
   200   infix_cons: int * string
   201 };
   202 
   203 fun dest_Literals (Literals lits) = lits;
   204 
   205 val literal_char = #literal_char o dest_Literals;
   206 val literal_string = #literal_string o dest_Literals;
   207 val literal_numeral = #literal_numeral o dest_Literals;
   208 val literal_positive_numeral = #literal_positive_numeral o dest_Literals;
   209 val literal_alternative_numeral = #literal_alternative_numeral o dest_Literals;
   210 val literal_naive_numeral = #literal_naive_numeral o dest_Literals;
   211 val literal_list = #literal_list o dest_Literals;
   212 val infix_cons = #infix_cons o dest_Literals;
   213 
   214 
   215 (** syntax printer **)
   216 
   217 (* binding priorities *)
   218 
   219 datatype lrx = L | R | X;
   220 
   221 datatype fixity =
   222     BR
   223   | NOBR
   224   | INFX of (int * lrx);
   225 
   226 val APP = INFX (~1, L);
   227 
   228 fun fixity_lrx L L = false
   229   | fixity_lrx R R = false
   230   | fixity_lrx _ _ = true;
   231 
   232 fun fixity NOBR _ = false
   233   | fixity _ NOBR = false
   234   | fixity (INFX (pr, lr)) (INFX (print_ctxt, lr_ctxt)) =
   235       pr < print_ctxt
   236       orelse pr = print_ctxt
   237         andalso fixity_lrx lr lr_ctxt
   238       orelse print_ctxt = ~1
   239   | fixity BR (INFX _) = false
   240   | fixity _ _ = true;
   241 
   242 fun gen_brackify _ [p] = p
   243   | gen_brackify true (ps as _::_) = enclose "(" ")" ps
   244   | gen_brackify false (ps as _::_) = Pretty.block ps;
   245 
   246 fun brackify fxy_ctxt =
   247   gen_brackify (fixity BR fxy_ctxt) o Pretty.breaks;
   248 
   249 fun brackify_infix infx fxy_ctxt (l, m, r) =
   250   (if fixity (INFX infx) fxy_ctxt then enclose "(" ")" else Pretty.block)
   251     ([l, str " ", m, Pretty.brk 1, r]);
   252 
   253 fun brackify_block fxy_ctxt p1 ps p2 =
   254   let val p = Pretty.block_enclose (p1, p2) ps
   255   in if fixity BR fxy_ctxt
   256     then enclose "(" ")" [p]
   257     else p
   258   end;
   259 
   260 fun applify opn cls f fxy_ctxt p [] = p
   261   | applify opn cls f fxy_ctxt p ps =
   262       (if (fixity BR fxy_ctxt) then enclose "(" ")" else Pretty.block)
   263         (p @@ enum "," opn cls (map f ps));
   264 
   265 fun tuplify _ _ [] = NONE
   266   | tuplify print fxy [x] = SOME (print fxy x)
   267   | tuplify print _ xs = SOME (enum "," "(" ")" (map (print NOBR) xs));
   268 
   269 
   270 (* generic syntax *)
   271 
   272 type tyco_syntax = int * ((fixity -> itype -> Pretty.T)
   273   -> fixity -> itype list -> Pretty.T);
   274 
   275 type simple_const_syntax = int * ((fixity -> iterm -> Pretty.T)
   276   -> fixity -> (iterm * itype) list -> Pretty.T);
   277 
   278 type complex_const_syntax = int * (string list * (literals -> string list
   279   -> (var_ctxt -> fixity -> iterm -> Pretty.T)
   280     -> thm option -> var_ctxt -> fixity -> (iterm * itype) list -> Pretty.T));
   281 
   282 datatype const_syntax = plain_const_syntax of string
   283   | complex_const_syntax of complex_const_syntax;
   284 
   285 fun requires_args (plain_const_syntax _) = 0
   286   | requires_args (complex_const_syntax (k, _)) = k;
   287 
   288 fun simple_const_syntax syn =
   289   complex_const_syntax (apsnd (fn f => ([], (fn _ => fn _ => fn print => fn _ => fn vars => f (print vars)))) syn);
   290 
   291 type activated_complex_const_syntax = int * ((var_ctxt -> fixity -> iterm -> Pretty.T)
   292   -> thm option -> var_ctxt -> fixity -> (iterm * itype) list -> Pretty.T)
   293 
   294 datatype activated_const_syntax = Plain_const_syntax of int * string
   295   | Complex_const_syntax of activated_complex_const_syntax;
   296 
   297 fun activate_const_syntax thy literals c (plain_const_syntax s) naming =
   298       (Plain_const_syntax (Code.args_number thy c, s), naming)
   299   | activate_const_syntax thy literals c (complex_const_syntax (n, (cs, f))) naming =
   300       fold_map (Code_Thingol.ensure_declared_const thy) cs naming
   301       |-> (fn cs' => pair (Complex_const_syntax (n, f literals cs')));
   302 
   303 fun gen_print_app print_app_expr print_term const_syntax some_thm vars fxy (app as ((c, (_, function_typs)), ts)) =
   304   case const_syntax c
   305    of NONE => brackify fxy (print_app_expr some_thm vars app)
   306     | SOME (Plain_const_syntax (_, s)) => brackify fxy (str s :: map (print_term some_thm vars BR) ts)
   307     | SOME (Complex_const_syntax (k, print)) =>
   308         let
   309           fun print' fxy ts = print (print_term some_thm) some_thm vars fxy (ts ~~ take k function_typs);
   310         in if k = length ts
   311           then print' fxy ts
   312         else if k < length ts
   313           then case chop k ts of (ts1, ts2) =>
   314             brackify fxy (print' APP ts1 :: map (print_term some_thm vars BR) ts2)
   315           else print_term some_thm vars fxy (Code_Thingol.eta_expand k app)
   316         end;
   317 
   318 fun gen_print_bind print_term thm (fxy : fixity) pat vars =
   319   let
   320     val vs = Code_Thingol.fold_varnames (insert (op =)) pat [];
   321     val vars' = intro_vars vs vars;
   322   in (print_term thm vars' fxy pat, vars') end;
   323 
   324 
   325 (* mixfix syntax *)
   326 
   327 datatype 'a mixfix =
   328     Arg of fixity
   329   | String of string
   330   | Break;
   331 
   332 fun mk_mixfix prep_arg (fixity_this, mfx) =
   333   let
   334     fun is_arg (Arg _) = true
   335       | is_arg _ = false;
   336     val i = (length o filter is_arg) mfx;
   337     fun fillin _ [] [] =
   338           []
   339       | fillin print (Arg fxy :: mfx) (a :: args) =
   340           (print fxy o prep_arg) a :: fillin print mfx args
   341       | fillin print (String s :: mfx) args =
   342           str s :: fillin print mfx args
   343       | fillin print (Break :: mfx) args =
   344           Pretty.brk 1 :: fillin print mfx args;
   345   in
   346     (i, fn print => fn fixity_ctxt => fn args =>
   347       gen_brackify (fixity fixity_this fixity_ctxt) (fillin print mfx args))
   348   end;
   349 
   350 fun parse_infix prep_arg (x, i) s =
   351   let
   352     val l = case x of L => INFX (i, L) | _ => INFX (i, X);
   353     val r = case x of R => INFX (i, R) | _ => INFX (i, X);
   354   in
   355     mk_mixfix prep_arg (INFX (i, x), [Arg l, String " ", String s, Break, Arg r])
   356   end;
   357 
   358 fun parse_mixfix mk_plain mk_complex prep_arg s =
   359   let
   360     val sym_any = Scan.one Symbol.is_regular;
   361     val parse = Scan.optional ($$ "!" >> K true) false -- Scan.repeat (
   362          ($$ "(" -- $$ "_" -- $$ ")" >> K (Arg NOBR))
   363       || ($$ "_" >> K (Arg BR))
   364       || ($$ "/" |-- Scan.repeat ($$ " ") >> (K Break))
   365       || (Scan.repeat1
   366            (   $$ "'" |-- sym_any
   367             || Scan.unless ($$ "_" || $$ "/" || $$ "(" |-- $$ "_" |-- $$ ")")
   368                  sym_any) >> (String o implode)));
   369   in case Scan.finite Symbol.stopper parse (Symbol.explode s)
   370    of ((false, [String s]), []) => mk_plain s
   371     | ((_, p as [_]), []) => mk_complex (mk_mixfix prep_arg (NOBR, p))
   372     | ((b, p as _ :: _ :: _), []) => mk_complex (mk_mixfix prep_arg (if b then NOBR else BR, p))
   373     | _ => Scan.!!
   374         (the_default ("malformed mixfix annotation: " ^ quote s) o snd) Scan.fail ()
   375   end;
   376 
   377 val (infixK, infixlK, infixrK) = ("infix", "infixl", "infixr");
   378 
   379 fun parse_syntax mk_plain mk_complex prep_arg =
   380   Scan.option (
   381       ((Parse.$$$ infixK >> K X)
   382         || (Parse.$$$ infixlK >> K L)
   383         || (Parse.$$$ infixrK >> K R))
   384         -- Parse.nat -- Parse.string
   385         >> (fn ((x, i), s) => mk_complex (parse_infix prep_arg (x, i) s))
   386       || Parse.string >> (fn s => (parse_mixfix mk_plain mk_complex prep_arg s)));
   387 
   388 val _ = List.app Keyword.keyword [infixK, infixlK, infixrK];
   389 
   390 fun parse_tyco_syntax x = parse_syntax (fn s => (0, (K o K o K o str) s)) I I x;
   391 
   392 val parse_const_syntax = parse_syntax plain_const_syntax simple_const_syntax fst;
   393 
   394 end; (*struct*)