src/Pure/Isar/isar_cmd.ML
author wenzelm
Sat Mar 01 22:46:31 2014 +0100 (2014-03-01 ago)
changeset 55828 42ac3cfb89f6
parent 53171 a5e54d4d9081
child 56005 4f4fc80b0613
permissions -rw-r--r--
clarified language markup: added "delimited" property;
type Symbol_Pos.source preserves information about delimited outer tokens (e.g string, cartouche);
observe Completion.Language_Context only for delimited languages, which is important to complete keywords after undelimited inner tokens, e.g. "lemma A pro";
     1 (*  Title:      Pure/Isar/isar_cmd.ML
     2     Author:     Markus Wenzel, TU Muenchen
     3 
     4 Miscellaneous Isar commands.
     5 *)
     6 
     7 signature ISAR_CMD =
     8 sig
     9   val global_setup: Symbol_Pos.source -> theory -> theory
    10   val local_setup: Symbol_Pos.source -> Proof.context -> Proof.context
    11   val parse_ast_translation: Symbol_Pos.source -> theory -> theory
    12   val parse_translation: Symbol_Pos.source -> theory -> theory
    13   val print_translation: Symbol_Pos.source -> theory -> theory
    14   val typed_print_translation: Symbol_Pos.source -> theory -> theory
    15   val print_ast_translation: Symbol_Pos.source -> theory -> theory
    16   val translations: (xstring * string) Syntax.trrule list -> theory -> theory
    17   val no_translations: (xstring * string) Syntax.trrule list -> theory -> theory
    18   val oracle: bstring * Position.T -> Symbol_Pos.source -> theory -> theory
    19   val add_defs: (bool * bool) * ((binding * string) * Attrib.src list) list -> theory -> theory
    20   val declaration: {syntax: bool, pervasive: bool} ->
    21     Symbol_Pos.source -> local_theory -> local_theory
    22   val simproc_setup: string * Position.T -> string list -> Symbol_Pos.source ->
    23     string list -> local_theory -> local_theory
    24   val hide_class: bool -> xstring list -> theory -> theory
    25   val hide_type: bool -> xstring list -> theory -> theory
    26   val hide_const: bool -> xstring list -> theory -> theory
    27   val hide_fact: bool -> xstring list -> theory -> theory
    28   val have: (Attrib.binding * (string * string list) list) list -> bool -> Proof.state -> Proof.state
    29   val hence: (Attrib.binding * (string * string list) list) list -> bool -> Proof.state -> Proof.state
    30   val show: (Attrib.binding * (string * string list) list) list -> bool -> Proof.state -> Proof.state
    31   val thus: (Attrib.binding * (string * string list) list) list -> bool -> Proof.state -> Proof.state
    32   val qed: Method.text_range option -> Toplevel.transition -> Toplevel.transition
    33   val terminal_proof: Method.text_range * Method.text_range option ->
    34     Toplevel.transition -> Toplevel.transition
    35   val default_proof: Toplevel.transition -> Toplevel.transition
    36   val immediate_proof: Toplevel.transition -> Toplevel.transition
    37   val done_proof: Toplevel.transition -> Toplevel.transition
    38   val skip_proof: Toplevel.transition -> Toplevel.transition
    39   val ml_diag: bool -> Symbol_Pos.source -> Toplevel.transition -> Toplevel.transition
    40   val diag_state: Proof.context -> Toplevel.state
    41   val diag_goal: Proof.context -> {context: Proof.context, facts: thm list, goal: thm}
    42   val print_theorems: bool -> Toplevel.transition -> Toplevel.transition
    43   val thy_deps: Toplevel.transition -> Toplevel.transition
    44   val locale_deps: Toplevel.transition -> Toplevel.transition
    45   val class_deps: Toplevel.transition -> Toplevel.transition
    46   val thm_deps: (Facts.ref * Attrib.src list) list -> Toplevel.transition -> Toplevel.transition
    47   val unused_thms: (string list * string list option) option ->
    48     Toplevel.transition -> Toplevel.transition
    49   val print_stmts: string list * (Facts.ref * Attrib.src list) list
    50     -> Toplevel.transition -> Toplevel.transition
    51   val print_thms: string list * (Facts.ref * Attrib.src list) list
    52     -> Toplevel.transition -> Toplevel.transition
    53   val print_prfs: bool -> string list * (Facts.ref * Attrib.src list) list option
    54     -> Toplevel.transition -> Toplevel.transition
    55   val print_prop: (string list * string) -> Toplevel.transition -> Toplevel.transition
    56   val print_term: (string list * string) -> Toplevel.transition -> Toplevel.transition
    57   val print_type: (string list * (string * string option)) ->
    58     Toplevel.transition -> Toplevel.transition
    59   val header_markup: Symbol_Pos.source -> Toplevel.transition -> Toplevel.transition
    60   val local_theory_markup: (xstring * Position.T) option * (Symbol_Pos.source) ->
    61     Toplevel.transition -> Toplevel.transition
    62   val proof_markup: Symbol_Pos.source -> Toplevel.transition -> Toplevel.transition
    63 end;
    64 
    65 structure Isar_Cmd: ISAR_CMD =
    66 struct
    67 
    68 
    69 (** theory declarations **)
    70 
    71 (* generic setup *)
    72 
    73 fun global_setup source =
    74   ML_Lex.read_source source
    75   |> ML_Context.expression (#pos source) "val setup: theory -> theory" "Context.map_theory setup"
    76   |> Context.theory_map;
    77 
    78 fun local_setup source =
    79   ML_Lex.read_source source
    80   |> ML_Context.expression (#pos source) "val setup: local_theory -> local_theory" "Context.map_proof setup"
    81   |> Context.proof_map;
    82 
    83 
    84 (* translation functions *)
    85 
    86 fun parse_ast_translation source =
    87   ML_Lex.read_source source
    88   |> ML_Context.expression (#pos source)
    89     "val parse_ast_translation: (string * (Proof.context -> Ast.ast list -> Ast.ast)) list"
    90     "Context.map_theory (Sign.parse_ast_translation parse_ast_translation)"
    91   |> Context.theory_map;
    92 
    93 fun parse_translation source =
    94   ML_Lex.read_source source
    95   |> ML_Context.expression (#pos source)
    96     "val parse_translation: (string * (Proof.context -> term list -> term)) list"
    97     "Context.map_theory (Sign.parse_translation parse_translation)"
    98   |> Context.theory_map;
    99 
   100 fun print_translation source =
   101   ML_Lex.read_source source
   102   |> ML_Context.expression (#pos source)
   103     "val print_translation: (string * (Proof.context -> term list -> term)) list"
   104     "Context.map_theory (Sign.print_translation print_translation)"
   105   |> Context.theory_map;
   106 
   107 fun typed_print_translation source =
   108   ML_Lex.read_source source
   109   |> ML_Context.expression (#pos source)
   110     "val typed_print_translation: (string * (Proof.context -> typ -> term list -> term)) list"
   111     "Context.map_theory (Sign.typed_print_translation typed_print_translation)"
   112   |> Context.theory_map;
   113 
   114 fun print_ast_translation source =
   115   ML_Lex.read_source source
   116   |> ML_Context.expression (#pos source)
   117     "val print_ast_translation: (string * (Proof.context -> Ast.ast list -> Ast.ast)) list"
   118     "Context.map_theory (Sign.print_ast_translation print_ast_translation)"
   119   |> Context.theory_map;
   120 
   121 
   122 (* translation rules *)
   123 
   124 fun read_trrules thy raw_rules =
   125   let
   126     val ctxt = Proof_Context.init_global thy;
   127   in
   128     raw_rules |> map (Syntax.map_trrule (fn (r, s) =>
   129       Syntax_Phases.parse_ast_pattern ctxt (Proof_Context.intern_type ctxt r, s)))
   130   end;
   131 
   132 fun translations args thy = Sign.add_trrules (read_trrules thy args) thy;
   133 fun no_translations args thy = Sign.del_trrules (read_trrules thy args) thy;
   134 
   135 
   136 (* oracles *)
   137 
   138 fun oracle (name, pos) source =
   139   let
   140     val body = ML_Lex.read_source source;
   141     val ants =
   142       ML_Lex.read Position.none
   143        ("local\n\
   144         \  val binding = " ^ ML_Syntax.make_binding (name, pos) ^ ";\n\
   145         \  val body = ") @ body @ ML_Lex.read Position.none (";\n\
   146         \in\n\
   147         \  val " ^ name ^
   148         " = snd (Context.>>> (Context.map_theory_result (Thm.add_oracle (binding, body))));\n\
   149         \end;\n");
   150   in Context.theory_map (ML_Context.exec (fn () => ML_Context.eval false (#pos source) ants)) end;
   151 
   152 
   153 (* old-style defs *)
   154 
   155 fun add_defs ((unchecked, overloaded), args) thy =
   156   thy |>
   157     (if unchecked then Global_Theory.add_defs_unchecked_cmd else Global_Theory.add_defs_cmd)
   158       overloaded
   159       (map (fn ((b, ax), srcs) => ((b, ax), map (Attrib.attribute_cmd_global thy) srcs)) args)
   160   |> snd;
   161 
   162 
   163 (* declarations *)
   164 
   165 fun declaration {syntax, pervasive} source =
   166   ML_Lex.read_source source
   167   |> ML_Context.expression (#pos source)
   168     "val declaration: Morphism.declaration"
   169     ("Context.map_proof (Local_Theory.declaration {syntax = " ^ Bool.toString syntax ^ ", \
   170       \pervasive = " ^ Bool.toString pervasive ^ "} declaration)")
   171   |> Context.proof_map;
   172 
   173 
   174 (* simprocs *)
   175 
   176 fun simproc_setup name lhss source identifier =
   177   ML_Lex.read_source source
   178   |> ML_Context.expression (#pos source)
   179     "val proc: Morphism.morphism -> Proof.context -> cterm -> thm option"
   180     ("Context.map_proof (Simplifier.def_simproc_cmd {name = " ^ ML_Syntax.make_binding name ^ ", \
   181       \lhss = " ^ ML_Syntax.print_strings lhss ^ ", proc = proc, \
   182       \identifier = Library.maps ML_Context.thms " ^ ML_Syntax.print_strings identifier ^ "})")
   183   |> Context.proof_map;
   184 
   185 
   186 (* hide names *)
   187 
   188 fun hide_names intern check hide fully xnames thy =
   189   let
   190     val names = map (intern thy) xnames;
   191     val bads = filter_out (check thy) names;
   192   in
   193     if null bads then fold (hide fully) names thy
   194     else error ("Attempt to hide undeclared item(s): " ^ commas_quote bads)
   195   end;
   196 
   197 val hide_class = hide_names Sign.intern_class (can o Sign.certify_class) Sign.hide_class;
   198 val hide_type = hide_names Sign.intern_type Sign.declared_tyname Sign.hide_type;
   199 val hide_const = hide_names Sign.intern_const Sign.declared_const Sign.hide_const;
   200 val hide_fact =
   201   hide_names Global_Theory.intern_fact Global_Theory.defined_fact Global_Theory.hide_fact;
   202 
   203 
   204 (* goals *)
   205 
   206 fun goal opt_chain goal stmt int =
   207   opt_chain #> goal NONE (K I) stmt int;
   208 
   209 val have = goal I Proof.have_cmd;
   210 val hence = goal Proof.chain Proof.have_cmd;
   211 val show = goal I Proof.show_cmd;
   212 val thus = goal Proof.chain Proof.show_cmd;
   213 
   214 
   215 (* local endings *)
   216 
   217 fun local_qed m = Toplevel.proof (Proof.local_qed (m, true));
   218 val local_terminal_proof = Toplevel.proof' o Proof.local_future_terminal_proof;
   219 val local_default_proof = Toplevel.proof Proof.local_default_proof;
   220 val local_immediate_proof = Toplevel.proof Proof.local_immediate_proof;
   221 val local_done_proof = Toplevel.proof Proof.local_done_proof;
   222 val local_skip_proof = Toplevel.proof' Proof.local_skip_proof;
   223 
   224 val skip_local_qed = Toplevel.skip_proof (fn i => if i > 1 then i - 1 else raise Toplevel.UNDEF);
   225 
   226 
   227 (* global endings *)
   228 
   229 fun global_qed m = Toplevel.end_proof (K (Proof.global_qed (m, true)));
   230 val global_terminal_proof = Toplevel.end_proof o Proof.global_future_terminal_proof;
   231 val global_default_proof = Toplevel.end_proof (K Proof.global_default_proof);
   232 val global_immediate_proof = Toplevel.end_proof (K Proof.global_immediate_proof);
   233 val global_skip_proof = Toplevel.end_proof Proof.global_skip_proof;
   234 val global_done_proof = Toplevel.end_proof (K Proof.global_done_proof);
   235 
   236 val skip_global_qed = Toplevel.skip_proof_to_theory (fn n => n = 1);
   237 
   238 
   239 (* common endings *)
   240 
   241 fun qed m = local_qed m o global_qed m o skip_local_qed o skip_global_qed;
   242 fun terminal_proof m = local_terminal_proof m o global_terminal_proof m;
   243 val default_proof = local_default_proof o global_default_proof;
   244 val immediate_proof = local_immediate_proof o global_immediate_proof;
   245 val done_proof = local_done_proof o global_done_proof;
   246 val skip_proof = local_skip_proof o global_skip_proof;
   247 
   248 
   249 (* diagnostic ML evaluation *)
   250 
   251 structure Diag_State = Proof_Data
   252 (
   253   type T = Toplevel.state;
   254   fun init _ = Toplevel.toplevel;
   255 );
   256 
   257 fun ml_diag verbose source = Toplevel.keep (fn state =>
   258   let val opt_ctxt =
   259     try Toplevel.generic_theory_of state
   260     |> Option.map (Context.proof_of #> Diag_State.put state)
   261   in ML_Context.eval_source_in opt_ctxt verbose source end);
   262 
   263 val diag_state = Diag_State.get;
   264 
   265 fun diag_goal ctxt =
   266   Proof.goal (Toplevel.proof_of (diag_state ctxt))
   267     handle Toplevel.UNDEF => error "No goal present";
   268 
   269 val _ = Theory.setup
   270   (ML_Antiquote.value (Binding.qualify true "Isar" (Binding.name "state"))
   271     (Scan.succeed "Isar_Cmd.diag_state ML_context") #>
   272    ML_Antiquote.value (Binding.qualify true "Isar" (Binding.name "goal"))
   273     (Scan.succeed "Isar_Cmd.diag_goal ML_context"));
   274 
   275 
   276 (* print theorems *)
   277 
   278 val print_theorems_proof =
   279   Toplevel.keep (Proof_Context.print_lthms o Proof.context_of o Toplevel.proof_of);
   280 
   281 fun print_theorems_theory verbose = Toplevel.keep (fn state =>
   282   Toplevel.theory_of state |>
   283   (case Toplevel.previous_context_of state of
   284     SOME prev => Proof_Display.print_theorems_diff verbose (Proof_Context.theory_of prev)
   285   | NONE => Proof_Display.print_theorems verbose));
   286 
   287 fun print_theorems verbose =
   288   Toplevel.unknown_context o print_theorems_theory verbose o print_theorems_proof;
   289 
   290 
   291 (* display dependencies *)
   292 
   293 val thy_deps = Toplevel.unknown_theory o Toplevel.keep (fn state =>
   294   let
   295     val thy = Toplevel.theory_of state;
   296     val thy_session = Present.session_name thy;
   297 
   298     val gr = rev (Theory.nodes_of thy) |> map (fn node =>
   299       let
   300         val name = Context.theory_name node;
   301         val parents = map Context.theory_name (Theory.parents_of node);
   302         val session = Present.session_name node;
   303         val unfold = (session = thy_session);
   304       in
   305        {name = name, ID = name, parents = parents, dir = session,
   306         unfold = unfold, path = "", content = []}
   307       end);
   308   in Graph_Display.display_graph gr end);
   309 
   310 val locale_deps = Toplevel.unknown_theory o Toplevel.keep (fn state =>
   311   let
   312     val thy = Toplevel.theory_of state;
   313     val gr = Locale.pretty_locale_deps thy |> map (fn {name, parents, body} =>
   314      {name = Locale.extern thy name, ID = name, parents = parents,
   315       dir = "", unfold = true, path = "", content = [body]});
   316   in Graph_Display.display_graph gr end);
   317 
   318 val class_deps = Toplevel.unknown_theory o Toplevel.keep (fn state =>
   319   let
   320     val ctxt = Toplevel.context_of state;
   321     val {classes = (space, algebra), ...} = Type.rep_tsig (Proof_Context.tsig_of ctxt);
   322     val classes = Sorts.classes_of algebra;
   323     fun entry (c, (i, (_, cs))) =
   324       (i, {name = Name_Space.extern ctxt space c, ID = c, parents = Graph.Keys.dest cs,
   325             dir = "", unfold = true, path = "", content = []});
   326     val gr =
   327       Graph.fold (cons o entry) classes []
   328       |> sort (int_ord o pairself #1) |> map #2;
   329   in Graph_Display.display_graph gr end);
   330 
   331 fun thm_deps args = Toplevel.unknown_theory o Toplevel.keep (fn state =>
   332   Thm_Deps.thm_deps (Toplevel.theory_of state)
   333     (Attrib.eval_thms (Toplevel.context_of state) args));
   334 
   335 
   336 (* find unused theorems *)
   337 
   338 fun unused_thms opt_range = Toplevel.keep (fn state =>
   339   let
   340     val thy = Toplevel.theory_of state;
   341     val ctxt = Toplevel.context_of state;
   342     fun pretty_thm (a, th) = Proof_Context.pretty_fact ctxt (a, [th]);
   343     val get_theory = Context.get_theory thy;
   344   in
   345     Thm_Deps.unused_thms
   346       (case opt_range of
   347         NONE => (Theory.parents_of thy, [thy])
   348       | SOME (xs, NONE) => (map get_theory xs, [thy])
   349       | SOME (xs, SOME ys) => (map get_theory xs, map get_theory ys))
   350     |> map pretty_thm |> Pretty.chunks |> Pretty.writeln
   351   end);
   352 
   353 
   354 (* print theorems, terms, types etc. *)
   355 
   356 local
   357 
   358 fun string_of_stmts ctxt args =
   359   Attrib.eval_thms ctxt args
   360   |> map (Element.pretty_statement ctxt Thm.theoremK)
   361   |> Pretty.chunks2 |> Pretty.string_of;
   362 
   363 fun string_of_thms ctxt args =
   364   Pretty.string_of (Proof_Context.pretty_fact ctxt ("", Attrib.eval_thms ctxt args));
   365 
   366 fun string_of_prfs full state arg =
   367   Pretty.string_of
   368     (case arg of
   369       NONE =>
   370         let
   371           val {context = ctxt, goal = thm} = Proof.simple_goal (Toplevel.proof_of state);
   372           val thy = Proof_Context.theory_of ctxt;
   373           val prf = Thm.proof_of thm;
   374           val prop = Thm.full_prop_of thm;
   375           val prf' = Proofterm.rewrite_proof_notypes ([], []) prf;
   376         in
   377           Proof_Syntax.pretty_proof ctxt
   378             (if full then Reconstruct.reconstruct_proof thy prop prf' else prf')
   379         end
   380     | SOME srcs =>
   381         let val ctxt = Toplevel.context_of state
   382         in map (Proof_Syntax.pretty_proof_of ctxt full) (Attrib.eval_thms ctxt srcs) end
   383         |> Pretty.chunks);
   384 
   385 fun string_of_prop ctxt s =
   386   let
   387     val prop = Syntax.read_prop ctxt s;
   388     val ctxt' = Variable.auto_fixes prop ctxt;
   389   in Pretty.string_of (Pretty.quote (Syntax.pretty_term ctxt' prop)) end;
   390 
   391 fun string_of_term ctxt s =
   392   let
   393     val t = Syntax.read_term ctxt s;
   394     val T = Term.type_of t;
   395     val ctxt' = Variable.auto_fixes t ctxt;
   396   in
   397     Pretty.string_of
   398       (Pretty.block [Pretty.quote (Syntax.pretty_term ctxt' t), Pretty.fbrk,
   399         Pretty.str "::", Pretty.brk 1, Pretty.quote (Syntax.pretty_typ ctxt' T)])
   400   end;
   401 
   402 fun string_of_type ctxt (s, NONE) =
   403       let val T = Syntax.read_typ ctxt s
   404       in Pretty.string_of (Pretty.quote (Syntax.pretty_typ ctxt T)) end
   405   | string_of_type ctxt (s1, SOME s2) =
   406       let
   407         val ctxt' = Config.put show_sorts true ctxt;
   408         val raw_T = Syntax.parse_typ ctxt' s1;
   409         val S = Syntax.read_sort ctxt' s2;
   410         val T =
   411           Syntax.check_term ctxt'
   412             (Logic.mk_type raw_T |> Type.constraint (Term.itselfT (Type_Infer.anyT S)))
   413           |> Logic.dest_type;
   414       in Pretty.string_of (Pretty.quote (Syntax.pretty_typ ctxt' T)) end;
   415 
   416 fun print_item string_of (modes, arg) = Toplevel.keep (fn state =>
   417   Print_Mode.with_modes modes (fn () => writeln (string_of state arg)) ());
   418 
   419 in
   420 
   421 val print_stmts = print_item (string_of_stmts o Toplevel.context_of);
   422 val print_thms = print_item (string_of_thms o Toplevel.context_of);
   423 val print_prfs = print_item o string_of_prfs;
   424 val print_prop = print_item (string_of_prop o Toplevel.context_of);
   425 val print_term = print_item (string_of_term o Toplevel.context_of);
   426 val print_type = print_item (string_of_type o Toplevel.context_of);
   427 
   428 end;
   429 
   430 
   431 (* markup commands *)
   432 
   433 fun header_markup txt = Toplevel.keep (fn state =>
   434   if Toplevel.is_toplevel state then Thy_Output.check_text txt state
   435   else raise Toplevel.UNDEF);
   436 
   437 fun local_theory_markup (loc, txt) = Toplevel.present_local_theory loc (Thy_Output.check_text txt);
   438 val proof_markup = Toplevel.present_proof o Thy_Output.check_text;
   439 
   440 end;