Distribution.Fields

Utilitiies to work with .cabal like file structure.

Types

data Field ann

A Cabal-like file consists of a series of fields (foo: bar) and sections (library ...).

Constructors

Field !(Name ann) [FieldLine ann]

Section !(Name ann) [SectionArg ann] [Field ann]

Instances

Functor Field

Defined in Distribution.Fields.Field

Methods

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

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

Foldable Field

Defined in Distribution.Fields.Field

Methods

fold :: Monoid m => Field m -> m

foldMap :: Monoid m => (a -> m) -> Field a -> m

foldMap' :: Monoid m => (a -> m) -> Field a -> m

foldr :: (a -> b -> b) -> b -> Field a -> b

foldr' :: (a -> b -> b) -> b -> Field a -> b

foldl :: (b -> a -> b) -> b -> Field a -> b

foldl' :: (b -> a -> b) -> b -> Field a -> b

foldr1 :: (a -> a -> a) -> Field a -> a

foldl1 :: (a -> a -> a) -> Field a -> a

toList :: Field a -> [a]

null :: Field a -> Bool

length :: Field a -> Int

elem :: Eq a => a -> Field a -> Bool

maximum :: Ord a => Field a -> a

minimum :: Ord a => Field a -> a

sum :: Num a => Field a -> a

product :: Num a => Field a -> a

Traversable Field

Defined in Distribution.Fields.Field

Methods

traverse :: Applicative f => (a -> f b) -> Field a -> f (Field b)

sequenceA :: Applicative f => Field (f a) -> f (Field a)

mapM :: Monad m => (a -> m b) -> Field a -> m (Field b)

sequence :: Monad m => Field (m a) -> m (Field a)

Eq ann => Eq (Field ann)

Defined in Distribution.Fields.Field

Methods

(==) :: Field ann -> Field ann -> Bool

(/=) :: Field ann -> Field ann -> Bool

Show ann => Show (Field ann)

Defined in Distribution.Fields.Field

Methods

showsPrec :: Int -> Field ann -> ShowS

show :: Field ann -> String

showList :: [Field ann] -> ShowS

data Name ann

A field name.

Invariant: ByteString is lower-case ASCII.

Constructors

Name !ann !FieldName

Instances

Functor Name

Defined in Distribution.Fields.Field

Methods

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

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

Foldable Name

Defined in Distribution.Fields.Field

Methods

fold :: Monoid m => Name m -> m

foldMap :: Monoid m => (a -> m) -> Name a -> m

foldMap' :: Monoid m => (a -> m) -> Name a -> m

foldr :: (a -> b -> b) -> b -> Name a -> b

foldr' :: (a -> b -> b) -> b -> Name a -> b

foldl :: (b -> a -> b) -> b -> Name a -> b

foldl' :: (b -> a -> b) -> b -> Name a -> b

foldr1 :: (a -> a -> a) -> Name a -> a

foldl1 :: (a -> a -> a) -> Name a -> a

toList :: Name a -> [a]

null :: Name a -> Bool

length :: Name a -> Int

elem :: Eq a => a -> Name a -> Bool

maximum :: Ord a => Name a -> a

minimum :: Ord a => Name a -> a

sum :: Num a => Name a -> a

product :: Num a => Name a -> a

Traversable Name

Defined in Distribution.Fields.Field

Methods

traverse :: Applicative f => (a -> f b) -> Name a -> f (Name b)

sequenceA :: Applicative f => Name (f a) -> f (Name a)

mapM :: Monad m => (a -> m b) -> Name a -> m (Name b)

sequence :: Monad m => Name (m a) -> m (Name a)

Eq ann => Eq (Name ann)

Defined in Distribution.Fields.Field

Methods

(==) :: Name ann -> Name ann -> Bool

(/=) :: Name ann -> Name ann -> Bool

Show ann => Show (Name ann)

Defined in Distribution.Fields.Field

Methods

showsPrec :: Int -> Name ann -> ShowS

show :: Name ann -> String

showList :: [Name ann] -> ShowS

