src/Pure/config.ML
author wenzelm
Sun, 21 May 2017 23:41:46 +0200
changeset 65895 744878d72021
parent 63806 c54a53ef1873
child 68827 1286ca9dfd26
permissions -rw-r--r--
more general workaround for failed sessions (again, see also 2edb89630a80, ed7b5cd3a7f2);
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
40291
012ed4426fda support for real valued configuration options;
wenzelm
parents: 39163
diff changeset
     9
  datatype value = Bool of bool | Int of int | Real of real | String of string
24114
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
39163
4d701c0388c3 more explicit indication of Config.raw options, which are only needed for bootstrapping Pure;
wenzelm
parents: 39116
diff changeset
    13
  type raw = value T
4d701c0388c3 more explicit indication of Config.raw options, which are only needed for bootstrapping Pure;
wenzelm
parents: 39116
diff changeset
    14
  val bool: raw -> bool T
4d701c0388c3 more explicit indication of Config.raw options, which are only needed for bootstrapping Pure;
wenzelm
parents: 39116
diff changeset
    15
  val int: raw -> int T
40291
012ed4426fda support for real valued configuration options;
wenzelm
parents: 39163
diff changeset
    16
  val real: raw -> real T
39163
4d701c0388c3 more explicit indication of Config.raw options, which are only needed for bootstrapping Pure;
wenzelm
parents: 39116
diff changeset
    17
  val string: raw -> string T
24114
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    18
  val get: Proof.context -> 'a T -> 'a
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    19
  val map: 'a T -> ('a -> 'a) -> Proof.context -> Proof.context
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    20
  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
    21
  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
    22
  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
    23
  val put_global: 'a T -> 'a -> theory -> theory
24114
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    24
  val get_generic: Context.generic -> 'a T -> 'a
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    25
  val map_generic: 'a T -> ('a -> 'a) -> Context.generic -> Context.generic
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    26
  val put_generic: 'a T -> 'a -> Context.generic -> Context.generic
56438
7f6b2634d853 more source positions;
wenzelm
parents: 56294
diff changeset
    27
  val declare: string * Position.T -> (Context.generic -> value) -> raw
7f6b2634d853 more source positions;
wenzelm
parents: 56294
diff changeset
    28
  val declare_option: string * Position.T -> raw
24125
454a0c895735 added name_of;
wenzelm
parents: 24114
diff changeset
    29
  val name_of: 'a T -> string
56438
7f6b2634d853 more source positions;
wenzelm
parents: 56294
diff changeset
    30
  val pos_of: 'a T -> Position.T
24114
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    31
end;
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    32
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    33
structure Config: CONFIG =
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    34
struct
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    35
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    36
(* simple values *)
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    37
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    38
datatype value =
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    39
  Bool of bool |
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    40
  Int of int |
40291
012ed4426fda support for real valued configuration options;
wenzelm
parents: 39163
diff changeset
    41
  Real of real |
24114
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    42
  String of string;
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    43
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    44
fun print_value (Bool true) = "true"
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    45
  | print_value (Bool false) = "false"
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    46
  | print_value (Int i) = signed_string_of_int i
63806
c54a53ef1873 clarified modules;
wenzelm
parents: 58951
diff changeset
    47
  | print_value (Real x) = Value.print_real x
24114
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    48
  | print_value (String s) = quote s;
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    49
38804
99cc7e748ab4 tuned printed type names, according to ML;
wenzelm
parents: 36787
diff changeset
    50
fun print_type (Bool _) = "bool"
99cc7e748ab4 tuned printed type names, according to ML;
wenzelm
parents: 36787
diff changeset
    51
  | print_type (Int _) = "int"
40291
012ed4426fda support for real valued configuration options;
wenzelm
parents: 39163
diff changeset
    52
  | print_type (Real _) = "real"
24114
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    53
  | print_type (String _) = "string";
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    54
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    55
fun same_type (Bool _) (Bool _) = true
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    56
  | same_type (Int _) (Int _) = true
40291
012ed4426fda support for real valued configuration options;
wenzelm
parents: 39163
diff changeset
    57
  | same_type (Real _) (Real _) = true
