Debian.Debianize.CopyrightDescription

https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/

Documentation

data CopyrightDescription

Description of the machine readable debian/copyright file. A special case is used to represeent the old style free format file - if the value is equal to newCopyrightDescription except for the field _summaryComment, the text in _summaryComment is the copyright file.

Constructors

CopyrightDescription

Fields

• _format :: URI
• _upstreamName :: Maybe Text
• _upstreamContact :: Maybe Text
• _upstreamSource :: Maybe Text
• _disclaimer :: Maybe Text
• _summaryComment :: Maybe Text
• _summaryLicense :: Maybe (License, Maybe Text)
• _summaryCopyright :: Maybe Text
• _filesAndLicenses :: [FilesOrLicenseDescription]

Instances

Eq CopyrightDescription

Defined in Debian.Debianize.CopyrightDescription

Methods

(==) :: CopyrightDescription -> CopyrightDescription -> Bool

(/=) :: CopyrightDescription -> CopyrightDescription -> Bool

Data CopyrightDescription

Defined in Debian.Debianize.CopyrightDescription

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CopyrightDescription -> c CopyrightDescription

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CopyrightDescription

toConstr :: CopyrightDescription -> Constr

dataTypeOf :: CopyrightDescription -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CopyrightDescription)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CopyrightDescription)

gmapT :: (forall b. Data b => b -> b) -> CopyrightDescription -> CopyrightDescription

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CopyrightDescription -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CopyrightDescription -> r

gmapQ :: (forall d. Data d => d -> u) -> CopyrightDescription -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CopyrightDescription -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CopyrightDescription -> m CopyrightDescription

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CopyrightDescription -> m CopyrightDescription

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CopyrightDescription -> m CopyrightDescription

Ord CopyrightDescription

Defined in Debian.Debianize.CopyrightDescription

Methods

compare :: CopyrightDescription -> CopyrightDescription -> Ordering

(<) :: CopyrightDescription -> CopyrightDescription -> Bool

(<=) :: CopyrightDescription -> CopyrightDescription -> Bool

(>) :: CopyrightDescription -> CopyrightDescription -> Bool

(>=) :: CopyrightDescription -> CopyrightDescription -> Bool

max :: CopyrightDescription -> CopyrightDescription -> CopyrightDescription

min :: CopyrightDescription -> CopyrightDescription -> CopyrightDescription

Show CopyrightDescription

Defined in Debian.Debianize.CopyrightDescription

Methods

showsPrec :: Int -> CopyrightDescription -> ShowS

show :: CopyrightDescription -> String

showList :: [CopyrightDescription] -> ShowS

Pretty CopyrightDescription

Defined in Debian.Debianize.CopyrightDescription

Methods

pretty :: CopyrightDescription -> Doc

Default CopyrightDescription

Defined in Debian.Debianize.CopyrightDescription

Methods

def :: CopyrightDescription

Pretty (PP (PackageDescription -> IO CopyrightDescription))

Defined in Debian.Debianize.Files

Methods

pretty :: PP (PackageDescription -> IO CopyrightDescription) -> Doc

data FilesOrLicenseDescription

Constructors

FilesDescription

Fields

• _filesPattern :: FilePath
• _filesCopyright :: Text
• _filesLicense :: License
• _filesLicenseText :: Maybe Text
• _filesComment :: Maybe Text

LicenseDescription

Fields

• _license :: License
• _licenseText :: Maybe Text
• _comment :: Maybe Text

Instances

Eq FilesOrLicenseDescription

Defined in Debian.Debianize.CopyrightDescription

Methods

(==) :: FilesOrLicenseDescription -> FilesOrLicenseDescription -> Bool

(/=) :: FilesOrLicenseDescription -> FilesOrLicenseDescription -> Bool

Data FilesOrLicenseDescription

Defined in Debian.Debianize.CopyrightDescription

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> FilesOrLicenseDescription -> c FilesOrLicenseDescription

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c FilesOrLicenseDescription

toConstr :: FilesOrLicenseDescription -> Constr

dataTypeOf :: FilesOrLicenseDescription -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c FilesOrLicenseDescription)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c FilesOrLicenseDescription)

gmapT :: (forall b. Data b => b -> b) -> FilesOrLicenseDescription -> FilesOrLicenseDescription

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> FilesOrLicenseDescription -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> FilesOrLicenseDescription -> r

gmapQ :: (forall d. Data d => d -> u) -> FilesOrLicenseDescription -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> FilesOrLicenseDescription -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> FilesOrLicenseDescription -> m FilesOrLicenseDescription

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> FilesOrLicenseDescription -> m FilesOrLicenseDescription

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> FilesOrLicenseDescription -> m FilesOrLicenseDescription

Ord FilesOrLicenseDescription

Defined in Debian.Debianize.CopyrightDescription

Methods

compare :: FilesOrLicenseDescription -> FilesOrLicenseDescription -> Ordering

(<) :: FilesOrLicenseDescription -> FilesOrLicenseDescription -> Bool

(<=) :: FilesOrLicenseDescription -> FilesOrLicenseDescription -> Bool

(>) :: FilesOrLicenseDescription -> FilesOrLicenseDescription -> Bool

(>=) :: FilesOrLicenseDescription -> FilesOrLicenseDescription -> Bool

max :: FilesOrLicenseDescription -> FilesOrLicenseDescription -> FilesOrLicenseDescription

min :: FilesOrLicenseDescription -> FilesOrLicenseDescription -> FilesOrLicenseDescription

Show FilesOrLicenseDescription

Defined in Debian.Debianize.CopyrightDescription

Methods

showsPrec :: Int -> FilesOrLicenseDescription -> ShowS

show :: FilesOrLicenseDescription -> String

showList :: [FilesOrLicenseDescription] -> ShowS

Lenses

format :: Lens' CopyrightDescription URI

upstreamName :: Lens' CopyrightDescription (Maybe Text)

upstreamContact :: Lens' CopyrightDescription (Maybe Text)

upstreamSource :: Lens' CopyrightDescription (Maybe Text)

disclaimer :: Lens' CopyrightDescription (Maybe Text)

summaryComment :: Lens' CopyrightDescription (Maybe Text)

summaryLicense :: Lens' CopyrightDescription (Maybe (License, Maybe Text))

summaryCopyright :: Lens' CopyrightDescription (Maybe Text)

filesAndLicenses :: Lens' CopyrightDescription [FilesOrLicenseDescription]

filesPattern :: Traversal' FilesOrLicenseDescription FilePath

filesCopyright :: Traversal' FilesOrLicenseDescription Text

filesLicense :: Traversal' FilesOrLicenseDescription License

filesLicenseText :: Traversal' FilesOrLicenseDescription (Maybe Text)

filesComment :: Traversal' FilesOrLicenseDescription (Maybe Text)

license :: Traversal' FilesOrLicenseDescription License

licenseText :: Traversal' FilesOrLicenseDescription (Maybe Text)

comment :: Traversal' FilesOrLicenseDescription (Maybe Text)

Builders

readCopyrightDescription :: Text -> CopyrightDescription

Read a CopyrightDescription from the text one might obtain from a debian/copyright file.

parseCopyrightDescription :: [Paragraph' Text] -> Maybe CopyrightDescription

Try to parse a structured copyright file

defaultCopyrightDescription :: PackageDescription -> IO CopyrightDescription

Infer a CopyrightDescription from a Cabal package description. This will try to read any copyright files listed in the cabal configuration. Inputs include the license field from the cabal file, the contents of the license files mentioned there, and the provided copyright0 value.