src/Pure/Isar/attrib.ML
author wenzelm
Tue May 03 22:27:32 2011 +0200 (2011-05-03)
changeset 42669 04dfffda5671
parent 42616 92715b528e78
child 42808 30870aee8a3f
permissions -rw-r--r--
more conventional naming scheme: names_long, names_short, names_unique;
     1 (*  Title:      Pure/Isar/attrib.ML
     2     Author:     Markus Wenzel, TU Muenchen
     3 
     4 Symbolic representation of attributes -- with name and syntax.
     5 *)
     6 
     7 signature ATTRIB =
     8 sig
     9   type src = Args.src
    10   type binding = binding * src list
    11   val empty_binding: binding
    12   val print_attributes: theory -> unit
    13   val intern: theory -> xstring -> string
    14   val intern_src: theory -> src -> src
    15   val pretty_attribs: Proof.context -> src list -> Pretty.T list
    16   val defined: theory -> string -> bool
    17   val attribute: theory -> src -> attribute
    18   val attribute_i: theory -> src -> attribute
    19   val map_specs: ('a -> 'att) ->
    20     (('c * 'a list) * 'b) list -> (('c * 'att list) * 'b) list
    21   val map_facts: ('a -> 'att) ->
    22     (('c * 'a list) * ('d * 'a list) list) list ->
    23     (('c * 'att list) * ('d * 'att list) list) list
    24   val map_facts_refs: ('a -> 'att) -> ('b -> 'fact) ->
    25     (('c * 'a list) * ('b * 'a list) list) list ->
    26     (('c * 'att list) * ('fact * 'att list) list) list
    27   val eval_thms: Proof.context -> (Facts.ref * src list) list -> thm list
    28   val crude_closure: Proof.context -> src -> src
    29   val setup: Binding.binding -> attribute context_parser -> string -> theory -> theory
    30   val attribute_setup: bstring * Position.T -> Symbol_Pos.text * Position.T -> string ->
    31     theory -> theory
    32   val add_del: attribute -> attribute -> attribute context_parser
    33   val thm_sel: Facts.interval list parser
    34   val thm: thm context_parser
    35   val thms: thm list context_parser
    36   val multi_thm: thm list context_parser
    37   val print_configs: Proof.context -> unit
    38   val internal: (morphism -> attribute) -> src
    39   val config_bool: Binding.binding ->
    40     (Context.generic -> bool) -> bool Config.T * (theory -> theory)
    41   val config_int: Binding.binding ->
    42     (Context.generic -> int) -> int Config.T * (theory -> theory)
    43   val config_real: Binding.binding ->
    44     (Context.generic -> real) -> real Config.T * (theory -> theory)
    45   val config_string: Binding.binding ->
    46     (Context.generic -> string) -> string Config.T * (theory -> theory)
    47   val config_bool_global: Binding.binding ->
    48     (Context.generic -> bool) -> bool Config.T * (theory -> theory)
    49   val config_int_global: Binding.binding ->
    50     (Context.generic -> int) -> int Config.T * (theory -> theory)
    51   val config_real_global: Binding.binding ->
    52     (Context.generic -> real) -> real Config.T * (theory -> theory)
    53   val config_string_global: Binding.binding ->
    54     (Context.generic -> string) -> string Config.T * (theory -> theory)
    55   val setup_config_bool: Binding.binding -> (Context.generic -> bool) -> bool Config.T
    56   val setup_config_int: Binding.binding -> (Context.generic -> int) -> int Config.T
    57   val setup_config_string: Binding.binding -> (Context.generic -> string) -> string Config.T
    58   val setup_config_real: Binding.binding -> (Context.generic -> real) -> real Config.T
    59 end;
    60 
    61 structure Attrib: ATTRIB =
    62 struct
    63 
    64 (* source and bindings *)
    65 
    66 type src = Args.src;
    67 
    68 type binding = binding * src list;
    69 val empty_binding: binding = (Binding.empty, []);
    70 
    71 
    72 
    73 (** named attributes **)
    74 
    75 (* theory data *)
    76 
    77 structure Attributes = Theory_Data
    78 (
    79   type T = ((src -> attribute) * string) Name_Space.table;
    80   val empty : T = Name_Space.empty_table "attribute";
    81   val extend = I;
    82   fun merge data : T = Name_Space.merge_tables data;
    83 );
    84 
    85 fun print_attributes thy =
    86   let
    87     val ctxt = Proof_Context.init_global thy;
    88     val attribs = Attributes.get thy;
    89     fun prt_attr (name, (_, comment)) = Pretty.block
    90       [Pretty.str (name ^ ":"), Pretty.brk 2, Pretty.str comment];
    91   in
    92     [Pretty.big_list "attributes:" (map prt_attr (Name_Space.extern_table ctxt attribs))]
    93     |> Pretty.chunks |> Pretty.writeln
    94   end;
    95 
    96 fun add_attribute name att comment thy = thy
    97   |> Attributes.map
    98     (Name_Space.define (Proof_Context.init_global thy) true (Sign.naming_of thy)
    99       (name, (att, comment)) #> snd);
   100 
   101 
   102 (* name space *)
   103 
   104 val intern = Name_Space.intern o #1 o Attributes.get;
   105 val intern_src = Args.map_name o intern;
   106 
   107 fun extern ctxt = Name_Space.extern ctxt (#1 (Attributes.get (Proof_Context.theory_of ctxt)));
   108 
   109 
   110 (* pretty printing *)
   111 
   112 fun pretty_attribs _ [] = []
   113   | pretty_attribs ctxt srcs =
   114       [Pretty.enum "," "[" "]" (map (Args.pretty_src ctxt o Args.map_name (extern ctxt)) srcs)];
   115 
   116 
   117 (* get attributes *)
   118 
   119 val defined = Symtab.defined o #2 o Attributes.get;
   120 
   121 fun attribute_i thy =
   122   let
   123     val (space, tab) = Attributes.get thy;
   124     fun attr src =
   125       let val ((name, _), pos) = Args.dest_src src in
   126         (case Symtab.lookup tab name of
   127           NONE => error ("Unknown attribute: " ^ quote name ^ Position.str_of pos)
   128         | SOME (att, _) => (Position.report pos (Name_Space.markup space name); att src))
   129       end;
   130   in attr end;
   131 
   132 fun attribute thy = attribute_i thy o intern_src thy;
   133 
   134 
   135 (* attributed declarations *)
   136 
   137 fun map_specs f = map (apfst (apsnd (map f)));
   138 
   139 fun map_facts f = map (apfst (apsnd (map f)) o apsnd (map (apsnd (map f))));
   140 fun map_facts_refs f g = map_facts f #> map (apsnd (map (apfst g)));
   141 
   142 
   143 (* fact expressions *)
   144 
   145 fun eval_thms ctxt srcs = ctxt
   146   |> Proof_Context.note_thmss ""
   147     (map_facts_refs (attribute (Proof_Context.theory_of ctxt)) (Proof_Context.get_fact ctxt)
   148       [((Binding.empty, []), srcs)])
   149   |> fst |> maps snd;
   150 
   151 
   152 (* crude_closure *)
   153 
   154 (*Produce closure without knowing facts in advance! The following
   155   works reasonably well for attribute parsers that do not peek at the
   156   thm structure.*)
   157 
   158 fun crude_closure ctxt src =
   159  (try (fn () => attribute_i (Proof_Context.theory_of ctxt) src
   160     (Context.Proof ctxt, Drule.asm_rl)) ();
   161   Args.closure src);
   162 
   163 
   164 (* attribute setup *)
   165 
   166 fun syntax scan = Args.syntax "attribute" scan;
   167 
   168 fun setup name scan =
   169   add_attribute name
   170     (fn src => fn (ctxt, th) => let val (a, ctxt') = syntax scan src ctxt in a (ctxt', th) end);
   171 
   172 fun attribute_setup name (txt, pos) cmt =
   173   Context.theory_map (ML_Context.expression pos
   174     "val (name, scan, comment): binding * attribute context_parser * string"
   175     "Context.map_theory (Attrib.setup name scan comment)"
   176     (ML_Lex.read Position.none ("(" ^ ML_Syntax.make_binding name ^ ", ") @
   177       ML_Lex.read pos txt @
   178       ML_Lex.read Position.none (", " ^ ML_Syntax.print_string cmt ^ ")")));
   179 
   180 
   181 (* add/del syntax *)
   182 
   183 fun add_del add del = Scan.lift (Args.add >> K add || Args.del >> K del || Scan.succeed add);
   184 
   185 
   186 
   187 (** parsing attributed theorems **)
   188 
   189 val thm_sel = Parse.$$$ "(" |-- Parse.list1
   190  (Parse.nat --| Parse.minus -- Parse.nat >> Facts.FromTo ||
   191   Parse.nat --| Parse.minus >> Facts.From ||
   192   Parse.nat >> Facts.Single) --| Parse.$$$ ")";
   193 
   194 local
   195 
   196 val fact_name = Args.internal_fact >> K "<fact>" || Args.name;
   197 
   198 fun gen_thm pick = Scan.depend (fn context =>
   199   let
   200     val thy = Context.theory_of context;
   201     val get = Context.cases (Global_Theory.get_fact context) Proof_Context.get_fact context;
   202     val get_fact = get o Facts.Fact;
   203     fun get_named pos name = get (Facts.Named ((name, pos), NONE));
   204   in
   205     Parse.$$$ "[" |-- Args.attribs (intern thy) --| Parse.$$$ "]" >> (fn srcs =>
   206       let
   207         val atts = map (attribute_i thy) srcs;
   208         val (context', th') = Library.apply atts (context, Drule.dummy_thm);
   209       in (context', pick "" [th']) end)
   210     ||
   211     (Scan.ahead Args.alt_name -- Args.named_fact get_fact
   212       >> (fn (s, fact) => ("", Facts.Fact s, fact)) ||
   213      Scan.ahead (Parse.position fact_name) :|-- (fn (name, pos) =>
   214       Args.named_fact (get_named pos) -- Scan.option thm_sel
   215         >> (fn (fact, sel) => (name, Facts.Named ((name, pos), sel), fact))))
   216     -- Args.opt_attribs (intern thy) >> (fn ((name, thmref, fact), srcs) =>
   217       let
   218         val ths = Facts.select thmref fact;
   219         val atts = map (attribute_i thy) srcs;
   220         val (context', ths') = Library.foldl_map (Library.apply atts) (context, ths);
   221       in (context', pick name ths') end)
   222   end);
   223 
   224 in
   225 
   226 val thm = gen_thm Facts.the_single;
   227 val multi_thm = gen_thm (K I);
   228 val thms = Scan.repeat multi_thm >> flat;
   229 
   230 end;
   231 
   232 
   233 
   234 (** basic attributes **)
   235 
   236 (* internal *)
   237 
   238 fun internal att = Args.src (("Pure.attribute", [Token.mk_attribute att]), Position.none);
   239 
   240 
   241 (* rule composition *)
   242 
   243 val COMP_att =
   244   Scan.lift (Scan.optional (Args.bracks Parse.nat) 1) -- thm
   245     >> (fn (i, B) => Thm.rule_attribute (fn _ => fn A => Drule.compose_single (A, i, B)));
   246 
   247 val THEN_att =
   248   Scan.lift (Scan.optional (Args.bracks Parse.nat) 1) -- thm
   249     >> (fn (i, B) => Thm.rule_attribute (fn _ => fn A => A RSN (i, B)));
   250 
   251 val OF_att =
   252   thms >> (fn Bs => Thm.rule_attribute (fn _ => fn A => Bs MRS A));
   253 
   254 
   255 (* rename_abs *)
   256 
   257 fun rename_abs x = (Scan.repeat (Args.maybe Args.name) >> (apsnd o Drule.rename_bvars')) x;
   258 
   259 
   260 (* unfold / fold definitions *)
   261 
   262 fun unfolded_syntax rule =
   263   thms >> (fn ths => Thm.rule_attribute (fn context => rule (Context.proof_of context) ths));
   264 
   265 val unfolded = unfolded_syntax Local_Defs.unfold;
   266 val folded = unfolded_syntax Local_Defs.fold;
   267 
   268 
   269 (* rule format *)
   270 
   271 val rule_format = Args.mode "no_asm"
   272   >> (fn true => Object_Logic.rule_format_no_asm | false => Object_Logic.rule_format);
   273 
   274 val elim_format = Thm.rule_attribute (K Tactic.make_elim);
   275 
   276 
   277 (* misc rules *)
   278 
   279 val no_vars = Thm.rule_attribute (fn context => fn th =>
   280   let
   281     val ctxt = Variable.set_body false (Context.proof_of context);
   282     val ((_, [th']), _) = Variable.import true [th] ctxt;
   283   in th' end);
   284 
   285 val eta_long =
   286   Thm.rule_attribute (K (Conv.fconv_rule Drule.eta_long_conversion));
   287 
   288 val rotated = Scan.optional Parse.int 1 >> (fn n => Thm.rule_attribute (K (rotate_prems n)));
   289 
   290 
   291 (* theory setup *)
   292 
   293 val _ = Context.>> (Context.map_theory
   294  (setup (Binding.name "attribute") (Scan.lift Args.internal_attribute >> Morphism.form)
   295     "internal attribute" #>
   296   setup (Binding.name "tagged") (Scan.lift (Args.name -- Args.name) >> Thm.tag) "tagged theorem" #>
   297   setup (Binding.name "untagged") (Scan.lift Args.name >> Thm.untag) "untagged theorem" #>
   298   setup (Binding.name "kind") (Scan.lift Args.name >> Thm.kind) "theorem kind" #>
   299   setup (Binding.name "COMP") COMP_att "direct composition with rules (no lifting)" #>
   300   setup (Binding.name "THEN") THEN_att "resolution with rule" #>
   301   setup (Binding.name "OF") OF_att "rule applied to facts" #>
   302   setup (Binding.name "rename_abs") (Scan.lift rename_abs)
   303     "rename bound variables in abstractions" #>
   304   setup (Binding.name "unfolded") unfolded "unfolded definitions" #>
   305   setup (Binding.name "folded") folded "folded definitions" #>
   306   setup (Binding.name "consumes") (Scan.lift (Scan.optional Parse.nat 1) >> Rule_Cases.consumes)
   307     "number of consumed facts" #>
   308   setup (Binding.name "constraints") (Scan.lift Parse.nat >> Rule_Cases.constraints)
   309     "number of equality constraints" #>
   310   setup (Binding.name "case_names") (Scan.lift (Scan.repeat1 Args.name) >> Rule_Cases.case_names)
   311     "named rule cases" #>
   312   setup (Binding.name "case_conclusion")
   313     (Scan.lift (Args.name -- Scan.repeat Args.name) >> Rule_Cases.case_conclusion)
   314     "named conclusion of rule cases" #>
   315   setup (Binding.name "params")
   316     (Scan.lift (Parse.and_list1 (Scan.repeat Args.name)) >> Rule_Cases.params)
   317     "named rule parameters" #>
   318   setup (Binding.name "standard") (Scan.succeed (Thm.rule_attribute (K Drule.export_without_context)))
   319     "result put into standard form (legacy)" #>
   320   setup (Binding.name "rule_format") rule_format "result put into canonical rule format" #>
   321   setup (Binding.name "elim_format") (Scan.succeed elim_format)
   322     "destruct rule turned into elimination rule format" #>
   323   setup (Binding.name "no_vars") (Scan.succeed no_vars) "frozen schematic vars" #>
   324   setup (Binding.name "eta_long") (Scan.succeed eta_long)
   325     "put theorem into eta long beta normal form" #>
   326   setup (Binding.name "atomize") (Scan.succeed Object_Logic.declare_atomize)
   327     "declaration of atomize rule" #>
   328   setup (Binding.name "rulify") (Scan.succeed Object_Logic.declare_rulify)
   329     "declaration of rulify rule" #>
   330   setup (Binding.name "rotated") (Scan.lift rotated) "rotated theorem premises" #>
   331   setup (Binding.name "defn") (add_del Local_Defs.defn_add Local_Defs.defn_del)
   332     "declaration of definitional transformations" #>
   333   setup (Binding.name "abs_def") (Scan.succeed (Thm.rule_attribute (K Drule.abs_def)))
   334     "abstract over free variables of a definition"));
   335 
   336 
   337 
   338 (** configuration options **)
   339 
   340 (* naming *)
   341 
   342 structure Configs = Theory_Data
   343 (
   344   type T = Config.raw Symtab.table;
   345   val empty = Symtab.empty;
   346   val extend = I;
   347   fun merge data = Symtab.merge (K true) data;
   348 );
   349 
   350 fun print_configs ctxt =
   351   let
   352     val thy = Proof_Context.theory_of ctxt;
   353     fun prt (name, config) =
   354       let val value = Config.get ctxt config in
   355         Pretty.block [Pretty.str (name ^ ": " ^ Config.print_type value ^ " ="), Pretty.brk 1,
   356           Pretty.str (Config.print_value value)]
   357       end;
   358     val configs = Name_Space.extern_table ctxt (#1 (Attributes.get thy), Configs.get thy);
   359   in Pretty.writeln (Pretty.big_list "configuration options" (map prt configs)) end;
   360 
   361 
   362 (* concrete syntax *)
   363 
   364 local
   365 
   366 val equals = Parse.$$$ "=";
   367 
   368 fun scan_value (Config.Bool _) =
   369       equals -- Args.$$$ "false" >> K (Config.Bool false) ||
   370       equals -- Args.$$$ "true" >> K (Config.Bool true) ||
   371       Scan.succeed (Config.Bool true)
   372   | scan_value (Config.Int _) = equals |-- Parse.int >> Config.Int
   373   | scan_value (Config.Real _) = equals |-- Parse.real >> Config.Real
   374   | scan_value (Config.String _) = equals |-- Args.name >> Config.String;
   375 
   376 fun scan_config thy config =
   377   let val config_type = Config.get_global thy config
   378   in scan_value config_type >> (K o Thm.declaration_attribute o K o Config.put_generic config) end;
   379 
   380 fun register binding config thy =
   381   let val name = Sign.full_name thy binding in
   382     thy
   383     |> setup binding (Scan.lift (scan_config thy config) >> Morphism.form) "configuration option"
   384     |> Configs.map (Symtab.update (name, config))
   385   end;
   386 
   387 fun declare make coerce global binding default =
   388   let
   389     val name = Binding.name_of binding;
   390     val config_value = Config.declare_generic {global = global} name (make o default);
   391     val config = coerce config_value;
   392   in (config, register binding config_value) end;
   393 
   394 in
   395 
   396 val config_bool = declare Config.Bool Config.bool false;
   397 val config_int = declare Config.Int Config.int false;
   398 val config_real = declare Config.Real Config.real false;
   399 val config_string = declare Config.String Config.string false;
   400 
   401 val config_bool_global = declare Config.Bool Config.bool true;
   402 val config_int_global = declare Config.Int Config.int true;
   403 val config_real_global = declare Config.Real Config.real true;
   404 val config_string_global = declare Config.String Config.string true;
   405 
   406 fun register_config config = register (Binding.name (Config.name_of config)) config;
   407 
   408 end;
   409 
   410 
   411 (* implicit setup *)
   412 
   413 local
   414 
   415 fun setup_config declare_config binding default =
   416   let
   417     val (config, setup) = declare_config binding default;
   418     val _ = Context.>> (Context.map_theory setup);
   419   in config end;
   420 
   421 in
   422 
   423 val setup_config_bool = setup_config config_bool;
   424 val setup_config_int = setup_config config_int;
   425 val setup_config_string = setup_config config_string;
   426 val setup_config_real = setup_config config_real;
   427 
   428 end;
   429 
   430 
   431 (* theory setup *)
   432 
   433 val _ = Context.>> (Context.map_theory
   434  (register_config Ast.trace_raw #>
   435   register_config Ast.stat_raw #>
   436   register_config Syntax.positions_raw #>
   437   register_config Printer.show_brackets_raw #>
   438   register_config Printer.show_sorts_raw #>
   439   register_config Printer.show_types_raw #>
   440   register_config Printer.show_structs_raw #>
   441   register_config Printer.show_question_marks_raw #>
   442   register_config Syntax.ambiguity_level_raw #>
   443   register_config Syntax_Trans.eta_contract_raw #>
   444   register_config Name_Space.names_long_raw #>
   445   register_config Name_Space.names_short_raw #>
   446   register_config Name_Space.names_unique_raw #>
   447   register_config ML_Context.trace_raw #>
   448   register_config Proof_Context.show_abbrevs_raw #>
   449   register_config Goal_Display.goals_limit_raw #>
   450   register_config Goal_Display.show_main_goal_raw #>
   451   register_config Goal_Display.show_consts_raw #>
   452   register_config Display.show_hyps_raw #>
   453   register_config Display.show_tags_raw #>
   454   register_config Unify.trace_bound_raw #>
   455   register_config Unify.search_bound_raw #>
   456   register_config Unify.trace_simp_raw #>
   457   register_config Unify.trace_types_raw #>
   458   register_config Raw_Simplifier.simp_depth_limit_raw #>
   459   register_config Raw_Simplifier.simp_trace_depth_limit_raw #>
   460   register_config Raw_Simplifier.simp_debug_raw #>
   461   register_config Raw_Simplifier.simp_trace_raw));
   462 
   463 end;