pangamebook/pangamebook.lua

-- pandoc filter to turn headers and links into numbers
-- Copyright 2021 Pelle Nilsson
-- MIT License
-- source: https://github.com/lifelike/pangamebook

-- version: 1.1 (2021-10-05)
-- fossil hash: db17fe61a7e3c56b7afe1132bdbe4c0ea6ec82102fb22b5207d2475eaace35a7

local nr = 1
local mapped = {}

function get_nr_for_header(text, identifier)
  local key = "#" .. identifier
  local name_nr = tonumber(text)
  if name_nr ~= nil then
    if name_nr >= nr then
       mapped[key] = name_nr
       nr = name_nr + 1
    else
       print("ERROR: Section number " .. name_nr
             .. " too low (expected >= " .. nr .. ")")
       os.exit(1)
    end
  else
    mapped[key] = nr
    nr = nr + 1
  end
  return mapped[key]
end

function one_string_from_block(b)
   local result = ""
   local found_text = false
   pandoc.walk_block(b, {
                        Str = function(s)
                           if found_text then
                              return ""
                           else
                              result = s.text
                           end
                        end
   })
   return result
end

function is_valid_section_name(el)
   local first = one_string_from_block(el)
   local s,e = string.find(first, "[a-z][a-z_0-9]*")
   return (s == 1 and e == string.len(first))
end

function is_number_section_name(el)
   local first = one_string_from_block(el)
   local as_number = tonumber(first)
   return as_number ~= null and as_number >= 1
end

function shuffle_insert(target, sections)
   while #sections > 0 do
      local i = math.random(1, #sections)
      local section = table.remove(sections, i)
      for i,v in ipairs(section) do
         table.insert(target, v)
      end
   end
end

function insert_sections(sections,
                         section_start,
                         section_end,
                         blocks)
   local section = {}
   for j=section_start,section_end-1 do
      table.insert(section, blocks[j])
   end
   table.insert(sections, section)
end

function Pandoc(doc)
   local sections = {}
   local first_section_i = 0
   local current_section_start = -1
   local blocks = {}
   for i,el in pairs(doc.blocks) do
      if (el.t == "Header"
          and el.level == 1) then
         if current_section_start >= 0 then
            insert_sections(sections,
                            current_section_start,
                            i,
                            doc.blocks)
         end
         if is_valid_section_name(el) then
            current_section_start = i
         else
            if #sections > 0 then
               shuffle_insert(blocks, sections)
            end
            table.insert(blocks, el)
            current_section_start = -1
         end
      else
         if current_section_start < 0 then
            table.insert(blocks, el)
         end
      end
   end
   if current_section_start >= 0 then
      insert_sections(sections,
                      current_section_start,
                      #doc.blocks,
                      doc.blocks)
   end
   if #sections > 0 then
      shuffle_insert(blocks, sections)
   end
   return pandoc.Pandoc(blocks, doc.meta)
end

function Header(el)
  if (el.level ~= 1
      or not (is_valid_section_name(el)
              or is_number_section_name(el))) then
     return el
  end
  local first = one_string_from_block(el)
  local as_number
  local found = false
  local replaced = false
  local identifier = el.identifier
  return pandoc.walk_block(el, {
    Str = function(b)
            if replaced then
              return pandoc.Str("")
            else
              replaced = true
              local nr = get_nr_for_header(b.text, identifier)
              return pandoc.Str(nr)
            end
          end
    })
end

function Link(el)
  if string.find(el.target, "://") ~= null then
     return
  end
  local nr = mapped[el.target]
  if nr == nil then
    return pandoc.Link(pandoc.Strong(pandoc.Str(el.target)), el.target)
  else
    local content = pandoc.Strong(pandoc.Str(nr))
    return pandoc.Link(content, el.target)
  end
end

function Blocks(blocks)
  return blocks
end

function Meta(meta)
   local mapped_meta = {}
   for k, v in pairs(mapped) do
      mapped_meta[k] = tostring(v)
   end
   meta["pangamebook-mapping"] = mapped_meta
   return meta
end

return {
   {Pandoc = Pandoc},
   {Header = Header},
   {Link = Link},
   {Meta = Meta}
}