data FieldLine ann

A line of text representing the value of a field from a Cabal file. A field may contain multiple lines.

Invariant: ByteString has no newlines.

Constructors

FieldLine !ann !ByteString

Instances

Functor FieldLine

Defined in Distribution.Fields.Field

Methods

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

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

Foldable FieldLine

Defined in Distribution.Fields.Field

Methods

fold :: Monoid m => FieldLine m -> m

foldMap :: Monoid m => (a -> m) -> FieldLine a -> m

foldMap' :: Monoid m => (a -> m) -> FieldLine a -> m

foldr :: (a -> b -> b) -> b -> FieldLine a -> b

foldr' :: (a -> b -> b) -> b -> FieldLine a -> b

foldl :: (b -> a -> b) -> b -> FieldLine a -> b

foldl' :: (b -> a -> b) -> b -> FieldLine a -> b

foldr1 :: (a -> a -> a) -> FieldLine a -> a

foldl1 :: (a -> a -> a) -> FieldLine a -> a

toList :: FieldLine a -> [a]

null :: FieldLine a -> Bool

length :: FieldLine a -> Int

elem :: Eq a => a -> FieldLine a -> Bool

maximum :: Ord a => FieldLine a -> a

minimum :: Ord a => FieldLine a -> a

sum :: Num a => FieldLine a -> a

product :: Num a => FieldLine a -> a

Traversable FieldLine

Defined in Distribution.Fields.Field

Methods

traverse :: Applicative f => (a -> f b) -> FieldLine a -> f (FieldLine b)

sequenceA :: Applicative f => FieldLine (f a) -> f (FieldLine a)

mapM :: Monad m => (a -> m b) -> FieldLine a -> m (FieldLine b)

sequence :: Monad m => FieldLine (m a) -> m (FieldLine a)

Eq ann => Eq (FieldLine ann)

Defined in Distribution.Fields.Field

Methods

(==) :: FieldLine ann -> FieldLine ann -> Bool

(/=) :: FieldLine ann -> FieldLine ann -> Bool

Show ann => Show (FieldLine ann)

Defined in Distribution.Fields.Field

Methods

showsPrec :: Int -> FieldLine ann -> ShowS

show :: FieldLine ann -> String

showList :: [FieldLine ann] -> ShowS

data SectionArg ann

Section arguments, e.g. name of the library

Constructors

SecArgName !ann !ByteString

identifier, or something which looks like number. Also many dot numbers, i.e. "7.6.3"

SecArgStr !ann !ByteString

quoted string

SecArgOther !ann !ByteString

everything else, mm. operators (e.g. in if-section conditionals)

Instances

Functor SectionArg

Defined in Distribution.Fields.Field

Methods

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

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

Foldable SectionArg

Defined in Distribution.Fields.Field

Methods

fold :: Monoid m => SectionArg m -> m

foldMap :: Monoid m => (a -> m) -> SectionArg a -> m

foldMap' :: Monoid m => (a -> m) -> SectionArg a -> m

foldr :: (a -> b -> b) -> b -> SectionArg a -> b

foldr' :: (a -> b -> b) -> b -> SectionArg a -> b

foldl :: (b -> a -> b) -> b -> SectionArg a -> b

foldl' :: (b -> a -> b) -> b -> SectionArg a -> b

foldr1 :: (a -> a -> a) -> SectionArg a -> a

foldl1 :: (a -> a -> a) -> SectionArg a -> a

toList :: SectionArg a -> [a]

null :: SectionArg a -> Bool

length :: SectionArg a -> Int

elem :: Eq a => a -> SectionArg a -> Bool

maximum :: Ord a => SectionArg a -> a

minimum :: Ord a => SectionArg a -> a

sum :: Num a => SectionArg a -> a

product :: Num a => SectionArg a -> a

Traversable SectionArg

Defined in Distribution.Fields.Field

Methods

traverse :: Applicative f => (a -> f b) -> SectionArg a -> f (SectionArg b)

sequenceA :: Applicative f => SectionArg (f a) -> f (SectionArg a)

