Commit 744305bc authored by Someone Serge's avatar Someone Serge
Browse files

lib: add getOutput', a nix-lang counterpart of _overrideFirst

parent f7a2522f

lib/attrsets.nix

+72 −1
Original line number Diff line number Diff line
@@ -1798,6 +1798,48 @@ rec { 
      then pkg.${output} or pkg.out or pkg

      else pkg;



  /**

    Like `getOutput` but with a list of fallback output names.

    This function is alligned with `_overrideFirst()` from the `multiple-outputs.sh` setup hook.



    # Inputs



    `outputs`



    : 1\. Function argument



    `pkg`



    : 2\. Function argument



    # Type



    ```

    getFirstOutput :: [String] -> Derivation -> String

    ```



    # Examples

    :::{.example}

    ## `lib.attrsets.getFirstOutput` usage example



    ```nix

    getFirstOutput [ "include" "dev" ] pkgs.openssl

    => "/nix/store/00000000000000000000000000000000-openssl-1.0.1r-dev"

    ```



    :::

  */

  getFirstOutput =

    candidates: pkg:

    let

      outputs = builtins.filter (name: hasAttr name pkg) candidates;

      output = builtins.head outputs;

    in

    if pkg.outputSpecified or false || outputs == [ ] then

      pkg

    else

      pkg.${output};



  /**

    Get a package's `bin` output.

    If the output does not exist, fallback to `.out` and then to the default.
@@ -1820,7 +1862,7 @@ rec { 


    ```nix

    getBin pkgs.openssl

    => "/nix/store/9rz8gxhzf8sw4kf2j2f1grr49w8zx5vj-openssl-1.0.1r"

    => "/nix/store/00000000000000000000000000000000-openssl-1.0.1r"

    ```



    :::
@@ -1887,6 +1929,35 @@ rec { 
  */

  getDev = getOutput "dev";



  /**

    Get a package's `include` output.

    If the output does not exist, fallback to `.dev`, then to `.out`, and then to the default.



    # Inputs



    `pkg`



    : The package whose `include` output will be retrieved.



    # Type



    ```

    getInclude :: Derivation -> String

    ```



    # Examples

    :::{.example}

    ## `lib.attrsets.getInclude` usage example



    ```nix

    getInclude pkgs.openssl

    => "/nix/store/00000000000000000000000000000000-openssl-1.0.1r-dev"

    ```



    :::

  */

  getInclude = getFirstOutput [ "include" "dev" "out" ];





  /**

    Get a package's `man` output.

lib/default.nix

+2 −2
Original line number Diff line number Diff line
@@ -86,8 +86,8 @@ let 
      mapAttrs' mapAttrsToList attrsToList concatMapAttrs mapAttrsRecursive

      mapAttrsRecursiveCond genAttrs isDerivation toDerivation optionalAttrs

      zipAttrsWithNames zipAttrsWith zipAttrs recursiveUpdateUntil

      recursiveUpdate matchAttrs mergeAttrsList overrideExisting showAttrPath getOutput

      getBin getLib getDev getMan chooseDevOutputs zipWithNames zip

      recursiveUpdate matchAttrs mergeAttrsList overrideExisting showAttrPath getOutput getFirstOutput

      getBin getLib getDev getInclude getMan chooseDevOutputs zipWithNames zip

      recurseIntoAttrs dontRecurseIntoAttrs cartesianProduct cartesianProductOfSets

      mapCartesianProduct updateManyAttrsByPath listToAttrs hasAttr getAttr isAttrs intersectAttrs removeAttrs;

    inherit (self.lists) singleton forEach map foldr fold foldl foldl' imap0 imap1