Copyright	(c) 2019-2021 Vaclav Svejcar
License	BSD-3-Clause
Maintainer	vaclav.svejcar@gmail.com
Stability	experimental
Portability	POSIX
Safe Haskell	None
Language	Haskell2010

Headroom.FileSupport.TemplateData

Description

Because each implementation of file support might require some custom data extracted for example from the template file, this module exposes data types specific for individual implementations.

Synopsis

data TemplateData
- = HaskellTemplateData HaskellTemplateData'
- | NoTemplateData
data HaddockOffsets = HaddockOffsets {
- hoCopyright :: Maybe Int
}
data HaskellTemplateData' = HaskellTemplateData' {
- htdHaddockOffsets :: HaddockOffsets
}

Documentation

data TemplateData Source #

Additional template data extracted from the template file.

Constructors

HaskellTemplateData HaskellTemplateData'	additional template data for Haskell
NoTemplateData	no additional template data provided

Instances

Instances details

Eq TemplateData Source #
Instance details Defined in Headroom.FileSupport.TemplateData Methods (==) :: TemplateData -> TemplateData -> Bool # (/=) :: TemplateData -> TemplateData -> Bool #
Show TemplateData Source #
Instance details Defined in Headroom.FileSupport.TemplateData Methods showsPrec :: Int -> TemplateData -> ShowS # show :: TemplateData -> String # showList :: [TemplateData] -> ShowS #

data HaddockOffsets Source #

Offsets for selected fields extracted from Haddock module header.

Constructors

HaddockOffsets
Fields hoCopyright :: Maybe Int offset for Copyright field

Instances

Instances details

Eq HaddockOffsets Source #
Instance details Defined in Headroom.FileSupport.TemplateData Methods (==) :: HaddockOffsets -> HaddockOffsets -> Bool # (/=) :: HaddockOffsets -> HaddockOffsets -> Bool #
Show HaddockOffsets Source #
Instance details Defined in Headroom.FileSupport.TemplateData Methods showsPrec :: Int -> HaddockOffsets -> ShowS # show :: HaddockOffsets -> String # showList :: [HaddockOffsets] -> ShowS #

data HaskellTemplateData' Source #

Additional template data required by Haskell file support

Constructors

HaskellTemplateData'
Fields htdHaddockOffsets :: HaddockOffsets offsets for Haddock fields

Instances

Instances details

Eq HaskellTemplateData' Source #
Instance details Defined in Headroom.FileSupport.TemplateData Methods (==) :: HaskellTemplateData' -> HaskellTemplateData' -> Bool # (/=) :: HaskellTemplateData' -> HaskellTemplateData' -> Bool #
Show HaskellTemplateData' Source #
Instance details Defined in Headroom.FileSupport.TemplateData Methods showsPrec :: Int -> HaskellTemplateData' -> ShowS # show :: HaskellTemplateData' -> String # showList :: [HaskellTemplateData'] -> ShowS #