1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
|
{-# LANGUAGE OverloadedStrings #-}
{- |
Module : Text.Pandoc.Highlighting
Copyright : Copyright (C) 2008-2025 John MacFarlane
License : GNU GPL, version 2 or above
Maintainer : John MacFarlane <[email protected]>
Stability : alpha
Portability : portable
Exports functions for syntax highlighting.
-}
module Text.Pandoc.Highlighting ( highlightingStyles
, languages
, languagesByExtension
, highlight
-- * Formats
-- ** LaTeX
, formatLaTeXInline
, formatLaTeXBlock
, styleToLaTeX
-- ** HTML
, formatHtmlInline
, formatHtmlBlock
, formatHtml4Block
, styleToCss
-- ** ConTeXt
, formatConTeXtInline
, formatConTeXtBlock
, styleToConTeXt
, formatANSI
-- ** Typst
, formatTypstBlock
, formatTypstInline
, styleToTypst
-- * Styles
, defaultStyle
, pygments
, espresso
, zenburn
, tango
, kate
, monochrome
, breezeDark
, haddock
, Style
, lookupHighlightingStyle
, fromListingsLanguage
, toListingsLanguage
) where
import Control.Monad ( msum )
import qualified Data.Map as M
import Data.Maybe (fromMaybe)
import qualified Data.Text as T
import Skylighting
( SyntaxMap,
breezeDark,
espresso,
haddock,
kate,
monochrome,
pygments,
tango,
zenburn,
formatHtml4Block,
formatHtmlBlock,
formatHtmlInline,
styleToCss,
formatConTeXtBlock,
formatConTeXtInline,
styleToConTeXt,
formatLaTeXBlock,
formatLaTeXInline,
styleToLaTeX,
formatTypstBlock,
formatTypstInline,
styleToTypst,
formatANSI,
Style,
FormatOptions(containerClasses, startNumber, lineAnchors,
numberLines, lineIdPrefix, codeClasses),
SourceLine,
lookupSyntax,
syntaxesByExtension,
parseTheme,
tokenize,
defaultFormatOpts,
TokenizerConfig(traceOutput, TokenizerConfig, syntaxMap),
Syntax(sShortname, sName),
TokenType(NormalTok) )
import Text.Pandoc.Definition ( Attr )
import Text.Pandoc.Class (PandocMonad, readFileLazy)
import Text.Pandoc.Error (PandocError(..))
import Control.Monad.Except (throwError)
import System.FilePath (takeExtension)
import Text.Pandoc.Shared (safeRead)
-- | The default highlighting style used by pandoc (pygments).
defaultStyle :: Style
defaultStyle = pygments
highlightingStyles :: [(T.Text, Style)]
highlightingStyles =
[("pygments", pygments),
("tango", tango),
("espresso", espresso),
("zenburn", zenburn),
("kate", kate),
("monochrome", monochrome),
("breezedark", breezeDark),
("haddock", haddock)]
languages :: SyntaxMap -> [T.Text]
languages syntaxmap = [T.toLower (sName s) | s <- M.elems syntaxmap]
languagesByExtension :: SyntaxMap -> T.Text -> [T.Text]
languagesByExtension syntaxmap ext =
[T.toLower (sName s) | s <- syntaxesByExtension syntaxmap (T.unpack ext)]
highlight :: SyntaxMap
-> (FormatOptions -> [SourceLine] -> a) -- ^ Formatter
-> Attr -- ^ Attributes of the CodeBlock
-> T.Text -- ^ Raw contents of the CodeBlock
-> Either T.Text a
highlight syntaxmap formatter (ident, classes, keyvals) rawCode =
let firstNum = fromMaybe 1 (safeRead (fromMaybe "1" $ lookup "startFrom" keyvals))
fmtOpts = defaultFormatOpts{
startNumber = firstNum,
lineAnchors = any (`elem`
["line-anchors", "lineAnchors"]) classes,
numberLines = any (`elem`
["number","numberLines", "number-lines"]) classes,
lineIdPrefix = if T.null ident
then mempty
else ident <> "-" }
tokenizeOpts = TokenizerConfig{ syntaxMap = syntaxmap
, traceOutput = False }
in case msum (map (`lookupSyntax` syntaxmap) classes) of
Nothing
| numberLines fmtOpts -> Right
$ formatter fmtOpts{ codeClasses = [],
containerClasses = classes }
$ map (\ln -> [(NormalTok, ln)])
$ T.lines rawCode
| otherwise -> Left ""
Just syntax -> either (Left . T.pack) Right $
formatter fmtOpts{ codeClasses =
[T.toLower (sShortname syntax)],
containerClasses = classes } <$>
tokenize tokenizeOpts syntax rawCode
-- Functions for correlating latex listings package's language names
-- with skylighting language names:
langToListingsMap :: M.Map T.Text T.Text
langToListingsMap = M.fromList langsList
listingsToLangMap :: M.Map T.Text T.Text
listingsToLangMap = M.fromList $ map switch langsList
where switch (a,b) = (b,a)
langsList :: [(T.Text, T.Text)]
langsList =
[("abap","ABAP"),
("acm","ACM"),
("acmscript","ACMscript"),
("acsl","ACSL"),
("ada","Ada"),
("algol","Algol"),
("ant","Ant"),
("assembler","Assembler"),
("gnuassembler","Assembler"),
("awk","Awk"),
("bash","bash"),
("monobasic","Basic"),
("purebasic","Basic"),
("c","C"),
("cs","C"),
("objectivec","C"),
("cpp","C++"),
("c++","C++"),
("ocaml","Caml"),
("cil","CIL"),
("clean","Clean"),
("cobol","Cobol"),
("comal80","Comal80"),
("command.com","command.com"),
("comsol","Comsol"),
("csh","csh"),
("delphi","Delphi"),
("eiffel","Eiffel"),
("elan","Elan"),
("elisp","elisp"),
("erlang","erlang"),
("euphoria","Euphoria"),
("fortran","Fortran"),
("gap","GAP"),
("gcl","GCL"),
("gnuplot","Gnuplot"),
("go","Go"),
("hansl","hansl"),
("haskell","Haskell"),
("html","HTML"),
("idl","IDL"),
("inform","inform"),
("java","Java"),
("jvmis","JVMIS"),
("ksh","ksh"),
("lingo","Lingo"),
("lisp","Lisp"),
("commonlisp","Lisp"),
("llvm","LLVM"),
("logo","Logo"),
("lua","Lua"),
("make","make"),
("makefile","make"),
("mathematica","Mathematica"),
("matlab","Matlab"),
("mercury","Mercury"),
("metapost","MetaPost"),
("miranda","Miranda"),
("mizar","Mizar"),
("ml","ML"),
("modula2","Modula-2"),
("mupad","MuPAD"),
("nastran","NASTRAN"),
("oberon2","Oberon-2"),
("ocl","OCL"),
("octave","Octave"),
("oorexx","OORexx"),
("oz","Oz"),
("pascal","Pascal"),
("perl","Perl"),
("php","PHP"),
("pli","PL/I"),
("plasm","Plasm"),
("postscript","PostScript"),
("pov","POV"),
("prolog","Prolog"),
("promela","Promela"),
("pstricks","PSTricks"),
("python","Python"),
("r","R"),
("reduce","Reduce"),
("rexx","Rexx"),
("rsl","RSL"),
("ruby","Ruby"),
("s","S"),
("sas","SAS"),
("scala","Scala"),
("scilab","Scilab"),
("sh","sh"),
("shelxl","SHELXL"),
("simula","Simula"),
("sparql","SPARQL"),
("sql","SQL"),
("swift","Swift"),
("tcl","tcl"),
("tex","TeX"),
("latex","TeX"),
("vbscript","VBScript"),
("verilog","Verilog"),
("vhdl","VHDL"),
("vrml","VRML"),
("xml","XML"),
("xslt","XSLT")]
-- | Determine listings language name from skylighting language name.
toListingsLanguage :: T.Text -> Maybe T.Text
toListingsLanguage lang = M.lookup (T.toLower lang) langToListingsMap
-- | Determine skylighting language name from listings language name.
fromListingsLanguage :: T.Text -> Maybe T.Text
fromListingsLanguage lang = M.lookup lang listingsToLangMap
-- | Lookup style from a name. If the name is a standard style,
-- load it; if it ends in ".theme", attempt to load a KDE theme
-- from the file path specified.
lookupHighlightingStyle :: PandocMonad m => String -> m Style
lookupHighlightingStyle s
| takeExtension s == ".theme" = -- attempt to load KDE theme
do contents <- readFileLazy s
case parseTheme contents of
Left _ -> throwError $ PandocOptionError $ T.pack $
"Could not read highlighting theme " ++ s
Right sty -> return sty
| otherwise =
case lookup (T.toLower $ T.pack s) highlightingStyles of
Just sty -> return sty
Nothing -> throwError $ PandocOptionError $ T.pack $
"Unknown highlight-style " ++ s
|
