This does break the API of being able to import any lib file and get
its libs, however I'm not sure people did this.
I made this while exploring being able to swap out docFn with a stub
in #2305, to avoid functor performance problems. I don't know if that
is going to move forward (or if it is a problem or not,) but after
doing all this work figured I'd put it up anyway :)
Two notable advantages to this approach:
1. when a lib inherits another lib's functions, it doesn't
automatically get put in to the scope of lib
2. when a lib implements a new obscure functions, it doesn't
automatically get put in to the scope of lib
Using the test script (later in this commit) I got the following diff
on the API:
+ diff master fixed-lib
11764a11765,11766
> .types.defaultFunctor
> .types.defaultTypeMerge
11774a11777,11778
> .types.isOptionType
> .types.isType
11781a11786
> .types.mkOptionType
11788a11794
> .types.setType
11795a11802
> .types.types
This means that this commit _adds_ to the API, however I can't find a
way to fix these last remaining discrepancies. At least none are
_removed_.
Test script (run with nix-repl in the PATH):
#!/bin/sh
set -eux
repl() {
suff=${1:-}
echo "(import ./lib)$suff" \
| nix-repl 2>&1
}
attrs_to_check() {
repl "${1:-}" \
| tr ';' $'\n' \
| grep "\.\.\." \
| cut -d' ' -f2 \
| sed -e "s/^/${1:-}./" \
| sort
}
summ() {
repl "${1:-}" \
| tr ' ' $'\n' \
| sort \
| uniq
}
deep_summ() {
suff="${1:-}"
depth="${2:-4}"
depth=$((depth - 1))
summ "$suff"
for attr in $(attrs_to_check "$suff" | grep -v "types.types"); do
if [ $depth -eq 0 ]; then
summ "$attr" | sed -e "s/^/$attr./"
else
deep_summ "$attr" "$depth" | sed -e "s/^/$attr./"
fi
done
}
(
cd nixpkgs
#git add .
#git commit -m "Auto-commit, sorry" || true
git checkout fixed-lib
deep_summ > ../fixed-lib
git checkout master
deep_summ > ../master
)
if diff master fixed-lib; then
echo "SHALLOW MATCH!"
fi
(
cd nixpkgs
git checkout fixed-lib
repl .types
)
(cherry picked from commit 152c63c9ff
)
102 lines
2.5 KiB
Nix
102 lines
2.5 KiB
Nix
{ lib }:
|
|
rec {
|
|
|
|
/* The identity function
|
|
For when you need a function that does “nothing”.
|
|
|
|
Type: id :: a -> a
|
|
*/
|
|
id = x: x;
|
|
|
|
/* The constant function
|
|
Ignores the second argument.
|
|
Or: Construct a function that always returns a static value.
|
|
|
|
Type: const :: a -> b -> a
|
|
Example:
|
|
let f = const 5; in f 10
|
|
=> 5
|
|
*/
|
|
const = x: y: x;
|
|
|
|
|
|
## Named versions corresponding to some builtin operators.
|
|
|
|
/* Concat two strings */
|
|
concat = x: y: x ++ y;
|
|
|
|
/* boolean “or” */
|
|
or = x: y: x || y;
|
|
|
|
/* boolean “and” */
|
|
and = x: y: x && y;
|
|
|
|
/* Convert a boolean to a string.
|
|
Note that toString on a bool returns "1" and "".
|
|
*/
|
|
boolToString = b: if b then "true" else "false";
|
|
|
|
/* Merge two attribute sets shallowly, right side trumps left
|
|
|
|
Example:
|
|
mergeAttrs { a = 1; b = 2; } { b = 3; c = 4; }
|
|
=> { a = 1; b = 3; c = 4; }
|
|
*/
|
|
mergeAttrs = x: y: x // y;
|
|
|
|
# Flip the order of the arguments of a binary function.
|
|
flip = f: a: b: f b a;
|
|
|
|
# Apply function if argument is non-null
|
|
mapNullable = f: a: if isNull a then a else f a;
|
|
|
|
# Pull in some builtins not included elsewhere.
|
|
inherit (builtins)
|
|
pathExists readFile isBool isFunction
|
|
isInt add sub lessThan
|
|
seq deepSeq genericClosure;
|
|
|
|
inherit (lib.strings) fileContents;
|
|
|
|
# Return the Nixpkgs version number.
|
|
nixpkgsVersion =
|
|
let suffixFile = ../.version-suffix; in
|
|
fileContents ../.version
|
|
+ (if pathExists suffixFile then fileContents suffixFile else "pre-git");
|
|
|
|
# Whether we're being called by nix-shell.
|
|
inNixShell = builtins.getEnv "IN_NIX_SHELL" != "";
|
|
|
|
# Return minimum/maximum of two numbers.
|
|
min = x: y: if x < y then x else y;
|
|
max = x: y: if x > y then x else y;
|
|
|
|
/* Integer modulus
|
|
|
|
Example:
|
|
mod 11 10
|
|
=> 1
|
|
mod 1 10
|
|
=> 1
|
|
*/
|
|
mod = base: int: base - (int * (builtins.div base int));
|
|
|
|
/* Reads a JSON file. */
|
|
importJSON = path:
|
|
builtins.fromJSON (builtins.readFile path);
|
|
|
|
/* See https://github.com/NixOS/nix/issues/749. Eventually we'd like these
|
|
to expand to Nix builtins that carry metadata so that Nix can filter out
|
|
the INFO messages without parsing the message string.
|
|
|
|
Usage:
|
|
{
|
|
foo = lib.warn "foo is deprecated" oldFoo;
|
|
}
|
|
|
|
TODO: figure out a clever way to integrate location information from
|
|
something like __unsafeGetAttrPos.
|
|
*/
|
|
warn = msg: builtins.trace "WARNING: ${msg}";
|
|
info = msg: builtins.trace "INFO: ${msg}";
|
|
}
|