ModuleCabal-syntax-3.18.1.0Haskell2010

Distribution.Fields.Field

Cabal-like file AST types: Field, Section etc

These types are parameterized by an annotation.

5 types
11 values

PackageCabal-syntax-3.18.1.0
Exports16
LanguageHaskell2010
LicenceBSD-3-Clause
SourceField.hs

Cabal file

9 declarations

datadata 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]

Instances7Functor, Foldable, Traversable, Foldable1, Eq, Ord, …

Functor FieldDefined in Cabal-syntax-3.18.1.0 · Distribution.Fields.Field
Foldable FieldDefined in Cabal-syntax-3.18.1.0 · Distribution.Fields.Field
Traversable FieldDefined in Cabal-syntax-3.18.1.0 · Distribution.Fields.Field
Foldable1 FieldDefined in Cabal-syntax-3.18.1.0 · Distribution.Fields.Field
Eq ann => Eq (Field ann)Defined in Cabal-syntax-3.18.1.0 · Distribution.Fields.Field
Ord ann => Ord (Field ann)Defined in Cabal-syntax-3.18.1.0 · Distribution.Fields.Field
Show ann => Show (Field ann)Defined in Cabal-syntax-3.18.1.0 · Distribution.Fields.Field

valuefieldName :: Field ann -> Name ann

Section of field name

valuefieldAnn :: Field ann -> ann

valuefieldUniverse :: Field ann -> [Field ann]

All transitive descendants of Field, including itself.

Note: the resulting list is never empty.

datadata 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

Instances7Functor, Foldable, Traversable, Foldable1, Eq, Ord, …

Functor FieldLineDefined in Cabal-syntax-3.18.1.0 · Distribution.Fields.Field
Foldable FieldLineDefined in Cabal-syntax-3.18.1.0 · Distribution.Fields.Field
Traversable FieldLineDefined in Cabal-syntax-3.18.1.0 · Distribution.Fields.Field
Foldable1 FieldLineDefined in Cabal-syntax-3.18.1.0 · Distribution.Fields.Field
Eq ann => Eq (FieldLine ann)Defined in Cabal-syntax-3.18.1.0 · Distribution.Fields.Field
Ord ann => Ord (FieldLine ann)Defined in Cabal-syntax-3.18.1.0 · Distribution.Fields.Field
Show ann => Show (FieldLine ann)Defined in Cabal-syntax-3.18.1.0 · Distribution.Fields.Field

valuefieldLineAnn :: FieldLine ann -> ann

valuefieldLineBS :: FieldLine ann -> ByteString

datadata 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)

Instances7Functor, Foldable, Traversable, Foldable1, Eq, Ord, …

Functor SectionArgDefined in Cabal-syntax-3.18.1.0 · Distribution.Fields.Field
Foldable SectionArgDefined in Cabal-syntax-3.18.1.0 · Distribution.Fields.Field
Traversable SectionArgDefined in Cabal-syntax-3.18.1.0 · Distribution.Fields.Field
Foldable1 SectionArgDefined in Cabal-syntax-3.18.1.0 · Distribution.Fields.Field
Eq ann => Eq (SectionArg ann)Defined in Cabal-syntax-3.18.1.0 · Distribution.Fields.Field
Ord ann => Ord (SectionArg ann)Defined in Cabal-syntax-3.18.1.0 · Distribution.Fields.Field
Show ann => Show (SectionArg ann)Defined in Cabal-syntax-3.18.1.0 · Distribution.Fields.Field

valuesectionArgAnn :: SectionArg ann -> ann

Extract annotation from SectionArg.

Name

5 declarations

typetype FieldName = ByteString

datadata Name ann

A field name.

Invariant: ByteString is lower-case ASCII.

Constructors

Name !ann !FieldName

Instances7Functor, Foldable, Traversable, Foldable1, Eq, Ord, …

Functor NameDefined in Cabal-syntax-3.18.1.0 · Distribution.Fields.Field
Foldable NameDefined in Cabal-syntax-3.18.1.0 · Distribution.Fields.Field
Traversable NameDefined in Cabal-syntax-3.18.1.0 · Distribution.Fields.Field
Foldable1 NameDefined in Cabal-syntax-3.18.1.0 · Distribution.Fields.Field
Eq ann => Eq (Name ann)Defined in Cabal-syntax-3.18.1.0 · Distribution.Fields.Field
Ord ann => Ord (Name ann)Defined in Cabal-syntax-3.18.1.0 · Distribution.Fields.Field
Show ann => Show (Name ann)Defined in Cabal-syntax-3.18.1.0 · Distribution.Fields.Field

valuemkName :: ann -> FieldName -> Name ann

valuegetName :: Name ann -> FieldName

valuenameAnn :: Name ann -> ann

Conversions to String

2 declarations

valuesectionArgsToString :: [SectionArg ann] -> String

valuefieldLinesToString :: [FieldLine ann] -> String

Convert [FieldLine] into String.

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