commit 9bfc4bbd63433c44aba71b01c54fa3c5130fcb0f · pyrox.dev/nixpkgs

doc/doc-support/lib-function-docs.nix

···

       22
       22
        
           docgen lists 'List manipulation functions'

     

       23
       23
        
           docgen debug 'Debugging functions'

     

       24
       24
        
           docgen options 'NixOS / nixpkgs option handling'

     

       25
       25
       +
           docgen filesystem 'Filesystem functions'

     

       25
       26
        
           docgen sources 'Source filtering functions'

     

       26
       27
        
         '';

     

       27
       28
        
       }

doc/functions/library.xml

···

       26
       26
        
       

     

       27
       27
        
        <xi:include href="./library/generated/options.xml" />

     

       28
       28
        
       

     

       29
       29
       +
        <xi:include href="./library/generated/filesystem.xml" />

     

       30
       30
       +
       

     

       29
       31
        
        <xi:include href="./library/generated/sources.xml" />

     

       30
       32
        
       </section>

+40 -18

lib/filesystem.nix

···

       1
       1
       +
       # Functions for copying sources to the Nix store.

     

       1
       2
        
       { lib }:

     

       2
       2
       -
       { # haskellPathsInDir : Path -> Map String Path

     

       3
       3
       -
         # A map of all haskell packages defined in the given path,

     

       4
       4
       -
         # identified by having a cabal file with the same name as the

     

       5
       5
       -
         # directory itself.

     

       6
       6
       -
         haskellPathsInDir = root:

     

       3
       3
       +
       

     

       4
       4
       +
       let

     

       5
       5
       +
         inherit (lib.strings)

     

       6
       6
       +
           hasPrefix

     

       7
       7
       +
           ;

     

       8
       8
       +
       in

     

       9
       9
       +
       

     

       10
       10
       +
       {

     

       11
       11
       +
         /*

     

       12
       12
       +
           A map of all haskell packages defined in the given path,

     

       13
       13
       +
           identified by having a cabal file with the same name as the

     

       14
       14
       +
           directory itself.

     

       15
       15
       +
       

     

       16
       16
       +
           Type: Path -> Map String Path

     

       17
       17
       +
         */

     

       18
       18
       +
         haskellPathsInDir =

     

       19
       19
       +
           # The directory within to search

     

       20
       20
       +
           root:

     

       7
       21
        
           let # Files in the root

     

       8
       22
        
               root-files = builtins.attrNames (builtins.readDir root);

     

       9
       23
        
               # Files with their full paths

     
···

       17
       31
        
                   builtins.pathExists (value + "/${name}.cabal")

     

       18
       32
        
                 ) root-files-with-paths;

     

       19
       33
        
           in builtins.listToAttrs cabal-subdirs;

     

       20
       20
       -
         # locateDominatingFile :  RegExp

     

       21
       21
       -
         #                      -> Path

     

       22
       22
       -
         #                      -> Nullable { path : Path;

     

       23
       23
       -
         #                                    matches : [ MatchResults ];

     

       24
       24
       -
         #                                  }

     

       25
       25
       -
         # Find the first directory containing a file matching 'pattern'

     

       26
       26
       -
         # upward from a given 'file'.

     

       27
       27
       -
         # Returns 'null' if no directories contain a file matching 'pattern'.

     

       28
       28
       -
         locateDominatingFile = pattern: file:

     

       34
       34
       +
         /*

     

       35
       35
       +
           Find the first directory containing a file matching 'pattern'

     

       36
       36
       +
           upward from a given 'file'.

     

       37
       37
       +
           Returns 'null' if no directories contain a file matching 'pattern'.

     

       38
       38
       +
       

     

       39
       39
       +
           Type: RegExp -> Path -> Nullable { path : Path; matches : [ MatchResults ]; }

     

       40
       40
       +
         */

     

       41
       41
       +
         locateDominatingFile =

     

       42
       42
       +
           # The pattern to search for

     

       43
       43
       +
           pattern:

     

       44
       44
       +
           # The file to start searching upward from

     

       45
       45
       +
           file:

     

       29
       46
        
           let go = path:

     

       30
       47
        
                 let files = builtins.attrNames (builtins.readDir path);

     

       31
       48
        
                     matches = builtins.filter (match: match != null)

     
···

       44
       61
        
           in go (if isDir then file else parent);

     

       45
       62
        
       

     

       46
       63
        
       

     

       47
       47
       -
         # listFilesRecursive: Path -> [ Path ]

     

       48
       48
       -
         #

     

       49
       49
       -
         # Given a directory, return a flattened list of all files within it recursively.

     

       50
       50
       -
         listFilesRecursive = dir: lib.flatten (lib.mapAttrsToList (name: type:

     

       64
       64
       +
         /*

     

       65
       65
       +
           Given a directory, return a flattened list of all files within it recursively.

     

       66
       66
       +
       

     

       67
       67
       +
           Type: Path -> [ Path ]

     

       68
       68
       +
         */

     

       69
       69
       +
         listFilesRecursive =

     

       70
       70
       +
           # The path to recursively list

     

       71
       71
       +
           dir:

     

       72
       72
       +
           lib.flatten (lib.mapAttrsToList (name: type:

     

       51
       73
        
           if type == "directory" then

     

       52
       74
        
             lib.filesystem.listFilesRecursive (dir + "/${name}")

     

       53
       75
        
           else