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: 
wenzelm@19420: Printing of theorems, goals, results etc.
paulson@1591: *)
paulson@1591: 
wenzelm@11883: signature BASIC_DISPLAY =
wenzelm@11883: sig
wenzelm@12081:   val goals_limit: int ref
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@14876:   val pretty_flexpair: Pretty.pp -> term * term -> Pretty.T
wenzelm@17447:   val pretty_thm_aux: Pretty.pp -> bool -> bool -> term list -> 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@16437:   val pretty_thm_sg: theory -> thm -> Pretty.T
wenzelm@16437:   val pretty_thms_sg: theory -> 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@8720:   val pretty_full_theory: theory -> Pretty.T list
wenzelm@14876:   val pretty_goals_aux: Pretty.pp -> string -> bool * bool -> int -> thm -> Pretty.T list
wenzelm@11883:   val pretty_goals: int -> thm -> Pretty.T list
wenzelm@11883:   val print_goals: int -> thm -> unit
wenzelm@11883:   val current_goals_markers: (string * string * string) ref
wenzelm@12418:   val pretty_current_goals: int -> int -> thm -> Pretty.T list
wenzelm@12418:   val print_current_goals_default: int -> int -> thm -> unit
wenzelm@12418:   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@16534: val goals_limit = ref 10;       (*max number of goals to print*)
wenzelm@12831: val show_hyps = ref false;      (*false: print meta-hypotheses as dots*)
wenzelm@11883: val show_tags = ref false;      (*false: suppress tags*)
wenzelm@6087: 
berghofe@14598: fun pretty_tag (name, args) = Pretty.strs (name :: map Library.quote args);
wenzelm@6087: val pretty_tags = Pretty.list "[" "]" o map pretty_tag;
paulson@1591: 
wenzelm@14876: fun pretty_flexpair pp (t, u) = Pretty.block
wenzelm@14876:   [Pretty.term pp t, Pretty.str " =?=", Pretty.brk 1, Pretty.term pp u];
berghofe@13658: 
wenzelm@17447: fun pretty_thm_aux pp quote show_hyps' asms raw_th =
paulson@1591:   let
wenzelm@17447:     val th = Thm.strip_shyps raw_th;
wenzelm@16290:     val {hyps, tpairs, prop, der = (ora, _), ...} = Thm.rep_thm th;
wenzelm@6087:     val xshyps = Thm.extra_shyps th;
wenzelm@6087:     val (_, tags) = Thm.get_name_tags th;
wenzelm@6087: 
berghofe@13658:     val q = if quote then Pretty.quote else I;
wenzelm@14876:     val prt_term = q o (Pretty.term pp);
wenzelm@6279: 
wenzelm@19300:     val hyps' = if ! show_hyps then hyps else subtract (op aconv) asms hyps;
wenzelm@17475:     val ora' = ora andalso (! show_hyps orelse not (! quick_and_dirty));
wenzelm@17447:     val hlen = length xshyps + length hyps' + length tpairs;
paulson@1591:     val hsymbs =
wenzelm@17475:       if hlen = 0 andalso not ora' then []
wenzelm@17447:       else if ! show_hyps orelse show_hyps' then
paulson@1591:         [Pretty.brk 2, Pretty.list "[" "]"
wenzelm@17447:           (map (q o pretty_flexpair pp) tpairs @ map prt_term hyps' @
wenzelm@14876:            map (Pretty.sort pp) xshyps @
wenzelm@17475:             (if ora' then [Pretty.str "!"] else []))]
wenzelm@6889:       else [Pretty.brk 2, Pretty.str ("[" ^ implode (replicate hlen ".") ^
wenzelm@17475:         (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@17447:   pretty_thm_aux (Sign.pp (Thm.theory_of_thm th)) quote false [] th;
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@16437: val pretty_thm_sg = pretty_thm oo Thm.transfer;
wenzelm@16437: val pretty_thms_sg = pretty_thms oo (map o Thm.transfer);
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);
wenzelm@16534: fun prthq thq = (Seq.print (K print_thm) 100000 thq; thq);
wenzelm@16534: fun prths ths = (prthq (Seq.of_list ths); ths);
paulson@1591: 
paulson@1591: 
paulson@1591: (* other printing commands *)
paulson@1591: 
wenzelm@4126: fun pretty_ctyp cT =
wenzelm@16437:   let val {thy, T, ...} = rep_ctyp cT in Sign.pretty_typ thy T end;
wenzelm@4126: 
paulson@1591: fun pprint_ctyp cT =
wenzelm@16437:   let val {thy, T, ...} = rep_ctyp cT in Sign.pprint_typ thy T end;
paulson@1591: 
paulson@1591: fun string_of_ctyp cT =
wenzelm@16437:   let val {thy, T, ...} = rep_ctyp cT in Sign.string_of_typ thy T end;
paulson@1591: 
paulson@1591: val print_ctyp = writeln o string_of_ctyp;
paulson@1591: 
wenzelm@3547: fun pretty_cterm ct =
wenzelm@16437:   let val {thy, t, ...} = rep_cterm ct in Sign.pretty_term thy t end;
wenzelm@3547: 
paulson@1591: fun pprint_cterm ct =
wenzelm@16437:   let val {thy, t, ...} = rep_cterm ct in Sign.pprint_term thy t end;
paulson@1591: 
paulson@1591: fun string_of_cterm ct =
wenzelm@16437:   let val {thy, t, ...} = rep_cterm ct in Sign.string_of_term thy 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@16437: val print_syntax = Syntax.print_syntax o Sign.syn_of;
wenzelm@4498: 
wenzelm@4498: 
wenzelm@11883: (* pretty_full_theory *)
wenzelm@4250: 
wenzelm@8720: fun pretty_full_theory thy =
wenzelm@4250:   let
wenzelm@16437:     fun prt_cls c = Sign.pretty_sort thy [c];
wenzelm@16437:     fun prt_sort S = Sign.pretty_sort thy S;
wenzelm@16437:     fun prt_arity t (c, Ss) = Sign.pretty_arity thy (t, Ss, [c]);
wenzelm@16437:     fun prt_typ ty = Pretty.quote (Sign.pretty_typ thy ty);
wenzelm@16290:     val prt_typ_no_tvars = prt_typ o Type.freeze_type;
wenzelm@16437:     fun prt_term t = Pretty.quote (Sign.pretty_term thy t);
wenzelm@18936:     val prt_term_no_vars = prt_term o Logic.unvarify;
wenzelm@4250: 
wenzelm@14794:     fun pretty_classrel (c, []) = prt_cls c
wenzelm@14794:       | pretty_classrel (c, cs) = Pretty.block
wenzelm@14794:           (prt_cls c :: Pretty.str " <" :: Pretty.brk 1 ::
wenzelm@14794:             Pretty.commas (map prt_cls cs));
wenzelm@4250: 
wenzelm@4250:     fun pretty_default S = Pretty.block
wenzelm@14794:       [Pretty.str "default sort:", Pretty.brk 1, prt_sort S];
wenzelm@4250: 
skalberg@15531:     fun pretty_witness NONE = Pretty.str "universal non-emptiness witness: -"
skalberg@15531:       | pretty_witness (SOME (T, S)) = Pretty.block
wenzelm@14794:           [Pretty.str "universal non-emptiness witness:", Pretty.brk 1,
wenzelm@14794:             prt_typ_no_tvars T, Pretty.str " ::", Pretty.brk 1, prt_sort S];
wenzelm@14794: 
wenzelm@14996:     val tfrees = map (fn v => TFree (v, []));
wenzelm@16364:     fun pretty_type syn (t, (Type.LogicalType n, _)) =
skalberg@15531:           if syn then NONE
skalberg@15531:           else SOME (prt_typ (Type (t, tfrees (Term.invent_names [] "'a" n))))
wenzelm@16364:       | pretty_type syn (t, (Type.Abbreviation (vs, U, syn'), _)) =
skalberg@15531:           if syn <> syn' then NONE
skalberg@15531:           else SOME (Pretty.block
wenzelm@14996:             [prt_typ (Type (t, tfrees vs)), Pretty.str " =", Pretty.brk 1, prt_typ U])
wenzelm@16364:       | pretty_type syn (t, (Type.Nonterminal, _)) =
skalberg@15531:           if not syn then NONE
skalberg@15531:           else SOME (prt_typ (Type (t, [])));
wenzelm@4250: 
wenzelm@19482:     val pretty_arities = maps (fn (t, ars) => map (prt_arity t) ars);
skalberg@14223: 
wenzelm@19365:     fun pretty_const (c, ty) = Pretty.block
wenzelm@19365:       [Pretty.str c, Pretty.str " ::", Pretty.brk 1, prt_typ_no_tvars ty];
wenzelm@19365: 
wenzelm@19365:     fun pretty_abbrev (c, (ty, t)) = Pretty.block
wenzelm@19365:       [Pretty.str c, Pretty.str " ::", Pretty.brk 1, prt_typ_no_tvars ty,
wenzelm@19365:         Pretty.str " ==", Pretty.brk 1, prt_term_no_vars t];
wenzelm@4250: 
wenzelm@18936:     fun prt_axm (a, t) = Pretty.block [Pretty.str (a ^ ":"), Pretty.brk 1, prt_term_no_vars t];
wenzelm@8720: 
wenzelm@17704:     val {axioms, defs = _, oracles} = Theory.rep_theory thy;
wenzelm@18061:     val {naming, syn = _, tsig, consts} = Sign.rep_sg thy;
wenzelm@18936:     val {constants, constraints} = Consts.dest consts;
wenzelm@14794:     val {classes, default, types, arities, log_types = _, witness} = Type.rep_tsig tsig;
wenzelm@14996: 
wenzelm@16845:     val clsses = NameSpace.dest_table (apsnd (Symtab.make o Graph.dest) classes);
wenzelm@16845:     val tdecls = NameSpace.dest_table types;
wenzelm@16845:     val arties = NameSpace.dest_table (Sign.type_space thy, arities);
wenzelm@18936:     val cnsts = NameSpace.extern_table constants;
wenzelm@19482:     val log_cnsts = map_filter (fn (c, (ty, NONE)) => SOME (c, ty) | _ => NONE) cnsts;
wenzelm@19482:     val abbrevs = map_filter (fn (c, (ty, SOME t)) => SOME (c, (ty, t)) | _ => NONE) cnsts;
wenzelm@19365:     val cnstrs = NameSpace.extern_table constraints;
wenzelm@16334:     val axms = NameSpace.extern_table axioms;
wenzelm@16334:     val oras = NameSpace.extern_table oracles;
wenzelm@4250:   in
wenzelm@16437:     [Pretty.strs ("names:" :: Context.names_of thy),
wenzelm@16534:       Pretty.strs ("theory data:" :: Context.theory_data_of thy),
wenzelm@16534:       Pretty.strs ("proof data:" :: Context.proof_data_of thy),
wenzelm@16127:       Pretty.strs ["name prefix:", NameSpace.path_of naming],
wenzelm@16364:       Pretty.big_list "classes:" (map pretty_classrel clsses),
wenzelm@8720:       pretty_default default,
wenzelm@14794:       pretty_witness witness,
wenzelm@19482:       Pretty.big_list "syntactic types:" (map_filter (pretty_type true) tdecls),
wenzelm@19482:       Pretty.big_list "logical types:" (map_filter (pretty_type false) tdecls),
wenzelm@16534:       Pretty.big_list "type arities:" (pretty_arities arties),
wenzelm@19365:       Pretty.big_list "logical consts:" (map pretty_const log_cnsts),
wenzelm@19365:       Pretty.big_list "abbreviations:" (map pretty_abbrev abbrevs),
wenzelm@19365:       Pretty.big_list "constraints:" (map pretty_const cnstrs),
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@16534: val show_consts = ref false;  (*true: show consts with types in proof state output*)
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@18980: fun ins_entry (x, y) =
wenzelm@18980:   AList.default (op =) (x, []) #>
wenzelm@18980:   AList.map_entry (op =) x (insert (op =) y);
wenzelm@12081: 
wenzelm@18980: val add_consts = Term.fold_aterms
wenzelm@18980:   (fn Const (c, T) => ins_entry (T, (c, T))
wenzelm@18980:     | _ => I);
wenzelm@11883: 
wenzelm@18980: val add_vars = Term.fold_aterms
wenzelm@18980:   (fn Free (x, T) => ins_entry (T, (x, ~1))
wenzelm@18980:     | Var (xi, T) => ins_entry (T, xi)
wenzelm@18980:     | _ => I);
wenzelm@11883: 
wenzelm@18980: val add_varsT = Term.fold_atyps
wenzelm@18980:   (fn TFree (x, S) => ins_entry (S, (x, ~1))
wenzelm@18980:     | TVar (xi, S) => ins_entry (S, xi)
wenzelm@18980:     | _ => I);
wenzelm@11883: 
wenzelm@16490: fun sort_idxs vs = map (apsnd (sort (prod_ord string_ord int_ord))) vs;
wenzelm@12081: fun sort_cnsts cs = map (apsnd (sort_wrt fst)) cs;
wenzelm@12081: 
wenzelm@18980: fun consts_of t = sort_cnsts (add_consts t []);
wenzelm@18980: fun vars_of t = sort_idxs (add_vars t []);
wenzelm@18980: fun varsT_of t = rev (sort_idxs (Term.fold_types add_varsT t []));
wenzelm@12081: 
wenzelm@12081: in
wenzelm@11883: 
wenzelm@14876: fun pretty_goals_aux pp begin_goal (msg, main) maxgoals state =
wenzelm@12081:   let
wenzelm@12081:     fun prt_atoms prt prtT (X, xs) = Pretty.block
wenzelm@12081:       [Pretty.block (Pretty.commas (map prt xs)), Pretty.str " ::",
wenzelm@12081:         Pretty.brk 1, prtT X];
wenzelm@11883: 
wenzelm@14876:     fun prt_var (x, ~1) = Pretty.term pp (Syntax.free x)
wenzelm@14876:       | prt_var xi = Pretty.term pp (Syntax.var xi);
wenzelm@12081: 
wenzelm@14876:     fun prt_varT (x, ~1) = Pretty.typ pp (TFree (x, []))
wenzelm@14876:       | prt_varT xi = Pretty.typ pp (TVar (xi, []));
wenzelm@12081: 
wenzelm@14876:     val prt_consts = prt_atoms (Pretty.term pp o Const) (Pretty.typ pp);
wenzelm@14876:     val prt_vars = prt_atoms prt_var (Pretty.typ pp);
wenzelm@14876:     val prt_varsT = prt_atoms prt_varT (Pretty.sort pp);
wenzelm@11883: 
wenzelm@11883: 
wenzelm@12081:     fun pretty_list _ _ [] = []
wenzelm@12081:       | pretty_list name prt lst = [Pretty.big_list name (map prt lst)];
wenzelm@11883: 
wenzelm@14876:     fun pretty_subgoal (n, A) = Pretty.blk (0,
wenzelm@14876:      [Pretty.str (begin_goal ^ " " ^ string_of_int n ^ ". "), Pretty.term pp A]);
wenzelm@12081:     fun pretty_subgoals As = map pretty_subgoal (1 upto length As ~~ As);
wenzelm@11883: 
wenzelm@14876:     val pretty_ffpairs = pretty_list "flex-flex pairs:" (pretty_flexpair pp);
wenzelm@11883: 
wenzelm@12081:     val pretty_consts = pretty_list "constants:" prt_consts o consts_of;
wenzelm@12081:     val pretty_vars = pretty_list "variables:" prt_vars o vars_of;
wenzelm@12081:     val pretty_varsT = pretty_list "type variables:" prt_varsT o varsT_of;
wenzelm@11883: 
wenzelm@11883: 
wenzelm@16290:     val {prop, tpairs, ...} = Thm.rep_thm state;
berghofe@13658:     val (As, B) = Logic.strip_horn prop;
wenzelm@12081:     val ngoals = length As;
wenzelm@11883: 
wenzelm@12081:     fun pretty_gs (types, sorts) =
wenzelm@14876:       (if main then [Pretty.term pp B] else []) @
wenzelm@12081:        (if ngoals = 0 then [Pretty.str "No subgoals!"]
wenzelm@12081:         else if ngoals > maxgoals then
skalberg@15570:           pretty_subgoals (Library.take (maxgoals, As)) @
wenzelm@12081:           (if msg then [Pretty.str ("A total of " ^ string_of_int ngoals ^ " subgoals...")]
wenzelm@12081:            else [])
wenzelm@12081:         else pretty_subgoals As) @
wenzelm@12081:       pretty_ffpairs tpairs @
wenzelm@12081:       (if ! show_consts then pretty_consts prop else []) @
wenzelm@12081:       (if types then pretty_vars prop else []) @
wenzelm@12081:       (if sorts then pretty_varsT prop else []);
wenzelm@12081:   in
wenzelm@12081:     setmp show_no_free_types true
skalberg@14178:       (setmp show_types (! show_types orelse ! show_sorts orelse ! show_all_types)
wenzelm@12081:         (setmp show_sorts false pretty_gs))
skalberg@14178:    (! show_types orelse ! show_sorts orelse ! show_all_types, ! show_sorts)
wenzelm@11883:   end;
wenzelm@11883: 
wenzelm@12081: fun pretty_goals_marker bg n th =
wenzelm@16437:   pretty_goals_aux (Sign.pp (Thm.theory_of_thm th)) bg (true, true) n th;
wenzelm@12081: 
wenzelm@12081: val pretty_goals = pretty_goals_marker "";
wenzelm@12418: val print_goals = (Pretty.writeln o Pretty.chunks) oo pretty_goals_marker "";
wenzelm@12081: 
paulson@1591: end;
paulson@1591: 
wenzelm@11883: 
wenzelm@11883: (* print_current_goals *)
wenzelm@11883: 
wenzelm@11883: val current_goals_markers = ref ("", "", "");
wenzelm@11883: 
wenzelm@12418: fun pretty_current_goals n m 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@12418:     (if begin_state = "" then [] else [Pretty.str begin_state]) @
wenzelm@12418:     [Pretty.str ("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@12418:       else ""))] @
wenzelm@12418:     pretty_goals_marker begin_goal m th @
wenzelm@12418:     (if end_state = "" then [] else [Pretty.str end_state])
wenzelm@11883:   end;
wenzelm@11883: 
wenzelm@12418: fun print_current_goals_default n m th =
wenzelm@12418:   Pretty.writeln (Pretty.chunks (pretty_current_goals n m th));
wenzelm@12418: 
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;