24114
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    58
  | same_type (String _) (String _) = true
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    59
  | same_type _ _ = false;
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    60
56438
7f6b2634d853 more source positions;
wenzelm
parents: 56294
diff changeset
    61
fun type_check (name, pos) f value =
24114
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    62
  let
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    63
    val value' = f value;
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    64
    val _ = same_type value value' orelse
56438
7f6b2634d853 more source positions;
wenzelm
parents: 56294
diff changeset
    65
      error ("Ill-typed configuration option " ^ quote name ^ Position.here pos ^ ": " ^
24114
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    66
        print_type value ^ " expected,\nbut " ^ print_type value' ^ " was found");
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    67
  in value' end;
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    68
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    69
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    70
(* abstract configuration options *)
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    71
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    72
datatype 'a T = Config of
24125
454a0c895735 added name_of;
wenzelm
parents: 24114
diff changeset
    73
 {name: string,
56438
7f6b2634d853 more source positions;
wenzelm
parents: 56294
diff changeset
    74
  pos: Position.T,
24125
454a0c895735 added name_of;
wenzelm
parents: 24114
diff changeset
    75
  get_value: Context.generic -> 'a,
24114
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    76
  map_value: ('a -> 'a) -> Context.generic -> Context.generic};
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    77
39163
4d701c0388c3 more explicit indication of Config.raw options, which are only needed for bootstrapping Pure;
wenzelm
parents: 39116
diff changeset
    78
type raw = value T;
4d701c0388c3 more explicit indication of Config.raw options, which are only needed for bootstrapping Pure;
wenzelm
parents: 39116
diff changeset
    79
56438
7f6b2634d853 more source positions;
wenzelm
parents: 56294
diff changeset
    80
fun coerce make dest (Config {name, pos, get_value, map_value}) = Config
24125
454a0c895735 added name_of;
wenzelm
parents: 24114
diff changeset
    81
 {name = name,
56438
7f6b2634d853 more source positions;
wenzelm
parents: 56294
diff changeset
    82
  pos = pos,
24125
454a0c895735 added name_of;
wenzelm
parents: 24114
diff changeset
    83
  get_value = dest o get_value,
454a0c895735 added name_of;
wenzelm
parents: 24114
diff changeset
    84
  map_value = fn f => map_value (make o f o dest)};
24114
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    85
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    86
val bool = coerce Bool (fn Bool b => b);
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    87
val int = coerce Int (fn Int i => i);
40291
012ed4426fda support for real valued configuration options;
wenzelm
parents: 39163
diff changeset
    88
val real = coerce Real (fn Real x => x);
24114
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    89
val string = coerce String (fn String s => s);
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
fun get_generic context (Config {get_value, ...}) = get_value context;
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    92
fun map_generic (Config {map_value, ...}) f context = map_value f context;
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    93
fun put_generic config value = map_generic config (K value);
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
fun get_ctxt ctxt = get_generic (Context.Proof ctxt);
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    96
fun map_ctxt config f = Context.proof_map (map_generic config f);
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    97
fun put_ctxt config value = map_ctxt config (K value);
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
    98
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
    99
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
   100
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
   101
fun put_global config value = map_global config (K value);
24114
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
   102
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
   103
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
   104
(* context information *)
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
   105
63806
c54a53ef1873 clarified modules;
wenzelm
parents: 58951
diff changeset
   106
structure Data = Generic_Data
24114
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
   107
(
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
   108
  type T = value Inttab.table;
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
   109
  val empty = Inttab.empty;
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
   110
  val extend = I;
33519
e31a85f92ce9 adapted Generic_Data, Proof_Data;
wenzelm
parents: 29606
diff changeset
   111
  fun merge data = Inttab.merge (K true) data;
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
58951
8b7caf447357 removed obsolete global-only options, which did not work out anyway (due to complexity of local_theory sandwich);
wenzelm
parents: 57858
diff changeset
   114
fun declare (name, pos) default =
24114
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
   115
  let
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
   116
    val id = serial ();
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
   117
36000
5560b2437789 configuration options admit dynamic default values;
wenzelm
parents: 33519
diff changeset
   118
    fun get_value context =
63806
c54a53ef1873 clarified modules;
wenzelm
parents: 58951
diff changeset
   119
      (case Inttab.lookup (Data.get context) id of
36000
5560b2437789 configuration options admit dynamic default values;
wenzelm
parents: 33519
diff changeset
   120
        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
   121
      | NONE => default context);
36000
5560b2437789 configuration options admit dynamic default values;
wenzelm
parents: 33519
diff changeset
   122
58951
8b7caf447357 removed obsolete global-only options, which did not work out anyway (due to complexity of local_theory sandwich);
wenzelm
parents: 57858
diff changeset
   123
    fun map_value f context =
63806
c54a53ef1873 clarified modules;
wenzelm
parents: 58951
diff changeset
   124
      Data.map (Inttab.update (id, type_check (name, pos) f (get_value context))) context;
58951
8b7caf447357 removed obsolete global-only options, which did not work out anyway (due to complexity of local_theory sandwich);
wenzelm
parents: 57858
diff changeset
   125
  in
8b7caf447357 removed obsolete global-only options, which did not work out anyway (due to complexity of local_theory sandwich);
wenzelm
parents: 57858
diff changeset
   126
    Config {name = name, pos = pos, get_value = get_value, map_value = map_value}
8b7caf447357 removed obsolete global-only options, which did not work out anyway (due to complexity of local_theory sandwich);
wenzelm
parents: 57858
diff changeset
   127
  end;
24114
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
   128
58951
8b7caf447357 removed obsolete global-only options, which did not work out anyway (due to complexity of local_theory sandwich);
wenzelm
parents: 57858
diff changeset
   129
fun declare_option (name, pos) =
51947
3301612c4893 support for system options as context-sensitive config options;
wenzelm
parents: 47814
diff changeset
   130
  let
3301612c4893 support for system options as context-sensitive config options;
wenzelm
parents: 47814
diff changeset
   131
    val typ = Options.default_typ name;
3301612c4893 support for system options as context-sensitive config options;
wenzelm
parents: 47814
diff changeset
   132
    val default =
3301612c4893 support for system options as context-sensitive config options;
wenzelm
parents: 47814
diff changeset
   133
      if typ = Options.boolT then fn _ => Bool (Options.default_bool name)
3301612c4893 support for system options as context-sensitive config options;
wenzelm
parents: 47814
diff changeset
   134
      else if typ = Options.intT then fn _ => Int (Options.default_int name)
3301612c4893 support for system options as context-sensitive config options;
wenzelm
parents: 47814
diff changeset
   135
      else if typ = Options.realT then fn _ => Real (Options.default_real name)
3301612c4893 support for system options as context-sensitive config options;
wenzelm
parents: 47814
diff changeset
   136
      else if typ = Options.stringT then fn _ => String (Options.default_string name)
56438
7f6b2634d853 more source positions;
wenzelm
parents: 56294
diff changeset
   137
      else error ("Unknown type for option " ^ quote name ^ Position.here pos ^ " : " ^ quote typ);
58951
8b7caf447357 removed obsolete global-only options, which did not work out anyway (due to complexity of local_theory sandwich);
wenzelm
parents: 57858
diff changeset
   138
  in declare (name, pos) default end;
51947
3301612c4893 support for system options as context-sensitive config options;
wenzelm
parents: 47814
diff changeset
   139
24125
454a0c895735 added name_of;
wenzelm
parents: 24114
diff changeset
   140
fun name_of (Config {name, ...}) = name;
56438
7f6b2634d853 more source positions;
wenzelm
parents: 56294
diff changeset
   141
fun pos_of (Config {pos, ...}) = pos;
24114
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
   142
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
   143
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
   144
(*final declarations of this structure!*)
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
   145
val get = get_ctxt;
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
   146
val map = map_ctxt;
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
   147
val put = put_ctxt;
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
   148
1b0bc10019a5 renamed config_option.ML to config.ML;
wenzelm
parents:
diff changeset
   149
end;