pandoc2review 1.5.0 → 2.0.0

data/lua/review.lua

@@ -25,7 +25,7 @@ local footnotes = {}
 
 -- internal
 local metadata = nil
-local stringify = (require "pandoc.utils").stringify
+local stringify = (require("pandoc.utils")).stringify
 local inline_commands = {
   -- processed if given as classes of Span elements
   -- true if syntax is `@<command>{string}`
@@ -48,7 +48,7 @@ local inline_commands = {
   title = true,
   chapref = true,
   list = true,
-  img =  true,
+  img = true,
   table = true,
   eq = true,
   hd = true,
@@ -83,21 +83,19 @@ local function log(s)
 end
 
 local function surround_inline(s)
-  if (string.match(s, "{") or string.match(s, "}")) then
-    if (string.match(s, "%$")) then -- use % for regexp escape
-      if (string.match(s, "|")) then
-        -- give up. escape } by \}
-        return "{" .. string.gsub(s, "}", "\\}") .. "}"
-      else
-        -- surround by ||
-        return "|" .. s .. "|"
-      end
-    else
-      -- surround by $$
-        return "$" .. s .. "$"
-    end
+  if not s:match("[{}]") then
+    return "{" .. s .. "}"
+  end
+  if not s:match("%$") then
+    return "$" .. s .. "$"
   end
-  return "{" .. s .. "}"
+
+  -- use % for regexp escape
+  if s:match("|") then
+    -- give up. escape } by \}
+    return "{" .. s:gsub("}", "\\}") .. "}"
+  end
+  return "|" .. s .. "|"
 end
 
 local function format_inline(fmt, s)
@@ -105,31 +103,18 @@ local function format_inline(fmt, s)
 end
 
 local function html_align(align)
-  if align == "AlignLeft" then
-    return ""
-  elseif align == "AlignRight" then
-    return "right"
-  elseif align == "AlignCenter" then
-    return "center"
-  else
-    return ""
-  end
+  return ({ AlignRight = "right", AlignCenter = "center" })[align] or ""
 end
 
 function Blocksep()
   return "\n\n"
 end
 
