2009-06-26 07:53:31 -06:00
|
|
|
|
# Definitions related to run-time type checking. Used in particular
|
|
|
|
|
# to type-check NixOS configurations.
|
|
|
|
|
|
2013-10-30 12:12:25 -06:00
|
|
|
|
with import ./lists.nix;
|
|
|
|
|
with import ./attrsets.nix;
|
|
|
|
|
with import ./options.nix;
|
|
|
|
|
with import ./trivial.nix;
|
|
|
|
|
with import ./strings.nix;
|
2015-03-12 16:01:47 -06:00
|
|
|
|
with {inherit (import ./modules.nix) mergeDefinitions; };
|
2009-06-26 07:53:31 -06:00
|
|
|
|
|
2015-03-12 16:01:47 -06:00
|
|
|
|
rec {
|
2009-06-26 07:53:31 -06:00
|
|
|
|
|
2013-03-13 08:05:30 -06:00
|
|
|
|
isType = type: x: (x._type or "") == type;
|
2009-06-26 07:53:31 -06:00
|
|
|
|
|
2009-11-19 10:19:39 -07:00
|
|
|
|
setType = typeName: value: value // {
|
|
|
|
|
_type = typeName;
|
|
|
|
|
};
|
|
|
|
|
|
2011-06-13 20:41:13 -06:00
|
|
|
|
|
2013-03-13 08:05:30 -06:00
|
|
|
|
isOptionType = isType "option-type";
|
2009-06-26 07:53:31 -06:00
|
|
|
|
mkOptionType =
|
2013-10-28 12:48:30 -06:00
|
|
|
|
{ # Human-readable representation of the type.
|
|
|
|
|
name
|
|
|
|
|
, # Function applied to each definition that should return true if
|
|
|
|
|
# its type-correct, false otherwise.
|
|
|
|
|
check ? (x: true)
|
|
|
|
|
, # Merge a list of definitions together into a single value.
|
2013-10-30 07:21:41 -06:00
|
|
|
|
# This function is called with two arguments: the location of
|
|
|
|
|
# the option in the configuration as a list of strings
|
|
|
|
|
# (e.g. ["boot" "loader "grub" "enable"]), and a list of
|
|
|
|
|
# definition values and locations (e.g. [ { file = "/foo.nix";
|
|
|
|
|
# value = 1; } { file = "/bar.nix"; value = 2 } ]).
|
2013-10-28 12:48:30 -06:00
|
|
|
|
merge ? mergeDefaultOption
|
|
|
|
|
, # Return a flat list of sub-options. Used to generate
|
|
|
|
|
# documentation.
|
|
|
|
|
getSubOptions ? prefix: {}
|
2014-08-29 08:42:44 -06:00
|
|
|
|
, # List of modules if any, or null if none.
|
|
|
|
|
getSubModules ? null
|
|
|
|
|
, # Function for building the same option type with a different list of
|
|
|
|
|
# modules.
|
|
|
|
|
substSubModules ? m: null
|
2009-06-26 07:53:31 -06:00
|
|
|
|
}:
|
|
|
|
|
{ _type = "option-type";
|
2014-08-29 08:42:44 -06:00
|
|
|
|
inherit name check merge getSubOptions getSubModules substSubModules;
|
2009-06-26 07:53:31 -06:00
|
|
|
|
};
|
|
|
|
|
|
2011-06-13 20:41:13 -06:00
|
|
|
|
|
2009-11-06 18:58:56 -07:00
|
|
|
|
types = rec {
|
2009-06-26 07:53:31 -06:00
|
|
|
|
|
2013-10-27 17:56:22 -06:00
|
|
|
|
unspecified = mkOptionType {
|
|
|
|
|
name = "unspecified";
|
|
|
|
|
};
|
|
|
|
|
|
2009-06-26 07:53:31 -06:00
|
|
|
|
bool = mkOptionType {
|
|
|
|
|
name = "boolean";
|
2013-11-12 05:48:19 -07:00
|
|
|
|
check = isBool;
|
2015-06-15 10:04:27 -06:00
|
|
|
|
merge = mergeEqualOption;
|
2009-06-26 07:53:31 -06:00
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
int = mkOptionType {
|
|
|
|
|
name = "integer";
|
2013-11-12 05:48:19 -07:00
|
|
|
|
check = isInt;
|
2013-10-30 07:21:41 -06:00
|
|
|
|
merge = mergeOneOption;
|
2009-06-26 07:53:31 -06:00
|
|
|
|
};
|
|
|
|
|
|
2013-10-29 06:45:30 -06:00
|
|
|
|
str = mkOptionType {
|
|
|
|
|
name = "string";
|
2013-11-12 05:48:19 -07:00
|
|
|
|
check = isString;
|
2013-10-29 06:45:30 -06:00
|
|
|
|
merge = mergeOneOption;
|
|
|
|
|
};
|
|
|
|
|
|
2013-10-30 07:21:41 -06:00
|
|
|
|
# Merge multiple definitions by concatenating them (with the given
|
|
|
|
|
# separator between the values).
|
|
|
|
|
separatedString = sep: mkOptionType {
|
2013-02-11 07:28:41 -07:00
|
|
|
|
name = "string";
|
2013-11-12 05:48:19 -07:00
|
|
|
|
check = isString;
|
2013-10-30 12:12:25 -06:00
|
|
|
|
merge = loc: defs: concatStringsSep sep (getValues defs);
|
2013-02-11 07:28:41 -07:00
|
|
|
|
};
|
|
|
|
|
|
2013-10-30 07:21:41 -06:00
|
|
|
|
lines = separatedString "\n";
|
|
|
|
|
commas = separatedString ",";
|
|
|
|
|
envVar = separatedString ":";
|
2013-10-28 09:14:15 -06:00
|
|
|
|
|
2013-10-30 07:21:41 -06:00
|
|
|
|
# Deprecated; should not be used because it quietly concatenates
|
|
|
|
|
# strings, which is usually not what you want.
|
|
|
|
|
string = separatedString "";
|
2009-11-06 18:58:56 -07:00
|
|
|
|
|
2009-06-26 07:53:31 -06:00
|
|
|
|
attrs = mkOptionType {
|
|
|
|
|
name = "attribute set";
|
2013-10-27 17:56:22 -06:00
|
|
|
|
check = isAttrs;
|
2015-07-23 09:19:21 -06:00
|
|
|
|
merge = loc: foldl' (res: def: mergeAttrs res def.value) {};
|
2009-06-26 07:53:31 -06:00
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
# derivation is a reserved keyword.
|
|
|
|
|
package = mkOptionType {
|
|
|
|
|
name = "derivation";
|
2015-08-06 11:55:42 -06:00
|
|
|
|
check = x: isDerivation x || isStorePath x;
|
|
|
|
|
merge = loc: defs:
|
|
|
|
|
let res = mergeOneOption loc defs;
|
|
|
|
|
in if isDerivation res then res else toDerivation res;
|
2009-06-26 07:53:31 -06:00
|
|
|
|
};
|
|
|
|
|
|
2012-05-25 11:19:07 -06:00
|
|
|
|
path = mkOptionType {
|
|
|
|
|
name = "path";
|
|
|
|
|
# Hacky: there is no ‘isPath’ primop.
|
2015-08-06 11:55:42 -06:00
|
|
|
|
check = x: builtins.substring 0 1 (toString x) == "/";
|
2013-10-28 12:48:30 -06:00
|
|
|
|
merge = mergeOneOption;
|
2012-05-25 11:19:07 -06:00
|
|
|
|
};
|
|
|
|
|
|
2013-08-22 00:45:22 -06:00
|
|
|
|
# drop this in the future:
|
2013-10-28 12:48:30 -06:00
|
|
|
|
list = builtins.trace "`types.list' is deprecated; use `types.listOf' instead" types.listOf;
|
2013-08-22 00:45:22 -06:00
|
|
|
|
|
2013-10-27 17:56:22 -06:00
|
|
|
|
listOf = elemType: mkOptionType {
|
2009-06-26 07:53:31 -06:00
|
|
|
|
name = "list of ${elemType.name}s";
|
2014-05-01 15:58:16 -06:00
|
|
|
|
check = isList;
|
2013-10-30 07:21:41 -06:00
|
|
|
|
merge = loc: defs:
|
2014-05-01 15:58:16 -06:00
|
|
|
|
map (x: x.value) (filter (x: x ? value) (concatLists (imap (n: def: imap (m: def':
|
2015-03-12 16:01:47 -06:00
|
|
|
|
(mergeDefinitions
|
|
|
|
|
(loc ++ ["[definition ${toString n}-entry ${toString m}]"])
|
|
|
|
|
elemType
|
|
|
|
|
[{ inherit (def) file; value = def'; }]
|
|
|
|
|
).optionalValue
|
|
|
|
|
) def.value) defs)));
|
2013-10-28 07:25:58 -06:00
|
|
|
|
getSubOptions = prefix: elemType.getSubOptions (prefix ++ ["*"]);
|
2014-08-29 08:42:44 -06:00
|
|
|
|
getSubModules = elemType.getSubModules;
|
|
|
|
|
substSubModules = m: listOf (elemType.substSubModules m);
|
2009-06-26 07:53:31 -06:00
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
attrsOf = elemType: mkOptionType {
|
2011-04-27 12:41:27 -06:00
|
|
|
|
name = "attribute set of ${elemType.name}s";
|
2014-05-01 16:13:06 -06:00
|
|
|
|
check = isAttrs;
|
2013-10-30 07:21:41 -06:00
|
|
|
|
merge = loc: defs:
|
2014-05-01 16:13:06 -06:00
|
|
|
|
mapAttrs (n: v: v.value) (filterAttrs (n: v: v ? value) (zipAttrsWith (name: defs:
|
2015-03-12 16:01:47 -06:00
|
|
|
|
(mergeDefinitions (loc ++ [name]) elemType defs).optionalValue
|
|
|
|
|
)
|
2013-10-30 07:21:41 -06:00
|
|
|
|
# Push down position info.
|
|
|
|
|
(map (def: listToAttrs (mapAttrsToList (n: def':
|
2014-05-01 16:13:06 -06:00
|
|
|
|
{ name = n; value = { inherit (def) file; value = def'; }; }) def.value)) defs)));
|
2013-10-28 07:25:58 -06:00
|
|
|
|
getSubOptions = prefix: elemType.getSubOptions (prefix ++ ["<name>"]);
|
2014-08-29 08:42:44 -06:00
|
|
|
|
getSubModules = elemType.getSubModules;
|
|
|
|
|
substSubModules = m: attrsOf (elemType.substSubModules m);
|
2009-06-26 07:53:31 -06:00
|
|
|
|
};
|
|
|
|
|
|
2011-06-13 20:41:13 -06:00
|
|
|
|
# List or attribute set of ...
|
|
|
|
|
loaOf = elemType:
|
|
|
|
|
let
|
|
|
|
|
convertIfList = defIdx: def:
|
2013-10-30 07:21:41 -06:00
|
|
|
|
if isList def.value then
|
|
|
|
|
{ inherit (def) file;
|
|
|
|
|
value = listToAttrs (
|
|
|
|
|
imap (elemIdx: elem:
|
2014-02-20 08:40:49 -07:00
|
|
|
|
{ name = elem.name or "unnamed-${toString defIdx}.${toString elemIdx}";
|
2013-10-30 07:21:41 -06:00
|
|
|
|
value = elem;
|
|
|
|
|
}) def.value);
|
|
|
|
|
}
|
2011-06-13 20:41:13 -06:00
|
|
|
|
else
|
|
|
|
|
def;
|
|
|
|
|
listOnly = listOf elemType;
|
|
|
|
|
attrOnly = attrsOf elemType;
|
|
|
|
|
in mkOptionType {
|
|
|
|
|
name = "list or attribute set of ${elemType.name}s";
|
2014-05-01 18:17:03 -06:00
|
|
|
|
check = x: isList x || isAttrs x;
|
2013-10-30 07:21:41 -06:00
|
|
|
|
merge = loc: defs: attrOnly.merge loc (imap convertIfList defs);
|
2013-10-28 07:25:58 -06:00
|
|
|
|
getSubOptions = prefix: elemType.getSubOptions (prefix ++ ["<name?>"]);
|
2014-08-29 08:42:44 -06:00
|
|
|
|
getSubModules = elemType.getSubModules;
|
|
|
|
|
substSubModules = m: loaOf (elemType.substSubModules m);
|
2013-10-27 17:56:22 -06:00
|
|
|
|
};
|
2011-06-13 20:41:13 -06:00
|
|
|
|
|
2009-06-26 07:53:31 -06:00
|
|
|
|
uniq = elemType: mkOptionType {
|
2013-10-28 07:25:58 -06:00
|
|
|
|
inherit (elemType) name check;
|
2013-10-28 12:48:30 -06:00
|
|
|
|
merge = mergeOneOption;
|
2013-10-28 07:25:58 -06:00
|
|
|
|
getSubOptions = elemType.getSubOptions;
|
2014-08-29 08:42:44 -06:00
|
|
|
|
getSubModules = elemType.getSubModules;
|
|
|
|
|
substSubModules = m: uniq (elemType.substSubModules m);
|
2009-06-26 07:53:31 -06:00
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
nullOr = elemType: mkOptionType {
|
2013-10-27 17:56:22 -06:00
|
|
|
|
name = "null or ${elemType.name}";
|
2009-06-26 07:53:31 -06:00
|
|
|
|
check = x: builtins.isNull x || elemType.check x;
|
2013-10-30 07:21:41 -06:00
|
|
|
|
merge = loc: defs:
|
|
|
|
|
let nrNulls = count (def: isNull def.value) defs; in
|
|
|
|
|
if nrNulls == length defs then null
|
|
|
|
|
else if nrNulls != 0 then
|
|
|
|
|
throw "The option `${showOption loc}' is defined both null and not null, in ${showFiles (getFiles defs)}."
|
|
|
|
|
else elemType.merge loc defs;
|
2013-10-28 07:25:58 -06:00
|
|
|
|
getSubOptions = elemType.getSubOptions;
|
2014-08-29 08:42:44 -06:00
|
|
|
|
getSubModules = elemType.getSubModules;
|
|
|
|
|
substSubModules = m: nullOr (elemType.substSubModules m);
|
2009-06-26 07:53:31 -06:00
|
|
|
|
};
|
|
|
|
|
|
2014-02-13 10:08:05 -07:00
|
|
|
|
submodule = opts:
|
2013-10-30 12:12:25 -06:00
|
|
|
|
let
|
|
|
|
|
opts' = toList opts;
|
|
|
|
|
inherit (import ./modules.nix) evalModules;
|
|
|
|
|
in
|
2013-10-28 07:25:58 -06:00
|
|
|
|
mkOptionType rec {
|
|
|
|
|
name = "submodule";
|
2013-11-12 05:48:19 -07:00
|
|
|
|
check = x: isAttrs x || isFunction x;
|
2013-10-30 07:21:41 -06:00
|
|
|
|
merge = loc: defs:
|
2013-10-28 07:25:58 -06:00
|
|
|
|
let
|
2013-11-12 05:48:19 -07:00
|
|
|
|
coerce = def: if isFunction def then def else { config = def; };
|
2013-10-30 07:21:41 -06:00
|
|
|
|
modules = opts' ++ map (def: { _file = def.file; imports = [(coerce def.value)]; }) defs;
|
2014-05-05 14:30:51 -06:00
|
|
|
|
in (evalModules {
|
|
|
|
|
inherit modules;
|
|
|
|
|
args.name = last loc;
|
|
|
|
|
prefix = loc;
|
|
|
|
|
}).config;
|
2013-10-28 08:48:20 -06:00
|
|
|
|
getSubOptions = prefix: (evalModules
|
|
|
|
|
{ modules = opts'; inherit prefix;
|
|
|
|
|
# FIXME: hack to get shit to evaluate.
|
2014-02-13 10:08:05 -07:00
|
|
|
|
args = { name = ""; }; }).options;
|
2014-08-29 08:42:44 -06:00
|
|
|
|
getSubModules = opts';
|
|
|
|
|
substSubModules = m: submodule m;
|
2013-10-28 07:25:58 -06:00
|
|
|
|
};
|
2013-10-27 17:56:22 -06:00
|
|
|
|
|
2014-05-01 09:30:20 -06:00
|
|
|
|
enum = values: mkOptionType {
|
2014-05-01 09:46:44 -06:00
|
|
|
|
name = "one of ${concatStringsSep ", " values}";
|
2014-05-01 09:30:20 -06:00
|
|
|
|
check = flip elem values;
|
|
|
|
|
merge = mergeOneOption;
|
|
|
|
|
};
|
|
|
|
|
|
2014-08-19 05:13:51 -06:00
|
|
|
|
either = t1: t2: mkOptionType {
|
|
|
|
|
name = "${t1.name} or ${t2.name}";
|
|
|
|
|
check = x: t1.check x || t2.check x;
|
|
|
|
|
merge = mergeOneOption;
|
|
|
|
|
};
|
|
|
|
|
|
2013-10-27 17:56:22 -06:00
|
|
|
|
# Obsolete alternative to configOf. It takes its option
|
|
|
|
|
# declarations from the ‘options’ attribute of containing option
|
|
|
|
|
# declaration.
|
|
|
|
|
optionSet = mkOptionType {
|
|
|
|
|
name = /* builtins.trace "types.optionSet is deprecated; use types.submodule instead" */ "option set";
|
2009-06-26 07:53:31 -06:00
|
|
|
|
};
|
|
|
|
|
|
2013-10-30 08:33:20 -06:00
|
|
|
|
# Augment the given type with an additional type check function.
|
|
|
|
|
addCheck = elemType: check: elemType // { check = x: elemType.check x && check x; };
|
|
|
|
|
|
2009-06-26 07:53:31 -06:00
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
}
|