Distribution.Client.Glob

cabal-install globbing features

data RootedGlob

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

Constructors

RootedGlob

Fields

• FilePathRoot

  what the glob is relative to

• Glob

  the glob

Instances

Parsec RootedGlob

Defined in Distribution.Simple.FileMonitor.Types

Methods

parsec :: CabalParsing m => m RootedGlob

Pretty RootedGlob

Defined in Distribution.Simple.FileMonitor.Types

Methods

pretty :: RootedGlob -> Doc

prettyVersioned :: CabalSpecVersion -> RootedGlob -> Doc

Structured RootedGlob

Defined in Distribution.Simple.FileMonitor.Types

Methods

structure :: Proxy RootedGlob -> Structure

structureHash' :: Tagged RootedGlob MD5

Generic RootedGlob

Defined in Distribution.Simple.FileMonitor.Types

Associated Types

type Rep RootedGlob :: Type -> Type

Methods

from :: RootedGlob -> Rep RootedGlob x

to :: Rep RootedGlob x -> RootedGlob

Show RootedGlob

Defined in Distribution.Simple.FileMonitor.Types

Methods

showsPrec :: Int -> RootedGlob -> ShowS

show :: RootedGlob -> String

showList :: [RootedGlob] -> ShowS

Binary RootedGlob

Defined in Distribution.Simple.FileMonitor.Types

Methods

put :: RootedGlob -> Put

get :: Get RootedGlob

putList :: [RootedGlob] -> Put

Eq RootedGlob

Defined in Distribution.Simple.FileMonitor.Types

Methods

(==) :: RootedGlob -> RootedGlob -> Bool

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

type Rep RootedGlob

Defined in Distribution.Simple.FileMonitor.Types

type Rep RootedGlob = D1 ('MetaData "RootedGlob" "Distribution.Simple.FileMonitor.Types" "Cabal-3.14.1.1-KNG8xgahazw32ECV34zzCb" 'False) (C1 ('MetaCons "RootedGlob" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePathRoot) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Glob)))

isTrivialRootedGlob :: RootedGlob -> Maybe FilePath

Check if a RootedGlob 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.

data FilePathRoot

Constructors

FilePathRelative

FilePathRoot FilePath

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

FilePathHomeDir

Instances

Parsec FilePathRoot

Defined in Distribution.Simple.FileMonitor.Types

Methods

parsec :: CabalParsing m => m FilePathRoot

Pretty FilePathRoot

Defined in Distribution.Simple.FileMonitor.Types

Methods

pretty :: FilePathRoot -> Doc

prettyVersioned :: CabalSpecVersion -> FilePathRoot -> Doc

Structured FilePathRoot

Defined in Distribution.Simple.FileMonitor.Types

Methods

structure :: Proxy FilePathRoot -> Structure

structureHash' :: Tagged FilePathRoot MD5

Generic FilePathRoot

Defined in Distribution.Simple.FileMonitor.Types

Associated Types

type Rep FilePathRoot :: Type -> Type

Methods

from :: FilePathRoot -> Rep FilePathRoot x

to :: Rep FilePathRoot x -> FilePathRoot

Show FilePathRoot

Defined in Distribution.Simple.FileMonitor.Types

Methods

showsPrec :: Int -> FilePathRoot -> ShowS

show :: FilePathRoot -> String

showList :: [FilePathRoot] -> ShowS

Binary FilePathRoot

Defined in Distribution.Simple.FileMonitor.Types

Methods

put :: FilePathRoot -> Put

get :: Get FilePathRoot

putList :: [FilePathRoot] -> Put

Eq FilePathRoot

Defined in Distribution.Simple.FileMonitor.Types

Methods

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

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

type Rep FilePathRoot

Defined in Distribution.Simple.FileMonitor.Types

type Rep FilePathRoot = D1 ('MetaData "FilePathRoot" "Distribution.Simple.FileMonitor.Types" "Cabal-3.14.1.1-KNG8xgahazw32ECV34zzCb" '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)))

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.

Additional re-exports

module Distribution.Simple.Glob

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.14.1.1-KNG8xgahazw32ECV34zzCb" '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)))

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.14.1.1-KNG8xgahazw32ECV34zzCb" '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]))))

type GlobPieces = [GlobPiece]

A single directory or file component of a globbed path

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

Match a RootedGlob 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.