Distribution.FieldGrammar.Newtypes

This module provides newtype wrappers to be used with Distribution.FieldGrammar.

List

alaList :: sep -> [a] -> List sep (Identity a) a

alaList and alaList' are simply List, with additional phantom arguments to constrain the resulting type

>>> :t alaList VCat
alaList VCat :: [a] -> List VCat (Identity a) a

>>> :t alaList' FSep Token
alaList' FSep Token :: [String] -> List FSep Token String

alaList' :: sep -> (a -> b) -> [a] -> List sep b a

More general version of alaList.

Modifiers

data CommaVCat

Vertical list with commas. Displayed with vcat

Constructors

CommaVCat

Instances

Sep CommaVCat

Defined in Distribution.FieldGrammar.Newtypes

Methods

prettySep :: Proxy CommaVCat -> [Doc] -> Doc

parseSep :: CabalParsing m => Proxy CommaVCat -> m a -> m [a]

parseSepNE :: CabalParsing m => Proxy CommaVCat -> m a -> m (NonEmpty a)

data CommaFSep

Paragraph fill list with commas. Displayed with fsep

Constructors

CommaFSep

Instances

Sep CommaFSep

Defined in Distribution.FieldGrammar.Newtypes

Methods

prettySep :: Proxy CommaFSep -> [Doc] -> Doc

parseSep :: CabalParsing m => Proxy CommaFSep -> m a -> m [a]

parseSepNE :: CabalParsing m => Proxy CommaFSep -> m a -> m (NonEmpty a)

data VCat

Vertical list with optional commas. Displayed with vcat.

Constructors

VCat

Instances

Sep VCat

Defined in Distribution.FieldGrammar.Newtypes

Methods

prettySep :: Proxy VCat -> [Doc] -> Doc

parseSep :: CabalParsing m => Proxy VCat -> m a -> m [a]

parseSepNE :: CabalParsing m => Proxy VCat -> m a -> m (NonEmpty a)

data FSep

Paragraph fill list with optional commas. Displayed with fsep.

Constructors

FSep

Instances

Sep FSep

Defined in Distribution.FieldGrammar.Newtypes

Methods

prettySep :: Proxy FSep -> [Doc] -> Doc

parseSep :: CabalParsing m => Proxy FSep -> m a -> m [a]

parseSepNE :: CabalParsing m => Proxy FSep -> m a -> m (NonEmpty a)

data NoCommaFSep

Paragraph fill list without commas. Displayed with fsep.

Constructors

NoCommaFSep

Instances

Sep NoCommaFSep

Defined in Distribution.FieldGrammar.Newtypes

Methods

prettySep :: Proxy NoCommaFSep -> [Doc] -> Doc

parseSep :: CabalParsing m => Proxy NoCommaFSep -> m a -> m [a]

parseSepNE :: CabalParsing m => Proxy NoCommaFSep -> m a -> m (NonEmpty a)

class Sep sep where

Methods

prettySep :: Proxy sep -> [Doc] -> Doc

parseSep :: CabalParsing m => Proxy sep -> m a -> m [a]

parseSepNE :: CabalParsing m => Proxy sep -> m a -> m (NonEmpty a)

Instances

Sep CommaFSep

Defined in Distribution.FieldGrammar.Newtypes

Methods

prettySep :: Proxy CommaFSep -> [Doc] -> Doc

parseSep :: CabalParsing m => Proxy CommaFSep -> m a -> m [a]

parseSepNE :: CabalParsing m => Proxy CommaFSep -> m a -> m (NonEmpty a)

Sep CommaVCat

Defined in Distribution.FieldGrammar.Newtypes

Methods

prettySep :: Proxy CommaVCat -> [Doc] -> Doc

parseSep :: CabalParsing m => Proxy CommaVCat -> m a -> m [a]

parseSepNE :: CabalParsing m => Proxy CommaVCat -> m a -> m (NonEmpty a)

Sep FSep

Defined in Distribution.FieldGrammar.Newtypes

Methods

prettySep :: Proxy FSep -> [Doc] -> Doc

parseSep :: CabalParsing m => Proxy FSep -> m a -> m [a]

parseSepNE :: CabalParsing m => Proxy FSep -> m a -> m (NonEmpty a)

Sep NoCommaFSep

Defined in Distribution.FieldGrammar.Newtypes

Methods

prettySep :: Proxy NoCommaFSep -> [Doc] -> Doc

parseSep :: CabalParsing m => Proxy NoCommaFSep -> m a -> m [a]

parseSepNE :: CabalParsing m => Proxy NoCommaFSep -> m a -> m (NonEmpty a)

Sep VCat

Defined in Distribution.FieldGrammar.Newtypes

Methods

prettySep :: Proxy VCat -> [Doc] -> Doc

parseSep :: CabalParsing m => Proxy VCat -> m a -> m [a]

parseSepNE :: CabalParsing m => Proxy VCat -> m a -> m (NonEmpty a)

Type

data List sep b a

