src/Pure/config.ML
author wenzelm
Fri, 27 Aug 2010 17:02:19 +0200
changeset 38804 99cc7e748ab4
parent 36787 f60e4dd6d76f
child 39116 f14735a88886
permissions -rw-r--r--
tuned printed type names, according to ML;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
24114
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
     1
(*  Title:      Pure/config.ML
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
     2
    Author:     Makarius
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
     3
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
     4
Configuration options as values within the local context.
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
     5
*)
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
     6
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
     7
signature CONFIG =
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
     8
sig
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
     9
  datatype value = Bool of bool | Int of int | String of string
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    10
  val print_value: value -> string
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    11
  val print_type: value -> string
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    12
  type 'a T
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    13
  val bool: value T -> bool T
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    14
  val int: value T -> int T
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    15
  val string: value T -> string T
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    16
  val get: Proof.context -> 'a T -> 'a
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    17
  val map: 'a T -> ('a -> 'a) -> Proof.context -> Proof.context
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    18
  val put: 'a T -> 'a -> Proof.context -> Proof.context
36787
f60e4dd6d76f renamed Config.get_thy to Config.get_global etc. to indicate that this is not the real thing;
wenzelm
parents: 36002
diff changeset
    19
  val get_global: theory -> 'a T -> 'a
f60e4dd6d76f renamed Config.get_thy to Config.get_global etc. to indicate that this is not the real thing;
wenzelm
parents: 36002
diff changeset
    20
  val map_global: 'a T -> ('a -> 'a) -> theory -> theory
f60e4dd6d76f renamed Config.get_thy to Config.get_global etc. to indicate that this is not the real thing;
wenzelm
parents: 36002
diff changeset
    21
  val put_global: 'a T -> 'a -> theory -> theory
24114
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    22
  val get_generic: Context.generic -> 'a T -> 'a
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    23
  val map_generic: 'a T -> ('a -> 'a) -> Context.generic -> Context.generic
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    24
  val put_generic: 'a T -> 'a -> Context.generic -> Context.generic
36002
f4f343500249 pass raw Context.generic, to avoid wasteful Context.proof_of -- Config.get_thy is often used in performance critical spots like unify.ML;
wenzelm
parents: 36000
diff changeset
    25
  val declare: bool -> string -> (Context.generic -> value) -> value T
24125
454a0c895735 added name_of;
wenzelm
parents: 24114
diff changeset
    26
  val name_of: 'a T -> string
24114
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    27
end;
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    28
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    29
structure Config: CONFIG =
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    30
struct
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    31
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    32
(* simple values *)
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    33
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    34
datatype value =
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    35
  Bool of bool |
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    36
  Int of int |
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    37
  String of string;
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    38
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    39
fun print_value (Bool true) = "true"
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    40
  | print_value (Bool false) = "false"
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    41
  | print_value (Int i) = signed_string_of_int i
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    42
  | print_value (String s) = quote s;
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    43
38804
99cc7e748ab4 tuned printed type names, according to ML;
wenzelm
parents: 36787
diff changeset
    44
fun print_type (Bool _) = "bool"
99cc7e748ab4 tuned printed type names, according to ML;
wenzelm
parents: 36787
diff changeset
    45
  | print_type (Int _) = "int"
