git.iko.soy/Idris-dev
on master help sign in
Idris-dev/src/Idris/Package/Common.hs
41 lines 2.2 kB history raw
1{-|
2Module : Idris.Package.Common
3Description : Data structures common to all `iPKG` file formats.
4License : BSD3
5Maintainer : The Idris Community.
6-}
7module Idris.Package.Common where
9import Idris.Core.TT (Name)
10import Idris.Imports
11import Idris.Options (Opt(..))
13-- | Description of an Idris package.
14data PkgDesc = PkgDesc {
15 pkgname :: PkgName -- ^ Name associated with a package.
16 , pkgdeps :: [PkgName] -- ^ List of packages this package depends on.
17 , pkgbrief :: Maybe String -- ^ Brief description of the package.
18 , pkgversion :: Maybe String -- ^ Version string to associate with the package.
19 , pkgreadme :: Maybe String -- ^ Location of the README file.
20 , pkglicense :: Maybe String -- ^ Description of the licensing information.
21 , pkgauthor :: Maybe String -- ^ Author information.
22 , pkgmaintainer :: Maybe String -- ^ Maintainer information.
23 , pkghomepage :: Maybe String -- ^ Website associated with the package.
24 , pkgsourceloc :: Maybe String -- ^ Location of the source files.
25 , pkgbugtracker :: Maybe String -- ^ Location of the project's bug tracker.
26 , libdeps :: [String] -- ^ External dependencies.
27 , objs :: [String] -- ^ Object files required by the package.
28 , makefile :: Maybe String -- ^ Makefile used to build external code. Used as part of the FFI process.
29 , idris_opts :: [Opt] -- ^ List of options to give the compiler.
30 , sourcedir :: String -- ^ Source directory for Idris files.
31 , modules :: [Name] -- ^ Modules provided by the package.
32 , idris_main :: Maybe Name -- ^ If an executable in which module can the Main namespace and function be found.
33 , execout :: Maybe String -- ^ What to call the executable.
34 , idris_tests :: [Name] -- ^ Lists of tests to execute against the package.
35 } deriving (Show)
37-- | Default settings for package descriptions.
38defaultPkg :: PkgDesc
39defaultPkg = PkgDesc unInitializedPkgName [] Nothing Nothing Nothing Nothing
40 Nothing Nothing Nothing Nothing
41 Nothing [] [] Nothing [] "" [] Nothing Nothing []