Distribution.Simple.Glob.Internal

Internal module for simple file globbing. Please import Distribution.Simple.Glob instead.

Documentation

data 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.

GlobFile !GlobPieces

A file glob.

GlobDirTrailing

Trailing dir; a glob ending in /.

Instances

Parsec Glob

Defined in Distribution.Simple.Glob.Internal

Methods

parsec :: CabalParsing m => m Glob

Pretty Glob

Defined in Distribution.Simple.Glob.Internal

Methods

pretty :: Glob -> Doc

prettyVersioned :: CabalSpecVersion -> Glob -> Doc

Structured Glob

Defined in Distribution.Simple.Glob.Internal

Methods

structure :: Proxy Glob -> Structure

structureHash' :: Tagged Glob MD5

Generic Glob

Defined in Distribution.Simple.Glob.Internal

Associated Types

type Rep Glob :: Type -> Type

Methods

from :: Glob -> Rep Glob x

to :: Rep Glob x -> Glob

Show Glob

Defined in Distribution.Simple.Glob.Internal

Methods

showsPrec :: Int -> Glob -> ShowS

show :: Glob -> String

showList :: [Glob] -> ShowS

Binary Glob

Defined in Distribution.Simple.Glob.Internal

Methods

put :: Glob -> Put

get :: Get Glob

putList :: [Glob] -> Put

Eq Glob

Defined in Distribution.Simple.Glob.Internal

Methods

(==) :: Glob -> Glob -> Bool

(/=) :: Glob -> Glob -> Bool

type Rep Glob

Defined in Distribution.Simple.Glob.Internal

type Rep Glob = D1 ('MetaData "Glob" "Distribution.Simple.Glob.Internal" "Cabal-3.12.1.0-IXrDPRyFYnM8N0ekMEkERa" 'False) ((C1 ('MetaCons "GlobDir" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 GlobPieces) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Glob)) :+: C1 ('MetaCons "GlobDirRecursive" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 GlobPieces))) :+: (C1 ('MetaCons "GlobFile" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 GlobPieces)) :+: C1 ('MetaCons "GlobDirTrailing" 'PrefixI 'False) (U1 :: Type -> Type)))

type GlobPieces = [GlobPiece]

A single directory or file component of a globbed path

data 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}...

Instances

Structured GlobPiece

Defined in Distribution.Simple.Glob.Internal

Methods

structure :: Proxy GlobPiece -> Structure

structureHash' :: Tagged GlobPiece MD5

Generic GlobPiece

Defined in Distribution.Simple.Glob.Internal

Associated Types

type Rep GlobPiece :: Type -> Type

Methods

from :: GlobPiece -> Rep GlobPiece x

to :: Rep GlobPiece x -> GlobPiece

Show GlobPiece

Defined in Distribution.Simple.Glob.Internal

Methods

showsPrec :: Int -> GlobPiece -> ShowS

show :: GlobPiece -> String

showList :: [GlobPiece] -> ShowS

Binary GlobPiece

Defined in Distribution.Simple.Glob.Internal

Methods

put :: GlobPiece -> Put

get :: Get GlobPiece

putList :: [GlobPiece] -> Put

Eq GlobPiece

Defined in Distribution.Simple.Glob.Internal

Methods

(==) :: GlobPiece -> GlobPiece -> Bool

(/=) :: GlobPiece -> GlobPiece -> Bool

type Rep GlobPiece

Defined in Distribution.Simple.Glob.Internal

type Rep GlobPiece = D1 ('MetaData "GlobPiece" "Distribution.Simple.Glob.Internal" "Cabal-3.12.1.0-IXrDPRyFYnM8N0ekMEkERa" 'False) (C1 ('MetaCons "WildCard" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Literal" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)) :+: C1 ('MetaCons "Union" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [GlobPieces]))))

Matching

matchGlob :: 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.

Since: 3.12.0.0

matchGlobPieces :: GlobPieces -> String -> Bool

Match a globbing pattern against a file path component

Parsing & printing

Parsing globs in a cabal package

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

enableMultidot :: CabalSpecVersion -> Bool

Parsing globs otherwise

dispGlobPieces :: GlobPieces -> Doc

isGlobEscapedChar :: Char -> Bool

Cabal package globbing errors

data GlobSyntaxError

Constructors

StarInDirectory

StarInFileName

StarInExtension

NoExtensionOnStar

EmptyGlob

LiteralFileNameGlobStar

VersionDoesNotSupportGlobStar

VersionDoesNotSupportGlob

Instances

Show GlobSyntaxError

Defined in Distribution.Simple.Glob.Internal

Methods

showsPrec :: Int -> GlobSyntaxError -> ShowS

show :: GlobSyntaxError -> String

showList :: [GlobSyntaxError] -> ShowS

Eq GlobSyntaxError

Defined in Distribution.Simple.Glob.Internal

Methods

(==) :: GlobSyntaxError -> GlobSyntaxError -> Bool

(/=) :: GlobSyntaxError -> GlobSyntaxError -> Bool

explainGlobSyntaxError :: FilePath -> GlobSyntaxError -> String

data 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!

Since: 3.12.0.0

Instances

Functor GlobResult

Defined in Distribution.Simple.Glob.Internal

Methods

fmap :: (a -> b) -> GlobResult a -> GlobResult b

(<$) :: a -> GlobResult b -> GlobResult a

Show a => Show (GlobResult a)

Defined in Distribution.Simple.Glob.Internal

Methods

showsPrec :: Int -> GlobResult a -> ShowS

show :: GlobResult a -> String

showList :: [GlobResult a] -> ShowS

Eq a => Eq (GlobResult a)

Defined in Distribution.Simple.Glob.Internal

Methods

(==) :: GlobResult a -> GlobResult a -> Bool

(/=) :: GlobResult a -> GlobResult a -> Bool

Ord a => Ord (GlobResult a)

Defined in Distribution.Simple.Glob.Internal

Methods

compare :: GlobResult a -> GlobResult a -> Ordering

(<) :: GlobResult a -> GlobResult a -> Bool

(<=) :: GlobResult a -> GlobResult a -> Bool

(>) :: GlobResult a -> GlobResult a -> Bool

(>=) :: GlobResult a -> GlobResult a -> Bool

max :: GlobResult a -> GlobResult a -> GlobResult a

min :: GlobResult a -> GlobResult a -> GlobResult a

runDirFileGlob

Arguments

:: 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.

isRecursiveInRoot :: Glob -> Bool

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

checkNameMatches :: CabalSpecVersion -> GlobPieces -> String -> Maybe (GlobResult ())

Check how the string matches the glob under this cabal version

fileGlobMatches :: 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)