Safe Haskell	Safe-Inferred
Language	Haskell2010

Debian.Debianize.CopyrightDescription

Contents

Lenses
Builders

Description

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

Synopsis

data CopyrightDescription = CopyrightDescription {
- _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]
}
data FilesOrLicenseDescription
- = FilesDescription {
  - _filesPattern :: FilePath
  - _filesCopyright :: Text
  - _filesLicense :: License
  - _filesLicenseText :: Maybe Text
  - _filesComment :: Maybe Text
  }
- | LicenseDescription {
  - _license :: License
  - _licenseText :: Maybe Text
  - _comment :: Maybe Text
  }
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)
readCopyrightDescription :: Text -> CopyrightDescription
parseCopyrightDescription :: [Paragraph' Text] -> Maybe CopyrightDescription
defaultCopyrightDescription :: PackageDescription -> IO CopyrightDescription

Documentation

data CopyrightDescription Source #

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

Instances details

Pretty CopyrightDescription Source #
Instance details Defined in Debian.Debianize.CopyrightDescription Methods pretty :: CopyrightDescription -> Doc # prettyVersioned :: CabalSpecVersion -> CopyrightDescription -> Doc #
Data CopyrightDescription Source #
Instance details 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 :: forall r r'. (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 #
Show CopyrightDescription Source #
Instance details Defined in Debian.Debianize.CopyrightDescription Methods showsPrec :: Int -> CopyrightDescription -> ShowS # show :: CopyrightDescription -> String # showList :: [CopyrightDescription] -> ShowS #
Default CopyrightDescription Source #
Instance details Defined in Debian.Debianize.CopyrightDescription Methods def :: CopyrightDescription #
Eq CopyrightDescription Source #
Instance details Defined in Debian.Debianize.CopyrightDescription Methods (==) :: CopyrightDescription -> CopyrightDescription -> Bool # (/=) :: CopyrightDescription -> CopyrightDescription -> Bool #
Ord CopyrightDescription Source #
Instance details 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 #
Pretty (PP (PackageDescription -> IO CopyrightDescription)) Source #
Instance details Defined in Debian.Debianize.Files Methods pretty :: PP (PackageDescription -> IO CopyrightDescription) -> Doc # prettyVersioned :: CabalSpecVersion -> PP (PackageDescription -> IO CopyrightDescription) -> Doc #

data FilesOrLicenseDescription Source #

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

Instances details

Data FilesOrLicenseDescription Source #
Instance details 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 :: forall r r'. (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 #
Show FilesOrLicenseDescription Source #
Instance details Defined in Debian.Debianize.CopyrightDescription Methods showsPrec :: Int -> FilesOrLicenseDescription -> ShowS # show :: FilesOrLicenseDescription -> String # showList :: [FilesOrLicenseDescription] -> ShowS #
Eq FilesOrLicenseDescription Source #
Instance details Defined in Debian.Debianize.CopyrightDescription Methods (==) :: FilesOrLicenseDescription -> FilesOrLicenseDescription -> Bool # (/=) :: FilesOrLicenseDescription -> FilesOrLicenseDescription -> Bool #
Ord FilesOrLicenseDescription Source #
Instance details 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 #

Lenses

format :: Lens' CopyrightDescription URI Source #

upstreamName :: Lens' CopyrightDescription (Maybe Text) Source #

upstreamContact :: Lens' CopyrightDescription (Maybe Text) Source #

upstreamSource :: Lens' CopyrightDescription (Maybe Text) Source #

disclaimer :: Lens' CopyrightDescription (Maybe Text) Source #

summaryComment :: Lens' CopyrightDescription (Maybe Text) Source #

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

summaryCopyright :: Lens' CopyrightDescription (Maybe Text) Source #

filesAndLicenses :: Lens' CopyrightDescription [FilesOrLicenseDescription] Source #

filesPattern :: Traversal' FilesOrLicenseDescription FilePath Source #

filesCopyright :: Traversal' FilesOrLicenseDescription Text Source #

filesLicense :: Traversal' FilesOrLicenseDescription License Source #

filesLicenseText :: Traversal' FilesOrLicenseDescription (Maybe Text) Source #

filesComment :: Traversal' FilesOrLicenseDescription (Maybe Text) Source #

license :: Traversal' FilesOrLicenseDescription License Source #

licenseText :: Traversal' FilesOrLicenseDescription (Maybe Text) Source #

comment :: Traversal' FilesOrLicenseDescription (Maybe Text) Source #

Builders

readCopyrightDescription :: Text -> CopyrightDescription Source #

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

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

Try to parse a structured copyright file

defaultCopyrightDescription :: PackageDescription -> IO CopyrightDescription Source #

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.