module Text.Pandoc.Definition ( Pandoc(..)
, Meta(..)
, MetaValue(..)
, nullMeta
, isNullMeta
, lookupMeta
, docTitle
, docAuthors
, docDate
, Block(..)
, Inline(..)
, Alignment(..)
, ListAttributes
, ListNumberStyle(..)
, ListNumberDelim(..)
, Format(..)
, Attr
, nullAttr
, TableCell
, QuoteType(..)
, Target
, MathType(..)
, Citation(..)
, CitationMode(..)
, pandocTypesVersion
) where
import Data.Generics (Data, Typeable)
import Data.Ord (comparing)
import Data.Aeson hiding (Null)
import qualified Data.Aeson.Types as Aeson
import qualified Data.Map as M
import GHC.Generics (Generic)
import Data.String
import Data.Char (toLower)
#if MIN_VERSION_base(4,8,0)
import Control.DeepSeq
#else
import Data.Monoid
import Control.Applicative ((<$>), (<*>))
import Control.DeepSeq.Generics
#endif
import Paths_pandoc_types (version)
import Data.Version (Version, versionBranch)
data Pandoc = Pandoc Meta [Block]
deriving (Eq, Ord, Read, Show, Typeable, Data, Generic)
instance Monoid Pandoc where
mempty = Pandoc mempty mempty
(Pandoc m1 bs1) `mappend` (Pandoc m2 bs2) =
Pandoc (m1 `mappend` m2) (bs1 `mappend` bs2)
newtype Meta = Meta { unMeta :: M.Map String MetaValue }
deriving (Eq, Ord, Show, Read, Typeable, Data, Generic)
instance Monoid Meta where
mempty = Meta (M.empty)
(Meta m1) `mappend` (Meta m2) = Meta (M.union m1 m2)
data MetaValue = MetaMap (M.Map String MetaValue)
| MetaList [MetaValue]
| MetaBool Bool
| MetaString String
| MetaInlines [Inline]
| MetaBlocks [Block]
deriving (Eq, Ord, Show, Read, Typeable, Data, Generic)
nullMeta :: Meta
nullMeta = Meta M.empty
isNullMeta :: Meta -> Bool
isNullMeta (Meta m) = M.null m
lookupMeta :: String -> Meta -> Maybe MetaValue
lookupMeta key (Meta m) = M.lookup key m
docTitle :: Meta -> [Inline]
docTitle meta =
case lookupMeta "title" meta of
Just (MetaString s) -> [Str s]
Just (MetaInlines ils) -> ils
Just (MetaBlocks [Plain ils]) -> ils
Just (MetaBlocks [Para ils]) -> ils
_ -> []
docAuthors :: Meta -> [[Inline]]
docAuthors meta =
case lookupMeta "author" meta of
Just (MetaString s) -> [[Str s]]
Just (MetaInlines ils) -> [ils]
Just (MetaList ms) -> [ils | MetaInlines ils <- ms] ++
[ils | MetaBlocks [Plain ils] <- ms] ++
[ils | MetaBlocks [Para ils] <- ms] ++
[[Str x] | MetaString x <- ms]
_ -> []
docDate :: Meta -> [Inline]
docDate meta =
case lookupMeta "date" meta of
Just (MetaString s) -> [Str s]
Just (MetaInlines ils) -> ils
Just (MetaBlocks [Plain ils]) -> ils
Just (MetaBlocks [Para ils]) -> ils
_ -> []
data Alignment = AlignLeft
| AlignRight
| AlignCenter
| AlignDefault deriving (Eq, Ord, Show, Read, Typeable, Data, Generic)
type ListAttributes = (Int, ListNumberStyle, ListNumberDelim)
data ListNumberStyle = DefaultStyle
| Example
| Decimal
| LowerRoman
| UpperRoman
| LowerAlpha
| UpperAlpha deriving (Eq, Ord, Show, Read, Typeable, Data, Generic)
data ListNumberDelim = DefaultDelim
| Period
| OneParen
| TwoParens deriving (Eq, Ord, Show, Read, Typeable, Data, Generic)
type Attr = (String, [String], [(String, String)])
nullAttr :: Attr
nullAttr = ("",[],[])
type TableCell = [Block]
newtype Format = Format String
deriving (Read, Show, Typeable, Data, Generic, ToJSON, FromJSON)
instance IsString Format where
fromString f = Format $ map toLower f
instance Eq Format where
Format x == Format y = map toLower x == map toLower y
instance Ord Format where
compare (Format x) (Format y) = compare (map toLower x) (map toLower y)
data Block
= Plain [Inline]
| Para [Inline]
| LineBlock [[Inline]]
| CodeBlock Attr String
| RawBlock Format String
| BlockQuote [Block]
| OrderedList ListAttributes [[Block]]
| BulletList [[Block]]
| DefinitionList [([Inline],[[Block]])]
| Header Int Attr [Inline]
| HorizontalRule
| Table [Inline] [Alignment] [Double] [TableCell] [[TableCell]]
| Div Attr [Block]
| Null
deriving (Eq, Ord, Read, Show, Typeable, Data, Generic)
data QuoteType = SingleQuote | DoubleQuote deriving (Show, Eq, Ord, Read, Typeable, Data, Generic)
type Target = (String, String)
data MathType = DisplayMath | InlineMath deriving (Show, Eq, Ord, Read, Typeable, Data, Generic)
data Inline
= Str String
| Emph [Inline]
| Strong [Inline]
| Strikeout [Inline]
| Superscript [Inline]
| Subscript [Inline]
| SmallCaps [Inline]
| Quoted QuoteType [Inline]
| Cite [Citation] [Inline]
| Code Attr String
| Space
| SoftBreak
| LineBreak
| Math MathType String
| RawInline Format String
| Link Attr [Inline] Target
| Image Attr [Inline] Target
| Note [Block]
| Span Attr [Inline]
deriving (Show, Eq, Ord, Read, Typeable, Data, Generic)
data Citation = Citation { citationId :: String
, citationPrefix :: [Inline]
, citationSuffix :: [Inline]
, citationMode :: CitationMode
, citationNoteNum :: Int
, citationHash :: Int
}
deriving (Show, Eq, Read, Typeable, Data, Generic)
instance Ord Citation where
compare = comparing citationHash
data CitationMode = AuthorInText | SuppressAuthor | NormalCitation
deriving (Show, Eq, Ord, Read, Typeable, Data, Generic)
taggedNoContent :: [Char] -> Value
taggedNoContent x = object [ "t" .= x ]
tagged :: ToJSON a => [Char] -> a -> Value
tagged x y = object [ "t" .= x, "c" .= y ]
instance FromJSON MetaValue where
parseJSON (Object v) = do
t <- v .: "t" :: Aeson.Parser Value
case t of
"MetaMap" -> MetaMap <$> (v .: "c")
"MetaList" -> MetaList <$> (v .: "c")
"MetaBool" -> MetaBool <$> (v .: "c")
"MetaString" -> MetaString <$> (v .: "c")
"MetaInlines" -> MetaInlines <$> (v .: "c")
"MetaBlocks" -> MetaBlocks <$> (v .: "c")
_ -> mempty
parseJSON _ = mempty
instance ToJSON MetaValue where
toJSON (MetaMap mp) = tagged "MetaMap" mp
toJSON (MetaList lst) = tagged "MetaList" lst
toJSON (MetaBool bool) = tagged "MetaBool" bool
toJSON (MetaString s) = tagged "MetaString" s
toJSON (MetaInlines ils) = tagged "MetaInlines" ils
toJSON (MetaBlocks blks) = tagged "MetaBlocks" blks
instance FromJSON Meta where
parseJSON j = Meta <$> parseJSON j
instance ToJSON Meta where
toJSON meta = toJSON $ unMeta meta
instance FromJSON CitationMode where
parseJSON (Object v) = do
t <- v .: "t" :: Aeson.Parser Value
case t of
"AuthorInText" -> return AuthorInText
"SuppressAuthor" -> return SuppressAuthor
"NormalCitation" -> return NormalCitation
_ -> mempty
parseJSON _ = mempty
instance ToJSON CitationMode where
toJSON cmode = taggedNoContent s
where s = case cmode of
AuthorInText -> "AuthorInText"
SuppressAuthor -> "SuppressAuthor"
NormalCitation -> "NormalCitation"
instance FromJSON Citation where
parseJSON (Object v) = do
citationId' <- v .: "citationId"
citationPrefix' <- v .: "citationPrefix"
citationSuffix' <- v .: "citationSuffix"
citationMode' <- v .: "citationMode"
citationNoteNum' <- v .: "citationNoteNum"
citationHash' <- v .: "citationHash"
return Citation { citationId = citationId'
, citationPrefix = citationPrefix'
, citationSuffix = citationSuffix'
, citationMode = citationMode'
, citationNoteNum = citationNoteNum'
, citationHash = citationHash'
}
parseJSON _ = mempty
instance ToJSON Citation where
toJSON cit =
object [ "citationId" .= citationId cit
, "citationPrefix" .= citationPrefix cit
, "citationSuffix" .= citationSuffix cit
, "citationMode" .= citationMode cit
, "citationNoteNum" .= citationNoteNum cit
, "citationHash" .= citationHash cit
]
instance FromJSON QuoteType where
parseJSON (Object v) = do
t <- v .: "t" :: Aeson.Parser Value
case t of
"SingleQuote" -> return SingleQuote
"DoubleQuote" -> return DoubleQuote
_ -> mempty
parseJSON _ = mempty
instance ToJSON QuoteType where
toJSON qtype = taggedNoContent s
where s = case qtype of
SingleQuote -> "SingleQuote"
DoubleQuote -> "DoubleQuote"
instance FromJSON MathType where
parseJSON (Object v) = do
t <- v .: "t" :: Aeson.Parser Value
case t of
"DisplayMath" -> return DisplayMath
"InlineMath" -> return InlineMath
_ -> mempty
parseJSON _ = mempty
instance ToJSON MathType where
toJSON mtype = taggedNoContent s
where s = case mtype of
DisplayMath -> "DisplayMath"
InlineMath -> "InlineMath"
instance FromJSON ListNumberStyle where
parseJSON (Object v) = do
t <- v .: "t" :: Aeson.Parser Value
case t of
"DefaultStyle" -> return DefaultStyle
"Example" -> return Example
"Decimal" -> return Decimal
"LowerRoman" -> return LowerRoman
"UpperRoman" -> return UpperRoman
"LowerAlpha" -> return LowerAlpha
"UpperAlpha" -> return UpperAlpha
_ -> mempty
parseJSON _ = mempty
instance ToJSON ListNumberStyle where
toJSON lsty = taggedNoContent s
where s = case lsty of
DefaultStyle -> "DefaultStyle"
Example -> "Example"
Decimal -> "Decimal"
LowerRoman -> "LowerRoman"
UpperRoman -> "UpperRoman"
LowerAlpha -> "LowerAlpha"
UpperAlpha -> "UpperAlpha"
instance FromJSON ListNumberDelim where
parseJSON (Object v) = do
t <- v .: "t" :: Aeson.Parser Value
case t of
"DefaultDelim" -> return DefaultDelim
"Period" -> return Period
"OneParen" -> return OneParen
"TwoParens" -> return TwoParens
_ -> mempty
parseJSON _ = mempty
instance ToJSON ListNumberDelim where
toJSON delim = taggedNoContent s
where s = case delim of
DefaultDelim -> "DefaultDelim"
Period -> "Period"
OneParen -> "OneParen"
TwoParens -> "TwoParens"
instance FromJSON Alignment where
parseJSON (Object v) = do
t <- v .: "t" :: Aeson.Parser Value
case t of
"AlignLeft" -> return AlignLeft
"AlignRight" -> return AlignRight
"AlignCenter" -> return AlignCenter
"AlignDefault" -> return AlignDefault
_ -> mempty
parseJSON _ = mempty
instance ToJSON Alignment where
toJSON delim = taggedNoContent s
where s = case delim of
AlignLeft -> "AlignLeft"
AlignRight -> "AlignRight"
AlignCenter -> "AlignCenter"
AlignDefault -> "AlignDefault"
instance FromJSON Inline where
parseJSON (Object v) = do
t <- v .: "t" :: Aeson.Parser Value
case t of
"Str" -> Str <$> v .: "c"
"Emph" -> Emph <$> v .: "c"
"Strong" -> Strong <$> v .: "c"
"Strikeout" -> Strikeout <$> v .: "c"
"Superscript" -> Superscript <$> v .: "c"
"Subscript" -> Subscript <$> v .: "c"
"SmallCaps" -> SmallCaps <$> v .: "c"
"Quoted" -> do (qt, ils) <- v .: "c"
return $ Quoted qt ils
"Cite" -> do (cits, ils) <- v .: "c"
return $ Cite cits ils
"Code" -> do (attr, s) <- v .: "c"
return $ Code attr s
"Space" -> return Space
"SoftBreak" -> return SoftBreak
"LineBreak" -> return LineBreak
"Math" -> do (mtype, s) <- v .: "c"
return $ Math mtype s
"RawInline" -> do (fmt, s) <- v .: "c"
return $ RawInline fmt s
"Link" -> do (attr, ils, tgt) <- v .: "c"
return $ Link attr ils tgt
"Image" -> do (attr, ils, tgt) <- v .: "c"
return $ Image attr ils tgt
"Note" -> Note <$> v .: "c"
"Span" -> do (attr, ils) <- v .: "c"
return $ Span attr ils
_ -> mempty
parseJSON _ = mempty
instance ToJSON Inline where
toJSON (Str s) = tagged "Str" s
toJSON (Emph ils) = tagged "Emph" ils
toJSON (Strong ils) = tagged "Strong" ils
toJSON (Strikeout ils) = tagged "Strikeout" ils
toJSON (Superscript ils) = tagged "Superscript" ils
toJSON (Subscript ils) = tagged "Subscript" ils
toJSON (SmallCaps ils) = tagged "SmallCaps" ils
toJSON (Quoted qtype ils) = tagged "Quoted" (qtype, ils)
toJSON (Cite cits ils) = tagged "Cite" (cits, ils)
toJSON (Code attr s) = tagged "Code" (attr, s)
toJSON Space = taggedNoContent "Space"
toJSON SoftBreak = taggedNoContent "SoftBreak"
toJSON LineBreak = taggedNoContent "LineBreak"
toJSON (Math mtype s) = tagged "Math" (mtype, s)
toJSON (RawInline fmt s) = tagged "RawInline" (fmt, s)
toJSON (Link attr ils target) = tagged "Link" (attr, ils, target)
toJSON (Image attr ils target) = tagged "Image" (attr, ils, target)
toJSON (Note blks) = tagged "Note" blks
toJSON (Span attr ils) = tagged "Span" (attr, ils)
instance FromJSON Block where
parseJSON (Object v) = do
t <- v .: "t" :: Aeson.Parser Value
case t of
"Plain" -> Plain <$> v .: "c"
"Para" -> Para <$> v .: "c"
"LineBlock" -> LineBlock <$> v .: "c"
"CodeBlock" -> do (attr, s) <- v .: "c"
return $ CodeBlock attr s
"RawBlock" -> do (fmt, s) <- v .: "c"
return $ RawBlock fmt s
"BlockQuote" -> BlockQuote <$> v .: "c"
"OrderedList" -> do (attr, items) <- v .: "c"
return $ OrderedList attr items
"BulletList" -> BulletList <$> v .: "c"
"DefinitionList" -> DefinitionList <$> v .: "c"
"Header" -> do (n, attr, ils) <- v .: "c"
return $ Header n attr ils
"HorizontalRule" -> return $ HorizontalRule
"Table" -> do (cpt, align, wdths, hdr, rows) <- v .: "c"
return $ Table cpt align wdths hdr rows
"Div" -> do (attr, blks) <- v .: "c"
return $ Div attr blks
"Null" -> return $ Null
_ -> mempty
parseJSON _ = mempty
instance ToJSON Block where
toJSON (Plain ils) = tagged "Plain" ils
toJSON (Para ils) = tagged "Para" ils
toJSON (LineBlock lns) = tagged "LineBlock" lns
toJSON (CodeBlock attr s) = tagged "CodeBlock" (attr, s)
toJSON (RawBlock fmt s) = tagged "RawBlock" (fmt, s)
toJSON (BlockQuote blks) = tagged "BlockQuote" blks
toJSON (OrderedList listAttrs blksList) = tagged "OrderedList" (listAttrs, blksList)
toJSON (BulletList blksList) = tagged "BulletList" blksList
toJSON (DefinitionList defs) = tagged "DefinitionList" defs
toJSON (Header n attr ils) = tagged "Header" (n, attr, ils)
toJSON HorizontalRule = taggedNoContent "HorizontalRule"
toJSON (Table caption aligns widths cells rows) =
tagged "Table" (caption, aligns, widths, cells, rows)
toJSON (Div attr blks) = tagged "Div" (attr, blks)
toJSON Null = taggedNoContent "Null"
instance FromJSON Pandoc where
parseJSON (Object v) = do
mbJVersion <- v .:? "pandoc-api-version" :: Aeson.Parser (Maybe [Int])
case mbJVersion of
Just jVersion | x : y : _ <- jVersion
, x' : y' : _ <- versionBranch pandocTypesVersion
, x == x'
, y == y' -> Pandoc <$> v .: "meta" <*> v .: "blocks"
| otherwise ->
fail $ mconcat [ "Incompatible API versions: "
, "encoded with "
, show jVersion
, " but attempted to decode with "
, show $ versionBranch pandocTypesVersion
, "."
]
_ -> fail "JSON missing pandoc-api-version."
parseJSON _ = mempty
instance ToJSON Pandoc where
toJSON (Pandoc meta blks) =
object [ "pandoc-api-version" .= versionBranch pandocTypesVersion
, "meta" .= meta
, "blocks" .= blks
]
#if MIN_VERSION_base(4,8,0)
instance NFData MetaValue
instance NFData Meta
instance NFData Citation
instance NFData Alignment
instance NFData Inline
instance NFData MathType
instance NFData Format
instance NFData CitationMode
instance NFData QuoteType
instance NFData ListNumberDelim
instance NFData ListNumberStyle
instance NFData Block
instance NFData Pandoc
#else
instance NFData MetaValue where rnf = genericRnf
instance NFData Meta where rnf = genericRnf
instance NFData Citation where rnf = genericRnf
instance NFData Alignment where rnf = genericRnf
instance NFData Inline where rnf = genericRnf
instance NFData MathType where rnf = genericRnf
instance NFData Format where rnf = genericRnf
instance NFData CitationMode where rnf = genericRnf
instance NFData QuoteType where rnf = genericRnf
instance NFData ListNumberDelim where rnf = genericRnf
instance NFData ListNumberStyle where rnf = genericRnf
instance NFData Block where rnf = genericRnf
instance NFData Pandoc where rnf = genericRnf
#endif
pandocTypesVersion :: Version
pandocTypesVersion = version