6713098919

Committed 31 Oct 2023 10:21PM UTC coverage: 52.831% (-21.8%) from 74.636%

Build # 6713098919

Build Type

push

github

Committed by

web-flow

Commit Message

Merge d0a2a1ee9 into b185d4972

Run Details

45 of 45 new or added lines in 3 files covered. (100.0%)

8173 of 15470 relevant lines covered (52.83%)

6562.28 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/packages/pdf/init.lua

local base = require("packages.base")

local package = pl.class(base)
package._name = "pdf"

local pdf

local function borderColor (color)
  if color then
    if color.r then return "/C [" .. color.r .. " " .. color.g .. " " .. color.b .. "]" end
    if color.c then return "/C [" .. color.c .. " " .. color.m .. " " .. color.y .. " " .. color.k .. "]" end
    if color.l then return "/C [" .. color.l .. "]" end
  end
  return ""
end

local function borderStyle (style, width)
  if style == "underline" then return "/BS<</Type/Border/S/U/W " .. width .. ">>" end
  if style == "dashed" then return "/BS<</Type/Border/S/D/D[3 2]/W " .. width .. ">>" end
  return "/Border[0 0 " .. width .. "]"
end

local function validate_date (date)
  return string.match(date, [[^D:%d+%s*-%s*%d%d%s*'%s*%d%d%s*'?$]]) ~= nil
end

function package:_init ()
  base._init(self)
  pdf = require("justenoughlibtexpdf")
  if SILE.outputter._name ~= "libtexpdf" then
    SU.error("pdf package requires libtexpdf backend")
  end
end

function package:registerCommands ()

  self:registerCommand("pdf:destination", function (options, _)
    local name = SU.required(options, "name", "pdf:destination")
    if type(SILE.outputter._ensureInit) == "function" then
      SILE.outputter:_ensureInit()
    end
    SILE.typesetter:pushHbox({
      outputYourself = function (_, typesetter, line)
        local state = typesetter.frame.state
        typesetter.frame:advancePageDirection(-line.height)
        local x, y = state.cursorX, state.cursorY
        typesetter.frame:advancePageDirection(line.height)
        local _y = SILE.documentState.paperSize[2] - y
        pdf.destination(name, x:tonumber(), _y:tonumber())
      end
    })
  end)

  self:registerCommand("pdf:bookmark", function (options, _)
    local dest = SU.required(options, "dest", "pdf:bookmark")
    local title = SU.required(options, "title", "pdf:bookmark")
    local level = options.level or 1
    -- Added UTF8 to UTF16-BE conversion
    -- For annotations and bookmarks, text strings must be encoded using
    -- either PDFDocEncoding or UTF16-BE with a leading byte-order marker.
    -- As PDFDocEncoding supports only limited character repertoire for
    -- European languages, we use UTF-16BE for internationalization.
    local ustr = SU.utf8_to_utf16be_hexencoded(title)
    if type(SILE.outputter._ensureInit) == "function" then
      SILE.outputter:_ensureInit()
    end
    SILE.typesetter:pushHbox({
      value = nil,
      height = SILE.measurement(0),
      width = SILE.measurement(0),
      depth = SILE.measurement(0),
      outputYourself = function ()
        local d = "<</Title<" .. ustr .. ">/A<</S/GoTo/D(" .. dest .. ")>>>>"
        pdf.bookmark(d, level)
      end
    })
  end)

  self:registerCommand("pdf:literal", function (_, content)
    if type(SILE.outputter._ensureInit) == "function" then
      SILE.outputter:_ensureInit()
    end
    SILE.typesetter:pushHbox({
      value = nil,
      height = SILE.measurement(0),
      width = SILE.measurement(0),
      depth = SILE.measurement(0),
      outputYourself = function (_, _, _)
        pdf.add_content(content[1])
      end
    })
  end)

  self:registerCommand("pdf:link", function (options, content)
    local dest = SU.required(options, "dest", "pdf:link")
    local target = options.external and "/Type/Action/S/URI/URI" or "/S/GoTo/D"
    local borderwidth = options.borderwidth and SU.cast("measurement", options.borderwidth):tonumber() or 0
    local bordercolor = borderColor(SILE.color(options.bordercolor or "blue"))
    local borderoffset = SU.cast("measurement", options.borderoffset or "1pt"):tonumber()
    local borderstyle = borderStyle(options.borderstyle, borderwidth)
    local llx, lly
    if type(SILE.outputter._ensureInit) == "function" then
      SILE.outputter:_ensureInit()
    end
    SILE.typesetter:pushHbox({
      value = nil,
      height = SILE.measurement(0),
      width = SILE.measurement(0),
      depth = SILE.measurement(0),
      outputYourself = function (_, typesetter, _)
        llx = typesetter.frame.state.cursorX:tonumber()
        lly = (SILE.documentState.paperSize[2] - typesetter.frame.state.cursorY):tonumber()
        pdf.begin_annotation()
      end
    })

    local hbox, hlist = SILE.typesetter:makeHbox(content) -- hack
    SILE.typesetter:pushHbox(hbox)
    SILE.typesetter:pushHlist(hlist)

    SILE.typesetter:pushHbox({
      value = nil,
      height = SILE.measurement(0),
      width = SILE.measurement(0),
      depth = SILE.measurement(0),
      outputYourself = function (_, typesetter, _)
        local d = "<</Type/Annot/Subtype/Link" .. borderstyle .. bordercolor .. "/A<<" .. target .. "(" .. dest .. ")>>>>"
        local x = typesetter.frame.state.cursorX:tonumber()
        local y = (SILE.documentState.paperSize[2] - typesetter.frame.state.cursorY + hbox.height):tonumber()
        pdf.end_annotation(d, llx , lly - borderoffset, x, y + borderoffset)
      end
    })
  end)

  self:registerCommand("pdf:metadata", function (options, _)
    local key = SU.required(options, "key", "pdf:metadata")
    if options.val ~= nil then
      SU.deprecated("\\pdf:metadata[…, val=…]", "\\pdf:metadata[…, value=…]", "0.12.0", "0.13.0")
    end
    local value = SU.required(options, "value", "pdf:metadata")

    if key == "Trapped" then
      SU.warn("Skipping special metadata key \\Trapped")
      return
    end

    if key == "ModDate" or key == "CreationDate" then
      if not validate_date(value) then
        SU.warn("Invalid date: " .. value)
        return
      end
    else
      -- see comment in pdf:bookmark
      value = SU.utf8_to_utf16be(value)
    end
    if type(SILE.outputter._ensureInit) == "function" then
      SILE.outputter:_ensureInit()
    end
    SILE.typesetter:pushHbox({
      value = nil,
      height = SILE.measurement(0),
      width = SILE.measurement(0),
      depth = SILE.measurement(0),
      outputYourself = function (_, _, _)
        pdf.metadata(key, value)
      end
    })
  end)

