Safe Haskell	None
Language	Haskell2010

Distribution.FieldGrammar.Newtypes

Contents

List
Version & License
Identifiers

Description

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

Synopsis

alaList :: sep -> [a] -> List sep (Identity a) a
alaList' :: sep -> (a -> b) -> [a] -> List sep b a
data CommaVCat = CommaVCat
data CommaFSep = CommaFSep
data VCat = VCat
data FSep = FSep
data NoCommaFSep = NoCommaFSep
class Sep sep where
- prettySep :: Proxy sep -> [Doc] -> Doc
- parseSep :: CabalParsing m => Proxy sep -> m a -> m [a]
- parseSepNE :: CabalParsing m => Proxy sep -> m a -> m (NonEmpty a)
data List sep b a
alaSet :: sep -> Set a -> Set' sep (Identity a) a
alaSet' :: sep -> (a -> b) -> Set a -> Set' sep b a
data Set' sep b a
alaNonEmpty :: sep -> NonEmpty a -> NonEmpty' sep (Identity a) a
alaNonEmpty' :: sep -> (a -> b) -> NonEmpty a -> NonEmpty' sep b a
data NonEmpty' sep b a
newtype SpecVersion = SpecVersion {
- getSpecVersion :: CabalSpecVersion
}
newtype TestedWith = TestedWith {
- getTestedWith :: (CompilerFlavor, VersionRange)
}
newtype SpecLicense = SpecLicense {
- getSpecLicense :: Either License License
}
newtype Token = Token {
- getToken :: String
}
newtype Token' = Token' {
- getToken' :: String
}
newtype MQuoted a = MQuoted {
- getMQuoted :: a
}
newtype FilePathNT = FilePathNT {
- getFilePathNT :: String
}

List

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

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 Source #

More general version of alaList.

Modifiers

data CommaVCat Source #

Vertical list with commas. Displayed with vcat

Constructors

CommaVCat

Instances

Instances details

Sep CommaVCat Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods prettySep :: Proxy CommaVCat -> [Doc] -> Doc Source # parseSep :: CabalParsing m => Proxy CommaVCat -> m a -> m [a] Source # parseSepNE :: CabalParsing m => Proxy CommaVCat -> m a -> m (NonEmpty a) Source #

data CommaFSep Source #

Paragraph fill list with commas. Displayed with fsep

Constructors

CommaFSep

Instances

Instances details

Sep CommaFSep Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods prettySep :: Proxy CommaFSep -> [Doc] -> Doc Source # parseSep :: CabalParsing m => Proxy CommaFSep -> m a -> m [a] Source # parseSepNE :: CabalParsing m => Proxy CommaFSep -> m a -> m (NonEmpty a) Source #

data VCat Source #

Vertical list with optional commas. Displayed with vcat.

Constructors

VCat

Instances

Instances details

Sep VCat Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods prettySep :: Proxy VCat -> [Doc] -> Doc Source # parseSep :: CabalParsing m => Proxy VCat -> m a -> m [a] Source # parseSepNE :: CabalParsing m => Proxy VCat -> m a -> m (NonEmpty a) Source #

data FSep Source #

Paragraph fill list with optional commas. Displayed with fsep.

Constructors

FSep

Instances

Instances details

Sep FSep Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods prettySep :: Proxy FSep -> [Doc] -> Doc Source # parseSep :: CabalParsing m => Proxy FSep -> m a -> m [a] Source # parseSepNE :: CabalParsing m => Proxy FSep -> m a -> m (NonEmpty a) Source #

data NoCommaFSep Source #

Paragraph fill list without commas. Displayed with fsep.

Constructors

NoCommaFSep

Instances

Instances details

Sep NoCommaFSep Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods prettySep :: Proxy NoCommaFSep -> [Doc] -> Doc Source # parseSep :: CabalParsing m => Proxy NoCommaFSep -> m a -> m [a] Source # parseSepNE :: CabalParsing m => Proxy NoCommaFSep -> m a -> m (NonEmpty a) Source #

class Sep sep where Source #

Methods

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

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

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

Instances

Instances details

