| Safe Haskell | Safe-Inferred |
|---|
Cartel.Ast
Contents
Description
An abstract syntax tree for Cabal files. There are thoughts in the Cartel module documentation on why this wheel is reinvented rather than reusing the types already available in the Cabal library.
The Cabal data type represents the root of the Cabal file; all
other types in this file are ultimately components of the Cabal
type.
Much documentation in this module is copied from the Developing Cabal Packages guide at
http://www.haskell.org/cabal/users-guide/developing-packages.html
- data Logical
- newtype Version = Version {}
- data Constraint = Constraint {}
- data ConstrTree
- data BuildType
- data License
- = GPL
- | AGPL
- | LGPL
- | BSD2
- | BSD3
- | BSD4
- | MIT
- | MPL
- | Apache
- | PublicDomain
- | AllRightsReserved
- | OtherLicense
- data Compiler
- data Properties = Properties {
- prName :: String
- prVersion :: Version
- prCabalVersion :: (Int, Int)
- prBuildType :: BuildType
- prLicense :: License
- prLicenseFile :: String
- prLicenseFiles :: [String]
- prCopyright :: String
- prAuthor :: String
- prMaintainer :: String
- prStability :: String
- prHomepage :: String
- prBugReports :: String
- prPackageUrl :: String
- prSynopsis :: String
- prDescription :: [String]
- prCategory :: String
- prTestedWith :: [(Compiler, ConstrTree)]
- prDataFiles :: [String]
- prDataDir :: String
- prExtraSourceFiles :: [String]
- prExtraDocFiles :: [String]
- prExtraTmpFiles :: [String]
- data RepoKind
- data Vcs
- data Repository = Repository {
- repoVcs :: Vcs
- repoKind :: RepoKind
- repoLocation :: String
- repoBranch :: String
- repoTag :: String
- repoSubdir :: String
- data Flag = Flag {}
- data Package = Package {}
- data Language
- = Haskell98
- | Haskell2010
- data BuildInfoField
- = BuildDepends [Package]
- | OtherModules [String]
- | HsSourceDirs [String]
- | Extensions [String]
- | BuildTools [Package]
- | Buildable Bool
- | GHCOptions [String]
- | GHCProfOptions [String]
- | GHCSharedOptions [String]
- | HugsOptions [String]
- | Nhc98Options [String]
- | Includes [String]
- | InstallIncludes [String]
- | IncludeDirs [String]
- | CSources [String]
- | ExtraLibraries [String]
- | ExtraLibDirs [String]
- | CCOptions [String]
- | CPPOptions [String]
- | LDOptions [String]
- | PkgConfigDepends [Package]
- | Frameworks [String]
- | DefaultLanguage Language
- data Condition
- data CondTree
- data CondBlock a = CondBlock {}
- data LibraryField
- newtype Library = Library {
- libFields :: [LibraryField]
- data ExecutableField
- data Executable = Executable {
- exeName :: String
- exeFields :: [ExecutableField]
- data TestSuiteType
- data TestSuiteField
- data TestSuite = TestSuite {
- tsName :: String
- tsFields :: [TestSuiteField]
- data BenchmarkField
- data Benchmark = Benchmark {}
- data Cabal = Cabal {
- cProperties :: Properties
- cRepositories :: [Repository]
- cFlags :: [Flag]
- cLibrary :: Maybe Library
- cExecutables :: [Executable]
- cTestSuites :: [TestSuite]
- cBenchmarks :: [Benchmark]
Constraint trees
A version number. The Cabal documentation says this "usually" consists of a sequence of natural numbers separated by dots. Though this suggests that a version number could contain something other than natural numbers, in fact the types in the Cabal library do not allow anything other than numbers and you will get a parse error if you try to use anything else.
Therefore Cartel's Version type only allows a list of Int in
a version number.
data Constraint Source
A version constraint; used primarily when specifying the build
dependencies of a package. For example, to specify
less than version 1.0, use Constraint LT (Version [1,0]).
There is no way to express less than or equal to or greater
than or equal to; for that, use ConstrTree.
Constructors
| Constraint | |
Fields
| |
Instances
data ConstrTree Source
Expresses a tree of constraints. This is how you represent
more complex dependency relationships. For example, to represent
less than or equal to version 1.0, use
> let one = Version [1,0] > in Branch Or (Constraint LT one) (Constraint EQ one)
Combinators in Cartel.Tools help you build the most common cases.
Constructors
| Leaf Constraint | |
| Branch Logical ConstrTree ConstrTree |
Instances
Global package description
Constructors
| GPL | |
| AGPL | |
| LGPL | |
| BSD2 | |
| BSD3 | |
| BSD4 | |
| MIT | |
| MPL | |
| Apache | |
| PublicDomain | |
| AllRightsReserved | |
| OtherLicense |
data Properties Source
Global package properties. Most of the String fields are
optional; to leave them blank, use the empty string. To future
proof your code, use empty, which provides
this record already filled in with default values (which are
typically blank.) Then you only alter the fields you wish to
fill in.
Constructors
| Properties | |
Fields
| |
Instances
| Eq Properties | |
| Ord Properties | |
| Show Properties | |
| Empty Properties | A default |
Repositories
What kind of VCS repository is this?
data Repository Source
Constructors
| Repository | |
Fields
| |
Instances
| Eq Repository | |
| Ord Repository | |
| Show Repository | |
| Empty Repository | A default |
Flags
A single flag.
Constructors
| Flag | |
Fields
| |
Build information
A single package, consisting of a package name and an optional
set of constraints. Used when specifying BuildDepends,
BuildTools, and PkgConfigDepends.
Constructors
| Package | |
Fields | |
Default language. Currently not documented in Cabal docs, see
Constructors
| Haskell98 | |
| Haskell2010 |
data BuildInfoField Source
A single field of build information. This can appear in a Library, Executable, Test-Suite, or Benchmark.
Constructors
| BuildDepends [Package] | A list of packages needed to build this component |
| OtherModules [String] | Modules used but not exposed. For libraries, these are
hidden modules; for executable, these are auxiliary modules to
be linked with the file in the
|
| HsSourceDirs [String] | Root directories for the module hierarchy |
| Extensions [String] | Haskell extensions used by every module. |
| BuildTools [Package] | Programs needed to build this package, such as c2hs. |
| Buildable Bool | Is this component buildable? |
| GHCOptions [String] | |
| GHCProfOptions [String] | |
| GHCSharedOptions [String] | |
| HugsOptions [String] | |
| Nhc98Options [String] | |
| Includes [String] | Header files to be included in any compilations via C. Applies to both header files that are already installed on the system and to those coming with the package to be installed. |
| InstallIncludes [String] | Header files to be installed into |
| IncludeDirs [String] | List of diretories to search for header files when dealing with C compilations. |
| CSources [String] | C sources to be compiled and lined with the Haskell files. |
| ExtraLibraries [String] | Extra libraries to link with. |
| ExtraLibDirs [String] | Directories to search for libraries. |
| CCOptions [String] | C Compiler options. |
| CPPOptions [String] | C Preprocessor options. Undocumented, see https://github.com/haskell/cabal/issues/646 |
| LDOptions [String] | Linker options. |
| PkgConfigDepends [Package] | List of pkg-config packages needed to build this component. |
| Frameworks [String] | OS X frameworks. |
| DefaultLanguage Language |
Conditionals
Conditions to use in the if statement when defining
conitional blocks.
Constructors
| OS String | Operating system; tested against |
| Arch String | Argument is matched against |
| Impl (Compiler, Maybe ConstrTree) | Tests for the configured Haskell implementation. |
| CFlag String | Evaluates to the current assignment of the flag of the given name. Flag names are case insensitive. Testing for flags that have not been introduced with a flag section is an error. |
| CTrue | Always true. |
| CFalse | Always false. |
Tree of conditions to use in a CondBlock.
An if-then-else block.
Libraries
data LibraryField Source
A field in the Library section of the Cabal file. A
Library section can have multiple fields.
Constructors
| LibExposedModules [String] | Exposed modules. |
| LibExposed Bool | Is the library exposed? GHC can hide libraries. |
| LibConditional (CondBlock LibraryField) | The |
| LibInfo BuildInfoField | The |
The entire Library section.
Constructors
| Library | |
Fields
| |
Executables
data ExecutableField Source
A single field in an Executable section. An Executable
section may have multiple fields.
Constructors
| ExeMainIs String |
|
| ExeConditional (CondBlock ExecutableField) | An |
| ExeInfo BuildInfoField | An |
data Executable Source
An entire Executable section.
Constructors
| Executable | |
Fields
| |
Instances
Test suites
data TestSuiteType Source
What kind of test suite is this?
Constructors
| ExitcodeStdio | An |
| Detailed | The |
Instances
data TestSuiteField Source
A single field value in a test suite section. A single test suite section may contain mulitple fields.
Constructors
| TestType TestSuiteType | What kind of test this is |
| TestMainIs String | The name of the |
| TestModule String | The module exporting the |
| TestConditional (CondBlock TestSuiteField) | A test may contain zero or more conditional blocks. |
| TestInfo BuildInfoField | A test suite can contain build information fields. |
An entire test suite section.
Constructors
| TestSuite | |
Fields
| |
Benchmarks
data BenchmarkField Source
A single field in a Benchmark section. Because Cabal
currently supports only one benchmark interface, which is
exitcode-stdio-1.0, all Cartel-generated files using benchmarks
will have benchmarks of this type.
Constructors
| BenchmarkConditional (CondBlock BenchmarkField) | A benchmark can have conditional blocks. |
| BenchmarkInfo BuildInfoField | A benchmark can have build information fields. |
Constructors
| Benchmark | |
Cabal
Data for the entire Cabal file.
Constructors
| Cabal | |
Fields
| |