src/Pure/display.ML
author wenzelm
Sat Jun 05 13:08:53 2004 +0200 (2004-06-05)
changeset 14876 477c414000f8
parent 14794 751d5af6d91e
child 14990 582b655da757
permissions -rw-r--r--
pretty_thm/goals_aux, pretty_flexpair: pp;
     1 (*  Title:      Pure/display.ML
     2     ID:         $Id$
     3     Author:     Lawrence C Paulson, Cambridge University Computer Laboratory
     4     Copyright   1993  University of Cambridge
     5 
     6 Printing of theories, theorems, etc.
     7 *)
     8 
     9 signature BASIC_DISPLAY =
    10 sig
    11   val goals_limit: int ref
    12   val show_hyps: bool ref
    13   val show_tags: bool ref
    14   val string_of_thm: thm -> string
    15   val print_thm: thm -> unit
    16   val print_thms: thm list -> unit
    17   val prth: thm -> thm
    18   val prthq: thm Seq.seq -> thm Seq.seq
    19   val prths: thm list -> thm list
    20   val string_of_ctyp: ctyp -> string
    21   val print_ctyp: ctyp -> unit
    22   val string_of_cterm: cterm -> string
    23   val print_cterm: cterm -> unit
    24   val print_syntax: theory -> unit
    25   val show_consts: bool ref
    26 end;
    27 
    28 signature DISPLAY =
    29 sig
    30   include BASIC_DISPLAY
    31   val pretty_flexpair: Pretty.pp -> term * term -> Pretty.T
    32   val pretty_thm_aux: Pretty.pp -> bool -> thm -> Pretty.T
    33   val pretty_thm_no_quote: thm -> Pretty.T
    34   val pretty_thm: thm -> Pretty.T
    35   val pretty_thms: thm list -> Pretty.T
    36   val pretty_thm_sg: Sign.sg -> thm -> Pretty.T
    37   val pretty_thms_sg: Sign.sg -> thm list -> Pretty.T
    38   val pprint_thm: thm -> pprint_args -> unit
    39   val pretty_ctyp: ctyp -> Pretty.T
    40   val pprint_ctyp: ctyp -> pprint_args -> unit
    41   val pretty_cterm: cterm -> Pretty.T
    42   val pprint_cterm: cterm -> pprint_args -> unit
    43   val pretty_theory: theory -> Pretty.T
    44   val pprint_theory: theory -> pprint_args -> unit
    45   val pretty_full_theory: theory -> Pretty.T list
    46   val pretty_name_space: string * NameSpace.T -> Pretty.T
    47   val pretty_goals_aux: Pretty.pp -> string -> bool * bool -> int -> thm -> Pretty.T list
    48   val pretty_goals: int -> thm -> Pretty.T list
    49   val print_goals: int -> thm -> unit
    50   val current_goals_markers: (string * string * string) ref
    51   val pretty_current_goals: int -> int -> thm -> Pretty.T list
    52   val print_current_goals_default: int -> int -> thm -> unit
    53   val print_current_goals_fn: (int -> int -> thm -> unit) ref
    54 end;
    55 
    56 structure Display: DISPLAY =
    57 struct
    58 
    59 
    60 (** print thm **)
    61 
    62 val goals_limit = ref 10;       (*max number of goals to print -- set by user*)
    63 val show_hyps = ref false;      (*false: print meta-hypotheses as dots*)
    64 val show_tags = ref false;      (*false: suppress tags*)
    65 
    66 fun pretty_tag (name, args) = Pretty.strs (name :: map Library.quote args);
    67 val pretty_tags = Pretty.list "[" "]" o map pretty_tag;
    68 
    69 fun pretty_flexpair pp (t, u) = Pretty.block
    70   [Pretty.term pp t, Pretty.str " =?=", Pretty.brk 1, Pretty.term pp u];
    71 
    72 fun pretty_thm_aux pp quote th =
    73   let
    74     val {hyps, tpairs, prop, der = (ora, _), ...} = rep_thm th;
    75     val xshyps = Thm.extra_shyps th;
    76     val (_, tags) = Thm.get_name_tags th;
    77 
    78     val q = if quote then Pretty.quote else I;
    79     val prt_term = q o (Pretty.term pp);
    80 
    81     val hlen = length xshyps + length hyps + length tpairs;
    82     val hsymbs =
    83       if hlen = 0 andalso not ora then []
    84       else if ! show_hyps then
    85         [Pretty.brk 2, Pretty.list "[" "]"
    86           (map (q o pretty_flexpair pp) tpairs @ map prt_term hyps @
    87            map (Pretty.sort pp) xshyps @
    88             (if ora then [Pretty.str "!"] else []))]
    89       else [Pretty.brk 2, Pretty.str ("[" ^ implode (replicate hlen ".") ^
    90         (if ora then "!" else "") ^ "]")];
    91     val tsymbs =
    92       if null tags orelse not (! show_tags) then []
    93       else [Pretty.brk 1, pretty_tags tags];
    94   in Pretty.block (prt_term prop :: (hsymbs @ tsymbs)) end;
    95 
    96 fun gen_pretty_thm quote th =
    97   pretty_thm_aux (Sign.pp (Thm.sign_of_thm th)) quote th;
    98 
    99 val pretty_thm = gen_pretty_thm true;
   100 val pretty_thm_no_quote = gen_pretty_thm false;
   101 
   102 
   103 val string_of_thm = Pretty.string_of o pretty_thm;
   104 val pprint_thm = Pretty.pprint o pretty_thm;
   105 
   106 fun pretty_thms [th] = pretty_thm th
   107   | pretty_thms ths = Pretty.block (Pretty.fbreaks (map pretty_thm ths));
   108 
   109 val pretty_thm_sg = pretty_thm oo Thm.transfer_sg;
   110 val pretty_thms_sg = pretty_thms oo (map o Thm.transfer_sg);
   111 
   112 
   113 (* top-level commands for printing theorems *)
   114 
   115 val print_thm = Pretty.writeln o pretty_thm;
   116 val print_thms = Pretty.writeln o pretty_thms;
   117 
   118 fun prth th = (print_thm th; th);
   119 
   120 (*Print and return a sequence of theorems, separated by blank lines. *)
   121 fun prthq thseq =
   122   (Seq.print (fn _ => print_thm) 100000 thseq; thseq);
   123 
   124 (*Print and return a list of theorems, separated by blank lines. *)
   125 fun prths ths = (seq (fn th => (print_thm th; writeln "")) ths; ths);
   126 
   127 
   128 (* other printing commands *)
   129 
   130 fun pretty_ctyp cT =
   131   let val {sign, T} = rep_ctyp cT in Sign.pretty_typ sign T end;
   132 
   133 fun pprint_ctyp cT =
   134   let val {sign, T} = rep_ctyp cT in Sign.pprint_typ sign T end;
   135 
   136 fun string_of_ctyp cT =
   137   let val {sign, T} = rep_ctyp cT in Sign.string_of_typ sign T end;
   138 
   139 val print_ctyp = writeln o string_of_ctyp;
   140 
   141 fun pretty_cterm ct =
   142   let val {sign, t, ...} = rep_cterm ct in Sign.pretty_term sign t end;
   143 
   144 fun pprint_cterm ct =
   145   let val {sign, t, ...} = rep_cterm ct in Sign.pprint_term sign t end;
   146 
   147 fun string_of_cterm ct =
   148   let val {sign, t, ...} = rep_cterm ct in Sign.string_of_term sign t end;
   149 
   150 val print_cterm = writeln o string_of_cterm;
   151 
   152 
   153 
   154 (** print theory **)
   155 
   156 val pretty_theory = Sign.pretty_sg o Theory.sign_of;
   157 val pprint_theory = Sign.pprint_sg o Theory.sign_of;
   158 
   159 val print_syntax = Syntax.print_syntax o Theory.syn_of;
   160 
   161 
   162 (* pretty_name_space  *)
   163 
   164 fun pretty_name_space (kind, space) =
   165   let
   166     fun prt_entry (name, accs) = Pretty.block
   167       (Pretty.str (Library.quote name ^ " =") :: Pretty.brk 1 ::
   168         Pretty.commas (map (Pretty.quote o Pretty.str) accs));
   169   in
   170     Pretty.fbreaks (Pretty.str (kind ^ ":") :: map prt_entry (NameSpace.dest space))
   171     |> Pretty.block
   172   end;
   173 
   174 
   175 (* pretty_full_theory *)
   176 
   177 fun pretty_full_theory thy =
   178   let
   179     val sg = Theory.sign_of thy;
   180 
   181     fun prt_cls c = Sign.pretty_sort sg [c];
   182     fun prt_sort S = Sign.pretty_sort sg S;
   183     fun prt_arity t (c, Ss) = Sign.pretty_arity sg (t, Ss, [c]);
   184     fun prt_typ_no_tvars ty = Pretty.quote (Sign.pretty_typ sg (#1 (Type.freeze_thaw_type ty)));
   185     fun prt_term t = Pretty.quote (Sign.pretty_term sg t);
   186 
   187     fun pretty_classrel (c, []) = prt_cls c
   188       | pretty_classrel (c, cs) = Pretty.block
   189           (prt_cls c :: Pretty.str " <" :: Pretty.brk 1 ::
   190             Pretty.commas (map prt_cls cs));
   191 
   192     fun pretty_default S = Pretty.block
   193       [Pretty.str "default sort:", Pretty.brk 1, prt_sort S];
   194 
   195     fun pretty_ty (t, n) = Pretty.block
   196       [Pretty.str t, Pretty.brk 1, Pretty.str (string_of_int n)];
   197 
   198     fun pretty_witness None = Pretty.str "universal non-emptiness witness: --"
   199       | pretty_witness (Some (T, S)) = Pretty.block
   200           [Pretty.str "universal non-emptiness witness:", Pretty.brk 1,
   201             prt_typ_no_tvars T, Pretty.str " ::", Pretty.brk 1, prt_sort S];
   202 
   203     fun pretty_nonterminals ts = Pretty.block
   204       (Pretty.breaks (Pretty.str "syntactic types:" :: map Pretty.str ts));
   205 
   206     fun pretty_abbr (t, (vs, rhs)) = Pretty.block
   207       [prt_typ_no_tvars (Type (t, map (fn v => TVar ((v, 0), [])) vs)),
   208         Pretty.str " =", Pretty.brk 1, prt_typ_no_tvars rhs];
   209 
   210     fun pretty_arities (t, ars) = map (prt_arity t) ars;
   211 
   212     fun pretty_final (c:string, tys:typ list) = Pretty.block
   213       ([Pretty.str c, Pretty.str " ::", Pretty.brk 1] @
   214          (if null tys then [Pretty.str "<all instances>"]
   215 	  else Pretty.commas (map prt_typ_no_tvars tys)));
   216 
   217     fun pretty_const (c, (ty, _)) = Pretty.block
   218       [Pretty.str c, Pretty.str " ::", Pretty.brk 1, prt_typ_no_tvars ty];
   219 
   220     fun prt_axm (a, t) = Pretty.block [Pretty.str (a ^ ":"), Pretty.brk 1, prt_term t];
   221 
   222 
   223     val {self = _, tsig, consts, path, spaces, data} = Sign.rep_sg sg;
   224     val {axioms, oracles, ...} = Theory.rep_theory thy;
   225     val spaces' = Library.sort_wrt fst spaces;
   226     val {classes, default, types, arities, log_types = _, witness} = Type.rep_tsig tsig;
   227     val tdecls = Symtab.dest types |>
   228       map (fn (t, (decl, _)) => (Sign.cond_extern sg Sign.typeK t, decl));
   229     val tycons = mapfilter (fn (t, Type.LogicalType n) => Some (t, n) | _ => None) tdecls;
   230     val abbrs = mapfilter (fn (t, Type.Abbreviation u) => Some (t, u) | _ => None) tdecls;
   231     val nonterminals = mapfilter (fn (t, Type.Nonterminal) => Some t | _ => None) tdecls;
   232     val finals = Symtab.dest (#final_consts (Theory.rep_theory thy));
   233     val cnsts = Sign.cond_extern_table sg Sign.constK consts;
   234     val axms = Sign.cond_extern_table sg Theory.axiomK axioms;
   235     val oras = Sign.cond_extern_table sg Theory.oracleK oracles;
   236   in
   237     [Pretty.strs ("stamps:" :: Sign.stamp_names_of sg),
   238       Pretty.strs ("data:" :: Sign.data_kinds data),
   239       Pretty.strs ["name prefix:", NameSpace.pack (if_none path ["-"])],
   240       Pretty.big_list "name spaces:" (map pretty_name_space spaces'),
   241       Pretty.big_list "classes:" (map pretty_classrel (Graph.dest classes)),
   242       pretty_default default,
   243       pretty_witness witness,
   244       Pretty.big_list "logical type constructors:" (map pretty_ty tycons),
   245       Pretty.big_list "type abbreviations:" (map pretty_abbr abbrs),
   246       pretty_nonterminals nonterminals,
   247       Pretty.big_list "type arities:" (flat (map pretty_arities (Symtab.dest arities))),
   248       Pretty.big_list "consts:" (map pretty_const cnsts),
   249       Pretty.big_list "finals:" (map pretty_final finals),
   250       Pretty.big_list "axioms:" (map prt_axm axms),
   251       Pretty.strs ("oracles:" :: (map #1 oras))]
   252   end;
   253 
   254 
   255 
   256 (** print_goals **)
   257 
   258 (* print_goals etc. *)
   259 
   260 (*show consts with types in proof state output?*)
   261 val show_consts = ref false;
   262 
   263 
   264 (*print thm A1,...,An/B in "goal style" -- premises as numbered subgoals*)
   265 
   266 local
   267 
   268 fun ins_entry (x, y) [] = [(x, [y])]
   269   | ins_entry (x, y) ((pair as (x', ys')) :: pairs) =
   270       if x = x' then (x', y ins ys') :: pairs
   271       else pair :: ins_entry (x, y) pairs;
   272 
   273 fun add_consts (Const (c, T), env) = ins_entry (T, (c, T)) env
   274   | add_consts (t $ u, env) = add_consts (u, add_consts (t, env))
   275   | add_consts (Abs (_, _, t), env) = add_consts (t, env)
   276   | add_consts (_, env) = env;
   277 
   278 fun add_vars (Free (x, T), env) = ins_entry (T, (x, ~1)) env
   279   | add_vars (Var (xi, T), env) = ins_entry (T, xi) env
   280   | add_vars (Abs (_, _, t), env) = add_vars (t, env)
   281   | add_vars (t $ u, env) = add_vars (u, add_vars (t, env))
   282   | add_vars (_, env) = env;
   283 
   284 fun add_varsT (Type (_, Ts), env) = foldr add_varsT (Ts, env)
   285   | add_varsT (TFree (x, S), env) = ins_entry (S, (x, ~1)) env
   286   | add_varsT (TVar (xi, S), env) = ins_entry (S, xi) env;
   287 
   288 fun sort_idxs vs = map (apsnd (sort (prod_ord String.compare Int.compare))) vs;
   289 fun sort_cnsts cs = map (apsnd (sort_wrt fst)) cs;
   290 
   291 fun consts_of t = sort_cnsts (add_consts (t, []));
   292 fun vars_of t = sort_idxs (add_vars (t, []));
   293 fun varsT_of t = rev (sort_idxs (it_term_types add_varsT (t, [])));
   294 
   295 in
   296 
   297 fun pretty_goals_aux pp begin_goal (msg, main) maxgoals state =
   298   let
   299     fun prt_atoms prt prtT (X, xs) = Pretty.block
   300       [Pretty.block (Pretty.commas (map prt xs)), Pretty.str " ::",
   301         Pretty.brk 1, prtT X];
   302 
   303     fun prt_var (x, ~1) = Pretty.term pp (Syntax.free x)
   304       | prt_var xi = Pretty.term pp (Syntax.var xi);
   305 
   306     fun prt_varT (x, ~1) = Pretty.typ pp (TFree (x, []))
   307       | prt_varT xi = Pretty.typ pp (TVar (xi, []));
   308 
   309     val prt_consts = prt_atoms (Pretty.term pp o Const) (Pretty.typ pp);
   310     val prt_vars = prt_atoms prt_var (Pretty.typ pp);
   311     val prt_varsT = prt_atoms prt_varT (Pretty.sort pp);
   312 
   313 
   314     fun pretty_list _ _ [] = []
   315       | pretty_list name prt lst = [Pretty.big_list name (map prt lst)];
   316 
   317     fun pretty_subgoal (n, A) = Pretty.blk (0,
   318      [Pretty.str (begin_goal ^ " " ^ string_of_int n ^ ". "), Pretty.term pp A]);
   319     fun pretty_subgoals As = map pretty_subgoal (1 upto length As ~~ As);
   320 
   321     val pretty_ffpairs = pretty_list "flex-flex pairs:" (pretty_flexpair pp);
   322 
   323     val pretty_consts = pretty_list "constants:" prt_consts o consts_of;
   324     val pretty_vars = pretty_list "variables:" prt_vars o vars_of;
   325     val pretty_varsT = pretty_list "type variables:" prt_varsT o varsT_of;
   326 
   327 
   328     val {prop, tpairs, ...} = rep_thm state;
   329     val (As, B) = Logic.strip_horn prop;
   330     val ngoals = length As;
   331 
   332     fun pretty_gs (types, sorts) =
   333       (if main then [Pretty.term pp B] else []) @
   334        (if ngoals = 0 then [Pretty.str "No subgoals!"]
   335         else if ngoals > maxgoals then
   336           pretty_subgoals (take (maxgoals, As)) @
   337           (if msg then [Pretty.str ("A total of " ^ string_of_int ngoals ^ " subgoals...")]
   338            else [])
   339         else pretty_subgoals As) @
   340       pretty_ffpairs tpairs @
   341       (if ! show_consts then pretty_consts prop else []) @
   342       (if types then pretty_vars prop else []) @
   343       (if sorts then pretty_varsT prop else []);
   344   in
   345     setmp show_no_free_types true
   346       (setmp show_types (! show_types orelse ! show_sorts orelse ! show_all_types)
   347         (setmp show_sorts false pretty_gs))
   348    (! show_types orelse ! show_sorts orelse ! show_all_types, ! show_sorts)
   349   end;
   350 
   351 fun pretty_goals_marker bg n th =
   352   pretty_goals_aux (Sign.pp (Thm.sign_of_thm th)) bg (true, true) n th;
   353 
   354 val pretty_goals = pretty_goals_marker "";
   355 val print_goals = (Pretty.writeln o Pretty.chunks) oo pretty_goals_marker "";
   356 
   357 end;
   358 
   359 
   360 (* print_current_goals *)
   361 
   362 val current_goals_markers = ref ("", "", "");
   363 
   364 fun pretty_current_goals n m th =
   365   let
   366     val ref (begin_state, end_state, begin_goal) = current_goals_markers;
   367     val ngoals = nprems_of th;
   368   in
   369     (if begin_state = "" then [] else [Pretty.str begin_state]) @
   370     [Pretty.str ("Level " ^ string_of_int n ^
   371       (if ngoals > 0 then " (" ^ string_of_int ngoals ^ " subgoal" ^
   372         (if ngoals <> 1 then "s" else "") ^ ")"
   373       else ""))] @
   374     pretty_goals_marker begin_goal m th @
   375     (if end_state = "" then [] else [Pretty.str end_state])
   376   end;
   377 
   378 fun print_current_goals_default n m th =
   379   Pretty.writeln (Pretty.chunks (pretty_current_goals n m th));
   380 
   381 val print_current_goals_fn = ref print_current_goals_default;
   382 
   383 end;
   384 
   385 structure BasicDisplay: BASIC_DISPLAY = Display;
   386 open BasicDisplay;