Sep CommaFSep Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods prettySep :: Proxy CommaFSep -> [Doc] -> Doc Source # parseSep :: CabalParsing m => Proxy CommaFSep -> m a -> m [a] Source # parseSepNE :: CabalParsing m => Proxy CommaFSep -> m a -> m (NonEmpty a) Source #
Sep CommaVCat Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods prettySep :: Proxy CommaVCat -> [Doc] -> Doc Source # parseSep :: CabalParsing m => Proxy CommaVCat -> m a -> m [a] Source # parseSepNE :: CabalParsing m => Proxy CommaVCat -> m a -> m (NonEmpty a) Source #
Sep FSep Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods prettySep :: Proxy FSep -> [Doc] -> Doc Source # parseSep :: CabalParsing m => Proxy FSep -> m a -> m [a] Source # parseSepNE :: CabalParsing m => Proxy FSep -> m a -> m (NonEmpty a) Source #
Sep NoCommaFSep Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods prettySep :: Proxy NoCommaFSep -> [Doc] -> Doc Source # parseSep :: CabalParsing m => Proxy NoCommaFSep -> m a -> m [a] Source # parseSepNE :: CabalParsing m => Proxy NoCommaFSep -> m a -> m (NonEmpty a) Source #
Sep VCat Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods prettySep :: Proxy VCat -> [Doc] -> Doc Source # parseSep :: CabalParsing m => Proxy VCat -> m a -> m [a] Source # parseSepNE :: CabalParsing m => Proxy VCat -> m a -> m (NonEmpty a) Source #

Type

data List sep b a Source #

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

Instances

Instances details

Newtype [a] (List sep wrapper a) Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods pack :: [a] -> List sep wrapper a Source # unpack :: List sep wrapper a -> [a] Source #
(Newtype a b, Sep sep, Parsec b) => Parsec (List sep b a) Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods parsec :: CabalParsing m => m (List sep b a) Source #
(Newtype a b, Sep sep, Pretty b) => Pretty (List sep b a) Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods pretty :: List sep b a -> Doc Source # prettyVersioned :: CabalSpecVersion -> List sep b a -> Doc Source #

Set

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

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: Cabal-syntax-3.2.0.0

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

More general version of alaSet.

Since: Cabal-syntax-3.2.0.0

data Set' sep b a Source #

Like List, but for Set.

Since: Cabal-syntax-3.2.0.0

Instances

Instances details