-function Doc(body, metadata, variables)
-  local buffer = {}
-  local function add(s)
-    table.insert(buffer, s)
-  end
-  add(body)
-  if (#footnotes > 0) then
-    add("\n" .. table.concat(footnotes, "\n"))
+function Doc(body, meta, variables)
+  if #footnotes == 0 then
+    return body
   end
-  return table.concat(buffer, "\n")
+  return table.concat({ body, "", table.concat(footnotes, "\n") }, "\n")
 end
 
 function Str(s)
@@ -145,11 +130,7 @@ function LineBreak()
 end
 
 function SoftBreak(s)
-  if (metadata.softbreak) then
-    return " "
-  else
-    return "<P2RBR/>"
-  end
+  return metadata.softbreak and " " or "<P2RBR/>"
 end
 
 function Plain(s)
@@ -161,13 +142,7 @@ function Para(s)
 end
 
 local function attr_val(attr, key)
-  local attr_table = {}
-  for k, v in pairs(attr) do
-    if (k == key and v and v ~= "") then
-      return v
-    end
-  end
-  return ""
+  return attr[key] or ""
 end
 
 local function attr_classes(attr)
@@ -180,7 +155,7 @@ local function attr_classes(attr)
 end
 
 local function attr_scale(attr, key) -- a helper for CaptionedImage
-  scale = attr_val(attr, key)
+  local scale, count = attr_val(attr, key), 0
   if (scale == "") or (key == "scale") then
     return scale
   end
@@ -194,28 +169,27 @@ local function attr_scale(attr, key) -- a helper for CaptionedImage
   return tonumber(scale) / 100
 end
 
-function Header(level, s, attr)
-  local headmark = ""
-  for i = 1, level do
-    headmark = headmark .. "="
+local function class_header(classes)
+  -- Re:VIEW's behavior
+  for _, cls in pairs({ "column", "nonum", "nodisp", "notoc" }) do
+    if classes[cls] then
+      return string.format("[%s]", cls)
+    end
   end
 
-  local classes = attr_classes(attr)
+  -- Pandoc's behavior
+  if classes.unnumbered then
+    return classes.unlisted and "[notoc]" or "[nonum]"
+  end
 
-  headmark = headmark .. (
-    -- Re:VIEW's behavior
-    classes["column"] and "[column]" or (
-    classes["nonum"] and "[nonum]" or (
-    classes["nodisp"] and "[nodisp]" or (
-    classes["notoc"] and "[notoc]" or (
-    -- Pandoc's behavior
-    classes["unnumbered"] and (
-      classes["unlisted"] and "[notoc]" or "[nonum]") or (
-    -- None
-    "")))))
-  )
-
-  if ((config.use_header_id == "true") and attr.id ~= "" and attr.id ~= s) then
+  -- None
+  return ""
+end
+
+function Header(level, s, attr)
+  local headmark = string.rep("=", level) .. class_header(attr_classes(attr))
+
+  if (config.use_header_id == "true") and attr.id ~= "" and attr.id ~= s then
     headmark = headmark .. "{" .. attr.id .. "}"
   end
 
@@ -223,17 +197,13 @@ function Header(level, s, attr)
 end
 
 function HorizontalRule()
-  if (config.use_hr == "true") then
-    return "//hr"
-  else
-    return ""
-  end
+  return config.use_hr == "true" and "//hr" or ""
 end
 
 local function lint_list(s)
-  return s:gsub("\n+(//beginchild)\n+", '\n\n%1\n\n'
-         ):gsub("\n+(//endchild)\n+", '\n\n%1\n\n'
-         ):gsub("\n+(//endchild)\n*$", "\n\n%1")
+  return s:gsub("\n+(//beginchild)\n+", "\n\n%1\n\n")
+    :gsub("\n+(//endchild)\n+", "\n\n%1\n\n")
+    :gsub("\n+(//endchild)\n*$", "\n\n%1")
 end
 
 function BulletList(items)
@@ -279,39 +249,33 @@ end
 function CodeBlock(s, attr)
   local classes = attr_classes(attr)
 
-  local command = nil
-  for k,v in pairs({cmd = "cmd", source = "source", quote = "source"}) do
+  local command = "list" -- default
+  for k, v in pairs({ cmd = "cmd", source = "source", quote = "source" }) do
     if classes[k] then
       command = v
       break
     end
   end
-  command = command or "list"
-
-  is_list = command == "list"
 
+  local is_list = command == "list"
 
-  local num = (is_list == false) and "" or (
-      (classes["numberLines"] or classes["number-lines"] or classes["num"]) and
-        "num" or ""
-    )
+  local num = (is_list and (classes["numberLines"] or classes["number-lines"] or classes["num"])) and "num" or ""
 
   local firstlinenum = ""
   if is_list and (num == "num") then
-    for _, key in ipairs({"startFrom", "start-from", "firstlinenum"}) do
-      firstlinenum = attr_val(attr, key)
-      if firstlinenum ~= "" then
-        firstlinenum = "//firstlinenum[" .. firstlinenum .. "]\n"
+    for _, key in ipairs({ "startFrom", "start-from", "firstlinenum" }) do
+      if attr[key] then
+        firstlinenum = "//firstlinenum[" .. attr[key] .. "]\n"
         break
       end
     end
   end
 
   local lang = ""
-  local not_lang = {numberLines = true, num = true, em = true, source = true}
+  local not_lang = { numberLines = true, num = true, em = true, source = true }
   not_lang["number-lines"] = true
   if is_list or (command == "source") then
-    for key,_ in pairs(classes) do
+    for key, _ in pairs(classes) do
       if not_lang[key] ~= true then
         lang = "[" .. key .. "]"
         break
@@ -322,9 +286,9 @@ function CodeBlock(s, attr)
   local caption = (command == "cmd") and "" or attr_val(attr, "caption")
   local identifier = ""
   local em = is_list and classes["em"] and "em" or ""
-  if (caption ~= "") then
+  if caption ~= "" then
     if is_list and (em == "") then
-      if (attr.id ~= "") then
+      if attr.id ~= "" then
         identifier = "[" .. attr.id .. "]"
       else
         list_num = list_num + 1
@@ -341,11 +305,7 @@ function CodeBlock(s, attr)
     end
   end
 
-  return (
-      firstlinenum ..
-      "//" .. em .. command .. num .. identifier .. caption .. lang ..
-      "{\n" .. s .. "\n//}"
-    )
+  return (firstlinenum .. "//" .. em .. command .. num .. identifier .. caption .. lang .. "{\n" .. s .. "\n//}")
 end
 
 function LineBlock(s)
@@ -354,7 +314,7 @@ function LineBlock(s)
 end
 
 function Link(s, src, tit)
-  if (src == s) then
+  if src == s then
     return format_inline("href", src)
   else
     return format_inline("href", src .. "," .. s)
@@ -411,7 +371,7 @@ function Table(caption, aligns, widths, headers, rows)
   end
   local tmp = {}
   for i, h in pairs(headers) do
-    align = html_align(aligns[i])
+    local align = html_align(aligns[i])
     if (config.use_table_align == "true") and (align ~= "") then
       h = format_inline("dtp", "table align=" .. align) .. h
     end
@@ -421,8 +381,8 @@ function Table(caption, aligns, widths, headers, rows)
   add("--------------")
   for _, row in pairs(rows) do
     tmp = {}
-      for i, c in pairs(row) do
-      align = html_align(aligns[i])
+    for i, c in pairs(row) do
+      local align = html_align(aligns[i])
       if (config.use_table_align == "true") and (align ~= "") then
         c = format_inline("dtp", "table align=" .. align) .. c
       end
@@ -435,13 +395,6 @@ function Table(caption, aligns, widths, headers, rows)
   return table.concat(buffer, "\n")
 end
 
-function Image(s, src, tit)
-  -- Re:VIEW @<icon> ignores caption and title
-  local id = string.gsub(src, "%.%w+$", "")
-  id = string.gsub(id, "^images/", "")
-  return format_inline("icon", id)
-end
-
 function CaptionedImage(s, src, tit, attr)
   local path = "[" .. s:gsub("%.%w+$", ""):gsub("^images/", "") .. "]"
 
@@ -451,7 +404,7 @@ function CaptionedImage(s, src, tit, attr)
   if scale == "" then
     local width = attr_scale(attr, "width")
     local height = attr_scale(attr, "height")
-    if (width ~= "") then
+    if width ~= "" then
       if (height ~= "") and (width ~= height) then
         log("WARNING: Image width and height must be same. Using width.\n")
       end
@@ -464,26 +417,15 @@ function CaptionedImage(s, src, tit, attr)
     scale = "[scale=" .. scale .. "]"
   end
 
-  local command = "//image"
-  local caption = ""
-  if (tit == "") then
-    command = "//indepimage"
-  else
-    caption = "[" .. tit .. "]"
-  end
+  local command = tit == "" and "//indepimage" or "//image"
+  local caption = tit == "" and "" or ("[" .. tit .. "]")
 
-  return (
-    command .. path .. caption .. scale .. "{" .. comment .. "\n//}"
-  )
+  return (command .. path .. caption .. scale .. "{" .. comment .. "\n//}")
 end
 
 function Image(s, src, tit, attr)
   -- Re:VIEW @<icon> ignores caption and title
-  if attr.is_figure then
-    return CaptionedImage(src, s, tit, attr)
-  end
-  local id = string.gsub(src, "%.%w+$", "")
-  id = string.gsub(id, "^images/", "")
+  local id = src:gsub("%.%w+$", ""):gsub("^images/", "")
   return format_inline("icon", id)
 end
 
@@ -499,12 +441,7 @@ function Cite(s, cs)
 end
 
 function Quoted(quotetype, s)
-  if (quotetype == "SingleQuote") then
-    return SingleQuoted(s)
-  end
-  if (quotetype == "DoubleQuote") then
-    return DoubleQuoted(s)
-  end
+  return _G[quotetype](s)
 end
 
 function SingleQuoted(s)
@@ -520,13 +457,9 @@ function SmallCaps(s)
 end
 
 function Div(s, attr)
-  local blankline = attr_val(attr, "blankline")
-  if blankline ~= "" then
-    local buffer = {}
-    for i = 1, tonumber(blankline) do
-      table.insert(buffer, "//blankline")
-    end
-    return table.concat(buffer, "\n")
+  local blankline = tonumber(attr.blankline)
+  if blankline then
+    return string.rep("//blankline\n", blankline):gsub("\n$", "")
   end
 
   local classes = attr_classes(attr)
@@ -540,15 +473,11 @@ function Div(s, attr)
   end
 
   if classes["review-internal"] then
-    s, _ = s:gsub(
-      "%]{<P2RREMOVEBELOW/>\n", "]{"
-    ):gsub(
-      "\n<P2RREMOVEABOVE/>//}", "//}"
-    )
+    s, _ = s:gsub("%]{<P2RREMOVEBELOW/>\n", "]{"):gsub("\n<P2RREMOVEABOVE/>//}", "//}")
     return s
   end
 
-  for cls,_ in pairs(classes) do
+  for cls, _ in pairs(classes) do
     s = "//" .. cls .. "{\n" .. s .. "\n//}"
   end
   return s
@@ -557,7 +486,7 @@ end
 function Span(s, attr)
   -- ruby and kw with a supplement
   local a = ""
-  for _, cmd in ipairs({"ruby", "kw"}) do
+  for _, cmd in ipairs({ "ruby", "kw" }) do
     a = attr_val(attr, cmd)
     if a ~= "" then
       s = format_inline(cmd, s .. "," .. a)
@@ -575,31 +504,31 @@ function Span(s, attr)
 end
 
 function RawInline(format, text)
-  if (format == "review") then
+  if format == "review" then
     return text
   end
 
-  if (metadata.hideraw) then
+  if metadata.hideraw then
     return ""
   end
 
-  if (format == "tex") then
+  if format == "tex" then
     return format_inline("embed", "|latex|" .. text)
   else
-    return format_inline("embed", "|" .. format .. "|", text)
+    return format_inline("embed", "|" .. format .. "|" .. text)
   end
 end
 
 function RawBlock(format, text)
-  if (format == "review") then
+  if format == "review" then
     return text
   end
 
-  if (metadata.hideraw) then
+  if metadata.hideraw then
     return ""
   end
 
-  if (format == "tex") then
+  if format == "tex" then
     return "//embed[latex]{\n" .. text .. "\n//}"
   else
     return "//embed[" .. format .. "]{\n" .. text .. "\n//}"
@@ -607,18 +536,18 @@ function RawBlock(format, text)
 end
 
 local function configure()
-  try_catch {
+  try_catch({
     try = function()
       metadata = PANDOC_DOCUMENT.meta
     end,
     catch = function(error)
       log("Due to your pandoc version is too old, config.yml loader is disabled.\n")
-    end
-  }
+    end,
+  })
 
-  if (metadata) then
+  if metadata then
     -- Load config from YAML
-    for k,v in pairs(config) do
+    for k, _ in pairs(config) do
       if metadata[k] ~= nil then
         config[k] = stringify(metadata[k])
       end
@@ -626,23 +555,225 @@ local function configure()
   end
 end
 
-if PANDOC_VERSION >= "3.0.0" then
-  -- NOTE: A wrapper to support Pandoc >= 3.0 https://pandoc.org/custom-writers.html#changes-in-pandoc-3.0
-  function Writer (doc, opts)
-    PANDOC_DOCUMENT = doc
-    PANDOC_WRITER_OPTIONS = opts
-    configure()
-    return pandoc.write_classic(doc, opts)
-  end
-else
+setmetatable(_G, {
+  __index = function(_, key)
+    log(string.format("WARNING: Undefined function '%s'\n", key))
+    return function()
+      return ""
+    end
+  end,
+})
+
+if PANDOC_VERSION < "3.0.0" then
   configure()
+  return
 end
 
-local meta = {}
-meta.__index =
-  function(_, key)
-    log(string.format("WARNING: Undefined function '%s'\n", key))
-    return function() return "" end
+Blocks = setmetatable({}, {
+  __index = function(_, key)
+    error("NotImplementedError: Blocks.%" .. tostring(key))
+  end,
+})
+
+Inlines = setmetatable({}, {
+  __index = function(_, key)
+    error("NotImplementedError: Inlines.%" .. tostring(key))
+  end,
+})
+
+local tidy_attr = function(el)
+  local ret = {}
+  for k, v in pairs(el.attr.attributes) do
+    ret[k] = v
+  end
+  ret.id = el.identifier or ""
+  ret.class = el.classes and table.concat(el.classes, " ")
+  return ret
+end
+
+local concat = pandoc.layout.concat
+
+local function render(...)
+  local x = pandoc.layout.render(...):gsub("\n+$", "")
+  return x
+end
+
+local function inlines(els)
+  local buff = {}
+  for _, el in ipairs(els) do
+    table.insert(buff, Inlines[el.tag](el))
+  end
+  return concat(buff)
+end
+
+local function blocks(els, sep)
+  local buff = {}
+  for _, el in ipairs(els) do
+    table.insert(buff, Blocks[el.tag](el))
   end
+  return concat(buff, sep)
+end
+
+Inlines.Str = function(el)
+  return Str(el.text)
+end
 
-setmetatable(_G, meta)
+for _, v in pairs({ "Space", "LineBreak", "SoftBreak" }) do
+  Inlines[v] = _G[v]
+end
+
+Blocks.HorizontalRule = function(_)
+  return HorizontalRule() .. "\n"
+end
+
+Blocks.Plain = function(el)
+  return inlines(el.content) .. "\n"
+end
+
+Blocks.Para = function(el)
+  if #el.content == 1 and el.content[1].tag == "Image" then
+    local img = el.content[1]
+    return CaptionedImage(img.src, img.title, render(inlines(img.caption)), tidy_attr(img)) .. "\n"
+  end
+  return inlines(el.content) .. "\n"
+end
+
+Blocks.Header = function(el)
+  return Header(el.level, render(inlines(el.content)), tidy_attr(el)) .. "\n"
+end
+
+local function render_blocks(blks, sep)
+  local ret = {}
+  for _, v in pairs(blks) do
+    table.insert(ret, render(blocks(v, sep or "\n")))
+  end
+  return ret
+end
+
+Blocks.BulletList = function(el)
+  return BulletList(render_blocks(el.content)) .. "\n"
+end
+
+Blocks.OrderedList = function(el)
+  return OrderedList(render_blocks(el.content), el.start) .. "\n"
+end
+
+Blocks.DefinitionList = function(el)
+  local items = {}
+  for _, v in pairs(el.content) do
+    local term = render(inlines(v[1]))
+    table.insert(items, { [term] = render_blocks(v[2]) })
+  end
+  return DefinitionList(items) .. "\n"
+end
+
+Blocks.BlockQuote = function(el)
+  return BlockQuote(render(blocks(el.content, "\n"))) .. "\n"
+end
+
+Blocks.CodeBlock = function(el)
+  return CodeBlock(el.text, tidy_attr(el)) .. "\n"
+end
+
+Blocks.LineBlock = function(el)
+  local lines = {}
+  for _, v in pairs(el.content) do
+    table.insert(lines, render(inlines(v)))
+  end
+  return LineBlock(lines) .. "\n"
+end
+
+Inlines.Link = function(el)
+  return Link(render(inlines(el.content)), el.target, el.title)
+end
+
+Inlines.Code = function(el)
+  return Code(el.text, tidy_attr(el))
+end
+
+for _, k in pairs({ "Emph", "Strong", "Strikeout", "Underline", "Subscript", "Superscript", "SmallCaps" }) do
+  Inlines[k] = function(el)
+    return _G[k](render(inlines(el.content)))
+  end
+end
+
+Inlines.Math = function(el)
+  return _G[el.mathtype](el.text)
+end
+
+Blocks.Table = function(el)
+  local tbl = pandoc.utils.to_simple_table(el)
+  local headers = render_blocks(tbl.headers)
+  local rows = {}
+  for _, row in pairs(tbl.rows) do
+    table.insert(rows, render_blocks(row, ""))
+  end
+  return Table(render(inlines(tbl.caption)), tbl.aligns, tbl.widths, headers, rows) .. "\n"
+end
+
+Inlines.Image = function(el)
+  return Image(render(inlines(el.caption)), el.src, el.title, tidy_attr(el))
+end
+
+Inlines.Note = function(el)
+  return Note(render(blocks(el.content, "\n")))
+end
+
+Inlines.Cite = function(el)
+  return Cite(render(inlines(el.content)))
+end
+
+Inlines.Quoted = function(el)
+  return Quoted(el.quotetype, render(inlines(el.content)))
+end
+
+Blocks.Div = function(el)
+  return Div(render(blocks(el.content, "\n")), tidy_attr(el)) .. "\n"
+end
+
+Inlines.Span = function(el)
+  return Span(render(inlines(el.content)), tidy_attr(el))
+end
+
+Inlines.RawInline = function(el)
+  return RawInline(el.format, el.text)
+end
+
+Blocks.RawBlock = function(el)
+  return RawBlock(el.format, el.text) .. "\n"
+end
+
+Blocks.Figure = function(el)
+  if #el.content > 1 or #el.content[1].content > 1 or el.content[1].content[1].tag ~= "Image" then
+    error("NotImplementedError: current implementation assumes Figure contains only a single image.")
+    -- because Pandoc 3.1.4 does not support Pandoc's markdown cotaining Figure with multiple images...
+  end
+
+  local img = el.content[1].content[1]
+
+  return CaptionedImage(img.src, img.title, render(inlines(img.caption)), tidy_attr(img)) .. "\n"
+end
+
+function Writer(doc, opts)
+  PANDOC_DOCUMENT = doc
+  PANDOC_WRITER_OPTIONS = opts
+  configure()
+
+  if metadata.classicwriter then
+    if pandoc.write_classic then
+      return pandoc.write_classic(
+        doc:walk({
+          Figure = function(el)
+            return pandoc.RawBlock("review", render(Blocks.Figure(el)))
+          end,
+        }),
+        opts
+      )
+    end
+    log("WARNING: pandoc.write_classic is defunct. Using modern writer")
+  end
+
+  -- body should keep trailing new lines but remove one if there are footnotes for the backward-compatibility
+  local body = pandoc.layout.render(pandoc.layout.concat({ blocks(doc.blocks, "\n") }))
+  return Doc(#footnotes == 0 and body or body:gsub("\n$", ""))
+end