summaryrefslogtreecommitdiff
path: root/macros/luatex/generic/lua-widow-control/t-lua-widow-control.mkxl
blob: aa3de5a63529985065d53551f0119b09da83afc3 (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
%D \module
%D   [     file=t-lua-widow-control,
%D      version=3.0.1, %%version
%D        title=lua-widow-control,
%D     subtitle=\ConTeXt module for lua-widow-control,
%D       author=Max Chernoff,
%D         date=2024-03-11, %%dashdate
%D    copyright=Max Chernoff,
%D      license=MPL-2.0+,
%D          url=https://github.com/gucci-on-fleek/lua-widow-control]
\startmodule[lua-widow-control]
\unprotect

% Preliminaries
\installnamespace{lwc}

\installswitchcommandhandler \????lwc {lwc} \????lwc

% Set up the options
\newdimen\lwc_emergency_stretch
\newdimen\lwc_draft_offset
\newcount\lwc_max_cost

\starttexdefinition lwc_set_parameters
    \lwc_emergency_stretch=\lwcparameter{emergencystretch}
    \lwc_draft_offset=\lwcparameter{draftoffset}

    \doifelse{\lwcparameter{\c!state}}\v!start{
        \lwc_enable
    }{
        \lwc_disable
    }

    \lwc_debug{\lwcparameter{debug}}

    \doif{\lwcparameter{draft}}\v!start{
        \setlwcparameter{showcosts}{\v!start}
        \setlwcparameter{showcolours}{\v!start}
    }

    \doif{\lwcparameter{draft}}\v!stop{
        \setlwcparameter{showcosts}{\v!stop}
        \setlwcparameter{showcolours}{\v!stop}
    }

    \lwc_show_costs{\lwcparameter{showcosts}}
    \lwc_show_colours{\lwcparameter{showcolours}}

    \lwc_nobreak{\lwcparameter{nobreak}}

    \lwc_max_cost=\lwcparameter{maxcost}

    % We can't just set the penalties because they will be reset automatically
    % at \\starttext.
    \startsetups[*default]
        \directsetup{*reset}

        \clubpenalty=\lwcparameter{orphanpenalty}
        \widowpenalty=\lwcparameter{widowpenalty}
        \displaywidowpenalty=\lwcparameter{widowpenalty}
        \brokenpenalty=\lwcparameter{brokenpenalty}
    \stopsetups

    \startsetups[grid][*default]
        \directsetup{*reset}

        \clubpenalty=\lwcparameter{orphanpenalty}
        \widowpenalty=\lwcparameter{widowpenalty}
        \displaywidowpenalty=\lwcparameter{widowpenalty}
        \brokenpenalty=\lwcparameter{brokenpenalty}
    \stopsetups

    \setups[*default]
\stoptexdefinition

% Load the main Lua file
\ctxloadluafile{lua-widow-control}

% Define the presets
\definelwc[default][
    emergencystretch=3em,
    maxcost=2147483647,
    nobreak=keep,
    orphanpenalty=1,
    widowpenalty=1,
    brokenpenalty=1,
]

\definelwc[strict][
    emergencystretch=0pt,
    maxcost=5000,
    nobreak=warn,
    widowpenalty=1,
    orphanpenalty=1,
    brokenpenalty=1,
]

\definelwc[balanced][
    emergencystretch=1em,
    maxcost=10000
    nobreak=keep,
    widowpenalty=500,
    orphanpenalty=500,
    brokenpenalty=500,
]

% Set up the default options
\setuplwc[
    \c!state=\v!start,
    debug=\v!stop,
    draft=,
    showcosts=\v!stop,
    showcolours=\v!stop,
    draftoffset=1in,
]

\setuplwc[default]

\appendtoks
    \ifcase\lwcsetupmode
        % can't happen
    \or % \setuplwc[name][key=value]
      \ifx\previouslwc\currentlwc
        \let\currentlwc\currentlwc
        \lwc_set_parameters
      \fi
    \or % \setuplwc[key=value]
      \let\currentlwc\previouslwc
      \lwc_set_parameters
    \or % \setuplwc[name]
      \glet\currentlwc\currentlwc % global
      \lwc_set_parameters
    \fi
\to \everysetuplwc

\lwc_set_parameters

% Here, we enable font expansion/contraction. It isn't strictly necessary for
% \lwc/'s functionality; however, it is required for the
% lengthened paragraphs to not have terrible spacing.
\definefontfeature[default][default][expansion=quality]
\setupalign[hz]

% Expansion of some parts of the document, such as section headings, is quite
% undesirable, so we'll disable \lwc/ for certain commands.
% We should only reenable \lwc/ at the end if it was already enabled.
\newcount\lwc_disable_count

\define\lwc_patch_pre{%
    \lwc_if_enabled%
        \advance\lwc_disable_count by 1%
        \lwc_disable%
    \fi%
}

\define\lwc_patch_post{
    \ifnum\lwc_disable_count>0\relax%
        \lwc_enable%
        \advance\lwc_disable_count by -1%
    \fi%
}

% Add the default patches
\prependtoks\lwc_patch_pre\to\everybeforesectionheadhandle % Sectioning
\prependtoks\lwc_patch_post\to\everyaftersectionheadhandle

% Make the commands public
\let\iflwc=\lwc_if_enabled

\protect
\stopmodule