end

package.documentation = [[
\begin{document}
The \autodoc:package{pdf} package enables basic support for PDF links and table-of-contents entries.
It provides the four commands \autodoc:command{\pdf:destination}, \autodoc:command{\pdf:link}, \autodoc:command{\pdf:bookmark}, and \autodoc:command{\pdf:metadata}.

The \autodoc:command{\pdf:destination} parameter creates a link target; it expects a parameter called \autodoc:parameter{name} to uniquely identify the target.
To create a link to that location in the document, use \autodoc:command{\pdf:link[dest=<name>]{<content>}}.

The \autodoc:command{\pdf:link} command accepts several options defining its border style: a \autodoc:parameter{borderwidth} length setting the border width (defaults to \code{0}, meaning no border), a \autodoc:parameter{borderstyle} string (can be set to \code{underline} or \code{dashed}, otherwise a solid box), a \autodoc:parameter{bordercolor} color specification for this border (defaults to \code{blue}), and finally a \autodoc:parameter{borderoffset} length for adjusting the border with some vertical space above the content and below the baseline (defaults to \code{1pt}).
Note that PDF renderers may vary on how they honor these border styling features on link annotations.

It also has an \autodoc:parameter{external} option for URL links, which is not intended to be used directly—refer to the \autodoc:package{url} package for more flexibility typesetting external links.

To set arbitrary key-value metadata, use something like \autodoc:command{\pdf:metadata[key=Author, value=J. Smith]}. The PDF metadata field names are case-sensitive. Common keys include \code{Title}, \code{Author}, \code{Subject}, \code{Keywords}, \code{CreationDate}, and \code{ModDate}.
\end{document}
]]

return package

