summaryrefslogtreecommitdiff
path: root/macros/luatex/latex/showkerning/showkerning.tex
blob: f60d7f2ecf27e78392a818d88703ab663fc25fe3 (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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
\documentclass[
ukenglish,%
twoside=false,%
fontsize=10pt,%
bibliography=totoc,%
numbers=autoenddot,%
headings=normalsize,%
overfullrule,%
headings=optiontotoc,%
]
{scrartcl}

\makeatletter
\providecommand\@ix{9.6}
\providecommand\@xi{10.4}
\providecommand\@xiii{13.15}
\def\subfootnotesize{%
    \@setfontsize%
    \subfootnotesize%
    {7.6}{8}%
}
\def\supernormalsize{%
    \@setfontsize%
    \supernormalsize%
    \@xi{12}%
}
\def\subnormalsize{%
    \@setfontsize%
    \subnormalsize%
    \@ix{11}%
}
\def\sublarge{%
    \@setfontsize%
    \sublarge%
    {11.2}{13}%
}
\def\superlarge{%
    \@setfontsize%
    \superlarge%
    \@xiii{16}%
}
\makeatother

\newcommand*{\sectionas}{2.3ex plus .2ex}
\newcommand*{\sectionbs}{-3.5ex plus -1ex minus -.2ex}
\newcommand*{\sectiontbs}{3.6pt}
\newcommand*{\subsectiontbs}{1.2pt}
\newcommand*{\subsectionas}{1.5ex plus .2ex}
\newcommand*{\subsectionbs}{-3.25ex plus -1ex minus -.2ex}
\newcommand*{\subsubsectionas}{\subsectionas}
\newcommand*{\subsubsectionbs}{\subsectionbs}
\newcommand*{\paragraphas}{-1em}
\newcommand*{\paragraphbs}{.8\baselineskip}

\newlength{\tnwsection}
\newlength{\tnwsubsection}
\newlength{\tnwsubsubsection}
\newlength{\tnwparagraph}
\newlength{\tisection}
\newlength{\tisubsection}
\newlength{\tisubsubsection}
\newlength{\tiparagraph}

\setlength{\tnwsection}{1.2em}
\addtolength{\tnwsection}{.6em}
\setlength{\tnwsubsection}{\tnwsection}
\addtolength{\tnwsubsection}{.75em}
\setlength{\tnwsubsubsection}{\tnwsubsection}
\addtolength{\tnwsubsubsection}{.75em}
\setlength{\tnwparagraph}{\tnwsubsubsection}
\addtolength{\tnwparagraph}{.75em}

\setlength{\tisection}{0em}
\setlength{\tisubsection}{\tisection}
\addtolength{\tisubsection}{\tnwsection}
\setlength{\tisubsubsection}{\tisubsection}
\addtolength{\tisubsubsection}{\tnwsubsection}
\setlength{\tiparagraph}{\tisubsubsection}
\addtolength{\tiparagraph}{\tnwsubsubsection}

\RedeclareSectionCommands[%
    tocraggedentrytext=true,%
]%
{section,subsection,subsubsection,paragraph}

\RedeclareSectionCommand[%
    tocindent=\tisection,%
    tocnumwidth=\tnwsection,%
    tocbeforeskip=\sectiontbs,%
    tocentryformat=\supernormalsize\sffamily\bfseries,%
    tocentrynumberformat=\supernormalsize\sffamily\bfseries,%
    tocpagenumberformat=\supernormalsize\sffamily\bfseries%
]%
{section}

\RedeclareSectionCommand[%
    tocindent=\tisubsection,%
    tocnumwidth=\tnwsubsection,%
    tocbeforeskip=\subsectiontbs,%
    tocentryformat=\subnormalsize,%
    tocentrynumberformat=\subnormalsize,%
    tocpagenumberformat=\subnormalsize%
]%
{subsection}

\RedeclareSectionCommand[%
    tocindent=\tisubsubsection,%
    tocnumwidth=\tnwsubsubsection,%
    tocbeforeskip=\sectiontbs%
]%
{subsubsection}

\RedeclareSectionCommand[%
    afterskip=\paragraphas,%
    beforeskip=\paragraphbs,%
    tocindent=\tiparagraph,%
    tocnumwidth=\tnwparagraph,%
    tocbeforeskip=\sectiontbs%
]%
{paragraph}

\linespread{1.1}

\newcommand*{\hs}{\hspace{.45em}}

\usepackage{fontspec}

\directlua{

    fonts.handlers.otf.addfeature {
        name = "onumkern",
        type = "kern",
        data = {
            ["v"] = { ["zero.taboldstyle"] = 80 },
            ["two.taboldstyle"] = { ["zero.taboldstyle"] = 30, ["/"] = 50 },
            ["five.taboldstyle"] = { ["/"] = 20 },
            ["»"] = { ["I"] = 50 },
        },
    }

}

\setmainfont{Tangent}[
    BoldFont = *-Medium,
    ItalicFont = *-Italic,
    Ligatures = {Common, TeX},
    Numbers = OldStyle,
    RawFeature = +onumkern
]

\setsansfont{SegoeUI}[
    BoldFont = seguisb.ttf,
    Ligatures = {Discretionary, TeX},
    Numbers = OldStyle
]

\setmonofont{Consolas}[
    ItalicFont = *-Italic,
    Numbers = OldStyle
]

\newcommand*{\mono}[1]{%
    {\subnormalsize\texttt{#1}}%
}

\usepackage{babel}
\usepackage[paper=a4paper,marginratio={2:1,3:4}]{geometry}
\usepackage{spacekern}
\usepackage{hyperref}
\usepackage{bookmark}
\usepackage{microtype}

\hypersetup{%
    pdflang=en,%
    unicode=true,%
	pdfborder={0 0 0},%
	bookmarksopen=true,%
    bookmarksopenlevel=0,%
	bookmarksnumbered=true,%
    pdftitle={The showkerning package},
    pdfsubject={Showing kerns in a document},
    pdfauthor={Thomas Kelkel},
    pdfkeywords={tex, latex, kerning}
}

\setlength{\parindent}{0pt}
\setlength{\parskip}{.4\baselineskip}

\newcommand*{\q}[1]{%
    ›%
    #1%
    ‹%
}
\newcommand*{\qq}[1]{%
    »%
    #1%
    «%
}

\newcommand*{\textnote}[1]{%
    {%
        \ttfamily%
        \char174{}%
        #1%
        \char174{}%
    }%
}

\usepackage{luacode}

\begin{luacode}

local FLOOR = math.floor

local function round ( num, dec )
    return FLOOR ( num * 10^dec + 0.5 ) / 10^dec
end

local p_array = {false, false, false, false, false}
local p_counter = 0
local ID = node.id
local NEW = node.new
local COPY = node.copy
local REM = node.remove
local PREV = node.prev
local NEXT = node.next
local TAIL = node.tail
local T_ID = node.traverse_id
local T_GLYPH = node.traverse_glyph
local INS_B = node.insert_before
local GLYPH = ID ( "glyph" )
local GLUE = ID ( "glue" )
local KERN = ID ( "kern" )
local HLIST = ID ( "hlist" )
local SWAPPED = table.swapped
local SUBTYPES = node.subtypes
local SPACESKIP = SWAPPED ( SUBTYPES ("glue") )["spaceskip"]
local WIDTH = round ( tex.sp ( "1.6em" ), 0 )
local ipairs = ipairs
local page_counter = 0
local INS_A = node.insert_after
local p_counter_x = 0
local ATC = luatexbase.add_to_callback

local function make_marks ( head, char, id, array, counter )
    for n in T_GLYPH ( head ) do
        if n.char == char then
            counter = counter + 1
            array[counter] = {false, false, false}
            head = INS_B ( head, n, NEW ( GLYPH ) )
            PREV ( n ).data = id
            local NEXT = n.next
            local inside_counter = 0
            while NEXT.char ~= char do
                inside_counter = inside_counter + 1
                array[counter][inside_counter] = COPY ( NEXT )
                NEXT = NEXT.next
                REM ( head, NEXT.prev )
            end
            head = REM ( head, NEXT )
            head = REM ( head, n )
        end
    end
    return head, array, counter
end

local function mark_notes ( head )
    head, p_array, p_counter = make_marks ( head, 174, 427956, p_array, p_counter )
    return head
end

local function make_margin_notes ( head, id, array, counter )
    for n in T_ID ( HLIST, head ) do
        local first_kern = 0
        local first_width = 0
        for glyph_node in T_GLYPH ( n.head ) do
            if glyph_node.data == id then
                counter = counter + 1
                local tail_node = TAIL ( n.head )
                local glue_node = NEW ( GLUE )
                glue_node.subtype = SPACESKIP
                glue_node.width = WIDTH
                local NEXT
                local switch_counter = 1 -- page_counter
                n.head = INS_A ( n.head, TAIL ( n.head ), glue_node )
                if ( switch_counter % 2 == 0 ) then
                    NEXT = glue_node
                else
                    NEXT = tail_node
                end
                local kern_value = 0
                for _, value in ipairs ( array[counter] ) do
                    if value ~= false then
                        local NUMBER = COPY ( value )
                            n.head = INS_A ( n.head, NEXT, NUMBER)
                            if NEXT.next then
                                NEXT = NEXT.next
                            end
                        if NUMBER.width then
                            kern_value = kern_value - NUMBER.width
                        end
                    end
                end
                local kern_node = NEW ( KERN )
                kern_node.kern = kern_value - glue_node.width
                if switch_counter % 2 ~= 0  then
                    kern_node.kern = kern_node.kern - tex.hsize + first_kern
                    n.head = INS_A ( n.head, tail_node, kern_node )
                end
                if ( switch_counter % 2 == 0 ) and ( first_kern < 0 ) then
                    kern_node.kern = kern_node.kern - first_kern + first_width - kern_value
                    n.head = INS_A ( n.head, tail_node, kern_node )
                end
                first_kern = kern_node.kern
                first_width = kern_value
            end
        end
    end
    return head, counter
end

local function make_text_notes ( head )
    page_counter = page_counter + 1
    head, p_counter_x = make_margin_notes ( head, 427956, p_array, p_counter_x )
    return head
end

    ATC ( "ligaturing", mark_notes , "mark notes" )
    ATC ( "pre_output_filter", make_text_notes , "count pages" )

\end{luacode}

\flushbottom

\pagestyle{empty}

\usepackage{showkerning}

\RedeclareSectionCommand[%
    afterskip=1.3ex plus .2ex,%
    beforeskip=-2.5ex plus -1ex minus -.2ex,%
    font=\superlarge%
]%
{section}

\begin{document}

\directlua{
    local function rem_kern ( head )
        for n in node.traverse ( head ) do
            if n.id == node.id ( "hlist" ) or n.id == node.id ( "vlist" ) then
                n.head = rem_kern ( n.head )
            elseif n.id == node.id ( "glyph" ) then
                if n.char == 112 then
                    n.prev.data = ""
                end
            end
        end
        return head
    end

    luatexbase.add_to_callback ( "post_linebreak_filter", rem_kern, "remove kern", 1 )
}

\title{The showk\kern-.1eme\kern.2emrn\kern-.05emin\kern.1emg package\vspace{.25\baselineskip}\\\superlarge{}\directlua{luatexbase.remove_from_callback ( "post_linebreak_filter", "show kerns in postline" ) luatexbase.remove_from_callback ( "hpack_filter", "show kerns in hpack" ) luatexbase.remove_from_callback ( "post_linebreak_filter", "remove kern" )}Showing kerns in a document}%
\author{\sublarge{}Thomas Kelkel\vspace{-.25\baselineskip}\\\sublarge{}kelkel@emaileon.de\vspace{-.25\baselineskip}}%
\date{\addfontfeature{LetterSpace=2}\sublarge{}2022/05/31\quad{}v0.1}%
\maketitle

\thispagestyle{empty}

\section{Introduction}

This package displays all kerning values in the form of colored bars directly at the respective position in the document. Positive values are displayed in green, negative values in red. The width of the bars corresponds exactly to the respective kerning value. The left edge of the bar is always at the position where the kerning node is placed. (This corresponds to the common representation method).

Please note that Lua{\addfontfeature{LetterSpace = 2}\LaTeX} is required to use this package.

\section{Basic usage}

To load the package, simply add the following line to the preamble of the document:

\begin{quote}
    \mono{\textbackslash{}usepackage\{showkerning\}}
\end{quote}

\section{Package options}

\addcontentsline{toc}{subsection}{ontop}

\textnote{ontop}By default, the bars are placed behind the glyphs. With this option they are in front of them. It can be loaded in the following way:

\begin{quote}
    \mono{\textbackslash{}usepackage[ontop]\{showkerning\}}
\end{quote}

\section{License}

This package is copyright © 2022 Thomas Kelkel. It may be distributed and/or modified under the conditions of the LaTeX Project Public License, either version 1.3c of this license or (at your option) any later version. This work has the LPPL maintenance status \qq{author maintained}.

\end{document}