9710365167

Committed 28 Jun 2024 09:04AM UTC coverage: 64.818% (+3.0%) from 61.779%

Build # 9710365167

Build Type

push

github

Committed by

alerque

Commit Message

chore(release): 0.15.4

Run Details

11257 of 17367 relevant lines covered (64.82%)

3154.47 hits per line

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

0.0

/packages/url/init.lua

local base = require("packages.base")

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

-- URL escape sequence, URL fragment:
local preferBreakBefore = "%#"
-- URL path elements, URL query arguments, acceptable extras:
local preferBreakAfter = ":/.;?&=!_-"
-- URL scheme:
local alwaysBreakAfter = ":" -- Must have only one character here!

local escapeRegExpMinimal = function (str)
   -- Minimalist = just what's needed for the above strings
   return string.gsub(str, "([%.%?%-%%])", "%%%1")
end

local breakPattern = "[" .. escapeRegExpMinimal(preferBreakBefore .. preferBreakAfter .. alwaysBreakAfter) .. "]"

function package:_init ()
   base._init(self)
   self:loadPackage("verbatim")
   self:loadPackage("inputfilter")
   self:loadPackage("pdf")
end

function package.declareSettings (_)
   SILE.settings:declare({
      parameter = "url.linebreak.primaryPenalty",
      type = "integer",
      default = 100,
      help = "Penalty for breaking lines in URLs at preferred breakpoints",
   })

   SILE.settings:declare({
      parameter = "url.linebreak.secondaryPenalty",
      type = "integer",
      default = 200,
      help = "Penalty for breaking lines in URLs at tolerable breakpoints (should be higher than url.linebreak.primaryPenalty)",
   })
end

