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
|
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE FlexibleInstances #-}
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE DeriveDataTypeable #-}
{-
Copyright © 2017 Albert Krewinkel <tarleb+pandoc@moltkeplatz.de>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-}
{- |
Module : Text.Pandoc.Lua
Copyright : Copyright © 2017 Albert Krewinkel
License : GNU GPL, version 2 or above
Maintainer : Albert Krewinkel <tarleb+pandoc@moltkeplatz.de>
Stability : alpha
Pandoc lua utils.
-}
module Text.Pandoc.Lua ( LuaException(..),
runLuaFilter,
pushPandocModule ) where
import Control.Exception
import Control.Monad (unless, when, (>=>))
import Control.Monad.Trans (MonadIO (..))
import Data.Map (Map)
import Data.Typeable (Typeable)
import Scripting.Lua (LuaState, StackValue (..))
import Text.Pandoc.Definition
import Text.Pandoc.Lua.PandocModule (pushPandocModule)
import Text.Pandoc.Lua.StackInstances ()
import Text.Pandoc.Walk
import qualified Data.Map as Map
import qualified Scripting.Lua as Lua
newtype LuaException = LuaException String
deriving (Show, Typeable)
instance Exception LuaException
runLuaFilter :: (MonadIO m)
=> FilePath -> [String] -> Pandoc -> m Pandoc
runLuaFilter filterPath args pd = liftIO $ do
lua <- Lua.newstate
Lua.openlibs lua
-- store module in global "pandoc"
pushPandocModule lua
Lua.setglobal lua "pandoc"
top <- Lua.gettop lua
status <- Lua.loadfile lua filterPath
if status /= 0
then do
Just luaErrMsg <- Lua.peek lua 1
throwIO (LuaException luaErrMsg)
else do
Lua.call lua 0 Lua.multret
newtop <- Lua.gettop lua
-- Use the implicitly defined global filter if nothing was returned
when (newtop - top < 1) $ pushGlobalFilter lua
Just luaFilters <- Lua.peek lua (-1)
Lua.push lua args
Lua.setglobal lua "PandocParameters"
doc <- runAll luaFilters pd
Lua.close lua
return doc
pushGlobalFilter :: LuaState -> IO ()
pushGlobalFilter lua =
Lua.newtable lua
*> Lua.getglobal2 lua "pandoc.global_filter"
*> Lua.call lua 0 1
*> Lua.rawseti lua (-2) 1
runAll :: [LuaFilter] -> Pandoc -> IO Pandoc
runAll = foldr ((>=>) . walkMWithLuaFilter) return
walkMWithLuaFilter :: LuaFilter -> Pandoc -> IO Pandoc
walkMWithLuaFilter (LuaFilter lua fnMap) =
walkM (execInlineLuaFilter lua fnMap) >=>
walkM (execBlockLuaFilter lua fnMap) >=>
walkM (execMetaLuaFilter lua fnMap) >=>
walkM (execDocLuaFilter lua fnMap)
type FunctionMap = Map String LuaFilterFunction
data LuaFilter = LuaFilter LuaState FunctionMap
newtype LuaFilterFunction = LuaFilterFunction { functionIndex :: Int }
execDocLuaFilter :: LuaState
-> FunctionMap
-> Pandoc -> IO Pandoc
execDocLuaFilter lua fnMap x = do
let docFnName = "Doc"
case Map.lookup docFnName fnMap of
Nothing -> return x
Just fn -> runFilterFunction lua fn x
execMetaLuaFilter :: LuaState
-> FunctionMap
-> Pandoc -> IO Pandoc
execMetaLuaFilter lua fnMap pd@(Pandoc meta blks) = do
let metaFnName = "Meta"
case Map.lookup metaFnName fnMap of
Nothing -> return pd
Just fn -> do
meta' <- runFilterFunction lua fn meta
return $ Pandoc meta' blks
execBlockLuaFilter :: LuaState
-> FunctionMap
-> Block -> IO Block
execBlockLuaFilter lua fnMap x = do
let tryFilter :: String -> IO Block
tryFilter filterFnName =
case Map.lookup filterFnName fnMap of
Nothing -> return x
Just fn -> runFilterFunction lua fn x
case x of
BlockQuote{} -> tryFilter "BlockQuote"
BulletList{} -> tryFilter "BulletList"
CodeBlock{} -> tryFilter "CodeBlock"
DefinitionList{} -> tryFilter "DefinitionList"
Div{} -> tryFilter "Div"
Header{} -> tryFilter "Header"
HorizontalRule -> tryFilter "HorizontalRule"
LineBlock{} -> tryFilter "LineBlock"
Null -> tryFilter "Null"
Para{} -> tryFilter "Para"
Plain{} -> tryFilter "Plain"
RawBlock{} -> tryFilter "RawBlock"
OrderedList{} -> tryFilter "OrderedList"
Table{} -> tryFilter "Table"
execInlineLuaFilter :: LuaState
-> FunctionMap
-> Inline -> IO Inline
execInlineLuaFilter lua fnMap x = do
let tryFilter :: String -> IO Inline
tryFilter filterFnName =
case Map.lookup filterFnName fnMap of
Nothing -> return x
Just fn -> runFilterFunction lua fn x
let tryFilterAlternatives :: [String] -> IO Inline
tryFilterAlternatives [] = return x
tryFilterAlternatives (fnName : alternatives) =
case Map.lookup fnName fnMap of
Nothing -> tryFilterAlternatives alternatives
Just fn -> runFilterFunction lua fn x
case x of
Cite{} -> tryFilter "Cite"
Code{} -> tryFilter "Code"
Emph{} -> tryFilter "Emph"
Image{} -> tryFilter "Image"
LineBreak -> tryFilter "LineBreak"
Link{} -> tryFilter "Link"
Math DisplayMath _ -> tryFilterAlternatives ["DisplayMath", "Math"]
Math InlineMath _ -> tryFilterAlternatives ["InlineMath", "Math"]
Note{} -> tryFilter "Note"
Quoted DoubleQuote _ -> tryFilterAlternatives ["DoubleQuoted", "Quoted"]
Quoted SingleQuote _ -> tryFilterAlternatives ["SingleQuoted", "Quoted"]
RawInline{} -> tryFilter "RawInline"
SmallCaps{} -> tryFilter "SmallCaps"
SoftBreak -> tryFilter "SoftBreak"
Space -> tryFilter "Space"
Span{} -> tryFilter "Span"
Str{} -> tryFilter "Str"
Strikeout{} -> tryFilter "Strikeout"
Strong{} -> tryFilter "Strong"
Subscript{} -> tryFilter "Subscript"
Superscript{} -> tryFilter "Superscript"
instance StackValue LuaFilter where
valuetype _ = Lua.TTABLE
push = undefined
peek lua idx = fmap (LuaFilter lua) <$> Lua.peek lua idx
-- | Push a value to the stack via a lua filter function. The filter function is
-- called with given element as argument and is expected to return an element.
-- Alternatively, the function can return nothing or nil, in which case the
-- element is left unchanged.
runFilterFunction :: StackValue a => LuaState -> LuaFilterFunction -> a -> IO a
runFilterFunction lua lf x = do
pushFilterFunction lua lf
Lua.push lua x
z <- Lua.pcall lua 1 1 0
if (z /= 0)
then do
msg <- Lua.peek lua (-1)
let prefix = "Error while running filter function: "
throwIO . LuaException $
case msg of
Nothing -> prefix ++ "could not read error message"
Just msg' -> prefix ++ msg'
else do
resType <- Lua.ltype lua (-1)
case resType of
Lua.TNIL -> Lua.pop lua 1 *> return x
_ -> do
mbres <- Lua.peek lua (-1)
case mbres of
Nothing -> throwIO $ LuaException
("Error while trying to get a filter's return "
++ "value from lua stack.")
Just res -> res <$ Lua.pop lua 1
-- | Push the filter function to the top of the stack.
pushFilterFunction :: Lua.LuaState -> LuaFilterFunction -> IO ()
pushFilterFunction lua lf =
-- The function is stored in a lua registry table, retrieve it from there.
Lua.rawgeti lua Lua.registryindex (functionIndex lf)
registerFilterFunction :: LuaState -> Int -> IO LuaFilterFunction
registerFilterFunction lua idx = do
isFn <- Lua.isfunction lua idx
unless isFn . throwIO . LuaException $ "Not a function at index " ++ show idx
Lua.pushvalue lua idx
refIdx <- Lua.ref lua Lua.registryindex
return $ LuaFilterFunction refIdx
instance StackValue LuaFilterFunction where
valuetype _ = Lua.TFUNCTION
push = pushFilterFunction
peek = fmap (fmap Just) . registerFilterFunction
|
