hsdev-0.1.6.1: Haskell development library and tool with support of autocompletion, symbol info, go to declaration, find references etc.

Safe HaskellNone
LanguageHaskell98

HsDev.Tools.Cabal

Contents

Synopsis

Documentation

data CabalPackage Source

Constructors

CabalPackage 

Fields

cabalPackageName :: String
 
cabalPackageSynopsis :: Maybe String
 
cabalPackageDefaultVersion :: Maybe Version
 
cabalPackageInstalledVersions :: [Version]
 
cabalPackageHomepage :: Maybe String
 
cabalPackageLicense :: Maybe License
 

Instances

cabalList :: [String] -> ToolM [CabalPackage] Source

Reexports

data Version :: *

A Version represents the version of a software entity.

An instance of Eq is provided, which implements exact equality modulo reordering of the tags in the versionTags field.

An instance of Ord is also provided, which gives lexicographic ordering on the versionBranch fields (i.e. 2.1 > 2.0, 1.2.3 > 1.2.2, etc.). This is expected to be sufficient for many uses, but note that you may need to use a more specific ordering for your versioning scheme. For example, some versioning schemes may include pre-releases which have tags "pre1", "pre2", and so on, and these would need to be taken into account when determining ordering. In some cases, date ordering may be more appropriate, so the application would have to look for date tags in the versionTags field and compare those. The bottom line is, don't always assume that compare and other Ord operations are the right thing for every Version.

Similarly, concrete representations of versions may differ. One possible concrete representation is provided (see showVersion and parseVersion), but depending on the application a different concrete representation may be more appropriate.

Constructors

Version 

Fields

versionBranch :: [Int]

The numeric branch for this version. This reflects the fact that most software versions are tree-structured; there is a main trunk which is tagged with versions at various points (1,2,3...), and the first branch off the trunk after version 3 is 3.1, the second branch off the trunk after version 3 is 3.2, and so on. The tree can be branched arbitrarily, just by adding more digits.

We represent the branch as a list of Int, so version 3.2.1 becomes [3,2,1]. Lexicographic ordering (i.e. the default instance of Ord for [Int]) gives the natural ordering of branches.

versionTags :: [String]

A version can be tagged with an arbitrary list of strings. The interpretation of the list of tags is entirely dependent on the entity that this version applies to.

Instances

data License :: *

Indicates the license under which a package's source code is released. Versions of the licenses not listed here will be rejected by Hackage and cause cabal check to issue a warning.

Constructors

GPL (Maybe Version)

GNU General Public License, version 2 or version 3.

AGPL (Maybe Version)

GNU Affero General Public License, version 3.

LGPL (Maybe Version)

GNU Lesser General Public License, version 2.1 or version 3.

BSD2

2-clause BSD license.

BSD3

3-clause BSD license.

BSD4

4-clause BSD license. This license has not been approved by the OSI and is incompatible with the GNU GPL. It is provided for historical reasons and should be avoided.

MIT

MIT license.

ISC

ISC license

MPL Version

Mozilla Public License, version 2.0.

Apache (Maybe Version)

Apache License, version 2.0.

PublicDomain

The author of a package disclaims any copyright to its source code and dedicates it to the public domain. This is not a software license. Please note that it is not possible to dedicate works to the public domain in every jurisdiction, nor is a work that is in the public domain in one jurisdiction necessarily in the public domain elsewhere.

AllRightsReserved

Explicitly 'All Rights Reserved', eg for proprietary software. The package may not be legally modified or redistributed by anyone but the rightsholder.

UnspecifiedLicense

No license specified which legally defaults to 'All Rights Reserved'. The package may not be legally modified or redistributed by anyone but the rightsholder.

OtherLicense

Any other software license.

UnknownLicense String

Indicates an erroneous license name.

Instances

Eq License 
Data License 
Read License 
Show License 
Generic License 
Binary License 
Text License 
type Rep License = D1 D1License ((:+:) ((:+:) ((:+:) (C1 C1_0License (S1 NoSelector (Rec0 (Maybe Version)))) ((:+:) (C1 C1_1License (S1 NoSelector (Rec0 (Maybe Version)))) (C1 C1_2License (S1 NoSelector (Rec0 (Maybe Version)))))) ((:+:) ((:+:) (C1 C1_3License U1) (C1 C1_4License U1)) ((:+:) (C1 C1_5License U1) (C1 C1_6License U1)))) ((:+:) ((:+:) ((:+:) (C1 C1_7License U1) (C1 C1_8License (S1 NoSelector (Rec0 Version)))) ((:+:) (C1 C1_9License (S1 NoSelector (Rec0 (Maybe Version)))) (C1 C1_10License U1))) ((:+:) ((:+:) (C1 C1_11License U1) (C1 C1_12License U1)) ((:+:) (C1 C1_13License U1) (C1 C1_14License (S1 NoSelector (Rec0 String)))))))