Distribution.Client.Glob

Documentation

data FilePathGlob

A file path specified by globbing

Constructors

FilePathGlob FilePathRoot FilePathGlobRel

Instances

Eq FilePathGlob

Defined in Distribution.Client.Glob

Methods

(==) :: FilePathGlob -> FilePathGlob -> Bool

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

Show FilePathGlob

Defined in Distribution.Client.Glob

Methods

showsPrec :: Int -> FilePathGlob -> ShowS

show :: FilePathGlob -> String

showList :: [FilePathGlob] -> ShowS

Generic FilePathGlob

Defined in Distribution.Client.Glob

Associated Types

type Rep FilePathGlob :: Type -> Type

Methods

from :: FilePathGlob -> Rep FilePathGlob x

to :: Rep FilePathGlob x -> FilePathGlob

Binary FilePathGlob

Defined in Distribution.Client.Glob

Methods

put :: FilePathGlob -> Put

get :: Get FilePathGlob

putList :: [FilePathGlob] -> Put

Structured FilePathGlob

Defined in Distribution.Client.Glob

Methods

structure :: Proxy FilePathGlob -> Structure

structureHash' :: Tagged FilePathGlob MD5

Parsec FilePathGlob

Defined in Distribution.Client.Glob

Methods

parsec :: CabalParsing m => m FilePathGlob

Pretty FilePathGlob

Defined in Distribution.Client.Glob

Methods

pretty :: FilePathGlob -> Doc

prettyVersioned :: CabalSpecVersion -> FilePathGlob -> Doc

type Rep FilePathGlob

Defined in Distribution.Client.Glob

