2009-02-09 09:51:03 -07:00
|
|
|
|
# Nixpkgs/NixOS option handling.
|
|
|
|
|
|
|
|
|
|
let lib = import ./default.nix; in
|
|
|
|
|
|
2009-02-28 11:21:25 -07:00
|
|
|
|
with import ./trivial.nix;
|
2009-02-09 09:51:03 -07:00
|
|
|
|
with import ./lists.nix;
|
|
|
|
|
with import ./attrsets.nix;
|
2013-10-27 18:14:16 -06:00
|
|
|
|
with import ./strings.nix;
|
2009-02-09 09:51:03 -07:00
|
|
|
|
|
|
|
|
|
rec {
|
|
|
|
|
|
2013-10-23 10:20:39 -06:00
|
|
|
|
isOption = lib.isType "option";
|
2013-10-30 08:33:20 -06:00
|
|
|
|
mkOption =
|
|
|
|
|
{ default ? null # Default value used when no definition is given in the configuration.
|
|
|
|
|
, defaultText ? null # Textual representation of the default, for in the manual.
|
|
|
|
|
, example ? null # Example value used in the manual.
|
|
|
|
|
, description ? null # String describing the option.
|
|
|
|
|
, type ? null # Option type, providing type-checking and value merging.
|
|
|
|
|
, apply ? null # Function that converts the option value to something else.
|
|
|
|
|
, internal ? null # Whether the option is for NixOS developers only.
|
|
|
|
|
, visible ? null # Whether the option shows up in the manual.
|
2015-07-30 05:36:57 -06:00
|
|
|
|
, readOnly ? null # Whether the option can be set only once
|
2013-10-30 08:33:20 -06:00
|
|
|
|
, options ? null # Obsolete, used by types.optionSet.
|
|
|
|
|
} @ attrs:
|
|
|
|
|
attrs // { _type = "option"; };
|
2009-05-27 14:25:17 -06:00
|
|
|
|
|
2013-07-18 13:13:42 -06:00
|
|
|
|
mkEnableOption = name: mkOption {
|
|
|
|
|
default = false;
|
|
|
|
|
example = true;
|
2013-10-17 06:29:51 -06:00
|
|
|
|
description = "Whether to enable ${name}.";
|
2013-07-18 13:13:42 -06:00
|
|
|
|
type = lib.types.bool;
|
|
|
|
|
};
|
|
|
|
|
|
2014-12-21 06:50:46 -07:00
|
|
|
|
# This option accept anything, but it does not produce any result. This
|
|
|
|
|
# is useful for sharing a module across different module sets without
|
|
|
|
|
# having to implement similar features as long as the value of the options
|
|
|
|
|
# are not expected.
|
|
|
|
|
mkSinkUndeclaredOptions = attrs: mkOption ({
|
|
|
|
|
internal = true;
|
|
|
|
|
visible = false;
|
|
|
|
|
default = false;
|
|
|
|
|
description = "Sink for option definitions.";
|
|
|
|
|
type = mkOptionType {
|
|
|
|
|
name = "sink";
|
|
|
|
|
check = x: true;
|
|
|
|
|
merge = loc: defs: false;
|
|
|
|
|
};
|
|
|
|
|
apply = x: throw "Option value is not readable because the option is not declared.";
|
|
|
|
|
} // attrs);
|
|
|
|
|
|
2013-10-30 07:21:41 -06:00
|
|
|
|
mergeDefaultOption = loc: defs:
|
|
|
|
|
let list = getValues defs; in
|
2012-08-13 12:19:31 -06:00
|
|
|
|
if length list == 1 then head list
|
2013-11-12 05:48:19 -07:00
|
|
|
|
else if all isFunction list then x: mergeDefaultOption loc (map (f: f x) list)
|
2009-05-19 08:54:41 -06:00
|
|
|
|
else if all isList list then concatLists list
|
2015-07-23 09:19:21 -06:00
|
|
|
|
else if all isAttrs list then foldl' lib.mergeAttrs {} list
|
|
|
|
|
else if all isBool list then foldl' lib.or false list
|
2013-11-12 05:48:19 -07:00
|
|
|
|
else if all isString list then lib.concatStrings list
|
|
|
|
|
else if all isInt list && all (x: x == head list) list then head list
|
2013-10-30 07:21:41 -06:00
|
|
|
|
else throw "Cannot merge definitions of `${showOption loc}' given in ${showFiles (getFiles defs)}.";
|
2009-02-09 09:51:03 -07:00
|
|
|
|
|
2013-10-30 07:21:41 -06:00
|
|
|
|
mergeOneOption = loc: defs:
|
|
|
|
|
if defs == [] then abort "This case should never happen."
|
|
|
|
|
else if length defs != 1 then
|
|
|
|
|
throw "The unique option `${showOption loc}' is defined multiple times, in ${showFiles (getFiles defs)}."
|
|
|
|
|
else (head defs).value;
|
|
|
|
|
|
2015-06-15 10:04:27 -06:00
|
|
|
|
/* "Merge" option definitions by checking that they all have the same value. */
|
|
|
|
|
mergeEqualOption = loc: defs:
|
|
|
|
|
if defs == [] then abort "This case should never happen."
|
2015-07-23 09:19:21 -06:00
|
|
|
|
else foldl' (val: def:
|
2015-06-15 10:04:27 -06:00
|
|
|
|
if def.value != val then
|
|
|
|
|
throw "The option `${showOption loc}' has conflicting definitions, in ${showFiles (getFiles defs)}."
|
|
|
|
|
else
|
|
|
|
|
val) (head defs).value defs;
|
|
|
|
|
|
2013-10-30 07:21:41 -06:00
|
|
|
|
getValues = map (x: x.value);
|
|
|
|
|
getFiles = map (x: x.file);
|
2009-02-09 09:51:03 -07:00
|
|
|
|
|
|
|
|
|
|
2009-06-11 10:03:38 -06:00
|
|
|
|
# Generate documentation template from the list of option declaration like
|
|
|
|
|
# the set generated with filterOptionSets.
|
2013-10-28 07:25:58 -06:00
|
|
|
|
optionAttrSetToDocList = optionAttrSetToDocList' [];
|
|
|
|
|
|
|
|
|
|
optionAttrSetToDocList' = prefix: options:
|
2015-07-23 08:32:52 -06:00
|
|
|
|
concatMap (opt:
|
2013-10-28 07:25:58 -06:00
|
|
|
|
let
|
|
|
|
|
docOption = rec {
|
|
|
|
|
name = showOption opt.loc;
|
|
|
|
|
description = opt.description or (throw "Option `${name}' has no description.");
|
|
|
|
|
declarations = filter (x: x != unknownModule) opt.declarations;
|
|
|
|
|
internal = opt.internal or false;
|
|
|
|
|
visible = opt.visible or true;
|
2015-07-30 05:36:57 -06:00
|
|
|
|
readOnly = opt.readOnly or false;
|
2016-09-06 19:03:32 -06:00
|
|
|
|
type = opt.type.description or null;
|
2013-10-28 07:25:58 -06:00
|
|
|
|
}
|
2014-10-04 17:54:34 -06:00
|
|
|
|
// (if opt ? example then { example = scrubOptionValue opt.example; } else {})
|
|
|
|
|
// (if opt ? default then { default = scrubOptionValue opt.default; } else {})
|
|
|
|
|
// (if opt ? defaultText then { default = opt.defaultText; } else {});
|
2013-10-28 07:25:58 -06:00
|
|
|
|
|
|
|
|
|
subOptions =
|
|
|
|
|
let ss = opt.type.getSubOptions opt.loc;
|
|
|
|
|
in if ss != {} then optionAttrSetToDocList' opt.loc ss else [];
|
|
|
|
|
in
|
2015-07-23 08:32:52 -06:00
|
|
|
|
[ docOption ] ++ subOptions) (collect isOption options);
|
2009-06-11 10:03:38 -06:00
|
|
|
|
|
2009-02-09 09:51:03 -07:00
|
|
|
|
|
2010-05-12 05:07:49 -06:00
|
|
|
|
/* This function recursively removes all derivation attributes from
|
|
|
|
|
`x' except for the `name' attribute. This is to make the
|
|
|
|
|
generation of `options.xml' much more efficient: the XML
|
|
|
|
|
representation of derivations is very large (on the order of
|
|
|
|
|
megabytes) and is not actually used by the manual generator. */
|
2013-10-17 06:29:51 -06:00
|
|
|
|
scrubOptionValue = x:
|
2013-10-30 09:19:07 -06:00
|
|
|
|
if isDerivation x then
|
|
|
|
|
{ type = "derivation"; drvPath = x.name; outPath = x.name; name = x.name; }
|
2010-05-12 05:07:49 -06:00
|
|
|
|
else if isList x then map scrubOptionValue x
|
2010-06-01 08:24:16 -06:00
|
|
|
|
else if isAttrs x then mapAttrs (n: v: scrubOptionValue v) (removeAttrs x ["_args"])
|
2010-05-12 05:07:49 -06:00
|
|
|
|
else x;
|
|
|
|
|
|
2011-09-05 04:14:24 -06:00
|
|
|
|
|
|
|
|
|
/* For use in the ‘example’ option attribute. It causes the given
|
|
|
|
|
text to be included verbatim in documentation. This is necessary
|
|
|
|
|
for example values that are not simple values, e.g.,
|
|
|
|
|
functions. */
|
|
|
|
|
literalExample = text: { _type = "literalExample"; inherit text; };
|
|
|
|
|
|
|
|
|
|
|
2013-10-27 17:56:22 -06:00
|
|
|
|
/* Helper functions. */
|
|
|
|
|
showOption = concatStringsSep ".";
|
2013-10-28 12:48:30 -06:00
|
|
|
|
showFiles = files: concatStringsSep " and " (map (f: "`${f}'") files);
|
2013-10-28 07:25:58 -06:00
|
|
|
|
unknownModule = "<unknown-file>";
|
2013-10-27 17:56:22 -06:00
|
|
|
|
|
2009-05-24 04:57:41 -06:00
|
|
|
|
}
|