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; # Compute the fixed point of the given function `f`, which is usually an # attribute set that expects its final, non-recursive representation as an # argument: # # f = self: { foo = "foo"; bar = "bar"; foobar = self.foo + self.bar; } # # Nix evaluates this recursion until all references to `self` have been # resolved. At that point, the final result is returned and `f x = x` holds: # # nix-repl> fix f # { bar = "bar"; foo = "foo"; foobar = "foobar"; } # # See https://en.wikipedia.org/wiki/Fixed-point_combinator for further # details. fix = f: let x = f x; in x; # A variant of `fix` that records the original recursive attribute set in the # result. This is useful in combination with the `extends` function to # implement deep overriding. See pkgs/development/haskell-modules/default.nix # for a concrete example. fix' = f: let x = f x // { __unfix__ = f; }; in x; # Modify the contents of an explicitly recursive attribute set in a way that # honors `self`-references. This is accomplished with a function # # g = self: super: { foo = super.foo + " + "; } # # that has access to the unmodified input (`super`) as well as the final # non-recursive representation of the attribute set (`self`). `extends` # differs from the native `//` operator insofar as that it's applied *before* # references to `self` are resolved: # # nix-repl> fix (extends g f) # { bar = "bar"; foo = "foo + "; foobar = "foo + bar"; } # # The name of the function is inspired by object-oriented inheritance, i.e. # think of it as an infix operator `g extends f` that mimics the syntax from # Java. It may seem counter-intuitive to have the "base class" as the second # argument, but it's nice this way if several uses of `extends` are cascaded. extends = f: rattrs: self: let super = rattrs self; in super // f self super; # Compose two extending functions of the type expected by 'extends' # into one where changes made in the first are available in the # 'super' of the second composeExtensions = f: g: self: super: let fApplied = f self super; super' = super // fApplied; in fApplied // g self super'; # Create an overridable, recursive attribute set. For example: # # nix-repl> obj = makeExtensible (self: { }) # # nix-repl> obj # { __unfix__ = «lambda»; extend = «lambda»; } # # nix-repl> obj = obj.extend (self: super: { foo = "foo"; }) # # nix-repl> obj # { __unfix__ = «lambda»; extend = «lambda»; foo = "foo"; } # # nix-repl> obj = obj.extend (self: super: { foo = super.foo + " + "; bar = "bar"; foobar = self.foo + self.bar; }) # # nix-repl> obj # { __unfix__ = «lambda»; bar = "bar"; extend = «lambda»; foo = "foo + "; foobar = "foo + bar"; } makeExtensible = makeExtensibleWithCustomName "extend"; # Same as `makeExtensible` but the name of the extending attribute is # customized. makeExtensibleWithCustomName = extenderName: rattrs: fix' rattrs // { ${extenderName} = f: makeExtensibleWithCustomName extenderName (extends f rattrs); }; # 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 (import ./strings.nix) 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; /* 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}"; }