paulson@1591: (*  Title:      Pure/display.ML
paulson@1591:     ID:         $Id$
paulson@1591:     Author:     Lawrence C Paulson, Cambridge University Computer Laboratory
paulson@1591:     Copyright   1993  University of Cambridge
paulson@1591: 
paulson@1591: Printing of theories, theorems, etc.
paulson@1591: *)
paulson@1591: 
wenzelm@11883: signature BASIC_DISPLAY =
wenzelm@11883: sig
wenzelm@11883:   val show_hyps: bool ref
wenzelm@11883:   val show_tags: bool ref
wenzelm@11883:   val string_of_thm: thm -> string
wenzelm@11883:   val print_thm: thm -> unit
wenzelm@11883:   val print_thms: thm list -> unit
wenzelm@11883:   val prth: thm -> thm
wenzelm@11883:   val prthq: thm Seq.seq -> thm Seq.seq
wenzelm@11883:   val prths: thm list -> thm list
wenzelm@11883:   val string_of_ctyp: ctyp -> string
wenzelm@11883:   val print_ctyp: ctyp -> unit
wenzelm@11883:   val string_of_cterm: cterm -> string
wenzelm@11883:   val print_cterm: cterm -> unit
wenzelm@11883:   val print_syntax: theory -> unit
wenzelm@11883:   val show_consts: bool ref
wenzelm@11883: end;
wenzelm@11883: 
paulson@1591: signature DISPLAY =
wenzelm@4950: sig
wenzelm@11883:   include BASIC_DISPLAY
wenzelm@12067:   val pretty_thm_aux: (sort -> Pretty.T) -> (term -> Pretty.T) -> bool -> thm -> Pretty.T
wenzelm@6976:   val pretty_thm_no_quote: thm -> Pretty.T
wenzelm@11883:   val pretty_thm: thm -> Pretty.T
wenzelm@11883:   val pretty_thms: thm list -> Pretty.T
wenzelm@11883:   val pretty_thm_sg: Sign.sg -> thm -> Pretty.T
wenzelm@11883:   val pretty_thms_sg: Sign.sg -> thm list -> Pretty.T
wenzelm@11883:   val pprint_thm: thm -> pprint_args -> unit
wenzelm@11883:   val pretty_ctyp: ctyp -> Pretty.T
wenzelm@11883:   val pprint_ctyp: ctyp -> pprint_args -> unit
wenzelm@11883:   val pretty_cterm: cterm -> Pretty.T
wenzelm@11883:   val pprint_cterm: cterm -> pprint_args -> unit
wenzelm@11883:   val pretty_theory: theory -> Pretty.T
wenzelm@11883:   val pprint_theory: theory -> pprint_args -> unit
wenzelm@8720:   val pretty_full_theory: theory -> Pretty.T list
wenzelm@11883:   val pretty_name_space: string * NameSpace.T -> Pretty.T
wenzelm@11883:   val pretty_goals_marker: string -> int -> thm -> Pretty.T list
wenzelm@11883:   val pretty_goals: int -> thm -> Pretty.T list
wenzelm@11883:   val pretty_sub_goals: bool -> int -> thm -> Pretty.T list
wenzelm@11883:   val print_goals_marker: string -> int -> thm -> unit
wenzelm@11883:   val print_goals: int -> thm -> unit
wenzelm@11883:   val current_goals_markers: (string * string * string) ref
wenzelm@11883:   val print_current_goals_default: (int -> int -> thm -> unit)
wenzelm@11883:   val print_current_goals_fn : (int -> int -> thm -> unit) ref
wenzelm@4950: end;
paulson@1591: 
wenzelm@4950: structure Display: DISPLAY =
paulson@1591: struct
paulson@1591: 
wenzelm@11883: 
wenzelm@6087: (** print thm **)
wenzelm@6087: 
wenzelm@11883: val show_hyps = ref true;       (*false: print meta-hypotheses as dots*)
wenzelm@11883: val show_tags = ref false;      (*false: suppress tags*)
wenzelm@6087: 
wenzelm@8402: fun pretty_tag (name, args) = Pretty.strs (name :: map quote args);
wenzelm@6087: val pretty_tags = Pretty.list "[" "]" o map pretty_tag;
paulson@1591: 
wenzelm@12067: fun pretty_thm_aux pretty_sort pretty_term quote th =
paulson@1591:   let
wenzelm@12067:     val {hyps, prop, der = (ora, _), ...} = rep_thm th;
wenzelm@6087:     val xshyps = Thm.extra_shyps th;
wenzelm@6087:     val (_, tags) = Thm.get_name_tags th;
wenzelm@6087: 
wenzelm@12067:     val prt_term = (if quote then Pretty.quote else I) o pretty_term;
wenzelm@6279: 
paulson@1591:     val hlen = length xshyps + length hyps;
paulson@1591:     val hsymbs =
wenzelm@9500:       if hlen = 0 andalso not ora then []
paulson@1591:       else if ! show_hyps then
paulson@1591:         [Pretty.brk 2, Pretty.list "[" "]"
wenzelm@12067:           (map prt_term hyps @ map pretty_sort xshyps @
wenzelm@9500:             (if ora then [Pretty.str "!"] else []))]
wenzelm@6889:       else [Pretty.brk 2, Pretty.str ("[" ^ implode (replicate hlen ".") ^
wenzelm@9500:         (if ora then "!" else "") ^ "]")];
wenzelm@6087:     val tsymbs =
wenzelm@6087:       if null tags orelse not (! show_tags) then []
wenzelm@6087:       else [Pretty.brk 1, pretty_tags tags];
wenzelm@6279:   in Pretty.block (prt_term prop :: (hsymbs @ tsymbs)) end;
paulson@1591: 
wenzelm@12067: fun gen_pretty_thm quote th =
wenzelm@12067:   let val sg = Thm.sign_of_thm th
wenzelm@12067:   in pretty_thm_aux (Sign.pretty_sort sg) (Sign.pretty_term sg) quote th end;
wenzelm@6889: 
wenzelm@12067: val pretty_thm = gen_pretty_thm true;
wenzelm@12067: val pretty_thm_no_quote = gen_pretty_thm false;
wenzelm@6889: 
wenzelm@6889: 
paulson@1591: val string_of_thm = Pretty.string_of o pretty_thm;
wenzelm@6279: val pprint_thm = Pretty.pprint o pretty_thm;
paulson@1591: 
wenzelm@6087: fun pretty_thms [th] = pretty_thm th
wenzelm@6087:   | pretty_thms ths = Pretty.block (Pretty.fbreaks (map pretty_thm ths));
paulson@1591: 
wenzelm@10010: val pretty_thm_sg = pretty_thm oo Thm.transfer_sg;
wenzelm@10010: val pretty_thms_sg = pretty_thms oo (map o Thm.transfer_sg);
wenzelm@10010: 
wenzelm@6087: 
wenzelm@6087: (* top-level commands for printing theorems *)
wenzelm@6087: 
wenzelm@6087: val print_thm = Pretty.writeln o pretty_thm;
wenzelm@6087: val print_thms = Pretty.writeln o pretty_thms;
paulson@1591: 
paulson@1591: fun prth th = (print_thm th; th);
paulson@1591: 
paulson@1591: (*Print and return a sequence of theorems, separated by blank lines. *)
paulson@1591: fun prthq thseq =
wenzelm@4270:   (Seq.print (fn _ => print_thm) 100000 thseq; thseq);
paulson@1591: 
paulson@1591: (*Print and return a list of theorems, separated by blank lines. *)
wenzelm@4210: fun prths ths = (seq (fn th => (print_thm th; writeln "")) ths; ths);
paulson@1591: 
paulson@1591: 
paulson@1591: (* other printing commands *)
paulson@1591: 
wenzelm@4126: fun pretty_ctyp cT =
wenzelm@4126:   let val {sign, T} = rep_ctyp cT in Sign.pretty_typ sign T end;
wenzelm@4126: 
paulson@1591: fun pprint_ctyp cT =
paulson@1591:   let val {sign, T} = rep_ctyp cT in Sign.pprint_typ sign T end;
paulson@1591: 
paulson@1591: fun string_of_ctyp cT =
paulson@1591:   let val {sign, T} = rep_ctyp cT in Sign.string_of_typ sign T end;
paulson@1591: 
paulson@1591: val print_ctyp = writeln o string_of_ctyp;
paulson@1591: 
wenzelm@3547: fun pretty_cterm ct =
wenzelm@3547:   let val {sign, t, ...} = rep_cterm ct in Sign.pretty_term sign t end;
wenzelm@3547: 
paulson@1591: fun pprint_cterm ct =
paulson@1591:   let val {sign, t, ...} = rep_cterm ct in Sign.pprint_term sign t end;
paulson@1591: 
paulson@1591: fun string_of_cterm ct =
paulson@1591:   let val {sign, t, ...} = rep_cterm ct in Sign.string_of_term sign t end;
paulson@1591: 
paulson@1591: val print_cterm = writeln o string_of_cterm;
paulson@1591: 
paulson@1591: 
wenzelm@4250: 
wenzelm@4250: (** print theory **)
paulson@1591: 
wenzelm@6390: val pretty_theory = Sign.pretty_sg o Theory.sign_of;
wenzelm@6390: val pprint_theory = Sign.pprint_sg o Theory.sign_of;
paulson@1591: 
wenzelm@6390: val print_syntax = Syntax.print_syntax o Theory.syn_of;
paulson@1591: 
wenzelm@4250: 
wenzelm@4498: (* pretty_name_space  *)
wenzelm@4498: 
wenzelm@4498: fun pretty_name_space (kind, space) =
wenzelm@4498:   let
wenzelm@4498:     fun prt_entry (name, accs) = Pretty.block
wenzelm@4498:       (Pretty.str (quote name ^ " =") :: Pretty.brk 1 ::
wenzelm@4498:         Pretty.commas (map (Pretty.str o quote) accs));
wenzelm@4498:   in
wenzelm@4498:     Pretty.fbreaks (Pretty.str (kind ^ ":") :: map prt_entry (NameSpace.dest space))
wenzelm@4498:     |> Pretty.block
wenzelm@4498:   end;
wenzelm@4498: 
wenzelm@4498: 
wenzelm@11883: (* pretty_full_theory *)
wenzelm@4250: 
wenzelm@8720: fun pretty_full_theory thy =
wenzelm@4250:   let
wenzelm@8720:     val sg = Theory.sign_of thy;
wenzelm@8720: 
wenzelm@4250:     fun prt_cls c = Sign.pretty_sort sg [c];
wenzelm@4250:     fun prt_sort S = Sign.pretty_sort sg S;
wenzelm@4250:     fun prt_arity t (c, Ss) = Sign.pretty_arity sg (t, Ss, [c]);
wenzelm@10737:     fun prt_typ_no_tvars ty = Pretty.quote (Sign.pretty_typ sg (#1 (Type.freeze_thaw_type ty)));
wenzelm@8720:     fun prt_term t = Pretty.quote (Sign.pretty_term sg t);
wenzelm@4250: 
wenzelm@4250:     fun pretty_classes cs = Pretty.block
wenzelm@4250:       (Pretty.breaks (Pretty.str "classes:" :: map prt_cls cs));
wenzelm@4250: 
wenzelm@4250:     fun pretty_classrel (c, cs) = Pretty.block
wenzelm@4250:       (prt_cls c :: Pretty.str " <" :: Pretty.brk 1 ::
wenzelm@4250:         Pretty.commas (map prt_cls cs));
wenzelm@4250: 
wenzelm@4250:     fun pretty_default S = Pretty.block
wenzelm@4250:       [Pretty.str "default:", Pretty.brk 1, prt_sort S];
wenzelm@4250: 
wenzelm@4250:     fun pretty_ty (t, n) = Pretty.block
wenzelm@8458:       [Pretty.str t, Pretty.brk 1, Pretty.str (string_of_int n)];
wenzelm@4250: 
wenzelm@7635:     fun pretty_log_types ts = Pretty.block
wenzelm@7635:       (Pretty.breaks (Pretty.str "logical types:" :: map Pretty.str ts));
wenzelm@7635: 
wenzelm@7635:     fun pretty_witness None = Pretty.str "universal non-emptiness witness: --"
wenzelm@7635:       | pretty_witness (Some (T, S)) = Pretty.block
wenzelm@10737:           [Pretty.str "universal non-emptiness witness:", Pretty.brk 1, prt_typ_no_tvars T,
wenzelm@8402:             Pretty.brk 1, prt_sort S];
wenzelm@7635: 
wenzelm@4250:     fun pretty_abbr (t, (vs, rhs)) = Pretty.block
wenzelm@10737:       [prt_typ_no_tvars (Type (t, map (fn v => TVar ((v, 0), [])) vs)),
wenzelm@10737:         Pretty.str " =", Pretty.brk 1, prt_typ_no_tvars rhs];
wenzelm@4250: 
wenzelm@4250:     fun pretty_arities (t, ars) = map (prt_arity t) ars;
wenzelm@4250: 
wenzelm@4250:     fun pretty_const (c, ty) = Pretty.block
wenzelm@10737:       [Pretty.str c, Pretty.str " ::", Pretty.brk 1, prt_typ_no_tvars ty];
wenzelm@4250: 
wenzelm@8720:     fun prt_axm (a, t) = Pretty.block [Pretty.str (a ^ ":"), Pretty.brk 1, prt_term t];
wenzelm@8720: 
wenzelm@8720: 
wenzelm@4250:     val {self = _, tsig, const_tab, syn = _, path, spaces, data} = Sign.rep_sg sg;
wenzelm@8720:     val {axioms, oracles, ...} = Theory.rep_theory thy;
wenzelm@6846:     val spaces' = Library.sort_wrt fst spaces;
wenzelm@7635:     val {classes, classrel, default, tycons = type_tab, log_types, univ_witness, abbrs, arities} =
wenzelm@4250:       Type.rep_tsig tsig;
wenzelm@7067:     val tycons = Sign.cond_extern_table sg Sign.typeK type_tab;
wenzelm@6846:     val consts = Sign.cond_extern_table sg Sign.constK const_tab;
wenzelm@8720:     val axms = Sign.cond_extern_table sg Theory.axiomK axioms;
wenzelm@8720:     val oras = Sign.cond_extern_table sg Theory.oracleK oracles;
wenzelm@4250:   in
wenzelm@8720:     [Pretty.strs ("stamps:" :: Sign.stamp_names_of sg),
wenzelm@8720:       Pretty.strs ("data:" :: Sign.data_kinds data),
wenzelm@11501:       Pretty.strs ["name prefix:", NameSpace.pack (if_none path ["-"])],
wenzelm@8720:       Pretty.big_list "name spaces:" (map pretty_name_space spaces'),
wenzelm@8720:       pretty_classes classes,
wenzelm@8720:       Pretty.big_list "class relation:" (map pretty_classrel (Symtab.dest classrel)),
wenzelm@8720:       pretty_default default,
wenzelm@8720:       pretty_log_types log_types,
wenzelm@8720:       pretty_witness univ_witness,
wenzelm@8720:       Pretty.big_list "type constructors:" (map pretty_ty tycons),
wenzelm@8720:       Pretty.big_list "type abbreviations:" (map pretty_abbr (Symtab.dest abbrs)),
wenzelm@8720:       Pretty.big_list "type arities:" (flat (map pretty_arities (Symtab.dest arities))),
wenzelm@8720:       Pretty.big_list "consts:" (map pretty_const consts),
wenzelm@8720:       Pretty.big_list "axioms:" (map prt_axm axms),
wenzelm@8720:       Pretty.strs ("oracles:" :: (map #1 oras))]
wenzelm@4250:   end;
wenzelm@4250: 
wenzelm@4250: 
wenzelm@11883: 
wenzelm@11883: (** print_goals **)
wenzelm@11883: 
wenzelm@11883: (* print_goals etc. *)
wenzelm@11883: 
wenzelm@8908: (*show consts with types in proof state output?*)
wenzelm@3851: val show_consts = ref false;
wenzelm@3851: 
paulson@1591: 
wenzelm@11883: (*print thm A1,...,An/B in "goal style" -- premises as numbered subgoals*)
wenzelm@11883: 
wenzelm@11883: local
wenzelm@11883: 
wenzelm@11883:   (* utils *)
wenzelm@11883: 
wenzelm@11883:   fun ins_entry (x, y) [] = [(x, [y])]
wenzelm@11883:     | ins_entry (x, y) ((pair as (x', ys')) :: pairs) =
wenzelm@11883:         if x = x' then (x', y ins ys') :: pairs
wenzelm@11883:         else pair :: ins_entry (x, y) pairs;
wenzelm@11883: 
wenzelm@11883:   fun add_consts (Const (c, T), env) = ins_entry (T, (c, T)) env
wenzelm@11883:     | add_consts (t $ u, env) = add_consts (u, add_consts (t, env))
wenzelm@11883:     | add_consts (Abs (_, _, t), env) = add_consts (t, env)
wenzelm@11883:     | add_consts (_, env) = env;
wenzelm@11883: 
wenzelm@11883:   fun add_vars (Free (x, T), env) = ins_entry (T, (x, ~1)) env
wenzelm@11883:     | add_vars (Var (xi, T), env) = ins_entry (T, xi) env
wenzelm@11883:     | add_vars (Abs (_, _, t), env) = add_vars (t, env)
wenzelm@11883:     | add_vars (t $ u, env) = add_vars (u, add_vars (t, env))
wenzelm@11883:     | add_vars (_, env) = env;
wenzelm@11883: 
wenzelm@11883:   fun add_varsT (Type (_, Ts), env) = foldr add_varsT (Ts, env)
wenzelm@11883:     | add_varsT (TFree (x, S), env) = ins_entry (S, (x, ~1)) env
wenzelm@11883:     | add_varsT (TVar (xi, S), env) = ins_entry (S, xi) env;
wenzelm@11883: 
wenzelm@11883:   fun sort_idxs vs = map (apsnd (sort (prod_ord string_ord int_ord))) vs;
wenzelm@11883:   fun sort_cnsts cs = map (apsnd (sort_wrt fst)) cs;
wenzelm@11883: 
wenzelm@11883: 
wenzelm@11883:   (* prepare atoms *)
wenzelm@11883: 
wenzelm@11883:   fun consts_of t = sort_cnsts (add_consts (t, []));
wenzelm@11883:   fun vars_of t = sort_idxs (add_vars (t, []));
wenzelm@11883:   fun varsT_of t = rev (sort_idxs (it_term_types add_varsT (t, [])));
wenzelm@11883: 
wenzelm@11883:   fun pretty_goals_marker_aux begin_goal print_msg print_goal maxgoals state =
wenzelm@11883:     let
wenzelm@11883:       val {sign, ...} = rep_thm state;
wenzelm@11883: 
wenzelm@11883:       val prt_term = Sign.pretty_term sign;
wenzelm@11883:       val prt_typ = Sign.pretty_typ sign;
wenzelm@11883:       val prt_sort = Sign.pretty_sort sign;
wenzelm@11883: 
wenzelm@11883:       fun prt_atoms prt prtT (X, xs) = Pretty.block
wenzelm@11883:         [Pretty.block (Pretty.commas (map prt xs)), Pretty.str " ::",
wenzelm@11883:           Pretty.brk 1, prtT X];
wenzelm@11883: 
wenzelm@11883:       fun prt_var (x, ~1) = prt_term (Syntax.free x)
wenzelm@11883:         | prt_var xi = prt_term (Syntax.var xi);
wenzelm@11883: 
wenzelm@11883:       fun prt_varT (x, ~1) = prt_typ (TFree (x, []))
wenzelm@11883:         | prt_varT xi = prt_typ (TVar (xi, []));
wenzelm@11883: 
wenzelm@11883:       val prt_consts = prt_atoms (prt_term o Const) prt_typ;
wenzelm@11883:       val prt_vars = prt_atoms prt_var prt_typ;
wenzelm@11883:       val prt_varsT = prt_atoms prt_varT prt_sort;
wenzelm@11883: 
wenzelm@11883: 
wenzelm@11883:       fun pretty_list _ _ [] = []
wenzelm@11883:         | pretty_list name prt lst = [Pretty.big_list name (map prt lst)];
wenzelm@11883: 
wenzelm@11883:       fun pretty_subgoal (n, A) =
wenzelm@11883:         Pretty.blk (0, [Pretty.str (begin_goal ^ " " ^ string_of_int n ^ ". "), prt_term A]);
wenzelm@11883:       fun pretty_subgoals As = map pretty_subgoal (1 upto length As ~~ As);
wenzelm@11883: 
wenzelm@11883:       val pretty_ffpairs = pretty_list "flex-flex pairs:" (prt_term o Logic.mk_flexpair);
wenzelm@11883: 
wenzelm@11883:       val pretty_consts = pretty_list "constants:" prt_consts o consts_of;
wenzelm@11883:       val pretty_vars = pretty_list "variables:" prt_vars o vars_of;
wenzelm@11883:       val pretty_varsT = pretty_list "type variables:" prt_varsT o varsT_of;
wenzelm@11883: 
wenzelm@11883: 
wenzelm@11883:       val {prop, ...} = rep_thm state;
wenzelm@11883:       val (tpairs, As, B) = Logic.strip_horn prop;
wenzelm@11883:       val ngoals = length As;
wenzelm@11883: 
wenzelm@11883:       fun pretty_gs (types, sorts) =
wenzelm@11883:         (if print_goal then [prt_term B] else []) @
wenzelm@11883:          (if ngoals = 0 then [Pretty.str "No subgoals!"]
wenzelm@11883:           else if ngoals > maxgoals then
wenzelm@11883:             pretty_subgoals (take (maxgoals, As)) @
wenzelm@11883:             (if print_msg then
wenzelm@11883:                 [Pretty.str ("A total of " ^ string_of_int ngoals ^ " subgoals...")]
wenzelm@11883:              else [])
wenzelm@11883:           else pretty_subgoals As) @
wenzelm@11883:         pretty_ffpairs tpairs @
wenzelm@11883:         (if ! show_consts then pretty_consts prop else []) @
wenzelm@11883:         (if types then pretty_vars prop else []) @
wenzelm@11883:         (if sorts then pretty_varsT prop else []);
wenzelm@11883:     in
wenzelm@11883:       setmp show_no_free_types true
wenzelm@11883:         (setmp show_types (! show_types orelse ! show_sorts)
wenzelm@11883:           (setmp show_sorts false pretty_gs))
wenzelm@11883:      (! show_types orelse ! show_sorts, ! show_sorts)
wenzelm@11883:   end;
wenzelm@11883: 
wenzelm@11883: in
wenzelm@11883:   fun pretty_goals_marker bg = pretty_goals_marker_aux bg true true;
wenzelm@11883:   val print_goals_marker = (Pretty.writeln o Pretty.chunks) ooo pretty_goals_marker;
wenzelm@11883:   val pretty_sub_goals = pretty_goals_marker_aux "" false;
wenzelm@11883:   val pretty_goals = pretty_goals_marker "";
wenzelm@11883:   val print_goals = print_goals_marker "";
paulson@1591: end;
paulson@1591: 
wenzelm@11883: 
wenzelm@11883: (* print_current_goals *)
wenzelm@11883: 
wenzelm@11883: val current_goals_markers = ref ("", "", "");
wenzelm@11883: 
wenzelm@11883: fun print_current_goals_default n max th =
wenzelm@11883:   let
wenzelm@11883:     val ref (begin_state, end_state, begin_goal) = current_goals_markers;
wenzelm@11883:     val ngoals = nprems_of th;
wenzelm@11883:   in
wenzelm@11883:     if begin_state = "" then () else writeln begin_state;
wenzelm@11883:     writeln ("Level " ^ string_of_int n ^
wenzelm@11883:       (if ngoals > 0 then " (" ^ string_of_int ngoals ^ " subgoal" ^
wenzelm@11883:         (if ngoals <> 1 then "s" else "") ^ ")"
wenzelm@11883:       else ""));
wenzelm@11883:     print_goals_marker begin_goal max th;
wenzelm@11883:     if end_state = "" then () else writeln end_state
wenzelm@11883:   end;
wenzelm@11883: 
wenzelm@11883: val print_current_goals_fn = ref print_current_goals_default;
wenzelm@11883: 
wenzelm@11883: end;
wenzelm@11883: 
wenzelm@11883: structure BasicDisplay: BASIC_DISPLAY = Display;
wenzelm@11883: open BasicDisplay;