24114
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    46
  | print_type (String _) = "string";
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    47
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    48
fun same_type (Bool _) (Bool _) = true
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    49
  | same_type (Int _) (Int _) = true
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    50
  | same_type (String _) (String _) = true
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    51
  | same_type _ _ = false;
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    52
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    53
fun type_check name f value =
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    54
  let
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    55
    val value' = f value;
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    56
    val _ = same_type value value' orelse
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    57
      error ("Ill-typed configuration option " ^ quote name ^ ": " ^
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    58
        print_type value ^ " expected,\nbut " ^ print_type value' ^ " was found");
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    59
  in value' end;
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    60
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    61
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    62
(* abstract configuration options *)
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    63
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    64
datatype 'a T = Config of
24125
454a0c895735 added name_of;
wenzelm
parents: 24114
diff changeset
    65
 {name: string,
454a0c895735 added name_of;
wenzelm
parents: 24114
diff changeset
    66
  get_value: Context.generic -> 'a,
24114
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    67
  map_value: ('a -> 'a) -> Context.generic -> Context.generic};
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    68
24125
454a0c895735 added name_of;
wenzelm
parents: 24114
diff changeset
    69
fun coerce make dest (Config {name, get_value, map_value}) = Config
454a0c895735 added name_of;
wenzelm
parents: 24114
diff changeset
    70
 {name = name,
454a0c895735 added name_of;
wenzelm
parents: 24114
diff changeset
    71
  get_value = dest o get_value,
454a0c895735 added name_of;
wenzelm
parents: 24114
diff changeset
    72
  map_value = fn f => map_value (make o f o dest)};
24114
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    73
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    74
val bool = coerce Bool (fn Bool b => b);
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    75
val int = coerce Int (fn Int i => i);
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    76
val string = coerce String (fn String s => s);
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    77
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    78
fun get_generic context (Config {get_value, ...}) = get_value context;
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    79
fun map_generic (Config {map_value, ...}) f context = map_value f context;
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    80
fun put_generic config value = map_generic config (K value);
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    81
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    82
fun get_ctxt ctxt = get_generic (Context.Proof ctxt);
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    83
fun map_ctxt config f = Context.proof_map (map_generic config f);
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    84
fun put_ctxt config value = map_ctxt config (K value);
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    85
36787
f60e4dd6d76f renamed Config.get_thy to Config.get_global etc. to indicate that this is not the real thing;
wenzelm
parents: 36002
diff changeset
    86
fun get_global thy = get_generic (Context.Theory thy);
f60e4dd6d76f renamed Config.get_thy to Config.get_global etc. to indicate that this is not the real thing;
wenzelm
parents: 36002
diff changeset
    87
fun map_global config f = Context.theory_map (map_generic config f);
f60e4dd6d76f renamed Config.get_thy to Config.get_global etc. to indicate that this is not the real thing;
wenzelm
parents: 36002
diff changeset
    88
fun put_global config value = map_global config (K value);
24114
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    89
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    90
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    91
(* context information *)
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    92
33519
e31a85f92ce9 adapted Generic_Data, Proof_Data;
wenzelm
parents: 29606
diff changeset
    93
structure Value = Generic_Data
24114
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    94
(
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    95
  type T = value Inttab.table;
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    96
  val empty = Inttab.empty;
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    97
  val extend = I;
33519
e31a85f92ce9 adapted Generic_Data, Proof_Data;
wenzelm
parents: 29606
diff changeset
    98
  fun merge data = Inttab.merge (K true) data;
24114
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    99
);
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
   100
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
   101
fun declare global name default =
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
   102
  let
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
   103
    val id = serial ();
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
   104
36000
5560b2437789 configuration options admit dynamic default values;
wenzelm
parents: 33519
diff changeset
   105
    fun get_value context =
5560b2437789 configuration options admit dynamic default values;
wenzelm
parents: 33519
diff changeset
   106
      (case Inttab.lookup (Value.get context) id of
5560b2437789 configuration options admit dynamic default values;
wenzelm
parents: 33519
diff changeset
   107
        SOME value => value
36002
f4f343500249 pass raw Context.generic, to avoid wasteful Context.proof_of -- Config.get_thy is often used in performance critical spots like unify.ML;
wenzelm
parents: 36000
diff changeset
   108
      | NONE => default context);
36000
5560b2437789 configuration options admit dynamic default values;
wenzelm
parents: 33519
diff changeset
   109
5560b2437789 configuration options admit dynamic default values;
wenzelm
parents: 33519
diff changeset
   110
    fun update_value f context =
5560b2437789 configuration options admit dynamic default values;
wenzelm
parents: 33519
diff changeset
   111
      Value.map (Inttab.update (id, type_check name f (get_value context))) context;
24114
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
   112
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
   113
    fun map_value f (context as Context.Proof _) =
36000
5560b2437789 configuration options admit dynamic default values;
wenzelm
parents: 33519
diff changeset
   114
          let val context' = update_value f context in
24114
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
   115
            if global andalso
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
   116
              get_value (Context.Theory (Context.theory_of context')) <> get_value context'
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
   117
            then (warning ("Ignoring local change of global option " ^ quote name); context)
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
   118
            else context'
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
   119
          end
36000
5560b2437789 configuration options admit dynamic default values;
wenzelm
parents: 33519
diff changeset
   120
      | map_value f context = update_value f context;
24125
454a0c895735 added name_of;
wenzelm
parents: 24114
diff changeset
   121
  in Config {name = name, get_value = get_value, map_value = map_value} end;
454a0c895735 added name_of;
wenzelm
parents: 24114
diff changeset
   122
454a0c895735 added name_of;
wenzelm
parents: 24114
diff changeset
   123
fun name_of (Config {name, ...}) = name;
24114
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
   124
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
   125
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
   126
(*final declarations of this structure!*)
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
   127
val get = get_ctxt;
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
   128
val map = map_ctxt;
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
   129
val put = put_ctxt;
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
   130
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
   131
end;