1	local base = require("packages.base")	×
2
3	local package = pl.class(base)	×
4	package._name = "pdf"	×
5
6	local pdf
7
8	local function borderColor (color)
9	if color then	×
10	if color.r then return "/C [" .. color.r .. " " .. color.g .. " " .. color.b .. "]" end	×
11	if color.c then return "/C [" .. color.c .. " " .. color.m .. " " .. color.y .. " " .. color.k .. "]" end	×
12	if color.l then return "/C [" .. color.l .. "]" end	×
13	end
14	return ""	×
15	end
16
17	local function borderStyle (style, width)
18	if style == "underline" then return "/BS<</Type/Border/S/U/W " .. width .. ">>" end	×
19	if style == "dashed" then return "/BS<</Type/Border/S/D/D[3 2]/W " .. width .. ">>" end	×
20	return "/Border[0 0 " .. width .. "]"	×
21	end
22
23	local function validate_date (date)
24	return string.match(date, [[^D:%d+%s-%s%d%d%s'%s%d%d%s*'?$]]) ~= nil	×
25	end
26
27	function package:_init ()	×
28	base._init(self)	×
29	pdf = require("justenoughlibtexpdf")	×
30	if SILE.outputter._name ~= "libtexpdf" then	×
31	SU.error("pdf package requires libtexpdf backend")	×
32	end
33	end
34
35	function package:registerCommands ()	×
36
37	self:registerCommand("pdf:destination", function (options, _)	×
38	local name = SU.required(options, "name", "pdf:destination")	×
39	if type(SILE.outputter._ensureInit) == "function" then	×
40	SILE.outputter:_ensureInit()	×
41	end
42	SILE.typesetter:pushHbox({	×
43	outputYourself = function (_, typesetter, line)
44	local state = typesetter.frame.state	×
45	typesetter.frame:advancePageDirection(-line.height)	×
46	local x, y = state.cursorX, state.cursorY	×
47	typesetter.frame:advancePageDirection(line.height)	×
48	local _y = SILE.documentState.paperSize[2] - y	×
49	pdf.destination(name, x:tonumber(), _y:tonumber())	×
50	end
51	})
52	end)
53
54	self:registerCommand("pdf:bookmark", function (options, _)	×
55	local dest = SU.required(options, "dest", "pdf:bookmark")	×
56	local title = SU.required(options, "title", "pdf:bookmark")	×
57	local level = options.level or 1	×
58	-- Added UTF8 to UTF16-BE conversion
59	-- For annotations and bookmarks, text strings must be encoded using
60	-- either PDFDocEncoding or UTF16-BE with a leading byte-order marker.
61	-- As PDFDocEncoding supports only limited character repertoire for
62	-- European languages, we use UTF-16BE for internationalization.
63	local ustr = SU.utf8_to_utf16be_hexencoded(title)	×
64	if type(SILE.outputter._ensureInit) == "function" then	×
65	SILE.outputter:_ensureInit()	×
66	end
67	SILE.typesetter:pushHbox({	×
68	value = nil,
69	height = SILE.measurement(0),
70	width = SILE.measurement(0),
71	depth = SILE.measurement(0),
72	outputYourself = function ()
73	local d = "<</Title<" .. ustr .. ">/A<</S/GoTo/D(" .. dest .. ")>>>>"	×
74	pdf.bookmark(d, level)	×
75	end
76	})
77	end)
78
79	self:registerCommand("pdf:literal", function (_, content)	×
80	if type(SILE.outputter._ensureInit) == "function" then	×
81	SILE.outputter:_ensureInit()	×
82	end
83	SILE.typesetter:pushHbox({	×
84	value = nil,
85	height = SILE.measurement(0),
86	width = SILE.measurement(0),
87	depth = SILE.measurement(0),
88	outputYourself = function (_, _, _)
89	pdf.add_content(content[1])	×
90	end
91	})
92	end)
93
94	self:registerCommand("pdf:link", function (options, content)	×
95	local dest = SU.required(options, "dest", "pdf:link")	×
96	local target = options.external and "/Type/Action/S/URI/URI" or "/S/GoTo/D"	×
97	local borderwidth = options.borderwidth and SU.cast("measurement", options.borderwidth):tonumber() or 0	×
98	local bordercolor = borderColor(SILE.color(options.bordercolor or "blue"))	×
99	local borderoffset = SU.cast("measurement", options.borderoffset or "1pt"):tonumber()	×
100	local borderstyle = borderStyle(options.borderstyle, borderwidth)	×
101	local llx, lly
102	if type(SILE.outputter._ensureInit) == "function" then	×
103	SILE.outputter:_ensureInit()	×
104	end
105	SILE.typesetter:pushHbox({	×
106	value = nil,
107	height = SILE.measurement(0),
108	width = SILE.measurement(0),
109	depth = SILE.measurement(0),
110	outputYourself = function (_, typesetter, _)
111	llx = typesetter.frame.state.cursorX:tonumber()	×
112	lly = (SILE.documentState.paperSize[2] - typesetter.frame.state.cursorY):tonumber()	×
113	pdf.begin_annotation()	×
114	end
115	})
116
117	local hbox, hlist = SILE.typesetter:makeHbox(content) -- hack	×
118	SILE.typesetter:pushHbox(hbox)	×
119	SILE.typesetter:pushHlist(hlist)	×
120
121	SILE.typesetter:pushHbox({	×
122	value = nil,
123	height = SILE.measurement(0),
124	width = SILE.measurement(0),
125	depth = SILE.measurement(0),
126	outputYourself = function (_, typesetter, _)
127	local d = "<</Type/Annot/Subtype/Link" .. borderstyle .. bordercolor .. "/A<<" .. target .. "(" .. dest .. ")>>>>"	×
128	local x = typesetter.frame.state.cursorX:tonumber()	×
129	local y = (SILE.documentState.paperSize[2] - typesetter.frame.state.cursorY + hbox.height):tonumber()	×
130	pdf.end_annotation(d, llx , lly - borderoffset, x, y + borderoffset)	×
131	end
132	})
133	end)
134
135	self:registerCommand("pdf:metadata", function (options, _)	×
136	local key = SU.required(options, "key", "pdf:metadata")	×
137	if options.val ~= nil then	×
138	SU.deprecated("\\pdf:metadata[…, val=…]", "\\pdf:metadata[…, value=…]", "0.12.0", "0.13.0")	×
139	end
140	local value = SU.required(options, "value", "pdf:metadata")	×
141
142	if key == "Trapped" then	×
143	SU.warn("Skipping special metadata key \\Trapped")	×
144	return	×
145	end
146
147	if key == "ModDate" or key == "CreationDate" then	×
148	if not validate_date(value) then	×
149	SU.warn("Invalid date: " .. value)	×
150	return	×
151	end
152	else
153	-- see comment in pdf:bookmark
154	value = SU.utf8_to_utf16be(value)	×
155	end
156	if type(SILE.outputter._ensureInit) == "function" then	×
157	SILE.outputter:_ensureInit()	×
158	end
159	SILE.typesetter:pushHbox({	×
160	value = nil,
161	height = SILE.measurement(0),
162	width = SILE.measurement(0),
163	depth = SILE.measurement(0),
164	outputYourself = function (_, _, _)
165	pdf.metadata(key, value)	×
166	end
167	})
168	end)
169
170	end
171
172	package.documentation = [[
173	\begin{document}
174	The \autodoc:package{pdf} package enables basic support for PDF links and table-of-contents entries.
175	It provides the four commands \autodoc:command{\pdf:destination}, \autodoc:command{\pdf:link}, \autodoc:command{\pdf:bookmark}, and \autodoc:command{\pdf:metadata}.
176
177	The \autodoc:command{\pdf:destination} parameter creates a link target; it expects a parameter called \autodoc:parameter{name} to uniquely identify the target.
178	To create a link to that location in the document, use \autodoc:command{\pdf:link[dest=<name>]{<content>}}.
179
180	The \autodoc:command{\pdf:link} command accepts several options defining its border style: a \autodoc:parameter{borderwidth} length setting the border width (defaults to \code{0}, meaning no border), a \autodoc:parameter{borderstyle} string (can be set to \code{underline} or \code{dashed}, otherwise a solid box), a \autodoc:parameter{bordercolor} color specification for this border (defaults to \code{blue}), and finally a \autodoc:parameter{borderoffset} length for adjusting the border with some vertical space above the content and below the baseline (defaults to \code{1pt}).
181	Note that PDF renderers may vary on how they honor these border styling features on link annotations.
182
183	It also has an \autodoc:parameter{external} option for URL links, which is not intended to be used directly—refer to the \autodoc:package{url} package for more flexibility typesetting external links.
184
185	To set arbitrary key-value metadata, use something like \autodoc:command{\pdf:metadata[key=Author, value=J. Smith]}. The PDF metadata field names are case-sensitive. Common keys include \code{Title}, \code{Author}, \code{Subject}, \code{Keywords}, \code{CreationDate}, and \code{ModDate}.
186	\end{document}
187	]]	×
188
189	return package	×

sile-typesetter / sile / 6713098919

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous