src/Pure/config.ML
author wenzelm
Mon Mar 10 15:04:01 2014 +0100 (2014-03-10)
changeset 56026 893fe12639bc
parent 52469 c06f1d36a8c9
child 56294 85911b8a6868
permissions -rw-r--r--
tuned signature -- prefer Name_Space.get with its builtin error;
wenzelm@24114
     1
(*  Title:      Pure/config.ML
wenzelm@24114
     2
    Author:     Makarius
wenzelm@24114
     3
wenzelm@24114
     4
Configuration options as values within the local context.
wenzelm@24114
     5
*)
wenzelm@24114
     6
wenzelm@24114
     7
signature CONFIG =
wenzelm@24114
     8
sig
wenzelm@40291
     9
  datatype value = Bool of bool | Int of int | Real of real | String of string
wenzelm@24114
    10
  val print_value: value -> string
wenzelm@24114
    11
  val print_type: value -> string
wenzelm@24114
    12
  type 'a T
wenzelm@39163
    13
  type raw = value T
wenzelm@39163
    14
  val bool: raw -> bool T
wenzelm@39163
    15
  val int: raw -> int T
wenzelm@40291
    16
  val real: raw -> real T
wenzelm@39163
    17
  val string: raw -> string T
wenzelm@24114
    18
  val get: Proof.context -> 'a T -> 'a
wenzelm@24114
    19
  val map: 'a T -> ('a -> 'a) -> Proof.context -> Proof.context
wenzelm@24114
    20
  val put: 'a T -> 'a -> Proof.context -> Proof.context
wenzelm@36787
    21
  val get_global: theory -> 'a T -> 'a
wenzelm@36787
    22
  val map_global: 'a T -> ('a -> 'a) -> theory -> theory
wenzelm@36787
    23
  val put_global: 'a T -> 'a -> theory -> theory
wenzelm@24114
    24
  val get_generic: Context.generic -> 'a T -> 'a
wenzelm@24114
    25
  val map_generic: 'a T -> ('a -> 'a) -> Context.generic -> Context.generic
wenzelm@24114
    26
  val put_generic: 'a T -> 'a -> Context.generic -> Context.generic
wenzelm@52469
    27
  val declare: string -> (Context.generic -> value) -> raw
wenzelm@39163
    28
  val declare_global: string -> (Context.generic -> value) -> raw
wenzelm@51947
    29
  val declare_option: string -> raw
wenzelm@52469
    30
  val declare_option_global: string -> raw
wenzelm@24125
    31
  val name_of: 'a T -> string
wenzelm@24114
    32
end;
wenzelm@24114
    33
wenzelm@24114
    34
structure Config: CONFIG =
wenzelm@24114
    35
struct
wenzelm@24114
    36
wenzelm@24114
    37
(* simple values *)
wenzelm@24114
    38
wenzelm@24114
    39
datatype value =
wenzelm@24114
    40
  Bool of bool |
wenzelm@24114
    41
  Int of int |
wenzelm@40291
    42
  Real of real |
wenzelm@24114
    43
  String of string;
wenzelm@24114
    44
wenzelm@24114
    45
fun print_value (Bool true) = "true"
wenzelm@24114
    46
  | print_value (Bool false) = "false"
wenzelm@24114
    47
  | print_value (Int i) = signed_string_of_int i
wenzelm@51990
    48
  | print_value (Real x) = Markup.print_real x
wenzelm@24114
    49
  | print_value (String s) = quote s;
wenzelm@24114
    50
wenzelm@38804
    51
fun print_type (Bool _) = "bool"
wenzelm@38804
    52
  | print_type (Int _) = "int"
wenzelm@40291
    53
  | print_type (Real _) = "real"
wenzelm@24114
    54
  | print_type (String _) = "string";
wenzelm@24114
    55
wenzelm@24114
    56
fun same_type (Bool _) (Bool _) = true
wenzelm@24114
    57
  | same_type (Int _) (Int _) = true
wenzelm@40291
    58
  | same_type (Real _) (Real _) = true
wenzelm@24114
    59
  | same_type (String _) (String _) = true
wenzelm@24114
    60
  | same_type _ _ = false;
wenzelm@24114
    61
wenzelm@24114
    62
fun type_check name f value =
wenzelm@24114
    63
  let
wenzelm@24114
    64
    val value' = f value;
wenzelm@24114
    65
    val _ = same_type value value' orelse
wenzelm@24114
    66
      error ("Ill-typed configuration option " ^ quote name ^ ": " ^
wenzelm@24114
    67
        print_type value ^ " expected,\nbut " ^ print_type value' ^ " was found");
wenzelm@24114
    68
  in value' end;
wenzelm@24114
    69
wenzelm@24114
    70
wenzelm@24114
    71
(* abstract configuration options *)
wenzelm@24114
    72
wenzelm@24114
    73
datatype 'a T = Config of
wenzelm@24125
    74
 {name: string,
wenzelm@24125
    75
  get_value: Context.generic -> 'a,
wenzelm@24114
    76
  map_value: ('a -> 'a) -> Context.generic -> Context.generic};
wenzelm@24114
    77
wenzelm@39163
    78
type raw = value T;
wenzelm@39163
    79
wenzelm@24125
    80
fun coerce make dest (Config {name, get_value, map_value}) = Config
wenzelm@24125
    81
 {name = name,
wenzelm@24125
    82
  get_value = dest o get_value,
wenzelm@24125
    83
  map_value = fn f => map_value (make o f o dest)};
wenzelm@24114
    84
wenzelm@24114
    85
val bool = coerce Bool (fn Bool b => b);
wenzelm@24114
    86
val int = coerce Int (fn Int i => i);
wenzelm@40291
    87
val real = coerce Real (fn Real x => x);
wenzelm@24114
    88
val string = coerce String (fn String s => s);
wenzelm@24114
    89
wenzelm@24114
    90
fun get_generic context (Config {get_value, ...}) = get_value context;
wenzelm@24114
    91
fun map_generic (Config {map_value, ...}) f context = map_value f context;
wenzelm@24114
    92
fun put_generic config value = map_generic config (K value);
wenzelm@24114
    93
wenzelm@24114
    94
fun get_ctxt ctxt = get_generic (Context.Proof ctxt);
wenzelm@24114
    95
fun map_ctxt config f = Context.proof_map (map_generic config f);
wenzelm@24114
    96
fun put_ctxt config value = map_ctxt config (K value);
wenzelm@24114
    97
wenzelm@36787
    98
fun get_global thy = get_generic (Context.Theory thy);
wenzelm@36787
    99
fun map_global config f = Context.theory_map (map_generic config f);
wenzelm@36787
   100
fun put_global config value = map_global config (K value);
wenzelm@24114
   101
wenzelm@24114
   102
wenzelm@24114
   103
(* context information *)
wenzelm@24114
   104
wenzelm@33519
   105
structure Value = Generic_Data
wenzelm@24114
   106
(
wenzelm@24114
   107
  type T = value Inttab.table;
wenzelm@24114
   108
  val empty = Inttab.empty;
wenzelm@24114
   109
  val extend = I;
wenzelm@33519
   110
  fun merge data = Inttab.merge (K true) data;
wenzelm@24114
   111
);
wenzelm@24114
   112
wenzelm@52469
   113
local
wenzelm@52469
   114
wenzelm@52039
   115
fun declare_generic global name default =
wenzelm@24114
   116
  let
wenzelm@24114
   117
    val id = serial ();
wenzelm@24114
   118
wenzelm@36000
   119
    fun get_value context =
wenzelm@36000
   120
      (case Inttab.lookup (Value.get context) id of
wenzelm@36000
   121
        SOME value => value
wenzelm@36002
   122
      | NONE => default context);
wenzelm@36000
   123
wenzelm@36000
   124
    fun update_value f context =
wenzelm@36000
   125
      Value.map (Inttab.update (id, type_check name f (get_value context))) context;
wenzelm@24114
   126
wenzelm@47814
   127
    fun map_value f (context as Context.Proof ctxt) =
wenzelm@36000
   128
          let val context' = update_value f context in
wenzelm@24114
   129
            if global andalso
wenzelm@47814
   130
              Context_Position.is_visible ctxt andalso
wenzelm@40291
   131
              print_value (get_value (Context.Theory (Context.theory_of context'))) <>
wenzelm@40291
   132
                print_value (get_value context')
wenzelm@47814
   133
            then
wenzelm@47814
   134
              (Context_Position.if_visible ctxt warning
wenzelm@47814
   135
                ("Ignoring local change of global option " ^ quote name); context)
wenzelm@24114
   136
            else context'
wenzelm@24114
   137
          end
wenzelm@36000
   138
      | map_value f context = update_value f context;
wenzelm@24125
   139
  in Config {name = name, get_value = get_value, map_value = map_value} end;
wenzelm@24125
   140
wenzelm@52469
   141
fun declare_option_generic global name =
wenzelm@51947
   142
  let
wenzelm@51947
   143
    val typ = Options.default_typ name;
wenzelm@51947
   144
    val default =
wenzelm@51947
   145
      if typ = Options.boolT then fn _ => Bool (Options.default_bool name)
wenzelm@51947
   146
      else if typ = Options.intT then fn _ => Int (Options.default_int name)
wenzelm@51947
   147
      else if typ = Options.realT then fn _ => Real (Options.default_real name)
wenzelm@51947
   148
      else if typ = Options.stringT then fn _ => String (Options.default_string name)
wenzelm@51947
   149
      else error ("Unknown type for option " ^ quote name ^ " : " ^ quote typ);
wenzelm@52469
   150
  in declare_generic global name default end;
wenzelm@52469
   151
wenzelm@52469
   152
in
wenzelm@52469
   153
wenzelm@52469
   154
val declare = declare_generic false;
wenzelm@52469
   155
val declare_global = declare_generic true;
wenzelm@52469
   156
val declare_option = declare_option_generic false;
wenzelm@52469
   157
val declare_option_global = declare_option_generic true;
wenzelm@52469
   158
wenzelm@52469
   159
end;
wenzelm@51947
   160
wenzelm@24125
   161
fun name_of (Config {name, ...}) = name;
wenzelm@24114
   162
wenzelm@24114
   163
wenzelm@24114
   164
(*final declarations of this structure!*)
wenzelm@24114
   165
val get = get_ctxt;
wenzelm@24114
   166
val map = map_ctxt;
wenzelm@24114
   167
val put = put_ctxt;
wenzelm@24114
   168
wenzelm@24114
   169
end;