summaryrefslogtreecommitdiff
path: root/Build/source/texk/web2c/luatexdir/tex/nesting.c
blob: bbad50b3cdbe893ff6a3f9504eb726f624fcbafd (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
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
/*

nesting.w

Copyright 2009-2010 Taco Hoekwater <taco@@luatex.org>

This file is part of LuaTeX.

LuaTeX is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation; either version 2 of the License, or (at your
option) any later version.

LuaTeX is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
License for more details.

You should have received a copy of the GNU General Public License along
with LuaTeX; if not, see <http://www.gnu.org/licenses/>.

*/

#include "ptexlib.h"

/*tex These are for |show_activities|: */

#define page_goal page_so_far[0]

/*tex

\TeX\ is typically in the midst of building many lists at once. For example, when
a math formula is being processed, \TeX\ is in math mode and working on an mlist;
this formula has temporarily interrupted \TeX\ from being in horizontal mode and
building the hlist of a paragraph; and this paragraph has temporarily interrupted
\TeX\ from being in vertical mode and building the vlist for the next page of a
document. Similarly, when a \.{\\vbox} occurs inside of an \.{\\hbox}, \TeX\ is
temporarily interrupted from working in restricted horizontal mode, and it enters
internal vertical mode. The ``semantic nest'' is a stack that keeps track of what
lists and modes are currently suspended.

At each level of processing we are in one of six modes:

|vmode| stands for vertical mode (the page builder);

|hmode| stands for horizontal mode (the paragraph builder);

|mmode| stands for displayed formula mode;

|-vmode| stands for internal vertical mode (e.g., in a \.{\\vbox});

|-hmode| stands for restricted horizontal mode (e.g., in an \.{\\hbox});

|-mmode| stands for math formula mode (not displayed).

The mode is temporarily set to zero while processing \.{\\write} texts in the
|ship_out| routine.

Numeric values are assigned to |vmode|, |hmode|, and |mmode| so that \TeX's ``big
semantic switch'' can select the appropriate thing to do by computing the value
|abs(mode)+cur_cmd|, where |mode| is the current mode and |cur_cmd| is the
current command code.

*/

static const char *string_mode(int m)
{
    if (m > 0) {
        switch (m / (max_command_cmd + 1)) {
            case 0:
                return "vertical mode";
                break;
            case 1:
                return "horizontal mode";
                break;
            case 2:
                return "display math mode";
                break;
            default:
                break;
        }
    } else if (m == 0) {
        return "no mode";
    } else {
        switch ((-m) / (max_command_cmd + 1)) {
            case 0:
                return "internal vertical mode";
                break;
            case 1:
                return "restricted horizontal mode";
                break;
            case 2:
                return "math mode";
                break;
            default:
                break;
        }
    }
    return "unknown mode";
}

void print_mode(int m)
{
    tprint(string_mode(m));
}

void print_in_mode(int m)
{
    tprint("' in ");
    tprint(string_mode(m));
}

int get_mode_id(void)
{
    int m = cur_list.mode_field;
    if (m > 0) {
        switch (m / (max_command_cmd + 1)) {
            case 0:
                return 'v';
                break;
            case 1:
                return 'h';
                break;
            case 2:
                return 'm';
                break;
            default:
                return '\0';
                break;
        }
    } else if (m == 0) {
        return 'n';;
    } else {
        switch ((-m) / (max_command_cmd + 1)) {
            case 0:
                return 'V';
                break;
            case 1:
                return 'H';
                break;
            case 2:
                return 'M';
                break;
            default:
                return '\0';
                break;
        }
    }
}

/*tex

The state of affairs at any semantic level can be represented by five values:

|mode| is the number representing the semantic mode, as just explained.

|head| is a |pointer| to a list head for the list being built; |link(head)|
therefore points to the first element of the list, or to |null| if the list is
empty.

|tail| is a |pointer| to the final node of the list being built; thus,
|tail=head| if and only if the list is empty.

|prev_graf| is the number of lines of the current paragraph that have already
been put into the present vertical list.

|aux| is an auxiliary |memory_word| that gives further information that is needed
to characterize the situation.

In vertical mode, |aux| is also known as |prev_depth|; it is the scaled value
representing the depth of the previous box, for use in baseline calculations, or
it is |<=-1000|pt if the next box on the vertical list is to be exempt from
baseline calculations. In horizontal mode, |aux| is also known as |space_factor|;
it holds the current space factor used in spacing calculations. In math mode,
|aux| is also known as |incompleat_noad|; if not |null|, it points to a record
that represents the numerator of a generalized fraction for which the denominator
is currently being formed in the current list.

There is also a sixth quantity, |mode_line|, which correlates the semantic nest
with the user's input; |mode_line| contains the source line number at which the
current level of nesting was entered. The negative of this line number is the
|mode_line| at the level of the user's output routine.

A seventh quantity, |eTeX_aux|, is used by the extended features eTeX. In math
mode it is known as |delim_ptr| and points to the most recent |fence_noad| of a
|math_left_group|.

In horizontal mode, the |prev_graf| field is used for initial language data.

The semantic nest is an array called |nest| that holds the |mode|, |head|,
|tail|, |prev_graf|, |aux|, and |mode_line| values for all semantic levels below
the currently active one. Information about the currently active level is kept in
the global quantities |mode|, |head|, |tail|, |prev_graf|, |aux|, and
|mode_line|, which live in a struct that is ready to be pushed onto |nest| if
necessary.

The math field is used by various bits and pieces in |texmath.w|

This implementation of \TeX\ uses two different conventions for representing
sequential stacks. @^stack conventions@>@^conventions for representing stacks@>

1) If there is frequent access to the top entry, and if the stack is essentially
never empty, then the top entry is kept in a global variable (even better would
be a machine register), and the other entries appear in the array
$\\{stack}[0\to(\\{ptr}-1)]$. The semantic stack is handled this way.

2) If there is infrequent top access, the entire stack contents are in the array
$\\{stack}[0\to(\\{ptr}-1)]$. For example, the |save_stack| is treated this way,
as we have seen.

In |nest_ptr| we have the first unused location of |nest|, and |max_nest_stack|
has the maximum of |nest_ptr| when pushing. In |shown_mode| we store the most
recent mode shown by \.{\\tracingcommands} and with |save_tail| we can examine
whether we have an auto kern before a glue.

*/

list_state_record *nest;
int nest_ptr, max_nest_stack, shown_mode;
halfword save_tail;

/*tex

We will see later that the vertical list at the bottom semantic level is split
into two parts; the ``current page'' runs from |page_head| to |page_tail|, and
the ``contribution list'' runs from |contrib_head| to |tail| of semantic level
zero. The idea is that contributions are first formed in vertical mode, then
``contributed'' to the current page (during which time the page-breaking
decisions are made). For now, we don't need to know any more details about the
page-building process.

*/

void initialize_nesting(void)
{
    nest_ptr = 0;
    max_nest_stack = 0;
    shown_mode = 0;
    cur_list.mode_field = vmode;
    cur_list.head_field = contrib_head;
    cur_list.tail_field = contrib_head;
    cur_list.eTeX_aux_field = null;
    cur_list.prev_depth_field = ignore_depth;
    cur_list.space_factor_field = 1000;
    cur_list.incompleat_noad_field = null;
    cur_list.ml_field = 0;
    cur_list.pg_field = 0;
    cur_list.dirs_field = null;
    init_math_fields();
}

/*tex

Here is a common way to make the current list grow:

*/

void tail_append(halfword p)
{
    couple_nodes(cur_list.tail_field, p);
    cur_list.tail_field = vlink(cur_list.tail_field);
}

halfword pop_tail(void)
{
    halfword n, r;
    if (cur_list.tail_field != cur_list.head_field) {
        r = cur_list.tail_field;
        if (vlink(alink(cur_list.tail_field)) == cur_list.tail_field) {
            n = alink(cur_list.tail_field);
        } else {
            n = cur_list.head_field;
            while (vlink(n) != cur_list.tail_field)
                n = vlink(n);
        }
        cur_list.tail_field = n;
        alink(r) = null;
        vlink(n) = null;
        return r;
    } else {
        return null;
    }
}

/*tex

When \TeX's work on one level is interrupted, the state is saved by calling
|push_nest|. This routine changes |head| and |tail| so that a new (empty) list is
begun; it does not change |mode| or |aux|.

*/

void push_nest(void)
{
    if (nest_ptr > max_nest_stack) {
        max_nest_stack = nest_ptr;
        if (nest_ptr == nest_size)
            overflow("semantic nest size", (unsigned) nest_size);
    }
    incr(nest_ptr);
    cur_list.mode_field = nest[nest_ptr - 1].mode_field;
    cur_list.head_field = new_node(temp_node, 0);
    cur_list.tail_field = cur_list.head_field;
    cur_list.eTeX_aux_field = null;
    cur_list.ml_field = line;
    cur_list.pg_field = 0;
    cur_list.dirs_field = null;
    cur_list.prev_depth_field = nest[nest_ptr - 1].prev_depth_field;
    cur_list.space_factor_field = nest[nest_ptr - 1].space_factor_field;
    cur_list.incompleat_noad_field = nest[nest_ptr - 1].incompleat_noad_field;
    init_math_fields();
}

/*tex

Conversely, when \TeX\ is finished on the current level, the former state is
restored by calling |pop_nest|. This routine will never be called at the lowest
semantic level, nor will it be called unless |head| is a node that should be
returned to free memory.

*/

void pop_nest(void)
{
    flush_node(cur_list.head_field);
    decr(nest_ptr);
}

/*tex

Here is a procedure that displays what \TeX\ is working on, at all levels.

*/

void show_activities(void)
{
    /*tex Index into |nest|: */
    int p;
    /*tex The mode: */
    int m;
    /*tex For showing the current page: */
    halfword q, r;
    /*tex Ditto: */
    int t;
    tprint_nl("");
    print_ln();
    for (p = nest_ptr; p >= 0; p--) {
        m = nest[p].mode_field;
        tprint_nl("### ");
        print_mode(m);
        tprint(" entered at line ");
        print_int(abs(nest[p].ml_field));
        if (nest[p].ml_field < 0)
            tprint(" (\\output routine)");
        if (p == 0) {
            /*tex Show the status of the current page */
            if (page_head != page_tail) {
                tprint_nl("### current page:");
                if (output_active)
                    tprint(" (held over for next output)");
                show_box(vlink(page_head));
                if (page_contents > empty) {
                    tprint_nl("total height ");
                    print_totals();
                    tprint_nl(" goal height ");
                    print_scaled(page_goal);
                    r = vlink(page_ins_head);
                    while (r != page_ins_head) {
                        print_ln();
                        tprint_esc("insert");
                        t = subtype(r);
                        print_int(t);
                        tprint(" adds ");
                        if (count(t) == 1000)
                            t = height(r);
                        else
                            t = x_over_n(height(r), 1000) * count(t);
                        print_scaled(t);
                        if (type(r) == split_up_node) {
                            q = page_head;
                            t = 0;
                            do {
                                q = vlink(q);
                                if ((type(q) == ins_node)
                                    && (subtype(q) == subtype(r)))
                                    incr(t);
                            } while (q != broken_ins(r));
                            tprint(", #");
                            print_int(t);
                            tprint(" might split");
                        }
                        r = vlink(r);
                    }
                }
            }
            if (vlink(contrib_head) != null)
                tprint_nl("### recent contributions:");
        }
        show_box(vlink(nest[p].head_field));
        /*tex Show the auxiliary field, |a|. */
        switch (abs(m) / (max_command_cmd + 1)) {
            case 0:
                tprint_nl("prevdepth ");
                if (nest[p].prev_depth_field <= ignore_depth)
                    tprint("ignored");
                else
                    print_scaled(nest[p].prev_depth_field);
                if (nest[p].pg_field != 0) {
                    tprint(", prevgraf ");
                    print_int(nest[p].pg_field);
                    if (nest[p].pg_field != 1)
                        tprint(" lines");
                    else
                        tprint(" line");
                }
                break;
            case 1:
                tprint_nl("spacefactor ");
                print_int(nest[p].space_factor_field);
                break;
            case 2:
                if (nest[p].incompleat_noad_field != null) {
                    tprint("this will be denominator of:");
                    show_box(nest[p].incompleat_noad_field);
                }
                break;
        }
    }
}