Distribution.Fields.Field

Cabal-like file AST types: Field, Section etc

These types are parametrized by an annotation.

Cabal file

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

fieldName :: Field ann -> Name ann

Section of field name

fieldAnn :: Field ann -> ann

fieldUniverse :: Field ann -> [Field ann]

All transitive descendants of Field, including itself.

Note: the resulting list is never empty.

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

fieldLineAnn :: FieldLine ann -> ann

Since: 3.0.0.0

fieldLineBS :: FieldLine ann -> ByteString

Since: 3.0.0.0

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

sectionArgAnn :: SectionArg ann -> ann

Extract annotation from SectionArg.

Name

type FieldName = ByteString

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

mkName :: ann -> FieldName -> Name ann

getName :: Name ann -> FieldName

nameAnn :: Name ann -> ann

Conversions to String

sectionArgsToString :: [SectionArg ann] -> String

Since: 3.6.0.0

fieldLinesToString :: [FieldLine ann] -> String

Convert [FieldLine] into String.

Note: this doesn't preserve indentation or empty lines, as the annotations (e.g. positions) are ignored.

Since: 3.6.0.0