List separated with optional commas. Displayed with sep, arguments of type a are parsed and pretty-printed as b.

Instances

Newtype [a] (List sep wrapper a)

Defined in Distribution.FieldGrammar.Newtypes

Methods

pack :: [a] -> List sep wrapper a

unpack :: List sep wrapper a -> [a]

(Newtype a b, Sep sep, Parsec b) => Parsec (List sep b a)

Defined in Distribution.FieldGrammar.Newtypes

Methods

parsec :: CabalParsing m => m (List sep b a)

(Newtype a b, Sep sep, Pretty b) => Pretty (List sep b a)

Defined in Distribution.FieldGrammar.Newtypes

Methods

pretty :: List sep b a -> Doc

prettyVersioned :: CabalSpecVersion -> List sep b a -> Doc

Set

alaSet :: sep -> Set a -> Set' sep (Identity a) a

alaSet and alaSet' are simply Set' constructor, with additional phantom arguments to constrain the resulting type

>>> :t alaSet VCat
alaSet VCat :: Set a -> Set' VCat (Identity a) a

>>> :t alaSet' FSep Token
alaSet' FSep Token :: Set String -> Set' FSep Token String

>>> unpack' (alaSet' FSep Token) <$> eitherParsec "foo bar foo"
Right (fromList ["bar","foo"])

Since: 3.2.0.0

alaSet' :: sep -> (a -> b) -> Set a -> Set' sep b a

More general version of alaSet.

Since: 3.2.0.0

data Set' sep b a

Like List, but for Set.

Since: 3.2.0.0

Instances