function package:registerCommands ()
   self:registerCommand("href", function (options, content)
      if options.src then
         SILE.call("pdf:link", {
            dest = options.src,
            external = true,
            borderwidth = options.borderwidth,
            borderstyle = options.borderstyle,
            bordercolor = options.bordercolor,
            borderoffset = options.borderoffset,
         }, content)
      else
         options.src = content[1]
         SILE.call("pdf:link", {
            dest = options.src,
            external = true,
            borderwidth = options.borderwidth,
            borderstyle = options.borderstyle,
            bordercolor = options.bordercolor,
            borderoffset = options.borderoffset,
         }, function (_, _)
            SILE.call("url", { language = options.language }, content)
         end)
      end
   end, "Inserts a PDF hyperlink.")

   local urlFilter = function (node, content, options)
      if type(node) == "table" then
         return node
      end
      local result = {}
      for token in SU.gtoke(node, breakPattern) do
         if token.string then
            result[#result + 1] = token.string
         else
            if string.find(preferBreakBefore, escapeRegExpMinimal(token.separator)) then
               -- Accepts breaking before, and at the extreme worst after.
               result[#result + 1] = self.class.packages.inputfilter:createCommand(
                  content.pos,
                  content.col,
                  content.lno,
                  "penalty",
                  { penalty = options.primaryPenalty }
               )
               result[#result + 1] = token.separator
               result[#result + 1] = self.class.packages.inputfilter:createCommand(
                  content.pos,
                  content.col,
                  content.lno,
                  "penalty",
                  { penalty = options.worsePenalty }
               )
            elseif token.separator == alwaysBreakAfter then
               -- Accept breaking after (only).
               result[#result + 1] = token.separator
               result[#result + 1] = self.class.packages.inputfilter:createCommand(
                  content.pos,
                  content.col,
                  content.lno,
                  "penalty",
                  { penalty = options.primaryPenalty }
               )
            else
               -- Accept breaking after, but tolerate breaking before.
               result[#result + 1] = self.class.packages.inputfilter:createCommand(
                  content.pos,
                  content.col,
                  content.lno,
                  "penalty",
                  { penalty = options.secondaryPenalty }
               )
               result[#result + 1] = token.separator
               result[#result + 1] = self.class.packages.inputfilter:createCommand(
                  content.pos,
                  content.col,
                  content.lno,
                  "penalty",
                  { penalty = options.primaryPenalty }
               )
            end
         end
      end
      return result
   end

   self:registerCommand("url", function (options, content)
      SILE.settings:temporarily(function ()
         local primaryPenalty = SILE.settings:get("url.linebreak.primaryPenalty")
         local secondaryPenalty = SILE.settings:get("url.linebreak.secondaryPenalty")
         local worsePenalty = primaryPenalty + secondaryPenalty

         if options.language then
            SILE.languageSupport.loadLanguage(options.language)
            if options.language == "fr" then
               -- Trick the engine by declaring a "fake"" language that doesn't apply
               -- the typographic rules for punctuations
               SILE.hyphenator.languages["_fr_noSpacingRules"] = SILE.hyphenator.languages.fr
               -- Not needed (the engine already defaults to SILE.nodeMakers.unicode if
               -- the language is not found):
               -- SILE.nodeMakers._fr_noSpacingRules = SILE.nodeMakers.unicode
               SILE.settings:set("document.language", "_fr_noSpacingRules")
            else
               SILE.settings:set("document.language", options.language)
            end
         else
            SILE.settings:set("document.language", "und")
         end

         local result = self.class.packages.inputfilter:transformContent(content, urlFilter, {
            primaryPenalty = primaryPenalty,
            secondaryPenalty = secondaryPenalty,
            worsePenalty = worsePenalty,
         })
         SILE.call("urlstyle", {}, result)
      end)
   end, "Inserts penalties in an URL so it can be broken over multiple lines at appropriate places.")

   self:registerCommand("urlstyle", function (options, content)
      SILE.call("code", options, content)
   end, "Hook that may be redefined to change the styling of URLs")
end

package.documentation = [[
\begin{document}
\use[module=packages.url]
This package enhances the typesetting of URLs in two ways.
First, it provides the \autodoc:command{\href[src=<url>]{<content>}} command which inserts PDF hyperlinks, \href[src=http://www.sile-typesetter.org/]{like this}.

The \autodoc:command{\href} command accepts the same \autodoc:parameter{borderwidth}, \autodoc:parameter{bordercolor}, \autodoc:parameter{borderstyle}, and \autodoc:parameter{borderoffset} styling options as the \autodoc:command[check=false]{\pdf:link} command from the \autodoc:package{pdf} package, for instance \href[src=http://www.sile-typesetter.org/, borderwidth=0.4pt, bordercolor=blue, borderstyle=underline]{like this}.

Nowadays, it is a common practice to have URLs in print articles (whether it is a good practice or not is yet \em{another} topic).
Therefore, the package also provides the \autodoc:command{\url} command, which will automatically insert breakpoints into unwieldy URLs like \url{https://github.com/sile-typesetter/sile-typesetter.github.io/tree/master/examples} so that they can be broken up over multiple lines.

It allows line breaks after the colon, and before or after appropriate segments of an URL (path elements, query parts, fragments, etc.).
By default, the \autodoc:command{\url} command ignores the current language, as one would not want hyphenation to occur in URL segments.
If you have no other choice, however, you can pass it a \autodoc:parameter{language} option to enforce a language to be applied.
Note that if French (\code{fr}) is selected, the special typographic rules applying to punctuations in this language are disabled.

To typeset a URL and also make it an active hyperlink, use the \autodoc:command{\href} command without the \autodoc:parameter{src} option,
but with the URL passed as argument.

The breaks are controlled by two penalty settings: \autodoc:setting{url.linebreak.primaryPenalty} for preferred breakpoints and, for less acceptable but still tolerable breakpoints, \autodoc:setting{url.linebreak.secondaryPenalty}—its value should logically be higher than the previous one.

The \autodoc:command{\urlstyle} command hook may be overridden to change the style of URLs.
By default, they are typeset as “code”.

\end{document}
]]

return package

1	local base = require("packages.base")	×
2
3	local package = pl.class(base)	×
4	package._name = "url"	×
5
6	-- URL escape sequence, URL fragment:
7	local preferBreakBefore = "%#"	×
8	-- URL path elements, URL query arguments, acceptable extras:
9	local preferBreakAfter = ":/.;?&=!_-"	×
10	-- URL scheme:
11	local alwaysBreakAfter = ":" -- Must have only one character here!	×
12
13	local escapeRegExpMinimal = function (str)
14	-- Minimalist = just what's needed for the above strings
15	return string.gsub(str, "([%.%?%-%%])", "%%%1")	×
16	end
17
18	local breakPattern = "[" .. escapeRegExpMinimal(preferBreakBefore .. preferBreakAfter .. alwaysBreakAfter) .. "]"	×
19
20	function package:_init ()	×
21	base._init(self)	×
22	self:loadPackage("verbatim")	×
23	self:loadPackage("inputfilter")	×
24	self:loadPackage("pdf")	×
25	end
26
27	function package.declareSettings (_)	×
28	SILE.settings:declare({	×
29	parameter = "url.linebreak.primaryPenalty",
30	type = "integer",
31	default = 100,
32	help = "Penalty for breaking lines in URLs at preferred breakpoints",
33	})
34
35	SILE.settings:declare({	×
36	parameter = "url.linebreak.secondaryPenalty",
37	type = "integer",
38	default = 200,
39	help = "Penalty for breaking lines in URLs at tolerable breakpoints (should be higher than url.linebreak.primaryPenalty)",
40	})
41	end
42
43	function package:registerCommands ()	×
44	self:registerCommand("href", function (options, content)	×
45	if options.src then	×
46	SILE.call("pdf:link", {	×
47	dest = options.src,
48	external = true,
49	borderwidth = options.borderwidth,
50	borderstyle = options.borderstyle,
51	bordercolor = options.bordercolor,
52	borderoffset = options.borderoffset,
53	}, content)	×
54	else
55	options.src = content[1]	×
56	SILE.call("pdf:link", {	×
57	dest = options.src,
58	external = true,
59	borderwidth = options.borderwidth,
60	borderstyle = options.borderstyle,
61	bordercolor = options.bordercolor,
62	borderoffset = options.borderoffset,
63	}, function (_, _)
64	SILE.call("url", { language = options.language }, content)	×
65	end)
66	end
67	end, "Inserts a PDF hyperlink.")	×
68
69	local urlFilter = function (node, content, options)
70	if type(node) == "table" then	×
71	return node	×
72	end
73	local result = {}	×
74	for token in SU.gtoke(node, breakPattern) do	×
75	if token.string then	×
76	result[#result + 1] = token.string	×
77	else
78	if string.find(preferBreakBefore, escapeRegExpMinimal(token.separator)) then	×
79	-- Accepts breaking before, and at the extreme worst after.
80	result[#result + 1] = self.class.packages.inputfilter:createCommand(	×
81	content.pos,	×
82	content.col,	×
83	content.lno,	×
84	"penalty",
85	{ penalty = options.primaryPenalty }	×
86	)
87	result[#result + 1] = token.separator	×
88	result[#result + 1] = self.class.packages.inputfilter:createCommand(	×
89	content.pos,	×
90	content.col,	×
91	content.lno,	×
92	"penalty",
93	{ penalty = options.worsePenalty }	×
94	)
95	elseif token.separator == alwaysBreakAfter then	×
96	-- Accept breaking after (only).
97	result[#result + 1] = token.separator	×
98	result[#result + 1] = self.class.packages.inputfilter:createCommand(	×
99	content.pos,	×
100	content.col,	×
101	content.lno,	×
102	"penalty",
103	{ penalty = options.primaryPenalty }	×
104	)
105	else
106	-- Accept breaking after, but tolerate breaking before.
107	result[#result + 1] = self.class.packages.inputfilter:createCommand(	×
108	content.pos,	×
109	content.col,	×
110	content.lno,	×
111	"penalty",
112	{ penalty = options.secondaryPenalty }	×
113	)
114	result[#result + 1] = token.separator	×
115	result[#result + 1] = self.class.packages.inputfilter:createCommand(	×
116	content.pos,	×
117	content.col,	×
118	content.lno,	×
119	"penalty",
120	{ penalty = options.primaryPenalty }	×
121	)
122	end
123	end
124	end
125	return result	×
126	end
127
128	self:registerCommand("url", function (options, content)	×
129	SILE.settings:temporarily(function ()	×
130	local primaryPenalty = SILE.settings:get("url.linebreak.primaryPenalty")	×
131	local secondaryPenalty = SILE.settings:get("url.linebreak.secondaryPenalty")	×
132	local worsePenalty = primaryPenalty + secondaryPenalty	×
133
134	if options.language then	×
135	SILE.languageSupport.loadLanguage(options.language)	×
136	if options.language == "fr" then	×
137	-- Trick the engine by declaring a "fake"" language that doesn't apply
138	-- the typographic rules for punctuations
139	SILE.hyphenator.languages["_fr_noSpacingRules"] = SILE.hyphenator.languages.fr	×
140	-- Not needed (the engine already defaults to SILE.nodeMakers.unicode if
141	-- the language is not found):
142	-- SILE.nodeMakers._fr_noSpacingRules = SILE.nodeMakers.unicode
143	SILE.settings:set("document.language", "_fr_noSpacingRules")	×
144	else
145	SILE.settings:set("document.language", options.language)	×
146	end
147	else
148	SILE.settings:set("document.language", "und")	×
149	end
150
151	local result = self.class.packages.inputfilter:transformContent(content, urlFilter, {	×
152	primaryPenalty = primaryPenalty,
153	secondaryPenalty = secondaryPenalty,
154	worsePenalty = worsePenalty,
155	})
156	SILE.call("urlstyle", {}, result)	×
157	end)
158	end, "Inserts penalties in an URL so it can be broken over multiple lines at appropriate places.")	×
159
160	self:registerCommand("urlstyle", function (options, content)	×
161	SILE.call("code", options, content)	×
162	end, "Hook that may be redefined to change the styling of URLs")	×
163	end
164
165	package.documentation = [[
166	\begin{document}
167	\use[module=packages.url]
168	This package enhances the typesetting of URLs in two ways.
169	First, it provides the \autodoc:command{\href[src=<url>]{<content>}} command which inserts PDF hyperlinks, \href[src=http://www.sile-typesetter.org/]{like this}.
170
171	The \autodoc:command{\href} command accepts the same \autodoc:parameter{borderwidth}, \autodoc:parameter{bordercolor}, \autodoc:parameter{borderstyle}, and \autodoc:parameter{borderoffset} styling options as the \autodoc:command[check=false]{\pdf:link} command from the \autodoc:package{pdf} package, for instance \href[src=http://www.sile-typesetter.org/, borderwidth=0.4pt, bordercolor=blue, borderstyle=underline]{like this}.
172
173	Nowadays, it is a common practice to have URLs in print articles (whether it is a good practice or not is yet \em{another} topic).
174	Therefore, the package also provides the \autodoc:command{\url} command, which will automatically insert breakpoints into unwieldy URLs like \url{https://github.com/sile-typesetter/sile-typesetter.github.io/tree/master/examples} so that they can be broken up over multiple lines.
175
176	It allows line breaks after the colon, and before or after appropriate segments of an URL (path elements, query parts, fragments, etc.).
177	By default, the \autodoc:command{\url} command ignores the current language, as one would not want hyphenation to occur in URL segments.
178	If you have no other choice, however, you can pass it a \autodoc:parameter{language} option to enforce a language to be applied.
179	Note that if French (\code{fr}) is selected, the special typographic rules applying to punctuations in this language are disabled.
180
181	To typeset a URL and also make it an active hyperlink, use the \autodoc:command{\href} command without the \autodoc:parameter{src} option,
182	but with the URL passed as argument.
183
184	The breaks are controlled by two penalty settings: \autodoc:setting{url.linebreak.primaryPenalty} for preferred breakpoints and, for less acceptable but still tolerable breakpoints, \autodoc:setting{url.linebreak.secondaryPenalty}—its value should logically be higher than the previous one.
185
186	The \autodoc:command{\urlstyle} command hook may be overridden to change the style of URLs.
187	By default, they are typeset as “code”.
188
189	\end{document}
190	]]	×
191
192	return package	×

sile-typesetter / sile / 9710365167

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