Newtype (Set a) (Set' sep wrapper a) Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods pack :: Set a -> Set' sep wrapper a Source # unpack :: Set' sep wrapper a -> Set a Source #
(Newtype a b, Ord a, Sep sep, Parsec b) => Parsec (Set' sep b a) Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods parsec :: CabalParsing m => m (Set' sep b a) Source #
(Newtype a b, Sep sep, Pretty b) => Pretty (Set' sep b a) Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods pretty :: Set' sep b a -> Doc Source # prettyVersioned :: CabalSpecVersion -> Set' sep b a -> Doc Source #

NonEmpty

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

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: Cabal-syntax-3.2.0.0

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

More general version of alaNonEmpty.

Since: Cabal-syntax-3.2.0.0

data NonEmpty' sep b a Source #

Like List, but for NonEmpty.

Since: Cabal-syntax-3.2.0.0

Instances

Instances details

Newtype (NonEmpty a) (NonEmpty' sep wrapper a) Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods pack :: NonEmpty a -> NonEmpty' sep wrapper a Source # unpack :: NonEmpty' sep wrapper a -> NonEmpty a Source #
(Newtype a b, Sep sep, Parsec b) => Parsec (NonEmpty' sep b a) Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods parsec :: CabalParsing m => m (NonEmpty' sep b a) Source #
(Newtype a b, Sep sep, Pretty b) => Pretty (NonEmpty' sep b a) Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods pretty :: NonEmpty' sep b a -> Doc Source # prettyVersioned :: CabalSpecVersion -> NonEmpty' sep b a -> Doc Source #

Version & License

newtype SpecVersion Source #

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

Instances details

Parsec SpecVersion Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods parsec :: CabalParsing m => m SpecVersion Source #
Pretty SpecVersion Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods pretty :: SpecVersion -> Doc Source # prettyVersioned :: CabalSpecVersion -> SpecVersion -> Doc Source #
Show SpecVersion Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods showsPrec :: Int -> SpecVersion -> ShowS Source # show :: SpecVersion -> String Source # showList :: [SpecVersion] -> ShowS Source #
Eq SpecVersion Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods (==) :: SpecVersion -> SpecVersion -> Bool # (/=) :: SpecVersion -> SpecVersion -> Bool #
Newtype CabalSpecVersion SpecVersion Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods pack :: CabalSpecVersion -> SpecVersion Source # unpack :: SpecVersion -> CabalSpecVersion Source #

newtype TestedWith Source #

Version range or just version

Constructors

TestedWith
Fields getTestedWith :: (CompilerFlavor, VersionRange)

Instances

Instances details

Parsec TestedWith Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods parsec :: CabalParsing m => m TestedWith Source #
Pretty TestedWith Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods pretty :: TestedWith -> Doc Source # prettyVersioned :: CabalSpecVersion -> TestedWith -> Doc Source #
Newtype (CompilerFlavor, VersionRange) TestedWith Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods pack :: (CompilerFlavor, VersionRange) -> TestedWith Source # unpack :: TestedWith -> (CompilerFlavor, VersionRange) Source #

newtype SpecLicense Source #

SPDX License expression or legacy license

Constructors

SpecLicense
Fields getSpecLicense :: Either License License

Instances

Instances details

Parsec SpecLicense Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods parsec :: CabalParsing m => m SpecLicense Source #
Pretty SpecLicense Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods pretty :: SpecLicense -> Doc Source # prettyVersioned :: CabalSpecVersion -> SpecLicense -> Doc Source #
Show SpecLicense Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods showsPrec :: Int -> SpecLicense -> ShowS Source # show :: SpecLicense -> String Source # showList :: [SpecLicense] -> ShowS Source #
Eq SpecLicense Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods (==) :: SpecLicense -> SpecLicense -> Bool # (/=) :: SpecLicense -> SpecLicense -> Bool #
Newtype (Either License License) SpecLicense Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods pack :: Either License License -> SpecLicense Source # unpack :: SpecLicense -> Either License License Source #

Identifiers

newtype Token Source #

Haskell string or [^ ,]+

Constructors

Token
Fields getToken :: String

Instances

Instances details

Parsec Token Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods parsec :: CabalParsing m => m Token Source #
Pretty Token Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods pretty :: Token -> Doc Source # prettyVersioned :: CabalSpecVersion -> Token -> Doc Source #
Newtype String Token Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods pack :: String -> Token Source # unpack :: Token -> String Source #

newtype Token' Source #

Haskell string or [^ ]+

Constructors

Token'
Fields getToken' :: String

Instances

Instances details

Parsec Token' Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods parsec :: CabalParsing m => m Token' Source #
Pretty Token' Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods pretty :: Token' -> Doc Source # prettyVersioned :: CabalSpecVersion -> Token' -> Doc Source #
Newtype String Token' Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods pack :: String -> Token' Source # unpack :: Token' -> String Source #

newtype MQuoted a Source #

Either "quoted" or un-quoted.

Constructors

MQuoted
Fields getMQuoted :: a

Instances

Instances details

Newtype a (MQuoted a) Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods pack :: a -> MQuoted a Source # unpack :: MQuoted a -> a Source #
Parsec a => Parsec (MQuoted a) Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods parsec :: CabalParsing m => m (MQuoted a) Source #
Pretty a => Pretty (MQuoted a) Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods pretty :: MQuoted a -> Doc Source # prettyVersioned :: CabalSpecVersion -> MQuoted a -> Doc Source #

newtype FilePathNT Source #

Filepath are parsed as Token.

Constructors

FilePathNT
Fields getFilePathNT :: String

Instances

Instances details

Parsec FilePathNT Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods parsec :: CabalParsing m => m FilePathNT Source #
Pretty FilePathNT Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods pretty :: FilePathNT -> Doc Source # prettyVersioned :: CabalSpecVersion -> FilePathNT -> Doc Source #
Newtype String FilePathNT Source #
Instance details Defined in Distribution.FieldGrammar.Newtypes Methods pack :: String -> FilePathNT Source # unpack :: FilePathNT -> String Source #