mapM :: Monad m => (a -> m b) -> SectionArg a -> m (SectionArg b)

sequence :: Monad m => SectionArg (m a) -> m (SectionArg a)

Eq ann => Eq (SectionArg ann)

Defined in Distribution.Fields.Field

Methods

(==) :: SectionArg ann -> SectionArg ann -> Bool

(/=) :: SectionArg ann -> SectionArg ann -> Bool

Show ann => Show (SectionArg ann)

Defined in Distribution.Fields.Field

Methods

showsPrec :: Int -> SectionArg ann -> ShowS

show :: SectionArg ann -> String

showList :: [SectionArg ann] -> ShowS

type FieldName = ByteString

Grammar and parsing

readFields :: ByteString -> Either ParseError [Field Position]

Parse cabal style ByteString into list of Fields, i.e. the cabal AST.

readFields' :: ByteString -> Either ParseError ([Field Position], [LexWarning])

Like readFields but also return lexer warnings

ParseResult

data ParseResult a

A monad with failure and accumulating errors and warnings.

Instances

Monad ParseResult

Defined in Distribution.Fields.ParseResult

Methods

(>>=) :: ParseResult a -> (a -> ParseResult b) -> ParseResult b

(>>) :: ParseResult a -> ParseResult b -> ParseResult b

return :: a -> ParseResult a

Functor ParseResult

Defined in Distribution.Fields.ParseResult

Methods

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

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

Applicative ParseResult

Defined in Distribution.Fields.ParseResult

Methods

pure :: a -> ParseResult a

(<*>) :: ParseResult (a -> b) -> ParseResult a -> ParseResult b

liftA2 :: (a -> b -> c) -> ParseResult a -> ParseResult b -> ParseResult c

(*>) :: ParseResult a -> ParseResult b -> ParseResult b

(<*) :: ParseResult a -> ParseResult b -> ParseResult a

runParseResult :: ParseResult a -> ([PWarning], Either (Maybe Version, NonEmpty PError) a)

Destruct a ParseResult into the emitted warnings and either a successful value or list of errors and possibly recovered a spec-version declaration.

parseString

Arguments

:: (ByteString -> ParseResult a)

File contents to final value parser

-> Verbosity

Verbosity level

-> String

File name

-> ByteString

-> IO a

parseWarning :: Position -> PWarnType -> String -> ParseResult ()

Add a warning. This doesn't fail the parsing process.

parseWarnings :: [PWarning] -> ParseResult ()

Add multiple warnings at once.

parseFailure :: Position -> String -> ParseResult ()

Add an error, but not fail the parser yet.

For fatal failure use parseFatalFailure

parseFatalFailure :: Position -> String -> ParseResult a

Add an fatal error.

Warnings

data PWarnType

Type of parser warning. We do classify warnings.

Different application may decide not to show some, or have fatal behaviour on others

Constructors

PWTOther

Unclassified warning

PWTUTF

Invalid UTF encoding

PWTBoolCase

true or false, not True or False

PWTVersionTag

there are version with tags

PWTNewSyntax

New syntax used, but no cabal-version: >= 1.2 specified

PWTOldSyntax

Old syntax used, and cabal-version >= 1.2 specified

PWTDeprecatedField

PWTInvalidSubsection

PWTUnknownField

PWTUnknownSection

PWTTrailingFields

PWTExtraMainIs

extra main-is field

PWTExtraTestModule

extra test-module field

PWTExtraBenchmarkModule

extra benchmark-module field

PWTLexNBSP

PWTLexBOM

PWTLexTab

PWTQuirkyCabalFile

legacy cabal file that we know how to patch

PWTDoubleDash

Double dash token, most likely it's a mistake - it's not a comment

PWTMultipleSingularField

e.g. name or version should be specified only once.

PWTBuildTypeDefault

Workaround for derive-package having build-type: Default. See https://github.com/haskell/cabal/issues/5020.

PWTVersionOperator

Version operators used (without cabal-version: 1.8)

PWTVersionWildcard