Newtype (Set a) (Set' sep wrapper a)

Defined in Distribution.FieldGrammar.Newtypes

Methods

pack :: Set a -> Set' sep wrapper a

unpack :: Set' sep wrapper a -> Set a

(Newtype a b, Ord a, Sep sep, Parsec b) => Parsec (Set' sep b a)

Defined in Distribution.FieldGrammar.Newtypes

Methods

parsec :: CabalParsing m => m (Set' sep b a)

(Newtype a b, Sep sep, Pretty b) => Pretty (Set' sep b a)

Defined in Distribution.FieldGrammar.Newtypes

Methods

pretty :: Set' sep b a -> Doc

prettyVersioned :: CabalSpecVersion -> Set' sep b a -> Doc

NonEmpty

alaNonEmpty :: sep -> NonEmpty a -> NonEmpty' sep (Identity a) a

alaNonEmpty and alaNonEmpty' are simply NonEmpty' constructor, with additional phantom arguments to constrain the resulting type

>>> :t alaNonEmpty VCat
alaNonEmpty VCat :: NonEmpty a -> NonEmpty' VCat (Identity a) a

>>> unpack' (alaNonEmpty' FSep Token) <$> eitherParsec "foo bar foo"
Right ("foo" :| ["bar","foo"])

Since: 3.2.0.0

alaNonEmpty' :: sep -> (a -> b) -> NonEmpty a -> NonEmpty' sep b a

More general version of alaNonEmpty.

Since: 3.2.0.0

data NonEmpty' sep b a

Like List, but for NonEmpty.

Since: 3.2.0.0

Instances

Newtype (NonEmpty a) (NonEmpty' sep wrapper a)

Defined in Distribution.FieldGrammar.Newtypes

Methods

pack :: NonEmpty a -> NonEmpty' sep wrapper a

unpack :: NonEmpty' sep wrapper a -> NonEmpty a

(Newtype a b, Sep sep, Parsec b) => Parsec (NonEmpty' sep b a)

Defined in Distribution.FieldGrammar.Newtypes

Methods

parsec :: CabalParsing m => m (NonEmpty' sep b a)

(Newtype a b, Sep sep, Pretty b) => Pretty (NonEmpty' sep b a)

Defined in Distribution.FieldGrammar.Newtypes

Methods

pretty :: NonEmpty' sep b a -> Doc

prettyVersioned :: CabalSpecVersion -> NonEmpty' sep b a -> Doc

Version & License

newtype SpecVersion

Version range or just version, i.e. cabal-version field.

There are few things to consider:

• Starting with 2.2 the cabal-version field should be the first field in the file and only exact version is accepted. Therefore if we get e.g. >= 2.2, we fail. See https://github.com/haskell/cabal/issues/4899

We have this newtype, as writing Parsec and Pretty instances for CabalSpecVersion would cause cycle in modules: Version -> CabalSpecVersion -> Parsec -> ...

Constructors

SpecVersion

Fields

• getSpecVersion :: CabalSpecVersion

Instances

Parsec SpecVersion

Defined in Distribution.FieldGrammar.Newtypes

Methods

parsec :: CabalParsing m => m SpecVersion

Pretty SpecVersion

Defined in Distribution.FieldGrammar.Newtypes

Methods

pretty :: SpecVersion -> Doc

prettyVersioned :: CabalSpecVersion -> SpecVersion -> Doc

Show SpecVersion

Defined in Distribution.FieldGrammar.Newtypes

Methods

showsPrec :: Int -> SpecVersion -> ShowS

show :: SpecVersion -> String

showList :: [SpecVersion] -> ShowS

Eq SpecVersion

Defined in Distribution.FieldGrammar.Newtypes

Methods

(==) :: SpecVersion -> SpecVersion -> Bool

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

Newtype CabalSpecVersion SpecVersion

Defined in Distribution.FieldGrammar.Newtypes

Methods

pack :: CabalSpecVersion -> SpecVersion

unpack :: SpecVersion -> CabalSpecVersion

newtype TestedWith

Version range or just version

Constructors

TestedWith

Fields

• getTestedWith :: (CompilerFlavor, VersionRange)

Instances

Parsec TestedWith

Defined in Distribution.FieldGrammar.Newtypes

Methods

parsec :: CabalParsing m => m TestedWith

Pretty TestedWith

Defined in Distribution.FieldGrammar.Newtypes

Methods

pretty :: TestedWith -> Doc

prettyVersioned :: CabalSpecVersion -> TestedWith -> Doc

Newtype (CompilerFlavor, VersionRange) TestedWith

Defined in Distribution.FieldGrammar.Newtypes

Methods

pack :: (CompilerFlavor, VersionRange) -> TestedWith

unpack :: TestedWith -> (CompilerFlavor, VersionRange)

newtype SpecLicense

SPDX License expression or legacy license

Constructors

SpecLicense

Fields

• getSpecLicense :: Either License License

Instances

Parsec SpecLicense

Defined in Distribution.FieldGrammar.Newtypes

Methods

parsec :: CabalParsing m => m SpecLicense

Pretty SpecLicense

Defined in Distribution.FieldGrammar.Newtypes

Methods

pretty :: SpecLicense -> Doc

prettyVersioned :: CabalSpecVersion -> SpecLicense -> Doc

Show SpecLicense

Defined in Distribution.FieldGrammar.Newtypes

Methods

showsPrec :: Int -> SpecLicense -> ShowS

show :: SpecLicense -> String

showList :: [SpecLicense] -> ShowS

Eq SpecLicense

Defined in Distribution.FieldGrammar.Newtypes

Methods

(==) :: SpecLicense -> SpecLicense -> Bool

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

Newtype (Either License License) SpecLicense

Defined in Distribution.FieldGrammar.Newtypes

Methods

pack :: Either License0 License -> SpecLicense

unpack :: SpecLicense -> Either License0 License

Identifiers

newtype Token

Haskell string or [^ ,]+

Constructors

Token

Fields

• getToken :: String

Instances

Parsec Token

Defined in Distribution.FieldGrammar.Newtypes

Methods

parsec :: CabalParsing m => m Token

Pretty Token

Defined in Distribution.FieldGrammar.Newtypes

Methods

pretty :: Token -> Doc

prettyVersioned :: CabalSpecVersion -> Token -> Doc

Newtype String Token

Defined in Distribution.FieldGrammar.Newtypes

Methods

pack :: String -> Token

unpack :: Token -> String

newtype Token'

Haskell string or [^ ]+

Constructors

Token'

Fields

• getToken' :: String

Instances

Parsec Token'

Defined in Distribution.FieldGrammar.Newtypes

Methods

parsec :: CabalParsing m => m Token'

Pretty Token'

Defined in Distribution.FieldGrammar.Newtypes

Methods

pretty :: Token' -> Doc

prettyVersioned :: CabalSpecVersion -> Token' -> Doc

Newtype String Token'

Defined in Distribution.FieldGrammar.Newtypes

Methods

pack :: String -> Token'

unpack :: Token' -> String

newtype MQuoted a

Either "quoted" or un-quoted.

Constructors

MQuoted

Fields

• getMQuoted :: a

Instances

Newtype a (MQuoted a)

Defined in Distribution.FieldGrammar.Newtypes

Methods

pack :: a -> MQuoted a

unpack :: MQuoted a -> a

Parsec a => Parsec (MQuoted a)

Defined in Distribution.FieldGrammar.Newtypes

Methods

parsec :: CabalParsing m => m (MQuoted a)

Pretty a => Pretty (MQuoted a)

Defined in Distribution.FieldGrammar.Newtypes

Methods

pretty :: MQuoted a -> Doc

prettyVersioned :: CabalSpecVersion -> MQuoted a -> Doc

newtype FilePathNT

Filepath are parsed as Token.

Constructors

FilePathNT

Fields

• getFilePathNT :: String

Instances

Parsec FilePathNT

Defined in Distribution.FieldGrammar.Newtypes

Methods

parsec :: CabalParsing m => m FilePathNT

Pretty FilePathNT

Defined in Distribution.FieldGrammar.Newtypes

Methods

pretty :: FilePathNT -> Doc

prettyVersioned :: CabalSpecVersion -> FilePathNT -> Doc

Newtype String FilePathNT

Defined in Distribution.FieldGrammar.Newtypes

Methods

pack :: String -> FilePathNT

unpack :: FilePathNT -> String