src/Pure/Tools/find_consts.ML
author wenzelm
Sat Mar 20 17:33:11 2010 +0100 (2010-03-20)
changeset 35845 e5980f0ad025
parent 33301 1fe9fc908ec3
child 36950 75b8f26f2f07
permissions -rw-r--r--
renamed varify/unvarify operations to varify_global/unvarify_global to emphasize that these only work in a global situation;
wenzelm@30143
     1
(*  Title:      Pure/Tools/find_consts.ML
kleing@29884
     2
    Author:     Timothy Bourke and Gerwin Klein, NICTA
kleing@29884
     3
wenzelm@30143
     4
Hoogle-like (http://www-users.cs.york.ac.uk/~ndm/hoogle) searching by
wenzelm@30143
     5
type over constants, but matching is not fuzzy.
kleing@29884
     6
*)
kleing@29884
     7
kleing@29884
     8
signature FIND_CONSTS =
kleing@29884
     9
sig
wenzelm@30143
    10
  datatype criterion =
wenzelm@30143
    11
      Strict of string
wenzelm@30143
    12
    | Loose of string
wenzelm@30143
    13
    | Name of string
kleing@29884
    14
  val find_consts : Proof.context -> (bool * criterion) list -> unit
kleing@29884
    15
end;
kleing@29884
    16
wenzelm@33301
    17
structure Find_Consts : FIND_CONSTS =
kleing@29884
    18
struct
kleing@29884
    19
wenzelm@30143
    20
(* search criteria *)
wenzelm@30143
    21
wenzelm@30143
    22
datatype criterion =
wenzelm@30143
    23
    Strict of string
wenzelm@30143
    24
  | Loose of string
wenzelm@30143
    25
  | Name of string;
kleing@29884
    26
wenzelm@31684
    27
wenzelm@30143
    28
(* matching types/consts *)
kleing@29884
    29
wenzelm@30143
    30
fun matches_subtype thy typat =
wenzelm@30143
    31
  let
kleing@29884
    32
    val p = can (fn ty => Sign.typ_match thy (typat, ty) Vartab.empty);
kleing@29884
    33
kleing@29884
    34
    fun fs [] = false
wenzelm@30143
    35
      | fs (t :: ts) = f t orelse fs ts
kleing@29884
    36
kleing@29884
    37
    and f (t as Type (_, ars)) = p t orelse fs ars
kleing@29884
    38
      | f t = p t;
kleing@29884
    39
  in f end;
kleing@29884
    40
wenzelm@30143
    41
fun check_const p (nm, (ty, _)) =
wenzelm@30143
    42
  if p (nm, ty)
wenzelm@30143
    43
  then SOME (Term.size_of_typ ty)
wenzelm@30143
    44
  else NONE;
kleing@29884
    45
wenzelm@30143
    46
fun opt_not f (c as (_, (ty, _))) =
wenzelm@30143
    47
  if is_some (f c)
wenzelm@30143
    48
  then NONE else SOME (Term.size_of_typ ty);
kleing@29884
    49
Timothy@30206
    50
fun filter_const _ NONE = NONE
Timothy@30206
    51
  | filter_const f (SOME (c, r)) =
wenzelm@31684
    52
      (case f c of
wenzelm@31684
    53
        NONE => NONE
wenzelm@31684
    54
      | SOME i => SOME (c, Int.min (r, i)));
wenzelm@30143
    55
wenzelm@30143
    56
wenzelm@30143
    57
(* pretty results *)
kleing@29895
    58
kleing@29895
    59
fun pretty_criterion (b, c) =
kleing@29895
    60
  let
kleing@29895
    61
    fun prfx s = if b then s else "-" ^ s;
kleing@29895
    62
  in
kleing@29895
    63
    (case c of
kleing@29895
    64
      Strict pat => Pretty.str (prfx "strict: " ^ quote pat)
kleing@29895
    65
    | Loose pat => Pretty.str (prfx (quote pat))
kleing@29895
    66
    | Name name => Pretty.str (prfx "name: " ^ quote name))
kleing@29895
    67
  end;
kleing@29895
    68
wenzelm@30143
    69
fun pretty_const ctxt (nm, ty) =
wenzelm@30143
    70
  let
wenzelm@35845
    71
    val ty' = Logic.unvarifyT_global ty;
kleing@29895
    72
  in
wenzelm@30143
    73
    Pretty.block
wenzelm@30143
    74
     [Pretty.quote (Pretty.str nm), Pretty.fbrk,
wenzelm@30143
    75
      Pretty.str "::", Pretty.brk 1,
wenzelm@30143
    76
      Pretty.quote (Syntax.pretty_typ ctxt ty')]
kleing@29895
    77
  end;
kleing@29895
    78
wenzelm@31684
    79
wenzelm@30143
    80
(* find_consts *)
wenzelm@30143
    81
wenzelm@30143
    82
fun find_consts ctxt raw_criteria =
wenzelm@30143
    83
  let
kleing@29895
    84
    val start = start_timing ();
kleing@29895
    85
kleing@29884
    86
    val thy = ProofContext.theory_of ctxt;
kleing@29884
    87
    val low_ranking = 10000;
kleing@29884
    88
wenzelm@33158
    89
    fun user_visible consts (nm, _) =
wenzelm@33158
    90
      if Consts.is_concealed consts nm then NONE else SOME low_ranking;
Timothy@30206
    91
Timothy@30207
    92
    fun make_pattern crit =
Timothy@30207
    93
      let
Timothy@30207
    94
        val raw_T = Syntax.parse_typ ctxt crit;
wenzelm@31684
    95
        val t =
wenzelm@31684
    96
          Syntax.check_term
wenzelm@31684
    97
            (ProofContext.set_mode ProofContext.mode_pattern ctxt)
wenzelm@31684
    98
            (Term.dummy_pattern raw_T);
Timothy@30207
    99
      in Term.type_of t end;
kleing@29884
   100
kleing@29884
   101
    fun make_match (Strict arg) =
kleing@29884
   102
          let val qty = make_pattern arg; in
wenzelm@30143
   103
            fn (_, (ty, _)) =>
wenzelm@30143
   104
              let
kleing@29884
   105
                val tye = Sign.typ_match thy (qty, ty) Vartab.empty;
wenzelm@31684
   106
                val sub_size =
wenzelm@31684
   107
                  Vartab.fold (fn (_, (_, t)) => fn n => Term.size_of_typ t + n) tye 0;
wenzelm@32790
   108
              in SOME sub_size end handle Type.TYPE_MATCH => NONE
kleing@29884
   109
          end
kleing@29884
   110
      | make_match (Loose arg) =
kleing@29884
   111
          check_const (matches_subtype thy (make_pattern arg) o snd)
kleing@29884
   112
      | make_match (Name arg) = check_const (match_string arg o fst);
kleing@29884
   113
kleing@29884
   114
    fun make_criterion (b, crit) = (if b then I else opt_not) (make_match crit);
Timothy@30206
   115
    val criteria = map make_criterion raw_criteria;
kleing@29884
   116
Timothy@30206
   117
    val consts = Sign.consts_of thy;
wenzelm@31684
   118
    val (_, consts_tab) = #constants (Consts.dest consts);
wenzelm@31684
   119
    fun eval_entry c =
wenzelm@33158
   120
      fold filter_const (user_visible consts :: criteria)
wenzelm@31684
   121
        (SOME (c, low_ranking));
kleing@29884
   122
wenzelm@30143
   123
    val matches =
Timothy@30206
   124
      Symtab.fold (cons o eval_entry) consts_tab []
wenzelm@30143
   125
      |> map_filter I
wenzelm@30143
   126
      |> sort (rev_order o int_ord o pairself snd)
wenzelm@31684
   127
      |> map (apsnd fst o fst);
kleing@29895
   128
wenzelm@31687
   129
    val end_msg = " in " ^ Time.toString (#cpu (end_timing start)) ^ " secs";
kleing@29884
   130
  in
kleing@29895
   131
    Pretty.big_list "searched for:" (map pretty_criterion raw_criteria)
kleing@29895
   132
      :: Pretty.str ""
wenzelm@31684
   133
      :: (Pretty.str o implode)
kleing@29895
   134
           (if null matches
kleing@29895
   135
            then ["nothing found", end_msg]
kleing@29895
   136
            else ["found ", (string_of_int o length) matches,
kleing@29895
   137
                  " constants", end_msg, ":"])
kleing@29895
   138
      :: Pretty.str ""
kleing@29895
   139
      :: map (pretty_const ctxt) matches
kleing@29895
   140
    |> Pretty.chunks
kleing@29884
   141
    |> Pretty.writeln
Timothy@30206
   142
  end;
kleing@29884
   143
wenzelm@30142
   144
wenzelm@30143
   145
(* command syntax *)
wenzelm@30142
   146
wenzelm@30142
   147
fun find_consts_cmd spec =
wenzelm@30142
   148
  Toplevel.unknown_theory o Toplevel.keep (fn state =>
wenzelm@30142
   149
    find_consts (Proof.context_of (Toplevel.enter_proof_body state)) spec);
wenzelm@30142
   150
wenzelm@30142
   151
local
wenzelm@30142
   152
wenzelm@30142
   153
structure P = OuterParse and K = OuterKeyword;
wenzelm@30142
   154
wenzelm@30142
   155
val criterion =
wenzelm@30142
   156
  P.reserved "strict" |-- P.!!! (P.$$$ ":" |-- P.xname) >> Strict ||
wenzelm@30142
   157
  P.reserved "name" |-- P.!!! (P.$$$ ":" |-- P.xname) >> Name ||
wenzelm@30142
   158
  P.xname >> Loose;
wenzelm@30142
   159
wenzelm@30142
   160
in
wenzelm@30142
   161
wenzelm@30142
   162
val _ =
wenzelm@30142
   163
  OuterSyntax.improper_command "find_consts" "search constants by type pattern" K.diag
wenzelm@33301
   164
    (Scan.repeat ((Scan.option P.minus >> is_none) -- criterion)
wenzelm@30142
   165
      >> (Toplevel.no_timing oo find_consts_cmd));
wenzelm@30142
   166
kleing@29884
   167
end;
kleing@29884
   168
wenzelm@30142
   169
end;
wenzelm@30142
   170