Distribution.Client.Glob · cabal-install-3.18.1.0

valueexplainGlobSyntaxError :: FilePath -> GlobSyntaxError -> String

valuefileGlobMatches

:: CabalSpecVersion
-> Glob
-> FilePath
-> Maybe (GlobResult ())

How/does the glob match the given filepath, according to the cabal version? Since this is pure, we don't make a distinction between matching on directories or files (i.e. this function won't return GlobMatchesDirectory)

valueglobMatches :: [GlobResult a] -> [a]

#

Extract the matches from a list of GlobResults.

Note: throws away the GlobMissingDirectory results; chances are that you want to check for these and error out if any are present.

valueisRecursiveInRoot :: Glob -> Bool

#

Is the root of this relative glob path a directory-recursive wildcard, e.g. **/*.txt ?

valuematchDirFileGlob

:: Verbosity
-> CabalSpecVersion
-> Maybe (SymbolicPath CWD ('Dir dir))
-> SymbolicPathX allowAbs dir file
-> IO [SymbolicPathX allowAbs dir file]

#

This will die' when the glob matches no files, or if the glob refers to a missing directory, or if the glob fails to parse.

The Version argument must be the spec version of the package description being processed, as globs behave slightly differently in different spec versions.

The first FilePath argument is the directory that the glob is relative to. It must be a valid directory (and hence it can't be the empty string). The returned values will not include this prefix.

The second FilePath is the glob itself.

valuematchDirFileGlobWithDie

:: Verbosity
-> forall res. Verbosity -> CabalException -> IO [res]
-> CabalSpecVersion
-> Maybe (SymbolicPath CWD ('Dir dir))
-> SymbolicPathX allowAbs dir file
-> IO [SymbolicPathX allowAbs dir file]

#

Like matchDirFileGlob but with customizable die

valuematchGlob :: FilePath -> Glob -> IO [FilePath]

#

Match a Glob against the file system, starting from a given root directory. The results are all relative to the given root.

valuematchGlobPieces :: GlobPieces -> String -> Bool

#

Match a globbing pattern against a file path component

valueparseFileGlob :: CabalSpecVersion -> FilePath -> Either GlobSyntaxError Glob

#

valuerunDirFileGlob

:: Verbosity
-> Maybe CabalSpecVersion
If the glob we are running should care about the cabal spec, and warnings such as GlobWarnMultiDot, then this should be the version. If you want to run a glob but don't care about any of the cabal-spec restrictions on globs, use Nothing!
-> FilePath
-> Glob
-> IO [GlobResult FilePath]

#

Match files against a pre-parsed glob, starting in a directory.

The Version argument must be the spec version of the package description being processed, as globs behave slightly differently in different spec versions.

The FilePath argument is the directory that the glob is relative to. It must be a valid directory (and hence it can't be the empty string). The returned values will not include this prefix.

valuegetFilePathRootDirectory :: FilePathRoot -> FilePath -> IO FilePath

#

valueisTrivialRootedGlob :: RootedGlob -> Maybe FilePath

#

valuematchFileGlob :: FilePath -> RootedGlob -> IO [FilePath]

#

datadata FilePathRoot

#

Constructors

FilePathRelative
FilePathRoot FilePath
e.g. "/", "c:" or result of takeDrive
FilePathHomeDir

Instances8Eq, Show, Generic, Binary, Parsec, Pretty, …

Eq FilePathRootDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
Show FilePathRootDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
Generic FilePathRootDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
Binary FilePathRootDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
Parsec FilePathRootDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
Pretty FilePathRootDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
Structured FilePathRootDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
type Rep FilePathRoot = D1 ('MetaData "FilePathRoot" "Distribution.Simple.FileMonitor.Types" "Cabal-3.18.1.0-2e60" 'False) (C1 ('MetaCons "FilePathRelative" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "FilePathRoot" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath)) :+: C1 ('MetaCons "FilePathHomeDir" 'PrefixI 'False) U1))Defined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types

datadata RootedGlob

#

A file path specified by globbing, relative to some root directory.

Constructors

RootedGlob FilePathRoot Glob

Instances8Eq, Show, Generic, Binary, Parsec, Pretty, …

Eq RootedGlobDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
Show RootedGlobDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
Generic RootedGlobDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
Binary RootedGlobDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
Parsec RootedGlobDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
Pretty RootedGlobDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
Structured RootedGlobDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
type Rep RootedGlob = D1 ('MetaData "RootedGlob" "Distribution.Simple.FileMonitor.Types" "Cabal-3.18.1.0-2e60" 'False) (C1 ('MetaCons "RootedGlob" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePathRoot) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Glob)))Defined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types

datadata GlobResult a

#

Constructors

GlobMatch a
The glob matched the value supplied.
GlobWarnMultiDot a
The glob did not match the value supplied because the cabal-version is too low and the extensions on the file did not precisely match the glob's extensions, but rather the glob was a proper suffix of the file's extensions; i.e., if not for the low cabal-version, it would have matched.
GlobMissingDirectory a
The glob couldn't match because the directory named doesn't exist. The directory will be as it appears in the glob (i.e., relative to the directory passed to matchDirFileGlob, and, for 'data-files', relative to 'data-dir').
GlobMatchesDirectory a
The glob matched a directory when we were looking for files only. It didn't match a file!

Instances4Functor, Eq, Ord, Show

Functor GlobResultDefined in Cabal-3.18.1.0 · Distribution.Simple.Glob
Eq a => Eq (GlobResult a)Defined in Cabal-3.18.1.0 · Distribution.Simple.Glob
Ord a => Ord (GlobResult a)Defined in Cabal-3.18.1.0 · Distribution.Simple.Glob
Show a => Show (GlobResult a)Defined in Cabal-3.18.1.0 · Distribution.Simple.Glob

datadata GlobSyntaxError

#

StarInDirectory StarInFileName StarInExtension NoExtensionOnStar EmptyGlob LiteralFileNameGlobStar VersionDoesNotSupportGlobStar VersionDoesNotSupportGlob

Instances2Eq, Show

Eq GlobSyntaxErrorDefined in Cabal-3.18.1.0 · Distribution.Simple.Glob
Show GlobSyntaxErrorDefined in Cabal-3.18.1.0 · Distribution.Simple.Glob

datadata Glob

#

A filepath specified by globbing.

Constructors

GlobDir !GlobPieces !Glob
```
dirGlob/glob
```
GlobDirRecursive !GlobPieces
**/glob, where ** denotes recursively traversing all directories and matching filenames on glob.
Note that the glob portion can only match on filenames, not paths, so for example **foo*.txt is not supported.
GlobFile !GlobPieces
A file glob.
GlobDirTrailing
Trailing dir; a glob ending in /.

