summaryrefslogtreecommitdiff
path: root/support/make4ht/filters/make4ht-domfilter.lua
blob: f6df769d60ca5ec076496f8a4db9e16dc050a84d (plain)
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
local filter_lib = require "make4ht-filterlib"
local dom    = require "luaxml-domobject"
local mkutils    = require "mkutils"
local log = logging.new "domfilter"

local function load_filter(filtername)
	return require("domfilters.make4ht-"..filtername)
end

-- save processed names, in order to block multiple executions of the filter
-- sequence on a same file
local processed = {}

local function filter(filters, name)
  -- because XML parsing to DOM is potentially expensive operation
  -- this filter will use cache for it's sequence
  -- all requests to the domfilter will add new filters to the
  -- one sequence, which will be executed on one DOM object.
  -- it is possible to request a different sequence using
  -- unique name parameter
  local name = name or "domfilter"
  local settings = mkutils.get_filter_settings(name) or {}
  local sequence = settings.sequence or {}
  local local_sequence = filter_lib.load_filters(filters, load_filter)
  for _, filter in ipairs(local_sequence) do
    table.insert(sequence, filter)
  end
  settings.sequence = sequence
  mkutils.filter_settings (name) (settings)

	return function(filename, parameters)
    -- load processed files for the current filter name
    local processed_files = processed[name] or {}
    -- don't process the file again
    if processed_files[filename] then
      return nil
    end
    local input = filter_lib.load_input_file(filename)
    if not input  then return nil, "Cannot load the input file" end
    -- we need to use pcall, because XML error would break the whole build process
    -- domobject will be error object if DOM parsing failed
    local status, domobject = pcall(function()
      return dom.parse(input)
    end)
    if not status then
      log:warning("DOM parsing of " .. filename .. " failed:")
      log:warning(domobject)
      return nil, "DOM parsing failed"
    end
		for _,f in pairs(sequence) do
			domobject = f(domobject,parameters)
		end
    local output = domobject:serialize()
    if output then
      filter_lib.save_input_file(filename, output)
    else
      log:warning("DOM filter failed on ".. filename)
    end
    -- mark the filename as processed
    processed_files[filename] = true
    processed[name] = processed_files
	end
end
return filter