type Rep FilePathGlob = D1 ('MetaData "FilePathGlob" "Distribution.Client.Glob" "cabal-install-3.8.1.0-7iNu5HGLMqL9QLfLAUJqbd" 'False) (C1 ('MetaCons "FilePathGlob" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePathRoot) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePathGlobRel)))

data FilePathRoot

Constructors

FilePathRelative

FilePathRoot FilePath

e.g. "/", "c:" or result of takeDrive

FilePathHomeDir

Instances

Eq FilePathRoot

Defined in Distribution.Client.Glob

Methods

(==) :: FilePathRoot -> FilePathRoot -> Bool

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

Show FilePathRoot

Defined in Distribution.Client.Glob

Methods

showsPrec :: Int -> FilePathRoot -> ShowS

show :: FilePathRoot -> String

showList :: [FilePathRoot] -> ShowS

Generic FilePathRoot

Defined in Distribution.Client.Glob

Associated Types

type Rep FilePathRoot :: Type -> Type

Methods

from :: FilePathRoot -> Rep FilePathRoot x

to :: Rep FilePathRoot x -> FilePathRoot

Binary FilePathRoot

Defined in Distribution.Client.Glob

Methods

put :: FilePathRoot -> Put

get :: Get FilePathRoot

putList :: [FilePathRoot] -> Put

Structured FilePathRoot

Defined in Distribution.Client.Glob

Methods

structure :: Proxy FilePathRoot -> Structure

structureHash' :: Tagged FilePathRoot MD5

Parsec FilePathRoot

Defined in Distribution.Client.Glob

Methods

parsec :: CabalParsing m => m FilePathRoot

Pretty FilePathRoot

Defined in Distribution.Client.Glob

Methods

pretty :: FilePathRoot -> Doc

prettyVersioned :: CabalSpecVersion -> FilePathRoot -> Doc

type Rep FilePathRoot

Defined in Distribution.Client.Glob

type Rep FilePathRoot = D1 ('MetaData "FilePathRoot" "Distribution.Client.Glob" "cabal-install-3.8.1.0-7iNu5HGLMqL9QLfLAUJqbd" 'False) (C1 ('MetaCons "FilePathRelative" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "FilePathRoot" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath)) :+: C1 ('MetaCons "FilePathHomeDir" 'PrefixI 'False) (U1 :: Type -> Type)))

data FilePathGlobRel

Constructors

GlobDir !Glob !FilePathGlobRel

GlobFile !Glob

GlobDirTrailing

trailing dir, a glob ending in /

Instances

Eq FilePathGlobRel

Defined in Distribution.Client.Glob

Methods

(==) :: FilePathGlobRel -> FilePathGlobRel -> Bool

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

Show FilePathGlobRel

Defined in Distribution.Client.Glob

Methods

showsPrec :: Int -> FilePathGlobRel -> ShowS

show :: FilePathGlobRel -> String

showList :: [FilePathGlobRel] -> ShowS

Generic FilePathGlobRel

Defined in Distribution.Client.Glob

Associated Types

type Rep FilePathGlobRel :: Type -> Type

Methods

from :: FilePathGlobRel -> Rep FilePathGlobRel x

to :: Rep FilePathGlobRel x -> FilePathGlobRel

Binary FilePathGlobRel

Defined in Distribution.Client.Glob

Methods

put :: FilePathGlobRel -> Put

get :: Get FilePathGlobRel

putList :: [FilePathGlobRel] -> Put

Structured FilePathGlobRel

Defined in Distribution.Client.Glob

Methods

structure :: Proxy FilePathGlobRel -> Structure

structureHash' :: Tagged FilePathGlobRel MD5

Parsec FilePathGlobRel

Defined in Distribution.Client.Glob

Methods

parsec :: CabalParsing m => m FilePathGlobRel

Pretty FilePathGlobRel

Defined in Distribution.Client.Glob

Methods

pretty :: FilePathGlobRel -> Doc

prettyVersioned :: CabalSpecVersion -> FilePathGlobRel -> Doc

type Rep FilePathGlobRel

Defined in Distribution.Client.Glob

type Rep FilePathGlobRel = D1 ('MetaData "FilePathGlobRel" "Distribution.Client.Glob" "cabal-install-3.8.1.0-7iNu5HGLMqL9QLfLAUJqbd" 'False) (C1 ('MetaCons "GlobDir" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Glob) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 FilePathGlobRel)) :+: (C1 ('MetaCons "GlobFile" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Glob)) :+: C1 ('MetaCons "GlobDirTrailing" 'PrefixI 'False) (U1 :: Type -> Type)))

type Glob = [GlobPiece]

A single directory or file component of a globbed path

data GlobPiece

A piece of a globbing pattern

Constructors

WildCard

Literal String

Union [Glob]

Instances

Eq GlobPiece

Defined in Distribution.Client.Glob

Methods

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

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

Show GlobPiece

Defined in Distribution.Client.Glob

Methods

showsPrec :: Int -> GlobPiece -> ShowS

show :: GlobPiece -> String

showList :: [GlobPiece] -> ShowS

Generic GlobPiece

Defined in Distribution.Client.Glob

Associated Types

type Rep GlobPiece :: Type -> Type

Methods

from :: GlobPiece -> Rep GlobPiece x

to :: Rep GlobPiece x -> GlobPiece

Binary GlobPiece

Defined in Distribution.Client.Glob

Methods

put :: GlobPiece -> Put

get :: Get GlobPiece

putList :: [GlobPiece] -> Put

Structured GlobPiece

Defined in Distribution.Client.Glob

Methods

structure :: Proxy GlobPiece -> Structure

structureHash' :: Tagged GlobPiece MD5

type Rep GlobPiece

Defined in Distribution.Client.Glob

type Rep GlobPiece = D1 ('MetaData "GlobPiece" "Distribution.Client.Glob" "cabal-install-3.8.1.0-7iNu5HGLMqL9QLfLAUJqbd" '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 [Glob]))))

matchFileGlob :: FilePath -> FilePathGlob -> IO [FilePath]

Match a FilePathGlob against the file system, starting from a given root directory for relative paths. The results of relative globs are relative to the given root. Matches for absolute globs are absolute.

matchFileGlobRel :: FilePath -> FilePathGlobRel -> IO [FilePath]

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

matchGlob :: Glob -> String -> Bool

Match a globbing pattern against a file path component

isTrivialFilePathGlob :: FilePathGlob -> Maybe FilePath

Check if a FilePathGlob doesn't actually make use of any globbing and is in fact equivalent to a non-glob FilePath.

If it is trivial in this sense then the result is the equivalent constant FilePath. On the other hand if it is not trivial (so could in principle match more than one file) then the result is Nothing.

getFilePathRootDirectory

Arguments

:: FilePathRoot

-> FilePath

root for relative paths

-> IO FilePath

Get the FilePath corresponding to a FilePathRoot.

The FilePath argument is required to supply the path for the FilePathRelative case.