Instances8Eq, Show, Generic, Binary, Parsec, Pretty, …

Eq GlobDefined in Cabal-3.18.1.0 · Distribution.Simple.Glob.Internal
Show GlobDefined in Cabal-3.18.1.0 · Distribution.Simple.Glob.Internal
Generic GlobDefined in Cabal-3.18.1.0 · Distribution.Simple.Glob.Internal
Binary GlobDefined in Cabal-3.18.1.0 · Distribution.Simple.Glob.Internal
Parsec GlobDefined in Cabal-3.18.1.0 · Distribution.Simple.Glob.Internal
Pretty GlobDefined in Cabal-3.18.1.0 · Distribution.Simple.Glob.Internal
Structured GlobDefined in Cabal-3.18.1.0 · Distribution.Simple.Glob.Internal
type Rep Glob = D1 ('MetaData "Glob" "Distribution.Simple.Glob.Internal" "Cabal-3.18.1.0-2e60" 'False) ((C1 ('MetaCons "GlobDir" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 GlobPieces) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Glob)) :+: C1 ('MetaCons "GlobDirRecursive" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 GlobPieces))) :+: (C1 ('MetaCons "GlobFile" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 GlobPieces)) :+: C1 ('MetaCons "GlobDirTrailing" 'PrefixI 'False) U1))Defined in Cabal-3.18.1.0 · Distribution.Simple.Glob.Internal

datadata GlobPiece

#

A piece of a globbing pattern

Constructors

WildCard
A wildcard *
Literal String
A literal string dirABC
Union [GlobPieces]
A union of patterns, e.g. dir{a,*.txt,c}...

Instances6Eq, Show, Generic, Binary, Structured, Rep

Eq GlobPieceDefined in Cabal-3.18.1.0 · Distribution.Simple.Glob.Internal
Show GlobPieceDefined in Cabal-3.18.1.0 · Distribution.Simple.Glob.Internal
Generic GlobPieceDefined in Cabal-3.18.1.0 · Distribution.Simple.Glob.Internal
Binary GlobPieceDefined in Cabal-3.18.1.0 · Distribution.Simple.Glob.Internal
Structured GlobPieceDefined in Cabal-3.18.1.0 · Distribution.Simple.Glob.Internal
type Rep GlobPiece = D1 ('MetaData "GlobPiece" "Distribution.Simple.Glob.Internal" "Cabal-3.18.1.0-2e60" 'False) (C1 ('MetaCons "WildCard" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "Literal" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)) :+: C1 ('MetaCons "Union" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [GlobPieces]))))Defined in Cabal-3.18.1.0 · Distribution.Simple.Glob.Internal

typetype GlobPieces = [GlobPiece]

#

A single directory or file component of a globbed path