Version wildcard used (without cabal-version: 1.6)

PWTSpecVersion

Warnings about cabal-version format.

PWTExperimental

Experimental feature

Instances

Bounded PWarnType

Defined in Distribution.Parsec.Warning

Methods

minBound :: PWarnType

maxBound :: PWarnType

Enum PWarnType

Defined in Distribution.Parsec.Warning

Methods

succ :: PWarnType -> PWarnType

pred :: PWarnType -> PWarnType

toEnum :: Int -> PWarnType

fromEnum :: PWarnType -> Int

enumFrom :: PWarnType -> [PWarnType]

enumFromThen :: PWarnType -> PWarnType -> [PWarnType]

enumFromTo :: PWarnType -> PWarnType -> [PWarnType]

enumFromThenTo :: PWarnType -> PWarnType -> PWarnType -> [PWarnType]

Eq PWarnType

Defined in Distribution.Parsec.Warning

Methods

(==) :: PWarnType -> PWarnType -> Bool

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

Ord PWarnType

Defined in Distribution.Parsec.Warning

Methods

compare :: PWarnType -> PWarnType -> Ordering

(<) :: PWarnType -> PWarnType -> Bool

(<=) :: PWarnType -> PWarnType -> Bool

(>) :: PWarnType -> PWarnType -> Bool

(>=) :: PWarnType -> PWarnType -> Bool

max :: PWarnType -> PWarnType -> PWarnType

min :: PWarnType -> PWarnType -> PWarnType

Show PWarnType

Defined in Distribution.Parsec.Warning

Methods

showsPrec :: Int -> PWarnType -> ShowS

show :: PWarnType -> String

showList :: [PWarnType] -> ShowS

Generic PWarnType

Defined in Distribution.Parsec.Warning

Associated Types

type Rep PWarnType :: Type -> Type

Methods

from :: PWarnType -> Rep PWarnType x

to :: Rep PWarnType x -> PWarnType

Binary PWarnType

Defined in Distribution.Parsec.Warning

Methods

put :: PWarnType -> Put

get :: Get PWarnType

putList :: [PWarnType] -> Put

NFData PWarnType

Defined in Distribution.Parsec.Warning

Methods

rnf :: PWarnType -> ()

type Rep PWarnType

Defined in Distribution.Parsec.Warning

type Rep PWarnType = D1 ('MetaData "PWarnType" "Distribution.Parsec.Warning" "Cabal-3.4.1.0-6DL0OBffl0FKxcw4uMtLyp" 'False) ((((C1 ('MetaCons "PWTOther" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "PWTUTF" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTBoolCase" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "PWTVersionTag" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "PWTNewSyntax" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTOldSyntax" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "PWTDeprecatedField" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "PWTInvalidSubsection" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTUnknownField" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "PWTUnknownSection" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "PWTTrailingFields" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTExtraMainIs" 'PrefixI 'False) (U1 :: Type -> Type))))) :+: (((C1 ('MetaCons "PWTExtraTestModule" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "PWTExtraBenchmarkModule" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTLexNBSP" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "PWTLexBOM" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "PWTLexTab" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTQuirkyCabalFile" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "PWTDoubleDash" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "PWTMultipleSingularField" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTBuildTypeDefault" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "PWTVersionOperator" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTVersionWildcard" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "PWTSpecVersion" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTExperimental" 'PrefixI 'False) (U1 :: Type -> Type))))))

data PWarning

Parser warning.

Constructors

PWarning !PWarnType !Position String

Instances

Show PWarning

Defined in Distribution.Parsec.Warning

Methods

showsPrec :: Int -> PWarning -> ShowS

show :: PWarning -> String

showList :: [PWarning] -> ShowS

Generic PWarning

Defined in Distribution.Parsec.Warning

Associated Types

type Rep PWarning :: Type -> Type

Methods

from :: PWarning -> Rep PWarning x

to :: Rep PWarning x -> PWarning

Binary PWarning

Defined in Distribution.Parsec.Warning

Methods

put :: PWarning -> Put

get :: Get PWarning

putList :: [PWarning] -> Put

NFData PWarning

Defined in Distribution.Parsec.Warning

Methods

rnf :: PWarning -> ()

type Rep PWarning

Defined in Distribution.Parsec.Warning

type Rep PWarning = D1 ('MetaData "PWarning" "Distribution.Parsec.Warning" "Cabal-3.4.1.0-6DL0OBffl0FKxcw4uMtLyp" 'False) (C1 ('MetaCons "PWarning" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PWarnType) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Position) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String))))

showPWarning :: FilePath -> PWarning -> String

Errors

data PError

Parser error.

Constructors

PError Position String

Instances

Show PError

Defined in Distribution.Parsec.Error

Methods

showsPrec :: Int -> PError -> ShowS

show :: PError -> String

showList :: [PError] -> ShowS

Generic PError

Defined in Distribution.Parsec.Error

Associated Types

type Rep PError :: Type -> Type

Methods

from :: PError -> Rep PError x

to :: Rep PError x -> PError

Binary PError

Defined in Distribution.Parsec.Error

Methods

put :: PError -> Put

get :: Get PError

putList :: [PError] -> Put

NFData PError

Defined in Distribution.Parsec.Error

Methods

rnf :: PError -> ()

type Rep PError

Defined in Distribution.Parsec.Error

type Rep PError = D1 ('MetaData "PError" "Distribution.Parsec.Error" "Cabal-3.4.1.0-6DL0OBffl0FKxcw4uMtLyp" 'False) (C1 ('MetaCons "PError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Position) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)))

showPError :: FilePath -> PError -> String

Pretty printing

data PrettyField ann

Constructors

PrettyField ann FieldName Doc

PrettySection ann FieldName [Doc] [PrettyField ann]

Instances

Functor PrettyField

Defined in Distribution.Fields.Pretty

Methods

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

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

Foldable PrettyField

Defined in Distribution.Fields.Pretty

Methods

fold :: Monoid m => PrettyField m -> m

foldMap :: Monoid m => (a -> m) -> PrettyField a -> m

foldMap' :: Monoid m => (a -> m) -> PrettyField a -> m

foldr :: (a -> b -> b) -> b -> PrettyField a -> b

foldr' :: (a -> b -> b) -> b -> PrettyField a -> b

foldl :: (b -> a -> b) -> b -> PrettyField a -> b

foldl' :: (b -> a -> b) -> b -> PrettyField a -> b

foldr1 :: (a -> a -> a) -> PrettyField a -> a

foldl1 :: (a -> a -> a) -> PrettyField a -> a

toList :: PrettyField a -> [a]

null :: PrettyField a -> Bool

length :: PrettyField a -> Int

elem :: Eq a => a -> PrettyField a -> Bool

maximum :: Ord a => PrettyField a -> a

minimum :: Ord a => PrettyField a -> a

sum :: Num a => PrettyField a -> a

product :: Num a => PrettyField a -> a

Traversable PrettyField

Defined in Distribution.Fields.Pretty

Methods

traverse :: Applicative f => (a -> f b) -> PrettyField a -> f (PrettyField b)

sequenceA :: Applicative f => PrettyField (f a) -> f (PrettyField a)

mapM :: Monad m => (a -> m b) -> PrettyField a -> m (PrettyField b)

sequence :: Monad m => PrettyField (m a) -> m (PrettyField a)

showFields :: (ann -> [String]) -> [PrettyField ann] -> String

Prettyprint a list of fields.

Note: the first argument should return Strings without newlines and properly prefixes (with --) to count as comments. This unsafety is left in place so one could generate empty lines between comment lines.

Transformation from Field

genericFromParsecFields

Arguments

:: Applicative f

=> (FieldName -> [FieldLine ann] -> f Doc)

transform field contents

-> (FieldName -> [SectionArg ann] -> f [Doc])

transform section arguments

-> [Field ann]

-> f [PrettyField ann]

fromParsecFields :: [Field ann] -> [PrettyField ann]

Simple variant of genericFromParsecField