1 T

E
X82 PART 1: INTRODUCTION 3
1. Introduction. This is T
E
X, a document compiler intended to produce typesetting of high quality.
The Pascal program that follows is the denition of T
E
X82, a standard version of T
E
X that is designed to
be highly portable so that identical output will be obtainable on a great variety of computers.
The main purpose of the following program is to explain the algorithms of T
E
X as clearly as possible. As
a result, the program will not necessarily be very ecient when a particular Pascal compiler has translated
it into a particular machine language. However, the program has been written so that it can be tuned to run
eciently in a wide variety of operating environments by making comparatively few changes. Such exibility
is possible because the documentation that follows is written in the WEB language, which is at a higher level
than Pascal; the preprocessing step that converts WEB to Pascal is able to introduce most of the necessary
renements. Semi-automatic translation to other languages is also feasible, because the program below does
not make extensive use of features that are peculiar to Pascal.
A large piece of software like T
E
X has inherent complexity that cannot be reduced below a certain level of
diculty, although each individual part is fairly simple by itself. The WEB language is intended to make the
algorithms as readable as possible, by reecting the way the individual program pieces t together and by
providing the cross-references that connect dierent parts. Detailed comments about what is going on, and
about why things were done in certain ways, have been liberally sprinkled throughout the program. These
comments explain features of the implementation, but they rarely attempt to explain the T
E
X language
itself, since the reader is supposed to be familiar with The T
E
Xbook.
2. The present implementation has a long ancestry, beginning in the summer of 1977, when Michael F.
Plass and Frank M. Liang designed and coded a prototype based on some specications that the author had
made in May of that year. This original protoT
E
X included macro denitions and elementary manipulations
on boxes and glue, but it did not have line-breaking, page-breaking, mathematical formulas, alignment
routines, error recovery, or the present semantic nest; furthermore, it used character lists instead of token
lists, so that a control sequence like \halign was represented by a list of seven characters. A complete version
of T
E
X was designed and coded by the author in late 1977 and early 1978; that program, like its prototype,
was written in the SAIL language, for which an excellent debugging system was available. Preliminary plans
to convert the SAIL code into a form somewhat like the present web were developed by Luis Trabb Pardo
and the author at the beginning of 1979, and a complete implementation was created by Ignacio A. Zabala
in 1979 and 1980. The T
E
X82 program, which was written by the author during the latter part of 1981
and the early part of 1982, also incorporates ideas from the 1979 implementation of T
E
X in MESA that
was written by Leonidas Guibas, Robert Sedgewick, and Douglas Wyatt at the Xerox Palo Alto Research
Center. Several hundred renements were introduced into T
E
X82 based on the experiences gained with the
original implementations, so that essentially every part of the system has been substantially improved. After
the appearance of Version 0 in September 1982, this program beneted greatly from the comments of
many other people, notably David R. Fuchs and Howard W. Trickey. A nal revision in September 1989
extended the input character set to eight-bit codes and introduced the ability to hyphenate words from
dierent languages, based on some ideas of Michael J. Ferguson.
No doubt there still is plenty of room for improvement, but the author is rmly committed to keeping
T
E
X82 frozen from now on; stability and reliability are to be its main virtues.
On the other hand, the WEB description can be extended without changing the core of T
E
X82 itself, and
the program has been designed so that such extensions are not extremely dicult to make. The banner
string dened here should be changed whenever T
E
X undergoes any modications, so that it will be clear
which version of T
E
X might be the guilty party when a problem arises.
If this program is changed, the resulting system should not be called T
E
X; the ocial name T
E
X by
itself is reserved for software systems that are fully compatible with each other. A special test suite called
the TRIP test is available for helping to determine whether a particular implementation deserves to be
known as T
E
X [cf. Stanford Computer Science report CS1027, November 1984].
dene banner ThisisTeX,Version3.1415926 printed when T
E
X starts
4 PART 1: INTRODUCTION T
E
X82 3
3. Dierent Pascals have slightly dierent conventions, and the present program expresses T
E
X in terms
of the Pascal that was available to the author in 1982. Constructions that apply to this particular compiler,
which we shall call Pascal-H, should help the reader see how to make an appropriate interface for other
systems if necessary. (Pascal-H is Charles Hedricks modication of a compiler for the DECsystem-10 that
was originally developed at the University of Hamburg; cf. SOFTWAREPractice & Experience 6 (1976),
2942. The T
E
X program below is intended to be adaptable, without extensive changes, to most other
versions of Pascal, so it does not fully use the admirable features of Pascal-H. Indeed, a conscious eort has
been made here to avoid using several idiosyncratic features of standard Pascal itself, so that most of the code
can be translated mechanically into other high-level languages. For example, the with and new features
are not used, nor are pointer types, set types, or enumerated scalar types; there are no var parameters,
except in the case of les; there are no tag elds on variant records; there are no assignments real integer ;
no procedures are declared local to other procedures.)
The portions of this program that involve system-dependent code, where changes might be necessary
because of dierences between Pascal compilers and/or dierences between operating systems, can be
identied by looking at the sections whose numbers are listed under system dependencies in the index.
Furthermore, the index entries for dirty Pascal list all places where the restrictions of Pascal have not been
followed perfectly, for one reason or another.
Incidentally, Pascals standard round function can be problematical, because it disagrees with the IEEE
oating-point standard. Many implementors have therefore chosen to substitute their own home-grown
rounding procedure.
4. The program begins with a normal Pascal program heading, whose components will be lled in later,
using the conventions of WEB. For example, the portion of the program called Global variables 13 below
will be replaced by a sequence of variable declarations that starts in 13 of this documentation. In this way,
we are able to dene each individual global variable when we are prepared to understand what it means; we
do not have to dene all of the globals at once. Cross references in 13, where it says See also sections 20,
26, . . . , also make it possible to look at the set of all global variables, if desired. Similar remarks apply to
the other portions of the program heading.
Actually the heading shown here is not quite normal: The program line does not mention any output
le, because Pascal-H would ask the T
E
X user to specify a le name if output were specied here.
dene mtype t@&y@&p@&e this is a WEB coding trick:
format mtype type mtype will be equivalent to type
format type true but type will not be treated as a reserved word
Compiler directives 9
program TEX; all le names are dened dynamically
label Labels in the outer block 6
const Constants in the outer block 11
mtype Types in the outer block 18
var Global variables 13
procedure initialize; this procedure gets things started properly
var Local variables for initialization 19
begin Initialize whatever T
E
X might access 8
end;
Basic printing procedures 57
Error handling procedures 78
5 T
E
X82 PART 1: INTRODUCTION 5
5. The overall T
E
X program begins with the heading just shown, after which comes a bunch of procedure
declarations and function declarations. Finally we will get to the main program, which begins with the
comment start here. If you want to skip down to the main program now, you can look up start here
in the index. But the author suggests that the best way to understand this program is to follow pretty
much the order of T
E
Xs components as they appear in the WEB description you are now reading, since the
present ordering is intended to combine the advantages of the bottom up and top down approaches to
the problem of understanding a somewhat complicated system.
6. Three labels must be declared in the main program, so we give them symbolic names.
dene start of TEX = 1 go here when T
E
Xs variables are initialized
dene end of TEX = 9998 go here to close les and terminate gracefully
dene nal end = 9999 this label marks the ending of the program
Labels in the outer block 6
start of TEX, end of TEX, nal end ; key control points
This code is used in section 4.
7. Some of the code below is intended to be used only when diagnosing the strange behavior that sometimes
occurs when T
E
X is being installed or when system wizards are fooling around with T
E
X without quite
knowing what they are doing. Such code will not normally be compiled; it is delimited by the codewords
debug . . . gubed, with apologies to people who wish to preserve the purity of English.
Similarly, there is some conditional code delimited by stat . . . tats that is intended for use when statistics
are to be kept about T
E
Xs memory usage. The stat . . . tats code also implements diagnostic information
for \tracingparagraphs and \tracingpages.
dene debug @{ change this to debug when debugging
dene gubed @} change this to gubed when debugging
format debug begin
format gubed end
dene stat @{ change this to stat when gathering usage statistics
dene tats @} change this to tats when gathering usage statistics
format stat begin
format tats end
8. This program has two important variations: (1) There is a long and slow version called INITEX, which
does the extra calculations needed to initialize T
E
Xs internal tables; and (2) there is a shorter and faster
production version, which cuts the initialization to a bare minimum. Parts of the program that are needed
in (1) but not in (2) are delimited by the codewords init . . . tini.
dene init change this to init @{ in the production version
dene tini change this to tini @} in the production version
format init begin
format tini end
Initialize whatever T
E
X might access 8
Set initial values of key variables 21
init Initialize table entries (done by INITEX only) 164 tini
This code is used in section 4.
6 PART 1: INTRODUCTION T
E
X82 9
9. If the rst character of a Pascal comment is a dollar sign, Pascal-H treats the comment as a list of
compiler directives that will aect the translation of this program into machine language. The directives
shown below specify full checking and inclusion of the Pascal debugger when T
E
X is being debugged, but
they cause range checking and other redundant code to be eliminated when the production system is being
generated. Arithmetic overow will be detected in all cases.
Compiler directives 9
@{@&$C, A+, D@} no range check, catch arithmetic overow, no debug overhead
debug @{@&$C+, D+@} gubed but turn everything on when debugging
This code is used in section 4.
10. This T
E
X implementation conforms to the rules of the Pascal User Manual published by Jensen and
Wirth in 1975, except where system-dependent code is necessary to make a useful system program, and
except in another respect where such conformity would unnecessarily obscure the meaning and clutter up
the code: We assume that case statements may include a default case that applies if no matching label is
found. Thus, we shall use constructions like
case x of
1: code for x = 1 ;
3: code for x = 3 ;
othercases code for x ,= 1 and x ,= 3
endcases
since most Pascal compilers have plugged this hole in the language by incorporating some sort of default
mechanism. For example, the Pascal-H compiler allows others : as a default label, and other Pascals
allow syntaxes like else or otherwise or otherwise:, etc. The denitions of othercases and endcases
should be changed to agree with local conventions. Note that no semicolon appears before endcases in this
program, so the denition of endcases should include a semicolon if the compiler wants one. (Of course,
if no default mechanism is available, the case statements of T
E
X will have to be laboriously extended by
listing all remaining cases. People who are stuck with such Pascals have, in fact, done this, successfully but
not happily!)
dene othercases others : default for cases not listed explicitly
dene endcases end follows the default case in an extended case statement
format othercases else
format endcases end
11 T
E
X82 PART 1: INTRODUCTION 7
11. The following parameters can be changed at compile time to extend or reduce T
E
Xs capacity. They
may have dierent values in INITEX and in production versions of T
E
X.
Constants in the outer block 11
mem max = 30000;
greatest index in T
E
Xs internal mem array; must be strictly less than max halfword ; must be
equal to mem top in INITEX, otherwise mem top
mem min = 0; smallest index in T
E
Xs internal mem array; must be min halfword or more; must be
equal to mem bot in INITEX, otherwise mem bot
buf size = 500; maximum number of characters simultaneously present in current lines of open les
and in control sequences between \csname and \endcsname; must not exceed max halfword
error line = 72; width of context lines on terminal error messages
half error line = 42; width of rst lines of contexts in terminal error messages; should be between 30
and error line 15
max print line = 79; width of longest text lines output; should be at least 60
stack size = 200; maximum number of simultaneous input sources
max in open = 6;
maximum number of input les and error insertions that can be going on simultaneously
font max = 75; maximum internal font number; must not exceed max quarterword and must be at
most font base + 256
font mem size = 20000; number of words of font info for all fonts
param size = 60; maximum number of simultaneous macro parameters
nest size = 40; maximum number of semantic levels simultaneously active
max strings = 3000; maximum number of strings; must not exceed max halfword
string vacancies = 8000; the minimum number of characters that should be available for the users
control sequences and font names, after T
E
Xs own error messages are stored
pool size = 32000; maximum number of characters in strings, including all error messages and help
texts, and the names of all fonts and control sequences; must exceed string vacancies by the total
length of T
E
Xs own strings, which is currently about 23000
save size = 600; space for saving values outside of current group; must be at most max halfword
trie size = 8000; space for hyphenation patterns; should be larger for INITEX than it is in production
versions of T
E
X
trie op size = 500; space for opcodes in the hyphenation patterns
dvi buf size = 800; size of the output buer; must be a multiple of 8
le name size = 40; le names shouldnt be longer than this
pool name = TeXformats:TEX.POOL;
string of length le name size; tells where the string pool appears
This code is used in section 4.
8 PART 1: INTRODUCTION T
E
X82 12
12. Like the preceding parameters, the following quantities can be changed at compile time to extend or
reduce T
E
Xs capacity. But if they are changed, it is necessary to rerun the initialization program INITEX
to generate new tables for the production T
E
X program. One cant simply make helter-skelter changes to
the following constants, since certain rather complex initialization numbers are computed from them. They
are dened here using WEB macros, instead of being put into Pascals const list, in order to emphasize this
distinction.
dene mem bot = 0
smallest index in the mem array dumped by INITEX; must not be less than mem min
dene mem top 30000 largest index in the mem array dumped by INITEX; must be substantially
larger than mem bot and not greater than mem max
dene font base = 0 smallest internal font number; must not be less than min quarterword
dene hash size = 2100 maximum number of control sequences; it should be at most about
(mem max mem min)/10
dene hash prime = 1777 a prime number equal to about 85% of hash size
dene hyph size = 307 another prime; the number of \hyphenation exceptions
13. In case somebody has inadvertently made bad settings of the constants, T
E
X checks them using a
global variable called bad .
This is the rst of many sections of T
E
X where global variables are dened.
Global variables 13
bad : integer ; is some constant wrong?
See also sections 20, 26, 30, 32, 39, 50, 54, 73, 76, 79, 96, 104, 115, 116, 117, 118, 124, 165, 173, 181, 213, 246, 253, 256, 271,
286, 297, 301, 304, 305, 308, 309, 310, 333, 361, 382, 387, 388, 410, 438, 447, 480, 489, 493, 512, 513, 520, 527, 532, 539,
549, 550, 555, 592, 595, 605, 616, 646, 647, 661, 684, 719, 724, 764, 770, 814, 821, 823, 825, 828, 833, 839, 847, 872, 892,
900, 905, 907, 921, 926, 943, 947, 950, 971, 980, 982, 989, 1032, 1074, 1266, 1281, 1299, 1305, 1331, 1342, and 1345.
This code is used in section 4.
14. Later on we will say if mem max max halfword then bad 14, or something similar. (We cant
do that until max halfword has been dened.)
Check the constant values for consistency 14
bad 0;
if (half error line < 30) (half error line > error line 15) then bad 1;
if max print line < 60 then bad 2;
if dvi buf size mod 8 ,= 0 then bad 3;
if mem bot + 1100 > mem top then bad 4;
if hash prime > hash size then bad 5;
if max in open 128 then bad 6;
if mem top < 256 + 11 then bad 7; we will want null list > 255
See also sections 111, 290, 522, and 1249.
This code is used in section 1332.
15 T
E
X82 PART 1: INTRODUCTION 9
15. Labels are given symbolic names by the following denitions, so that occasional goto statements
will be meaningful. We insert the label exit just before the end of a procedure in which we have used
the return statement dened below; the label restart is occasionally used at the very beginning of a
procedure; and the label reswitch is occasionally used just prior to a case statement in which some cases
change the conditions and we wish to branch to the newly applicable case. Loops that are set up with the
loop construction dened below are commonly exited by going to done or to found or to not found , and
they are sometimes repeated by going to continue. If two or more parts of a subroutine start dierently
but end up the same, the shared code may be gathered together at common ending .
Incidentally, this program never declares a label that isnt actually used, because some fussy Pascal
compilers will complain about redundant labels.
dene exit = 10 go here to leave a procedure
dene restart = 20 go here to start a procedure again
dene reswitch = 21 go here to start a case statement again
dene continue = 22 go here to resume a loop
dene done = 30 go here to exit a loop
dene done1 = 31 like done, when there is more than one loop
dene done2 = 32 for exiting the second loop in a long block
dene done3 = 33 for exiting the third loop in a very long block
dene done4 = 34 for exiting the fourth loop in an extremely long block
dene done5 = 35 for exiting the fth loop in an immense block
dene done6 = 36 for exiting the sixth loop in a block
dene found = 40 go here when youve found it
dene found1 = 41 like found , when theres more than one per routine
dene found2 = 42 like found , when theres more than two per routine
dene not found = 45 go here when youve found nothing
dene common ending = 50 go here when you want to merge with another branch
16. Here are some macros for common programming idioms.
dene incr (#) # # + 1 increase a variable by unity
dene decr (#) # # 1 decrease a variable by unity
dene negate(#) # # change the sign of a variable
dene loop while true do repeat over and over until a goto happens
format loop xclause WEBs xclause acts like while true do
dene do nothing empty statement
dene return goto exit terminate a procedure call
format return nil
dene empty = 0 symbolic name for a null constant
10 PART 2: THE CHARACTER SET T
E
X82 17
17. The character set. In order to make T
E
X readily portable to a wide variety of computers, all of its
input text is converted to an internal eight-bit code that includes standard ASCII, the American Standard
Code for Information Interchange. This conversion is done immediately when each character is read in.
Conversely, characters are converted from ASCII to the users external representation just before they are
output to a text le.
Such an internal code is relevant to users of T
E
X primarily because it governs the positions of characters
in the fonts. For example, the character A has ASCII code 65 = 101 , and when T
E
X typesets this letter
it species character number 65 in the current font. If that font actually has A in a dierent position,
T
E
X doesnt know what the real position is; the program that does the actual printing from T
E
Xs device-
independent les is responsible for converting from ASCII to a particular font encoding.
T
E
Xs internal code also denes the value of constants that begin with a reverse apostrophe; and it provides
an index to the \catcode, \mathcode, \uccode, \lccode, and \delcode tables.
18. Characters of text that have been converted to T
E
Xs internal form are said to be of type ASCII code,
which is a subrange of the integers.
Types in the outer block 18
ASCII code = 0 . . 255; eight-bit numbers
See also sections 25, 38, 101, 109, 113, 150, 212, 269, 300, 548, 594, 920, and 925.
This code is used in section 4.
19. The original Pascal compiler was designed in the late 60s, when six-bit character sets were common, so
it did not make provision for lowercase letters. Nowadays, of course, we need to deal with both capital and
small letters in a convenient way, especially in a program for typesetting; so the present specication of T
E
X
has been written under the assumption that the Pascal compiler and run-time system permit the use of text
les with more than 64 distinguishable characters. More precisely, we assume that the character set contains
at least the letters and symbols associated with ASCII codes 40 through 176 ; all of these characters are
now available on most computer terminals.
Since we are dealing with more characters than were present in the rst Pascal compilers, we have to
decide what to call the associated data type. Some Pascals use the original name char for the characters in
text les, even though there now are more than 64 such characters, while other Pascals consider char to be
a 64-element subrange of a larger data type that has some other name.
In order to accommodate this dierence, we shall use the name text char to stand for the data type of
the characters that are converted to and from ASCII code when they are input and output. We shall also
assume that text char consists of the elements chr (rst text char ) through chr (last text char ), inclusive.
The following denitions should be adjusted if necessary.
dene text char char the data type of characters in text les
dene rst text char = 0 ordinal number of the smallest element of text char
dene last text char = 255 ordinal number of the largest element of text char
Local variables for initialization 19
i: integer ;
See also sections 163 and 927.
This code is used in section 4.
20. The T
E
X processor converts between ASCII code and the users external character set by means of
arrays xord and xchr that are analogous to Pascals ord and chr functions.
Global variables 13 +
xord : array [text char ] of ASCII code; species conversion of input characters
xchr : array [ASCII code] of text char ; species conversion of output characters
21 T
E
X82 PART 2: THE CHARACTER SET 11
21. Since we are assuming that our Pascal system is able to read and write the visible characters of
standard ASCII (although not necessarily using the ASCII codes to represent them), the following assignment
statements initialize the standard part of the xchr array properly, without needing any system-dependent
changes. On the other hand, it is possible to implement T
E
X with less complete character sets, and in such
cases it will be necessary to change something here.
Set initial values of key variables 21
xchr [40 ] ; xchr [41 ] !; xchr [42 ] "; xchr [43 ] #; xchr [44 ] $;
xchr [45 ] %; xchr [46 ] &; xchr [47 ] ;
xchr [50 ] (; xchr [51 ] ); xchr [52 ] *; xchr [53 ] +; xchr [54 ] ,;
xchr [55 ] ; xchr [56 ] .; xchr [57 ] /;
xchr [60 ] 0; xchr [61 ] 1; xchr [62 ] 2; xchr [63 ] 3; xchr [64 ] 4;
xchr [65 ] 5; xchr [66 ] 6; xchr [67 ] 7;
xchr [70 ] 8; xchr [71 ] 9; xchr [72 ] :; xchr [73 ] ;; xchr [74 ] <;
xchr [75 ] =; xchr [76 ] >; xchr [77 ] ?;
xchr [100 ] @; xchr [101 ] A; xchr [102 ] B; xchr [103 ] C; xchr [104 ] D;
xchr [105 ] E; xchr [106 ] F; xchr [107 ] G;
xchr [110 ] H; xchr [111 ] I; xchr [112 ] J; xchr [113 ] K; xchr [114 ] L;
xchr [115 ] M; xchr [116 ] N; xchr [117 ] O;
xchr [120 ] P; xchr [121 ] Q; xchr [122 ] R; xchr [123 ] S; xchr [124 ] T;
xchr [125 ] U; xchr [126 ] V; xchr [127 ] W;
xchr [130 ] X; xchr [131 ] Y; xchr [132 ] Z; xchr [133 ] [; xchr [134 ] \;
xchr [135 ] ]; xchr [136 ] ^; xchr [137 ] _;
xchr [140 ] `; xchr [141 ] a; xchr [142 ] b; xchr [143 ] c; xchr [144 ] d;
xchr [145 ] e; xchr [146 ] f; xchr [147 ] g;
xchr [150 ] h; xchr [151 ] i; xchr [152 ] j; xchr [153 ] k; xchr [154 ] l;
xchr [155 ] m; xchr [156 ] n; xchr [157 ] o;
xchr [160 ] p; xchr [161 ] q; xchr [162 ] r; xchr [163 ] s; xchr [164 ] t;
xchr [165 ] u; xchr [166 ] v; xchr [167 ] w;
xchr [170 ] x; xchr [171 ] y; xchr [172 ] z; xchr [173 ] {; xchr [174 ] |;
xchr [175 ] }; xchr [176 ] ~;
See also sections 23, 24, 74, 77, 80, 97, 166, 215, 254, 257, 272, 287, 383, 439, 481, 490, 521, 551, 556, 593, 596, 606, 648, 662,
685, 771, 928, 990, 1033, 1267, 1282, 1300, and 1343.
This code is used in section 8.
22. Some of the ASCII codes without visible characters have been given symbolic names in this program
because they are used with a special meaning.
dene null code = 0 ASCII code that might disappear
dene carriage return = 15 ASCII code used at end of line
dene invalid code = 177 ASCII code that many systems prohibit in text les
12 PART 2: THE CHARACTER SET T
E
X82 23
23. The ASCII code is standard only to a certain extent, since many computer installations have found it
advantageous to have ready access to more than 94 printing characters. Appendix C of The T
E
Xbook gives a
complete specication of the intended correspondence between characters and T
E
Xs internal representation.
If T
E
X is being used on a garden-variety Pascal for which only standard ASCII codes will appear in the
input and output les, it doesnt really matter what codes are specied in xchr [0 . . 37 ], but the safest
policy is to blank everything out by using the code shown below.
However, other settings of xchr will make T
E
X more friendly on computers that have an extended character
set, so that users can type things like instead of \ne. People with extended character sets can assign
codes arbitrarily, giving an xchr equivalent to whatever characters the users of T
E
X are allowed to have
in their input les. It is best to make the codes correspond to the intended interpretations as shown in
Appendix C whenever possible; but this is not necessary. For example, in countries with an alphabet of
more than 26 letters, it is usually best to map the additional letters into codes less than 40 . To get the
most permissive character set, change on the right of these assignment statements to chr (i).
Set initial values of key variables 21 +
for i 0 to 37 do xchr [i] ;
for i 177 to 377 do xchr [i] ;
24. The following system-independent code makes the xord array contain a suitable inverse to the infor-
mation in xchr . Note that if xchr [i] = xchr [j] where i < j < 177 , the value of xord [xchr [i]] will turn out
to be j or more; hence, standard ASCII code numbers will be used instead of codes below 40 in case there
is a coincidence.
Set initial values of key variables 21 +
for i rst text char to last text char do xord [chr (i)] invalid code;
for i 200 to 377 do xord [xchr [i]] i;
for i 0 to 176 do xord [xchr [i]] i;
25 T
E
X82 PART 3: INPUT AND OUTPUT 13
25. Input and output. The bane of portability is the fact that dierent operating systems treat input
and output quite dierently, perhaps because computer scientists have not given sucient attention to this
problem. People have felt somehow that input and output are not part of real programming. Well, it is
true that some kinds of programming are more fun than others. With existing input/output conventions
being so diverse and so messy, the only sources of joy in such parts of the code are the rare occasions when
one can nd a way to make the program a little less bad than it might have been. We have two choices,
either to attack I/O now and get it over with, or to postpone I/O until near the end. Neither prospect is
very attractive, so lets get it over with.
The basic operations we need to do are (1) inputting and outputting of text, to or from a le or the users
terminal; (2) inputting and outputting of eight-bit bytes, to or from a le; (3) instructing the operating system
to initiate (open) or to terminate (close) input or output from a specied le; (4) testing whether the
end of an input le has been reached.
T
E
X needs to deal with two kinds of les. We shall use the term alpha le for a le that contains textual
data, and the term byte le for a le that contains eight-bit binary information. These two types turn out
to be the same on many computers, but sometimes there is a signicant distinction, so we shall be careful
to distinguish between them. Standard protocols for transferring such les from computer to computer, via
high-speed networks, are now becoming available to more and more communities of users.
The program actually makes use also of a third kind of le, called a word le, when dumping and reloading
base information for its own initialization. We shall dene a word le later; but it will be possible for us to
specify simple operations on word les before they are dened.
Types in the outer block 18 +
eight bits = 0 . . 255; unsigned one-byte quantity
alpha le = packed le of text char ; les that contain textual data
byte le = packed le of eight bits ; les that contain binary data
26. Most of what we need to do with respect to input and output can be handled by the I/O facilities
that are standard in Pascal, i.e., the routines called get , put , eof , and so on. But standard Pascal does not
allow le variables to be associated with le names that are determined at run time, so it cannot be used
to implement T
E
X; some sort of extension to Pascals ordinary reset and rewrite is crucial for our purposes.
We shall assume that name of le is a variable of an appropriate type such that the Pascal run-time system
being used to implement T
E
X can open a le whose external name is specied by name of le.
Global variables 13 +
name of le: packed array [1 . . le name size] of char ;
on some systems this may be a record variable
name length: 0 . . le name size;
this many characters are actually relevant in name of le (the rest are blank)
14 PART 3: INPUT AND OUTPUT T
E
X82 27
27. The Pascal-H compiler with which the present version of T
E
X was prepared has extended the rules of
Pascal in a very convenient way. To open le f, we can write
reset (f, name, /O) for input;
rewrite(f, name, /O) for output.
The name parameter, which is of type packed array [any] of char , stands for the name of the external
le that is being opened for input or output. Blank spaces that might appear in name are ignored.
The /O parameter tells the operating system not to issue its own error messages if something goes wrong.
If a le of the specied name cannot be found, or if such a le cannot be opened for some other reason (e.g.,
someone may already be trying to write the same le), we will have erstat (f) ,= 0 after an unsuccessful reset
or rewrite. This allows T
E
X to undertake appropriate corrective action.
T
E
Xs le-opening procedures return false if no le identied by name of le could be opened.
dene reset OK(#) erstat (#) = 0
dene rewrite OK(#) erstat (#) = 0
function a open in(var f : alpha le): boolean; open a text le for input
begin reset (f, name of le, /O); a open in reset OK(f);
end;
function a open out (var f : alpha le): boolean; open a text le for output
begin rewrite(f, name of le, /O); a open out rewrite OK(f);
end;
function b open in(var f : byte le): boolean; open a binary le for input
begin reset (f, name of le, /O); b open in reset OK(f);
end;
function b open out (var f : byte le): boolean; open a binary le for output
begin rewrite(f, name of le, /O); b open out rewrite OK(f);
end;
function w open in(var f : word le): boolean; open a word le for input
begin reset (f, name of le, /O); w open in reset OK(f);
end;
function w open out (var f : word le): boolean; open a word le for output
begin rewrite(f, name of le, /O); w open out rewrite OK(f);
end;
28. Files can be closed with the Pascal-H routine close(f), which should be used when all input or output
with respect to f has been completed. This makes f available to be opened again, if desired; and if f was
used for output, the close operation makes the corresponding external le appear on the users area, ready
to be read.
These procedures should not generate error messages if a le is being closed before it has been successfully
opened.
procedure a close(var f : alpha le); close a text le
begin close(f);
end;
procedure b close(var f : byte le); close a binary le
begin close(f);
end;
procedure w close(var f : word le); close a word le
begin close(f);
end;
29 T
E
X82 PART 3: INPUT AND OUTPUT 15
29. Binary input and output are done with Pascals ordinary get and put procedures, so we dont have to
make any other special arrangements for binary I/O. Text output is also easy to do with standard Pascal
routines. The treatment of text input is more dicult, however, because of the necessary translation to
ASCII code values. T
E
Xs conventions should be ecient, and they should blend nicely with the users
operating environment.
30. Input from text les is read one line at a time, using a routine called input ln. This function is dened
in terms of global variables called buer , rst , and last that will be described in detail later; for now, it
suces for us to know that buer is an array of ASCII code values, and that rst and last are indices into
this array representing the beginning and ending of a line of text.
Global variables 13 +
buer : array [0 . . buf size] of ASCII code; lines of characters being read
rst : 0 . . buf size; the rst unused position in buer
last : 0 . . buf size; end of the line just input to buer
max buf stack : 0 . . buf size; largest index used in buer
16 PART 3: INPUT AND OUTPUT T
E
X82 31
31. The input ln function brings the next line of input from the specied le into available positions of
the buer array and returns the value true, unless the le has already been entirely read, in which case it
returns false and sets last rst . In general, the ASCII code numbers that represent the next line of the
le are input into buer [rst ], buer [rst +1], . . . , buer [last 1]; and the global variable last is set equal
to rst plus the length of the line. Trailing blanks are removed from the line; thus, either last = rst (in
which case the line was entirely blank) or buer [last 1] ,= "".
An overow error is given, however, if the normal actions of input ln would make last buf size; this is
done so that other parts of T
E
X can safely look at the contents of buer [last + 1] without overstepping the
bounds of the buer array. Upon entry to input ln, the condition rst < buf size will always hold, so that
there is always room for an empty line.
The variable max buf stack , which is used to keep track of how large the buf size parameter must be to
accommodate the present job, is also kept up to date by input ln.
If the bypass eoln parameter is true, input ln will do a get before looking at the rst character of the line;
this skips over an eoln that was in f. The procedure does not do a get when it reaches the end of the line;
therefore it can be used to acquire input from the users terminal as well as from ordinary text les.
Standard Pascal says that a le should have eoln immediately before eof , but T
E
X needs only a weaker
restriction: If eof occurs in the middle of a line, the system function eoln should return a true result (even
though f will be undened).
Since the inner loop of input ln is part of T
E
Xs inner loopeach character of input comes in at this
placeit is wise to reduce system overhead by making use of special routines that read in an entire array of
characters at once, if such routines are available. The following code uses standard Pascal to illustrate what
needs to be done, but ner tuning is often possible at well-developed Pascal sites.
function input ln(var f : alpha le; bypass eoln : boolean): boolean;
inputs the next line or returns false
var last nonblank : 0 . . buf size; last with trailing blanks removed
begin if bypass eoln then
if eof (f) then get (f); input the rst character of the line into f
last rst ; cf. Matthew 19 : 30
if eof (f) then input ln false
else begin last nonblank rst ;
while eoln(f) do
begin if last max buf stack then
begin max buf stack last + 1;
if max buf stack = buf size then Report overow of the input buer, and abort 35 ;
end;
buer [last ] xord [f]; get (f); incr (last );
if buer [last 1] ,= "" then last nonblank last ;
end;
last last nonblank ; input ln true;
end;
end;
32. The users terminal acts essentially like other les of text, except that it is used both for input and
for output. When the terminal is considered an input le, the le variable is called term in, and when it is
considered an output le the le variable is term out .
Global variables 13 +
term in: alpha le; the terminal as an input le
term out : alpha le; the terminal as an output le
33 T
E
X82 PART 3: INPUT AND OUTPUT 17
33. Here is how to open the terminal les in Pascal-H. The /I switch suppresses the rst get .
dene t open in reset (term in, TTY:, /O/I) open the terminal for text input
dene t open out rewrite(term out , TTY:, /O) open the terminal for text output
34. Sometimes it is necessary to synchronize the input/output mixture that happens on the users terminal,
and three system-dependent procedures are used for this purpose. The rst of these, update terminal , is
called when we want to make sure that everything we have output to the terminal so far has actually left the
computers internal buers and been sent. The second, clear terminal , is called when we wish to cancel any
input that the user may have typed ahead (since we are about to issue an unexpected error message). The
third, wake up terminal , is supposed to revive the terminal if the user has disabled it by some instruction
to the operating system. The following macros show how these operations can be specied in Pascal-H:
dene update terminal break (term out ) empty the terminal output buer
dene clear terminal break in(term in, true) clear the terminal input buer
dene wake up terminal do nothing cancel the users cancellation of output
35. We need a special routine to read the rst line of T
E
X input from the users terminal. This line is
dierent because it is read before we have opened the transcript le; there is sort of a chicken and egg
problem here. If the user types \input paper on the rst line, or if some macro invoked by that line does
such an \input, the transcript le will be named paper.log; but if no \input commands are performed
during the rst line of terminal input, the transcript le will acquire its default name texput.log. (The
transcript le will not contain error messages generated by the rst line before the rst \input command.)
The rst line is even more special if we are lucky enough to have an operating system that treats T
E
X
dierently from a run-of-the-mill Pascal object program. Its nice to let the user start running a T
E
X job by
typing a command line like tex paper; in such a case, T
E
X will operate as if the rst line of input were
paper, i.e., the rst line will consist of the remainder of the command line, after the part that invoked T
E
X.
The rst line is special also because it may be read before T
E
X has input a format le. In such cases,
normal error messages cannot yet be given. The following code uses concepts that will be explained later.
(If the Pascal compiler does not support non-local goto, the statement goto nal end should be replaced
by something that quietly terminates the program.)
Report overow of the input buer, and abort 35
if format ident = 0 then
begin write ln(term out , Buffersizeexceeded!); goto nal end ;
end
else begin cur input .loc eld rst ; cur input .limit eld last 1;
overow("buffersize", buf size);
end
This code is used in section 31.
18 PART 3: INPUT AND OUTPUT T
E
X82 36
36. Dierent systems have dierent ways to get started. But regardless of what conventions are adopted,
the routine that initializes the terminal should satisfy the following specications:
1) It should open le term in for input from the terminal. (The le term out will already be open for
output to the terminal.)
2) If the user has given a command line, this line should be considered the rst line of terminal input.
Otherwise the user should be prompted with **, and the rst line of input should be whatever is
typed in response.
3) The rst line of input, which might or might not be a command line, should appear in locations rst
to last 1 of the buer array.
4) The global variable loc should be set so that the character to be read next by T
E
X is in buer [loc].
This character should not be blank, and we should have loc < last .
(It may be necessary to prompt the user several times before a non-blank line comes in. The prompt is **
instead of the later * because the meaning is slightly dierent: \input need not be typed immediately
after **.)
dene loc cur input .loc eld location of rst unread character in buer
37. The following program does the required initialization without retrieving a possible command line. It
should be clear how to modify this routine to deal with command lines, if the system permits them.
function init terminal : boolean; gets the terminal input started
label exit ;
begin t open in;
loop begin wake up terminal ; write(term out , **); update terminal ;
if input ln(term in, true) then this shouldnt happen
begin write ln(term out ); write(term out , !Endoffileontheterminal...why?);
init terminal false; return;
end;
loc rst ;
while (loc < last ) (buer [loc] = "") do incr (loc);
if loc < last then
begin init terminal true; return; return unless the line was all blank
end;
write ln(term out , Pleasetypethenameofyourinputfile.);
end;
exit : end;
38 T
E
X82 PART 4: STRING HANDLING 19
38. String handling. Control sequence names and diagnostic messages are variable-length strings of
eight-bit characters. Since Pascal does not have a well-developed string mechanism, T
E
X does all of its string
processing by homegrown methods.
Elaborate facilities for dynamic strings are not needed, so all of the necessary operations can be handled
with a simple data structure. The array str pool contains all of the (eight-bit) ASCII codes in all of the strings,
and the array str start contains indices of the starting points of each string. Strings are referred to by integer
numbers, so that string number s comprises the characters str pool [j] for str start [s] j < str start [s + 1].
Additional integer variables pool ptr and str ptr indicate the number of entries used so far in str pool and
str start , respectively; locations str pool [pool ptr ] and str start [str ptr ] are ready for the next string to be
allocated.
String numbers 0 to 255 are reserved for strings that correspond to single ASCII characters. This is in
accordance with the conventions of WEB, which converts single-character strings into the ASCII code number
of the single character involved, while it converts other strings into integers and builds a string pool le.
Thus, when the string constant "." appears in the program below, WEB converts it into the integer 46,
which is the ASCII code for a period, while WEB will convert a string like "hello" into some integer greater
than 255. String number 46 will presumably be the single character .; but some ASCII codes have no
standard visible representation, and T
E
X sometimes needs to be able to print an arbitrary ASCII character,
so the rst 256 strings are used to specify exactly what should be printed for each of the 256 possibilities.
Elements of the str pool array must be ASCII codes that can actually be printed; i.e., they must have an
xchr equivalent in the local character set. (This restriction applies only to preloaded strings, not to those
generated dynamically by the user.)
Some Pascal compilers wont pack integers into a single byte unless the integers lie in the range 128 . . 127.
To accommodate such systems we access the string pool only via macros that can easily be redened.
dene si (#) # convert from ASCII code to packed ASCII code
dene so(#) # convert from packed ASCII code to ASCII code
Types in the outer block 18 +
pool pointer = 0 . . pool size; for variables that point into str pool
str number = 0 . . max strings ; for variables that point into str start
packed ASCII code = 0 . . 255; elements of str pool array
39. Global variables 13 +
str pool : packed array [pool pointer ] of packed ASCII code; the characters
str start : array [str number ] of pool pointer ; the starting pointers
pool ptr : pool pointer ; rst unused position in str pool
str ptr : str number ; number of the current string being created
init pool ptr : pool pointer ; the starting value of pool ptr
init str ptr : str number ; the starting value of str ptr
40. Several of the elementary string operations are performed using WEB macros instead of Pascal pro-
cedures, because many of the operations are done quite frequently and we want to avoid the overhead of
procedure calls. For example, here is a simple macro that computes the length of a string.
dene length(#) (str start [# + 1] str start [#]) the number of characters in string number #
41. The length of the current string is called cur length:
dene cur length (pool ptr str start [str ptr ])
20 PART 4: STRING HANDLING T
E
X82 42
42. Strings are created by appending character codes to str pool . The append char macro, dened here,
does not check to see if the value of pool ptr has gotten too high; this test is supposed to be made before
append char is used. There is also a ush char macro, which erases the last character appended.
To test if there is room to append l more characters to str pool , we shall write str room(l), which aborts
T
E
X and gives an apologetic error message if there isnt enough room.
dene append char (#) put ASCII code # at the end of str pool
begin str pool [pool ptr ] si (#); incr (pool ptr );
end
dene ush char decr (pool ptr ) forget the last character in the pool
dene str room(#) make sure that the pool hasnt overowed
begin if pool ptr + # > pool size then overow("poolsize", pool size init pool ptr );
end
43. Once a sequence of characters has been appended to str pool , it ocially becomes a string when the
function make string is called. This function returns the identication number of the new string as its value.
function make string : str number ; current string enters the pool
begin if str ptr = max strings then overow("numberofstrings", max strings init str ptr );
incr (str ptr ); str start [str ptr ] pool ptr ; make string str ptr 1;
end;
44. To destroy the most recently made string, we say ush string .
dene ush string
begin decr (str ptr ); pool ptr str start [str ptr ];
end
45. The following subroutine compares string s with another string of the same length that appears in
buer starting at position k; the result is true if and only if the strings are equal. Empirical tests indicate
that str eq buf is used in such a way that it tends to return true about 80 percent of the time.
function str eq buf (s : str number ; k : integer ): boolean; test equality of strings
label not found ; loop exit
var j: pool pointer ; running index
result : boolean; result of comparison
begin j str start [s];
while j < str start [s + 1] do
begin if so(str pool [j]) ,= buer [k] then
begin result false; goto not found ;
end;
incr (j); incr (k);
end;
result true;
not found : str eq buf result ;
end;
46 T
E
X82 PART 4: STRING HANDLING 21
46. Here is a similar routine, but it compares two strings in the string pool, and it does not assume that
they have the same length.
function str eq str (s, t : str number ): boolean; test equality of strings
label not found ; loop exit
var j, k: pool pointer ; running indices
result : boolean; result of comparison
begin result false;
if length(s) ,= length(t) then goto not found ;
j str start [s]; k str start [t];
while j < str start [s + 1] do
begin if str pool [j] ,= str pool [k] then goto not found ;
incr (j); incr (k);
end;
result true;
not found : str eq str result ;
end;
47. The initial values of str pool , str start , pool ptr , and str ptr are computed by the INITEX program,
based in part on the information that WEB has output while processing T
E
X.
init function get strings started : boolean;
initializes the string pool, but returns false if something goes wrong
label done, exit ;
var k, l: 0 . . 255; small indices or counters
m, n: text char ; characters input from pool le
g: str number ; garbage
a: integer ; accumulator for check sum
c: boolean; check sum has been checked
begin pool ptr 0; str ptr 0; str start [0] 0; Make the rst 256 strings 48 ;
Read the other strings from the TEX.POOL le and return true, or give an error message and return
false 51 ;
exit : end;
tini
48. dene app lc hex (#) l #;
if l < 10 then append char (l + "0") else append char (l 10 + "a")
Make the rst 256 strings 48
for k 0 to 255 do
begin if ( Character k cannot be printed 49 ) then
begin append char ("^"); append char ("^");
if k < 100 then append char (k + 100 )
else if k < 200 then append char (k 100 )
else begin app lc hex (k div 16); app lc hex (k mod 16);
end;
end
else append char (k);
g make string ;
end
This code is used in section 47.
22 PART 4: STRING HANDLING T
E
X82 49
49. The rst 128 strings will contain 95 standard ASCII characters, and the other 33 characters will be
printed in three-symbol form like ^^A unless a system-dependent change is made here. Installations that
have an extended character set, where for example xchr [32 ] = , would like string 32 to be the single
character 32 instead of the three characters 136 , 136 , 132 (^^Z). On the other hand, even people with
an extended character set will want to represent string 15 by ^^M, since 15 is carriage return; the idea is
to produce visible strings instead of tabs or line-feeds or carriage-returns or bell-rings or characters that are
treated anomalously in text les.
Unprintable characters of codes 128255 are, similarly, rendered ^^80^^ff.
The boolean expression dened here should be true unless T
E
X internal code number k corresponds to a
non-troublesome visible symbol in the local character set. An appropriate formula for the extended character
set recommended in The T
E
Xbook would, for example, be k [0, 10 . . 12 , 14 , 15 , 33 , 177 . . 377 ].
If character k cannot be printed, and k < 200 , then character k + 100 or k 100 must be printable;
moreover, ASCII codes [41 . . 46 , 60 . . 71 , 136 , 141 . . 146 , 160 . . 171 ] must be printable. Thus, at
least 81 printable characters are needed.
Character k cannot be printed 49
(k < "") (k > "~")
This code is used in section 48.
50. When the WEB system program called TANGLE processes the TEX.WEB description that you are now
reading, it outputs the Pascal program TEX.PAS and also a string pool le called TEX.POOL. The INITEX
program reads the latter le, where each string appears as a two-digit decimal length followed by the string
itself, and the information is recorded in T
E
Xs string memory.
Global variables 13 +
init pool le: alpha le; the string-pool le output by TANGLE
tini
51. dene bad pool (#)
begin wake up terminal ; write ln(term out , #); a close(pool le); get strings started false;
return;
end
Read the other strings from the TEX.POOL le and return true, or give an error message and return
false 51
name of le pool name; we neednt set name length
if a open in(pool le) then
begin c false;
repeat Read one string, but return false if the string memory space is getting too tight for
comfort 52 ;
until c;
a close(pool le); get strings started true;
end
else bad pool (!IcantreadTEX.POOL.)
This code is used in section 47.
52 T
E
X82 PART 4: STRING HANDLING 23
52. Read one string, but return false if the string memory space is getting too tight for comfort 52
begin if eof (pool le) then bad pool (!TEX.POOLhasnochecksum.);
read (pool le, m, n); read two digits of string length
if m = * then Check the pool check sum 53
else begin if (xord [m] < "0") (xord [m] > "9") (xord [n] < "0") (xord [n] > "9") then
bad pool (!TEX.POOLlinedoesntbeginwithtwodigits.);
l xord [m] 10 + xord [n] "0" 11; compute the length
if pool ptr +l +string vacancies > pool size then bad pool (!YouhavetoincreasePOOLSIZE.);
for k 1 to l do
begin if eoln(pool le) then m else read (pool le, m);
append char (xord [m]);
end;
read ln(pool le); g make string ;
end;
end
This code is used in section 51.
53. The WEB operation @$ denotes the value that should be at the end of this TEX.POOL le; any other
value means that the wrong pool le has been loaded.
Check the pool check sum 53
begin a 0; k 1;
loop begin if (xord [n] < "0") (xord [n] > "9") then
bad pool (!TEX.POOLchecksumdoesnthaveninedigits.);
a 10 a + xord [n] "0";
if k = 9 then goto done;
incr (k); read (pool le, n);
end;
done: if a ,= @$ then bad pool (!TEX.POOLdoesntmatch;TANGLEmeagain.);
c true;
end
This code is used in section 52.
24 PART 5: ON-LINE AND OFF-LINE PRINTING T
E
X82 54
54. On-line and o-line printing. Messages that are sent to a users terminal and to the transcript-
log le are produced by several print procedures. These procedures will direct their output to a variety of
places, based on the setting of the global variable selector , which has the following possible values:
term and log , the normal setting, prints on the terminal and on the transcript le.
log only, prints only on the transcript le.
term only, prints only on the terminal.
no print , doesnt print at all. This is used only in rare cases before the transcript le is open.
pseudo, puts output into a cyclic buer that is used by the show context routine; when we get to that routine
we shall discuss the reasoning behind this curious mode.
new string , appends the output to the current string in the string pool.
0 to 15, prints on one of the sixteen les for \write output.
The symbolic names term and log , etc., have been assigned numeric codes that satisfy the convenient
relations no print + 1 = term only, no print + 2 = log only, term only + 2 = log only + 1 = term and log .
Three additional global variables, tally and term oset and le oset , record the number of characters
that have been printed since they were most recently cleared to zero. We use tally to record the length of
(possibly very long) stretches of printing; term oset and le oset , on the other hand, keep track of how
many characters have appeared so far on the current line that has been output to the terminal or to the
transcript le, respectively.
dene no print = 16 selector setting that makes data disappear
dene term only = 17 printing is destined for the terminal only
dene log only = 18 printing is destined for the transcript le only
dene term and log = 19 normal selector setting
dene pseudo = 20 special selector setting for show context
dene new string = 21 printing is deected to the string pool
dene max selector = 21 highest selector setting
Global variables 13 +
log le: alpha le; transcript of T
E
X session
selector : 0 . . max selector ; where to print a message
dig : array [0 . . 22] of 0 . . 15; digits in a number being output
tally: integer ; the number of characters recently printed
term oset : 0 . . max print line; the number of characters on the current terminal line
le oset : 0 . . max print line; the number of characters on the current le line
trick buf : array [0 . . error line] of ASCII code; circular buer for pseudoprinting
trick count : integer ; threshold for pseudoprinting, explained later
rst count : integer ; another variable for pseudoprinting
55. Initialize the output routines 55
selector term only; tally 0; term oset 0; le oset 0;
See also sections 61, 528, and 533.
This code is used in section 1332.
56. Macro abbreviations for output to the terminal and to the log le are dened here for convenience.
Some systems need special conventions for terminal output, and it is possible to adhere to those conventions
by changing wterm, wterm ln, and wterm cr in this section.
dene wterm(#) write(term out , #)
dene wterm ln(#) write ln(term out , #)
dene wterm cr write ln(term out )
dene wlog (#) write(log le, #)
dene wlog ln(#) write ln(log le, #)
dene wlog cr write ln(log le)
57 T
E
X82 PART 5: ON-LINE AND OFF-LINE PRINTING 25
57. To end a line of text output, we call print ln.
Basic printing procedures 57
procedure print ln; prints an end-of-line
begin case selector of
term and log : begin wterm cr ; wlog cr ; term oset 0; le oset 0;
end;
log only: begin wlog cr ; le oset 0;
end;
term only: begin wterm cr ; term oset 0;
end;
no print , pseudo, new string : do nothing ;
othercases write ln(write le[selector ])
endcases;
end; tally is not aected
See also sections 58, 59, 60, 62, 63, 64, 65, 262, 263, 518, 699, and 1355.
This code is used in section 4.
58. The print char procedure sends one character to the desired destination, using the xchr array to map
it into an external character compatible with input ln. All printing comes through print ln or print char .
Basic printing procedures 57 +
procedure print char (s : ASCII code); prints a single character
label exit ;
begin if Character s is the current new-line character 244 then
if selector < pseudo then
begin print ln; return;
end;
case selector of
term and log : begin wterm(xchr [s]); wlog (xchr [s]); incr (term oset ); incr (le oset );
if term oset = max print line then
begin wterm cr ; term oset 0;
end;
if le oset = max print line then
begin wlog cr ; le oset 0;
end;
end;
log only: begin wlog (xchr [s]); incr (le oset );
if le oset = max print line then print ln;
end;
term only: begin wterm(xchr [s]); incr (term oset );
if term oset = max print line then print ln;
end;
no print : do nothing ;
pseudo: if tally < trick count then trick buf [tally mod error line] s;
new string : begin if pool ptr < pool size then append char (s);
end; we drop characters if the string space is full
othercases write(write le[selector ], xchr [s])
endcases;
incr (tally);
exit : end;
26 PART 5: ON-LINE AND OFF-LINE PRINTING T
E
X82 59
59. An entire string is output by calling print . Note that if we are outputting the single standard ASCII
character c, we could call print ("c"), since "c" = 99 is the number of a single-character string, as explained
above. But print char ("c") is quicker, so T
E
X goes directly to the print char routine when it knows that
this is safe. (The present implementation assumes that it is always safe to print a visible ASCII character.)
Basic printing procedures 57 +
procedure print (s : integer ); prints string s
label exit ;
var j: pool pointer ; current character code position
nl : integer ; new-line character to restore
begin if s str ptr then s "???" this cant happen
else if s < 256 then
if s < 0 then s "???" cant happen
else begin if selector > pseudo then
begin print char (s); return; internal strings are not expanded
end;
if ( Character s is the current new-line character 244 ) then
if selector < pseudo then
begin print ln; return;
end;
nl new line char ; new line char 1; temporarily disable new-line character
j str start [s];
while j < str start [s + 1] do
begin print char (so(str pool [j])); incr (j);
end;
new line char nl ; return;
end;
j str start [s];
while j < str start [s + 1] do
begin print char (so(str pool [j])); incr (j);
end;
exit : end;
60. Control sequence names, le names, and strings constructed with \string might contain ASCII code
values that cant be printed using print char . Therefore we use slow print for them:
Basic printing procedures 57 +
procedure slow print (s : integer ); prints string s
var j: pool pointer ; current character code position
begin if (s str ptr ) (s < 256) then print (s)
else begin j str start [s];
while j < str start [s + 1] do
begin print (so(str pool [j])); incr (j);
end;
end;
end;
61 T
E
X82 PART 5: ON-LINE AND OFF-LINE PRINTING 27
61. Here is the very rst thing that T
E
X prints: a headline that identies the version number and format
package. The term oset variable is temporarily incorrect, but the discrepancy is not serious since we assume
that the banner and format identier together will occupy at most max print line character positions.
Initialize the output routines 55 +
wterm(banner );
if format ident = 0 then wterm ln((noformatpreloaded))
else begin slow print (format ident ); print ln;
end;
update terminal ;
62. The procedure print nl is like print , but it makes sure that the string appears at the beginning of a
new line.
Basic printing procedures 57 +
procedure print nl (s : str number ); prints string s at beginning of line
begin if ((term oset > 0) (odd (selector ))) ((le oset > 0) (selector log only)) then print ln;
print (s);
end;
63. The procedure print esc prints a string that is preceded by the users escape character (which is usually
a backslash).
Basic printing procedures 57 +
procedure print esc(s : str number ); prints escape character, then s
var c: integer ; the escape character code
begin Set variable c to the current escape character 243 ;
if c 0 then
if c < 256 then print (c);
slow print (s);
end;
64. An array of digits in the range 0 . . 15 is printed by print the digs .
Basic printing procedures 57 +
procedure print the digs (k : eight bits ); prints dig [k 1] . . . dig [0]
begin while k > 0 do
begin decr (k);
if dig [k] < 10 then print char ("0" + dig [k])
else print char ("A" 10 + dig [k]);
end;
end;
28 PART 5: ON-LINE AND OFF-LINE PRINTING T
E
X82 65
65. The following procedure, which prints out the decimal representation of a given integer n, has been
written carefully so that it works properly if n = 0 or if (n) would cause overow. It does not apply mod or
div to negative arguments, since such operations are not implemented consistently by all Pascal compilers.
Basic printing procedures 57 +
procedure print int (n : integer ); prints an integer in decimal form
var k: 0 . . 23; index to current digit; we assume that n < 10
23

m: integer ; used to negate n in possibly dangerous cases

begin k 0;
if n < 0 then
begin print char ("");
if n > 100000000 then negate(n)
else begin m 1 n; n mdiv 10; m (mmod 10) + 1; k 1;
if m < 10 then dig [0] m
else begin dig [0] 0; incr (n);
end;
end;
end;
repeat dig [k] n mod 10; n n div 10; incr (k);
until n = 0;
print the digs (k);
end;
66. Here is a trivial procedure to print two digits; it is usually called with a parameter in the range
0 n 99.
procedure print two(n : integer ); prints two least signicant digits
begin n abs (n) mod 100; print char ("0" + (n div 10)); print char ("0" + (n mod 10));
end;
67. Hexadecimal printing of nonnegative integers is accomplished by print hex .
procedure print hex (n : integer ); prints a positive integer in hexadecimal form
var k: 0 . . 22; index to current digit; we assume that 0 n < 16
22

begin k 0; print char ("""");

repeat dig [k] n mod 16; n n div 16; incr (k);
until n = 0;
print the digs (k);
end;
68. Old versions of T
E
X needed a procedure called print ASCII whose function is now subsumed by print .
We retain the old name here as a possible aid to future software archologists.
dene print ASCII print
69 T
E
X82 PART 5: ON-LINE AND OFF-LINE PRINTING 29
69. Roman numerals are produced by the print roman int routine. Readers who like puzzles might enjoy
trying to gure out how this tricky code works; therefore no explanation will be given. Notice that 1990
yields mcmxc, not mxm.
procedure print roman int (n : integer );
label exit ;
var j, k: pool pointer ; mysterious indices into str pool
u, v: nonnegative integer ; mysterious numbers
begin j str start ["m2d5c2l5x2v5i"]; v 1000;
loop begin while n v do
begin print char (so(str pool [j])); n n v;
end;
if n 0 then return; nonpositive input produces no output
k j + 2; u v div (so(str pool [k 1]) "0");
if str pool [k 1] = si ("2") then
begin k k + 2; u u div (so(str pool [k 1]) "0");
end;
if n + u v then
begin print char (so(str pool [k])); n n + u;
end
else begin j j + 2; v v div (so(str pool [j 1]) "0");
end;
end;
exit : end;
70. The print subroutine will not print a string that is still being created. The following procedure will.
procedure print current string ; prints a yet-unmade string
var j: pool pointer ; points to current character code
begin j str start [str ptr ];
while j < pool ptr do
begin print char (so(str pool [j])); incr (j);
end;
end;
71. Here is a procedure that asks the user to type a line of input, assuming that the selector setting is
either term only or term and log . The input is placed into locations rst through last 1 of the buer
array, and echoed on the transcript le if appropriate.
This procedure is never called when interaction < scroll mode.
dene prompt input (#)
begin wake up terminal ; print (#); term input ;
end prints a string and gets a line of input
procedure term input ; gets a line from the terminal
var k: 0 . . buf size; index into buer
begin update terminal ; now the user sees the prompt for sure
if input ln(term in, true) then fatal error ("Endoffileontheterminal!");
term oset 0; the users line ended with return
decr (selector ); prepare to echo the input
if last ,= rst then
for k rst to last 1 do print (buer [k]);
print ln; incr (selector ); restore previous status
end;
30 PART 6: REPORTING ERRORS T
E
X82 72
72. Reporting errors. When something anomalous is detected, T
E
X typically does something like this:
print err ("Somethinganomaloushasbeendetected");
help3 ("Thisisthefirstlineofmyoffertohelp.")
("Thisisthesecondline.Imtryingto")
("explainthebestwayforyoutoproceed.");
error ;
A two-line help message would be given using help2 , etc.; these informal helps should use simple vocabulary
that complements the words used in the ocial error message that was printed. (Outside the U.S.A., the
help messages should preferably be translated into the local vernacular. Each line of help is at most 60
characters long, in the present implementation, so that max print line will not be exceeded.)
The print err procedure supplies a ! before the ocial message, and makes sure that the terminal is
awake if a stop is going to occur. The error procedure supplies a . after the ocial message, then it shows
the location of the error; and if interaction = error stop mode, it also enters into a dialog with the user,
during which time the help message may be printed.
73. The global variable interaction has four settings, representing increasing amounts of user interaction:
dene batch mode = 0 omits all stops and omits terminal output
dene nonstop mode = 1 omits all stops
dene scroll mode = 2 omits error stops
dene error stop mode = 3 stops at every opportunity to interact
dene print err (#)
begin if interaction = error stop mode then wake up terminal ;
print nl ("!"); print (#);
end
Global variables 13 +
interaction: batch mode . . error stop mode; current level of interaction
74. Set initial values of key variables 21 +
interaction error stop mode;
75. T
E
X is careful not to call error when the print selector setting might be unusual. The only possible
values of selector at the time of error messages are
no print (when interaction = batch mode and log le not yet open);
term only (when interaction > batch mode and log le not yet open);
log only (when interaction = batch mode and log le is open);
term and log (when interaction > batch mode and log le is open).
Initialize the print selector based on interaction 75
if interaction = batch mode then selector no print else selector term only
This code is used in sections 1265 and 1337.
76 T
E
X82 PART 6: REPORTING ERRORS 31
76. A global variable deletions allowed is set false if the get next routine is active when error is called; this
ensures that get next and related routines like get token will never be called recursively. A similar interlock
is provided by set box allowed .
The global variable history records the worst level of error that has been detected. It has four possible
values: spotless , warning issued , error message issued , and fatal error stop.
Another global variable, error count , is increased by one when an error occurs without an interactive
dialog, and it is reset to zero at the end of every paragraph. If error count reaches 100, T
E
X decides that
there is no point in continuing further.
dene spotless = 0 history value when nothing has been amiss yet
dene warning issued = 1 history value when begin diagnostic has been called
dene error message issued = 2 history value when error has been called
dene fatal error stop = 3 history value when termination was premature
Global variables 13 +
deletions allowed : boolean; is it safe for error to call get token?
set box allowed : boolean; is it safe to do a \setbox assignment?
history: spotless . . fatal error stop; has the source input been clean so far?
error count : 1 . . 100; the number of scrolled errors since the last paragraph ended
77. The value of history is initially fatal error stop, but it will be changed to spotless if T
E
X survives the
initialization process.
Set initial values of key variables 21 +
deletions allowed true; set box allowed true; error count 0; history is initialized elsewhere
78. Since errors can be detected almost anywhere in T
E
X, we want to declare the error procedures near
the beginning of the program. But the error procedures in turn use some other procedures, which need to
be declared forward before we get to error itself.
It is possible for error to be called recursively if some error arises when get token is being used to delete
a token, and/or if some fatal error occurs while T
E
X is trying to x a non-fatal one. But such recursion is
never more than two levels deep.
Error handling procedures 78
procedure normalize selector ; forward ;
procedure get token; forward ;
procedure term input ; forward ;
procedure show context ; forward ;
procedure begin le reading ; forward ;
procedure open log le; forward ;
procedure close les and terminate; forward ;
procedure clear for error prompt ; forward ;
procedure give err help; forward ;
debug procedure debug help; forward ; gubed
See also sections 81, 82, 93, 94, and 95.
This code is used in section 4.
32 PART 6: REPORTING ERRORS T
E
X82 79
79. Individual lines of help are recorded in the array help line, which contains entries in positions 0 . .
(help ptr 1). They should be printed in reverse order, i.e., with help line[0] appearing last.
dene hlp1 (#) help line[0] #; end
dene hlp2 (#) help line[1] #; hlp1
dene hlp3 (#) help line[2] #; hlp2
dene hlp4 (#) help line[3] #; hlp3
dene hlp5 (#) help line[4] #; hlp4
dene hlp6 (#) help line[5] #; hlp5
dene help0 help ptr 0 sometimes there might be no help
dene help1 begin help ptr 1; hlp1 use this with one help line
dene help2 begin help ptr 2; hlp2 use this with two help lines
dene help3 begin help ptr 3; hlp3 use this with three help lines
dene help4 begin help ptr 4; hlp4 use this with four help lines
dene help5 begin help ptr 5; hlp5 use this with ve help lines
dene help6 begin help ptr 6; hlp6 use this with six help lines
Global variables 13 +
help line: array [0 . . 5] of str number ; helps for the next error
help ptr : 0 . . 6; the number of help lines present
use err help: boolean; should the err help list be shown?
80. Set initial values of key variables 21 +
help ptr 0; use err help false;
81. The jump out procedure just cuts across all active procedure levels and goes to end of TEX. This
is the only nontrivial goto statement in the whole program. It is used when there is no recovery from a
particular error.
Some Pascal compilers do not implement non-local goto statements. In such cases the body of jump out
should simply be close les and terminate; followed by a call on some system procedure that quietly
terminates the program.
Error handling procedures 78 +
procedure jump out ;
begin goto end of TEX;
end;
82. Here now is the general error routine.
Error handling procedures 78 +
procedure error ; completes the job of error reporting
label continue, exit ;
var c: ASCII code; what the user types
s1 , s2 , s3 , s4 : integer ; used to save global variables when deleting tokens
begin if history < error message issued then history error message issued ;
print char ("."); show context ;
if interaction = error stop mode then Get users advice and return 83 ;
incr (error count );
if error count = 100 then
begin print nl ("(Thatmakes100errors;pleasetryagain.)"); history fatal error stop;
jump out ;
end;
Put help message on the transcript le 90 ;
exit : end;
83 T
E
X82 PART 6: REPORTING ERRORS 33
83. Get users advice and return 83
loop begin continue: clear for error prompt ; prompt input ("?");
if last = rst then return;
c buer [rst ];
if c "a" then c c + "A" "a"; convert to uppercase
Interpret code c and return if done 84 ;
end
This code is used in section 82.
84. It is desirable to provide an E option here that gives the user an easy way to return from T
E
X to
the system editor, with the oending line ready to be edited. But such an extension requires some system
wizardry, so the present implementation simply types out the name of the le that should be edited and the
relevant line number.
There is a secret D option available when the debugging routines havent been commented out.
Interpret code c and return if done 84
case c of
"0", "1", "2", "3", "4", "5", "6", "7", "8", "9": if deletions allowed then
Delete c "0" tokens and goto continue 88 ;
debug "D": begin debug help; goto continue; end; gubed
"E": if base ptr > 0 then
begin print nl ("Youwanttoeditfile"); slow print (input stack [base ptr ].name eld );
print ("atline"); print int (line); interaction scroll mode; jump out ;
end;
"H": Print the help information and goto continue 89 ;
"I": Introduce new material from the terminal and return 87 ;
"Q", "R", "S": Change the interaction level and return 86 ;
"X": begin interaction scroll mode; jump out ;
end;
othercases do nothing
endcases;
Print the menu of available options 85
This code is used in section 83.
85. Print the menu of available options 85
begin print ("Type<return>toproceed,Stoscrollfutureerrormessages,");
print nl ("Rtorunwithoutstopping,Qtorunquietly,");
print nl ("Itoinsertsomething,");
if base ptr > 0 then print ("Etoedityourfile,");
if deletions allowed then
print nl ("1or...or9toignorethenext1to9tokensofinput,");
print nl ("Hforhelp,Xtoquit.");
end
This code is used in section 84.
34 PART 6: REPORTING ERRORS T
E
X82 86
86. Here the author of T
E
X apologizes for making use of the numerical relation between "Q", "R", "S",
and the desired interaction settings batch mode, nonstop mode, scroll mode.
Change the interaction level and return 86
begin error count 0; interaction batch mode + c "Q"; print ("OK,entering");
case c of
"Q": begin print esc("batchmode"); decr (selector );
end;
"R": print esc("nonstopmode");
"S": print esc("scrollmode");
end; there are no other cases
print ("..."); print ln; update terminal ; return;
end
This code is used in section 84.
87. When the following code is executed, buer [(rst +1) . . (last 1)] may contain the material inserted
by the user; otherwise another prompt will be given. In order to understand this part of the program fully,
you need to be familiar with T
E
Xs input stacks.
Introduce new material from the terminal and return 87
begin begin le reading ; enter a new syntactic level for terminal input
now state = mid line, so an initial blank space will count as a blank
if last > rst + 1 then
begin loc rst + 1; buer [rst ] "";
end
else begin prompt input ("insert>"); loc rst ;
end;
rst last ; cur input .limit eld last 1; no end line char ends this line
return;
end
This code is used in section 84.
88. We allow deletion of up to 99 tokens at a time.
Delete c "0" tokens and goto continue 88
begin s1 cur tok ; s2 cur cmd ; s3 cur chr ; s4 align state; align state 1000000;
OK to interrupt false;
if (last > rst + 1) (buer [rst + 1] "0") (buer [rst + 1] "9") then
c c 10 + buer [rst + 1] "0" 11
else c c "0";
while c > 0 do
begin get token; one-level recursive call of error is possible
decr (c);
end;
cur tok s1 ; cur cmd s2 ; cur chr s3 ; align state s4 ; OK to interrupt true;
help2 ("Ihavejustdeletedsometext,asyouasked.")
("Youcannowdeletemore,orinsert,orwhatever."); show context ; goto continue;
end
This code is used in section 84.
89 T
E
X82 PART 6: REPORTING ERRORS 35
89. Print the help information and goto continue 89
begin if use err help then
begin give err help; use err help false;
end
else begin if help ptr = 0 then help2 ("Sorry,Idontknowhowtohelpinthissituation.")
("Maybeyoushouldtryaskingahuman?");
repeat decr (help ptr ); print (help line[help ptr ]); print ln;
until help ptr = 0;
end;
help4 ("Sorry,IalreadygavewhathelpIcould...")
("Maybeyoushouldtryaskingahuman?")
("AnerrormighthaveoccurredbeforeInoticedanyproblems.")
("``Ifallelsefails,readtheinstructions.");
goto continue;
end
This code is used in section 84.
90. Put help message on the transcript le 90
if interaction > batch mode then decr (selector ); avoid terminal output
if use err help then
begin print ln; give err help;
end
else while help ptr > 0 do
begin decr (help ptr ); print nl (help line[help ptr ]);
end;
print ln;
if interaction > batch mode then incr (selector ); re-enable terminal output
print ln
This code is used in section 82.
91. A dozen or so error messages end with a parenthesized integer, so we save a teeny bit of program space
by declaring the following procedure:
procedure int error (n : integer );
begin print ("("); print int (n); print char (")"); error ;
end;
92. In anomalous cases, the print selector might be in an unknown state; the following subroutine is called
to x things just enough to keep running a bit longer.
procedure normalize selector ;
begin if log opened then selector term and log
else selector term only;
if job name = 0 then open log le;
if interaction = batch mode then decr (selector );
end;
36 PART 6: REPORTING ERRORS T
E
X82 93
93. The following procedure prints T
E
Xs last words before dying.
dene succumb
begin if interaction = error stop mode then interaction scroll mode;
no more interaction
if log opened then error ;
debug if interaction > batch mode then debug help;
gubed
history fatal error stop; jump out ; irrecoverable error
end
Error handling procedures 78 +
procedure fatal error (s : str number ); prints s, and thats it
begin normalize selector ;
print err ("Emergencystop"); help1 (s); succumb;
end;
94. Here is the most dreaded error message.
Error handling procedures 78 +
procedure overow(s : str number ; n : integer ); stop due to niteness
begin normalize selector ; print err ("TeXcapacityexceeded,sorry["); print (s); print char ("=");
print int (n); print char ("]"); help2 ("Ifyoureallyabsolutelyneedmorecapacity,")
("youcanaskawizardtoenlargeme."); succumb;
end;
95. The program might sometime run completely amok, at which point there is no choice but to stop. If
no previous error has been detected, thats bad news; a message is printed that is really intended for the
T
E
X maintenance person instead of the user (unless the user has been particularly diabolical). The index
entries for this cant happen may help to pinpoint the problem.
Error handling procedures 78 +
procedure confusion(s : str number ); consistency check violated; s tells where
begin normalize selector ;
if history < error message issued then
begin print err ("Thiscanthappen("); print (s); print char (")");
help1 ("Imbroken.Pleaseshowthistosomeonewhocanfixcanfix");
end
else begin print err ("Icantgoonmeetingyoulikethis");
help2 ("Oneofyourfauxpasseemstohavewoundedmedeeply...")
("infact,Imbarelyconscious.Pleasefixitandtryagain.");
end;
succumb;
end;
96. Users occasionally want to interrupt T
E
X while its running. If the Pascal runtime system allows this,
one can implement a routine that sets the global variable interrupt to some nonzero value when such an
interrupt is signalled. Otherwise there is probably at least a way to make interrupt nonzero using the Pascal
debugger.
dene check interrupt
begin if interrupt ,= 0 then pause for instructions ;
end
Global variables 13 +
interrupt : integer ; should T
E
X pause for instructions?
OK to interrupt : boolean; should interrupts be observed?
97 T
E
X82 PART 6: REPORTING ERRORS 37
97. Set initial values of key variables 21 +
interrupt 0; OK to interrupt true;
98. When an interrupt has been detected, the program goes into its highest interaction level and lets the
user have nearly the full exibility of the error routine. T
E
X checks for interrupts only at times when it is
safe to do this.
procedure pause for instructions ;
begin if OK to interrupt then
begin interaction error stop mode;
if (selector = log only) (selector = no print ) then incr (selector );
print err ("Interruption"); help3 ("Yourang?")
("Trytoinsertsomeinstructionsforme(e.g.,`I\showlists),")
("unlessyoujustwanttoquitbytyping`X."); deletions allowed false; error ;
deletions allowed true; interrupt 0;
end;
end;
38 PART 7: ARITHMETIC WITH SCALED DIMENSIONS T
E
X82 99
99. Arithmetic with scaled dimensions. The principal computations performed by T
E
X are done
entirely in terms of integers less than 2
31
in magnitude; and divisions are done only when both dividend
and divisor are nonnegative. Thus, the arithmetic specied in this program can be carried out in exactly
the same way on a wide variety of computers, including some small ones. Why? Because the arithmetic
calculations need to be spelled out precisely in order to guarantee that T
E
X will produce identical output
on dierent machines. If some quantities were rounded dierently in dierent implementations, we would
nd that line breaks and even page breaks might occur in dierent places. Hence the arithmetic of T
E
X has
been designed with care, and systems that claim to be implementations of T
E
X82 should follow precisely the
calculations as they appear in the present program.
(Actually there are three places where T
E
X uses div with a possibly negative numerator. These are
harmless; see div in the index. Also if the user sets the \time or the \year to a negative value, some
diagnostic information will involve negative-numerator division. The same remarks apply for mod as well
as for div.)
100. Here is a routine that calculates half of an integer, using an unambiguous convention with respect to
signed odd numbers.
function half (x : integer ): integer ;
begin if odd (x) then half (x + 1) div 2
else half x div 2;
end;
101. Fixed-point arithmetic is done on scaled integers that are multiples of 2
16
. In other words, a binary
point is assumed to be sixteen bit positions from the right end of a binary computer word.
dene unity 200000 2
16
, represents 1.00000
dene two 400000 2
17
, represents 2.00000
Types in the outer block 18 +
scaled = integer ; this type is used for scaled integers
nonnegative integer = 0 . . 17777777777 ; 0 x < 2
31

small number = 0 . . 63; this type is self-explanatory

102. The following function is used to create a scaled integer from a given decimal fraction (.d
0
d
1
. . . d
k1
),
where 0 k 17. The digit d
i
is given in dig [i], and the calculation produces a correctly rounded result.
function round decimals (k : small number ): scaled ; converts a decimal fraction
var a: integer ; the accumulator
begin a 0;
while k > 0 do
begin decr (k); a (a + dig [k] two) div 10;
end;
round decimals (a + 1) div 2;
end;
103 T
E
X82 PART 7: ARITHMETIC WITH SCALED DIMENSIONS 39
103. Conversely, here is a procedure analogous to print int . If the output of this procedure is subsequently
read by T
E
X and converted by the round decimals routine above, it turns out that the original value will
be reproduced exactly; the simplest such decimal number is output, but there is always at least one digit
following the decimal point.
The invariant relation in the repeat loop is that a sequence of decimal digits yet to be printed will yield
the original number if and only if they form a fraction f in the range s 10 2
16
f < s. We can stop if
and only if f = 0 satises this condition; the loop will terminate before s can possibly become zero.
procedure print scaled (s : scaled ); prints scaled real, rounded to ve digits
var delta: scaled ; amount of allowable inaccuracy
begin if s < 0 then
begin print char (""); negate(s); print the sign, if negative
end;
print int (s div unity); print the integer part
print char ("."); s 10 (s mod unity) + 5; delta 10;
repeat if delta > unity then s s + 100000 50000; round the last digit
print char ("0" + (s div unity)); s 10 (s mod unity); delta delta 10;
until s delta;
end;
104. Physical sizes that a T
E
X user species for portions of documents are represented internally as scaled
points. Thus, if we dene an sp (scaled point) as a unit equal to 2
16
printers points, every dimension
inside of T
E
X is an integer number of sp. There are exactly 4,736,286.72 sp per inch. Users are not allowed
to specify dimensions larger than 2
30
1 sp, which is a distance of about 18.892 feet (5.7583 meters); two
such quantities can be added without overow on a 32-bit computer.
The present implementation of T
E
X does not check for overow when dimensions are added or subtracted.
This could be done by inserting a few dozen tests of the form if x 10000000000 then report overow,
but the chance of overow is so remote that such tests do not seem worthwhile.
T
E
X needs to do only a few arithmetic operations on scaled quantities, other than addition and subtraction,
and the following subroutines do most of the work. A single computation might use several subroutine calls,
and it is desirable to avoid producing multiple error messages in case of arithmetic overow; so the routines
set the global variable arith error to true instead of reporting errors directly to the user. Another global
variable, remainder , holds the remainder after a division.
Global variables 13 +
arith error : boolean; has arithmetic overow occurred recently?
remainder : scaled ; amount subtracted to get an exact division
105. The rst arithmetical subroutine we need computes nx + y, where x and y are scaled and n is an
integer. We will also use it to multiply integers.
dene nx plus y(#) mult and add (#, 7777777777 )
dene mult integers (#) mult and add (#, 0, 17777777777 )
function mult and add (n : integer ; x, y, max answer : scaled ): scaled ;
begin if n < 0 then
begin negate(x); negate(n);
end;
if n = 0 then mult and add y
else if ((x (max answer y) div n) (x (max answer +y) div n)) then mult and add n x +y
else begin arith error true; mult and add 0;
end;
end;
40 PART 7: ARITHMETIC WITH SCALED DIMENSIONS T
E
X82 106
106. We also need to divide scaled dimensions by integers.
function x over n(x : scaled ; n : integer ): scaled ;
var negative: boolean; should remainder be negated?
begin negative false;
if n = 0 then
begin arith error true; x over n 0; remainder x;
end
else begin if n < 0 then
begin negate(x); negate(n); negative true;
end;
if x 0 then
begin x over n x div n; remainder x mod n;
end
else begin x over n ((x) div n); remainder ((x) mod n);
end;
end;
if negative then negate(remainder );
end;
107. Then comes the multiplication of a scaled number by a fraction n/d, where n and d are nonnegative
integers 2
16
and d is positive. It would be too dangerous to multiply by n and then divide by d, in separate
operations, since overow might well occur; and it would be too inaccurate to divide by d and then multiply
by n. Hence this subroutine simulates 1.5-precision arithmetic.
function xn over d (x : scaled ; n, d : integer ): scaled ;
var positive: boolean; was x 0?
t, u, v: nonnegative integer ; intermediate quantities
begin if x 0 then positive true
else begin negate(x); positive false;
end;
t (x mod 100000 ) n; u (x div 100000 ) n + (t div 100000 );
v (u mod d) 100000 + (t mod 100000 );
if u div d 100000 then arith error true
else u 100000 (u div d) + (v div d);
if positive then
begin xn over d u; remainder v mod d;
end
else begin xn over d u; remainder (v mod d);
end;
end;
108 T
E
X82 PART 7: ARITHMETIC WITH SCALED DIMENSIONS 41
108. The next subroutine is used to compute the badness of glue, when a total t is supposed to be made
from amounts that sum to s. According to The T
E
Xbook, the badness of this situation is 100(t/s)
3
; however,
badness is simply a heuristic, so we need not squeeze out the last drop of accuracy when computing it. All
we really want is an approximation that has similar properties.
The actual method used to compute the badness is easier to read from the program than to describe
in words. It produces an integer value that is a reasonably close approximation to 100(t/s)
3
, and all
implementations of T
E
X should use precisely this method. Any badness of 2
13
or more is treated as innitely
bad, and represented by 10000.
It is not dicult to prove that
badness (t + 1, s) badness (t, s) badness (t, s + 1).
The badness function dened here is capable of computing at most 1095 distinct values, but that is plenty.
dene inf bad = 10000 innitely bad value
function badness (t, s : scaled ): halfword ; compute badness, given t 0
var r: integer ; approximation to t/s, where
3
100 2
18

begin if t = 0 then badness 0

else if s 0 then badness inf bad
else begin if t 7230584 then r (t 297) div s 297
3
= 99.94 2
18

else if s 1663497 then r t div (s div 297)

else r t;
if r > 1290 then badness inf bad 1290
3
< 2
31
< 1291
3

else badness (r r r + 400000 ) div 1000000 ;

end; that was r
3
/2
18
, rounded to the nearest integer
end;
109. When T
E
X packages a list into a box, it needs to calculate the proportionality ratio by which the
glue inside the box should stretch or shrink. This calculation does not aect T
E
Xs decision making, so the
precise details of rounding, etc., in the glue calculation are not of critical importance for the consistency of
results on dierent computers.
We shall use the type glue ratio for such proportionality ratios. A glue ratio should take the same amount
of memory as an integer (usually 32 bits) if it is to blend smoothly with T
E
Xs other data structures. Thus
glue ratio should be equivalent to short real in some implementations of Pascal. Alternatively, it is possible
to deal with glue ratios using nothing but xed-point arithmetic; see TUGboat 3,1 (March 1982), 1027.
(But the routines cited there must be modied to allow negative glue ratios.)
dene set glue ratio zero(#) # 0.0 store the representation of zero ratio
dene set glue ratio one(#) # 1.0 store the representation of unit ratio
dene oat (#) # convert from glue ratio to type real
dene unoat (#) # convert from real to type glue ratio
dene oat constant (#) #.0 convert integer constant to real
Types in the outer block 18 +
glue ratio = real ; one-word representation of a glue expansion factor
42 PART 8: PACKED DATA T
E
X82 110
110. Packed data. In order to make ecient use of storage space, T
E
X bases its major data structures
on a memory word , which contains either a (signed) integer, possibly scaled, or a (signed) glue ratio, or a
small number of elds that are one half or one quarter of the size used for storing integers.
If x is a variable of type memory word , it contains up to four elds that can be referred to as follows:
x.int (an integer )
x.sc (a scaled integer)
x.gr (a glue ratio)
x.hh.lh, x.hh.rh (two halfword elds)
x.hh.b0 , x.hh.b1 , x.hh.rh (two quarterword elds, one halfword eld)
x.qqqq .b0 , x.qqqq .b1 , x.qqqq .b2 , x.qqqq .b3 (four quarterword elds)
This is somewhat cumbersome to write, and not very readable either, but macros will be used to make the
notation shorter and more transparent. The Pascal code below gives a formal denition of memory word and
its subsidiary types, using packed variant records. T
E
X makes no assumptions about the relative positions
of the elds within a word.
Since we are assuming 32-bit integers, a halfword must contain at least 16 bits, and a quarterword must
contain at least 8 bits. But it doesnt hurt to have more bits; for example, with enough 36-bit words you
might be able to have mem max as large as 262142, which is eight times as much memory as anybody had
during the rst four years of T
E
Xs existence.
N.B.: Valuable memory space will be dreadfully wasted unless T
E
X is compiled by a Pascal that packs
all of the memory word variants into the space of a single integer. This means, for example, that glue ratio
words should be short real instead of real on some computers. Some Pascal compilers will pack an integer
whose subrange is 0 . . 255 into an eight-bit eld, but others insist on allocating space for an additional sign
bit; on such systems you can get 256 values into a quarterword only if the subrange is 128 . . 127.
The present implementation tries to accommodate as many variations as possible, so it makes few as-
sumptions. If integers having the subrange min quarterword . . max quarterword can be packed into a
quarterword, and if integers having the subrange min halfword . . max halfword can be packed into a
halfword, everything should work satisfactorily.
It is usually most ecient to have min quarterword = min halfword = 0, so one should try to achieve this
unless it causes a severe problem. The values dened here are recommended for most 32-bit computers.
dene min quarterword = 0 smallest allowable value in a quarterword
dene max quarterword = 255 largest allowable value in a quarterword
dene min halfword 0 smallest allowable value in a halfword
dene max halfword 65535 largest allowable value in a halfword
111. Here are the inequalities that the quarterword and halfword values must satisfy (or rather, the
inequalities that they mustnt satisfy):
Check the constant values for consistency 14 +
init if (mem min ,= mem bot ) (mem max ,= mem top) then bad 10;
tini
if (mem min > mem bot ) (mem max < mem top) then bad 10;
if (min quarterword > 0) (max quarterword < 127) then bad 11;
if (min halfword > 0) (max halfword < 32767) then bad 12;
if (min quarterword < min halfword ) (max quarterword > max halfword ) then bad 13;
if (mem min < min halfword ) (mem max max halfword )
(mem bot mem min > max halfword + 1) then bad 14;
if (font base < min quarterword ) (font max > max quarterword ) then bad 15;
if font max > font base + 256 then bad 16;
if (save size > max halfword ) (max strings > max halfword ) then bad 17;
if buf size > max halfword then bad 18;
if max quarterword min quarterword < 255 then bad 19;
112 T
E
X82 PART 8: PACKED DATA 43
112. The operation of adding or subtracting min quarterword occurs quite frequently in T
E
X, so it is
convenient to abbreviate this operation by using the macros qi and qo for input and output to and from
quarterword format.
The inner loop of T
E
X will run faster with respect to compilers that dont optimize expressions like x+0
and x 0, if these macros are simplied in the obvious way when min quarterword = 0.
dene qi (#) # + min quarterword to put an eight bits item into a quarterword
dene qo(#) # min quarterword to take an eight bits item out of a quarterword
dene hi (#) # + min halfword to put a sixteen-bit item into a halfword
dene ho(#) # min halfword to take a sixteen-bit item from a halfword
113. The reader should study the following denitions closely:
dene sc int scaled data is equivalent to integer
Types in the outer block 18 +
quarterword = min quarterword . . max quarterword ; 1/4 of a word
halfword = min halfword . . max halfword ; 1/2 of a word
two choices = 1 . . 2; used when there are two variants in a record
four choices = 1 . . 4; used when there are four variants in a record
two halves = packed record rh: halfword ;
case two choices of
1: (lh : halfword );
2: (b0 : quarterword ; b1 : quarterword );
end;
four quarters = packed record b0 : quarterword ;
b1 : quarterword ;
b2 : quarterword ;
b3 : quarterword ;
end;
memory word = record
case four choices of
1: (int : integer );
2: (gr : glue ratio);
3: (hh : two halves );
4: (qqqq : four quarters );
end;
word le = le of memory word ;
114. When debugging, we may want to print a memory word without knowing what type it is; so we print
it in all modes.
debug procedure print word (w : memory word ); prints w in all ways
begin print int (w.int ); print char ("");
print scaled (w.sc); print char ("");
print scaled (round (unity oat (w.gr ))); print ln;
print int (w.hh.lh); print char ("="); print int (w.hh.b0 ); print char (":"); print int (w.hh.b1 );
print char (";"); print int (w.hh.rh); print char ("");
print int (w.qqqq .b0 ); print char (":"); print int (w.qqqq .b1 ); print char (":"); print int (w.qqqq .b2 );
print char (":"); print int (w.qqqq .b3 );
end;
gubed
44 PART 9: DYNAMIC MEMORY ALLOCATION T
E
X82 115
115. Dynamic memory allocation. The T
E
X system does nearly all of its own memory allocation, so
that it can readily be transported into environments that do not have automatic facilities for strings, garbage
collection, etc., and so that it can be in control of what error messages the user receives. The dynamic storage
requirements of T
E
X are handled by providing a large array mem in which consecutive blocks of words are
used as nodes by the T
E
X routines.
Pointer variables are indices into this array, or into another array called eqtb that will be explained later.
A pointer variable might also be a special ag that lies outside the bounds of mem, so we allow pointers to
assume any halfword value. The minimum halfword value represents a null pointer. T
E
X does not assume
that mem[null ] exists.
dene pointer halfword a ag or a location in mem or eqtb
dene null min halfword the null pointer
Global variables 13 +
temp ptr : pointer ; a pointer variable for occasional emergency use
116. The mem array is divided into two regions that are allocated separately, but the dividing line between
these two regions is not xed; they grow together until nding their natural size in a particular job.
Locations less than or equal to lo mem max are used for storing variable-length records consisting of two
or more words each. This region is maintained using an algorithm similar to the one described in exercise
2.519 of The Art of Computer Programming. However, no size eld appears in the allocated nodes; the
program is responsible for knowing the relevant size when a node is freed. Locations greater than or equal
to hi mem min are used for storing one-word records; a conventional AVAIL stack is used for allocation in
this region.
Locations of mem between mem bot and mem top may be dumped as part of preloaded format les, by
the INITEX preprocessor. Production versions of T
E
X may extend the memory at both ends in order to
provide more space; locations between mem min and mem bot are always used for variable-size nodes, and
locations between mem top and mem max are always used for single-word nodes.
The key pointers that govern mem allocation have a prescribed order:
null mem min mem bot <lo mem max <hi mem min <mem top mem end mem max .
Empirical tests show that the present implementation of T
E
X tends to spend about 9% of its running time
allocating nodes, and about 6% deallocating them after their use.
Global variables 13 +
mem: array [mem min . . mem max ] of memory word ; the big dynamic storage area
lo mem max : pointer ; the largest location of variable-size memory in use
hi mem min: pointer ; the smallest location of one-word memory in use
117. In order to study the memory requirements of particular applications, it is possible to prepare a
version of T
E
X that keeps track of current and maximum memory usage. When code between the delimiters
stat . . . tats is not commented out, T
E
X will run a bit slower but it will report these statistics when
tracing stats is suciently large.
Global variables 13 +
var used , dyn used : integer ; how much memory is in use
118 T
E
X82 PART 9: DYNAMIC MEMORY ALLOCATION 45
118. Lets consider the one-word memory region rst, since its the simplest. The pointer variable mem end
holds the highest-numbered location of mem that has ever been used. The free locations of mem that occur
between hi mem min and mem end , inclusive, are of type two halves , and we write info(p) and link (p) for
the lh and rh elds of mem[p] when it is of this type. The single-word free locations form a linked list
avail , link (avail ), link (link (avail )), . . .
terminated by null .
dene link (#) mem[#].hh.rh the link eld of a memory word
dene info(#) mem[#].hh.lh the info eld of a memory word
Global variables 13 +
avail : pointer ; head of the list of available one-word nodes
mem end : pointer ; the last one-word node used in mem
119. If memory is exhausted, it might mean that the user has forgotten a right brace. We will dene some
procedures later that try to help pinpoint the trouble.
Declare the procedure called show token list 292
Declare the procedure called runaway 306
120. The function get avail returns a pointer to a new one-word node whose link eld is null. However,
T
E
X will halt if there is no more room left.
If the available-space list is empty, i.e., if avail = null , we try rst to increase mem end . If that cannot
be done, i.e., if mem end = mem max , we try to decrease hi mem min. If that cannot be done, i.e., if
hi mem min = lo mem max + 1, we have to quit.
function get avail : pointer ; single-word node allocation
var p: pointer ; the new node being got
begin p avail ; get top location in the avail stack
if p ,= null then avail link (avail ) and pop it o
else if mem end < mem max then or go into virgin territory
begin incr (mem end ); p mem end ;
end
else begin decr (hi mem min); p hi mem min;
if hi mem min lo mem max then
begin runaway; if memory is exhausted, display possible runaway text
overow("mainmemorysize", mem max +1 mem min); quit; all one-word nodes are busy
end;
end;
link (p) null ; provide an oft-desired initialization of the new node
stat incr (dyn used ); tats maintain statistics
get avail p;
end;
121. Conversely, a one-word node is recycled by calling free avail . This routine is part of T
E
Xs inner
loop, so we want it to be fast.
dene free avail (#) single-word node liberation
begin link (#) avail ; avail #;
stat decr (dyn used ); tats
end
46 PART 9: DYNAMIC MEMORY ALLOCATION T
E
X82 122
122. Theres also a fast get avail routine, which saves the procedure-call overhead at the expense of extra
programming. This routine is used in the places that would otherwise account for the most calls of get avail .
dene fast get avail (#)
begin # avail ; avoid get avail if possible, to save time
if # = null then # get avail
else begin avail link (#); link (#) null ;
stat incr (dyn used ); tats
end;
end
123. The procedure ush list (p) frees an entire linked list of one-word nodes that starts at position p.
procedure ush list (p : pointer ); makes list of single-word nodes available
var q, r: pointer ; list traversers
begin if p ,= null then
begin r p;
repeat q r; r link (r);
stat decr (dyn used ); tats
until r = null ; now q is the last node on the list
link (q) avail ; avail p;
end;
end;
124. The available-space list that keeps track of the variable-size portion of mem is a nonempty, doubly-
linked circular list of empty nodes, pointed to by the roving pointer rover .
Each empty node has size 2 or more; the rst word contains the special value max halfword in its link
eld and the size in its info eld; the second word contains the two pointers for double linking.
Each nonempty node also has size 2 or more. Its rst word is of type two halves, and its link eld is never
equal to max halfword . Otherwise there is complete exibility with respect to the contents of its other elds
and its other words.
(We require mem max < max halfword because terrible things can happen when max halfword appears
in the link eld of a nonempty node.)
dene empty ag max halfword the link of an empty variable-size node
dene is empty(#) (link (#) = empty ag ) tests for empty node
dene node size info the size eld in empty variable-size nodes
dene llink (#) info(# + 1) left link in doubly-linked list of empty nodes
dene rlink (#) link (# + 1) right link in doubly-linked list of empty nodes
Global variables 13 +
rover : pointer ; points to some node in the list of empties
125 T
E
X82 PART 9: DYNAMIC MEMORY ALLOCATION 47
125. A call to get node with argument s returns a pointer to a new node of size s, which must be 2 or
more. The link eld of the rst word of this new node is set to null. An overow stop occurs if no suitable
space exists.
If get node is called with s = 2
30
, it simply merges adjacent free areas and returns the value max halfword .
function get node(s : integer ): pointer ; variable-size node allocation
label found , exit , restart ;
var p: pointer ; the node currently under inspection
q: pointer ; the node physically after node p
r: integer ; the newly allocated node, or a candidate for this honor
t: integer ; temporary register
begin restart : p rover ; start at some free node in the ring
repeat Try to allocate within node p and its physical successors, and goto found if allocation was
possible 127 ;
p rlink (p); move to the next node in the ring
until p = rover ; repeat until the whole list has been traversed
if s = 10000000000 then
begin get node max halfword ; return;
end;
if lo mem max + 2 < hi mem min then
if lo mem max + 2 mem bot + max halfword then
Grow more variable-size memory and goto restart 126 ;
overow("mainmemorysize", mem max + 1 mem min); sorry, nothing satisfactory is left
found : link (r) null ; this node is now nonempty
stat var used var used + s; maintain usage statistics
tats
get node r;
exit : end;
126. The lower part of mem grows by 1000 words at a time, unless we are very close to going under. When
it grows, we simply link a new node into the available-space list. This method of controlled growth helps to
keep the mem usage consecutive when T
E
X is implemented on virtual memory systems.
Grow more variable-size memory and goto restart 126
begin if hi mem min lo mem max 1998 then t lo mem max + 1000
else t lo mem max +1 +(hi mem min lo mem max ) div 2; lo mem max +2 t < hi mem min
p llink (rover ); q lo mem max ; rlink (p) q; llink (rover ) q;
if t > mem bot + max halfword then t mem bot + max halfword ;
rlink (q) rover ; llink (q) p; link (q) empty ag ; node size(q) t lo mem max ;
lo mem max t; link (lo mem max ) null ; info(lo mem max ) null ; rover q; goto restart ;
end
This code is used in section 125.
48 PART 9: DYNAMIC MEMORY ALLOCATION T
E
X82 127
127. Empirical tests show that the routine in this section performs a node-merging operation about 0.75
times per allocation, on the average, after which it nds that r > p + 1 about 95% of the time.
Try to allocate within node p and its physical successors, and goto found if allocation was possible 127
q p + node size(p); nd the physical successor
while is empty(q) do merge node p with node q
begin t rlink (q);
if q = rover then rover t;
llink (t) llink (q); rlink (llink (q)) t;
q q + node size(q);
end;
r q s;
if r > p + 1 then Allocate from the top of node p and goto found 128 ;
if r = p then
if rlink (p) ,= p then Allocate entire node p and goto found 129 ;
node size(p) q p reset the size in case it grew
This code is used in section 125.
128. Allocate from the top of node p and goto found 128
begin node size(p) r p; store the remaining size
rover p; start searching here next time
goto found ;
end
This code is used in section 127.
129. Here we delete node p from the ring, and let rover rove around.
Allocate entire node p and goto found 129
begin rover rlink (p); t llink (p); llink (rover ) t; rlink (t) rover ; goto found ;
end
This code is used in section 127.
130. Conversely, when some variable-size node p of size s is no longer needed, the operation free node(p, s)
will make its words available, by inserting p as a new empty node just before where rover now points.
procedure free node(p : pointer ; s : halfword ); variable-size node liberation
var q: pointer ; llink (rover )
begin node size(p) s; link (p) empty ag ; q llink (rover ); llink (p) q; rlink (p) rover ;
set both links
llink (rover ) p; rlink (q) p; insert p into the ring
stat var used var used s; tats maintain statistics
end;
131 T
E
X82 PART 9: DYNAMIC MEMORY ALLOCATION 49
131. Just before INITEX writes out the memory, it sorts the doubly linked available space list. The list is
probably very short at such times, so a simple insertion sort is used. The smallest available location will be
pointed to by rover , the next-smallest by rlink (rover ), etc.
init procedure sort avail ; sorts the available variable-size nodes by location
var p, q, r: pointer ; indices into mem
old rover : pointer ; initial rover setting
begin p get node(10000000000 ); merge adjacent free areas
p rlink (rover ); rlink (rover ) max halfword ; old rover rover ;
while p ,= old rover do Sort p into the list starting at rover and advance p to rlink (p) 132 ;
p rover ;
while rlink (p) ,= max halfword do
begin llink (rlink (p)) p; p rlink (p);
end;
rlink (p) rover ; llink (rover ) p;
end;
tini
132. The following while loop is guaranteed to terminate, since the list that starts at rover ends with
max halfword during the sorting procedure.
Sort p into the list starting at rover and advance p to rlink (p) 132
if p < rover then
begin q p; p rlink (q); rlink (q) rover ; rover q;
end
else begin q rover ;
while rlink (q) < p do q rlink (q);
r rlink (p); rlink (p) rlink (q); rlink (q) p; p r;
end
This code is used in section 131.
50 PART 10: DATA STRUCTURES FOR BOXES AND THEIR FRIENDS T
E
X82 133
133. Data structures for boxes and their friends. From the computers standpoint, T
E
Xs chief
mission is to create horizontal and vertical lists. We shall now investigate how the elements of these lists are
represented internally as nodes in the dynamic memory.
A horizontal or vertical list is linked together by link elds in the rst word of each node. Individual
nodes represent boxes, glue, penalties, or special things like discretionary hyphens; because of this variety,
some nodes are longer than others, and we must distinguish dierent kinds of nodes. We do this by putting
a type eld in the rst word, together with the link and an optional subtype.
dene type(#) mem[#].hh.b0 identies what kind of node this is
dene subtype(#) mem[#].hh.b1 secondary identication in some cases
134. A char node, which represents a single character, is the most important kind of node because it
accounts for the vast majority of all boxes. Special precautions are therefore taken to ensure that a char node
does not take up much memory space. Every such node is one word long, and in fact it is identiable by this
property, since other kinds of nodes have at least two words, and they appear in mem locations less than
hi mem min. This makes it possible to omit the type eld in a char node, leaving us room for two bytes
that identify a font and a character within that font.
Note that the format of a char node allows for up to 256 dierent fonts and up to 256 characters per font;
but most implementations will probably limit the total number of fonts to fewer than 75 per job, and most
fonts will stick to characters whose codes are less than 128 (since higher codes are more dicult to access
on most keyboards).
Extensions of T
E
X intended for oriental languages will need even more than 256 256 possible characters,
when we consider dierent sizes and styles of type. It is suggested that Chinese and Japanese fonts be handled
by representing such characters in two consecutive char node entries: The rst of these has font = font base,
and its link points to the second; the second identies the font and the character dimensions. The saving
feature about oriental characters is that most of them have the same box dimensions. The character eld of
the rst char node is a charext that distinguishes between graphic symbols whose dimensions are identical
for typesetting purposes. (See the METAFONT manual.) Such an extension of T
E
X would not be dicult;
further details are left to the reader.
In order to make sure that the character code ts in a quarterword, T
E
X adds the quantity min quarterword
to the actual code.
Character nodes appear only in horizontal lists, never in vertical lists.
dene is char node(#) (# hi mem min) does the argument point to a char node?
dene font type the font code in a char node
dene character subtype the character code in a char node
135 T
E
X82 PART 10: DATA STRUCTURES FOR BOXES AND THEIR FRIENDS 51
135. An hlist node stands for a box that was made from a horizontal list. Each hlist node is seven words
long, and contains the following elds (in addition to the mandatory type and link , which we shall not
mention explicitly when discussing the other node types): The height and width and depth are scaled
integers denoting the dimensions of the box. There is also a shift amount eld, a scaled integer indicating
how much this box should be lowered (if it appears in a horizontal list), or how much it should be moved to
the right (if it appears in a vertical list). There is a list ptr eld, which points to the beginning of the list
from which this box was fabricated; if list ptr is null , the box is empty. Finally, there are three elds that
represent the setting of the glue: glue set (p) is a word of type glue ratio that represents the proportionality
constant for glue setting; glue sign(p) is stretching or shrinking or normal depending on whether or not the
glue should stretch or shrink or remain rigid; and glue order (p) species the order of innity to which glue
setting applies (normal , l , ll , or lll ). The subtype eld is not used.
dene hlist node = 0 type of hlist nodes
dene box node size = 7 number of words to allocate for a box node
dene width oset = 1 position of width eld in a box node
dene depth oset = 2 position of depth eld in a box node
dene height oset = 3 position of height eld in a box node
dene width(#) mem[# + width oset ].sc width of the box, in sp
dene depth(#) mem[# + depth oset ].sc depth of the box, in sp
dene height (#) mem[# + height oset ].sc height of the box, in sp
dene shift amount (#) mem[# + 4].sc repositioning distance, in sp
dene list oset = 5 position of list ptr eld in a box node
dene list ptr (#) link (# + list oset ) beginning of the list inside the box
dene glue order (#) subtype(# + list oset ) applicable order of innity
dene glue sign(#) type(# + list oset ) stretching or shrinking
dene normal = 0 the most common case when several cases are named
dene stretching = 1 glue setting applies to the stretch components
dene shrinking = 2 glue setting applies to the shrink components
dene glue oset = 6 position of glue set in a box node
dene glue set (#) mem[# + glue oset ].gr a word of type glue ratio for glue setting
136. The new null box function returns a pointer to an hlist node in which all subelds have the values
corresponding to \hbox{}. The subtype eld is set to min quarterword , since thats the desired span count
value if this hlist node is changed to an unset node.
function new null box : pointer ; creates a new box node
var p: pointer ; the new node
begin p get node(box node size); type(p) hlist node; subtype(p) min quarterword ;
width(p) 0; depth(p) 0; height (p) 0; shift amount (p) 0; list ptr (p) null ;
glue sign(p) normal ; glue order (p) normal ; set glue ratio zero(glue set (p)); new null box p;
end;
137. A vlist node is like an hlist node in all respects except that it contains a vertical list.
dene vlist node = 1 type of vlist nodes
138. A rule node stands for a solid black rectangle; it has width, depth, and height elds just as in an
hlist node. However, if any of these dimensions is 2
30
, the actual value will be determined by running the
rule up to the boundary of the innermost enclosing box. This is called a running dimension. The width is
never running in an hlist; the height and depth are never running in a vlist.
dene rule node = 2 type of rule nodes
dene rule node size = 4 number of words to allocate for a rule node
dene null ag 10000000000 2
30
, signies a missing item
dene is running (#) (# = null ag ) tests for a running dimension
52 PART 10: DATA STRUCTURES FOR BOXES AND THEIR FRIENDS T
E
X82 139
139. A new rule node is delivered by the new rule function. It makes all the dimensions running, so you
have to change the ones that are not allowed to run.
function new rule: pointer ;
var p: pointer ; the new node
begin p get node(rule node size); type(p) rule node; subtype(p) 0; the subtype is not used
width(p) null ag ; depth(p) null ag ; height (p) null ag ; new rule p;
end;
140. Insertions are represented by ins node records, where the subtype indicates the corresponding box
number. For example, \insert 250 leads to an ins node whose subtype is 250 + min quarterword . The
height eld of an ins node is slightly misnamed; it actually holds the natural height plus depth of the vertical
list being inserted. The depth eld holds the split max depth to be used in case this insertion is split, and
the split top ptr points to the corresponding split top skip. The oat cost eld holds the oating penalty
that will be used if this insertion oats to a subsequent page after a split insertion of the same class. There
is one more eld, the ins ptr , which points to the beginning of the vlist for the insertion.
dene ins node = 3 type of insertion nodes
dene ins node size = 5 number of words to allocate for an insertion
dene oat cost (#) mem[# + 1].int the oating penalty to be used
dene ins ptr (#) info(# + 4) the vertical list to be inserted
dene split top ptr (#) link (# + 4) the split top skip to be used
141. A mark node has a mark ptr eld that points to the reference count of a token list that contains the
users \mark text. This eld occupies a full word instead of a halfword, because theres nothing to put in
the other halfword; it is easier in Pascal to use the full word than to risk leaving garbage in the unused half.
dene mark node = 4 type of a mark node
dene small node size = 2 number of words to allocate for most node types
dene mark ptr (#) mem[# + 1].int head of the token list for a mark
142. An adjust node, which occurs only in horizontal lists, species material that will be moved out into
the surrounding vertical list; i.e., it is used to implement T
E
Xs \vadjust operation. The adjust ptr eld
points to the vlist containing this material.
dene adjust node = 5 type of an adjust node
dene adjust ptr mark ptr vertical list to be moved out of horizontal list
143. A ligature node, which occurs only in horizontal lists, species a character that was fabricated from
the interaction of two or more actual characters. The second word of the node, which is called the lig char
word, contains font and character elds just as in a char node. The characters that generated the ligature
have not been forgotten, since they are needed for diagnostic messages and for hyphenation; the lig ptr eld
points to a linked list of character nodes for all original characters that have been deleted. (This list might
be empty if the characters that generated the ligature were retained in other nodes.)
The subtype eld is 0, plus 2 and/or 1 if the original source of the ligature included implicit left and/or
right boundaries.
dene ligature node = 6 type of a ligature node
dene lig char (#) # + 1 the word where the ligature is to be found
dene lig ptr (#) link (lig char (#)) the list of characters
144 T
E
X82 PART 10: DATA STRUCTURES FOR BOXES AND THEIR FRIENDS 53
144. The new ligature function creates a ligature node having given contents of the font , character , and
lig ptr elds. We also have a new lig item function, which returns a two-word node having a given character
eld. Such nodes are used for temporary processing as ligatures are being created.
function new ligature(f, c : quarterword ; q : pointer ): pointer ;
var p: pointer ; the new node
begin p get node(small node size); type(p) ligature node; font (lig char (p)) f;
character (lig char (p)) c; lig ptr (p) q; subtype(p) 0; new ligature p;
end;
function new lig item(c : quarterword ): pointer ;
var p: pointer ; the new node
begin p get node(small node size); character (p) c; lig ptr (p) null ; new lig item p;
end;
145. A disc node, which occurs only in horizontal lists, species a discretionary line break. If such a
break occurs at node p, the text that starts at pre break (p) will precede the break, the text that starts at
post break (p) will follow the break, and text that appears in the next replace count (p) nodes will be ignored.
For example, an ordinary discretionary hyphen, indicated by \, yields a disc node with pre break pointing
to a char node containing a hyphen, post break = null , and replace count = 0. All three of the discretionary
texts must be lists that consist entirely of character, kern, box, rule, and ligature nodes.
If pre break (p) = null , the ex hyphen penalty will be charged for this break. Otherwise the hyphen penalty
will be charged. The texts will actually be substituted into the list by the line-breaking algorithm if it decides
to make the break, and the discretionary node will disappear at that time; thus, the output routine sees only
discretionaries that were not chosen.
dene disc node = 7 type of a discretionary node
dene replace count subtype how many subsequent nodes to replace
dene pre break llink text that precedes a discretionary break
dene post break rlink text that follows a discretionary break
function new disc: pointer ; creates an empty disc node
var p: pointer ; the new node
begin p get node(small node size); type(p) disc node; replace count (p) 0; pre break (p) null ;
post break (p) null ; new disc p;
end;
146. A whatsit node is a wild card reserved for extensions to T
E
X. The subtype eld in its rst word says
what whatsit it is, and implicitly determines the node size (which must be 2 or more) and the format of the
remaining words. When a whatsit node is encountered in a list, special actions are invoked; knowledgeable
people who are careful not to mess up the rest of T
E
X are able to make T
E
X do new things by adding code
at the end of the program. For example, there might be a T
E
Xnicolor extension to specify dierent colors
of ink, and the whatsit node might contain the desired parameters.
The present implementation of T
E
X treats the features associated with \write and \special as if they
were extensions, in order to illustrate how such routines might be coded. We shall defer further discussion
of extensions until the end of this program.
dene whatsit node = 8 type of special extension nodes
54 PART 10: DATA STRUCTURES FOR BOXES AND THEIR FRIENDS T
E
X82 147
147. A math node, which occurs only in horizontal lists, appears before and after mathematical formulas.
The subtype eld is before before the formula and after after it. There is a width eld, which represents the
amount of surrounding space inserted by \mathsurround.
dene math node = 9 type of a math node
dene before = 0 subtype for math node that introduces a formula
dene after = 1 subtype for math node that winds up a formula
function new math(w : scaled ; s : small number ): pointer ;
var p: pointer ; the new node
begin p get node(small node size); type(p) math node; subtype(p) s; width(p) w;
new math p;
end;
148. T
E
X makes use of the fact that hlist node, vlist node, rule node, ins node, mark node, adjust node,
ligature node, disc node, whatsit node, and math node are at the low end of the type codes, by permitting
a break at glue in a list if and only if the type of the previous node is less than math node. Furthermore, a
node is discarded after a break if its type is math node or more.
dene precedes break (#) (type(#) < math node)
dene non discardable(#) (type(#) < math node)
149. A glue node represents glue in a list. However, it is really only a pointer to a separate glue
specication, since T
E
X makes use of the fact that many essentially identical nodes of glue are usually
present. If p points to a glue node, glue ptr (p) points to another packet of words that specify the stretch
and shrink components, etc.
Glue nodes also serve to represent leaders; the subtype is used to distinguish between ordinary glue (which
is called normal ) and the three kinds of leaders (which are called a leaders , c leaders , and x leaders ). The
leader ptr eld points to a rule node or to a box node containing the leaders; it is set to null in ordinary
glue nodes.
Many kinds of glue are computed from T
E
Xs skip parameters, and it is helpful to know which parameter
has led to a particular glue node. Therefore the subtype is set to indicate the source of glue, whenever it
originated as a parameter. We will be dening symbolic names for the parameter numbers later (e.g.,
line skip code = 0, baseline skip code = 1, etc.); it suces for now to say that the subtype of parametric glue
will be the same as the parameter number, plus one.
In math formulas there are two more possibilities for the subtype in a glue node: mu glue denotes an
\mskip (where the units are scaled mu instead of scaled pt); and cond math glue denotes the \nonscript
feature that cancels the glue node immediately following if it appears in a subscript.
dene glue node = 10 type of node that points to a glue specication
dene cond math glue = 98 special subtype to suppress glue in the next node
dene mu glue = 99 subtype for math glue
dene a leaders = 100 subtype for aligned leaders
dene c leaders = 101 subtype for centered leaders
dene x leaders = 102 subtype for expanded leaders
dene glue ptr llink pointer to a glue specication
dene leader ptr rlink pointer to box or rule node for leaders
150 T
E
X82 PART 10: DATA STRUCTURES FOR BOXES AND THEIR FRIENDS 55
150. A glue specication has a halfword reference count in its rst word, representing null plus the number
of glue nodes that point to it (less one). Note that the reference count appears in the same position as the
link eld in list nodes; this is the eld that is initialized to null when a node is allocated, and it is also the
eld that is agged by empty ag in empty nodes.
Glue specications also contain three scaled elds, for the width, stretch, and shrink dimensions. Finally,
there are two one-byte elds called stretch order and shrink order ; these contain the orders of innity
(normal , l , ll , or lll ) corresponding to the stretch and shrink values.
dene glue spec size = 4 number of words to allocate for a glue specication
dene glue ref count (#) link (#) reference count of a glue specication
dene stretch(#) mem[# + 2].sc the stretchability of this glob of glue
dene shrink (#) mem[# + 3].sc the shrinkability of this glob of glue
dene stretch order type order of innity for stretching
dene shrink order subtype order of innity for shrinking
dene l = 1 rst-order innity
dene ll = 2 second-order innity
dene lll = 3 third-order innity
Types in the outer block 18 +
glue ord = normal . . lll ; innity to the 0, 1, 2, or 3 power
151. Here is a function that returns a pointer to a copy of a glue spec. The reference count in the copy is
null , because there is assumed to be exactly one reference to the new specication.
function new spec(p : pointer ): pointer ; duplicates a glue specication
var q: pointer ; the new spec
begin q get node(glue spec size);
mem[q] mem[p]; glue ref count (q) null ;
width(q) width(p); stretch(q) stretch(p); shrink (q) shrink (p); new spec q;
end;
152. And heres a function that creates a glue node for a given parameter identied by its code number;
for example, new param glue(line skip code) returns a pointer to a glue node for the current \lineskip.
function new param glue(n : small number ): pointer ;
var p: pointer ; the new node
q: pointer ; the glue specication
begin p get node(small node size); type(p) glue node; subtype(p) n + 1; leader ptr (p) null ;
q Current mem equivalent of glue parameter number n 224 ; glue ptr (p) q;
incr (glue ref count (q)); new param glue p;
end;
153. Glue nodes that are more or less anonymous are created by new glue, whose argument points to a
glue specication.
function new glue(q : pointer ): pointer ;
var p: pointer ; the new node
begin p get node(small node size); type(p) glue node; subtype(p) normal ;
leader ptr (p) null ; glue ptr (p) q; incr (glue ref count (q)); new glue p;
end;
56 PART 10: DATA STRUCTURES FOR BOXES AND THEIR FRIENDS T
E
X82 154
154. Still another subroutine is needed: This one is sort of a combination of new param glue and new glue.
It creates a glue node for one of the current glue parameters, but it makes a fresh copy of the glue specication,
since that specication will probably be subject to change, while the parameter will stay put. The global
variable temp ptr is set to the address of the new spec.
function new skip param(n : small number ): pointer ;
var p: pointer ; the new node
begin temp ptr new spec( Current mem equivalent of glue parameter number n 224 );
p new glue(temp ptr ); glue ref count (temp ptr ) null ; subtype(p) n + 1; new skip param p;
end;
155. A kern node has a width eld to specify a (normally negative) amount of spacing. This spacing
correction appears in horizontal lists between letters like A and V when the font designer said that it looks
better to move them closer together or further apart. A kern node can also appear in a vertical list, when
its width denotes additional spacing in the vertical direction. The subtype is either normal (for kerns
inserted from font information or math mode calculations) or explicit (for kerns inserted from \kern and
\/ commands) or acc kern (for kerns inserted from non-math accents) or mu glue (for kerns inserted from
\mkern specications in math formulas).
dene kern node = 11 type of a kern node
dene explicit = 1 subtype of kern nodes from \kern and \/
dene acc kern = 2 subtype of kern nodes from accents
156. The new kern function creates a kern node having a given width.
function new kern(w : scaled ): pointer ;
var p: pointer ; the new node
begin p get node(small node size); type(p) kern node; subtype(p) normal ; width(p) w;
new kern p;
end;
157. A penalty node species the penalty associated with line or page breaking, in its penalty eld. This
eld is a fullword integer, but the full range of integer values is not used: Any penalty 10000 is treated
as innity, and no break will be allowed for such high values. Similarly, any penalty 10000 is treated as
negative innity, and a break will be forced.
dene penalty node = 12 type of a penalty node
dene inf penalty = inf bad innite penalty value
dene eject penalty = inf penalty negatively innite penalty value
dene penalty(#) mem[# + 1].int the added cost of breaking a list here
158. Anyone who has been reading the last few sections of the program will be able to guess what comes
next.
function new penalty(m : integer ): pointer ;
var p: pointer ; the new node
begin p get node(small node size); type(p) penalty node; subtype(p) 0;
the subtype is not used
penalty(p) m; new penalty p;
end;
159 T
E
X82 PART 10: DATA STRUCTURES FOR BOXES AND THEIR FRIENDS 57
159. You might think that we have introduced enough node types by now. Well, almost, but there is
one more: An unset node has nearly the same format as an hlist node or vlist node; it is used for entries
in \halign or \valign that are not yet in their nal form, since the box dimensions are their natural
sizes before any glue adjustment has been made. The glue set word is not present; instead, we have a
glue stretch eld, which contains the total stretch of order glue order that is present in the hlist or vlist
being boxed. Similarly, the shift amount eld is replaced by a glue shrink eld, containing the total shrink
of order glue sign that is present. The subtype eld is called span count ; an unset box typically contains
the data for qo(span count ) + 1 columns. Unset nodes will be changed to box nodes when alignment is
completed.
dene unset node = 13 type for an unset node
dene glue stretch(#) mem[# + glue oset ].sc total stretch in an unset node
dene glue shrink shift amount total shrink in an unset node
dene span count subtype indicates the number of spanned columns
160. In fact, there are still more types coming. When we get to math formula processing we will see that
a style node has type = 14; and a number of larger type codes will also be dened, for use in math mode
only.
161. Warning: If any changes are made to these data structure layouts, such as changing any of the node
sizes or even reordering the words of nodes, the copy node list procedure and the memory initialization code
below may have to be changed. Such potentially dangerous parts of the program are listed in the index
under data structure assumptions. However, other references to the nodes are made symbolically in terms
of the WEB macro denitions above, so that format changes will leave T
E
Xs other algorithms intact.
58 PART 11: MEMORY LAYOUT T
E
X82 162
162. Memory layout. Some areas of mem are dedicated to xed usage, since static allocation is
more ecient than dynamic allocation when we can get away with it. For example, locations mem bot
to mem bot + 3 are always used to store the specication for glue that is 0pt plus 0pt minus 0pt. The
following macro denitions accomplish the static allocation by giving symbolic names to the xed positions.
Static variable-size nodes appear in locations mem bot through lo mem stat max , and static single-word
nodes appear in locations hi mem stat min through mem top, inclusive. It is harmless to let lig trick and
garbage share the same location of mem.
dene zero glue mem bot specication for 0pt plus 0pt minus 0pt
dene l glue zero glue + glue spec size 0pt plus 1fil minus 0pt
dene ll glue l glue + glue spec size 0pt plus 1fill minus 0pt
dene ss glue ll glue + glue spec size 0pt plus 1fil minus 1fil
dene l neg glue ss glue + glue spec size 0pt plus 1fil minus 0pt
dene lo mem stat max l neg glue + glue spec size 1
largest statically allocated word in the variable-size mem
dene page ins head mem top list of insertion data for current page
dene contrib head mem top 1 vlist of items not yet on current page
dene page head mem top 2 vlist for current page
dene temp head mem top 3 head of a temporary list of some kind
dene hold head mem top 4 head of a temporary list of another kind
dene adjust head mem top 5 head of adjustment list returned by hpack
dene active mem top 7 head of active list in line break , needs two words
dene align head mem top 8 head of preamble list for alignments
dene end span mem top 9 tail of spanned-width lists
dene omit template mem top 10 a constant token list
dene null list mem top 11 permanently empty list
dene lig trick mem top 12 a ligature masquerading as a char node
dene garbage mem top 12 used for scrap information
dene backup head mem top 13 head of token list built by scan keyword
dene hi mem stat min mem top 13 smallest statically allocated word in the one-word mem
dene hi mem stat usage = 14 the number of one-word nodes always present
163. The following code gets mem o to a good start, when T
E
X is initializing itself the slow way.
Local variables for initialization 19 +
k: integer ; index into mem, eqtb, etc.
164 T
E
X82 PART 11: MEMORY LAYOUT 59
164. Initialize table entries (done by INITEX only) 164
for k mem bot + 1 to lo mem stat max do mem[k].sc 0; all glue dimensions are zeroed
k mem bot ; while k lo mem stat max do set rst words of glue specications
begin glue ref count (k) null + 1; stretch order (k) normal ; shrink order (k) normal ;
k k + glue spec size;
end;
stretch(l glue) unity; stretch order (l glue) l ;
stretch(ll glue) unity; stretch order (ll glue) ll ;
stretch(ss glue) unity; stretch order (ss glue) l ;
shrink (ss glue) unity; shrink order (ss glue) l ;
stretch(l neg glue) unity; stretch order (l neg glue) l ;
rover lo mem stat max + 1; link (rover ) empty ag ; now initialize the dynamic memory
node size(rover ) 1000; which is a 1000-word available node
llink (rover ) rover ; rlink (rover ) rover ;
lo mem max rover + 1000; link (lo mem max ) null ; info(lo mem max ) null ;
for k hi mem stat min to mem top do mem[k] mem[lo mem max ]; clear list heads
Initialize the special list heads and constant nodes 790 ;
avail null ; mem end mem top; hi mem min hi mem stat min;
initialize the one-word memory
var used lo mem stat max + 1 mem bot ; dyn used hi mem stat usage; initialize statistics
See also sections 222, 228, 232, 240, 250, 258, 552, 946, 951, 1216, 1301, and 1369.
This code is used in section 8.
165. If T
E
X is extended improperly, the mem array might get screwed up. For example, some pointers
might be wrong, or some dead nodes might not have been freed when the last reference to them disappeared.
Procedures check mem and search mem are available to help diagnose such problems. These procedures
make use of two arrays called free and was free that are present only if T
E
Xs debugging routines have been
included. (You may want to decrease the size of mem while you are debugging.)
Global variables 13 +
debug free: packed array [mem min . . mem max ] of boolean; free cells
was free: packed array [mem min . . mem max ] of boolean; previously free cells
was mem end , was lo max , was hi min: pointer ; previous mem end , lo mem max , and hi mem min
panicking : boolean; do we want to check memory constantly?
gubed
166. Set initial values of key variables 21 +
debug was mem end mem min; indicate that everything was previously free
was lo max mem min; was hi min mem max ; panicking false;
gubed
60 PART 11: MEMORY LAYOUT T
E
X82 167
167. Procedure check mem makes sure that the available space lists of mem are well formed, and it
optionally prints out all locations that are reserved now but were free the last time this procedure was
called.
debug procedure check mem(print locs : boolean);
label done1 , done2 ; loop exits
var p, q: pointer ; current locations of interest in mem
clobbered : boolean; is something amiss?
begin for p mem min to lo mem max do free[p] false; you can probably do this faster
for p hi mem min to mem end do free[p] false; ditto
Check single-word avail list 168 ;
Check variable-size avail list 169 ;
Check ags of unavailable nodes 170 ;
if print locs then Print newly busy locations 171 ;
for p mem min to lo mem max do was free[p] free[p];
for p hi mem min to mem end do was free[p] free[p]; was free free might be faster
was mem end mem end ; was lo max lo mem max ; was hi min hi mem min;
end;
gubed
168. Check single-word avail list 168
p avail ; q null ; clobbered false;
while p ,= null do
begin if (p > mem end ) (p < hi mem min) then clobbered true
else if free[p] then clobbered true;
if clobbered then
begin print nl ("AVAILlistclobberedat"); print int (q); goto done1 ;
end;
free[p] true; q p; p link (q);
end;
done1 :
This code is used in section 167.
169. Check variable-size avail list 169
p rover ; q null ; clobbered false;
repeat if (p lo mem max ) (p < mem min) then clobbered true
else if (rlink (p) lo mem max ) (rlink (p) < mem min) then clobbered true
else if (is empty(p)) (node size(p) < 2) (p + node size(p) > lo mem max )
(llink (rlink (p)) ,= p) then clobbered true;
if clobbered then
begin print nl ("DoubleAVAILlistclobberedat"); print int (q); goto done2 ;
end;
for q p to p + node size(p) 1 do mark all locations free
begin if free[q] then
begin print nl ("Doublyfreelocationat"); print int (q); goto done2 ;
end;
free[q] true;
end;
q p; p rlink (p);
until p = rover ;
done2 :
This code is used in section 167.
170 T
E
X82 PART 11: MEMORY LAYOUT 61
170. Check ags of unavailable nodes 170
p mem min;
while p lo mem max do node p should not be empty
begin if is empty(p) then
begin print nl ("Badflagat"); print int (p);
end;
while (p lo mem max ) free[p] do incr (p);
while (p lo mem max ) free[p] do incr (p);
end
This code is used in section 167.
171. Print newly busy locations 171
begin print nl ("Newbusylocs:");
for p mem min to lo mem max do
if free[p] ((p > was lo max ) was free[p]) then
begin print char (""); print int (p);
end;
for p hi mem min to mem end do
if free[p] ((p < was hi min) (p > was mem end ) was free[p]) then
begin print char (""); print int (p);
end;
end
This code is used in section 167.
172. The search mem procedure attempts to answer the question Who points to node p? In doing so, it
fetches link and info elds of mem that might not be of type two halves . Strictly speaking, this is undened
in Pascal, and it can lead to false drops (words that seem to point to p purely by coincidence). But for
debugging purposes, we want to rule out the places that do not point to p, so a few false drops are tolerable.
debug procedure search mem(p : pointer ); look for pointers to p
var q: integer ; current position being searched
begin for q mem min to lo mem max do
begin if link (q) = p then
begin print nl ("LINK("); print int (q); print char (")");
end;
if info(q) = p then
begin print nl ("INFO("); print int (q); print char (")");
end;
end;
for q hi mem min to mem end do
begin if link (q) = p then
begin print nl ("LINK("); print int (q); print char (")");
end;
if info(q) = p then
begin print nl ("INFO("); print int (q); print char (")");
end;
end;
Search eqtb for equivalents equal to p 255 ;
Search save stack for equivalents that point to p 285 ;
Search hyph list for pointers to p 933 ;
end;
gubed
62 PART 12: DISPLAYING BOXES T
E
X82 173
173. Displaying boxes. We can reinforce our knowledge of the data structures just introduced by
considering two procedures that display a list in symbolic form. The rst of these, called short display, is
used in overfull box messages to give the top-level description of a list. The other one, called show node list ,
prints a detailed description of exactly what is in the data structure.
The philosophy of short display is to ignore the ne points about exactly what is inside boxes, except that
ligatures and discretionary breaks are expanded. As a result, short display is a recursive procedure, but the
recursion is never more than one level deep.
A global variable font in short display keeps track of the font code that is assumed to be present when
short display begins; deviations from this font will be printed.
Global variables 13 +
font in short display: integer ; an internal font number
174. Boxes, rules, inserts, whatsits, marks, and things in general that are sort of complicated are
indicated only by printing [].
procedure short display(p : integer ); prints highlights of list p
var n: integer ; for replacement counts
begin while p > mem min do
begin if is char node(p) then
begin if p mem end then
begin if font (p) ,= font in short display then
begin if (font (p) < font base) (font (p) > font max ) then print char ("*")
else Print the font identier for font (p) 267 ;
print char (""); font in short display font (p);
end;
print ASCII (qo(character (p)));
end;
end
else Print a short indication of the contents of node p 175 ;
p link (p);
end;
end;
175. Print a short indication of the contents of node p 175
case type(p) of
hlist node, vlist node, ins node, whatsit node, mark node, adjust node, unset node: print ("[]");
rule node: print char ("|");
glue node: if glue ptr (p) ,= zero glue then print char ("");
math node: print char ("$");
ligature node: short display(lig ptr (p));
disc node: begin short display(pre break (p)); short display(post break (p));
n replace count (p);
while n > 0 do
begin if link (p) ,= null then p link (p);
decr (n);
end;
end;
othercases do nothing
endcases
This code is used in section 174.
176 T
E
X82 PART 12: DISPLAYING BOXES 63
176. The show node list routine requires some auxiliary subroutines: one to print a font-and-character
combination, one to print a token list without its reference count, and one to print a rule dimension.
procedure print font and char (p : integer ); prints char node data
begin if p > mem end then print esc("CLOBBERED.")
else begin if (font (p) < font base) (font (p) > font max ) then print char ("*")
else Print the font identier for font (p) 267 ;
print char (""); print ASCII (qo(character (p)));
end;
end;
procedure print mark (p : integer ); prints token list data in braces
begin print char ("{");
if (p < hi mem min) (p > mem end ) then print esc("CLOBBERED.")
else show token list (link (p), null , max print line 10);
print char ("}");
end;
procedure print rule dimen(d : scaled ); prints dimension in rule node
begin if is running (d) then print char ("*")
else print scaled (d);
end;
177. Then there is a subroutine that prints glue stretch and shrink, possibly followed by the name of nite
units:
procedure print glue(d : scaled ; order : integer ; s : str number ); prints a glue component
begin print scaled (d);
if (order < normal ) (order > lll ) then print ("foul")
else if order > normal then
begin print ("fil");
while order > l do
begin print char ("l"); decr (order );
end;
end
else if s ,= 0 then print (s);
end;
178. The next subroutine prints a whole glue specication.
procedure print spec(p : integer ; s : str number ); prints a glue specication
begin if (p < mem min) (p lo mem max ) then print char ("*")
else begin print scaled (width(p));
if s ,= 0 then print (s);
if stretch(p) ,= 0 then
begin print ("plus"); print glue(stretch(p), stretch order (p), s);
end;
if shrink (p) ,= 0 then
begin print ("minus"); print glue(shrink (p), shrink order (p), s);
end;
end;
end;
179. We also need to declare some procedures that appear later in this documentation.
Declare procedures needed for displaying the elements of mlists 691
Declare the procedure called print skip param 225
64 PART 12: DISPLAYING BOXES T
E
X82 180
180. Since boxes can be inside of boxes, show node list is inherently recursive, up to a given maximum
number of levels. The history of nesting is indicated by the current string, which will be printed at the
beginning of each line; the length of this string, namely cur length, is the depth of nesting.
Recursive calls on show node list therefore use the following pattern:
dene node list display(#)
begin append char ("."); show node list (#); ush char ;
end str room need not be checked; see show box below
181. A global variable called depth threshold is used to record the maximum depth of nesting for which
show node list will show information. If we have depth threshold = 0, for example, only the top level
information will be given and no sublists will be traversed. Another global variable, called breadth max , tells
the maximum number of items to show at each level; breadth max had better be positive, or you wont see
anything.
Global variables 13 +
depth threshold : integer ; maximum nesting depth in box displays
breadth max : integer ; maximum number of items shown at the same list level
182. Now we are ready for show node list itself. This procedure has been written to be extra robust in
the sense that it should not crash or get into a loop even if the data structures have been messed up by bugs
in the rest of the program. You can safely call its parent routine show box (p) for arbitrary values of p when
you are debugging T
E
X. However, in the presence of bad data, the procedure may fetch a memory word
whose variant is dierent from the way it was stored; for example, it might try to read mem[p].hh when
mem[p] contains a scaled integer, if p is a pointer that has been clobbered or chosen at random.
procedure show node list (p : integer ); prints a node list symbolically
label exit ;
var n: integer ; the number of items already printed at this level
g: real ; a glue ratio, as a oating point number
begin if cur length > depth threshold then
begin if p > null then print ("[]"); indicate that theres been some truncation
return;
end;
n 0;
while p > mem min do
begin print ln; print current string ; display the nesting history
if p > mem end then pointer out of range
begin print ("Badlink,displayaborted."); return;
end;
incr (n);
if n > breadth max then time to stop
begin print ("etc."); return;
end;
Display node p 183 ;
p link (p);
end;
exit : end;
183 T
E
X82 PART 12: DISPLAYING BOXES 65
183. Display node p 183
if is char node(p) then print font and char (p)
else case type(p) of
hlist node, vlist node, unset node: Display box p 184 ;
rule node: Display rule p 187 ;
ins node: Display insertion p 188 ;
whatsit node: Display the whatsit node p 1356 ;
glue node: Display glue p 189 ;
kern node: Display kern p 191 ;
math node: Display math node p 192 ;
ligature node: Display ligature p 193 ;
penalty node: Display penalty p 194 ;
disc node: Display discretionary p 195 ;
mark node: Display mark p 196 ;
adjust node: Display adjustment p 197 ;
Cases of show node list that arise in mlists only 690
othercases print ("Unknownnodetype!")
endcases
This code is used in section 182.
184. Display box p 184
begin if type(p) = hlist node then print esc("h")
else if type(p) = vlist node then print esc("v")
else print esc("unset");
print ("box("); print scaled (height (p)); print char ("+"); print scaled (depth(p)); print (")x");
print scaled (width(p));
if type(p) = unset node then Display special elds of the unset node p 185
else begin Display the value of glue set (p) 186 ;
if shift amount (p) ,= 0 then
begin print (",shifted"); print scaled (shift amount (p));
end;
end;
node list display(list ptr (p)); recursive call
end
This code is used in section 183.
185. Display special elds of the unset node p 185
begin if span count (p) ,= min quarterword then
begin print ("("); print int (qo(span count (p)) + 1); print ("columns)");
end;
if glue stretch(p) ,= 0 then
begin print (",stretch"); print glue(glue stretch(p), glue order (p), 0);
end;
if glue shrink (p) ,= 0 then
begin print (",shrink"); print glue(glue shrink (p), glue sign(p), 0);
end;
end
This code is used in section 184.
66 PART 12: DISPLAYING BOXES T
E
X82 186
186. The code will have to change in this place if glue ratio is a structured type instead of an ordinary real .
Note that this routine should avoid arithmetic errors even if the glue set eld holds an arbitrary random
value. The following code assumes that a properly formed nonzero real number has absolute value 2
20
or
more when it is regarded as an integer; this precaution was adequate to prevent oating point underow on
the authors computer.
Display the value of glue set (p) 186
g oat (glue set (p));
if (g ,= oat constant (0)) (glue sign(p) ,= normal ) then
begin print (",glueset");
if glue sign(p) = shrinking then print ("");
if abs (mem[p + glue oset ].int ) < 4000000 then print ("?.?")
else if abs (g) > oat constant (20000) then
begin if g > oat constant (0) then print char (">")
else print ("<");
print glue(20000 unity, glue order (p), 0);
end
else print glue(round (unity g), glue order (p), 0);
end
This code is used in section 184.
187. Display rule p 187
begin print esc("rule("); print rule dimen(height (p)); print char ("+"); print rule dimen(depth(p));
print (")x"); print rule dimen(width(p));
end
This code is used in section 183.
188. Display insertion p 188
begin print esc("insert"); print int (qo(subtype(p))); print (",naturalsize");
print scaled (height (p)); print (";split("); print spec(split top ptr (p), 0); print char (",");
print scaled (depth(p)); print (");floatcost"); print int (oat cost (p)); node list display(ins ptr (p));
recursive call
end
This code is used in section 183.
189. Display glue p 189
if subtype(p) a leaders then Display leaders p 190
else begin print esc("glue");
if subtype(p) ,= normal then
begin print char ("(");
if subtype(p) < cond math glue then print skip param(subtype(p) 1)
else if subtype(p) = cond math glue then print esc("nonscript")
else print esc("mskip");
print char (")");
end;
if subtype(p) ,= cond math glue then
begin print char ("");
if subtype(p) < cond math glue then print spec(glue ptr (p), 0)
else print spec(glue ptr (p), "mu");
end;
end
This code is used in section 183.
190 T
E
X82 PART 12: DISPLAYING BOXES 67
190. Display leaders p 190
begin print esc("");
if subtype(p) = c leaders then print char ("c")
else if subtype(p) = x leaders then print char ("x");
print ("leaders"); print spec(glue ptr (p), 0); node list display(leader ptr (p)); recursive call
end
This code is used in section 189.
191. An explicit kern value is indicated implicitly by an explicit space.
Display kern p 191
if subtype(p) ,= mu glue then
begin print esc("kern");
if subtype(p) ,= normal then print char ("");
print scaled (width(p));
if subtype(p) = acc kern then print ("(foraccent)");
end
else begin print esc("mkern"); print scaled (width(p)); print ("mu");
end
This code is used in section 183.
192. Display math node p 192
begin print esc("math");
if subtype(p) = before then print ("on")
else print ("off");
if width(p) ,= 0 then
begin print (",surrounded"); print scaled (width(p));
end;
end
This code is used in section 183.
193. Display ligature p 193
begin print font and char (lig char (p)); print ("(ligature");
if subtype(p) > 1 then print char ("|");
font in short display font (lig char (p)); short display(lig ptr (p));
if odd (subtype(p)) then print char ("|");
print char (")");
end
This code is used in section 183.
194. Display penalty p 194
begin print esc("penalty"); print int (penalty(p));
end
This code is used in section 183.
68 PART 12: DISPLAYING BOXES T
E
X82 195
195. The post break list of a discretionary node is indicated by a prexed | instead of the . before the
pre break list.
Display discretionary p 195
begin print esc("discretionary");
if replace count (p) > 0 then
begin print ("replacing"); print int (replace count (p));
end;
node list display(pre break (p)); recursive call
append char ("|"); show node list (post break (p)); ush char ; recursive call
end
This code is used in section 183.
196. Display mark p 196
begin print esc("mark"); print mark (mark ptr (p));
end
This code is used in section 183.
197. Display adjustment p 197
begin print esc("vadjust"); node list display(adjust ptr (p)); recursive call
end
This code is used in section 183.
198. The recursive machinery is started by calling show box .
procedure show box (p : pointer );
begin Assign the values depth threshold show box depth and breadth max show box breadth 236 ;
if breadth max 0 then breadth max 5;
if pool ptr + depth threshold pool size then depth threshold pool size pool ptr 1;
now theres enough room for prex string
show node list (p); the show starts at p
print ln;
end;
199 T
E
X82 PART 13: DESTROYING BOXES 69
199. Destroying boxes. When we are done with a node list, we are obliged to return it to free storage,
including all of its sublists. The recursive procedure ush node list does this for us.
200. First, however, we shall consider two non-recursive procedures that do simpler tasks. The rst of
these, delete token ref , is called when a pointer to a token lists reference count is being removed. This
means that the token list should disappear if the reference count was null , otherwise the count should be
decreased by one.
dene token ref count (#) info(#) reference count preceding a token list
procedure delete token ref (p : pointer );
p points to the reference count of a token list that is losing one reference
begin if token ref count (p) = null then ush list (p)
else decr (token ref count (p));
end;
201. Similarly, delete glue ref is called when a pointer to a glue specication is being withdrawn.
dene fast delete glue ref (#)
begin if glue ref count (#) = null then free node(#, glue spec size)
else decr (glue ref count (#));
end
procedure delete glue ref (p : pointer ); p points to a glue specication
fast delete glue ref (p);
70 PART 13: DESTROYING BOXES T
E
X82 202
202. Now we are ready to delete any node list, recursively. In practice, the nodes deleted are usually
charnodes (about 2/3 of the time), and they are glue nodes in about half of the remaining cases.
procedure ush node list (p : pointer ); erase list of nodes starting at p
label done; go here when node p has been freed
var q: pointer ; successor to node p
begin while p ,= null do
begin q link (p);
if is char node(p) then free avail (p)
else begin case type(p) of
hlist node, vlist node, unset node: begin ush node list (list ptr (p)); free node(p, box node size);
goto done;
end;
rule node: begin free node(p, rule node size); goto done;
end;
ins node: begin ush node list (ins ptr (p)); delete glue ref (split top ptr (p));
free node(p, ins node size); goto done;
end;
whatsit node: Wipe out the whatsit node p and goto done 1358 ;
glue node: begin fast delete glue ref (glue ptr (p));
if leader ptr (p) ,= null then ush node list (leader ptr (p));
end;
kern node, math node, penalty node: do nothing ;
ligature node: ush node list (lig ptr (p));
mark node: delete token ref (mark ptr (p));
disc node: begin ush node list (pre break (p)); ush node list (post break (p));
end;
adjust node: ush node list (adjust ptr (p));
Cases of ush node list that arise in mlists only 698
othercases confusion("flushing")
endcases;
free node(p, small node size);
done: end;
p q;
end;
end;
203 T
E
X82 PART 14: COPYING BOXES 71
203. Copying boxes. Another recursive operation that acts on boxes is sometimes needed: The proce-
dure copy node list returns a pointer to another node list that has the same structure and meaning as the
original. Note that since glue specications and token lists have reference counts, we need not make copies
of them. Reference counts can never get too large to t in a halfword, since each pointer to a node is in a
dierent memory address, and the total number of memory addresses ts in a halfword.
(Well, there actually are also references from outside mem; if the save stack is made arbitrarily large, it
would theoretically be possible to break T
E
X by overowing a reference count. But who would want to do
that?)
dene add token ref (#) incr (token ref count (#)) new reference to a token list
dene add glue ref (#) incr (glue ref count (#)) new reference to a glue spec
204. The copying procedure copies words en masse without bothering to look at their individual elds. If
the node format changesfor example, if the size is altered, or if some link eld is moved to another relative
positionthen this code may need to be changed too.
function copy node list (p : pointer ): pointer ;
makes a duplicate of the node list that starts at p and returns a pointer to the new list
var h: pointer ; temporary head of copied list
q: pointer ; previous position in new list
r: pointer ; current node being fabricated for new list
words : 0 . . 5; number of words remaining to be copied
begin h get avail ; q h;
while p ,= null do
begin Make a copy of node p in node r 205 ;
link (q) r; q r; p link (p);
end;
link (q) null ; q link (h); free avail (h); copy node list q;
end;
205. Make a copy of node p in node r 205
words 1; this setting occurs in more branches than any other
if is char node(p) then r get avail
else Case statement to copy dierent types and set words to the number of initial words not yet
copied 206 ;
while words > 0 do
begin decr (words ); mem[r + words ] mem[p + words ];
end
This code is used in section 204.
72 PART 14: COPYING BOXES T
E
X82 206
206. Case statement to copy dierent types and set words to the number of initial words not yet
copied 206
case type(p) of
hlist node, vlist node, unset node: begin r get node(box node size); mem[r + 6] mem[p + 6];
mem[r + 5] mem[p + 5]; copy the last two words
list ptr (r) copy node list (list ptr (p)); this aects mem[r + 5]
words 5;
end;
rule node: begin r get node(rule node size); words rule node size;
end;
ins node: begin r get node(ins node size); mem[r + 4] mem[p + 4]; add glue ref (split top ptr (p));
ins ptr (r) copy node list (ins ptr (p)); this aects mem[r + 4]
words ins node size 1;
end;
whatsit node: Make a partial copy of the whatsit node p and make r point to it; set words to the
number of initial words not yet copied 1357 ;
glue node: begin r get node(small node size); add glue ref (glue ptr (p)); glue ptr (r) glue ptr (p);
leader ptr (r) copy node list (leader ptr (p));
end;
kern node, math node, penalty node: begin r get node(small node size); words small node size;
end;
ligature node: begin r get node(small node size); mem[lig char (r)] mem[lig char (p)];
copy font and character
lig ptr (r) copy node list (lig ptr (p));
end;
disc node: begin r get node(small node size); pre break (r) copy node list (pre break (p));
post break (r) copy node list (post break (p));
end;
mark node: begin r get node(small node size); add token ref (mark ptr (p));
words small node size;
end;
adjust node: begin r get node(small node size); adjust ptr (r) copy node list (adjust ptr (p));
end; words = 1 = small node size 1
othercases confusion("copying")
endcases
This code is used in section 205.
207 T
E
X82 PART 15: THE COMMAND CODES 73
207. The command codes. Before we can go any further, we need to dene symbolic names for the
internal code numbers that represent the various commands obeyed by T
E
X. These codes are somewhat
arbitrary, but not completely so. For example, the command codes for character types are xed by the
language, since a user says, e.g., \catcode `\$ = 3 to make $ a math delimiter, and the command code
math shift is equal to 3. Some other codes have been made adjacent so that case statements in the program
need not consider cases that are widely spaced, or so that case statements can be replaced by if statements.
At any rate, here is the list, for future reference. First come the catcode commands, several of which
share their numeric codes with ordinary commands when the catcode cannot emerge from T
E
Xs scanning
routine.
dene escape = 0 escape delimiter (called \ in The T
E
Xbook)
dene relax = 0 do nothing ( \relax )
dene left brace = 1 beginning of a group ( { )
dene right brace = 2 ending of a group ( } )
dene math shift = 3 mathematics shift character ( $ )
dene tab mark = 4 alignment delimiter ( &, \span )
dene car ret = 5 end of line ( carriage return, \cr, \crcr )
dene out param = 5 output a macro parameter
dene mac param = 6 macro parameter symbol ( # )
dene sup mark = 7 superscript ( ^ )
dene sub mark = 8 subscript ( _ )
dene ignore = 9 characters to ignore ( ^^@ )
dene endv = 9 end of v
j
list in alignment template
dene spacer = 10 characters equivalent to blank space ( )
dene letter = 11 characters regarded as letters ( A..Z, a..z )
dene other char = 12 none of the special character types
dene active char = 13 characters that invoke macros ( ~ )
dene par end = 13 end of paragraph ( \par )
dene match = 13 match a macro parameter
dene comment = 14 characters that introduce comments ( % )
dene end match = 14 end of parameters to macro
dene stop = 14 end of job ( \end, \dump )
dene invalid char = 15 characters that shouldnt appear ( ^^? )
dene delim num = 15 specify delimiter numerically ( \delimiter )
dene max char code = 15 largest catcode for individual characters
74 PART 15: THE COMMAND CODES T
E
X82 208
208. Next are the ordinary run-of-the-mill command codes. Codes that are min internal or more represent
internal quantities that might be expanded by \the.
dene char num = 16 character specied numerically ( \char )
dene math char num = 17 explicit math code ( \mathchar )
dene mark = 18 mark denition ( \mark )
dene xray = 19 peek inside of T
E
X ( \show, \showbox, etc. )
dene make box = 20 make a box ( \box, \copy, \hbox, etc. )
dene hmove = 21 horizontal motion ( \moveleft, \moveright )
dene vmove = 22 vertical motion ( \raise, \lower )
dene un hbox = 23 unglue a box ( \unhbox, \unhcopy )
dene un vbox = 24 unglue a box ( \unvbox, \unvcopy )
dene remove item = 25 nullify last item ( \unpenalty, \unkern, \unskip )
dene hskip = 26 horizontal glue ( \hskip, \hfil, etc. )
dene vskip = 27 vertical glue ( \vskip, \vfil, etc. )
dene mskip = 28 math glue ( \mskip )
dene kern = 29 xed space ( \kern)
dene mkern = 30 math kern ( \mkern )
dene leader ship = 31 use a box ( \shipout, \leaders, etc. )
dene halign = 32 horizontal table alignment ( \halign )
dene valign = 33 vertical table alignment ( \valign )
dene no align = 34 temporary escape from alignment ( \noalign )
dene vrule = 35 vertical rule ( \vrule )
dene hrule = 36 horizontal rule ( \hrule )
dene insert = 37 vlist inserted in box ( \insert )
dene vadjust = 38 vlist inserted in enclosing paragraph ( \vadjust )
dene ignore spaces = 39 gobble spacer tokens ( \ignorespaces )
dene after assignment = 40 save till assignment is done ( \afterassignment )
dene after group = 41 save till group is done ( \aftergroup )
dene break penalty = 42 additional badness ( \penalty )
dene start par = 43 begin paragraph ( \indent, \noindent )
dene ital corr = 44 italic correction ( \/ )
dene accent = 45 attach accent in text ( \accent )
dene math accent = 46 attach accent in math ( \mathaccent )
dene discretionary = 47 discretionary texts ( \, \discretionary )
dene eq no = 48 equation number ( \eqno, \leqno )
dene left right = 49 variable delimiter ( \left, \right )
dene math comp = 50 component of formula ( \mathbin, etc. )
dene limit switch = 51 diddle limit conventions ( \displaylimits, etc. )
dene above = 52 generalized fraction ( \above, \atop, etc. )
dene math style = 53 style specication ( \displaystyle, etc. )
dene math choice = 54 choice specication ( \mathchoice )
dene non script = 55 conditional math glue ( \nonscript )
dene vcenter = 56 vertically center a vbox ( \vcenter )
dene case shift = 57 force specic case ( \lowercase, \uppercase )
dene message = 58 send to user ( \message, \errmessage )
dene extension = 59 extensions to T
E
X ( \write, \special, etc. )
dene in stream = 60 les for reading ( \openin, \closein )
dene begin group = 61 begin local grouping ( \begingroup )
dene end group = 62 end local grouping ( \endgroup )
dene omit = 63 omit alignment template ( \omit )
dene ex space = 64 explicit space ( \ )
dene no boundary = 65 suppress boundary ligatures ( \noboundary )
208 T
E
X82 PART 15: THE COMMAND CODES 75
dene radical = 66 square root and similar signs ( \radical )
dene end cs name = 67 end control sequence ( \endcsname )
dene min internal = 68 the smallest code that can follow \the
dene char given = 68 character code dened by \chardef
dene math given = 69 math code dened by \mathchardef
dene last item = 70 most recent item ( \lastpenalty, \lastkern, \lastskip )
dene max non prexed command = 70 largest command code that cant be \global
209. The next codes are special; they all relate to mode-independent assignment of values to T
E
Xs internal
registers or tables. Codes that are max internal or less represent internal quantities that might be expanded
by \the.
dene toks register = 71 token list register ( \toks )
dene assign toks = 72 special token list ( \output, \everypar, etc. )
dene assign int = 73 user-dened integer ( \tolerance, \day, etc. )
dene assign dimen = 74 user-dened length ( \hsize, etc. )
dene assign glue = 75 user-dened glue ( \baselineskip, etc. )
dene assign mu glue = 76 user-dened muglue ( \thinmuskip, etc. )
dene assign font dimen = 77 user-dened font dimension ( \fontdimen )
dene assign font int = 78 user-dened font integer ( \hyphenchar, \skewchar )
dene set aux = 79 specify state info ( \spacefactor, \prevdepth )
dene set prev graf = 80 specify state info ( \prevgraf )
dene set page dimen = 81 specify state info ( \pagegoal, etc. )
dene set page int = 82 specify state info ( \deadcycles, \insertpenalties )
dene set box dimen = 83 change dimension of box ( \wd, \ht, \dp )
dene set shape = 84 specify fancy paragraph shape ( \parshape )
dene def code = 85 dene a character code ( \catcode, etc. )
dene def family = 86 declare math fonts ( \textfont, etc. )
dene set font = 87 set current font ( font identiers )
dene def font = 88 dene a font le ( \font )
dene register = 89 internal register ( \count, \dimen, etc. )
dene max internal = 89 the largest code that can follow \the
dene advance = 90 advance a register or parameter ( \advance )
dene multiply = 91 multiply a register or parameter ( \multiply )
dene divide = 92 divide a register or parameter ( \divide )
dene prex = 93 qualify a denition ( \global, \long, \outer )
dene let = 94 assign a command code ( \let, \futurelet )
dene shorthand def = 95 code denition ( \chardef, \countdef, etc. )
dene read to cs = 96 read into a control sequence ( \read )
dene def = 97 macro denition ( \def, \gdef, \xdef, \edef )
dene set box = 98 set a box ( \setbox )
dene hyph data = 99 hyphenation data ( \hyphenation, \patterns )
dene set interaction = 100 dene level of interaction ( \batchmode, etc. )
dene max command = 100 the largest command code seen at big switch
76 PART 15: THE COMMAND CODES T
E
X82 210
210. The remaining command codes are extra special, since they cannot get through T
E
Xs scanner to the
main control routine. They have been given values higher than max command so that their special nature
is easily discernible. The expandable commands come rst.
dene undened cs = max command + 1 initial state of most eq type elds
dene expand after = max command + 2 special expansion ( \expandafter )
dene no expand = max command + 3 special nonexpansion ( \noexpand )
dene input = max command + 4 input a source le ( \input, \endinput )
dene if test = max command + 5 conditional text ( \if, \ifcase, etc. )
dene or else = max command + 6 delimiters for conditionals ( \else, etc. )
dene cs name = max command + 7 make a control sequence from tokens ( \csname )
dene convert = max command + 8 convert to text ( \number, \string, etc. )
dene the = max command + 9 expand an internal quantity ( \the )
dene top bot mark = max command + 10 inserted mark ( \topmark, etc. )
dene call = max command + 11 non-long, non-outer control sequence
dene long call = max command + 12 long, non-outer control sequence
dene outer call = max command + 13 non-long, outer control sequence
dene long outer call = max command + 14 long, outer control sequence
dene end template = max command + 15 end of an alignment template
dene dont expand = max command + 16 the following token was marked by \noexpand
dene glue ref = max command + 17 the equivalent points to a glue specication
dene shape ref = max command + 18 the equivalent points to a parshape specication
dene box ref = max command + 19 the equivalent points to a box node, or is null
dene data = max command + 20 the equivalent is simply a halfword number
211 T
E
X82 PART 16: THE SEMANTIC NEST 77
211. The semantic nest. T
E
X is typically in the midst of building many lists at once. For example,
when a math formula is being processed, T
E
X is in math mode and working on an mlist; this formula has
temporarily interrupted T
E
X from being in horizontal mode and building the hlist of a paragraph; and this
paragraph has temporarily interrupted T
E
X 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, T
E
X 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 T
E
Xs 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.
dene vmode = 1 vertical mode
dene hmode = vmode + max command + 1 horizontal mode
dene mmode = hmode + max command + 1 math mode
procedure print mode(m : integer ); prints the mode represented by m
begin if m > 0 then
case mdiv (max command + 1) of
0: print ("vertical");
1: print ("horizontal");
2: print ("displaymath");
end
else if m = 0 then print ("no")
else case (m) div (max command + 1) of
0: print ("internalvertical");
1: print ("restrictedhorizontal");
2: print ("math");
end;
print ("mode");
end;
78 PART 16: THE SEMANTIC NEST T
E
X82 212
212. The state of aairs at any semantic level can be represented by ve 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 rst element of the
list, or to null if the list is empty.
tail is a pointer to the nal 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 1000pt 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 and clang ; it holds the current
space factor used in spacing calculations, and the current language used for hyphenation. (The value of clang
is undened in restricted horizontal mode.) 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 users 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 users output routine.
In horizontal mode, the prev graf eld 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 Pascal record
that is ready to be pushed onto nest if necessary.
dene ignore depth 65536000 prev depth value that is ignored
Types in the outer block 18 +
list state record = record mode eld : mmode . . mmode; head eld , tail eld : pointer ;
pg eld , ml eld : integer ; aux eld : memory word ;
end;
213. dene mode cur list .mode eld current mode
dene head cur list .head eld header node of current list
dene tail cur list .tail eld nal node on current list
dene prev graf cur list .pg eld number of paragraph lines accumulated
dene aux cur list .aux eld auxiliary data about the current list
dene prev depth aux .sc the name of aux in vertical mode
dene space factor aux .hh.lh part of aux in horizontal mode
dene clang aux .hh.rh the other part of aux in horizontal mode
dene incompleat noad aux .int the name of aux in math mode
dene mode line cur list .ml eld source le line number at beginning of list
Global variables 13 +
nest : array [0 . . nest size] of list state record ;
nest ptr : 0 . . nest size; rst unused location of nest
max nest stack : 0 . . nest size; maximum of nest ptr when pushing
cur list : list state record ; the top semantic state
shown mode: mmode . . mmode; most recent mode shown by \tracingcommands
214. Here is a common way to make the current list grow:
dene tail append (#)
begin link (tail ) #; tail link (tail );
end
215 T
E
X82 PART 16: THE SEMANTIC NEST 79
215. 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 rst formed in vertical mode, then contributed to the current
page (during which time the page-breaking decisions are made). For now, we dont need to know any more
details about the page-building process.
Set initial values of key variables 21 +
nest ptr 0; max nest stack 0; mode vmode; head contrib head ; tail contrib head ;
prev depth ignore depth; mode line 0; prev graf 0; shown mode 0;
Start a new current page 991 ;
216. When T
E
Xs 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 .
procedure push nest ; enter a new semantic level, save the old
begin if nest ptr > max nest stack then
begin max nest stack nest ptr ;
if nest ptr = nest size then overow("semanticnestsize", nest size);
end;
nest [nest ptr ] cur list ; stack the record
incr (nest ptr ); head get avail ; tail head ; prev graf 0; mode line line;
end;
217. Conversely, when T
E
X is nished 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.
procedure pop nest ; leave a semantic level, re-enter the old
begin free avail (head ); decr (nest ptr ); cur list nest [nest ptr ];
end;
80 PART 16: THE SEMANTIC NEST T
E
X82 218
218. Here is a procedure that displays what T
E
X is working on, at all levels.
procedure print totals ; forward ;
procedure show activities ;
var p: 0 . . nest size; index into nest
m: mmode . . mmode; mode
a: memory word ; auxiliary
q, r: pointer ; for showing the current page
t: integer ; ditto
begin nest [nest ptr ] cur list ; put the top level into the array
print nl (""); print ln;
for p nest ptr downto 0 do
begin m nest [p].mode eld ; a nest [p].aux eld ; print nl ("###"); print mode(m);
print ("enteredatline"); print int (abs (nest [p].ml eld ));
if m = hmode then
if nest [p].pg eld ,= 40600000 then
begin print ("(language"); print int (nest [p].pg eld mod 200000 ); print (":hyphenmin");
print int (nest [p].pg eld div 20000000 ); print char (",");
print int ((nest [p].pg eld div 200000 ) mod 100 ); print char (")");
end;
if nest [p].ml eld < 0 then print ("(\outputroutine)");
if p = 0 then
begin Show the status of the current page 986 ;
if link (contrib head ) ,= null then print nl ("###recentcontributions:");
end;
show box (link (nest [p].head eld )); Show the auxiliary eld, a 219 ;
end;
end;
219. Show the auxiliary eld, a 219
case abs (m) div (max command + 1) of
0: begin print nl ("prevdepth");
if a.sc ignore depth then print ("ignored")
else print scaled (a.sc);
if nest [p].pg eld ,= 0 then
begin print (",prevgraf"); print int (nest [p].pg eld ); print ("line");
if nest [p].pg eld ,= 1 then print char ("s");
end;
end;
1: begin print nl ("spacefactor"); print int (a.hh.lh);
if m > 0 then if a.hh.rh > 0 then
begin print (",currentlanguage"); print int (a.hh.rh); end;
end;
2: if a.int ,= null then
begin print ("thiswillbedenominatorof:"); show box (a.int ); end;
end there are no other cases
This code is used in section 218.
220 T
E
X82 PART 17: THE TABLE OF EQUIVALENTS 81
220. The table of equivalents. Now that we have studied the data structures for T
E
Xs semantic
routines, we ought to consider the data structures used by its syntactic routines. In other words, our next
concern will be the tables that T
E
X looks at when it is scanning what the user has written.
The biggest and most important such table is called eqtb. It holds the current equivalents of things;
i.e., it explains what things mean or what their current values are, for all quantities that are subject to the
nesting structure provided by T
E
Xs grouping mechanism. There are six parts to eqtb:
1) eqtb[active base . . (hash base 1)] holds the current equivalents of single-character control sequences.
2) eqtb[hash base . . (glue base 1)] holds the current equivalents of multiletter control sequences.
3) eqtb[glue base . . (local base 1)] holds the current equivalents of glue parameters like the current
baselineskip.
4) eqtb[local base . . (int base 1)] holds the current equivalents of local halfword quantities like the current
box registers, the current catcodes, the current font, and a pointer to the current paragraph shape.
5) eqtb[int base . . (dimen base 1)] holds the current equivalents of fullword integer parameters like the
current hyphenation penalty.
6) eqtb[dimen base . . eqtb size] holds the current equivalents of fullword dimension parameters like the
current hsize or amount of hanging indentation.
Note that, for example, the current amount of baselineskip glue is determined by the setting of a particular
location in region 3 of eqtb, while the current meaning of the control sequence \baselineskip (which might
have been changed by \def or \let) appears in region 2.
221. Each entry in eqtb is a memory word . Most of these words are of type two halves , and subdivided
into three elds:
1) The eq level (a quarterword) is the level of grouping at which this equivalent was dened. If the level
is level zero, the equivalent has never been dened; level one refers to the outer level (outside of all
groups), and this level is also used for global denitions that never go away. Higher levels are for
equivalents that will disappear at the end of their group.
2) The eq type (another quarterword) species what kind of entry this is. There are many types, since each
T
E
X primitive like \hbox, \def, etc., has its own special code. The list of command codes above
includes all possible settings of the eq type eld.
3) The equiv (a halfword) is the current equivalent value. This may be a font number, a pointer into mem,
or a variety of other things.
dene eq level eld (#) #.hh.b1
dene eq type eld (#) #.hh.b0
dene equiv eld (#) #.hh.rh
dene eq level (#) eq level eld (eqtb[#]) level of denition
dene eq type(#) eq type eld (eqtb[#]) command code for equivalent
dene equiv (#) equiv eld (eqtb[#]) equivalent value
dene level zero = min quarterword level for undened quantities
dene level one = level zero + 1 outermost level for dened quantities
82 PART 17: THE TABLE OF EQUIVALENTS T
E
X82 222
222. Many locations in eqtb have symbolic names. The purpose of the next paragraphs is to dene these
names, and to set up the initial values of the equivalents.
In the rst region we have 256 equivalents for active characters that act as control sequences, followed
by 256 equivalents for single-character control sequences.
Then comes region 2, which corresponds to the hash table that we will dene later. The maximum address
in this region is used for a dummy control sequence that is perpetually undened. There also are several
locations for control sequences that are perpetually dened (since they are used in error recovery).
dene active base = 1 beginning of region 1, for active character equivalents
dene single base = active base + 256 equivalents of one-character control sequences
dene null cs = single base + 256 equivalent of \csname\endcsname
dene hash base = null cs + 1 beginning of region 2, for the hash table
dene frozen control sequence = hash base + hash size for error recovery
dene frozen protection = frozen control sequence inaccessible but denable
dene frozen cr = frozen control sequence + 1 permanent \cr
dene frozen end group = frozen control sequence + 2 permanent \endgroup
dene frozen right = frozen control sequence + 3 permanent \right
dene frozen = frozen control sequence + 4 permanent \fi
dene frozen end template = frozen control sequence + 5 permanent \endtemplate
dene frozen endv = frozen control sequence + 6 second permanent \endtemplate
dene frozen relax = frozen control sequence + 7 permanent \relax
dene end write = frozen control sequence + 8 permanent \endwrite
dene frozen dont expand = frozen control sequence + 9 permanent \notexpanded:
dene frozen null font = frozen control sequence + 10 permanent \nullfont
dene font id base = frozen null font font base begins table of 257 permanent font identiers
dene undened control sequence = frozen null font + 257 dummy location
dene glue base = undened control sequence + 1 beginning of region 3
Initialize table entries (done by INITEX only) 164 +
eq type(undened control sequence) undened cs ; equiv (undened control sequence) null ;
eq level (undened control sequence) level zero;
for k active base to undened control sequence 1 do eqtb[k] eqtb[undened control sequence];
223. Here is a routine that displays the current meaning of an eqtb entry in region 1 or 2. (Similar routines
for the other regions will appear below.)
Show equivalent n, in region 1 or 2 223
begin sprint cs (n); print char ("="); print cmd chr (eq type(n), equiv (n));
if eq type(n) call then
begin print char (":"); show token list (link (equiv (n)), null , 32);
end;
end
This code is used in section 252.
224 T
E
X82 PART 17: THE TABLE OF EQUIVALENTS 83
224. Region 3 of eqtb contains the 256 \skip registers, as well as the glue parameters dened here. It is
important that the muskip parameters have larger numbers than the others.
dene line skip code = 0 interline glue if baseline skip is infeasible
dene baseline skip code = 1 desired glue between baselines
dene par skip code = 2 extra glue just above a paragraph
dene above display skip code = 3 extra glue just above displayed math
dene below display skip code = 4 extra glue just below displayed math
dene above display short skip code = 5 glue above displayed math following short lines
dene below display short skip code = 6 glue below displayed math following short lines
dene left skip code = 7 glue at left of justied lines
dene right skip code = 8 glue at right of justied lines
dene top skip code = 9 glue at top of main pages
dene split top skip code = 10 glue at top of split pages
dene tab skip code = 11 glue between aligned entries
dene space skip code = 12 glue between words (if not zero glue)
dene xspace skip code = 13 glue after sentences (if not zero glue)
dene par ll skip code = 14 glue on last line of paragraph
dene thin mu skip code = 15 thin space in math formula
dene med mu skip code = 16 medium space in math formula
dene thick mu skip code = 17 thick space in math formula
dene glue pars = 18 total number of glue parameters
dene skip base = glue base + glue pars table of 256 skip registers
dene mu skip base = skip base + 256 table of 256 muskip registers
dene local base = mu skip base + 256 beginning of region 4
dene skip(#) equiv (skip base + #) mem location of glue specication
dene mu skip(#) equiv (mu skip base + #) mem location of math glue spec
dene glue par (#) equiv (glue base + #) mem location of glue specication
dene line skip glue par (line skip code)
dene baseline skip glue par (baseline skip code)
dene par skip glue par (par skip code)
dene above display skip glue par (above display skip code)
dene below display skip glue par (below display skip code)
dene above display short skip glue par (above display short skip code)
dene below display short skip glue par (below display short skip code)
dene left skip glue par (left skip code)
dene right skip glue par (right skip code)
dene top skip glue par (top skip code)
dene split top skip glue par (split top skip code)
dene tab skip glue par (tab skip code)
dene space skip glue par (space skip code)
dene xspace skip glue par (xspace skip code)
dene par ll skip glue par (par ll skip code)
dene thin mu skip glue par (thin mu skip code)
dene med mu skip glue par (med mu skip code)
dene thick mu skip glue par (thick mu skip code)
Current mem equivalent of glue parameter number n 224
glue par (n)
This code is used in sections 152 and 154.
84 PART 17: THE TABLE OF EQUIVALENTS T
E
X82 225
225. Sometimes we need to convert T
E
Xs internal code numbers into symbolic form. The print skip param
routine gives the symbolic name of a glue parameter.
Declare the procedure called print skip param 225
procedure print skip param(n : integer );
begin case n of
line skip code: print esc("lineskip");
baseline skip code: print esc("baselineskip");
par skip code: print esc("parskip");
above display skip code: print esc("abovedisplayskip");
below display skip code: print esc("belowdisplayskip");
above display short skip code: print esc("abovedisplayshortskip");
below display short skip code: print esc("belowdisplayshortskip");
left skip code: print esc("leftskip");
right skip code: print esc("rightskip");
top skip code: print esc("topskip");
split top skip code: print esc("splittopskip");
tab skip code: print esc("tabskip");
space skip code: print esc("spaceskip");
xspace skip code: print esc("xspaceskip");
par ll skip code: print esc("parfillskip");
thin mu skip code: print esc("thinmuskip");
med mu skip code: print esc("medmuskip");
thick mu skip code: print esc("thickmuskip");
othercases print ("[unknownglueparameter!]")
endcases;
end;
This code is used in section 179.
226 T
E
X82 PART 17: THE TABLE OF EQUIVALENTS 85
226. The symbolic names for glue parameters are put into T
E
Xs hash table by using the routine called
primitive, dened below. Let us enter them now, so that we dont have to list all those parameter names
anywhere else.
Put each of T
E
Xs primitives into the hash table 226
primitive("lineskip", assign glue, glue base + line skip code);
primitive("baselineskip", assign glue, glue base + baseline skip code);
primitive("parskip", assign glue, glue base + par skip code);
primitive("abovedisplayskip", assign glue, glue base + above display skip code);
primitive("belowdisplayskip", assign glue, glue base + below display skip code);
primitive("abovedisplayshortskip", assign glue, glue base + above display short skip code);
primitive("belowdisplayshortskip", assign glue, glue base + below display short skip code);
primitive("leftskip", assign glue, glue base + left skip code);
primitive("rightskip", assign glue, glue base + right skip code);
primitive("topskip", assign glue, glue base + top skip code);
primitive("splittopskip", assign glue, glue base + split top skip code);
primitive("tabskip", assign glue, glue base + tab skip code);
primitive("spaceskip", assign glue, glue base + space skip code);
primitive("xspaceskip", assign glue, glue base + xspace skip code);
primitive("parfillskip", assign glue, glue base + par ll skip code);
primitive("thinmuskip", assign mu glue, glue base + thin mu skip code);
primitive("medmuskip", assign mu glue, glue base + med mu skip code);
primitive("thickmuskip", assign mu glue, glue base + thick mu skip code);
See also sections 230, 238, 248, 265, 334, 376, 384, 411, 416, 468, 487, 491, 553, 780, 983, 1052, 1058, 1071, 1088, 1107, 1114,
1141, 1156, 1169, 1178, 1188, 1208, 1219, 1222, 1230, 1250, 1254, 1262, 1272, 1277, 1286, 1291, and 1344.
This code is used in section 1336.
227. Cases of print cmd chr for symbolic printing of primitives 227
assign glue, assign mu glue: if chr code < skip base then print skip param(chr code glue base)
else if chr code < mu skip base then
begin print esc("skip"); print int (chr code skip base);
end
else begin print esc("muskip"); print int (chr code mu skip base);
end;
See also sections 231, 239, 249, 266, 335, 377, 385, 412, 417, 469, 488, 492, 781, 984, 1053, 1059, 1072, 1089, 1108, 1115, 1143,
1157, 1170, 1179, 1189, 1209, 1220, 1223, 1231, 1251, 1255, 1261, 1263, 1273, 1278, 1287, 1292, 1295, and 1346.
This code is used in section 298.
228. All glue parameters and registers are initially 0pt plus0pt minus0pt.
Initialize table entries (done by INITEX only) 164 +
equiv (glue base) zero glue; eq level (glue base) level one; eq type(glue base) glue ref ;
for k glue base + 1 to local base 1 do eqtb[k] eqtb[glue base];
glue ref count (zero glue) glue ref count (zero glue) + local base glue base;
86 PART 17: THE TABLE OF EQUIVALENTS T
E
X82 229
229. Show equivalent n, in region 3 229
if n < skip base then
begin print skip param(n glue base); print char ("=");
if n < glue base + thin mu skip code then print spec(equiv (n), "pt")
else print spec(equiv (n), "mu");
end
else if n < mu skip base then
begin print esc("skip"); print int (n skip base); print char ("="); print spec(equiv (n), "pt");
end
else begin print esc("muskip"); print int (n mu skip base); print char ("=");
print spec(equiv (n), "mu");
end
This code is used in section 252.
230 T
E
X82 PART 17: THE TABLE OF EQUIVALENTS 87
230. Region 4 of eqtb contains the local quantities dened here. The bulk of this region is taken up by
ve tables that are indexed by eight-bit characters; these tables are important to both the syntactic and
semantic portions of T
E
X. There are also a bunch of special things like font and token parameters, as well
as the tables of \toks and \box registers.
dene par shape loc = local base species paragraph shape
dene output routine loc = local base + 1 points to token list for \output
dene every par loc = local base + 2 points to token list for \everypar
dene every math loc = local base + 3 points to token list for \everymath
dene every display loc = local base + 4 points to token list for \everydisplay
dene every hbox loc = local base + 5 points to token list for \everyhbox
dene every vbox loc = local base + 6 points to token list for \everyvbox
dene every job loc = local base + 7 points to token list for \everyjob
dene every cr loc = local base + 8 points to token list for \everycr
dene err help loc = local base + 9 points to token list for \errhelp
dene toks base = local base + 10 table of 256 token list registers
dene box base = toks base + 256 table of 256 box registers
dene cur font loc = box base + 256 internal font number outside math mode
dene math font base = cur font loc + 1 table of 48 math font numbers
dene cat code base = math font base + 48 table of 256 command codes (the catcodes)
dene lc code base = cat code base + 256 table of 256 lowercase mappings
dene uc code base = lc code base + 256 table of 256 uppercase mappings
dene sf code base = uc code base + 256 table of 256 spacefactor mappings
dene math code base = sf code base + 256 table of 256 math mode mappings
dene int base = math code base + 256 beginning of region 5
dene par shape ptr equiv (par shape loc)
dene output routine equiv (output routine loc)
dene every par equiv (every par loc)
dene every math equiv (every math loc)
dene every display equiv (every display loc)
dene every hbox equiv (every hbox loc)
dene every vbox equiv (every vbox loc)
dene every job equiv (every job loc)
dene every cr equiv (every cr loc)
dene err help equiv (err help loc)
dene toks (#) equiv (toks base + #)
dene box (#) equiv (box base + #)
dene cur font equiv (cur font loc)
dene fam fnt (#) equiv (math font base + #)
dene cat code(#) equiv (cat code base + #)
dene lc code(#) equiv (lc code base + #)
dene uc code(#) equiv (uc code base + #)
dene sf code(#) equiv (sf code base + #)
dene math code(#) equiv (math code base + #)
Note: math code(c) is the true math code plus min halfword
Put each of T
E
Xs primitives into the hash table 226 +
primitive("output", assign toks , output routine loc); primitive("everypar", assign toks , every par loc);
primitive("everymath", assign toks , every math loc);
primitive("everydisplay", assign toks , every display loc);
primitive("everyhbox", assign toks , every hbox loc); primitive("everyvbox", assign toks , every vbox loc);
primitive("everyjob", assign toks , every job loc); primitive("everycr", assign toks , every cr loc);
primitive("errhelp", assign toks , err help loc);
88 PART 17: THE TABLE OF EQUIVALENTS T
E
X82 231
231. Cases of print cmd chr for symbolic printing of primitives 227 +
assign toks : if chr code toks base then
begin print esc("toks"); print int (chr code toks base);
end
else case chr code of
output routine loc: print esc("output");
every par loc: print esc("everypar");
every math loc: print esc("everymath");
every display loc: print esc("everydisplay");
every hbox loc: print esc("everyhbox");
every vbox loc: print esc("everyvbox");
every job loc: print esc("everyjob");
every cr loc: print esc("everycr");
othercases print esc("errhelp")
endcases;
232. We initialize most things to null or undened values. An undened font is represented by the internal
code font base.
However, the character code tables are given initial values based on the conventional interpretation of
ASCII code. These initial values should not be changed when T
E
X is adapted for use with non-English
languages; all changes to the initialization conventions should be made in format packages, not in T
E
X itself,
so that global interchange of formats is possible.
dene null font font base
dene var code 70000 math code meaning use the current family
Initialize table entries (done by INITEX only) 164 +
par shape ptr null ; eq type(par shape loc) shape ref ; eq level (par shape loc) level one;
for k output routine loc to toks base + 255 do eqtb[k] eqtb[undened control sequence];
box (0) null ; eq type(box base) box ref ; eq level (box base) level one;
for k box base + 1 to box base + 255 do eqtb[k] eqtb[box base];
cur font null font ; eq type(cur font loc) data; eq level (cur font loc) level one;
for k math font base to math font base + 47 do eqtb[k] eqtb[cur font loc];
equiv (cat code base) 0; eq type(cat code base) data; eq level (cat code base) level one;
for k cat code base + 1 to int base 1 do eqtb[k] eqtb[cat code base];
for k 0 to 255 do
begin cat code(k) other char ; math code(k) hi (k); sf code(k) 1000;
end;
cat code(carriage return) car ret ; cat code("") spacer ; cat code("\") escape;
cat code("%") comment ; cat code(invalid code) invalid char ; cat code(null code) ignore;
for k "0" to "9" do math code(k) hi (k + var code);
for k "A" to "Z" do
begin cat code(k) letter ; cat code(k + "a" "A") letter ;
math code(k) hi (k + var code + 100);
math code(k + "a" "A") hi (k + "a" "A" + var code + 100);
lc code(k) k + "a" "A"; lc code(k + "a" "A") k + "a" "A";
uc code(k) k; uc code(k + "a" "A") k;
sf code(k) 999;
end;
233 T
E
X82 PART 17: THE TABLE OF EQUIVALENTS 89
233. Show equivalent n, in region 4 233
if n = par shape loc then
begin print esc("parshape"); print char ("=");
if par shape ptr = null then print char ("0")
else print int (info(par shape ptr ));
end
else if n < toks base then
begin print cmd chr (assign toks , n); print char ("=");
if equiv (n) ,= null then show token list (link (equiv (n)), null , 32);
end
else if n < box base then
begin print esc("toks"); print int (n toks base); print char ("=");
if equiv (n) ,= null then show token list (link (equiv (n)), null , 32);
end
else if n < cur font loc then
begin print esc("box"); print int (n box base); print char ("=");
if equiv (n) = null then print ("void")
else begin depth threshold 0; breadth max 1; show node list (equiv (n));
end;
end
else if n < cat code base then Show the font identier in eqtb[n] 234
else Show the halfword code in eqtb[n] 235
This code is used in section 252.
234. Show the font identier in eqtb[n] 234
begin if n = cur font loc then print ("currentfont")
else if n < math font base + 16 then
begin print esc("textfont"); print int (n math font base);
end
else if n < math font base + 32 then
begin print esc("scriptfont"); print int (n math font base 16);
end
else begin print esc("scriptscriptfont"); print int (n math font base 32);
end;
print char ("=");
print esc(hash[font id base + equiv (n)].rh); thats font id text (equiv (n))
end
This code is used in section 233.
90 PART 17: THE TABLE OF EQUIVALENTS T
E
X82 235
235. Show the halfword code in eqtb[n] 235
if n < math code base then
begin if n < lc code base then
begin print esc("catcode"); print int (n cat code base);
end
else if n < uc code base then
begin print esc("lccode"); print int (n lc code base);
end
else if n < sf code base then
begin print esc("uccode"); print int (n uc code base);
end
else begin print esc("sfcode"); print int (n sf code base);
end;
print char ("="); print int (equiv (n));
end
else begin print esc("mathcode"); print int (n math code base); print char ("=");
print int (ho(equiv (n)));
end
This code is used in section 233.
236 T
E
X82 PART 17: THE TABLE OF EQUIVALENTS 91
236. Region 5 of eqtb contains the integer parameters and registers dened here, as well as the del code
table. The latter table diers from the cat code . . math code tables that precede it, since delimiter codes
are fullword integers while the other kinds of codes occupy at most a halfword. This is what makes region 5
dierent from region 4. We will store the eq level information in an auxiliary array of quarterwords that will
be dened later.
dene pretolerance code = 0 badness tolerance before hyphenation
dene tolerance code = 1 badness tolerance after hyphenation
dene line penalty code = 2 added to the badness of every line
dene hyphen penalty code = 3 penalty for break after discretionary hyphen
dene ex hyphen penalty code = 4 penalty for break after explicit hyphen
dene club penalty code = 5 penalty for creating a club line
dene widow penalty code = 6 penalty for creating a widow line
dene display widow penalty code = 7 ditto, just before a display
dene broken penalty code = 8 penalty for breaking a page at a broken line
dene bin op penalty code = 9 penalty for breaking after a binary operation
dene rel penalty code = 10 penalty for breaking after a relation
dene pre display penalty code = 11 penalty for breaking just before a displayed formula
dene post display penalty code = 12 penalty for breaking just after a displayed formula
dene inter line penalty code = 13 additional penalty between lines
dene double hyphen demerits code = 14 demerits for double hyphen break
dene nal hyphen demerits code = 15 demerits for nal hyphen break
dene adj demerits code = 16 demerits for adjacent incompatible lines
dene mag code = 17 magnication ratio
dene delimiter factor code = 18 ratio for variable-size delimiters
dene looseness code = 19 change in number of lines for a paragraph
dene time code = 20 current time of day
dene day code = 21 current day of the month
dene month code = 22 current month of the year
dene year code = 23 current year of our Lord
dene show box breadth code = 24 nodes per level in show box
dene show box depth code = 25 maximum level in show box
dene hbadness code = 26 hboxes exceeding this badness will be shown by hpack
dene vbadness code = 27 vboxes exceeding this badness will be shown by vpack
dene pausing code = 28 pause after each line is read from a le
dene tracing online code = 29 show diagnostic output on terminal
dene tracing macros code = 30 show macros as they are being expanded
dene tracing stats code = 31 show memory usage if T
E
X knows it
dene tracing paragraphs code = 32 show line-break calculations
dene tracing pages code = 33 show page-break calculations
dene tracing output code = 34 show boxes when they are shipped out
dene tracing lost chars code = 35 show characters that arent in the font
dene tracing commands code = 36 show command codes at big switch
dene tracing restores code = 37 show equivalents when they are restored
dene uc hyph code = 38 hyphenate words beginning with a capital letter
dene output penalty code = 39 penalty found at current page break
dene max dead cycles code = 40 bound on consecutive dead cycles of output
dene hang after code = 41 hanging indentation changes after this many lines
dene oating penalty code = 42 penalty for insertions heldover after a split
dene global defs code = 43 override \global specications
dene cur fam code = 44 current family
dene escape char code = 45 escape character for token output
dene default hyphen char code = 46 value of \hyphenchar when a font is loaded
92 PART 17: THE TABLE OF EQUIVALENTS T
E
X82 236
dene default skew char code = 47 value of \skewchar when a font is loaded
dene end line char code = 48 character placed at the right end of the buer
dene new line char code = 49 character that prints as print ln
dene language code = 50 current hyphenation table
dene left hyphen min code = 51 minimum left hyphenation fragment size
dene right hyphen min code = 52 minimum right hyphenation fragment size
dene holding inserts code = 53 do not remove insertion nodes from \box255
dene error context lines code = 54 maximum intermediate line pairs shown
dene int pars = 55 total number of integer parameters
dene count base = int base + int pars 256 user \count registers
dene del code base = count base + 256 256 delimiter code mappings
dene dimen base = del code base + 256 beginning of region 6
dene del code(#) eqtb[del code base + #].int
dene count (#) eqtb[count base + #].int
dene int par (#) eqtb[int base + #].int an integer parameter
dene pretolerance int par (pretolerance code)
dene tolerance int par (tolerance code)
dene line penalty int par (line penalty code)
dene hyphen penalty int par (hyphen penalty code)
dene ex hyphen penalty int par (ex hyphen penalty code)
dene club penalty int par (club penalty code)
dene widow penalty int par (widow penalty code)
dene display widow penalty int par (display widow penalty code)
dene broken penalty int par (broken penalty code)
dene bin op penalty int par (bin op penalty code)
dene rel penalty int par (rel penalty code)
dene pre display penalty int par (pre display penalty code)
dene post display penalty int par (post display penalty code)
dene inter line penalty int par (inter line penalty code)
dene double hyphen demerits int par (double hyphen demerits code)
dene nal hyphen demerits int par (nal hyphen demerits code)
dene adj demerits int par (adj demerits code)
dene mag int par (mag code)
dene delimiter factor int par (delimiter factor code)
dene looseness int par (looseness code)
dene time int par (time code)
dene day int par (day code)
dene month int par (month code)
dene year int par (year code)
dene show box breadth int par (show box breadth code)
dene show box depth int par (show box depth code)
dene hbadness int par (hbadness code)
dene vbadness int par (vbadness code)
dene pausing int par (pausing code)
dene tracing online int par (tracing online code)
dene tracing macros int par (tracing macros code)
dene tracing stats int par (tracing stats code)
dene tracing paragraphs int par (tracing paragraphs code)
dene tracing pages int par (tracing pages code)
dene tracing output int par (tracing output code)
dene tracing lost chars int par (tracing lost chars code)
dene tracing commands int par (tracing commands code)
236 T
E
X82 PART 17: THE TABLE OF EQUIVALENTS 93
dene tracing restores int par (tracing restores code)
dene uc hyph int par (uc hyph code)
dene output penalty int par (output penalty code)
dene max dead cycles int par (max dead cycles code)
dene hang after int par (hang after code)
dene oating penalty int par (oating penalty code)
dene global defs int par (global defs code)
dene cur fam int par (cur fam code)
dene escape char int par (escape char code)
dene default hyphen char int par (default hyphen char code)
dene default skew char int par (default skew char code)
dene end line char int par (end line char code)
dene new line char int par (new line char code)
dene language int par (language code)
dene left hyphen min int par (left hyphen min code)
dene right hyphen min int par (right hyphen min code)
dene holding inserts int par (holding inserts code)
dene error context lines int par (error context lines code)
Assign the values depth threshold show box depth and breadth max show box breadth 236
depth threshold show box depth; breadth max show box breadth
This code is used in section 198.
94 PART 17: THE TABLE OF EQUIVALENTS T
E
X82 237
237. We can print the symbolic name of an integer parameter as follows.
procedure print param(n : integer );
begin case n of
pretolerance code: print esc("pretolerance");
tolerance code: print esc("tolerance");
line penalty code: print esc("linepenalty");
hyphen penalty code: print esc("hyphenpenalty");
ex hyphen penalty code: print esc("exhyphenpenalty");
club penalty code: print esc("clubpenalty");
widow penalty code: print esc("widowpenalty");
display widow penalty code: print esc("displaywidowpenalty");
broken penalty code: print esc("brokenpenalty");
bin op penalty code: print esc("binoppenalty");
rel penalty code: print esc("relpenalty");
pre display penalty code: print esc("predisplaypenalty");
post display penalty code: print esc("postdisplaypenalty");
inter line penalty code: print esc("interlinepenalty");
double hyphen demerits code: print esc("doublehyphendemerits");
nal hyphen demerits code: print esc("finalhyphendemerits");
adj demerits code: print esc("adjdemerits");
mag code: print esc("mag");
delimiter factor code: print esc("delimiterfactor");
looseness code: print esc("looseness");
time code: print esc("time");
day code: print esc("day");
month code: print esc("month");
year code: print esc("year");
show box breadth code: print esc("showboxbreadth");
show box depth code: print esc("showboxdepth");
hbadness code: print esc("hbadness");
vbadness code: print esc("vbadness");
pausing code: print esc("pausing");
tracing online code: print esc("tracingonline");
tracing macros code: print esc("tracingmacros");
tracing stats code: print esc("tracingstats");
tracing paragraphs code: print esc("tracingparagraphs");
tracing pages code: print esc("tracingpages");
tracing output code: print esc("tracingoutput");
tracing lost chars code: print esc("tracinglostchars");
tracing commands code: print esc("tracingcommands");
tracing restores code: print esc("tracingrestores");
uc hyph code: print esc("uchyph");
output penalty code: print esc("outputpenalty");
max dead cycles code: print esc("maxdeadcycles");
hang after code: print esc("hangafter");
oating penalty code: print esc("floatingpenalty");
global defs code: print esc("globaldefs");
cur fam code: print esc("fam");
escape char code: print esc("escapechar");
default hyphen char code: print esc("defaulthyphenchar");
default skew char code: print esc("defaultskewchar");
end line char code: print esc("endlinechar");
237 T
E
X82 PART 17: THE TABLE OF EQUIVALENTS 95
new line char code: print esc("newlinechar");
language code: print esc("language");
left hyphen min code: print esc("lefthyphenmin");
right hyphen min code: print esc("righthyphenmin");
holding inserts code: print esc("holdinginserts");
error context lines code: print esc("errorcontextlines");
othercases print ("[unknownintegerparameter!]")
endcases;
end;
96 PART 17: THE TABLE OF EQUIVALENTS T
E
X82 238
238. The integer parameter names must be entered into the hash table.
Put each of T
E
Xs primitives into the hash table 226 +
primitive("pretolerance", assign int , int base + pretolerance code);
primitive("tolerance", assign int , int base + tolerance code);
primitive("linepenalty", assign int , int base + line penalty code);
primitive("hyphenpenalty", assign int , int base + hyphen penalty code);
primitive("exhyphenpenalty", assign int , int base + ex hyphen penalty code);
primitive("clubpenalty", assign int , int base + club penalty code);
primitive("widowpenalty", assign int , int base + widow penalty code);
primitive("displaywidowpenalty", assign int , int base + display widow penalty code);
primitive("brokenpenalty", assign int , int base + broken penalty code);
primitive("binoppenalty", assign int , int base + bin op penalty code);
primitive("relpenalty", assign int , int base + rel penalty code);
primitive("predisplaypenalty", assign int , int base + pre display penalty code);
primitive("postdisplaypenalty", assign int , int base + post display penalty code);
primitive("interlinepenalty", assign int , int base + inter line penalty code);
primitive("doublehyphendemerits", assign int , int base + double hyphen demerits code);
primitive("finalhyphendemerits", assign int , int base + nal hyphen demerits code);
primitive("adjdemerits", assign int , int base + adj demerits code);
primitive("mag", assign int , int base + mag code);
primitive("delimiterfactor", assign int , int base + delimiter factor code);
primitive("looseness", assign int , int base + looseness code);
primitive("time", assign int , int base + time code);
primitive("day", assign int , int base + day code);
primitive("month", assign int , int base + month code);
primitive("year", assign int , int base + year code);
primitive("showboxbreadth", assign int , int base + show box breadth code);
primitive("showboxdepth", assign int , int base + show box depth code);
primitive("hbadness", assign int , int base + hbadness code);
primitive("vbadness", assign int , int base + vbadness code);
primitive("pausing", assign int , int base + pausing code);
primitive("tracingonline", assign int , int base + tracing online code);
primitive("tracingmacros", assign int , int base + tracing macros code);
primitive("tracingstats", assign int , int base + tracing stats code);
primitive("tracingparagraphs", assign int , int base + tracing paragraphs code);
primitive("tracingpages", assign int , int base + tracing pages code);
primitive("tracingoutput", assign int , int base + tracing output code);
primitive("tracinglostchars", assign int , int base + tracing lost chars code);
primitive("tracingcommands", assign int , int base + tracing commands code);
primitive("tracingrestores", assign int , int base + tracing restores code);
primitive("uchyph", assign int , int base + uc hyph code);
primitive("outputpenalty", assign int , int base + output penalty code);
primitive("maxdeadcycles", assign int , int base + max dead cycles code);
primitive("hangafter", assign int , int base + hang after code);
primitive("floatingpenalty", assign int , int base + oating penalty code);
primitive("globaldefs", assign int , int base + global defs code);
primitive("fam", assign int , int base + cur fam code);
primitive("escapechar", assign int , int base + escape char code);
primitive("defaulthyphenchar", assign int , int base + default hyphen char code);
primitive("defaultskewchar", assign int , int base + default skew char code);
primitive("endlinechar", assign int , int base + end line char code);
primitive("newlinechar", assign int , int base + new line char code);
238 T
E
X82 PART 17: THE TABLE OF EQUIVALENTS 97
primitive("language", assign int , int base + language code);
primitive("lefthyphenmin", assign int , int base + left hyphen min code);
primitive("righthyphenmin", assign int , int base + right hyphen min code);
primitive("holdinginserts", assign int , int base + holding inserts code);
primitive("errorcontextlines", assign int , int base + error context lines code);
239. Cases of print cmd chr for symbolic printing of primitives 227 +
assign int : if chr code < count base then print param(chr code int base)
else begin print esc("count"); print int (chr code count base);
end;
240. The integer parameters should really be initialized by a macro package; the following initialization
does the minimum to keep T
E
X from complete failure.
Initialize table entries (done by INITEX only) 164 +
for k int base to del code base 1 do eqtb[k].int 0;
mag 1000; tolerance 10000; hang after 1; max dead cycles 25; escape char "\";
end line char carriage return;
for k 0 to 255 do del code(k) 1;
del code(".") 0; this null delimiter is used in error recovery
241. The following procedure, which is called just before T
E
X initializes its input and output, establishes
the initial values of the date and time. Since standard Pascal cannot provide such information, something
special is needed. The program here simply species July 4, 1776, at noon; but users probably want a better
approximation to the truth.
procedure x date and time;
begin time 12 60; minutes since midnight
day 4; fourth day of the month
month 7; seventh month of the year
year 1776; Anno Domini
end;
242. Show equivalent n, in region 5 242
begin if n < count base then print param(n int base)
else if n < del code base then
begin print esc("count"); print int (n count base);
end
else begin print esc("delcode"); print int (n del code base);
end;
print char ("="); print int (eqtb[n].int );
end
This code is used in section 252.
243. Set variable c to the current escape character 243
c escape char
This code is used in section 63.
244. Character s is the current new-line character 244
s = new line char
This code is used in sections 58 and 59.
98 PART 17: THE TABLE OF EQUIVALENTS T
E
X82 245
245. T
E
X is occasionally supposed to print diagnostic information that goes only into the transcript le,
unless tracing online is positive. Here are two routines that adjust the destination of print commands:
procedure begin diagnostic; prepare to do some tracing
begin old setting selector ;
if (tracing online 0) (selector = term and log ) then
begin decr (selector );
if history = spotless then history warning issued ;
end;
end;
procedure end diagnostic(blank line : boolean); restore proper conditions after tracing
begin print nl ("");
if blank line then print ln;
selector old setting ;
end;
246. Of course we had better declare another global variable, if the previous routines are going to work.
Global variables 13 +
old setting : 0 . . max selector ;
247 T
E
X82 PART 17: THE TABLE OF EQUIVALENTS 99
247. The nal region of eqtb contains the dimension parameters dened here, and the 256 \dimen registers.
dene par indent code = 0 indentation of paragraphs
dene math surround code = 1 space around math in text
dene line skip limit code = 2 threshold for line skip instead of baseline skip
dene hsize code = 3 line width in horizontal mode
dene vsize code = 4 page height in vertical mode
dene max depth code = 5 maximum depth of boxes on main pages
dene split max depth code = 6 maximum depth of boxes on split pages
dene box max depth code = 7 maximum depth of explicit vboxes
dene hfuzz code = 8 tolerance for overfull hbox messages
dene vfuzz code = 9 tolerance for overfull vbox messages
dene delimiter shortfall code = 10 maximum amount uncovered by variable delimiters
dene null delimiter space code = 11 blank space in null delimiters
dene script space code = 12 extra space after subscript or superscript
dene pre display size code = 13 length of text preceding a display
dene display width code = 14 length of line for displayed equation
dene display indent code = 15 indentation of line for displayed equation
dene overfull rule code = 16 width of rule that identies overfull hboxes
dene hang indent code = 17 amount of hanging indentation
dene h oset code = 18 amount of horizontal oset when shipping pages out
dene v oset code = 19 amount of vertical oset when shipping pages out
dene emergency stretch code = 20 reduces badnesses on nal pass of line-breaking
dene dimen pars = 21 total number of dimension parameters
dene scaled base = dimen base + dimen pars table of 256 user-dened \dimen registers
dene eqtb size = scaled base + 255 largest subscript of eqtb
dene dimen(#) eqtb[scaled base + #].sc
dene dimen par (#) eqtb[dimen base + #].sc a scaled quantity
dene par indent dimen par (par indent code)
dene math surround dimen par (math surround code)
dene line skip limit dimen par (line skip limit code)
dene hsize dimen par (hsize code)
dene vsize dimen par (vsize code)
dene max depth dimen par (max depth code)
dene split max depth dimen par (split max depth code)
dene box max depth dimen par (box max depth code)
dene hfuzz dimen par (hfuzz code)
dene vfuzz dimen par (vfuzz code)
dene delimiter shortfall dimen par (delimiter shortfall code)
dene null delimiter space dimen par (null delimiter space code)
dene script space dimen par (script space code)
dene pre display size dimen par (pre display size code)
dene display width dimen par (display width code)
dene display indent dimen par (display indent code)
dene overfull rule dimen par (overfull rule code)
dene hang indent dimen par (hang indent code)
dene h oset dimen par (h oset code)
dene v oset dimen par (v oset code)
dene emergency stretch dimen par (emergency stretch code)
procedure print length param(n : integer );
begin case n of
par indent code: print esc("parindent");
math surround code: print esc("mathsurround");
100 PART 17: THE TABLE OF EQUIVALENTS T
E
X82 247
line skip limit code: print esc("lineskiplimit");
hsize code: print esc("hsize");
vsize code: print esc("vsize");
max depth code: print esc("maxdepth");
split max depth code: print esc("splitmaxdepth");
box max depth code: print esc("boxmaxdepth");
hfuzz code: print esc("hfuzz");
vfuzz code: print esc("vfuzz");
delimiter shortfall code: print esc("delimitershortfall");
null delimiter space code: print esc("nulldelimiterspace");
script space code: print esc("scriptspace");
pre display size code: print esc("predisplaysize");
display width code: print esc("displaywidth");
display indent code: print esc("displayindent");
overfull rule code: print esc("overfullrule");
hang indent code: print esc("hangindent");
h oset code: print esc("hoffset");
v oset code: print esc("voffset");
emergency stretch code: print esc("emergencystretch");
othercases print ("[unknowndimenparameter!]")
endcases;
end;
248. Put each of T
E
Xs primitives into the hash table 226 +
primitive("parindent", assign dimen, dimen base + par indent code);
primitive("mathsurround", assign dimen, dimen base + math surround code);
primitive("lineskiplimit", assign dimen, dimen base + line skip limit code);
primitive("hsize", assign dimen, dimen base + hsize code);
primitive("vsize", assign dimen, dimen base + vsize code);
primitive("maxdepth", assign dimen, dimen base + max depth code);
primitive("splitmaxdepth", assign dimen, dimen base + split max depth code);
primitive("boxmaxdepth", assign dimen, dimen base + box max depth code);
primitive("hfuzz", assign dimen, dimen base + hfuzz code);
primitive("vfuzz", assign dimen, dimen base + vfuzz code);
primitive("delimitershortfall", assign dimen, dimen base + delimiter shortfall code);
primitive("nulldelimiterspace", assign dimen, dimen base + null delimiter space code);
primitive("scriptspace", assign dimen, dimen base + script space code);
primitive("predisplaysize", assign dimen, dimen base + pre display size code);
primitive("displaywidth", assign dimen, dimen base + display width code);
primitive("displayindent", assign dimen, dimen base + display indent code);
primitive("overfullrule", assign dimen, dimen base + overfull rule code);
primitive("hangindent", assign dimen, dimen base + hang indent code);
primitive("hoffset", assign dimen, dimen base + h oset code);
primitive("voffset", assign dimen, dimen base + v oset code);
primitive("emergencystretch", assign dimen, dimen base + emergency stretch code);
249. Cases of print cmd chr for symbolic printing of primitives 227 +
assign dimen: if chr code < scaled base then print length param(chr code dimen base)
else begin print esc("dimen"); print int (chr code scaled base);
end;
250 T
E
X82 PART 17: THE TABLE OF EQUIVALENTS 101
250. Initialize table entries (done by INITEX only) 164 +
for k dimen base to eqtb size do eqtb[k].sc 0;
251. Show equivalent n, in region 6 251
begin if n < scaled base then print length param(n dimen base)
else begin print esc("dimen"); print int (n scaled base);
end;
print char ("="); print scaled (eqtb[n].sc); print ("pt");
end
This code is used in section 252.
252. Here is a procedure that displays the contents of eqtb[n] symbolically.
Declare the procedure called print cmd chr 298
stat procedure show eqtb(n : pointer );
begin if n < active base then print char ("?") this cant happen
else if n < glue base then Show equivalent n, in region 1 or 2 223
else if n < local base then Show equivalent n, in region 3 229
else if n < int base then Show equivalent n, in region 4 233
else if n < dimen base then Show equivalent n, in region 5 242
else if n eqtb size then Show equivalent n, in region 6 251
else print char ("?"); this cant happen either
end;
tats
253. The last two regions of eqtb have fullword values instead of the three elds eq level , eq type, and
equiv . An eq type is unnecessary, but T
E
X needs to store the eq level information in another array called
xeq level .
Global variables 13 +
eqtb: array [active base . . eqtb size] of memory word ;
xeq level : array [int base . . eqtb size] of quarterword ;
254. Set initial values of key variables 21 +
for k int base to eqtb size do xeq level [k] level one;
255. When the debugging routine search mem is looking for pointers having a given value, it is interested
only in regions 1 to 3 of eqtb, and in the rst part of region 4.
Search eqtb for equivalents equal to p 255
for q active base to box base + 255 do
begin if equiv (q) = p then
begin print nl ("EQUIV("); print int (q); print char (")");
end;
end
This code is used in section 172.
102 PART 18: THE HASH TABLE T
E
X82 256
256. The hash table. Control sequences are stored and retrieved by means of a fairly standard hash
table algorithm called the method of coalescing lists (cf. Algorithm 6.4C in The Art of Computer Pro-
gramming). Once a control sequence enters the table, it is never removed, because there are complicated
situations involving \gdef where the removal of a control sequence at the end of a group would be a mistake
preventable only by the introduction of a complicated reference-count mechanism.
The actual sequence of letters forming a control sequence identier is stored in the str pool array together
with all the other strings. An auxiliary array hash consists of items with two halfword elds per word. The
rst of these, called next (p), points to the next identier belonging to the same coalesced list as the identier
corresponding to p; and the other, called text (p), points to the str start entry for ps identier. If position p
of the hash table is empty, we have text (p) = 0; if position p is either empty or the end of a coalesced hash
list, we have next (p) = 0. An auxiliary pointer variable called hash used is maintained in such a way that
all locations p hash used are nonempty. The global variable cs count tells how many multiletter control
sequences have been dened, if statistics are being kept.
A global boolean variable called no new control sequence is set to true during the time that new hash
table entries are forbidden.
dene next (#) hash[#].lh link for coalesced lists
dene text (#) hash[#].rh string number for control sequence name
dene hash is full (hash used = hash base) test if all positions are occupied
dene font id text (#) text (font id base + #) a frozen font identiers name
Global variables 13 +
hash: array [hash base . . undened control sequence 1] of two halves ; the hash table
hash used : pointer ; allocation pointer for hash
no new control sequence: boolean; are new identiers legal?
cs count : integer ; total number of known identiers
257. Set initial values of key variables 21 +
no new control sequence true; new identiers are usually forbidden
next (hash base) 0; text (hash base) 0;
for k hash base + 1 to undened control sequence 1 do hash[k] hash[hash base];
258. Initialize table entries (done by INITEX only) 164 +
hash used frozen control sequence; nothing is used
cs count 0; eq type(frozen dont expand ) dont expand ;
text (frozen dont expand ) "notexpanded:";
259 T
E
X82 PART 18: THE HASH TABLE 103
259. Here is the subroutine that searches the hash table for an identier that matches a given string of
length l > 1 appearing in buer [j . . (j + l 1)]. If the identier is found, the corresponding hash table
address is returned. Otherwise, if the global variable no new control sequence is true, the dummy address
undened control sequence is returned. Otherwise the identier is inserted into the hash table and its location
is returned.
function id lookup(j, l : integer ): pointer ; search the hash table
label found ; go here if you found it
var h: integer ; hash code
d: integer ; number of characters in incomplete current string
p: pointer ; index in hash array
k: pointer ; index in buer array
begin Compute the hash code h 261 ;
p h + hash base; we start searching here; note that 0 h < hash prime
loop begin if text (p) > 0 then
if length(text (p)) = l then
if str eq buf (text (p), j) then goto found ;
if next (p) = 0 then
begin if no new control sequence then p undened control sequence
else Insert a new control sequence after p, then make p point to it 260 ;
goto found ;
end;
p next (p);
end;
found : id lookup p;
end;
260. Insert a new control sequence after p, then make p point to it 260
begin if text (p) > 0 then
begin repeat if hash is full then overow("hashsize", hash size);
decr (hash used );
until text (hash used ) = 0; search for an empty location in hash
next (p) hash used ; p hash used ;
end;
str room(l); d cur length;
while pool ptr > str start [str ptr ] do
begin decr (pool ptr ); str pool [pool ptr + l] str pool [pool ptr ];
end; move current string up to make room for another
for k j to j + l 1 do append char (buer [k]);
text (p) make string ; pool ptr pool ptr + d;
stat incr (cs count ); tats
end
This code is used in section 259.
104 PART 18: THE HASH TABLE T
E
X82 261
261. The value of hash prime should be roughly 85% of hash size, and it should be a prime number. The
theory of hashing tells us to expect fewer than two table probes, on the average, when the search is successful.
[See J. S. Vitter, Journal of the ACM 30 (1983), 231258.]
Compute the hash code h 261
h buer [j];
for k j + 1 to j + l 1 do
begin h h + h + buer [k];
while h hash prime do h h hash prime;
end
This code is used in section 259.
262. Single-character control sequences do not need to be looked up in a hash table, since we can use
the character code itself as a direct address. The procedure print cs prints the name of a control sequence,
given a pointer to its address in eqtb. A space is printed after the name unless it is a single nonletter or an
active character. This procedure might be invoked with invalid data, so it is extra robust. The individual
characters must be printed one at a time using print , since they may be unprintable.
Basic printing procedures 57 +
procedure print cs (p : integer ); prints a purported control sequence
begin if p < hash base then single character
if p single base then
if p = null cs then
begin print esc("csname"); print esc("endcsname");
end
else begin print esc(p single base);
if cat code(p single base) = letter then print char ("");
end
else if p < active base then print esc("IMPOSSIBLE.")
else print (p active base)
else if p undened control sequence then print esc("IMPOSSIBLE.")
else if (text (p) < 0) (text (p) str ptr ) then print esc("NONEXISTENT.")
else begin print esc(text (p)); print char ("");
end;
end;
263. Here is a similar procedure; it avoids the error checks, and it never prints a space after the control
sequence.
Basic printing procedures 57 +
procedure sprint cs (p : pointer ); prints a control sequence
begin if p < hash base then
if p < single base then print (p active base)
else if p < null cs then print esc(p single base)
else begin print esc("csname"); print esc("endcsname");
end
else print esc(text (p));
end;
264 T
E
X82 PART 18: THE HASH TABLE 105
264. We need to put T
E
Xs primitive control sequences into the hash table, together with their command
code (which will be the eq type) and an operand (which will be the equiv ). The primitive procedure does
this, in a way that no T
E
X user can. The global value cur val contains the new eqtb pointer after primitive
has acted.
init procedure primitive(s : str number ; c : quarterword ; o : halfword );
var k: pool pointer ; index into str pool
j: small number ; index into buer
l: small number ; length of the string
begin if s < 256 then cur val s + single base
else begin k str start [s]; l str start [s + 1] k; we will move s into the (empty) buer
for j 0 to l 1 do buer [j] so(str pool [k + j]);
cur val id lookup(0, l); no new control sequence is false
ush string ; text (cur val ) s; we dont want to have the string twice
end;
eq level (cur val ) level one; eq type(cur val ) c; equiv (cur val ) o;
end;
tini
106 PART 18: THE HASH TABLE T
E
X82 265
265. Many of T
E
Xs primitives need no equiv , since they are identiable by their eq type alone. These
primitives are loaded into the hash table as follows:
Put each of T
E
Xs primitives into the hash table 226 +
primitive("", ex space, 0);
primitive("/", ital corr , 0);
primitive("accent", accent , 0);
primitive("advance", advance, 0);
primitive("afterassignment", after assignment , 0);
primitive("aftergroup", after group, 0);
primitive("begingroup", begin group, 0);
primitive("char", char num, 0);
primitive("csname", cs name, 0);
primitive("delimiter", delim num, 0);
primitive("divide", divide, 0);
primitive("endcsname", end cs name, 0);
primitive("endgroup", end group, 0); text (frozen end group) "endgroup";
eqtb[frozen end group] eqtb[cur val ];
primitive("expandafter", expand after , 0);
primitive("font", def font , 0);
primitive("fontdimen", assign font dimen, 0);
primitive("halign", halign, 0);
primitive("hrule", hrule, 0);
primitive("ignorespaces", ignore spaces , 0);
primitive("insert", insert , 0);
primitive("mark", mark , 0);
primitive("mathaccent", math accent , 0);
primitive("mathchar", math char num, 0);
primitive("mathchoice", math choice, 0);
primitive("multiply", multiply, 0);
primitive("noalign", no align, 0);
primitive("noboundary", no boundary, 0);
primitive("noexpand", no expand , 0);
primitive("nonscript", non script , 0);
primitive("omit", omit , 0);
primitive("parshape", set shape, 0);
primitive("penalty", break penalty, 0);
primitive("prevgraf", set prev graf , 0);
primitive("radical", radical , 0);
primitive("read", read to cs , 0);
primitive("relax", relax , 256); cf. scan le name
text (frozen relax ) "relax"; eqtb[frozen relax ] eqtb[cur val ];
primitive("setbox", set box , 0);
primitive("the", the, 0);
primitive("toks", toks register , 0);
primitive("vadjust", vadjust , 0);
primitive("valign", valign, 0);
primitive("vcenter", vcenter , 0);
primitive("vrule", vrule, 0);
266 T
E
X82 PART 18: THE HASH TABLE 107
266. Each primitive has a corresponding inverse, so that it is possible to display the cryptic numeric
contents of eqtb in symbolic form. Every call of primitive in this program is therefore accompanied by some
straightforward code that forms part of the print cmd chr routine below.
Cases of print cmd chr for symbolic printing of primitives 227 +
accent : print esc("accent");
advance: print esc("advance");
after assignment : print esc("afterassignment");
after group: print esc("aftergroup");
assign font dimen: print esc("fontdimen");
begin group: print esc("begingroup");
break penalty: print esc("penalty");
char num: print esc("char");
cs name: print esc("csname");
def font : print esc("font");
delim num: print esc("delimiter");
divide: print esc("divide");
end cs name: print esc("endcsname");
end group: print esc("endgroup");
ex space: print esc("");
expand after : print esc("expandafter");
halign: print esc("halign");
hrule: print esc("hrule");
ignore spaces : print esc("ignorespaces");
insert : print esc("insert");
ital corr : print esc("/");
mark : print esc("mark");
math accent : print esc("mathaccent");
math char num: print esc("mathchar");
math choice: print esc("mathchoice");
multiply: print esc("multiply");
no align: print esc("noalign");
no boundary: print esc("noboundary");
no expand : print esc("noexpand");
non script : print esc("nonscript");
omit : print esc("omit");
radical : print esc("radical");
read to cs : print esc("read");
relax : print esc("relax");
set box : print esc("setbox");
set prev graf : print esc("prevgraf");
set shape: print esc("parshape");
the: print esc("the");
toks register : print esc("toks");
vadjust : print esc("vadjust");
valign: print esc("valign");
vcenter : print esc("vcenter");
vrule: print esc("vrule");
108 PART 18: THE HASH TABLE T
E
X82 267
267. We will deal with the other primitives later, at some point in the program where their eq type and
equiv values are more meaningful. For example, the primitives for math mode will be loaded when we
consider the routines that deal with formulas. It is easy to nd where each particular primitive was treated
by looking in the index at the end; for example, the section where "radical" entered eqtb is listed under
\radical primitive. (Primitives consisting of a single nonalphabetic character, like \/, are listed under
Single-character primitives.)
Meanwhile, this is a convenient place to catch up on something we were unable to do before the hash table
was dened:
Print the font identier for font (p) 267
print esc(font id text (font (p)))
This code is used in sections 174 and 176.
268 T
E
X82 PART 19: SAVING AND RESTORING EQUIVALENTS 109
268. Saving and restoring equivalents. The nested structure provided by { . . . } groups in T
E
X
means that eqtb entries valid in outer groups should be saved and restored later if they are overridden inside
the braces. When a new eqtb value is being assigned, the program therefore checks to see if the previous
entry belongs to an outer level. In such a case, the old value is placed on the save stack just before the new
value enters eqtb. At the end of a grouping level, i.e., when the right brace is sensed, the save stack is used
to restore the outer values, and the inner ones are destroyed.
Entries on the save stack are of type memory word . The top item on this stack is save stack [p], where
p = save ptr 1; it contains three elds called save type, save level , and save index , and it is interpreted in
one of four ways:
1) If save type(p) = restore old value, then save index (p) is a location in eqtb whose current value should
be destroyed at the end of the current group and replaced by save stack [p 1]. Furthermore if
save index (p) int base, then save level (p) should replace the corresponding entry in xeq level .
2) If save type(p) = restore zero, then save index (p) is a location in eqtb whose current value should be
destroyed at the end of the current group, when it should be replaced by the current value of
eqtb[undened control sequence].
3) If save type(p) = insert token, then save index (p) is a token that should be inserted into T
E
Xs input
when the current group ends.
4) If save type(p) = level boundary, then save level (p) is a code explaining what kind of group we were
previously in, and save index (p) points to the level boundary word at the bottom of the entries for
that group.
dene save type(#) save stack [#].hh.b0 classies a save stack entry
dene save level (#) save stack [#].hh.b1 saved level for regions 5 and 6, or group code
dene save index (#) save stack [#].hh.rh eqtb location or token or save stack location
dene restore old value = 0 save type when a value should be restored later
dene restore zero = 1 save type when an undened entry should be restored
dene insert token = 2 save type when a token is being saved for later use
dene level boundary = 3 save type corresponding to beginning of group
110 PART 19: SAVING AND RESTORING EQUIVALENTS T
E
X82 269
269. Here are the group codes that are used to discriminate between dierent kinds of groups. They allow
T
E
X to decide what special actions, if any, should be performed when a group ends.
Some groups are not supposed to be ended by right braces. For example, the $ that begins a math
formula causes a math shift group to be started, and this should be terminated by a matching $. Similarly,
a group that starts with \left should end with \right, and one that starts with \begingroup should end
with \endgroup.
dene bottom level = 0 group code for the outside world
dene simple group = 1 group code for local structure only
dene hbox group = 2 code for \hbox{...}
dene adjusted hbox group = 3 code for \hbox{...} in vertical mode
dene vbox group = 4 code for \vbox{...}
dene vtop group = 5 code for \vtop{...}
dene align group = 6 code for \halign{...}, \valign{...}
dene no align group = 7 code for \noalign{...}
dene output group = 8 code for output routine
dene math group = 9 code for, e.g., ^{...}
dene disc group = 10 code for \discretionary{...}{...}{...}
dene insert group = 11 code for \insert{...}, \vadjust{...}
dene vcenter group = 12 code for \vcenter{...}
dene math choice group = 13 code for \mathchoice{...}{...}{...}{...}
dene semi simple group = 14 code for \begingroup...\endgroup
dene math shift group = 15 code for $...$
dene math left group = 16 code for \left...\right
dene max group code = 16
Types in the outer block 18 +
group code = 0 . . max group code; save level for a level boundary
270. The global variable cur group keeps track of what sort of group we are currently in. Another global
variable, cur boundary, points to the topmost level boundary word. And cur level is the current depth of
nesting. The routines are designed to preserve the condition that no entry in the save stack or in eqtb ever
has a level greater than cur level .
271. Global variables 13 +
save stack : array [0 . . save size] of memory word ;
save ptr : 0 . . save size; rst unused entry on save stack
max save stack : 0 . . save size; maximum usage of save stack
cur level : quarterword ; current nesting level for groups
cur group: group code; current group type
cur boundary: 0 . . save size; where the current level begins
272. At this time it might be a good idea for the reader to review the introduction to eqtb that was given
above just before the long lists of parameter names. Recall that the outer level of the program is level one,
since undened control sequences are assumed to be dened at level zero.
Set initial values of key variables 21 +
save ptr 0; cur level level one; cur group bottom level ; cur boundary 0; max save stack 0;
273 T
E
X82 PART 19: SAVING AND RESTORING EQUIVALENTS 111
273. The following macro is used to test if there is room for up to six more entries on save stack . By
making a conservative test like this, we can get by with testing for overow in only a few places.
dene check full save stack
if save ptr > max save stack then
begin max save stack save ptr ;
if max save stack > save size 6 then overow("savesize", save size);
end
274. Procedure new save level is called when a group begins. The argument is a group identication code
like hbox group. After calling this routine, it is safe to put ve more entries on save stack .
In some cases integer-valued items are placed onto the save stack just below a level boundary word, because
this is a convenient place to keep information that is supposed to pop up just when the group has nished.
For example, when \hbox to 100pt{...} is being treated, the 100pt dimension is stored on save stack
just before new save level is called.
We use the notation saved (k) to stand for an integer item that appears in location save ptr + k of the
save stack.
dene saved (#) save stack [save ptr + #].int
procedure new save level (c : group code); begin a new level of grouping
begin check full save stack ; save type(save ptr ) level boundary; save level (save ptr ) cur group;
save index (save ptr ) cur boundary;
if cur level = max quarterword then
overow("groupinglevels", max quarterword min quarterword );
quit if (cur level + 1) is too big to be stored in eqtb
cur boundary save ptr ; incr (cur level ); incr (save ptr ); cur group c;
end;
275. Just before an entry of eqtb is changed, the following procedure should be called to update the other
data structures properly. It is important to keep in mind that reference counts in mem include references
from within save stack , so these counts must be handled carefully.
procedure eq destroy(w : memory word ); gets ready to forget w
var q: pointer ; equiv eld of w
begin case eq type eld (w) of
call , long call , outer call , long outer call : delete token ref (equiv eld (w));
glue ref : delete glue ref (equiv eld (w));
shape ref : begin q equiv eld (w); we need to free a \parshape block
if q ,= null then free node(q, info(q) + info(q) + 1);
end; such a block is 2n + 1 words long, where n = info(q)
box ref : ush node list (equiv eld (w));
othercases do nothing
endcases;
end;
276. To save a value of eqtb[p] that was established at level l, we can use the following subroutine.
procedure eq save(p : pointer ; l : quarterword ); saves eqtb[p]
begin check full save stack ;
if l = level zero then save type(save ptr ) restore zero
else begin save stack [save ptr ] eqtb[p]; incr (save ptr ); save type(save ptr ) restore old value;
end;
save level (save ptr ) l; save index (save ptr ) p; incr (save ptr );
end;
112 PART 19: SAVING AND RESTORING EQUIVALENTS T
E
X82 277
277. The procedure eq dene denes an eqtb entry having specied eq type and equiv elds, and saves the
former value if appropriate. This procedure is used only for entries in the rst four regions of eqtb, i.e., only
for entries that have eq type and equiv elds. After calling this routine, it is safe to put four more entries
on save stack , provided that there was room for four more entries before the call, since eq save makes the
necessary test.
procedure eq dene(p : pointer ; t : quarterword ; e : halfword ); new data for eqtb
begin if eq level (p) = cur level then eq destroy(eqtb[p])
else if cur level > level one then eq save(p, eq level (p));
eq level (p) cur level ; eq type(p) t; equiv (p) e;
end;
278. The counterpart of eq dene for the remaining (fullword) positions in eqtb is called eq word dene.
Since xeq level [p] level one for all p, a restore zero will never be used in this case.
procedure eq word dene(p : pointer ; w : integer );
begin if xeq level [p] ,= cur level then
begin eq save(p, xeq level [p]); xeq level [p] cur level ;
end;
eqtb[p].int w;
end;
279. The eq dene and eq word dene routines take care of local denitions. Global denitions are done in
almost the same way, but there is no need to save old values, and the new value is associated with level one.
procedure geq dene(p : pointer ; t : quarterword ; e : halfword ); global eq dene
begin eq destroy(eqtb[p]); eq level (p) level one; eq type(p) t; equiv (p) e;
end;
procedure geq word dene(p : pointer ; w : integer ); global eq word dene
begin eqtb[p].int w; xeq level [p] level one;
end;
280. Subroutine save for after puts a token on the stack for save-keeping.
procedure save for after (t : halfword );
begin if cur level > level one then
begin check full save stack ; save type(save ptr ) insert token; save level (save ptr ) level zero;
save index (save ptr ) t; incr (save ptr );
end;
end;
281. The unsave routine goes the other way, taking items o of save stack . This routine takes care of
restoration when a level ends; everything belonging to the topmost group is cleared o of the save stack.
Declare the procedure called restore trace 284
procedure back input ; forward ;
procedure unsave; pops the top level o the save stack
label done;
var p: pointer ; position to be restored
l: quarterword ; saved level, if in fullword regions of eqtb
t: halfword ; saved value of cur tok
begin if cur level > level one then
begin decr (cur level ); Clear o top level from save stack 282 ;
end
else confusion("curlevel"); unsave is not used when cur group = bottom level
end;
282 T
E
X82 PART 19: SAVING AND RESTORING EQUIVALENTS 113
282. Clear o top level from save stack 282
loop begin decr (save ptr );
if save type(save ptr ) = level boundary then goto done;
p save index (save ptr );
if save type(save ptr ) = insert token then Insert token p into T
E
Xs input 326
else begin if save type(save ptr ) = restore old value then
begin l save level (save ptr ); decr (save ptr );
end
else save stack [save ptr ] eqtb[undened control sequence];
Store save stack [save ptr ] in eqtb[p], unless eqtb[p] holds a global value 283 ;
end;
end;
done: cur group save level (save ptr ); cur boundary save index (save ptr )
This code is used in section 281.
283. A global denition, which sets the level to level one, will not be undone by unsave. If at least one
global denition of eqtb[p] has been carried out within the group that just ended, the last such denition
will therefore survive.
Store save stack [save ptr ] in eqtb[p], unless eqtb[p] holds a global value 283
if p < int base then
if eq level (p) = level one then
begin eq destroy(save stack [save ptr ]); destroy the saved value
stat if tracing restores > 0 then restore trace(p, "retaining");
tats
end
else begin eq destroy(eqtb[p]); destroy the current value
eqtb[p] save stack [save ptr ]; restore the saved value
stat if tracing restores > 0 then restore trace(p, "restoring");
tats
end
else if xeq level [p] ,= level one then
begin eqtb[p] save stack [save ptr ]; xeq level [p] l;
stat if tracing restores > 0 then restore trace(p, "restoring");
tats
end
else begin stat if tracing restores > 0 then restore trace(p, "retaining");
tats
end
This code is used in section 282.
284. Declare the procedure called restore trace 284
stat procedure restore trace(p : pointer ; s : str number ); eqtb[p] has just been restored or retained
begin begin diagnostic; print char ("{"); print (s); print char (""); show eqtb(p); print char ("}");
end diagnostic(false);
end;
tats
This code is used in section 281.
114 PART 19: SAVING AND RESTORING EQUIVALENTS T
E
X82 285
285. When looking for possible pointers to a memory location, it is helpful to look for references from eqtb
that might be waiting on the save stack. Of course, we might nd spurious pointers too; but this routine is
merely an aid when debugging, and at such times we are grateful for any scraps of information, even if they
prove to be irrelevant.
Search save stack for equivalents that point to p 285
if save ptr > 0 then
for q 0 to save ptr 1 do
begin if equiv eld (save stack [q]) = p then
begin print nl ("SAVE("); print int (q); print char (")");
end;
end
This code is used in section 172.
286. Most of the parameters kept in eqtb can be changed freely, but theres an exception: The magnication
should not be used with two dierent values during any T
E
X job, since a single magnication is applied to
an entire run. The global variable mag set is set to the current magnication whenever it becomes necessary
to freeze it at a particular value.
Global variables 13 +
mag set : integer ; if nonzero, this magnication should be used henceforth
287. Set initial values of key variables 21 +
mag set 0;
288. The prepare mag subroutine is called whenever T
E
X wants to use mag for magnication.
procedure prepare mag ;
begin if (mag set > 0) (mag ,= mag set ) then
begin print err ("Incompatiblemagnification("); print int (mag ); print (");");
print nl ("thepreviousvaluewillberetained");
help2 ("Icanhandleonlyonemagnificationratioperjob.SoIve")
("revertedtothemagnificationyouusedearlieronthisrun.");
int error (mag set ); geq word dene(int base + mag code, mag set ); mag mag set
end;
if (mag 0) (mag > 32768) then
begin print err ("Illegalmagnificationhasbeenchangedto1000");
help1 ("Themagnificationratiomustbebetween1and32768."); int error (mag );
geq word dene(int base + mag code, 1000);
end;
mag set mag ;
end;
289 T
E
X82 PART 20: TOKEN LISTS 115
289. Token lists. A T
E
X token is either a character or a control sequence, and it is represented internally
in one of two ways: (1) A character whose ASCII code number is c and whose command code is m is
represented as the number 2
8
m + c; the command code is in the range 1 m 14. (2) A control sequence
whose eqtb address is p is represented as the number cs token ag +p. Here cs token ag = 2
12
1 is larger
than 2
8
m + c, yet it is small enough that cs token ag + p < max halfword ; thus, a token ts comfortably
in a halfword.
A token t represents a left brace command if and only if t < left brace limit ; it represents a right brace
command if and only if we have left brace limit t < right brace limit ; and it represents a match or
end match command if and only if match token t end match token. The following denitions take care
of these token-oriented constants and a few others.
dene cs token ag 7777 amount added to the eqtb location in a token that stands for a control
sequence; is a multiple of 256, less 1
dene left brace token = 0400 2
8
left brace
dene left brace limit = 1000 2
8
(left brace + 1)
dene right brace token = 1000 2
8
right brace
dene right brace limit = 1400 2
8
(right brace + 1)
dene math shift token = 1400 2
8
math shift
dene tab token = 2000 2
8
tab mark
dene out param token = 2400 2
8
out param
dene space token = 5040 2
8
spacer + ""
dene letter token = 5400 2
8
letter
dene other token = 6000 2
8
other char
dene match token = 6400 2
8
match
dene end match token = 7000 2
8
end match
290. Check the constant values for consistency 14 +
if cs token ag + undened control sequence > max halfword then bad 21;
116 PART 20: TOKEN LISTS T
E
X82 291
291. A token list is a singly linked list of one-word nodes in mem, where each word contains a token
and a link. Macro denitions, output-routine denitions, marks, \write texts, and a few other things are
remembered by T
E
X in the form of token lists, usually preceded by a node with a reference count in its
token ref count eld. The token stored in location p is called info(p).
Three special commands appear in the token lists of macro denitions. When m = match, it means
that T
E
X should scan a parameter for the current macro; when m = end match, it means that parameter
matching should end and T
E
X should start reading the macro text; and when m = out param, it means that
T
E
X should insert parameter number c into the text at this point.
The enclosing { and } characters of a macro denition are omitted, but the nal right brace of an output
routine is included at the end of its token list.
Here is an example macro denition that illustrates these conventions. After T
E
X processes the text
\def\mac a#1#2 \b {#1\a ##1#2 #2}
the denition of \mac is represented as a token list containing
(reference count), letter a, match #, match #, spacer , \b, end match,
out param 1, \, letter a, spacer , mac param #, other char 1,
out param 2, spacer , out param 2.
The procedure scan toks builds such token lists, and macro call does the parameter matching.
Examples such as
\def\m{\def\m{a}b}
explain why reference counts would be needed even if T
E
X had no \let operation: When the token list for
\m is being read, the redenition of \m changes the eqtb entry before the token list has been fully consumed,
so we dare not simply destroy a token list when its control sequence is being redened.
If the parameter-matching part of a denition ends with #{, the corresponding token list will have {
just before the end match and also at the very end. The rst { is used to delimit the parameter; the
second one keeps the rst from disappearing.
292 T
E
X82 PART 20: TOKEN LISTS 117
292. The procedure show token list , which prints a symbolic form of the token list that starts at a given
node p, illustrates these conventions. The token list being displayed should not begin with a reference count.
However, the procedure is intended to be robust, so that if the memory links are awry or if p is not really a
pointer to a token list, nothing catastrophic will happen.
An additional parameter q is also given; this parameter is either null or it points to a node in the token
list where a certain magic computation takes place that will be explained later. (Basically, q is non-null
when we are printing the two-line context information at the time of an error message; q marks the place
corresponding to where the second line should begin.)
For example, if p points to the node containing the rst a in the token list above, then show token list
will print the string
a#1#2\b>#1\a##1#2#2;
and if q points to the node containing the second a, the magic computation will be performed just before
the second a is printed.
The generation will stop, and \ETC. will be printed, if the length of printing exceeds a given limit l.
Anomalous entries are printed in the form of control sequences that are not followed by a blank space, e.g.,
\BAD.; this cannot be confused with actual control sequences because a real control sequence named BAD
would come out \BAD.
Declare the procedure called show token list 292
procedure show token list (p, q : integer ; l : integer );
label exit ;
var m, c: integer ; pieces of a token
match chr : ASCII code; character used in a match
n: ASCII code; the highest parameter number, as an ASCII digit
begin match chr "#"; n "0"; tally 0;
while (p ,= null ) (tally < l) do
begin if p = q then Do magic computation 320 ;
Display token p, and return if there are problems 293 ;
p link (p);
end;
if p ,= null then print esc("ETC.");
exit : end;
This code is used in section 119.
293. Display token p, and return if there are problems 293
if (p < hi mem min) (p > mem end ) then
begin print esc("CLOBBERED."); return;
end;
if info(p) cs token ag then print cs (info(p) cs token ag )
else begin m info(p) div 400 ; c info(p) mod 400 ;
if info(p) < 0 then print esc("BAD.")
else Display the token (m, c) 294 ;
end
This code is used in section 292.
118 PART 20: TOKEN LISTS T
E
X82 294
294. The procedure usually learns the character code used for macro parameters by seeing one in a
match command before it runs into any out param commands.
Display the token (m, c) 294
case m of
left brace, right brace, math shift , tab mark , sup mark , sub mark , spacer , letter , other char : print (c);
mac param: begin print (c); print (c);
end;
out param: begin print (match chr );
if c 9 then print char (c + "0")
else begin print char ("!"); return;
end;
end;
match: begin match chr c; print (c); incr (n); print char (n);
if n > "9" then return;
end;
end match: print (">");
othercases print esc("BAD.")
endcases
This code is used in section 293.
295. Heres the way we sometimes want to display a token list, given a pointer to its reference count; the
pointer may be null.
procedure token show(p : pointer );
begin if p ,= null then show token list (link (p), null , 10000000);
end;
296. The print meaning subroutine displays cur cmd and cur chr in symbolic form, including the expan-
sion of a macro or mark.
procedure print meaning ;
begin print cmd chr (cur cmd , cur chr );
if cur cmd call then
begin print char (":"); print ln; token show(cur chr );
end
else if cur cmd = top bot mark then
begin print char (":"); print ln; token show(cur mark [cur chr ]);
end;
end;
297 T
E
X82 PART 21: INTRODUCTION TO THE SYNTACTIC ROUTINES 119
297. Introduction to the syntactic routines. Lets pause a moment now and try to look at the Big
Picture. The T
E
X program consists of three main parts: syntactic routines, semantic routines, and output
routines. The chief purpose of the syntactic routines is to deliver the users input to the semantic routines,
one token at a time. The semantic routines act as an interpreter responding to these tokens, which may be
regarded as commands. And the output routines are periodically called on to convert box-and-glue lists into
a compact set of instructions that will be sent to a typesetter. We have discussed the basic data structures
and utility routines of T
E
X, so we are good and ready to plunge into the real activity by considering the
syntactic routines.
Our current goal is to come to grips with the get next procedure, which is the keystone of T
E
Xs input
mechanism. Each call of get next sets the value of three variables cur cmd , cur chr , and cur cs , representing
the next input token.
cur cmd denotes a command code from the long list of codes given above;
cur chr denotes a character code or other modier of the command code;
cur cs is the eqtb location of the current control sequence,
if the current token was a control sequence, otherwise its zero.
Underlying this external behavior of get next is all the machinery necessary to convert from character les
to tokens. At a given time we may be only partially nished with the reading of several les (for which
\input was specied), and partially nished with the expansion of some user-dened macros and/or some
macro parameters, and partially nished with the generation of some text in a template for \halign, and so
on. When reading a character le, special characters must be classied as math delimiters, etc.; comments
and extra blank spaces must be removed, paragraphs must be recognized, and control sequences must be
found in the hash table. Furthermore there are occasions in which the scanning routines have looked ahead
for a word like plus but only part of that word was found, hence a few characters must be put back into
the input and scanned again.
To handle these situations, which might all be present simultaneously, T
E
X uses various stacks that
hold information about the incomplete activities, and there is a nite state control for each level of the
input mechanism. These stacks record the current state of an implicitly recursive process, but the get next
procedure is not recursive. Therefore it will not be dicult to translate these algorithms into low-level
languages that do not support recursion.
Global variables 13 +
cur cmd : eight bits ; current command set by get next
cur chr : halfword ; operand of current command
cur cs : pointer ; control sequence found here, zero if none found
cur tok : halfword ; packed representative of cur cmd and cur chr
120 PART 21: INTRODUCTION TO THE SYNTACTIC ROUTINES T
E
X82 298
298. The print cmd chr routine prints a symbolic interpretation of a command code and its modier. This
is used in certain You cant error messages, and in the implementation of diagnostic routines like \show.
The body of print cmd chr is a rather tedious listing of print commands, and most of it is essentially an
inverse to the primitive routine that enters a T
E
X primitive into eqtb. Therefore much of this procedure
appears elsewhere in the program, together with the corresponding primitive calls.
dene chr cmd (#)
begin print (#); print ASCII (chr code);
end
Declare the procedure called print cmd chr 298
procedure print cmd chr (cmd : quarterword ; chr code : halfword );
begin case cmd of
left brace: chr cmd ("begingroupcharacter");
right brace: chr cmd ("endgroupcharacter");
math shift : chr cmd ("mathshiftcharacter");
mac param: chr cmd ("macroparametercharacter");
sup mark : chr cmd ("superscriptcharacter");
sub mark : chr cmd ("subscriptcharacter");
endv : print ("endofalignmenttemplate");
spacer : chr cmd ("blankspace");
letter : chr cmd ("theletter");
other char : chr cmd ("thecharacter");
Cases of print cmd chr for symbolic printing of primitives 227
othercases print ("[unknowncommandcode!]")
endcases;
end;
This code is used in section 252.
299. Here is a procedure that displays the current command.
procedure show cur cmd chr ;
begin begin diagnostic; print nl ("{");
if mode ,= shown mode then
begin print mode(mode); print (":"); shown mode mode;
end;
print cmd chr (cur cmd , cur chr ); print char ("}"); end diagnostic(false);
end;
300 T
E
X82 PART 22: INPUT STACKS AND STATES 121
300. Input stacks and states. This implementation of T
E
X uses two dierent conventions for repre-
senting sequential 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 . . (ptr 1)]. For example, the semantic stack described above is handled this way,
and so is the input stack that we are about to study.
2) If there is infrequent top access, the entire stack contents are in the array stack [0 . . (ptr 1)]. For
example, the save stack is treated this way, as we have seen.
The state of T
E
Xs input mechanism appears in the input stack, whose entries are records with six elds,
called state, index , start , loc, limit , and name. This stack is maintained with convention (1), so it is declared
in the following way:
Types in the outer block 18 +
in state record = record state eld , index eld : quarterword ;
start eld , loc eld , limit eld , name eld : halfword ;
end;
301. Global variables 13 +
input stack : array [0 . . stack size] of in state record ;
input ptr : 0 . . stack size; rst unused location of input stack
max in stack : 0 . . stack size; largest value of input ptr when pushing
cur input : in state record ; the top input state, according to convention (1)
302. Weve already dened the special variable loc cur input .loc eld in our discussion of basic input-
output routines. The other components of cur input are dened in the same way:
dene state cur input .state eld current scanner state
dene index cur input .index eld reference for buer information
dene start cur input .start eld starting position in buer
dene limit cur input .limit eld end of current line in buer
dene name cur input .name eld name of the current le
122 PART 22: INPUT STACKS AND STATES T
E
X82 303
303. Lets look more closely now at the control variables (state, index , start , loc, limit , name), assuming
that T
E
X is reading a line of characters that have been input from some le or from the users terminal.
There is an array called buer that acts as a stack of all lines of characters that are currently being read
from les, including all lines on subsidiary levels of the input stack that are not yet completed. T
E
X will
return to the other lines when it is nished with the present input le.
(Incidentally, on a machine with byte-oriented addressing, it might be appropriate to combine buer with
the str pool array, letting the buer entries grow downward from the top of the string pool and checking
that these two tables dont bump into each other.)
The line we are currently working on begins in position start of the buer; the next character we are about
to read is buer [loc]; and limit is the location of the last character present. If loc > limit , the line has been
completely read. Usually buer [limit ] is the end line char , denoting the end of a line, but this is not true
if the current line is an insertion that was entered on the users terminal in response to an error message.
The name variable is a string number that designates the name of the current le, if we are reading a text
le. It is zero if we are reading from the terminal; it is n + 1 if we are reading from input stream n, where
0 n 16. (Input stream 16 stands for an invalid stream number; in such cases the input is actually from
the terminal, under control of the procedure read toks .)
The state variable has one of three values, when we are scanning such les:
1) state = mid line is the normal state.
2) state = skip blanks is like mid line, but blanks are ignored.
3) state = new line is the state at the beginning of a line.
These state values are assigned numeric codes so that if we add the state code to the next characters
command code, we get distinct values. For example, mid line + spacer stands for the case that a blank
space character occurs in the middle of a line when it is not being ignored; after this case is processed, the
next value of state will be skip blanks .
dene mid line = 1 state code when scanning a line of characters
dene skip blanks = 2 + max char code state code when ignoring blanks
dene new line = 3 + max char code + max char code state code at start of line
304 T
E
X82 PART 22: INPUT STACKS AND STATES 123
304. Additional information about the current line is available via the index variable, which counts how
many lines of characters are present in the buer below the current level. We have index = 0 when reading
from the terminal and prompting the user for each line; then if the user types, e.g., \input paper, we will
have index = 1 while reading the le paper.tex. However, it does not follow that index is the same as the
input stack pointer, since many of the levels on the input stack may come from token lists. For example,
the instruction \input paper might occur in a token list.
The global variable in open is equal to the index value of the highest non-token-list level. Thus, the
number of partially read lines in the buer is in open + 1, and we have in open = index when we are not
reading a token list.
If we are not currently reading from the terminal, or from an input stream, we are reading from the le
variable input le[index ]. We use the notation terminal input as a convenient abbreviation for name = 0,
and cur le as an abbreviation for input le[index ].
The global variable line contains the line number in the topmost open le, for use in error messages. If
we are not reading from the terminal, line stack [index ] holds the line number for the enclosing level, so that
line can be restored when the current le has been read. Line numbers should never be negative, since the
negative of the current line number is used to identify the users output routine in the mode line eld of the
semantic nest entries.
If more information about the input state is needed, it can be included in small arrays like those shown
here. For example, the current page or segment number in the input le might be put into a variable
page, maintained for enclosing levels in page stack : array [1 . . max in open] of integer by analogy with
line stack .
dene terminal input (name = 0) are we reading from the terminal?
dene cur le input le[index ] the current alpha le variable
Global variables 13 +
in open: 0 . . max in open; the number of lines in the buer, less one
open parens : 0 . . max in open; the number of open text les
input le: array [1 . . max in open] of alpha le;
line: integer ; current line number in the current source le
line stack : array [1 . . max in open] of integer ;
124 PART 22: INPUT STACKS AND STATES T
E
X82 305
305. Users of T
E
X sometimes forget to balance left and right braces properly, and one of the ways T
E
X
tries to spot such errors is by considering an input le as broken into subles by control sequences that are
declared to be \outer.
A variable called scanner status tells T
E
X whether or not to complain when a suble ends. This variable
has six possible values:
normal , means that a suble can safely end here without incident.
skipping , means that a suble can safely end here, but not a le, because were reading past some conditional
text that was not selected.
dening , means that a suble shouldnt end now because a macro is being dened.
matching , means that a suble shouldnt end now because a macro is being used and we are searching for
the end of its arguments.
aligning , means that a suble shouldnt end now because we are not nished with the preamble of an \halign
or \valign.
absorbing , means that a suble shouldnt end now because we are reading a balanced token list for \message,
\write, etc.
If the scanner status is not normal , the variable warning index points to the eqtb location for the relevant
control sequence name to print in an error message.
dene skipping = 1 scanner status when passing conditional text
dene dening = 2 scanner status when reading a macro denition
dene matching = 3 scanner status when reading macro arguments
dene aligning = 4 scanner status when reading an alignment preamble
dene absorbing = 5 scanner status when reading a balanced text
Global variables 13 +
scanner status : normal . . absorbing ; can a suble end now?
warning index : pointer ; identier relevant to non-normal scanner status
def ref : pointer ; reference count of token list being dened
306. Here is a procedure that uses scanner status to print a warning message when a suble has ended,
and at certain other crucial times:
Declare the procedure called runaway 306
procedure runaway;
var p: pointer ; head of runaway list
begin if scanner status > skipping then
begin print nl ("Runaway");
case scanner status of
dening : begin print ("definition"); p def ref ;
end;
matching : begin print ("argument"); p temp head ;
end;
aligning : begin print ("preamble"); p hold head ;
end;
absorbing : begin print ("text"); p def ref ;
end;
end; there are no other cases
print char ("?"); print ln; show token list (link (p), null , error line 10);
end;
end;
This code is used in section 119.
307 T
E
X82 PART 22: INPUT STACKS AND STATES 125
307. However, all this discussion about input state really applies only to the case that we are inputting
from a le. There is another important case, namely when we are currently getting input from a token list.
In this case state = token list , and the conventions about the other state variables are dierent:
loc is a pointer to the current node in the token list, i.e., the node that will be read next. If loc = null , the
token list has been fully read.
start points to the rst node of the token list; this node may or may not contain a reference count, depending
on the type of token list involved.
token type, which takes the place of index in the discussion above, is a code number that explains what kind
of token list is being scanned.
name points to the eqtb address of the control sequence being expanded, if the current token list is a macro.
param start , which takes the place of limit , tells where the parameters of the current macro begin in the
param stack , if the current token list is a macro.
The token type can take several values, depending on where the current token list came from:
parameter , if a parameter is being scanned;
u template, if the u
j
part of an alignment template is being scanned;
v template, if the v
j
part of an alignment template is being scanned;
backed up, if the token list being scanned has been inserted as to be read again.
inserted , if the token list being scanned has been inserted as the text expansion of a \count or similar
variable;
macro, if a user-dened control sequence is being scanned;
output text , if an \output routine is being scanned;
every par text , if the text of \everypar is being scanned;
every math text , if the text of \everymath is being scanned;
every display text , if the text of \everydisplay is being scanned;
every hbox text , if the text of \everyhbox is being scanned;
every vbox text , if the text of \everyvbox is being scanned;
every job text , if the text of \everyjob is being scanned;
every cr text , if the text of \everycr is being scanned;
mark text , if the text of a \mark is being scanned;
write text , if the text of a \write is being scanned.
The codes for output text , every par text , etc., are equal to a constant plus the corresponding codes for token
list parameters output routine loc, every par loc, etc. The token list begins with a reference count if and
only if token type macro.
dene token list = 0 state code when scanning a token list
dene token type index type of current token list
dene param start limit base of macro parameters in param stack
dene parameter = 0 token type code for parameter
dene u template = 1 token type code for u
j
template
dene v template = 2 token type code for v
j
template
dene backed up = 3 token type code for text to be reread
dene inserted = 4 token type code for inserted texts
dene macro = 5 token type code for dened control sequences
dene output text = 6 token type code for output routines
dene every par text = 7 token type code for \everypar
dene every math text = 8 token type code for \everymath
dene every display text = 9 token type code for \everydisplay
dene every hbox text = 10 token type code for \everyhbox
dene every vbox text = 11 token type code for \everyvbox
dene every job text = 12 token type code for \everyjob
dene every cr text = 13 token type code for \everycr
126 PART 22: INPUT STACKS AND STATES T
E
X82 307
dene mark text = 14 token type code for \topmark, etc.
dene write text = 15 token type code for \write
308. The param stack is an auxiliary array used to hold pointers to the token lists for parameters at the
current level and subsidiary levels of input. This stack is maintained with convention (2), and it grows at a
dierent rate from the others.
Global variables 13 +
param stack : array [0 . . param size] of pointer ; token list pointers for parameters
param ptr : 0 . . param size; rst unused entry in param stack
max param stack : integer ; largest value of param ptr , will be param size + 9
309. The input routines must also interact with the processing of \halign and \valign, since the appear-
ance of tab marks and \cr in certain places is supposed to trigger the beginning of special v
j
template text
in the scanner. This magic is accomplished by an align state variable that is increased by 1 when a { is
scanned and decreased by 1 when a } is scanned. The align state is nonzero during the u
j
template, after
which it is set to zero; the v
j
template begins when a tab mark or \cr occurs at a time that align state = 0.
Global variables 13 +
align state: integer ; group level with respect to current alignment
310. Thus, the current input state can be very complicated indeed; there can be many levels and each
level can arise in a variety of ways. The show context procedure, which is used by T
E
Xs error-reporting
routine to print out the current input state on all levels down to the most recent line of characters from an
input le, illustrates most of these conventions. The global variable base ptr contains the lowest level that
was displayed by this procedure.
Global variables 13 +
base ptr : 0 . . stack size; shallowest level shown by show context
311 T
E
X82 PART 22: INPUT STACKS AND STATES 127
311. The status at each level is indicated by printing two lines, where the rst line indicates what was
read so far and the second line shows what remains to be read. The context is cropped, if necessary, so
that the rst line contains at most half error line characters, and the second contains at most error line.
Non-current input levels whose token type is backed up are shown only if they have not been fully read.
procedure show context ; prints where the scanner is
label done;
var old setting : 0 . . max selector ; saved selector setting
nn: integer ; number of contexts shown so far, less one
bottom line: boolean; have we reached the nal context to be shown?
Local variables for formatting calculations 315
begin base ptr input ptr ; input stack [base ptr ] cur input ; store current state
nn 1; bottom line false;
loop begin cur input input stack [base ptr ]; enter into the context
if (state ,= token list ) then
if (name > 17) (base ptr = 0) then bottom line true;
if (base ptr = input ptr ) bottom line (nn < error context lines ) then
Display the current context 312
else if nn = error context lines then
begin print nl ("..."); incr (nn); omitted if error context lines < 0
end;
if bottom line then goto done;
decr (base ptr );
end;
done: cur input input stack [input ptr ]; restore original state
end;
312. Display the current context 312
begin if (base ptr = input ptr ) (state ,= token list ) (token type ,= backed up) (loc ,= null ) then
we omit backed-up token lists that have already been read
begin tally 0; get ready to count characters
old setting selector ;
if state ,= token list then
begin Print location of current line 313 ;
Pseudoprint the line 318 ;
end
else begin Print type of token list 314 ;
Pseudoprint the token list 319 ;
end;
selector old setting ; stop pseudoprinting
Print two lines using the tricky pseudoprinted information 317 ;
incr (nn);
end;
end
This code is used in section 311.
128 PART 22: INPUT STACKS AND STATES T
E
X82 313
313. This routine should be changed, if necessary, to give the best possible indication of where the current
line resides in the input le. For example, on some systems it is best to print both a page and line number.
Print location of current line 313
if name 17 then
if terminal input then
if base ptr = 0 then print nl ("<*>")
else print nl ("<insert>")
else begin print nl ("<read");
if name = 17 then print char ("*") else print int (name 1);
print char (">");
end
else begin print nl ("l."); print int (line);
end;
print char ("")
This code is used in section 312.
314. Print type of token list 314
case token type of
parameter : print nl ("<argument>");
u template, v template: print nl ("<template>");
backed up: if loc = null then print nl ("<recentlyread>")
else print nl ("<tobereadagain>");
inserted : print nl ("<insertedtext>");
macro: begin print ln; print cs (name);
end;
output text : print nl ("<output>");
every par text : print nl ("<everypar>");
every math text : print nl ("<everymath>");
every display text : print nl ("<everydisplay>");
every hbox text : print nl ("<everyhbox>");
every vbox text : print nl ("<everyvbox>");
every job text : print nl ("<everyjob>");
every cr text : print nl ("<everycr>");
mark text : print nl ("<mark>");
write text : print nl ("<write>");
othercases print nl ("?") this should never happen
endcases
This code is used in section 312.
315 T
E
X82 PART 22: INPUT STACKS AND STATES 129
315. Here it is necessary to explain a little trick. We dont want to store a long string that corresponds
to a token list, because that string might take up lots of memory; and we are printing during a time
when an error message is being given, so we dare not do anything that might overow one of T
E
Xs tables.
So pseudoprinting is the answer: We enter a mode of printing that stores characters into a buer of
length error line, where character k + 1 is placed into trick buf [k mod error line] if k < trick count ,
otherwise character k is dropped. Initially we set tally 0 and trick count 1000000; then when
we reach the point where transition from line 1 to line 2 should occur, we set rst count tally and
trick count max(error line, tally +1 +error line half error line). At the end of the pseudoprinting, the
values of rst count , tally, and trick count give us all the information we need to print the two lines, and
all of the necessary text is in trick buf .
Namely, let l be the length of the descriptive information that appears on the rst line. The length of
the context information gathered for that line is k = rst count , and the length of the context information
gathered for line 2 is m = min(tally, trick count ) k. If l + k h, where h = half error line, we print
trick buf [0 . . k 1] after the descriptive information on line 1, and set n l + k; here n is the length of
line 1. If l + k > h, some cropping is necessary, so we set n h and print ... followed by
trick buf [(l + k h + 3) . . k 1],
where subscripts of trick buf are circular modulo error line. The second line consists of n spaces followed
by trick buf [k . . (k + m 1)], unless n + m > error line; in the latter case, further cropping is done. This
is easier to program than to explain.
Local variables for formatting calculations 315
i: 0 . . buf size; index into buer
j: 0 . . buf size; end of current line in buer
l: 0 . . half error line; length of descriptive information on line 1
m: integer ; context information gathered for line 2
n: 0 . . error line; length of line 1
p: integer ; starting or ending place in trick buf
q: integer ; temporary index
This code is used in section 311.
316. The following code sets up the print routines so that they will gather the desired information.
dene begin pseudoprint
begin l tally; tally 0; selector pseudo; trick count 1000000;
end
dene set trick count
begin rst count tally; trick count tally + 1 + error line half error line;
if trick count < error line then trick count error line;
end
130 PART 22: INPUT STACKS AND STATES T
E
X82 317
317. And the following code uses the information after it has been gathered.
Print two lines using the tricky pseudoprinted information 317
if trick count = 1000000 then set trick count ; set trick count must be performed
if tally < trick count then m tally rst count
else m trick count rst count ; context on line 2
if l + rst count half error line then
begin p 0; n l + rst count ;
end
else begin print ("..."); p l + rst count half error line + 3; n half error line;
end;
for q p to rst count 1 do print char (trick buf [q mod error line]);
print ln;
for q 1 to n do print char (""); print n spaces to begin line 2
if m + n error line then p rst count + m
else p rst count + (error line n 3);
for q rst count to p 1 do print char (trick buf [q mod error line]);
if m + n > error line then print ("...")
This code is used in section 312.
318. But the trick is distracting us from our current goal, which is to understand the input state. So lets
concentrate on the data structures that are being pseudoprinted as we nish up the show context procedure.
Pseudoprint the line 318
begin pseudoprint ;
if buer [limit ] = end line char then j limit
else j limit + 1; determine the eective end of the line
if j > 0 then
for i start to j 1 do
begin if i = loc then set trick count ;
print (buer [i]);
end
This code is used in section 312.
319. Pseudoprint the token list 319
begin pseudoprint ;
if token type < macro then show token list (start , loc, 100000)
else show token list (link (start ), loc, 100000) avoid reference count
This code is used in section 312.
320. Here is the missing piece of show token list that is activated when the token beginning line 2 is about
to be shown:
Do magic computation 320
set trick count
This code is used in section 292.
321 T
E
X82 PART 23: MAINTAINING THE INPUT STACKS 131
321. Maintaining the input stacks. The following subroutines change the input status in commonly
needed ways.
First comes push input , which stores the current state and creates a new level (having, initially, the same
properties as the old).
dene push input enter a new input level, save the old
begin if input ptr > max in stack then
begin max in stack input ptr ;
if input ptr = stack size then overow("inputstacksize", stack size);
end;
input stack [input ptr ] cur input ; stack the record
incr (input ptr );
end
322. And of course what goes up must come down.
dene pop input leave an input level, re-enter the old
begin decr (input ptr ); cur input input stack [input ptr ];
end
323. Here is a procedure that starts a new level of token-list input, given a token list p and its type t. If
t = macro, the calling routine should set name and loc.
dene back list (#) begin token list (#, backed up) backs up a simple token list
dene ins list (#) begin token list (#, inserted ) inserts a simple token list
procedure begin token list (p : pointer ; t : quarterword );
begin push input ; state token list ; start p; token type t;
if t macro then the token list starts with a reference count
begin add token ref (p);
if t = macro then param start param ptr
else begin loc link (p);
if tracing macros > 1 then
begin begin diagnostic; print nl ("");
case t of
mark text : print esc("mark");
write text : print esc("write");
othercases print cmd chr (assign toks , t output text + output routine loc)
endcases;
print (">"); token show(p); end diagnostic(false);
end;
end;
end
else loc p;
end;
132 PART 23: MAINTAINING THE INPUT STACKS T
E
X82 324
324. When a token list has been fully scanned, the following computations should be done as we leave
that level of input. The token type tends to be equal to either backed up or inserted about 2/3 of the time.
procedure end token list ; leave a token-list input level
begin if token type backed up then token list to be deleted
begin if token type inserted then ush list (start )
else begin delete token ref (start ); update reference count
if token type = macro then parameters must be ushed
while param ptr > param start do
begin decr (param ptr ); ush list (param stack [param ptr ]);
end;
end;
end
else if token type = u template then
if align state > 500000 then align state 0
else fatal error ("(interwovenalignmentpreamblesarenotallowed)");
pop input ; check interrupt ;
end;
325. Sometimes T
E
X has read too far and wants to unscan what it has seen. The back input procedure
takes care of this by putting the token just scanned back into the input stream, ready to be read again. This
procedure can be used only if cur tok represents the token to be replaced. Some applications of T
E
X use
this procedure a lot, so it has been slightly optimized for speed.
procedure back input ; undoes one token of input
var p: pointer ; a token list of length one
begin while (state = token list ) (loc = null ) (token type ,= v template) do end token list ;
conserve stack space
p get avail ; info(p) cur tok ;
if cur tok < right brace limit then
if cur tok < left brace limit then decr (align state)
else incr (align state);
push input ; state token list ; start p; token type backed up; loc p;
that was back list (p), without procedure overhead
end;
326. Insert token p into T
E
Xs input 326
begin t cur tok ; cur tok p; back input ; cur tok t;
end
This code is used in section 282.
327. The back error routine is used when we want to replace an oending token just before issuing an error
message. This routine, like back input , requires that cur tok has been set. We disable interrupts during the
call of back input so that the help message wont be lost.
procedure back error ; back up one token and call error
begin OK to interrupt false; back input ; OK to interrupt true; error ;
end;
procedure ins error ; back up one inserted token and call error
begin OK to interrupt false; back input ; token type inserted ; OK to interrupt true; error ;
end;
328 T
E
X82 PART 23: MAINTAINING THE INPUT STACKS 133
328. The begin le reading procedure starts a new level of input for lines of characters to be read from a
le, or as an insertion from the terminal. It does not take care of opening the le, nor does it set loc or limit
or line.
procedure begin le reading ;
begin if in open = max in open then overow("textinputlevels", max in open);
if rst = buf size then overow("buffersize", buf size);
incr (in open); push input ; index in open; line stack [index ] line; start rst ; state mid line;
name 0; terminal input is now true
end;
329. Conversely, the variables must be downdated when such a level of input is nished:
procedure end le reading ;
begin rst start ; line line stack [index ];
if name > 17 then a close(cur le); forget it
pop input ; decr (in open);
end;
330. In order to keep the stack from overowing during a long sequence of inserted \show commands,
the following routine removes completed error-inserted lines from memory.
procedure clear for error prompt ;
begin while (state ,= token list ) terminal input (input ptr > 0) (loc > limit ) do end le reading ;
print ln; clear terminal ;
end;
331. To get T
E
Xs whole input mechanism going, we perform the following actions.
Initialize the input routines 331
begin input ptr 0; max in stack 0; in open 0; open parens 0; max buf stack 0;
param ptr 0; max param stack 0; rst buf size;
repeat buer [rst ] 0; decr (rst );
until rst = 0;
scanner status normal ; warning index null ; rst 1; state new line; start 1; index 0;
line 0; name 0; force eof false; align state 1000000;
if init terminal then goto nal end ;
limit last ; rst last + 1; init terminal has set loc and last
end
This code is used in section 1337.
134 PART 24: GETTING THE NEXT TOKEN T
E
X82 332
332. Getting the next token. The heart of T
E
Xs input mechanism is the get next procedure, which
we shall develop in the next few sections of the program. Perhaps we shouldnt actually call it the heart,
however, because it really acts as T
E
Xs eyes and mouth, reading the source les and gobbling them up. And
it also helps T
E
X to regurgitate stored token lists that are to be processed again.
The main duty of get next is to input one token and to set cur cmd and cur chr to that tokens command
code and modier. Furthermore, if the input token is a control sequence, the eqtb location of that control
sequence is stored in cur cs ; otherwise cur cs is set to zero.
Underlying this simple description is a certain amount of complexity because of all the cases that need to
be handled. However, the inner loop of get next is reasonably short and fast.
When get next is asked to get the next token of a \read line, it sets cur cmd = cur chr = cur cs = 0 in
the case that no more tokens appear on that line. (There might not be any tokens at all, if the end line char
has ignore as its catcode.)
333. The value of par loc is the eqtb address of \par. This quantity is needed because a blank line of
input is supposed to be exactly equivalent to the appearance of \par; we must set cur cs par loc when
detecting a blank line.
Global variables 13 +
par loc: pointer ; location of \par in eqtb
par token: halfword ; token representing \par
334. Put each of T
E
Xs primitives into the hash table 226 +
primitive("par", par end , 256); cf. scan le name
par loc cur val ; par token cs token ag + par loc;
335. Cases of print cmd chr for symbolic printing of primitives 227 +
par end : print esc("par");
336. Before getting into get next , lets consider the subroutine that is called when an \outer control
sequence has been scanned or when the end of a le has been reached. These two cases are distinguished by
cur cs , which is zero at the end of a le.
procedure check outer validity;
var p: pointer ; points to inserted token list
q: pointer ; auxiliary pointer
begin if scanner status ,= normal then
begin deletions allowed false; Back up an outer control sequence so that it can be reread 337 ;
if scanner status > skipping then Tell the user what has run away and try to recover 338
else begin print err ("Incomplete"); print cmd chr (if test , cur if );
print (";alltextwasignoredafterline"); print int (skip line);
help3 ("Aforbiddencontrolsequenceoccurredinskippedtext.")
("Thiskindoferrorhappenswhenyousay`\if...andforget")
("thematching`\fi.Iveinserteda`\fi;thismightwork.");
if cur cs ,= 0 then cur cs 0
else help line[2] "ThefileendedwhileIwasskippingconditionaltext.";
cur tok cs token ag + frozen ; ins error ;
end;
deletions allowed true;
end;
end;
337 T
E
X82 PART 24: GETTING THE NEXT TOKEN 135
337. An outer control sequence that occurs in a \read will not be reread, since the error recovery for
\read is not very powerful.
Back up an outer control sequence so that it can be reread 337
if cur cs ,= 0 then
begin if (state = token list ) (name < 1) (name > 17) then
begin p get avail ; info(p) cs token ag + cur cs ; back list (p);
prepare to read the control sequence again
end;
cur cmd spacer ; cur chr ""; replace it by a space
end
This code is used in section 336.
338. Tell the user what has run away and try to recover 338
begin runaway; print a denition, argument, or preamble
if cur cs = 0 then print err ("Fileended")
else begin cur cs 0; print err ("Forbiddencontrolsequencefound");
end;
print ("whilescanning"); Print either definition or use or preamble or text, and insert
tokens that should lead to recovery 339 ;
print ("of"); sprint cs (warning index );
help4 ("Isuspectyouhaveforgottena`},causingme")
("toreadpastwhereyouwantedmetostop.")
("Illtrytorecover;butiftheerrorisserious,")
("youdbettertype`Eor`Xnowandfixyourfile.");
error ;
end
This code is used in section 336.
339. The recovery procedure cant be fully understood without knowing more about the T
E
X routines that
should be aborted, but we can sketch the ideas here: For a runaway denition we will insert a right brace;
for a runaway preamble, we will insert a special \cr token and a right brace; and for a runaway argument,
we will set long state to outer call and insert \par.
Print either definition or use or preamble or text, and insert tokens that should lead to
recovery 339
p get avail ;
case scanner status of
dening : begin print ("definition"); info(p) right brace token + "}";
end;
matching : begin print ("use"); info(p) par token; long state outer call ;
end;
aligning : begin print ("preamble"); info(p) right brace token + "}"; q p; p get avail ;
link (p) q; info(p) cs token ag + frozen cr ; align state 1000000;
end;
absorbing : begin print ("text"); info(p) right brace token + "}";
end;
end; there are no other cases
ins list (p)
This code is used in section 338.
340. We need to mention a procedure here that may be called by get next .
procedure rm up the line; forward ;
136 PART 24: GETTING THE NEXT TOKEN T
E
X82 341
341. Now were ready to take the plunge into get next itself. Parts of this routine are executed more often
than any other instructions of T
E
X.
dene switch = 25 a label in get next
dene start cs = 26 another
procedure get next ; sets cur cmd , cur chr , cur cs to next token
label restart , go here to get the next input token
switch, go here to eat the next character from a le
reswitch, go here to digest it again
start cs , go here to start looking for a control sequence
found , go here when a control sequence has been found
exit ; go here when the next input token has been got
var k: 0 . . buf size; an index into buer
t: halfword ; a token
cat : 0 . . max char code; cat code(cur chr ), usually
c, cc: ASCII code; constituents of a possible expanded code
d: 2 . . 3; number of excess characters in an expanded code
begin restart : cur cs 0;
if state ,= token list then Input from external le, goto restart if no input found 343
else Input from token list, goto restart if end of list or if a parameter needs to be expanded 357 ;
If an alignment entry has just ended, take appropriate action 342 ;
exit : end;
342. An alignment entry ends when a tab or \cr occurs, provided that the current level of braces is the
same as the level that was present at the beginning of that alignment entry; i.e., provided that align state
has returned to the value it had after the u
j
template for that entry.
If an alignment entry has just ended, take appropriate action 342
if cur cmd car ret then
if cur cmd tab mark then
if align state = 0 then Insert the v
j
template and goto restart 789
This code is used in section 341.
343. Input from external le, goto restart if no input found 343
begin switch: if loc limit then current line not yet nished
begin cur chr buer [loc]; incr (loc);
reswitch: cur cmd cat code(cur chr ); Change state if necessary, and goto switch if the current
character should be ignored, or goto reswitch if the current character changes to another 344 ;
end
else begin state new line;
Move to next line of le, or goto restart if there is no next line, or return if a \read line has
nished 360 ;
check interrupt ; goto switch;
end;
end
This code is used in section 341.
344 T
E
X82 PART 24: GETTING THE NEXT TOKEN 137
344. The following 48-way switch accomplishes the scanning quickly, assuming that a decent Pascal
compiler has translated the code. Note that the numeric values for mid line, skip blanks , and new line
are spaced apart from each other by max char code + 1, so we can add a characters command code to the
state to get a single number that characterizes both.
dene any state plus (#) mid line + #, skip blanks + #, new line + #
Change state if necessary, and goto switch if the current character should be ignored, or goto reswitch if
the current character changes to another 344
case state + cur cmd of
Cases where character is ignored 345 : goto switch;
any state plus (escape): Scan a control sequence and set state skip blanks or mid line 354 ;
any state plus (active char ): Process an active-character control sequence and set state mid line 353 ;
any state plus (sup mark ): If this sup mark starts an expanded character like ^^A or ^^df, then goto
reswitch, otherwise set state mid line 352 ;
any state plus (invalid char ): Decry the invalid character and goto restart 346 ;
Handle situations involving spaces, braces, changes of state 347
othercases do nothing
endcases
This code is used in section 343.
345. Cases where character is ignored 345
any state plus (ignore), skip blanks + spacer , new line + spacer
This code is used in section 344.
346. We go to restart instead of to switch, because state might equal token list after the error has been
dealt with (cf. clear for error prompt ).
Decry the invalid character and goto restart 346
begin print err ("Textlinecontainsaninvalidcharacter");
help2 ("AfunnysymbolthatIcantreadhasjustbeeninput.")
("Continue,andIllforgetthatiteverhappened.");
deletions allowed false; error ; deletions allowed true; goto restart ;
end
This code is used in section 344.
347. dene add delims to(#) # + math shift , # + tab mark , # + mac param, # + sub mark , # + letter ,
# + other char
Handle situations involving spaces, braces, changes of state 347
mid line + spacer : Enter skip blanks state, emit a space 349 ;
mid line + car ret : Finish line, emit a space 348 ;
skip blanks + car ret , any state plus (comment ): Finish line, goto switch 350 ;
new line + car ret : Finish line, emit a \par 351 ;
mid line + left brace: incr (align state);
skip blanks + left brace, new line + left brace: begin state mid line; incr (align state);
end;
mid line + right brace: decr (align state);
skip blanks + right brace, new line + right brace: begin state mid line; decr (align state);
end;
add delims to(skip blanks ), add delims to(new line): state mid line;
This code is used in section 344.
138 PART 24: GETTING THE NEXT TOKEN T
E
X82 348
348. When a character of type spacer gets through, its character code is changed to "" = 40 . This
means that the ASCII codes for tab and space, and for the space inserted at the end of a line, will be treated
alike when macro parameters are being matched. We do this since such characters are indistinguishable on
most computer terminal displays.
Finish line, emit a space 348
begin loc limit + 1; cur cmd spacer ; cur chr "";
end
This code is used in section 347.
349. The following code is performed only when cur cmd = spacer .
Enter skip blanks state, emit a space 349
begin state skip blanks ; cur chr "";
end
This code is used in section 347.
350. Finish line, goto switch 350
begin loc limit + 1; goto switch;
end
This code is used in section 347.
351. Finish line, emit a \par 351
begin loc limit + 1; cur cs par loc; cur cmd eq type(cur cs ); cur chr equiv (cur cs );
if cur cmd outer call then check outer validity;
end
This code is used in section 347.
352. Notice that a code like ^^8 becomes x if not followed by a hex digit.
dene is hex (#) (((# "0") (# "9")) ((# "a") (# "f")))
dene hex to cur chr
if c "9" then cur chr c "0" else cur chr c "a" + 10;
if cc "9" then cur chr 16 cur chr + cc "0"
else cur chr 16 cur chr + cc "a" + 10
If this sup mark starts an expanded character like ^^A or ^^df, then goto reswitch, otherwise set
state mid line 352
begin if cur chr = buer [loc] then
if loc < limit then
begin c buer [loc + 1]; if c < 200 then yes we have an expanded char
begin loc loc + 2;
if is hex (c) then
if loc limit then
begin cc buer [loc]; if is hex (cc) then
begin incr (loc); hex to cur chr ; goto reswitch;
end;
end;
if c < 100 then cur chr c + 100 else cur chr c 100 ;
goto reswitch;
end;
end;
state mid line;
end
This code is used in section 344.
353 T
E
X82 PART 24: GETTING THE NEXT TOKEN 139
353. Process an active-character control sequence and set state mid line 353
begin cur cs cur chr + active base; cur cmd eq type(cur cs ); cur chr equiv (cur cs );
state mid line;
if cur cmd outer call then check outer validity;
end
This code is used in section 344.
354. Control sequence names are scanned only when they appear in some line of a le; once they have
been scanned the rst time, their eqtb location serves as a unique identication, so T
E
X doesnt need to refer
to the original name any more except when it prints the equivalent in symbolic form.
The program that scans a control sequence has been written carefully in order to avoid the blowups that
might otherwise occur if a malicious user tried something like \catcode15=0. The algorithm might look
at buer [limit + 1], but it never looks at buer [limit + 2].
If expanded characters like ^^A or ^^df appear in or just following a control sequence name, they are
converted to single characters in the buer and the process is repeated, slowly but surely.
Scan a control sequence and set state skip blanks or mid line 354
begin if loc > limit then cur cs null cs state is irrelevant in this case
else begin start cs : k loc; cur chr buer [k]; cat cat code(cur chr ); incr (k);
if cat = letter then state skip blanks
else if cat = spacer then state skip blanks
else state mid line;
if (cat = letter ) (k limit ) then Scan ahead in the buer until nding a nonletter; if an expanded
code is encountered, reduce it and goto start cs ; otherwise if a multiletter control sequence is
found, adjust cur cs and loc, and goto found 356
else If an expanded code is present, reduce it and goto start cs 355 ;
cur cs single base + buer [loc]; incr (loc);
end;
found : cur cmd eq type(cur cs ); cur chr equiv (cur cs );
if cur cmd outer call then check outer validity;
end
This code is used in section 344.
140 PART 24: GETTING THE NEXT TOKEN T
E
X82 355
355. Whenever we reach the following piece of code, we will have cur chr = buer [k1] and k limit +1
and cat = cat code(cur chr ). If an expanded code like ^^A or ^^df appears in buer [(k 1) . . (k + 1)] or
buer [(k 1) . . (k +2)], we will store the corresponding code in buer [k 1] and shift the rest of the buer
left two or three places.
If an expanded code is present, reduce it and goto start cs 355
begin if buer [k] = cur chr then if cat = sup mark then if k < limit then
begin c buer [k + 1]; if c < 200 then yes, one is indeed present
begin d 2;
if is hex (c) then if k + 2 limit then
begin cc buer [k + 2]; if is hex (cc) then incr (d);
end;
if d > 2 then
begin hex to cur chr ; buer [k 1] cur chr ;
end
else if c < 100 then buer [k 1] c + 100
else buer [k 1] c 100 ;
limit limit d; rst rst d;
while k limit do
begin buer [k] buer [k + d]; incr (k);
end;
goto start cs ;
end;
end;
end
This code is used in sections 354 and 356.
356. Scan ahead in the buer until nding a nonletter; if an expanded code is encountered, reduce it
and goto start cs ; otherwise if a multiletter control sequence is found, adjust cur cs and loc, and
goto found 356
begin repeat cur chr buer [k]; cat cat code(cur chr ); incr (k);
until (cat ,= letter ) (k > limit );
If an expanded code is present, reduce it and goto start cs 355 ;
if cat ,= letter then decr (k); now k points to rst nonletter
if k > loc + 1 then multiletter control sequence has been scanned
begin cur cs id lookup(loc, k loc); loc k; goto found ;
end;
end
This code is used in section 354.
357 T
E
X82 PART 24: GETTING THE NEXT TOKEN 141
357. Lets consider now what happens when get next is looking at a token list.
Input from token list, goto restart if end of list or if a parameter needs to be expanded 357
if loc ,= null then list not exhausted
begin t info(loc); loc link (loc); move to next
if t cs token ag then a control sequence token
begin cur cs t cs token ag ; cur cmd eq type(cur cs ); cur chr equiv (cur cs );
if cur cmd outer call then
if cur cmd = dont expand then Get the next token, suppressing expansion 358
else check outer validity;
end
else begin cur cmd t div 400 ; cur chr t mod 400 ;
case cur cmd of
left brace: incr (align state);
right brace: decr (align state);
out param: Insert macro parameter and goto restart 359 ;
othercases do nothing
endcases;
end;
end
else begin we are done with this token list
end token list ; goto restart ; resume previous level
end
This code is used in section 341.
358. The present point in the program is reached only when the expand routine has inserted a special
marker into the input. In this special case, info(loc) is known to be a control sequence token, and
link (loc) = null .
dene no expand ag = 257 this characterizes a special variant of relax
Get the next token, suppressing expansion 358
begin cur cs info(loc) cs token ag ; loc null ;
cur cmd eq type(cur cs ); cur chr equiv (cur cs );
if cur cmd > max command then
begin cur cmd relax ; cur chr no expand ag ;
end;
end
This code is used in section 357.
359. Insert macro parameter and goto restart 359
begin begin token list (param stack [param start + cur chr 1], parameter ); goto restart ;
end
This code is used in section 357.
142 PART 24: GETTING THE NEXT TOKEN T
E
X82 360
360. All of the easy branches of get next have now been taken care of. There is one more branch.
dene end line char inactive (end line char < 0) (end line char > 255)
Move to next line of le, or goto restart if there is no next line, or return if a \read line has
nished 360
if name > 17 then Read next line of le into buer , or goto restart if the le has ended 362
else begin if terminal input then \read line has ended
begin cur cmd 0; cur chr 0; return;
end;
if input ptr > 0 then text was inserted during error recovery
begin end le reading ; goto restart ; resume previous level
end;
if selector < log only then open log le;
if interaction > nonstop mode then
begin if end line char inactive then incr (limit );
if limit = start then previous line was empty
print nl ("(Pleasetypeacommandorsay`\end)");
print ln; rst start ; prompt input ("*"); input on-line into buer
limit last ;
if end line char inactive then decr (limit )
else buer [limit ] end line char ;
rst limit + 1; loc start ;
end
else fatal error ("***(jobaborted,nolegal\endfound)");
nonstop mode, which is intended for overnight batch processing, never waits for on-line input
end
This code is used in section 343.
361. The global variable force eof is normally false; it is set true by an \endinput command.
Global variables 13 +
force eof : boolean; should the next \input be aborted early?
362. Read next line of le into buer , or goto restart if the le has ended 362
begin incr (line); rst start ;
if force eof then
begin if input ln(cur le, true) then not end of le
rm up the line this sets limit
else force eof true;
end;
if force eof then
begin print char (")"); decr (open parens ); update terminal ; show user that le has been read
force eof false; end le reading ; resume previous level
check outer validity; goto restart ;
end;
if end line char inactive then decr (limit )
else buer [limit ] end line char ;
rst limit + 1; loc start ; ready to read
end
This code is used in section 360.
363 T
E
X82 PART 24: GETTING THE NEXT TOKEN 143
363. If the user has set the pausing parameter to some positive value, and if nonstop mode has not been
selected, each line of input is displayed on the terminal and the transcript le, followed by =>. T
E
X waits
for a response. If the response is simply carriage return, the line is accepted as it stands, otherwise the line
typed is used instead of the line in the le.
procedure rm up the line;
var k: 0 . . buf size; an index into buer
begin limit last ;
if pausing > 0 then
if interaction > nonstop mode then
begin wake up terminal ; print ln;
if start < limit then
for k start to limit 1 do print (buer [k]);
rst limit ; prompt input ("=>"); wait for user response
if last > rst then
begin for k rst to last 1 do move line down in buer
buer [k + start rst ] buer [k];
limit start + last rst ;
end;
end;
end;
364. Since get next is used so frequently in T
E
X, it is convenient to dene three related procedures that
do a little more:
get token not only sets cur cmd and cur chr , it also sets cur tok , a packed halfword version of the current
token.
get x token, meaning get an expanded token, is like get token, but if the current token turns out to be
a user-dened control sequence (i.e., a macro call), or a conditional, or something like \topmark or
\expandafter or \csname, it is eliminated from the input by beginning the expansion of the macro
or the evaluation of the conditional.
x token is like get x token except that it assumes that get next has already been called.
In fact, these three procedures account for almost every use of get next .
365. No new control sequences will be dened except during a call of get token, or when \csname com-
presses a token list, because no new control sequence is always true at other times.
procedure get token; sets cur cmd , cur chr , cur tok
begin no new control sequence false; get next ; no new control sequence true;
if cur cs = 0 then cur tok (cur cmd 400 ) + cur chr
else cur tok cs token ag + cur cs ;
end;
144 PART 25: EXPANDING THE NEXT TOKEN T
E
X82 366
366. Expanding the next token. Only a dozen or so command codes > max command can possibly
be returned by get next ; in increasing order, they are undened cs , expand after , no expand , input , if test ,
or else, cs name, convert , the, top bot mark , call , long call , outer call , long outer call , and end template.
The expand subroutine is used when cur cmd > max command . It removes a call or a conditional or
one of the other special operations just listed. It follows that expand might invoke itself recursively. In all
cases, expand destroys the current token, but it sets things up so that the next get next will deliver the
appropriate next token. The value of cur tok need not be known when expand is called.
Since several of the basic scanning routines communicate via global variables, their values are saved as
local variables of expand so that recursive calls dont invalidate them.
Declare the procedure called macro call 389
Declare the procedure called insert relax 379
procedure pass text ; forward ;
procedure start input ; forward ;
procedure conditional ; forward ;
procedure get x token; forward ;
procedure conv toks ; forward ;
procedure ins the toks ; forward ;
procedure expand ;
var t: halfword ; token that is being expanded after
p, q, r: pointer ; for list manipulation
j: 0 . . buf size; index into buer
cv backup: integer ; to save the global quantity cur val
cvl backup, radix backup, co backup: small number ; to save cur val level , etc.
backup backup: pointer ; to save link (backup head )
save scanner status : small number ; temporary storage of scanner status
begin cv backup cur val ; cvl backup cur val level ; radix backup radix ; co backup cur order ;
backup backup link (backup head );
if cur cmd < call then Expand a nonmacro 367
else if cur cmd < end template then macro call
else Insert a token containing frozen endv 375 ;
cur val cv backup; cur val level cvl backup; radix radix backup; cur order co backup;
link (backup head ) backup backup;
end;
367. Expand a nonmacro 367
begin if tracing commands > 1 then show cur cmd chr ;
case cur cmd of
top bot mark : Insert the appropriate mark text into the scanner 386 ;
expand after : Expand the token after the next token 368 ;
no expand : Suppress expansion of the next token 369 ;
cs name: Manufacture a control sequence name 372 ;
convert : conv toks ; this procedure is discussed in Part 27 below
the: ins the toks ; this procedure is discussed in Part 27 below
if test : conditional ; this procedure is discussed in Part 28 below
or else: Terminate the current conditional and skip to \fi 510 ;
input : Initiate or terminate input from a le 378 ;
othercases Complain about an undened macro 370
endcases;
end
This code is used in section 366.
368 T
E
X82 PART 25: EXPANDING THE NEXT TOKEN 145
368. It takes only a little shuing to do what T
E
X calls \expandafter.
Expand the token after the next token 368
begin get token; t cur tok ; get token;
if cur cmd > max command then expand else back input ;
cur tok t; back input ;
end
This code is used in section 367.
369. The implementation of \noexpand is a bit trickier, because it is necessary to insert a special dont expand
marker into T
E
Xs reading mechanism. This special marker is processed by get next , but it does not slow
down the inner loop.
Since \outer macros might arise here, we must also clear the scanner status temporarily.
Suppress expansion of the next token 369
begin save scanner status scanner status ; scanner status normal ; get token;
scanner status save scanner status ; t cur tok ; back input ;
now start and loc point to the backed-up token t
if t cs token ag then
begin p get avail ; info(p) cs token ag + frozen dont expand ; link (p) loc; start p;
loc p;
end;
end
This code is used in section 367.
370. Complain about an undened macro 370
begin print err ("Undefinedcontrolsequence");
help5 ("Thecontrolsequenceattheendofthetopline")
("ofyourerrormessagewasnever\defed.Ifyouhave")
("misspelledit(e.g.,`\hobx),type`Iandthecorrect")
("spelling(e.g.,`I\hbox).Otherwisejustcontinue,")
("andIllforgetaboutwhateverwasundefined."); error ;
end
This code is used in section 367.
371. The expand procedure and some other routines that construct token lists nd it convenient to use
the following macros, which are valid only if the variables p and q are reserved for token-list building.
dene store new token(#)
begin q get avail ; link (p) q; info(q) #; p q; link (p) is null
end
dene fast store new token(#)
begin fast get avail (q); link (p) q; info(q) #; p q; link (p) is null
end
146 PART 25: EXPANDING THE NEXT TOKEN T
E
X82 372
372. Manufacture a control sequence name 372
begin r get avail ; p r; head of the list of characters
repeat get x token;
if cur cs = 0 then store new token(cur tok );
until cur cs ,= 0;
if cur cmd ,= end cs name then Complain about missing \endcsname 373 ;
Look up the characters of list r in the hash table, and set cur cs 374 ;
ush list (r);
if eq type(cur cs ) = undened cs then
begin eq dene(cur cs , relax , 256); N.B.: The save stack might change
end; the control sequence will now match \relax
cur tok cur cs + cs token ag ; back input ;
end
This code is used in section 367.
373. Complain about missing \endcsname 373
begin print err ("Missing"); print esc("endcsname"); print ("inserted");
help2 ("Thecontrolsequencemarked<tobereadagain>should")
("notappearbetween\csnameand\endcsname."); back error ;
end
This code is used in section 372.
374. Look up the characters of list r in the hash table, and set cur cs 374
j rst ; p link (r);
while p ,= null do
begin if j max buf stack then
begin max buf stack j + 1;
if max buf stack = buf size then overow("buffersize", buf size);
end;
buer [j] info(p) mod 400 ; incr (j); p link (p);
end;
if j > rst + 1 then
begin no new control sequence false; cur cs id lookup(rst , j rst );
no new control sequence true;
end
else if j = rst then cur cs null cs the list is empty
else cur cs single base + buer [rst ] the list has length one
This code is used in section 372.
375. An end template command is eectively changed to an endv command by the following code. (The
reason for this is discussed below; the frozen end template at the end of the template has passed the
check outer validity test, so its mission of error detection has been accomplished.)
Insert a token containing frozen endv 375
begin cur tok cs token ag + frozen endv ; back input ;
end
This code is used in section 366.
376 T
E
X82 PART 25: EXPANDING THE NEXT TOKEN 147
376. The processing of \input involves the start input subroutine, which will be declared later; the
processing of \endinput is trivial.
Put each of T
E
Xs primitives into the hash table 226 +
primitive("input", input , 0);
primitive("endinput", input , 1);
377. Cases of print cmd chr for symbolic printing of primitives 227 +
input : if chr code = 0 then print esc("input") else print esc("endinput");
378. Initiate or terminate input from a le 378
if cur chr > 0 then force eof true
else if name in progress then insert relax
else start input
This code is used in section 367.
379. Sometimes the expansion looks too far ahead, so we want to insert a harmless \relax into the users
input.
Declare the procedure called insert relax 379
procedure insert relax ;
begin cur tok cs token ag +cur cs ; back input ; cur tok cs token ag +frozen relax ; back input ;
token type inserted ;
end;
This code is used in section 366.
380. Here is a recursive procedure that is T
E
Xs usual way to get the next token of input. It has been
slightly optimized to take account of common cases.
procedure get x token; sets cur cmd , cur chr , cur tok , and expands macros
label restart , done;
begin restart : get next ;
if cur cmd max command then goto done;
if cur cmd call then
if cur cmd < end template then macro call
else begin cur cs frozen endv ; cur cmd endv ; goto done; cur chr = null list
end
else expand ;
goto restart ;
done: if cur cs = 0 then cur tok (cur cmd 400 ) + cur chr
else cur tok cs token ag + cur cs ;
end;
381. The get x token procedure is equivalent to two consecutive procedure calls: get next ; x token.
procedure x token; get x token without the initial get next
begin while cur cmd > max command do
begin expand ; get next ;
end;
if cur cs = 0 then cur tok (cur cmd 400 ) + cur chr
else cur tok cs token ag + cur cs ;
end;
148 PART 25: EXPANDING THE NEXT TOKEN T
E
X82 382
382. A control sequence that has been \defed by the user is expanded by T
E
Xs macro call procedure.
Before we get into the details of macro call , however, lets consider the treatment of primitives like
\topmark, since they are essentially macros without parameters. The token lists for such marks are kept in
a global array of ve pointers; we refer to the individual entries of this array by symbolic names top mark ,
etc. The value of top mark is either null or a pointer to the reference count of a token list.
dene top mark code = 0 the mark in eect at the previous page break
dene rst mark code = 1 the rst mark between top mark and bot mark
dene bot mark code = 2 the mark in eect at the current page break
dene split rst mark code = 3 the rst mark found by \vsplit
dene split bot mark code = 4 the last mark found by \vsplit
dene top mark cur mark [top mark code]
dene rst mark cur mark [rst mark code]
dene bot mark cur mark [bot mark code]
dene split rst mark cur mark [split rst mark code]
dene split bot mark cur mark [split bot mark code]
Global variables 13 +
cur mark : array [top mark code . . split bot mark code] of pointer ; token lists for marks
383. Set initial values of key variables 21 +
top mark null ; rst mark null ; bot mark null ; split rst mark null ; split bot mark null ;
384. Put each of T
E
Xs primitives into the hash table 226 +
primitive("topmark", top bot mark , top mark code);
primitive("firstmark", top bot mark , rst mark code);
primitive("botmark", top bot mark , bot mark code);
primitive("splitfirstmark", top bot mark , split rst mark code);
primitive("splitbotmark", top bot mark , split bot mark code);
385. Cases of print cmd chr for symbolic printing of primitives 227 +
top bot mark : case chr code of
rst mark code: print esc("firstmark");
bot mark code: print esc("botmark");
split rst mark code: print esc("splitfirstmark");
split bot mark code: print esc("splitbotmark");
othercases print esc("topmark")
endcases;
386. The following code is activated when cur cmd = top bot mark and when cur chr is a code like
top mark code.
Insert the appropriate mark text into the scanner 386
begin if cur mark [cur chr ] ,= null then begin token list (cur mark [cur chr ], mark text );
end
This code is used in section 367.
387 T
E
X82 PART 25: EXPANDING THE NEXT TOKEN 149
387. Now lets consider macro call itself, which is invoked when T
E
X is scanning a control sequence whose
cur cmd is either call , long call , outer call , or long outer call . The control sequence denition appears in
the token list whose reference count is in location cur chr of mem.
The global variable long state will be set to call or to long call , depending on whether or not the control
sequence disallows \par in its parameters. The get next routine will set long state to outer call and emit
\par, if a le ends or if an \outer control sequence occurs in the midst of an argument.
Global variables 13 +
long state: call . . long outer call ; governs the acceptance of \par
388. The parameters, if any, must be scanned before the macro is expanded. Parameters are token lists
without reference counts. They are placed on an auxiliary stack called pstack while they are being scanned,
since the param stack may be losing entries during the matching process. (Note that param stack cant
be gaining entries, since macro call is the only routine that puts anything onto param stack , and it is not
recursive.)
Global variables 13 +
pstack : array [0 . . 8] of pointer ; arguments supplied to a macro
389. After parameter scanning is complete, the parameters are moved to the param stack . Then the macro
body is fed to the scanner; in other words, macro call places the dened text of the control sequence at the
top of T
E
Xs input stack, so that get next will proceed to read it next.
The global variable cur cs contains the eqtb address of the control sequence being expanded, when
macro call begins. If this control sequence has not been declared \long, i.e., if its command code in the
eq type eld is not long call or long outer call , its parameters are not allowed to contain the control sequence
\par. If an illegal \par appears, the macro call is aborted, and the \par will be rescanned.
Declare the procedure called macro call 389
procedure macro call ; invokes a user-dened control sequence
label exit , continue, done, done1 , found ;
var r: pointer ; current node in the macros token list
p: pointer ; current node in parameter token list being built
q: pointer ; new node being put into the token list
s: pointer ; backup pointer for parameter matching
t: pointer ; cycle pointer for backup recovery
u, v: pointer ; auxiliary pointers for backup recovery
rbrace ptr : pointer ; one step before the last right brace token
n: small number ; the number of parameters scanned
unbalance: halfword ; unmatched left braces in current parameter
m: halfword ; the number of tokens or groups (usually)
ref count : pointer ; start of the token list
save scanner status : small number ; scanner status upon entry
save warning index : pointer ; warning index upon entry
match chr : ASCII code; character used in parameter
begin save scanner status scanner status ; save warning index warning index ;
warning index cur cs ; ref count cur chr ; r link (ref count ); n 0;
if tracing macros > 0 then Show the text of the macro being expanded 401 ;
if info(r) ,= end match token then Scan the parameters and make link (r) point to the macro body;
but return if an illegal \par is detected 391 ;
Feed the macro body and its parameters to the scanner 390 ;
exit : scanner status save scanner status ; warning index save warning index ;
end;
This code is used in section 366.
150 PART 25: EXPANDING THE NEXT TOKEN T
E
X82 390
390. Before we put a new token list on the input stack, it is wise to clean o all token lists that have
recently been depleted. Then a user macro that ends with a call to itself will not require unbounded stack
space.
Feed the macro body and its parameters to the scanner 390
while (state = token list ) (loc = null ) (token type ,= v template) do end token list ;
conserve stack space
begin token list (ref count , macro); name warning index ; loc link (r);
if n > 0 then
begin if param ptr + n > max param stack then
begin max param stack param ptr + n;
if max param stack > param size then overow("parameterstacksize", param size);
end;
for m 0 to n 1 do param stack [param ptr + m] pstack [m];
param ptr param ptr + n;
end
This code is used in section 389.
391. At this point, the reader will nd it advisable to review the explanation of token list format that was
presented earlier, since many aspects of that format are of importance chiey in the macro call routine.
The token list might begin with a string of compulsory tokens before the rst match or end match. In
that case the macro name is supposed to be followed by those tokens; the following program will set s = null
to represent this restriction. Otherwise s will be set to the rst token of a string that will delimit the next
parameter.
Scan the parameters and make link (r) point to the macro body; but return if an illegal \par is
detected 391
begin scanner status matching ; unbalance 0; long state eq type(cur cs );
if long state outer call then long state long state 2;
repeat link (temp head ) null ;
if (info(r) > match token + 255) (info(r) < match token) then s null
else begin match chr info(r) match token; s link (r); r s; p temp head ; m 0;
end;
Scan a parameter until its delimiter string has been found; or, if s = null , simply scan the delimiter
string 392 ;
now info(r) is a token whose command code is either match or end match
until info(r) = end match token;
end
This code is used in section 389.
392 T
E
X82 PART 25: EXPANDING THE NEXT TOKEN 151
392. If info(r) is a match or end match command, it cannot be equal to any token found by get token.
Therefore an undelimited parameteri.e., a match that is immediately followed by match or end match
will always fail the test cur tok = info(r) in the following algorithm.
Scan a parameter until its delimiter string has been found; or, if s = null , simply scan the delimiter
string 392
continue: get token; set cur tok to the next token of input
if cur tok = info(r) then Advance r; goto found if the parameter delimiter has been fully matched,
otherwise goto continue 394 ;
Contribute the recently matched tokens to the current parameter, and goto continue if a partial match
is still in eect; but abort if s = null 397 ;
if cur tok = par token then
if long state ,= long call then Report a runaway argument and abort 396 ;
if cur tok < right brace limit then
if cur tok < left brace limit then Contribute an entire group to the current parameter 399
else Report an extra right brace and goto continue 395
else Store the current token, but goto continue if it is a blank space that would become an undelimited
parameter 393 ;
incr (m);
if info(r) > end match token then goto continue;
if info(r) < match token then goto continue;
found : if s ,= null then Tidy up the parameter just scanned, and tuck it away 400
This code is used in section 391.
393. Store the current token, but goto continue if it is a blank space that would become an undelimited
parameter 393
begin if cur tok = space token then
if info(r) end match token then
if info(r) match token then goto continue;
store new token(cur tok );
end
This code is used in section 392.
394. A slightly subtle point arises here: When the parameter delimiter ends with #{, the token list will
have a left brace both before and after the end match. Only one of these should aect the align state, but
both will be scanned, so we must make a correction.
Advance r; goto found if the parameter delimiter has been fully matched, otherwise goto continue 394
begin r link (r);
if (info(r) match token) (info(r) end match token) then
begin if cur tok < left brace limit then decr (align state);
goto found ;
end
else goto continue;
end
This code is used in section 392.
152 PART 25: EXPANDING THE NEXT TOKEN T
E
X82 395
395. Report an extra right brace and goto continue 395
begin back input ; print err ("Argumentof"); sprint cs (warning index ); print ("hasanextra}");
help6 ("Iverunacrossa`}thatdoesntseemtomatchanything.")
("Forexample,`\def\a#1{...}and`\a}wouldproduce")
("thiserror.Ifyousimplyproceednow,the`\parthat")
("Ivejustinsertedwillcausemetoreportarunaway")
("argumentthatmightbetherootoftheproblem.Butif")
("your`}wasspurious,justtype`2anditwillgoaway."); incr (align state);
long state call ; cur tok par token; ins error ; goto continue;
end a white lie; the \par wont always trigger a runaway
This code is used in section 392.
396. If long state = outer call , a runaway argument has already been reported.
Report a runaway argument and abort 396
begin if long state = call then
begin runaway; print err ("Paragraphendedbefore"); sprint cs (warning index );
print ("wascomplete");
help3 ("Isuspectyouveforgottena`},causingmetoapplythis")
("controlsequencetotoomuchtext.Howcanwerecover?")
("Myplanistoforgetthewholethingandhopeforthebest."); back error ;
end;
pstack [n] link (temp head ); align state align state unbalance;
for m 0 to n do ush list (pstack [m]);
return;
end
This code is used in sections 392 and 399.
397 T
E
X82 PART 25: EXPANDING THE NEXT TOKEN 153
397. When the following code becomes active, we have matched tokens from s to the predecessor of r, and
we have found that cur tok ,= info(r). An interesting situation now presents itself: If the parameter is to be
delimited by a string such as ab, and if we have scanned aa, we want to contribute one a to the current
parameter and resume looking for a b. The program must account for such partial matches and for others
that can be quite complex. But most of the time we have s = r and nothing needs to be done.
Incidentally, it is possible for \par tokens to sneak in to certain parameters of non-\long macros. For
example, consider a case like \def\a#1\par!{...} where the rst \par is not followed by an exclamation
point. In such situations it does not seem appropriate to prohibit the \par, so T
E
X keeps quiet about this
bending of the rules.
Contribute the recently matched tokens to the current parameter, and goto continue if a partial match is
still in eect; but abort if s = null 397
if s ,= r then
if s = null then Report an improper use of the macro and abort 398
else begin t s;
repeat store new token(info(t)); incr (m); u link (t); v s;
loop begin if u = r then
if cur tok ,= info(v) then goto done
else begin r link (v); goto continue;
end;
if info(u) ,= info(v) then goto done;
u link (u); v link (v);
end;
done: t link (t);
until t = r;
r s; at this point, no tokens are recently matched
end
This code is used in section 392.
398. Report an improper use of the macro and abort 398
begin print err ("Useof"); sprint cs (warning index ); print ("doesntmatchitsdefinition");
help4 ("Ifyousay,e.g.,`\def\a1{...},thenyoumustalways")
("put`1after`\a,sincecontrolsequencenamesare")
("madeupoflettersonly.Themacroherehasnotbeen")
("followedbytherequiredstuff,soImignoringit."); error ; return;
end
This code is used in section 397.
399. Contribute an entire group to the current parameter 399
begin unbalance 1;
loop begin fast store new token(cur tok ); get token;
if cur tok = par token then
if long state ,= long call then Report a runaway argument and abort 396 ;
if cur tok < right brace limit then
if cur tok < left brace limit then incr (unbalance)
else begin decr (unbalance);
if unbalance = 0 then goto done1 ;
end;
end;
done1 : rbrace ptr p; store new token(cur tok );
end
This code is used in section 392.
154 PART 25: EXPANDING THE NEXT TOKEN T
E
X82 400
400. If the parameter consists of a single group enclosed in braces, we must strip o the enclosing braces.
Thats why rbrace ptr was introduced.
Tidy up the parameter just scanned, and tuck it away 400
begin if (m = 1) (info(p) < right brace limit ) (p ,= temp head ) then
begin link (rbrace ptr ) null ; free avail (p); p link (temp head ); pstack [n] link (p); free avail (p);
end
else pstack [n] link (temp head );
incr (n);
if tracing macros > 0 then
begin begin diagnostic; print nl (match chr ); print int (n); print ("<");
show token list (pstack [n 1], null , 1000); end diagnostic(false);
end;
end
This code is used in section 392.
401. Show the text of the macro being expanded 401
begin begin diagnostic; print ln; print cs (warning index ); token show(ref count );
end diagnostic(false);
end
This code is used in section 389.
402 T
E
X82 PART 26: BASIC SCANNING SUBROUTINES 155
402. Basic scanning subroutines. Lets turn now to some procedures that T
E
X calls upon frequently
to digest certain kinds of patterns in the input. Most of these are quite simple; some are quite elaborate.
Almost all of the routines call get x token, which can cause them to be invoked recursively.
403. The scan left brace routine is called when a left brace is supposed to be the next non-blank token.
(The term left brace means, more precisely, a character whose catcode is left brace.) T
E
X allows \relax
to appear before the left brace.
procedure scan left brace; reads a mandatory left brace
begin Get the next non-blank non-relax non-call token 404 ;
if cur cmd ,= left brace then
begin print err ("Missing{inserted");
help4 ("Aleftbracewasmandatoryhere,soIveputonein.")
("Youmightwanttodeleteand/orinsertsomecorrections")
("sothatIwillfindamatchingrightbracesoon.")
("(Ifyoureconfusedbyallthis,trytyping`I}now.)"); back error ;
cur tok left brace token + "{"; cur cmd left brace; cur chr "{"; incr (align state);
end;
end;
404. Get the next non-blank non-relax non-call token 404
repeat get x token;
until (cur cmd ,= spacer ) (cur cmd ,= relax )
This code is used in sections 403, 1078, 1084, 1151, 1160, 1211, 1226, and 1270.
405. The scan optional equals routine looks for an optional = sign preceded by optional spaces; \relax
is not ignored here.
procedure scan optional equals ;
begin Get the next non-blank non-call token 406 ;
if cur tok ,= other token + "=" then back input ;
end;
406. Get the next non-blank non-call token 406
repeat get x token;
until cur cmd ,= spacer
This code is used in sections 405, 441, 455, 503, 526, 577, 785, 791, and 1045.
156 PART 26: BASIC SCANNING SUBROUTINES T
E
X82 407
407. In case you are getting bored, here is a slightly less trivial routine: Given a string of lowercase letters,
like pt or plus or width, the scan keyword routine checks to see whether the next tokens of input match
this string. The match must be exact, except that uppercase letters will match their lowercase counterparts;
uppercase equivalents are determined by subtracting "a" "A", rather than using the uc code table, since
T
E
X uses this routine only for its own limited set of keywords.
If a match is found, the characters are eectively removed from the input and true is returned. Otherwise
false is returned, and the input is left essentially unchanged (except for the fact that some macros may have
been expanded, etc.).
function scan keyword (s : str number ): boolean; look for a given string
label exit ;
var p: pointer ; tail of the backup list
q: pointer ; new node being added to the token list via store new token
k: pool pointer ; index into str pool
begin p backup head ; link (p) null ; k str start [s];
while k < str start [s + 1] do
begin get x token; recursion is possible here
if (cur cs = 0) ((cur chr = so(str pool [k])) (cur chr = so(str pool [k]) "a" + "A")) then
begin store new token(cur tok ); incr (k);
end
else if (cur cmd ,= spacer ) (p ,= backup head ) then
begin back input ;
if p ,= backup head then back list (link (backup head ));
scan keyword false; return;
end;
end;
ush list (link (backup head )); scan keyword true;
exit : end;
408. Here is a procedure that sounds an alarm when mu and non-mu units are being switched.
procedure mu error ;
begin print err ("Incompatibleglueunits");
help1 ("Imgoingtoassumethat1mu=1ptwhentheyremixed."); error ;
end;
409. The next routine scan something internal is used to fetch internal numeric quantities like \hsize,
and also to handle the \the when expanding constructions like \the\toks0 and \the\baselineskip.
Soon we will be considering the scan int procedure, which calls scan something internal ; on the other hand,
scan something internal also calls scan int , for constructions like \catcode`\$ or \fontdimen 3 \ff. So
we have to declare scan int as a forward procedure. A few other procedures are also declared at this point.
procedure scan int ; forward ; scans an integer value
Declare procedures that scan restricted classes of integers 433
Declare procedures that scan font-related stu 577
410 T
E
X82 PART 26: BASIC SCANNING SUBROUTINES 157
410. T
E
X doesnt know exactly what to expect when scan something internal begins. For example, an
integer or dimension or glue value could occur immediately after \hskip; and one can even say \the with
respect to token lists in constructions like \xdef\o{\the\output}. On the other hand, only integers are
allowed after a construction like \count. To handle the various possibilities, scan something internal has
a level parameter, which tells the highest kind of quantity that scan something internal is allowed to
produce. Six levels are distinguished, namely int val , dimen val , glue val , mu val , ident val , and tok val .
The output of scan something internal (and of the other routines scan int , scan dimen, and scan glue
below) is put into the global variable cur val , and its level is put into cur val level . The highest values of
cur val level are special: mu val is used only when cur val points to something in a muskip register, or to
one of the three parameters \thinmuskip, \medmuskip, \thickmuskip; ident val is used only when cur val
points to a font identier; tok val is used only when cur val points to null or to the reference count of a
token list. The last two cases are allowed only when scan something internal is called with level = tok val .
If the output is glue, cur val will point to a glue specication, and the reference count of that glue will
have been updated to reect this reference; if the output is a nonempty token list, cur val will point to its
reference count, but in this case the count will not have been updated. Otherwise cur val will contain the
integer or scaled value in question.
dene int val = 0 integer values
dene dimen val = 1 dimension values
dene glue val = 2 glue specications
dene mu val = 3 math glue specications
dene ident val = 4 font identier
dene tok val = 5 token lists
Global variables 13 +
cur val : integer ; value returned by numeric scanners
cur val level : int val . . tok val ; the level of this value
411. The hash table is initialized with \count, \dimen, \skip, and \muskip all having register as
their command code; they are distinguished by the chr code, which is either int val , dimen val , glue val , or
mu val .
Put each of T
E
Xs primitives into the hash table 226 +
primitive("count", register , int val ); primitive("dimen", register , dimen val );
primitive("skip", register , glue val ); primitive("muskip", register , mu val );
412. Cases of print cmd chr for symbolic printing of primitives 227 +
register : if chr code = int val then print esc("count")
else if chr code = dimen val then print esc("dimen")
else if chr code = glue val then print esc("skip")
else print esc("muskip");
158 PART 26: BASIC SCANNING SUBROUTINES T
E
X82 413
413. OK, were ready for scan something internal itself. A second parameter, negative, is set true if
the value that is found should be negated. It is assumed that cur cmd and cur chr represent the rst
token of the internal quantity to be scanned; an error will be signalled if cur cmd < min internal or
cur cmd > max internal .
dene scanned result end (#) cur val level #; end
dene scanned result (#) begin cur val #; scanned result end
procedure scan something internal (level : small number ; negative : boolean);
fetch an internal parameter
var m: halfword ; chr code part of the operand token
p: 0 . . nest size; index into nest
begin m cur chr ;
case cur cmd of
def code: Fetch a character code from some table 414 ;
toks register , assign toks , def family, set font , def font : Fetch a token list or font identier, provided
that level = tok val 415 ;
assign int : scanned result (eqtb[m].int )(int val );
assign dimen: scanned result (eqtb[m].sc)(dimen val );
assign glue: scanned result (equiv (m))(glue val );
assign mu glue: scanned result (equiv (m))(mu val );
set aux : Fetch the space factor or the prev depth 418 ;
set prev graf : Fetch the prev graf 422 ;
set page int : Fetch the dead cycles or the insert penalties 419 ;
set page dimen: Fetch something on the page so far 421 ;
set shape: Fetch the par shape size 423 ;
set box dimen: Fetch a box dimension 420 ;
char given, math given: scanned result (cur chr )(int val );
assign font dimen: Fetch a font dimension 425 ;
assign font int : Fetch a font integer 426 ;
register : Fetch a register 427 ;
last item: Fetch an item in the current node, if appropriate 424 ;
othercases Complain that \the cant do this; give zero result 428
endcases;
while cur val level > level do Convert cur val to a lower level 429 ;
Fix the reference count, if any, and negate cur val if negative 430 ;
end;
414. Fetch a character code from some table 414
begin scan char num;
if m = math code base then scanned result (ho(math code(cur val )))(int val )
else if m < math code base then scanned result (equiv (m + cur val ))(int val )
else scanned result (eqtb[m + cur val ].int )(int val );
end
This code is used in section 413.
415 T
E
X82 PART 26: BASIC SCANNING SUBROUTINES 159
415. Fetch a token list or font identier, provided that level = tok val 415
if level ,= tok val then
begin print err ("Missingnumber,treatedaszero");
help3 ("Anumbershouldhavebeenhere;Iinserted`0.")
("(IfyoucantfigureoutwhyIneededtoseeanumber,")
("lookup`weirderrorintheindextoTheTeXbook.)"); back error ;
scanned result (0)(dimen val );
end
else if cur cmd assign toks then
begin if cur cmd < assign toks then cur cmd = toks register
begin scan eight bit int ; m toks base + cur val ;
end;
scanned result (equiv (m))(tok val );
end
else begin back input ; scan font ident ; scanned result (font id base + cur val )(ident val );
end
This code is used in section 413.
416. Users refer to \the\spacefactor only in horizontal mode, and to \the\prevdepth only in vertical
mode; so we put the associated mode in the modier part of the set aux command. The set page int
command has modier 0 or 1, for \deadcycles and \insertpenalties, respectively. The set box dimen
command is modied by either width oset , height oset , or depth oset . And the last item command is
modied by either int val , dimen val , glue val , input line no code, or badness code.
dene input line no code = glue val + 1 code for \inputlineno
dene badness code = glue val + 2 code for \badness
Put each of T
E
Xs primitives into the hash table 226 +
primitive("spacefactor", set aux , hmode); primitive("prevdepth", set aux , vmode);
primitive("deadcycles", set page int , 0); primitive("insertpenalties", set page int , 1);
primitive("wd", set box dimen, width oset ); primitive("ht", set box dimen, height oset );
primitive("dp", set box dimen, depth oset ); primitive("lastpenalty", last item, int val );
primitive("lastkern", last item, dimen val ); primitive("lastskip", last item, glue val );
primitive("inputlineno", last item, input line no code); primitive("badness", last item, badness code);
417. Cases of print cmd chr for symbolic printing of primitives 227 +
set aux : if chr code = vmode then print esc("prevdepth") else print esc("spacefactor");
set page int : if chr code = 0 then print esc("deadcycles") else print esc("insertpenalties");
set box dimen: if chr code = width oset then print esc("wd")
else if chr code = height oset then print esc("ht")
else print esc("dp");
last item: case chr code of
int val : print esc("lastpenalty");
dimen val : print esc("lastkern");
glue val : print esc("lastskip");
input line no code: print esc("inputlineno");
othercases print esc("badness")
endcases;
160 PART 26: BASIC SCANNING SUBROUTINES T
E
X82 418
418. Fetch the space factor or the prev depth 418
if abs (mode) ,= m then
begin print err ("Improper"); print cmd chr (set aux , m);
help4 ("Youcanreferto\spacefactoronlyinhorizontalmode;")
("youcanreferto\prevdepthonlyinverticalmode;and")
("neitheroftheseismeaningfulinside\write.So")
("Imforgettingwhatyousaidandusingzeroinstead."); error ;
if level ,= tok val then scanned result (0)(dimen val )
else scanned result (0)(int val );
end
else if m = vmode then scanned result (prev depth)(dimen val )
else scanned result (space factor )(int val )
This code is used in section 413.
419. Fetch the dead cycles or the insert penalties 419
begin if m = 0 then cur val dead cycles else cur val insert penalties ;
cur val level int val ;
end
This code is used in section 413.
420. Fetch a box dimension 420
begin scan eight bit int ;
if box (cur val ) = null then cur val 0 else cur val mem[box (cur val ) + m].sc;
cur val level dimen val ;
end
This code is used in section 413.
421. Inside an \output routine, a user may wish to look at the page totals that were present at the moment
when output was triggered.
dene max dimen 7777777777 2
30
1
Fetch something on the page so far 421
begin if (page contents = empty) (output active) then
if m = 0 then cur val max dimen else cur val 0
else cur val page so far [m];
cur val level dimen val ;
end
This code is used in section 413.
422. Fetch the prev graf 422
if mode = 0 then scanned result (0)(int val ) prev graf = 0 within \write
else begin nest [nest ptr ] cur list ; p nest ptr ;
while abs (nest [p].mode eld ) ,= vmode do decr (p);
scanned result (nest [p].pg eld )(int val );
end
This code is used in section 413.
423 T
E
X82 PART 26: BASIC SCANNING SUBROUTINES 161
423. Fetch the par shape size 423
begin if par shape ptr = null then cur val 0
else cur val info(par shape ptr );
cur val level int val ;
end
This code is used in section 413.
424. Here is where \lastpenalty, \lastkern, and \lastskip are implemented. The reference count for
\lastskip will be updated later.
We also handle \inputlineno and \badness here, because they are legal in similar contexts.
Fetch an item in the current node, if appropriate 424
if cur chr > glue val then
begin if cur chr = input line no code then cur val line
else cur val last badness ; cur chr = badness code
cur val level int val ;
end
else begin if cur chr = glue val then cur val zero glue else cur val 0;
cur val level cur chr ;
if is char node(tail ) (mode ,= 0) then
case cur chr of
int val : if type(tail ) = penalty node then cur val penalty(tail );
dimen val : if type(tail ) = kern node then cur val width(tail );
glue val : if type(tail ) = glue node then
begin cur val glue ptr (tail );
if subtype(tail ) = mu glue then cur val level mu val ;
end;
end there are no other cases
else if (mode = vmode) (tail = head ) then
case cur chr of
int val : cur val last penalty;
dimen val : cur val last kern;
glue val : if last glue ,= max halfword then cur val last glue;
end; there are no other cases
end
This code is used in section 413.
425. Fetch a font dimension 425
begin nd font dimen(false); font info[fmem ptr ].sc 0;
scanned result (font info[cur val ].sc)(dimen val );
end
This code is used in section 413.
426. Fetch a font integer 426
begin scan font ident ;
if m = 0 then scanned result (hyphen char [cur val ])(int val )
else scanned result (skew char [cur val ])(int val );
end
This code is used in section 413.
162 PART 26: BASIC SCANNING SUBROUTINES T
E
X82 427
427. Fetch a register 427
begin scan eight bit int ;
case m of
int val : cur val count (cur val );
dimen val : cur val dimen(cur val );
glue val : cur val skip(cur val );
mu val : cur val mu skip(cur val );
end; there are no other cases
cur val level m;
end
This code is used in section 413.
428. Complain that \the cant do this; give zero result 428
begin print err ("Youcantuse`"); print cmd chr (cur cmd , cur chr ); print ("after");
print esc("the"); help1 ("Imforgettingwhatyousaidandusingzeroinstead."); error ;
if level ,= tok val then scanned result (0)(dimen val )
else scanned result (0)(int val );
end
This code is used in section 413.
429. When a glue val changes to a dimen val , we use the width component of the glue; there is no need to
decrease the reference count, since it has not yet been increased. When a dimen val changes to an int val ,
we use scaled points so that the value doesnt actually change. And when a mu val changes to a glue val ,
the value doesnt change either.
Convert cur val to a lower level 429
begin if cur val level = glue val then cur val width(cur val )
else if cur val level = mu val then mu error ;
decr (cur val level );
end
This code is used in section 413.
430. If cur val points to a glue specication at this point, the reference count for the glue does not yet
include the reference by cur val . If negative is true, cur val level is known to be mu val .
Fix the reference count, if any, and negate cur val if negative 430
if negative then
if cur val level glue val then
begin cur val new spec(cur val ); Negate all three glue components of cur val 431 ;
end
else negate(cur val )
else if (cur val level glue val ) (cur val level mu val ) then add glue ref (cur val )
This code is used in section 413.
431. Negate all three glue components of cur val 431
begin negate(width(cur val )); negate(stretch(cur val )); negate(shrink (cur val ));
end
This code is used in section 430.
432. Our next goal is to write the scan int procedure, which scans anything that T
E
X treats as an integer.
But rst we might as well look at some simple applications of scan int that have already been made inside
of scan something internal .
433 T
E
X82 PART 26: BASIC SCANNING SUBROUTINES 163
433. Declare procedures that scan restricted classes of integers 433
procedure scan eight bit int ;
begin scan int ;
if (cur val < 0) (cur val > 255) then
begin print err ("Badregistercode");
help2 ("Aregisternumbermustbebetween0and255.")
("Ichangedthisonetozero."); int error (cur val ); cur val 0;
end;
end;
See also sections 434, 435, 436, and 437.
This code is used in section 409.
434. Declare procedures that scan restricted classes of integers 433 +
procedure scan char num;
begin scan int ;
if (cur val < 0) (cur val > 255) then
begin print err ("Badcharactercode");
help2 ("Acharacternumbermustbebetween0and255.")
("Ichangedthisonetozero."); int error (cur val ); cur val 0;
end;
end;
435. While were at it, we might as well deal with similar routines that will be needed later.
Declare procedures that scan restricted classes of integers 433 +
procedure scan four bit int ;
begin scan int ;
if (cur val < 0) (cur val > 15) then
begin print err ("Badnumber");
help2 ("SinceIexpectedtoreadanumberbetween0and15,")
("Ichangedthisonetozero."); int error (cur val ); cur val 0;
end;
end;
436. Declare procedures that scan restricted classes of integers 433 +
procedure scan fteen bit int ;
begin scan int ;
if (cur val < 0) (cur val > 77777 ) then
begin print err ("Badmathchar"); help2 ("Amathcharnumbermustbebetween0and32767.")
("Ichangedthisonetozero."); int error (cur val ); cur val 0;
end;
end;
437. Declare procedures that scan restricted classes of integers 433 +
procedure scan twenty seven bit int ;
begin scan int ;
if (cur val < 0) (cur val > 777777777 ) then
begin print err ("Baddelimitercode");
help2 ("Anumericdelimitercodemustbebetween0and2^{27}1.")
("Ichangedthisonetozero."); int error (cur val ); cur val 0;
end;
end;
164 PART 26: BASIC SCANNING SUBROUTINES T
E
X82 438
438. An integer number can be preceded by any number of spaces and + or signs. Then comes either
a decimal constant (i.e., radix 10), an octal constant (i.e., radix 8, preceded by ), a hexadecimal constant
(radix 16, preceded by "), an alphabetic constant (preceded by `), or an internal variable. After scanning is
complete, cur val will contain the answer, which must be at most 2
31
1 = 2147483647 in absolute value.
The value of radix is set to 10, 8, or 16 in the cases of decimal, octal, or hexadecimal constants, otherwise
radix is set to zero. An optional space follows a constant.
dene octal token = other token + "" apostrophe, indicates an octal constant
dene hex token = other token + """" double quote, indicates a hex constant
dene alpha token = other token + "`" reverse apostrophe, precedes alpha constants
dene point token = other token + "." decimal point
dene continental point token = other token + "," decimal point, Eurostyle
Global variables 13 +
radix : small number ; scan int sets this to 8, 10, 16, or zero
439. We initialize the following global variables just in case expand comes into action before any of the
basic scanning routines has assigned them a value.
Set initial values of key variables 21 +
cur val 0; cur val level int val ; radix 0; cur order normal ;
440. The scan int routine is used also to scan the integer part of a fraction; for example, the 3 in
3.14159 will be found by scan int . The scan dimen routine assumes that cur tok = point token after the
integer part of such a fraction has been scanned by scan int , and that the decimal point has been backed
up to be scanned again.
procedure scan int ; sets cur val to an integer
label done;
var negative: boolean; should the answer be negated?
m: integer ; 2
31
div radix , the threshold of danger
d: small number ; the digit just scanned
vacuous : boolean; have no digits appeared?
OK so far : boolean; has an error message been issued?
begin radix 0; OK so far true;
Get the next non-blank non-sign token; set negative appropriately 441 ;
if cur tok = alpha token then Scan an alphabetic character code into cur val 442
else if (cur cmd min internal ) (cur cmd max internal ) then
scan something internal (int val , false)
else Scan a numeric constant 444 ;
if negative then negate(cur val );
end;
441. Get the next non-blank non-sign token; set negative appropriately 441
negative false;
repeat Get the next non-blank non-call token 406 ;
if cur tok = other token + "" then
begin negative negative; cur tok other token + "+";
end;
until cur tok ,= other token + "+"
This code is used in sections 440, 448, and 461.
442 T
E
X82 PART 26: BASIC SCANNING SUBROUTINES 165
442. A space is ignored after an alphabetic character constant, so that such constants behave like numeric
ones.
Scan an alphabetic character code into cur val 442
begin get token; suppress macro expansion
if cur tok < cs token ag then
begin cur val cur chr ;
if cur cmd right brace then
if cur cmd = right brace then incr (align state)
else decr (align state);
end
else if cur tok < cs token ag + single base then cur val cur tok cs token ag active base
else cur val cur tok cs token ag single base;
if cur val > 255 then
begin print err ("Improperalphabeticconstant");
help2 ("Aonecharactercontrolsequencebelongsaftera`mark.")
("SoImessentiallyinserting\0here."); cur val "0"; back error ;
end
else Scan an optional space 443 ;
end
This code is used in section 440.
443. Scan an optional space 443
begin get x token;
if cur cmd ,= spacer then back input ;
end
This code is used in sections 442, 448, 455, and 1200.
444. Scan a numeric constant 444
begin radix 10; m 214748364;
if cur tok = octal token then
begin radix 8; m 2000000000 ; get x token;
end
else if cur tok = hex token then
begin radix 16; m 1000000000 ; get x token;
end;
vacuous true; cur val 0;
Accumulate the constant until cur tok is not a suitable digit 445 ;
if vacuous then Express astonishment that no number was here 446
else if cur cmd ,= spacer then back input ;
end
This code is used in section 440.
166 PART 26: BASIC SCANNING SUBROUTINES T
E
X82 445
445. dene innity 17777777777 the largest positive value that T
E
X knows
dene zero token = other token + "0" zero, the smallest digit
dene A token = letter token + "A" the smallest special hex digit
dene other A token = other token + "A" special hex digit of type other char
Accumulate the constant until cur tok is not a suitable digit 445
loop begin if (cur tok < zero token + radix ) (cur tok zero token) (cur tok zero token + 9)
then d cur tok zero token
else if radix = 16 then
if (cur tok A token + 5) (cur tok A token) then d cur tok A token + 10
else if (cur tok other A token + 5) (cur tok other A token) then
d cur tok other A token + 10
else goto done
else goto done;
vacuous false;
if (cur val m) ((cur val > m) (d > 7) (radix ,= 10)) then
begin if OK so far then
begin print err ("Numbertoobig");
help2 ("Icanonlygoupto2147483647=17777777777=""7FFFFFFF,")
("soImusingthatnumberinsteadofyours."); error ; cur val innity;
OK so far false;
end;
end
else cur val cur val radix + d;
get x token;
end;
done:
This code is used in section 444.
446. Express astonishment that no number was here 446
begin print err ("Missingnumber,treatedaszero");
help3 ("Anumbershouldhavebeenhere;Iinserted`0.")
("(IfyoucantfigureoutwhyIneededtoseeanumber,")
("lookup`weirderrorintheindextoTheTeXbook.)"); back error ;
end
This code is used in section 444.
447. The scan dimen routine is similar to scan int , but it sets cur val to a scaled value, i.e., an integral
number of sp. One of its main tasks is therefore to interpret the abbreviations for various kinds of units and
to convert measurements to scaled points.
There are three parameters: mu is true if the nite units must be mu, while mu is false if mu units
are disallowed; inf is true if the innite units fil, fill, filll are permitted; and shortcut is true if
cur val already contains an integer and only the units need to be considered.
The order of innity that was found in the case of innite glue is returned in the global variable cur order .
Global variables 13 +
cur order : glue ord ; order of innity found by scan dimen
448 T
E
X82 PART 26: BASIC SCANNING SUBROUTINES 167
448. Constructions like 77 pt are legal dimensions, so scan dimen may begin with scan int . This
explains why it is convenient to use scan int also for the integer part of a decimal fraction.
Several branches of scan dimen work with cur val as an integer and with an auxiliary fraction f, so that
the actual quantity of interest is cur val +f/2
16
. At the end of the routine, this unpacked representation
is put into the single word cur val , which suddenly switches signicance from integer to scaled .
dene attach fraction = 88 go here to pack cur val and f into cur val
dene attach sign = 89 go here when cur val is correct except perhaps for sign
dene scan normal dimen scan dimen(false, false, false)
procedure scan dimen(mu, inf , shortcut : boolean); sets cur val to a dimension
label done, done1 , done2 , found , not found , attach fraction, attach sign;
var negative: boolean; should the answer be negated?
f: integer ; numerator of a fraction whose denominator is 2
16

Local variables for dimension calculations 450

begin f 0; arith error false; cur order normal ; negative false;
if shortcut then
begin Get the next non-blank non-sign token; set negative appropriately 441 ;
if (cur cmd min internal ) (cur cmd max internal ) then
Fetch an internal dimension and goto attach sign, or fetch an internal integer 449
else begin back input ;
if cur tok = continental point token then cur tok point token;
if cur tok ,= point token then scan int
else begin radix 10; cur val 0;
end;
if cur tok = continental point token then cur tok point token;
if (radix = 10) (cur tok = point token) then Scan decimal fraction 452 ;
end;
end;
if cur val < 0 then in this case f = 0
begin negative negative; negate(cur val );
end;
Scan units and set cur val to x (cur val + f/2
16
), where there are x sp per unit; goto attach sign if
the units are internal 453 ;
Scan an optional space 443 ;
attach sign: if arith error (abs (cur val ) 10000000000 ) then
Report that this dimension is out of range 460 ;
if negative then negate(cur val );
end;
449. Fetch an internal dimension and goto attach sign, or fetch an internal integer 449
if mu then
begin scan something internal (mu val , false); Coerce glue to a dimension 451 ;
if cur val level = mu val then goto attach sign;
if cur val level ,= int val then mu error ;
end
else begin scan something internal (dimen val , false);
if cur val level = dimen val then goto attach sign;
end
This code is used in section 448.
168 PART 26: BASIC SCANNING SUBROUTINES T
E
X82 450
450. Local variables for dimension calculations 450
num, denom: 1 . . 65536; conversion ratio for the scanned units
k, kk : small number ; number of digits in a decimal fraction
p, q: pointer ; top of decimal digit stack
v: scaled ; an internal dimension
save cur val : integer ; temporary storage of cur val
This code is used in section 448.
451. The following code is executed when scan something internal was called asking for mu val , when we
really wanted a mudimen instead of muglue.
Coerce glue to a dimension 451
if cur val level glue val then
begin v width(cur val ); delete glue ref (cur val ); cur val v;
end
This code is used in sections 449 and 455.
452. When the following code is executed, we have cur tok = point token, but this token has been backed
up using back input ; we must rst discard it.
It turns out that a decimal point all by itself is equivalent to 0.0. Lets hope people dont use that fact.
Scan decimal fraction 452
begin k 0; p null ; get token; point token is being re-scanned
loop begin get x token;
if (cur tok > zero token + 9) (cur tok < zero token) then goto done1 ;
if k < 17 then digits for k 17 cannot aect the result
begin q get avail ; link (q) p; info(q) cur tok zero token; p q; incr (k);
end;
end;
done1 : for kk k downto 1 do
begin dig [kk 1] info(p); q p; p link (p); free avail (q);
end;
f round decimals (k);
if cur cmd ,= spacer then back input ;
end
This code is used in section 448.
453 T
E
X82 PART 26: BASIC SCANNING SUBROUTINES 169
453. Now comes the harder part: At this point in the program, cur val is a nonnegative integer and f/2
16
is a nonnegative fraction less than 1; we want to multiply the sum of these two quantities by the appropriate
factor, based on the specied units, in order to produce a scaled result, and we want to do the calculation
with xed point arithmetic that does not overow.
Scan units and set cur val to x (cur val + f/2
16
), where there are x sp per unit; goto attach sign if the
units are internal 453
if inf then Scan for fil units; goto attach fraction if found 454 ;
Scan for units that are internal dimensions; goto attach sign with cur val set if found 455 ;
if mu then Scan for mu units and goto attach fraction 456 ;
if scan keyword ("true") then Adjust for the magnication ratio 457 ;
if scan keyword ("pt") then goto attach fraction; the easy case
Scan for all other units and adjust cur val and f accordingly; goto done in the case of scaled
points 458 ;
attach fraction: if cur val 40000 then arith error true
else cur val cur val unity + f;
done:
This code is used in section 448.
454. A specication like filllll or fill L L L will lead to two error messages (one for each additional
keyword "l").
Scan for fil units; goto attach fraction if found 454
if scan keyword ("fil") then
begin cur order l ;
while scan keyword ("l") do
begin if cur order = lll then
begin print err ("Illegalunitofmeasure("); print ("replacedbyfilll)");
help1 ("Idddontgoanyhigherthanfilll."); error ;
end
else incr (cur order );
end;
goto attach fraction;
end
This code is used in section 453.
170 PART 26: BASIC SCANNING SUBROUTINES T
E
X82 455
455. Scan for units that are internal dimensions; goto attach sign with cur val set if found 455
save cur val cur val ; Get the next non-blank non-call token 406 ;
if (cur cmd < min internal ) (cur cmd > max internal ) then back input
else begin if mu then
begin scan something internal (mu val , false); Coerce glue to a dimension 451 ;
if cur val level ,= mu val then mu error ;
end
else scan something internal (dimen val , false);
v cur val ; goto found ;
end;
if mu then goto not found ;
if scan keyword ("em") then v ( The em width for cur font 558 )
else if scan keyword ("ex") then v ( The x-height for cur font 559 )
else goto not found ;
Scan an optional space 443 ;
found : cur val nx plus y(save cur val , v, xn over d (v, f, 200000 )); goto attach sign;
not found :
This code is used in section 453.
456. Scan for mu units and goto attach fraction 456
if scan keyword ("mu") then goto attach fraction
else begin print err ("Illegalunitofmeasure("); print ("muinserted)");
help4 ("Theunitofmeasurementinmathgluemustbemu.")
("Torecovergracefullyfromthiserror,itsbestto")
("deletetheerroneousunits;e.g.,type`2todelete")
("twoletters.(SeeChapter27ofTheTeXbook.)"); error ; goto attach fraction;
end
This code is used in section 453.
457. Adjust for the magnication ratio 457
begin prepare mag ;
if mag ,= 1000 then
begin cur val xn over d (cur val , 1000, mag ); f (1000 f + 200000 remainder ) div mag ;
cur val cur val + (f div 200000 ); f f mod 200000 ;
end;
end
This code is used in section 453.
458 T
E
X82 PART 26: BASIC SCANNING SUBROUTINES 171
458. The necessary conversion factors can all be specied exactly as fractions whose numerator and
denominator sum to 32768 or less. According to the denitions here, 2660 dd 1000.33297 mm; this agrees
well with the value 1000.333 mm cited by Bosshard in Technische Grundlagen zur Satzherstellung (Bern,
1980).
dene set conversion end (#) denom #;
end
dene set conversion(#) begin num #; set conversion end
Scan for all other units and adjust cur val and f accordingly; goto done in the case of scaled points 458
if scan keyword ("in") then set conversion(7227)(100)
else if scan keyword ("pc") then set conversion(12)(1)
else if scan keyword ("cm") then set conversion(7227)(254)
else if scan keyword ("mm") then set conversion(7227)(2540)
else if scan keyword ("bp") then set conversion(7227)(7200)
else if scan keyword ("dd") then set conversion(1238)(1157)
else if scan keyword ("cc") then set conversion(14856)(1157)
else if scan keyword ("sp") then goto done
else Complain about unknown unit and goto done2 459 ;
cur val xn over d (cur val , num, denom); f (num f + 200000 remainder ) div denom;
cur val cur val + (f div 200000 ); f f mod 200000 ;
done2 :
This code is used in section 453.
459. Complain about unknown unit and goto done2 459
begin print err ("Illegalunitofmeasure("); print ("ptinserted)");
help6 ("Dimensionscanbeinunitsofem,ex,in,pt,pc,")
("cm,mm,dd,cc,bp,orsp;butyoursisanewone!")
("Illassumethatyoumeanttosaypt,forprinterspoints.")
("Torecovergracefullyfromthiserror,itsbestto")
("deletetheerroneousunits;e.g.,type`2todelete")
("twoletters.(SeeChapter27ofTheTeXbook.)"); error ; goto done2 ;
end
This code is used in section 458.
460. Report that this dimension is out of range 460
begin print err ("Dimensiontoolarge");
help2 ("Icantworkwithsizesbiggerthanabout19feet.")
("ContinueandIllusethelargestvalueIcan.");
error ; cur val max dimen; arith error false;
end
This code is used in section 448.
172 PART 26: BASIC SCANNING SUBROUTINES T
E
X82 461
461. The nal member of T
E
Xs value-scanning trio is scan glue, which makes cur val point to a glue
specication. The reference count of that glue spec will take account of the fact that cur val is pointing
to it.
The level parameter should be either glue val or mu val .
Since scan dimen was so much more complex than scan int , we might expect scan glue to be even worse.
But fortunately, it is very simple, since most of the work has already been done.
procedure scan glue(level : small number ); sets cur val to a glue spec pointer
label exit ;
var negative: boolean; should the answer be negated?
q: pointer ; new glue specication
mu: boolean; does level = mu val ?
begin mu (level = mu val ); Get the next non-blank non-sign token; set negative appropriately 441 ;
if (cur cmd min internal ) (cur cmd max internal ) then
begin scan something internal (level , negative);
if cur val level glue val then
begin if cur val level ,= level then mu error ;
return;
end;
if cur val level = int val then scan dimen(mu, false, true)
else if level = mu val then mu error ;
end
else begin back input ; scan dimen(mu, false, false);
if negative then negate(cur val );
end;
Create a new glue specication whose width is cur val ; scan for its stretch and shrink components 462 ;
exit : end;
462. Create a new glue specication whose width is cur val ; scan for its stretch and shrink
components 462
q new spec(zero glue); width(q) cur val ;
if scan keyword ("plus") then
begin scan dimen(mu, true, false); stretch(q) cur val ; stretch order (q) cur order ;
end;
if scan keyword ("minus") then
begin scan dimen(mu, true, false); shrink (q) cur val ; shrink order (q) cur order ;
end;
cur val q
This code is used in section 461.
463 T
E
X82 PART 26: BASIC SCANNING SUBROUTINES 173
463. Heres a similar procedure that returns a pointer to a rule node. This routine is called just after T
E
X
has seen \hrule or \vrule; therefore cur cmd will be either hrule or vrule. The idea is to store the default
rule dimensions in the node, then to override them if height or width or depth specications are found
(in any order).
dene default rule = 26214 0.4 pt
function scan rule spec: pointer ;
label reswitch;
var q: pointer ; the rule node being created
begin q new rule; width, depth, and height all equal null ag now
if cur cmd = vrule then width(q) default rule
else begin height (q) default rule; depth(q) 0;
end;
reswitch: if scan keyword ("width") then
begin scan normal dimen; width(q) cur val ; goto reswitch;
end;
if scan keyword ("height") then
begin scan normal dimen; height (q) cur val ; goto reswitch;
end;
if scan keyword ("depth") then
begin scan normal dimen; depth(q) cur val ; goto reswitch;
end;
scan rule spec q;
end;
174 PART 27: BUILDING TOKEN LISTS T
E
X82 464
464. Building token lists. The token lists for macros and for other things like \mark and \output and
\write are produced by a procedure called scan toks .
Before we get into the details of scan toks , lets consider a much simpler task, that of converting the current
string into a token list. The str toks function does this; it classies spaces as type spacer and everything
else as type other char .
The token list created by str toks begins at link (temp head ) and ends at the value p that is returned. (If
p = temp head , the list is empty.)
function str toks (b : pool pointer ): pointer ; changes the string str pool [b . . pool ptr ] to a token list
var p: pointer ; tail of the token list
q: pointer ; new node being added to the token list via store new token
t: halfword ; token being appended
k: pool pointer ; index into str pool
begin str room(1); p temp head ; link (p) null ; k b;
while k < pool ptr do
begin t so(str pool [k]);
if t = "" then t space token
else t other token + t;
fast store new token(t); incr (k);
end;
pool ptr b; str toks p;
end;
465. The main reason for wanting str toks is the next function, the toks , which has similar input/output
characteristics.
This procedure is supposed to scan something like \skip\count12, i.e., whatever can follow \the, and
it constructs a token list containing something like 3.0pt minus 0.5fill.
function the toks : pointer ;
var old setting : 0 . . max selector ; holds selector setting
p, q, r: pointer ; used for copying a token list
b: pool pointer ; base of temporary string
begin get x token; scan something internal (tok val , false);
if cur val level ident val then Copy the token list 466
else begin old setting selector ; selector new string ; b pool ptr ;
case cur val level of
int val : print int (cur val );
dimen val : begin print scaled (cur val ); print ("pt");
end;
glue val : begin print spec(cur val , "pt"); delete glue ref (cur val );
end;
mu val : begin print spec(cur val , "mu"); delete glue ref (cur val );
end;
end; there are no other cases
selector old setting ; the toks str toks (b);
end;
end;
466 T
E
X82 PART 27: BUILDING TOKEN LISTS 175
466. Copy the token list 466
begin p temp head ; link (p) null ;
if cur val level = ident val then store new token(cs token ag + cur val )
else if cur val ,= null then
begin r link (cur val ); do not copy the reference count
while r ,= null do
begin fast store new token(info(r)); r link (r);
end;
end;
the toks p;
end
This code is used in section 465.
467. Heres part of the expand subroutine that we are now ready to complete:
procedure ins the toks ;
begin link (garbage) the toks ; ins list (link (temp head ));
end;
468. The primitives \number, \romannumeral, \string, \meaning, \fontname, and \jobname are dened
as follows.
dene number code = 0 command code for \number
dene roman numeral code = 1 command code for \romannumeral
dene string code = 2 command code for \string
dene meaning code = 3 command code for \meaning
dene font name code = 4 command code for \fontname
dene job name code = 5 command code for \jobname
Put each of T
E
Xs primitives into the hash table 226 +
primitive("number", convert , number code);
primitive("romannumeral", convert , roman numeral code);
primitive("string", convert , string code);
primitive("meaning", convert , meaning code);
primitive("fontname", convert , font name code);
primitive("jobname", convert , job name code);
469. Cases of print cmd chr for symbolic printing of primitives 227 +
convert : case chr code of
number code: print esc("number");
roman numeral code: print esc("romannumeral");
string code: print esc("string");
meaning code: print esc("meaning");
font name code: print esc("fontname");
othercases print esc("jobname")
endcases;
176 PART 27: BUILDING TOKEN LISTS T
E
X82 470
470. The procedure conv toks uses str toks to insert the token list for convert functions into the scanner;
\outer control sequences are allowed to follow \string and \meaning.
procedure conv toks ;
var old setting : 0 . . max selector ; holds selector setting
c: number code . . job name code; desired type of conversion
save scanner status : small number ; scanner status upon entry
b: pool pointer ; base of temporary string
begin c cur chr ; Scan the argument for command c 471 ;
old setting selector ; selector new string ; b pool ptr ; Print the result of command c 472 ;
selector old setting ; link (garbage) str toks (b); ins list (link (temp head ));
end;
471. Scan the argument for command c 471
case c of
number code, roman numeral code: scan int ;
string code, meaning code: begin save scanner status scanner status ; scanner status normal ;
get token; scanner status save scanner status ;
end;
font name code: scan font ident ;
job name code: if job name = 0 then open log le;
end there are no other cases
This code is used in section 470.
472. Print the result of command c 472
case c of
number code: print int (cur val );
roman numeral code: print roman int (cur val );
string code: if cur cs ,= 0 then sprint cs (cur cs )
else print char (cur chr );
meaning code: print meaning ;
font name code: begin print (font name[cur val ]);
if font size[cur val ] ,= font dsize[cur val ] then
begin print ("at"); print scaled (font size[cur val ]); print ("pt");
end;
end;
job name code: print (job name);
end there are no other cases
This code is used in section 470.
473 T
E
X82 PART 27: BUILDING TOKEN LISTS 177
473. Now we cant postpone the diculties any longer; we must bravely tackle scan toks . This function
returns a pointer to the tail of a new token list, and it also makes def ref point to the reference count at the
head of that list.
There are two boolean parameters, macro def and xpand . If macro def is true, the goal is to create the
token list for a macro denition; otherwise the goal is to create the token list for some other T
E
X primitive:
\mark, \output, \everypar, \lowercase, \uppercase, \message, \errmessage, \write, or \special. In
the latter cases a left brace must be scanned next; this left brace will not be part of the token list, nor will
the matching right brace that comes at the end. If xpand is false, the token list will simply be copied from
the input using get token. Otherwise all expandable tokens will be expanded until unexpandable tokens are
left, except that the results of expanding \the are not expanded further. If both macro def and xpand
are true, the expansion applies only to the macro body (i.e., to the material following the rst left brace
character).
The value of cur cs when scan toks begins should be the eqtb address of the control sequence to display
in runaway error messages.
function scan toks (macro def , xpand : boolean): pointer ;
label found , done, done1 , done2 ;
var t: halfword ; token representing the highest parameter number
s: halfword ; saved token
p: pointer ; tail of the token list being built
q: pointer ; new node being added to the token list via store new token
unbalance: halfword ; number of unmatched left braces
hash brace: halfword ; possible #{ token
begin if macro def then scanner status dening else scanner status absorbing ;
warning index cur cs ; def ref get avail ; token ref count (def ref ) null ; p def ref ;
hash brace 0; t zero token;
if macro def then Scan and build the parameter part of the macro denition 474
else scan left brace; remove the compulsory left brace
Scan and build the body of the token list; goto found when nished 477 ;
found : scanner status normal ;
if hash brace ,= 0 then store new token(hash brace);
scan toks p;
end;
474. Scan and build the parameter part of the macro denition 474
begin loop
begin get token; set cur cmd , cur chr , cur tok
if cur tok < right brace limit then goto done1 ;
if cur cmd = mac param then If the next character is a parameter number, make cur tok a match
token; but if it is a left brace, store left brace, end match, set hash brace, and goto done 476 ;
store new token(cur tok );
end;
done1 : store new token(end match token);
if cur cmd = right brace then Express shock at the missing left brace; goto found 475 ;
done: end
This code is used in section 473.
475. Express shock at the missing left brace; goto found 475
begin print err ("Missing{inserted"); incr (align state);
help2 ("Wherewastheleftbrace?Yousaidsomethinglike`\def\a},")
("whichImgoingtointerpretas`\def\a{}."); error ; goto found ;
end
This code is used in section 474.
178 PART 27: BUILDING TOKEN LISTS T
E
X82 476
476. If the next character is a parameter number, make cur tok a match token; but if it is a left brace,
store left brace, end match, set hash brace, and goto done 476
begin s match token + cur chr ; get token;
if cur cmd = left brace then
begin hash brace cur tok ; store new token(cur tok ); store new token(end match token);
goto done;
end;
if t = zero token + 9 then
begin print err ("Youalreadyhavenineparameters");
help1 ("Imgoingtoignorethe#signyoujustused."); error ;
end
else begin incr (t);
if cur tok ,= t then
begin print err ("Parametersmustbenumberedconsecutively");
help2 ("Iveinsertedthedigityoushouldhaveusedafterthe#.")
("Type`1todeletewhatyoudiduse."); back error ;
end;
cur tok s;
end;
end
This code is used in section 474.
477. Scan and build the body of the token list; goto found when nished 477
unbalance 1;
loop begin if xpand then Expand the next part of the input 478
else get token;
if cur tok < right brace limit then
if cur cmd < right brace then incr (unbalance)
else begin decr (unbalance);
if unbalance = 0 then goto found ;
end
else if cur cmd = mac param then
if macro def then Look for parameter number or ## 479 ;
store new token(cur tok );
end
This code is used in section 473.
478. Here we insert an entire token list created by the toks without expanding it further.
Expand the next part of the input 478
begin loop
begin get next ;
if cur cmd max command then goto done2 ;
if cur cmd ,= the then expand
else begin q the toks ;
if link (temp head ) ,= null then
begin link (p) link (temp head ); p q;
end;
end;
end;
done2 : x token
end
This code is used in section 477.
479 T
E
X82 PART 27: BUILDING TOKEN LISTS 179
479. Look for parameter number or ## 479
begin s cur tok ;
if xpand then get x token
else get token;
if cur cmd ,= mac param then
if (cur tok zero token) (cur tok > t) then
begin print err ("Illegalparameternumberindefinitionof"); sprint cs (warning index );
help3 ("Youmeanttotype##insteadof#,right?")
("Ormaybea}wasforgottensomewhereearlier,andthings")
("areallscrewedup?Imgoingtoassumethatyoumeant##."); back error ; cur tok s;
end
else cur tok out param token "0" + cur chr ;
end
This code is used in section 477.
480. Another way to create a token list is via the \read command. The sixteen les potentially usable for
reading appear in the following global variables. The value of read open[n] will be closed if stream number
n has not been opened or if it has been fully read; just open if an \openin but not a \read has been done;
and normal if it is open and ready to read the next line.
dene closed = 2 not open, or at end of le
dene just open = 1 newly opened, rst line not yet read
Global variables 13 +
read le: array [0 . . 15] of alpha le; used for \read
read open: array [0 . . 16] of normal . . closed ; state of read le[n]
481. Set initial values of key variables 21 +
for k 0 to 16 do read open[k] closed ;
482. The read toks procedure constructs a token list like that for any macro denition, and makes cur val
point to it. Parameter r points to the control sequence that will receive this token list.
procedure read toks (n : integer ; r : pointer );
label done;
var p: pointer ; tail of the token list
q: pointer ; new node being added to the token list via store new token
s: integer ; saved value of align state
m: small number ; stream number
begin scanner status dening ; warning index r; def ref get avail ;
token ref count (def ref ) null ; p def ref ; the reference count
store new token(end match token);
if (n < 0) (n > 15) then m 16 else m n;
s align state; align state 1000000; disable tab marks, etc.
repeat Input and store tokens from the next line of the le 483 ;
until align state = 1000000;
cur val def ref ; scanner status normal ; align state s;
end;
180 PART 27: BUILDING TOKEN LISTS T
E
X82 483
483. Input and store tokens from the next line of the le 483
begin le reading ; name m + 1;
if read open[m] = closed then Input for \read from the terminal 484
else if read open[m] = just open then Input the rst line of read le[m] 485
else Input the next line of read le[m] 486 ;
limit last ;
if end line char inactive then decr (limit )
else buer [limit ] end line char ;
rst limit + 1; loc start ; state new line;
loop begin get token;
if cur tok = 0 then goto done; cur cmd = cur chr = 0 will occur at the end of the line
if align state < 1000000 then unmatched } aborts the line
begin repeat get token;
until cur tok = 0;
align state 1000000; goto done;
end;
store new token(cur tok );
end;
done: end le reading
This code is used in section 482.
484. Here we input on-line into the buer array, prompting the user explicitly if n 0. The value of n is
set negative so that additional prompts will not be given in the case of multi-line input.
Input for \read from the terminal 484
if interaction > nonstop mode then
if n < 0 then prompt input ("")
else begin wake up terminal ; print ln; sprint cs (r); prompt input ("="); n 1;
end
else fatal error ("***(cannot\readfromterminalinnonstopmodes)")
This code is used in section 483.
485. The rst line of a le must be treated specially, since input ln must be told not to start with get .
Input the rst line of read le[m] 485
if input ln(read le[m], false) then read open[m] normal
else begin a close(read le[m]); read open[m] closed ;
end
This code is used in section 483.
486. An empty line is appended at the end of a read le.
Input the next line of read le[m] 486
begin if input ln(read le[m], true) then
begin a close(read le[m]); read open[m] closed ;
if align state ,= 1000000 then
begin runaway; print err ("Fileendedwithin"); print esc("read");
help1 ("This\readhasunbalancedbraces."); align state 1000000; error ;
end;
end;
end
This code is used in section 483.
487 T
E
X82 PART 28: CONDITIONAL PROCESSING 181
487. Conditional processing. We consider now the way T
E
X handles various kinds of \if commands.
dene if char code = 0 \if
dene if cat code = 1 \ifcat
dene if int code = 2 \ifnum
dene if dim code = 3 \ifdim
dene if odd code = 4 \ifodd
dene if vmode code = 5 \ifvmode
dene if hmode code = 6 \ifhmode
dene if mmode code = 7 \ifmmode
dene if inner code = 8 \ifinner
dene if void code = 9 \ifvoid
dene if hbox code = 10 \ifhbox
dene if vbox code = 11 \ifvbox
dene ifx code = 12 \ifx
dene if eof code = 13 \ifeof
dene if true code = 14 \iftrue
dene if false code = 15 \iffalse
dene if case code = 16 \ifcase
Put each of T
E
Xs primitives into the hash table 226 +
primitive("if", if test , if char code); primitive("ifcat", if test , if cat code);
primitive("ifnum", if test , if int code); primitive("ifdim", if test , if dim code);
primitive("ifodd", if test , if odd code); primitive("ifvmode", if test , if vmode code);
primitive("ifhmode", if test , if hmode code); primitive("ifmmode", if test , if mmode code);
primitive("ifinner", if test , if inner code); primitive("ifvoid", if test , if void code);
primitive("ifhbox", if test , if hbox code); primitive("ifvbox", if test , if vbox code);
primitive("ifx", if test , ifx code); primitive("ifeof", if test , if eof code);
primitive("iftrue", if test , if true code); primitive("iffalse", if test , if false code);
primitive("ifcase", if test , if case code);
488. Cases of print cmd chr for symbolic printing of primitives 227 +
if test : case chr code of
if cat code: print esc("ifcat");
if int code: print esc("ifnum");
if dim code: print esc("ifdim");
if odd code: print esc("ifodd");
if vmode code: print esc("ifvmode");
if hmode code: print esc("ifhmode");
if mmode code: print esc("ifmmode");
if inner code: print esc("ifinner");
if void code: print esc("ifvoid");
if hbox code: print esc("ifhbox");
if vbox code: print esc("ifvbox");
ifx code: print esc("ifx");
if eof code: print esc("ifeof");
if true code: print esc("iftrue");
if false code: print esc("iffalse");
if case code: print esc("ifcase");
othercases print esc("if")
endcases;
182 PART 28: CONDITIONAL PROCESSING T
E
X82 489
489. Conditions can be inside conditions, and this nesting has a stack that is independent of the save stack .
Four global variables represent the top of the condition stack: cond ptr points to pushed-down entries, if
any; if limit species the largest code of a or else command that is syntactically legal; cur if is the name
of the current type of conditional; and if line is the line number at which it began.
If no conditions are currently in progress, the condition stack has the special state cond ptr = null ,
if limit = normal , cur if = 0, if line = 0. Otherwise cond ptr points to a two-word node; the type, subtype,
and link elds of the rst word contain if limit , cur if , and cond ptr at the next level, and the second word
contains the corresponding if line.
dene if node size = 2 number of words in stack entry for conditionals
dene if line eld (#) mem[# + 1].int
dene if code = 1 code for \if... being evaluated
dene code = 2 code for \fi
dene else code = 3 code for \else
dene or code = 4 code for \or
Global variables 13 +
cond ptr : pointer ; top of the condition stack
if limit : normal . . or code; upper bound on or else codes
cur if : small number ; type of conditional being worked on
if line: integer ; line where that conditional began
490. Set initial values of key variables 21 +
cond ptr null ; if limit normal ; cur if 0; if line 0;
491. Put each of T
E
Xs primitives into the hash table 226 +
primitive("fi", or else, code); text (frozen ) "fi"; eqtb[frozen ] eqtb[cur val ];
primitive("or", or else, or code); primitive("else", or else, else code);
492. Cases of print cmd chr for symbolic printing of primitives 227 +
or else: if chr code = code then print esc("fi")
else if chr code = or code then print esc("or")
else print esc("else");
493. When we skip conditional text, we keep track of the line number where skipping began, for use in
error messages.
Global variables 13 +
skip line: integer ; skipping began here
494 T
E
X82 PART 28: CONDITIONAL PROCESSING 183
494. Here is a procedure that ignores text until coming to an \or, \else, or \fi at level zero of \if . . . \fi
nesting. After it has acted, cur chr will indicate the token that was found, but cur tok will not be set (because
this makes the procedure run faster).
procedure pass text ;
label done;
var l: integer ; level of \if . . . \fi nesting
save scanner status : small number ; scanner status upon entry
begin save scanner status scanner status ; scanner status skipping ; l 0; skip line line;
loop begin get next ;
if cur cmd = or else then
begin if l = 0 then goto done;
if cur chr = code then decr (l);
end
else if cur cmd = if test then incr (l);
end;
done: scanner status save scanner status ;
end;
495. When we begin to process a new \if, we set if limit if code; then if \or or \else or \fi occurs
before the current \if condition has been evaluated, \relax will be inserted. For example, a sequence of
commands like \ifvoid1\else...\fi would otherwise require something after the 1.
Push the condition stack 495
begin p get node(if node size); link (p) cond ptr ; type(p) if limit ; subtype(p) cur if ;
if line eld (p) if line; cond ptr p; cur if cur chr ; if limit if code; if line line;
end
This code is used in section 498.
496. Pop the condition stack 496
begin p cond ptr ; if line if line eld (p); cur if subtype(p); if limit type(p);
cond ptr link (p); free node(p, if node size);
end
This code is used in sections 498, 500, 509, and 510.
497. Heres a procedure that changes the if limit code corresponding to a given value of cond ptr .
procedure change if limit (l : small number ; p : pointer );
label exit ;
var q: pointer ;
begin if p = cond ptr then if limit l thats the easy case
else begin q cond ptr ;
loop begin if q = null then confusion("if");
if link (q) = p then
begin type(q) l; return;
end;
q link (q);
end;
end;
exit : end;
184 PART 28: CONDITIONAL PROCESSING T
E
X82 498
498. A condition is started when the expand procedure encounters an if test command; in that case expand
reduces to conditional , which is a recursive procedure.
procedure conditional ;
label exit , common ending ;
var b: boolean; is the condition true?
r: "<" . . ">"; relation to be evaluated
m, n: integer ; to be tested against the second operand
p, q: pointer ; for traversing token lists in \ifx tests
save scanner status : small number ; scanner status upon entry
save cond ptr : pointer ; cond ptr corresponding to this conditional
this if : small number ; type of this conditional
begin Push the condition stack 495 ; save cond ptr cond ptr ; this if cur chr ;
Either process \ifcase or set b to the value of a boolean condition 501 ;
if tracing commands > 1 then Display the value of b 502 ;
if b then
begin change if limit (else code, save cond ptr ); return; wait for \else or \fi
end;
Skip to \else or \fi, then goto common ending 500 ;
common ending : if cur chr = code then Pop the condition stack 496
else if limit code; wait for \fi
exit : end;
499. In a construction like \if\iftrue abc\else d\fi, the rst \else that we come to after learning
that the \if is false is not the \else were looking for. Hence the following curious logic is needed.
500. Skip to \else or \fi, then goto common ending 500
loop begin pass text ;
if cond ptr = save cond ptr then
begin if cur chr ,= or code then goto common ending ;
print err ("Extra"); print esc("or");
help1 ("Imignoringthis;itdoesntmatchany\if."); error ;
end
else if cur chr = code then Pop the condition stack 496 ;
end
This code is used in section 498.
501 T
E
X82 PART 28: CONDITIONAL PROCESSING 185
501. Either process \ifcase or set b to the value of a boolean condition 501
case this if of
if char code, if cat code: Test if two characters match 506 ;
if int code, if dim code: Test relation between integers or dimensions 503 ;
if odd code: Test if an integer is odd 504 ;
if vmode code: b (abs (mode) = vmode);
if hmode code: b (abs (mode) = hmode);
if mmode code: b (abs (mode) = mmode);
if inner code: b (mode < 0);
if void code, if hbox code, if vbox code: Test box register status 505 ;
ifx code: Test if two tokens match 507 ;
if eof code: begin scan four bit int ; b (read open[cur val ] = closed );
end;
if true code: b true;
if false code: b false;
if case code: Select the appropriate case and return or goto common ending 509 ;
end there are no other cases
This code is used in section 498.
502. Display the value of b 502
begin begin diagnostic;
if b then print ("{true}") else print ("{false}");
end diagnostic(false);
end
This code is used in section 498.
503. Here we use the fact that "<", "=", and ">" are consecutive ASCII codes.
Test relation between integers or dimensions 503
begin if this if = if int code then scan int else scan normal dimen;
n cur val ; Get the next non-blank non-call token 406 ;
if (cur tok other token + "<") (cur tok other token + ">") then r cur tok other token
else begin print err ("Missing=insertedfor"); print cmd chr (if test , this if );
help1 ("Iwasexpectingtosee`<,`=,or`>.Didnt."); back error ; r "=";
end;
if this if = if int code then scan int else scan normal dimen;
case r of
"<": b (n < cur val );
"=": b (n = cur val );
">": b (n > cur val );
end;
end
This code is used in section 501.
504. Test if an integer is odd 504
begin scan int ; b odd (cur val );
end
This code is used in section 501.
186 PART 28: CONDITIONAL PROCESSING T
E
X82 505
505. Test box register status 505
begin scan eight bit int ; p box (cur val );
if this if = if void code then b (p = null )
else if p = null then b false
else if this if = if hbox code then b (type(p) = hlist node)
else b (type(p) = vlist node);
end
This code is used in section 501.
506. An active character will be treated as category 13 following \if\noexpand or following \ifcat\noexpand.
We use the fact that active characters have the smallest tokens, among all control sequences.
dene get x token or active char
begin get x token;
if cur cmd = relax then
if cur chr = no expand ag then
begin cur cmd active char ; cur chr cur tok cs token ag active base;
end;
end
Test if two characters match 506
begin get x token or active char ;
if (cur cmd > active char ) (cur chr > 255) then not a character
begin m relax ; n 256;
end
else begin m cur cmd ; n cur chr ;
end;
get x token or active char ;
if (cur cmd > active char ) (cur chr > 255) then
begin cur cmd relax ; cur chr 256;
end;
if this if = if char code then b (n = cur chr ) else b (m = cur cmd );
end
This code is used in section 501.
507. Note that \ifx will declare two macros dierent if one is long or outer and the other isnt, even
though the texts of the macros are the same.
We need to reset scanner status , since \outer control sequences are allowed, but we might be scanning a
macro denition or preamble.
Test if two tokens match 507
begin save scanner status scanner status ; scanner status normal ; get next ; n cur cs ;
p cur cmd ; q cur chr ; get next ;
if cur cmd ,= p then b false
else if cur cmd < call then b (cur chr = q)
else Test if two macro texts match 508 ;
scanner status save scanner status ;
end
This code is used in section 501.
508 T
E
X82 PART 28: CONDITIONAL PROCESSING 187
508. Note also that \ifx decides that macros \a and \b are dierent in examples like this:
\def\a{\c} \def\c{}
\def\b{\d} \def\d{}
Test if two macro texts match 508
begin p link (cur chr ); q link (equiv (n)); omit reference counts
if p = q then b true
else begin while (p ,= null ) (q ,= null ) do
if info(p) ,= info(q) then p null
else begin p link (p); q link (q);
end;
b ((p = null ) (q = null ));
end;
end
This code is used in section 507.
509. Select the appropriate case and return or goto common ending 509
begin scan int ; n cur val ; n is the number of cases to pass
if tracing commands > 1 then
begin begin diagnostic; print ("{case"); print int (n); print char ("}"); end diagnostic(false);
end;
while n ,= 0 do
begin pass text ;
if cond ptr = save cond ptr then
if cur chr = or code then decr (n)
else goto common ending
else if cur chr = code then Pop the condition stack 496 ;
end;
change if limit (or code, save cond ptr ); return; wait for \or, \else, or \fi
end
This code is used in section 501.
510. The processing of conditionals is complete except for the following code, which is actually part of
expand . It comes into play when \or, \else, or \fi is scanned.
Terminate the current conditional and skip to \fi 510
if cur chr > if limit then
if if limit = if code then insert relax condition not yet evaluated
else begin print err ("Extra"); print cmd chr ( or else, cur chr );
help1 ("Imignoringthis;itdoesntmatchany\if."); error ;
end
else begin while cur chr ,= code do pass text ; skip to \fi
Pop the condition stack 496 ;
end
This code is used in section 367.
188 PART 29: FILE NAMES T
E
X82 511
511. File names. Its time now to fret about le names. Besides the fact that dierent operating systems
treat les in dierent ways, we must cope with the fact that completely dierent naming conventions are used
by dierent groups of people. The following programs show what is required for one particular operating
system; similar routines for other systems are not dicult to devise.
T
E
X assumes that a le name has three parts: the name proper; its extension; and a le area where
it is found in an external le system. The extension of an input le or a write le is assumed to be .tex
unless otherwise specied; it is .log on the transcript le that records each run of T
E
X; it is .tfm on the
font metric les that describe characters in the fonts T
E
X uses; it is .dvi on the output les that specify
typesetting information; and it is .fmt on the format les written by INITEX to initialize T
E
X. The le area
can be arbitrary on input les, but les are usually output to the users current area. If an input le cannot
be found on the specied area, T
E
X will look for it on a special system area; this special area is intended for
commonly used input les like webmac.tex.
Simple uses of T
E
X refer only to le names that have no explicit extension or area. For example, a person
usually says \input paper or \font\tenrm = helvetica instead of \input paper.new or \font\tenrm
= <csd.knuth>test. Simple le names are best, because they make the T
E
X source les portable; whenever
a le name consists entirely of letters and digits, it should be treated in the same way by all implementations
of T
E
X. However, users need the ability to refer to other les in their environment, especially when responding
to error messages concerning unopenable les; therefore we want to let them use the syntax that appears in
their favorite operating system.
The following procedures dont allow spaces to be part of le names; but some users seem to like names that
are spaced-out. System-dependent changes to allow such things should probably be made with reluctance,
and only when an entire le name that includes spaces is quoted somehow.
512. In order to isolate the system-dependent aspects of le names, the system-independent parts of T
E
X
are expressed in terms of three system-dependent procedures called begin name, more name, and end name.
In essence, if the user-specied characters of the le name are c
1
. . . c
n
, the system-independent driver program
does the operations
begin name; more name(c
1
); . . . ; more name(c
n
); end name.
These three procedures communicate with each other via global variables. Afterwards the le name will
appear in the string pool as three strings called cur name, cur area, and cur ext ; the latter two are null
(i.e., ""), unless they were explicitly specied by the user.
Actually the situation is slightly more complicated, because T
E
X needs to know when the le name ends.
The more name routine is a function (with side eects) that returns true on the calls more name(c
1
), . . . ,
more name(c
n1
). The nal call more name(c
n
) returns false; or, it returns true and the token following
c
n
is something like \hbox (i.e., not a character). In other words, more name is supposed to return true
unless it is sure that the le name has been completely scanned; and end name is supposed to be able to
nish the assembly of cur name, cur area, and cur ext regardless of whether more name(c
n
) returned true
or false.
Global variables 13 +
cur name: str number ; name of le just scanned
cur area: str number ; le area just scanned, or ""
cur ext : str number ; le extension just scanned, or ""
513 T
E
X82 PART 29: FILE NAMES 189
513. The le names we shall deal with for illustrative purposes have the following structure: If the name
contains > or :, the le area consists of all characters up to and including the nal such character; otherwise
the le area is null. If the remaining le name contains ., the le extension consists of all such characters
from the rst remaining . to the end, otherwise the le extension is null.
We can scan such le names easily by using two global variables that keep track of the occurrences of area
and extension delimiters:
Global variables 13 +
area delimiter : pool pointer ; the most recent > or :, if any
ext delimiter : pool pointer ; the relevant ., if any
514. Input les that cant be found in the users area may appear in a standard system area called
TEX area. Font metric les whose areas are not given explicitly are assumed to appear in a standard system
area called TEX font area. These system area names will, of course, vary from place to place.
dene TEX area "TeXinputs:"
dene TEX font area "TeXfonts:"
515. Here now is the rst of the system-dependent routines for le name scanning.
procedure begin name;
begin area delimiter 0; ext delimiter 0;
end;
516. And heres the second. The string pool might change as the le name is being scanned, since a new
\csname might be entered; therefore we keep area delimiter and ext delimiter relative to the beginning of
the current string, instead of assigning an absolute address like pool ptr to them.
function more name(c : ASCII code): boolean;
begin if c = "" then more name false
else begin str room(1); append char (c); contribute c to the current string
if (c = ">") (c = ":") then
begin area delimiter cur length; ext delimiter 0;
end
else if (c = ".") (ext delimiter = 0) then ext delimiter cur length;
more name true;
end;
end;
517. The third.
procedure end name;
begin if str ptr + 3 > max strings then overow("numberofstrings", max strings init str ptr );
if area delimiter = 0 then cur area ""
else begin cur area str ptr ; str start [str ptr + 1] str start [str ptr ] + area delimiter ; incr (str ptr );
end;
if ext delimiter = 0 then
begin cur ext ""; cur name make string ;
end
else begin cur name str ptr ;
str start [str ptr + 1] str start [str ptr ] + ext delimiter area delimiter 1; incr (str ptr );
cur ext make string ;
end;
end;
190 PART 29: FILE NAMES T
E
X82 518
518. Conversely, here is a routine that takes three strings and prints a le name that might have produced
them. (The routine is system dependent, because some operating systems put the le area last instead of
rst.)
Basic printing procedures 57 +
procedure print le name(n, a, e : integer );
begin slow print (a); slow print (n); slow print (e);
end;
519. Another system-dependent routine is needed to convert three internal T
E
X strings into the name of le
value that is used to open les. The present code allows both lowercase and uppercase letters in the le
name.
dene append to name(#)
begin c #; incr (k);
if k le name size then name of le[k] xchr [c];
end
procedure pack le name(n, a, e : str number );
var k: integer ; number of positions lled in name of le
c: ASCII code; character being packed
j: pool pointer ; index into str pool
begin k 0;
for j str start [a] to str start [a + 1] 1 do append to name(so(str pool [j]));
for j str start [n] to str start [n + 1] 1 do append to name(so(str pool [j]));
for j str start [e] to str start [e + 1] 1 do append to name(so(str pool [j]));
if k le name size then name length k else name length le name size;
for k name length + 1 to le name size do name of le[k] ;
end;
520. A messier routine is also needed, since format le names must be scanned before T
E
Xs string
mechanism has been initialized. We shall use the global variable TEX format default to supply the text
for default system areas and extensions related to format les.
dene format default length = 20 length of the TEX format default string
dene format area length = 11 length of its area part
dene format ext length = 4 length of its .fmt part
dene format extension = ".fmt" the extension, as a WEB constant
Global variables 13 +
TEX format default : packed array [1 . . format default length] of char ;
521. Set initial values of key variables 21 +
TEX format default TeXformats:plain.fmt;
522. Check the constant values for consistency 14 +
if format default length > le name size then bad 31;
523 T
E
X82 PART 29: FILE NAMES 191
523. Here is the messy routine that was just mentioned. It sets name of le from the rst n characters
of TEX format default , followed by buer [a . . b], followed by the last format ext length characters of
TEX format default .
We dare not give error messages here, since T
E
X calls this routine before the error routine is ready to roll.
Instead, we simply drop excess characters, since the error will be detected in another way when a strange
le name isnt found.
procedure pack buered name(n : small number ; a, b : integer );
var k: integer ; number of positions lled in name of le
c: ASCII code; character being packed
j: integer ; index into buer or TEX format default
begin if n + b a + 1 + format ext length > le name size then
b a + le name size n 1 format ext length;
k 0;
for j 1 to n do append to name(xord [TEX format default [j]]);
for j a to b do append to name(buer [j]);
for j format default length format ext length + 1 to format default length do
append to name(xord [TEX format default [j]]);
if k le name size then name length k else name length le name size;
for k name length + 1 to le name size do name of le[k] ;
end;
524. Here is the only place we use pack buered name. This part of the program becomes active when a
virgin T
E
X is trying to get going, just after the preliminary initialization, or when the user is substituting
another format le by typing & after the initial ** prompt. The buer contains the rst line of input in
buer [loc . . (last 1)], where loc < last and buer [loc] ,= "".
Declare the function called open fmt le 524
function open fmt le: boolean;
label found , exit ;
var j: 0 . . buf size; the rst space after the format le name
begin j loc;
if buer [loc] = "&" then
begin incr (loc); j loc; buer [last ] "";
while buer [j] ,= "" do incr (j);
pack buered name(0, loc, j 1); try rst without the system le area
if w open in(fmt le) then goto found ;
pack buered name(format area length, loc, j 1); now try the system format le area
if w open in(fmt le) then goto found ;
wake up terminal ; wterm ln(Sorry,Icantfindthatformat;, willtryPLAIN.);
update terminal ;
end; now pull out all the stops: try for the system plain le
pack buered name(format default length format ext length, 1, 0);
if w open in(fmt le) then
begin wake up terminal ; wterm ln(IcantfindthePLAINformatfile!);
open fmt le false; return;
end;
found : loc j; open fmt le true;
exit : end;
This code is used in section 1303.
192 PART 29: FILE NAMES T
E
X82 525
525. Operating systems often make it possible to determine the exact name (and possible version number)
of a le that has been opened. The following routine, which simply makes a T
E
X string from the value of
name of le, should ideally be changed to deduce the full name of le f, which is the le most recently
opened, if it is possible to do this in a Pascal program.
This routine might be called after string memory has overowed, hence we dare not use str room.
function make name string : str number ;
var k: 1 . . le name size; index into name of le
begin if (pool ptr + name length > pool size) (str ptr = max strings ) (cur length > 0) then
make name string "?"
else begin for k 1 to name length do append char (xord [name of le[k]]);
make name string make string ;
end;
end;
function a make name string (var f : alpha le): str number ;
begin a make name string make name string ;
end;
function b make name string (var f : byte le): str number ;
begin b make name string make name string ;
end;
function w make name string (var f : word le): str number ;
begin w make name string make name string ;
end;
526. Now lets consider the driver routines by which T
E
X deals with le names in a system-independent
manner. First comes a procedure that looks for a le name in the input by calling get x token for the
information.
procedure scan le name;
label done;
begin name in progress true; begin name; Get the next non-blank non-call token 406 ;
loop begin if (cur cmd > other char ) (cur chr > 255) then not a character
begin back input ; goto done;
end;
if more name(cur chr ) then goto done;
get x token;
end;
done: end name; name in progress false;
end;
527. The global variable name in progress is used to prevent recursive use of scan le name, since the
begin name and other procedures communicate via global variables. Recursion would arise only by devious
tricks like \input\input f; such attempts at sabotage must be thwarted. Furthermore, name in progress
prevents \input from being initiated when a font size specication is being scanned.
Another global variable, job name, contains the le name that was rst \input by the user. This name
is extended by .log and .dvi and .fmt in the names of T
E
Xs output les.
Global variables 13 +
name in progress : boolean; is a le name being scanned?
job name: str number ; principal le name
log opened : boolean; has the transcript le been opened?
528 T
E
X82 PART 29: FILE NAMES 193
528. Initially job name = 0; it becomes nonzero as soon as the true name is known. We have job name = 0
if and only if the log le has not been opened, except of course for a short time just after job name has
become nonzero.
Initialize the output routines 55 +
job name 0; name in progress false; log opened false;
529. Here is a routine that manufactures the output le names, assuming that job name ,= 0. It ignores
and changes the current settings of cur area and cur ext .
dene pack cur name pack le name(cur name, cur area, cur ext )
procedure pack job name(s : str number ); s = ".log", ".dvi", or format extension
begin cur area ""; cur ext s; cur name job name; pack cur name;
end;
530. If some trouble arises when T
E
X tries to open a le, the following routine calls upon the user to
supply another le name. Parameter s is used in the error message to identify the type of le; parameter e
is the default extension if none is given. Upon exit from the routine, variables cur name, cur area, cur ext ,
and name of le are ready for another attempt at le opening.
procedure prompt le name(s, e : str number );
label done;
var k: 0 . . buf size; index into buer
begin if interaction = scroll mode then wake up terminal ;
if s = "inputfilename" then print err ("Icantfindfile`")
else print err ("Icantwriteonfile`");
print le name(cur name, cur area, cur ext ); print (".");
if e = ".tex" then show context ;
print nl ("Pleasetypeanother"); print (s);
if interaction < scroll mode then fatal error ("***(jobaborted,fileerrorinnonstopmode)");
clear terminal ; prompt input (":"); Scan le name in the buer 531 ;
if cur ext = "" then cur ext e;
pack cur name;
end;
531. Scan le name in the buer 531
begin begin name; k rst ;
while (buer [k] = "") (k < last ) do incr (k);
loop begin if k = last then goto done;
if more name(buer [k]) then goto done;
incr (k);
end;
done: end name;
end
This code is used in section 530.
194 PART 29: FILE NAMES T
E
X82 532
532. Heres an example of how these conventions are used. Whenever it is time to ship out a box of stu,
we shall use the macro ensure dvi open.
dene ensure dvi open
if output le name = 0 then
begin if job name = 0 then open log le;
pack job name(".dvi");
while b open out (dvi le) do prompt le name("filenameforoutput", ".dvi");
output le name b make name string (dvi le);
end
Global variables 13 +
dvi le: byte le; the device-independent output goes here
output le name: str number ; full name of the output le
log name: str number ; full name of the log le
533. Initialize the output routines 55 +
output le name 0;
534. The open log le routine is used to open the transcript le and to help it catch up to what has
previously been printed on the terminal.
procedure open log le;
var old setting : 0 . . max selector ; previous selector setting
k: 0 . . buf size; index into months and buer
l: 0 . . buf size; end of rst input line
months : packed array [1 . . 36] of char ; abbreviations of month names
begin old setting selector ;
if job name = 0 then job name "texput";
pack job name(".log");
while a open out (log le) do Try to get a dierent log le name 535 ;
log name a make name string (log le); selector log only; log opened true;
Print the banner line, including the date and time 536 ;
input stack [input ptr ] cur input ; make sure bottom level is in memory
print nl ("**"); l input stack [0].limit eld ; last position of rst line
if buer [l] = end line char then decr (l);
for k 1 to l do print (buer [k]);
print ln; now the transcript le contains the rst line of input
selector old setting + 2; log only or term and log
end;
535. Sometimes open log le is called at awkward moments when T
E
X is unable to print error messages
or even to show context . The prompt le name routine can result in a fatal error , but the error routine will
not be invoked because log opened will be false.
The normal idea of batch mode is that nothing at all should be written on the terminal. However, in the
unusual case that no log le could be opened, we make an exception and allow an explanatory message to
be seen.
Incidentally, the program always refers to the log le as a transcript file, because some systems
cannot use the extension .log for this le.
Try to get a dierent log le name 535
begin selector term only; prompt le name("transcriptfilename", ".log");
end
This code is used in section 534.
536 T
E
X82 PART 29: FILE NAMES 195
536. Print the banner line, including the date and time 536
begin wlog (banner ); slow print (format ident ); print (""); print int (day); print char ("");
months JANFEBMARAPRMAYJUNJULAUGSEPOCTNOVDEC;
for k 3 month 2 to 3 month do wlog (months [k]);
print char (""); print int (year ); print char (""); print two(time div 60); print char (":");
print two(time mod 60);
end
This code is used in section 534.
537. Lets turn now to the procedure that is used to initiate le reading when an \input command is
being processed.
procedure start input ; T
E
X will \input something
label done;
begin scan le name; set cur name to desired le name
if cur ext = "" then cur ext ".tex";
pack cur name;
loop begin begin le reading ; set up cur le and new level of input
if a open in(cur le) then goto done;
if cur area = "" then
begin pack le name(cur name, TEX area, cur ext );
if a open in(cur le) then goto done;
end;
end le reading ; remove the level that didnt work
prompt le name("inputfilename", ".tex");
end;
done: name a make name string (cur le);
if job name = 0 then
begin job name cur name; open log le;
end; open log le doesnt show context , so limit and loc neednt be set to meaningful values yet
if term oset + length(name) > max print line 2 then print ln
else if (term oset > 0) (le oset > 0) then print char ("");
print char ("("); incr (open parens ); slow print (name); update terminal ; state new line;
if name = str ptr 1 then we can conserve string pool space now
begin ush string ; name cur name;
end;
Read the rst line of the new le 538 ;
end;
538. Here we have to remember to tell the input ln routine not to start with a get . If the le is empty, it
is considered to contain a single blank line.
Read the rst line of the new le 538
begin line 1;
if input ln(cur le, false) then do nothing ;
rm up the line;
if end line char inactive then decr (limit )
else buer [limit ] end line char ;
rst limit + 1; loc start ;
end
This code is used in section 537.
196 PART 30: FONT METRIC DATA T
E
X82 539
539. Font metric data. T
E
X gets its knowledge about fonts from font metric les, also called TFM les;
the T in TFM stands for T
E
X, but other programs know about them too.
The information in a TFM le appears in a sequence of 8-bit bytes. Since the number of bytes is always a
multiple of 4, we could also regard the le as a sequence of 32-bit words, but T
E
X uses the byte interpretation.
The format of TFM les was designed by Lyle Ramshaw in 1980. The intent is to convey a lot of dierent
kinds of information in a compact but useful form.
Global variables 13 +
tfm le: byte le;
540. The rst 24 bytes (6 words) of a TFM le contain twelve 16-bit integers that give the lengths of the
various subsequent portions of the le. These twelve integers are, in order:
lf = length of the entire le, in words;
lh = length of the header data, in words;
bc = smallest character code in the font;
ec = largest character code in the font;
nw = number of words in the width table;
nh = number of words in the height table;
nd = number of words in the depth table;
ni = number of words in the italic correction table;
nl = number of words in the lig/kern table;
nk = number of words in the kern table;
ne = number of words in the extensible character table;
np = number of font parameter words.
They are all nonnegative and less than 2
15
. We must have bc 1 ec 255, and
lf = 6 + lh + (ec bc + 1) + nw + nh + nd + ni + nl + nk + ne + np.
Note that a font may contain as many as 256 characters (if bc = 0 and ec = 255), and as few as 0 characters
(if bc = ec + 1).
Incidentally, when two or more 8-bit bytes are combined to form an integer of 16 or more bits, the most
signicant bytes appear rst in the le. This is called BigEndian order.
541. The rest of the TFM le may be regarded as a sequence of ten data arrays having the informal
specication
header : array [0 . . lh 1] of stu
char info : array [bc . . ec] of char info word
width : array [0 . . nw 1] of x word
height : array [0 . . nh 1] of x word
depth : array [0 . . nd 1] of x word
italic : array [0 . . ni 1] of x word
lig kern : array [0 . . nl 1] of lig kern command
kern : array [0 . . nk 1] of x word
exten : array [0 . . ne 1] of extensible recipe
param : array [1 . . np] of x word
The most important data type used here is a x word , which is a 32-bit representation of a binary fraction.
A x word is a signed quantity, with the twos complement of the entire word used to represent negation.
Of the 32 bits in a x word , exactly 12 are to the left of the binary point; thus, the largest x word value is
2048 2
20
, and the smallest is 2048. We will see below, however, that all but two of the x word values
must lie between 16 and +16.
542 T
E
X82 PART 30: FONT METRIC DATA 197
542. The rst data array is a block of header information, which contains general facts about the font.
The header must contain at least two words, header [0] and header [1], whose meaning is explained below.
Additional header information of use to other software routines might also be included, but T
E
X82 does not
need to know about such details. For example, 16 more words of header information are in use at the Xerox
Palo Alto Research Center; the rst ten specify the character coding scheme used (e.g., XEROX text or
TeX math symbols), the next ve give the font identier (e.g., HELVETICA or CMSY), and the last gives
the face byte. The program that converts DVI les to Xerox printing format gets this information by
looking at the TFM le, which it needs to read anyway because of other information that is not explicitly
repeated in DVI format.
header [0] is a 32-bit check sum that T
E
X will copy into the DVI output le. Later on when the DVI le is
printed, possibly on another computer, the actual font that gets used is supposed to have a check sum
that agrees with the one in the TFM le used by T
E
X. In this way, users will be warned about potential
incompatibilities. (However, if the check sum is zero in either the font le or the TFM le, no check
is made.) The actual relation between this check sum and the rest of the TFM le is not important;
the check sum is simply an identication number with the property that incompatible fonts almost
always have distinct check sums.
header [1] is a x word containing the design size of the font, in units of T
E
X points. This number must be
at least 1.0; it is fairly arbitrary, but usually the design size is 10.0 for a 10 point font, i.e., a font
that was designed to look best at a 10-point size, whatever that really means. When a T
E
X user asks
for a font at pt, the eect is to override the design size and replace it by , and to multiply the x
and y coordinates of the points in the font image by a factor of divided by the design size. All other
dimensions in the TFM le are x word numbers in design-size units, with the exception of param[1]
(which denotes the slant ratio). Thus, for example, the value of param[6], which denes the em unit,
is often the x word value 2
20
= 1.0, since many fonts have a design size equal to one em. The other
dimensions must be less than 16 design-size units in absolute value; thus, header [1] and param[1] are
the only x word entries in the whole TFM le whose rst byte might be something besides 0 or 255.
543. Next comes the char info array, which contains one char info word per character. Each word in this
part of the le contains six elds packed into four bytes as follows.
rst byte: width index (8 bits)
second byte: height index (4 bits) times 16, plus depth index (4 bits)
third byte: italic index (6 bits) times 4, plus tag (2 bits)
fourth byte: remainder (8 bits)
The actual width of a character is width[width index ], in design-size units; this is a device for compressing
information, since many characters have the same width. Since it is quite common for many characters to
have the same height, depth, or italic correction, the TFM format imposes a limit of 16 dierent heights, 16
dierent depths, and 64 dierent italic corrections.
The italic correction of a character has two dierent uses. (a) In ordinary text, the italic correction is
added to the width only if the T
E
X user species \/ after the character. (b) In math formulas, the italic
correction is always added to the width, except with respect to the positioning of subscripts.
Incidentally, the relation width[0] = height [0] = depth[0] = italic[0] = 0 should always hold, so that an
index of zero implies a value of zero. The width index should never be zero unless the character does not exist
in the font, since a character is valid if and only if it lies between bc and ec and has a nonzero width index .
198 PART 30: FONT METRIC DATA T
E
X82 544
544. The tag eld in a char info word has four values that explain how to interpret the remainder eld.
tag = 0 (no tag ) means that remainder is unused.
tag = 1 (lig tag ) means that this character has a ligature/kerning program starting at position remainder
in the lig kern array.
tag = 2 (list tag ) means that this character is part of a chain of characters of ascending sizes, and not the
largest in the chain. The remainder eld gives the character code of the next larger character.
tag = 3 (ext tag ) means that this character code represents an extensible character, i.e., a character that
is built up of smaller pieces so that it can be made arbitrarily large. The pieces are specied in
exten[remainder ].
Characters with tag = 2 and tag = 3 are treated as characters with tag = 0 unless they are used in
special circumstances in math formulas. For example, the \sum operation looks for a list tag , and the \left
operation looks for both list tag and ext tag .
dene no tag = 0 vanilla character
dene lig tag = 1 character has a ligature/kerning program
dene list tag = 2 character has a successor in a charlist
dene ext tag = 3 character is extensible
545 T
E
X82 PART 30: FONT METRIC DATA 199
545. The lig kern array contains instructions in a simple programming language that explains what to do
for special letter pairs. Each word in this array is a lig kern command of four bytes.
rst byte: skip byte, indicates that this is the nal program step if the byte is 128 or more, otherwise the
next step is obtained by skipping this number of intervening steps.
second byte: next char , if next char follows the current character, then perform the operation and stop,
otherwise continue.
third byte: op byte, indicates a ligature step if less than 128, a kern step otherwise.
fourth byte: remainder .
In a kern step, an additional space equal to kern[256 (op byte 128) +remainder ] is inserted between the
current character and next char . This amount is often negative, so that the characters are brought closer
together by kerning; but it might be positive.
There are eight kinds of ligature steps, having op byte codes 4a+2b+c where 0 a b+c and 0 b, c 1.
The character whose code is remainder is inserted between the current character and next char ; then the
current character is deleted if b = 0, and next char is deleted if c = 0; then we pass over a characters to
reach the next current character (which may have a ligature/kerning program of its own).
If the very rst instruction of the lig kern array has skip byte = 255, the next char byte is the so-called
right boundary character of this font; the value of next char need not lie between bc and ec. If the very
last instruction of the lig kern array has skip byte = 255, there is a special ligature/kerning program for a
left boundary character, beginning at location 256 op byte + remainder . The interpretation is that T
E
X
puts implicit boundary characters before and after each consecutive string of characters from the same font.
These implicit characters do not appear in the output, but they can aect ligatures and kerning.
If the very rst instruction of a characters lig kern program has skip byte > 128, the program actually
begins in location 256 op byte +remainder . This feature allows access to large lig kern arrays, because the
rst instruction must otherwise appear in a location 255.
Any instruction with skip byte > 128 in the lig kern array must satisfy the condition
256 op byte + remainder < nl .
If such an instruction is encountered during normal program execution, it denotes an unconditional halt; no
ligature or kerning command is performed.
dene stop ag qi (128) value indicating STOP in a lig/kern program
dene kern ag qi (128) op code for a kern step
dene skip byte(#) #.b0
dene next char (#) #.b1
dene op byte(#) #.b2
dene rem byte(#) #.b3
546. Extensible characters are specied by an extensible recipe, which consists of four bytes called top,
mid , bot , and rep (in this order). These bytes are the character codes of individual pieces used to build up
a large symbol. If top, mid , or bot are zero, they are not present in the built-up result. For example, an
extensible vertical line is like an extensible bracket, except that the top and bottom pieces are missing.
Let T, M, B, and R denote the respective pieces, or an empty box if the piece isnt present. Then the
extensible characters have the form TR
k
MR
k
B from top to bottom, for some k 0, unless M is absent; in
the latter case we can have TR
k
B for both even and odd values of k. The width of the extensible character is
the width of R; and the height-plus-depth is the sum of the individual height-plus-depths of the components
used, since the pieces are butted together in a vertical list.
dene ext top(#) #.b0 top piece in a recipe
dene ext mid (#) #.b1 mid piece in a recipe
dene ext bot (#) #.b2 bot piece in a recipe
dene ext rep(#) #.b3 rep piece in a recipe
200 PART 30: FONT METRIC DATA T
E
X82 547
547. The nal portion of a TFM le is the param array, which is another sequence of x word values.
param[1] = slant is the amount of italic slant, which is used to help position accents. For example, slant = .25
means that when you go up one unit, you also go .25 units to the right. The slant is a pure number;
its the only x word other than the design size itself that is not scaled by the design size.
param[2] = space is the normal spacing between words in text. Note that character "" in the font need not
have anything to do with blank spaces.
param[3] = space stretch is the amount of glue stretching between words.
param[4] = space shrink is the amount of glue shrinking between words.
param[5] = x height is the size of one ex in the font; it is also the height of letters for which accents dont
have to be raised or lowered.
param[6] = quad is the size of one em in the font.
param[7] = extra space is the amount added to param[2] at the ends of sentences.
If fewer than seven parameters are present, T
E
X sets the missing parameters to zero. Fonts used for math
symbols are required to have additional parameter information, which is explained later.
dene slant code = 1
dene space code = 2
dene space stretch code = 3
dene space shrink code = 4
dene x height code = 5
dene quad code = 6
dene extra space code = 7
548. So that is what TFM les hold. Since T
E
X has to absorb such information about lots of fonts, it stores
most of the data in a large array called font info. Each item of font info is a memory word ; the x word
data gets converted into scaled entries, while everything else goes into words of type four quarters .
When the user denes \font\f, say, T
E
X assigns an internal number to the users font \f. Adding this
number to font id base gives the eqtb location of a frozen control sequence that will always select the font.
Types in the outer block 18 +
internal font number = font base . . font max ; font in a char node
font index = 0 . . font mem size; index into font info
549 T
E
X82 PART 30: FONT METRIC DATA 201
549. Here now is the (rather formidable) array of font arrays.
dene non char qi (256) a halfword code that cant match a real character
dene non address = 0 a spurious bchar label
Global variables 13 +
font info: array [font index ] of memory word ; the big collection of font data
fmem ptr : font index ; rst unused word of font info
font ptr : internal font number ; largest internal font number in use
font check : array [internal font number ] of four quarters ; check sum
font size: array [internal font number ] of scaled ; at size
font dsize: array [internal font number ] of scaled ; design size
font params : array [internal font number ] of font index ; how many font parameters are present
font name: array [internal font number ] of str number ; name of the font
font area: array [internal font number ] of str number ; area of the font
font bc: array [internal font number ] of eight bits ; beginning (smallest) character code
font ec: array [internal font number ] of eight bits ; ending (largest) character code
font glue: array [internal font number ] of pointer ;
glue specication for interword space, null if not allocated
font used : array [internal font number ] of boolean;
has a character from this font actually appeared in the output?
hyphen char : array [internal font number ] of integer ; current \hyphenchar values
skew char : array [internal font number ] of integer ; current \skewchar values
bchar label : array [internal font number ] of font index ;
start of lig kern program for left boundary character, non address if there is none
font bchar : array [internal font number ] of min quarterword . . non char ;
right boundary character, non char if there is none
font false bchar : array [internal font number ] of min quarterword . . non char ;
font bchar if it doesnt exist in the font, otherwise non char
550. Besides the arrays just enumerated, we have directory arrays that make it easy to get at the
individual entries in font info. For example, the char info data for character c in font f will be in
font info[char base[f] + c].qqqq ; and if w is the width index part of this word (the b0 eld), the width of
the character is font info[width base[f] + w].sc. (These formulas assume that min quarterword has already
been added to c and to w, since T
E
X stores its quarterwords that way.)
Global variables 13 +
char base: array [internal font number ] of integer ; base addresses for char info
width base: array [internal font number ] of integer ; base addresses for widths
height base: array [internal font number ] of integer ; base addresses for heights
depth base: array [internal font number ] of integer ; base addresses for depths
italic base: array [internal font number ] of integer ; base addresses for italic corrections
lig kern base: array [internal font number ] of integer ; base addresses for ligature/kerning programs
kern base: array [internal font number ] of integer ; base addresses for kerns
exten base: array [internal font number ] of integer ; base addresses for extensible recipes
param base: array [internal font number ] of integer ; base addresses for font parameters
551. Set initial values of key variables 21 +
for k font base to font max do font used [k] false;
202 PART 30: FONT METRIC DATA T
E
X82 552
552. T
E
X always knows at least one font, namely the null font. It has no characters, and its seven
parameters are all equal to zero.
Initialize table entries (done by INITEX only) 164 +
font ptr null font ; fmem ptr 7; font name[null font ] "nullfont"; font area[null font ] "";
hyphen char [null font ] ""; skew char [null font ] 1; bchar label [null font ] non address ;
font bchar [null font ] non char ; font false bchar [null font ] non char ; font bc[null font ] 1;
font ec[null font ] 0; font size[null font ] 0; font dsize[null font ] 0; char base[null font ] 0;
width base[null font ] 0; height base[null font ] 0; depth base[null font ] 0;
italic base[null font ] 0; lig kern base[null font ] 0; kern base[null font ] 0;
exten base[null font ] 0; font glue[null font ] null ; font params [null font ] 7;
param base[null font ] 1;
for k 0 to 6 do font info[k].sc 0;
553. Put each of T
E
Xs primitives into the hash table 226 +
primitive("nullfont", set font , null font ); text (frozen null font ) "nullfont";
eqtb[frozen null font ] eqtb[cur val ];
554 T
E
X82 PART 30: FONT METRIC DATA 203
554. Of course we want to dene macros that suppress the detail of how font information is actually
packed, so that we dont have to write things like
font info[width base[f] + font info[char base[f] + c].qqqq .b0 ].sc
too often. The WEB denitions here make char info(f)(c) the four quarters word of font information
corresponding to character c of font f. If q is such a word, char width(f)(q) will be the characters width;
hence the long formula above is at least abbreviated to
char width(f)(char info(f)(c)).
Usually, of course, we will fetch q rst and look at several of its elds at the same time.
The italic correction of a character will be denoted by char italic(f)(q), so it is analogous to char width.
But we will get at the height and depth in a slightly dierent way, since we usually want to compute both
height and depth if we want either one. The value of height depth(q) will be the 8-bit quantity
b = height index 16 + depth index ,
and if b is such a byte we will write char height (f)(b) and char depth(f)(b) for the height and depth of the
character c for which q = char info(f)(c). Got that?
The tag eld will be called char tag (q); the remainder byte will be called rem byte(q), using a macro that
we have already dened above.
Access to a characters width, height , depth, and tag elds is part of T
E
Xs inner loop, so we want these
macros to produce code that is as fast as possible under the circumstances.
dene char info end (#) # ] .qqqq
dene char info(#) font info [ char base[#] + char info end
dene char width end (#) #.b0 ] .sc
dene char width(#) font info [ width base[#] + char width end
dene char exists (#) (#.b0 > min quarterword )
dene char italic end (#) (qo(#.b2 )) div 4 ] .sc
dene char italic(#) font info [ italic base[#] + char italic end
dene height depth(#) qo(#.b1 )
dene char height end (#) (#) div 16 ] .sc
dene char height (#) font info [ height base[#] + char height end
dene char depth end (#) (#) mod 16 ] .sc
dene char depth(#) font info [ depth base[#] + char depth end
dene char tag (#) ((qo(#.b2 )) mod 4)
555. The global variable null character is set up to be a word of char info for a character that doesnt
exist. Such a word provides a convenient way to deal with erroneous situations.
Global variables 13 +
null character : four quarters ; nonexistent character information
556. Set initial values of key variables 21 +
null character .b0 min quarterword ; null character .b1 min quarterword ;
null character .b2 min quarterword ; null character .b3 min quarterword ;
204 PART 30: FONT METRIC DATA T
E
X82 557
557. Here are some macros that help process ligatures and kerns. We write char kern(f)(j) to nd the
amount of kerning specied by kerning command j in font f. If j is the char info for a character with a
ligature/kern program, the rst instruction of that program is either i = font info[lig kern start (f)(j)] or
font info[lig kern restart (f)(i)], depending on whether or not skip byte(i) stop ag .
The constant kern base oset should be simplied, for Pascal compilers that do not do local optimization.
dene char kern end (#) 256 op byte(#) + rem byte(#) ] .sc
dene char kern(#) font info [ kern base[#] + char kern end
dene kern base oset 256 (128 + min quarterword )
dene lig kern start (#) lig kern base[#] + rem byte beginning of lig/kern program
dene lig kern restart end (#) 256 op byte(#) + rem byte(#) + 32768 kern base oset
dene lig kern restart (#) lig kern base[#] + lig kern restart end
558. Font parameters are referred to as slant (f), space(f), etc.
dene param end (#) param base[#] ] .sc
dene param(#) font info [ # + param end
dene slant param(slant code) slant to the right, per unit distance upward
dene space param(space code) normal space between words
dene space stretch param(space stretch code) stretch between words
dene space shrink param(space shrink code) shrink between words
dene x height param(x height code) one ex
dene quad param(quad code) one em
dene extra space param(extra space code) additional space at end of sentence
The em width for cur font 558
quad (cur font )
This code is used in section 455.
559. The x-height for cur font 559
x height (cur font )
This code is used in section 455.
560 T
E
X82 PART 30: FONT METRIC DATA 205
560. T
E
X checks the information of a TFM le for validity as the le is being read in, so that no further
checks will be needed when typesetting is going on. The somewhat tedious subroutine that does this is called
read font info. It has four parameters: the user font identier u, the le name and area strings nom and
aire, and the at size s. If s is negative, its the negative of a scale factor to be applied to the design size;
s = 1000 is the normal case. Otherwise s will be substituted for the design size; in this case, s must be
positive and less than 2048 pt (i.e., it must be less than 2
27
when considered as an integer).
The subroutine opens and closes a global le variable called tfm le. It returns the value of the internal
font number that was just loaded. If an error is detected, an error message is issued and no font information
is stored; null font is returned in this case.
dene bad tfm = 11 label for read font info
dene abort goto bad tfm do this when the TFM data is wrong
function read font info(u : pointer ; nom, aire : str number ; s : scaled ): internal font number ;
input a TFM le
label done, bad tfm, not found ;
var k: font index ; index into font info
le opened : boolean; was tfm le successfully opened?
lf , lh, bc, ec, nw, nh, nd , ni , nl , nk , ne, np: halfword ; sizes of subles
f: internal font number ; the new fonts number
g: internal font number ; the number to return
a, b, c, d: eight bits ; byte variables
qw: four quarters ; sw: scaled ; accumulators
bch label : integer ; left boundary start location, or innity
bchar : 0 . . 256; right boundary character, or 256
z: scaled ; the design size or the at size
alpha: integer ; beta: 1 . . 16; auxiliary quantities used in xed-point multiplication
begin g null font ;
Read and check the font data; abort if the TFM le is malformed; if theres no room for this font, say so
and goto done; otherwise incr (font ptr ) and goto done 562 ;
bad tfm: Report that the font wont be loaded 561 ;
done: if le opened then b close(tfm le);
read font info g;
end;
206 PART 30: FONT METRIC DATA T
E
X82 561
561. There are programs called TFtoPL and PLtoTF that convert between the TFM format and a symbolic
property-list format that can be easily edited. These programs contain extensive diagnostic information, so
T
E
X does not have to bother giving precise details about why it rejects a particular TFM le.
dene start font error message print err ("Font"); sprint cs (u); print char ("=");
print le name(nom, aire, "");
if s 0 then
begin print ("at"); print scaled (s); print ("pt");
end
else if s ,= 1000 then
begin print ("scaled"); print int (s);
end
Report that the font wont be loaded 561
start font error message;
if le opened then print ("notloadable:Badmetric(TFM)file")
else print ("notloadable:Metric(TFM)filenotfound");
help5 ("Iwasntabletoreadthesizedataforthisfont,")
("soIwillignorethefontspecification.")
("[WizardscanfixTFMfilesusingTFtoPL/PLtoTF.]")
("Youmighttryinsertingadifferentfontspec;")
("e.g.,type`I\font<samefontid>=<substitutefontname>."); error
This code is used in section 560.
562. Read and check the font data; abort if the TFM le is malformed; if theres no room for this font,
say so and goto done; otherwise incr (font ptr ) and goto done 562
Open tfm le for input 563 ;
Read the TFM size elds 565 ;
Use size elds to allocate font information 566 ;
Read the TFM header 568 ;
Read character data 569 ;
Read box dimensions 571 ;
Read ligature/kern program 573 ;
Read extensible character recipes 574 ;
Read font parameters 575 ;
Make nal adjustments and goto done 576
This code is used in section 560.
563. Open tfm le for input 563
le opened false;
if aire = "" then pack le name(nom, TEX font area, ".tfm")
else pack le name(nom, aire, ".tfm");
if b open in(tfm le) then abort ;
le opened true
This code is used in section 562.
564 T
E
X82 PART 30: FONT METRIC DATA 207
564. Note: A malformed TFM le might be shorter than it claims to be; thus eof (tfm le) might be true
when read font info refers to tfm le or when it says get (tfm le). If such circumstances cause system error
messages, you will have to defeat them somehow, for example by dening fget to be begin get (tfm le); if
eof (tfm le) then abort ; end.
dene fget get (tfm le)
dene fbyte tfm le
dene read sixteen(#)
begin # fbyte;
if # > 127 then abort ;
fget ; # # 400 + fbyte;
end
dene store four quarters (#)
begin fget ; a fbyte; qw.b0 qi (a); fget ; b fbyte; qw.b1 qi (b); fget ; c fbyte;
qw.b2 qi (c); fget ; d fbyte; qw.b3 qi (d); # qw;
end
565. Read the TFM size elds 565
begin read sixteen(lf ); fget ; read sixteen(lh); fget ; read sixteen(bc); fget ; read sixteen(ec);
if (bc > ec + 1) (ec > 255) then abort ;
if bc > 255 then bc = 256 and ec = 255
begin bc 1; ec 0;
end;
fget ; read sixteen(nw); fget ; read sixteen(nh); fget ; read sixteen(nd ); fget ; read sixteen(ni ); fget ;
read sixteen(nl ); fget ; read sixteen(nk ); fget ; read sixteen(ne); fget ; read sixteen(np);
if lf ,= 6 + lh + (ec bc + 1) + nw + nh + nd + ni + nl + nk + ne + np then abort ;
if (nw = 0) (nh = 0) (nd = 0) (ni = 0) then abort ;
end
This code is used in section 562.
566. The preliminary settings of the index-oset variables char base, width base, lig kern base, kern base,
and exten base will be corrected later by subtracting min quarterword from them; and we will subtract 1
from param base too. Its best to forget about such anomalies until later.
Use size elds to allocate font information 566
lf lf 6 lh; lf words should be loaded into font info
if np < 7 then lf lf + 7 np; at least seven parameters will appear
if (font ptr = font max ) (fmem ptr + lf > font mem size) then
Apologize for not loading the font, goto done 567 ;
f font ptr + 1; char base[f] fmem ptr bc; width base[f] char base[f] + ec + 1;
height base[f] width base[f] + nw; depth base[f] height base[f] + nh;
italic base[f] depth base[f] + nd ; lig kern base[f] italic base[f] + ni ;
kern base[f] lig kern base[f] + nl kern base oset ;
exten base[f] kern base[f] + kern base oset + nk ; param base[f] exten base[f] + ne
This code is used in section 562.
567. Apologize for not loading the font, goto done 567
begin start font error message; print ("notloaded:Notenoughroomleft");
help4 ("ImafraidIwontbeabletomakeuseofthisfont,")
("becausemymemoryforcharactersizedataistoosmall.")
("Ifyourereallystuck,askawizardtoenlargeme.")
("Ormaybetry`I\font<samefontid>=<nameofloadedfont>."); error ; goto done;
end
This code is used in section 566.
208 PART 30: FONT METRIC DATA T
E
X82 568
568. Only the rst two words of the header are needed by T
E
X82.
Read the TFM header 568
begin if lh < 2 then abort ;
store four quarters (font check [f]); fget ; read sixteen(z); this rejects a negative design size
fget ; z z 400 + fbyte; fget ; z (z 20 ) + (fbyte div 20 );
if z < unity then abort ;
while lh > 2 do
begin fget ; fget ; fget ; fget ; decr (lh); ignore the rest of the header
end;
font dsize[f] z;
if s ,= 1000 then
if s 0 then z s
else z xn over d (z, s, 1000);
font size[f] z;
end
This code is used in section 562.
569. Read character data 569
for k fmem ptr to width base[f] 1 do
begin store four quarters (font info[k].qqqq );
if (a nw) (b div 20 nh) (b mod 20 nd ) (c div 4 ni ) then abort ;
case c mod 4 of
lig tag : if d nl then abort ;
ext tag : if d ne then abort ;
list tag : Check for charlist cycle 570 ;
othercases do nothing no tag
endcases;
end
This code is used in section 562.
570. We want to make sure that there is no cycle of characters linked together by list tag entries, since
such a cycle would get T
E
X into an endless loop. If such a cycle exists, the routine here detects it when
processing the largest character code in the cycle.
dene check byte range(#)
begin if (# < bc) (# > ec) then abort
end
dene current character being worked on k + bc fmem ptr
Check for charlist cycle 570
begin check byte range(d);
while d < current character being worked on do
begin qw char info(f)(d); N.B.: not qi (d), since char base[f] hasnt been adjusted yet
if char tag (qw) ,= list tag then goto not found ;
d qo(rem byte(qw)); next character on the list
end;
if d = current character being worked on then abort ; yes, theres a cycle
not found : end
This code is used in section 569.
571 T
E
X82 PART 30: FONT METRIC DATA 209
571. A x word whose four bytes are (a, b, c, d) from left to right represents the number
x =

b 2
4
+ c 2
12
+ d 2
20
, if a = 0;
16 + b 2
4
+ c 2
12
+ d 2
20
, if a = 255.
(No other choices of a are allowed, since the magnitude of a number in design-size units must be less than
16.) We want to multiply this quantity by the integer z, which is known to be less than 2
27
. If z < 2
23
, the
individual multiplications b z, c z, d z cannot overow; otherwise we will divide z by 2, 4, 8, or 16, to
obtain a multiplier less than 2
23
, and we can compensate for this later. If z has thereby been replaced by
z

= z/2
e
, let = 2
4e
; we shall compute
(b + c 2
8
+ d 2
16
) z

/|
if a = 0, or the same quantity minus = 2
4+e
z

if a = 255. This calculation must be done exactly, in order

to guarantee portability of T
E
X between computers.
dene store scaled (#)
begin fget ; a fbyte; fget ; b fbyte; fget ; c fbyte; fget ; d fbyte;
sw (((((d z) div 400 ) + (c z)) div 400 ) + (b z)) div beta;
if a = 0 then # sw else if a = 255 then # sw alpha else abort ;
end
Read box dimensions 571
begin Replace z by z

and compute , 572 ;

for k width base[f] to lig kern base[f] 1 do store scaled (font info[k].sc);
if font info[width base[f]].sc ,= 0 then abort ; width[0] must be zero
if font info[height base[f]].sc ,= 0 then abort ; height [0] must be zero
if font info[depth base[f]].sc ,= 0 then abort ; depth[0] must be zero
if font info[italic base[f]].sc ,= 0 then abort ; italic[0] must be zero
end
This code is used in section 562.
572. Replace z by z

and compute , 572

begin alpha 16;
while z 40000000 do
begin z z div 2; alpha alpha + alpha;
end;
beta 256 div alpha; alpha alpha z;
end
This code is used in section 571.
210 PART 30: FONT METRIC DATA T
E
X82 573
573. dene check existence(#)
begin check byte range(#); qw char info(f)(#); N.B.: not qi (#)
if char exists (qw) then abort ;
end
Read ligature/kern program 573
bch label 77777 ; bchar 256;
if nl > 0 then
begin for k lig kern base[f] to kern base[f] + kern base oset 1 do
begin store four quarters (font info[k].qqqq );
if a > 128 then
begin if 256 c + d nl then abort ;
if a = 255 then
if k = lig kern base[f] then bchar b;
end
else begin if b ,= bchar then check existence(b);
if c < 128 then check existence(d) check ligature
else if 256 (c 128) + d nk then abort ; check kern
if a < 128 then
if k lig kern base[f] + a + 1 nl then abort ;
end;
end;
if a = 255 then bch label 256 c + d;
end;
for k kern base[f] + kern base oset to exten base[f] 1 do store scaled (font info[k].sc);
This code is used in section 562.
574. Read extensible character recipes 574
for k exten base[f] to param base[f] 1 do
begin store four quarters (font info[k].qqqq );
if a ,= 0 then check existence(a);
if b ,= 0 then check existence(b);
if c ,= 0 then check existence(c);
check existence(d);
end
This code is used in section 562.
575. We check to see that the TFM le doesnt end prematurely; but no error message is given for les
having more than lf words.
Read font parameters 575
begin for k 1 to np do
if k = 1 then the slant parameter is a pure number
begin fget ; sw fbyte;
if sw > 127 then sw sw 256;
fget ; sw sw 400 + fbyte; fget ; sw sw 400 + fbyte; fget ;
font info[param base[f]].sc (sw 20 ) + (fbyte div 20 );
end
else store scaled (font info[param base[f] + k 1].sc);
if eof (tfm le) then abort ;
for k np + 1 to 7 do font info[param base[f] + k 1].sc 0;
end
This code is used in section 562.
576 T
E
X82 PART 30: FONT METRIC DATA 211
576. Now to wrap it up, we have checked all the necessary things about the TFM le, and all we need to
do is put the nishing touches on the data for the new font.
dene adjust (#) #[f] qo(#[f]) correct for the excess min quarterword that was added
Make nal adjustments and goto done 576
if np 7 then font params [f] np else font params [f] 7;
hyphen char [f] default hyphen char ; skew char [f] default skew char ;
if bch label < nl then bchar label [f] bch label + lig kern base[f]
else bchar label [f] non address ;
font bchar [f] qi (bchar ); font false bchar [f] qi (bchar );
if bchar ec then
if bchar bc then
begin qw char info(f)(bchar ); N.B.: not qi (bchar )
if char exists (qw) then font false bchar [f] non char ;
end;
font name[f] nom; font area[f] aire; font bc[f] bc; font ec[f] ec; font glue[f] null ;
adjust (char base); adjust (width base); adjust (lig kern base); adjust (kern base); adjust (exten base);
decr (param base[f]); fmem ptr fmem ptr + lf ; font ptr f; g f; goto done
This code is used in section 562.
577. Before we forget about the format of these tables, lets deal with two of T
E
Xs basic scanning routines
related to font information.
Declare procedures that scan font-related stu 577
procedure scan font ident ;
var f: internal font number ; m: halfword ;
begin Get the next non-blank non-call token 406 ;
if cur cmd = def font then f cur font
else if cur cmd = set font then f cur chr
else if cur cmd = def family then
begin m cur chr ; scan four bit int ; f equiv (m + cur val );
end
else begin print err ("Missingfontidentifier");
help2 ("Iwaslookingforacontrolsequencewhose")
("currentmeaninghasbeendefinedby\font."); back error ; f null font ;
end;
cur val f;
end;
See also section 578.
This code is used in section 409.
212 PART 30: FONT METRIC DATA T
E
X82 578
578. The following routine is used to implement \fontdimen n f. The boolean parameter writing is set
true if the calling program intends to change the parameter value.
Declare procedures that scan font-related stu 577 +
procedure nd font dimen(writing : boolean); sets cur val to font info location
var f: internal font number ; n: integer ; the parameter number
begin scan int ; n cur val ; scan font ident ; f cur val ;
if n 0 then cur val fmem ptr
else begin if writing (n space shrink code) (n space code) (font glue[f] ,= null ) then
begin delete glue ref (font glue[f]); font glue[f] null ;
end;
if n > font params [f] then
if f < font ptr then cur val fmem ptr
else Increase the number of parameters in the last font 580
else cur val n + param base[f];
end;
Issue an error message if cur val = fmem ptr 579 ;
end;
579. Issue an error message if cur val = fmem ptr 579
if cur val = fmem ptr then
begin print err ("Font"); print esc(font id text (f)); print ("hasonly");
print int (font params [f]); print ("fontdimenparameters");
help2 ("Toincreasethenumberoffontparameters,youmust")
("use\fontdimenimmediatelyafterthe\fontisloaded."); error ;
end
This code is used in section 578.
580. Increase the number of parameters in the last font 580
begin repeat if fmem ptr = font mem size then overow("fontmemory", font mem size);
font info[fmem ptr ].sc 0; incr (fmem ptr ); incr (font params [f]);
until n = font params [f];
cur val fmem ptr 1; this equals param base[f] + font params [f]
end
This code is used in section 578.
581. When T
E
X wants to typeset a character that doesnt exist, the character node is not created; thus
the output routine can assume that characters exist when it sees them. The following procedure prints a
warning message unless the user has suppressed it.
procedure char warning (f : internal font number ; c : eight bits );
begin if tracing lost chars > 0 then
begin begin diagnostic; print nl ("Missingcharacter:Thereisno"); print ASCII (c);
print ("infont"); slow print (font name[f]); print char ("!"); end diagnostic(false);
end;
end;
582 T
E
X82 PART 30: FONT METRIC DATA 213
582. Here is a function that returns a pointer to a character node for a given character in a given font. If
that character doesnt exist, null is returned instead.
function new character (f : internal font number ; c : eight bits ): pointer ;
label exit ;
var p: pointer ; newly allocated node
begin if font bc[f] c then
if font ec[f] c then
if char exists (char info(f)(qi (c))) then
begin p get avail ; font (p) f; character (p) qi (c); new character p; return;
end;
char warning (f, c); new character null ;
exit : end;
214 PART 31: DEVICE-INDEPENDENT FILE FORMAT T
E
X82 583
583. Device-independent le format. The most important output produced by a run of T
E
X is the
device independent (DVI) le that species where characters and rules are to appear on printed pages.
The form of these les was designed by David R. Fuchs in 1979. Almost any reasonable typesetting device
can be driven by a program that takes DVI les as input, and dozens of such DVI-to-whatever programs have
been written. Thus, it is possible to print the output of T
E
X on many dierent kinds of equipment, using
T
E
X as a device-independent front end.
A DVI le is a stream of 8-bit bytes, which may be regarded as a series of commands in a machine-like
language. The rst byte of each command is the operation code, and this code is followed by zero or
more bytes that provide parameters to the command. The parameters themselves may consist of several
consecutive bytes; for example, the set rule command has two parameters, each of which is four bytes
long. Parameters are usually regarded as nonnegative integers; but four-byte-long parameters, and shorter
parameters that denote distances, can be either positive or negative. Such parameters are given in twos
complement notation. For example, a two-byte-long distance parameter has a value between 2
15
and
2
15
1. As in TFM les, numbers that occupy more than one byte position appear in BigEndian order.
A DVI le consists of a preamble, followed by a sequence of one or more pages, followed by a
postamble. The preamble is simply a pre command, with its parameters that dene the dimensions
used in the le; this must come rst. Each page consists of a bop command, followed by any number of
other commands that tell where characters are to be placed on a physical page, followed by an eop command.
The pages appear in the order that T
E
X generated them. If we ignore nop commands and fnt def commands
(which are allowed between any two commands in the le), each eop command is immediately followed by
a bop command, or by a post command; in the latter case, there are no more pages in the le, and the
remaining bytes form the postamble. Further details about the postamble will be explained later.
Some parameters in DVI commands are pointers. These are four-byte quantities that give the location
number of some other byte in the le; the rst byte is number 0, then comes number 1, and so on. For
example, one of the parameters of a bop command points to the previous bop; this makes it feasible to read
the pages in backwards order, in case the results are being directed to a device that stacks its output face
up. Suppose the preamble of a DVI le occupies bytes 0 to 99. Now if the rst page occupies bytes 100 to
999, say, and if the second page occupies bytes 1000 to 1999, then the bop that starts in byte 1000 points
to 100 and the bop that starts in byte 2000 points to 1000. (The very rst bop, i.e., the one starting in byte
100, has a pointer of 1.)
584. The DVI format is intended to be both compact and easily interpreted by a machine. Compactness
is achieved by making most of the information implicit instead of explicit. When a DVI-reading program
reads the commands for a page, it keeps track of several quantities: (a) The current font f is an integer;
this value is changed only by fnt and fnt num commands. (b) The current position on the page is given by
two numbers called the horizontal and vertical coordinates, h and v. Both coordinates are zero at the upper
left corner of the page; moving to the right corresponds to increasing the horizontal coordinate, and moving
down corresponds to increasing the vertical coordinate. Thus, the coordinates are essentially Cartesian,
except that vertical directions are ipped; the Cartesian version of (h, v) would be (h, v). (c) The current
spacing amounts are given by four numbers w, x, y, and z, where w and x are used for horizontal spacing
and where y and z are used for vertical spacing. (d) There is a stack containing (h, v, w, x, y, z) values; the
DVI commands push and pop are used to change the current level of operation. Note that the current font f
is not pushed and popped; the stack contains only information about positioning.
The values of h, v, w, x, y, and z are signed integers having up to 32 bits, including the sign. Since they
represent physical distances, there is a small unit of measurement such that increasing h by 1 means moving
a certain tiny distance to the right. The actual unit of measurement is variable, as explained below; T
E
X sets
things up so that its DVI output is in sp units, i.e., scaled points, in agreement with all the scaled dimensions
in T
E
Xs data structures.
585 T
E
X82 PART 31: DEVICE-INDEPENDENT FILE FORMAT 215
585. Here is a list of all the commands that may appear in a DVI le. Each command is specied by
its symbolic name (e.g., bop), its opcode byte (e.g., 139), and its parameters (if any). The parameters
are followed by a bracketed number telling how many bytes they occupy; for example, p[4] means that
parameter p is four bytes long.
set char 0 0. Typeset character number 0 from font f such that the reference point of the character is
at (h, v). Then increase h by the width of that character. Note that a character may have zero or
negative width, so one cannot be sure that h will advance after this command; but h usually does
increase.
set char 1 through set char 127 (opcodes 1 to 127). Do the operations of set char 0 ; but use the character
whose number matches the opcode, instead of character 0.
set1 128 c[1]. Same as set char 0 , except that character number c is typeset. T
E
X82 uses this command for
characters in the range 128 c < 256.
set2 129 c[2]. Same as set1 , except that c is two bytes long, so it is in the range 0 c < 65536. T
E
X82
never uses this command, but it should come in handy for extensions of T
E
X that deal with oriental
languages.
set3 130 c[3]. Same as set1 , except that c is three bytes long, so it can be as large as 2
24
1. Not even
the Chinese language has this many characters, but this command might prove useful in some yet
unforeseen extension.
set4 131 c[4]. Same as set1 , except that c is four bytes long. Imagine that.
set rule 132 a[4] b[4]. Typeset a solid black rectangle of height a and width b, with its bottom left corner at
(h, v). Then set h h + b. If either a 0 or b 0, nothing should be typeset. Note that if b < 0,
the value of h will decrease even though nothing else happens. See below for details about how to
typeset rules so that consistency with METAFONT is guaranteed.
put1 133 c[1]. Typeset character number c from font f such that the reference point of the character is at
(h, v). (The put commands are exactly like the set commands, except that they simply put out a
character or a rule without moving the reference point afterwards.)
put2 134 c[2]. Same as set2 , except that h is not changed.
put3 135 c[3]. Same as set3 , except that h is not changed.
put4 136 c[4]. Same as set4 , except that h is not changed.
put rule 137 a[4] b[4]. Same as set rule, except that h is not changed.
nop 138. No operation, do nothing. Any number of nops may occur between DVI commands, but a nop
cannot be inserted between a command and its parameters or between two parameters.
bop 139 c
0
[4] c
1
[4] . . . c
9
[4] p[4]. Beginning of a page: Set (h, v, w, x, y, z) (0, 0, 0, 0, 0, 0) and set the
stack empty. Set the current font f to an undened value. The ten c
i
parameters hold the values of
\count0 . . . \count9 in T
E
X at the time \shipout was invoked for this page; they can be used to
identify pages, if a user wants to print only part of a DVI le. The parameter p points to the previous
bop in the le; the rst bop has p = 1.
eop 140. End of page: Print what you have read since the previous bop. At this point the stack should
be empty. (The DVI-reading programs that drive most output devices will have kept a buer of the
material that appears on the page that has just ended. This material is largely, but not entirely, in
order by v coordinate and (for xed v) by h coordinate; so it usually needs to be sorted into some
order that is appropriate for the device in question.)
push 141. Push the current values of (h, v, w, x, y, z) onto the top of the stack; do not change any of these
values. Note that f is not pushed.
pop 142. Pop the top six values o of the stack and assign them respectively to (h, v, w, x, y, z). The number
of pops should never exceed the number of pushes, since it would be highly embarrassing if the stack
were empty at the time of a pop command.
right1 143 b[1]. Set h h+b, i.e., move right b units. The parameter is a signed number in twos complement
notation, 128 b < 128; if b < 0, the reference point moves left.
216 PART 31: DEVICE-INDEPENDENT FILE FORMAT T
E
X82 585
right2 144 b[2]. Same as right1 , except that b is a two-byte quantity in the range 32768 b < 32768.
right3 145 b[3]. Same as right1 , except that b is a three-byte quantity in the range 2
23
b < 2
23
.
right4 146 b[4]. Same as right1 , except that b is a four-byte quantity in the range 2
31
b < 2
31
.
w0 147. Set h h+w; i.e., move right w units. With luck, this parameterless command will usually suce,
because the same kind of motion will occur several times in succession; the following commands
explain how w gets particular values.
w1 148 b[1]. Set w b and h h + b. The value of b is a signed quantity in twos complement notation,
128 b < 128. This command changes the current w spacing and moves right by b.
w2 149 b[2]. Same as w1 , but b is two bytes long, 32768 b < 32768.
w3 150 b[3]. Same as w1 , but b is three bytes long, 2
23
b < 2
23
.
w4 151 b[4]. Same as w1 , but b is four bytes long, 2
31
b < 2
31
.
x0 152. Set h h + x; i.e., move right x units. The x commands are like the w commands except that
they involve x instead of w.
x1 153 b[1]. Set x b and h h + b. The value of b is a signed quantity in twos complement notation,
128 b < 128. This command changes the current x spacing and moves right by b.
x2 154 b[2]. Same as x1 , but b is two bytes long, 32768 b < 32768.
x3 155 b[3]. Same as x1 , but b is three bytes long, 2
23
b < 2
23
.
x4 156 b[4]. Same as x1 , but b is four bytes long, 2
31
b < 2
31
.
down1 157 a[1]. Set v v + a, i.e., move down a units. The parameter is a signed number in twos
complement notation, 128 a < 128; if a < 0, the reference point moves up.
down2 158 a[2]. Same as down1 , except that a is a two-byte quantity in the range 32768 a < 32768.
down3 159 a[3]. Same as down1 , except that a is a three-byte quantity in the range 2
23
a < 2
23
.
down4 160 a[4]. Same as down1 , except that a is a four-byte quantity in the range 2
31
a < 2
31
.
y0 161. Set v v +y; i.e., move down y units. With luck, this parameterless command will usually suce,
because the same kind of motion will occur several times in succession; the following commands
explain how y gets particular values.
y1 162 a[1]. Set y a and v v + a. The value of a is a signed quantity in twos complement notation,
128 a < 128. This command changes the current y spacing and moves down by a.
y2 163 a[2]. Same as y1 , but a is two bytes long, 32768 a < 32768.
y3 164 a[3]. Same as y1 , but a is three bytes long, 2
23
a < 2
23
.
y4 165 a[4]. Same as y1 , but a is four bytes long, 2
31
a < 2
31
.
z0 166. Set v v + z; i.e., move down z units. The z commands are like the y commands except that
they involve z instead of y.
z1 167 a[1]. Set z a and v v + a. The value of a is a signed quantity in twos complement notation,
128 a < 128. This command changes the current z spacing and moves down by a.
z2 168 a[2]. Same as z1 , but a is two bytes long, 32768 a < 32768.
z3 169 a[3]. Same as z1 , but a is three bytes long, 2
23
a < 2
23
.
z4 170 a[4]. Same as z1 , but a is four bytes long, 2
31
a < 2
31
.
fnt num 0 171. Set f 0. Font 0 must previously have been dened by a fnt def instruction, as explained
below.
fnt num 1 through fnt num 63 (opcodes 172 to 234). Set f 1, . . . , f 63, respectively.
fnt1 235 k[1]. Set f k. T
E
X82 uses this command for font numbers in the range 64 k < 256.
fnt2 236 k[2]. Same as fnt1 , except that k is two bytes long, so it is in the range 0 k < 65536. T
E
X82
never generates this command, but large font numbers may prove useful for specications of color
or texture, or they may be used for special fonts that have xed numbers in some external coding
scheme.
585 T
E
X82 PART 31: DEVICE-INDEPENDENT FILE FORMAT 217
fnt3 237 k[3]. Same as fnt1 , except that k is three bytes long, so it can be as large as 2
24
1.
fnt4 238 k[4]. Same as fnt1 , except that k is four bytes long; this is for the really big font numbers (and for
the negative ones).
xxx1 239 k[1] x[k]. This command is undened in general; it functions as a (k + 2)-byte nop unless special
DVI-reading programs are being used. T
E
X82 generates xxx1 when a short enough \special appears,
setting k to the number of bytes being sent. It is recommended that x be a string having the form of
a keyword followed by possible parameters relevant to that keyword.
xxx2 240 k[2] x[k]. Like xxx1 , but 0 k < 65536.
xxx3 241 k[3] x[k]. Like xxx1 , but 0 k < 2
24
.
xxx4 242 k[4] x[k]. Like xxx1 , but k can be ridiculously large. T
E
X82 uses xxx4 when sending a string of
length 256 or more.
fnt def1 243 k[1] c[4] s[4] d[4] a[1] l[1] n[a + l]. Dene font k, where 0 k < 256; font denitions will be
explained shortly.
fnt def2 244 k[2] c[4] s[4] d[4] a[1] l[1] n[a + l]. Dene font k, where 0 k < 65536.
fnt def3 245 k[3] c[4] s[4] d[4] a[1] l[1] n[a + l]. Dene font k, where 0 k < 2
24
.
fnt def4 246 k[4] c[4] s[4] d[4] a[1] l[1] n[a + l]. Dene font k, where 2
31
k < 2
31
.
pre 247 i[1] num[4] den[4] mag [4] k[1] x[k]. Beginning of the preamble; this must come at the very beginning
of the le. Parameters i, num, den, mag , k, and x are explained below.
post 248. Beginning of the postamble, see below.
post post 249. Ending of the postamble, see below.
Commands 250255 are undened at the present time.
586. dene set char 0 = 0 typeset character 0 and move right
dene set1 = 128 typeset a character and move right
dene set rule = 132 typeset a rule and move right
dene put rule = 137 typeset a rule
dene nop = 138 no operation
dene bop = 139 beginning of page
dene eop = 140 ending of page
dene push = 141 save the current positions
dene pop = 142 restore previous positions
dene right1 = 143 move right
dene w0 = 147 move right by w
dene w1 = 148 move right and set w
dene x0 = 152 move right by x
dene x1 = 153 move right and set x
dene down1 = 157 move down
dene y0 = 161 move down by y
dene y1 = 162 move down and set y
dene z0 = 166 move down by z
dene z1 = 167 move down and set z
dene fnt num 0 = 171 set current font to 0
dene fnt1 = 235 set current font
dene xxx1 = 239 extension to DVI primitives
dene xxx4 = 242 potentially long extension to DVI primitives
dene fnt def1 = 243 dene the meaning of a font number
dene pre = 247 preamble
dene post = 248 postamble beginning
dene post post = 249 postamble ending
218 PART 31: DEVICE-INDEPENDENT FILE FORMAT T
E
X82 587
587. The preamble contains basic information about the le as a whole. As stated above, there are six
parameters:
i[1] num[4] den[4] mag [4] k[1] x[k].
The i byte identies DVI format; currently this byte is always set to 2. (The value i = 3 is currently used
for an extended format that allows a mixture of right-to-left and left-to-right typesetting. Some day we will
set i = 4, when DVI format makes another incompatible changeperhaps in the year 2048.)
The next two parameters, num and den, are positive integers that dene the units of measurement; they
are the numerator and denominator of a fraction by which all dimensions in the DVI le could be multiplied
in order to get lengths in units of 10
7
meters. Since 7227pt = 254cm, and since T
E
X works with scaled
points where there are 2
16
sp in a point, T
E
X sets num/den = (254 10
5
)/(7227 2
16
) = 25400000/473628672.
The mag parameter is what T
E
X calls \mag, i.e., 1000 times the desired magnication. The actual fraction
by which dimensions are multiplied is therefore mag num/1000den. Note that if a T
E
X source document
does not call for any true dimensions, and if you change it only by specifying a dierent \mag setting, the
DVI le that T
E
X creates will be completely unchanged except for the value of mag in the preamble and
postamble. (Fancy DVI-reading programs allow users to override the mag setting when a DVI le is being
printed.)
Finally, k and x allow the DVI writer to include a comment, which is not interpreted further. The length
of comment x is k, where 0 k < 256.
dene id byte = 2 identies the kind of DVI les described here
588. Font denitions for a given font number k contain further parameters
c[4] s[4] d[4] a[1] l[1] n[a + l].
The four-byte value c is the check sum that T
E
X found in the TFM le for this font; c should match the check
sum of the font found by programs that read this DVI le.
Parameter s contains a xed-point scale factor that is applied to the character widths in font k; font
dimensions in TFM les and other font les are relative to this quantity, which is called the at size elsewhere
in this documentation. The value of s is always positive and less than 2
27
. It is given in the same units as
the other DVI dimensions, i.e., in sp when T
E
X82 has made the le. Parameter d is similar to s; it is the
design size, and (like s) it is given in DVI units. Thus, font k is to be used at mag s/1000d times its
normal size.
The remaining part of a font denition gives the external name of the font, which is an ASCII string of
length a + l. The number a is the length of the area or directory, and l is the length of the font name
itself; the standard local system font area is supposed to be used when a = 0. The n eld contains the area
in its rst a bytes.
Font denitions must appear before the rst use of a particular font number. Once font k is dened, it
must not be dened again; however, we shall see below that font denitions appear in the postamble as well
as in the pages, so in this sense each font number is dened exactly twice, if at all. Like nop commands,
font denitions can appear before the rst bop, or between an eop and a bop.
589. Sometimes it is desirable to make horizontal or vertical rules line up precisely with certain features in
characters of a font. It is possible to guarantee the correct matching between DVI output and the characters
generated by METAFONT by adhering to the following principles: (1) The METAFONT characters should be
positioned so that a bottom edge or left edge that is supposed to line up with the bottom or left edge of
a rule appears at the reference point, i.e., in row 0 and column 0 of the METAFONT raster. This ensures
that the position of the rule will not be rounded dierently when the pixel size is not a perfect multiple of
the units of measurement in the DVI le. (2) A typeset rule of height a > 0 and width b > 0 should be
equivalent to a METAFONT-generated character having black pixels in precisely those raster positions whose
METAFONT coordinates satisfy 0 x < b and 0 y < a, where is the number of pixels per DVI unit.
590 T
E
X82 PART 31: DEVICE-INDEPENDENT FILE FORMAT 219
590. The last page in a DVI le is followed by post ; this command introduces the postamble, which
summarizes important facts that T
E
X has accumulated about the le, making it possible to print subsets of
the data with reasonable eciency. The postamble has the form
post p[4] num[4] den[4] mag [4] l[4] u[4] s[2] t[2]
font denitions
post post q[4] i[1] 223s[4]
Here p is a pointer to the nal bop in the le. The next three parameters, num, den, and mag , are duplicates
of the quantities that appeared in the preamble.
Parameters l and u give respectively the height-plus-depth of the tallest page and the width of the widest
page, in the same units as other dimensions of the le. These numbers might be used by a DVI-reading
program to position individual pages on large sheets of lm or paper; however, the standard convention
for output on normal size paper is to position each page so that the upper left-hand corner is exactly one
inch from the left and the top. Experience has shown that it is unwise to design DVI-to-printer software
that attempts cleverly to center the output; a xed position of the upper left corner is easiest for users to
understand and to work with. Therefore l and u are often ignored.
Parameter s is the maximum stack depth (i.e., the largest excess of push commands over pop commands)
needed to process this le. Then comes t, the total number of pages (bop commands) present.
The postamble continues with font denitions, which are any number of fnt def commands as described
above, possibly interspersed with nop commands. Each font number that is used in the DVI le must be
dened exactly twice: Once before it is rst selected by a fnt command, and once in the postamble.
591. The last part of the postamble, following the post post byte that signies the end of the font
denitions, contains q, a pointer to the post command that started the postamble. An identication byte, i,
comes next; this currently equals 2, as in the preamble.
The i byte is followed by four or more bytes that are all equal to the decimal number 223 (i.e., 337 in
octal). T
E
X puts out four to seven of these trailing bytes, until the total length of the le is a multiple of
four bytes, since this works out best on machines that pack four bytes per word; but any number of 223s is
allowed, as long as there are at least four of them. In eect, 223 is a sort of signature that is added at the
very end.
This curious way to nish o a DVI le makes it feasible for DVI-reading programs to nd the postamble
rst, on most computers, even though T
E
X wants to write the postamble last. Most operating systems
permit random access to individual words or bytes of a le, so the DVI reader can start at the end and skip
backwards over the 223s until nding the identication byte. Then it can back up four bytes, read q, and
move to byte q of the le. This byte should, of course, contain the value 248 (post ); now the postamble can
be read, so the DVI reader can discover all the information needed for typesetting the pages. Note that it is
also possible to skip through the DVI le at reasonably high speed to locate a particular page, if that proves
desirable. This saves a lot of time, since DVI les used in production jobs tend to be large.
Unfortunately, however, standard Pascal does not include the ability to access a random position in a le,
or even to determine the length of a le. Almost all systems nowadays provide the necessary capabilities,
so DVI format has been designed to work most eciently with modern operating systems. But if DVI les
have to be processed under the restrictions of standard Pascal, one can simply read them from front to back,
since the necessary header information is present in the preamble and in the font denitions. (The l and u
and s and t parameters, which appear only in the postamble, are frills that are handy but not absolutely
necessary.)
220 PART 32: SHIPPING PAGES OUT T
E
X82 592
592. Shipping pages out. After considering T
E
Xs eyes and stomach, we come now to the bowels.
The ship out procedure is given a pointer to a box; its mission is to describe that box in DVI form,
outputting a page to dvi le. The DVI coordinates (h, v) = (0, 0) should correspond to the upper left
corner of the box being shipped.
Since boxes can be inside of boxes inside of boxes, the main work of ship out is done by two mutually
recursive routines, hlist out and vlist out , which traverse the hlists and vlists inside of horizontal and vertical
boxes.
As individual pages are being processed, we need to accumulate information about the entire set of pages,
since such statistics must be reported in the postamble. The global variables total pages , max v , max h,
max push, and last bop are used to record this information.
The variable doing leaders is true while leaders are being output. The variable dead cycles contains the
number of times an output routine has been initiated since the last ship out .
A few additional global variables are also dened here for use in vlist out and hlist out . They could have
been local variables, but that would waste stack space when boxes are deeply nested, since the values of
these variables are not needed during recursive calls.
Global variables 13 +
total pages : integer ; the number of pages that have been shipped out
max v : scaled ; maximum height-plus-depth of pages shipped so far
max h: scaled ; maximum width of pages shipped so far
max push: integer ; deepest nesting of push commands encountered so far
last bop: integer ; location of previous bop in the DVI output
dead cycles : integer ; recent outputs that didnt ship anything out
doing leaders : boolean; are we inside a leader box?
c, f: quarterword ; character and font in current char node
rule ht , rule dp, rule wd : scaled ; size of current rule being output
g: pointer ; current glue specication
lq , lr : integer ; quantities used in calculations for leaders
593. Set initial values of key variables 21 +
total pages 0; max v 0; max h 0; max push 0; last bop 1; doing leaders false;
dead cycles 0; cur s 1;
594. The DVI bytes are output to a buer instead of being written directly to the output le. This makes it
possible to reduce the overhead of subroutine calls, thereby measurably speeding up the computation, since
output of DVI bytes is part of T
E
Xs inner loop. And it has another advantage as well, since we can change
instructions in the buer in order to make the output more compact. For example, a down2 command can
be changed to a y2 , thereby making a subsequent y0 command possible, saving two bytes.
The output buer is divided into two parts of equal size; the bytes found in dvi buf [0 . . half buf 1]
constitute the rst half, and those in dvi buf [half buf . . dvi buf size 1] constitute the second. The global
variable dvi ptr points to the position that will receive the next output byte. When dvi ptr reaches dvi limit ,
which is always equal to one of the two values half buf or dvi buf size, the half buer that is about to be
invaded next is sent to the output and dvi limit is changed to its other value. Thus, there is always at least
a half buers worth of information present, except at the very beginning of the job.
Bytes of the DVI le are numbered sequentially starting with 0; the next byte to be generated will be
number dvi oset + dvi ptr . A byte is present in the buer only if its number is dvi gone.
Types in the outer block 18 +
dvi index = 0 . . dvi buf size; an index into the output buer
595 T
E
X82 PART 32: SHIPPING PAGES OUT 221
595. Some systems may nd it more ecient to make dvi buf a packed array, since output of four bytes
at once may be facilitated.
Global variables 13 +
dvi buf : array [dvi index ] of eight bits ; buer for DVI output
half buf : dvi index ; half of dvi buf size
dvi limit : dvi index ; end of the current half buer
dvi ptr : dvi index ; the next available buer address
dvi oset : integer ; dvi buf size times the number of times the output buer has been fully emptied
dvi gone: integer ; the number of bytes already output to dvi le
596. Initially the buer is all in one piece; we will output half of it only after it rst lls up.
Set initial values of key variables 21 +
half buf dvi buf size div 2; dvi limit dvi buf size; dvi ptr 0; dvi oset 0; dvi gone 0;
597. The actual output of dvi buf [a . . b] to dvi le is performed by calling write dvi (a, b). For best results,
this procedure should be optimized to run as fast as possible on each particular system, since it is part of
T
E
Xs inner loop. It is safe to assume that a and b + 1 will both be multiples of 4 when write dvi (a, b) is
called; therefore it is possible on many machines to use ecient methods to pack four bytes per word and
to output an array of words with one system call.
procedure write dvi (a, b : dvi index );
var k: dvi index ;
begin for k a to b do write(dvi le, dvi buf [k]);
end;
598. To put a byte in the buer without paying the cost of invoking a procedure each time, we use the
macro dvi out .
dene dvi out (#) begin dvi buf [dvi ptr ] #; incr (dvi ptr );
if dvi ptr = dvi limit then dvi swap;
end
procedure dvi swap; outputs half of the buer
begin if dvi limit = dvi buf size then
begin write dvi (0, half buf 1); dvi limit half buf ; dvi oset dvi oset + dvi buf size;
dvi ptr 0;
end
else begin write dvi (half buf , dvi buf size 1); dvi limit dvi buf size;
end;
dvi gone dvi gone + half buf ;
end;
599. Here is how we clean out the buer when T
E
X is all through; dvi ptr will be a multiple of 4.
Empty the last bytes out of dvi buf 599
if dvi limit = half buf then write dvi (half buf , dvi buf size 1);
if dvi ptr > 0 then write dvi (0, dvi ptr 1)
This code is used in section 642.
222 PART 32: SHIPPING PAGES OUT T
E
X82 600
600. The dvi four procedure outputs four bytes in twos complement notation, without risking arithmetic
overow.
procedure dvi four (x : integer );
begin if x 0 then dvi out (x div 100000000 )
else begin x x + 10000000000 ; x x + 10000000000 ; dvi out ((x div 100000000 ) + 128);
end;
x x mod 100000000 ; dvi out (x div 200000 ); x x mod 200000 ; dvi out (x div 400 );
dvi out (x mod 400 );
end;
601. A mild optimization of the output is performed by the dvi pop routine, which issues a pop unless it
is possible to cancel a push pop pair. The parameter to dvi pop is the byte address following the old push
that matches the new pop.
procedure dvi pop(l : integer );
begin if (l = dvi oset + dvi ptr ) (dvi ptr > 0) then decr (dvi ptr )
else dvi out (pop);
end;
602. Heres a procedure that outputs a font denition. Since T
E
X82 uses at most 256 dierent fonts per
job, fnt def1 is always used as the command code.
procedure dvi font def (f : internal font number );
var k: pool pointer ; index into str pool
begin dvi out (fnt def1 ); dvi out (f font base 1);
dvi out (qo(font check [f].b0 )); dvi out (qo(font check [f].b1 )); dvi out (qo(font check [f].b2 ));
dvi out (qo(font check [f].b3 ));
dvi four (font size[f]); dvi four (font dsize[f]);
dvi out (length(font area[f])); dvi out (length(font name[f]));
Output the font name whose internal number is f 603 ;
end;
603. Output the font name whose internal number is f 603
for k str start [font area[f]] to str start [font area[f] + 1] 1 do dvi out (so(str pool [k]));
for k str start [font name[f]] to str start [font name[f] + 1] 1 do dvi out (so(str pool [k]))
This code is used in section 602.
604 T
E
X82 PART 32: SHIPPING PAGES OUT 223
604. Versions of T
E
X intended for small computers might well choose to omit the ideas in the next few
parts of this program, since it is not really necessary to optimize the DVI code by making use of the w0 , x0 ,
y0 , and z0 commands. Furthermore, the algorithm that we are about to describe does not pretend to give
an optimum reduction in the length of the DVI code; after all, speed is more important than compactness.
But the method is surprisingly eective, and it takes comparatively little time.
We can best understand the basic idea by rst considering a simpler problem that has the same essential
characteristics. Given a sequence of digits, say 3 1 4 1 5 9 2 6 5 3 5 8 9, we want to assign subscripts d, y, or z to
each digit so as to maximize the number of y-hits and z-hits; a y-hit is an instance of two appearances
of the same digit with the subscript y, where no ys intervene between the two appearances, and a z-hit is
dened similarly. For example, the sequence above could be decorated with subscripts as follows:
3
z
1
y
4
d
1
y
5
y
9
d
2
d
6
d
5
y
3
z
5
y
8
d
9
d
.
There are three y-hits (1
y
. . . 1
y
and 5
y
. . . 5
y
. . . 5
y
) and one z-hit (3
z
. . . 3
z
); there are no d-hits, since the
two appearances of 9
d
have ds between them, but we dont count d-hits so it doesnt matter how many
there are. These subscripts are analogous to the DVI commands called down, y, and z, and the digits are
analogous to dierent amounts of vertical motion; a y-hit or z-hit corresponds to the opportunity to use the
one-byte commands y0 or z0 in a DVI le.
T
E
Xs method of assigning subscripts works like this: Append a new digit, say , to the right of the
sequence. Now look back through the sequence until one of the following things happens: (a) You see
y
or

z
, and this was the rst time you encountered a y or z subscript, respectively. Then assign y or z to the
new ; you have scored a hit. (b) You see
d
, and no y subscripts have been encountered so far during this
search. Then change the previous
d
to
y
(this corresponds to changing a command in the output buer),
and assign y to the new ; its another hit. (c) You see
d
, and a y subscript has been seen but not a z.
Change the previous
d
to
z
and assign z to the new . (d) You encounter both y and z subscripts before
encountering a suitable , or you scan all the way to the front of the sequence. Assign d to the new ; this
assignment may be changed later.
The subscripts 3
z
1
y
4
d
. . . in the example above were, in fact, produced by this procedure, as the reader
can verify. (Go ahead and try it.)
605. In order to implement such an idea, T
E
X maintains a stack of pointers to the down, y, and z commands
that have been generated for the current page. And there is a similar stack for right , w, and x commands.
These stacks are called the down stack and right stack, and their top elements are maintained in the variables
down ptr and right ptr .
Each entry in these stacks contains four elds: The width eld is the amount of motion down or to the
right; the location eld is the byte number of the DVI command in question (including the appropriate
dvi oset ); the link eld points to the next item below this one on the stack; and the info eld encodes the
options for possible change in the DVI command.
dene movement node size = 3 number of words per entry in the down and right stacks
dene location(#) mem[# + 2].int DVI byte number for a movement command
Global variables 13 +
down ptr , right ptr : pointer ; heads of the down and right stacks
606. Set initial values of key variables 21 +
down ptr null ; right ptr null ;
224 PART 32: SHIPPING PAGES OUT T
E
X82 607
607. Here is a subroutine that produces a DVI command for some specied downward or rightward
motion. It has two parameters: w is the amount of motion, and o is either down1 or right1 . We use
the fact that the command codes have convenient arithmetic properties: y1 down1 = w1 right1 and
z1 down1 = x1 right1 .
procedure movement (w : scaled ; o : eight bits );
label exit , found , not found , 2, 1;
var mstate: small number ; have we seen a y or z?
p, q: pointer ; current and top nodes on the stack
k: integer ; index into dvi buf , modulo dvi buf size
begin q get node(movement node size); new node for the top of the stack
width(q) w; location(q) dvi oset + dvi ptr ;
if o = down1 then
begin link (q) down ptr ; down ptr q;
end
else begin link (q) right ptr ; right ptr q;
end;
Look at the other stack entries until deciding what sort of DVI command to generate; goto found if
node p is a hit 611 ;
Generate a down or right command for w and return 610 ;
found : Generate a y0 or z0 command in order to reuse a previous appearance of w 609 ;
exit : end;
608. The info elds in the entries of the down stack or the right stack have six possible settings: y here
or z here mean that the DVI command refers to y or z, respectively (or to w or x, in the case of horizontal
motion); yz OK means that the DVI command is down (or right ) but can be changed to either y or z (or to
either w or x); y OK means that it is down and can be changed to y but not z; z OK is similar; and d xed
means it must stay down.
The four settings yz OK, y OK, z OK, d xed would not need to be distinguished from each other
if we were simply solving the digit-subscripting problem mentioned above. But in T
E
Xs case there is a
complication because of the nested structure of push and pop commands. Suppose we add parentheses to
the digit-subscripting problem, redening hits so that
y
. . .
y
is a hit if all ys between the s are enclosed
in properly nested parentheses, and if the parenthesis level of the right-hand
y
is deeper than or equal to
that of the left-hand one. Thus, ( and ) correspond to push and pop. Now if we want to assign a
subscript to the nal 1 in the sequence
2
y
7
d
1
d
( 8
z
2
y
8
z
) 1
we cannot change the previous 1
d
to 1
y
, since that would invalidate the 2
y
. . . 2
y
hit. But we can change it
to 1
z
, scoring a hit since the intervening 8
z
s are enclosed in parentheses.
The program below removes movement nodes that are introduced after a push, before it outputs the
corresponding pop.
dene y here = 1 info when the movement entry points to a y command
dene z here = 2 info when the movement entry points to a z command
dene yz OK = 3 info corresponding to an unconstrained down command
dene y OK = 4 info corresponding to a down that cant become a z
dene z OK = 5 info corresponding to a down that cant become a y
dene d xed = 6 info corresponding to a down that cant change
609 T
E
X82 PART 32: SHIPPING PAGES OUT 225
609. When the movement procedure gets to the label found , the value of info(p) will be either y here or
z here. If it is, say, y here, the procedure generates a y0 command (or a w0 command), and marks all info
elds between q and p so that y is not OK in that range.
Generate a y0 or z0 command in order to reuse a previous appearance of w 609
info(q) info(p);
if info(q) = y here then
begin dvi out (o + y0 down1 ); y0 or w0
while link (q) ,= p do
begin q link (q);
case info(q) of
yz OK: info(q) z OK;
y OK: info(q) d xed ;
othercases do nothing
endcases;
end;
end
else begin dvi out (o + z0 down1 ); z0 or x0
while link (q) ,= p do
begin q link (q);
case info(q) of
yz OK: info(q) y OK;
z OK: info(q) d xed ;
othercases do nothing
endcases;
end;
end
This code is used in section 607.
610. Generate a down or right command for w and return 610
info(q) yz OK;
if abs (w) 40000000 then
begin dvi out (o + 3); down4 or right4
dvi four (w); return;
end;
if abs (w) 100000 then
begin dvi out (o + 2); down3 or right3
if w < 0 then w w + 100000000 ;
dvi out (w div 200000 ); w w mod 200000 ; goto 2;
end;
if abs (w) 200 then
begin dvi out (o + 1); down2 or right2
if w < 0 then w w + 200000 ;
goto 2;
end;
dvi out (o); down1 or right1
if w < 0 then w w + 400 ;
goto 1;
2: dvi out (w div 400 );
1: dvi out (w mod 400 ); return
This code is used in section 607.
226 PART 32: SHIPPING PAGES OUT T
E
X82 611
611. As we search through the stack, we are in one of three states, y seen, z seen, or none seen, depending
on whether we have encountered y here or z here nodes. These states are encoded as multiples of 6, so that
they can be added to the info elds for quick decision-making.
dene none seen = 0 no y here or z here nodes have been encountered yet
dene y seen = 6 we have seen y here but not z here
dene z seen = 12 we have seen z here but not y here
Look at the other stack entries until deciding what sort of DVI command to generate; goto found if node
p is a hit 611
p link (q); mstate none seen;
while p ,= null do
begin if width(p) = w then Consider a node with matching width; goto found if its a hit 612
else case mstate + info(p) of
none seen + y here: mstate y seen;
none seen + z here: mstate z seen;
y seen + z here, z seen + y here: goto not found ;
othercases do nothing
endcases;
p link (p);
end;
not found :
This code is used in section 607.
612. We might nd a valid hit in a y or z byte that is already gone from the buer. But we cant change
bytes that are gone forever; the moving nger writes, . . . .
Consider a node with matching width; goto found if its a hit 612
case mstate + info(p) of
none seen + yz OK, none seen + y OK, z seen + yz OK, z seen + y OK:
if location(p) < dvi gone then goto not found
else Change buered instruction to y or w and goto found 613 ;
none seen + z OK, y seen + yz OK, y seen + z OK:
if location(p) < dvi gone then goto not found
else Change buered instruction to z or x and goto found 614 ;
none seen + y here, none seen + z here, y seen + z here, z seen + y here: goto found ;
othercases do nothing
endcases
This code is used in section 611.
613. Change buered instruction to y or w and goto found 613
begin k location(p) dvi oset ;
if k < 0 then k k + dvi buf size;
dvi buf [k] dvi buf [k] + y1 down1 ; info(p) y here; goto found ;
end
This code is used in section 612.
614. Change buered instruction to z or x and goto found 614
begin k location(p) dvi oset ;
if k < 0 then k k + dvi buf size;
dvi buf [k] dvi buf [k] + z1 down1 ; info(p) z here; goto found ;
end
This code is used in section 612.
615 T
E
X82 PART 32: SHIPPING PAGES OUT 227
615. In case you are wondering when all the movement nodes are removed from T
E
Xs memory, the answer
is that they are recycled just before hlist out and vlist out nish outputting a box. This restores the down
and right stacks to the state they were in before the box was output, except that some infos may have
become more restrictive.
procedure prune movements (l : integer ); delete movement nodes with location l
label done, exit ;
var p: pointer ; node being deleted
begin while down ptr ,= null do
begin if location(down ptr ) < l then goto done;
p down ptr ; down ptr link (p); free node(p, movement node size);
end;
done: while right ptr ,= null do
begin if location(right ptr ) < l then return;
p right ptr ; right ptr link (p); free node(p, movement node size);
end;
exit : end;
616. The actual distances by which we want to move might be computed as the sum of several separate
movements. For example, there might be several glue nodes in succession, or we might want to move right by
the width of some box plus some amount of glue. More importantly, the baselineskip distances are computed
in terms of glue together with the depth and height of adjacent boxes, and we want the DVI le to lump
these three quantities together into a single motion.
Therefore, T
E
X maintains two pairs of global variables: dvi h and dvi v are the h and v coordinates
corresponding to the commands actually output to the DVI le, while cur h and cur v are the coordinates
corresponding to the current state of the output routines. Coordinate changes will accumulate in cur h and
cur v without being reected in the output, until such a change becomes necessary or desirable; we can call
the movement procedure whenever we want to make dvi h = cur h or dvi v = cur v .
The current font reected in the DVI output is called dvi f ; there is no need for a cur f variable.
The depth of nesting of hlist out and vlist out is called cur s ; this is essentially the depth of push commands
in the DVI output.
dene synch h
if cur h ,= dvi h then
begin movement (cur h dvi h, right1 ); dvi h cur h;
end
dene synch v
if cur v ,= dvi v then
begin movement (cur v dvi v , down1 ); dvi v cur v ;
end
Global variables 13 +
dvi h, dvi v : scaled ; a DVI reader program thinks we are here
cur h, cur v : scaled ; T
E
X thinks we are here
dvi f : internal font number ; the current font
cur s : integer ; current depth of output box nesting, initially 1
228 PART 32: SHIPPING PAGES OUT T
E
X82 617
617. Initialize variables as ship out begins 617
dvi h 0; dvi v 0; cur h h oset ; dvi f null font ; ensure dvi open;
if total pages = 0 then
begin dvi out (pre); dvi out (id byte); output the preamble
dvi four (25400000); dvi four (473628672); conversion ratio for sp
prepare mag ; dvi four (mag ); magnication factor is frozen
old setting selector ; selector new string ; print ("TeXoutput"); print int (year );
print char ("."); print two(month); print char ("."); print two(day); print char (":");
print two(time div 60); print two(time mod 60); selector old setting ; dvi out (cur length);
for s str start [str ptr ] to pool ptr 1 do dvi out (so(str pool [s]));
pool ptr str start [str ptr ]; ush the current string
end
This code is used in section 640.
618. When hlist out is called, its duty is to output the box represented by the hlist node pointed to by
temp ptr . The reference point of that box has coordinates (cur h, cur v ).
Similarly, when vlist out is called, its duty is to output the box represented by the vlist node pointed to
by temp ptr . The reference point of that box has coordinates (cur h, cur v ).
procedure vlist out ; forward ; hlist out and vlist out are mutually recursive
619 T
E
X82 PART 32: SHIPPING PAGES OUT 229
619. The recursive procedures hlist out and vlist out each have local variables save h and save v to hold
the values of dvi h and dvi v just before entering a new level of recursion. In eect, the values of save h and
save v on T
E
Xs run-time stack correspond to the values of h and v that a DVI-reading program will push
onto its coordinate stack.
dene move past = 13 go to this label when advancing past glue or a rule
dene n rule = 14 go to this label to nish processing a rule
dene next p = 15 go to this label when nished with node p
Declare procedures needed in hlist out , vlist out 1368
procedure hlist out ; output an hlist node box
label reswitch, move past , n rule, next p;
var base line: scaled ; the baseline coordinate for this box
left edge: scaled ; the left coordinate for this box
save h, save v : scaled ; what dvi h and dvi v should pop to
this box : pointer ; pointer to containing box
g order : glue ord ; applicable order of innity for glue
g sign: normal . . shrinking ; selects type of glue
p: pointer ; current position in the hlist
save loc: integer ; DVI byte location upon entry
leader box : pointer ; the leader box being replicated
leader wd : scaled ; width of leader box being replicated
lx : scaled ; extra space between leader boxes
outer doing leaders : boolean; were we doing leaders?
edge: scaled ; left edge of sub-box, or right edge of leader space
glue temp: real ; glue value before rounding
cur glue: real ; glue seen so far
cur g : scaled ; rounded equivalent of cur glue times the glue ratio
begin cur g 0; cur glue oat constant (0); this box temp ptr ; g order glue order (this box );
g sign glue sign(this box ); p list ptr (this box ); incr (cur s );
if cur s > 0 then dvi out (push);
if cur s > max push then max push cur s ;
save loc dvi oset + dvi ptr ; base line cur v ; left edge cur h;
while p ,= null do Output node p for hlist out and move to the next node, maintaining the condition
cur v = base line 620 ;
prune movements (save loc);
if cur s > 0 then dvi pop(save loc);
decr (cur s );
end;
230 PART 32: SHIPPING PAGES OUT T
E
X82 620
620. We ought to give special care to the eciency of one part of hlist out , since it belongs to T
E
Xs inner
loop. When a char node is encountered, we save a little time by processing several nodes in succession until
reaching a non-char node. The program uses the fact that set char 0 = 0.
Output node p for hlist out and move to the next node, maintaining the condition cur v = base line 620
reswitch: if is char node(p) then
begin synch h; synch v ;
repeat f font (p); c character (p);
if f ,= dvi f then Change font dvi f to f 621 ;
if c qi (128) then dvi out (set1 );
dvi out (qo(c));
cur h cur h + char width(f)(char info(f)(c)); p link (p);
until is char node(p);
dvi h cur h;
end
else Output the non-char node p for hlist out and move to the next node 622
This code is used in section 619.
621. Change font dvi f to f 621
begin if font used [f] then
begin dvi font def (f); font used [f] true;
end;
if f 64 + font base then dvi out (f font base 1 + fnt num 0 )
else begin dvi out (fnt1 ); dvi out (f font base 1);
end;
dvi f f;
end
This code is used in section 620.
622. Output the non-char node p for hlist out and move to the next node 622
begin case type(p) of
hlist node, vlist node: Output a box in an hlist 623 ;
rule node: begin rule ht height (p); rule dp depth(p); rule wd width(p); goto n rule;
end;
whatsit node: Output the whatsit node p in an hlist 1367 ;
glue node: Move right or output leaders 625 ;
kern node, math node: cur h cur h + width(p);
ligature node: Make node p look like a char node and goto reswitch 652 ;
othercases do nothing
endcases;
goto next p;
n rule: Output a rule in an hlist 624 ;
move past : cur h cur h + rule wd ;
next p: p link (p);
end
This code is used in section 620.
623 T
E
X82 PART 32: SHIPPING PAGES OUT 231
623. Output a box in an hlist 623
if list ptr (p) = null then cur h cur h + width(p)
else begin save h dvi h; save v dvi v ; cur v base line + shift amount (p);
shift the box down
temp ptr p; edge cur h;
if type(p) = vlist node then vlist out else hlist out ;
dvi h save h; dvi v save v ; cur h edge + width(p); cur v base line;
end
This code is used in section 622.
624. Output a rule in an hlist 624
if is running (rule ht ) then rule ht height (this box );
if is running (rule dp) then rule dp depth(this box );
rule ht rule ht + rule dp; this is the rule thickness
if (rule ht > 0) (rule wd > 0) then we dont output empty rules
begin synch h; cur v base line + rule dp; synch v ; dvi out (set rule); dvi four (rule ht );
dvi four (rule wd ); cur v base line; dvi h dvi h + rule wd ;
end
This code is used in section 622.
625. dene billion oat constant (1000000000)
dene vet glue(#) glue temp #;
if glue temp > billion then glue temp billion
else if glue temp < billion then glue temp billion
Move right or output leaders 625
begin g glue ptr (p); rule wd width(g) cur g ;
if g sign ,= normal then
begin if g sign = stretching then
begin if stretch order (g) = g order then
begin cur glue cur glue + stretch(g); vet glue(oat (glue set (this box )) cur glue);
cur g round (glue temp);
end;
end
else if shrink order (g) = g order then
begin cur glue cur glue shrink (g); vet glue(oat (glue set (this box )) cur glue);
cur g round (glue temp);
end;
end;
rule wd rule wd + cur g ;
if subtype(p) a leaders then
Output leaders in an hlist, goto n rule if a rule or to next p if done 626 ;
goto move past ;
end
This code is used in section 622.
232 PART 32: SHIPPING PAGES OUT T
E
X82 626
626. Output leaders in an hlist, goto n rule if a rule or to next p if done 626
begin leader box leader ptr (p);
if type(leader box ) = rule node then
begin rule ht height (leader box ); rule dp depth(leader box ); goto n rule;
end;
leader wd width(leader box );
if (leader wd > 0) (rule wd > 0) then
begin rule wd rule wd + 10; compensate for oating-point rounding
edge cur h +rule wd ; lx 0; Let cur h be the position of the rst box, and set leader wd +lx to
the spacing between corresponding parts of boxes 627 ;
while cur h + leader wd edge do
Output a leader box at cur h, then advance cur h by leader wd + lx 628 ;
cur h edge 10; goto next p;
end;
end
This code is used in section 625.
627. The calculations related to leaders require a bit of care. First, in the case of a leaders (aligned leaders),
we want to move cur h to left edge plus the smallest multiple of leader wd for which the result is not less than
the current value of cur h; i.e., cur h should become left edge +leader wd ,(cur h left edge)/leader wd |.
The program here should work in all cases even though some implementations of Pascal give nonstandard
results for the div operation when cur h is less than left edge.
In the case of c leaders (centered leaders), we want to increase cur h by half of the excess space not
occupied by the leaders; and in the case of x leaders (expanded leaders) we increase cur h by 1/(q + 1) of
this excess space, where q is the number of times the leader box will be replicated. Slight inaccuracies in the
division might accumulate; half of this rounding error is placed at each end of the leaders.
Let cur h be the position of the rst box, and set leader wd + lx to the spacing between corresponding
parts of boxes 627
if subtype(p) = a leaders then
begin save h cur h; cur h left edge + leader wd ((cur h left edge) div leader wd );
if cur h < save h then cur h cur h + leader wd ;
end
else begin lq rule wd div leader wd ; the number of box copies
lr rule wd mod leader wd ; the remaining space
if subtype(p) = c leaders then cur h cur h + (lr div 2)
else begin lx lr div (lq + 1); cur h cur h + ((lr (lq 1) lx ) div 2);
end;
end
This code is used in section 626.
628. The synch operations here are intended to decrease the number of bytes needed to specify horizontal
and vertical motion in the DVI output.
Output a leader box at cur h, then advance cur h by leader wd + lx 628
begin cur v base line + shift amount (leader box ); synch v ; save v dvi v ;
synch h; save h dvi h; temp ptr leader box ; outer doing leaders doing leaders ;
doing leaders true;
if type(leader box ) = vlist node then vlist out else hlist out ;
doing leaders outer doing leaders ; dvi v save v ; dvi h save h; cur v base line;
cur h save h + leader wd + lx ;
end
This code is used in section 626.
629 T
E
X82 PART 32: SHIPPING PAGES OUT 233
629. The vlist out routine is similar to hlist out , but a bit simpler.
procedure vlist out ; output a vlist node box
label move past , n rule, next p;
var left edge: scaled ; the left coordinate for this box
top edge: scaled ; the top coordinate for this box
save h, save v : scaled ; what dvi h and dvi v should pop to
this box : pointer ; pointer to containing box
g order : glue ord ; applicable order of innity for glue
g sign: normal . . shrinking ; selects type of glue
p: pointer ; current position in the vlist
save loc: integer ; DVI byte location upon entry
leader box : pointer ; the leader box being replicated
leader ht : scaled ; height of leader box being replicated
lx : scaled ; extra space between leader boxes
outer doing leaders : boolean; were we doing leaders?
edge: scaled ; bottom boundary of leader space
glue temp: real ; glue value before rounding
cur glue: real ; glue seen so far
cur g : scaled ; rounded equivalent of cur glue times the glue ratio
begin cur g 0; cur glue oat constant (0); this box temp ptr ; g order glue order (this box );
g sign glue sign(this box ); p list ptr (this box ); incr (cur s );
if cur s > 0 then dvi out (push);
if cur s > max push then max push cur s ;
save loc dvi oset + dvi ptr ; left edge cur h; cur v cur v height (this box ); top edge cur v ;
while p ,= null do Output node p for vlist out and move to the next node, maintaining the condition
cur h = left edge 630 ;
prune movements (save loc);
if cur s > 0 then dvi pop(save loc);
decr (cur s );
end;
630. Output node p for vlist out and move to the next node, maintaining the condition
cur h = left edge 630
begin if is char node(p) then confusion("vlistout")
else Output the non-char node p for vlist out 631 ;
next p: p link (p);
end
This code is used in section 629.
234 PART 32: SHIPPING PAGES OUT T
E
X82 631
631. Output the non-char node p for vlist out 631
begin case type(p) of
hlist node, vlist node: Output a box in a vlist 632 ;
rule node: begin rule ht height (p); rule dp depth(p); rule wd width(p); goto n rule;
end;
whatsit node: Output the whatsit node p in a vlist 1366 ;
glue node: Move down or output leaders 634 ;
kern node: cur v cur v + width(p);
othercases do nothing
endcases;
goto next p;
n rule: Output a rule in a vlist, goto next p 633 ;
move past : cur v cur v + rule ht ;
end
This code is used in section 630.
632. The synch v here allows the DVI output to use one-byte commands for adjusting v in most cases,
since the baselineskip distance will usually be constant.
Output a box in a vlist 632
if list ptr (p) = null then cur v cur v + height (p) + depth(p)
else begin cur v cur v + height (p); synch v ; save h dvi h; save v dvi v ;
cur h left edge + shift amount (p); shift the box right
temp ptr p;
if type(p) = vlist node then vlist out else hlist out ;
dvi h save h; dvi v save v ; cur v save v + depth(p); cur h left edge;
end
This code is used in section 631.
633. Output a rule in a vlist, goto next p 633
if is running (rule wd ) then rule wd width(this box );
rule ht rule ht + rule dp; this is the rule thickness
cur v cur v + rule ht ;
if (rule ht > 0) (rule wd > 0) then we dont output empty rules
begin synch h; synch v ; dvi out (put rule); dvi four (rule ht ); dvi four (rule wd );
end;
goto next p
This code is used in section 631.
634 T
E
X82 PART 32: SHIPPING PAGES OUT 235
634. Move down or output leaders 634
begin g glue ptr (p); rule ht width(g) cur g ;
if g sign ,= normal then
begin if g sign = stretching then
begin if stretch order (g) = g order then
begin cur glue cur glue + stretch(g); vet glue(oat (glue set (this box )) cur glue);
cur g round (glue temp);
end;
end
else if shrink order (g) = g order then
begin cur glue cur glue shrink (g); vet glue(oat (glue set (this box )) cur glue);
cur g round (glue temp);
end;
end;
rule ht rule ht + cur g ;
if subtype(p) a leaders then
Output leaders in a vlist, goto n rule if a rule or to next p if done 635 ;
goto move past ;
end
This code is used in section 631.
635. Output leaders in a vlist, goto n rule if a rule or to next p if done 635
begin leader box leader ptr (p);
if type(leader box ) = rule node then
begin rule wd width(leader box ); rule dp 0; goto n rule;
end;
leader ht height (leader box ) + depth(leader box );
if (leader ht > 0) (rule ht > 0) then
begin rule ht rule ht + 10; compensate for oating-point rounding
edge cur v + rule ht ; lx 0; Let cur v be the position of the rst box, and set leader ht + lx to
the spacing between corresponding parts of boxes 636 ;
while cur v + leader ht edge do
Output a leader box at cur v , then advance cur v by leader ht + lx 637 ;
cur v edge 10; goto next p;
end;
end
This code is used in section 634.
636. Let cur v be the position of the rst box, and set leader ht + lx to the spacing between
corresponding parts of boxes 636
if subtype(p) = a leaders then
begin save v cur v ; cur v top edge + leader ht ((cur v top edge) div leader ht );
if cur v < save v then cur v cur v + leader ht ;
end
else begin lq rule ht div leader ht ; the number of box copies
lr rule ht mod leader ht ; the remaining space
if subtype(p) = c leaders then cur v cur v + (lr div 2)
else begin lx lr div (lq + 1); cur v cur v + ((lr (lq 1) lx ) div 2);
end;
end
This code is used in section 635.
236 PART 32: SHIPPING PAGES OUT T
E
X82 637
637. When we reach this part of the program, cur v indicates the top of a leader box, not its baseline.
Output a leader box at cur v , then advance cur v by leader ht + lx 637
begin cur h left edge + shift amount (leader box ); synch h; save h dvi h;
cur v cur v + height (leader box ); synch v ; save v dvi v ; temp ptr leader box ;
outer doing leaders doing leaders ; doing leaders true;
if type(leader box ) = vlist node then vlist out else hlist out ;
doing leaders outer doing leaders ; dvi v save v ; dvi h save h; cur h left edge;
cur v save v height (leader box ) + leader ht + lx ;
end
This code is used in section 635.
638. The hlist out and vlist out procedures are now complete, so we are ready for the ship out routine
that gets them started in the rst place.
procedure ship out (p : pointer ); output the box p
label done;
var page loc: integer ; location of the current bop
j, k: 0 . . 9; indices to rst ten count registers
s: pool pointer ; index into str pool
old setting : 0 . . max selector ; saved selector setting
begin if tracing output > 0 then
begin print nl (""); print ln; print ("Completedboxbeingshippedout");
end;
if term oset > max print line 9 then print ln
else if (term oset > 0) (le oset > 0) then print char ("");
print char ("["); j 9;
while (count (j) = 0) (j > 0) do decr (j);
for k 0 to j do
begin print int (count (k));
if k < j then print char (".");
end;
update terminal ;
if tracing output > 0 then
begin print char ("]"); begin diagnostic; show box (p); end diagnostic(true);
end;
Ship box p out 640 ;
if tracing output 0 then print char ("]");
dead cycles 0; update terminal ; progress report
Flush the box from memory, showing statistics if requested 639 ;
end;
639 T
E
X82 PART 32: SHIPPING PAGES OUT 237
639. Flush the box from memory, showing statistics if requested 639
stat if tracing stats > 1 then
begin print nl ("Memoryusagebefore:"); print int (var used ); print char ("&");
print int (dyn used ); print char (";");
end;
tats
ush node list (p);
stat if tracing stats > 1 then
begin print ("after:"); print int (var used ); print char ("&"); print int (dyn used );
print (";stilluntouched:"); print int (hi mem min lo mem max 1); print ln;
end;
tats
This code is used in section 638.
640. Ship box p out 640
Update the values of max h and max v ; but if the page is too large, goto done 641 ;
Initialize variables as ship out begins 617 ;
page loc dvi oset + dvi ptr ; dvi out (bop);
for k 0 to 9 do dvi four (count (k));
dvi four (last bop); last bop page loc; cur v height (p) + v oset ; temp ptr p;
if type(p) = vlist node then vlist out else hlist out ;
dvi out (eop); incr (total pages ); cur s 1;
done:
This code is used in section 638.
641. Sometimes the user will generate a huge page because other error messages are being ignored. Such
pages are not output to the dvi le, since they may confuse the printing software.
Update the values of max h and max v ; but if the page is too large, goto done 641
if (height (p) > max dimen) (depth(p) > max dimen)
(height (p) + depth(p) + v oset > max dimen) (width(p) + h oset > max dimen) then
begin print err ("Hugepagecannotbeshippedout");
help2 ("Thepagejustcreatedismorethan18feettallor")
("morethan18feetwide,soIsuspectsomethingwentwrong."); error ;
if tracing output 0 then
begin begin diagnostic; print nl ("Thefollowingboxhasbeendeleted:"); show box (p);
end diagnostic(true);
end;
goto done;
end;
if height (p) + depth(p) + v oset > max v then max v height (p) + depth(p) + v oset ;
if width(p) + h oset > max h then max h width(p) + h oset
This code is used in section 640.
238 PART 32: SHIPPING PAGES OUT T
E
X82 642
642. At the end of the program, we must nish things o by writing the postamble. If total pages = 0,
the DVI le was never opened. If total pages 65536, the DVI le will lie. And if max push 65536, the
user deserves whatever chaos might ensue.
An integer variable k will be declared for use by this routine.
Finish the DVI le 642
while cur s > 1 do
begin if cur s > 0 then dvi out (pop)
else begin dvi out (eop); incr (total pages );
end;
decr (cur s );
end;
if total pages = 0 then print nl ("Nopagesofoutput.")
else begin dvi out (post ); beginning of the postamble
dvi four (last bop); last bop dvi oset + dvi ptr 5; post location
dvi four (25400000); dvi four (473628672); conversion ratio for sp
prepare mag ; dvi four (mag ); magnication factor
dvi four (max v ); dvi four (max h);
dvi out (max push div 256); dvi out (max push mod 256);
dvi out ((total pages div 256) mod 256); dvi out (total pages mod 256);
Output the font denitions for all fonts that were used 643 ;
dvi out (post post ); dvi four (last bop); dvi out (id byte);
k 4 + ((dvi buf size dvi ptr ) mod 4); the number of 223s
while k > 0 do
begin dvi out (223); decr (k);
end;
Empty the last bytes out of dvi buf 599 ;
print nl ("Outputwrittenon"); slow print (output le name); print ("("); print int (total pages );
print ("page");
if total pages ,= 1 then print char ("s");
print (","); print int (dvi oset + dvi ptr ); print ("bytes)."); b close(dvi le);
end
This code is used in section 1333.
643. Output the font denitions for all fonts that were used 643
while font ptr > font base do
begin if font used [font ptr ] then dvi font def (font ptr );
decr (font ptr );
end
This code is used in section 642.
644 T
E
X82 PART 33: PACKAGING 239
644. Packaging. Were essentially done with the parts of T
E
X that are concerned with the input
(get next ) and the output (ship out ). So its time to get heavily into the remaining part, which does
the real work of typesetting.
After lists are constructed, T
E
X wraps them up and puts them into boxes. Two major subroutines are
given the responsibility for this task: hpack applies to horizontal lists (hlists) and vpack applies to vertical
lists (vlists). The main duty of hpack and vpack is to compute the dimensions of the resulting boxes, and
to adjust the glue if one of those dimensions is pre-specied. The computed sizes normally enclose all of the
material inside the new box; but some items may stick out if negative glue is used, if the box is overfull, or
if a \vbox includes other boxes that have been shifted left.
The subroutine call hpack (p, w, m) returns a pointer to an hlist node for a box containing the hlist that
starts at p. Parameter w species a width; and parameter m is either exactly or additional . Thus,
hpack (p, w, exactly) produces a box whose width is exactly w, while hpack (p, w, additional ) yields a box
whose width is the natural width plus w. It is convenient to dene a macro called natural to cover the
most common case, so that we can say hpack (p, natural ) to get a box that has the natural width of list p.
Similarly, vpack (p, w, m) returns a pointer to a vlist node for a box containing the vlist that starts at p.
In this case w represents a height instead of a width; the parameter m is interpreted as in hpack .
dene exactly = 0 a box dimension is pre-specied
dene additional = 1 a box dimension is increased from the natural one
dene natural 0, additional shorthand for parameters to hpack and vpack
645. The parameters to hpack and vpack correspond to T
E
Xs primitives like \hbox to 300pt, \hbox
spread 10pt; note that \hbox with no dimension following it is equivalent to \hbox spread 0pt. The
scan spec subroutine scans such constructions in the users input, including the mandatory left brace that
follows them, and it puts the specication onto save stack so that the desired box can later be obtained by
executing the following code:
save ptr save ptr 2;
hpack (p, saved (1), saved (0)).
Special care is necessary to ensure that the special save stack codes are placed just below the new group
code, because scanning can change save stack when \csname appears.
procedure scan spec(c : group code; three codes : boolean); scans a box specication and left brace
label found ;
var s: integer ; temporarily saved value
spec code: exactly . . additional ;
begin if three codes then s saved (0);
if scan keyword ("to") then spec code exactly
else if scan keyword ("spread") then spec code additional
else begin spec code additional ; cur val 0; goto found ;
end;
scan normal dimen;
found : if three codes then
begin saved (0) s; incr (save ptr );
end;
saved (0) spec code; saved (1) cur val ; save ptr save ptr + 2; new save level (c); scan left brace;
end;
240 PART 33: PACKAGING T
E
X82 646
646. To gure out the glue setting, hpack and vpack determine how much stretchability and shrinkability
are present, considering all four orders of innity. The highest order of innity that has a nonzero coecient
is then used as if no other orders were present.
For example, suppose that the given list contains six glue nodes with the respective stretchabilities 3pt,
8ll, 5l, 6pt, 3l, 8ll. Then the total is essentially 2l; and if a total additional space of 6pt is to be
achieved by stretching, the actual amounts of stretch will be 0pt, 0pt, 15pt, 0pt, 9pt, and 0pt, since only
l glue will be considered. (The ll glue is therefore not really stretching innitely with respect to l;
nobody would actually want that to happen.)
The arrays total stretch and total shrink are used to determine how much glue of each kind is present. A
global variable last badness is used to implement \badness.
Global variables 13 +
total stretch, total shrink : array [glue ord ] of scaled ; glue found by hpack or vpack
last badness : integer ; badness of the most recently packaged box
647. If the global variable adjust tail is non-null, the hpack routine also removes all occurrences of ins node,
mark node, and adjust node items and appends the resulting material onto the list that ends at location
adjust tail .
Global variables 13 +
adjust tail : pointer ; tail of adjustment list
648. Set initial values of key variables 21 +
adjust tail null ; last badness 0;
649. Here now is hpack , which contains few if any surprises.
function hpack (p : pointer ; w : scaled ; m : small number ): pointer ;
label reswitch, common ending , exit ;
var r: pointer ; the box node that will be returned
q: pointer ; trails behind p
h, d, x: scaled ; height, depth, and natural width
s: scaled ; shift amount
g: pointer ; points to a glue specication
o: glue ord ; order of innity
f: internal font number ; the font in a char node
i: four quarters ; font information about a char node
hd : eight bits ; height and depth indices for a character
begin last badness 0; r get node(box node size); type(r) hlist node;
subtype(r) min quarterword ; shift amount (r) 0; q r + list oset ; link (q) p;
h 0; Clear dimensions to zero 650 ;
while p ,= null do Examine node p in the hlist, taking account of its eect on the dimensions of the
new box, or moving it to the adjustment list; then advance p to the next node 651 ;
if adjust tail ,= null then link (adjust tail ) null ;
height (r) h; depth(r) d;
Determine the value of width(r) and the appropriate glue setting; then return or goto
common ending 657 ;
common ending : Finish issuing a diagnostic message for an overfull or underfull hbox 663 ;
exit : hpack r;
end;
650 T
E
X82 PART 33: PACKAGING 241
650. Clear dimensions to zero 650
d 0; x 0; total stretch[normal ] 0; total shrink [normal ] 0; total stretch[l ] 0;
total shrink [l ] 0; total stretch[ll ] 0; total shrink [ll ] 0; total stretch[lll ] 0;
total shrink [lll ] 0
This code is used in sections 649 and 668.
651. Examine node p in the hlist, taking account of its eect on the dimensions of the new box, or
moving it to the adjustment list; then advance p to the next node 651
begin reswitch: while is char node(p) do Incorporate character dimensions into the dimensions of the
hbox that will contain it, then move to the next node 654 ;
if p ,= null then
begin case type(p) of
hlist node, vlist node, rule node, unset node: Incorporate box dimensions into the dimensions of the
hbox that will contain it 653 ;
ins node, mark node, adjust node: if adjust tail ,= null then
Transfer node p to the adjustment list 655 ;
whatsit node: Incorporate a whatsit node into an hbox 1360 ;
glue node: Incorporate glue into the horizontal totals 656 ;
kern node, math node: x x + width(p);
ligature node: Make node p look like a char node and goto reswitch 652 ;
othercases do nothing
endcases;
p link (p);
end;
end
This code is used in section 649.
652. Make node p look like a char node and goto reswitch 652
begin mem[lig trick ] mem[lig char (p)]; link (lig trick ) link (p); p lig trick ; goto reswitch;
end
This code is used in sections 622, 651, and 1147.
653. The code here implicitly uses the fact that running dimensions are indicated by null ag , which will
be ignored in the calculations because it is a highly negative number.
Incorporate box dimensions into the dimensions of the hbox that will contain it 653
begin x x + width(p);
if type(p) rule node then s 0 else s shift amount (p);
if height (p) s > h then h height (p) s;
if depth(p) + s > d then d depth(p) + s;
end
This code is used in section 651.
242 PART 33: PACKAGING T
E
X82 654
654. The following code is part of T
E
Xs inner loop; i.e., adding another character of text to the users
input will cause each of these instructions to be exercised one more time.
Incorporate character dimensions into the dimensions of the hbox that will contain it, then move to the
next node 654
begin f font (p); i char info(f)(character (p)); hd height depth(i); x x + char width(f)(i);
s char height (f)(hd ); if s > h then h s;
s char depth(f)(hd ); if s > d then d s;
p link (p);
end
This code is used in section 651.
655. Although node q is not necessarily the immediate predecessor of node p, it always points to some
node in the list preceding p. Thus, we can delete nodes by moving q when necessary. The algorithm takes
linear time, and the extra computation does not intrude on the inner loop unless it is necessary to make a
deletion.
Transfer node p to the adjustment list 655
begin while link (q) ,= p do q link (q);
if type(p) = adjust node then
begin link (adjust tail ) adjust ptr (p);
while link (adjust tail ) ,= null do adjust tail link (adjust tail );
p link (p); free node(link (q), small node size);
end
else begin link (adjust tail ) p; adjust tail p; p link (p);
end;
link (q) p; p q;
end
This code is used in section 651.
656. Incorporate glue into the horizontal totals 656
begin g glue ptr (p); x x + width(g);
o stretch order (g); total stretch[o] total stretch[o] + stretch(g); o shrink order (g);
total shrink [o] total shrink [o] + shrink (g);
if subtype(p) a leaders then
begin g leader ptr (p);
if height (g) > h then h height (g);
if depth(g) > d then d depth(g);
end;
end
This code is used in section 651.
657. When we get to the present part of the program, x is the natural width of the box being packaged.
Determine the value of width(r) and the appropriate glue setting; then return or goto
common ending 657
if m = additional then w x + w;
width(r) w; x w x; now x is the excess to be made up
if x = 0 then
begin glue sign(r) normal ; glue order (r) normal ; set glue ratio zero(glue set (r)); return;
end
else if x > 0 then Determine horizontal glue stretch setting, then return or goto common ending 658
else Determine horizontal glue shrink setting, then return or goto common ending 664
This code is used in section 649.
658 T
E
X82 PART 33: PACKAGING 243
658. Determine horizontal glue stretch setting, then return or goto common ending 658
begin Determine the stretch order 659 ;
glue order (r) o; glue sign(r) stretching ;
if total stretch[o] ,= 0 then glue set (r) unoat (x/total stretch[o])
else begin glue sign(r) normal ; set glue ratio zero(glue set (r)); theres nothing to stretch
end;
if o = normal then
if list ptr (r) ,= null then
Report an underfull hbox and goto common ending , if this box is suciently bad 660 ;
return;
end
This code is used in section 657.
659. Determine the stretch order 659
if total stretch[lll ] ,= 0 then o lll
else if total stretch[ll ] ,= 0 then o ll
else if total stretch[l ] ,= 0 then o l
else o normal
This code is used in sections 658, 673, and 796.
660. Report an underfull hbox and goto common ending , if this box is suciently bad 660
begin last badness badness (x, total stretch[normal ]);
if last badness > hbadness then
begin print ln;
if last badness > 100 then print nl ("Underfull") else print nl ("Loose");
print ("\hbox(badness"); print int (last badness ); goto common ending ;
end;
end
This code is used in section 658.
661. In order to provide a decent indication of where an overfull or underfull box originated, we use a
global variable pack begin line that is set nonzero only when hpack is being called by the paragraph builder
or the alignment nishing routine.
Global variables 13 +
pack begin line: integer ; source le line where the current paragraph or alignment began; a negative
value denotes alignment
662. Set initial values of key variables 21 +
pack begin line 0;
244 PART 33: PACKAGING T
E
X82 663
663. Finish issuing a diagnostic message for an overfull or underfull hbox 663
if output active then print (")hasoccurredwhile\outputisactive")
else begin if pack begin line ,= 0 then
begin if pack begin line > 0 then print (")inparagraphatlines")
else print (")inalignmentatlines");
print int (abs (pack begin line)); print ("");
end
else print (")detectedatline");
print int (line);
end;
print ln;
font in short display null font ; short display(list ptr (r)); print ln;
begin diagnostic; show box (r); end diagnostic(true)
This code is used in section 649.
664. Determine horizontal glue shrink setting, then return or goto common ending 664
begin Determine the shrink order 665 ;
glue order (r) o; glue sign(r) shrinking ;
if total shrink [o] ,= 0 then glue set (r) unoat ((x)/total shrink [o])
else begin glue sign(r) normal ; set glue ratio zero(glue set (r)); theres nothing to shrink
end;
if (total shrink [o] < x) (o = normal ) (list ptr (r) ,= null ) then
begin last badness 1000000; set glue ratio one(glue set (r)); use the maximum shrinkage
Report an overfull hbox and goto common ending , if this box is suciently bad 666 ;
end
else if o = normal then
if list ptr (r) ,= null then
Report a tight hbox and goto common ending , if this box is suciently bad 667 ;
return;
end
This code is used in section 657.
665. Determine the shrink order 665
if total shrink [lll ] ,= 0 then o lll
else if total shrink [ll ] ,= 0 then o ll
else if total shrink [l ] ,= 0 then o l
else o normal
This code is used in sections 664, 676, and 796.
666. Report an overfull hbox and goto common ending , if this box is suciently bad 666
if (x total shrink [normal ] > hfuzz ) (hbadness < 100) then
begin if (overfull rule > 0) (x total shrink [normal ] > hfuzz ) then
begin while link (q) ,= null do q link (q);
link (q) new rule; width(link (q)) overfull rule;
end;
print ln; print nl ("Overfull\hbox("); print scaled (x total shrink [normal ]);
print ("pttoowide"); goto common ending ;
end
This code is used in section 664.
667 T
E
X82 PART 33: PACKAGING 245
667. Report a tight hbox and goto common ending , if this box is suciently bad 667
begin last badness badness (x, total shrink [normal ]);
if last badness > hbadness then
begin print ln; print nl ("Tight\hbox(badness"); print int (last badness ); goto common ending ;
end;
end
This code is used in section 664.
668. The vpack subroutine is actually a special case of a slightly more general routine called vpackage,
which has four parameters. The fourth parameter, which is max dimen in the case of vpack , species the
maximum depth of the page box that is constructed. The depth is rst computed by the normal rules; if it
exceeds this limit, the reference point is simply moved down until the limiting depth is attained.
dene vpack (#) vpackage(#, max dimen) special case of unconstrained depth
function vpackage(p : pointer ; h : scaled ; m : small number ; l : scaled ): pointer ;
label common ending , exit ;
var r: pointer ; the box node that will be returned
w, d, x: scaled ; width, depth, and natural height
s: scaled ; shift amount
g: pointer ; points to a glue specication
o: glue ord ; order of innity
begin last badness 0; r get node(box node size); type(r) vlist node;
subtype(r) min quarterword ; shift amount (r) 0; list ptr (r) p;
w 0; Clear dimensions to zero 650 ;
while p ,= null do Examine node p in the vlist, taking account of its eect on the dimensions of the
new box; then advance p to the next node 669 ;
width(r) w;
if d > l then
begin x x + d l; depth(r) l;
end
else depth(r) d;
Determine the value of height (r) and the appropriate glue setting; then return or goto
common ending 672 ;
common ending : Finish issuing a diagnostic message for an overfull or underfull vbox 675 ;
exit : vpackage r;
end;
669. Examine node p in the vlist, taking account of its eect on the dimensions of the new box; then
advance p to the next node 669
begin if is char node(p) then confusion("vpack")
else case type(p) of
hlist node, vlist node, rule node, unset node: Incorporate box dimensions into the dimensions of the
vbox that will contain it 670 ;
whatsit node: Incorporate a whatsit node into a vbox 1359 ;
glue node: Incorporate glue into the vertical totals 671 ;
kern node: begin x x + d + width(p); d 0;
end;
othercases do nothing
endcases;
p link (p);
end
This code is used in section 668.
246 PART 33: PACKAGING T
E
X82 670
670. Incorporate box dimensions into the dimensions of the vbox that will contain it 670
begin x x + d + height (p); d depth(p);
if type(p) rule node then s 0 else s shift amount (p);
if width(p) + s > w then w width(p) + s;
end
This code is used in section 669.
671. Incorporate glue into the vertical totals 671
begin x x + d; d 0;
g glue ptr (p); x x + width(g);
o stretch order (g); total stretch[o] total stretch[o] + stretch(g); o shrink order (g);
total shrink [o] total shrink [o] + shrink (g);
if subtype(p) a leaders then
begin g leader ptr (p);
if width(g) > w then w width(g);
end;
end
This code is used in section 669.
672. When we get to the present part of the program, x is the natural height of the box being packaged.
Determine the value of height (r) and the appropriate glue setting; then return or goto
common ending 672
if m = additional then h x + h;
height (r) h; x h x; now x is the excess to be made up
if x = 0 then
begin glue sign(r) normal ; glue order (r) normal ; set glue ratio zero(glue set (r)); return;
end
else if x > 0 then Determine vertical glue stretch setting, then return or goto common ending 673
else Determine vertical glue shrink setting, then return or goto common ending 676
This code is used in section 668.
673. Determine vertical glue stretch setting, then return or goto common ending 673
begin Determine the stretch order 659 ;
glue order (r) o; glue sign(r) stretching ;
if total stretch[o] ,= 0 then glue set (r) unoat (x/total stretch[o])
else begin glue sign(r) normal ; set glue ratio zero(glue set (r)); theres nothing to stretch
end;
if o = normal then
if list ptr (r) ,= null then
Report an underfull vbox and goto common ending , if this box is suciently bad 674 ;
return;
end
This code is used in section 672.
674 T
E
X82 PART 33: PACKAGING 247
674. Report an underfull vbox and goto common ending , if this box is suciently bad 674
begin last badness badness (x, total stretch[normal ]);
if last badness > vbadness then
begin print ln;
if last badness > 100 then print nl ("Underfull") else print nl ("Loose");
print ("\vbox(badness"); print int (last badness ); goto common ending ;
end;
end
This code is used in section 673.
675. Finish issuing a diagnostic message for an overfull or underfull vbox 675
if output active then print (")hasoccurredwhile\outputisactive")
else begin if pack begin line ,= 0 then its actually negative
begin print (")inalignmentatlines"); print int (abs (pack begin line)); print ("");
end
else print (")detectedatline");
print int (line); print ln;
end;
begin diagnostic; show box (r); end diagnostic(true)
This code is used in section 668.
676. Determine vertical glue shrink setting, then return or goto common ending 676
begin Determine the shrink order 665 ;
glue order (r) o; glue sign(r) shrinking ;
if total shrink [o] ,= 0 then glue set (r) unoat ((x)/total shrink [o])
else begin glue sign(r) normal ; set glue ratio zero(glue set (r)); theres nothing to shrink
end;
if (total shrink [o] < x) (o = normal ) (list ptr (r) ,= null ) then
begin last badness 1000000; set glue ratio one(glue set (r)); use the maximum shrinkage
Report an overfull vbox and goto common ending , if this box is suciently bad 677 ;
end
else if o = normal then
if list ptr (r) ,= null then
Report a tight vbox and goto common ending , if this box is suciently bad 678 ;
return;
end
This code is used in section 672.
677. Report an overfull vbox and goto common ending , if this box is suciently bad 677
if (x total shrink [normal ] > vfuzz ) (vbadness < 100) then
begin print ln; print nl ("Overfull\vbox("); print scaled (x total shrink [normal ]);
print ("pttoohigh"); goto common ending ;
end
This code is used in section 676.
678. Report a tight vbox and goto common ending , if this box is suciently bad 678
begin last badness badness (x, total shrink [normal ]);
if last badness > vbadness then
begin print ln; print nl ("Tight\vbox(badness"); print int (last badness ); goto common ending ;
end;
end
This code is used in section 676.
248 PART 33: PACKAGING T
E
X82 679
679. When a box is being appended to the current vertical list, the baselineskip calculation is handled by
the append to vlist routine.
procedure append to vlist (b : pointer );
var d: scaled ; deciency of space between baselines
p: pointer ; a new glue node
begin if prev depth > ignore depth then
begin d width(baseline skip) prev depth height (b);
if d < line skip limit then p new param glue(line skip code)
else begin p new skip param(baseline skip code); width(temp ptr ) d; temp ptr = glue ptr (p)
end;
link (tail ) p; tail p;
end;
link (tail ) b; tail b; prev depth depth(b);
end;
680 T
E
X82 PART 34: DATA STRUCTURES FOR MATH MODE 249
680. Data structures for math mode. When T
E
X reads a formula that is enclosed between $s, it
constructs an mlist, which is essentially a tree structure representing that formula. An mlist is a linear
sequence of items, but we can regard it as a tree structure because mlists can appear within mlists. For
example, many of the entries can be subscripted or superscripted, and such scripts are mlists in their own
right.
An entire formula is parsed into such a tree before any of the actual typesetting is done, because the
current style of type is usually not known until the formula has been fully scanned. For example, when the
formula $a+b \over c+d$ is being read, there is no way to tell that a+b will be in script size until \over
has appeared.
During the scanning process, each element of the mlist being built is classied as a relation, a binary
operator, an open parenthesis, etc., or as a construct like \sqrt that must be built up. This classication
appears in the mlist data structure.
After a formula has been fully scanned, the mlist is converted to an hlist so that it can be incorporated
into the surrounding text. This conversion is controlled by a recursive procedure that decides all of the
appropriate styles by a top-down process starting at the outermost level and working in towards the
subformulas. The formula is ultimately pasted together using combinations of horizontal and vertical boxes,
with glue and penalty nodes inserted as necessary.
An mlist is represented internally as a linked list consisting chiey of noads (pronounced no-adds), to
distinguish them from the somewhat similar nodes in hlists and vlists. Certain kinds of ordinary nodes
are allowed to appear in mlists together with the noads; T
E
X tells the dierence by means of the type eld,
since a noads type is always greater than that of a node. An mlist does not contain character nodes, hlist
nodes, vlist nodes, math nodes, ligature nodes, or unset nodes; in particular, each mlist item appears in the
variable-size part of mem, so the type eld is always present.
250 PART 34: DATA STRUCTURES FOR MATH MODE T
E
X82 681
681. Each noad is four or more words long. The rst word contains the type and subtype and link elds
that are already so familiar to us; the second, third, and fourth words are called the noads nucleus , subscr ,
and supscr elds.
Consider, for example, the simple formula $x^2$, which would be parsed into an mlist containing a single
element called an ord noad . The nucleus of this noad is a representation of x, the subscr is empty, and the
supscr is a representation of 2.
The nucleus , subscr , and supscr elds are further broken into subelds. If p points to a noad, and if q is
one of its principal elds (e.g., q = subscr (p)), there are several possibilities for the subelds, depending on
the math type of q.
math type(q) = math char means that fam(q) refers to one of the sixteen font families, and character (q) is
the number of a character within a font of that family, as in a character node.
math type(q) = math text char is similar, but the character is unsubscripted and unsuperscripted and it is
followed immediately by another character from the same font. (This math type setting appears only
briey during the processing; it is used to suppress unwanted italic corrections.)
math type(q) = empty indicates a eld with no value (the corresponding attribute of noad p is not present).
math type(q) = sub box means that info(q) points to a box node (either an hlist node or a vlist node) that
should be used as the value of the eld. The shift amount in the subsidiary box node is the amount
by which that box will be shifted downward.
math type(q) = sub mlist means that info(q) points to an mlist; the mlist must be converted to an hlist in
order to obtain the value of this eld.
In the latter case, we might have info(q) = null . This is not the same as math type(q) = empty; for example,
$P_{}$ and $P$ produce dierent results (the former will not have the italic correction added to the
width of P, but the script skip will be added).
The denitions of subelds given here are evidently wasteful of space, since a halfword is being used for
the math type although only three bits would be needed. However, there are hardly ever many noads present
at once, since they are soon converted to nodes that take up even more space, so we can aord to represent
them in whatever way simplies the programming.
dene noad size = 4 number of words in a normal noad
dene nucleus (#) # + 1 the nucleus eld of a noad
dene supscr (#) # + 2 the supscr eld of a noad
dene subscr (#) # + 3 the subscr eld of a noad
dene math type link a halfword in mem
dene fam font a quarterword in mem
dene math char = 1 math type when the attribute is simple
dene sub box = 2 math type when the attribute is a box
dene sub mlist = 3 math type when the attribute is a formula
dene math text char = 4 math type when italic correction is dubious
682 T
E
X82 PART 34: DATA STRUCTURES FOR MATH MODE 251
682. Each portion of a formula is classied as Ord, Op, Bin, Rel, Ope, Clo, Pun, or Inn, for purposes of
spacing and line breaking. An ord noad , op noad , bin noad , rel noad , open noad , close noad , punct noad ,
or inner noad is used to represent portions of the various types. For example, an = sign in a formula leads
to the creation of a rel noad whose nucleus eld is a representation of an equals sign (usually fam = 0,
character = 75 ). A formula preceded by \mathrel also results in a rel noad . When a rel noad is followed
by an op noad , say, and possibly separated by one or more ordinary nodes (not noads), T
E
X will insert a
penalty node (with the current rel penalty) just after the formula that corresponds to the rel noad , unless
there already was a penalty immediately following; and a thick space will be inserted just before the
formula that corresponds to the op noad .
A noad of type ord noad , op noad , . . . , inner noad usually has a subtype = normal . The only exception
is that an op noad might have subtype = limits or no limits , if the normal positioning of limits has been
overridden for this operator.
dene ord noad = unset node + 3 type of a noad classied Ord
dene op noad = ord noad + 1 type of a noad classied Op
dene bin noad = ord noad + 2 type of a noad classied Bin
dene rel noad = ord noad + 3 type of a noad classied Rel
dene open noad = ord noad + 4 type of a noad classied Ope
dene close noad = ord noad + 5 type of a noad classied Clo
dene punct noad = ord noad + 6 type of a noad classied Pun
dene inner noad = ord noad + 7 type of a noad classied Inn
dene limits = 1 subtype of op noad whose scripts are to be above, below
dene no limits = 2 subtype of op noad whose scripts are to be normal
252 PART 34: DATA STRUCTURES FOR MATH MODE T
E
X82 683
683. A radical noad is ve words long; the fth word is the left delimiter eld, which usually represents a
square root sign.
A fraction noad is six words long; it has a right delimiter eld as well as a left delimiter .
Delimiter elds are of type four quarters , and they have four subelds called small fam, small char ,
large fam, large char . These subelds represent variable-size delimiters by giving the small and large
starting characters, as explained in Chapter 17 of The T
E
Xbook.
A fraction noad is actually quite dierent from all other noads. Not only does it have six words, it has
thickness , denominator , and numerator elds instead of nucleus , subscr , and supscr . The thickness is a
scaled value that tells how thick to make a fraction rule; however, the special value default code is used to
stand for the default rule thickness of the current size. The numerator and denominator point to mlists
that dene a fraction; we always have
math type(numerator ) = math type(denominator ) = sub mlist .
The left delimiter and right delimiter elds specify delimiters that will be placed at the left and right of
the fraction. In this way, a fraction noad is able to represent all of T
E
Xs operators \over, \atop, \above,
\overwithdelims, \atopwithdelims, and \abovewithdelims.
dene left delimiter (#) # + 4 rst delimiter eld of a noad
dene right delimiter (#) # + 5 second delimiter eld of a fraction noad
dene radical noad = inner noad + 1 type of a noad for square roots
dene radical noad size = 5 number of mem words in a radical noad
dene fraction noad = radical noad + 1 type of a noad for generalized fractions
dene fraction noad size = 6 number of mem words in a fraction noad
dene small fam(#) mem[#].qqqq .b0 fam for small delimiter
dene small char (#) mem[#].qqqq .b1 character for small delimiter
dene large fam(#) mem[#].qqqq .b2 fam for large delimiter
dene large char (#) mem[#].qqqq .b3 character for large delimiter
dene thickness width thickness eld in a fraction noad
dene default code 10000000000 denotes default rule thickness
dene numerator supscr numerator eld in a fraction noad
dene denominator subscr denominator eld in a fraction noad
684. The global variable empty eld is set up for initialization of empty elds in new noads. Similarly,
null delimiter is for the initialization of delimiter elds.
Global variables 13 +
empty eld : two halves ;
null delimiter : four quarters ;
685. Set initial values of key variables 21 +
empty eld .rh empty; empty eld .lh null ;
null delimiter .b0 0; null delimiter .b1 min quarterword ;
null delimiter .b2 0; null delimiter .b3 min quarterword ;
686. The new noad function creates an ord noad that is completely null.
function new noad : pointer ;
var p: pointer ;
begin p get node(noad size); type(p) ord noad ; subtype(p) normal ;
mem[nucleus (p)].hh empty eld ; mem[subscr (p)].hh empty eld ;
mem[supscr (p)].hh empty eld ; new noad p;
end;
687 T
E
X82 PART 34: DATA STRUCTURES FOR MATH MODE 253
687. A few more kinds of noads will complete the set: An under noad has its nucleus underlined; an
over noad has it overlined. An accent noad places an accent over its nucleus; the accent character appears
as fam(accent chr (p)) and character (accent chr (p)). A vcenter noad centers its nucleus vertically with
respect to the axis of the formula; in such noads we always have math type(nucleus (p)) = sub box .
And nally, we have left noad and right noad types, to implement T
E
Xs \left and \right. The nucleus
of such noads is replaced by a delimiter eld; thus, for example, \left( produces a left noad such that
delimiter (p) holds the family and character codes for all left parentheses. A left noad never appears in an
mlist except as the rst element, and a right noad never appears in an mlist except as the last element;
furthermore, we either have both a left noad and a right noad , or neither one is present. The subscr and
supscr elds are always empty in a left noad and a right noad .
dene under noad = fraction noad + 1 type of a noad for underlining
dene over noad = under noad + 1 type of a noad for overlining
dene accent noad = over noad + 1 type of a noad for accented subformulas
dene accent noad size = 5 number of mem words in an accent noad
dene accent chr (#) # + 4 the accent chr eld of an accent noad
dene vcenter noad = accent noad + 1 type of a noad for \vcenter
dene left noad = vcenter noad + 1 type of a noad for \left
dene right noad = left noad + 1 type of a noad for \right
dene delimiter nucleus delimiter eld in left and right noads
dene scripts allowed (#) (type(#) ord noad ) (type(#) < left noad )
688. Math formulas can also contain instructions like \textstyle that override T
E
Xs normal style rules.
A style node is inserted into the data structure to record such instructions; it is three words long, so it
is considered a node instead of a noad. The subtype is either display style or text style or script style or
script script style. The second and third words of a style node are not used, but they are present because a
choice node is converted to a style node.
T
E
X uses even numbers 0, 2, 4, 6 to encode the basic styles display style, . . . , script script style, and
adds 1 to get the cramped versions of these styles. This gives a numerical order that is backwards from
the convention of Appendix G in The T
E
Xbook; i.e., a smaller style has a larger numerical value.
dene style node = unset node + 1 type of a style node
dene style node size = 3 number of words in a style node
dene display style = 0 subtype for \displaystyle
dene text style = 2 subtype for \textstyle
dene script style = 4 subtype for \scriptstyle
dene script script style = 6 subtype for \scriptscriptstyle
dene cramped = 1 add this to an uncramped style if you want to cramp it
function new style(s : small number ): pointer ; create a style node
var p: pointer ; the new node
begin p get node(style node size); type(p) style node; subtype(p) s; width(p) 0;
depth(p) 0; the width and depth are not used
new style p;
end;
254 PART 34: DATA STRUCTURES FOR MATH MODE T
E
X82 689
689. Finally, the \mathchoice primitive creates a choice node, which has special subelds display mlist ,
text mlist , script mlist , and script script mlist pointing to the mlists for each style.
dene choice node = unset node + 2 type of a choice node
dene display mlist (#) info(# + 1) mlist to be used in display style
dene text mlist (#) link (# + 1) mlist to be used in text style
dene script mlist (#) info(# + 2) mlist to be used in script style
dene script script mlist (#) link (# + 2) mlist to be used in scriptscript style
function new choice: pointer ; create a choice node
var p: pointer ; the new node
begin p get node(style node size); type(p) choice node; subtype(p) 0;
the subtype is not used
display mlist (p) null ; text mlist (p) null ; script mlist (p) null ; script script mlist (p) null ;
new choice p;
end;
690. Lets consider now the previously unwritten part of show node list that displays the things that can
only be present in mlists; this program illustrates how to access the data structures just dened.
In the context of the following program, p points to a node or noad that should be displayed, and the
current string contains the recursion history that leads to this point. The recursion history consists of a
dot for each outer level in which p is subsidiary to some node, or in which p is subsidiary to the nucleus
eld of some noad; the dot is replaced by _ or ^ or / or \ if p is descended from the subscr or supscr
or denominator or numerator elds of noads. For example, the current string would be .^._/ if p points
to the ord noad for x in the (ridiculous) formula $\sqrt{a^{\mathinner{b_{c\over x+y}}}}$.
Cases of show node list that arise in mlists only 690
style node: print style(subtype(p));
choice node: Display choice node p 695 ;
ord noad , op noad , bin noad , rel noad , open noad , close noad , punct noad ,
inner noad , radical noad , over noad , under noad , vcenter noad , accent noad , left noad , right noad :
Display normal noad p 696 ;
fraction noad : Display fraction noad p 697 ;
This code is used in section 183.
691. Here are some simple routines used in the display of noads.
Declare procedures needed for displaying the elements of mlists 691
procedure print fam and char (p : pointer ); prints family and character
begin print esc("fam"); print int (fam(p)); print char (""); print ASCII (qo(character (p)));
end;
procedure print delimiter (p : pointer ); prints a delimiter as 24-bit hex value
var a: integer ; accumulator
begin a small fam(p) 256 + qo(small char (p));
a a 1000 + large fam(p) 256 + qo(large char (p));
if a < 0 then print int (a) this should never happen
else print hex (a);
end;
See also sections 692 and 694.
This code is used in section 179.
692 T
E
X82 PART 34: DATA STRUCTURES FOR MATH MODE 255
692. The next subroutine will descend to another level of recursion when a subsidiary mlist needs to be
displayed. The parameter c indicates what character is to become part of the recursion history. An empty
mlist is distinguished from a eld with math type(p) = empty, because these are not equivalent (as explained
above).
Declare procedures needed for displaying the elements of mlists 691 +
procedure show info; forward ; show node list (info(temp ptr ))
procedure print subsidiary data(p : pointer ; c : ASCII code); display a noad eld
begin if cur length depth threshold then
begin if math type(p) ,= empty then print ("[]");
end
else begin append char (c); include c in the recursion history
temp ptr p; prepare for show info if recursion is needed
case math type(p) of
math char : begin print ln; print current string ; print fam and char (p);
end;
sub box : show info; recursive call
sub mlist : if info(p) = null then
begin print ln; print current string ; print ("{}");
end
else show info; recursive call
othercases do nothing empty
endcases;
ush char ; remove c from the recursion history
end;
end;
693. The inelegant introduction of show info in the code above seems better than the alternative of using
Pascals strange forward declaration for a procedure with parameters. The Pascal convention about dropping
parameters from a post-forward procedure is, frankly, so intolerable to the author of T
E
X that he would
rather stoop to communication via a global temporary variable. (A similar stoopidity occurred with respect
to hlist out and vlist out above, and it will occur with respect to mlist to hlist below.)
procedure show info; the reader will kindly forgive this
begin show node list (info(temp ptr ));
end;
694. Declare procedures needed for displaying the elements of mlists 691 +
procedure print style(c : integer );
begin case c div 2 of
0: print esc("displaystyle"); display style = 0
1: print esc("textstyle"); text style = 2
2: print esc("scriptstyle"); script style = 4
3: print esc("scriptscriptstyle"); script script style = 6
othercases print ("Unknownstyle!")
endcases;
end;
256 PART 34: DATA STRUCTURES FOR MATH MODE T
E
X82 695
695. Display choice node p 695
begin print esc("mathchoice"); append char ("D"); show node list (display mlist (p)); ush char ;
append char ("T"); show node list (text mlist (p)); ush char ; append char ("S");
show node list (script mlist (p)); ush char ; append char ("s"); show node list (script script mlist (p));
ush char ;
end
This code is used in section 690.
696. Display normal noad p 696
begin case type(p) of
ord noad : print esc("mathord");
op noad : print esc("mathop");
bin noad : print esc("mathbin");
rel noad : print esc("mathrel");
open noad : print esc("mathopen");
close noad : print esc("mathclose");
punct noad : print esc("mathpunct");
inner noad : print esc("mathinner");
over noad : print esc("overline");
under noad : print esc("underline");
vcenter noad : print esc("vcenter");
radical noad : begin print esc("radical"); print delimiter (left delimiter (p));
end;
accent noad : begin print esc("accent"); print fam and char (accent chr (p));
end;
left noad : begin print esc("left"); print delimiter (delimiter (p));
end;
right noad : begin print esc("right"); print delimiter (delimiter (p));
end;
end;
if subtype(p) ,= normal then
if subtype(p) = limits then print esc("limits")
else print esc("nolimits");
if type(p) < left noad then print subsidiary data(nucleus (p), ".");
print subsidiary data(supscr (p), "^"); print subsidiary data(subscr (p), "_");
end
This code is used in section 690.
697 T
E
X82 PART 34: DATA STRUCTURES FOR MATH MODE 257
697. Display fraction noad p 697
begin print esc("fraction,thickness");
if thickness (p) = default code then print ("=default")
else print scaled (thickness (p));
if (small fam(left delimiter (p)) ,= 0) (small char (left delimiter (p)) ,= min quarterword )
(large fam(left delimiter (p)) ,= 0) (large char (left delimiter (p)) ,= min quarterword ) then
begin print (",leftdelimiter"); print delimiter (left delimiter (p));
end;
if (small fam(right delimiter (p)) ,= 0) (small char (right delimiter (p)) ,= min quarterword )
(large fam(right delimiter (p)) ,= 0) (large char (right delimiter (p)) ,= min quarterword ) then
begin print (",rightdelimiter"); print delimiter (right delimiter (p));
end;
print subsidiary data(numerator (p), "\"); print subsidiary data(denominator (p), "/");
end
This code is used in section 690.
698. That which can be displayed can also be destroyed.
Cases of ush node list that arise in mlists only 698
style node: begin free node(p, style node size); goto done;
end;
choice node: begin ush node list (display mlist (p)); ush node list (text mlist (p));
ush node list (script mlist (p)); ush node list (script script mlist (p)); free node(p, style node size);
goto done;
end;
ord noad , op noad , bin noad , rel noad , open noad , close noad , punct noad , inner noad , radical noad ,
over noad , under noad , vcenter noad , accent noad :
begin if math type(nucleus (p)) sub box then ush node list (info(nucleus (p)));
if math type(supscr (p)) sub box then ush node list (info(supscr (p)));
if math type(subscr (p)) sub box then ush node list (info(subscr (p)));
if type(p) = radical noad then free node(p, radical noad size)
else if type(p) = accent noad then free node(p, accent noad size)
else free node(p, noad size);
goto done;
end;
left noad , right noad : begin free node(p, noad size); goto done;
end;
fraction noad : begin ush node list (info(numerator (p))); ush node list (info(denominator (p)));
free node(p, fraction noad size); goto done;
end;
This code is used in section 202.
258 PART 35: SUBROUTINES FOR MATH MODE T
E
X82 699
699. Subroutines for math mode. In order to convert mlists to hlists, i.e., noads to nodes, we need
several subroutines that are conveniently dealt with now.
Let us rst introduce the macros that make it easy to get at the parameters and other font information. A
size code, which is a multiple of 16, is added to a family number to get an index into the table of internal font
numbers for each combination of family and size. (Be alert: Size codes get larger as the type gets smaller.)
dene text size = 0 size code for the largest size in a family
dene script size = 16 size code for the medium size in a family
dene script script size = 32 size code for the smallest size in a family
Basic printing procedures 57 +
procedure print size(s : integer );
begin if s = text size then print esc("textfont")
else if s = script size then print esc("scriptfont")
else print esc("scriptscriptfont");
end;
700. Before an mlist is converted to an hlist, T
E
X makes sure that the fonts in family 2 have enough
parameters to be math-symbol fonts, and that the fonts in family 3 have enough parameters to be math-
extension fonts. The math-symbol parameters are referred to by using the following macros, which take a
size code as their parameter; for example, num1 (cur size) gives the value of the num1 parameter for the
current size.
dene mathsy end (#) fam fnt (2 + #) ] ] .sc
dene mathsy(#) font info [ # + param base [ mathsy end
dene math x height mathsy(5) height of x
dene math quad mathsy(6) 18mu
dene num1 mathsy(8) numerator shift-up in display styles
dene num2 mathsy(9) numerator shift-up in non-display, non-\atop
dene num3 mathsy(10) numerator shift-up in non-display \atop
dene denom1 mathsy(11) denominator shift-down in display styles
dene denom2 mathsy(12) denominator shift-down in non-display styles
dene sup1 mathsy(13) superscript shift-up in uncramped display style
dene sup2 mathsy(14) superscript shift-up in uncramped non-display
dene sup3 mathsy(15) superscript shift-up in cramped styles
dene sub1 mathsy(16) subscript shift-down if superscript is absent
dene sub2 mathsy(17) subscript shift-down if superscript is present
dene sup drop mathsy(18) superscript baseline below top of large box
dene sub drop mathsy(19) subscript baseline below bottom of large box
dene delim1 mathsy(20) size of \atopwithdelims delimiters in display styles
dene delim2 mathsy(21) size of \atopwithdelims delimiters in non-displays
dene axis height mathsy(22) height of fraction lines above the baseline
dene total mathsy params = 22
701. The math-extension parameters have similar macros, but the size code is omitted (since it is always
cur size when we refer to such parameters).
dene mathex (#) font info[# + param base[fam fnt (3 + cur size)]].sc
dene default rule thickness mathex (8) thickness of \over bars
dene big op spacing1 mathex (9) minimum clearance above a displayed op
dene big op spacing2 mathex (10) minimum clearance below a displayed op
dene big op spacing3 mathex (11) minimum baselineskip above displayed op
dene big op spacing4 mathex (12) minimum baselineskip below displayed op
dene big op spacing5 mathex (13) padding above and below displayed limits
dene total mathex params = 13
702 T
E
X82 PART 35: SUBROUTINES FOR MATH MODE 259
702. We also need to compute the change in style between mlists and their subsidiaries. The following
macros dene the subsidiary style for an overlined nucleus (cramped style), for a subscript or a superscript
(sub style or sup style), or for a numerator or denominator (num style or denom style).
dene cramped style(#) 2 (# div 2) + cramped cramp the style
dene sub style(#) 2 (# div 4) + script style + cramped smaller and cramped
dene sup style(#) 2 (# div 4) + script style + (# mod 2) smaller
dene num style(#) # + 2 2 (# div 6) smaller unless already script-script
dene denom style(#) 2 (# div 2) + cramped + 2 2 (# div 6) smaller, cramped
703. When the style changes, the following piece of program computes associated information:
Set up the values of cur size and cur mu, based on cur style 703
begin if cur style < script style then cur size text size
else cur size 16 ((cur style text style) div 2);
cur mu x over n(math quad (cur size), 18);
end
This code is used in sections 720, 726, 730, 754, 760, and 763.
704. Here is a function that returns a pointer to a rule node having a given thickness t. The rule will
extend horizontally to the boundary of the vlist that eventually contains it.
function fraction rule(t : scaled ): pointer ; construct the bar for a fraction
var p: pointer ; the new node
begin p new rule; height (p) t; depth(p) 0; fraction rule p;
end;
705. The overbar function returns a pointer to a vlist box that consists of a given box b, above which has
been placed a kern of height k under a fraction rule of thickness t under additional space of height t.
function overbar (b : pointer ; k, t : scaled ): pointer ;
var p, q: pointer ; nodes being constructed
begin p new kern(k); link (p) b; q fraction rule(t); link (q) p; p new kern(t); link (p) q;
overbar vpack (p, natural );
end;
260 PART 35: SUBROUTINES FOR MATH MODE T
E
X82 706
706. The var delimiter function, which nds or constructs a suciently large delimiter, is the most
interesting of the auxiliary functions that currently concern us. Given a pointer d to a delimiter eld in
some noad, together with a size code s and a vertical distance v, this function returns a pointer to a box that
contains the smallest variant of d whose height plus depth is v or more. (And if no variant is large enough,
it returns the largest available variant.) In particular, this routine will construct arbitrarily large delimiters
from extensible components, if d leads to such characters.
The value returned is a box whose shift amount has been set so that the box is vertically centered with
respect to the axis in the given size. If a built-up symbol is returned, the height of the box before shifting
will be the height of its topmost component.
Declare subprocedures for var delimiter 709
function var delimiter (d : pointer ; s : small number ; v : scaled ): pointer ;
label found , continue;
var b: pointer ; the box that will be constructed
f, g: internal font number ; best-so-far and tentative font codes
c, x, y: quarterword ; best-so-far and tentative character codes
m, n: integer ; the number of extensible pieces
u: scaled ; height-plus-depth of a tentative character
w: scaled ; largest height-plus-depth so far
q: four quarters ; character info
hd : eight bits ; height-depth byte
r: four quarters ; extensible pieces
z: small number ; runs through font family members
large attempt : boolean; are we trying the large variant?
begin f null font ; w 0; large attempt false; z small fam(d); x small char (d);
loop begin Look at the variants of (z, x); set f and c whenever a better character is found; goto
found as soon as a large enough variant is encountered 707 ;
if large attempt then goto found ; there were none large enough
large attempt true; z large fam(d); x large char (d);
end;
found : if f ,= null font then Make variable b point to a box for (f, c) 710
else begin b new null box ; width(b) null delimiter space;
use this width if no delimiter was found
end;
shift amount (b) half (height (b) depth(b)) axis height (s); var delimiter b;
end;
707. The search process is complicated slightly by the facts that some of the characters might not be
present in some of the fonts, and they might not be probed in increasing order of height.
Look at the variants of (z, x); set f and c whenever a better character is found; goto found as soon as a
large enough variant is encountered 707
if (z ,= 0) (x ,= min quarterword ) then
begin z z + s + 16;
repeat z z 16; g fam fnt (z);
if g ,= null font then Look at the list of characters starting with x in font g; set f and c whenever
a better character is found; goto found as soon as a large enough variant is encountered 708 ;
until z < 16;
end
This code is used in section 706.
708 T
E
X82 PART 35: SUBROUTINES FOR MATH MODE 261
708. Look at the list of characters starting with x in font g; set f and c whenever a better character is
found; goto found as soon as a large enough variant is encountered 708
begin y x;
if (qo(y) font bc[g]) (qo(y) font ec[g]) then
begin continue: q char info(g)(y);
if char exists (q) then
begin if char tag (q) = ext tag then
begin f g; c y; goto found ;
end;
hd height depth(q); u char height (g)(hd ) + char depth(g)(hd );
if u > w then
begin f g; c y; w u;
if u v then goto found ;
end;
if char tag (q) = list tag then
begin y rem byte(q); goto continue;
end;
end;
end;
end
This code is used in section 707.
709. Here is a subroutine that creates a new box, whose list contains a single character, and whose width
includes the italic correction for that character. The height or depth of the box will be negative, if the height
or depth of the character is negative; thus, this routine may deliver a slightly dierent result than hpack
would produce.
Declare subprocedures for var delimiter 709
function char box (f : internal font number ; c : quarterword ): pointer ;
var q: four quarters ; hd : eight bits ; height depth byte
b, p: pointer ; the new box and its character node
begin q char info(f)(c); hd height depth(q); b new null box ;
width(b) char width(f)(q) + char italic(f)(q); height (b) char height (f)(hd );
depth(b) char depth(f)(hd ); p get avail ; character (p) c; font (p) f; list ptr (b) p;
char box b;
end;
See also sections 711 and 712.
This code is used in section 706.
710. When the following code is executed, char tag (q) will be equal to ext tag if and only if a built-up
symbol is supposed to be returned.
Make variable b point to a box for (f, c) 710
if char tag (q) = ext tag then
Construct an extensible character in a new box b, using recipe rem byte(q) and font f 713
else b char box (f, c)
This code is used in section 706.
262 PART 35: SUBROUTINES FOR MATH MODE T
E
X82 711
711. When we build an extensible character, its handy to have the following subroutine, which puts a
given character on top of the characters already in box b:
Declare subprocedures for var delimiter 709 +
procedure stack into box (b : pointer ; f : internal font number ; c : quarterword );
var p: pointer ; new node placed into b
begin p char box (f, c); link (p) list ptr (b); list ptr (b) p; height (b) height (p);
end;
712. Another handy subroutine computes the height plus depth of a given character:
Declare subprocedures for var delimiter 709 +
function height plus depth(f : internal font number ; c : quarterword ): scaled ;
var q: four quarters ; hd : eight bits ; height depth byte
begin q char info(f)(c); hd height depth(q);
height plus depth char height (f)(hd ) + char depth(f)(hd );
end;
713. Construct an extensible character in a new box b, using recipe rem byte(q) and font f 713
begin b new null box ; type(b) vlist node; r font info[exten base[f] + rem byte(q)].qqqq ;
Compute the minimum suitable height, w, and the corresponding number of extension steps, n; also set
width(b) 714 ;
c ext bot (r);
if c ,= min quarterword then stack into box (b, f, c);
c ext rep(r);
for m 1 to n do stack into box (b, f, c);
c ext mid (r);
if c ,= min quarterword then
begin stack into box (b, f, c); c ext rep(r);
for m 1 to n do stack into box (b, f, c);
end;
c ext top(r);
if c ,= min quarterword then stack into box (b, f, c);
depth(b) w height (b);
end
This code is used in section 710.
714 T
E
X82 PART 35: SUBROUTINES FOR MATH MODE 263
714. The width of an extensible character is the width of the repeatable module. If this module does not
have positive height plus depth, we dont use any copies of it, otherwise we use as few as possible (in groups
of two if there is a middle part).
Compute the minimum suitable height, w, and the corresponding number of extension steps, n; also set
width(b) 714
c ext rep(r); u height plus depth(f, c); w 0; q char info(f)(c);
width(b) char width(f)(q) + char italic(f)(q);
c ext bot (r); if c ,= min quarterword then w w + height plus depth(f, c);
c ext mid (r); if c ,= min quarterword then w w + height plus depth(f, c);
c ext top(r); if c ,= min quarterword then w w + height plus depth(f, c);
n 0;
if u > 0 then
while w < v do
begin w w + u; incr (n);
if ext mid (r) ,= min quarterword then w w + u;
end
This code is used in section 713.
715. The next subroutine is much simpler; it is used for numerators and denominators of fractions as well
as for displayed operators and their limits above and below. It takes a given box b and changes it so that
the new box is centered in a box of width w. The centering is done by putting \hss glue at the left and
right of the list inside b, then packaging the new box; thus, the actual box might not really be centered, if
it already contains innite glue.
The given box might contain a single character whose italic correction has been added to the width of the
box; in this case a compensating kern is inserted.
function rebox (b : pointer ; w : scaled ): pointer ;
var p: pointer ; temporary register for list manipulation
f: internal font number ; font in a one-character box
v: scaled ; width of a character without italic correction
begin if (width(b) ,= w) (list ptr (b) ,= null ) then
begin if type(b) = vlist node then b hpack (b, natural );
p list ptr (b);
if (is char node(p)) (link (p) = null ) then
begin f font (p); v char width(f)(char info(f)(character (p)));
if v ,= width(b) then link (p) new kern(width(b) v);
end;
free node(b, box node size); b new glue(ss glue); link (b) p;
while link (p) ,= null do p link (p);
link (p) new glue(ss glue); rebox hpack (b, w, exactly);
end
else begin width(b) w; rebox b;
end;
end;
264 PART 35: SUBROUTINES FOR MATH MODE T
E
X82 716
716. Here is a subroutine that creates a new glue specication from another one that is expressed in mu,
given the value of the math unit.
dene mu mult (#) nx plus y(n, #, xn over d (#, f, 200000 ))
function math glue(g : pointer ; m : scaled ): pointer ;
var p: pointer ; the new glue specication
n: integer ; integer part of m
f: scaled ; fraction part of m
begin n x over n(m, 200000 ); f remainder ;
if f < 0 then
begin decr (n); f f + 200000 ;
end;
p get node(glue spec size); width(p) mu mult (width(g)); convert mu to pt
stretch order (p) stretch order (g);
if stretch order (p) = normal then stretch(p) mu mult (stretch(g))
else stretch(p) stretch(g);
shrink order (p) shrink order (g);
if shrink order (p) = normal then shrink (p) mu mult (shrink (g))
else shrink (p) shrink (g);
math glue p;
end;
717. The math kern subroutine removes mu glue from a kern node, given the value of the math unit.
procedure math kern(p : pointer ; m : scaled );
var n: integer ; integer part of m
f: scaled ; fraction part of m
begin if subtype(p) = mu glue then
begin n x over n(m, 200000 ); f remainder ;
if f < 0 then
begin decr (n); f f + 200000 ;
end;
width(p) mu mult (width(p)); subtype(p) explicit ;
end;
end;
718. Sometimes it is necessary to destroy an mlist. The following subroutine empties the current list,
assuming that abs (mode) = mmode.
procedure ush math;
begin ush node list (link (head )); ush node list (incompleat noad ); link (head ) null ; tail head ;
incompleat noad null ;
end;
719 T
E
X82 PART 36: TYPESETTING MATH FORMULAS 265
719. Typesetting math formulas. T
E
Xs most important routine for dealing with formulas is called
mlist to hlist . After a formula has been scanned and represented as an mlist, this routine converts it to an
hlist that can be placed into a box or incorporated into the text of a paragraph. There are three implicit
parameters, passed in global variables: cur mlist points to the rst node or noad in the given mlist (and
it might be null ); cur style is a style code; and mlist penalties is true if penalty nodes for potential line
breaks are to be inserted into the resulting hlist. After mlist to hlist has acted, link (temp head ) points to
the translated hlist.
Since mlists can be inside mlists, the procedure is recursive. And since this is not part of T
E
Xs inner
loop, the program has been written in a manner that stresses compactness over eciency.
Global variables 13 +
cur mlist : pointer ; beginning of mlist to be translated
cur style: small number ; style code at current place in the list
cur size: small number ; size code corresponding to cur style
cur mu: scaled ; the math unit width corresponding to cur size
mlist penalties : boolean; should mlist to hlist insert penalties?
720. The recursion in mlist to hlist is due primarily to a subroutine called clean box that puts a given
noad eld into a box using a given math style; mlist to hlist can call clean box , which can call mlist to hlist .
The box returned by clean box is clean in the sense that its shift amount is zero.
procedure mlist to hlist ; forward ;
function clean box (p : pointer ; s : small number ): pointer ;
label found ;
var q: pointer ; beginning of a list to be boxed
save style: small number ; cur style to be restored
x: pointer ; box to be returned
r: pointer ; temporary pointer
begin case math type(p) of
math char : begin cur mlist new noad ; mem[nucleus (cur mlist )] mem[p];
end;
sub box : begin q info(p); goto found ;
end;
sub mlist : cur mlist info(p);
othercases begin q new null box ; goto found ;
end
endcases;
save style cur style; cur style s; mlist penalties false;
mlist to hlist ; q link (temp head ); recursive call
cur style save style; restore the style
Set up the values of cur size and cur mu, based on cur style 703 ;
found : if is char node(q) (q = null ) then x hpack (q, natural )
else if (link (q) = null ) (type(q) vlist node) (shift amount (q) = 0) then x q
its already clean
else x hpack (q, natural );
Simplify a trivial box 721 ;
clean box x;
end;
266 PART 36: TYPESETTING MATH FORMULAS T
E
X82 721
721. Here we save memory space in a common case.
Simplify a trivial box 721
q list ptr (x);
if is char node(q) then
begin r link (q);
if r ,= null then
if link (r) = null then
if is char node(r) then
if type(r) = kern node then unneeded italic correction
begin free node(r, small node size); link (q) null ;
end;
end
This code is used in section 720.
722. It is convenient to have a procedure that converts a math char eld to an unpacked form. The
fetch routine sets cur f , cur c, and cur i to the font code, character code, and character information bytes
of a given noad eld. It also takes care of issuing error messages for nonexistent characters; in such cases,
char exists (cur i ) will be false after fetch has acted, and the eld will also have been reset to empty.
procedure fetch(a : pointer ); unpack the math char eld a
begin cur c character (a); cur f fam fnt (fam(a) + cur size);
if cur f = null font then Complain about an undened family and set cur i null 723
else begin if (qo(cur c) font bc[cur f ]) (qo(cur c) font ec[cur f ]) then
cur i char info(cur f )(cur c)
else cur i null character ;
if (char exists (cur i )) then
begin char warning (cur f , qo(cur c)); math type(a) empty;
end;
end;
end;
723. Complain about an undened family and set cur i null 723
begin print err (""); print size(cur size); print char (""); print int (fam(a));
print ("isundefined(character"); print ASCII (qo(cur c)); print char (")");
help4 ("Somewhereinthemathformulajustended,youusedthe")
("statedcharacterfromanundefinedfontfamily.Forexample,")
("plainTeXdoesntallow\itor\slinsubscripts.Proceed,")
("andIlltrytoforgetthatIneededthatcharacter."); error ; cur i null character ;
math type(a) empty;
end
This code is used in section 722.
724. The outputs of fetch are placed in global variables.
Global variables 13 +
cur f : internal font number ; the font eld of a math char
cur c: quarterword ; the character eld of a math char
cur i : four quarters ; the char info of a math char , or a lig/kern instruction
725 T
E
X82 PART 36: TYPESETTING MATH FORMULAS 267
725. We need to do a lot of dierent things, so mlist to hlist makes two passes over the given mlist.
The rst pass does most of the processing: It removes mu spacing from glue, it recursively evaluates all
subsidiary mlists so that only the top-level mlist remains to be handled, it puts fractions and square roots
and such things into boxes, it attaches subscripts and superscripts, and it computes the overall height and
depth of the top-level mlist so that the size of delimiters for a left noad and a right noad will be known.
The hlist resulting from each noad is recorded in that noads new hlist eld, an integer eld that replaces
the nucleus or thickness .
The second pass eliminates all noads and inserts the correct glue and penalties between nodes.
dene new hlist (#) mem[nucleus (#)].int the translation of an mlist
726. Here is the overall plan of mlist to hlist , and the list of its local variables.
dene done with noad = 80 go here when a noad has been fully translated
dene done with node = 81 go here when a node has been fully converted
dene check dimensions = 82 go here to update max h and max d
dene delete q = 83 go here to delete q and move to the next node
Declare math construction procedures 734
procedure mlist to hlist ;
label reswitch, check dimensions , done with noad , done with node, delete q , done;
var mlist : pointer ; beginning of the given list
penalties : boolean; should penalty nodes be inserted?
style: small number ; the given style
save style: small number ; holds cur style during recursion
q: pointer ; runs through the mlist
r: pointer ; the most recent noad preceding q
r type: small number ; the type of noad r, or op noad if r = null
t: small number ; the eective type of noad q during the second pass
p, x, y, z: pointer ; temporary registers for list construction
pen: integer ; a penalty to be inserted
s: small number ; the size of a noad to be deleted
max h, max d : scaled ; maximum height and depth of the list translated so far
delta: scaled ; oset between subscript and superscript
begin mlist cur mlist ; penalties mlist penalties ; style cur style;
tuck global parameters away as local variables
q mlist ; r null ; r type op noad ; max h 0; max d 0;
Set up the values of cur size and cur mu, based on cur style 703 ;
while q ,= null do Process node-or-noad q as much as possible in preparation for the second pass of
mlist to hlist , then move to the next item in the mlist 727 ;
Convert a nal bin noad to an ord noad 729 ;
Make a second pass over the mlist, removing all noads and inserting the proper spacing and
penalties 760 ;
end;
268 PART 36: TYPESETTING MATH FORMULAS T
E
X82 727
727. We use the fact that no character nodes appear in an mlist, hence the eld type(q) is always present.
Process node-or-noad q as much as possible in preparation for the second pass of mlist to hlist , then move
to the next item in the mlist 727
begin Do rst-pass processing based on type(q); goto done with noad if a noad has been fully
processed, goto check dimensions if it has been translated into new hlist (q), or goto done with node
if a node has been fully processed 728 ;
check dimensions : z hpack (new hlist (q), natural );
if height (z) > max h then max h height (z);
if depth(z) > max d then max d depth(z);
free node(z, box node size);
done with noad : r q; r type type(r);
done with node: q link (q);
end
This code is used in section 726.
728. One of the things we must do on the rst pass is change a bin noad to an ord noad if the bin noad
is not in the context of a binary operator. The values of r and r type make this fairly easy.
Do rst-pass processing based on type(q); goto done with noad if a noad has been fully processed, goto
check dimensions if it has been translated into new hlist (q), or goto done with node if a node has
been fully processed 728
reswitch: delta 0;
case type(q) of
bin noad : case r type of
bin noad , op noad , rel noad , open noad , punct noad , left noad : begin type(q) ord noad ;
goto reswitch;
end;
othercases do nothing
endcases;
rel noad , close noad , punct noad , right noad : begin
Convert a nal bin noad to an ord noad 729 ;
if type(q) = right noad then goto done with noad ;
end;
Cases for noads that can follow a bin noad 733
Cases for nodes that can appear in an mlist, after which we goto done with node 730
othercases confusion("mlist1")
endcases;
Convert nucleus (q) to an hlist and attach the sub/superscripts 754
This code is used in section 727.
729. Convert a nal bin noad to an ord noad 729
if r type = bin noad then type(r) ord noad
This code is used in sections 726 and 728.
730 T
E
X82 PART 36: TYPESETTING MATH FORMULAS 269
730. Cases for nodes that can appear in an mlist, after which we goto done with node 730
style node: begin cur style subtype(q);
Set up the values of cur size and cur mu, based on cur style 703 ;
goto done with node;
end;
choice node: Change this node to a style node followed by the correct choice, then goto
done with node 731 ;
ins node, mark node, adjust node, whatsit node, penalty node, disc node: goto done with node;
rule node: begin if height (q) > max h then max h height (q);
if depth(q) > max d then max d depth(q);
goto done with node;
end;
glue node: begin Convert math glue to ordinary glue 732 ;
goto done with node;
end;
kern node: begin math kern(q, cur mu); goto done with node;
end;
This code is used in section 728.
731. dene choose mlist (#)
begin p #(q); #(q) null ; end
Change this node to a style node followed by the correct choice, then goto done with node 731
begin case cur style div 2 of
0: choose mlist (display mlist ); display style = 0
1: choose mlist (text mlist ); text style = 2
2: choose mlist (script mlist ); script style = 4
3: choose mlist (script script mlist ); script script style = 6
end; there are no other cases
ush node list (display mlist (q)); ush node list (text mlist (q)); ush node list (script mlist (q));
ush node list (script script mlist (q));
type(q) style node; subtype(q) cur style; width(q) 0; depth(q) 0;
if p ,= null then
begin z link (q); link (q) p;
while link (p) ,= null do p link (p);
link (p) z;
end;
goto done with node;
end
This code is used in section 730.
270 PART 36: TYPESETTING MATH FORMULAS T
E
X82 732
732. Conditional math glue (\nonscript) results in a glue node pointing to zero glue, with subtype(q) =
cond math glue; in such a case the node following will be eliminated if it is a glue or kern node and if the
current size is dierent from text size. Unconditional math glue (\muskip) is converted to normal glue by
multiplying the dimensions by cur mu.
Convert math glue to ordinary glue 732
if subtype(q) = mu glue then
begin x glue ptr (q); y math glue(x, cur mu); delete glue ref (x); glue ptr (q) y;
subtype(q) normal ;
end
else if (cur size ,= text size) (subtype(q) = cond math glue) then
begin p link (q);
if p ,= null then
if (type(p) = glue node) (type(p) = kern node) then
begin link (q) link (p); link (p) null ; ush node list (p);
end;
end
This code is used in section 730.
733. Cases for noads that can follow a bin noad 733
left noad : goto done with noad ;
fraction noad : begin make fraction(q); goto check dimensions ;
end;
op noad : begin delta make op(q);
if subtype(q) = limits then goto check dimensions ;
end;
ord noad : make ord (q);
open noad , inner noad : do nothing ;
radical noad : make radical (q);
over noad : make over (q);
under noad : make under (q);
accent noad : make math accent (q);
vcenter noad : make vcenter (q);
This code is used in section 728.
734. Most of the actual construction work of mlist to hlist is done by procedures with names like make fraction,
make radical , etc. To illustrate the general setup of such procedures, lets begin with a couple of simple
ones.
Declare math construction procedures 734
procedure make over (q : pointer );
begin info(nucleus (q)) overbar (clean box (nucleus (q), cramped style(cur style)),
3 default rule thickness , default rule thickness ); math type(nucleus (q)) sub box ;
end;
See also sections 735, 736, 737, 738, 743, 749, 752, 756, and 762.
This code is used in section 726.
735 T
E
X82 PART 36: TYPESETTING MATH FORMULAS 271
735. Declare math construction procedures 734 +
procedure make under (q : pointer );
var p, x, y: pointer ; temporary registers for box construction
delta: scaled ; overall height plus depth
begin x clean box (nucleus (q), cur style); p new kern(3 default rule thickness ); link (x) p;
link (p) fraction rule(default rule thickness ); y vpack (x, natural );
delta height (y) + depth(y) + default rule thickness ; height (y) height (x);
depth(y) delta height (y); info(nucleus (q)) y; math type(nucleus (q)) sub box ;
end;
736. Declare math construction procedures 734 +
procedure make vcenter (q : pointer );
var v: pointer ; the box that should be centered vertically
delta: scaled ; its height plus depth
begin v info(nucleus (q));
if type(v) ,= vlist node then confusion("vcenter");
delta height (v) + depth(v); height (v) axis height (cur size) + half (delta);
depth(v) delta height (v);
end;
737. According to the rules in the DVI le specications, we ensure alignment between a square root sign
and the rule above its nucleus by assuming that the baseline of the square-root symbol is the same as the
bottom of the rule. The height of the square-root symbol will be the thickness of the rule, and the depth of
the square-root symbol should exceed or equal the height-plus-depth of the nucleus plus a certain minimum
clearance clr . The symbol will be placed so that the actual clearance is clr plus half the excess.
Declare math construction procedures 734 +
procedure make radical (q : pointer );
var x, y: pointer ; temporary registers for box construction
delta, clr : scaled ; dimensions involved in the calculation
begin x clean box (nucleus (q), cramped style(cur style));
if cur style < text style then display style
clr default rule thickness + (abs (math x height (cur size)) div 4)
else begin clr default rule thickness ; clr clr + (abs (clr ) div 4);
end;
y var delimiter (left delimiter (q), cur size, height (x) + depth(x) + clr + default rule thickness );
delta depth(y) (height (x) + depth(x) + clr );
if delta > 0 then clr clr + half (delta); increase the actual clearance
shift amount (y) (height (x) + clr ); link (y) overbar (x, clr , height (y));
info(nucleus (q)) hpack (y, natural ); math type(nucleus (q)) sub box ;
end;
272 PART 36: TYPESETTING MATH FORMULAS T
E
X82 738
738. Slants are not considered when placing accents in math mode. The accenter is centered over the
accentee, and the accent width is treated as zero with respect to the size of the nal box.
Declare math construction procedures 734 +
procedure make math accent (q : pointer );
label done, done1 ;
var p, x, y: pointer ; temporary registers for box construction
a: integer ; address of lig/kern instruction
c: quarterword ; accent character
f: internal font number ; its font
i: four quarters ; its char info
s: scaled ; amount to skew the accent to the right
h: scaled ; height of character being accented
delta: scaled ; space to remove between accent and accentee
w: scaled ; width of the accentee, not including sub/superscripts
begin fetch(accent chr (q));
if char exists (cur i ) then
begin i cur i ; c cur c; f cur f ;
Compute the amount of skew 741 ;
x clean box (nucleus (q), cramped style(cur style)); w width(x); h height (x);
Switch to a larger accent if available and appropriate 740 ;
if h < x height (f) then delta h else delta x height (f);
if (math type(supscr (q)) ,= empty) (math type(subscr (q)) ,= empty) then
if math type(nucleus (q)) = math char then Swap the subscript and superscript into box x 742 ;
y char box (f, c); shift amount (y) s + half (w width(y)); width(y) 0; p new kern(delta);
link (p) x; link (y) p; y vpack (y, natural ); width(y) width(x);
if height (y) < h then Make the height of box y equal to h 739 ;
info(nucleus (q)) y; math type(nucleus (q)) sub box ;
end;
end;
739. Make the height of box y equal to h 739
begin p new kern(h height (y)); link (p) list ptr (y); list ptr (y) p; height (y) h;
end
This code is used in section 738.
740. Switch to a larger accent if available and appropriate 740
loop begin if char tag (i) ,= list tag then goto done;
y rem byte(i); i char info(f)(y);
if char exists (i) then goto done;
if char width(f)(i) > w then goto done;
c y;
end;
done:
This code is used in section 738.
741 T
E
X82 PART 36: TYPESETTING MATH FORMULAS 273
741. Compute the amount of skew 741
s 0;
if math type(nucleus (q)) = math char then
begin fetch(nucleus (q));
if char tag (cur i ) = lig tag then
begin a lig kern start (cur f )(cur i ); cur i font info[a].qqqq ;
if skip byte(cur i ) > stop ag then
begin a lig kern restart (cur f )(cur i ); cur i font info[a].qqqq ;
end;
loop begin if qo(next char (cur i )) = skew char [cur f ] then
begin if op byte(cur i ) kern ag then
if skip byte(cur i ) stop ag then s char kern(cur f )(cur i );
goto done1 ;
end;
if skip byte(cur i ) stop ag then goto done1 ;
a a + qo(skip byte(cur i )) + 1; cur i font info[a].qqqq ;
end;
end;
end;
done1 :
This code is used in section 738.
742. Swap the subscript and superscript into box x 742
begin ush node list (x); x new noad ; mem[nucleus (x)] mem[nucleus (q)];
mem[supscr (x)] mem[supscr (q)]; mem[subscr (x)] mem[subscr (q)];
mem[supscr (q)].hh empty eld ; mem[subscr (q)].hh empty eld ;
math type(nucleus (q)) sub mlist ; info(nucleus (q)) x; x clean box (nucleus (q), cur style);
delta delta + height (x) h; h height (x);
end
This code is used in section 738.
743. The make fraction procedure is a bit dierent because it sets new hlist (q) directly rather than making
a sub-box.
Declare math construction procedures 734 +
procedure make fraction(q : pointer );
var p, v, x, y, z: pointer ; temporary registers for box construction
delta, delta1 , delta2 , shift up, shift down, clr : scaled ; dimensions for box calculations
begin if thickness (q) = default code then thickness (q) default rule thickness ;
Create equal-width boxes x and z for the numerator and denominator, and compute the default amounts
shift up and shift down by which they are displaced from the baseline 744 ;
if thickness (q) = 0 then Adjust shift up and shift down for the case of no fraction line 745
else Adjust shift up and shift down for the case of a fraction line 746 ;
Construct a vlist box for the fraction, according to shift up and shift down 747 ;
Put the fraction into a box with its delimiters, and make new hlist (q) point to it 748 ;
end;
274 PART 36: TYPESETTING MATH FORMULAS T
E
X82 744
744. Create equal-width boxes x and z for the numerator and denominator, and compute the default
amounts shift up and shift down by which they are displaced from the baseline 744
x clean box (numerator (q), num style(cur style));
z clean box (denominator (q), denom style(cur style));
if width(x) < width(z) then x rebox (x, width(z))
else z rebox (z, width(x));
if cur style < text style then display style
begin shift up num1 (cur size); shift down denom1 (cur size);
end
else begin shift down denom2 (cur size);
if thickness (q) ,= 0 then shift up num2 (cur size)
else shift up num3 (cur size);
end
This code is used in section 743.
745. The numerator and denominator must be separated by a certain minimum clearance, called clr in
the following program. The dierence between clr and the actual clearance is 2delta.
Adjust shift up and shift down for the case of no fraction line 745
begin if cur style < text style then clr 7 default rule thickness
else clr 3 default rule thickness ;
delta half (clr ((shift up depth(x)) (height (z) shift down)));
if delta > 0 then
begin shift up shift up + delta; shift down shift down + delta;
end;
end
This code is used in section 743.
746. In the case of a fraction line, the minimum clearance depends on the actual thickness of the line.
Adjust shift up and shift down for the case of a fraction line 746
begin if cur style < text style then clr 3 thickness (q)
else clr thickness (q);
delta half (thickness (q)); delta1 clr ((shift up depth(x)) (axis height (cur size) + delta));
delta2 clr ((axis height (cur size) delta) (height (z) shift down));
if delta1 > 0 then shift up shift up + delta1 ;
if delta2 > 0 then shift down shift down + delta2 ;
end
This code is used in section 743.
747. Construct a vlist box for the fraction, according to shift up and shift down 747
v new null box ; type(v) vlist node; height (v) shift up + height (x);
depth(v) depth(z) + shift down; width(v) width(x); this also equals width(z)
if thickness (q) = 0 then
begin p new kern((shift up depth(x)) (height (z) shift down)); link (p) z;
end
else begin y fraction rule(thickness (q));
p new kern((axis height (cur size) delta) (height (z) shift down));
link (y) p; link (p) z;
p new kern((shift up depth(x)) (axis height (cur size) + delta)); link (p) y;
end;
link (x) p; list ptr (v) x
This code is used in section 743.
748 T
E
X82 PART 36: TYPESETTING MATH FORMULAS 275
748. Put the fraction into a box with its delimiters, and make new hlist (q) point to it 748
if cur style < text style then delta delim1 (cur size)
else delta delim2 (cur size);
x var delimiter (left delimiter (q), cur size, delta); link (x) v;
z var delimiter (right delimiter (q), cur size, delta); link (v) z;
new hlist (q) hpack (x, natural )
This code is used in section 743.
749. If the nucleus of an op noad is a single character, it is to be centered vertically with respect to
the axis, after rst being enlarged (via a character list in the font) if we are in display style. The normal
convention for placing displayed limits is to put them above and below the operator in display style.
The italic correction is removed from the character if there is a subscript and the limits are not being
displayed. The make op routine returns the value that should be used as an oset between subscript and
superscript.
After make op has acted, subtype(q) will be limits if and only if the limits have been set above and below
the operator. In that case, new hlist (q) will already contain the desired nal box.
Declare math construction procedures 734 +
function make op(q : pointer ): scaled ;
var delta: scaled ; oset between subscript and superscript
p, v, x, y, z: pointer ; temporary registers for box construction
c: quarterword ; i: four quarters ; registers for character examination
shift up, shift down: scaled ; dimensions for box calculation
begin if (subtype(q) = normal ) (cur style < text style) then subtype(q) limits ;
if math type(nucleus (q)) = math char then
begin fetch(nucleus (q));
if (cur style < text style) (char tag (cur i ) = list tag ) then make it larger
begin c rem byte(cur i ); i char info(cur f )(c);
if char exists (i) then
begin cur c c; cur i i; character (nucleus (q)) c;
end;
end;
delta char italic(cur f )(cur i ); x clean box (nucleus (q), cur style);
if (math type(subscr (q)) ,= empty) (subtype(q) ,= limits ) then width(x) width(x) delta;
remove italic correction
shift amount (x) half (height (x) depth(x)) axis height (cur size); center vertically
math type(nucleus (q)) sub box ; info(nucleus (q)) x;
end
else delta 0;
if subtype(q) = limits then Construct a box with limits above and below it, skewed by delta 750 ;
make op delta;
end;
276 PART 36: TYPESETTING MATH FORMULAS T
E
X82 750
750. The following program builds a vlist box v for displayed limits. The width of the box is not aected
by the fact that the limits may be skewed.
Construct a box with limits above and below it, skewed by delta 750
begin x clean box (supscr (q), sup style(cur style)); y clean box (nucleus (q), cur style);
z clean box (subscr (q), sub style(cur style)); v new null box ; type(v) vlist node;
width(v) width(y);
if width(x) > width(v) then width(v) width(x);
if width(z) > width(v) then width(v) width(z);
x rebox (x, width(v)); y rebox (y, width(v)); z rebox (z, width(v));
shift amount (x) half (delta); shift amount (z) shift amount (x); height (v) height (y);
depth(v) depth(y);
Attach the limits to y and adjust height (v), depth(v) to account for their presence 751 ;
new hlist (q) v;
end
This code is used in section 749.
751. We use shift up and shift down in the following program for the amount of glue between the displayed
operator y and its limits x and z. The vlist inside box v will consist of x followed by y followed by z, with
kern nodes for the spaces between and around them.
Attach the limits to y and adjust height (v), depth(v) to account for their presence 751
if math type(supscr (q)) = empty then
begin free node(x, box node size); list ptr (v) y;
end
else begin shift up big op spacing3 depth(x);
if shift up < big op spacing1 then shift up big op spacing1 ;
p new kern(shift up); link (p) y; link (x) p;
p new kern(big op spacing5 ); link (p) x; list ptr (v) p;
height (v) height (v) + big op spacing5 + height (x) + depth(x) + shift up;
end;
if math type(subscr (q)) = empty then free node(z, box node size)
else begin shift down big op spacing4 height (z);
if shift down < big op spacing2 then shift down big op spacing2 ;
p new kern(shift down); link (y) p; link (p) z;
p new kern(big op spacing5 ); link (z) p;
depth(v) depth(v) + big op spacing5 + height (z) + depth(z) + shift down;
end
This code is used in section 750.
752 T
E
X82 PART 36: TYPESETTING MATH FORMULAS 277
752. A ligature found in a math formula does not create a ligature node, because there is no question of
hyphenation afterwards; the ligature will simply be stored in an ordinary char node, after residing in an
ord noad .
The math type is converted to math text char here if we would not want to apply an italic correction to
the current character unless it belongs to a math font (i.e., a font with space = 0).
No boundary characters enter into these ligatures.
Declare math construction procedures 734 +
procedure make ord (q : pointer );
label restart , exit ;
var a: integer ; address of lig/kern instruction
p, r: pointer ; temporary registers for list manipulation
begin restart :
if math type(subscr (q)) = empty then
if math type(supscr (q)) = empty then
if math type(nucleus (q)) = math char then
begin p link (q);
if p ,= null then
if (type(p) ord noad ) (type(p) punct noad ) then
if math type(nucleus (p)) = math char then
if fam(nucleus (p)) = fam(nucleus (q)) then
begin math type(nucleus (q)) math text char ; fetch(nucleus (q));
if char tag (cur i ) = lig tag then
begin a lig kern start (cur f )(cur i ); cur c character (nucleus (p));
cur i font info[a].qqqq ;
if skip byte(cur i ) > stop ag then
begin a lig kern restart (cur f )(cur i ); cur i font info[a].qqqq ;
end;
loop begin If instruction cur i is a kern with cur c, attach the kern after q; or if it is
a ligature with cur c, combine noads q and p appropriately; then return if the
cursor has moved past a noad, or goto restart 753 ;
if skip byte(cur i ) stop ag then return;
a a + qo(skip byte(cur i )) + 1; cur i font info[a].qqqq ;
end;
end;
end;
end;
exit : end;
278 PART 36: TYPESETTING MATH FORMULAS T
E
X82 753
753. Note that a ligature between an ord noad and another kind of noad is replaced by an ord noad , when
the two noads collapse into one. But we could make a parenthesis (say) change shape when it follows certain
letters. Presumably a font designer will dene such ligatures only when this convention makes sense.
If instruction cur i is a kern with cur c, attach the kern after q; or if it is a ligature with cur c,
combine noads q and p appropriately; then return if the cursor has moved past a noad, or goto
restart 753
if next char (cur i ) = cur c then
if skip byte(cur i ) stop ag then
if op byte(cur i ) kern ag then
begin p new kern(char kern(cur f )(cur i )); link (p) link (q); link (q) p; return;
end
else begin check interrupt ; allow a way out of innite ligature loop
case op byte(cur i ) of
qi (1), qi (5): character (nucleus (q)) rem byte(cur i ); =:|, =:|>
qi (2), qi (6): character (nucleus (p)) rem byte(cur i ); |=:, |=:>
qi (3), qi (7), qi (11): begin r new noad ; |=:|, |=:|>, |=:|>>
character (nucleus (r)) rem byte(cur i ); fam(nucleus (r)) fam(nucleus (q));
link (q) r; link (r) p;
if op byte(cur i ) < qi (11) then math type(nucleus (r)) math char
else math type(nucleus (r)) math text char ; prevent combination
end;
othercases begin link (q) link (p); character (nucleus (q)) rem byte(cur i ); =:
mem[subscr (q)] mem[subscr (p)]; mem[supscr (q)] mem[supscr (p)];
free node(p, noad size);
end
endcases;
if op byte(cur i ) > qi (3) then return;
math type(nucleus (q)) math char ; goto restart ;
end
This code is used in section 752.
754 T
E
X82 PART 36: TYPESETTING MATH FORMULAS 279
754. When we get to the following part of the program, we have fallen through from cases that did not
lead to check dimensions or done with noad or done with node. Thus, q points to a noad whose nucleus
may need to be converted to an hlist, and whose subscripts and superscripts need to be appended if they
are present.
If nucleus (q) is not a math char , the variable delta is the amount by which a superscript should be moved
right with respect to a subscript when both are present.
Convert nucleus (q) to an hlist and attach the sub/superscripts 754
case math type(nucleus (q)) of
math char , math text char : Create a character node p for nucleus (q), possibly followed by a kern node
for the italic correction, and set delta to the italic correction if a subscript is present 755 ;
empty: p null ;
sub box : p info(nucleus (q));
sub mlist : begin cur mlist info(nucleus (q)); save style cur style; mlist penalties false;
mlist to hlist ; recursive call
cur style save style; Set up the values of cur size and cur mu, based on cur style 703 ;
p hpack (link (temp head ), natural );
end;
othercases confusion("mlist2")
endcases;
new hlist (q) p;
if (math type(subscr (q)) = empty) (math type(supscr (q)) = empty) then goto check dimensions ;
make scripts (q, delta)
This code is used in section 728.
755. Create a character node p for nucleus (q), possibly followed by a kern node for the italic correction,
and set delta to the italic correction if a subscript is present 755
begin fetch(nucleus (q));
if char exists (cur i ) then
begin delta char italic(cur f )(cur i ); p new character (cur f , qo(cur c));
if (math type(nucleus (q)) = math text char ) (space(cur f ) ,= 0) then delta 0;
no italic correction in mid-word of text font
if (math type(subscr (q)) = empty) (delta ,= 0) then
begin link (p) new kern(delta); delta 0;
end;
end
else p null ;
end
This code is used in section 754.
280 PART 36: TYPESETTING MATH FORMULAS T
E
X82 756
756. The purpose of make scripts (q, delta) is to attach the subscript and/or superscript of noad q to the
list that starts at new hlist (q), given that subscript and superscript arent both empty. The superscript will
appear to the right of the subscript by a given distance delta.
We set shift down and shift up to the minimum amounts to shift the baseline of subscripts and superscripts
based on the given nucleus.
Declare math construction procedures 734 +
procedure make scripts (q : pointer ; delta : scaled );
var p, x, y, z: pointer ; temporary registers for box construction
shift up, shift down, clr : scaled ; dimensions in the calculation
t: small number ; subsidiary size code
begin p new hlist (q);
if is char node(p) then
begin shift up 0; shift down 0;
end
else begin z hpack (p, natural );
if cur style < script style then t script size else t script script size;
shift up height (z) sup drop(t); shift down depth(z) + sub drop(t); free node(z, box node size);
end;
if math type(supscr (q)) = empty then Construct a subscript box x when there is no superscript 757
else begin Construct a superscript box x 758 ;
if math type(subscr (q)) = empty then shift amount (x) shift up
else Construct a sub/superscript combination box x, with the superscript oset by delta 759 ;
end;
if new hlist (q) = null then new hlist (q) x
else begin p new hlist (q);
while link (p) ,= null do p link (p);
link (p) x;
end;
end;
757. When there is a subscript without a superscript, the top of the subscript should not exceed the
baseline plus four-fths of the x-height.
Construct a subscript box x when there is no superscript 757
begin x clean box (subscr (q), sub style(cur style)); width(x) width(x) + script space;
if shift down < sub1 (cur size) then shift down sub1 (cur size);
clr height (x) (abs (math x height (cur size) 4) div 5);
if shift down < clr then shift down clr ;
shift amount (x) shift down;
end
This code is used in section 756.
758 T
E
X82 PART 36: TYPESETTING MATH FORMULAS 281
758. The bottom of a superscript should never descend below the baseline plus one-fourth of the x-height.
Construct a superscript box x 758
begin x clean box (supscr (q), sup style(cur style)); width(x) width(x) + script space;
if odd (cur style) then clr sup3 (cur size)
else if cur style < text style then clr sup1 (cur size)
else clr sup2 (cur size);
if shift up < clr then shift up clr ;
clr depth(x) + (abs (math x height (cur size)) div 4);
if shift up < clr then shift up clr ;
end
This code is used in section 756.
759. When both subscript and superscript are present, the subscript must be separated from the super-
script by at least four times default rule thickness . If this condition would be violated, the subscript moves
down, after which both subscript and superscript move up so that the bottom of the superscript is at least
as high as the baseline plus four-fths of the x-height.
Construct a sub/superscript combination box x, with the superscript oset by delta 759
begin y clean box (subscr (q), sub style(cur style)); width(y) width(y) + script space;
if shift down < sub2 (cur size) then shift down sub2 (cur size);
clr 4 default rule thickness ((shift up depth(x)) (height (y) shift down));
if clr > 0 then
begin shift down shift down + clr ;
clr (abs (math x height (cur size) 4) div 5) (shift up depth(x));
if clr > 0 then
begin shift up shift up + clr ; shift down shift down clr ;
end;
end;
shift amount (x) delta; superscript is delta to the right of the subscript
p new kern((shift up depth(x)) (height (y) shift down)); link (x) p; link (p) y;
x vpack (x, natural ); shift amount (x) shift down;
end
This code is used in section 756.
760. We have now tied up all the loose ends of the rst pass of mlist to hlist . The second pass simply goes
through and hooks everything together with the proper glue and penalties. It also handles the left noad and
right noad that might be present, since max h and max d are now known. Variable p points to a node at
the current end of the nal hlist.
Make a second pass over the mlist, removing all noads and inserting the proper spacing and penalties 760
p temp head ; link (p) null ; q mlist ; r type 0; cur style style;
Set up the values of cur size and cur mu, based on cur style 703 ;
while q ,= null do
begin If node q is a style node, change the style and goto delete q ; otherwise if it is not a noad, put
it into the hlist, advance q, and goto done; otherwise set s to the size of noad q, set t to the
associated type (ord noad . . inner noad ), and set pen to the associated penalty 761 ;
Append inter-element spacing based on r type and t 766 ;
Append any new hlist entries for q, and any appropriate penalties 767 ;
r type t;
delete q : r q; q link (q); free node(r, s);
done: end
This code is used in section 726.
282 PART 36: TYPESETTING MATH FORMULAS T
E
X82 761
761. Just before doing the big case switch in the second pass, the program sets up default values so that
most of the branches are short.
If node q is a style node, change the style and goto delete q ; otherwise if it is not a noad, put it into the
hlist, advance q, and goto done; otherwise set s to the size of noad q, set t to the associated type
(ord noad . . inner noad ), and set pen to the associated penalty 761
t ord noad ; s noad size; pen inf penalty;
case type(q) of
op noad , open noad , close noad , punct noad , inner noad : t type(q);
bin noad : begin t bin noad ; pen bin op penalty;
end;
rel noad : begin t rel noad ; pen rel penalty;
end;
ord noad , vcenter noad , over noad , under noad : do nothing ;
radical noad : s radical noad size;
accent noad : s accent noad size;
fraction noad : begin t inner noad ; s fraction noad size;
end;
left noad , right noad : t make left right (q, style, max d , max h);
style node: Change the current style and goto delete q 763 ;
whatsit node, penalty node, rule node, disc node, adjust node, ins node, mark node, glue node, kern node:
begin link (p) q; p q; q link (q); link (p) null ; goto done;
end;
othercases confusion("mlist3")
endcases
This code is used in section 760.
762. The make left right function constructs a left or right delimiter of the required size and returns the
value open noad or close noad . The right noad and left noad will both be based on the original style, so
they will have consistent sizes.
We use the fact that right noad left noad = close noad open noad .
Declare math construction procedures 734 +
function make left right (q : pointer ; style : small number ; max d , max h : scaled ): small number ;
var delta, delta1 , delta2 : scaled ; dimensions used in the calculation
begin if style < script style then cur size text size
else cur size 16 ((style text style) div 2);
delta2 max d + axis height (cur size); delta1 max h + max d delta2 ;
if delta2 > delta1 then delta1 delta2 ; delta1 is max distance from axis
delta (delta1 div 500) delimiter factor ; delta2 delta1 + delta1 delimiter shortfall ;
if delta < delta2 then delta delta2 ;
new hlist (q) var delimiter (delimiter (q), cur size, delta);
make left right type(q) (left noad open noad ); open noad or close noad
end;
763. Change the current style and goto delete q 763
begin cur style subtype(q); s style node size;
Set up the values of cur size and cur mu, based on cur style 703 ;
goto delete q ;
end
This code is used in section 761.
764 T
E
X82 PART 36: TYPESETTING MATH FORMULAS 283
764. The inter-element spacing in math formulas depends on a 8 8 table that T
E
X preloads as a 64-digit
string. The elements of this string have the following signicance:
0 means no space;
1 means a conditional thin space (\nonscript\mskip\thinmuskip);
2 means a thin space (\mskip\thinmuskip);
3 means a conditional medium space (\nonscript\mskip\medmuskip);
4 means a conditional thick space (\nonscript\mskip\thickmuskip);
* means an impossible case.
This is all pretty cryptic, but The T
E
Xbook explains what is supposed to happen, and the string makes it
happen.
A global variable magic oset is computed so that if a and b are in the range ord noad . . inner noad ,
then str pool [a 8 + b + magic oset ] is the digit for spacing between noad types a and b.
If Pascal had provided a good way to preload constant arrays, this part of the program would not have
been so strange.
dene math spacing =
"0234000122*4000133**3**344*0400400*000000234000111*1111112341011"
Global variables 13 +
magic oset : integer ; used to nd inter-element spacing
765. Compute the magic oset 765
magic oset str start [math spacing ] 9 ord noad
This code is used in section 1337.
766. Append inter-element spacing based on r type and t 766
if r type > 0 then not the rst noad
begin case so(str pool [r type 8 + t + magic oset ]) of
"0": x 0;
"1": if cur style < script style then x thin mu skip code else x 0;
"2": x thin mu skip code;
"3": if cur style < script style then x med mu skip code else x 0;
"4": if cur style < script style then x thick mu skip code else x 0;
othercases confusion("mlist4")
endcases;
if x ,= 0 then
begin y math glue(glue par (x), cur mu); z new glue(y); glue ref count (y) null ;
link (p) z; p z;
subtype(z) x + 1; store a symbolic subtype
end;
end
This code is used in section 760.
284 PART 36: TYPESETTING MATH FORMULAS T
E
X82 767
767. We insert a penalty node after the hlist entries of noad q if pen is not an innite penalty, and if
the node immediately following q is not a penalty node or a rel noad or absent entirely.
Append any new hlist entries for q, and any appropriate penalties 767
if new hlist (q) ,= null then
begin link (p) new hlist (q);
repeat p link (p);
until link (p) = null ;
end;
if penalties then
if link (q) ,= null then
if pen < inf penalty then
begin r type type(link (q));
if r type ,= penalty node then
if r type ,= rel noad then
begin z new penalty(pen); link (p) z; p z;
end;
end
This code is used in section 760.
768 T
E
X82 PART 37: ALIGNMENT 285
768. Alignment. Its sort of a miracle whenever \halign and \valign work, because they cut across
so many of the control structures of T
E
X.
Therefore the present page is probably not the best place for a beginner to start reading this program; it
is better to master everything else rst.
Let us focus our thoughts on an example of what the input might be, in order to get some idea about
how the alignment miracle happens. The example doesnt do anything useful, but it is suciently general
to indicate all of the special cases that must be dealt with; please do not be disturbed by its apparent
complexity and meaninglessness.
\tabskip 2pt plus 3pt
\halign to 300pt{u1#v1&
\tabskip 1pt plus 1fil u2#v2&
u3#v3\cr
a1&\omit a2&\vrule\cr
\noalign{\vskip 3pt}
b1\span b2\cr
\omit&c2\span\omit\cr}
Heres what happens:
(0) When \halign to 300pt{ is scanned, the scan spec routine places the 300pt dimension onto the
save stack , and an align group code is placed above it. This will make it possible to complete the alignment
when the matching } is found.
(1) The preamble is scanned next. Macros in the preamble are not expanded, except as part of a tabskip
specication. For example, if u2 had been a macro in the preamble above, it would have been expanded,
since T
E
X must look for minus... as part of the tabskip glue. A preamble list is constructed based on
the users preamble; in our case it contains the following seven items:
\glue 2pt plus 3pt (the tabskip preceding column 1)
\alignrecord, width (preamble info for column 1)
\glue 2pt plus 3pt (the tabskip between columns 1 and 2)
\alignrecord, width (preamble info for column 2)
\glue 1pt plus 1fil (the tabskip between columns 2 and 3)
\alignrecord, width (preamble info for column 3)
\glue 1pt plus 1fil (the tabskip following column 3)
These alignrecord entries have the same size as an unset node, since they will later be converted into such
nodes. However, at the moment they have no type or subtype elds; they have info elds instead, and these
info elds are initially set to the value end span, for reasons explained below. Furthermore, the alignrecord
nodes have no height or depth elds; these are renamed u part and v part , and they point to token lists for
the templates of the alignment. For example, the u part eld in the rst alignrecord points to the token list
u1, i.e., the template preceding the # for column 1.
(2) T
E
X now looks at what follows the \cr that ended the preamble. It is not \noalign or \omit, so
this input is put back to be read again, and the template u1 is fed to the scanner. Just before reading u1,
T
E
X goes into restricted horizontal mode. Just after reading u1, T
E
X will see a1, and then (when the & is
sensed) T
E
X will see v1. Then T
E
X scans an endv token, indicating the end of a column. At this point an
unset node is created, containing the contents of the current hlist (i.e., u1a1v1). The natural width of this
unset node replaces the width eld of the alignrecord for column 1; in general, the alignrecords will record
the maximum natural width that has occurred so far in a given column.
(3) Since \omit follows the &, the templates for column 2 are now bypassed. Again T
E
X goes into
restricted horizontal mode and makes an unset node from the resulting hlist; but this time the hlist contains
simply a2. The natural width of the new unset box is remembered in the width eld of the alignrecord for
column 2.
(4) A third unset node is created for column 3, using essentially the mechanism that worked for column 1;
this unset box contains u3\vrule v3. The vertical rule in this case has running dimensions that will later
286 PART 37: ALIGNMENT T
E
X82 768
extend to the height and depth of the whole rst row, since each unset node in a row will eventually inherit
the height and depth of its enclosing box.
(5) The rst row has now ended; it is made into a single unset box comprising the following seven items:
\glue 2pt plus 3pt
\unsetbox for 1 column: u1a1v1
\glue 2pt plus 3pt
\unsetbox for 1 column: a2
\glue 1pt plus 1fil
\unsetbox for 1 column: u3\vrule v3
\glue 1pt plus 1fil
The width of this unset row is unimportant, but it has the correct height and depth, so the correct baselineskip
glue will be computed as the row is inserted into a vertical list.
(6) Since \noalign follows the current \cr, T
E
X appends additional material (in this case \vskip 3pt)
to the vertical list. While processing this material, T
E
X will be in internal vertical mode, and no align group
will be on save stack .
(7) The next row produces an unset box that looks like this:
\glue 2pt plus 3pt
\unsetbox for 2 columns: u1b1v1u2b2v2
\glue 1pt plus 1fil
\unsetbox for 1 column: (empty)
\glue 1pt plus 1fil
The natural width of the unset box that spans columns 1 and 2 is stored in a span node, which we will
explain later; the info eld of the alignrecord for column 1 now points to the new span node, and the info
of the span node points to end span.
(8) The nal row produces the unset box
\glue 2pt plus 3pt
\unsetbox for 1 column: (empty)
\glue 2pt plus 3pt
\unsetbox for 2 columns: u2c2v2
\glue 1pt plus 1fil
A new span node is attached to the alignrecord for column 2.
(9) The last step is to compute the true column widths and to change all the unset boxes to hboxes,
appending the whole works to the vertical list that encloses the \halign. The rules for deciding on the nal
widths of each unset column box will be explained below.
Note that as \halign is being processed, we fearlessly give up control to the rest of T
E
X. At critical junctures,
an alignment routine is called upon to step in and do some little action, but most of the time these routines
just lurk in the background. Its something like post-hypnotic suggestion.
769. We have mentioned that alignrecords contain no height or depth elds. Their glue sign and glue order
are pre-empted as well, since it is necessary to store information about what to do when a template ends.
This information is called the extra info eld.
dene u part (#) mem[# + height oset ].int pointer to u
j
token list
dene v part (#) mem[# + depth oset ].int pointer to v
j
token list
dene extra info(#) info(# + list oset ) info to remember during template
770 T
E
X82 PART 37: ALIGNMENT 287
770. Alignments can occur within alignments, so a small stack is used to access the alignrecord information.
At each level we have a preamble pointer, indicating the beginning of the preamble list; a cur align pointer,
indicating the current position in the preamble list; a cur span pointer, indicating the value of cur align at
the beginning of a sequence of spanned columns; a cur loop pointer, indicating the tabskip glue before an
alignrecord that should be copied next if the current list is extended; and the align state variable, which
indicates the nesting of braces so that \cr and \span and tab marks are properly intercepted. There also are
pointers cur head and cur tail to the head and tail of a list of adjustments being moved out from horizontal
mode to vertical mode.
The current values of these seven quantities appear in global variables; when they have to be pushed down,
they are stored in 5-word nodes, and align ptr points to the topmost such node.
dene preamble link (align head ) the current preamble list
dene align stack node size = 5 number of mem words to save alignment states
Global variables 13 +
cur align: pointer ; current position in preamble list
cur span: pointer ; start of currently spanned columns in preamble list
cur loop: pointer ; place to copy when extending a periodic preamble
align ptr : pointer ; most recently pushed-down alignment stack node
cur head , cur tail : pointer ; adjustment list pointers
771. The align state and preamble variables are initialized elsewhere.
Set initial values of key variables 21 +
align ptr null ; cur align null ; cur span null ; cur loop null ; cur head null ;
cur tail null ;
772. Alignment stack maintenance is handled by a pair of trivial routines called push alignment and
pop alignment .
procedure push alignment ;
var p: pointer ; the new alignment stack node
begin p get node(align stack node size); link (p) align ptr ; info(p) cur align;
llink (p) preamble; rlink (p) cur span; mem[p + 2].int cur loop; mem[p + 3].int align state;
info(p + 4) cur head ; link (p + 4) cur tail ; align ptr p; cur head get avail ;
end;
procedure pop alignment ;
var p: pointer ; the top alignment stack node
begin free avail (cur head ); p align ptr ; cur tail link (p + 4); cur head info(p + 4);
align state mem[p + 3].int ; cur loop mem[p + 2].int ; cur span rlink (p); preamble llink (p);
cur align info(p); align ptr link (p); free node(p, align stack node size);
end;
773. T
E
X has eight procedures that govern alignments: init align and n align are used at the very
beginning and the very end; init row and n row are used at the beginning and end of individual rows;
init span is used at the beginning of a sequence of spanned columns (possibly involving only one column);
init col and n col are used at the beginning and end of individual columns; and align peek is used after
\cr to see whether the next item is \noalign.
We shall consider these routines in the order they are rst used during the course of a complete \halign,
namely init align, align peek , init row, init span, init col , n col , n row, n align.
288 PART 37: ALIGNMENT T
E
X82 774
774. When \halign or \valign has been scanned in an appropriate mode, T
E
X calls init align, whose
task is to get everything o to a good start. This mostly involves scanning the preamble and putting its
information into the preamble list.
Declare the procedure called get preamble token 782
procedure align peek ; forward ;
procedure normal paragraph; forward ;
procedure init align;
label done, done1 , done2 , continue;
var save cs ptr : pointer ; warning index value for error messages
p: pointer ; for short-term temporary use
begin save cs ptr cur cs ; \halign or \valign, usually
push alignment ; align state 1000000; enter a new alignment level
Check for improper alignment in displayed math 776 ;
push nest ; enter a new semantic level
Change current mode to vmode for \halign, hmode for \valign 775 ;
scan spec(align group, false);
Scan the preamble and record it in the preamble list 777 ;
new save level (align group);
if every cr ,= null then begin token list (every cr , every cr text );
align peek ; look for \noalign or \omit
end;
775. In vertical modes, prev depth already has the correct value. But if we are in mmode (displayed
formula mode), we reach out to the enclosing vertical mode for the prev depth value that produces the
correct baseline calculations.
Change current mode to vmode for \halign, hmode for \valign 775
if mode = mmode then
begin mode vmode; prev depth nest [nest ptr 2].aux eld .sc;
end
else if mode > 0 then negate(mode)
This code is used in section 774.
776. When \halign is used as a displayed formula, there should be no other pieces of mlists present.
Check for improper alignment in displayed math 776
if (mode = mmode) ((tail ,= head ) (incompleat noad ,= null )) then
begin print err ("Improper"); print esc("halign"); print ("inside$$s");
help3 ("Displayscanusespecialalignments(like\eqalignno)")
("onlyifnothingbutthealignmentitselfisbetween$$s.")
("SoIvedeletedtheformulasthatprecededthisalignment."); error ; ush math;
end
This code is used in section 774.
777 T
E
X82 PART 37: ALIGNMENT 289
777. Scan the preamble and record it in the preamble list 777
preamble null ; cur align align head ; cur loop null ; scanner status aligning ;
warning index save cs ptr ; align state 1000000; at this point, cur cmd = left brace
loop begin Append the current tabskip glue to the preamble list 778 ;
if cur cmd = car ret then goto done; \cr ends the preamble
Scan preamble text until cur cmd is tab mark or car ret , looking for changes in the tabskip glue;
append an alignrecord to the preamble list 779 ;
end;
done: scanner status normal
This code is used in section 774.
778. Append the current tabskip glue to the preamble list 778
link (cur align) new param glue(tab skip code); cur align link (cur align)
This code is used in section 777.
779. Scan preamble text until cur cmd is tab mark or car ret , looking for changes in the tabskip glue;
append an alignrecord to the preamble list 779
Scan the template u
j
, putting the resulting token list in hold head 783 ;
link (cur align) new null box ; cur align link (cur align); a new alignrecord
info(cur align) end span; width(cur align) null ag ; u part (cur align) link (hold head );
Scan the template v
j
, putting the resulting token list in hold head 784 ;
v part (cur align) link (hold head )
This code is used in section 777.
780. We enter \span into eqtb with tab mark as its command code, and with span code as the command
modier. This makes T
E
X interpret it essentially the same as an alignment delimiter like &, yet it is
recognizably dierent when we need to distinguish it from a normal delimiter. It also turns out to be useful
to give a special cr code to \cr, and an even larger cr cr code to \crcr.
The end of a template is represented by two frozen control sequences called \endtemplate. The rst
has the command code end template, which is > outer call , so it will not easily disappear in the presence of
errors. The get x token routine converts the rst into the second, which has endv as its command code.
dene span code = 256 distinct from any character
dene cr code = 257 distinct from span code and from any character
dene cr cr code = cr code + 1 this distinguishes \crcr from \cr
dene end template token cs token ag + frozen end template
Put each of T
E
Xs primitives into the hash table 226 +
primitive("span", tab mark , span code);
primitive("cr", car ret , cr code); text (frozen cr ) "cr"; eqtb[frozen cr ] eqtb[cur val ];
primitive("crcr", car ret , cr cr code); text (frozen end template) "endtemplate";
text (frozen endv ) "endtemplate"; eq type(frozen endv ) endv ; equiv (frozen endv ) null list ;
eq level (frozen endv ) level one;
eqtb[frozen end template] eqtb[frozen endv ]; eq type(frozen end template) end template;
781. Cases of print cmd chr for symbolic printing of primitives 227 +
tab mark : if chr code = span code then print esc("span")
else chr cmd ("alignmenttabcharacter");
car ret : if chr code = cr code then print esc("cr")
else print esc("crcr");
290 PART 37: ALIGNMENT T
E
X82 782
782. The preamble is copied directly, except that \tabskip causes a change to the tabskip glue, thereby
possibly expanding macros that immediately follow it. An appearance of \span also causes such an expansion.
Note that if the preamble contains \global\tabskip, the \global token survives in the preamble and
the \tabskip denes new tabskip glue (locally).
Declare the procedure called get preamble token 782
procedure get preamble token;
label restart ;
begin restart : get token;
while (cur chr = span code) (cur cmd = tab mark ) do
begin get token; this token will be expanded once
if cur cmd > max command then
begin expand ; get token;
end;
end;
if cur cmd = endv then fatal error ("(interwovenalignmentpreamblesarenotallowed)");
if (cur cmd = assign glue) (cur chr = glue base + tab skip code) then
begin scan optional equals ; scan glue(glue val );
if global defs > 0 then geq dene(glue base + tab skip code, glue ref , cur val )
else eq dene(glue base + tab skip code, glue ref , cur val );
goto restart ;
end;
end;
This code is used in section 774.
783. Spaces are eliminated from the beginning of a template.
Scan the template u
j
, putting the resulting token list in hold head 783
p hold head ; link (p) null ;
loop begin get preamble token;
if cur cmd = mac param then goto done1 ;
if (cur cmd car ret ) (cur cmd tab mark ) (align state = 1000000) then
if (p = hold head ) (cur loop = null ) (cur cmd = tab mark ) then cur loop cur align
else begin print err ("Missing#insertedinalignmentpreamble");
help3 ("Thereshouldbeexactlyone#between&s,whenan")
("\halignor\valignisbeingsetup.Inthiscaseyouhad")
("none,soIveputonein;maybethatwillwork."); back error ; goto done1 ;
end
else if (cur cmd ,= spacer ) (p ,= hold head ) then
begin link (p) get avail ; p link (p); info(p) cur tok ;
end;
end;
done1 :
This code is used in section 779.
784 T
E
X82 PART 37: ALIGNMENT 291
784. Scan the template v
j
, putting the resulting token list in hold head 784
p hold head ; link (p) null ;
loop begin continue: get preamble token;
if (cur cmd car ret ) (cur cmd tab mark ) (align state = 1000000) then goto done2 ;
if cur cmd = mac param then
begin print err ("Onlyone#isallowedpertab");
help3 ("Thereshouldbeexactlyone#between&s,whenan")
("\halignor\valignisbeingsetup.Inthiscaseyouhad")
("morethanone,soImignoringallbutthefirst."); error ; goto continue;
end;
link (p) get avail ; p link (p); info(p) cur tok ;
end;
done2 : link (p) get avail ; p link (p); info(p) end template token put \endtemplate at the end
This code is used in section 779.
785. The tricky part about alignments is getting the templates into the scanner at the right time, and
recovering control when a row or column is nished.
We usually begin a row after each \cr has been sensed, unless that \cr is followed by \noalign or by the
right brace that terminates the alignment. The align peek routine is used to look ahead and do the right
thing; it either gets a new row started, or gets a \noalign started, or nishes o the alignment.
Declare the procedure called align peek 785
procedure align peek ;
label restart ;
begin restart : align state 1000000; Get the next non-blank non-call token 406 ;
if cur cmd = no align then
begin scan left brace; new save level (no align group);
if mode = vmode then normal paragraph;
end
else if cur cmd = right brace then n align
else if (cur cmd = car ret ) (cur chr = cr cr code) then goto restart ignore \crcr
else begin init row; start a new row
init col ; start a new column and replace what we peeked at
end;
end;
This code is used in section 800.
786. To start a row (i.e., a row that rhymes with dough but not with bough), we enter a new semantic
level, copy the rst tabskip glue, and change from internal vertical mode to restricted horizontal mode or
vice versa. The space factor and prev depth are not used on this semantic level, but we clear them to zero
just to be tidy.
Declare the procedure called init span 787
procedure init row;
begin push nest ; mode (hmode vmode) mode;
if mode = hmode then space factor 0 else prev depth 0;
tail append (new glue(glue ptr (preamble))); subtype(tail ) tab skip code + 1;
cur align link (preamble); cur tail cur head ; init span(cur align);
end;
292 PART 37: ALIGNMENT T
E
X82 787
787. The parameter to init span is a pointer to the alignrecord where the next column or group of columns
will begin. A new semantic level is entered, so that the columns will generate a list for subsequent packaging.
Declare the procedure called init span 787
procedure init span(p : pointer );
begin push nest ;
if mode = hmode then space factor 1000
else begin prev depth ignore depth; normal paragraph;
end;
cur span p;
end;
This code is used in section 786.
788. When a column begins, we assume that cur cmd is either omit or else the current token should be
put back into the input until the u
j
template has been scanned. (Note that cur cmd might be tab mark
or car ret .) We also assume that align state is approximately 1000000 at this time. We remain in the same
mode, and start the template if it is called for.
procedure init col ;
begin extra info(cur align) cur cmd ;
if cur cmd = omit then align state 0
else begin back input ; begin token list (u part (cur align), u template);
end; now align state = 1000000
end;
789. The scanner sets align state to zero when the u
j
template ends. When a subsequent \cr or \span
or tab mark occurs with align state = 0, the scanner activates the following code, which res up the v
j

template. We need to remember the cur chr , which is either cr cr code, cr code, span code, or a character
code, depending on how the column text has ended.
This part of the program had better not be activated when the preamble to another alignment is being
scanned, or when no alignment preamble is active.
Insert the v
j
template and goto restart 789
begin if (scanner status = aligning ) (cur align = null ) then
fatal error ("(interwovenalignmentpreamblesarenotallowed)");
cur cmd extra info(cur align); extra info(cur align) cur chr ;
if cur cmd = omit then begin token list (omit template, v template)
else begin token list (v part (cur align), v template);
align state 1000000; goto restart ;
end
This code is used in section 342.
790. The token list omit template just referred to is a constant token list that contains the special control
sequence \endtemplate only.
Initialize the special list heads and constant nodes 790
info(omit template) end template token; link (omit template) = null
See also sections 797, 820, 981, and 988.
This code is used in section 164.
791 T
E
X82 PART 37: ALIGNMENT 293
791. When the endv command at the end of a v
j
template comes through the scanner, things really
start to happen; and it is the n col routine that makes them happen. This routine returns true if a row as
well as a column has been nished.
function n col : boolean;
label exit ;
var p: pointer ; the alignrecord after the current one
q, r: pointer ; temporary pointers for list manipulation
s: pointer ; a new span node
u: pointer ; a new unset box
w: scaled ; natural width
o: glue ord ; order of innity
n: halfword ; span counter
begin if cur align = null then confusion("endv");
q link (cur align); if q = null then confusion("endv");
if align state < 500000 then fatal error ("(interwovenalignmentpreamblesarenotallowed)");
p link (q); If the preamble list has been traversed, check that the row has ended 792 ;
if extra info(cur align) ,= span code then
begin unsave; new save level (align group);
Package an unset box for the current column and record its width 796 ;
Copy the tabskip glue between columns 795 ;
if extra info(cur align) cr code then
begin n col true; return;
end;
init span(p);
end;
align state 1000000; Get the next non-blank non-call token 406 ;
cur align p; init col ; n col false;
exit : end;
792. If the preamble list has been traversed, check that the row has ended 792
if (p = null ) (extra info(cur align) < cr code) then
if cur loop ,= null then Lengthen the preamble periodically 793
else begin print err ("Extraalignmenttabhasbeenchangedto"); print esc("cr");
help3 ("Youhavegivenmore\spanor&marksthantherewere")
("inthepreambletothe\halignor\valignnowinprogress.")
("SoIllassumethatyoumeanttotype\crinstead."); extra info(cur align) cr code;
error ;
end
This code is used in section 791.
793. Lengthen the preamble periodically 793
begin link (q) new null box ; p link (q); a new alignrecord
info(p) end span; width(p) null ag ; cur loop link (cur loop);
Copy the templates from node cur loop into node p 794 ;
cur loop link (cur loop); link (p) new glue(glue ptr (cur loop));
end
This code is used in section 792.
294 PART 37: ALIGNMENT T
E
X82 794
794. Copy the templates from node cur loop into node p 794
q hold head ; r u part (cur loop);
while r ,= null do
begin link (q) get avail ; q link (q); info(q) info(r); r link (r);
end;
link (q) null ; u part (p) link (hold head ); q hold head ; r v part (cur loop);
while r ,= null do
begin link (q) get avail ; q link (q); info(q) info(r); r link (r);
end;
link (q) null ; v part (p) link (hold head )
This code is used in section 793.
795. Copy the tabskip glue between columns 795
tail append (new glue(glue ptr (link (cur align)))); subtype(tail ) tab skip code + 1
This code is used in section 791.
796. Package an unset box for the current column and record its width 796
begin if mode = hmode then
begin adjust tail cur tail ; u hpack (link (head ), natural ); w width(u); cur tail adjust tail ;
adjust tail null ;
end
else begin u vpackage(link (head ), natural , 0); w height (u);
end;
n min quarterword ; this represents a span count of 1
if cur span ,= cur align then Update width entry for spanned columns 798
else if w > width(cur align) then width(cur align) w;
type(u) unset node; span count (u) n;
Determine the stretch order 659 ;
glue order (u) o; glue stretch(u) total stretch[o];
Determine the shrink order 665 ;
glue sign(u) o; glue shrink (u) total shrink [o];
pop nest ; link (tail ) u; tail u;
end
This code is used in section 791.
797. A span node is a 2-word record containing width, info, and link elds. The link eld is not really a
link, it indicates the number of spanned columns; the info eld points to a span node for the same starting
column, having a greater extent of spanning, or to end span, which has the largest possible link eld; the
width eld holds the largest natural width corresponding to a particular set of spanned columns.
A list of the maximum widths so far, for spanned columns starting at a given column, begins with the
info eld of the alignrecord for that column.
dene span node size = 2 number of mem words for a span node
Initialize the special list heads and constant nodes 790 +
link (end span) max quarterword + 1; info(end span) null ;
798 T
E
X82 PART 37: ALIGNMENT 295
798. Update width entry for spanned columns 798
begin q cur span;
repeat incr (n); q link (link (q));
until q = cur align;
if n > max quarterword then confusion("256spans"); this can happen, but wont
q cur span;
while link (info(q)) < n do q info(q);
if link (info(q)) > n then
begin s get node(span node size); info(s) info(q); link (s) n; info(q) s; width(s) w;
end
else if width(info(q)) < w then width(info(q)) w;
end
This code is used in section 796.
799. At the end of a row, we append an unset box to the current vlist (for \halign) or the current hlist
(for \valign). This unset box contains the unset boxes for the columns, separated by the tabskip glue.
Everything will be set later.
procedure n row;
var p: pointer ; the new unset box
begin if mode = hmode then
begin p hpack (link (head ), natural ); pop nest ; append to vlist (p);
if cur head ,= cur tail then
begin link (tail ) link (cur head ); tail cur tail ;
end;
end
else begin p vpack (link (head ), natural ); pop nest ; link (tail ) p; tail p; space factor 1000;
end;
type(p) unset node; glue stretch(p) 0;
if every cr ,= null then begin token list (every cr , every cr text );
align peek ;
end; note that glue shrink (p) = 0 since glue shrink shift amount
296 PART 37: ALIGNMENT T
E
X82 800
800. Finally, we will reach the end of the alignment, and we can breathe a sigh of relief that memory
hasnt overowed. All the unset boxes will now be set so that the columns line up, taking due account of
spanned columns.
procedure do assignments ; forward ;
procedure resume after display; forward ;
procedure build page; forward ;
procedure n align;
var p, q, r, s, u, v: pointer ; registers for the list operations
t, w: scaled ; width of column
o: scaled ; shift oset for unset boxes
n: halfword ; matching span amount
rule save: scaled ; temporary storage for overfull rule
aux save: memory word ; temporary storage for aux
begin if cur group ,= align group then confusion("align1");
unsave; that align group was for individual entries
if cur group ,= align group then confusion("align0");
unsave; that align group was for the whole alignment
if nest [nest ptr 1].mode eld = mmode then o display indent
else o 0;
Go through the preamble list, determining the column widths and changing the alignrecords to dummy
unset boxes 801 ;
Package the preamble list, to determine the actual tabskip glue amounts, and let p point to this
prototype box 804 ;
Set the glue in all the unset boxes of the current list 805 ;
ush node list (p); pop alignment ; Insert the current list into its environment 812 ;
end;
Declare the procedure called align peek 785
801 T
E
X82 PART 37: ALIGNMENT 297
801. Its time now to dismantle the preamble list and to compute the column widths. Let w
ij
be the
maximum of the natural widths of all entries that span columns i through j, inclusive. The alignrecord for
column i contains w
ii
in its width eld, and there is also a linked list of the nonzero w
ij
for increasing j,
accessible via the info eld; these span nodes contain the value j i +min quarterword in their link elds.
The values of w
ii
were initialized to null ag , which we regard as .
The nal column widths are dened by the formula
w
j
= max
1ij

w
ij

ik<j
(t
k
+ w
k
)

,
where t
k
is the natural width of the tabskip glue between columns k and k + 1. However, if w
ij
= for
all i in the range 1 i j (i.e., if every entry that involved column j also involved column j + 1), we let
w
j
= 0, and we zero out the tabskip glue after column j.
T
E
X computes these values by using the following scheme: First w
1
= w
11
. Then replace w
2j
by
max(w
2j
, w
1j
t
1
w
1
), for all j > 1. Then w
2
= w
22
. Then replace w
3j
by max(w
3j
, w
2j
t
2
w
2
)
for all j > 2; and so on. If any w
j
turns out to be , its value is changed to zero and so is the next
tabskip.
Go through the preamble list, determining the column widths and changing the alignrecords to dummy
unset boxes 801
q link (preamble);
repeat ush list (u part (q)); ush list (v part (q)); p link (link (q));
if width(q) = null ag then Nullify width(q) and the tabskip glue following this column 802 ;
if info(q) ,= end span then
Merge the widths in the span nodes of q with those of p, destroying the span nodes of q 803 ;
type(q) unset node; span count (q) min quarterword ; height (q) 0; depth(q) 0;
glue order (q) normal ; glue sign(q) normal ; glue stretch(q) 0; glue shrink (q) 0; q p;
until q = null
This code is used in section 800.
802. Nullify width(q) and the tabskip glue following this column 802
begin width(q) 0; r link (q); s glue ptr (r);
if s ,= zero glue then
begin add glue ref (zero glue); delete glue ref (s); glue ptr (r) zero glue;
end;
end
This code is used in section 801.
298 PART 37: ALIGNMENT T
E
X82 803
803. Merging of two span-node lists is a typical exercise in the manipulation of linearly linked data
structures. The essential invariant in the following repeat loop is that we want to dispense with node
r, in qs list, and u is its successor; all nodes of ps list up to and including s have been processed, and the
successor of s matches r or precedes r or follows r, according as link (r) = n or link (r) > n or link (r) < n.
Merge the widths in the span nodes of q with those of p, destroying the span nodes of q 803
begin t width(q) + width(glue ptr (link (q))); r info(q); s end span; info(s) p;
n min quarterword + 1;
repeat width(r) width(r) t; u info(r);
while link (r) > n do
begin s info(s); n link (info(s)) + 1;
end;
if link (r) < n then
begin info(r) info(s); info(s) r; decr (link (r)); s r;
end
else begin if width(r) > width(info(s)) then width(info(s)) width(r);
free node(r, span node size);
end;
r u;
until r = end span;
end
This code is used in section 801.
804. Now the preamble list has been converted to a list of alternating unset boxes and tabskip glue, where
the box widths are equal to the nal column sizes. In case of \valign, we change the widths to heights, so
that a correct error message will be produced if the alignment is overfull or underfull.
Package the preamble list, to determine the actual tabskip glue amounts, and let p point to this prototype
box 804
save ptr save ptr 2; pack begin line mode line;
if mode = vmode then
begin rule save overfull rule; overfull rule 0; prevent rule from being packaged
p hpack (preamble, saved (1), saved (0)); overfull rule rule save;
end
else begin q link (preamble);
repeat height (q) width(q); width(q) 0; q link (link (q));
until q = null ;
p vpack (preamble, saved (1), saved (0)); q link (preamble);
repeat width(q) height (q); height (q) 0; q link (link (q));
until q = null ;
end;
pack begin line 0
This code is used in section 800.
805 T
E
X82 PART 37: ALIGNMENT 299
805. Set the glue in all the unset boxes of the current list 805
q link (head ); s head ;
while q ,= null do
begin if is char node(q) then
if type(q) = unset node then Set the unset box q and the unset boxes in it 807
else if type(q) = rule node then
Make the running dimensions in rule q extend to the boundaries of the alignment 806 ;
s q; q link (q);
end
This code is used in section 800.
806. Make the running dimensions in rule q extend to the boundaries of the alignment 806
begin if is running (width(q)) then width(q) width(p);
if is running (height (q)) then height (q) height (p);
if is running (depth(q)) then depth(q) depth(p);
if o ,= 0 then
begin r link (q); link (q) null ; q hpack (q, natural ); shift amount (q) o; link (q) r;
link (s) q;
end;
end
This code is used in section 805.
807. The unset box q represents a row that contains one or more unset boxes, depending on how soon \cr
occurred in that row.
Set the unset box q and the unset boxes in it 807
begin if mode = vmode then
begin type(q) hlist node; width(q) width(p);
end
else begin type(q) vlist node; height (q) height (p);
end;
glue order (q) glue order (p); glue sign(q) glue sign(p); glue set (q) glue set (p);
shift amount (q) o; r link (list ptr (q)); s link (list ptr (p));
repeat Set the glue in node r and change it from an unset node 808 ;
r link (link (r)); s link (link (s));
until r = null ;
end
This code is used in section 805.
300 PART 37: ALIGNMENT T
E
X82 808
808. A box made from spanned columns will be followed by tabskip glue nodes and by empty boxes as if
there were no spanning. This permits perfect alignment of subsequent entries, and it prevents values that
depend on oating point arithmetic from entering into the dimensions of any boxes.
Set the glue in node r and change it from an unset node 808
n span count (r); t width(s); w t; u hold head ;
while n > min quarterword do
begin decr (n); Append tabskip glue and an empty box to list u, and update s and t as the prototype
nodes are passed 809 ;
end;
if mode = vmode then
Make the unset node r into an hlist node of width w, setting the glue as if the width were t 810
else Make the unset node r into a vlist node of height w, setting the glue as if the height were t 811 ;
shift amount (r) 0;
if u ,= hold head then append blank boxes to account for spanned nodes
begin link (u) link (r); link (r) link (hold head ); r u;
end
This code is used in section 807.
809. Append tabskip glue and an empty box to list u, and update s and t as the prototype nodes are
passed 809
s link (s); v glue ptr (s); link (u) new glue(v); u link (u); subtype(u) tab skip code + 1;
t t + width(v);
if glue sign(p) = stretching then
begin if stretch order (v) = glue order (p) then t t + round (oat (glue set (p)) stretch(v));
end
else if glue sign(p) = shrinking then
begin if shrink order (v) = glue order (p) then t t round (oat (glue set (p)) shrink (v));
end;
s link (s); link (u) new null box ; u link (u); t t + width(s);
if mode = vmode then width(u) width(s) else begin type(u) vlist node; height (u) width(s);
end
This code is used in section 808.
810. Make the unset node r into an hlist node of width w, setting the glue as if the width were t 810
begin height (r) height (q); depth(r) depth(q);
if t = width(r) then
begin glue sign(r) normal ; glue order (r) normal ; set glue ratio zero(glue set (r));
end
else if t > width(r) then
begin glue sign(r) stretching ;
if glue stretch(r) = 0 then set glue ratio zero(glue set (r))
else glue set (r) unoat ((t width(r))/glue stretch(r));
end
else begin glue order (r) glue sign(r); glue sign(r) shrinking ;
if glue shrink (r) = 0 then set glue ratio zero(glue set (r))
else if (glue order (r) = normal ) (width(r) t > glue shrink (r)) then
set glue ratio one(glue set (r))
else glue set (r) unoat ((width(r) t)/glue shrink (r));
end;
width(r) w; type(r) hlist node;
end
This code is used in section 808.
811 T
E
X82 PART 37: ALIGNMENT 301
811. Make the unset node r into a vlist node of height w, setting the glue as if the height were t 811
begin width(r) width(q);
if t = height (r) then
begin glue sign(r) normal ; glue order (r) normal ; set glue ratio zero(glue set (r));
end
else if t > height (r) then
begin glue sign(r) stretching ;
if glue stretch(r) = 0 then set glue ratio zero(glue set (r))
else glue set (r) unoat ((t height (r))/glue stretch(r));
end
else begin glue order (r) glue sign(r); glue sign(r) shrinking ;
if glue shrink (r) = 0 then set glue ratio zero(glue set (r))
else if (glue order (r) = normal ) (height (r) t > glue shrink (r)) then
set glue ratio one(glue set (r))
else glue set (r) unoat ((height (r) t)/glue shrink (r));
end;
height (r) w; type(r) vlist node;
end
This code is used in section 808.
812. We now have a completed alignment, in the list that starts at head and ends at tail . This list will be
merged with the one that encloses it. (In case the enclosing mode is mmode, for displayed formulas, we will
need to insert glue before and after the display; that part of the program will be deferred until were more
familiar with such operations.)
In restricted horizontal mode, the clang part of aux is undened; an over-cautious Pascal runtime system
may complain about this.
Insert the current list into its environment 812
aux save aux ; p link (head ); q tail ; pop nest ;
if mode = mmode then Finish an alignment in a display 1206
else begin aux aux save; link (tail ) p;
if p ,= null then tail q;
if mode = vmode then build page;
end
This code is used in section 800.
302 PART 38: BREAKING PARAGRAPHS INTO LINES T
E
X82 813
813. Breaking paragraphs into lines. We come now to what is probably the most interesting algo-
rithm of T
E
X: the mechanism for choosing the best possible breakpoints that yield the individual lines of
a paragraph. T
E
Xs line-breaking algorithm takes a given horizontal list and converts it to a sequence of
boxes that are appended to the current vertical list. In the course of doing this, it creates a special data
structure containing three kinds of records that are not used elsewhere in T
E
X. Such nodes are created while
a paragraph is being processed, and they are destroyed afterwards; thus, the other parts of T
E
X do not need
to know anything about how line-breaking is done.
The method used here is based on an approach devised by Michael F. Plass and the author in 1977,
subsequently generalized and improved by the same two people in 1980. A detailed discussion appears in
SOFTWAREPractice & Experience 11 (1981), 11191184, where it is shown that the line-breaking problem
can be regarded as a special case of the problem of computing the shortest path in an acyclic network. The
cited paper includes numerous examples and describes the history of line breaking as it has been practiced
by printers through the ages. The present implementation adds two new ideas to the algorithm of 1980:
Memory space requirements are considerably reduced by using smaller records for inactive nodes than for
active ones, and arithmetic overow is avoided by using delta distances instead of keeping track of the
total distance from the beginning of the paragraph to the current point.
814. The line break procedure should be invoked only in horizontal mode; it leaves that mode and places
its output into the current vlist of the enclosing vertical mode (or internal vertical mode). There is one
explicit parameter: nal widow penalty is the amount of additional penalty to be inserted before the nal
line of the paragraph.
There are also a number of implicit parameters: The hlist to be broken starts at link (head ), and it is
nonempty. The value of prev graf in the enclosing semantic level tells where the paragraph should begin
in the sequence of line numbers, in case hanging indentation or \parshape are in use; prev graf is zero
unless this paragraph is being continued after a displayed formula. Other implicit parameters, such as the
par shape ptr and various penalties to use for hyphenation, etc., appear in eqtb.
After line break has acted, it will have updated the current vlist and the value of prev graf . Furthermore,
the global variable just box will point to the nal box created by line break , so that the width of this line can
be ascertained when it is necessary to decide whether to use above display skip or above display short skip
before a displayed formula.
Global variables 13 +
just box : pointer ; the hlist node for the last line of the new paragraph
815. Since line break is a rather lengthy proceduresort of a small world unto itselfwe must build it
up little by little, somewhat more cautiously than we have done with the simpler procedures of T
E
X. Here
is the general outline.
Declare subprocedures for line break 826
procedure line break (nal widow penalty : integer );
label done, done1 , done2 , done3 , done4 , done5 , continue;
var Local variables for line breaking 862
begin pack begin line mode line; this is for over/underfull box messages
Get ready to start line breaking 816 ;
Find optimal breakpoints 863 ;
Break the paragraph at the chosen breakpoints, justify the resulting lines to the correct widths, and
append them to the current vertical list 876 ;
Clean up the memory by removing the break nodes 865 ;
pack begin line 0;
end;
816 T
E
X82 PART 38: BREAKING PARAGRAPHS INTO LINES 303
816. The rst task is to move the list from head to temp head and go into the enclosing semantic level.
We also append the \parfillskip glue to the end of the paragraph, removing a space (or other glue node)
if it was there, since spaces usually precede blank lines and instances of $$. The par ll skip is preceded
by an innite penalty, so it will never be considered as a potential breakpoint.
This code assumes that a glue node and a penalty node occupy the same number of mem words.
Get ready to start line breaking 816
link (temp head ) link (head );
if is char node(tail ) then tail append (new penalty(inf penalty))
else if type(tail ) ,= glue node then tail append (new penalty(inf penalty))
else begin type(tail ) penalty node; delete glue ref (glue ptr (tail )); ush node list (leader ptr (tail ));
penalty(tail ) inf penalty;
end;
link (tail ) new param glue(par ll skip code); init cur lang prev graf mod 200000 ;
init l hyf prev graf div 20000000 ; init r hyf (prev graf div 200000 ) mod 100 ; pop nest ;
See also sections 827, 834, and 848.
This code is used in section 815.
817. When looking for optimal line breaks, T
E
X creates a break node for each break that is feasible,
in the sense that there is a way to end a line at the given place without requiring any line to stretch more
than a given tolerance. A break node is characterized by three things: the position of the break (which is
a pointer to a glue node, math node, penalty node, or disc node); the ordinal number of the line that will
follow this breakpoint; and the tness classication of the line that has just ended, i.e., tight t , decent t ,
loose t , or very loose t .
dene tight t = 3 tness classication for lines shrinking 0.5 to 1.0 of their shrinkability
dene loose t = 1 tness classication for lines stretching 0.5 to 1.0 of their stretchability
dene very loose t = 0 tness classication for lines stretching more than their stretchability
dene decent t = 2 tness classication for all other lines
818. The algorithm essentially determines the best possible way to achieve each feasible combination of
position, line, and tness. Thus, it answers questions like, What is the best way to break the opening
part of the paragraph so that the fourth line is a tight line ending at such-and-such a place? However, the
fact that all lines are to be the same length after a certain point makes it possible to regard all suciently
large line numbers as equivalent, when the looseness parameter is zero, and this makes it possible for the
algorithm to save space and time.
An active node and a passive node are created in mem for each feasible breakpoint that needs to be
considered. Active nodes are three words long and passive nodes are two words long. We need active nodes
only for breakpoints near the place in the paragraph that is currently being examined, so they are recycled
within a comparatively short time after they are created.
304 PART 38: BREAKING PARAGRAPHS INTO LINES T
E
X82 819
819. An active node for a given breakpoint contains six elds:
link points to the next node in the list of active nodes; the last active node has link = last active.
break node points to the passive node associated with this breakpoint.
line number is the number of the line that follows this breakpoint.
tness is the tness classication of the line ending at this breakpoint.
type is either hyphenated or unhyphenated , depending on whether this breakpoint is a disc node.
total demerits is the minimum possible sum of demerits over all lines leading from the beginning of the
paragraph to this breakpoint.
The value of link (active) points to the rst active node on a linked list of all currently active nodes. This
list is in order by line number , except that nodes with line number > easy line may be in any order relative
to each other.
dene active node size = 3 number of words in active nodes
dene tness subtype very loose t . . tight t on nal line for this break
dene break node rlink pointer to the corresponding passive node
dene line number llink line that begins at this breakpoint
dene total demerits (#) mem[# + 2].int the quantity that T
E
X minimizes
dene unhyphenated = 0 the type of a normal active break node
dene hyphenated = 1 the type of an active node that breaks at a disc node
dene last active active the active list ends where it begins
820. Initialize the special list heads and constant nodes 790 +
type(last active) hyphenated ; line number (last active) max halfword ; subtype(last active) 0;
the subtype is never examined by the algorithm
821. The passive node for a given breakpoint contains only four elds:
link points to the passive node created just before this one, if any, otherwise it is null .
cur break points to the position of this breakpoint in the horizontal list for the paragraph being broken.
prev break points to the passive node that should precede this one in an optimal path to this breakpoint.
serial is equal to n if this passive node is the nth one created during the current pass. (This eld is used
only when printing out detailed statistics about the line-breaking calculations.)
There is a global variable called passive that points to the most recently created passive node. Another
global variable, printed node, is used to help print out the paragraph when detailed information about the
line-breaking computation is being displayed.
dene passive node size = 2 number of words in passive nodes
dene cur break rlink in passive node, points to position of this breakpoint
dene prev break llink points to passive node that should precede this one
dene serial info serial number for symbolic identication
Global variables 13 +
passive: pointer ; most recent node on passive list
printed node: pointer ; most recent node that has been printed
pass number : halfword ; the number of passive nodes allocated on this pass
822 T
E
X82 PART 38: BREAKING PARAGRAPHS INTO LINES 305
822. The active list also contains delta nodes that help the algorithm compute the badness of individual
lines. Such nodes appear only between two active nodes, and they have type = delta node. If p and r are
active nodes and if q is a delta node between them, so that link (p) = q and link (q) = r, then q tells the
space dierence between lines in the horizontal list that start after breakpoint p and lines that start after
breakpoint r. In other words, if we know the length of the line that starts after p and ends at our current
position, then the corresponding length of the line that starts after r is obtained by adding the amounts in
node q. A delta node contains six scaled numbers, since it must record the net change in glue stretchability
with respect to all orders of innity. The natural width dierence appears in mem[q + 1].sc; the stretch
dierences in units of pt, l, ll, and lll appear in mem[q +2 . . q +5].sc; and the shrink dierence appears
in mem[q + 6].sc. The subtype eld of a delta node is not used.
dene delta node size = 7 number of words in a delta node
dene delta node = 2 type eld in a delta node
823. As the algorithm runs, it maintains a set of six delta-like registers for the length of the line following
the rst active breakpoint to the current position in the given hlist. When it makes a pass through the active
list, it also maintains a similar set of six registers for the length following the active breakpoint of current
interest. A third set holds the length of an empty line (namely, the sum of \leftskip and \rightskip);
and a fourth set is used to create new delta nodes.
When we pass a delta node we want to do operations like
for k 1 to 6 do cur active width[k] cur active width[k] + mem[q + k].sc;
and we want to do this without the overhead of for loops. The do all six macro makes such six-tuples
convenient.
dene do all six (#) #(1); #(2); #(3); #(4); #(5); #(6)
Global variables 13 +
active width: array [1 . . 6] of scaled ; distance from rst active node to cur p
cur active width: array [1 . . 6] of scaled ; distance from current active node
background : array [1 . . 6] of scaled ; length of an empty line
break width: array [1 . . 6] of scaled ; length being computed after current break
306 PART 38: BREAKING PARAGRAPHS INTO LINES T
E
X82 824
824. Lets state the principles of the delta nodes more precisely and concisely, so that the following
programs will be less obscure. For each legal breakpoint p in the paragraph, we dene two quantities (p)
and (p) such that the length of material in a line from breakpoint p to breakpoint q is +(q) (p), for
some xed . Intuitively, (p) and (q) are the total length of material from the beginning of the paragraph
to a point after a break at p and to a point before a break at q; and is the width of an empty line,
namely the length contributed by \leftskip and \rightskip.
Suppose, for example, that the paragraph consists entirely of alternating boxes and glue skips; let
the boxes have widths x
1
. . . x
n
and let the skips have widths y
1
. . . y
n
, so that the paragraph can be
represented by x
1
y
1
. . . x
n
y
n
. Let p
i
be the legal breakpoint at y
i
; then (p
i
) = x
1
+ y
1
+ + x
i
+ y
i
,
and (p
i
) = x
1
+ y
1
+ + x
i
. To check this, note that the length of material from p
2
to p
5
, say, is
+ x
3
+ y
3
+ x
4
+ y
4
+ x
5
= + (p
5
) (p
2
).
The quantities , , involve glue stretchability and shrinkability as well as a natural width. If we were
to compute (p) and (p) for each p, we would need multiple precision arithmetic, and the multiprecise
numbers would have to be kept in the active nodes. T
E
X avoids this problem by working entirely with
relative dierences or deltas. Suppose, for example, that the active list contains a
1

1
a
2

2
a
3
, where the
as are active breakpoints and the s are delta nodes. Then
1
= (a
1
) (a
2
) and
2
= (a
2
) (a
3
).
If the line breaking algorithm is currently positioned at some other breakpoint p, the active width array
contains the value + (p) (a
1
). If we are scanning through the list of active nodes and considering a
tentative line that runs from a
2
to p, say, the cur active width array will contain the value +(p) (a
2
).
Thus, when we move from a
2
to a
3
, we want to add (a
2
) (a
3
) to cur active width; and this is just
2
,
which appears in the active list between a
2
and a
3
. The background array contains . The break width array
will be used to calculate values of new delta nodes when the active list is being updated.
825. Glue nodes in a horizontal list that is being paragraphed are not supposed to include innite
shrinkability; that is why the algorithm maintains four registers for stretching but only one for shrinking. If
the user tries to introduce innite shrinkability, the shrinkability will be reset to nite and an error message
will be issued. A boolean variable no shrink error yet prevents this error message from appearing more than
once per paragraph.
dene check shrinkage(#)
if (shrink order (#) ,= normal ) (shrink (#) ,= 0) then
begin # nite shrink (#);
end
Global variables 13 +
no shrink error yet : boolean; have we complained about innite shrinkage?
826. Declare subprocedures for line break 826
function nite shrink (p : pointer ): pointer ; recovers from innite shrinkage
var q: pointer ; new glue specication
begin if no shrink error yet then
begin no shrink error yet false; print err ("Infiniteglueshrinkagefoundinaparagraph");
help5 ("Theparagraphjustendedincludessomegluethathas")
("infiniteshrinkability,e.g.,`\hskip0ptminus1fil.")
("Suchgluedoesntbelongthereitallowsaparagraph")
("ofanylengthtofitononeline.Butitssafetoproceed,")
("sincetheoffensiveshrinkabilityhasbeenmadefinite."); error ;
end;
q new spec(p); shrink order (q) normal ; delete glue ref (p); nite shrink q;
end;
See also sections 829, 877, 895, and 942.
This code is used in section 815.
827 T
E
X82 PART 38: BREAKING PARAGRAPHS INTO LINES 307
827. Get ready to start line breaking 816 +
no shrink error yet true;
check shrinkage(left skip); check shrinkage(right skip);
q left skip; r right skip; background [1] width(q) + width(r);
background [2] 0; background [3] 0; background [4] 0; background [5] 0;
background [2 + stretch order (q)] stretch(q);
background [2 + stretch order (r)] background [2 + stretch order (r)] + stretch(r);
background [6] shrink (q) + shrink (r);
828. A pointer variable cur p runs through the given horizontal list as we look for breakpoints. This
variable is global, since it is used both by line break and by its subprocedure try break .
Another global variable called threshold is used to determine the feasibility of individual lines: Breakpoints
are feasible if there is a way to reach them without creating lines whose badness exceeds threshold . (The
badness is compared to threshold before penalties are added, so that penalty values do not aect the feasibility
of breakpoints, except that no break is allowed when the penalty is 10000 or more.) If threshold is 10000
or more, all legal breaks are considered feasible, since the badness function specied above never returns a
value greater than 10000.
Up to three passes might be made through the paragraph in an attempt to nd at least one set of feasible
breakpoints. On the rst pass, we have threshold = pretolerance and second pass = nal pass = false.
If this pass fails to nd a feasible solution, threshold is set to tolerance, second pass is set true, and an
attempt is made to hyphenate as many words as possible. If that fails too, we add emergency stretch to the
background stretchability and set nal pass = true.
Global variables 13 +
cur p: pointer ; the current breakpoint under consideration
second pass : boolean; is this our second attempt to break this paragraph?
nal pass : boolean; is this our nal attempt to break this paragraph?
threshold : integer ; maximum badness on feasible lines
308 PART 38: BREAKING PARAGRAPHS INTO LINES T
E
X82 829
829. The heart of the line-breaking procedure is try break , a subroutine that tests if the current breakpoint
cur p is feasible, by running through the active list to see what lines of text can be made from active nodes
to cur p. If feasible breaks are possible, new break nodes are created. If cur p is too far from an active
node, that node is deactivated.
The parameter pi to try break is the penalty associated with a break at cur p; we have pi = eject penalty
if the break is forced, and pi = inf penalty if the break is illegal.
The other parameter, break type, is set to hyphenated or unhyphenated , depending on whether or not
the current break is at a disc node. The end of a paragraph is also regarded as hyphenated ; this case is
distinguishable by the condition cur p = null .
dene copy to cur active(#) cur active width[#] active width[#]
dene deactivate = 60 go here when node r should be deactivated
Declare subprocedures for line break 826 +
procedure try break (pi : integer ; break type : small number );
label exit , done, done1 , continue, deactivate;
var r: pointer ; runs through the active list
prev r : pointer ; stays a step behind r
old l : halfword ; maximum line number in current equivalence class of lines
no break yet : boolean; have we found a feasible break at cur p?
Other local variables for try break 830
begin Make sure that pi is in the proper range 831 ;
no break yet true; prev r active; old l 0; do all six (copy to cur active);
loop begin continue: r link (prev r ); If node r is of type delta node, update cur active width, set
prev r and prev prev r , then goto continue 832 ;
If a line number class has ended, create new active nodes for the best feasible breaks in that class;
then return if r = last active, otherwise compute the new line width 835 ;
Consider the demerits for a line from r to cur p; deactivate node r if it should no longer be active;
then goto continue if a line from r to cur p is infeasible, otherwise record a new feasible
break 851 ;
end;
exit : stat Update the value of printed node for symbolic displays 858 tats
end;
830. Other local variables for try break 830
prev prev r : pointer ; a step behind prev r , if type(prev r ) = delta node
s: pointer ; runs through nodes ahead of cur p
q: pointer ; points to a new node being created
v: pointer ; points to a glue specication or a node ahead of cur p
t: integer ; node count, if cur p is a discretionary node
f: internal font number ; used in character width calculation
l: halfword ; line number of current active node
node r stays active: boolean; should node r remain in the active list?
line width: scaled ; the current line will be justied to this width
t class : very loose t . . tight t ; possible tness class of test line
b: halfword ; badness of test line
d: integer ; demerits of test line
articial demerits : boolean; has d been forced to zero?
save link : pointer ; temporarily holds value of link (cur p)
shortfall : scaled ; used in badness calculations
This code is used in section 829.
831 T
E
X82 PART 38: BREAKING PARAGRAPHS INTO LINES 309
831. Make sure that pi is in the proper range 831
if abs (pi ) inf penalty then
if pi > 0 then return this breakpoint is inhibited by innite penalty
else pi eject penalty this breakpoint will be forced
This code is used in section 829.
832. The following code uses the fact that type(last active) ,= delta node.
dene update width(#) cur active width[#] cur active width[#] + mem[r + #].sc
If node r is of type delta node, update cur active width, set prev r and prev prev r , then goto
continue 832
if type(r) = delta node then
begin do all six (update width); prev prev r prev r ; prev r r; goto continue;
end
This code is used in section 829.
833. As we consider various ways to end a line at cur p, in a given line number class, we keep track of the
best total demerits known, in an array with one entry for each of the tness classications. For example,
minimal demerits [tight t ] contains the fewest total demerits of feasible line breaks ending at cur p with
a tight t line; best place[tight t ] points to the passive node for the break before cur p that achieves
such an optimum; and best pl line[tight t ] is the line number eld in the active node corresponding to
best place[tight t ]. When no feasible break sequence is known, the minimal demerits entries will be equal
to awful bad , which is 2
30
1. Another variable, minimum demerits , keeps track of the smallest value in
the minimal demerits array.
dene awful bad 7777777777 more than a billion demerits
Global variables 13 +
minimal demerits : array [very loose t . . tight t ] of integer ;
best total demerits known for current line class and position, given the tness
minimum demerits : integer ; best total demerits known for current line class and position
best place: array [very loose t . . tight t ] of pointer ; how to achieve minimal demerits
best pl line: array [very loose t . . tight t ] of halfword ; corresponding line number
834. Get ready to start line breaking 816 +
minimum demerits awful bad ; minimal demerits [tight t ] awful bad ;
minimal demerits [decent t ] awful bad ; minimal demerits [loose t ] awful bad ;
minimal demerits [very loose t ] awful bad ;
835. The rst part of the following code is part of T
E
Xs inner loop, so we dont want to waste any time.
The current active node, namely node r, contains the line number that will be considered next. At the end
of the list we have arranged the data structure so that r = last active and line number (last active) > old l .
If a line number class has ended, create new active nodes for the best feasible breaks in that class; then
return if r = last active, otherwise compute the new line width 835
begin l line number (r);
if l > old l then
begin now we are no longer in the inner loop
if (minimum demerits < awful bad ) ((old l ,= easy line) (r = last active)) then
Create new active nodes for the best feasible breaks just found 836 ;
if r = last active then return;
Compute the new line width 850 ;
end;
end
This code is used in section 829.
310 PART 38: BREAKING PARAGRAPHS INTO LINES T
E
X82 836
836. It is not necessary to create new active nodes having minimal demerits greater than minimum demerits +
abs (adj demerits ), since such active nodes will never be chosen in the nal paragraph breaks. This observa-
tion allows us to omit a substantial number of feasible breakpoints from further consideration.
Create new active nodes for the best feasible breaks just found 836
begin if no break yet then Compute the values of break width 837 ;
Insert a delta node to prepare for breaks at cur p 843 ;
if abs (adj demerits ) awful bad minimum demerits then minimum demerits awful bad 1
else minimum demerits minimum demerits + abs (adj demerits );
for t class very loose t to tight t do
begin if minimal demerits [t class ] minimum demerits then
Insert a new active node from best place[t class ] to cur p 845 ;
minimal demerits [t class ] awful bad ;
end;
minimum demerits awful bad ; Insert a delta node to prepare for the next active node 844 ;
end
This code is used in section 835.
837. When we insert a new active node for a break at cur p, suppose this new node is to be placed just
before active node a; then we essentially want to insert cur p

before a, where = (a) (cur p) and

= (cur p) (a) in the notation explained above. The cur active width array now holds +(cur p)
(a); so can be obtained by subtracting cur active width from the quantity +(cur p) (cur p). The
latter quantity can be regarded as the length of a line from cur p to cur p; we call it the break width at
cur p.
The break width is usually negative, since it consists of the background (which is normally zero) minus the
width of nodes following cur p that are eliminated after a break. If, for example, node cur p is a glue node,
the width of this glue is subtracted from the background; and we also look ahead to eliminate all subsequent
glue and penalty and kern and math nodes, subtracting their widths as well.
Kern nodes do not disappear at a line break unless they are explicit .
dene set break width to background (#) break width[#] background [#]
Compute the values of break width 837
begin no break yet false; do all six (set break width to background ); s cur p;
if break type > unhyphenated then
if cur p ,= null then Compute the discretionary break width values 840 ;
while s ,= null do
begin if is char node(s) then goto done;
case type(s) of
glue node: Subtract glue from break width 838 ;
penalty node: do nothing ;
math node: break width[1] break width[1] width(s);
kern node: if subtype(s) ,= explicit then goto done
else break width[1] break width[1] width(s);
othercases goto done
endcases;
s link (s);
end;
done: end
This code is used in section 836.
838 T
E
X82 PART 38: BREAKING PARAGRAPHS INTO LINES 311
838. Subtract glue from break width 838
begin v glue ptr (s); break width[1] break width[1] width(v);
break width[2 + stretch order (v)] break width[2 + stretch order (v)] stretch(v);
break width[6] break width[6] shrink (v);
end
This code is used in section 837.
839. When cur p is a discretionary break, the length of a line from cur p to cur p has to be dened
properly so that the other calculations work out. Suppose that the pre-break text at cur p has length l
0
,
the post-break text has length l
1
, and the replacement text has length l. Suppose also that q is the node
following the replacement text. Then length of a line from cur p to q will be computed as +(q)(cur p),
where (q) = (cur p) l
0
+ l. The actual length will be the background plus l
1
, so the length from cur p
to cur p should be + l
0
+ l
1
l. If the post-break text of the discretionary is empty, a break may also
discard q; in that unusual case we subtract the length of q and any other nodes that will be discarded after
the discretionary break.
The value of l
0
need not be computed, since line break will put it into the global variable disc width before
calling try break .
Global variables 13 +
disc width: scaled ; the length of discretionary material preceding a break
840. Compute the discretionary break width values 840
begin t replace count (cur p); v cur p; s post break (cur p);
while t > 0 do
begin decr (t); v link (v); Subtract the width of node v from break width 841 ;
end;
while s ,= null do
begin Add the width of node s to break width 842 ;
s link (s);
end;
break width[1] break width[1] + disc width;
if post break (cur p) = null then s link (v); nodes may be discardable after the break
end
This code is used in section 837.
841. Replacement texts and discretionary texts are supposed to contain only character nodes, kern nodes,
ligature nodes, and box or rule nodes.
Subtract the width of node v from break width 841
if is char node(v) then
begin f font (v); break width[1] break width[1] char width(f)(char info(f)(character (v)));
end
else case type(v) of
ligature node: begin f font (lig char (v));
break width[1] break width[1] char width(f)(char info(f)(character (lig char (v))));
end;
hlist node, vlist node, rule node, kern node: break width[1] break width[1] width(v);
othercases confusion("disc1")
endcases
This code is used in section 840.
312 PART 38: BREAKING PARAGRAPHS INTO LINES T
E
X82 842
842. Add the width of node s to break width 842
if is char node(s) then
begin f font (s); break width[1] break width[1] + char width(f)(char info(f)(character (s)));
end
else case type(s) of
ligature node: begin f font (lig char (s));
break width[1] break width[1] + char width(f)(char info(f)(character (lig char (s))));
end;
hlist node, vlist node, rule node, kern node: break width[1] break width[1] + width(s);
othercases confusion("disc2")
endcases
This code is used in section 840.
843. We use the fact that type(active) ,= delta node.
dene convert to break width(#) mem[prev r + #].sc
mem[prev r + #].sc cur active width[#] + break width[#]
dene store break width(#) active width[#] break width[#]
dene new delta to break width(#) mem[q + #].sc break width[#] cur active width[#]
Insert a delta node to prepare for breaks at cur p 843
if type(prev r ) = delta node then modify an existing delta node
begin do all six (convert to break width);
end
else if prev r = active then no delta node needed at the beginning
begin do all six (store break width);
end
else begin q get node(delta node size); link (q) r; type(q) delta node;
subtype(q) 0; the subtype is not used
do all six (new delta to break width); link (prev r ) q; prev prev r prev r ; prev r q;
end
This code is used in section 836.
844. When the following code is performed, we will have just inserted at least one active node before r,
so type(prev r ) ,= delta node.
dene new delta from break width(#) mem[q + #].sc cur active width[#] break width[#]
Insert a delta node to prepare for the next active node 844
if r ,= last active then
begin q get node(delta node size); link (q) r; type(q) delta node;
subtype(q) 0; the subtype is not used
do all six (new delta from break width); link (prev r ) q; prev prev r prev r ; prev r q;
end
This code is used in section 836.
845 T
E
X82 PART 38: BREAKING PARAGRAPHS INTO LINES 313
845. When we create an active node, we also create the corresponding passive node.
Insert a new active node from best place[t class ] to cur p 845
begin q get node(passive node size); link (q) passive; passive q; cur break (q) cur p;
stat incr (pass number ); serial (q) pass number ; tats
prev break (q) best place[t class ];
q get node(active node size); break node(q) passive; line number (q) best pl line[t class ] + 1;
tness (q) t class ; type(q) break type; total demerits (q) minimal demerits [t class ];
link (q) r; link (prev r ) q; prev r q;
stat if tracing paragraphs > 0 then Print a symbolic description of the new break node 846 ;
tats
end
This code is used in section 836.
846. Print a symbolic description of the new break node 846
begin print nl ("@@"); print int (serial (passive)); print (":line"); print int (line number (q) 1);
print char ("."); print int (t class );
if break type = hyphenated then print char ("");
print ("t="); print int (total demerits (q)); print (">@@");
if prev break (passive) = null then print char ("0")
else print int (serial (prev break (passive)));
end
This code is used in section 845.
847. The length of lines depends on whether the user has specied \parshape or \hangindent. If
par shape ptr is not null, it points to a (2n + 1)-word record in mem, where the info in the rst word
contains the value of n, and the other 2n words contain the left margins and line lengths for the rst n lines
of the paragraph; the specications for line n apply to all subsequent lines. If par shape ptr = null , the
shape of the paragraph depends on the value of n = hang after ; if n 0, hanging indentation takes place
on lines n + 1, n + 2, . . . , otherwise it takes place on lines 1, . . . , [n[. When hanging indentation is active,
the left margin is hang indent , if hang indent 0, else it is 0; the line length is hsize [hang indent [. The
normal setting is par shape ptr = null , hang after = 1, and hang indent = 0. Note that if hang indent = 0,
the value of hang after is irrelevant.
Global variables 13 +
easy line: halfword ; line numbers > easy line are equivalent in break nodes
last special line: halfword ; line numbers > last special line all have the same width
rst width: scaled ; the width of all lines last special line, if no \parshape has been specied
second width: scaled ; the width of all lines > last special line
rst indent : scaled ; left margin to go with rst width
second indent : scaled ; left margin to go with second width
314 PART 38: BREAKING PARAGRAPHS INTO LINES T
E
X82 848
848. We compute the values of easy line and the other local variables relating to line length when the
line break procedure is initializing itself.
Get ready to start line breaking 816 +
if par shape ptr = null then
if hang indent = 0 then
begin last special line 0; second width hsize; second indent 0;
end
else Set line length parameters in preparation for hanging indentation 849
else begin last special line info(par shape ptr ) 1;
second width mem[par shape ptr + 2 (last special line + 1)].sc;
second indent mem[par shape ptr + 2 last special line + 1].sc;
end;
if looseness = 0 then easy line last special line
else easy line max halfword
849. Set line length parameters in preparation for hanging indentation 849
begin last special line abs (hang after );
if hang after < 0 then
begin rst width hsize abs (hang indent );
if hang indent 0 then rst indent hang indent
else rst indent 0;
second width hsize; second indent 0;
end
else begin rst width hsize; rst indent 0; second width hsize abs (hang indent );
if hang indent 0 then second indent hang indent
else second indent 0;
end;
end
This code is used in section 848.
850. When we come to the following code, we have just encountered the rst active node r whose
line number eld contains l. Thus we want to compute the length of the lth line of the current paragraph.
Furthermore, we want to set old l to the last number in the class of line numbers equivalent to l.
Compute the new line width 850
if l > easy line then
begin line width second width; old l max halfword 1;
end
else begin old l l;
if l > last special line then line width second width
else if par shape ptr = null then line width rst width
else line width mem[par shape ptr + 2 l ].sc;
end
This code is used in section 835.
851 T
E
X82 PART 38: BREAKING PARAGRAPHS INTO LINES 315
851. The remaining part of try break deals with the calculation of demerits for a break from r to cur p.
The rst thing to do is calculate the badness, b. This value will always be between zero and inf bad + 1;
the latter value occurs only in the case of lines from r to cur p that cannot shrink enough to t the necessary
width. In such cases, node r will be deactivated. We also deactivate node r when a break at cur p is forced,
since future breaks must go through a forced break.
Consider the demerits for a line from r to cur p; deactivate node r if it should no longer be active; then
goto continue if a line from r to cur p is infeasible, otherwise record a new feasible break 851
begin articial demerits false;
shortfall line width cur active width[1]; were this much too short
if shortfall > 0 then
Set the value of b to the badness for stretching the line, and compute the corresponding t class 852
else Set the value of b to the badness for shrinking the line, and compute the corresponding t class 853 ;
if (b > inf bad ) (pi = eject penalty) then Prepare to deactivate node r, and goto deactivate unless
there is a reason to consider lines of text from r to cur p 854
else begin prev r r;
if b > threshold then goto continue;
node r stays active true;
end;
Record a new feasible break 855 ;
if node r stays active then goto continue; prev r has been set to r
deactivate: Deactivate node r 860 ;
end
This code is used in section 829.
852. When a line must stretch, the available stretchability can be found in the subarray cur active width[2 . .
5], in units of points, l, ll, and lll.
The present section is part of T
E
Xs inner loop, and it is most often performed when the badness is innite;
therefore it is worth while to make a quick test for large width excess and small stretchability, before calling
the badness subroutine.
Set the value of b to the badness for stretching the line, and compute the corresponding t class 852
if (cur active width[3] ,= 0) (cur active width[4] ,= 0) (cur active width[5] ,= 0) then
begin b 0; t class decent t ; innite stretch
end
else begin if shortfall > 7230584 then
if cur active width[2] < 1663497 then
begin b inf bad ; t class very loose t ; goto done1 ;
end;
b badness (shortfall , cur active width[2]);
if b > 12 then
if b > 99 then t class very loose t
else t class loose t
else t class decent t ;
done1 : end
This code is used in section 851.
316 PART 38: BREAKING PARAGRAPHS INTO LINES T
E
X82 853
853. Shrinkability is never innite in a paragraph; we can shrink the line from r to cur p by at most
cur active width[6].
Set the value of b to the badness for shrinking the line, and compute the corresponding t class 853
begin if shortfall > cur active width[6] then b inf bad + 1
else b badness (shortfall , cur active width[6]);
if b > 12 then t class tight t else t class decent t ;
end
This code is used in section 851.
854. During the nal pass, we dare not lose all active nodes, lest we lose touch with the line breaks already
found. The code shown here makes sure that such a catastrophe does not happen, by permitting overfull
boxes as a last resort. This particular part of T
E
X was a source of several subtle bugs before the correct
program logic was nally discovered; readers who seek to improve T
E
X should therefore think thrice before
daring to make any changes here.
Prepare to deactivate node r, and goto deactivate unless there is a reason to consider lines of text from r
to cur p 854
begin if nal pass (minimum demerits = awful bad ) (link (r) = last active) (prev r = active) then
articial demerits true set demerits zero, this break is forced
else if b > threshold then goto deactivate;
node r stays active false;
end
This code is used in section 851.
855. When we get to this part of the code, the line from r to cur p is feasible, its badness is b, and
its tness classication is t class . We dont want to make an active node for this break yet, but we will
compute the total demerits and record them in the minimal demerits array, if such a break is the current
champion among all ways to get to cur p in a given line-number class and tness class.
Record a new feasible break 855
if articial demerits then d 0
else Compute the demerits, d, from r to cur p 859 ;
stat if tracing paragraphs > 0 then Print a symbolic description of this feasible break 856 ;
tats
d d + total demerits (r); this is the minimum total demerits from the beginning to cur p via r
if d minimal demerits [t class ] then
begin minimal demerits [t class ] d; best place[t class ] break node(r); best pl line[t class ] l;
if d < minimum demerits then minimum demerits d;
end
This code is used in section 851.
856 T
E
X82 PART 38: BREAKING PARAGRAPHS INTO LINES 317
856. Print a symbolic description of this feasible break 856
begin if printed node ,= cur p then
Print the list between printed node and cur p, then set printed node cur p 857 ;
print nl ("@");
if cur p = null then print esc("par")
else if type(cur p) ,= glue node then
begin if type(cur p) = penalty node then print esc("penalty")
else if type(cur p) = disc node then print esc("discretionary")
else if type(cur p) = kern node then print esc("kern")
else print esc("math");
end;
print ("via@@");
if break node(r) = null then print char ("0")
else print int (serial (break node(r)));
print ("b=");
if b > inf bad then print char ("*") else print int (b);
print ("p="); print int (pi ); print ("d=");
if articial demerits then print char ("*") else print int (d);
end
This code is used in section 855.
857. Print the list between printed node and cur p, then set printed node cur p 857
begin print nl ("");
if cur p = null then short display(link (printed node))
else begin save link link (cur p); link (cur p) null ; print nl ("");
short display(link (printed node)); link (cur p) save link ;
end;
printed node cur p;
end
This code is used in section 856.
858. When the data for a discretionary break is being displayed, we will have printed the pre break and
post break lists; we want to skip over the third list, so that the discretionary data will not appear twice. The
following code is performed at the very end of try break .
Update the value of printed node for symbolic displays 858
if cur p = printed node then
if cur p ,= null then
if type(cur p) = disc node then
begin t replace count (cur p);
while t > 0 do
begin decr (t); printed node link (printed node);
end;
end
This code is used in section 829.
318 PART 38: BREAKING PARAGRAPHS INTO LINES T
E
X82 859
859. Compute the demerits, d, from r to cur p 859
begin d line penalty + b;
if abs (d) 10000 then d 100000000 else d d d;
if pi ,= 0 then
if pi > 0 then d d + pi pi
else if pi > eject penalty then d d pi pi ;
if (break type = hyphenated ) (type(r) = hyphenated ) then
if cur p ,= null then d d + double hyphen demerits
else d d + nal hyphen demerits ;
if abs (t class tness (r)) > 1 then d d + adj demerits ;
end
This code is used in section 855.
860. When an active node disappears, we must delete an adjacent delta node if the active node was at the
beginning or the end of the active list, or if it was surrounded by delta nodes. We also must preserve the
property that cur active width represents the length of material from link (prev r ) to cur p.
dene combine two deltas (#) mem[prev r + #].sc mem[prev r + #].sc + mem[r + #].sc
dene downdate width(#) cur active width[#] cur active width[#] mem[prev r + #].sc
Deactivate node r 860
link (prev r ) link (r); free node(r, active node size);
if prev r = active then Update the active widths, since the rst active node has been deleted 861
else if type(prev r ) = delta node then
begin r link (prev r );
if r = last active then
begin do all six (downdate width); link (prev prev r ) last active;
free node(prev r , delta node size); prev r prev prev r ;
end
else if type(r) = delta node then
begin do all six (update width); do all six (combine two deltas ); link (prev r ) link (r);
free node(r, delta node size);
end;
end
This code is used in section 851.
861. The following code uses the fact that type(last active) ,= delta node. If the active list has just become
empty, we do not need to update the active width array, since it will be initialized when an active node is
next inserted.
dene update active(#) active width[#] active width[#] + mem[r + #].sc
Update the active widths, since the rst active node has been deleted 861
begin r link (active);
if type(r) = delta node then
begin do all six (update active); do all six (copy to cur active); link (active) link (r);
free node(r, delta node size);
end;
end
This code is used in section 860.
862 T
E
X82 PART 39: BREAKING PARAGRAPHS INTO LINES, CONTINUED 319
862. Breaking paragraphs into lines, continued. So far we have gotten a little way into the
line break routine, having covered its important try break subroutine. Now lets consider the rest of the
process.
The main loop of line break traverses the given hlist, starting at link (temp head ), and calls try break at
each legal breakpoint. A variable called auto breaking is set to true except within math formulas, since glue
nodes are not legal breakpoints when they appear in formulas.
The current node of interest in the hlist is pointed to by cur p. Another variable, prev p, is usually one
step behind cur p, but the real meaning of prev p is this: If type(cur p) = glue node then cur p is a legal
breakpoint if and only if auto breaking is true and prev p does not point to a glue node, penalty node,
explicit kern node, or math node.
The following declarations provide for a few other local variables that are used in special calculations.
Local variables for line breaking 862
auto breaking : boolean; is node cur p outside a formula?
prev p: pointer ; helps to determine when glue nodes are breakpoints
q, r, s, prev s : pointer ; miscellaneous nodes of temporary interest
f: internal font number ; used when calculating character widths
See also section 893.
This code is used in section 815.
320 PART 39: BREAKING PARAGRAPHS INTO LINES, CONTINUED T
E
X82 863
863. The loop in the following code is performed at most thrice per call of line break , since it is actually
a pass over the entire paragraph.
Find optimal breakpoints 863
threshold pretolerance;
if threshold 0 then
begin stat if tracing paragraphs > 0 then
begin begin diagnostic; print nl ("@firstpass"); end; tats
second pass false; nal pass false;
end
else begin threshold tolerance; second pass true; nal pass (emergency stretch 0);
stat if tracing paragraphs > 0 then begin diagnostic;
tats
end;
loop begin if threshold > inf bad then threshold inf bad ;
if second pass then Initialize for hyphenating a paragraph 891 ;
Create an active breakpoint representing the beginning of the paragraph 864 ;
cur p link (temp head ); auto breaking true;
prev p cur p; glue at beginning is not a legal breakpoint
while (cur p ,= null ) (link (active) ,= last active) do Call try break if cur p is a legal breakpoint;
on the second pass, also try to hyphenate the next word, if cur p is a glue node; then advance
cur p to the next node of the paragraph that could possibly be a legal breakpoint 866 ;
if cur p = null then Try the nal line break at the end of the paragraph, and goto done if the
desired breakpoints have been found 873 ;
Clean up the memory by removing the break nodes 865 ;
if second pass then
begin stat if tracing paragraphs > 0 then print nl ("@secondpass"); tats
threshold tolerance; second pass true; nal pass (emergency stretch 0);
end if at rst you dont succeed, . . .
else begin stat if tracing paragraphs > 0 then print nl ("@emergencypass"); tats
background [2] background [2] + emergency stretch; nal pass true;
end;
end;
done: stat if tracing paragraphs > 0 then
begin end diagnostic(true); normalize selector ;
end;
tats
This code is used in section 815.
864. The active node that represents the starting point does not need a corresponding passive node.
dene store background (#) active width[#] background [#]
Create an active breakpoint representing the beginning of the paragraph 864
q get node(active node size); type(q) unhyphenated ; tness (q) decent t ; link (q) last active;
break node(q) null ; line number (q) prev graf + 1; total demerits (q) 0; link (active) q;
do all six (store background );
passive null ; printed node temp head ; pass number 0; font in short display null font
This code is used in section 863.
865 T
E
X82 PART 39: BREAKING PARAGRAPHS INTO LINES, CONTINUED 321
865. Clean up the memory by removing the break nodes 865
q link (active);
while q ,= last active do
begin cur p link (q);
if type(q) = delta node then free node(q, delta node size)
else free node(q, active node size);
q cur p;
end;
q passive;
while q ,= null do
begin cur p link (q); free node(q, passive node size); q cur p;
end
This code is used in sections 815 and 863.
866. Here is the main switch in the line break routine, where legal breaks are determined. As we move
through the hlist, we need to keep the active width array up to date, so that the badness of individual lines
is readily calculated by try break . It is convenient to use the short name act width for the component of
active width that represents real width as opposed to glue.
dene act width active width[1] length from rst active node to current node
dene kern break
begin if is char node(link (cur p)) auto breaking then
if type(link (cur p)) = glue node then try break (0, unhyphenated );
act width act width + width(cur p);
end
Call try break if cur p is a legal breakpoint; on the second pass, also try to hyphenate the next word, if
cur p is a glue node; then advance cur p to the next node of the paragraph that could possibly be a
legal breakpoint 866
begin if is char node(cur p) then
Advance cur p to the node following the present string of characters 867 ;
case type(cur p) of
hlist node, vlist node, rule node: act width act width + width(cur p);
whatsit node: Advance past a whatsit node in the line break loop 1362 ;
glue node: begin If node cur p is a legal breakpoint, call try break ; then update the active widths by
including the glue in glue ptr (cur p) 868 ;
if second pass auto breaking then Try to hyphenate the following word 894 ;
end;
kern node: if subtype(cur p) = explicit then kern break
else act width act width + width(cur p);
ligature node: begin f font (lig char (cur p));
act width act width + char width(f)(char info(f)(character (lig char (cur p))));
end;
disc node: Try to break after a discretionary fragment, then goto done5 869 ;
math node: begin auto breaking (subtype(cur p) = after ); kern break ;
end;
penalty node: try break (penalty(cur p), unhyphenated );
mark node, ins node, adjust node: do nothing ;
othercases confusion("paragraph")
endcases;
prev p cur p; cur p link (cur p);
done5 : end
This code is used in section 863.
322 PART 39: BREAKING PARAGRAPHS INTO LINES, CONTINUED T
E
X82 867
867. The code that passes over the characters of words in a paragraph is part of T
E
Xs inner loop, so it has
been streamlined for speed. We use the fact that \parfillskip glue appears at the end of each paragraph;
it is therefore unnecessary to check if link (cur p) = null when cur p is a character node.
Advance cur p to the node following the present string of characters 867
begin prev p cur p;
repeat f font (cur p); act width act width + char width(f)(char info(f)(character (cur p)));
cur p link (cur p);
until is char node(cur p);
end
This code is used in section 866.
868. When node cur p is a glue node, we look at prev p to see whether or not a breakpoint is legal at
cur p, as explained above.
If node cur p is a legal breakpoint, call try break ; then update the active widths by including the glue in
glue ptr (cur p) 868
if auto breaking then
begin if is char node(prev p) then try break (0, unhyphenated )
else if precedes break (prev p) then try break (0, unhyphenated )
else if (type(prev p) = kern node) (subtype(prev p) ,= explicit ) then try break (0, unhyphenated );
end;
check shrinkage(glue ptr (cur p)); q glue ptr (cur p); act width act width + width(q);
active width[2 + stretch order (q)] active width[2 + stretch order (q)] + stretch(q);
active width[6] active width[6] + shrink (q)
This code is used in section 866.
869. The following code knows that discretionary texts contain only character nodes, kern nodes, box
nodes, rule nodes, and ligature nodes.
Try to break after a discretionary fragment, then goto done5 869
begin s pre break (cur p); disc width 0;
if s = null then try break (ex hyphen penalty, hyphenated )
else begin repeat Add the width of node s to disc width 870 ;
s link (s);
until s = null ;
act width act width + disc width; try break (hyphen penalty, hyphenated );
act width act width disc width;
end;
r replace count (cur p); s link (cur p);
while r > 0 do
begin Add the width of node s to act width 871 ;
decr (r); s link (s);
end;
prev p cur p; cur p s; goto done5 ;
end
This code is used in section 866.
870 T
E
X82 PART 39: BREAKING PARAGRAPHS INTO LINES, CONTINUED 323
870. Add the width of node s to disc width 870
if is char node(s) then
begin f font (s); disc width disc width + char width(f)(char info(f)(character (s)));
end
else case type(s) of
ligature node: begin f font (lig char (s));
disc width disc width + char width(f)(char info(f)(character (lig char (s))));
end;
hlist node, vlist node, rule node, kern node: disc width disc width + width(s);
othercases confusion("disc3")
endcases
This code is used in section 869.
871. Add the width of node s to act width 871
if is char node(s) then
begin f font (s); act width act width + char width(f)(char info(f)(character (s)));
end
else case type(s) of
ligature node: begin f font (lig char (s));
act width act width + char width(f)(char info(f)(character (lig char (s))));
end;
hlist node, vlist node, rule node, kern node: act width act width + width(s);
othercases confusion("disc4")
endcases
This code is used in section 869.
872. The forced line break at the paragraphs end will reduce the list of breakpoints so that all active
nodes represent breaks at cur p = null . On the rst pass, we insist on nding an active node that has the
correct looseness. On the nal pass, there will be at least one active node, and we will match the desired
looseness as well as we can.
The global variable best bet will be set to the active node for the best way to break the paragraph, and a
few other variables are used to help determine what is best.
Global variables 13 +
best bet : pointer ; use this passive node and its predecessors
fewest demerits : integer ; the demerits associated with best bet
best line: halfword ; line number following the last line of the new paragraph
actual looseness : integer ; the dierence between line number (best bet ) and the optimum best line
line di : integer ; the dierence between the current line number and the optimum best line
873. Try the nal line break at the end of the paragraph, and goto done if the desired breakpoints have
been found 873
begin try break (eject penalty, hyphenated );
if link (active) ,= last active then
begin Find an active node with fewest demerits 874 ;
if looseness = 0 then goto done;
Find the best active node for the desired looseness 875 ;
if (actual looseness = looseness ) nal pass then goto done;
end;
end
This code is used in section 863.
324 PART 39: BREAKING PARAGRAPHS INTO LINES, CONTINUED T
E
X82 874
874. Find an active node with fewest demerits 874
r link (active); fewest demerits awful bad ;
repeat if type(r) ,= delta node then
if total demerits (r) < fewest demerits then
begin fewest demerits total demerits (r); best bet r;
end;
r link (r);
until r = last active;
best line line number (best bet )
This code is used in section 873.
875. The adjustment for a desired looseness is a slightly more complicated version of the loop just
considered. Note that if a paragraph is broken into segments by displayed equations, each segment will
be subject to the looseness calculation, independently of the other segments.
Find the best active node for the desired looseness 875
begin r link (active); actual looseness 0;
repeat if type(r) ,= delta node then
begin line di line number (r) best line;
if ((line di < actual looseness ) (looseness line di ))
((line di > actual looseness ) (looseness line di )) then
begin best bet r; actual looseness line di ; fewest demerits total demerits (r);
end
else if (line di = actual looseness ) (total demerits (r) < fewest demerits ) then
begin best bet r; fewest demerits total demerits (r);
end;
end;
r link (r);
until r = last active;
best line line number (best bet );
end
This code is used in section 873.
876. Once the best sequence of breakpoints has been found (hurray), we call on the procedure post line break
to nish the remainder of the work. (By introducing this subprocedure, we are able to keep line break from
getting extremely long.)
Break the paragraph at the chosen breakpoints, justify the resulting lines to the correct widths, and
append them to the current vertical list 876
post line break (nal widow penalty)
This code is used in section 815.
877 T
E
X82 PART 39: BREAKING PARAGRAPHS INTO LINES, CONTINUED 325
877. The total number of lines that will be set by post line break is best line prev graf 1. The last
breakpoint is specied by break node(best bet ), and this passive node points to the other breakpoints via
the prev break links. The nishing-up phase starts by linking the relevant passive nodes in forward order,
changing prev break to next break . (The next break elds actually reside in the same memory space as the
prev break elds did, but we give them a new name because of their new signicance.) Then the lines are
justied, one by one.
dene next break prev break new name for prev break after links are reversed
Declare subprocedures for line break 826 +
procedure post line break (nal widow penalty : integer );
label done, done1 ;
var q, r, s: pointer ; temporary registers for list manipulation
disc break : boolean; was the current break at a discretionary node?
post disc break : boolean; and did it have a nonempty post-break part?
cur width: scaled ; width of line number cur line
cur indent : scaled ; left margin of line number cur line
t: quarterword ; used for replacement counts in discretionary nodes
pen: integer ; use when calculating penalties between lines
cur line: halfword ; the current line number being justied
begin Reverse the links of the relevant passive nodes, setting cur p to the rst breakpoint 878 ;
cur line prev graf + 1;
repeat Justify the line ending at breakpoint cur p, and append it to the current vertical list, together
with associated penalties and other insertions 880 ;
incr (cur line); cur p next break (cur p);
if cur p ,= null then
if post disc break then Prune unwanted nodes at the beginning of the next line 879 ;
until cur p = null ;
if (cur line ,= best line) (link (temp head ) ,= null ) then confusion("linebreaking");
prev graf best line 1;
end;
878. The job of reversing links in a list is conveniently regarded as the job of taking items o one stack
and putting them on another. In this case we take them o a stack pointed to by q and having prev break
elds; we put them on a stack pointed to by cur p and having next break elds. Node r is the passive node
being moved from stack to stack.
Reverse the links of the relevant passive nodes, setting cur p to the rst breakpoint 878
q break node(best bet ); cur p null ;
repeat r q; q prev break (q); next break (r) cur p; cur p r;
until q = null
This code is used in section 877.
326 PART 39: BREAKING PARAGRAPHS INTO LINES, CONTINUED T
E
X82 879
879. Glue and penalty and kern and math nodes are deleted at the beginning of a line, except in the
anomalous case that the node to be deleted is actually one of the chosen breakpoints. Otherwise the pruning
done here is designed to match the lookahead computation in try break , where the break width values are
computed for non-discretionary breakpoints.
Prune unwanted nodes at the beginning of the next line 879
begin r temp head ;
loop begin q link (r);
if q = cur break (cur p) then goto done1 ; cur break (cur p) is the next breakpoint
now q cannot be null
if is char node(q) then goto done1 ;
if non discardable(q) then goto done1 ;
if type(q) = kern node then
if subtype(q) ,= explicit then goto done1 ;
r q; now type(q) = glue node, kern node, math node or penalty node
end;
done1 : if r ,= temp head then
begin link (r) null ; ush node list (link (temp head )); link (temp head ) q;
end;
end
This code is used in section 877.
880. The current line to be justied appears in a horizontal list starting at link (temp head ) and ending at
cur break (cur p). If cur break (cur p) is a glue node, we reset the glue to equal the right skip glue; otherwise
we append the right skip glue at the right. If cur break (cur p) is a discretionary node, we modify the list so
that the discretionary break is compulsory, and we set disc break to true. We also append the left skip glue
at the left of the line, unless it is zero.
Justify the line ending at breakpoint cur p, and append it to the current vertical list, together with
associated penalties and other insertions 880
Modify the end of the line to reect the nature of the break and to include \rightskip; also set the
proper value of disc break 881 ;
Put the \leftskip glue at the left and detach this line 887 ;
Call the packaging subroutine, setting just box to the justied box 889 ;
Append the new box to the current vertical list, followed by the list of special nodes taken out of the
box by the packager 888 ;
Append a penalty node, if a nonzero penalty is appropriate 890
This code is used in section 877.
881 T
E
X82 PART 39: BREAKING PARAGRAPHS INTO LINES, CONTINUED 327
881. At the end of the following code, q will point to the nal node on the list about to be justied.
Modify the end of the line to reect the nature of the break and to include \rightskip; also set the
proper value of disc break 881
q cur break (cur p); disc break false; post disc break false;
if q ,= null then q cannot be a char node
if type(q) = glue node then
begin delete glue ref (glue ptr (q)); glue ptr (q) right skip; subtype(q) right skip code + 1;
add glue ref (right skip); goto done;
end
else begin if type(q) = disc node then
Change discretionary to compulsory and set disc break true 882
else if (type(q) = math node) (type(q) = kern node) then width(q) 0;
end
else begin q temp head ;
while link (q) ,= null do q link (q);
end;
Put the \rightskip glue after node q 886 ;
done:
This code is used in section 880.
882. Change discretionary to compulsory and set disc break true 882
begin t replace count (q);
Destroy the t nodes following q, and make r point to the following node 883 ;
if post break (q) ,= null then Transplant the post-break list 884 ;
if pre break (q) ,= null then Transplant the pre-break list 885 ;
link (q) r; disc break true;
end
This code is used in section 881.
883. Destroy the t nodes following q, and make r point to the following node 883
if t = 0 then r link (q)
else begin r q;
while t > 1 do
begin r link (r); decr (t);
end;
s link (r); r link (s); link (s) null ; ush node list (link (q)); replace count (q) 0;
end
This code is used in section 882.
884. We move the post-break list from inside node q to the main list by reattaching it just before the
present node r, then resetting r.
Transplant the post-break list 884
begin s post break (q);
while link (s) ,= null do s link (s);
link (s) r; r post break (q); post break (q) null ; post disc break true;
end
This code is used in section 882.
328 PART 39: BREAKING PARAGRAPHS INTO LINES, CONTINUED T
E
X82 885
885. We move the pre-break list from inside node q to the main list by reattaching it just after the present
node q, then resetting q.
Transplant the pre-break list 885
begin s pre break (q); link (q) s;
while link (s) ,= null do s link (s);
pre break (q) null ; q s;
end
This code is used in section 882.
886. Put the \rightskip glue after node q 886
r new param glue(right skip code); link (r) link (q); link (q) r; q r
This code is used in section 881.
887. The following code begins with q at the end of the list to be justied. It ends with q at the beginning
of that list, and with link (temp head ) pointing to the remainder of the paragraph, if any.
Put the \leftskip glue at the left and detach this line 887
r link (q); link (q) null ; q link (temp head ); link (temp head ) r;
if left skip ,= zero glue then
begin r new param glue(left skip code); link (r) q; q r;
end
This code is used in section 880.
888. Append the new box to the current vertical list, followed by the list of special nodes taken out of
the box by the packager 888
append to vlist (just box );
if adjust head ,= adjust tail then
begin link (tail ) link (adjust head ); tail adjust tail ;
end;
adjust tail null
This code is used in section 880.
889. Now q points to the hlist that represents the current line of the paragraph. We need to compute the
appropriate line width, pack the line into a box of this size, and shift the box by the appropriate amount of
indentation.
Call the packaging subroutine, setting just box to the justied box 889
if cur line > last special line then
begin cur width second width; cur indent second indent ;
end
else if par shape ptr = null then
begin cur width rst width; cur indent rst indent ;
end
else begin cur width mem[par shape ptr + 2 cur line].sc;
cur indent mem[par shape ptr + 2 cur line 1].sc;
end;
adjust tail adjust head ; just box hpack (q, cur width, exactly); shift amount (just box ) cur indent
This code is used in section 880.
890 T
E
X82 PART 39: BREAKING PARAGRAPHS INTO LINES, CONTINUED 329
890. Penalties between the lines of a paragraph come from club and widow lines, from the inter line penalty
parameter, and from lines that end at discretionary breaks. Breaking between lines of a two-line paragraph
gets both club-line and widow-line penalties. The local variable pen will be set to the sum of all relevant
penalties for the current line, except that the nal line is never penalized.
Append a penalty node, if a nonzero penalty is appropriate 890
if cur line + 1 ,= best line then
begin pen inter line penalty;
if cur line = prev graf + 1 then pen pen + club penalty;
if cur line + 2 = best line then pen pen + nal widow penalty;
if disc break then pen pen + broken penalty;
if pen ,= 0 then
begin r new penalty(pen); link (tail ) r; tail r;
end;
end
This code is used in section 880.
330 PART 40: PRE-HYPHENATION T
E
X82 891
891. Pre-hyphenation. When the line-breaking routine is unable to nd a feasible sequence of break-
points, it makes a second pass over the paragraph, attempting to hyphenate the hyphenatable words. The
goal of hyphenation is to insert discretionary material into the paragraph so that there are more potential
places to break.
The general rules for hyphenation are somewhat complex and technical, because we want to be able to
hyphenate words that are preceded or followed by punctuation marks, and because we want the rules to
work for languages other than English. We also must contend with the fact that hyphens might radically
alter the ligature and kerning structure of a word.
A sequence of characters will be considered for hyphenation only if it belongs to a potentially hyphenatable
part of the current paragraph. This is a sequence of nodes p
0
p
1
. . . p
m
where p
0
is a glue node, p
1
. . . p
m1
are either character or ligature or whatsit or implicit kern nodes, and p
m
is a glue or penalty or insertion
or adjust or mark or whatsit or explicit kern node. (Therefore hyphenation is disabled by boxes, math
formulas, and discretionary nodes already inserted by the user.) The ligature nodes among p
1
. . . p
m1
are
eectively expanded into the original non-ligature characters; the kern nodes and whatsits are ignored. Each
character c is now classied as either a nonletter (if lc code(c) = 0), a lowercase letter (if lc code(c) = c),
or an uppercase letter (otherwise); an uppercase letter is treated as if it were lc code(c) for purposes of
hyphenation. The characters generated by p
1
. . . p
m1
may begin with nonletters; let c
1
be the rst letter
that is not in the middle of a ligature. Whatsit nodes preceding c
1
are ignored; a whatsit found after c
1
will
be the terminating node p
m
. All characters that do not have the same font as c
1
will be treated as nonletters.
The hyphen char for that font must be between 0 and 255, otherwise hyphenation will not be attempted.
T
E
X looks ahead for as many consecutive letters c
1
. . . c
n
as possible; however, n must be less than 64, so a
character that would otherwise be c
64
is eectively not a letter. Furthermore c
n
must not be in the middle
of a ligature. In this way we obtain a string of letters c
1
. . . c
n
that are generated by nodes p
a
. . . p
b
, where
1 a b + 1 m. If n l hyf + r hyf , this string qualies for hyphenation; however, uc hyph must be
positive, if c
1
is uppercase.
The hyphenation process takes place in three stages. First, the candidate sequence c
1
. . . c
n
is found; then
potential positions for hyphens are determined by referring to hyphenation tables; and nally, the nodes
p
a
. . . p
b
are replaced by a new sequence of nodes that includes the discretionary breaks found.
Fortunately, we do not have to do all this calculation very often, because of the way it has been taken out
of T
E
Xs inner loop. For example, when the second edition of the authors 700-page book Seminumerical
Algorithms was typeset by T
E
X, only about 1.2 hyphenations needed to be tried per paragraph, since the
line breaking algorithm needed to use two passes on only about 5 per cent of the paragraphs.
Initialize for hyphenating a paragraph 891
begin init if trie not ready then init trie;
tini
cur lang init cur lang ; l hyf init l hyf ; r hyf init r hyf ;
end
This code is used in section 863.
892 T
E
X82 PART 40: PRE-HYPHENATION 331
892. The letters c
1
. . . c
n
that are candidates for hyphenation are placed into an array called hc; the number
n is placed into hn; pointers to nodes p
a1
and p
b
in the description above are placed into variables ha and
hb; and the font number is placed into hf .
Global variables 13 +
hc: array [0 . . 65] of 0 . . 256; word to be hyphenated
hn: small number ; the number of positions occupied in hc
ha, hb: pointer ; nodes ha . . hb should be replaced by the hyphenated result
hf : internal font number ; font number of the letters in hc
hu: array [0 . . 63] of 0 . . 256; like hc, before conversion to lowercase
hyf char : integer ; hyphen character of the relevant font
cur lang , init cur lang : ASCII code; current hyphenation table of interest
l hyf , r hyf , init l hyf , init r hyf : integer ; limits on fragment sizes
hyf bchar : halfword ; boundary character after c
n

893. Hyphenation routines need a few more local variables.
Local variables for line breaking 862 +
j: small number ; an index into hc or hu
c: 0 . . 255; character being considered for hyphenation
894. When the following code is activated, the line break procedure is in its second pass, and cur p points
to a glue node.
Try to hyphenate the following word 894
begin prev s cur p; s link (prev s );
if s ,= null then
begin Skip to node ha, or goto done1 if no hyphenation should be attempted 896 ;
if l hyf + r hyf > 63 then goto done1 ;
Skip to node hb, putting letters into hu and hc 897 ;
Check that the nodes following hb permit hyphenation and that at least l hyf + r hyf letters have
been found, otherwise goto done1 899 ;
hyphenate;
end;
done1 : end
This code is used in section 866.
895. Declare subprocedures for line break 826 +
Declare the function called reconstitute 906
procedure hyphenate;
label common ending , done, found , found1 , found2 , not found , exit ;
var Local variables for hyphenation 901
begin Find hyphen locations for the word in hc, or return 923 ;
If no hyphens were found, return 902 ;
Replace nodes ha . . hb by a sequence of nodes that includes the discretionary hyphens 903 ;
exit : end;
332 PART 40: PRE-HYPHENATION T
E
X82 896
896. The rst thing we need to do is nd the node ha just before the rst letter.
Skip to node ha, or goto done1 if no hyphenation should be attempted 896
loop begin if is char node(s) then
begin c qo(character (s)); hf font (s);
end
else if type(s) = ligature node then
if lig ptr (s) = null then goto continue
else begin q lig ptr (s); c qo(character (q)); hf font (q);
end
else if (type(s) = kern node) (subtype(s) = normal ) then goto continue
else if type(s) = whatsit node then
begin Advance past a whatsit node in the pre-hyphenation loop 1363 ;
goto continue;
end
else goto done1 ;
if lc code(c) ,= 0 then
if (lc code(c) = c) (uc hyph > 0) then goto done2
else goto done1 ;
continue: prev s s; s link (prev s );
end;
done2 : hyf char hyphen char [hf ];
if hyf char < 0 then goto done1 ;
if hyf char > 255 then goto done1 ;
ha prev s
This code is used in section 894.
897. The word to be hyphenated is now moved to the hu and hc arrays.
Skip to node hb, putting letters into hu and hc 897
hn 0;
loop begin if is char node(s) then
begin if font (s) ,= hf then goto done3 ;
hyf bchar character (s); c qo(hyf bchar );
if lc code(c) = 0 then goto done3 ;
if hn = 63 then goto done3 ;
hb s; incr (hn); hu[hn] c; hc[hn] lc code(c); hyf bchar non char ;
end
else if type(s) = ligature node then Move the characters of a ligature node to hu and hc; but goto
done3 if they are not all letters 898
else if (type(s) = kern node) (subtype(s) = normal ) then
begin hb s; hyf bchar font bchar [hf ];
end
else goto done3 ;
s link (s);
end;
done3 :
This code is used in section 894.
898 T
E
X82 PART 40: PRE-HYPHENATION 333
898. We let j be the index of the character being stored when a ligature node is being expanded, since
we do not want to advance hn until we are sure that the entire ligature consists of letters. Note that it is
possible to get to done3 with hn = 0 and hb not set to any value.
Move the characters of a ligature node to hu and hc; but goto done3 if they are not all letters 898
begin if font (lig char (s)) ,= hf then goto done3 ;
j hn; q lig ptr (s); if q > null then hyf bchar character (q);
while q > null do
begin c qo(character (q));
if lc code(c) = 0 then goto done3 ;
if j = 63 then goto done3 ;
incr (j); hu[j] c; hc[j] lc code(c);
q link (q);
end;
hb s; hn j;
if odd (subtype(s)) then hyf bchar font bchar [hf ] else hyf bchar non char ;
end
This code is used in section 897.
899. Check that the nodes following hb permit hyphenation and that at least l hyf + r hyf letters have
been found, otherwise goto done1 899
if hn < l hyf + r hyf then goto done1 ; l hyf and r hyf are 1
loop begin if (is char node(s)) then
case type(s) of
ligature node: do nothing ;
kern node: if subtype(s) ,= normal then goto done4 ;
whatsit node, glue node, penalty node, ins node, adjust node, mark node: goto done4 ;
othercases goto done1
endcases;
s link (s);
end;
done4 :
This code is used in section 894.
334 PART 41: POST-HYPHENATION T
E
X82 900
900. Post-hyphenation. If a hyphen may be inserted between hc[j] and hc[j + 1], the hyphenation
procedure will set hyf [j] to some small odd number. But before we look at T
E
Xs hyphenation procedure,
which is independent of the rest of the line-breaking algorithm, let us consider what we will do with the
hyphens it nds, since it is better to work on this part of the program before forgetting what ha and hb,
etc., are all about.
Global variables 13 +
hyf : array [0 . . 64] of 0 . . 9; odd values indicate discretionary hyphens
init list : pointer ; list of punctuation characters preceding the word
init lig : boolean; does init list represent a ligature?
init lft : boolean; if so, did the ligature involve a left boundary?
901. Local variables for hyphenation 901
i, j, l: 0 . . 65; indices into hc or hu
q, r, s: pointer ; temporary registers for list manipulation
bchar : halfword ; right boundary character of hyphenated word, or non char
See also sections 912, 922, and 929.
This code is used in section 895.
902. T
E
X will never insert a hyphen that has fewer than \lefthyphenmin letters before it or fewer than
\righthyphenmin after it; hence, a short word has comparatively little chance of being hyphenated. If no
hyphens have been found, we can save time by not having to make any changes to the paragraph.
If no hyphens were found, return 902
for j l hyf to hn r hyf do
if odd (hyf [j]) then goto found1 ;
return;
found1 :
This code is used in section 895.
903 T
E
X82 PART 41: POST-HYPHENATION 335
903. If hyphens are in fact going to be inserted, T
E
X rst deletes the subsequence of nodes between ha
and hb. An attempt is made to preserve the eect that implicit boundary characters and punctuation marks
had on ligatures inside the hyphenated word, by storing a left boundary or preceding character in hu[0] and
by storing a possible right boundary in bchar . We set j 0 if hu[0] is to be part of the reconstruction;
otherwise j 1. The variable s will point to the tail of the current hlist, and q will point to the node
following hb, so that things can be hooked up after we reconstitute the hyphenated word.
Replace nodes ha . . hb by a sequence of nodes that includes the discretionary hyphens 903
q link (hb); link (hb) null ; r link (ha); link (ha) null ; bchar hyf bchar ;
if is char node(ha) then
if font (ha) ,= hf then goto found2
else begin init list ha; init lig false; hu[0] qo(character (ha));
end
else if type(ha) = ligature node then
if font (lig char (ha)) ,= hf then goto found2
else begin init list lig ptr (ha); init lig true; init lft (subtype(ha) > 1);
hu[0] qo(character (lig char (ha)));
if init list = null then
if init lft then
begin hu[0] 256; init lig false;
end; in this case a ligature will be reconstructed from scratch
free node(ha, small node size);
end
else begin no punctuation found; look for left boundary
if is char node(r) then
if type(r) = ligature node then
if subtype(r) > 1 then goto found2 ;
j 1; s ha; init list null ; goto common ending ;
end;
s cur p; we have cur p ,= ha because type(cur p) = glue node
while link (s) ,= ha do s link (s);
j 0; goto common ending ;
found2 : s ha; j 0; hu[0] 256; init lig false; init list null ;
common ending : ush node list (r);
Reconstitute nodes for the hyphenated word, inserting discretionary hyphens 913 ;
ush list (init list )
This code is used in section 895.
904. We must now face the fact that the battle is not over, even though the hyphens have been found: The
process of reconstituting a word can be nontrivial because ligatures might change when a hyphen is present.
The T
E
Xbook discusses the diculties of the word dicult, and the discretionary material surrounding a
hyphen can be considerably more complex than that. Suppose abcdef is a word in a font for which the only
ligatures are bc, cd, de, and ef. If this word permits hyphenation between b and c, the two patterns with
and without hyphenation are a b cd ef and a bc de f. Thus the insertion of a hyphen might cause eects to
ripple arbitrarily far into the rest of the word. A further complication arises if additional hyphens appear
together with such rippling, e.g., if the word in the example just given could also be hyphenated between c
and d; T
E
X avoids this by simply ignoring the additional hyphens in such weird cases.
Still further complications arise in the presence of ligatures that do not delete the original characters.
When punctuation precedes the word being hyphenated, T
E
Xs method is not perfect under all possible
scenarios, because punctuation marks and letters can propagate information back and forth. For example,
suppose the original pre-hyphenation pair *a changes to *y via a |=: ligature, which changes to xy via a
=:| ligature; if p
a1
= x and p
a
= y, the reconstitution procedure isnt smart enough to obtain xy again. In
such cases the font designer should include a ligature that goes from xa to xy.
336 PART 41: POST-HYPHENATION T
E
X82 905
905. The processing is facilitated by a subroutine called reconstitute. Given a string of characters x
j
. . . x
n
,
there is a smallest index m j such that the translation of x
j
. . . x
n
by ligatures and kerning has the form
y
1
. . . y
t
followed by the translation of x
m+1
. . . x
n
, where y
1
. . . y
t
is some nonempty sequence of character,
ligature, and kern nodes. We call x
j
. . . x
m
a cut prex of x
j
. . . x
n
. For example, if x
1
x
2
x
3
= fly, and if
the font contains as a ligature and a kern between and y, then m = 2, t = 2, and y
1
will be a ligature
node for followed by an appropriate kern node y
2
. In the most common case, x
j
forms no ligature with
x
j+1
and we simply have m = j, y
1
= x
j
. If m < n we can repeat the procedure on x
m+1
. . . x
n
until the
entire translation has been found.
The reconstitute function returns the integer m and puts the nodes y
1
. . . y
t
into a linked list starting at
link (hold head ), getting the input x
j
. . . x
n
from the hu array. If x
j
= 256, we consider x
j
to be an implicit
left boundary character; in this case j must be strictly less than n. There is a parameter bchar , which
is either 256 or an implicit right boundary character assumed to be present just following x
n
. (The value
hu[n + 1] is never explicitly examined, but the algorithm imagines that bchar is there.)
If there exists an index k in the range j k m such that hyf [k] is odd and such that the result of
reconstitute would have been dierent if x
k+1
had been hchar , then reconstitute sets hyphen passed to the
smallest such k. Otherwise it sets hyphen passed to zero.
A special convention is used in the case j = 0: Then we assume that the translation of hu[0] appears
in a special list of charnodes starting at init list ; moreover, if init lig is true, then hu[0] will be a ligature
character, involving a left boundary if init lft is true. This facility is provided for cases when a hyphenated
word is preceded by punctuation (like single or double quotes) that might aect the translation of the
beginning of the word.
Global variables 13 +
hyphen passed : small number ; rst hyphen in a ligature, if any
906. Declare the function called reconstitute 906
function reconstitute(j, n : small number ; bchar , hchar : halfword ): small number ;
label continue, done;
var p: pointer ; temporary register for list manipulation
t: pointer ; a node being appended to
q: four quarters ; character information or a lig/kern instruction
cur rh: halfword ; hyphen character for ligature testing
test char : halfword ; hyphen or other character for ligature testing
w: scaled ; amount of kerning
k: font index ; position of current lig/kern instruction
begin hyphen passed 0; t hold head ; w 0; link (hold head ) null ;
at this point ligature present = lft hit = rt hit = false
Set up data structures with the cursor following position j 908 ;
continue: If theres a ligature or kern at the cursor position, update the data structures, possibly
advancing j; continue until the cursor moves 909 ;
Append a ligature and/or kern to the translation; goto continue if the stack of inserted ligatures is
nonempty 910 ;
reconstitute j;
end;
This code is used in section 895.
907 T
E
X82 PART 41: POST-HYPHENATION 337
907. The reconstitution procedure shares many of the global data structures by which T
E
X has processed
the words before they were hyphenated. There is an implied cursor between characters cur l and cur r ;
these characters will be tested for possible ligature activity. If ligature present then cur l is a ligature
character formed from the original characters following cur q in the current translation list. There is a
ligature stack between the cursor and character j + 1, consisting of pseudo-ligature nodes linked together
by their link elds. This stack is normally empty unless a ligature command has created a new character that
will need to be processed later. A pseudo-ligature is a special node having a character eld that represents
a potential ligature and a lig ptr eld that points to a char node or is null . We have
cur r =

character (lig stack ), if lig stack > null ;

qi (hu[j+1]), if lig stack = null and j < n;
bchar, if lig stack = null and j = n.
Global variables 13 +
cur l , cur r : halfword ; characters before and after the cursor
cur q : pointer ; where a ligature should be detached
lig stack : pointer ; unnished business to the right of the cursor
ligature present : boolean; should a ligature node be made for cur l ?
lft hit , rt hit : boolean; did we hit a ligature with a boundary character?
908. dene append charnode to t (#)
begin link (t) get avail ; t link (t); font (t) hf ; character (t) #;
end
dene set cur r
begin if j < n then cur r qi (hu[j + 1]) else cur r bchar ;
if odd (hyf [j]) then cur rh hchar else cur rh non char ;
end
Set up data structures with the cursor following position j 908
cur l qi (hu[j]); cur q t;
if j = 0 then
begin ligature present init lig ; p init list ;
if ligature present then lft hit init lft ;
while p > null do
begin append charnode to t (character (p)); p link (p);
end;
end
else if cur l < non char then append charnode to t (cur l );
lig stack null ; set cur r
This code is used in section 906.
338 PART 41: POST-HYPHENATION T
E
X82 909
909. We may want to look at the lig/kern program twice, once for a hyphen and once for a normal letter.
(The hyphen might appear after the letter in the program, so wed better not try to look for both at once.)
If theres a ligature or kern at the cursor position, update the data structures, possibly advancing j;
continue until the cursor moves 909
if cur l = non char then
begin k bchar label [hf ];
if k = non address then goto done else q font info[k].qqqq ;
end
else begin q char info(hf )(cur l );
if char tag (q) ,= lig tag then goto done;
k lig kern start (hf )(q); q font info[k].qqqq ;
if skip byte(q) > stop ag then
begin k lig kern restart (hf )(q); q font info[k].qqqq ;
end;
end; now k is the starting address of the lig/kern program
if cur rh < non char then test char cur rh else test char cur r ;
loop begin if next char (q) = test char then
if skip byte(q) stop ag then
if cur rh < non char then
begin hyphen passed j; hchar non char ; cur rh non char ; goto continue;
end
else begin if hchar < non char then
if odd (hyf [j]) then
begin hyphen passed j; hchar non char ;
end;
if op byte(q) < kern ag then
Carry out a ligature replacement, updating the cursor structure and possibly advancing j;
goto continue if the cursor doesnt advance, otherwise goto done 911 ;
w char kern(hf )(q); goto done; this kern will be inserted below
end;
if skip byte(q) stop ag then
if cur rh = non char then goto done
else begin cur rh non char ; goto continue;
end;
k k + qo(skip byte(q)) + 1; q font info[k].qqqq ;
end;
done:
This code is used in section 906.
910 T
E
X82 PART 41: POST-HYPHENATION 339
910. dene wrap lig (#)
if ligature present then
begin p new ligature(hf , cur l , link (cur q ));
if lft hit then
begin subtype(p) 2; lft hit false;
end;
if # then
if lig stack = null then
begin incr (subtype(p)); rt hit false;
end;
link (cur q ) p; t p; ligature present false;
end
dene pop lig stack
begin if lig ptr (lig stack ) > null then
begin link (t) lig ptr (lig stack ); this is a charnode for hu[j + 1]
t link (t); incr (j);
end;
p lig stack ; lig stack link (p); free node(p, small node size);
if lig stack = null then set cur r else cur r character (lig stack );
end if lig stack isnt null we have cur rh = non char
Append a ligature and/or kern to the translation; goto continue if the stack of inserted ligatures is
nonempty 910
wrap lig (rt hit );
if w ,= 0 then
begin link (t) new kern(w); t link (t); w 0;
end;
if lig stack > null then
begin cur q t; cur l character (lig stack ); ligature present true; pop lig stack ; goto continue;
end
This code is used in section 906.
340 PART 41: POST-HYPHENATION T
E
X82 911
911. Carry out a ligature replacement, updating the cursor structure and possibly advancing j; goto
continue if the cursor doesnt advance, otherwise goto done 911
begin if cur l = non char then lft hit true;
if j = n then
if lig stack = null then rt hit true;
check interrupt ; allow a way out in case theres an innite ligature loop
case op byte(q) of
qi (1), qi (5): begin cur l rem byte(q); =:|, =:|>
ligature present true;
end;
qi (2), qi (6): begin cur r rem byte(q); |=:, |=:>
if lig stack > null then character (lig stack ) cur r
else begin lig stack new lig item(cur r );
if j = n then bchar non char
else begin p get avail ; lig ptr (lig stack ) p; character (p) qi (hu[j + 1]); font (p) hf ;
end;
end;
end;
qi (3): begin cur r rem byte(q); |=:|
p lig stack ; lig stack new lig item(cur r ); link (lig stack ) p;
end;
qi (7), qi (11): begin wrap lig (false); |=:|>, |=:|>>
cur q t; cur l rem byte(q); ligature present true;
end;
othercases begin cur l rem byte(q); ligature present true; =:
if lig stack > null then pop lig stack
else if j = n then goto done
else begin append charnode to t (cur r ); incr (j); set cur r ;
end;
end
endcases;
if op byte(q) > qi (4) then
if op byte(q) ,= qi (7) then goto done;
goto continue;
end
This code is used in section 909.
912. Okay, were ready to insert the potential hyphenations that were found. When the following program
is executed, we want to append the word hu[1 . . hn] after node ha, and node q should be appended to
the result. During this process, the variable i will be a temporary index into hu; the variable j will be an
index to our current position in hu; the variable l will be the counterpart of j, in a discretionary branch; the
variable r will point to new nodes being created; and we need a few new local variables:
Local variables for hyphenation 901 +
major tail , minor tail : pointer ;
the end of lists in the main and discretionary branches being reconstructed
c: ASCII code; character temporarily replaced by a hyphen
c loc: 0 . . 63; where that character came from
r count : integer ; replacement count for discretionary
hyf node: pointer ; the hyphen, if it exists
913 T
E
X82 PART 41: POST-HYPHENATION 341
913. When the following code is performed, hyf [0] and hyf [hn] will be zero.
Reconstitute nodes for the hyphenated word, inserting discretionary hyphens 913
repeat l j; j reconstitute(j, hn, bchar , qi (hyf char )) + 1;
if hyphen passed = 0 then
begin link (s) link (hold head );
while link (s) > null do s link (s);
if odd (hyf [j 1]) then
begin l j; hyphen passed j 1; link (hold head ) null ;
end;
end;
if hyphen passed > 0 then Create and append a discretionary node as an alternative to the
unhyphenated word, and continue to develop both branches until they become equivalent 914 ;
until j > hn;
link (s) q
This code is used in section 903.
914. In this repeat loop we will insert another discretionary if hyf [j 1] is odd, when both branches of the
previous discretionary end at position j 1. Strictly speaking, we arent justied in doing this, because we
dont know that a hyphen after j 1 is truly independent of those branches. But in almost all applications
we would rather not lose a potentially valuable hyphenation point. (Consider the word dicult, where the
letter c is in position j.)
dene advance major tail
begin major tail link (major tail ); incr (r count );
end
Create and append a discretionary node as an alternative to the unhyphenated word, and continue to
develop both branches until they become equivalent 914
repeat r get node(small node size); link (r) link (hold head ); type(r) disc node; major tail r;
r count 0;
while link (major tail ) > null do advance major tail ;
i hyphen passed ; hyf [i] 0; Put the characters hu[l . . i] and a hyphen into pre break (r) 915 ;
Put the characters hu[i + 1 . . ] into post break (r), appending to this list and to major tail until
synchronization has been achieved 916 ;
Move pointer s to the end of the current list, and set replace count (r) appropriately 918 ;
hyphen passed j 1; link (hold head ) null ;
until odd (hyf [j 1])
This code is used in section 913.
342 PART 41: POST-HYPHENATION T
E
X82 915
915. The new hyphen might combine with the previous character via ligature or kern. At this point we
have l 1 i < j and i < hn.
Put the characters hu[l . . i] and a hyphen into pre break (r) 915
minor tail null ; pre break (r) null ; hyf node new character (hf , hyf char );
if hyf node ,= null then
begin incr (i); c hu[i]; hu[i] hyf char ; free avail (hyf node);
end;
while l i do
begin l reconstitute(l, i, font bchar [hf ], non char ) + 1;
if link (hold head ) > null then
begin if minor tail = null then pre break (r) link (hold head )
else link (minor tail ) link (hold head );
minor tail link (hold head );
while link (minor tail ) > null do minor tail link (minor tail );
end;
end;
if hyf node ,= null then
begin hu[i] c; restore the character in the hyphen position
l i; decr (i);
end
This code is used in section 914.
916. The synchronization algorithm begins with l = i + 1 j.
Put the characters hu[i + 1 . . ] into post break (r), appending to this list and to major tail until
synchronization has been achieved 916
minor tail null ; post break (r) null ; c loc 0;
if bchar label [hf ] ,= non address then put left boundary at beginning of new line
begin decr (l); c hu[l]; c loc l; hu[l] 256;
end;
while l < j do
begin repeat l reconstitute(l, hn, bchar , non char ) + 1;
if c loc > 0 then
begin hu[c loc] c; c loc 0;
end;
if link (hold head ) > null then
begin if minor tail = null then post break (r) link (hold head )
else link (minor tail ) link (hold head );
minor tail link (hold head );
while link (minor tail ) > null do minor tail link (minor tail );
end;
until l j;
while l > j do Append characters of hu[j . . ] to major tail , advancing j 917 ;
end
This code is used in section 914.
917. Append characters of hu[j . . ] to major tail , advancing j 917
begin j reconstitute(j, hn, bchar , non char ) + 1; link (major tail ) link (hold head );
while link (major tail ) > null do advance major tail ;
end
This code is used in section 916.
918 T
E
X82 PART 41: POST-HYPHENATION 343
918. Ligature insertion can cause a word to grow exponentially in size. Therefore we must test the size of
r count here, even though the hyphenated text was at most 63 characters long.
Move pointer s to the end of the current list, and set replace count (r) appropriately 918
if r count > 127 then we have to forget the discretionary hyphen
begin link (s) link (r); link (r) null ; ush node list (r);
end
else begin link (s) r; replace count (r) r count ;
end;
s major tail
This code is used in section 914.
344 PART 42: HYPHENATION T
E
X82 919
919. Hyphenation. When a word hc[1 . . hn] has been set up to contain a candidate for hyphenation,
T
E
X rst looks to see if it is in the users exception dictionary. If not, hyphens are inserted based on patterns
that appear within the given word, using an algorithm due to Frank M. Liang.
Lets consider Liangs method rst, since it is much more interesting than the exception-lookup routine.
The algorithm begins by setting hyf [j] to zero for all j, and invalid characters are inserted into hc[0] and
hc[hn +1] to serve as delimiters. Then a reasonably fast method is used to see which of a given set of patterns
occurs in the word hc[0 . . (hn + 1)]. Each pattern p
1
. . . p
k
of length k has an associated sequence of k + 1
numbers n
0
. . . n
k
; and if the pattern occurs in hc[(j+1) . . (j+k)], T
E
X will set hyf [j+i] max(hyf [j+i], n
i
)
for 0 i k. After this has been done for each pattern that occurs, a discretionary hyphen will be inserted
between hc[j] and hc[j + 1] when hyf [j] is odd, as we have already seen.
The set of patterns p
1
. . . p
k
and associated numbers n
0
. . . n
k
depends, of course, on the language whose
words are being hyphenated, and on the degree of hyphenation that is desired. A method for nding
appropriate ps and ns, from a given dictionary of words and acceptable hyphenations, is discussed in
Liangs Ph.D. thesis (Stanford University, 1983); T
E
X simply starts with the patterns and works from there.
920. The patterns are stored in a compact table that is also ecient for retrieval, using a variant of
trie memory [cf. The Art of Computer Programming 3 (1973), 481505]. We can nd each pattern
p
1
. . . p
k
by letting z
0
be one greater than the relevant language index and then, for 1 i k, setting
z
i
trie link (z
i1
) + p
i
; the pattern will be identied by the number z
k
. Since all the pattern information
is packed together into a single trie link array, it is necessary to prevent confusion between the data from
inequivalent patterns, so another table is provided such that trie char (z
i
) = p
i
for all i. There is also a table
trie op(z
k
) to identify the numbers n
0
. . . n
k
associated with p
1
. . . p
k
.
Comparatively few dierent number sequences n
0
. . . n
k
actually occur, since most of the ns are generally
zero. Therefore the number sequences are encoded in such a way that trie op(z
k
) is only one byte long. If
trie op(z
k
) ,= min quarterword , when p
1
. . . p
k
has matched the letters in hc[(l k+1) . . l ] of language t, we
perform all of the required operations for this pattern by carrying out the following little program: Set v
trie op(z
k
). Then set v v+op start [t], hyf [lhyf distance[v]] max(hyf [lhyf distance[v]], hyf num[v]),
and v hyf next [v]; repeat, if necessary, until v = min quarterword .
Types in the outer block 18 +
trie pointer = 0 . . trie size; an index into trie
921. dene trie link (#) trie[#].rh downward link in a trie
dene trie char (#) trie[#].b1 character matched at this trie location
dene trie op(#) trie[#].b0 program for hyphenation at this trie location
Global variables 13 +
trie: array [trie pointer ] of two halves ; trie link , trie char , trie op
hyf distance: array [1 . . trie op size] of small number ; position k j of n
j

hyf num: array [1 . . trie op size] of small number ; value of n
j

hyf next : array [1 . . trie op size] of quarterword ; continuation code
op start : array [ASCII code] of 0 . . trie op size; oset for current language
922. Local variables for hyphenation 901 +
z: trie pointer ; an index into trie
v: integer ; an index into hyf distance, etc.
923 T
E
X82 PART 42: HYPHENATION 345
923. Assuming that these auxiliary tables have been set up properly, the hyphenation algorithm is quite
short. In the following code we set hc[hn + 2] to the impossible value 256, in order to guarantee that
hc[hn + 3] will never be fetched.
Find hyphen locations for the word in hc, or return 923
for j 0 to hn do hyf [j] 0;
Look for the word hc[1 . . hn] in the exception table, and goto found (with hyf containing the hyphens)
if an entry is found 930 ;
if trie char (cur lang + 1) ,= qi (cur lang ) then return; no patterns for cur lang
hc[0] 0; hc[hn + 1] 0; hc[hn + 2] 256; insert delimiters
for j 0 to hn r hyf + 1 do
begin z trie link (cur lang + 1) + hc[j]; l j;
while hc[l] = qo(trie char (z)) do
begin if trie op(z) ,= min quarterword then Store maximum values in the hyf table 924 ;
incr (l); z trie link (z) + hc[l];
end;
end;
found : for j 0 to l hyf 1 do hyf [j] 0;
for j 0 to r hyf 1 do hyf [hn j] 0
This code is used in section 895.
924. Store maximum values in the hyf table 924
begin v trie op(z);
repeat v v + op start [cur lang ]; i l hyf distance[v];
if hyf num[v] > hyf [i] then hyf [i] hyf num[v];
v hyf next [v];
until v = min quarterword ;
end
This code is used in section 923.
925. The exception table that is built by T
E
Xs \hyphenation primitive is organized as an ordered hash
table [cf. Amble and Knuth, The Computer Journal 17 (1974), 135142] using linear probing. If and
are words, we will say that < if [[ < [[ or if [[ = [[ and is lexicographically smaller than . (The
notation [[ stands for the length of .) The idea of ordered hashing is to arrange the table so that a given
word can be sought by computing a hash address h = h() and then looking in table positions h, h 1,
. . . , until encountering the rst word . If this word is dierent from , we can conclude that is not in
the table.
The words in the table point to lists in mem that specify hyphen positions in their info elds. The list
for c
1
. . . c
n
contains the number k if the word c
1
. . . c
n
has a discretionary hyphen between c
k
and c
k+1
.
Types in the outer block 18 +
hyph pointer = 0 . . hyph size; an index into the ordered hash table
926. Global variables 13 +
hyph word : array [hyph pointer ] of str number ; exception words
hyph list : array [hyph pointer ] of pointer ; lists of hyphen positions
hyph count : hyph pointer ; the number of words in the exception dictionary
927. Local variables for initialization 19 +
z: hyph pointer ; runs through the exception dictionary
346 PART 42: HYPHENATION T
E
X82 928
928. Set initial values of key variables 21 +
for z 0 to hyph size do
begin hyph word [z] 0; hyph list [z] null ;
end;
hyph count 0;
929. The algorithm for exception lookup is quite simple, as soon as we have a few more local variables to
work with.
Local variables for hyphenation 901 +
h: hyph pointer ; an index into hyph word and hyph list
k: str number ; an index into str start
u: pool pointer ; an index into str pool
930. First we compute the hash code h, then we search until we either nd the word or we dont. Words
from dierent languages are kept separate by appending the language code to the string.
Look for the word hc[1 . . hn] in the exception table, and goto found (with hyf containing the hyphens) if
an entry is found 930
h hc[1]; incr (hn); hc[hn] cur lang ;
for j 2 to hn do h (h + h + hc[j]) mod hyph size;
loop begin If the string hyph word [h] is less than hc[1 . . hn], goto not found ; but if the two strings
are equal, set hyf to the hyphen positions and goto found 931 ;
if h > 0 then decr (h) else h hyph size;
end;
not found : decr (hn)
This code is used in section 923.
931. If the string hyph word [h] is less than hc[1 . . hn], goto not found ; but if the two strings are equal,
set hyf to the hyphen positions and goto found 931
k hyph word [h];
if k = 0 then goto not found ;
if length(k) < hn then goto not found ;
if length(k) = hn then
begin j 1; u str start [k];
repeat if so(str pool [u]) < hc[j] then goto not found ;
if so(str pool [u]) > hc[j] then goto done;
incr (j); incr (u);
until j > hn;
Insert hyphens as specied in hyph list [h] 932 ;
decr (hn); goto found ;
end;
done:
This code is used in section 930.
932. Insert hyphens as specied in hyph list [h] 932
s hyph list [h];
while s ,= null do
begin hyf [info(s)] 1; s link (s);
end
This code is used in section 931.
933 T
E
X82 PART 42: HYPHENATION 347
933. Search hyph list for pointers to p 933
for q 0 to hyph size do
begin if hyph list [q] = p then
begin print nl ("HYPH("); print int (q); print char (")");
end;
end
This code is used in section 172.
934. We have now completed the hyphenation routine, so the line break procedure is nished at last. Since
the hyphenation exception table is fresh in our minds, its a good time to deal with the routine that adds
new entries to it.
When T
E
X has scanned \hyphenation, it calls on a procedure named new hyph exceptions to do the
right thing.
dene set cur lang
if language 0 then cur lang 0
else if language > 255 then cur lang 0
else cur lang language
procedure new hyph exceptions ; enters new exceptions
label reswitch, exit , found , not found ;
var n: 0 . . 64; length of current word; not always a small number
j: 0 . . 64; an index into hc
h: hyph pointer ; an index into hyph word and hyph list
k: str number ; an index into str start
p: pointer ; head of a list of hyphen positions
q: pointer ; used when creating a new node for list p
s, t: str number ; strings being compared or stored
u, v: pool pointer ; indices into str pool
begin scan left brace; a left brace must follow \hyphenation
set cur lang ;
Enter as many hyphenation exceptions as are listed, until coming to a right brace; then return 935 ;
exit : end;
935. Enter as many hyphenation exceptions as are listed, until coming to a right brace; then
return 935
n 0; p null ;
loop begin get x token;
reswitch: case cur cmd of
letter , other char , char given: Append a new letter or hyphen 937 ;
char num: begin scan char num; cur chr cur val ; cur cmd char given; goto reswitch;
end;
spacer , right brace: begin if n > 1 then Enter a hyphenation exception 939 ;
if cur cmd = right brace then return;
n 0; p null ;
end;
othercases Give improper \hyphenation error 936
endcases;
end
This code is used in section 934.
348 PART 42: HYPHENATION T
E
X82 936
936. Give improper \hyphenation error 936
begin print err ("Improper"); print esc("hyphenation"); print ("willbeflushed");
help2 ("Hyphenationexceptionsmustcontainonlyletters")
("andhyphens.Butcontinue;Illforgiveandforget."); error ;
end
This code is used in section 935.
937. Append a new letter or hyphen 937
if cur chr = "" then Append the value n to list p 938
else begin if lc code(cur chr ) = 0 then
begin print err ("Notaletter");
help2 ("Lettersin\hyphenationwordsmusthave\lccode>0.")
("Proceed;IllignorethecharacterIjustread."); error ;
end
else if n < 63 then
begin incr (n); hc[n] lc code(cur chr );
end;
end
This code is used in section 935.
938. Append the value n to list p 938
begin if n < 63 then
begin q get avail ; link (q) p; info(q) n; p q;
end;
end
This code is used in section 937.
939. Enter a hyphenation exception 939
begin incr (n); hc[n] cur lang ; str room(n); h 0;
for j 1 to n do
begin h (h + h + hc[j]) mod hyph size; append char (hc[j]);
end;
s make string ; Insert the pair (s, p) into the exception table 940 ;
end
This code is used in section 935.
940. Insert the pair (s, p) into the exception table 940
if hyph count = hyph size then overow("exceptiondictionary", hyph size);
incr (hyph count );
while hyph word [h] ,= 0 do
begin If the string hyph word [h] is less than or equal to s, interchange (hyph word [h], hyph list [h])
with (s, p) 941 ;
if h > 0 then decr (h) else h hyph size;
end;
hyph word [h] s; hyph list [h] p
This code is used in section 939.
941 T
E
X82 PART 42: HYPHENATION 349
941. If the string hyph word [h] is less than or equal to s, interchange (hyph word [h], hyph list [h]) with
(s, p) 941
k hyph word [h];
if length(k) < length(s) then goto found ;
if length(k) > length(s) then goto not found ;
u str start [k]; v str start [s];
repeat if str pool [u] < str pool [v] then goto found ;
if str pool [u] > str pool [v] then goto not found ;
incr (u); incr (v);
until u = str start [k + 1];
found : q hyph list [h]; hyph list [h] p; p q;
t hyph word [h]; hyph word [h] s; s t;
not found :
This code is used in section 940.
350 PART 43: INITIALIZING THE HYPHENATION TABLES T
E
X82 942
942. Initializing the hyphenation tables. The trie for T
E
Xs hyphenation algorithm is built from a
sequence of patterns following a \patterns specication. Such a specication is allowed only in INITEX,
since the extra memory for auxiliary tables and for the initialization program itself would only clutter up
the production version of T
E
X with a lot of deadwood.
The rst step is to build a trie that is linked, instead of packed into sequential storage, so that insertions
are readily made. After all patterns have been processed, INITEX compresses the linked trie by identifying
common subtries. Finally the trie is packed into the ecient sequential form that the hyphenation algorithm
actually uses.
Declare subprocedures for line break 826 +
init Declare procedures for preprocessing hyphenation patterns 944
tini
943. Before we discuss trie building in detail, lets consider the simpler problem of creating the hyf distance,
hyf num, and hyf next arrays.
Suppose, for example, that T
E
X reads the pattern ab2cde1. This is a pattern of length 5, with n
0
. . . n
5
=
0 0 2 0 0 1 in the notation above. We want the corresponding trie op code v to have hyf distance[v] = 3,
hyf num[v] = 2, and hyf next [v] = v

, where the auxiliary trie op code v

has hyf distance[v

] = 0,
hyf num[v

] = 1, and hyf next [v

] = min quarterword .
T
E
X computes an appropriate value v with the new trie op subroutine below, by setting
v

new trie op(0, 1, min quarterword ), v new trie op(3, 2, v

).
This subroutine looks up its three parameters in a special hash table, assigning a new value only if these
three have not appeared before for the current language.
The hash table is called trie op hash, and the number of entries it contains is trie op ptr .
Global variables 13 +
init trie op hash: array [trie op size . . trie op size] of 0 . . trie op size;
trie op codes for quadruples
trie used : array [ASCII code] of quarterword ; largest opcode used so far for this language
trie op lang : array [1 . . trie op size] of ASCII code; language part of a hashed quadruple
trie op val : array [1 . . trie op size] of quarterword ; opcode corresponding to a hashed quadruple
trie op ptr : 0 . . trie op size; number of stored ops so far
tini
944 T
E
X82 PART 43: INITIALIZING THE HYPHENATION TABLES 351
944. Its tempting to remove the overow stops in the following procedure; new trie op could return
min quarterword (thereby simply ignoring part of a hyphenation pattern) instead of aborting the job.
However, that would lead to dierent hyphenation results on dierent installations of T
E
X using the same
patterns. The overow stops are necessary for portability of patterns.
Declare procedures for preprocessing hyphenation patterns 944
function new trie op(d, n : small number ; v : quarterword ): quarterword ;
label exit ;
var h: trie op size . . trie op size; trial hash location
u: quarterword ; trial op code
l: 0 . . trie op size; pointer to stored data
begin h abs (n + 313 d + 361 v + 1009 cur lang ) mod (trie op size + trie op size) trie op size;
loop begin l trie op hash[h];
if l = 0 then empty position found for a new op
begin if trie op ptr = trie op size then overow("patternmemoryops", trie op size);
u trie used [cur lang ];
if u = max quarterword then
overow("patternmemoryopsperlanguage", max quarterword min quarterword );
incr (trie op ptr ); incr (u); trie used [cur lang ] u; hyf distance[trie op ptr ] d;
hyf num[trie op ptr ] n; hyf next [trie op ptr ] v; trie op lang [trie op ptr ] cur lang ;
trie op hash[h] trie op ptr ; trie op val [trie op ptr ] u; new trie op u; return;
end;
if (hyf distance[l] = d) (hyf num[l] = n) (hyf next [l] = v) (trie op lang [l] = cur lang ) then
begin new trie op trie op val [l]; return;
end;
if h > trie op size then decr (h) else h trie op size;
end;
exit : end;
See also sections 948, 949, 953, 957, 959, 960, and 966.
This code is used in section 942.
945. After new trie op has compressed the necessary opcode information, plenty of information is available
to unscramble the data into the nal form needed by our hyphenation algorithm.
Sort the hyphenation op tables into proper order 945
op start [0] min quarterword ;
for j 1 to 255 do op start [j] op start [j 1] + qo(trie used [j 1]);
for j 1 to trie op ptr do trie op hash[j] op start [trie op lang [j]] + trie op val [j]; destination
for j 1 to trie op ptr do
while trie op hash[j] > j do
begin k trie op hash[j];
t hyf distance[k]; hyf distance[k] hyf distance[j]; hyf distance[j] t;
t hyf num[k]; hyf num[k] hyf num[j]; hyf num[j] t;
t hyf next [k]; hyf next [k] hyf next [j]; hyf next [j] t;
trie op hash[j] trie op hash[k]; trie op hash[k] k;
end
This code is used in section 952.
352 PART 43: INITIALIZING THE HYPHENATION TABLES T
E
X82 946
946. Before we forget how to initialize the data structures that have been mentioned so far, lets write
down the code that gets them started.
Initialize table entries (done by INITEX only) 164 +
for k trie op size to trie op size do trie op hash[k] 0;
for k 0 to 255 do trie used [k] min quarterword ;
trie op ptr 0;
947. The linked trie that is used to preprocess hyphenation patterns appears in several global arrays. Each
node represents an instruction of the form if you see character c, then perform operation o, move to the
next character, and go to node l; otherwise go to node r. The four quantities c, o, l, and r are stored in four
arrays trie c, trie o, trie l , and trie r . The root of the trie is trie l [0], and the number of nodes is trie ptr .
Null trie pointers are represented by zero. To initialize the trie, we simply set trie l [0] and trie ptr to zero.
We also set trie c[0] to some arbitrary value, since the algorithm may access it.
The algorithms maintain the condition
trie c[trie r [z]] > trie c[z] whenever z ,= 0 and trie r [z] ,= 0;
in other words, sibling nodes are ordered by their c elds.
dene trie root trie l [0] root of the linked trie
Global variables 13 +
init trie c: packed array [trie pointer ] of packed ASCII code; characters to match
trie o: packed array [trie pointer ] of quarterword ; operations to perform
trie l : packed array [trie pointer ] of trie pointer ; left subtrie links
trie r : packed array [trie pointer ] of trie pointer ; right subtrie links
trie ptr : trie pointer ; the number of nodes in the trie
trie hash: packed array [trie pointer ] of trie pointer ; used to identify equivalent subtries
tini
948. Let us suppose that a linked trie has already been constructed. Experience shows that we can often
reduce its size by recognizing common subtries; therefore another hash table is introduced for this purpose,
somewhat similar to trie op hash. The new hash table will be initialized to zero.
The function trie node(p) returns p if p is distinct from other nodes that it has seen, otherwise it returns
the number of the rst equivalent node that it has seen.
Notice that we might make subtries equivalent even if they correspond to patterns for dierent languages,
in which the trie ops might mean quite dierent things. Thats perfectly all right.
Declare procedures for preprocessing hyphenation patterns 944 +
function trie node(p : trie pointer ): trie pointer ; converts to a canonical form
label exit ;
var h: trie pointer ; trial hash location
q: trie pointer ; trial trie node
begin h abs (trie c[p] + 1009 trie o[p] + 2718 trie l [p] + 3142 trie r [p]) mod trie size;
loop begin q trie hash[h];
if q = 0 then
begin trie hash[h] p; trie node p; return;
end;
if (trie c[q] = trie c[p]) (trie o[q] = trie o[p]) (trie l [q] = trie l [p]) (trie r [q] = trie r [p]) then
begin trie node q; return;
end;
if h > 0 then decr (h) else h trie size;
end;
exit : end;
949 T
E
X82 PART 43: INITIALIZING THE HYPHENATION TABLES 353
949. A neat recursive procedure is now able to compress a trie by traversing it and applying trie node to
its nodes in bottom up fashion. We will compress the entire trie by clearing trie hash to zero and then
saying trie root compress trie(trie root ).
Declare procedures for preprocessing hyphenation patterns 944 +
function compress trie(p : trie pointer ): trie pointer ;
begin if p = 0 then compress trie 0
else begin trie l [p] compress trie(trie l [p]); trie r [p] compress trie(trie r [p]);
compress trie trie node(p);
end;
end;
950. The compressed trie will be packed into the trie array using a top-down rst-t procedure. This
is a little tricky, so the reader should pay close attention: The trie hash array is cleared to zero again and
renamed trie ref for this phase of the operation; later on, trie ref [p] will be nonzero only if the linked trie
node p is the smallest character in a family and if the characters c of that family have been allocated to
locations trie ref [p] + c in the trie array. Locations of trie that are in use will have trie link = 0, while
the unused holes in trie will be doubly linked with trie link pointing to the next larger vacant location and
trie back pointing to the next smaller one. This double linking will have been carried out only as far as
trie max , where trie max is the largest index of trie that will be needed. To save time at the low end of
the trie, we maintain array entries trie min[c] pointing to the smallest hole that is greater than c. Another
array trie taken tells whether or not a given location is equal to trie ref [p] for some p; this array is used to
ensure that distinct nodes in the compressed trie will have distinct trie ref entries.
dene trie ref trie hash where linked trie families go into trie
dene trie back (#) trie[#].lh backward links in trie holes
Global variables 13 +
init trie taken: packed array [1 . . trie size] of boolean; does a family start here?
trie min: array [ASCII code] of trie pointer ; the rst possible slot for each character
trie max : trie pointer ; largest location used in trie
trie not ready: boolean; is the trie still in linked form?
tini
951. Each time \patterns appears, it contributes further patterns to the future trie, which will be built
only when hyphenation is attempted or when a format le is dumped. The boolean variable trie not ready
will change to false when the trie is compressed; this will disable further patterns.
Initialize table entries (done by INITEX only) 164 +
trie not ready true; trie root 0; trie c[0] si (0); trie ptr 0;
952. Here is how the trie-compression data structures are initialized. If storage is tight, it would be possible
to overlap trie op hash, trie op lang , and trie op val with trie, trie hash, and trie taken, because we nish
with the former just before we need the latter.
Get ready to compress the trie 952
Sort the hyphenation op tables into proper order 945 ;
for p 0 to trie size do trie hash[p] 0;
trie root compress trie(trie root ); identify equivalent subtries
for p 0 to trie ptr do trie ref [p] 0;
for p 0 to 255 do trie min[p] p + 1;
trie link (0) 1; trie max 0
This code is used in section 966.
354 PART 43: INITIALIZING THE HYPHENATION TABLES T
E
X82 953
953. The rst t procedure nds the smallest hole z in trie such that a trie family starting at a given
node p will t into vacant positions starting at z. If c = trie c[p], this means that location z c must not
already be taken by some other family, and that z c +c

must be vacant for all characters c

in the family.
The procedure sets trie ref [p] to z c when the rst t has been found.
Declare procedures for preprocessing hyphenation patterns 944 +
procedure rst t (p : trie pointer ); packs a family into trie
label not found , found ;
var h: trie pointer ; candidate for trie ref [p]
z: trie pointer ; runs through holes
q: trie pointer ; runs through the family starting at p
c: ASCII code; smallest character in the family
l, r: trie pointer ; left and right neighbors
ll : 1 . . 256; upper limit of trie min updating
begin c so(trie c[p]); z trie min[c]; get the rst conceivably good hole
loop begin h z c;
Ensure that trie max h + 256 954 ;
if trie taken[h] then goto not found ;
If all characters of the family t relative to h, then goto found , otherwise goto not found 955 ;
not found : z trie link (z); move to the next hole
end;
found : Pack the family into trie relative to h 956 ;
end;
954. By making sure that trie max is at least h +256, we can be sure that trie max > z, since h = z c.
It follows that location trie max will never be occupied in trie, and we will have trie max trie link (z).
Ensure that trie max h + 256 954
if trie max < h + 256 then
begin if trie size h + 256 then overow("patternmemory", trie size);
repeat incr (trie max ); trie taken[trie max ] false; trie link (trie max ) trie max + 1;
trie back (trie max ) trie max 1;
until trie max = h + 256;
end
This code is used in section 953.
955. If all characters of the family t relative to h, then goto found , otherwise goto not found 955
q trie r [p];
while q > 0 do
begin if trie link (h + so(trie c[q])) = 0 then goto not found ;
q trie r [q];
end;
goto found
This code is used in section 953.
956 T
E
X82 PART 43: INITIALIZING THE HYPHENATION TABLES 355
956. Pack the family into trie relative to h 956
trie taken[h] true; trie ref [p] h; q p;
repeat z h + so(trie c[q]); l trie back (z); r trie link (z); trie back (r) l; trie link (l) r;
trie link (z) 0;
if l < 256 then
begin if z < 256 then ll z else ll 256;
repeat trie min[l] r; incr (l);
until l = ll ;
end;
q trie r [q];
until q = 0
This code is used in section 953.
957. To pack the entire linked trie, we use the following recursive procedure.
Declare procedures for preprocessing hyphenation patterns 944 +
procedure trie pack (p : trie pointer ); pack subtries of a family
var q: trie pointer ; a local variable that need not be saved on recursive calls
begin repeat q trie l [p];
if (q > 0) (trie ref [q] = 0) then
begin rst t (q); trie pack (q);
end;
p trie r [p];
until p = 0;
end;
958. When the whole trie has been allocated into the sequential table, we must go through it once again so
that trie contains the correct information. Null pointers in the linked trie will be represented by the value 0,
which properly implements an empty family.
Move the data into trie 958
h.rh 0; h.b0 min quarterword ; h.b1 min quarterword ;
trie link 0, trie op min quarterword , trie char qi (0)
if trie root = 0 then no patterns were given
begin for r 0 to 256 do trie[r] h;
trie max 256;
end
else begin trie x (trie root ); this xes the non-holes in trie
r 0; now we will zero out all the holes
repeat s trie link (r); trie[r] h; r s;
until r > trie max ;
end;
trie char (0) qi ("?"); make trie char (c) ,= c for all c
This code is used in section 966.
356 PART 43: INITIALIZING THE HYPHENATION TABLES T
E
X82 959
959. The xing-up procedure is, of course, recursive. Since the linked trie usually has overlapping subtries,
the same data may be moved several times; but that causes no harm, and at most as much work is done as
it took to build the uncompressed trie.
Declare procedures for preprocessing hyphenation patterns 944 +
procedure trie x (p : trie pointer ); moves p and its siblings into trie
var q: trie pointer ; a local variable that need not be saved on recursive calls
c: ASCII code; another one that need not be saved
z: trie pointer ; trie reference; this local variable must be saved
begin z trie ref [p];
repeat q trie l [p]; c so(trie c[p]); trie link (z + c) trie ref [q]; trie char (z + c) qi (c);
trie op(z + c) trie o[p];
if q > 0 then trie x (q);
p trie r [p];
until p = 0;
end;
960. Now lets go back to the easier problem, of building the linked trie. When INITEX has scanned the
\patterns control sequence, it calls on new patterns to do the right thing.
Declare procedures for preprocessing hyphenation patterns 944 +
procedure new patterns ; initializes the hyphenation pattern data
label done, done1 ;
var k, l: 0 . . 64; indices into hc and hyf ; not always in small number range
digit sensed : boolean; should the next digit be treated as a letter?
v: quarterword ; trie op code
p, q: trie pointer ; nodes of trie traversed during insertion
rst child : boolean; is p = trie l [q]?
c: ASCII code; character being inserted
begin if trie not ready then
begin set cur lang ; scan left brace; a left brace must follow \patterns
Enter all of the patterns into a linked trie, until coming to a right brace 961 ;
end
else begin print err ("Toolatefor"); print esc("patterns");
help1 ("Allpatternsmustbegivenbeforetypesettingbegins."); error ;
link (garbage) scan toks (false, false); ush list (def ref );
end;
end;
961 T
E
X82 PART 43: INITIALIZING THE HYPHENATION TABLES 357
961. Novices are not supposed to be using \patterns, so the error messages are terse. (Note that all error
messages appear in T
E
Xs string pool, even if they are used only by INITEX.)
Enter all of the patterns into a linked trie, until coming to a right brace 961
k 0; hyf [0] 0; digit sensed false;
loop begin get x token;
case cur cmd of
letter , other char : Append a new letter or a hyphen level 962 ;
spacer , right brace: begin if k > 0 then Insert a new pattern into the linked trie 963 ;
if cur cmd = right brace then goto done;
k 0; hyf [0] 0; digit sensed false;
end;
othercases begin print err ("Bad"); print esc("patterns"); help1 ("(SeeAppendixH.)"); error ;
end
endcases;
end;
done:
This code is used in section 960.
962. Append a new letter or a hyphen level 962
if digit sensed (cur chr < "0") (cur chr > "9") then
begin if cur chr = "." then cur chr 0 edge-of-word delimiter
else begin cur chr lc code(cur chr );
if cur chr = 0 then
begin print err ("Nonletter"); help1 ("(SeeAppendixH.)"); error ;
end;
end;
if k < 63 then
begin incr (k); hc[k] cur chr ; hyf [k] 0; digit sensed false;
end;
end
else if k < 63 then
begin hyf [k] cur chr "0"; digit sensed true;
end
This code is used in section 961.
358 PART 43: INITIALIZING THE HYPHENATION TABLES T
E
X82 963
963. When the following code comes into play, the pattern p
1
. . . p
k
appears in hc[1 . . k], and the
corresponding sequence of numbers n
0
. . . n
k
appears in hyf [0 . . k].
Insert a new pattern into the linked trie 963
begin Compute the trie op code, v, and set l 0 965 ;
q 0; hc[0] cur lang ;
while l k do
begin c hc[l]; incr (l); p trie l [q]; rst child true;
while (p > 0) (c > so(trie c[p])) do
begin q p; p trie r [q]; rst child false;
end;
if (p = 0) (c < so(trie c[p])) then
Insert a new trie node between q and p, and make p point to it 964 ;
q p; now node q represents p
1
. . . p
l1

end;
if trie o[q] ,= min quarterword then
begin print err ("Duplicatepattern"); help1 ("(SeeAppendixH.)"); error ;
end;
trie o[q] v;
end
This code is used in section 961.
964. Insert a new trie node between q and p, and make p point to it 964
begin if trie ptr = trie size then overow("patternmemory", trie size);
incr (trie ptr ); trie r [trie ptr ] p; p trie ptr ; trie l [p] 0;
if rst child then trie l [q] p else trie r [q] p;
trie c[p] si (c); trie o[p] min quarterword ;
end
This code is used in section 963.
965. Compute the trie op code, v, and set l 0 965
if hc[1] = 0 then hyf [0] 0;
if hc[k] = 0 then hyf [k] 0;
l k; v min quarterword ;
loop begin if hyf [l] ,= 0 then v new trie op(k l, hyf [l], v);
if l > 0 then decr (l) else goto done1 ;
end;
done1 :
This code is used in section 963.
966 T
E
X82 PART 43: INITIALIZING THE HYPHENATION TABLES 359
966. Finally we put everything together: Here is how the trie gets to its nal, ecient form. The following
packing routine is rigged so that the root of the linked tree gets mapped into location 1 of trie, as required
by the hyphenation algorithm. This happens because the rst call of rst t will take location 1.
Declare procedures for preprocessing hyphenation patterns 944 +
procedure init trie;
var p: trie pointer ; pointer for initialization
j, k, t: integer ; all-purpose registers for initialization
r, s: trie pointer ; used to clean up the packed trie
h: two halves ; template used to zero out tries holes
begin Get ready to compress the trie 952 ;
if trie root ,= 0 then
begin rst t (trie root ); trie pack (trie root );
end;
Move the data into trie 958 ;
trie not ready false;
end;
360 PART 44: BREAKING VERTICAL LISTS INTO PAGES T
E
X82 967
967. Breaking vertical lists into pages. The vsplit procedure, which implements T
E
Xs \vsplit
operation, is considerably simpler than line break because it doesnt have to worry about hyphenation, and
because its mission is to discover a single break instead of an optimum sequence of breakpoints. But before
we get into the details of vsplit , we need to consider a few more basic things.
968. A subroutine called prune page top takes a pointer to a vlist and returns a pointer to a modied vlist
in which all glue, kern, and penalty nodes have been deleted before the rst box or rule node. However, the
rst box or rule is actually preceded by a newly created glue node designed so that the topmost baseline will
be at distance split top skip from the top, whenever this is possible without backspacing.
In this routine and those that follow, we make use of the fact that a vertical list contains no character
nodes, hence the type eld exists for each node in the list.
function prune page top(p : pointer ): pointer ; adjust top after page break
var prev p: pointer ; lags one step behind p
q: pointer ; temporary variable for list manipulation
begin prev p temp head ; link (temp head ) p;
while p ,= null do
case type(p) of
hlist node, vlist node, rule node: Insert glue for split top skip and set p null 969 ;
whatsit node, mark node, ins node: begin prev p p; p link (prev p);
end;
glue node, kern node, penalty node: begin q p; p link (q); link (q) null ; link (prev p) p;
ush node list (q);
end;
othercases confusion("pruning")
endcases;
prune page top link (temp head );
end;
969. Insert glue for split top skip and set p null 969
begin q new skip param(split top skip code); link (prev p) q; link (q) p;
now temp ptr = glue ptr (q)
if width(temp ptr ) > height (p) then width(temp ptr ) width(temp ptr ) height (p)
else width(temp ptr ) 0;
p null ;
end
This code is used in section 968.
970 T
E
X82 PART 44: BREAKING VERTICAL LISTS INTO PAGES 361
970. The next subroutine nds the best place to break a given vertical list so as to obtain a box of
height h, with maximum depth d. A pointer to the beginning of the vertical list is given, and a pointer to
the optimum breakpoint is returned. The list is eectively followed by a forced break, i.e., a penalty node
with the eject penalty; if the best break occurs at this articial node, the value null is returned.
An array of six scaled distances is used to keep track of the height from the beginning of the list to the
current place, just as in line break . In fact, we use one of the same arrays, only changing its name to reect
its new signicance.
dene active height active width new name for the six distance variables
dene cur height active height [1] the natural height
dene set height zero(#) active height [#] 0 initialize the height to zero
dene update heights = 90 go here to record glue in the active height table
function vert break (p : pointer ; h, d : scaled ): pointer ; nds optimum page break
label done, not found , update heights ;
var prev p: pointer ; if p is a glue node, type(prev p) determines whether p is a legal breakpoint
q, r: pointer ; glue specications
pi : integer ; penalty value
b: integer ; badness at a trial breakpoint
least cost : integer ; the smallest badness plus penalties found so far
best place: pointer ; the most recent break that leads to least cost
prev dp: scaled ; depth of previous box in the list
t: small number ; type of the node following a kern
begin prev p p; an initial glue node is not a legal breakpoint
least cost awful bad ; do all six (set height zero); prev dp 0;
loop begin If node p is a legal breakpoint, check if this break is the best known, and goto done if p is
null or if the page-so-far is already too full to accept more stu 972 ;
prev p p; p link (prev p);
end;
done: vert break best place;
end;
971. A global variable best height plus depth will be set to the natural size of the box that corresponds to
the optimum breakpoint found by vert break . (This value is used by the insertion-splitting algorithm of the
page builder.)
Global variables 13 +
best height plus depth: scaled ; height of the best box, without stretching or shrinking
362 PART 44: BREAKING VERTICAL LISTS INTO PAGES T
E
X82 972
972. A subtle point to be noted here is that the maximum depth d might be negative, so cur height and
prev dp might need to be corrected even after a glue or kern node.
If node p is a legal breakpoint, check if this break is the best known, and goto done if p is null or if the
page-so-far is already too full to accept more stu 972
if p = null then pi eject penalty
else Use node p to update the current height and depth measurements; if this node is not a legal
breakpoint, goto not found or update heights , otherwise set pi to the associated penalty at the
break 973 ;
Check if node p is a new champion breakpoint; then goto done if p is a forced break or if the page-so-far
is already too full 974 ;
if (type(p) < glue node) (type(p) > kern node) then goto not found ;
update heights : Update the current height and depth measurements with respect to a glue or kern
node p 976 ;
not found : if prev dp > d then
begin cur height cur height + prev dp d; prev dp d;
end;
This code is used in section 970.
973. Use node p to update the current height and depth measurements; if this node is not a legal
breakpoint, goto not found or update heights , otherwise set pi to the associated penalty at the
break 973
case type(p) of
hlist node, vlist node, rule node: begin
cur height cur height + prev dp + height (p); prev dp depth(p); goto not found ;
end;
whatsit node: Process whatsit p in vert break loop, goto not found 1365 ;
glue node: if precedes break (prev p) then pi 0
else goto update heights ;
kern node: begin if link (p) = null then t penalty node
else t type(link (p));
if t = glue node then pi 0 else goto update heights ;
end;
penalty node: pi penalty(p);
mark node, ins node: goto not found ;
othercases confusion("vertbreak")
endcases
This code is used in section 972.
974 T
E
X82 PART 44: BREAKING VERTICAL LISTS INTO PAGES 363
974. dene deplorable 100000 more than inf bad , but less than awful bad
Check if node p is a new champion breakpoint; then goto done if p is a forced break or if the page-so-far
is already too full 974
if pi < inf penalty then
begin Compute the badness, b, using awful bad if the box is too full 975 ;
if b < awful bad then
if pi eject penalty then b pi
else if b < inf bad then b b + pi
else b deplorable;
if b least cost then
begin best place p; least cost b; best height plus depth cur height + prev dp;
end;
if (b = awful bad ) (pi eject penalty) then goto done;
end
This code is used in section 972.
975. Compute the badness, b, using awful bad if the box is too full 975
if cur height < h then
if (active height [3] ,= 0) (active height [4] ,= 0) (active height [5] ,= 0) then b 0
else b badness (h cur height , active height [2])
else if cur height h > active height [6] then b awful bad
else b badness (cur height h, active height [6])
This code is used in section 974.
976. Vertical lists that are subject to the vert break procedure should not contain innite shrinkability,
since that would permit any amount of information to t on one page.
Update the current height and depth measurements with respect to a glue or kern node p 976
if type(p) = kern node then q p
else begin q glue ptr (p);
active height [2 + stretch order (q)] active height [2 + stretch order (q)] + stretch(q);
active height [6] active height [6] + shrink (q);
if (shrink order (q) ,= normal ) (shrink (q) ,= 0) then
begin
print err ("Infiniteglueshrinkagefoundinboxbeingsplit");
help4 ("Theboxyouare\vsplittingcontainssomeinfinitely")
("shrinkableglue,e.g.,`\vssor`\vskip0ptminus1fil.")
("Suchgluedoesntbelongthere;butyoucansafelyproceed,")
("sincetheoffensiveshrinkabilityhasbeenmadefinite."); error ; r new spec(q);
shrink order (r) normal ; delete glue ref (q); glue ptr (p) r; q r;
end;
end;
cur height cur height + prev dp + width(q); prev dp 0
This code is used in section 972.
364 PART 44: BREAKING VERTICAL LISTS INTO PAGES T
E
X82 977
977. Now we are ready to consider vsplit itself. Most of its work is accomplished by the two subroutines
that we have just considered.
Given the number of a vlist box n, and given a desired page height h, the vsplit function nds the best
initial segment of the vlist and returns a box for a page of height h. The remainder of the vlist, if any,
replaces the original box, after removing glue and penalties and adjusting for split top skip. Mark nodes
in the split-o box are used to set the values of split rst mark and split bot mark ; we use the fact that
split rst mark = null if and only if split bot mark = null .
The original box becomes void if and only if it has been entirely extracted. The extracted box is void
if and only if the original box was void (or if it was, erroneously, an hlist box).
function vsplit (n : eight bits ; h : scaled ): pointer ; extracts a page of height h from box n
label exit , done;
var v: pointer ; the box to be split
p: pointer ; runs through the vlist
q: pointer ; points to where the break occurs
begin v box (n);
if split rst mark ,= null then
begin delete token ref (split rst mark ); split rst mark null ; delete token ref (split bot mark );
split bot mark null ;
end;
Dispense with trivial cases of void or bad boxes 978 ;
q vert break (list ptr (v), h, split max depth);
Look at all the marks in nodes before the break, and set the nal link to null at the break 979 ;
q prune page top(q); p list ptr (v); free node(v, box node size);
if q = null then box (n) null the eq level of the box stays the same
else box (n) vpack (q, natural );
vsplit vpackage(p, h, exactly, split max depth);
exit : end;
978. Dispense with trivial cases of void or bad boxes 978
if v = null then
begin vsplit null ; return;
end;
if type(v) ,= vlist node then
begin print err (""); print esc("vsplit"); print ("needsa"); print esc("vbox");
help2 ("Theboxyouaretryingtosplitisan\hbox.")
("Icantsplitsuchabox,soIllleaveitalone."); error ; vsplit null ; return;
end
This code is used in section 977.
979 T
E
X82 PART 44: BREAKING VERTICAL LISTS INTO PAGES 365
979. Its possible that the box begins with a penalty node that is the best break, so we must be careful
to handle this special case correctly.
Look at all the marks in nodes before the break, and set the nal link to null at the break 979
p list ptr (v);
if p = q then list ptr (v) null
else loop begin if type(p) = mark node then
if split rst mark = null then
begin split rst mark mark ptr (p); split bot mark split rst mark ;
token ref count (split rst mark ) token ref count (split rst mark ) + 2;
end
else begin delete token ref (split bot mark ); split bot mark mark ptr (p);
add token ref (split bot mark );
end;
if link (p) = q then
begin link (p) null ; goto done;
end;
p link (p);
end;
done:
This code is used in section 977.
366 PART 45: THE PAGE BUILDER T
E
X82 980
980. The page builder. When T
E
X appends new material to its main vlist in vertical mode, it uses a
method something like vsplit to decide where a page ends, except that the calculations are done on line
as new items come in. The main complication in this process is that insertions must be put into their boxes
and removed from the vlist, in a more-or-less optimum manner.
We shall use the term current page for that part of the main vlist that is being considered as a candidate
for being broken o and sent to the users output routine. The current page starts at link (page head ), and
it ends at page tail . We have page head = page tail if this list is empty.
Utter chaos would reign if the user kept changing page specications while a page is being constructed,
so the page builder keeps the pertinent specications frozen as soon as the page receives its rst box or
insertion. The global variable page contents is empty when the current page contains only mark nodes and
content-less whatsit nodes; it is inserts only if the page contains only insertion nodes in addition to marks
and whatsits. Glue nodes, kern nodes, and penalty nodes are discarded until a box or rule node appears, at
which time page contents changes to box there. As soon as page contents becomes non-empty, the current
vsize and max depth are squirreled away into page goal and page max depth; the latter values will be used
until the page has been forwarded to the users output routine. The \topskip adjustment is made when
page contents changes to box there.
Although page goal starts out equal to vsize, it is decreased by the scaled natural height-plus-depth of the
insertions considered so far, and by the \skip corrections for those insertions. Therefore it represents the
size into which the non-inserted material should t, assuming that all insertions in the current page have
been made.
The global variables best page break and least page cost correspond respectively to the local variables
best place and least cost in the vert break routine that we have already studied; i.e., they record the location
and value of the best place currently known for breaking the current page. The value of page goal at the
time of the best break is stored in best size.
dene inserts only = 1 page contents when an insert node has been contributed, but no boxes
dene box there = 2 page contents when a box or rule has been contributed
Global variables 13 +
page tail : pointer ; the nal node on the current page
page contents : empty . . box there; what is on the current page so far?
page max depth: scaled ; maximum box depth on page being built
best page break : pointer ; break here to get the best page known so far
least page cost : integer ; the score for this currently best page
best size: scaled ; its page goal
981 T
E
X82 PART 45: THE PAGE BUILDER 367
981. The page builder has another data structure to keep track of insertions. This is a list of four-
word nodes, starting and ending at page ins head . That is, the rst element of the list is node r
1
=
link (page ins head ); node r
j
is followed by r
j+1
= link (r
j
); and if there are n items we have r
n+1
=
page ins head . The subtype eld of each node in this list refers to an insertion number; for example,
\insert 250 would correspond to a node whose subtype is qi (250) (the same as the subtype eld of the
relevant ins node). These subtype elds are in increasing order, and subtype(page ins head ) = qi (255), so
page ins head serves as a convenient sentinel at the end of the list. A record is present for each insertion
number that appears in the current page.
The type eld in these nodes distinguishes two possibilities that might occur as we look ahead before
deciding on the optimum page break. If type(r) = inserting , then height (r) contains the total of the height-
plus-depth dimensions of the box and all its inserts seen so far. If type(r) = split up, then no more insertions
will be made into this box, because at least one previous insertion was too big to t on the current page;
broken ptr (r) points to the node where that insertion will be split, if T
E
X decides to split it, broken ins (r)
points to the insertion node that was tentatively split, and height (r) includes also the natural height plus
depth of the part that would be split o.
In both cases, last ins ptr (r) points to the last ins node encountered for box qo(subtype(r)) that would be
at least partially inserted on the next page; and best ins ptr (r) points to the last such ins node that should
actually be inserted, to get the page with minimum badness among all page breaks considered so far. We
have best ins ptr (r) = null if and only if no insertion for this box should be made to produce this optimum
page.
The data structure denitions here use the fact that the height eld appears in the fourth word of a box
node.
dene page ins node size = 4 number of words for a page insertion node
dene inserting = 0 an insertion class that has not yet overowed
dene split up = 1 an overowed insertion class
dene broken ptr (#) link (# + 1) an insertion for this class will break here if anywhere
dene broken ins (#) info(# + 1) this insertion might break at broken ptr
dene last ins ptr (#) link (# + 2) the most recent insertion for this subtype
dene best ins ptr (#) info(# + 2) the optimum most recent insertion
Initialize the special list heads and constant nodes 790 +
subtype(page ins head ) qi (255); type(page ins head ) split up; link (page ins head ) page ins head ;
368 PART 45: THE PAGE BUILDER T
E
X82 982
982. An array page so far records the heights and depths of everything on the current page. This array
contains six scaled numbers, like the similar arrays already considered in line break and vert break ; and it
also contains page goal and page depth, since these values are all accessible to the user via set page dimen
commands. The value of page so far [1] is also called page total . The stretch and shrink components of the
\skip corrections for each insertion are included in page so far , but the natural space components of these
corrections are not, since they have been subtracted from page goal .
The variable page depth records the depth of the current page; it has been adjusted so that it is at most
page max depth. The variable last glue points to the glue specication of the most recent node contributed
from the contribution list, if this was a glue node; otherwise last glue = max halfword . (If the contribution
list is nonempty, however, the value of last glue is not necessarily accurate.) The variables last penalty and
last kern are similar. And nally, insert penalties holds the sum of the penalties associated with all split
and oating insertions.
dene page goal page so far [0] desired height of information on page being built
dene page total page so far [1] height of the current page
dene page shrink page so far [6] shrinkability of the current page
dene page depth page so far [7] depth of the current page
Global variables 13 +
page so far : array [0 . . 7] of scaled ; height and glue of the current page
last glue: pointer ; used to implement \lastskip
last penalty: integer ; used to implement \lastpenalty
last kern: scaled ; used to implement \lastkern
insert penalties : integer ; sum of the penalties for held-over insertions
983. Put each of T
E
Xs primitives into the hash table 226 +
primitive("pagegoal", set page dimen, 0); primitive("pagetotal", set page dimen, 1);
primitive("pagestretch", set page dimen, 2); primitive("pagefilstretch", set page dimen, 3);
primitive("pagefillstretch", set page dimen, 4); primitive("pagefilllstretch", set page dimen, 5);
primitive("pageshrink", set page dimen, 6); primitive("pagedepth", set page dimen, 7);
984. Cases of print cmd chr for symbolic printing of primitives 227 +
set page dimen: case chr code of
0: print esc("pagegoal");
1: print esc("pagetotal");
2: print esc("pagestretch");
3: print esc("pagefilstretch");
4: print esc("pagefillstretch");
5: print esc("pagefilllstretch");
6: print esc("pageshrink");
othercases print esc("pagedepth")
endcases;
985 T
E
X82 PART 45: THE PAGE BUILDER 369
985. dene print plus end (#) print (#); end
dene print plus (#)
if page so far [#] ,= 0 then
begin print ("plus"); print scaled (page so far [#]); print plus end
procedure print totals ;
begin print scaled (page total ); print plus (2)(""); print plus (3)("fil"); print plus (4)("fill");
print plus (5)("filll");
if page shrink ,= 0 then
begin print ("minus"); print scaled (page shrink );
end;
end;
986. Show the status of the current page 986
if page head ,= page tail then
begin print nl ("###currentpage:");
if output active then print ("(heldoverfornextoutput)");
show box (link (page head ));
if page contents > empty then
begin print nl ("totalheight"); print totals ; print nl ("goalheight");
print scaled (page goal ); r link (page ins head );
while r ,= page ins head do
begin print ln; print esc("insert"); t qo(subtype(r)); print int (t); print ("adds");
if count (t) = 1000 then t height (r)
else t x over n(height (r), 1000) count (t);
print scaled (t);
if type(r) = split up then
begin q page head ; t 0;
repeat q link (q);
if (type(q) = ins node) (subtype(q) = subtype(r)) then incr (t);
until q = broken ins (r);
print (",#"); print int (t); print ("mightsplit");
end;
r link (r);
end;
end;
end
This code is used in section 218.
987. Here is a procedure that is called when the page contents is changing from empty to inserts only or
box there.
dene set page so far zero(#) page so far [#] 0
procedure freeze page specs (s : small number );
begin page contents s; page goal vsize; page max depth max depth; page depth 0;
do all six (set page so far zero); least page cost awful bad ;
stat if tracing pages > 0 then
begin begin diagnostic; print nl ("%%goalheight="); print scaled (page goal );
print (",maxdepth="); print scaled (page max depth); end diagnostic(false);
end; tats
end;
370 PART 45: THE PAGE BUILDER T
E
X82 988
988. Pages are built by appending nodes to the current list in T
E
Xs vertical mode, which is at the
outermost level of the semantic nest. This vlist is split into two parts; the current page that we have been
talking so much about already, and the contribution list that receives new nodes as they are created. The
current page contains everything that the page builder has accounted for in its data structures, as described
above, while the contribution list contains other things that have been generated by other parts of T
E
X but
have not yet been seen by the page builder. The contribution list starts at link (contrib head ), and it ends
at the current node in T
E
Xs vertical mode.
When T
E
X has appended new material in vertical mode, it calls the procedure build page, which tries to
catch up by moving nodes from the contribution list to the current page. This procedure will succeed in its
goal of emptying the contribution list, unless a page break is discovered, i.e., unless the current page has
grown to the point where the optimum next page break has been determined. In the latter case, the nodes
after the optimum break will go back onto the contribution list, and control will eectively pass to the users
output routine.
We make type(page head ) = glue node, so that an initial glue node on the current page will not be
considered a valid breakpoint.
Initialize the special list heads and constant nodes 790 +
type(page head ) glue node; subtype(page head ) normal ;
989. The global variable output active is true during the time the users output routine is driving T
E
X.
Global variables 13 +
output active: boolean; are we in the midst of an output routine?
990. Set initial values of key variables 21 +
output active false; insert penalties 0;
991. The page builder is ready to start a fresh page if we initialize the following state variables. (However,
the page insertion list is initialized elsewhere.)
Start a new current page 991
page contents empty; page tail page head ; link (page head ) null ;
last glue max halfword ; last penalty 0; last kern 0; page depth 0; page max depth 0
This code is used in sections 215 and 1017.
992. At certain times box 255 is supposed to be void (i.e., null ), or an insertion box is supposed to be
ready to accept a vertical list. If not, an error message is printed, and the following subroutine ushes the
unwanted contents, reporting them to the user.
procedure box error (n : eight bits );
begin error ; begin diagnostic; print nl ("Thefollowingboxhasbeendeleted:");
show box (box (n)); end diagnostic(true); ush node list (box (n)); box (n) null ;
end;
993 T
E
X82 PART 45: THE PAGE BUILDER 371
993. The following procedure guarantees that a given box register does not contain an \hbox.
procedure ensure vbox (n : eight bits );
var p: pointer ; the box register contents
begin p box (n);
if p ,= null then
if type(p) = hlist node then
begin print err ("Insertionscanonlybeaddedtoavbox");
help3 ("Tuttut:Youretryingto\insertintoa")
("\boxregisterthatnowcontainsan\hbox.")
("Proceed,andIlldiscarditspresentcontents."); box error (n);
end;
end;
994. T
E
X is not always in vertical mode at the time build page is called; the current mode reects what T
E
X
should return to, after the contribution list has been emptied. A call on build page should be immediately
followed by goto big switch, which is T
E
Xs central control point.
dene contribute = 80 go here to link a node into the current page
Declare the procedure called re up 1012
procedure build page; append contributions to the current page
label exit , done, done1 , continue, contribute, update heights ;
var p: pointer ; the node being appended
q, r: pointer ; nodes being examined
b, c: integer ; badness and cost of current page
pi : integer ; penalty to be added to the badness
n: min quarterword . . 255; insertion box number
delta, h, w: scaled ; sizes used for insertion calculations
begin if (link (contrib head ) = null ) output active then return;
repeat continue: p link (contrib head );
Update the values of last glue, last penalty, and last kern 996 ;
Move node p to the current page; if it is time for a page break, put the nodes following the break
back onto the contribution list, and return to the users output routine if there is one 997 ;
until link (contrib head ) = null ;
Make the contribution list empty by setting its tail to contrib head 995 ;
exit : end;
995. dene contrib tail nest [0].tail eld tail of the contribution list
Make the contribution list empty by setting its tail to contrib head 995
if nest ptr = 0 then tail contrib head vertical mode
else contrib tail contrib head other modes
This code is used in section 994.
372 PART 45: THE PAGE BUILDER T
E
X82 996
996. Update the values of last glue, last penalty, and last kern 996
if last glue ,= max halfword then delete glue ref (last glue);
last penalty 0; last kern 0;
if type(p) = glue node then
begin last glue glue ptr (p); add glue ref (last glue);
end
else begin last glue max halfword ;
if type(p) = penalty node then last penalty penalty(p)
else if type(p) = kern node then last kern width(p);
end
This code is used in section 994.
997. The code here is an example of a many-way switch into routines that merge together in dierent
places. Some people call this unstructured programming, but the author doesnt see much wrong with it, as
long as the various labels have a well-understood meaning.
Move node p to the current page; if it is time for a page break, put the nodes following the break back
onto the contribution list, and return to the users output routine if there is one 997
If the current page is empty and node p is to be deleted, goto done1 ; otherwise use node p to update
the state of the current page; if this node is an insertion, goto contribute; otherwise if this node is
not a legal breakpoint, goto contribute or update heights ; otherwise set pi to the penalty associated
with this breakpoint 1000 ;
Check if node p is a new champion breakpoint; then if it is time for a page break, prepare for output,
and either re up the users output routine and return or ship out the page and goto done 1005 ;
if (type(p) < glue node) (type(p) > kern node) then goto contribute;
update heights : Update the current page measurements with respect to the glue or kern specied by
node p 1004 ;
contribute: Make sure that page max depth is not exceeded 1003 ;
Link node p into the current page and goto done 998 ;
done1 : Recycle node p 999 ;
done:
This code is used in section 994.
998. Link node p into the current page and goto done 998
link (page tail ) p; page tail p; link (contrib head ) link (p); link (p) null ; goto done
This code is used in section 997.
999. Recycle node p 999
link (contrib head ) link (p); link (p) null ; ush node list (p)
This code is used in section 997.
1000 T
E
X82 PART 45: THE PAGE BUILDER 373
1000. The title of this section is already so long, it seems best to avoid making it more accurate but still
longer, by mentioning the fact that a kern node at the end of the contribution list will not be contributed
until we know its successor.
If the current page is empty and node p is to be deleted, goto done1 ; otherwise use node p to update the
state of the current page; if this node is an insertion, goto contribute; otherwise if this node is not a
legal breakpoint, goto contribute or update heights ; otherwise set pi to the penalty associated with
this breakpoint 1000
case type(p) of
hlist node, vlist node, rule node: if page contents < box there then
Initialize the current page, insert the \topskip glue ahead of p, and goto continue 1001
else Prepare to move a box or rule node to the current page, then goto contribute 1002 ;
whatsit node: Prepare to move whatsit p to the current page, then goto contribute 1364 ;
glue node: if page contents < box there then goto done1
else if precedes break (page tail ) then pi 0
else goto update heights ;
kern node: if page contents < box there then goto done1
else if link (p) = null then return
else if type(link (p)) = glue node then pi 0
else goto update heights ;
penalty node: if page contents < box there then goto done1 else pi penalty(p);
mark node: goto contribute;
ins node: Append an insertion to the current page and goto contribute 1008 ;
othercases confusion("page")
endcases
This code is used in section 997.
1001. Initialize the current page, insert the \topskip glue ahead of p, and goto continue 1001
begin if page contents = empty then freeze page specs (box there)
else page contents box there;
q new skip param(top skip code); now temp ptr = glue ptr (q)
if width(temp ptr ) > height (p) then width(temp ptr ) width(temp ptr ) height (p)
else width(temp ptr ) 0;
link (q) p; link (contrib head ) q; goto continue;
end
This code is used in section 1000.
1002. Prepare to move a box or rule node to the current page, then goto contribute 1002
begin page total page total + page depth + height (p); page depth depth(p); goto contribute;
end
This code is used in section 1000.
1003. Make sure that page max depth is not exceeded 1003
if page depth > page max depth then
begin page total page total + page depth page max depth;
page depth page max depth;
end;
This code is used in section 997.
374 PART 45: THE PAGE BUILDER T
E
X82 1004
1004. Update the current page measurements with respect to the glue or kern specied by node p 1004
if type(p) = kern node then q p
else begin q glue ptr (p);
page so far [2 + stretch order (q)] page so far [2 + stretch order (q)] + stretch(q);
page shrink page shrink + shrink (q);
if (shrink order (q) ,= normal ) (shrink (q) ,= 0) then
begin
print err ("Infiniteglueshrinkagefoundoncurrentpage");
help4 ("Thepageabouttobeoutputcontainssomeinfinitely")
("shrinkableglue,e.g.,`\vssor`\vskip0ptminus1fil.")
("Suchgluedoesntbelongthere;butyoucansafelyproceed,")
("sincetheoffensiveshrinkabilityhasbeenmadefinite."); error ; r new spec(q);
shrink order (r) normal ; delete glue ref (q); glue ptr (p) r; q r;
end;
end;
page total page total + page depth + width(q); page depth 0
This code is used in section 997.
1005. Check if node p is a new champion breakpoint; then if it is time for a page break, prepare for
output, and either re up the users output routine and return or ship out the page and goto
done 1005
if pi < inf penalty then
begin Compute the badness, b, of the current page, using awful bad if the box is too full 1007 ;
if b < awful bad then
if pi eject penalty then c pi
else if b < inf bad then c b + pi + insert penalties
else c deplorable
else c b;
if insert penalties 10000 then c awful bad ;
stat if tracing pages > 0 then Display the page break cost 1006 ;
tats
if c least page cost then
begin best page break p; best size page goal ; least page cost c; r link (page ins head );
while r ,= page ins head do
begin best ins ptr (r) last ins ptr (r); r link (r);
end;
end;
if (c = awful bad ) (pi eject penalty) then
begin re up(p); output the current page at the best place
if output active then return; users output routine will act
goto done; the page has been shipped out by default output routine
end;
end
This code is used in section 997.
1006 T
E
X82 PART 45: THE PAGE BUILDER 375
1006. Display the page break cost 1006
begin begin diagnostic; print nl ("%"); print ("t="); print totals ;
print ("g="); print scaled (page goal );
print ("b=");
if b = awful bad then print char ("*") else print int (b);
print ("p="); print int (pi ); print ("c=");
if c = awful bad then print char ("*") else print int (c);
if c least page cost then print char ("#");
end diagnostic(false);
end
This code is used in section 1005.
1007. Compute the badness, b, of the current page, using awful bad if the box is too full 1007
if page total < page goal then
if (page so far [3] ,= 0) (page so far [4] ,= 0) (page so far [5] ,= 0) then b 0
else b badness (page goal page total , page so far [2])
else if page total page goal > page shrink then b awful bad
else b badness (page total page goal , page shrink )
This code is used in section 1005.
1008. Append an insertion to the current page and goto contribute 1008
begin if page contents = empty then freeze page specs (inserts only);
n subtype(p); r page ins head ;
while n subtype(link (r)) do r link (r);
n qo(n);
if subtype(r) ,= qi (n) then Create a page insertion node with subtype(r) = qi (n), and include the glue
correction for box n in the current page state 1009 ;
if type(r) = split up then insert penalties insert penalties + oat cost (p)
else begin last ins ptr (r) p; delta page goal page total page depth + page shrink ;
this much room is left if we shrink the maximum
if count (n) = 1000 then h height (p)
else h x over n(height (p), 1000) count (n); this much room is needed
if ((h 0) (h delta)) (height (p) + height (r) dimen(n)) then
begin page goal page goal h; height (r) height (r) + height (p);
end
else Find the best way to split the insertion, and change type(r) to split up 1010 ;
end;
goto contribute;
end
This code is used in section 1000.
376 PART 45: THE PAGE BUILDER T
E
X82 1009
1009. We take note of the value of \skip n and the height plus depth of \box n only when the rst
\insert n node is encountered for a new page. A user who changes the contents of \box n after that rst
\insert n had better be either extremely careful or extremely lucky, or both.
Create a page insertion node with subtype(r) = qi (n), and include the glue correction for box n in the
current page state 1009
begin q get node(page ins node size); link (q) link (r); link (r) q; r q; subtype(r) qi (n);
type(r) inserting ; ensure vbox (n);
if box (n) = null then height (r) 0
else height (r) height (box (n)) + depth(box (n));
best ins ptr (r) null ;
q skip(n);
if count (n) = 1000 then h height (r)
else h x over n(height (r), 1000) count (n);
page goal page goal h width(q);
page so far [2 + stretch order (q)] page so far [2 + stretch order (q)] + stretch(q);
page shrink page shrink + shrink (q);
if (shrink order (q) ,= normal ) (shrink (q) ,= 0) then
begin print err ("Infiniteglueshrinkageinsertedfrom"); print esc("skip"); print int (n);
help3 ("Thecorrectionglueforpagebreakingwithinsertions")
("musthavefiniteshrinkability.Butyoumayproceed,")
("sincetheoffensiveshrinkabilityhasbeenmadefinite."); error ;
end;
end
This code is used in section 1008.
1010. Here is the code that will split a long footnote between pages, in an emergency. The current situation
deserves to be recapitulated: Node p is an insertion into box n; the insertion will not t, in its entirety, either
because it would make the total contents of box n greater than \dimen n, or because it would make the
incremental amount of growth h greater than the available space delta, or both. (This amount h has been
weighted by the insertion scaling factor, i.e., by \count n over 1000.) Now we will choose the best way to
break the vlist of the insertion, using the same criteria as in the \vsplit operation.
Find the best way to split the insertion, and change type(r) to split up 1010
begin if count (n) 0 then w max dimen
else begin w page goal page total page depth;
if count (n) ,= 1000 then w x over n(w, count (n)) 1000;
end;
if w > dimen(n) height (r) then w dimen(n) height (r);
q vert break (ins ptr (p), w, depth(p)); height (r) height (r) + best height plus depth;
stat if tracing pages > 0 then Display the insertion split cost 1011 ;
tats
if count (n) ,= 1000 then best height plus depth x over n(best height plus depth, 1000) count (n);
page goal page goal best height plus depth; type(r) split up; broken ptr (r) q;
broken ins (r) p;
if q = null then insert penalties insert penalties + eject penalty
else if type(q) = penalty node then insert penalties insert penalties + penalty(q);
end
This code is used in section 1008.
1011 T
E
X82 PART 45: THE PAGE BUILDER 377
1011. Display the insertion split cost 1011
begin begin diagnostic; print nl ("%split"); print int (n); print ("to"); print scaled (w);
print char (","); print scaled (best height plus depth);
print ("p=");
if q = null then print int (eject penalty)
else if type(q) = penalty node then print int (penalty(q))
else print char ("0");
end diagnostic(false);
end
This code is used in section 1010.
1012. When the page builder has looked at as much material as could appear before the next page break,
it makes its decision. The break that gave minimum badness will be used to put a completed page into
box 255, with insertions appended to their other boxes.
We also set the values of top mark , rst mark , and bot mark . The program uses the fact that bot mark ,=
null implies rst mark ,= null ; it also knows that bot mark = null implies top mark = rst mark = null .
The re up subroutine prepares to output the current page at the best place; then it res up the users
output routine, if there is one, or it simply ships out the page. There is one parameter, c, which represents
the node that was being contributed to the page when the decision to force an output was made.
Declare the procedure called re up 1012
procedure re up(c : pointer );
label exit ;
var p, q, r, s: pointer ; nodes being examined and/or changed
prev p: pointer ; predecessor of p
n: min quarterword . . 255; insertion box number
wait : boolean; should the present insertion be held over?
save vbadness : integer ; saved value of vbadness
save vfuzz : scaled ; saved value of vfuzz
save split top skip: pointer ; saved value of split top skip
begin Set the value of output penalty 1013 ;
if bot mark ,= null then
begin if top mark ,= null then delete token ref (top mark );
top mark bot mark ; add token ref (top mark ); delete token ref (rst mark ); rst mark null ;
end;
Put the optimal current page into box 255, update rst mark and bot mark , append insertions to their
boxes, and put the remaining nodes back on the contribution list 1014 ;
if (top mark ,= null ) (rst mark = null ) then
begin rst mark top mark ; add token ref (top mark );
end;
if output routine ,= null then
if dead cycles max dead cycles then
Explain that too many dead cycles have occurred in a row 1024
else Fire up the users output routine and return 1025 ;
Perform the default output routine 1023 ;
exit : end;
This code is used in section 994.
378 PART 45: THE PAGE BUILDER T
E
X82 1013
1013. Set the value of output penalty 1013
if type(best page break ) = penalty node then
begin geq word dene(int base + output penalty code, penalty(best page break ));
penalty(best page break ) inf penalty;
end
else geq word dene(int base + output penalty code, inf penalty)
This code is used in section 1012.
1014. As the page is nally being prepared for output, pointer p runs through the vlist, with prev p trailing
behind; pointer q is the tail of a list of insertions that are being held over for a subsequent page.
Put the optimal current page into box 255, update rst mark and bot mark , append insertions to their
boxes, and put the remaining nodes back on the contribution list 1014
if c = best page break then best page break null ; c not yet linked in
Ensure that box 255 is empty before output 1015 ;
insert penalties 0; this will count the number of insertions held over
save split top skip split top skip;
if holding inserts 0 then Prepare all the boxes involved in insertions to act as queues 1018 ;
q hold head ; link (q) null ; prev p page head ; p link (prev p);
while p ,= best page break do
begin if type(p) = ins node then
begin if holding inserts 0 then Either insert the material specied by node p into the
appropriate box, or hold it for the next page; also delete node p from the current page 1020 ;
end
else if type(p) = mark node then Update the values of rst mark and bot mark 1016 ;
prev p p; p link (prev p);
end;
split top skip save split top skip; Break the current page at node p, put it in box 255, and put the
remaining nodes on the contribution list 1017 ;
Delete the page-insertion nodes 1019
This code is used in section 1012.
1015. Ensure that box 255 is empty before output 1015
if box (255) ,= null then
begin print err (""); print esc("box"); print ("255isnotvoid");
help2 ("Youshouldntuse\box255exceptin\outputroutines.")
("Proceed,andIlldiscarditspresentcontents."); box error (255);
end
This code is used in section 1014.
1016. Update the values of rst mark and bot mark 1016
begin if rst mark = null then
begin rst mark mark ptr (p); add token ref (rst mark );
end;
if bot mark ,= null then delete token ref (bot mark );
bot mark mark ptr (p); add token ref (bot mark );
end
This code is used in section 1014.
1017 T
E
X82 PART 45: THE PAGE BUILDER 379
1017. When the following code is executed, the current page runs from node link (page head ) to node
prev p, and the nodes from p to page tail are to be placed back at the front of the contribution list.
Furthermore the heldover insertions appear in a list from link (hold head ) to q; we will put them into the
current page list for safekeeping while the users output routine is active. We might have q = hold head ; and
p = null if and only if prev p = page tail . Error messages are suppressed within vpackage, since the box
might appear to be overfull or underfull simply because the stretch and shrink from the \skip registers for
inserts are not actually present in the box.
Break the current page at node p, put it in box 255, and put the remaining nodes on the contribution
list 1017
if p ,= null then
begin if link (contrib head ) = null then
if nest ptr = 0 then tail page tail
else contrib tail page tail ;
link (page tail ) link (contrib head ); link (contrib head ) p; link (prev p) null ;
end;
save vbadness vbadness ; vbadness inf bad ; save vfuzz vfuzz ; vfuzz max dimen;
inhibit error messages
box (255) vpackage(link (page head ), best size, exactly, page max depth); vbadness save vbadness ;
vfuzz save vfuzz ;
if last glue ,= max halfword then delete glue ref (last glue);
Start a new current page 991 ; this sets last glue max halfword
if q ,= hold head then
begin link (page head ) link (hold head ); page tail q;
end
This code is used in section 1014.
1018. If many insertions are supposed to go into the same box, we want to know the position of the
last node in that box, so that we dont need to waste time when linking further information into it. The
last ins ptr elds of the page insertion nodes are therefore used for this purpose during the packaging phase.
Prepare all the boxes involved in insertions to act as queues 1018
begin r link (page ins head );
while r ,= page ins head do
begin if best ins ptr (r) ,= null then
begin n qo(subtype(r)); ensure vbox (n);
if box (n) = null then box (n) new null box ;
p box (n) + list oset ;
while link (p) ,= null do p link (p);
last ins ptr (r) p;
end;
r link (r);
end;
end
This code is used in section 1014.
1019. Delete the page-insertion nodes 1019
r link (page ins head );
while r ,= page ins head do
begin q link (r); free node(r, page ins node size); r q;
end;
link (page ins head ) page ins head
This code is used in section 1014.
380 PART 45: THE PAGE BUILDER T
E
X82 1020
1020. We will set best ins ptr null and package the box corresponding to insertion node r, just after
making the nal insertion into that box. If this nal insertion is split up, the remainder after splitting and
pruning (if any) will be carried over to the next page.
Either insert the material specied by node p into the appropriate box, or hold it for the next page; also
delete node p from the current page 1020
begin r link (page ins head );
while subtype(r) ,= subtype(p) do r link (r);
if best ins ptr (r) = null then wait true
else begin wait false; s last ins ptr (r); link (s) ins ptr (p);
if best ins ptr (r) = p then Wrap up the box specied by node r, splitting node p if called for; set
wait true if node p holds a remainder after splitting 1021
else begin while link (s) ,= null do s link (s);
last ins ptr (r) s;
end;
end;
Either append the insertion node p after node q, and remove it from the current page, or delete
node(p) 1022 ;
end
This code is used in section 1014.
1021. Wrap up the box specied by node r, splitting node p if called for; set wait true if node p
holds a remainder after splitting 1021
begin if type(r) = split up then
if (broken ins (r) = p) (broken ptr (r) ,= null ) then
begin while link (s) ,= broken ptr (r) do s link (s);
link (s) null ; split top skip split top ptr (p); ins ptr (p) prune page top(broken ptr (r));
if ins ptr (p) ,= null then
begin temp ptr vpack (ins ptr (p), natural ); height (p) height (temp ptr ) + depth(temp ptr );
free node(temp ptr , box node size); wait true;
end;
end;
best ins ptr (r) null ; n qo(subtype(r)); temp ptr list ptr (box (n));
free node(box (n), box node size); box (n) vpack (temp ptr , natural );
end
This code is used in section 1020.
1022. Either append the insertion node p after node q, and remove it from the current page, or delete
node(p) 1022
link (prev p) link (p); link (p) null ;
if wait then
begin link (q) p; q p; incr (insert penalties );
end
else begin delete glue ref (split top ptr (p)); free node(p, ins node size);
end;
p prev p
This code is used in section 1020.
1023 T
E
X82 PART 45: THE PAGE BUILDER 381
1023. The list of heldover insertions, running from link (page head ) to page tail , must be moved to the
contribution list when the user has specied no output routine.
Perform the default output routine 1023
begin if link (page head ) ,= null then
begin if link (contrib head ) = null then
if nest ptr = 0 then tail page tail else contrib tail page tail
else link (page tail ) link (contrib head );
link (contrib head ) link (page head ); link (page head ) null ; page tail page head ;
end;
ship out (box (255)); box (255) null ;
end
This code is used in section 1012.
1024. Explain that too many dead cycles have occurred in a row 1024
begin print err ("Outputloop"); print int (dead cycles ); print ("consecutivedeadcycles");
help3 ("Iveconcludedthatyour\outputisawry;itneverdoesa")
("\shipout,soImshipping\box255outmyself.Nexttime")
("increase\maxdeadcyclesifyouwantmetobemorepatient!"); error ;
end
This code is used in section 1012.
1025. Fire up the users output routine and return 1025
begin output active true; incr (dead cycles ); push nest ; mode vmode;
prev depth ignore depth; mode line line; begin token list (output routine, output text );
new save level (output group); normal paragraph; scan left brace; return;
end
This code is used in section 1012.
1026. When the users output routine nishes, it has constructed a vlist in internal vertical mode, and
T
E
X will do the following:
Resume the page builder after an output routine has come to an end 1026
begin if (loc ,= null ) ((token type ,= output text ) (token type ,= backed up)) then
Recover from an unbalanced output routine 1027 ;
end token list ; conserve stack space in case more outputs are triggered
end graf ; unsave; output active false; insert penalties 0;
Ensure that box 255 is empty after output 1028 ;
if tail ,= head then current list goes after heldover insertions
begin link (page tail ) link (head ); page tail tail ;
end;
if link (page head ) ,= null then and both go before heldover contributions
begin if link (contrib head ) = null then contrib tail page tail ;
link (page tail ) link (contrib head ); link (contrib head ) link (page head ); link (page head ) null ;
page tail page head ;
end;
pop nest ; build page;
end
This code is used in section 1100.
382 PART 45: THE PAGE BUILDER T
E
X82 1027
1027. Recover from an unbalanced output routine 1027
begin print err ("Unbalancedoutputroutine");
help2 ("Yoursneakyoutputroutinehasproblematic{sand/or}s.")
("Icanthandlethatverywell;goodluck."); error ;
repeat get token;
until loc = null ;
end loops forever if reading from a le, since null = min halfword 0
This code is used in section 1026.
1028. Ensure that box 255 is empty after output 1028
if box (255) ,= null then
begin print err ("Outputroutinedidntuseallof"); print esc("box"); print int (255);
help3 ("Your\outputcommandsshouldempty\box255,")
("e.g.,bysaying`\shipout\box255.")
("Proceed;Illdiscarditspresentcontents."); box error (255);
end
This code is used in section 1026.
1029 T
E
X82 PART 46: THE CHIEF EXECUTIVE 383
1029. The chief executive. We come now to the main control routine, which contains the master
switch that causes all the various pieces of T
E
X to do their things, in the right order.
In a sense, this is the grand climax of the program: It applies all the tools that we have worked so hard
to construct. In another sense, this is the messiest part of the program: It necessarily refers to other pieces
of code all over the place, so that a person cant fully understand what is going on without paging back
and forth to be reminded of conventions that are dened elsewhere. We are now at the hub of the web, the
central nervous system that touches most of the other parts and ties them together.
The structure of main control itself is quite simple. Theres a label called big switch, at which point the
next token of input is fetched using get x token. Then the program branches at high speed into one of about
100 possible directions, based on the value of the current mode and the newly fetched command code; the
sum abs (mode) + cur cmd indicates what to do next. For example, the case vmode + letter arises when a
letter occurs in vertical mode (or internal vertical mode); this case leads to instructions that initialize a new
paragraph and enter horizontal mode.
The big case statement that contains this multiway switch has been labeled reswitch, so that the program
can goto reswitch when the next token has already been fetched. Most of the cases are quite short; they
call an action procedure that does the work for that case, and then they either goto reswitch or they fall
through to the end of the case statement, which returns control back to big switch. Thus, main control is
not an extremely large procedure, in spite of the multiplicity of things it must do; it is small enough to be
handled by Pascal compilers that put severe restrictions on procedure size.
One case is singled out for special treatment, because it accounts for most of T
E
Xs activities in typical
applications. The process of reading simple text and converting it into char node records, while looking for
ligatures and kerns, is part of T
E
Xs inner loop; the whole program runs eciently when its inner loop is
fast, so this part has been written with particular care.
384 PART 46: THE CHIEF EXECUTIVE T
E
X82 1030
1030. We shall concentrate rst on the inner loop of main control , deferring consideration of the other
cases until later.
dene big switch = 60 go here to branch on the next token of input
dene main loop = 70 go here to typeset a string of consecutive characters
dene main loop wrapup = 80 go here to nish a character or ligature
dene main loop move = 90 go here to advance the ligature cursor
dene main loop move lig = 95 same, when advancing past a generated ligature
dene main loop lookahead = 100 go here to bring in another character, if any
dene main lig loop = 110 go here to check for ligatures or kerning
dene append normal space = 120 go here to append a normal space between words
Declare action procedures for use by main control 1043
Declare the procedure called handle right brace 1068
procedure main control ; governs T
E
Xs activities
label big switch, reswitch, main loop, main loop wrapup, main loop move, main loop move + 1,
main loop move + 2, main loop move lig , main loop lookahead , main loop lookahead + 1,
main lig loop, main lig loop + 1, main lig loop + 2, append normal space, exit ;
var t: integer ; general-purpose temporary variable
begin if every job ,= null then begin token list (every job, every job text );
big switch: get x token;
reswitch: Give diagnostic information, if requested 1031 ;
case abs (mode) + cur cmd of
hmode + letter , hmode + other char , hmode + char given: goto main loop;
hmode + char num: begin scan char num; cur chr cur val ; goto main loop; end;
hmode + no boundary: begin get x token;
if (cur cmd = letter ) (cur cmd = other char ) (cur cmd = char given) (cur cmd = char num)
then cancel boundary true;
goto reswitch;
end;
hmode + spacer : if space factor = 1000 then goto append normal space
else app space;
hmode + ex space, mmode + ex space: goto append normal space;
Cases of main control that are not part of the inner loop 1045
end; of the big case statement
goto big switch;
main loop: Append character cur chr and the following characters (if any) to the current hlist in the
current font; goto reswitch when a non-character has been fetched 1034 ;
append normal space: Append a normal inter-word space to the current list, then goto big switch 1041 ;
exit : end;
1031. When a new token has just been fetched at big switch, we have an ideal place to monitor T
E
Xs
activity.
Give diagnostic information, if requested 1031
if interrupt ,= 0 then
if OK to interrupt then
begin back input ; check interrupt ; goto big switch;
end;
debug if panicking then check mem(false); gubed
if tracing commands > 0 then show cur cmd chr
This code is used in section 1030.
1032 T
E
X82 PART 46: THE CHIEF EXECUTIVE 385
1032. The following part of the program was rst written in a structured manner, according to the
philosophy that premature optimization is the root of all evil. Then it was rearranged into pieces of
spaghetti so that the most common actions could proceed with little or no redundancy.
The original unoptimized form of this algorithm resembles the reconstitute procedure, which was described
earlier in connection with hyphenation. Again we have an implied cursor between characters cur l and
cur r . The main dierence is that the lig stack can now contain a charnode as well as pseudo-ligatures; that
stack is now usually nonempty, because the next character of input (if any) has been appended to it. In
main control we have
cur r =

character (lig stack ), if lig stack > null ;

font bchar [cur font ], otherwise;
except when character (lig stack ) = font false bchar [cur font ]. Several additional global variables are needed.
Global variables 13 +
main f : internal font number ; the current font
main i : four quarters ; character information bytes for cur l
main j : four quarters ; ligature/kern command
main k : font index ; index into font info
main p: pointer ; temporary register for list manipulation
main s : integer ; space factor value
bchar : halfword ; right boundary character of current font, or non char
false bchar : halfword ; nonexistent character matching bchar , or non char
cancel boundary: boolean; should the left boundary be ignored?
ins disc: boolean; should we insert a discretionary node?
1033. The boolean variables of the main loop are normally false, and always reset to false before the loop
is left. That saves us the extra work of initializing each time.
Set initial values of key variables 21 +
ligature present false; cancel boundary false; lft hit false; rt hit false; ins disc false;
386 PART 46: THE CHIEF EXECUTIVE T
E
X82 1034
1034. We leave the space factor unchanged if sf code(cur chr ) = 0; otherwise we set it equal to sf code(cur chr ),
except that it should never change from a value less than 1000 to a value exceeding 1000. The most common
case is sf code(cur chr ) = 1000, so we want that case to be fast.
The overall structure of the main loop is presented here. Some program labels are inside the individual
sections.
dene adjust space factor
main s sf code(cur chr );
if main s = 1000 then space factor 1000
else if main s < 1000 then
begin if main s > 0 then space factor main s ;
end
else if space factor < 1000 then space factor 1000
else space factor main s
Append character cur chr and the following characters (if any) to the current hlist in the current font;
goto reswitch when a non-character has been fetched 1034
adjust space factor ;
main f cur font ; bchar font bchar [main f ]; false bchar font false bchar [main f ];
if mode > 0 then
if language ,= clang then x language;
fast get avail (lig stack ); font (lig stack ) main f ; cur l qi (cur chr ); character (lig stack ) cur l ;
cur q tail ;
if cancel boundary then
begin cancel boundary false; main k non address ;
end
else main k bchar label [main f ];
if main k = non address then goto main loop move + 2; no left boundary processing
cur r cur l ; cur l non char ; goto main lig loop + 1; begin with cursor after left boundary
main loop wrapup: Make a ligature node, if ligature present ; insert a null discretionary, if
appropriate 1035 ;
main loop move: If the cursor is immediately followed by the right boundary, goto reswitch; if its
followed by an invalid character, goto big switch; otherwise move the cursor one step to the right
and goto main lig loop 1036 ;
main loop lookahead : Look ahead for another character, or leave lig stack empty if theres none there 1038 ;
main lig loop: If theres a ligature/kern command relevant to cur l and cur r , adjust the text
appropriately; exit to main loop wrapup 1039 ;
main loop move lig : Move the cursor past a pseudo-ligature, then goto main loop lookahead or
main lig loop 1037
This code is used in section 1030.
1035 T
E
X82 PART 46: THE CHIEF EXECUTIVE 387
1035. If link (cur q ) is nonnull when wrapup is invoked, cur q points to the list of characters that were
consumed while building the ligature character cur l .
A discretionary break is not inserted for an explicit hyphen when we are in restricted horizontal mode. In
particular, this avoids putting discretionary nodes inside of other discretionaries.
dene pack lig (#) the parameter is either rt hit or false
begin main p new ligature(main f , cur l , link (cur q ));
if lft hit then
begin subtype(main p) 2; lft hit false;
end;
if # then
if lig stack = null then
begin incr (subtype(main p)); rt hit false;
end;
link (cur q ) main p; tail main p; ligature present false;
end
dene wrapup(#)
if cur l < non char then
begin if link (cur q ) > null then
if character (tail ) = qi (hyphen char [main f ]) then ins disc true;
if ligature present then pack lig (#);
if ins disc then
begin ins disc false;
if mode > 0 then tail append (new disc);
end;
end
Make a ligature node, if ligature present ; insert a null discretionary, if appropriate 1035
wrapup(rt hit )
This code is used in section 1034.
1036. If the cursor is immediately followed by the right boundary, goto reswitch; if its followed by
an invalid character, goto big switch; otherwise move the cursor one step to the right and goto
main lig loop 1036
if lig stack = null then goto reswitch;
cur q tail ; cur l character (lig stack );
main loop move + 1: if is char node(lig stack ) then goto main loop move lig ;
main loop move + 2: if (cur chr < font bc[main f ]) (cur chr > font ec[main f ]) then
begin char warning (main f , cur chr ); free avail (lig stack ); goto big switch;
end;
main i char info(main f )(cur l );
if char exists (main i ) then
begin char warning (main f , cur chr ); free avail (lig stack ); goto big switch;
end;
link (tail ) lig stack ; tail lig stack main loop lookahead is next
This code is used in section 1034.
388 PART 46: THE CHIEF EXECUTIVE T
E
X82 1037
1037. Here we are at main loop move lig . When we begin this code we have cur q = tail and cur l =
character (lig stack ).
Move the cursor past a pseudo-ligature, then goto main loop lookahead or main lig loop 1037
main p lig ptr (lig stack );
if main p > null then tail append (main p); append a single character
temp ptr lig stack ; lig stack link (temp ptr ); free node(temp ptr , small node size);
main i char info(main f )(cur l ); ligature present true;
if lig stack = null then
if main p > null then goto main loop lookahead
else cur r bchar
else cur r character (lig stack );
goto main lig loop
This code is used in section 1034.
1038. The result of \char can participate in a ligature or kern, so we must look ahead for it.
Look ahead for another character, or leave lig stack empty if theres none there 1038
get next ; set only cur cmd and cur chr , for speed
if cur cmd = letter then goto main loop lookahead + 1;
if cur cmd = other char then goto main loop lookahead + 1;
if cur cmd = char given then goto main loop lookahead + 1;
x token; now expand and set cur cmd , cur chr , cur tok
if cur cmd = letter then goto main loop lookahead + 1;
if cur cmd = other char then goto main loop lookahead + 1;
if cur cmd = char given then goto main loop lookahead + 1;
if cur cmd = char num then
begin scan char num; cur chr cur val ; goto main loop lookahead + 1;
end;
if cur cmd = no boundary then bchar non char ;
cur r bchar ; lig stack null ; goto main lig loop;
main loop lookahead + 1: adjust space factor ; fast get avail (lig stack ); font (lig stack ) main f ;
cur r qi (cur chr ); character (lig stack ) cur r ;
if cur r = false bchar then cur r non char this prevents spurious ligatures
This code is used in section 1034.
1039 T
E
X82 PART 46: THE CHIEF EXECUTIVE 389
1039. Even though comparatively few characters have a lig/kern program, several of the instructions here
count as part of T
E
Xs inner loop, since a potentially long sequential search must be performed. For example,
tests with Computer Modern Roman showed that about 40 per cent of all characters actually encountered
in practice had a lig/kern program, and that about four lig/kern commands were investigated for every such
character.
At the beginning of this code we have main i = char info(main f )(cur l ).
If theres a ligature/kern command relevant to cur l and cur r , adjust the text appropriately; exit to
main loop wrapup 1039
if char tag (main i ) ,= lig tag then goto main loop wrapup;
if cur r = non char then goto main loop wrapup;
main k lig kern start (main f )(main i ); main j font info[main k ].qqqq ;
if skip byte(main j ) stop ag then goto main lig loop + 2;
main k lig kern restart (main f )(main j );
main lig loop + 1: main j font info[main k ].qqqq ;
main lig loop + 2: if next char (main j ) = cur r then
if skip byte(main j ) stop ag then Do ligature or kern command, returning to main lig loop or
main loop wrapup or main loop move 1040 ;
if skip byte(main j ) = qi (0) then incr (main k )
else begin if skip byte(main j ) stop ag then goto main loop wrapup;
main k main k + qo(skip byte(main j )) + 1;
end;
goto main lig loop + 1
This code is used in section 1034.
390 PART 46: THE CHIEF EXECUTIVE T
E
X82 1040
1040. When a ligature or kern instruction matches a character, we know from read font info that the
character exists in the font, even though we havent veried its existence in the normal way.
This section could be made into a subroutine, if the code inside main control needs to be shortened.
Do ligature or kern command, returning to main lig loop or main loop wrapup or main loop move 1040
begin if op byte(main j ) kern ag then
begin wrapup(rt hit ); tail append (new kern(char kern(main f )(main j ))); goto main loop move;
end;
if cur l = non char then lft hit true
else if lig stack = null then rt hit true;
check interrupt ; allow a way out in case theres an innite ligature loop
case op byte(main j ) of
qi (1), qi (5): begin cur l rem byte(main j ); =:|, =:|>
main i char info(main f )(cur l ); ligature present true;
end;
qi (2), qi (6): begin cur r rem byte(main j ); |=:, |=:>
if lig stack = null then right boundary character is being consumed
begin lig stack new lig item(cur r ); bchar non char ;
end
else if is char node(lig stack ) then link (lig stack ) = null
begin main p lig stack ; lig stack new lig item(cur r ); lig ptr (lig stack ) main p;
end
else character (lig stack ) cur r ;
end;
qi (3): begin cur r rem byte(main j ); |=:|
main p lig stack ; lig stack new lig item(cur r ); link (lig stack ) main p;
end;
qi (7), qi (11): begin wrapup(false); |=:|>, |=:|>>
cur q tail ; cur l rem byte(main j ); main i char info(main f )(cur l );
ligature present true;
end;
othercases begin cur l rem byte(main j ); ligature present true; =:
if lig stack = null then goto main loop wrapup
else goto main loop move + 1;
end
endcases;
if op byte(main j ) > qi (4) then
if op byte(main j ) ,= qi (7) then goto main loop wrapup;
if cur l < non char then goto main lig loop;
main k bchar label [main f ]; goto main lig loop + 1;
end
This code is used in section 1039.
1041 T
E
X82 PART 46: THE CHIEF EXECUTIVE 391
1041. The occurrence of blank spaces is almost part of T
E
Xs inner loop, since we usually encounter
about one space for every ve non-blank characters. Therefore main control gives second-highest priority to
ordinary spaces.
When a glue parameter like \spaceskip is set to 0pt, we will see to it later that the corresponding glue
specication is precisely zero glue, not merely a pointer to some specication that happens to be full of
zeroes. Therefore it is simple to test whether a glue parameter is zero or not.
Append a normal inter-word space to the current list, then goto big switch 1041
if space skip = zero glue then
begin Find the glue specication, main p, for text spaces in the current font 1042 ;
temp ptr new glue(main p);
end
else temp ptr new param glue(space skip code);
link (tail ) temp ptr ; tail temp ptr ; goto big switch
This code is used in section 1030.
1042. Having font glue allocated for each text font saves both time and memory. If any of the three spacing
parameters are subsequently changed by the use of \fontdimen, the nd font dimen procedure deallocates
the font glue specication allocated here.
Find the glue specication, main p, for text spaces in the current font 1042
begin main p font glue[cur font ];
if main p = null then
begin main p new spec(zero glue); main k param base[cur font ] + space code;
width(main p) font info[main k ].sc; thats space(cur font )
stretch(main p) font info[main k + 1].sc; and space stretch(cur font )
shrink (main p) font info[main k + 2].sc; and space shrink (cur font )
font glue[cur font ] main p;
end;
end
This code is used in sections 1041 and 1043.
1043. Declare action procedures for use by main control 1043
procedure app space; handle spaces when space factor ,= 1000
var q: pointer ; glue node
begin if (space factor 2000) (xspace skip ,= zero glue) then q new param glue(xspace skip code)
else begin if space skip ,= zero glue then main p space skip
else Find the glue specication, main p, for text spaces in the current font 1042 ;
main p new spec(main p);
Modify the glue specication in main p according to the space factor 1044 ;
q new glue(main p); glue ref count (main p) null ;
end;
link (tail ) q; tail q;
end;
See also sections 1047, 1049, 1050, 1051, 1054, 1060, 1061, 1064, 1069, 1070, 1075, 1079, 1084, 1086, 1091, 1093, 1095, 1096,
1099, 1101, 1103, 1105, 1110, 1113, 1117, 1119, 1123, 1127, 1129, 1131, 1135, 1136, 1138, 1142, 1151, 1155, 1159, 1160,
1163, 1165, 1172, 1174, 1176, 1181, 1191, 1194, 1200, 1211, 1270, 1275, 1279, 1288, 1293, 1302, 1348, and 1376.
This code is used in section 1030.
1044. Modify the glue specication in main p according to the space factor 1044
if space factor 2000 then width(main p) width(main p) + extra space(cur font );
stretch(main p) xn over d (stretch(main p), space factor , 1000);
shrink (main p) xn over d (shrink (main p), 1000, space factor )
This code is used in section 1043.
392 PART 46: THE CHIEF EXECUTIVE T
E
X82 1045
1045. Whewthat covers the main loop. We can now proceed at a leisurely pace through the other
combinations of possibilities.
dene any mode(#) vmode + #, hmode + #, mmode + # for mode-independent commands
Cases of main control that are not part of the inner loop 1045
any mode(relax ), vmode + spacer , mmode + spacer , mmode + no boundary: do nothing ;
any mode(ignore spaces ): begin Get the next non-blank non-call token 406 ;
goto reswitch;
end;
vmode + stop: if its all over then return; this is the only way out
Forbidden cases detected in main control 1048 any mode(mac param): report illegal case;
Math-only cases in non-math modes, or vice versa 1046 : insert dollar sign;
Cases of main control that build boxes and lists 1056
Cases of main control that dont depend on mode 1210
Cases of main control that are for extensions to T
E
X 1347
This code is used in section 1030.
1046. Here is a list of cases where the user has probably gotten into or out of math mode by mistake. T
E
X
will insert a dollar sign and rescan the current token.
dene non math(#) vmode + #, hmode + #
Math-only cases in non-math modes, or vice versa 1046
non math(sup mark ), non math(sub mark ), non math(math char num), non math(math given),
non math(math comp), non math(delim num), non math(left right ), non math(above),
non math(radical ), non math(math style), non math(math choice), non math(vcenter ),
non math(non script ), non math(mkern), non math(limit switch), non math(mskip),
non math(math accent ), mmode + endv , mmode + par end , mmode + stop, mmode + vskip,
mmode + un vbox , mmode + valign, mmode + hrule
This code is used in section 1045.
1047. Declare action procedures for use by main control 1043 +
procedure insert dollar sign;
begin back input ; cur tok math shift token + "$"; print err ("Missing$inserted");
help2 ("Iveinsertedabeginmath/endmathsymbolsinceIthink")
("youleftoneout.Proceed,withfingerscrossed."); ins error ;
end;
1048. When erroneous situations arise, T
E
X usually issues an error message specic to the particular error.
For example, \noalign should not appear in any mode, since it is recognized by the align peek routine in
all of its legitimate appearances; a special error message is given when \noalign occurs elsewhere. But
sometimes the most appropriate error message is simply that the user is not allowed to do what he or she
has attempted. For example, \moveleft is allowed only in vertical mode, and \lower only in non-vertical
modes. Such cases are enumerated here and in the other sections referred to under See also . . . .
Forbidden cases detected in main control 1048
vmode + vmove, hmode + hmove, mmode + hmove, any mode(last item),
See also sections 1098, 1111, and 1144.
This code is used in section 1045.
1049 T
E
X82 PART 46: THE CHIEF EXECUTIVE 393
1049. The you cant procedure prints a line saying that the current command is illegal in the current
mode; it identies these things symbolically.
Declare action procedures for use by main control 1043 +
procedure you cant ;
begin print err ("Youcantuse`"); print cmd chr (cur cmd , cur chr ); print ("in");
print mode(mode);
end;
1050. Declare action procedures for use by main control 1043 +
procedure report illegal case;
begin you cant ; help4 ("Sorry,butImnotprogrammedtohandlethiscase;")
("Illjustpretendthatyoudidntaskforit.")
("Ifyoureinthewrongmode,youmightbeableto")
("returntotherightonebytyping`I}or`I$or`I\par.");
error ;
end;
1051. Some operations are allowed only in privileged modes, i.e., in cases that mode > 0. The privileged
function is used to detect violations of this rule; it issues an error message and returns false if the current
mode is negative.
Declare action procedures for use by main control 1043 +
function privileged : boolean;
begin if mode > 0 then privileged true
else begin report illegal case; privileged false;
end;
end;
1052. Either \dump or \end will cause main control to enter the endgame, since both of them have stop
as their command code.
Put each of T
E
Xs primitives into the hash table 226 +
primitive("end", stop, 0);
primitive("dump", stop, 1);
1053. Cases of print cmd chr for symbolic printing of primitives 227 +
stop: if chr code = 1 then print esc("dump") else print esc("end");
394 PART 46: THE CHIEF EXECUTIVE T
E
X82 1054
1054. We dont want to leave main control immediately when a stop command is sensed, because it may
be necessary to invoke an \output routine several times before things really grind to a halt. (The output
routine might even say \gdef\end{...}, to prolong the life of the job.) Therefore its all over is true only
when the current page and contribution list are empty, and when the last output was not a dead cycle.
Declare action procedures for use by main control 1043 +
function its all over : boolean; do this when \end or \dump occurs
label exit ;
begin if privileged then
begin if (page head = page tail ) (head = tail ) (dead cycles = 0) then
begin its all over true; return;
end;
back input ; we will try to end again after ejecting residual material
tail append (new null box ); width(tail ) hsize; tail append (new glue(ll glue));
tail append (new penalty(10000000000 ));
build page; append \hbox to \hsize{}\vfill\penalty10000000000
end;
its all over false;
exit : end;
1055 T
E
X82 PART 47: BUILDING BOXES AND LISTS 395
1055. Building boxes and lists. The most important parts of main control are concerned with T
E
Xs
chief mission of box-making. We need to control the activities that put entries on vlists and hlists, as well as
the activities that convert those lists into boxes. All of the necessary machinery has already been developed;
it remains for us to push the buttons at the right times.
1056. As an introduction to these routines, lets consider one of the simplest cases: What happens when
\hrule occurs in vertical mode, or \vrule in horizontal mode or math mode? The code in main control
is short, since the scan rule spec routine already does most of what is required; thus, there is no need for a
special action procedure.
Note that baselineskip calculations are disabled after a rule in vertical mode, by setting prev depth
ignore depth.
Cases of main control that build boxes and lists 1056
vmode + hrule, hmode + vrule, mmode + vrule: begin tail append (scan rule spec);
if abs (mode) = vmode then prev depth ignore depth
else if abs (mode) = hmode then space factor 1000;
end;
See also sections 1057, 1063, 1067, 1073, 1090, 1092, 1094, 1097, 1102, 1104, 1109, 1112, 1116, 1122, 1126, 1130, 1134, 1137,
1140, 1150, 1154, 1158, 1162, 1164, 1167, 1171, 1175, 1180, 1190, and 1193.
This code is used in section 1045.
1057. The processing of things like \hskip and \vskip is slightly more complicated. But the code in
main control is very short, since it simply calls on the action routine append glue. Similarly, \kern activates
append kern.
Cases of main control that build boxes and lists 1056 +
vmode + vskip, hmode + hskip, mmode + hskip, mmode + mskip: append glue;
any mode(kern), mmode + mkern: append kern;
1058. The hskip and vskip command codes are used for control sequences like \hss and \vfil as well as
for \hskip and \vskip. The dierence is in the value of cur chr .
dene l code = 0 identies \hfil and \vfil
dene ll code = 1 identies \hfill and \vfill
dene ss code = 2 identies \hss and \vss
dene l neg code = 3 identies \hfilneg and \vfilneg
dene skip code = 4 identies \hskip and \vskip
dene mskip code = 5 identies \mskip
Put each of T
E
Xs primitives into the hash table 226 +
primitive("hskip", hskip, skip code);
primitive("hfil", hskip, l code); primitive("hfill", hskip, ll code);
primitive("hss", hskip, ss code); primitive("hfilneg", hskip, l neg code);
primitive("vskip", vskip, skip code);
primitive("vfil", vskip, l code); primitive("vfill", vskip, ll code);
primitive("vss", vskip, ss code); primitive("vfilneg", vskip, l neg code);
primitive("mskip", mskip, mskip code);
primitive("kern", kern, explicit ); primitive("mkern", mkern, mu glue);
396 PART 47: BUILDING BOXES AND LISTS T
E
X82 1059
1059. Cases of print cmd chr for symbolic printing of primitives 227 +
hskip: case chr code of
skip code: print esc("hskip");
l code: print esc("hfil");
ll code: print esc("hfill");
ss code: print esc("hss");
othercases print esc("hfilneg")
endcases;
vskip: case chr code of
skip code: print esc("vskip");
l code: print esc("vfil");
ll code: print esc("vfill");
ss code: print esc("vss");
othercases print esc("vfilneg")
endcases;
mskip: print esc("mskip");
kern: print esc("kern");
mkern: print esc("mkern");
1060. All the work relating to glue creation has been relegated to the following subroutine. It does not
call build page, because it is used in at least one place where that would be a mistake.
Declare action procedures for use by main control 1043 +
procedure append glue;
var s: small number ; modier of skip command
begin s cur chr ;
case s of
l code: cur val l glue;
ll code: cur val ll glue;
ss code: cur val ss glue;
l neg code: cur val l neg glue;
skip code: scan glue(glue val );
mskip code: scan glue(mu val );
end; now cur val points to the glue specication
tail append (new glue(cur val ));
if s skip code then
begin decr (glue ref count (cur val ));
if s > skip code then subtype(tail ) mu glue;
end;
end;
1061. Declare action procedures for use by main control 1043 +
procedure append kern;
var s: quarterword ; subtype of the kern node
begin s cur chr ; scan dimen(s = mu glue, false, false); tail append (new kern(cur val ));
subtype(tail ) s;
end;
1062 T
E
X82 PART 47: BUILDING BOXES AND LISTS 397
1062. Many of the actions related to box-making are triggered by the appearance of braces in the
input. For example, when the user says \hbox to 100pt{ hlist } in vertical mode, the information
about the box size (100pt, exactly) is put onto save stack with a level boundary word just above it, and
cur group adjusted hbox group; T
E
X enters restricted horizontal mode to process the hlist. The right
brace eventually causes save stack to be restored to its former state, at which time the information about
the box size (100pt, exactly) is available once again; a box is packaged and we leave restricted horizontal
mode, appending the new box to the current list of the enclosing mode (in this case to the current list of
vertical mode), followed by any vertical adjustments that were removed from the box by hpack .
The next few sections of the program are therefore concerned with the treatment of left and right curly
braces.
1063. If a left brace occurs in the middle of a page or paragraph, it simply introduces a new level of
grouping, and the matching right brace will not have such a drastic eect. Such grouping aects neither the
mode nor the current list.
Cases of main control that build boxes and lists 1056 +
non math(left brace): new save level (simple group);
any mode(begin group): new save level (semi simple group);
any mode(end group): if cur group = semi simple group then unsave
else o save;
1064. We have to deal with errors in which braces and such things are not properly nested. Sometimes
the user makes an error of commission by inserting an extra symbol, but sometimes the user makes an error
of omission. T
E
X cant always tell one from the other, so it makes a guess and tries to avoid getting into a
loop.
The o save routine is called when the current group code is wrong. It tries to insert something into the
users input that will help clean o the top level.
Declare action procedures for use by main control 1043 +
procedure o save;
var p: pointer ; inserted token
begin if cur group = bottom level then Drop current token and complain that it was unmatched 1066
else begin back input ; p get avail ; link (temp head ) p; print err ("Missing");
Prepare to insert a token that matches cur group, and print what it is 1065 ;
print ("inserted"); ins list (link (temp head ));
help5 ("Iveinsertedsomethingthatyoumayhaveforgotten.")
("(Seethe<insertedtext>above.)")
("Withluck,thiswillgetmeunwedged.Butifyou")
("reallydidntforgetanything,trytyping`2now;then")
("myinsertionandmycurrentdilemmawillbothdisappear."); error ;
end;
end;
398 PART 47: BUILDING BOXES AND LISTS T
E
X82 1065
1065. At this point, link (temp head ) = p, a pointer to an empty one-word node.
Prepare to insert a token that matches cur group, and print what it is 1065
case cur group of
semi simple group: begin info(p) cs token ag + frozen end group; print esc("endgroup");
end;
math shift group: begin info(p) math shift token + "$"; print char ("$");
end;
math left group: begin info(p) cs token ag + frozen right ; link (p) get avail ; p link (p);
info(p) other token + "."; print esc("right.");
end;
othercases begin info(p) right brace token + "}"; print char ("}");
end
endcases
This code is used in section 1064.
1066. Drop current token and complain that it was unmatched 1066
begin print err ("Extra"); print cmd chr (cur cmd , cur chr );
help1 ("Thingsareprettymixedup,butIthinktheworstisover.");
error ;
end
This code is used in section 1064.
1067. The routine for a right brace character branches into many subcases, since a variety of things may
happen, depending on cur group. Some types of groups are not supposed to be ended by a right brace; error
messages are given in hopes of pinpointing the problem. Most branches of this routine will be lled in later,
when we are ready to understand them; meanwhile, we must prepare ourselves to deal with such errors.
Cases of main control that build boxes and lists 1056 +
any mode(right brace): handle right brace;
1068. Declare the procedure called handle right brace 1068
procedure handle right brace;
var p, q: pointer ; for short-term use
d: scaled ; holds split max depth in insert group
f: integer ; holds oating penalty in insert group
begin case cur group of
simple group: unsave;
bottom level : begin print err ("Toomany}s");
help2 ("Youveclosedmoregroupsthanyouopened.")
("Suchbooboosaregenerallyharmless,sokeepgoing."); error ;
end;
semi simple group, math shift group, math left group: extra right brace;
Cases of handle right brace where a right brace triggers a delayed action 1085
othercases confusion("rightbrace")
endcases;
end;
This code is used in section 1030.
1069 T
E
X82 PART 47: BUILDING BOXES AND LISTS 399
1069. Declare action procedures for use by main control 1043 +
procedure extra right brace;
begin print err ("Extra},orforgotten");
case cur group of
semi simple group: print esc("endgroup");
math shift group: print char ("$");
math left group: print esc("right");
end;
help5 ("Ivedeletedagroupclosingsymbolbecauseitseemstobe")
("spurious,asin`$x}$.Butperhapsthe}islegitimateand")
("youforgotsomethingelse,asin`\hbox{$x}.Insuchcases")
("thewaytorecoveristoinsertboththeforgottenandthe")
("deletedmaterial,e.g.,bytyping`I$}."); error ; incr (align state);
end;
1070. Here is where we clear the parameters that are supposed to revert to their default values after every
paragraph and when internal vertical mode is entered.
Declare action procedures for use by main control 1043 +
procedure normal paragraph;
begin if looseness ,= 0 then eq word dene(int base + looseness code, 0);
if hang indent ,= 0 then eq word dene(dimen base + hang indent code, 0);
if hang after ,= 1 then eq word dene(int base + hang after code, 1);
if par shape ptr ,= null then eq dene(par shape loc, shape ref , null );
end;
400 PART 47: BUILDING BOXES AND LISTS T
E
X82 1071
1071. Now lets turn to the question of how \hbox is treated. We actually need to consider also a slightly
larger context, since constructions like \setbox3=\hbox... and \leaders\hbox... and \lower3.8pt\hbox...
are supposed to invoke quite dierent actions after the box has been packaged. Conversely, constructions
like \setbox3= can be followed by a variety of dierent kinds of boxes, and we would like to encode such
things in an ecient way.
In other words, there are two problems: to represent the context of a box, and to represent its type.
The rst problem is solved by putting a context code on the save stack , just below the two entries
that give the dimensions produced by scan spec. The context code is either a (signed) shift amount, or
it is a large integer box ag , where box ag = 2
30
. Codes box ag through box ag + 255 represent
\setbox0 through \setbox255; codes box ag +256 through box ag +511 represent \global\setbox0
through \global\setbox255; code box ag +512 represents \shipout; and codes box ag +513 through
box ag + 515 represent \leaders, \cleaders, and \xleaders.
The second problem is solved by giving the command code make box to all control sequences that produce
a box, and by using the following chr code values to distinguish between them: box code, copy code,
last box code, vsplit code, vtop code, vtop code + vmode, and vtop code + hmode, where the latter two are
used denote \vbox and \hbox, respectively.
dene box ag 10000000000 context code for \setbox0
dene ship out ag box ag + 512 context code for \shipout
dene leader ag box ag + 513 context code for \leaders
dene box code = 0 chr code for \box
dene copy code = 1 chr code for \copy
dene last box code = 2 chr code for \lastbox
dene vsplit code = 3 chr code for \vsplit
dene vtop code = 4 chr code for \vtop
Put each of T
E
Xs primitives into the hash table 226 +
primitive("moveleft", hmove, 1); primitive("moveright", hmove, 0);
primitive("raise", vmove, 1); primitive("lower", vmove, 0);
primitive("box", make box , box code); primitive("copy", make box , copy code);
primitive("lastbox", make box , last box code); primitive("vsplit", make box , vsplit code);
primitive("vtop", make box , vtop code);
primitive("vbox", make box , vtop code + vmode); primitive("hbox", make box , vtop code + hmode);
primitive("shipout", leader ship, a leaders 1); ship out ag = leader ag 1
primitive("leaders", leader ship, a leaders ); primitive("cleaders", leader ship, c leaders );
primitive("xleaders", leader ship, x leaders );
1072. Cases of print cmd chr for symbolic printing of primitives 227 +
hmove: if chr code = 1 then print esc("moveleft") else print esc("moveright");
vmove: if chr code = 1 then print esc("raise") else print esc("lower");
make box : case chr code of
box code: print esc("box");
copy code: print esc("copy");
last box code: print esc("lastbox");
vsplit code: print esc("vsplit");
vtop code: print esc("vtop");
vtop code + vmode: print esc("vbox");
othercases print esc("hbox")
endcases;
leader ship: if chr code = a leaders then print esc("leaders")
else if chr code = c leaders then print esc("cleaders")
else if chr code = x leaders then print esc("xleaders")
else print esc("shipout");
1073 T
E
X82 PART 47: BUILDING BOXES AND LISTS 401
1073. Constructions that require a box are started by calling scan box with a specied context code. The
scan box routine veries that a make box command comes next and then it calls begin box .
Cases of main control that build boxes and lists 1056 +
vmode + hmove, hmode + vmove, mmode + vmove: begin t cur chr ; scan normal dimen;
if t = 0 then scan box (cur val ) else scan box (cur val );
end;
any mode(leader ship): scan box (leader ag a leaders + cur chr );
any mode(make box ): begin box (0);
1074. The global variable cur box will point to a newly made box. If the box is void, we will have
cur box = null . Otherwise we will have type(cur box ) = hlist node or vlist node or rule node; the rule node
case can occur only with leaders.
Global variables 13 +
cur box : pointer ; box to be placed into its context
1075. The box end procedure does the right thing with cur box , if box context represents the context as
explained above.
Declare action procedures for use by main control 1043 +
procedure box end (box context : integer );
var p: pointer ; ord noad for new box in math mode
begin if box context < box ag then
Append box cur box to the current list, shifted by box context 1076
else if box context < ship out ag then Store cur box in a box register 1077
else if cur box ,= null then
if box context > ship out ag then Append a new leader node that uses cur box 1078
else ship out (cur box );
end;
402 PART 47: BUILDING BOXES AND LISTS T
E
X82 1076
1076. The global variable adjust tail will be non-null if and only if the current box might include adjust-
ments that should be appended to the current vertical list.
Append box cur box to the current list, shifted by box context 1076
begin if cur box ,= null then
begin shift amount (cur box ) box context ;
if abs (mode) = vmode then
begin append to vlist (cur box );
if adjust tail ,= null then
begin if adjust head ,= adjust tail then
begin link (tail ) link (adjust head ); tail adjust tail ;
end;
adjust tail null ;
end;
if mode > 0 then build page;
end
else begin if abs (mode) = hmode then space factor 1000
else begin p new noad ; math type(nucleus (p)) sub box ; info(nucleus (p)) cur box ;
cur box p;
end;
link (tail ) cur box ; tail cur box ;
end;
end;
end
This code is used in section 1075.
1077. Store cur box in a box register 1077
if box context < box ag + 256 then eq dene(box base box ag + box context , box ref , cur box )
else geq dene(box base box ag 256 + box context , box ref , cur box )
This code is used in section 1075.
1078. Append a new leader node that uses cur box 1078
begin Get the next non-blank non-relax non-call token 404 ;
if ((cur cmd = hskip) (abs (mode) ,= vmode)) ((cur cmd = vskip) (abs (mode) = vmode)) then
begin append glue; subtype(tail ) box context (leader ag a leaders );
leader ptr (tail ) cur box ;
end
else begin print err ("Leadersnotfollowedbyproperglue");
help3 ("Youshouldsay`\leaders<boxorrule><hskiporvskip>.")
("Ifoundthe<boxorrule>,buttheresnosuitable")
("<hskiporvskip>,soImignoringtheseleaders."); back error ; ush node list (cur box );
end;
end
This code is used in section 1075.
1079 T
E
X82 PART 47: BUILDING BOXES AND LISTS 403
1079. Now that we can see what eventually happens to boxes, we can consider the rst steps in their
creation. The begin box routine is called when box context is a context specication, cur chr species the
type of box desired, and cur cmd = make box .
Declare action procedures for use by main control 1043 +
procedure begin box (box context : integer );
label exit , done;
var p, q: pointer ; run through the current list
m: quarterword ; the length of a replacement list
k: halfword ; 0 or vmode or hmode
n: eight bits ; a box number
begin case cur chr of
box code: begin scan eight bit int ; cur box box (cur val ); box (cur val ) null ;
the box becomes void, at the same level
end;
copy code: begin scan eight bit int ; cur box copy node list (box (cur val ));
end;
last box code: If the current list ends with a box node, delete it from the list and make cur box point to
it; otherwise set cur box null 1080 ;
vsplit code: Split o part of a vertical box, make cur box point to it 1082 ;
othercases Initiate the construction of an hbox or vbox, then return 1083
endcases;
box end (box context ); in simple cases, we use the box immediately
exit : end;
1080. Note that the condition is char node(tail ) implies that head ,= tail , since head is a one-word node.
If the current list ends with a box node, delete it from the list and make cur box point to it; otherwise set
cur box null 1080
begin cur box null ;
if abs (mode) = mmode then
begin you cant ; help1 ("Sorry;this\lastboxwillbevoid."); error ;
end
else if (mode = vmode) (head = tail ) then
begin you cant ; help2 ("Sorry...Iusuallycanttakethingsfromthecurrentpage.")
("This\lastboxwillthereforebevoid."); error ;
end
else begin if is char node(tail ) then
if (type(tail ) = hlist node) (type(tail ) = vlist node) then
Remove the last box, unless its part of a discretionary 1081 ;
end;
end
This code is used in section 1079.
404 PART 47: BUILDING BOXES AND LISTS T
E
X82 1081
1081. Remove the last box, unless its part of a discretionary 1081
begin q head ;
repeat p q;
if is char node(q) then
if type(q) = disc node then
begin for m 1 to replace count (q) do p link (p);
if p = tail then goto done;
end;
q link (p);
until q = tail ;
cur box tail ; shift amount (cur box ) 0; tail p; link (p) null ;
done: end
This code is used in section 1080.
1082. Here we deal with things like \vsplit 13 to 100pt.
Split o part of a vertical box, make cur box point to it 1082
begin scan eight bit int ; n cur val ;
if scan keyword ("to") then
begin print err ("Missing`toinserted");
help2 ("Imworkingon`\vsplit<boxnumber>to<dimen>;")
("willlookforthe<dimen>next."); error ;
end;
scan normal dimen; cur box vsplit (n, cur val );
end
This code is used in section 1079.
1083. Here is where we enter restricted horizontal mode or internal vertical mode, in order to make a box.
Initiate the construction of an hbox or vbox, then return 1083
begin k cur chr vtop code; saved (0) box context ;
if k = hmode then
if (box context < box ag ) (abs (mode) = vmode) then scan spec(adjusted hbox group, true)
else scan spec(hbox group, true)
else begin if k = vmode then scan spec(vbox group, true)
else begin scan spec(vtop group, true); k vmode;
end;
normal paragraph;
end;
push nest ; mode k;
if k = vmode then
begin prev depth ignore depth;
if every vbox ,= null then begin token list (every vbox , every vbox text );
end
else begin space factor 1000;
if every hbox ,= null then begin token list (every hbox , every hbox text );
end;
return;
end
This code is used in section 1079.
1084 T
E
X82 PART 47: BUILDING BOXES AND LISTS 405
1084. Declare action procedures for use by main control 1043 +
procedure scan box (box context : integer ); the next input should specify a box or perhaps a rule
begin Get the next non-blank non-relax non-call token 404 ;
if cur cmd = make box then begin box (box context )
else if (box context leader ag ) ((cur cmd = hrule) (cur cmd = vrule)) then
begin cur box scan rule spec; box end (box context );
end
else begin
print err ("A<box>wassupposedtobehere");
help3 ("Iwasexpectingtosee\hboxor\vboxor\copyor\boxor")
("somethinglikethat.Soyoumightfindsomethingmissingin")
("youroutput.Butkeeptrying;youcanfixthislater."); back error ;
end;
end;
1085. When the right brace occurs at the end of an \hbox or \vbox or \vtop construction, the package
routine comes into action. We might also have to nish a paragraph that hasnt ended.
Cases of handle right brace where a right brace triggers a delayed action 1085
hbox group: package(0);
adjusted hbox group: begin adjust tail adjust head ; package(0);
end;
vbox group: begin end graf ; package(0);
end;
vtop group: begin end graf ; package(vtop code);
end;
See also sections 1100, 1118, 1132, 1133, 1168, 1173, and 1186.
This code is used in section 1068.
1086. Declare action procedures for use by main control 1043 +
procedure package(c : small number );
var h: scaled ; height of box
p: pointer ; rst node in a box
d: scaled ; max depth
begin d box max depth; unsave; save ptr save ptr 3;
if mode = hmode then cur box hpack (link (head ), saved (2), saved (1))
else begin cur box vpackage(link (head ), saved (2), saved (1), d);
if c = vtop code then Readjust the height and depth of cur box , for \vtop 1087 ;
end;
pop nest ; box end (saved (0));
end;
1087. The height of a \vtop box is inherited from the rst item on its list, if that item is an hlist node,
vlist node, or rule node; otherwise the \vtop height is zero.
Readjust the height and depth of cur box , for \vtop 1087
begin h 0; p list ptr (cur box );
if p ,= null then
if type(p) rule node then h height (p);
depth(cur box ) depth(cur box ) h + height (cur box ); height (cur box ) h;
end
This code is used in section 1086.
406 PART 47: BUILDING BOXES AND LISTS T
E
X82 1088
1088. A paragraph begins when horizontal-mode material occurs in vertical mode, or when the paragraph
is explicitly started by \indent or \noindent.
Put each of T
E
Xs primitives into the hash table 226 +
primitive("indent", start par , 1); primitive("noindent", start par , 0);
1089. Cases of print cmd chr for symbolic printing of primitives 227 +
start par : if chr code = 0 then print esc("noindent") else print esc("indent");
1090. Cases of main control that build boxes and lists 1056 +
vmode + start par : new graf (cur chr > 0);
vmode + letter , vmode + other char , vmode + char num, vmode + char given, vmode + math shift ,
vmode + un hbox , vmode + vrule, vmode + accent , vmode + discretionary, vmode + hskip,
vmode + valign, vmode + ex space, vmode + no boundary:
begin back input ; new graf (true);
end;
1091. Declare action procedures for use by main control 1043 +
function norm min(h : integer ): small number ;
begin if h 0 then norm min 1 else if h 63 then norm min 63 else norm min h;
end;
procedure new graf (indented : boolean);
begin prev graf 0;
if (mode = vmode) (head ,= tail ) then tail append (new param glue(par skip code));
push nest ; mode hmode; space factor 1000; set cur lang ; clang cur lang ;
prev graf (norm min(left hyphen min) 100 + norm min(right hyphen min)) 200000 + cur lang ;
if indented then
begin tail new null box ; link (head ) tail ; width(tail ) par indent ; end;
if every par ,= null then begin token list (every par , every par text );
if nest ptr = 1 then build page; put par skip glue on current page
end;
1092. Cases of main control that build boxes and lists 1056 +
hmode + start par , mmode + start par : indent in hmode;
1093. Declare action procedures for use by main control 1043 +
procedure indent in hmode;
var p, q: pointer ;
begin if cur chr > 0 then \indent
begin p new null box ; width(p) par indent ;
if abs (mode) = hmode then space factor 1000
else begin q new noad ; math type(nucleus (q)) sub box ; info(nucleus (q)) p; p q;
end;
tail append (p);
end;
end;
1094 T
E
X82 PART 47: BUILDING BOXES AND LISTS 407
1094. A paragraph ends when a par end command is sensed, or when we are in horizontal mode when
reaching the right brace of vertical-mode routines like \vbox, \insert, or \output.
Cases of main control that build boxes and lists 1056 +
vmode + par end : begin normal paragraph;
if mode > 0 then build page;
end;
hmode + par end : begin if align state < 0 then o save;
this tries to recover from an alignment that didnt end properly
end graf ; this takes us to the enclosing mode, if mode > 0
if mode = vmode then build page;
end;
hmode + stop, hmode + vskip, hmode + hrule, hmode + un vbox , hmode + halign: head for vmode;
1095. Declare action procedures for use by main control 1043 +
procedure head for vmode;
begin if mode < 0 then
if cur cmd ,= hrule then o save
else begin print err ("Youcantuse`"); print esc("hrule");
print ("hereexceptwithleaders");
help2 ("Toputahorizontalruleinanhboxoranalignment,")
("youshoulduse\leadersor\hrulefill(seeTheTeXbook)."); error ;
end
else begin back input ; cur tok par token; back input ; token type inserted ;
end;
end;
1096. Declare action procedures for use by main control 1043 +
procedure end graf ;
begin if mode = hmode then
begin if head = tail then pop nest null paragraphs are ignored
else line break (widow penalty);
normal paragraph; error count 0;
end;
end;
1097. Insertion and adjustment and mark nodes are constructed by the following pieces of the program.
Cases of main control that build boxes and lists 1056 +
any mode(insert ), hmode + vadjust , mmode + vadjust : begin insert or adjust ;
any mode(mark ): make mark ;
1098. Forbidden cases detected in main control 1048 +
vmode + vadjust ,
408 PART 47: BUILDING BOXES AND LISTS T
E
X82 1099
1099. Declare action procedures for use by main control 1043 +
procedure begin insert or adjust ;
begin if cur cmd = vadjust then cur val 255
else begin scan eight bit int ;
if cur val = 255 then
begin print err ("Youcant"); print esc("insert"); print int (255);
help1 ("Imchangingto\insert0;box255isspecial."); error ; cur val 0;
end;
end;
saved (0) cur val ; incr (save ptr ); new save level (insert group); scan left brace; normal paragraph;
push nest ; mode vmode; prev depth ignore depth;
end;
1100. Cases of handle right brace where a right brace triggers a delayed action 1085 +
insert group: begin end graf ; q split top skip; add glue ref (q); d split max depth;
f oating penalty; unsave; decr (save ptr );
now saved (0) is the insertion number, or 255 for vadjust
p vpack (link (head ), natural ); pop nest ;
if saved (0) < 255 then
begin tail append (get node(ins node size)); type(tail ) ins node; subtype(tail ) qi (saved (0));
height (tail ) height (p) + depth(p); ins ptr (tail ) list ptr (p); split top ptr (tail ) q;
depth(tail ) d; oat cost (tail ) f;
end
else begin tail append (get node(small node size)); type(tail ) adjust node;
subtype(tail ) 0; the subtype is not used
adjust ptr (tail ) list ptr (p); delete glue ref (q);
end;
free node(p, box node size);
if nest ptr = 0 then build page;
end;
output group: Resume the page builder after an output routine has come to an end 1026 ;
1101. Declare action procedures for use by main control 1043 +
procedure make mark ;
var p: pointer ; new node
begin p scan toks (false, true); p get node(small node size); type(p) mark node;
subtype(p) 0; the subtype is not used
mark ptr (p) def ref ; link (tail ) p; tail p;
end;
1102. Penalty nodes get into a list via the break penalty command.
Cases of main control that build boxes and lists 1056 +
any mode(break penalty): append penalty;
1103. Declare action procedures for use by main control 1043 +
procedure append penalty;
begin scan int ; tail append (new penalty(cur val ));
if mode = vmode then build page;
end;
1104 T
E
X82 PART 47: BUILDING BOXES AND LISTS 409
1104. The remove item command removes a penalty, kern, or glue node if it appears at the tail of the
current list, using a brute-force linear scan. Like \lastbox, this command is not allowed in vertical mode
(except internal vertical mode), since the current list in vertical mode is sent to the page builder. But if we
happen to be able to implement it in vertical mode, we do.
Cases of main control that build boxes and lists 1056 +
any mode(remove item): delete last ;
1105. When delete last is called, cur chr is the type of node that will be deleted, if present.
Declare action procedures for use by main control 1043 +
procedure delete last ;
label exit ;
var p, q: pointer ; run through the current list
m: quarterword ; the length of a replacement list
begin if (mode = vmode) (tail = head ) then
Apologize for inability to do the operation now, unless \unskip follows non-glue 1106
else begin if is char node(tail ) then
if type(tail ) = cur chr then
begin q head ;
repeat p q;
if is char node(q) then
if type(q) = disc node then
begin for m 1 to replace count (q) do p link (p);
if p = tail then return;
end;
q link (p);
until q = tail ;
link (p) null ; ush node list (tail ); tail p;
end;
end;
exit : end;
1106. Apologize for inability to do the operation now, unless \unskip follows non-glue 1106
begin if (cur chr ,= glue node) (last glue ,= max halfword ) then
begin you cant ; help2 ("Sorry...Iusuallycanttakethingsfromthecurrentpage.")
("Try`I\vskip\lastskipinstead.");
if cur chr = kern node then help line[0] ("Try`I\kern\lastkerninstead.")
else if cur chr ,= glue node then
help line[0] ("Perhapsyoucanmaketheoutputroutinedoit.");
error ;
end;
end
This code is used in section 1105.
1107. Put each of T
E
Xs primitives into the hash table 226 +
primitive("unpenalty", remove item, penalty node);
primitive("unkern", remove item, kern node);
primitive("unskip", remove item, glue node);
primitive("unhbox", un hbox , box code);
primitive("unhcopy", un hbox , copy code);
primitive("unvbox", un vbox , box code);
primitive("unvcopy", un vbox , copy code);
410 PART 47: BUILDING BOXES AND LISTS T
E
X82 1108
1108. Cases of print cmd chr for symbolic printing of primitives 227 +
remove item: if chr code = glue node then print esc("unskip")
else if chr code = kern node then print esc("unkern")
else print esc("unpenalty");
un hbox : if chr code = copy code then print esc("unhcopy")
else print esc("unhbox");
un vbox : if chr code = copy code then print esc("unvcopy")
else print esc("unvbox");
1109. The un hbox and un vbox commands unwrap one of the 256 current boxes.
Cases of main control that build boxes and lists 1056 +
vmode + un vbox , hmode + un hbox , mmode + un hbox : unpackage;
1110. Declare action procedures for use by main control 1043 +
procedure unpackage;
label exit ;
var p: pointer ; the box
c: box code . . copy code; should we copy?
begin c cur chr ; scan eight bit int ; p box (cur val );
if p = null then return;
if (abs (mode) = mmode) ((abs (mode) = vmode) (type(p) ,= vlist node))
((abs (mode) = hmode) (type(p) ,= hlist node)) then
begin print err ("Incompatiblelistcantbeunboxed");
help3 ("Sorry,Pandora.(Yousneakydevil.)")
("Irefusetounboxan\hboxinverticalmodeorviceversa.")
("AndIcantopenanyboxesinmathmode.");
error ; return;
end;
if c = copy code then link (tail ) copy node list (list ptr (p))
else begin link (tail ) list ptr (p); box (cur val ) null ; free node(p, box node size);
end;
while link (tail ) ,= null do tail link (tail );
exit : end;
1111. Forbidden cases detected in main control 1048 +
vmode + ital corr ,
1112. Italic corrections are converted to kern nodes when the ital corr command follows a character. In
math mode the same eect is achieved by appending a kern of zero here, since italic corrections are supplied
later.
Cases of main control that build boxes and lists 1056 +
hmode + ital corr : append italic correction;
mmode + ital corr : tail append (new kern(0));
1113 T
E
X82 PART 47: BUILDING BOXES AND LISTS 411
1113. Declare action procedures for use by main control 1043 +
procedure append italic correction;
label exit ;
var p: pointer ; char node at the tail of the current list
f: internal font number ; the font in the char node
begin if tail ,= head then
begin if is char node(tail ) then p tail
else if type(tail ) = ligature node then p lig char (tail )
else return;
f font (p); tail append (new kern(char italic(f)(char info(f)(character (p)))));
subtype(tail ) explicit ;
end;
exit : end;
1114. Discretionary nodes are easy in the common case \, but in the general case we must process three
braces full of items.
Put each of T
E
Xs primitives into the hash table 226 +
primitive("", discretionary, 1); primitive("discretionary", discretionary, 0);
1115. Cases of print cmd chr for symbolic printing of primitives 227 +
discretionary: if chr code = 1 then print esc("") else print esc("discretionary");
1116. Cases of main control that build boxes and lists 1056 +
hmode + discretionary, mmode + discretionary: append discretionary;
1117. The space factor does not change when we append a discretionary node, but it starts out as 1000
in the subsidiary lists.
Declare action procedures for use by main control 1043 +
procedure append discretionary;
var c: integer ; hyphen character
begin tail append (new disc);
if cur chr = 1 then
begin c hyphen char [cur font ];
if c 0 then
if c < 256 then pre break (tail ) new character (cur font , c);
end
else begin incr (save ptr ); saved (1) 0; new save level (disc group); scan left brace; push nest ;
mode hmode; space factor 1000;
end;
end;
1118. The three discretionary lists are constructed somewhat as if they were hboxes. A subroutine called
build discretionary handles the transitions. (This is sort of fun.)
Cases of handle right brace where a right brace triggers a delayed action 1085 +
disc group: build discretionary;
412 PART 47: BUILDING BOXES AND LISTS T
E
X82 1119
1119. Declare action procedures for use by main control 1043 +
procedure build discretionary;
label done, exit ;
var p, q: pointer ; for link manipulation
n: integer ; length of discretionary list
begin unsave;
Prune the current list, if necessary, until it contains only char node, kern node, hlist node, vlist node,
rule node, and ligature node items; set n to the length of the list, and set q to the lists tail 1121 ;
p link (head ); pop nest ;
case saved (1) of
0: pre break (tail ) p;
1: post break (tail ) p;
2: Attach list p to the current list, and record its length; then nish up and return 1120 ;
end; there are no other cases
incr (saved (1)); new save level (disc group); scan left brace; push nest ; mode hmode;
space factor 1000;
exit : end;
1120. Attach list p to the current list, and record its length; then nish up and return 1120
begin if (n > 0) (abs (mode) = mmode) then
begin print err ("Illegalmath"); print esc("discretionary");
help2 ("Sorry:Thethirdpartofadiscretionarybreakmustbe")
("empty,inmathformulas.Ihadtodeleteyourthirdpart."); ush node list (p); n 0;
error ;
end
else link (tail ) p;
if n max quarterword then replace count (tail ) n
else begin print err ("Discretionarylististoolong");
help2 ("WowIneverthoughtanybodywouldtweakmehere.")
("Youcantseriouslyneedsuchahugediscretionarylist?"); error ;
end;
if n > 0 then tail q;
decr (save ptr ); return;
end
This code is used in section 1119.
1121 T
E
X82 PART 47: BUILDING BOXES AND LISTS 413
1121. During this loop, p = link (q) and there are n items preceding p.
Prune the current list, if necessary, until it contains only char node, kern node, hlist node, vlist node,
rule node, and ligature node items; set n to the length of the list, and set q to the lists tail 1121
q head ; p link (q); n 0;
while p ,= null do
begin if is char node(p) then
if type(p) > rule node then
if type(p) ,= kern node then
if type(p) ,= ligature node then
begin print err ("Improperdiscretionarylist");
help1 ("Discretionarylistsmustcontainonlyboxesandkerns.");
error ; begin diagnostic;
print nl ("Thefollowingdiscretionarysublisthasbeendeleted:"); show box (p);
end diagnostic(true); ush node list (p); link (q) null ; goto done;
end;
q p; p link (q); incr (n);
end;
done:
This code is used in section 1119.
1122. We need only one more thing to complete the horizontal mode routines, namely the \accent
primitive.
Cases of main control that build boxes and lists 1056 +
hmode + accent : make accent ;
1123. The positioning of accents is straightforward but tedious. Given an accent of width a, designed for
characters of height x and slant s; and given a character of width w, height h, and slant t: We will shift the
accent down by x h, and we will insert kern nodes that have the eect of centering the accent over the
character and shifting the accent to the right by =
1
2
(w a) + h t x s. If either character is absent
from the font, we will simply use the other, without shifting.
Declare action procedures for use by main control 1043 +
procedure make accent ;
var s, t: real ; amount of slant
p, q, r: pointer ; character, box, and kern nodes
f: internal font number ; relevant font
a, h, x, w, delta: scaled ; heights and widths, as explained above
i: four quarters ; character information
begin scan char num; f cur font ; p new character (f, cur val );
if p ,= null then
begin x x height (f); s slant (f)/oat constant (65536);
a char width(f)(char info(f)(character (p)));
do assignments ;
Create a character node q for the next character, but set q null if problems arise 1124 ;
if q ,= null then Append the accent with appropriate kerns, then set p q 1125 ;
link (tail ) p; tail p; space factor 1000;
end;
end;
414 PART 47: BUILDING BOXES AND LISTS T
E
X82 1124
1124. Create a character node q for the next character, but set q null if problems arise 1124
q null ; f cur font ;
if (cur cmd = letter ) (cur cmd = other char ) (cur cmd = char given) then
q new character (f, cur chr )
else if cur cmd = char num then
begin scan char num; q new character (f, cur val );
end
else back input
This code is used in section 1123.
1125. The kern nodes appended here must be distinguished from other kerns, lest they be wiped away by
the hyphenation algorithm or by a previous line break.
The two kerns are computed with (machine-dependent) real arithmetic, but their sum is machine-independent;
the net eect is machine-independent, because the user cannot remove these nodes nor access them via
\lastkern.
Append the accent with appropriate kerns, then set p q 1125
begin t slant (f)/oat constant (65536); i char info(f)(character (q)); w char width(f)(i);
h char height (f)(height depth(i));
if h ,= x then the accent must be shifted up or down
begin p hpack (p, natural ); shift amount (p) x h;
end;
delta round ((w a)/oat constant (2) + h t x s); r new kern(delta); subtype(r) acc kern;
link (tail ) r; link (r) p; tail new kern(a delta); subtype(tail ) acc kern; link (p) tail ;
p q;
end
This code is used in section 1123.
1126. When \cr or \span or a tab mark comes through the scanner into main control , it might be that
the user has foolishly inserted one of them into something that has nothing to do with alignment. But it
is far more likely that a left brace or right brace has been omitted, since get next takes actions appropriate
to alignment only when \cr or \span or tab marks occur with align state = 0. The following program
attempts to make an appropriate recovery.
Cases of main control that build boxes and lists 1056 +
any mode(car ret ), any mode(tab mark ): align error ;
any mode(no align): no align error ;
any mode(omit ): omit error ;
1127 T
E
X82 PART 47: BUILDING BOXES AND LISTS 415
1127. Declare action procedures for use by main control 1043 +
procedure align error ;
begin if abs (align state) > 2 then
Express consternation over the fact that no alignment is in progress 1128
else begin back input ;
if align state < 0 then
begin print err ("Missing{inserted"); incr (align state); cur tok left brace token + "{";
end
else begin print err ("Missing}inserted"); decr (align state); cur tok right brace token + "}";
end;
help3 ("Iveputinwhatseemstobenecessarytofix")
("thecurrentcolumnofthecurrentalignment.")
("Trytogoon,sincethismightalmostwork."); ins error ;
end;
end;
1128. Express consternation over the fact that no alignment is in progress 1128
begin print err ("Misplaced"); print cmd chr (cur cmd , cur chr );
if cur tok = tab token + "&" then
begin help6 ("Icantfigureoutwhyyouwouldwanttouseatabmark")
("here.Ifyoujustwantanampersand,theremedyis")
("simple:Justtype`I\&now.Butifsomerightbrace")
("upabovehasendedapreviousalignmentprematurely,")
("youreprobablydueformoreerrormessages,andyou")
("mighttrytyping`Snowjusttoseewhatissalvageable.");
end
else begin help5 ("Icantfigureoutwhyyouwouldwanttouseatabmark")
("or\cror\spanjustnow.Ifsomethinglikearightbrace")
("upabovehasendedapreviousalignmentprematurely,")
("youreprobablydueformoreerrormessages,andyou")
("mighttrytyping`Snowjusttoseewhatissalvageable.");
end;
error ;
end
This code is used in section 1127.
1129. The help messages here contain a little white lie, since \noalign and \omit are allowed also after
\noalign{...}.
Declare action procedures for use by main control 1043 +
procedure no align error ;
begin print err ("Misplaced"); print esc("noalign");
help2 ("Iexpecttosee\noalignonlyafterthe\crof")
("analignment.Proceed,andIllignorethiscase."); error ;
end;
procedure omit error ;
begin print err ("Misplaced"); print esc("omit");
help2 ("Iexpecttosee\omitonlyaftertabmarksorthe\crof")
("analignment.Proceed,andIllignorethiscase."); error ;
end;
416 PART 47: BUILDING BOXES AND LISTS T
E
X82 1130
1130. Weve now covered most of the abuses of \halign and \valign. Lets take a look at what happens
when they are used correctly.
Cases of main control that build boxes and lists 1056 +
vmode + halign, hmode + valign: init align;
mmode + halign: if privileged then
if cur group = math shift group then init align
else o save;
vmode + endv , hmode + endv : do endv ;
1131. An align group code is supposed to remain on the save stack during an entire alignment, until
n align removes it.
A devious user might force an endv command to occur just about anywhere; we must defeat such hacks.
Declare action procedures for use by main control 1043 +
procedure do endv ;
begin base ptr input ptr ; input stack [base ptr ] cur input ;
while (input stack [base ptr ].index eld ,= v template) (input stack [base ptr ].loc eld =
null ) (input stack [base ptr ].state eld = token list ) do decr (base ptr );
if (input stack [base ptr ].index eld ,= v template) (input stack [base ptr ].loc eld ,=
null ) (input stack [base ptr ].state eld ,= token list ) then
fatal error ("(interwovenalignmentpreamblesarenotallowed)");
if cur group = align group then
begin end graf ;
if n col then n row;
end
else o save;
end;
1132. Cases of handle right brace where a right brace triggers a delayed action 1085 +
align group: begin back input ; cur tok cs token ag + frozen cr ; print err ("Missing");
print esc("cr"); print ("inserted");
help1 ("Imguessingthatyoumeanttoendanalignmenthere."); ins error ;
end;
1133. Cases of handle right brace where a right brace triggers a delayed action 1085 +
no align group: begin end graf ; unsave; align peek ;
end;
1134. Finally, \endcsname is not supposed to get through to main control .
Cases of main control that build boxes and lists 1056 +
any mode(end cs name): cs error ;
1135. Declare action procedures for use by main control 1043 +
procedure cs error ;
begin print err ("Extra"); print esc("endcsname");
help1 ("Imignoringthis,sinceIwasntdoinga\csname."); error ;
end;
1136 T
E
X82 PART 48: BUILDING MATH LISTS 417
1136. Building math lists. The routines that T
E
X uses to create mlists are similar to those we have
just seen for the generation of hlists and vlists. But it is necessary to make noads as well as nodes, so the
reader should review the discussion of math mode data structures before trying to make sense out of the
following program.
Here is a little routine that needs to be done whenever a subformula is about to be processed. The
parameter is a code like math group.
Declare action procedures for use by main control 1043 +
procedure push math(c : group code);
begin push nest ; mode mmode; incompleat noad null ; new save level (c);
end;
1137. We get into math mode from horizontal mode when a $ (i.e., a math shift character) is scanned.
We must check to see whether this $ is immediately followed by another, in case display math mode is
called for.
Cases of main control that build boxes and lists 1056 +
hmode + math shift : init math;
1138. Declare action procedures for use by main control 1043 +
procedure init math;
label reswitch, found , not found , done;
var w: scaled ; new or partial pre display size
l: scaled ; new display width
s: scaled ; new display indent
p: pointer ; current node when calculating pre display size
q: pointer ; glue specication when calculating pre display size
f: internal font number ; font in current char node
n: integer ; scope of paragraph shape specication
v: scaled ; w plus possible glue amount
d: scaled ; increment to v
begin get token; get x token would fail on \ifmmode !
if (cur cmd = math shift ) (mode > 0) then Go into display math mode 1145
else begin back input ; Go into ordinary math mode 1139 ;
end;
end;
1139. Go into ordinary math mode 1139
begin push math(math shift group); eq word dene(int base + cur fam code, 1);
if every math ,= null then begin token list (every math, every math text );
end
This code is used in sections 1138 and 1142.
1140. We get into ordinary math mode from display math mode when \eqno or \leqno appears. In
such cases cur chr will be 0 or 1, respectively; the value of cur chr is placed onto save stack for safe keeping.
Cases of main control that build boxes and lists 1056 +
mmode + eq no: if privileged then
if cur group = math shift group then start eq no
else o save;
1141. Put each of T
E
Xs primitives into the hash table 226 +
primitive("eqno", eq no, 0); primitive("leqno", eq no, 1);
418 PART 48: BUILDING MATH LISTS T
E
X82 1142
1142. When T
E
X is in display math mode, cur group = math shift group, so it is not necessary for the
start eq no procedure to test for this condition.
Declare action procedures for use by main control 1043 +
procedure start eq no;
begin saved (0) cur chr ; incr (save ptr ); Go into ordinary math mode 1139 ;
end;
1143. Cases of print cmd chr for symbolic printing of primitives 227 +
eq no: if chr code = 1 then print esc("leqno") else print esc("eqno");
1144. Forbidden cases detected in main control 1048 +
non math(eq no),
1145. When we enter display math mode, we need to call line break to process the partial paragraph
that has just been interrupted by the display. Then we can set the proper values of display width and
display indent and pre display size.
Go into display math mode 1145
begin if head = tail then \noindent$$ or $$ $$
begin pop nest ; w max dimen;
end
else begin line break (display widow penalty);
Calculate the natural width, w, by which the characters of the nal line extend to the right of the
reference point, plus two ems; or set w max dimen if the non-blank information on that line is
aected by stretching or shrinking 1146 ;
end; now we are in vertical mode, working on the list that will contain the display
Calculate the length, l, and the shift amount, s, of the display lines 1149 ;
push math(math shift group); mode mmode; eq word dene(int base + cur fam code, 1);
eq word dene(dimen base + pre display size code, w);
eq word dene(dimen base + display width code, l); eq word dene(dimen base + display indent code, s);
if every display ,= null then begin token list (every display, every display text );
if nest ptr = 1 then build page;
end
This code is used in section 1138.
1146. Calculate the natural width, w, by which the characters of the nal line extend to the right of the
reference point, plus two ems; or set w max dimen if the non-blank information on that line is
aected by stretching or shrinking 1146
v shift amount (just box ) + 2 quad (cur font ); w max dimen; p list ptr (just box );
while p ,= null do
begin Let d be the natural width of node p; if the node is visible, goto found ; if the node is glue
that stretches or shrinks, set v max dimen 1147 ;
if v < max dimen then v v + d;
goto not found ;
found : if v < max dimen then
begin v v + d; w v;
end
else begin w max dimen; goto done;
end;
not found : p link (p);
end;
done:
This code is used in section 1145.
1147 T
E
X82 PART 48: BUILDING MATH LISTS 419
1147. Let d be the natural width of node p; if the node is visible, goto found ; if the node is glue that
stretches or shrinks, set v max dimen 1147
reswitch: if is char node(p) then
begin f font (p); d char width(f)(char info(f)(character (p))); goto found ;
end;
case type(p) of
hlist node, vlist node, rule node: begin d width(p); goto found ;
end;
ligature node: Make node p look like a char node and goto reswitch 652 ;
kern node, math node: d width(p);
glue node: Let d be the natural width of this glue; if stretching or shrinking, set v max dimen; goto
found in the case of leaders 1148 ;
whatsit node: Let d be the width of the whatsit p 1361 ;
othercases d 0
endcases
This code is used in section 1146.
1148. We need to be careful that w, v, and d do not depend on any glue set values, since such values are
subject to system-dependent rounding. System-dependent numbers are not allowed to inltrate parameters
like pre display size, since T
E
X82 is supposed to make the same decisions on all machines.
Let d be the natural width of this glue; if stretching or shrinking, set v max dimen; goto found in the
case of leaders 1148
begin q glue ptr (p); d width(q);
if glue sign(just box ) = stretching then
begin if (glue order (just box ) = stretch order (q)) (stretch(q) ,= 0) then v max dimen;
end
else if glue sign(just box ) = shrinking then
begin if (glue order (just box ) = shrink order (q)) (shrink (q) ,= 0) then v max dimen;
end;
if subtype(p) a leaders then goto found ;
end
This code is used in section 1147.
1149. A displayed equation is considered to be three lines long, so we calculate the length and oset of
line number prev graf + 2.
Calculate the length, l, and the shift amount, s, of the display lines 1149
if par shape ptr = null then
if (hang indent ,= 0) (((hang after 0) (prev graf + 2 > hang after ))
(prev graf + 1 < hang after )) then
begin l hsize abs (hang indent );
if hang indent > 0 then s hang indent else s 0;
end
else begin l hsize; s 0;
end
else begin n info(par shape ptr );
if prev graf + 2 n then p par shape ptr + 2 n
else p par shape ptr + 2 (prev graf + 2);
s mem[p 1].sc; l mem[p].sc;
end
This code is used in section 1145.
420 PART 48: BUILDING MATH LISTS T
E
X82 1150
1150. Subformulas of math formulas cause a new level of math mode to be entered, on the semantic nest
as well as the save stack. These subformulas arise in several ways: (1) A left brace by itself indicates the
beginning of a subformula that will be put into a box, thereby freezing its glue and preventing line breaks.
(2) A subscript or superscript is treated as a subformula if it is not a single character; the same applies to the
nucleus of things like \underline. (3) The \left primitive initiates a subformula that will be terminated by
a matching \right. The group codes placed on save stack in these three cases are math group, math group,
and math left group, respectively.
Here is the code that handles case (1); the other cases are not quite as trivial, so we shall consider them
later.
Cases of main control that build boxes and lists 1056 +
mmode + left brace: begin tail append (new noad ); back input ; scan math(nucleus (tail ));
end;
1151. Recall that the nucleus , subscr , and supscr elds in a noad are broken down into subelds called
math type and either info or (fam, character ). The job of scan math is to gure out what to place in one
of these principal elds; it looks at the subformula that comes next in the input, and places an encoding of
that subformula into a given word of mem.
dene fam in range ((cur fam 0) (cur fam < 16))
Declare action procedures for use by main control 1043 +
procedure scan math(p : pointer );
label restart , reswitch, exit ;
var c: integer ; math character code
begin restart : Get the next non-blank non-relax non-call token 404 ;
reswitch: case cur cmd of
letter , other char , char given: begin c ho(math code(cur chr ));
if c = 100000 then
begin Treat cur chr as an active character 1152 ;
goto restart ;
end;
end;
char num: begin scan char num; cur chr cur val ; cur cmd char given; goto reswitch;
end;
math char num: begin scan fteen bit int ; c cur val ;
end;
math given: c cur chr ;
delim num: begin scan twenty seven bit int ; c cur val div 10000 ;
end;
othercases Scan a subformula enclosed in braces and return 1153
endcases;
math type(p) math char ; character (p) qi (c mod 256);
if (c var code) fam in range then fam(p) cur fam
else fam(p) (c div 256) mod 16;
exit : end;
1152. An active character that is an outer call is allowed here.
Treat cur chr as an active character 1152
begin cur cs cur chr + active base; cur cmd eq type(cur cs ); cur chr equiv (cur cs ); x token;
back input ;
end
This code is used in sections 1151 and 1155.
1153 T
E
X82 PART 48: BUILDING MATH LISTS 421
1153. The pointer p is placed on save stack while a complex subformula is being scanned.
Scan a subformula enclosed in braces and return 1153
begin back input ; scan left brace;
saved (0) p; incr (save ptr ); push math(math group); return;
end
This code is used in section 1151.
1154. The simplest math formula is, of course, $ $, when no noads are generated. The next simplest
cases involve a single character, e.g., $x$. Even though such cases may not seem to be very interesting,
the reader can perhaps understand how happy the author was when $x$ was rst properly typeset by T
E
X.
The code in this section was used.
Cases of main control that build boxes and lists 1056 +
mmode + letter , mmode + other char , mmode + char given: set math char (ho(math code(cur chr )));
mmode + char num: begin scan char num; cur chr cur val ; set math char (ho(math code(cur chr )));
end;
mmode + math char num: begin scan fteen bit int ; set math char (cur val );
end;
mmode + math given: set math char (cur chr );
mmode + delim num: begin scan twenty seven bit int ; set math char (cur val div 10000 );
end;
1155. The set math char procedure creates a new noad appropriate to a given math code, and appends
it to the current mlist. However, if the math code is suciently large, the cur chr is treated as an active
character and nothing is appended.
Declare action procedures for use by main control 1043 +
procedure set math char (c : integer );
var p: pointer ; the new noad
begin if c 100000 then Treat cur chr as an active character 1152
else begin p new noad ; math type(nucleus (p)) math char ;
character (nucleus (p)) qi (c mod 256); fam(nucleus (p)) (c div 256) mod 16;
if c var code then
begin if fam in range then fam(nucleus (p)) cur fam;
type(p) ord noad ;
end
else type(p) ord noad + (c div 10000 );
link (tail ) p; tail p;
end;
end;
1156. Primitive math operators like \mathop and \underline are given the command code math comp,
supplemented by the noad type that they generate.
Put each of T
E
Xs primitives into the hash table 226 +
primitive("mathord", math comp, ord noad ); primitive("mathop", math comp, op noad );
primitive("mathbin", math comp, bin noad ); primitive("mathrel", math comp, rel noad );
primitive("mathopen", math comp, open noad ); primitive("mathclose", math comp, close noad );
primitive("mathpunct", math comp, punct noad ); primitive("mathinner", math comp, inner noad );
primitive("underline", math comp, under noad ); primitive("overline", math comp, over noad );
primitive("displaylimits", limit switch, normal ); primitive("limits", limit switch, limits );
primitive("nolimits", limit switch, no limits );
422 PART 48: BUILDING MATH LISTS T
E
X82 1157
1157. Cases of print cmd chr for symbolic printing of primitives 227 +
math comp: case chr code of
ord noad : print esc("mathord");
op noad : print esc("mathop");
bin noad : print esc("mathbin");
rel noad : print esc("mathrel");
open noad : print esc("mathopen");
close noad : print esc("mathclose");
punct noad : print esc("mathpunct");
inner noad : print esc("mathinner");
under noad : print esc("underline");
othercases print esc("overline")
endcases;
limit switch: if chr code = limits then print esc("limits")
else if chr code = no limits then print esc("nolimits")
else print esc("displaylimits");
1158. Cases of main control that build boxes and lists 1056 +
mmode + math comp: begin tail append (new noad ); type(tail ) cur chr ; scan math(nucleus (tail ));
end;
mmode + limit switch: math limit switch;
1159. Declare action procedures for use by main control 1043 +
procedure math limit switch;
label exit ;
begin if head ,= tail then
if type(tail ) = op noad then
begin subtype(tail ) cur chr ; return;
end;
print err ("Limitcontrolsmustfollowamathoperator");
help1 ("Imignoringthismisplaced\limitsor\nolimitscommand."); error ;
exit : end;
1160. Delimiter elds of noads are lled in by the scan delimiter routine. The rst parameter of this
procedure is the mem address where the delimiter is to be placed; the second tells if this delimiter follows
\radical or not.
Declare action procedures for use by main control 1043 +
procedure scan delimiter (p : pointer ; r : boolean);
begin if r then scan twenty seven bit int
else begin Get the next non-blank non-relax non-call token 404 ;
case cur cmd of
letter , other char : cur val del code(cur chr );
delim num: scan twenty seven bit int ;
othercases cur val 1
endcases;
end;
if cur val < 0 then
Report that an invalid delimiter code is being changed to null; set cur val 0 1161 ;
small fam(p) (cur val div 4000000 ) mod 16; small char (p) qi ((cur val div 10000 ) mod 256);
large fam(p) (cur val div 256) mod 16; large char (p) qi (cur val mod 256);
end;
1161 T
E
X82 PART 48: BUILDING MATH LISTS 423
1161. Report that an invalid delimiter code is being changed to null; set cur val 0 1161
begin print err ("Missingdelimiter(.inserted)");
help6 ("Iwasexpectingtoseesomethinglike`(or`\{or")
("`\}here.Ifyoutyped,e.g.,`{insteadof`\{,you")
("shouldprobablydeletethe`{bytyping`1now,sothat")
("bracesdontgetunbalanced.Otherwisejustproceed.")
("Acceptabledelimitersarecharacterswhose\delcodeis")
("nonnegative,oryoucanuse`\delimiter<delimitercode>."); back error ; cur val 0;
end
This code is used in section 1160.
1162. Cases of main control that build boxes and lists 1056 +
mmode + radical : math radical ;
1163. Declare action procedures for use by main control 1043 +
procedure math radical ;
begin tail append (get node(radical noad size)); type(tail ) radical noad ; subtype(tail ) normal ;
mem[nucleus (tail )].hh empty eld ; mem[subscr (tail )].hh empty eld ;
mem[supscr (tail )].hh empty eld ; scan delimiter (left delimiter (tail ), true); scan math(nucleus (tail ));
end;
1164. Cases of main control that build boxes and lists 1056 +
mmode + accent , mmode + math accent : math ac;
1165. Declare action procedures for use by main control 1043 +
procedure math ac;
begin if cur cmd = accent then Complain that the user should have said \mathaccent 1166 ;
tail append (get node(accent noad size)); type(tail ) accent noad ; subtype(tail ) normal ;
mem[nucleus (tail )].hh empty eld ; mem[subscr (tail )].hh empty eld ;
mem[supscr (tail )].hh empty eld ; math type(accent chr (tail )) math char ; scan fteen bit int ;
character (accent chr (tail )) qi (cur val mod 256);
if (cur val var code) fam in range then fam(accent chr (tail )) cur fam
else fam(accent chr (tail )) (cur val div 256) mod 16;
scan math(nucleus (tail ));
end;
1166. Complain that the user should have said \mathaccent 1166
begin print err ("Pleaseuse"); print esc("mathaccent"); print ("foraccentsinmathmode");
help2 ("Imchanging\accentto\mathaccenthere;wishmeluck.")
("(Accentsarenotthesameinformulasastheyareintext.)"); error ;
end
This code is used in section 1165.
1167. Cases of main control that build boxes and lists 1056 +
mmode + vcenter : begin scan spec(vcenter group, false); normal paragraph; push nest ; mode vmode;
prev depth ignore depth;
if every vbox ,= null then begin token list (every vbox , every vbox text );
end;
424 PART 48: BUILDING MATH LISTS T
E
X82 1168
1168. Cases of handle right brace where a right brace triggers a delayed action 1085 +
vcenter group: begin end graf ; unsave; save ptr save ptr 2;
p vpack (link (head ), saved (1), saved (0)); pop nest ; tail append (new noad ); type(tail ) vcenter noad ;
math type(nucleus (tail )) sub box ; info(nucleus (tail )) p;
end;
1169. The routine that inserts a style node holds no surprises.
Put each of T
E
Xs primitives into the hash table 226 +
primitive("displaystyle", math style, display style); primitive("textstyle", math style, text style);
primitive("scriptstyle", math style, script style);
primitive("scriptscriptstyle", math style, script script style);
1170. Cases of print cmd chr for symbolic printing of primitives 227 +
math style: print style(chr code);
1171. Cases of main control that build boxes and lists 1056 +
mmode + math style: tail append (new style(cur chr ));
mmode + non script : begin tail append (new glue(zero glue)); subtype(tail ) cond math glue;
end;
mmode + math choice: append choices ;
1172. The routine that scans the four mlists of a \mathchoice is very much like the routine that builds
discretionary nodes.
Declare action procedures for use by main control 1043 +
procedure append choices ;
begin tail append (new choice); incr (save ptr ); saved (1) 0; push math(math choice group);
scan left brace;
end;
1173. Cases of handle right brace where a right brace triggers a delayed action 1085 +
math choice group: build choices ;
1174. Declare action procedures for use by main control 1043 +
Declare the function called n mlist 1184
procedure build choices ;
label exit ;
var p: pointer ; the current mlist
begin unsave; p n mlist (null );
case saved (1) of
0: display mlist (tail ) p;
1: text mlist (tail ) p;
2: script mlist (tail ) p;
3: begin script script mlist (tail ) p; decr (save ptr ); return;
end;
end; there are no other cases
incr (saved (1)); push math(math choice group); scan left brace;
exit : end;
1175 T
E
X82 PART 48: BUILDING MATH LISTS 425
1175. Subscripts and superscripts are attached to the previous nucleus by the action procedure called
sub sup. We use the facts that sub mark = sup mark + 1 and subscr (p) = supscr (p) + 1.
Cases of main control that build boxes and lists 1056 +
mmode + sub mark , mmode + sup mark : sub sup;
1176. Declare action procedures for use by main control 1043 +
procedure sub sup;
var t: small number ; type of previous sub/superscript
p: pointer ; eld to be lled by scan math
begin t empty; p null ;
if tail ,= head then
if scripts allowed (tail ) then
begin p supscr (tail ) + cur cmd sup mark ; supscr or subscr
t math type(p);
end;
if (p = null ) (t ,= empty) then Insert a dummy noad to be sub/superscripted 1177 ;
scan math(p);
end;
1177. Insert a dummy noad to be sub/superscripted 1177
begin tail append (new noad ); p supscr (tail ) + cur cmd sup mark ; supscr or subscr
if t ,= empty then
begin if cur cmd = sup mark then
begin print err ("Doublesuperscript");
help1 ("Itreat`x^1^2essentiallylike`x^1{}^2.");
end
else begin print err ("Doublesubscript");
help1 ("Itreat`x_1_2essentiallylike`x_1{}_2.");
end;
error ;
end;
end
This code is used in section 1176.
1178. An operation like \over causes the current mlist to go into a state of suspended animation:
incompleat noad points to a fraction noad that contains the mlist-so-far as its numerator, while the de-
nominator is yet to come. Finally when the mlist is nished, the denominator will go into the incompleat
fraction noad, and that noad will become the whole formula, unless it is surrounded by \left and \right
delimiters.
dene above code = 0 \above
dene over code = 1 \over
dene atop code = 2 \atop
dene delimited code = 3 \abovewithdelims, etc.
Put each of T
E
Xs primitives into the hash table 226 +
primitive("above", above, above code);
primitive("over", above, over code);
primitive("atop", above, atop code);
primitive("abovewithdelims", above, delimited code + above code);
primitive("overwithdelims", above, delimited code + over code);
primitive("atopwithdelims", above, delimited code + atop code);
426 PART 48: BUILDING MATH LISTS T
E
X82 1179
1179. Cases of print cmd chr for symbolic printing of primitives 227 +
above: case chr code of
over code: print esc("over");
atop code: print esc("atop");
delimited code + above code: print esc("abovewithdelims");
delimited code + over code: print esc("overwithdelims");
delimited code + atop code: print esc("atopwithdelims");
othercases print esc("above")
endcases;
1180. Cases of main control that build boxes and lists 1056 +
mmode + above: math fraction;
1181. Declare action procedures for use by main control 1043 +
procedure math fraction;
var c: small number ; the type of generalized fraction we are scanning
begin c cur chr ;
if incompleat noad ,= null then
Ignore the fraction operation and complain about this ambiguous case 1183
else begin incompleat noad get node(fraction noad size); type(incompleat noad ) fraction noad ;
subtype(incompleat noad ) normal ; math type(numerator (incompleat noad )) sub mlist ;
info(numerator (incompleat noad )) link (head );
mem[denominator (incompleat noad )].hh empty eld ;
mem[left delimiter (incompleat noad )].qqqq null delimiter ;
mem[right delimiter (incompleat noad )].qqqq null delimiter ;
link (head ) null ; tail head ; Use code c to distinguish between generalized fractions 1182 ;
end;
end;
1182. Use code c to distinguish between generalized fractions 1182
if c delimited code then
begin scan delimiter (left delimiter (incompleat noad ), false);
scan delimiter (right delimiter (incompleat noad ), false);
end;
case c mod delimited code of
above code: begin scan normal dimen; thickness (incompleat noad ) cur val ;
end;
over code: thickness (incompleat noad ) default code;
atop code: thickness (incompleat noad ) 0;
end there are no other cases
This code is used in section 1181.
1183 T
E
X82 PART 48: BUILDING MATH LISTS 427
1183. Ignore the fraction operation and complain about this ambiguous case 1183
begin if c delimited code then
begin scan delimiter (garbage, false); scan delimiter (garbage, false);
end;
if c mod delimited code = above code then scan normal dimen;
print err ("Ambiguous;youneedanother{and}");
help3 ("Imignoringthisfractionspecification,sinceIdont")
("knowwhetheraconstructionlike`x\overy\overz")
("means`{x\overy}\overzor`x\over{y\overz}."); error ;
end
This code is used in section 1181.
1184. At the end of a math formula or subformula, the n mlist routine is called upon to return a pointer
to the newly completed mlist, and to pop the nest back to the enclosing semantic level. The parameter to
n mlist , if not null, points to a right noad that ends the current mlist; this right noad has not yet been
appended.
Declare the function called n mlist 1184
function n mlist (p : pointer ): pointer ;
var q: pointer ; the mlist to return
begin if incompleat noad ,= null then Compleat the incompleat noad 1185
else begin link (tail ) p; q link (head );
end;
pop nest ; n mlist q;
end;
This code is used in section 1174.
1185. Compleat the incompleat noad 1185
begin math type(denominator (incompleat noad )) sub mlist ;
info(denominator (incompleat noad )) link (head );
if p = null then q incompleat noad
else begin q info(numerator (incompleat noad ));
if type(q) ,= left noad then confusion("right");
info(numerator (incompleat noad )) link (q); link (q) incompleat noad ; link (incompleat noad ) p;
end;
end
This code is used in section 1184.
428 PART 48: BUILDING MATH LISTS T
E
X82 1186
1186. Now at last were ready to see what happens when a right brace occurs in a math formula. Two
special cases are simplied here: Braces are eectively removed when they surround a single Ord without
sub/superscripts, or when they surround an accent that is the nucleus of an Ord atom.
Cases of handle right brace where a right brace triggers a delayed action 1085 +
math group: begin unsave; decr (save ptr );
math type(saved (0)) sub mlist ; p n mlist (null ); info(saved (0)) p;
if p ,= null then
if link (p) = null then
if type(p) = ord noad then
begin if math type(subscr (p)) = empty then
if math type(supscr (p)) = empty then
begin mem[saved (0)].hh mem[nucleus (p)].hh; free node(p, noad size);
end;
end
else if type(p) = accent noad then
if saved (0) = nucleus (tail ) then
if type(tail ) = ord noad then Replace the tail of the list by p 1187 ;
end;
1187. Replace the tail of the list by p 1187
begin q head ;
while link (q) ,= tail do q link (q);
link (q) p; free node(tail , noad size); tail p;
end
This code is used in section 1186.
1188. We have dealt with all constructions of math mode except \left and \right, so the picture is
completed by the following sections of the program.
Put each of T
E
Xs primitives into the hash table 226 +
primitive("left", left right , left noad ); primitive("right", left right , right noad );
text (frozen right ) "right"; eqtb[frozen right ] eqtb[cur val ];
1189. Cases of print cmd chr for symbolic printing of primitives 227 +
left right : if chr code = left noad then print esc("left")
else print esc("right");
1190. Cases of main control that build boxes and lists 1056 +
mmode + left right : math left right ;
1191 T
E
X82 PART 48: BUILDING MATH LISTS 429
1191. Declare action procedures for use by main control 1043 +
procedure math left right ;
var t: small number ; left noad or right noad
p: pointer ; new noad
begin t cur chr ;
if (t = right noad ) (cur group ,= math left group) then Try to recover from mismatched \right 1192
else begin p new noad ; type(p) t; scan delimiter (delimiter (p), false);
if t = left noad then
begin push math(math left group); link (head ) p; tail p;
end
else begin p n mlist (p); unsave; end of math left group
tail append (new noad ); type(tail ) inner noad ; math type(nucleus (tail )) sub mlist ;
info(nucleus (tail )) p;
end;
end;
end;
1192. Try to recover from mismatched \right 1192
begin if cur group = math shift group then
begin scan delimiter (garbage, false); print err ("Extra"); print esc("right");
help1 ("Imignoringa\rightthathadnomatching\left."); error ;
end
else o save;
end
This code is used in section 1191.
1193. Here is the only way out of math mode.
Cases of main control that build boxes and lists 1056 +
mmode + math shift : if cur group = math shift group then after math
else o save;
430 PART 48: BUILDING MATH LISTS T
E
X82 1194
1194. Declare action procedures for use by main control 1043 +
procedure after math;
var l: boolean; \leqno instead of \eqno
danger : boolean; not enough symbol fonts are present
m: integer ; mmode or mmode
p: pointer ; the formula
a: pointer ; box containing equation number
Local variables for nishing a displayed formula 1198
begin danger false; Check that the necessary fonts for math symbols are present; if not, ush the
current math lists and set danger true 1195 ;
m mode; l false; p n mlist (null ); this pops the nest
if mode = m then end of equation number
begin Check that another $ follows 1197 ;
cur mlist p; cur style text style; mlist penalties false; mlist to hlist ;
a hpack (link (temp head ), natural ); unsave; decr (save ptr ); now cur group = math shift group
if saved (0) = 1 then l true;
danger false; Check that the necessary fonts for math symbols are present; if not, ush the current
math lists and set danger true 1195 ;
m mode; p n mlist (null );
end
else a null ;
if m < 0 then Finish math in text 1196
else begin if a = null then Check that another $ follows 1197 ;
Finish displayed math 1199 ;
end;
end;
1195. Check that the necessary fonts for math symbols are present; if not, ush the current math lists
and set danger true 1195
if (font params [fam fnt (2 + text size)] < total mathsy params )
(font params [fam fnt (2 + script size)] < total mathsy params )
(font params [fam fnt (2 + script script size)] < total mathsy params ) then
begin print err ("Mathformuladeleted:Insufficientsymbolfonts");
help3 ("Sorry,butIcanttypesetmathunless\textfont2")
("and\scriptfont2and\scriptscriptfont2haveall")
("the\fontdimenvaluesneededinmathsymbolfonts."); error ; ush math; danger true;
end
else if (font params [fam fnt (3 + text size)] < total mathex params )
(font params [fam fnt (3 + script size)] < total mathex params )
(font params [fam fnt (3 + script script size)] < total mathex params ) then
begin print err ("Mathformuladeleted:Insufficientextensionfonts");
help3 ("Sorry,butIcanttypesetmathunless\textfont3")
("and\scriptfont3and\scriptscriptfont3haveall")
("the\fontdimenvaluesneededinmathextensionfonts."); error ; ush math;
danger true;
end
This code is used in sections 1194 and 1194.
1196 T
E
X82 PART 48: BUILDING MATH LISTS 431
1196. The unsave is done after everything else here; hence an appearance of \mathsurround inside of
$...$ aects the spacing at these particular $s. This is consistent with the conventions of $$...$$, since
\abovedisplayskip inside a display aects the space above that display.
Finish math in text 1196
begin tail append (new math(math surround , before)); cur mlist p; cur style text style;
mlist penalties (mode > 0); mlist to hlist ; link (tail ) link (temp head );
while link (tail ) ,= null do tail link (tail );
tail append (new math(math surround , after )); space factor 1000; unsave;
end
This code is used in section 1194.
1197. T
E
X gets to the following part of the program when the rst $ ending a display has been scanned.
Check that another $ follows 1197
begin get x token;
if cur cmd ,= math shift then
begin print err ("Displaymathshouldendwith$$");
help2 ("The`$thatIjustsawsupposedlymatchesaprevious`$$.")
("SoIshallassumethatyoutyped`$$bothtimes."); back error ;
end;
end
This code is used in sections 1194, 1194, and 1206.
1198. We have saved the worst for last: The fussiest part of math mode processing occurs when a displayed
formula is being centered and placed with an optional equation number.
Local variables for nishing a displayed formula 1198
b: pointer ; box containing the equation
w: scaled ; width of the equation
z: scaled ; width of the line
e: scaled ; width of equation number
q: scaled ; width of equation number plus space to separate from equation
d: scaled ; displacement of equation in the line
s: scaled ; move the line right this much
g1 , g2 : small number ; glue parameter codes for before and after
r: pointer ; kern node used to position the display
t: pointer ; tail of adjustment list
This code is used in section 1194.
432 PART 48: BUILDING MATH LISTS T
E
X82 1199
1199. At this time p points to the mlist for the formula; a is either null or it points to a box containing
the equation number; and we are in vertical mode (or internal vertical mode).
Finish displayed math 1199
cur mlist p; cur style display style; mlist penalties false; mlist to hlist ; p link (temp head );
adjust tail adjust head ; b hpack (p, natural ); p list ptr (b); t adjust tail ; adjust tail null ;
w width(b); z display width; s display indent ;
if (a = null ) danger then
begin e 0; q 0;
end
else begin e width(a); q e + math quad (text size);
end;
if w +q > z then Squeeze the equation as much as possible; if there is an equation number that should
go on a separate line by itself, set e 0 1201 ;
Determine the displacement, d, of the left edge of the equation, with respect to the line size z, assuming
that l = false 1202 ;
Append the glue or equation number preceding the display 1203 ;
Append the display and perhaps also the equation number 1204 ;
Append the glue or equation number following the display 1205 ;
resume after display
This code is used in section 1194.
1200. Declare action procedures for use by main control 1043 +
procedure resume after display;
begin if cur group ,= math shift group then confusion("display");
unsave; prev graf prev graf + 3; push nest ; mode hmode; space factor 1000; set cur lang ;
clang cur lang ;
prev graf (norm min(left hyphen min) 100 + norm min(right hyphen min)) 200000 + cur lang ;
Scan an optional space 443 ;
if nest ptr = 1 then build page;
end;
1201. The user can force the equation number to go on a separate line by causing its width to be zero.
Squeeze the equation as much as possible; if there is an equation number that should go on a separate line
by itself, set e 0 1201
begin if (e ,= 0) ((w total shrink [normal ] + q z)
(total shrink [l ] ,= 0) (total shrink [ll ] ,= 0) (total shrink [lll ] ,= 0)) then
begin free node(b, box node size); b hpack (p, z q, exactly);
end
else begin e 0;
if w > z then
begin free node(b, box node size); b hpack (p, z, exactly);
end;
end;
w width(b);
end
This code is used in section 1199.
1202 T
E
X82 PART 48: BUILDING MATH LISTS 433
1202. We try rst to center the display without regard to the existence of the equation number. If that
would make it too close (where too close means that the space between display and equation number is
less than the width of the equation number), we either center it in the remaining space or move it as far
from the equation number as possible. The latter alternative is taken only if the display begins with glue,
since we assume that the user put glue there to control the spacing precisely.
Determine the displacement, d, of the left edge of the equation, with respect to the line size z, assuming
that l = false 1202
d half (z w);
if (e > 0) (d < 2 e) then too close
begin d half (z w e);
if p ,= null then
if is char node(p) then
if type(p) = glue node then d 0;
end
This code is used in section 1199.
1203. If the equation number is set on a line by itself, either before or after the formula, we append an
innite penalty so that no page break will separate the display from its number; and we use the same size
and displacement for all three potential lines of the display, even though \parshape may specify them
dierently.
Append the glue or equation number preceding the display 1203
tail append (new penalty(pre display penalty));
if (d + s pre display size) l then not enough clearance
begin g1 above display skip code; g2 below display skip code;
end
else begin g1 above display short skip code; g2 below display short skip code;
end;
if l (e = 0) then it follows that type(a) = hlist node
begin shift amount (a) s; append to vlist (a); tail append (new penalty(inf penalty));
end
else tail append (new param glue(g1 ))
This code is used in section 1199.
1204. Append the display and perhaps also the equation number 1204
if e ,= 0 then
begin r new kern(z w e d);
if l then
begin link (a) r; link (r) b; b a; d 0;
end
else begin link (b) r; link (r) a;
end;
b hpack (b, natural );
end;
shift amount (b) s + d; append to vlist (b)
This code is used in section 1199.
434 PART 48: BUILDING MATH LISTS T
E
X82 1205
1205. Append the glue or equation number following the display 1205
if (a ,= null ) (e = 0) l then
begin tail append (new penalty(inf penalty)); shift amount (a) s + z width(a); append to vlist (a);
g2 0;
end;
if t ,= adjust head then migrating material comes after equation number
begin link (tail ) link (adjust head ); tail t;
end;
tail append (new penalty(post display penalty));
if g2 > 0 then tail append (new param glue(g2 ))
This code is used in section 1199.
1206. When \halign appears in a display, the alignment routines operate essentially as they do in vertical
mode. Then the following program is activated, with p and q pointing to the beginning and end of the
resulting list, and with aux save holding the prev depth value.
Finish an alignment in a display 1206
begin do assignments ;
if cur cmd ,= math shift then Ponticate about improper alignment in display 1207
else Check that another $ follows 1197 ;
pop nest ; tail append (new penalty(pre display penalty));
tail append (new param glue(above display skip code)); link (tail ) p;
if p ,= null then tail q;
tail append (new penalty(post display penalty)); tail append (new param glue(below display skip code));
prev depth aux save.sc; resume after display;
end
This code is used in section 812.
1207. Ponticate about improper alignment in display 1207
begin print err ("Missing$$inserted");
help2 ("Displayscanusespecialalignments(like\eqalignno)")
("onlyifnothingbutthealignmentitselfisbetween$$s."); back error ;
end
This code is used in section 1206.
1208 T
E
X82 PART 49: MODE-INDEPENDENT PROCESSING 435
1208. Mode-independent processing. The long main control procedure has now been fully specied,
except for certain activities that are independent of the current mode. These activities do not change the
current vlist or hlist or mlist; if they change anything, it is the value of a parameter or the meaning of a
control sequence.
Assignments to values in eqtb can be global or local. Furthermore, a control sequence can be dened to be
\long or \outer, and it might or might not be expanded. The prexes \global, \long, and \outer
can occur in any order. Therefore we assign binary numeric codes, making it possible to accumulate the
union of all specied prexes by adding the corresponding codes. (Pascals set operations could also have
been used.)
Put each of T
E
Xs primitives into the hash table 226 +
primitive("long", prex , 1); primitive("outer", prex , 2); primitive("global", prex , 4);
primitive("def", def , 0); primitive("gdef", def , 1); primitive("edef", def , 2); primitive("xdef", def , 3);
1209. Cases of print cmd chr for symbolic printing of primitives 227 +
prex : if chr code = 1 then print esc("long")
else if chr code = 2 then print esc("outer")
else print esc("global");
def : if chr code = 0 then print esc("def")
else if chr code = 1 then print esc("gdef")
else if chr code = 2 then print esc("edef")
else print esc("xdef");
1210. Every prex, and every command code that might or might not be prexed, calls the action
procedure prexed command . This routine accumulates a sequence of prexes until coming to a non-prex,
then it carries out the command.
Cases of main control that dont depend on mode 1210
any mode(toks register ), any mode(assign toks ), any mode(assign int ), any mode(assign dimen),
any mode(assign glue), any mode(assign mu glue), any mode(assign font dimen),
any mode(assign font int ), any mode(set aux ), any mode(set prev graf ), any mode(set page dimen),
any mode(set page int ), any mode(set box dimen), any mode(set shape), any mode(def code),
any mode(def family), any mode(set font ), any mode(def font ), any mode(register ),
any mode(advance), any mode(multiply), any mode(divide), any mode(prex ), any mode(let ),
any mode(shorthand def ), any mode(read to cs ), any mode(def ), any mode(set box ),
any mode(hyph data), any mode(set interaction): prexed command ;
See also sections 1268, 1271, 1274, 1276, 1285, and 1290.
This code is used in section 1045.
436 PART 49: MODE-INDEPENDENT PROCESSING T
E
X82 1211
1211. If the user says, e.g., \global\global, the redundancy is silently accepted.
Declare action procedures for use by main control 1043 +
Declare subprocedures for prexed command 1215
procedure prexed command ;
label done, exit ;
var a: small number ; accumulated prex codes so far
f: internal font number ; identies a font
j: halfword ; index into a \parshape specication
k: font index ; index into font info
p, q: pointer ; for temporary short-term use
n: integer ; ditto
e: boolean; should a denition be expanded? or was \let not done?
begin a 0;
while cur cmd = prex do
begin if odd (a div cur chr ) then a a + cur chr ;
Get the next non-blank non-relax non-call token 404 ;
if cur cmd max non prexed command then Discard erroneous prexes and return 1212 ;
end;
Discard the prexes \long and \outer if they are irrelevant 1213 ;
Adjust for the setting of \globaldefs 1214 ;
case cur cmd of
Assignments 1217
othercases confusion("prefix")
endcases;
done: Insert a token saved by \afterassignment, if any 1269 ;
exit : end;
1212. Discard erroneous prexes and return 1212
begin print err ("Youcantuseaprefixwith`"); print cmd chr (cur cmd , cur chr );
print char (""); help1 ("Illpretendyoudidntsay\longor\outeror\global.");
back error ; return;
end
This code is used in section 1211.
1213. Discard the prexes \long and \outer if they are irrelevant 1213
if (cur cmd ,= def ) (a mod 4 ,= 0) then
begin print err ("Youcantuse`"); print esc("long"); print ("or`"); print esc("outer");
print ("with`"); print cmd chr (cur cmd , cur chr ); print char ("");
help1 ("Illpretendyoudidntsay\longor\outerhere."); error ;
end
This code is used in section 1211.
1214 T
E
X82 PART 49: MODE-INDEPENDENT PROCESSING 437
1214. The previous routine does not have to adjust a so that a mod 4 = 0, since the following routines
test for the \global prex as follows.
dene global (a 4)
dene dene(#)
if global then geq dene(#) else eq dene(#)
dene word dene(#)
if global then geq word dene(#) else eq word dene(#)
Adjust for the setting of \globaldefs 1214
if global defs ,= 0 then
if global defs < 0 then
begin if global then a a 4;
end
else begin if global then a a + 4;
end
This code is used in section 1211.
1215. When a control sequence is to be dened, by \def or \let or something similar, the get r token
routine will substitute a special control sequence for a token that is not redenable.
Declare subprocedures for prexed command 1215
procedure get r token;
label restart ;
begin restart : repeat get token;
until cur tok ,= space token;
if (cur cs = 0) (cur cs > frozen control sequence) then
begin print err ("Missingcontrolsequenceinserted");
help5 ("Pleasedontsay`\defcs{...},say`\def\cs{...}.")
("Iveinsertedaninaccessiblecontrolsequencesothatyour")
("definitionwillbecompletedwithoutmixingmeuptoobadly.")
("Youcanrecovergraciouslyfromthiserror,ifyoure")
("careful;seeexercise27.2inTheTeXbook.");
if cur cs = 0 then back input ;
cur tok cs token ag + frozen protection; ins error ; goto restart ;
end;
end;
See also sections 1229, 1236, 1243, 1244, 1245, 1246, 1247, 1257, and 1265.
This code is used in section 1211.
1216. Initialize table entries (done by INITEX only) 164 +
text (frozen protection) "inaccessible";
1217. Heres an example of the way many of the following routines operate. (Unfortunately, they arent
all as simple as this.)
Assignments 1217
set font : dene(cur font loc, data, cur chr );
See also sections 1218, 1221, 1224, 1225, 1226, 1228, 1232, 1234, 1235, 1241, 1242, 1248, 1252, 1253, 1256, and 1264.
This code is used in section 1211.
438 PART 49: MODE-INDEPENDENT PROCESSING T
E
X82 1218
1218. When a def command has been scanned, cur chr is odd if the denition is supposed to be global,
and cur chr 2 if the denition is supposed to be expanded.
Assignments 1217 +
def : begin if odd (cur chr ) global (global defs 0) then a a + 4;
e (cur chr 2); get r token; p cur cs ; q scan toks (true, e); dene(p, call + (a mod 4), def ref );
end;
1219. Both \let and \futurelet share the command code let .
Put each of T
E
Xs primitives into the hash table 226 +
primitive("let", let , normal );
primitive("futurelet", let , normal + 1);
1220. Cases of print cmd chr for symbolic printing of primitives 227 +
let : if chr code ,= normal then print esc("futurelet") else print esc("let");
1221. Assignments 1217 +
let : begin n cur chr ; get r token; p cur cs ;
if n = normal then
begin repeat get token;
until cur cmd ,= spacer ;
if cur tok = other token + "=" then
begin get token;
if cur cmd = spacer then get token;
end;
end
else begin get token; q cur tok ; get token; back input ; cur tok q; back input ;
look ahead, then back up
end; note that back input doesnt aect cur cmd , cur chr
if cur cmd call then add token ref (cur chr );
dene(p, cur cmd , cur chr );
end;
1222. A \chardef creates a control sequence whose cmd is char given; a \mathchardef creates a control
sequence whose cmd is math given; and the corresponding chr is the character code or math code. A
\countdef or \dimendef or \skipdef or \muskipdef creates a control sequence whose cmd is assign int or
. . . or assign mu glue, and the corresponding chr is the eqtb location of the internal register in question.
dene char def code = 0 shorthand def for \chardef
dene math char def code = 1 shorthand def for \mathchardef
dene count def code = 2 shorthand def for \countdef
dene dimen def code = 3 shorthand def for \dimendef
dene skip def code = 4 shorthand def for \skipdef
dene mu skip def code = 5 shorthand def for \muskipdef
dene toks def code = 6 shorthand def for \toksdef
Put each of T
E
Xs primitives into the hash table 226 +
primitive("chardef", shorthand def , char def code);
primitive("mathchardef", shorthand def , math char def code);
primitive("countdef", shorthand def , count def code);
primitive("dimendef", shorthand def , dimen def code);
primitive("skipdef", shorthand def , skip def code);
primitive("muskipdef", shorthand def , mu skip def code);
primitive("toksdef", shorthand def , toks def code);
1223 T
E
X82 PART 49: MODE-INDEPENDENT PROCESSING 439
1223. Cases of print cmd chr for symbolic printing of primitives 227 +
shorthand def : case chr code of
char def code: print esc("chardef");
math char def code: print esc("mathchardef");
count def code: print esc("countdef");
dimen def code: print esc("dimendef");
skip def code: print esc("skipdef");
mu skip def code: print esc("muskipdef");
othercases print esc("toksdef")
endcases;
char given: begin print esc("char"); print hex (chr code);
end;
math given: begin print esc("mathchar"); print hex (chr code);
end;
1224. We temporarily dene p to be relax , so that an occurrence of p while scanning the denition will
simply stop the scanning instead of producing an undened control sequence error or expanding the
previous meaning. This allows, for instance, \chardef\foo=123\foo.
Assignments 1217 +
shorthand def : begin n cur chr ; get r token; p cur cs ; dene(p, relax , 256); scan optional equals ;
case n of
char def code: begin scan char num; dene(p, char given, cur val );
end;
math char def code: begin scan fteen bit int ; dene(p, math given, cur val );
end;
othercases begin scan eight bit int ;
case n of
count def code: dene(p, assign int , count base + cur val );
dimen def code: dene(p, assign dimen, scaled base + cur val );
skip def code: dene(p, assign glue, skip base + cur val );
mu skip def code: dene(p, assign mu glue, mu skip base + cur val );
toks def code: dene(p, assign toks , toks base + cur val );
end; there are no other cases
end
endcases;
end;
1225. Assignments 1217 +
read to cs : begin scan int ; n cur val ;
if scan keyword ("to") then
begin print err ("Missing`toinserted");
help2 ("Youshouldhavesaid`\read<number>to\cs.")
("Imgoingtolookforthe\csnow."); error ;
end;
get r token; p cur cs ; read toks (n, p); dene(p, call , cur val );
end;
440 PART 49: MODE-INDEPENDENT PROCESSING T
E
X82 1226
1226. The token-list parameters, \output and \everypar, etc., receive their values in the following way.
(For safetys sake, we place an enclosing pair of braces around an \output list.)
Assignments 1217 +
toks register , assign toks : begin q cur cs ;
if cur cmd = toks register then
begin scan eight bit int ; p toks base + cur val ;
end
else p cur chr ; p = every par loc or output routine loc or . . .
scan optional equals ; Get the next non-blank non-relax non-call token 404 ;
if cur cmd ,= left brace then If the right-hand side is a token parameter or token register, nish the
assignment and goto done 1227 ;
back input ; cur cs q; q scan toks (false, false);
if link (def ref ) = null then empty list: revert to the default
begin dene(p, undened cs , null ); free avail (def ref );
end
else begin if p = output routine loc then enclose in curlies
begin link (q) get avail ; q link (q); info(q) right brace token + "}"; q get avail ;
info(q) left brace token + "{"; link (q) link (def ref ); link (def ref ) q;
end;
dene(p, call , def ref );
end;
end;
1227. If the right-hand side is a token parameter or token register, nish the assignment and goto
done 1227
begin if cur cmd = toks register then
begin scan eight bit int ; cur cmd assign toks ; cur chr toks base + cur val ;
end;
if cur cmd = assign toks then
begin q equiv (cur chr );
if q = null then dene(p, undened cs , null )
else begin add token ref (q); dene(p, call , q);
end;
goto done;
end;
end
This code is used in section 1226.
1228. Similar routines are used to assign values to the numeric parameters.
Assignments 1217 +
assign int : begin p cur chr ; scan optional equals ; scan int ; word dene(p, cur val );
end;
assign dimen: begin p cur chr ; scan optional equals ; scan normal dimen; word dene(p, cur val );
end;
assign glue, assign mu glue: begin p cur chr ; n cur cmd ; scan optional equals ;
if n = assign mu glue then scan glue(mu val ) else scan glue(glue val );
trap zero glue; dene(p, glue ref , cur val );
end;
1229 T
E
X82 PART 49: MODE-INDEPENDENT PROCESSING 441
1229. When a glue register or parameter becomes zero, it will always point to zero glue because of the
following procedure. (Exception: The tabskip glue isnt trapped while preambles are being scanned.)
Declare subprocedures for prexed command 1215 +
procedure trap zero glue;
begin if (width(cur val ) = 0) (stretch(cur val ) = 0) (shrink (cur val ) = 0) then
begin add glue ref (zero glue); delete glue ref (cur val ); cur val zero glue;
end;
end;
1230. The various character code tables are changed by the def code commands, and the font families are
declared by def family.
Put each of T
E
Xs primitives into the hash table 226 +
primitive("catcode", def code, cat code base); primitive("mathcode", def code, math code base);
primitive("lccode", def code, lc code base); primitive("uccode", def code, uc code base);
primitive("sfcode", def code, sf code base); primitive("delcode", def code, del code base);
primitive("textfont", def family, math font base);
primitive("scriptfont", def family, math font base + script size);
primitive("scriptscriptfont", def family, math font base + script script size);
1231. Cases of print cmd chr for symbolic printing of primitives 227 +
def code: if chr code = cat code base then print esc("catcode")
else if chr code = math code base then print esc("mathcode")
else if chr code = lc code base then print esc("lccode")
else if chr code = uc code base then print esc("uccode")
else if chr code = sf code base then print esc("sfcode")
else print esc("delcode");
def family: print size(chr code math font base);
1232. The dierent types of code values have dierent legal ranges; the following program is careful to
check each case properly.
Assignments 1217 +
def code: begin Let n be the largest legal code value, based on cur chr 1233 ;
p cur chr ; scan char num; p p + cur val ; scan optional equals ; scan int ;
if ((cur val < 0) (p < del code base)) (cur val > n) then
begin print err ("Invalidcode("); print int (cur val );
if p < del code base then print ("),shouldbeintherange0..")
else print ("),shouldbeatmost");
print int (n); help1 ("Imgoingtouse0insteadofthatillegalcodevalue.");
error ; cur val 0;
end;
if p < math code base then dene(p, data, cur val )
else if p < del code base then dene(p, data, hi (cur val ))
else word dene(p, cur val );
end;
442 PART 49: MODE-INDEPENDENT PROCESSING T
E
X82 1233
1233. Let n be the largest legal code value, based on cur chr 1233
if cur chr = cat code base then n max char code
else if cur chr = math code base then n 100000
else if cur chr = sf code base then n 77777
else if cur chr = del code base then n 77777777
else n 255
This code is used in section 1232.
1234. Assignments 1217 +
def family: begin p cur chr ; scan four bit int ; p p + cur val ; scan optional equals ; scan font ident ;
dene(p, data, cur val );
end;
1235. Next we consider changes to T
E
Xs numeric registers.
Assignments 1217 +
register , advance, multiply, divide: do register command (a);
1236. We use the fact that register < advance < multiply < divide.
Declare subprocedures for prexed command 1215 +
procedure do register command (a : small number );
label found , exit ;
var l, q, r, s: pointer ; for list manipulation
p: int val . . mu val ; type of register involved
begin q cur cmd ; Compute the register location l and its type p; but return if invalid 1237 ;
if q = register then scan optional equals
else if scan keyword ("by") then do nothing ; optional by
arith error false;
if q < multiply then Compute result of register or advance, put it in cur val 1238
else Compute result of multiply or divide, put it in cur val 1240 ;
if arith error then
begin print err ("Arithmeticoverflow");
help2 ("Icantcarryoutthatmultiplicationordivision,")
("sincetheresultisoutofrange.");
if p glue val then delete glue ref (cur val );
error ; return;
end;
if p < glue val then word dene(l, cur val )
else begin trap zero glue; dene(l, glue ref , cur val );
end;
exit : end;
1237 T
E
X82 PART 49: MODE-INDEPENDENT PROCESSING 443
1237. Here we use the fact that the consecutive codes int val . . mu val and assign int . . assign mu glue
correspond to each other nicely.
Compute the register location l and its type p; but return if invalid 1237
begin if q ,= register then
begin get x token;
if (cur cmd assign int ) (cur cmd assign mu glue) then
begin l cur chr ; p cur cmd assign int ; goto found ;
end;
if cur cmd ,= register then
begin print err ("Youcantuse`"); print cmd chr (cur cmd , cur chr ); print ("after");
print cmd chr (q, 0); help1 ("Imforgettingwhatyousaidandnotchanginganything.");
error ; return;
end;
end;
p cur chr ; scan eight bit int ;
case p of
int val : l cur val + count base;
dimen val : l cur val + scaled base;
glue val : l cur val + skip base;
mu val : l cur val + mu skip base;
end; there are no other cases
end;
found :
This code is used in section 1236.
1238. Compute result of register or advance, put it in cur val 1238
if p < glue val then
begin if p = int val then scan int else scan normal dimen;
if q = advance then cur val cur val + eqtb[l].int ;
end
else begin scan glue(p);
if q = advance then Compute the sum of two glue specs 1239 ;
end
This code is used in section 1236.
1239. Compute the sum of two glue specs 1239
begin q new spec(cur val ); r equiv (l); delete glue ref (cur val ); width(q) width(q) + width(r);
if stretch(q) = 0 then stretch order (q) normal ;
if stretch order (q) = stretch order (r) then stretch(q) stretch(q) + stretch(r)
else if (stretch order (q) < stretch order (r)) (stretch(r) ,= 0) then
begin stretch(q) stretch(r); stretch order (q) stretch order (r);
end;
if shrink (q) = 0 then shrink order (q) normal ;
if shrink order (q) = shrink order (r) then shrink (q) shrink (q) + shrink (r)
else if (shrink order (q) < shrink order (r)) (shrink (r) ,= 0) then
begin shrink (q) shrink (r); shrink order (q) shrink order (r);
end;
cur val q;
end
This code is used in section 1238.
444 PART 49: MODE-INDEPENDENT PROCESSING T
E
X82 1240
1240. Compute result of multiply or divide, put it in cur val 1240
begin scan int ;
if p < glue val then
if q = multiply then
if p = int val then cur val mult integers (eqtb[l].int , cur val )
else cur val nx plus y(eqtb[l].int , cur val , 0)
else cur val x over n(eqtb[l].int , cur val )
else begin s equiv (l); r new spec(s);
if q = multiply then
begin width(r) nx plus y(width(s), cur val , 0); stretch(r) nx plus y(stretch(s), cur val , 0);
shrink (r) nx plus y(shrink (s), cur val , 0);
end
else begin width(r) x over n(width(s), cur val ); stretch(r) x over n(stretch(s), cur val );
shrink (r) x over n(shrink (s), cur val );
end;
cur val r;
end;
end
This code is used in section 1236.
1241. The processing of boxes is somewhat dierent, because we may need to scan and create an entire
box before we actually change the value of the old one.
Assignments 1217 +
set box : begin scan eight bit int ;
if global then n 256 + cur val else n cur val ;
scan optional equals ;
if set box allowed then scan box (box ag + n)
else begin print err ("Improper"); print esc("setbox");
help2 ("Sorry,\setboxisnotallowedafter\haligninadisplay,")
("orbetween\accentandanaccentedcharacter."); error ;
end;
end;
1242. The space factor or prev depth settings are changed when a set aux command is sensed. Similarly,
prev graf is changed in the presence of set prev graf , and dead cycles or insert penalties in the presence of
set page int . These denitions are always global.
When some dimension of a box register is changed, the change isnt exactly global; but T
E
X does not look
at the \global switch.
Assignments 1217 +
set aux : alter aux ;
set prev graf : alter prev graf ;
set page dimen: alter page so far ;
set page int : alter integer ;
set box dimen: alter box dimen;
1243 T
E
X82 PART 49: MODE-INDEPENDENT PROCESSING 445
1243. Declare subprocedures for prexed command 1215 +
procedure alter aux ;
var c: halfword ; hmode or vmode
begin if cur chr ,= abs (mode) then report illegal case
else begin c cur chr ; scan optional equals ;
if c = vmode then
begin scan normal dimen; prev depth cur val ;
end
else begin scan int ;
if (cur val 0) (cur val > 32767) then
begin print err ("Badspacefactor");
help1 ("Iallowonlyvaluesintherange1..32767here."); int error (cur val );
end
else space factor cur val ;
end;
end;
end;
1244. Declare subprocedures for prexed command 1215 +
procedure alter prev graf ;
var p: 0 . . nest size; index into nest
begin nest [nest ptr ] cur list ; p nest ptr ;
while abs (nest [p].mode eld ) ,= vmode do decr (p);
scan optional equals ; scan int ;
if cur val < 0 then
begin print err ("Bad"); print esc("prevgraf");
help1 ("Iallowonlynonnegativevalueshere."); int error (cur val );
end
else begin nest [p].pg eld cur val ; cur list nest [nest ptr ];
end;
end;
1245. Declare subprocedures for prexed command 1215 +
procedure alter page so far ;
var c: 0 . . 7; index into page so far
begin c cur chr ; scan optional equals ; scan normal dimen; page so far [c] cur val ;
end;
1246. Declare subprocedures for prexed command 1215 +
procedure alter integer ;
var c: 0 . . 1; 0 for \deadcycles, 1 for \insertpenalties
begin c cur chr ; scan optional equals ; scan int ;
if c = 0 then dead cycles cur val
else insert penalties cur val ;
end;
446 PART 49: MODE-INDEPENDENT PROCESSING T
E
X82 1247
1247. Declare subprocedures for prexed command 1215 +
procedure alter box dimen;
var c: small number ; width oset or height oset or depth oset
b: eight bits ; box number
begin c cur chr ; scan eight bit int ; b cur val ; scan optional equals ; scan normal dimen;
if box (b) ,= null then mem[box (b) + c].sc cur val ;
end;
1248. Paragraph shapes are set up in the obvious way.
Assignments 1217 +
set shape: begin scan optional equals ; scan int ; n cur val ;
if n 0 then p null
else begin p get node(2 n + 1); info(p) n;
for j 1 to n do
begin scan normal dimen; mem[p + 2 j 1].sc cur val ; indentation
scan normal dimen; mem[p + 2 j].sc cur val ; width
end;
end;
dene(par shape loc, shape ref , p);
end;
1249. Heres something that isnt quite so obvious. It guarantees that info(par shape ptr ) can hold any
positive n for which get node(2 n + 1) doesnt overow the memory capacity.
Check the constant values for consistency 14 +
if 2 max halfword < mem top mem min then bad 41;
1250. New hyphenation data is loaded by the hyph data command.
Put each of T
E
Xs primitives into the hash table 226 +
primitive("hyphenation", hyph data, 0); primitive("patterns", hyph data, 1);
1251. Cases of print cmd chr for symbolic printing of primitives 227 +
hyph data: if chr code = 1 then print esc("patterns")
else print esc("hyphenation");
1252. Assignments 1217 +
hyph data: if cur chr = 1 then
begin init new patterns ; goto done; tini
print err ("PatternscanbeloadedonlybyINITEX"); help0 ; error ;
repeat get token;
until cur cmd = right brace; ush the patterns
return;
end
else begin new hyph exceptions ; goto done;
end;
1253 T
E
X82 PART 49: MODE-INDEPENDENT PROCESSING 447
1253. All of T
E
Xs parameters are kept in eqtb except the font information, the interaction mode, and the
hyphenation tables; these are strictly global.
Assignments 1217 +
assign font dimen: begin nd font dimen(true); k cur val ; scan optional equals ; scan normal dimen;
font info[k].sc cur val ;
end;
assign font int : begin n cur chr ; scan font ident ; f cur val ; scan optional equals ; scan int ;
if n = 0 then hyphen char [f] cur val else skew char [f] cur val ;
end;
1254. Put each of T
E
Xs primitives into the hash table 226 +
primitive("hyphenchar", assign font int , 0); primitive("skewchar", assign font int , 1);
1255. Cases of print cmd chr for symbolic printing of primitives 227 +
assign font int : if chr code = 0 then print esc("hyphenchar")
else print esc("skewchar");
1256. Here is where the information for a new font gets loaded.
Assignments 1217 +
def font : new font (a);
1257. Declare subprocedures for prexed command 1215 +
procedure new font (a : small number );
label common ending ;
var u: pointer ; users font identier
s: scaled ; stated at size, or negative of scaled magnication
f: internal font number ; runs through existing fonts
t: str number ; name for the frozen font identier
old setting : 0 . . max selector ; holds selector setting
ushable string : str number ; string not yet referenced
begin if job name = 0 then open log le; avoid confusing texput with the font name
get r token; u cur cs ;
if u hash base then t text (u)
else if u single base then
if u = null cs then t "FONT" else t u single base
else begin old setting selector ; selector new string ; print ("FONT"); print (u active base);
selector old setting ; str room(1); t make string ;
end;
dene(u, set font , null font ); scan optional equals ; scan le name;
Scan the font size specication 1258 ;
If this font has already been loaded, set f to the internal font number and goto common ending 1260 ;
f read font info(u, cur name, cur area, s);
common ending : equiv (u) f; eqtb[font id base + f] eqtb[u]; font id text (f) t;
end;
448 PART 49: MODE-INDEPENDENT PROCESSING T
E
X82 1258
1258. Scan the font size specication 1258
name in progress true; this keeps cur name from being changed
if scan keyword ("at") then Put the (positive) at size into s 1259
else if scan keyword ("scaled") then
begin scan int ; s cur val ;
if (cur val 0) (cur val > 32768) then
begin print err ("Illegalmagnificationhasbeenchangedto1000");
help1 ("Themagnificationratiomustbebetween1and32768."); int error (cur val );
s 1000;
end;
end
else s 1000;
name in progress false
This code is used in section 1257.
1259. Put the (positive) at size into s 1259
begin scan normal dimen; s cur val ;
if (s 0) (s 1000000000 ) then
begin print err ("Improper`atsize("); print scaled (s); print ("pt),replacedby10pt");
help2 ("Icanonlyhandlefontsatpositivesizesthatare")
("lessthan2048pt,soIvechangedwhatyousaidto10pt."); error ; s 10 unity;
end;
end
This code is used in section 1258.
1260. When the user gives a new identier to a font that was previously loaded, the new name becomes
the font identier of record. Font names xyz and XYZ are considered to be dierent.
If this font has already been loaded, set f to the internal font number and goto common ending 1260
ushable string str ptr 1;
for f font base + 1 to font ptr do
if str eq str (font name[f], cur name) str eq str (font area[f], cur area) then
begin if cur name = ushable string then
begin ush string ; cur name font name[f];
end;
if s > 0 then
begin if s = font size[f] then goto common ending ;
end
else if font size[f] = xn over d (font dsize[f], s, 1000) then goto common ending ;
end
This code is used in section 1257.
1261. Cases of print cmd chr for symbolic printing of primitives 227 +
set font : begin print ("selectfont"); slow print (font name[chr code]);
if font size[chr code] ,= font dsize[chr code] then
begin print ("at"); print scaled (font size[chr code]); print ("pt");
end;
end;
1262 T
E
X82 PART 49: MODE-INDEPENDENT PROCESSING 449
1262. Put each of T
E
Xs primitives into the hash table 226 +
primitive("batchmode", set interaction, batch mode);
primitive("nonstopmode", set interaction, nonstop mode);
primitive("scrollmode", set interaction, scroll mode);
primitive("errorstopmode", set interaction, error stop mode);
1263. Cases of print cmd chr for symbolic printing of primitives 227 +
set interaction: case chr code of
batch mode: print esc("batchmode");
nonstop mode: print esc("nonstopmode");
scroll mode: print esc("scrollmode");
othercases print esc("errorstopmode")
endcases;
1264. Assignments 1217 +
set interaction: new interaction;
1265. Declare subprocedures for prexed command 1215 +
procedure new interaction;
begin print ln; interaction cur chr ; Initialize the print selector based on interaction 75 ;
if log opened then selector selector + 2;
end;
1266. The \afterassignment command puts a token into the global variable after token. This global
variable is examined just after every assignment has been performed.
Global variables 13 +
after token: halfword ; zero, or a saved token
1267. Set initial values of key variables 21 +
after token 0;
1268. Cases of main control that dont depend on mode 1210 +
any mode(after assignment ): begin get token; after token cur tok ;
end;
1269. Insert a token saved by \afterassignment, if any 1269
if after token ,= 0 then
begin cur tok after token; back input ; after token 0;
end
This code is used in section 1211.
1270. Here is a procedure that might be called Get the next non-blank non-relax non-call non-assignment
token.
Declare action procedures for use by main control 1043 +
procedure do assignments ;
label exit ;
begin loop
begin Get the next non-blank non-relax non-call token 404 ;
if cur cmd max non prexed command then return;
set box allowed false; prexed command ; set box allowed true;
end;
exit : end;
450 PART 49: MODE-INDEPENDENT PROCESSING T
E
X82 1271
1271. Cases of main control that dont depend on mode 1210 +
any mode(after group): begin get token; save for after (cur tok );
end;
1272. Files for \read are opened and closed by the in stream command.
Put each of T
E
Xs primitives into the hash table 226 +
primitive("openin", in stream, 1); primitive("closein", in stream, 0);
1273. Cases of print cmd chr for symbolic printing of primitives 227 +
in stream: if chr code = 0 then print esc("closein")
else print esc("openin");
1274. Cases of main control that dont depend on mode 1210 +
any mode(in stream): open or close in;
1275. Declare action procedures for use by main control 1043 +
procedure open or close in;
var c: 0 . . 1; 1 for \openin, 0 for \closein
n: 0 . . 15; stream number
begin c cur chr ; scan four bit int ; n cur val ;
if read open[n] ,= closed then
begin a close(read le[n]); read open[n] closed ;
end;
if c ,= 0 then
begin scan optional equals ; scan le name;
if cur ext = "" then cur ext ".tex";
pack cur name;
if a open in(read le[n]) then read open[n] just open;
end;
end;
1276. The user can issue messages to the terminal, regardless of the current mode.
Cases of main control that dont depend on mode 1210 +
any mode(message): issue message;
1277. Put each of T
E
Xs primitives into the hash table 226 +
primitive("message", message, 0); primitive("errmessage", message, 1);
1278. Cases of print cmd chr for symbolic printing of primitives 227 +
message: if chr code = 0 then print esc("message")
else print esc("errmessage");
1279 T
E
X82 PART 49: MODE-INDEPENDENT PROCESSING 451
1279. Declare action procedures for use by main control 1043 +
procedure issue message;
var old setting : 0 . . max selector ; holds selector setting
c: 0 . . 1; identies \message and \errmessage
s: str number ; the message
begin c cur chr ; link (garbage) scan toks (false, true); old setting selector ;
selector new string ; token show(def ref ); selector old setting ; ush list (def ref ); str room(1);
s make string ;
if c = 0 then Print string s on the terminal 1280
else Print string s as an error message 1283 ;
ush string ;
end;
1280. Print string s on the terminal 1280
begin if term oset + length(s) > max print line 2 then print ln
else if (term oset > 0) (le oset > 0) then print char ("");
slow print (s); update terminal ;
end
This code is used in section 1279.
1281. If \errmessage occurs often in scroll mode, without user-dened \errhelp, we dont want to give
a long help message each time. So we give a verbose explanation only once.
Global variables 13 +
long help seen: boolean; has the long \errmessage help been used?
1282. Set initial values of key variables 21 +
long help seen false;
1283. Print string s as an error message 1283
begin print err (""); slow print (s);
if err help ,= null then use err help true
else if long help seen then help1 ("(Thatwasanother\errmessage.)")
else begin if interaction < error stop mode then long help seen true;
help4 ("Thiserrormessagewasgeneratedbyan\errmessage")
("command,soIcantgiveanyexplicithelp.")
("PretendthatyoureHerculePoirot:Examineallclues,")
("anddeducethetruthbyorderandmethod.");
end;
error ; use err help false;
end
This code is used in section 1279.
1284. The error routine calls on give err help if help is requested from the err help parameter.
procedure give err help;
begin token show(err help);
end;
1285. The \uppercase and \lowercase commands are implemented by building a token list and then
changing the cases of the letters in it.
Cases of main control that dont depend on mode 1210 +
any mode(case shift ): shift case;
452 PART 49: MODE-INDEPENDENT PROCESSING T
E
X82 1286
1286. Put each of T
E
Xs primitives into the hash table 226 +
primitive("lowercase", case shift , lc code base); primitive("uppercase", case shift , uc code base);
1287. Cases of print cmd chr for symbolic printing of primitives 227 +
case shift : if chr code = lc code base then print esc("lowercase")
else print esc("uppercase");
1288. Declare action procedures for use by main control 1043 +
procedure shift case;
var b: pointer ; lc code base or uc code base
p: pointer ; runs through the token list
t: halfword ; token
c: eight bits ; character code
begin b cur chr ; p scan toks (false, false); p link (def ref );
while p ,= null do
begin Change the case of the token in p, if a change is appropriate 1289 ;
p link (p);
end;
back list (link (def ref )); free avail (def ref ); omit reference count
end;
1289. When the case of a chr code changes, we dont change the cmd . We also change active characters,
using the fact that cs token ag + active base is a multiple of 256.
Change the case of the token in p, if a change is appropriate 1289
t info(p);
if t < cs token ag + single base then
begin c t mod 256;
if equiv (b + c) ,= 0 then info(p) t c + equiv (b + c);
end
This code is used in section 1288.
1290. We come nally to the last pieces missing from main control , namely the \show commands that
are useful when debugging.
Cases of main control that dont depend on mode 1210 +
any mode(xray): show whatever ;
1291. dene show code = 0 \show
dene show box code = 1 \showbox
dene show the code = 2 \showthe
dene show lists = 3 \showlists
Put each of T
E
Xs primitives into the hash table 226 +
primitive("show", xray, show code); primitive("showbox", xray, show box code);
primitive("showthe", xray, show the code); primitive("showlists", xray, show lists );
1292. Cases of print cmd chr for symbolic printing of primitives 227 +
xray: case chr code of
show box code: print esc("showbox");
show the code: print esc("showthe");
show lists : print esc("showlists");
othercases print esc("show")
endcases;
1293 T
E
X82 PART 49: MODE-INDEPENDENT PROCESSING 453
1293. Declare action procedures for use by main control 1043 +
procedure show whatever ;
label common ending ;
var p: pointer ; tail of a token list to show
begin case cur chr of
show lists : begin begin diagnostic; show activities ;
end;
show box code: Show the current contents of a box 1296 ;
show code: Show the current meaning of a token, then goto common ending 1294 ;
othercases Show the current value of some parameter or register, then goto common ending 1297
endcases;
Complete a potentially long \show command 1298 ;
common ending : if interaction < error stop mode then
begin help0 ; decr (error count );
end
else if tracing online > 0 then
begin
help3 ("Thisisntanerrormessage;Imjust\showingsomething.")
("Type`I\show...toshowmore(e.g.,\show\cs,")
("\showthe\count10,\showbox255,\showlists).");
end
else begin
help5 ("Thisisntanerrormessage;Imjust\showingsomething.")
("Type`I\show...toshowmore(e.g.,\show\cs,")
("\showthe\count10,\showbox255,\showlists).")
("Andtype`I\tracingonline=1\show...toshowboxesand")
("listsonyourterminalaswellasinthetranscriptfile.");
end;
error ;
end;
1294. Show the current meaning of a token, then goto common ending 1294
begin get token;
if interaction = error stop mode then wake up terminal ;
print nl (">");
if cur cs ,= 0 then
begin sprint cs (cur cs ); print char ("=");
end;
print meaning ; goto common ending ;
end
This code is used in section 1293.
1295. Cases of print cmd chr for symbolic printing of primitives 227 +
undened cs : print ("undefined");
call : print ("macro");
long call : print esc("longmacro");
outer call : print esc("outermacro");
long outer call : begin print esc("long"); print esc("outermacro");
end;
end template: print esc("outerendtemplate");
454 PART 49: MODE-INDEPENDENT PROCESSING T
E
X82 1296
1296. Show the current contents of a box 1296
begin scan eight bit int ; begin diagnostic; print nl (">\box"); print int (cur val ); print char ("=");
if box (cur val ) = null then print ("void")
else show box (box (cur val ));
end
This code is used in section 1293.
1297. Show the current value of some parameter or register, then goto common ending 1297
begin p the toks ;
if interaction = error stop mode then wake up terminal ;
print nl (">"); token show(temp head ); ush list (link (temp head )); goto common ending ;
end
This code is used in section 1293.
1298. Complete a potentially long \show command 1298
end diagnostic(true); print err ("OK");
if selector = term and log then
if tracing online 0 then
begin selector term only; print ("(seethetranscriptfile)"); selector term and log ;
end
This code is used in section 1293.
1299 T
E
X82 PART 50: DUMPING AND UNDUMPING THE TABLES 455
1299. Dumping and undumping the tables. After INITEX has seen a collection of fonts and macros,
it can write all the necessary information on an auxiliary le so that production versions of T
E
X are able
to initialize their memory at high speed. The present section of the program takes care of such output and
input. We shall consider simultaneously the processes of storing and restoring, so that the inverse relation
between them is clear.
The global variable format ident is a string that is printed right after the banner line when T
E
X is ready
to start. For INITEX this string says simply (INITEX); for other versions of T
E
X it says, for example,
(preloaded format=plain 1982.11.19), showing the year, month, and day that the format le was
created. We have format ident = 0 before T
E
Xs tables are loaded.
Global variables 13 +
format ident : str number ;
1300. Set initial values of key variables 21 +
format ident 0;
1301. Initialize table entries (done by INITEX only) 164 +
format ident "(INITEX)";
1302. Declare action procedures for use by main control 1043 +
init procedure store fmt le;
label found1 , found2 , done1 , done2 ;
var j, k, l: integer ; all-purpose indices
p, q: pointer ; all-purpose pointers
x: integer ; something to dump
w: four quarters ; four ASCII codes
begin If dumping is not allowed, abort 1304 ;
Create the format ident , open the format le, and inform the user that dumping has begun 1328 ;
Dump constants for consistency check 1307 ;
Dump the string pool 1309 ;
Dump the dynamic memory 1311 ;
Dump the table of equivalents 1313 ;
Dump the font information 1320 ;
Dump the hyphenation tables 1324 ;
Dump a couple more things and the closing check word 1326 ;
Close the format le 1329 ;
end;
tini
456 PART 50: DUMPING AND UNDUMPING THE TABLES T
E
X82 1303
1303. Corresponding to the procedure that dumps a format le, we have a function that reads one in.
The function returns false if the dumped format is incompatible with the present T
E
X table sizes, etc.
dene bad fmt = 6666 go here if the format le is unacceptable
dene too small (#)
begin wake up terminal ; wterm ln(!Mustincreasethe, #); goto bad fmt ;
end
Declare the function called open fmt le 524
function load fmt le: boolean;
label bad fmt , exit ;
var j, k: integer ; all-purpose indices
p, q: pointer ; all-purpose pointers
x: integer ; something undumped
w: four quarters ; four ASCII codes
begin Undump constants for consistency check 1308 ;
Undump the string pool 1310 ;
Undump the dynamic memory 1312 ;
Undump the table of equivalents 1314 ;
Undump the font information 1321 ;
Undump the hyphenation tables 1325 ;
Undump a couple more things and the closing check word 1327 ;
load fmt le true; return; it worked!
bad fmt : wake up terminal ; wterm ln((Fatalformatfileerror;Imstymied));
load fmt le false;
exit : end;
1304. The user is not allowed to dump a format le unless save ptr = 0. This condition implies that
cur level = level one, hence the xeq level array is constant and it need not be dumped.
If dumping is not allowed, abort 1304
if save ptr ,= 0 then
begin print err ("Youcantdumpinsideagroup"); help1 ("`{...\dump}isanono.");
succumb;
end
This code is used in section 1302.
1305. Format les consist of memory word items, and we use the following macros to dump words of
dierent types:
dene dump wd (#)
begin fmt le #; put (fmt le); end
dene dump int (#)
begin fmt le.int #; put (fmt le); end
dene dump hh(#)
begin fmt le.hh #; put (fmt le); end
dene dump qqqq (#)
begin fmt le.qqqq #; put (fmt le); end
Global variables 13 +
fmt le: word le; for input or output of format information
1306 T
E
X82 PART 50: DUMPING AND UNDUMPING THE TABLES 457
1306. The inverse macros are slightly more complicated, since we need to check the range of the values
we are reading in. We say undump(a)(b)(x) to read an integer value x that is supposed to be in the range
a x b.
dene undump wd (#)
begin get (fmt le); # fmt le; end
dene undump int (#)
begin get (fmt le); # fmt le.int ; end
dene undump hh(#)
begin get (fmt le); # fmt le.hh; end
dene undump qqqq (#)
begin get (fmt le); # fmt le.qqqq ; end
dene undump end end (#) # x; end
dene undump end (#) (x > #) then goto bad fmt else undump end end
dene undump(#)
begin undump int (x);
if (x < #) undump end
dene undump size end end (#) too small (#) else undump end end
dene undump size end (#)
if x > # then undump size end end
dene undump size(#)
begin undump int (x);
if x < # then goto bad fmt ;
undump size end
1307. The next few sections of the program should make it clear how we use the dump/undump macros.
Dump constants for consistency check 1307
dump int (@$);
dump int (mem bot );
dump int (mem top);
dump int (eqtb size);
dump int (hash prime);
dump int (hyph size)
This code is used in section 1302.
1308. Sections of a WEB program that are commented out still contribute strings to the string pool;
therefore INITEX and T
E
X will have the same strings. (And it is, of course, a good thing that they do.)
Undump constants for consistency check 1308
x fmt le.int ;
if x ,= @$ then goto bad fmt ; check that strings are the same
undump int (x);
if x ,= mem bot then goto bad fmt ;
undump int (x);
if x ,= mem top then goto bad fmt ;
undump int (x);
if x ,= eqtb size then goto bad fmt ;
undump int (x);
if x ,= hash prime then goto bad fmt ;
undump int (x);
if x ,= hyph size then goto bad fmt
This code is used in section 1303.
458 PART 50: DUMPING AND UNDUMPING THE TABLES T
E
X82 1309
1309. dene dump four ASCII w.b0 qi (so(str pool [k])); w.b1 qi (so(str pool [k + 1]));
w.b2 qi (so(str pool [k + 2])); w.b3 qi (so(str pool [k + 3])); dump qqqq (w)
Dump the string pool 1309
dump int (pool ptr ); dump int (str ptr );
for k 0 to str ptr do dump int (str start [k]);
k 0;
while k + 4 < pool ptr do
begin dump four ASCII ; k k + 4;
end;
k pool ptr 4; dump four ASCII ; print ln; print int (str ptr );
print ("stringsoftotallength"); print int (pool ptr )
This code is used in section 1302.
1310. dene undump four ASCII undump qqqq (w); str pool [k] si (qo(w.b0 ));
str pool [k + 1] si (qo(w.b1 )); str pool [k + 2] si (qo(w.b2 )); str pool [k + 3] si (qo(w.b3 ))
Undump the string pool 1310
undump size(0)(pool size)(stringpoolsize)(pool ptr );
undump size(0)(max strings )(maxstrings)(str ptr );
for k 0 to str ptr do undump(0)(pool ptr )(str start [k]);
k 0;
while k + 4 < pool ptr do
begin undump four ASCII ; k k + 4;
end;
k pool ptr 4; undump four ASCII ; init str ptr str ptr ; init pool ptr pool ptr
This code is used in section 1303.
1311. By sorting the list of available spaces in the variable-size portion of mem, we are usually able to get
by without having to dump very much of the dynamic memory.
We recompute var used and dyn used , so that INITEX dumps valid information even when it has not been
gathering statistics.
Dump the dynamic memory 1311
sort avail ; var used 0; dump int (lo mem max ); dump int (rover ); p mem bot ; q rover ; x 0;
repeat for k p to q + 1 do dump wd (mem[k]);
x x + q + 2 p; var used var used + q p; p q + node size(q); q rlink (q);
until q = rover ;
var used var used + lo mem max p; dyn used mem end + 1 hi mem min;
for k p to lo mem max do dump wd (mem[k]);
x x + lo mem max + 1 p; dump int (hi mem min); dump int (avail );
for k hi mem min to mem end do dump wd (mem[k]);
x x + mem end + 1 hi mem min; p avail ;
while p ,= null do
begin decr (dyn used ); p link (p);
end;
dump int (var used ); dump int (dyn used ); print ln; print int (x);
print ("memorylocationsdumped;currentusageis"); print int (var used ); print char ("&");
print int (dyn used )
This code is used in section 1302.
1312 T
E
X82 PART 50: DUMPING AND UNDUMPING THE TABLES 459
1312. Undump the dynamic memory 1312
undump(lo mem stat max + 1000)(hi mem stat min 1)(lo mem max );
undump(lo mem stat max + 1)(lo mem max )(rover ); p mem bot ; q rover ;
repeat for k p to q + 1 do undump wd (mem[k]);
p q + node size(q);
if (p > lo mem max ) ((q rlink (q)) (rlink (q) ,= rover )) then goto bad fmt ;
q rlink (q);
until q = rover ;
for k p to lo mem max do undump wd (mem[k]);
if mem min < mem bot 2 then make more low memory available
begin p llink (rover ); q mem min + 1; link (mem min) null ; info(mem min) null ;
we dont use the bottom word
rlink (p) q; llink (rover ) q;
rlink (q) rover ; llink (q) p; link (q) empty ag ; node size(q) mem bot q;
end;
undump(lo mem max + 1)(hi mem stat min)(hi mem min); undump(null )(mem top)(avail );
mem end mem top;
for k hi mem min to mem end do undump wd (mem[k]);
undump int (var used ); undump int (dyn used )
This code is used in section 1303.
1313. Dump the table of equivalents 1313
Dump regions 1 to 4 of eqtb 1315 ;
Dump regions 5 and 6 of eqtb 1316 ;
dump int (par loc); dump int (write loc);
Dump the hash table 1318
This code is used in section 1302.
1314. Undump the table of equivalents 1314
Undump regions 1 to 6 of eqtb 1317 ;
undump(hash base)(frozen control sequence)(par loc); par token cs token ag + par loc;
undump(hash base)(frozen control sequence)(write loc);
Undump the hash table 1319
This code is used in section 1303.
460 PART 50: DUMPING AND UNDUMPING THE TABLES T
E
X82 1315
1315. The table of equivalents usually contains repeated information, so we dump it in compressed form:
The sequence of n+2 values (n, x
1
, . . . , x
n
, m) in the format le represents n+m consecutive entries of eqtb,
with m extra copies of x
n
, namely (x
1
, . . . , x
n
, x
n
, . . . , x
n
).
Dump regions 1 to 4 of eqtb 1315
k active base;
repeat j k;
while j < int base 1 do
begin if (equiv (j) = equiv (j + 1)) (eq type(j) = eq type(j + 1)) (eq level (j) = eq level (j + 1))
then goto found1 ;
incr (j);
end;
l int base; goto done1 ; j = int base 1
found1 : incr (j); l j;
while j < int base 1 do
begin if (equiv (j) ,= equiv (j + 1)) (eq type(j) ,= eq type(j + 1)) (eq level (j) ,= eq level (j + 1))
then goto done1 ;
incr (j);
end;
done1 : dump int (l k);
while k < l do
begin dump wd (eqtb[k]); incr (k);
end;
k j + 1; dump int (k l);
until k = int base
This code is used in section 1313.
1316. Dump regions 5 and 6 of eqtb 1316
repeat j k;
while j < eqtb size do
begin if eqtb[j].int = eqtb[j + 1].int then goto found2 ;
incr (j);
end;
l eqtb size + 1; goto done2 ; j = eqtb size
found2 : incr (j); l j;
while j < eqtb size do
begin if eqtb[j].int ,= eqtb[j + 1].int then goto done2 ;
incr (j);
end;
done2 : dump int (l k);
while k < l do
begin dump wd (eqtb[k]); incr (k);
end;
k j + 1; dump int (k l);
until k > eqtb size
This code is used in section 1313.
1317 T
E
X82 PART 50: DUMPING AND UNDUMPING THE TABLES 461
1317. Undump regions 1 to 6 of eqtb 1317
k active base;
repeat undump int (x);
if (x < 1) (k + x > eqtb size + 1) then goto bad fmt ;
for j k to k + x 1 do undump wd (eqtb[j]);
k k + x; undump int (x);
if (x < 0) (k + x > eqtb size + 1) then goto bad fmt ;
for j k to k + x 1 do eqtb[j] eqtb[k 1];
k k + x;
until k > eqtb size
This code is used in section 1314.
1318. A dierent scheme is used to compress the hash table, since its lower region is usually sparse. When
text (p) ,= 0 for p hash used , we output two words, p and hash[p]. The hash table is, of course, densely
packed for p hash used , so the remaining entries are output in a block.
Dump the hash table 1318
dump int (hash used ); cs count frozen control sequence 1 hash used ;
for p hash base to hash used do
if text (p) ,= 0 then
begin dump int (p); dump hh(hash[p]); incr (cs count );
end;
for p hash used + 1 to undened control sequence 1 do dump hh(hash[p]);
dump int (cs count );
print ln; print int (cs count ); print ("multilettercontrolsequences")
This code is used in section 1313.
1319. Undump the hash table 1319
undump(hash base)(frozen control sequence)(hash used ); p hash base 1;
repeat undump(p + 1)(hash used )(p); undump hh(hash[p]);
until p = hash used ;
for p hash used + 1 to undened control sequence 1 do undump hh(hash[p]);
undump int (cs count )
This code is used in section 1314.
1320. Dump the font information 1320
dump int (fmem ptr );
for k 0 to fmem ptr 1 do dump wd (font info[k]);
dump int (font ptr );
for k null font to font ptr do Dump the array info for internal font number k 1322 ;
print ln; print int (fmem ptr 7); print ("wordsoffontinfofor");
print int (font ptr font base); print ("preloadedfont");
if font ptr ,= font base + 1 then print char ("s")
This code is used in section 1302.
1321. Undump the font information 1321
undump size(7)(font mem size)(fontmemsize)(fmem ptr );
for k 0 to fmem ptr 1 do undump wd (font info[k]);
undump size(font base)(font max )(fontmax)(font ptr );
for k null font to font ptr do Undump the array info for internal font number k 1323
This code is used in section 1303.
462 PART 50: DUMPING AND UNDUMPING THE TABLES T
E
X82 1322
1322. Dump the array info for internal font number k 1322
begin dump qqqq (font check [k]); dump int (font size[k]); dump int (font dsize[k]);
dump int (font params [k]);
dump int (hyphen char [k]); dump int (skew char [k]);
dump int (font name[k]); dump int (font area[k]);
dump int (font bc[k]); dump int (font ec[k]);
dump int (char base[k]); dump int (width base[k]); dump int (height base[k]);
dump int (depth base[k]); dump int (italic base[k]); dump int (lig kern base[k]);
dump int (kern base[k]); dump int (exten base[k]); dump int (param base[k]);
dump int (font glue[k]);
dump int (bchar label [k]); dump int (font bchar [k]); dump int (font false bchar [k]);
print nl ("\font"); print esc(font id text (k)); print char ("=");
print le name(font name[k], font area[k], "");
if font size[k] ,= font dsize[k] then
begin print ("at"); print scaled (font size[k]); print ("pt");
end;
end
This code is used in section 1320.
1323. Undump the array info for internal font number k 1323
begin undump qqqq (font check [k]);
undump int (font size[k]); undump int (font dsize[k]);
undump(min halfword )(max halfword )(font params [k]);
undump int (hyphen char [k]); undump int (skew char [k]);
undump(0)(str ptr )(font name[k]); undump(0)(str ptr )(font area[k]);
undump(0)(255)(font bc[k]); undump(0)(255)(font ec[k]);
undump int (char base[k]); undump int (width base[k]); undump int (height base[k]);
undump int (depth base[k]); undump int (italic base[k]); undump int (lig kern base[k]);
undump int (kern base[k]); undump int (exten base[k]); undump int (param base[k]);
undump(min halfword )(lo mem max )(font glue[k]);
undump(0)(fmem ptr 1)(bchar label [k]); undump(min quarterword )(non char )(font bchar [k]);
undump(min quarterword )(non char )(font false bchar [k]);
end
This code is used in section 1321.
1324 T
E
X82 PART 50: DUMPING AND UNDUMPING THE TABLES 463
1324. Dump the hyphenation tables 1324
dump int (hyph count );
for k 0 to hyph size do
if hyph word [k] ,= 0 then
begin dump int (k); dump int (hyph word [k]); dump int (hyph list [k]);
end;
print ln; print int (hyph count ); print ("hyphenationexception");
if hyph count ,= 1 then print char ("s");
if trie not ready then init trie;
dump int (trie max );
for k 0 to trie max do dump hh(trie[k]);
dump int (trie op ptr );
for k 1 to trie op ptr do
begin dump int (hyf distance[k]); dump int (hyf num[k]); dump int (hyf next [k]);
end;
print nl ("Hyphenationtrieoflength"); print int (trie max ); print ("has");
print int (trie op ptr ); print ("op");
if trie op ptr ,= 1 then print char ("s");
print ("outof"); print int (trie op size);
for k 255 downto 0 do
if trie used [k] > min quarterword then
begin print nl (""); print int (qo(trie used [k])); print ("forlanguage"); print int (k);
dump int (k); dump int (qo(trie used [k]));
end
This code is used in section 1302.
1325. Only nonempty parts of op start need to be restored.
Undump the hyphenation tables 1325
undump(0)(hyph size)(hyph count );
for k 1 to hyph count do
begin undump(0)(hyph size)(j); undump(0)(str ptr )(hyph word [j]);
undump(min halfword )(max halfword )(hyph list [j]);
end;
undump size(0)(trie size)(triesize)(j); init trie max j; tini
for k 0 to j do undump hh(trie[k]);
undump size(0)(trie op size)(trieopsize)(j); init trie op ptr j; tini
for k 1 to j do
begin undump(0)(63)(hyf distance[k]); a small number
undump(0)(63)(hyf num[k]); undump(min quarterword )(max quarterword )(hyf next [k]);
end;
init for k 0 to 255 do trie used [k] min quarterword ;
tini
k 256;
while j > 0 do
begin undump(0)(k 1)(k); undump(1)(j)(x); init trie used [k] qi (x); tini
j j x; op start [k] qo(j);
end;
init trie not ready false tini
This code is used in section 1303.
464 PART 50: DUMPING AND UNDUMPING THE TABLES T
E
X82 1326
1326. We have already printed a lot of statistics, so we set tracing stats 0 to prevent them from
appearing again.
Dump a couple more things and the closing check word 1326
dump int (interaction); dump int (format ident ); dump int (69069); tracing stats 0
This code is used in section 1302.
1327. Undump a couple more things and the closing check word 1327
undump(batch mode)(error stop mode)(interaction); undump(0)(str ptr )(format ident ); undump int (x);
if (x ,= 69069) eof (fmt le) then goto bad fmt
This code is used in section 1303.
1328. Create the format ident , open the format le, and inform the user that dumping has
begun 1328
selector new string ; print ("(preloadedformat="); print (job name); print char ("");
print int (year ); print char ("."); print int (month); print char ("."); print int (day); print char (")");
if interaction = batch mode then selector log only
else selector term and log ;
str room(1); format ident make string ; pack job name(format extension);
while w open out (fmt le) do prompt le name("formatfilename", format extension);
print nl ("Beginningtodumponfile"); slow print (w make name string (fmt le)); ush string ;
print nl (""); slow print (format ident )
This code is used in section 1302.
1329. Close the format le 1329
w close(fmt le)
This code is used in section 1302.
1330 T
E
X82 PART 51: THE MAIN PROGRAM 465
1330. The main program. This is it: the part of T
E
X that executes all those procedures we have
written.
Wellalmost. Lets leave space for a few more routines that we may have forgotten.
Last-minute procedures 1333
1331. We have noted that there are two versions of T
E
X82. One, called INITEX, has to be run rst; it
initializes everything from scratch, without reading a format le, and it has the capability of dumping a
format le. The other one is called VIRTEX; it is a virgin program that needs to input a format le in
order to get started. VIRTEX typically has more memory capacity than INITEX, because it does not need the
space consumed by the auxiliary hyphenation tables and the numerous calls on primitive, etc.
The VIRTEX program cannot read a format le instantaneously, of course; the best implementations
therefore allow for production versions of T
E
X that not only avoid the loading routine for Pascal object
code, they also have a format le pre-loaded. This is impossible to do if we stick to standard Pascal; but
there is a simple way to fool many systems into avoiding the initialization, as follows: (1) We declare a global
integer variable called ready already. The probability is negligible that this variable holds any particular
value like 314159 when VIRTEX is rst loaded. (2) After we have read in a format le and initialized
everything, we set ready already 314159. (3) Soon VIRTEX will print *, waiting for more input; and at
this point we interrupt the program and save its core image in some form that the operating system can
reload speedily. (4) When that core image is activated, the program starts again at the beginning; but now
ready already = 314159 and all the other global variables have their initial values too. The former chastity
has vanished!
In other words, if we allow ourselves to test the condition ready already = 314159, before ready already
has been assigned a value, we can avoid the lengthy initialization. Dirty tricks rarely pay o so handsomely.
On systems that allow such preloading, the standard program called TeX should be the one that has plain
format preloaded, since that agrees with The T
E
Xbook. Other versions, e.g., AmSTeX, should also be provided
for commonly used formats.
Global variables 13 +
ready already: integer ; a sacrice of purity for economy
466 PART 51: THE MAIN PROGRAM T
E
X82 1332
1332. Now this is really it: T
E
X starts and ends here.
The initial test involving ready already should be deleted if the Pascal runtime system is smart enough to
detect such a mistake.
begin start here
history fatal error stop; in case we quit during initialization
t open out ; open the terminal for output
if ready already = 314159 then goto start of TEX;
Check the constant values for consistency 14
if bad > 0 then
begin wterm ln(Ouchmyinternalconstantshavebeenclobbered!, case, bad : 1);
goto nal end ;
end;
initialize; set global variables to their starting values
init if get strings started then goto nal end ;
init prim; call primitive for each primitive
init str ptr str ptr ; init pool ptr pool ptr ; x date and time;
tini
ready already 314159;
start of TEX: Initialize the output routines 55 ;
Get the rst line of input and prepare to start 1337 ;
history spotless ; ready to go!
main control ; come to life
nal cleanup; prepare for death
end of TEX: close les and terminate;
nal end : ready already 0;
end.
1333. Here we do whatever is needed to complete T
E
Xs job gracefully on the local operating system. The
code here might come into play after a fatal error; it must therefore consist entirely of safe operations that
cannot produce error messages. For example, it would be a mistake to call str room or make string at this
time, because a call on overow might lead to an innite loop.
Actually theres one way to get error messages, via prepare mag ; but that cant cause innite recursion.
This program doesnt bother to close the input les that may still be open.
Last-minute procedures 1333
procedure close les and terminate;
var k: integer ; all-purpose index
begin Finish the extensions 1378 ;
stat if tracing stats > 0 then Output statistics about this job 1334 ; tats
wake up terminal ; Finish the DVI le 642 ;
if log opened then
begin wlog cr ; a close(log le); selector selector 2;
if selector = term only then
begin print nl ("Transcriptwrittenon"); slow print (log name); print char (".");
end;
end;
end;
See also sections 1335, 1336, and 1338.
This code is used in section 1330.
1334 T
E
X82 PART 51: THE MAIN PROGRAM 467
1334. The present section goes directly to the log le instead of using print commands, because theres
no need for these strings to take up str pool memory when a non-stat version of T
E
X is being used.
Output statistics about this job 1334
if log opened then
begin wlog ln(); wlog ln(HereishowmuchofTeXsmemory, youused:);
wlog (, str ptr init str ptr : 1, string);
if str ptr ,= init str ptr + 1 then wlog (s);
wlog ln(outof, max strings init str ptr : 1);
wlog ln(, pool ptr init pool ptr : 1, stringcharactersoutof, pool size init pool ptr : 1);
wlog ln(, lo mem max mem min + mem end hi mem min + 2 : 1,
wordsofmemoryoutof, mem end + 1 mem min : 1);
wlog ln(, cs count : 1, multilettercontrolsequencesoutof, hash size : 1);
wlog (, fmem ptr : 1, wordsoffontinfofor, font ptr font base : 1, font);
if font ptr ,= font base + 1 then wlog (s);
wlog ln(,outof, font mem size : 1, for, font max font base : 1);
wlog (, hyph count : 1, hyphenationexception);
if hyph count ,= 1 then wlog (s);
wlog ln(outof, hyph size : 1);
wlog ln(, max in stack : 1, i,, max nest stack : 1, n,, max param stack : 1, p,,
max buf stack + 1 : 1, b,, max save stack + 6 : 1, sstackpositionsoutof,
stack size : 1, i,, nest size : 1, n,, param size : 1, p,, buf size : 1, b,, save size : 1, s);
end
This code is used in section 1333.
468 PART 51: THE MAIN PROGRAM T
E
X82 1335
1335. We get to the nal cleanup routine when \end or \dump has been scanned and its all over.
Last-minute procedures 1333 +
procedure nal cleanup;
label exit ;
var c: small number ; 0 for \end, 1 for \dump
begin c cur chr ;
if job name = 0 then open log le;
while input ptr > 0 do
if state = token list then end token list else end le reading ;
while open parens > 0 do
begin print (")"); decr (open parens );
end;
if cur level > level one then
begin print nl ("("); print esc("endoccurred"); print ("insideagroupatlevel");
print int (cur level level one); print char (")");
end;
while cond ptr ,= null do
begin print nl ("("); print esc("endoccurred"); print ("when"); print cmd chr (if test , cur if );
if if line ,= 0 then
begin print ("online"); print int (if line);
end;
print ("wasincomplete)"); if line if line eld (cond ptr ); cur if subtype(cond ptr );
temp ptr cond ptr ; cond ptr link (cond ptr ); free node(temp ptr , if node size);
end;
if history ,= spotless then
if ((history = warning issued ) (interaction < error stop mode)) then
if selector = term and log then
begin selector term only;
print nl ("(seethetranscriptfileforadditionalinformation)");
selector term and log ;
end;
if c = 1 then
begin init for c top mark code to split bot mark code do
if cur mark [c] ,= null then delete token ref (cur mark [c]);
if last glue ,= max halfword then delete glue ref (last glue);
store fmt le; return; tini
print nl ("(\dumpisperformedonlybyINITEX)"); return;
end;
exit : end;
1336. Last-minute procedures 1333 +
init procedure init prim; initialize all the primitives
begin no new control sequence false; Put each of T
E
Xs primitives into the hash table 226 ;
no new control sequence true;
end;
tini
1337 T
E
X82 PART 51: THE MAIN PROGRAM 469
1337. When we begin the following code, T
E
Xs tables may still contain garbage; the strings might not
even be present. Thus we must proceed cautiously to get bootstrapped in.
But when we nish this part of the program, T
E
X is ready to call on the main control routine to do its
work.
Get the rst line of input and prepare to start 1337
begin Initialize the input routines 331 ;
if (format ident = 0) (buer [loc] = "&") then
begin if format ident ,= 0 then initialize; erase preloaded format
if open fmt le then goto nal end ;
if load fmt le then
begin w close(fmt le); goto nal end ;
end;
w close(fmt le);
while (loc < limit ) (buer [loc] = "") do incr (loc);
end;
if end line char inactive then decr (limit )
else buer [limit ] end line char ;
x date and time;
Compute the magic oset 765 ;
Initialize the print selector based on interaction 75 ;
if (loc < limit ) (cat code(buer [loc]) ,= escape) then start input ; \input assumed
end
This code is used in section 1332.
470 PART 52: DEBUGGING T
E
X82 1338
1338. Debugging. Once T
E
X is working, you should be able to diagnose most errors with the \show
commands and other diagnostic features. But for the initial stages of debugging, and for the revelation of
really deep mysteries, you can compile T
E
X with a few more aids, including the Pascal runtime checks and
its debugger. An additional routine called debug help will also come into play when you type D after an
error message; debug help also occurs just before a fatal error causes T
E
X to succumb.
The interface to debug help is primitive, but it is good enough when used with a Pascal debugger that
allows you to set breakpoints and to read variables and change their values. After getting the prompt
debug #, you type either a negative number (this exits debug help), or zero (this goes to a location where
you can set a breakpoint, thereby entering into dialog with the Pascal debugger), or a positive number m
followed by an argument n. The meaning of m and n will be clear from the program below. (If m = 13,
there is an additional argument, l.)
dene breakpoint = 888 place where a breakpoint is desirable
Last-minute procedures 1333 +
debug procedure debug help; routine to display various things
label breakpoint , exit ;
var k, l, m, n: integer ;
begin loop
begin wake up terminal ; print nl ("debug#(1toexit):"); update terminal ; read (term in, m);
if m < 0 then return
else if m = 0 then
begin goto breakpoint ; @\ go to every label at least once
breakpoint : m 0; @{BREAKPOINT@}@\
end
else begin read (term in, n);
case m of
Numbered cases for debug help 1339
othercases print ("?")
endcases;
end;
end;
exit : end;
gubed
1339 T
E
X82 PART 52: DEBUGGING 471
1339. Numbered cases for debug help 1339
1: print word (mem[n]); display mem[n] in all forms
2: print int (info(n));
3: print int (link (n));
4: print word (eqtb[n]);
5: print word (font info[n]);
6: print word (save stack [n]);
7: show box (n); show a box, abbreviated by show box depth and show box breadth
8: begin breadth max 10000; depth threshold pool size pool ptr 10; show node list (n);
show a box in its entirety
end;
9: show token list (n, null , 1000);
10: slow print (n);
11: check mem(n > 0); check wellformedness; print new busy locations if n > 0
12: search mem(n); look for pointers to n
13: begin read (term in, l); print cmd chr (n, l);
end;
14: for k 0 to n do print (buer [k]);
15: begin font in short display null font ; short display(n);
end;
16: panicking panicking ;
This code is used in section 1338.
472 PART 53: EXTENSIONS T
E
X82 1340
1340. Extensions. The program above includes a bunch of hooks that allow further capabilities to
be added without upsetting T
E
Xs basic structure. Most of these hooks are concerned with whatsit nodes,
which are intended to be used for special purposes; whenever a new extension to T
E
X involves a new kind
of whatsit node, a corresponding change needs to be made to the routines below that deal with such nodes,
but it will usually be unnecessary to make many changes to the other parts of this program.
In order to demonstrate how extensions can be made, we shall treat \write, \openout, \closeout,
\immediate, \special, and \setlanguage as if they were extensions. These commands are actually
primitives of T
E
X, and they should appear in all implementations of the system; but lets try to imagine
that they arent. Then the program below illustrates how a person could add them.
Sometimes, of course, an extension will require changes to T
E
X itself; no system of hooks could be complete
enough for all conceivable extensions. The features associated with \write are almost all conned to the
following paragraphs, but there are small parts of the print ln and print char procedures that were introduced
specically to \write characters. Furthermore one of the token lists recognized by the scanner is a write text ;
and there are a few other miscellaneous places where we have already provided for some aspect of \write.
The goal of a T
E
X extender should be to minimize alterations to the standard parts of the program, and to
avoid them completely if possible. He or she should also be quite sure that theres no easy way to accomplish
the desired goals with the standard features that T
E
X already has. Think thrice before extending, because
that may save a lot of work, and it will also keep incompatible extensions of T
E
X from proliferating.
1341. First lets consider the format of whatsit nodes that are used to represent the data associated with
\write and its relatives. Recall that a whatsit has type = whatsit node, and the subtype is supposed
to distinguish dierent kinds of whatsits. Each node occupies two or more words; the exact number is
immaterial, as long as it is readily determined from the subtype or other data.
We shall introduce ve subtype values here, corresponding to the control sequences \openout, \write,
\closeout, \special, and \setlanguage. The second word of I/O whatsits has a write stream eld that
identies the write-stream number (0 to 15, or 16 for out-of-range and positive, or 17 for out-of-range and
negative). In the case of \write and \special, there is also a eld that points to the reference count of a
token list that should be sent. In the case of \openout, we need three words and three auxiliary subelds to
hold the string numbers for name, area, and extension.
dene write node size = 2 number of words in a write/whatsit node
dene open node size = 3 number of words in an open/whatsit node
dene open node = 0 subtype in whatsits that represent les to \openout
dene write node = 1 subtype in whatsits that represent things to \write
dene close node = 2 subtype in whatsits that represent streams to \closeout
dene special node = 3 subtype in whatsits that represent \special things
dene language node = 4 subtype in whatsits that change the current language
dene what lang (#) link (# + 1) language number, in the range 0 . . 255
dene what lhm(#) type(# + 1) minimum left fragment, in the range 1 . . 63
dene what rhm(#) subtype(# + 1) minimum right fragment, in the range 1 . . 63
dene write tokens (#) link (# + 1) reference count of token list to write
dene write stream(#) info(# + 1) stream number (0 to 17)
dene open name(#) link (# + 1) string number of le name to open
dene open area(#) info(# + 2) string number of le area for open name
dene open ext (#) link (# + 2) string number of le extension for open name
1342 T
E
X82 PART 53: EXTENSIONS 473
1342. The sixteen possible \write streams are represented by the write le array. The jth le is open if
and only if write open[j] = true. The last two streams are special; write open[16] represents a stream number
greater than 15, while write open[17] represents a negative stream number, and both of these variables are
always false.
Global variables 13 +
write le: array [0 . . 15] of alpha le;
write open: array [0 . . 17] of boolean;
1343. Set initial values of key variables 21 +
for k 0 to 17 do write open[k] false;
1344. Extensions might introduce new command codes; but its best to use extension with a modier,
whenever possible, so that main control stays the same.
dene immediate code = 4 command modier for \immediate
dene set language code = 5 command modier for \setlanguage
Put each of T
E
Xs primitives into the hash table 226 +
primitive("openout", extension, open node);
primitive("write", extension, write node); write loc cur val ;
primitive("closeout", extension, close node);
primitive("special", extension, special node);
primitive("immediate", extension, immediate code);
primitive("setlanguage", extension, set language code);
1345. The variable write loc just introduced is used to provide an appropriate error message in case of
runaway write texts.
Global variables 13 +
write loc: pointer ; eqtb address of \write
1346. Cases of print cmd chr for symbolic printing of primitives 227 +
extension: case chr code of
open node: print esc("openout");
write node: print esc("write");
close node: print esc("closeout");
special node: print esc("special");
immediate code: print esc("immediate");
set language code: print esc("setlanguage");
othercases print ("[unknownextension!]")
endcases;
1347. When an extension command occurs in main control , in any mode, the do extension routine is
called.
Cases of main control that are for extensions to T
E
X 1347
any mode(extension): do extension;
This code is used in section 1045.
474 PART 53: EXTENSIONS T
E
X82 1348
1348. Declare action procedures for use by main control 1043 +
Declare procedures needed in do extension 1349
procedure do extension;
var i, j, k: integer ; all-purpose integers
p, q, r: pointer ; all-purpose pointers
begin case cur chr of
open node: Implement \openout 1351 ;
write node: Implement \write 1352 ;
close node: Implement \closeout 1353 ;
special node: Implement \special 1354 ;
immediate code: Implement \immediate 1375 ;
set language code: Implement \setlanguage 1377 ;
othercases confusion("ext1")
endcases;
end;
1349. Here is a subroutine that creates a whatsit node having a given subtype and a given number of
words. It initializes only the rst word of the whatsit, and appends it to the current list.
Declare procedures needed in do extension 1349
procedure new whatsit (s : small number ; w : small number );
var p: pointer ; the new node
begin p get node(w); type(p) whatsit node; subtype(p) s; link (tail ) p; tail p;
end;
See also section 1350.
This code is used in section 1348.
1350. The next subroutine uses cur chr to decide what sort of whatsit is involved, and also inserts a
write stream number.
Declare procedures needed in do extension 1349 +
procedure new write whatsit (w : small number );
begin new whatsit (cur chr , w);
if w ,= write node size then scan four bit int
else begin scan int ;
if cur val < 0 then cur val 17
else if cur val > 15 then cur val 16;
end;
write stream(tail ) cur val ;
end;
1351. Implement \openout 1351
begin new write whatsit (open node size); scan optional equals ; scan le name;
open name(tail ) cur name; open area(tail ) cur area; open ext (tail ) cur ext ;
end
This code is used in section 1348.
1352 T
E
X82 PART 53: EXTENSIONS 475
1352. When \write 12{...} appears, we scan the token list {...} without expanding its macros; the
macros will be expanded later when this token list is rescanned.
Implement \write 1352
begin k cur cs ; new write whatsit (write node size);
cur cs k; p scan toks (false, false); write tokens (tail ) def ref ;
end
This code is used in section 1348.
1353. Implement \closeout 1353
begin new write whatsit (write node size); write tokens (tail ) null ;
end
This code is used in section 1348.
1354. When \special{...} appears, we expand the macros in the token list as in \xdef and \mark.
Implement \special 1354
begin new whatsit (special node, write node size); write stream(tail ) null ; p scan toks (false, true);
write tokens (tail ) def ref ;
end
This code is used in section 1348.
1355. Each new type of node that appears in our data structure must be capable of being displayed,
copied, destroyed, and so on. The routines that we need for write-oriented whatsits are somewhat like those
for mark nodes; other extensions might, of course, involve more subtlety here.
Basic printing procedures 57 +
procedure print write whatsit (s : str number ; p : pointer );
begin print esc(s);
if write stream(p) < 16 then print int (write stream(p))
else if write stream(p) = 16 then print char ("*")
else print char ("");
end;
1356. Display the whatsit node p 1356
case subtype(p) of
open node: begin print write whatsit ("openout", p); print char ("=");
print le name(open name(p), open area(p), open ext (p));
end;
write node: begin print write whatsit ("write", p); print mark (write tokens (p));
end;
close node: print write whatsit ("closeout", p);
special node: begin print esc("special"); print mark (write tokens (p));
end;
language node: begin print esc("setlanguage"); print int (what lang (p)); print ("(hyphenmin");
print int (what lhm(p)); print char (","); print int (what rhm(p)); print char (")");
end;
othercases print ("whatsit?")
endcases
This code is used in section 183.
476 PART 53: EXTENSIONS T
E
X82 1357
1357. Make a partial copy of the whatsit node p and make r point to it; set words to the number of
initial words not yet copied 1357
case subtype(p) of
open node: begin r get node(open node size); words open node size;
end;
write node, special node: begin r get node(write node size); add token ref (write tokens (p));
words write node size;
end;
close node, language node: begin r get node(small node size); words small node size;
end;
othercases confusion("ext2")
endcases
This code is used in section 206.
1358. Wipe out the whatsit node p and goto done 1358
begin case subtype(p) of
open node: free node(p, open node size);
write node, special node: begin delete token ref (write tokens (p)); free node(p, write node size);
goto done;
end;
close node, language node: free node(p, small node size);
othercases confusion("ext3")
endcases;
goto done;
end
This code is used in section 202.
1359. Incorporate a whatsit node into a vbox 1359
do nothing
This code is used in section 669.
1360. Incorporate a whatsit node into an hbox 1360
do nothing
This code is used in section 651.
1361. Let d be the width of the whatsit p 1361
d 0
This code is used in section 1147.
1362. dene adv past (#) if subtype(#) = language node then
begin cur lang what lang (#); l hyf what lhm(#); r hyf what rhm(#); end
Advance past a whatsit node in the line break loop 1362 adv past (cur p)
This code is used in section 866.
1363. Advance past a whatsit node in the pre-hyphenation loop 1363 adv past (s)
This code is used in section 896.
1364. Prepare to move whatsit p to the current page, then goto contribute 1364
goto contribute
This code is used in section 1000.
1365 T
E
X82 PART 53: EXTENSIONS 477
1365. Process whatsit p in vert break loop, goto not found 1365
goto not found
This code is used in section 973.
1366. Output the whatsit node p in a vlist 1366
out what (p)
This code is used in section 631.
1367. Output the whatsit node p in an hlist 1367
out what (p)
This code is used in section 622.
1368. After all this preliminary shuing, we come nally to the routines that actually send out the
requested data. Lets do \special rst (its easier).
Declare procedures needed in hlist out , vlist out 1368
procedure special out (p : pointer );
var old setting : 0 . . max selector ; holds print selector
k: pool pointer ; index into str pool
begin synch h; synch v ;
old setting selector ; selector new string ;
show token list (link (write tokens (p)), null , pool size pool ptr ); selector old setting ; str room(1);
if cur length < 256 then
begin dvi out (xxx1 ); dvi out (cur length);
end
else begin dvi out (xxx4 ); dvi four (cur length);
end;
for k str start [str ptr ] to pool ptr 1 do dvi out (so(str pool [k]));
pool ptr str start [str ptr ]; erase the string
end;
See also sections 1370 and 1373.
This code is used in section 619.
1369. To write a token list, we must run it through T
E
Xs scanner, expanding macros and \the and
\number, etc. This might cause runaways, if a delimited macro parameter isnt matched, and runaways
would be extremely confusing since we are calling on T
E
Xs scanner in the middle of a \shipout command.
Therefore we will put a dummy control sequence as a stopper, right after the token list. This control
sequence is articially dened to be \outer.
Initialize table entries (done by INITEX only) 164 +
text (end write) "endwrite"; eq level (end write) level one; eq type(end write) outer call ;
equiv (end write) null ;
478 PART 53: EXTENSIONS T
E
X82 1370
1370. Declare procedures needed in hlist out , vlist out 1368 +
procedure write out (p : pointer );
var old setting : 0 . . max selector ; holds print selector
old mode: integer ; saved mode
j: small number ; write stream number
q, r: pointer ; temporary variables for list manipulation
begin Expand macros in the token list and make link (def ref ) point to the result 1371 ;
old setting selector ; j write stream(p);
if write open[j] then selector j
else begin write to the terminal if le isnt open
if (j = 17) (selector = term and log ) then selector log only;
print nl ("");
end;
token show(def ref ); print ln; ush list (def ref ); selector old setting ;
end;
1371. The nal line of this routine is slightly subtle; at least, the author didnt think about it until getting
burnt! There is a used-up token list on the stack, namely the one that contained end write token. (We insert
this articial \endwrite to prevent runaways, as explained above.) If it were not removed, and if there
were numerous writes on a single page, the stack would overow.
dene end write token cs token ag + end write
Expand macros in the token list and make link (def ref ) point to the result 1371
q get avail ; info(q) right brace token + "}";
r get avail ; link (q) r; info(r) end write token; ins list (q);
begin token list (write tokens (p), write text );
q get avail ; info(q) left brace token + "{"; ins list (q);
now were ready to scan { token list } \endwrite
old mode mode; mode 0; disable \prevdepth, \spacefactor, \lastskip, \prevgraf
cur cs write loc; q scan toks (false, true); expand macros, etc.
get token; if cur tok ,= end write token then Recover from an unbalanced write command 1372 ;
mode old mode; end token list conserve stack space
This code is used in section 1370.
1372. Recover from an unbalanced write command 1372
begin print err ("Unbalancedwritecommand");
help2 ("Onthispagetheresa\writewithfewerreal{sthan}s.")
("Icanthandlethatverywell;goodluck."); error ;
repeat get token;
until cur tok = end write token;
end
This code is used in section 1371.
1373 T
E
X82 PART 53: EXTENSIONS 479
1373. The out what procedure takes care of outputting whatsit nodes for vlist out and hlist out .
Declare procedures needed in hlist out , vlist out 1368 +
procedure out what (p : pointer );
var j: small number ; write stream number
begin case subtype(p) of
open node, write node, close node: Do some work that has been queued up for \write 1374 ;
special node: special out (p);
language node: do nothing ;
othercases confusion("ext4")
endcases;
end;
1374. We dont implement \write inside of leaders. (The reason is that the number of times a leader
box appears might be dierent in dierent implementations, due to machine-dependent rounding in the glue
calculations.)
Do some work that has been queued up for \write 1374
if doing leaders then
begin j write stream(p);
if subtype(p) = write node then write out (p)
else begin if write open[j] then a close(write le[j]);
if subtype(p) = close node then write open[j] false
else if j < 16 then
begin cur name open name(p); cur area open area(p); cur ext open ext (p);
if cur ext = "" then cur ext ".tex";
pack cur name;
while a open out (write le[j]) do prompt le name("outputfilename", ".tex");
write open[j] true;
end;
end;
end
This code is used in section 1373.
1375. The presence of \immediate causes the do extension procedure to descend to one level of recursion.
Nothing happens unless \immediate is followed by \openout, \write, or \closeout.
Implement \immediate 1375
begin get x token;
if (cur cmd = extension) (cur chr close node) then
begin p tail ; do extension; append a whatsit node
out what (tail ); do the action immediately
ush node list (tail ); tail p; link (p) null ;
end
else back input ;
end
This code is used in section 1348.
480 PART 53: EXTENSIONS T
E
X82 1376
1376. The \language extension is somewhat dierent. We need a subroutine that comes into play when
a character of a non-clang language is being appended to the current paragraph.
Declare action procedures for use by main control 1043 +
procedure x language;
var l: ASCII code; the new current language
begin if language 0 then l 0
else if language > 255 then l 0
else l language;
if l ,= clang then
begin new whatsit (language node, small node size); what lang (tail ) l; clang l;
what lhm(tail ) norm min(left hyphen min); what rhm(tail ) norm min(right hyphen min);
end;
end;
1377. Implement \setlanguage 1377
if abs (mode) ,= hmode then report illegal case
else begin new whatsit (language node, small node size); scan int ;
if cur val 0 then clang 0
else if cur val > 255 then clang 0
else clang cur val ;
what lang (tail ) clang ; what lhm(tail ) norm min(left hyphen min);
what rhm(tail ) norm min(right hyphen min);
end
This code is used in section 1348.
1378. Finish the extensions 1378
for k 0 to 15 do
if write open[k] then a close(write le[k])
This code is used in section 1333.
1379 T
E
X82 PART 54: SYSTEM-DEPENDENT CHANGES 481
1379. System-dependent changes. This section should be replaced, if necessary, by any special
modications of the program that are necessary to make T
E
X work at a particular installation. It is usually
best to design your change le so that all changes to previous sections preserve the section numbering; then
everybodys version will be consistent with the published program. More extensive changes, which introduce
new sections, can be inserted here; then only the index itself will get a new section number.
482 PART 55: INDEX T
E
X82 1380
1380. Index. Here is where you can nd all uses of each identier in the program, with underlined
entries pointing to where the identier was dened. If the identier is only one letter long, however, you get
to see only the underlined entries. All references are to section numbers instead of page numbers.
This index also lists error messages and other aspects of the program that you might want to look up
some day. For example, the entry for system dependencies lists all sections that should receive special
attention from people who are installing T
E
X in a new operating environment. A list of various things that
cant happen appears under this cant happen. Approximately 40 sections are listed under inner loop;
these account for about 60% of T
E
Xs running time, exclusive of input and output.
** : 37, 534.
* : 174, 176, 178, 313, 360, 856, 1006, 1355.
> : 294.
=> : 363.
??? : 59.
? : 83.
@ : 856.
@@ : 846.
a: 47, 102, 218, 518, 519, 523, 560, 597, 691, 722,
738, 752, 1123, 1194, 1211, 1236, 1257.
A <box> was supposed to... : 1084.
a close: 28, 51, 329, 485, 486, 1275, 1333,
1374, 1378.
a leaders : 149, 189, 625, 627, 634, 636, 656, 671,
1071, 1072, 1073, 1078, 1148.
a make name string : 525, 534, 537.
a open in: 27, 51, 537, 1275.
a open out : 27, 534, 1374.
A token: 445.
abort : 560, 563, 564, 565, 568, 569, 570, 571,
573, 575.
above: 208, 1046, 1178, 1179, 1180.
\above primitive: 1178.
above code: 1178, 1179, 1182, 1183.
above display short skip: 224, 814.
\abovedisplayshortskip primitive: 226.
above display short skip code: 224, 225, 226, 1203.
above display skip: 224, 814.
\abovedisplayskip primitive: 226.
above display skip code: 224, 225, 226, 1203, 1206.
\abovewithdelims primitive: 1178.
abs : 66, 186, 211, 218, 219, 418, 422, 448, 501,
610, 663, 675, 718, 737, 757, 758, 759, 831,
836, 849, 859, 944, 948, 1029, 1030, 1056,
1076, 1078, 1080, 1083, 1093, 1110, 1120, 1127,
1149, 1243, 1244, 1377.
absorbing : 305, 306, 339, 473.
acc kern: 155, 191, 1125.
accent : 208, 265, 266, 1090, 1122, 1164, 1165.
\accent primitive: 265.
accent chr : 687, 696, 738, 1165.
accent noad : 687, 690, 696, 698, 733, 761,
1165, 1186.
accent noad size: 687, 698, 761, 1165.
act width: 866, 867, 868, 869, 871.
action procedure: 1029.
active: 162, 819, 829, 843, 854, 860, 861, 863,
864, 865, 873, 874, 875.
active base: 220, 222, 252, 253, 255, 262, 263, 353,
442, 506, 1152, 1257, 1289, 1315, 1317.
active char : 207, 344, 506.
active height : 970, 975, 976.
active node size: 819, 845, 860, 864, 865.
active width: 823, 824, 829, 843, 861, 864,
866, 868, 970.
actual looseness : 872, 873, 875.
add delims to: 347.
add glue ref : 203, 206, 430, 802, 881, 996,
1100, 1229.
add token ref : 203, 206, 323, 979, 1012, 1016,
1221, 1227, 1357.
additional : 644, 645, 657, 672.
adj demerits : 236, 836, 859.
\adjdemerits primitive: 238.
adj demerits code: 236, 237, 238.
adjust : 576.
adjust head : 162, 888, 889, 1076, 1085, 1199, 1205.
adjust node: 142, 148, 175, 183, 202, 206, 647,
651, 655, 730, 761, 866, 899, 1100.
adjust ptr : 142, 197, 202, 206, 655, 1100.
adjust space factor : 1034, 1038.
adjust tail : 647, 648, 649, 651, 655, 796, 888,
889, 1076, 1085, 1199.
adjusted hbox group: 269, 1062, 1083, 1085.
adv past : 1362, 1363.
advance: 209, 265, 266, 1210, 1235, 1236, 1238.
\advance primitive: 265.
advance major tail : 914, 917.
after : 147, 866, 1196.
after assignment : 208, 265, 266, 1268.
\afterassignment primitive: 265.
after group: 208, 265, 266, 1271.
\aftergroup primitive: 265.
after math: 1193, 1194.
after token: 1266, 1267, 1268, 1269.
aire: 560, 561, 563, 576.
align error : 1126, 1127.
align group: 269, 768, 774, 791, 800, 1131, 1132.
1380 T
E
X82 PART 55: INDEX 483
align head : 162, 770, 777.
align peek : 773, 774, 785, 799, 1048, 1133.
align ptr : 770, 771, 772.
align stack node size: 770, 772.
align state: 88, 309, 324, 325, 331, 339, 342, 347,
357, 394, 395, 396, 403, 442, 475, 482, 483,
486, 770, 771, 772, 774, 777, 783, 784, 785,
788, 789, 791, 1069, 1094, 1126, 1127.
aligning : 305, 306, 339, 777, 789.
alignment of rules with characters: 589.
alpha: 560, 571, 572.
alpha le: 25, 27, 28, 31, 32, 50, 54, 304, 480,
525, 1342.
alpha token: 438, 440.
alter aux : 1242, 1243.
alter box dimen: 1242, 1247.
alter integer : 1242, 1246.
alter page so far : 1242, 1245.
alter prev graf : 1242, 1244.
Ambiguous... : 1183.
Amble, Ole: 925.
AmSTeX : 1331.
any mode: 1045, 1048, 1057, 1063, 1067, 1073,
1097, 1102, 1104, 1126, 1134, 1210, 1268, 1271,
1274, 1276, 1285, 1290, 1347.
any state plus : 344, 345, 347.
app lc hex : 48.
app space: 1030, 1043.
append char : 42, 48, 52, 58, 180, 195, 260, 516,
525, 692, 695, 939.
append charnode to t : 908, 911.
append choices : 1171, 1172.
append discretionary: 1116, 1117.
append glue: 1057, 1060, 1078.
append italic correction: 1112, 1113.
append kern: 1057, 1061.
append normal space: 1030.
append penalty: 1102, 1103.
append to name: 519, 523.
append to vlist : 679, 799, 888, 1076, 1203, 1204,
1205.
area delimiter : 513, 515, 516, 517.
Argument of \x has... : 395.
arith error : 104, 105, 106, 107, 448, 453, 460,
1236.
Arithmetic overflow : 1236.
articial demerits : 830, 851, 854, 855, 856.
ASCII code: 17, 503.
ASCII code: 18, 19, 20, 29, 30, 31, 38, 42, 54, 58,
60, 82, 292, 341, 389, 516, 519, 523, 692, 892,
912, 921, 943, 950, 953, 959, 960, 1376.
assign dimen: 209, 248, 249, 413, 1210, 1224,
1228.
assign font dimen: 209, 265, 266, 413, 1210, 1253.
assign font int : 209, 413, 1210, 1253, 1254, 1255.
assign glue: 209, 226, 227, 413, 782, 1210,
1224, 1228.
assign int : 209, 238, 239, 413, 1210, 1222, 1224,
1228, 1237.
assign mu glue: 209, 226, 227, 413, 1210, 1222,
1224, 1228, 1237.
assign toks : 209, 230, 231, 233, 323, 413, 415,
1210, 1224, 1226, 1227.
at : 1258.
\atop primitive: 1178.
atop code: 1178, 1179, 1182.
\atopwithdelims primitive: 1178.
attach fraction: 448, 453, 454, 456.
attach sign: 448, 449, 455.
auto breaking : 862, 863, 866, 868.
aux : 212, 213, 216, 800, 812.
aux eld : 212, 213, 218, 775.
aux save: 800, 812, 1206.
avail : 118, 120, 121, 122, 123, 164, 168, 1311, 1312.
AVAIL list clobbered... : 168.
awful bad : 833, 834, 835, 836, 854, 874, 970, 974,
975, 987, 1005, 1006, 1007.
axis height : 700, 706, 736, 746, 747, 749, 762.
b: 464, 465, 470, 498, 523, 560, 597, 679, 705, 706,
709, 711, 715, 830, 970, 994, 1198, 1247, 1288.
b close: 28, 560, 642.
b make name string : 525, 532.
b open in: 27, 563.
b open out : 27, 532.
back error : 327, 373, 396, 403, 415, 442, 446,
476, 479, 503, 577, 783, 1078, 1084, 1161,
1197, 1207, 1212.
back input : 281, 325, 326, 327, 368, 369, 372, 375,
379, 395, 405, 407, 415, 443, 444, 448, 452, 455,
461, 526, 788, 1031, 1047, 1054, 1064, 1090,
1095, 1124, 1127, 1132, 1138, 1150, 1152, 1153,
1215, 1221, 1226, 1269, 1375.
back list : 323, 325, 337, 407, 1288.
backed up: 307, 311, 312, 314, 323, 324, 325, 1026.
background : 823, 824, 827, 837, 863, 864.
backup backup: 366.
backup head : 162, 366, 407.
BAD : 293, 294.
bad : 13, 14, 111, 290, 522, 1249, 1332.
Bad \patterns : 961.
Bad \prevgraf : 1244.
Bad character code : 434.
Bad delimiter code : 437.
484 PART 55: INDEX T
E
X82 1380
Bad flag... : 170.
Bad link... : 182.
Bad mathchar : 436.
Bad number : 435.
Bad register code : 433.
Bad space factor : 1243.
bad fmt : 1303, 1306, 1308, 1312, 1317, 1327.
bad pool : 51, 52, 53.
bad tfm: 560.
badness : 108, 660, 667, 674, 678, 828, 852, 853,
975, 1007.
\badness primitive: 416.
badness code: 416, 424.
banner : 2, 61, 536, 1299.
base line: 619, 623, 624, 628.
base ptr : 84, 85, 310, 311, 312, 313, 1131.
baseline skip: 224, 247, 679.
\baselineskip primitive: 226.
baseline skip code: 149, 224, 225, 226, 679.
batch mode: 73, 75, 86, 90, 92, 93, 535, 1262,
1263, 1327, 1328.
\batchmode primitive: 1262.
bc: 540, 541, 543, 545, 560, 565, 566, 570, 576.
bch label : 560, 573, 576.
bchar : 560, 573, 576, 901, 903, 905, 906, 908, 911,
913, 916, 917, 1032, 1034, 1037, 1038, 1040.
bchar label : 549, 552, 576, 909, 916, 1034, 1040,
1322, 1323.
before: 147, 192, 1196.
begin: 7, 8.
begin box : 1073, 1079, 1084.
begin diagnostic: 76, 245, 284, 299, 323, 400, 401,
502, 509, 581, 638, 641, 663, 675, 863, 987,
992, 1006, 1011, 1121, 1293, 1296.
begin le reading : 78, 87, 328, 483, 537.
begin group: 208, 265, 266, 1063.
\begingroup primitive: 265.
begin insert or adjust : 1097, 1099.
begin name: 512, 515, 526, 527, 531.
begin pseudoprint : 316, 318, 319.
begin token list : 323, 359, 386, 390, 774, 788,
789, 799, 1025, 1030, 1083, 1091, 1139, 1145,
1167, 1371.
Beginning to dump... : 1328.
below display short skip: 224.
\belowdisplayshortskip primitive: 226.
below display short skip code: 224, 225, 226, 1203.
below display skip: 224.
\belowdisplayskip primitive: 226.
below display skip code: 224, 225, 226, 1203, 1206.
best bet : 872, 874, 875, 877, 878.
best height plus depth: 971, 974, 1010, 1011.
best ins ptr : 981, 1005, 1009, 1018, 1020, 1021.
best line: 872, 874, 875, 877, 890.
best page break : 980, 1005, 1013, 1014.
best pl line: 833, 845, 855.
best place: 833, 845, 855, 970, 974, 980.
best size: 980, 1005, 1017.
beta: 560, 571, 572.
big op spacing1 : 701, 751.
big op spacing2 : 701, 751.
big op spacing3 : 701, 751.
big op spacing4 : 701, 751.
big op spacing5 : 701, 751.
big switch: 209, 236, 994, 1029, 1030, 1031,
1036, 1041.
BigEndian order: 540.
billion: 625.
bin noad : 682, 690, 696, 698, 728, 729, 761,
1156, 1157.
bin op penalty: 236, 761.
\binoppenalty primitive: 238.
bin op penalty code: 236, 237, 238.
blank line: 245.
boolean: 27, 31, 37, 45, 46, 47, 76, 79, 96, 104,
106, 107, 165, 167, 245, 256, 311, 361, 407, 413,
440, 448, 461, 473, 498, 516, 524, 527, 549,
560, 578, 592, 619, 629, 645, 706, 719, 726,
791, 825, 828, 829, 830, 862, 877, 900, 907,
950, 960, 989, 1012, 1032, 1051, 1054, 1091,
1160, 1194, 1211, 1281, 1303, 1342.
bop: 583, 585, 586, 588, 590, 592, 638, 640.
Bosshard, Hans Rudolf: 458.
bot : 546.
bot mark : 382, 383, 1012, 1016.
\botmark primitive: 384.
bot mark code: 382, 384, 385.
bottom level : 269, 272, 281, 1064, 1068.
bottom line: 311.
bowels: 592.
box : 230, 232, 420, 505, 977, 992, 993, 1009,
1015, 1017, 1018, 1021, 1023, 1028, 1079,
1110, 1247, 1296.
\box primitive: 1071.
box base: 230, 232, 233, 255, 1077.
box code: 1071, 1072, 1079, 1107, 1110.
box context : 1075, 1076, 1077, 1078, 1079, 1083,
1084.
box end : 1075, 1079, 1084, 1086.
box error : 992, 993, 1015, 1028.
box ag : 1071, 1075, 1077, 1083, 1241.
box max depth: 247, 1086.
\boxmaxdepth primitive: 248.
box max depth code: 247, 248.
1380 T
E
X82 PART 55: INDEX 485
box node size: 135, 136, 202, 206, 649, 668, 715,
727, 751, 756, 977, 1021, 1100, 1110, 1201.
box ref : 210, 232, 275, 1077.
box there: 980, 987, 1000, 1001.
\box255 is not void : 1015.
bp : 458.
brain: 1029.
breadth max : 181, 182, 198, 233, 236, 1339.
break : 34.
break in: 34.
break node: 819, 845, 855, 856, 864, 877, 878.
break penalty: 208, 265, 266, 1102.
break type: 829, 837, 845, 846, 859.
break width: 823, 824, 837, 838, 840, 841, 842,
843, 844, 879.
breakpoint : 1338.
broken ins : 981, 986, 1010, 1021.
broken penalty: 236, 890.
\brokenpenalty primitive: 238.
broken penalty code: 236, 237, 238.
broken ptr : 981, 1010, 1021.
buf size: 11, 30, 31, 35, 71, 111, 315, 328, 331,
341, 363, 366, 374, 524, 530, 534, 1334.
buer : 30, 31, 36, 37, 45, 71, 83, 87, 88, 259, 260,
261, 264, 302, 303, 315, 318, 331, 341, 343, 352,
354, 355, 356, 360, 362, 363, 366, 374, 483, 484,
523, 524, 530, 531, 534, 538, 1337, 1339.
Buffer size exceeded : 35.
build choices : 1173, 1174.
build discretionary: 1118, 1119.
build page: 800, 812, 988, 994, 1026, 1054, 1060,
1076, 1091, 1094, 1100, 1103, 1145, 1200.
by : 1236.
bypass eoln: 31.
byte le: 25, 27, 28, 525, 532, 539.
b0 : 110, 113, 114, 133, 221, 268, 545, 546, 550, 554,
556, 564, 602, 683, 685, 921, 958, 1309, 1310.
b1 : 110, 113, 114, 133, 221, 268, 545, 546, 554,
556, 564, 602, 683, 685, 921, 958, 1309, 1310.
b2 : 110, 113, 114, 545, 546, 554, 556, 564, 602,
683, 685, 1309, 1310.
b3 : 110, 113, 114, 545, 546, 556, 564, 602, 683,
685, 1309, 1310.
c: 47, 63, 82, 144, 264, 274, 292, 341, 470, 516, 519,
523, 560, 581, 582, 592, 645, 692, 694, 706, 709,
711, 712, 738, 749, 893, 912, 953, 959, 960, 994,
1012, 1086, 1110, 1117, 1136, 1151, 1155, 1181,
1243, 1245, 1246, 1247, 1275, 1279, 1288, 1335.
c leaders : 149, 190, 627, 636, 1071, 1072.
\cleaders primitive: 1071.
c loc: 912, 916.
call : 210, 223, 275, 296, 366, 380, 387, 395, 396,
507, 1218, 1221, 1225, 1226, 1227, 1295.
cancel boundary: 1030, 1032, 1033, 1034.
cannot \read : 484.
car ret : 207, 232, 342, 347, 777, 780, 781, 783,
784, 785, 788, 1126.
carriage return: 22, 49, 207, 232, 240, 363.
case shift : 208, 1285, 1286, 1287.
cat : 341, 354, 355, 356.
cat code: 230, 232, 236, 262, 341, 343, 354,
355, 356, 1337.
\catcode primitive: 1230.
cat code base: 230, 232, 233, 235, 1230, 1231, 1233.
cc: 341, 352, 355.
cc : 458.
change if limit : 497, 498, 509.
char : 19, 26, 520, 534.
\char primitive: 265.
char base: 550, 552, 554, 566, 570, 576, 1322, 1323.
char box : 709, 710, 711, 738.
\chardef primitive: 1222.
char def code: 1222, 1223, 1224.
char depth: 554, 654, 708, 709, 712.
char depth end : 554.
char exists : 554, 573, 576, 582, 708, 722, 738,
740, 749, 755, 1036.
char given: 208, 413, 935, 1030, 1038, 1090, 1124,
1151, 1154, 1222, 1223, 1224.
char height : 554, 654, 708, 709, 712, 1125.
char height end : 554.
char info: 543, 550, 554, 555, 557, 570, 573, 576,
582, 620, 654, 708, 709, 712, 714, 715, 722, 724,
738, 740, 749, 841, 842, 866, 867, 870, 871, 909,
1036, 1037, 1039, 1040, 1113, 1123, 1125, 1147.
char info end : 554.
char info word : 541, 543, 544.
char italic: 554, 709, 714, 749, 755, 1113.
char italic end : 554.
char kern: 557, 741, 753, 909, 1040.
char kern end : 557.
char node: 134, 143, 145, 162, 176, 548, 592, 620,
649, 752, 881, 907, 1029, 1113, 1138.
char num: 208, 265, 266, 935, 1030, 1038, 1090,
1124, 1151, 1154.
char tag : 554, 570, 708, 710, 740, 741, 749,
752, 909, 1039.
char warning : 581, 582, 722, 1036.
char width: 554, 620, 654, 709, 714, 715, 740, 841,
842, 866, 867, 870, 871, 1123, 1125, 1147.
char width end : 554.
character : 134, 143, 144, 174, 176, 206, 582, 620,
654, 681, 682, 683, 687, 691, 709, 715, 722, 724,
486 PART 55: INDEX T
E
X82 1380
749, 752, 753, 841, 842, 866, 867, 870, 871,
896, 897, 898, 903, 907, 908, 910, 911, 1032,
1034, 1035, 1036, 1037, 1038, 1040, 1113, 1123,
1125, 1147, 1151, 1155, 1165.
character set dependencies: 23, 49.
check sum: 53, 542, 588.
check byte range: 570, 573.
check dimensions : 726, 727, 733, 754.
check existence: 573, 574.
check full save stack : 273, 274, 276, 280.
check interrupt : 96, 324, 343, 753, 911, 1031, 1040.
check mem: 165, 167, 1031, 1339.
check outer validity: 336, 351, 353, 354, 357,
362, 375.
check shrinkage: 825, 827, 868.
Chinese characters: 134, 585.
choice node: 688, 689, 690, 698, 730.
choose mlist : 731.
chr : 19, 20, 23, 24, 1222.
chr cmd : 298, 781.
chr code: 227, 231, 239, 249, 298, 377, 385, 411,
412, 413, 417, 469, 488, 492, 781, 984, 1053,
1059, 1071, 1072, 1089, 1108, 1115, 1143,
1157, 1170, 1179, 1189, 1209, 1220, 1223,
1231, 1251, 1255, 1261, 1263, 1273, 1278,
1287, 1289, 1292, 1346.
clang : 212, 213, 812, 1034, 1091, 1200, 1376, 1377.
clean box : 720, 734, 735, 737, 738, 742, 744, 749,
750, 757, 758, 759.
clear for error prompt : 78, 83, 330, 346.
clear terminal : 34, 330, 530.
CLOBBERED : 293.
clobbered : 167, 168, 169.
close: 28.
close les and terminate: 78, 81, 1332, 1333.
\closein primitive: 1272.
close noad : 682, 690, 696, 698, 728, 761, 762,
1156, 1157.
close node: 1341, 1344, 1346, 1348, 1356, 1357,
1358, 1373, 1374, 1375.
\closeout primitive: 1344.
closed : 480, 481, 483, 485, 486, 501, 1275.
clr : 737, 743, 745, 746, 756, 757, 758, 759.
club penalty: 236, 890.
\clubpenalty primitive: 238.
club penalty code: 236, 237, 238.
cm : 458.
cmd : 298, 1222, 1289.
co backup: 366.
combine two deltas : 860.
comment : 207, 232, 347.
common ending : 15, 498, 500, 509, 649, 660,
666, 667, 668, 674, 677, 678, 895, 903, 1257,
1260, 1293, 1294, 1297.
Completed box... : 638.
compress trie: 949, 952.
cond math glue: 149, 189, 732, 1171.
cond ptr : 489, 490, 495, 496, 497, 498, 500,
509, 1335.
conditional : 366, 367, 498.
confusion: 95, 202, 206, 281, 497, 630, 669, 728,
736, 754, 761, 766, 791, 798, 800, 841, 842,
866, 870, 871, 877, 968, 973, 1000, 1068, 1185,
1200, 1211, 1348, 1357, 1358, 1373.
continental point token: 438, 448.
continue: 15, 82, 83, 84, 88, 89, 389, 392, 393,
394, 395, 397, 706, 708, 774, 784, 815, 829, 832,
851, 896, 906, 909, 910, 911, 994, 1001.
contrib head : 162, 215, 218, 988, 994, 995, 998,
999, 1001, 1017, 1023, 1026.
contrib tail : 995, 1017, 1023, 1026.
contribute: 994, 997, 1000, 1002, 1008, 1364.
conv toks : 366, 367, 470.
conventions for representing stacks: 300.
convert : 210, 366, 367, 468, 469, 470.
convert to break width: 843.
\copy primitive: 1071.
copy code: 1071, 1072, 1079, 1107, 1108, 1110.
copy node list : 161, 203, 204, 206, 1079, 1110.
copy to cur active: 829, 861.
count : 236, 427, 638, 640, 986, 1008, 1009, 1010.
\count primitive: 411.
count base: 236, 239, 242, 1224, 1237.
\countdef primitive: 1222.
count def code: 1222, 1223, 1224.
\cr primitive: 780.
cr code: 780, 781, 789, 791, 792.
\crcr primitive: 780.
cr cr code: 780, 785, 789.
cramped : 688, 702.
cramped style: 702, 734, 737, 738.
cs count : 256, 258, 260, 1318, 1319, 1334.
cs error : 1134, 1135.
cs name: 210, 265, 266, 366, 367.
\csname primitive: 265.
cs token ag : 289, 290, 293, 334, 336, 337, 339,
357, 358, 365, 369, 372, 375, 379, 380, 381,
442, 466, 506, 780, 1065, 1132, 1215, 1289,
1314, 1371.
cur active width: 823, 824, 829, 832, 837, 843,
844, 851, 852, 853, 860.
cur align: 770, 771, 772, 777, 778, 779, 783, 786,
788, 789, 791, 792, 795, 796, 798.
1380 T
E
X82 PART 55: INDEX 487
cur area: 512, 517, 529, 530, 537, 1257, 1260,
1351, 1374.
cur boundary: 270, 271, 272, 274, 282.
cur box : 1074, 1075, 1076, 1077, 1078, 1079, 1080,
1081, 1082, 1084, 1086, 1087.
cur break : 821, 845, 879, 880, 881.
cur c: 722, 723, 724, 738, 749, 752, 753, 755.
cur chr : 88, 296, 297, 299, 332, 337, 341, 343, 348,
349, 351, 352, 353, 354, 355, 356, 357, 358, 359,
360, 364, 365, 378, 380, 381, 386, 387, 389, 403,
407, 413, 424, 428, 442, 470, 472, 474, 476,
479, 483, 494, 495, 498, 500, 506, 507, 508,
509, 510, 526, 577, 782, 785, 789, 935, 937,
962, 1030, 1034, 1036, 1038, 1049, 1058, 1060,
1061, 1066, 1073, 1079, 1083, 1090, 1093, 1105,
1106, 1110, 1117, 1124, 1128, 1140, 1142, 1151,
1152, 1154, 1155, 1158, 1159, 1160, 1171, 1181,
1191, 1211, 1212, 1213, 1217, 1218, 1221, 1224,
1226, 1227, 1228, 1232, 1233, 1234, 1237, 1243,
1245, 1246, 1247, 1252, 1253, 1265, 1275, 1279,
1288, 1293, 1335, 1348, 1350, 1375.
cur cmd : 88, 211, 296, 297, 299, 332, 337, 341,
342, 343, 344, 348, 349, 351, 353, 354, 357, 358,
360, 364, 365, 366, 367, 368, 372, 380, 381, 386,
387, 403, 404, 406, 407, 413, 415, 428, 440, 442,
443, 444, 448, 452, 455, 461, 463, 474, 476, 477,
478, 479, 483, 494, 506, 507, 526, 577, 777, 782,
783, 784, 785, 788, 789, 935, 961, 1029, 1030,
1038, 1049, 1066, 1078, 1079, 1084, 1095, 1099,
1124, 1128, 1138, 1151, 1152, 1160, 1165, 1176,
1177, 1197, 1206, 1211, 1212, 1213, 1221, 1226,
1227, 1228, 1236, 1237, 1252, 1270, 1375.
cur cs : 297, 332, 333, 336, 337, 338, 341, 351,
353, 354, 356, 357, 358, 365, 372, 374, 379,
380, 381, 389, 391, 407, 472, 473, 507, 774,
1152, 1215, 1218, 1221, 1224, 1225, 1226,
1257, 1294, 1352, 1371.
cur ext : 512, 517, 529, 530, 537, 1275, 1351, 1374.
cur f : 722, 724, 738, 741, 749, 752, 753, 755.
cur fam: 236, 1151, 1155, 1165.
cur fam code: 236, 237, 238, 1139, 1145.
cur le: 304, 329, 362, 537, 538.
cur font : 230, 232, 558, 559, 577, 1032, 1034,
1042, 1044, 1117, 1123, 1124, 1146.
cur font loc: 230, 232, 233, 234, 1217.
cur g : 619, 625, 629, 634.
cur glue: 619, 625, 629, 634.
cur group: 270, 271, 272, 274, 281, 282, 800, 1062,
1063, 1064, 1065, 1067, 1068, 1069, 1130, 1131,
1140, 1142, 1191, 1192, 1193, 1194, 1200.
cur h: 616, 617, 618, 619, 620, 622, 623, 626,
627, 628, 629, 632, 637.
cur head : 770, 771, 772, 786, 799.
cur height : 970, 972, 973, 974, 975, 976.
cur i : 722, 723, 724, 738, 741, 749, 752, 753, 755.
cur if : 336, 489, 490, 495, 496, 1335.
cur indent : 877, 889.
cur input : 35, 36, 87, 301, 302, 311, 321, 322,
534, 1131.
cur l : 907, 908, 909, 910, 911, 1032, 1034, 1035,
1036, 1037, 1039, 1040.
cur lang : 891, 892, 923, 924, 930, 934, 939, 944,
963, 1091, 1200, 1362.
cur length: 41, 180, 182, 260, 516, 525, 617,
692, 1368.
cur level : 270, 271, 272, 274, 277, 278, 280,
281, 1304, 1335.
cur line: 877, 889, 890.
cur list : 213, 216, 217, 218, 422, 1244.
cur loop: 770, 771, 772, 777, 783, 792, 793, 794.
cur mark : 296, 382, 386, 1335.
cur mlist : 719, 720, 726, 754, 1194, 1196, 1199.
cur mu: 703, 719, 730, 732, 766.
cur name: 512, 517, 529, 530, 537, 1257, 1258,
1260, 1351, 1374.
cur order : 366, 439, 447, 448, 454, 462.
cur p: 823, 828, 829, 830, 833, 837, 839, 840, 845,
851, 853, 855, 856, 857, 858, 859, 860, 862,
863, 865, 866, 867, 868, 869, 872, 877, 878,
879, 880, 881, 894, 903, 1362.
cur q : 907, 908, 910, 911, 1034, 1035, 1036,
1037, 1040.
cur r : 907, 908, 909, 910, 911, 1032, 1034, 1037,
1038, 1039, 1040.
cur rh: 906, 908, 909, 910.
cur s : 593, 616, 619, 629, 640, 642.
cur size: 700, 701, 703, 719, 722, 723, 732, 736,
737, 744, 746, 747, 748, 749, 757, 758, 759, 762.
cur span: 770, 771, 772, 787, 796, 798.
cur style: 703, 719, 720, 726, 730, 731, 734,
735, 737, 738, 742, 744, 745, 746, 748, 749,
750, 754, 756, 757, 758, 759, 760, 763, 766,
1194, 1196, 1199.
cur tail : 770, 771, 772, 786, 796, 799.
cur tok : 88, 281, 297, 325, 326, 327, 336, 364,
365, 366, 368, 369, 372, 375, 379, 380, 381,
392, 393, 394, 395, 397, 399, 403, 405, 407,
440, 441, 442, 444, 445, 448, 452, 474, 476,
477, 479, 483, 494, 503, 506, 783, 784, 1038,
1047, 1095, 1127, 1128, 1132, 1215, 1221, 1268,
1269, 1271, 1371, 1372.
cur v : 616, 618, 619, 623, 624, 628, 629, 631, 632,
633, 635, 636, 637, 640.
cur val : 264, 265, 334, 366, 410, 413, 414, 415,
488 PART 55: INDEX T
E
X82 1380
419, 420, 421, 423, 424, 425, 426, 427, 429,
430, 431, 433, 434, 435, 436, 437, 438, 439,
440, 442, 444, 445, 447, 448, 450, 451, 453,
455, 457, 458, 460, 461, 462, 463, 465, 466,
472, 482, 491, 501, 503, 504, 505, 509, 553,
577, 578, 579, 580, 645, 780, 782, 935, 1030,
1038, 1060, 1061, 1073, 1079, 1082, 1099, 1103,
1110, 1123, 1124, 1151, 1154, 1160, 1161, 1165,
1182, 1188, 1224, 1225, 1226, 1227, 1228, 1229,
1232, 1234, 1236, 1237, 1238, 1239, 1240, 1241,
1243, 1244, 1245, 1246, 1247, 1248, 1253, 1258,
1259, 1275, 1296, 1344, 1350, 1377.
cur val level : 366, 410, 413, 419, 420, 421,
423, 424, 427, 429, 430, 439, 449, 451, 455,
461, 465, 466.
cur width: 877, 889.
current page: 980.
current character being worked on: 570.
cv backup: 366.
cvl backup: 366.
d: 107, 176, 177, 259, 341, 440, 560, 649, 668, 679,
706, 830, 944, 970, 1068, 1086, 1138, 1198.
d xed : 608, 609.
danger : 1194, 1195, 1199.
data: 210, 232, 1217, 1232, 1234.
data structure assumptions: 161, 164, 204, 816,
968, 981, 1289.
day: 236, 241, 536, 617, 1328.
\day primitive: 238.
day code: 236, 237, 238.
dd : 458.
deactivate: 829, 851, 854.
dead cycles : 419, 592, 593, 638, 1012, 1024, 1025,
1054, 1242, 1246.
\deadcycles primitive: 416.
debug: 7, 9, 78, 84, 93, 114, 165, 166, 167,
172, 1031, 1338.
debug # : 1338.
debug help: 78, 84, 93, 1338.
debugging: 7, 84, 96, 114, 165, 182, 1031, 1338.
decent t : 817, 834, 852, 853, 864.
decr : 16, 42, 44, 64, 71, 86, 88, 89, 90, 92, 102,
120, 121, 123, 175, 177, 200, 201, 205, 217, 245,
260, 281, 282, 311, 322, 324, 325, 329, 331, 347,
356, 357, 360, 362, 394, 399, 422, 429, 442, 477,
483, 494, 509, 534, 538, 568, 576, 601, 619, 629,
638, 642, 643, 716, 717, 803, 808, 840, 858,
869, 883, 915, 916, 930, 931, 940, 944, 948,
965, 1060, 1100, 1120, 1127, 1131, 1174, 1186,
1194, 1244, 1293, 1311, 1335, 1337.
def : 209, 1208, 1209, 1210, 1213, 1218.
\def primitive: 1208.
def code: 209, 413, 1210, 1230, 1231, 1232.
def family: 209, 413, 577, 1210, 1230, 1231, 1234.
def font : 209, 265, 266, 413, 577, 1210, 1256.
def ref : 305, 306, 473, 482, 960, 1101, 1218, 1226,
1279, 1288, 1352, 1354, 1370.
default code: 683, 697, 743, 1182.
default hyphen char : 236, 576.
\defaulthyphenchar primitive: 238.
default hyphen char code: 236, 237, 238.
default rule: 463.
default rule thickness : 683, 701, 734, 735, 737,
743, 745, 759.
default skew char : 236, 576.
\defaultskewchar primitive: 238.
default skew char code: 236, 237, 238.
defecation: 597.
dene: 1214, 1217, 1218, 1221, 1224, 1225, 1226,
1227, 1228, 1232, 1234, 1236, 1248, 1257.
dening : 305, 306, 339, 473, 482.
del code: 236, 240, 1160.
\delcode primitive: 1230.
del code base: 236, 240, 242, 1230, 1232, 1233.
delete glue ref : 201, 202, 275, 451, 465, 578, 732,
802, 816, 826, 881, 976, 996, 1004, 1017, 1022,
1100, 1229, 1236, 1239, 1335.
delete last : 1104, 1105.
delete q : 726, 760, 763.
delete token ref : 200, 202, 275, 324, 977, 979,
1012, 1016, 1335, 1358.
deletions allowed : 76, 77, 84, 85, 98, 336, 346.
delim num: 207, 265, 266, 1046, 1151, 1154, 1160.
delimited code: 1178, 1179, 1182, 1183.
delimiter : 687, 696, 762, 1191.
\delimiter primitive: 265.
delimiter factor : 236, 762.
\delimiterfactor primitive: 238.
delimiter factor code: 236, 237, 238.
delimiter shortfall : 247, 762.
\delimitershortfall primitive: 248.
delimiter shortfall code: 247, 248.
delim1 : 700, 748.
delim2 : 700, 748.
delta: 103, 726, 728, 733, 735, 736, 737, 738, 742,
743, 745, 746, 747, 748, 749, 750, 754, 755, 756,
759, 762, 994, 1008, 1010, 1123, 1125.
delta node: 822, 830, 832, 843, 844, 860, 861,
865, 874, 875.
delta node size: 822, 843, 844, 860, 861, 865.
delta1 : 743, 746, 762.
delta2 : 743, 746, 762.
den: 585, 587, 590.
denom: 450, 458.
1380 T
E
X82 PART 55: INDEX 489
denom style: 702, 744.
denominator : 683, 690, 697, 698, 744, 1181, 1185.
denom1 : 700, 744.
denom2 : 700, 744.
deplorable: 974, 1005.
depth : 463.
depth: 135, 136, 138, 139, 140, 184, 187, 188, 463,
554, 622, 624, 626, 631, 632, 635, 641, 649, 653,
656, 668, 670, 679, 688, 704, 706, 709, 713, 727,
730, 731, 735, 736, 737, 745, 746, 747, 749, 750,
751, 756, 758, 759, 768, 769, 801, 806, 810, 973,
1002, 1009, 1010, 1021, 1087, 1100.
depth base: 550, 552, 554, 566, 571, 1322, 1323.
depth index : 543, 554.
depth oset : 135, 416, 769, 1247.
depth threshold : 181, 182, 198, 233, 236, 692, 1339.
dig : 54, 64, 65, 67, 102, 452.
digit sensed : 960, 961, 962.
dimen: 247, 427, 1008, 1010.
\dimen primitive: 411.
dimen base: 220, 236, 247, 248, 249, 250, 251,
252, 1070, 1145.
\dimendef primitive: 1222.
dimen def code: 1222, 1223, 1224.
dimen par : 247.
dimen pars : 247.
dimen val : 410, 411, 412, 413, 415, 416, 417,
418, 420, 421, 424, 425, 427, 428, 429, 449,
455, 465, 1237.
Dimension too large : 460.
dirty Pascal: 3, 114, 172, 182, 186, 285, 812, 1331.
disc break : 877, 880, 881, 882, 890.
disc group: 269, 1117, 1118, 1119.
disc node: 145, 148, 175, 183, 202, 206, 730,
761, 817, 819, 829, 856, 858, 866, 881, 914,
1081, 1105.
disc width: 839, 840, 869, 870.
discretionary: 208, 1090, 1114, 1115, 1116.
Discretionary list is too long : 1120.
\discretionary primitive: 1114.
Display math...with $$ : 1197.
display indent : 247, 800, 1138, 1145, 1199.
\displayindent primitive: 248.
display indent code: 247, 248, 1145.
\displaylimits primitive: 1156.
display mlist : 689, 695, 698, 731, 1174.
display style: 688, 694, 731, 1169, 1199.
\displaystyle primitive: 1169.
display widow penalty: 236, 1145.
\displaywidowpenalty primitive: 238.
display widow penalty code: 236, 237, 238.
display width: 247, 1138, 1145, 1199.
\displaywidth primitive: 248.
display width code: 247, 248, 1145.
div: 100, 627, 636.
divide: 209, 265, 266, 1210, 1235, 1236.
\divide primitive: 265.
do all six : 823, 829, 832, 837, 843, 844, 860,
861, 864, 970, 987.
do assignments : 800, 1123, 1206, 1270.
do endv : 1130, 1131.
do extension: 1347, 1348, 1375.
do nothing : 16, 34, 57, 58, 84, 175, 202, 275, 344,
357, 538, 569, 609, 611, 612, 622, 631, 651,
669, 692, 728, 733, 761, 837, 866, 899, 1045,
1236, 1359, 1360, 1373.
do register command : 1235, 1236.
doing leaders : 592, 593, 628, 637, 1374.
done: 15, 47, 53, 202, 281, 282, 311, 380, 389, 397,
440, 445, 448, 453, 458, 473, 474, 476, 482, 483,
494, 526, 530, 531, 537, 560, 567, 576, 615, 638,
640, 641, 698, 726, 738, 740, 760, 761, 774, 777,
815, 829, 837, 863, 873, 877, 881, 895, 906,
909, 911, 931, 960, 961, 970, 974, 977, 979,
994, 997, 998, 1005, 1079, 1081, 1119, 1121,
1138, 1146, 1211, 1227, 1252, 1358.
done with noad : 726, 727, 728, 733, 754.
done with node: 726, 727, 730, 731, 754.
done1 : 15, 167, 168, 389, 399, 448, 452, 473, 474,
738, 741, 774, 783, 815, 829, 852, 877, 879, 894,
896, 899, 960, 965, 994, 997, 1000, 1302, 1315.
done2 : 15, 167, 169, 448, 458, 459, 473, 478, 774,
784, 815, 896, 1302, 1316.
done3 : 15, 815, 897, 898.
done4 : 15, 815, 899.
done5 : 15, 815, 866, 869.
done6 : 15.
dont expand : 210, 258, 357, 369.
Double subscript : 1177.
Double superscript : 1177.
double hyphen demerits : 236, 859.
\doublehyphendemerits primitive: 238.
double hyphen demerits code: 236, 237, 238.
Doubly free location... : 169.
down ptr : 605, 606, 607, 615.
downdate width: 860.
down1 : 585, 586, 607, 609, 610, 613, 614, 616.
down2 : 585, 594, 610.
down3 : 585, 610.
down4 : 585, 610.
\dp primitive: 416.
dry rot: 95.
\dump...only by INITEX : 1335.
\dump primitive: 1052.
490 PART 55: INDEX T
E
X82 1380
dump four ASCII : 1309.
dump hh: 1305, 1318, 1324.
dump int : 1305, 1307, 1309, 1311, 1313, 1315,
1316, 1318, 1320, 1322, 1324, 1326.
dump qqqq : 1305, 1309, 1322.
dump wd : 1305, 1311, 1315, 1316, 1320.
Duplicate pattern : 963.
dvi buf : 594, 595, 597, 598, 607, 613, 614.
dvi buf size: 11, 14, 594, 595, 596, 598, 599,
607, 613, 614, 642.
dvi f : 616, 617, 620, 621.
dvi le: 532, 592, 595, 597, 642.
DVI les: 583.
dvi font def : 602, 621, 643.
dvi four : 600, 602, 610, 617, 624, 633, 640,
642, 1368.
dvi gone: 594, 595, 596, 598, 612.
dvi h: 616, 617, 619, 620, 623, 624, 628, 629,
632, 637.
dvi index : 594, 595, 597.
dvi limit : 594, 595, 596, 598, 599.
dvi oset : 594, 595, 596, 598, 601, 605, 607, 613,
614, 619, 629, 640, 642.
dvi out : 598, 600, 601, 602, 603, 609, 610, 617,
619, 620, 621, 624, 629, 633, 640, 642, 1368.
dvi pop: 601, 619, 629.
dvi ptr : 594, 595, 596, 598, 599, 601, 607, 619,
629, 640, 642.
dvi swap: 598.
dvi v : 616, 617, 619, 623, 628, 629, 632, 637.
dyn used : 117, 120, 121, 122, 123, 164, 639,
1311, 1312.
e: 277, 279, 518, 519, 530, 1198, 1211.
easy line: 819, 835, 847, 848, 850.
ec: 540, 541, 543, 545, 560, 565, 566, 570, 576.
\edef primitive: 1208.
edge: 619, 623, 626, 629, 635.
eight bits : 25, 64, 112, 297, 549, 560, 581, 582,
595, 607, 649, 706, 709, 712, 977, 992, 993,
1079, 1247, 1288.
eject penalty: 157, 829, 831, 851, 859, 873, 970,
972, 974, 1005, 1010, 1011.
else: 10.
\else primitive: 491.
else code: 489, 491, 498.
em : 455.
Emergency stop : 93.
emergency stretch: 247, 828, 863.
\emergencystretch primitive: 248.
emergency stretch code: 247, 248.
empty: 16, 421, 681, 685, 687, 692, 722, 723, 738,
749, 751, 752, 754, 755, 756, 980, 986, 987,
991, 1001, 1008, 1176, 1177, 1186.
empty line at end of le: 486, 538.
empty eld : 684, 685, 686, 742, 1163, 1165, 1181.
empty ag : 124, 126, 130, 150, 164, 1312.
end: 7, 8, 10.
End of file on the terminal : 37, 71.
(\end occurred...) : 1335.
\end primitive: 1052.
end cs name: 208, 265, 266, 372, 1134.
\endcsname primitive: 265.
end diagnostic: 245, 284, 299, 323, 400, 401, 502,
509, 581, 638, 641, 663, 675, 863, 987, 992,
1006, 1011, 1121, 1298.
end le reading : 329, 330, 360, 362, 483, 537,
1335.
end graf : 1026, 1085, 1094, 1096, 1100, 1131,
1133, 1168.
end group: 208, 265, 266, 1063.
\endgroup primitive: 265.
\endinput primitive: 376.
end line char : 87, 236, 240, 303, 318, 332, 360,
362, 483, 534, 538, 1337.
\endlinechar primitive: 238.
end line char code: 236, 237, 238.
end line char inactive: 360, 362, 483, 538, 1337.
end match: 207, 289, 291, 294, 391, 392, 394.
end match token: 289, 389, 391, 392, 393, 394,
474, 476, 482.
end name: 512, 517, 526, 531.
end of TEX: 6, 81, 1332.
end span: 162, 768, 779, 793, 797, 801, 803.
end template: 210, 366, 375, 380, 780, 1295.
end template token: 780, 784, 790.
end token list : 324, 325, 357, 390, 1026, 1335,
1371.
end write: 222, 1369, 1371.
\endwrite : 1369.
end write token: 1371, 1372.
endcases: 10.
endv : 207, 298, 375, 380, 768, 780, 782, 791,
1046, 1130, 1131.
ensure dvi open: 532, 617.
ensure vbox : 993, 1009, 1018.
eof : 26, 31, 52, 564, 575, 1327.
eoln: 31, 52.
eop: 583, 585, 586, 588, 640, 642.
eq dene: 277, 278, 279, 372, 782, 1070, 1077,
1214.
eq destroy: 275, 277, 279, 283.
eq level : 221, 222, 228, 232, 236, 253, 264, 277,
279, 283, 780, 977, 1315, 1369.
eq level eld : 221.
1380 T
E
X82 PART 55: INDEX 491
eq no: 208, 1140, 1141, 1143, 1144.
\eqno primitive: 1141.
eq save: 276, 277, 278.
eq type: 210, 221, 222, 223, 228, 232, 253, 258,
264, 265, 267, 277, 279, 351, 353, 354, 357, 358,
372, 389, 391, 780, 1152, 1315, 1369.
eq type eld : 221, 275.
eq word dene: 278, 279, 1070, 1139, 1145, 1214.
eqtb: 115, 163, 220, 221, 222, 223, 224, 228, 230,
232, 236, 240, 242, 247, 250, 251, 252, 253, 255,
262, 264, 265, 266, 267, 268, 270, 272, 274,
275, 276, 277, 278, 279, 281, 282, 283, 284,
285, 286, 289, 291, 297, 298, 305, 307, 332,
333, 354, 389, 413, 414, 473, 491, 548, 553,
780, 814, 1188, 1208, 1222, 1238, 1240, 1253,
1257, 1315, 1316, 1317, 1339, 1345.
eqtb size: 220, 247, 250, 252, 253, 254, 1307,
1308, 1316, 1317.
equiv : 221, 222, 223, 224, 228, 229, 230, 232,
233, 234, 235, 253, 255, 264, 265, 267, 275,
277, 279, 351, 353, 354, 357, 358, 413, 414,
415, 508, 577, 780, 1152, 1227, 1239, 1240,
1257, 1289, 1315, 1369.
equiv eld : 221, 275, 285.
err help: 79, 230, 1283, 1284.
\errhelp primitive: 230.
err help loc: 230.
\errmessage primitive: 1277.
error : 72, 75, 76, 78, 79, 82, 88, 91, 93, 98, 327,
338, 346, 370, 398, 408, 418, 428, 445, 454, 456,
459, 460, 475, 476, 486, 500, 510, 523, 535, 561,
567, 579, 641, 723, 776, 784, 792, 826, 936,
937, 960, 961, 962, 963, 976, 978, 992, 1004,
1009, 1024, 1027, 1050, 1064, 1066, 1068, 1069,
1080, 1082, 1095, 1099, 1106, 1110, 1120, 1121,
1128, 1129, 1135, 1159, 1166, 1177, 1183, 1192,
1195, 1213, 1225, 1232, 1236, 1237, 1241, 1252,
1259, 1283, 1284, 1293, 1372.
error context lines : 236, 311.
\errorcontextlines primitive: 238.
error context lines code: 236, 237, 238.
error count : 76, 77, 82, 86, 1096, 1293.
error line: 11, 14, 54, 58, 306, 311, 315, 316, 317.
error message issued : 76, 82, 95.
error stop mode: 72, 73, 74, 82, 93, 98, 1262,
1283, 1293, 1294, 1297, 1327, 1335.
\errorstopmode primitive: 1262.
erstat : 27.
escape: 207, 232, 344, 1337.
escape char : 236, 240, 243.
\escapechar primitive: 238.
escape char code: 236, 237, 238.
etc : 182.
ETC : 292.
every cr : 230, 774, 799.
\everycr primitive: 230.
every cr loc: 230, 231.
every cr text : 307, 314, 774, 799.
every display: 230, 1145.
\everydisplay primitive: 230.
every display loc: 230, 231.
every display text : 307, 314, 1145.
every hbox : 230, 1083.
\everyhbox primitive: 230.
every hbox loc: 230, 231.
every hbox text : 307, 314, 1083.
every job: 230, 1030.
\everyjob primitive: 230.
every job loc: 230, 231.
every job text : 307, 314, 1030.
every math: 230, 1139.
\everymath primitive: 230.
every math loc: 230, 231.
every math text : 307, 314, 1139.
every par : 230, 1091.
\everypar primitive: 230.
every par loc: 230, 231, 307, 1226.
every par text : 307, 314, 1091.
every vbox : 230, 1083, 1167.
\everyvbox primitive: 230.
every vbox loc: 230, 231.
every vbox text : 307, 314, 1083, 1167.
ex : 455.
ex hyphen penalty: 145, 236, 869.
\exhyphenpenalty primitive: 238.
ex hyphen penalty code: 236, 237, 238.
ex space: 208, 265, 266, 1030, 1090.
exactly: 644, 645, 715, 889, 977, 1017, 1062, 1201.
exit : 15, 16, 37, 47, 58, 59, 69, 82, 125, 182, 292,
341, 389, 407, 461, 497, 498, 524, 582, 607,
615, 649, 668, 752, 791, 829, 895, 934, 944,
948, 977, 994, 1012, 1030, 1054, 1079, 1105,
1110, 1113, 1119, 1151, 1159, 1174, 1211, 1236,
1270, 1303, 1335, 1338.
expand : 358, 366, 368, 371, 380, 381, 439, 467,
478, 498, 510, 782.
expand after : 210, 265, 266, 366, 367.
\expandafter primitive: 265.
explicit : 155, 717, 837, 866, 868, 879, 1058, 1113.
ext bot : 546, 713, 714.
ext delimiter : 513, 515, 516, 517.
ext mid : 546, 713, 714.
ext rep: 546, 713, 714.
ext tag : 544, 569, 708, 710.
492 PART 55: INDEX T
E
X82 1380
ext top: 546, 713, 714.
exten: 544.
exten base: 550, 552, 566, 573, 574, 576, 713,
1322, 1323.
extensible recipe: 541, 546.
extension: 208, 1344, 1346, 1347, 1375.
extensions to T
E
X: 2, 146, 1340.
Extra \else : 510.
Extra \endcsname : 1135.
Extra \fi : 510.
Extra \or : 500, 510.
Extra \right. : 1192.
Extra }, or forgotten x : 1069.
Extra alignment tab... : 792.
Extra x : 1066.
extra info: 769, 788, 789, 791, 792.
extra right brace: 1068, 1069.
extra space: 547, 558, 1044.
extra space code: 547, 558.
eyes and mouth: 332.
f: 27, 28, 31, 144, 448, 525, 560, 577, 578, 581,
582, 592, 602, 649, 706, 709, 711, 712, 715,
716, 717, 738, 830, 862, 1068, 1113, 1123,
1138, 1211, 1257.
false: 27, 31, 37, 45, 46, 47, 51, 76, 80, 88, 89,
98, 106, 107, 166, 167, 168, 169, 264, 284, 299,
311, 323, 327, 331, 336, 346, 361, 362, 365, 374,
400, 401, 407, 425, 440, 441, 445, 447, 448, 449,
455, 460, 461, 462, 465, 485, 501, 502, 505, 507,
509, 512, 516, 524, 526, 528, 538, 551, 563,
581, 593, 706, 720, 722, 754, 774, 791, 826,
828, 837, 851, 854, 863, 881, 903, 906, 910,
911, 951, 954, 960, 961, 962, 963, 966, 987,
990, 1006, 1011, 1020, 1026, 1031, 1033, 1034,
1035, 1040, 1051, 1054, 1061, 1101, 1167, 1182,
1183, 1191, 1192, 1194, 1199, 1226, 1236, 1258,
1270, 1279, 1282, 1283, 1288, 1303, 1325, 1336,
1342, 1343, 1352, 1354, 1371, 1374.
false bchar : 1032, 1034, 1038.
fam: 681, 682, 683, 687, 691, 722, 723, 752, 753,
1151, 1155, 1165.
\fam primitive: 238.
fam fnt : 230, 700, 701, 707, 722, 1195.
fam in range: 1151, 1155, 1165.
fast delete glue ref : 201, 202.
fast get avail : 122, 371, 1034, 1038.
fast store new token: 371, 399, 464, 466.
Fatal format file error : 1303.
fatal error : 71, 93, 324, 360, 484, 530, 535, 782,
789, 791, 1131.
fatal error stop: 76, 77, 82, 93, 1332.
fbyte: 564, 568, 571, 575.
Ferguson, Michael John: 2.
fetch: 722, 724, 738, 741, 749, 752, 755.
fewest demerits : 872, 874, 875.
fget : 564, 565, 568, 571, 575.
\fi primitive: 491.
code: 489, 491, 492, 494, 498, 500, 509, 510.
or else: 210, 366, 367, 489, 491, 492, 494, 510.
fil : 454.
l : 135, 150, 164, 177, 454, 650, 659, 665, 1201.
l code: 1058, 1059, 1060.
l glue: 162, 164, 1060.
l neg code: 1058, 1060.
l neg glue: 162, 164, 1060.
File ended while scanning... : 338.
File ended within \read : 486.
le name size: 11, 26, 519, 522, 523, 525.
le oset : 54, 55, 57, 58, 62, 537, 638, 1280.
le opened : 560, 561, 563.
ll : 135, 150, 164, 650, 659, 665, 1201.
ll code: 1058, 1059, 1060.
ll glue: 162, 164, 1054, 1060.
lll : 135, 150, 177, 454, 650, 659, 665, 1201.
n align: 773, 785, 800, 1131.
n col : 773, 791, 1131.
n mlist : 1174, 1184, 1186, 1191, 1194.
n row: 773, 799, 1131.
n rule: 619, 622, 626, 629, 631, 635.
nal cleanup: 1332, 1335.
nal end : 6, 35, 331, 1332, 1337.
nal hyphen demerits : 236, 859.
\finalhyphendemerits primitive: 238.
nal hyphen demerits code: 236, 237, 238.
nal pass : 828, 854, 863, 873.
nal widow penalty: 814, 815, 876, 877, 890.
nd font dimen: 425, 578, 1042, 1253.
ngers: 511.
nite shrink : 825, 826.
re up: 1005, 1012.
rm up the line: 340, 362, 363, 538.
rst : 30, 31, 35, 36, 37, 71, 83, 87, 88, 328, 329,
331, 355, 360, 362, 363, 374, 483, 531, 538.
rst child : 960, 963, 964.
rst count : 54, 315, 316, 317.
rst t : 953, 957, 966.
rst indent : 847, 849, 889.
rst mark : 382, 383, 1012, 1016.
\firstmark primitive: 384.
rst mark code: 382, 384, 385.
rst text char : 19, 24.
rst width: 847, 849, 850, 889.
t class : 830, 836, 845, 846, 852, 853, 855, 859.
tness : 819, 845, 859, 864.
1380 T
E
X82 PART 55: INDEX 493
x date and time: 241, 1332, 1337.
x language: 1034, 1376.
x word : 541, 542, 547, 548, 571.
oat : 109, 114, 186, 625, 634, 809.
oat constant : 109, 186, 619, 625, 629, 1123, 1125.
oat cost : 140, 188, 1008, 1100.
oating penalty: 140, 236, 1068, 1100.
\floatingpenalty primitive: 238.
oating penalty code: 236, 237, 238.
ush char : 42, 180, 195, 692, 695.
ush list : 123, 200, 324, 372, 396, 407, 801, 903,
960, 1279, 1297, 1370.
ush math: 718, 776, 1195.
ush node list : 199, 202, 275, 639, 698, 718, 731,
732, 742, 800, 816, 879, 883, 903, 918, 968, 992,
999, 1078, 1105, 1120, 1121, 1375.
ush string : 44, 264, 537, 1260, 1279, 1328.
ushable string : 1257, 1260.
fmem ptr : 425, 549, 552, 566, 569, 570, 576, 578,
579, 580, 1320, 1321, 1323, 1334.
fmt le: 524, 1305, 1306, 1308, 1327, 1328,
1329, 1337.
fnt def1 : 585, 586, 602.
fnt def2 : 585.
fnt def3 : 585.
fnt def4 : 585.
fnt num 0 : 585, 586, 621.
fnt1 : 585, 586, 621.
fnt2 : 585.
fnt3 : 585.
fnt4 : 585.
font : 134, 143, 144, 174, 176, 193, 206, 267, 548,
582, 620, 654, 681, 709, 715, 724, 841, 842,
866, 867, 870, 871, 896, 897, 898, 903, 908,
911, 1034, 1038, 1113, 1147.
font metric les: 539.
font parameters: 700, 701.
Font x has only... : 579.
Font x=xx not loadable... : 561.
Font x=xx not loaded... : 567.
\font primitive: 265.
font area: 549, 552, 576, 602, 603, 1260, 1322,
1323.
font base: 11, 12, 111, 134, 174, 176, 222, 232,
548, 551, 602, 621, 643, 1260, 1320, 1321, 1334.
font bc: 549, 552, 576, 582, 708, 722, 1036,
1322, 1323.
font bchar : 549, 552, 576, 897, 898, 915, 1032,
1034, 1322, 1323.
font check : 549, 568, 602, 1322, 1323.
\fontdimen primitive: 265.
font dsize: 472, 549, 552, 568, 602, 1260, 1261,
1322, 1323.
font ec: 549, 552, 576, 582, 708, 722, 1036,
1322, 1323.
font false bchar : 549, 552, 576, 1032, 1034,
1322, 1323.
font glue: 549, 552, 576, 578, 1042, 1322, 1323.
font id base: 222, 234, 256, 415, 548, 1257.
font id text : 234, 256, 267, 579, 1257, 1322.
font in short display: 173, 174, 193, 663, 864,
1339.
font index : 548, 549, 560, 906, 1032, 1211.
font info: 11, 425, 548, 549, 550, 552, 554, 557,
558, 560, 566, 569, 571, 573, 574, 575, 578,
580, 700, 701, 713, 741, 752, 909, 1032, 1039,
1042, 1211, 1253, 1320, 1321, 1339.
font max : 11, 111, 174, 176, 548, 551, 566,
1321, 1334.
font mem size: 11, 548, 566, 580, 1321, 1334.
font name: 472, 549, 552, 576, 581, 602, 603,
1260, 1261, 1322, 1323.
\fontname primitive: 468.
font name code: 468, 469, 471, 472.
font params : 549, 552, 576, 578, 579, 580, 1195,
1322, 1323.
font ptr : 549, 552, 566, 576, 578, 643, 1260,
1320, 1321, 1334.
font size: 472, 549, 552, 568, 602, 1260, 1261,
1322, 1323.
font used : 549, 551, 621, 643.
FONTx : 1257.
for accent : 191.
Forbidden control sequence... : 338.
force eof : 331, 361, 362, 378.
format area length: 520, 524.
format default length: 520, 522, 523, 524.
format ext length: 520, 523, 524.
format extension: 520, 529, 1328.
format ident : 35, 61, 536, 1299, 1300, 1301, 1326,
1327, 1328, 1337.
forward : 78, 218, 281, 340, 366, 409, 618, 692,
693, 720, 774, 800.
found : 15, 125, 128, 129, 259, 341, 354, 356,
389, 392, 394, 448, 455, 473, 475, 477, 524,
607, 609, 612, 613, 614, 645, 706, 708, 720,
895, 923, 931, 934, 941, 953, 955, 1138, 1146,
1147, 1148, 1236, 1237.
found1 : 15, 895, 902, 1302, 1315.
found2 : 15, 895, 903, 1302, 1316.
four choices : 113.
four quarters : 113, 548, 549, 554, 555, 560, 649,
683, 684, 706, 709, 712, 724, 738, 749, 906,
494 PART 55: INDEX T
E
X82 1380
1032, 1123, 1302, 1303.
fraction noad : 683, 687, 690, 698, 733, 761,
1178, 1181.
fraction noad size: 683, 698, 761, 1181.
fraction rule: 704, 705, 735, 747.
free: 165, 167, 168, 169, 170, 171.
free avail : 121, 202, 204, 217, 400, 452, 772,
915, 1036, 1226, 1288.
free node: 130, 201, 202, 275, 496, 615, 655, 698,
715, 721, 727, 751, 753, 756, 760, 772, 803, 860,
861, 865, 903, 910, 977, 1019, 1021, 1022, 1037,
1100, 1110, 1186, 1187, 1201, 1335, 1358.
freeze page specs : 987, 1001, 1008.
frozen control sequence: 222, 258, 1215, 1314,
1318, 1319.
frozen cr : 222, 339, 780, 1132.
frozen dont expand : 222, 258, 369.
frozen end group: 222, 265, 1065.
frozen end template: 222, 375, 780.
frozen endv : 222, 375, 380, 780.
frozen : 222, 336, 491.
frozen null font : 222, 553.
frozen protection: 222, 1215, 1216.
frozen relax : 222, 265, 379.
frozen right : 222, 1065, 1188.
Fuchs, David Raymond: 2, 583, 591.
\futurelet primitive: 1219.
g: 47, 182, 560, 592, 649, 668, 706, 716.
g order : 619, 625, 629, 634.
g sign: 619, 625, 629, 634.
garbage: 162, 467, 470, 960, 1183, 1192, 1279.
\gdef primitive: 1208.
geq dene: 279, 782, 1077, 1214.
geq word dene: 279, 288, 1013, 1214.
get : 26, 29, 31, 33, 485, 538, 564, 1306.
get avail : 120, 122, 204, 205, 216, 325, 337, 339,
369, 371, 372, 452, 473, 482, 582, 709, 772, 783,
784, 794, 908, 911, 938, 1064, 1065, 1226, 1371.
get next : 76, 297, 332, 336, 340, 341, 357, 360,
364, 365, 366, 369, 380, 381, 387, 389, 478,
494, 507, 644, 1038, 1126.
get node: 125, 131, 136, 139, 144, 145, 147, 151,
152, 153, 156, 158, 206, 495, 607, 649, 668,
686, 688, 689, 716, 772, 798, 843, 844, 845,
864, 914, 1009, 1100, 1101, 1163, 1165, 1181,
1248, 1249, 1349, 1357.
get preamble token: 782, 783, 784.
get r token: 1215, 1218, 1221, 1224, 1225, 1257.
get strings started : 47, 51, 1332.
get token: 76, 78, 88, 364, 365, 368, 369, 392,
399, 442, 452, 471, 473, 474, 476, 477, 479,
483, 782, 1027, 1138, 1215, 1221, 1252, 1268,
1271, 1294, 1371, 1372.
get x token: 364, 366, 372, 380, 381, 402, 404, 406,
407, 443, 444, 445, 452, 465, 479, 506, 526, 780,
935, 961, 1029, 1030, 1138, 1197, 1237, 1375.
get x token or active char : 506.
give err help: 78, 89, 90, 1284.
global : 1214, 1218, 1241.
global denitions: 221, 279, 283.
\global primitive: 1208.
global defs : 236, 782, 1214, 1218.
\globaldefs primitive: 238.
global defs code: 236, 237, 238.
glue base: 220, 222, 224, 226, 227, 228, 229,
252, 782.
glue node: 149, 152, 153, 175, 183, 202, 206, 424,
622, 631, 651, 669, 730, 732, 761, 816, 817,
837, 856, 862, 866, 879, 881, 899, 903, 968,
972, 973, 988, 996, 997, 1000, 1106, 1107,
1108, 1147, 1202.
glue oset : 135, 159, 186.
glue ord : 150, 447, 619, 629, 646, 649, 668, 791.
glue order : 135, 136, 159, 185, 186, 619, 629,
657, 658, 664, 672, 673, 676, 769, 796, 801,
807, 809, 810, 811, 1148.
glue par : 224, 766.
glue pars : 224.
glue ptr : 149, 152, 153, 175, 189, 190, 202, 206,
424, 625, 634, 656, 671, 679, 732, 786, 793,
795, 802, 803, 809, 816, 838, 868, 881, 969,
976, 996, 1001, 1004, 1148.
glue ratio: 109, 110, 113, 135, 186.
glue ref : 210, 228, 275, 782, 1228, 1236.
glue ref count : 150, 151, 152, 153, 154, 164, 201,
203, 228, 766, 1043, 1060.
glue set : 135, 136, 159, 186, 625, 634, 657, 658,
664, 672, 673, 676, 807, 809, 810, 811, 1148.
glue shrink : 159, 185, 796, 799, 801, 810, 811.
glue sign: 135, 136, 159, 185, 186, 619, 629, 657,
658, 664, 672, 673, 676, 769, 796, 801, 807,
809, 810, 811, 1148.
glue spec size: 150, 151, 162, 164, 201, 716.
glue stretch: 159, 185, 796, 799, 801, 810, 811.
glue temp: 619, 625, 629, 634.
glue val : 410, 411, 412, 413, 416, 417, 424, 427,
429, 430, 451, 461, 465, 782, 1060, 1228, 1236,
1237, 1238, 1240.
goal height : 986, 987.
goto: 35, 81.
gr : 110, 113, 114, 135.
group code: 269, 271, 274, 645, 1136.
gubed: 7.
1380 T
E
X82 PART 55: INDEX 495
Guibas, Leonidas Ioannis: 2.
g1 : 1198, 1203.
g2 : 1198, 1203, 1205.
h: 204, 259, 649, 668, 738, 929, 934, 944, 948, 953,
966, 970, 977, 994, 1086, 1091, 1123.
h oset : 247, 617, 641.
\hoffset primitive: 248.
h oset code: 247, 248.
ha: 892, 896, 900, 903, 912.
half : 100, 706, 736, 737, 738, 745, 746, 749,
750, 1202.
half buf : 594, 595, 596, 598, 599.
half error line: 11, 14, 311, 315, 316, 317.
halfword : 108, 110, 113, 115, 130, 264, 277, 279,
280, 281, 297, 298, 300, 333, 341, 366, 389, 413,
464, 473, 549, 560, 577, 681, 791, 800, 821, 829,
830, 833, 847, 872, 877, 892, 901, 906, 907,
1032, 1079, 1211, 1243, 1266, 1288.
halign: 208, 265, 266, 1094, 1130.
\halign primitive: 265.
handle right brace: 1067, 1068.
hang after : 236, 240, 847, 849, 1070, 1149.
\hangafter primitive: 238.
hang after code: 236, 237, 238, 1070.
hang indent : 247, 847, 848, 849, 1070, 1149.
\hangindent primitive: 248.
hang indent code: 247, 248, 1070.
hanging indentation: 847.
hash: 234, 256, 257, 259, 260, 1318, 1319.
hash base: 220, 222, 256, 257, 259, 262, 263,
1257, 1314, 1318, 1319.
hash brace: 473, 476.
hash is full : 256, 260.
hash prime: 12, 14, 259, 261, 1307, 1308.
hash size: 12, 14, 222, 260, 261, 1334.
hash used : 256, 258, 260, 1318, 1319.
hb: 892, 897, 898, 900, 903.
hbadness : 236, 660, 666, 667.
\hbadness primitive: 238.
hbadness code: 236, 237, 238.
\hbox primitive: 1071.
hbox group: 269, 274, 1083, 1085.
hc: 892, 893, 897, 898, 900, 901, 919, 920, 923,
930, 931, 934, 937, 939, 960, 962, 963, 965.
hchar : 905, 906, 908, 909.
hd : 649, 654, 706, 708, 709, 712.
head : 212, 213, 215, 216, 217, 424, 718, 776, 796,
799, 805, 812, 814, 816, 1026, 1054, 1080,
1081, 1086, 1091, 1096, 1100, 1105, 1113,
1119, 1121, 1145, 1159, 1168, 1176, 1181,
1184, 1185, 1187, 1191.
head eld : 212, 213, 218.
head for vmode: 1094, 1095.
header : 542.
Hedrick, Charles Locke: 3.
height : 135, 136, 138, 139, 140, 184, 187, 188, 463,
554, 622, 624, 626, 629, 631, 632, 635, 637, 640,
641, 649, 653, 656, 670, 672, 679, 704, 706,
709, 711, 713, 727, 730, 735, 736, 737, 738,
739, 742, 745, 746, 747, 749, 750, 751, 756,
757, 759, 768, 769, 796, 801, 804, 806, 807,
809, 810, 811, 969, 973, 981, 986, 1001, 1002,
1008, 1009, 1010, 1021, 1087, 1100.
height : 463.
height base: 550, 552, 554, 566, 571, 1322, 1323.
height depth: 554, 654, 708, 709, 712, 1125.
height index : 543, 554.
height oset : 135, 416, 417, 769, 1247.
height plus depth: 712, 714.
held over for next output : 986.
help line: 79, 89, 90, 336, 1106.
help ptr : 79, 80, 89, 90.
help0 : 79, 1252, 1293.
help1 : 79, 93, 95, 288, 408, 428, 454, 476, 486,
500, 503, 510, 960, 961, 962, 963, 1066, 1080,
1099, 1121, 1132, 1135, 1159, 1177, 1192, 1212,
1213, 1232, 1237, 1243, 1244, 1258, 1283, 1304.
help2 : 72, 79, 88, 89, 94, 95, 288, 346, 373, 433,
434, 435, 436, 437, 442, 445, 460, 475, 476,
577, 579, 641, 936, 937, 978, 1015, 1027, 1047,
1068, 1080, 1082, 1095, 1106, 1120, 1129, 1166,
1197, 1207, 1225, 1236, 1241, 1259, 1372.
help3 : 72, 79, 98, 336, 396, 415, 446, 479, 776,
783, 784, 792, 993, 1009, 1024, 1028, 1078,
1084, 1110, 1127, 1183, 1195, 1293.
help4 : 79, 89, 338, 398, 403, 418, 456, 567, 723,
976, 1004, 1050, 1283.
help5 : 79, 370, 561, 826, 1064, 1069, 1128,
1215, 1293.
help6 : 79, 395, 459, 1128, 1161.
Here is how much... : 1334.
hex to cur chr : 352, 355.
hex token: 438, 444.
hf : 892, 896, 897, 898, 903, 908, 909, 910,
911, 915, 916.
\hfil primitive: 1058.
\hfilneg primitive: 1058.
\hfill primitive: 1058.
hfuzz : 247, 666.
\hfuzz primitive: 248.
hfuzz code: 247, 248.
hh: 110, 113, 114, 118, 133, 182, 213, 219, 221, 268,
686, 742, 1163, 1165, 1181, 1186, 1305, 1306.
hi : 112, 232, 1232.
496 PART 55: INDEX T
E
X82 1380
hi mem min: 116, 118, 120, 125, 126, 134, 164,
165, 167, 168, 171, 172, 176, 293, 639, 1311,
1312, 1334.
hi mem stat min: 162, 164, 1312.
hi mem stat usage: 162, 164.
history: 76, 77, 82, 93, 95, 245, 1332, 1335.
hlist node: 135, 136, 137, 138, 148, 159, 175, 183,
184, 202, 206, 505, 618, 619, 622, 631, 644,
649, 651, 669, 681, 807, 810, 814, 841, 842,
866, 870, 871, 968, 973, 993, 1000, 1074, 1080,
1087, 1110, 1147, 1203.
hlist out : 592, 615, 616, 618, 619, 620, 623, 628,
629, 632, 637, 638, 640, 693, 1373.
hlp1 : 79.
hlp2 : 79.
hlp3 : 79.
hlp4 : 79.
hlp5 : 79.
hlp6 : 79.
hmode: 211, 218, 416, 501, 786, 787, 796, 799,
1030, 1045, 1046, 1048, 1056, 1057, 1071, 1073,
1076, 1079, 1083, 1086, 1091, 1092, 1093, 1094,
1096, 1097, 1109, 1110, 1112, 1116, 1117, 1119,
1122, 1130, 1137, 1200, 1243, 1377.
hmove: 208, 1048, 1071, 1072, 1073.
hn: 892, 897, 898, 899, 902, 912, 913, 915, 916,
917, 919, 923, 930, 931.
ho: 112, 235, 414, 1151, 1154.
hold head : 162, 306, 779, 783, 784, 794, 808, 905,
906, 913, 914, 915, 916, 917, 1014, 1017.
holding inserts : 236, 1014.
\holdinginserts primitive: 238.
holding inserts code: 236, 237, 238.
hpack : 162, 236, 644, 645, 646, 647, 649, 661,
709, 715, 720, 727, 737, 748, 754, 756, 796,
799, 804, 806, 889, 1062, 1086, 1125, 1194,
1199, 1201, 1204.
hrule: 208, 265, 266, 463, 1046, 1056, 1084,
1094, 1095.
\hrule primitive: 265.
hsize: 247, 847, 848, 849, 1054, 1149.
\hsize primitive: 248.
hsize code: 247, 248.
hskip: 208, 1057, 1058, 1059, 1078, 1090.
\hskip primitive: 1058.
\hss primitive: 1058.
\ht primitive: 416.
hu: 892, 893, 897, 898, 901, 903, 905, 907, 908,
910, 911, 912, 915, 916.
Huge page... : 641.
hyf : 900, 902, 905, 908, 909, 913, 914, 919, 920,
923, 924, 932, 960, 961, 962, 963, 965.
hyf bchar : 892, 897, 898, 903.
hyf char : 892, 896, 913, 915.
hyf distance: 920, 921, 922, 924, 943, 944, 945,
1324, 1325.
hyf next : 920, 921, 924, 943, 944, 945, 1324, 1325.
hyf node: 912, 915.
hyf num: 920, 921, 924, 943, 944, 945, 1324, 1325.
hyph count : 926, 928, 940, 1324, 1325, 1334.
hyph data: 209, 1210, 1250, 1251, 1252.
hyph list : 926, 928, 929, 932, 933, 934, 940,
941, 1324, 1325.
hyph pointer : 925, 926, 927, 929, 934.
hyph size: 12, 925, 928, 930, 933, 939, 940, 1307,
1308, 1324, 1325, 1334.
hyph word : 926, 928, 929, 931, 934, 940, 941,
1324, 1325.
hyphen char : 426, 549, 552, 576, 891, 896, 1035,
1117, 1253, 1322, 1323.
\hyphenchar primitive: 1254.
hyphen passed : 905, 906, 909, 913, 914.
hyphen penalty: 145, 236, 869.
\hyphenpenalty primitive: 238.
hyphen penalty code: 236, 237, 238.
hyphenate: 894, 895.
hyphenated : 819, 820, 829, 846, 859, 869, 873.
Hyphenation trie... : 1324.
\hyphenation primitive: 1250.
i: 19, 315, 587, 649, 738, 749, 901, 1123, 1348.
I cant find file x : 530.
I cant find PLAIN... : 524.
I cant go on... : 95.
I cant read TEX.POOL : 51.
I cant write on file x : 530.
id byte: 587, 617, 642.
id lookup: 259, 264, 356, 374.
ident val : 410, 415, 465, 466.
\ifcase primitive: 487.
if case code: 487, 488, 501.
if cat code: 487, 488, 501.
\ifcat primitive: 487.
\if primitive: 487.
if char code: 487, 501, 506.
if code: 489, 495, 510.
\ifdim primitive: 487.
if dim code: 487, 488, 501.
\ifeof primitive: 487.
if eof code: 487, 488, 501.
\iffalse primitive: 487.
if false code: 487, 488, 501.
\ifhbox primitive: 487.
if hbox code: 487, 488, 501, 505.
\ifhmode primitive: 487.
1380 T
E
X82 PART 55: INDEX 497
if hmode code: 487, 488, 501.
\ifinner primitive: 487.
if inner code: 487, 488, 501.
\ifnum primitive: 487.
if int code: 487, 488, 501, 503.
if limit : 489, 490, 495, 496, 497, 498, 510.
if line: 489, 490, 495, 496, 1335.
if line eld : 489, 495, 496, 1335.
\ifmmode primitive: 487.
if mmode code: 487, 488, 501.
if node size: 489, 495, 496, 1335.
\ifodd primitive: 487.
if odd code: 487, 488, 501.
if test : 210, 336, 366, 367, 487, 488, 494, 498,
503, 1335.
\iftrue primitive: 487.
if true code: 487, 488, 501.
\ifvbox primitive: 487.
if vbox code: 487, 488, 501.
\ifvmode primitive: 487.
if vmode code: 487, 488, 501.
\ifvoid primitive: 487.
if void code: 487, 488, 501, 505.
\ifx primitive: 487.
ifx code: 487, 488, 501.
ignore: 207, 232, 332, 345.
ignore depth: 212, 215, 219, 679, 787, 1025, 1056,
1083, 1099, 1167.
ignore spaces : 208, 265, 266, 1045.
\ignorespaces primitive: 265.
Illegal magnification... : 288, 1258.
Illegal math \disc... : 1120.
Illegal parameter number... : 479.
Illegal unit of measure : 454, 456, 459.
\immediate primitive: 1344.
immediate code: 1344, 1346, 1348.
IMPOSSIBLE : 262.
Improper \halign... : 776.
Improper \hyphenation... : 936.
Improper \prevdepth : 418.
Improper \setbox : 1241.
Improper \spacefactor : 418.
Improper at size... : 1259.
Improper alphabetic constant : 442.
Improper discretionary list : 1121.
in : 458.
in open: 304, 328, 329, 331.
in state record : 300, 301.
in stream: 208, 1272, 1273, 1274.
Incompatible glue units : 408.
Incompatible list... : 1110.
Incompatible magnification : 288.
incompleat noad : 212, 213, 718, 776, 1136, 1178,
1181, 1182, 1184, 1185.
Incomplete \if... : 336.
incr : 16, 31, 37, 42, 43, 45, 46, 53, 58, 59, 60, 65,
67, 70, 71, 82, 90, 98, 120, 122, 152, 153, 170,
182, 203, 216, 260, 274, 276, 280, 294, 311, 312,
321, 325, 328, 343, 347, 352, 354, 355, 356, 357,
360, 362, 374, 392, 395, 397, 399, 400, 403, 407,
442, 452, 454, 464, 475, 476, 477, 494, 517, 519,
524, 531, 537, 580, 598, 619, 629, 640, 642, 645,
714, 798, 845, 877, 897, 898, 910, 911, 914,
915, 923, 930, 931, 937, 939, 940, 941, 944,
954, 956, 962, 963, 964, 986, 1022, 1025, 1035,
1039, 1069, 1099, 1117, 1119, 1121, 1127, 1142,
1153, 1172, 1174, 1315, 1316, 1318, 1337.
\indent primitive: 1088.
indent in hmode: 1092, 1093.
indented : 1091.
index : 300, 302, 303, 304, 307, 328, 329, 331.
index eld : 300, 302, 1131.
inf : 447, 448, 453.
inf bad : 108, 157, 851, 852, 853, 856, 863, 974,
1005, 1017.
inf penalty: 157, 761, 767, 816, 829, 831, 974,
1005, 1013, 1203, 1205.
Infinite glue shrinkage... : 826, 976, 1004,
1009.
innity: 445.
info: 118, 124, 126, 140, 164, 172, 200, 233, 275,
291, 293, 325, 337, 339, 357, 358, 369, 371, 374,
389, 391, 392, 393, 394, 397, 400, 423, 452, 466,
508, 605, 608, 609, 610, 611, 612, 613, 614, 615,
681, 689, 692, 693, 698, 720, 734, 735, 736, 737,
738, 742, 749, 754, 768, 769, 772, 779, 783,
784, 790, 793, 794, 797, 798, 801, 803, 821,
847, 848, 925, 932, 938, 981, 1065, 1076, 1093,
1149, 1151, 1168, 1181, 1185, 1186, 1191, 1226,
1248, 1249, 1289, 1312, 1339, 1341, 1371.
init: 8, 47, 50, 131, 264, 891, 942, 943, 947, 950,
1252, 1302, 1325, 1332, 1335, 1336.
init align: 773, 774, 1130.
init col : 773, 785, 788, 791.
init cur lang : 816, 891, 892.
init l hyf : 816, 891, 892.
init lft : 900, 903, 905, 908.
init lig : 900, 903, 905, 908.
init list : 900, 903, 905, 908.
init math: 1137, 1138.
init pool ptr : 39, 42, 1310, 1332, 1334.
init prim: 1332, 1336.
init r hyf : 816, 891, 892.
init row: 773, 785, 786.
498 PART 55: INDEX T
E
X82 1380
init span: 773, 786, 787, 791.
init str ptr : 39, 43, 517, 1310, 1332, 1334.
init terminal : 37, 331.
init trie: 891, 966, 1324.
INITEX : 8, 11, 12, 47, 50, 116, 1299, 1331.
initialize: 4, 1332, 1337.
inner loop: 31, 112, 120, 121, 122, 123, 125, 127,
128, 130, 202, 324, 325, 341, 342, 343, 357, 365,
380, 399, 407, 554, 597, 611, 620, 651, 654, 655,
832, 835, 851, 852, 867, 1030, 1039, 1041.
inner noad : 682, 683, 690, 696, 698, 733, 761,
764, 1156, 1157, 1191.
input : 210, 366, 367, 376, 377.
\input primitive: 376.
input le: 304.
\inputlineno primitive: 416.
input line no code: 416, 417, 424.
input ln: 30, 31, 37, 58, 71, 362, 485, 486, 538.
input ptr : 301, 311, 312, 321, 322, 330, 331,
360, 534, 1131, 1335.
input stack : 84, 301, 311, 321, 322, 534, 1131.
ins disc: 1032, 1033, 1035.
ins error : 327, 336, 395, 1047, 1127, 1132, 1215.
ins list : 323, 339, 467, 470, 1064, 1371.
ins node: 140, 148, 175, 183, 202, 206, 647,
651, 730, 761, 866, 899, 968, 973, 981, 986,
1000, 1014, 1100.
ins node size: 140, 202, 206, 1022, 1100.
ins ptr : 140, 188, 202, 206, 1010, 1020, 1021, 1100.
ins the toks : 366, 367, 467.
insert : 208, 265, 266, 1097.
insert> : 87.
\insert primitive: 265.
insert dollar sign: 1045, 1047.
insert group: 269, 1068, 1099, 1100.
insert penalties : 419, 982, 990, 1005, 1008, 1010,
1014, 1022, 1026, 1242, 1246.
\insertpenalties primitive: 416.
insert relax : 378, 379, 510.
insert token: 268, 280, 282.
inserted : 307, 314, 323, 324, 327, 379, 1095.
inserting : 981, 1009.
Insertions can only... : 993.
inserts only: 980, 987, 1008.
int : 110, 113, 114, 140, 141, 157, 186, 213, 219,
236, 240, 242, 274, 278, 279, 413, 414, 489,
605, 725, 769, 772, 819, 1238, 1240, 1305,
1306, 1308, 1316.
int base: 220, 230, 232, 236, 238, 239, 240, 242,
252, 253, 254, 268, 283, 288, 1013, 1070,
1139, 1145, 1315.
int error : 91, 288, 433, 434, 435, 436, 437, 1243,
1244, 1258.
int par : 236.
int pars : 236.
int val : 410, 411, 412, 413, 414, 416, 417, 418,
419, 422, 423, 424, 426, 427, 428, 429, 439, 440,
449, 461, 465, 1236, 1237, 1238, 1240.
integer : 3, 13, 19, 45, 47, 54, 59, 60, 63, 65, 66,
67, 69, 82, 91, 94, 96, 100, 101, 102, 105, 106,
107, 108, 109, 110, 113, 117, 125, 158, 163, 172,
173, 174, 176, 177, 178, 181, 182, 211, 212, 218,
225, 237, 247, 256, 259, 262, 278, 279, 286, 292,
304, 308, 309, 311, 315, 366, 410, 440, 448, 450,
482, 489, 493, 494, 498, 518, 519, 523, 549, 550,
560, 578, 592, 595, 600, 601, 607, 615, 616, 619,
629, 638, 645, 646, 661, 691, 694, 699, 706, 716,
717, 726, 738, 752, 764, 815, 828, 829, 830, 833,
872, 877, 892, 912, 922, 966, 970, 980, 982, 994,
1012, 1030, 1032, 1068, 1075, 1079, 1084, 1091,
1117, 1119, 1138, 1151, 1155, 1194, 1211, 1302,
1303, 1331, 1333, 1338, 1348, 1370.
inter line penalty: 236, 890.
\interlinepenalty primitive: 238.
inter line penalty code: 236, 237, 238.
interaction: 71, 72, 73, 74, 75, 82, 84, 86, 90, 92,
93, 98, 360, 363, 484, 530, 1265, 1283, 1293,
1294, 1297, 1326, 1327, 1328, 1335.
internal font number : 548, 549, 550, 560, 577,
578, 581, 582, 602, 616, 649, 706, 709, 711,
712, 715, 724, 738, 830, 862, 892, 1032, 1113,
1123, 1138, 1211, 1257.
interrupt : 96, 97, 98, 1031.
Interruption : 98.
interwoven alignment preambles... : 324,
782, 789, 791, 1131.
Invalid code : 1232.
invalid char : 207, 232, 344.
invalid code: 22, 24, 232.
is char node: 134, 174, 183, 202, 205, 424, 620,
630, 651, 669, 715, 720, 721, 756, 805, 816,
837, 841, 842, 866, 867, 868, 870, 871, 879,
896, 897, 899, 903, 1036, 1040, 1080, 1081,
1105, 1113, 1121, 1147, 1202.
is empty: 124, 127, 169, 170.
is hex : 352, 355.
is running : 138, 176, 624, 633, 806.
issue message: 1276, 1279.
ital corr : 208, 265, 266, 1111, 1112.
italic correction: 543.
italic base: 550, 552, 554, 566, 571, 1322, 1323.
italic index : 543.
its all over : 1045, 1054, 1335.
1380 T
E
X82 PART 55: INDEX 499
j: 45, 46, 59, 60, 69, 70, 259, 264, 315, 366, 519,
523, 524, 638, 893, 901, 906, 934, 966, 1211,
1302, 1303, 1348, 1370, 1373.
Japanese characters: 134, 585.
Jensen, Kathleen: 10.
job aborted : 360.
job aborted, file error... : 530.
job name: 92, 471, 472, 527, 528, 529, 532, 534,
537, 1257, 1328, 1335.
\jobname primitive: 468.
job name code: 468, 470, 471, 472.
jump out : 81, 82, 84, 93.
just box : 814, 888, 889, 1146, 1148.
just open: 480, 483, 1275.
k: 45, 46, 47, 64, 65, 67, 69, 71, 102, 163, 259,
264, 341, 363, 407, 450, 464, 519, 523, 525,
530, 534, 560, 587, 597, 602, 607, 638, 705,
906, 929, 934, 960, 966, 1079, 1211, 1302, 1303,
1333, 1338, 1348, 1368.
kern: 208, 545, 1057, 1058, 1059.
\kern primitive: 1058.
kern base: 550, 552, 557, 566, 573, 576, 1322, 1323.
kern base oset : 557, 566, 573.
kern break : 866.
kern ag : 545, 741, 753, 909, 1040.
kern node: 155, 156, 183, 202, 206, 424, 622, 631,
651, 669, 721, 730, 732, 761, 837, 841, 842,
856, 866, 868, 870, 871, 879, 881, 896, 897,
899, 968, 972, 973, 976, 996, 997, 1000, 1004,
1106, 1107, 1108, 1121, 1147.
kk : 450, 452.
Knuth, Donald Ervin: 2, 86, 693, 813, 891, 925,
997, 1154, 1371.
l: 47, 259, 264, 276, 281, 292, 315, 494, 497, 534,
601, 615, 668, 830, 901, 944, 953, 960, 1138,
1194, 1236, 1302, 1338, 1376.
l hyf : 891, 892, 894, 899, 902, 923, 1362.
language: 236, 934, 1034, 1376.
\language primitive: 238.
language code: 236, 237, 238.
language node: 1341, 1356, 1357, 1358, 1362,
1373, 1376, 1377.
large attempt : 706.
large char : 683, 691, 697, 706, 1160.
large fam: 683, 691, 697, 706, 1160.
last : 30, 31, 35, 36, 37, 71, 83, 87, 88, 331, 360,
363, 483, 524, 531.
last active: 819, 820, 832, 835, 844, 854, 860, 861,
863, 864, 865, 873, 874, 875.
last badness : 424, 646, 648, 649, 660, 664, 667,
668, 674, 676, 678.
last bop: 592, 593, 640, 642.
\lastbox primitive: 1071.
last box code: 1071, 1072, 1079.
last glue: 424, 982, 991, 996, 1017, 1106, 1335.
last ins ptr : 981, 1005, 1008, 1018, 1020.
last item: 208, 413, 416, 417, 1048.
last kern: 424, 982, 991, 996.
\lastkern primitive: 416.
last nonblank : 31.
last penalty: 424, 982, 991, 996.
\lastpenalty primitive: 416.
\lastskip primitive: 416.
last special line: 847, 848, 849, 850, 889.
last text char : 19, 24.
lc code: 230, 232, 891, 896, 897, 898, 937, 962.
\lccode primitive: 1230.
lc code base: 230, 235, 1230, 1231, 1286, 1287,
1288.
leader box : 619, 626, 628, 629, 635, 637.
leader ag : 1071, 1073, 1078, 1084.
leader ht : 629, 635, 636, 637.
leader ptr : 149, 152, 153, 190, 202, 206, 626,
635, 656, 671, 816, 1078.
leader ship: 208, 1071, 1072, 1073.
leader wd : 619, 626, 627, 628.
leaders: 1374.
Leaders not followed by... : 1078.
\leaders primitive: 1071.
least cost : 970, 974, 980.
least page cost : 980, 987, 1005, 1006.
\left primitive: 1188.
left brace: 207, 289, 294, 298, 347, 357, 403, 473,
476, 777, 1063, 1150, 1226.
left brace limit : 289, 325, 392, 394, 399.
left brace token: 289, 403, 1127, 1226, 1371.
left delimiter : 683, 696, 697, 737, 748, 1163,
1181, 1182.
left edge: 619, 627, 629, 632, 637.
left hyphen min: 236, 1091, 1200, 1376, 1377.
\lefthyphenmin primitive: 238.
left hyphen min code: 236, 237, 238.
left noad : 687, 690, 696, 698, 725, 728, 733, 760,
761, 762, 1185, 1188, 1189, 1191.
left right : 208, 1046, 1188, 1189, 1190.
left skip: 224, 827, 880, 887.
\leftskip primitive: 226.
left skip code: 224, 225, 226, 887.
length: 40, 46, 259, 537, 602, 931, 941, 1280.
length of lines: 847.
\leqno primitive: 1141.
let : 209, 1210, 1219, 1220, 1221.
\let primitive: 1219.
500 PART 55: INDEX T
E
X82 1380
letter : 207, 232, 262, 289, 291, 294, 298, 347,
354, 356, 935, 961, 1029, 1030, 1038, 1090,
1124, 1151, 1154, 1160.
letter token: 289, 445.
level : 410, 413, 415, 418, 428, 461.
level boundary: 268, 270, 274, 282.
level one: 221, 228, 232, 254, 264, 272, 277, 278,
279, 280, 281, 283, 780, 1304, 1335, 1369.
level zero: 221, 222, 272, 276, 280.
lf : 540, 560, 565, 566, 575, 576.
lft hit : 906, 907, 908, 910, 911, 1033, 1035, 1040.
lh: 110, 113, 114, 118, 213, 219, 256, 540, 541,
560, 565, 566, 568, 685, 950.
Liang, Franklin Mark: 2, 919.
lig char : 143, 144, 193, 206, 652, 841, 842, 866,
870, 871, 898, 903, 1113.
lig kern: 544, 545, 549.
lig kern base: 550, 552, 557, 566, 571, 573, 576,
1322, 1323.
lig kern command : 541, 545.
lig kern restart : 557, 741, 752, 909, 1039.
lig kern restart end : 557.
lig kern start : 557, 741, 752, 909, 1039.
lig ptr : 143, 144, 175, 193, 202, 206, 896, 898,
903, 907, 910, 911, 1037, 1040.
lig stack : 907, 908, 910, 911, 1032, 1034, 1035,
1036, 1037, 1038, 1040.
lig tag : 544, 569, 741, 752, 909, 1039.
lig trick : 162, 652.
ligature node: 143, 144, 148, 175, 183, 202, 206,
622, 651, 752, 841, 842, 866, 870, 871, 896,
897, 899, 903, 1113, 1121, 1147.
ligature present : 906, 907, 908, 910, 911, 1033,
1035, 1037, 1040.
limit : 300, 302, 303, 307, 318, 328, 330, 331, 343,
348, 350, 351, 352, 354, 355, 356, 360, 362,
363, 483, 537, 538, 1337.
Limit controls must follow... : 1159.
limit eld : 35, 87, 300, 302, 534.
limit switch: 208, 1046, 1156, 1157, 1158.
limits : 682, 696, 733, 749, 1156, 1157.
\limits primitive: 1156.
line: 84, 216, 304, 313, 328, 329, 331, 362, 424,
494, 495, 538, 663, 675, 1025.
line break : 162, 814, 815, 828, 839, 848, 862, 863,
866, 876, 894, 934, 967, 970, 982, 1096, 1145.
line di : 872, 875.
line number : 819, 820, 833, 835, 845, 846, 850,
864, 872, 874, 875.
line penalty: 236, 859.
\linepenalty primitive: 238.
line penalty code: 236, 237, 238.
line skip: 224, 247.
\lineskip primitive: 226.
line skip code: 149, 152, 224, 225, 226, 679.
line skip limit : 247, 679.
\lineskiplimit primitive: 248.
line skip limit code: 247, 248.
line stack : 304, 328, 329.
line width: 830, 850, 851.
link : 118, 120, 121, 122, 123, 124, 125, 126, 130,
133, 134, 135, 140, 143, 150, 164, 168, 172, 174,
175, 176, 182, 202, 204, 212, 214, 218, 223, 233,
292, 295, 306, 319, 323, 339, 357, 358, 366, 369,
371, 374, 389, 390, 391, 394, 396, 397, 400, 407,
452, 464, 466, 467, 470, 478, 489, 495, 496, 497,
508, 605, 607, 609, 611, 615, 620, 622, 630, 649,
651, 652, 654, 655, 666, 669, 679, 681, 689, 705,
711, 715, 718, 719, 720, 721, 727, 731, 732, 735,
737, 738, 739, 747, 748, 751, 752, 753, 754, 755,
756, 759, 760, 761, 766, 767, 770, 772, 778, 779,
783, 784, 786, 790, 791, 793, 794, 795, 796, 797,
798, 799, 801, 802, 803, 804, 805, 806, 807, 808,
809, 812, 814, 816, 819, 821, 822, 829, 830, 837,
840, 843, 844, 845, 854, 857, 858, 860, 861, 862,
863, 864, 865, 866, 867, 869, 873, 874, 875, 877,
879, 880, 881, 882, 883, 884, 885, 886, 887, 888,
890, 894, 896, 897, 898, 899, 903, 905, 906,
907, 908, 910, 911, 913, 914, 915, 916, 917,
918, 932, 938, 960, 968, 969, 970, 973, 979,
980, 981, 986, 988, 991, 994, 998, 999, 1000,
1001, 1005, 1008, 1009, 1014, 1017, 1018, 1019,
1020, 1021, 1022, 1023, 1026, 1035, 1036, 1037,
1040, 1041, 1043, 1064, 1065, 1076, 1081, 1086,
1091, 1100, 1101, 1105, 1110, 1119, 1120, 1121,
1123, 1125, 1146, 1155, 1168, 1181, 1184, 1185,
1186, 1187, 1191, 1194, 1196, 1199, 1204, 1205,
1206, 1226, 1279, 1288, 1297, 1311, 1312, 1335,
1339, 1341, 1349, 1368, 1371, 1375.
list oset : 135, 649, 769, 1018.
list ptr : 135, 136, 184, 202, 206, 619, 623, 629,
632, 658, 663, 664, 668, 673, 676, 709, 711,
715, 721, 739, 747, 751, 807, 977, 979, 1021,
1087, 1100, 1110, 1146, 1199.
list state record : 212, 213.
list tag : 544, 569, 570, 708, 740, 749.
ll : 953, 956.
llink : 124, 126, 127, 129, 130, 131, 145, 149, 164,
169, 772, 819, 821, 1312.
lo mem max : 116, 120, 125, 126, 164, 165, 167,
169, 170, 171, 172, 178, 639, 1311, 1312,
1323, 1334.
lo mem stat max : 162, 164, 1312.
load fmt le: 1303, 1337.
1380 T
E
X82 PART 55: INDEX 501
loc: 36, 37, 87, 300, 302, 303, 307, 312, 314, 318,
319, 323, 325, 328, 330, 331, 343, 348, 350, 351,
352, 354, 356, 357, 358, 360, 362, 369, 390,
483, 524, 537, 538, 1026, 1027, 1337.
loc eld : 35, 36, 300, 302, 1131.
local base: 220, 224, 228, 230, 252.
location: 605, 607, 612, 613, 614, 615.
log le: 54, 56, 75, 534, 1333.
log name: 532, 534, 1333.
log only: 54, 57, 58, 62, 75, 98, 360, 534, 1328,
1370.
log opened : 92, 93, 527, 528, 534, 535, 1265,
1333, 1334.
\long primitive: 1208.
long call : 210, 275, 366, 387, 389, 392, 399, 1295.
long help seen: 1281, 1282, 1283.
long outer call : 210, 275, 366, 387, 389, 1295.
long state: 339, 387, 391, 392, 395, 396, 399.
loop: 15, 16.
Loose \hbox... : 660.
Loose \vbox... : 674.
loose t : 817, 834, 852.
looseness : 236, 848, 873, 875, 1070.
\looseness primitive: 238.
looseness code: 236, 237, 238, 1070.
\lower primitive: 1071.
\lowercase primitive: 1286.
lq : 592, 627, 636.
lr : 592, 627, 636.
lx : 619, 626, 627, 628, 629, 635, 636, 637.
m: 47, 65, 158, 211, 218, 292, 315, 389, 413,
440, 482, 498, 577, 649, 668, 706, 716, 717,
1079, 1105, 1194, 1338.
mac param: 207, 291, 294, 298, 347, 474, 477,
479, 783, 784, 1045.
macro: 307, 314, 319, 323, 324, 390.
macro call : 291, 366, 380, 382, 387, 388, 389, 391.
macro def : 473, 477.
mag : 236, 240, 288, 457, 585, 587, 588, 590,
617, 642.
\mag primitive: 238.
mag code: 236, 237, 238, 288.
mag set : 286, 287, 288.
magic oset : 764, 765, 766.
main control : 1029, 1030, 1032, 1040, 1041, 1052,
1054, 1055, 1056, 1057, 1126, 1134, 1208, 1290,
1332, 1337, 1344, 1347.
main f : 1032, 1034, 1035, 1036, 1037, 1038,
1039, 1040.
main i : 1032, 1036, 1037, 1039, 1040.
main j : 1032, 1039, 1040.
main k : 1032, 1034, 1039, 1040, 1042.
main lig loop: 1030, 1034, 1037, 1038, 1039, 1040.
main loop: 1030.
main loop lookahead : 1030, 1034, 1036, 1037,
1038.
main loop move: 1030, 1034, 1036, 1040.
main loop move lig : 1030, 1034, 1036, 1037.
main loop wrapup: 1030, 1034, 1039, 1040.
main p: 1032, 1035, 1037, 1040, 1041, 1042,
1043, 1044.
main s : 1032, 1034.
major tail : 912, 914, 917, 918.
make accent : 1122, 1123.
make box : 208, 1071, 1072, 1073, 1079, 1084.
make fraction: 733, 734, 743.
make left right : 761, 762.
make mark : 1097, 1101.
make math accent : 733, 738.
make name string : 525.
make op: 733, 749.
make ord : 733, 752.
make over : 733, 734.
make radical : 733, 734, 737.
make scripts : 754, 756.
make string : 43, 48, 52, 260, 517, 525, 939, 1257,
1279, 1328, 1333.
make under : 733, 735.
make vcenter : 733, 736.
mark : 208, 265, 266, 1097.
\mark primitive: 265.
mark node: 141, 148, 175, 183, 202, 206, 647,
651, 730, 761, 866, 899, 968, 973, 979, 1000,
1014, 1101.
mark ptr : 141, 142, 196, 202, 206, 979, 1016, 1101.
mark text : 307, 314, 323, 386.
mastication: 341.
match: 207, 289, 291, 292, 294, 391, 392.
match chr : 292, 294, 389, 391, 400.
match token: 289, 391, 392, 393, 394, 476.
matching : 305, 306, 339, 391.
Math formula deleted... : 1195.
math ac: 1164, 1165.
math accent : 208, 265, 266, 1046, 1164.
\mathaccent primitive: 265.
\mathbin primitive: 1156.
math char : 681, 692, 720, 722, 724, 738, 741, 749,
752, 753, 754, 1151, 1155, 1165.
\mathchar primitive: 265.
\mathchardef primitive: 1222.
math char def code: 1222, 1223, 1224.
math char num: 208, 265, 266, 1046, 1151, 1154.
math choice: 208, 265, 266, 1046, 1171.
\mathchoice primitive: 265.
502 PART 55: INDEX T
E
X82 1380
math choice group: 269, 1172, 1173, 1174.
\mathclose primitive: 1156.
math code: 230, 232, 236, 414, 1151, 1154.
\mathcode primitive: 1230.
math code base: 230, 235, 414, 1230, 1231,
1232, 1233.
math comp: 208, 1046, 1156, 1157, 1158.
math font base: 230, 232, 234, 1230, 1231.
math fraction: 1180, 1181.
math given: 208, 413, 1046, 1151, 1154, 1222,
1223, 1224.
math glue: 716, 732, 766.
math group: 269, 1136, 1150, 1153, 1186.
\mathinner primitive: 1156.
math kern: 717, 730.
math left group: 269, 1065, 1068, 1069, 1150, 1191.
math left right : 1190, 1191.
math limit switch: 1158, 1159.
math node: 147, 148, 175, 183, 202, 206, 622, 651,
817, 837, 866, 879, 881, 1147.
\mathop primitive: 1156.
\mathopen primitive: 1156.
\mathord primitive: 1156.
\mathpunct primitive: 1156.
math quad : 700, 703, 1199.
math radical : 1162, 1163.
\mathrel primitive: 1156.
math shift : 207, 289, 294, 298, 347, 1090, 1137,
1138, 1193, 1197, 1206.
math shift group: 269, 1065, 1068, 1069, 1130,
1139, 1140, 1142, 1145, 1192, 1193, 1194, 1200.
math shift token: 289, 1047, 1065.
math spacing : 764, 765.
math style: 208, 1046, 1169, 1170, 1171.
math surround : 247, 1196.
\mathsurround primitive: 248.
math surround code: 247, 248.
math text char : 681, 752, 753, 754, 755.
math type: 681, 683, 687, 692, 698, 720, 722, 723,
734, 735, 737, 738, 741, 742, 749, 751, 752, 753,
754, 755, 756, 1076, 1093, 1151, 1155, 1165,
1168, 1176, 1181, 1185, 1186, 1191.
math x height : 700, 737, 757, 758, 759.
mathex : 701.
mathsy: 700.
mathsy end : 700.
max answer : 105.
max buf stack : 30, 31, 331, 374, 1334.
max char code: 207, 303, 341, 344, 1233.
max command : 209, 210, 211, 219, 358, 366, 368,
380, 381, 478, 782.
max d : 726, 727, 730, 760, 761, 762.
max dead cycles : 236, 240, 1012.
\maxdeadcycles primitive: 238.
max dead cycles code: 236, 237, 238.
max depth: 247, 980, 987.
\maxdepth primitive: 248.
max depth code: 247, 248.
max dimen: 421, 460, 641, 668, 1010, 1017,
1145, 1146, 1148.
max group code: 269.
max h: 592, 593, 641, 642, 726, 727, 730, 760,
761, 762.
max halfword : 11, 14, 110, 111, 113, 124, 125,
126, 131, 132, 289, 290, 424, 820, 848, 850, 982,
991, 996, 1017, 1106, 1249, 1323, 1325, 1335.
max in open: 11, 14, 304, 328.
max in stack : 301, 321, 331, 1334.
max internal : 209, 413, 440, 448, 455, 461.
max nest stack : 213, 215, 216, 1334.
max non prexed command : 208, 1211, 1270.
max param stack : 308, 331, 390, 1334.
max print line: 11, 14, 54, 58, 61, 72, 176, 537,
638, 1280.
max push: 592, 593, 619, 629, 642.
max quarterword : 11, 110, 111, 113, 274, 797,
798, 944, 1120, 1325.
max save stack : 271, 272, 273, 1334.
max selector : 54, 246, 311, 465, 470, 534, 638,
1257, 1279, 1368, 1370.
max strings : 11, 38, 43, 111, 517, 525, 1310, 1334.
max v : 592, 593, 641, 642.
\meaning primitive: 468.
meaning code: 468, 469, 471, 472.
med mu skip: 224.
\medmuskip primitive: 226.
med mu skip code: 224, 225, 226, 766.
mem: 11, 12, 115, 116, 118, 124, 126, 131, 133,
134, 135, 140, 141, 150, 151, 157, 159, 162,
163, 164, 165, 167, 172, 182, 186, 203, 205,
206, 221, 224, 275, 291, 387, 420, 489, 605,
652, 680, 681, 683, 686, 687, 720, 725, 742,
753, 769, 770, 772, 797, 816, 818, 819, 822,
823, 832, 843, 844, 847, 848, 850, 860, 861,
889, 925, 1149, 1151, 1160, 1163, 1165, 1181,
1186, 1247, 1248, 1311, 1312, 1339.
mem bot : 11, 12, 14, 111, 116, 125, 126, 162, 164,
1307, 1308, 1311, 1312.
mem end : 116, 118, 120, 164, 165, 167, 168, 171,
172, 174, 176, 182, 293, 1311, 1312, 1334.
mem max : 11, 12, 14, 110, 111, 116, 120, 124,
125, 165, 166.
mem min: 11, 12, 111, 116, 120, 125, 165, 166,
167, 169, 170, 171, 172, 174, 178, 182, 1249,
1380 T
E
X82 PART 55: INDEX 503
1312, 1334.
mem top: 11, 12, 14, 111, 116, 162, 164, 1249,
1307, 1308, 1312.
Memory usage... : 639.
memory word : 110, 113, 114, 116, 182, 212, 218,
221, 253, 268, 271, 275, 548, 549, 800, 1305.
message: 208, 1276, 1277, 1278.
\message primitive: 1277.
METAFONT: 589.
mid : 546.
mid line: 87, 303, 328, 344, 347, 352, 353, 354.
min halfword : 11, 110, 111, 112, 113, 115, 230,
1027, 1323, 1325.
min internal : 208, 413, 440, 448, 455, 461.
min quarterword : 12, 110, 111, 112, 113, 134, 136,
140, 185, 221, 274, 549, 550, 554, 556, 557, 566,
576, 649, 668, 685, 697, 707, 713, 714, 796, 801,
803, 808, 920, 923, 924, 943, 944, 945, 946, 958,
963, 964, 965, 994, 1012, 1323, 1324, 1325.
minimal demerits : 833, 834, 836, 845, 855.
minimum demerits : 833, 834, 835, 836, 854, 855.
minor tail : 912, 915, 916.
minus : 462.
Misplaced & : 1128.
Misplaced \cr : 1128.
Misplaced \noalign : 1129.
Misplaced \omit : 1129.
Misplaced \span : 1128.
Missing = inserted : 503.
Missing # inserted... : 783.
Missing $ inserted : 1047, 1065.
Missing \cr inserted : 1132.
Missing \endcsname... : 373.
Missing \endgroup inserted : 1065.
Missing \right. inserted : 1065.
Missing { inserted : 403, 475, 1127.
Missing } inserted : 1065, 1127.
Missing to inserted : 1082.
Missing to... : 1225.
Missing $$ inserted : 1207.
Missing character : 581.
Missing control... : 1215.
Missing delimiter... : 1161.
Missing font identifier : 577.
Missing number... : 415, 446.
mkern: 208, 1046, 1057, 1058, 1059.
\mkern primitive: 1058.
ml eld : 212, 213, 218.
mlist : 726, 760.
mlist penalties : 719, 720, 726, 754, 1194, 1196,
1199.
mlist to hlist : 693, 719, 720, 725, 726, 734, 754,
760, 1194, 1196, 1199.
mm : 458.
mmode: 211, 212, 213, 218, 501, 718, 775, 776,
800, 812, 1030, 1045, 1046, 1048, 1056, 1057,
1073, 1080, 1092, 1097, 1109, 1110, 1112,
1116, 1120, 1130, 1136, 1140, 1145, 1150,
1154, 1158, 1162, 1164, 1167, 1171, 1175,
1180, 1190, 1193, 1194.
mode: 211, 212, 213, 215, 216, 299, 418, 422, 424,
501, 718, 775, 776, 785, 786, 787, 796, 799,
804, 807, 808, 809, 812, 1025, 1029, 1030, 1034,
1035, 1049, 1051, 1056, 1076, 1078, 1080, 1083,
1086, 1091, 1093, 1094, 1095, 1096, 1099, 1103,
1105, 1110, 1117, 1119, 1120, 1136, 1138, 1145,
1167, 1194, 1196, 1200, 1243, 1370, 1371, 1377.
mode eld : 212, 213, 218, 422, 800, 1244.
mode line: 212, 213, 215, 216, 304, 804, 815, 1025.
month: 236, 241, 536, 617, 1328.
\month primitive: 238.
month code: 236, 237, 238.
months : 534, 536.
more name: 512, 516, 526, 531.
\moveleft primitive: 1071.
move past : 619, 622, 625, 629, 631, 634.
\moveright primitive: 1071.
movement : 607, 609, 616.
movement node size: 605, 607, 615.
mskip: 208, 1046, 1057, 1058, 1059.
\mskip primitive: 1058.
mskip code: 1058, 1060.
mstate: 607, 611, 612.
mtype: 4.
mu: 447, 448, 449, 453, 455, 461, 462.
mu : 456.
mu error : 408, 429, 449, 455, 461.
mu glue: 149, 155, 191, 424, 717, 732, 1058,
1060, 1061.
mu mult : 716, 717.
mu skip: 224, 427.
\muskip primitive: 411.
mu skip base: 224, 227, 229, 1224, 1237.
\muskipdef primitive: 1222.
mu skip def code: 1222, 1223, 1224.
mu val : 410, 411, 413, 424, 427, 429, 430, 449,
451, 455, 461, 465, 1060, 1228, 1236, 1237.
mult and add : 105.
mult integers : 105, 1240.
multiply: 209, 265, 266, 1210, 1235, 1236, 1240.
\multiply primitive: 265.
Must increase the x : 1303.
504 PART 55: INDEX T
E
X82 1380
n: 47, 65, 66, 67, 69, 91, 94, 105, 106, 107, 152,
154, 174, 182, 225, 237, 247, 252, 292, 315, 389,
482, 498, 518, 519, 523, 578, 706, 716, 717, 791,
800, 906, 934, 944, 977, 992, 993, 994, 1012,
1079, 1119, 1138, 1211, 1275, 1338.
name: 300, 302, 303, 304, 307, 311, 313, 314, 323,
328, 329, 331, 337, 360, 390, 483, 537.
name eld : 84, 300, 302.
name in progress : 378, 526, 527, 528, 1258.
name length: 26, 51, 519, 523, 525.
name of le: 26, 27, 51, 519, 523, 525, 530.
natural : 644, 705, 715, 720, 727, 735, 737, 738,
748, 754, 756, 759, 796, 799, 806, 977, 1021,
1100, 1125, 1194, 1199, 1204.
nd : 540, 541, 560, 565, 566, 569.
ne: 540, 541, 560, 565, 566, 569.
negate: 16, 65, 103, 105, 106, 107, 430, 431,
440, 448, 461, 775.
negative: 106, 413, 430, 440, 441, 448, 461.
nest : 212, 213, 216, 217, 218, 219, 413, 422,
775, 800, 995, 1244.
nest ptr : 213, 215, 216, 217, 218, 422, 775, 800,
995, 1017, 1023, 1091, 1100, 1145, 1200, 1244.
nest size: 11, 213, 216, 218, 413, 1244, 1334.
new character : 582, 755, 915, 1117, 1123, 1124.
new choice: 689, 1172.
new delta from break width: 844.
new delta to break width: 843.
new disc: 145, 1035, 1117.
new font : 1256, 1257.
new glue: 153, 154, 715, 766, 786, 793, 795, 809,
1041, 1043, 1054, 1060, 1171.
new graf : 1090, 1091.
new hlist : 725, 727, 743, 748, 749, 750, 754,
756, 762, 767.
new hyph exceptions : 934, 1252.
new interaction: 1264, 1265.
new kern: 156, 705, 715, 735, 738, 739, 747,
751, 753, 755, 759, 910, 1040, 1061, 1112,
1113, 1125, 1204.
new lig item: 144, 911, 1040.
new ligature: 144, 910, 1035.
new line: 303, 331, 343, 344, 345, 347, 483, 537.
new line char : 59, 236, 244.
\newlinechar primitive: 238.
new line char code: 236, 237, 238.
new math: 147, 1196.
new noad : 686, 720, 742, 753, 1076, 1093, 1150,
1155, 1158, 1168, 1177, 1191.
new null box : 136, 706, 709, 713, 720, 747, 750,
779, 793, 809, 1018, 1054, 1091, 1093.
new param glue: 152, 154, 679, 778, 816, 886, 887,
1041, 1043, 1091, 1203, 1205, 1206.
new patterns : 960, 1252.
new penalty: 158, 767, 816, 890, 1054, 1103,
1203, 1205, 1206.
new rule: 139, 463, 666, 704.
new save level : 274, 645, 774, 785, 791, 1025,
1063, 1099, 1117, 1119, 1136.
new skip param: 154, 679, 969, 1001.
new spec: 151, 154, 430, 462, 826, 976, 1004,
1042, 1043, 1239, 1240.
new string : 54, 57, 58, 465, 470, 617, 1257,
1279, 1328, 1368.
new style: 688, 1171.
new trie op: 943, 944, 945, 965.
new whatsit : 1349, 1350, 1354, 1376, 1377.
new write whatsit : 1350, 1351, 1352, 1353.
next : 256, 257, 259, 260.
next break : 877, 878.
next char : 545, 741, 753, 909, 1039.
next p: 619, 622, 626, 629, 630, 631, 633, 635.
nh: 540, 541, 560, 565, 566, 569.
ni : 540, 541, 560, 565, 566, 569.
nil: 16.
nk : 540, 541, 560, 565, 566, 573.
nl : 59, 540, 541, 545, 560, 565, 566, 569, 573, 576.
nn: 311, 312.
No pages of output : 642.
no align: 208, 265, 266, 785, 1126.
\noalign primitive: 265.
no align error : 1126, 1129.
no align group: 269, 768, 785, 1133.
no boundary: 208, 265, 266, 1030, 1038, 1045,
1090.
\noboundary primitive: 265.
no break yet : 829, 836, 837.
no expand : 210, 265, 266, 366, 367.
\noexpand primitive: 265.
no expand ag : 358, 506.
\noindent primitive: 1088.
no limits : 682, 1156, 1157.
\nolimits primitive: 1156.
no new control sequence: 256, 257, 259, 264,
365, 374, 1336.
no print : 54, 57, 58, 75, 98.
no shrink error yet : 825, 826, 827.
no tag : 544, 569.
noad size: 681, 686, 698, 753, 761, 1186, 1187.
node list display: 180, 184, 188, 190, 195, 197.
node r stays active: 830, 851, 854.
node size: 124, 126, 127, 128, 130, 164, 169,
1311, 1312.
1380 T
E
X82 PART 55: INDEX 505
nom: 560, 561, 563, 576.
non address : 549, 552, 576, 909, 916, 1034.
non char : 549, 552, 576, 897, 898, 901, 908, 909,
910, 911, 915, 916, 917, 1032, 1034, 1035,
1038, 1039, 1040, 1323.
non discardable: 148, 879.
non math: 1046, 1063, 1144.
non script : 208, 265, 266, 1046, 1171.
\nonscript primitive: 265, 732.
none seen: 611, 612.
NONEXISTENT : 262.
Nonletter : 962.
nonnegative integer : 69, 101, 107.
nonstop mode: 73, 86, 360, 363, 484, 1262, 1263.
\nonstopmode primitive: 1262.
nop: 583, 585, 586, 588, 590.
norm min: 1091, 1200, 1376, 1377.
normal : 135, 136, 149, 150, 153, 155, 156, 164,
177, 186, 189, 191, 305, 331, 336, 369, 439, 448,
471, 473, 480, 482, 485, 489, 490, 507, 619, 625,
629, 634, 650, 657, 658, 659, 660, 664, 665, 666,
667, 672, 673, 674, 676, 677, 678, 682, 686, 696,
716, 732, 749, 777, 801, 810, 811, 825, 826,
896, 897, 899, 976, 988, 1004, 1009, 1156, 1163,
1165, 1181, 1201, 1219, 1220, 1221, 1239.
normal paragraph: 774, 785, 787, 1025, 1070,
1083, 1094, 1096, 1099, 1167.
normalize selector : 78, 92, 93, 94, 95, 863.
Not a letter : 937.
not found : 15, 45, 46, 448, 455, 560, 570, 607,
611, 612, 895, 930, 931, 934, 941, 953, 955,
970, 972, 973, 1138, 1146, 1365.
notexpanded: : 258.
np: 540, 541, 560, 565, 566, 575, 576.
nucleus : 681, 682, 683, 686, 687, 690, 696, 698,
720, 725, 734, 735, 736, 737, 738, 741, 742, 749,
750, 752, 753, 754, 755, 1076, 1093, 1150, 1151,
1155, 1158, 1163, 1165, 1168, 1186, 1191.
null : 115, 116, 118, 120, 122, 123, 125, 126, 135,
136, 144, 145, 149, 150, 151, 152, 153, 154, 164,
168, 169, 175, 176, 182, 200, 201, 202, 204, 210,
212, 218, 219, 222, 223, 232, 233, 275, 292, 295,
306, 307, 312, 314, 325, 331, 357, 358, 371, 374,
382, 383, 386, 390, 391, 392, 397, 400, 407, 410,
420, 423, 452, 464, 466, 473, 478, 482, 489, 490,
497, 505, 508, 549, 552, 576, 578, 582, 606, 611,
615, 619, 623, 629, 632, 648, 649, 651, 655, 658,
664, 666, 668, 673, 676, 681, 685, 689, 692, 715,
718, 719, 720, 721, 726, 731, 732, 752, 754, 755,
756, 760, 761, 766, 767, 771, 774, 776, 777, 783,
784, 789, 790, 791, 792, 794, 796, 797, 799, 801,
804, 805, 806, 807, 812, 821, 829, 837, 840, 846,
847, 848, 850, 856, 857, 858, 859, 863, 864, 865,
867, 869, 872, 877, 878, 879, 881, 882, 883,
884, 885, 887, 888, 889, 894, 896, 898, 903,
906, 907, 908, 910, 911, 913, 914, 915, 916,
917, 918, 928, 932, 935, 968, 969, 970, 972,
973, 977, 978, 979, 981, 991, 992, 993, 994,
998, 999, 1000, 1009, 1010, 1011, 1012, 1014,
1015, 1016, 1017, 1018, 1020, 1021, 1022, 1023,
1026, 1027, 1028, 1030, 1032, 1035, 1036, 1037,
1038, 1040, 1042, 1043, 1070, 1074, 1075, 1076,
1079, 1080, 1081, 1083, 1087, 1091, 1105, 1110,
1121, 1123, 1124, 1131, 1136, 1139, 1145, 1146,
1149, 1167, 1174, 1176, 1181, 1184, 1185, 1186,
1194, 1196, 1199, 1202, 1205, 1206, 1226, 1227,
1247, 1248, 1283, 1288, 1296, 1311, 1312, 1335,
1339, 1353, 1354, 1368, 1369, 1375.
null delimiter: 240, 1065.
null character : 555, 556, 722, 723.
null code: 22, 232.
null cs : 222, 262, 263, 354, 374, 1257.
null delimiter : 684, 685, 1181.
null delimiter space: 247, 706.
\nulldelimiterspace primitive: 248.
null delimiter space code: 247, 248.
null ag : 138, 139, 463, 653, 779, 793, 801.
null font : 232, 552, 553, 560, 577, 617, 663, 706,
707, 722, 864, 1257, 1320, 1321, 1339.
\nullfont primitive: 553.
null list : 14, 162, 380, 780.
num: 450, 458, 585, 587, 590.
num style: 702, 744.
Number too big : 445.
\number primitive: 468.
number code: 468, 469, 470, 471, 472.
numerator : 683, 690, 697, 698, 744, 1181, 1185.
num1 : 700, 744.
num2 : 700, 744.
num3 : 700, 744.
nw: 540, 541, 560, 565, 566, 569.
nx plus y: 105, 455, 716, 1240.
o: 264, 607, 649, 668, 791, 800.
octal token: 438, 444.
odd : 62, 100, 193, 504, 758, 898, 902, 908, 909,
913, 914, 1211, 1218.
o save: 1063, 1064, 1094, 1095, 1130, 1131,
1140, 1192, 1193.
OK : 1298.
OK so far : 440, 445.
OK to interrupt : 88, 96, 97, 98, 327, 1031.
old l : 829, 835, 850.
old mode: 1370, 1371.
old rover : 131.
506 PART 55: INDEX T
E
X82 1380
old setting : 245, 246, 311, 312, 465, 470, 534, 617,
638, 1257, 1279, 1368, 1370.
omit : 208, 265, 266, 788, 789, 1126.
\omit primitive: 265.
omit error : 1126, 1129.
omit template: 162, 789, 790.
Only one # is allowed... : 784.
op byte: 545, 557, 741, 753, 909, 911, 1040.
op noad : 682, 690, 696, 698, 726, 728, 733, 749,
761, 1156, 1157, 1159.
op start : 920, 921, 924, 945, 1325.
open area: 1341, 1351, 1356, 1374.
open ext : 1341, 1351, 1356, 1374.
open fmt le: 524, 1337.
\openin primitive: 1272.
open log le: 78, 92, 360, 471, 532, 534, 535,
537, 1257, 1335.
open name: 1341, 1351, 1356, 1374.
open noad : 682, 690, 696, 698, 728, 733, 761,
762, 1156, 1157.
open node: 1341, 1344, 1346, 1348, 1356, 1357,
1358, 1373.
open node size: 1341, 1351, 1357, 1358.
open or close in: 1274, 1275.
\openout primitive: 1344.
open parens : 304, 331, 362, 537, 1335.
\or primitive: 491.
or code: 489, 491, 492, 500, 509.
ord : 20.
ord noad : 681, 682, 686, 687, 690, 696, 698, 728,
729, 733, 752, 753, 761, 764, 765, 1075, 1155,
1156, 1157, 1186.
order : 177.
oriental characters: 134, 585.
other A token: 445.
other char : 207, 232, 289, 291, 294, 298, 347,
445, 464, 526, 935, 961, 1030, 1038, 1090,
1124, 1151, 1154, 1160.
other token: 289, 405, 438, 441, 445, 464, 503,
1065, 1221.
othercases: 10.
others : 10.
Ouch...clobbered : 1332.
out param: 207, 289, 291, 294, 357.
out param token: 289, 479.
out what : 1366, 1367, 1373, 1375.
\outer primitive: 1208.
outer call : 210, 275, 339, 351, 353, 354, 357, 366,
387, 391, 396, 780, 1152, 1295, 1369.
outer doing leaders : 619, 628, 629, 637.
output : 4.
Output loop... : 1024.
Output routine didnt use... : 1028.
Output written on x : 642.
\output primitive: 230.
output active: 421, 663, 675, 986, 989, 990, 994,
1005, 1025, 1026.
output le name: 532, 533, 642.
output group: 269, 1025, 1100.
output penalty: 236.
\outputpenalty primitive: 238.
output penalty code: 236, 237, 238, 1013.
output routine: 230, 1012, 1025.
output routine loc: 230, 231, 232, 307, 323, 1226.
output text : 307, 314, 323, 1025, 1026.
\over primitive: 1178.
over code: 1178, 1179, 1182.
over noad : 687, 690, 696, 698, 733, 761, 1156.
\overwithdelims primitive: 1178.
overbar : 705, 734, 737.
overow: 35, 42, 43, 94, 120, 125, 216, 260,
273, 274, 321, 328, 374, 390, 517, 580, 940,
944, 954, 964, 1333.
overow in arithmetic: 9, 104.
Overfull \hbox... : 666.
Overfull \vbox... : 677.
overfull boxes: 854.
overfull rule: 247, 666, 800, 804.
\overfullrule primitive: 248.
overfull rule code: 247, 248.
\overline primitive: 1156.
p: 120, 123, 125, 130, 131, 136, 139, 144, 145, 147,
151, 152, 153, 154, 156, 158, 167, 172, 174, 176,
178, 182, 198, 200, 201, 202, 204, 218, 259, 262,
263, 276, 277, 278, 279, 281, 284, 292, 295, 306,
315, 323, 325, 336, 366, 389, 407, 413, 450, 464,
465, 473, 482, 497, 498, 582, 607, 615, 619, 629,
638, 649, 668, 679, 686, 688, 689, 691, 692, 704,
705, 709, 711, 715, 716, 717, 720, 726, 735, 738,
743, 749, 752, 756, 772, 774, 787, 791, 799, 800,
826, 906, 934, 948, 949, 953, 957, 959, 960,
966, 968, 970, 993, 994, 1012, 1064, 1068, 1075,
1079, 1086, 1093, 1101, 1105, 1110, 1113, 1119,
1123, 1138, 1151, 1155, 1160, 1174, 1176, 1184,
1191, 1194, 1211, 1236, 1244, 1288, 1293, 1302,
1303, 1348, 1349, 1355, 1368, 1370, 1373.
pack begin line: 661, 662, 663, 675, 804, 815.
pack buered name: 523, 524.
pack cur name: 529, 530, 537, 1275, 1374.
pack le name: 519, 529, 537, 563.
pack job name: 529, 532, 534, 1328.
pack lig : 1035.
package: 1085, 1086.
packed ASCII code: 38, 39, 947.
1380 T
E
X82 PART 55: INDEX 507
page: 304.
page contents : 421, 980, 986, 987, 991, 1000,
1001, 1008.
page depth: 982, 987, 991, 1002, 1003, 1004,
1008, 1010.
\pagedepth primitive: 983.
\pagefilstretch primitive: 983.
\pagefillstretch primitive: 983.
\pagefilllstretch primitive: 983.
page goal : 980, 982, 986, 987, 1005, 1006, 1007,
1008, 1009, 1010.
\pagegoal primitive: 983.
page head : 162, 215, 980, 986, 988, 991, 1014,
1017, 1023, 1026, 1054.
page ins head : 162, 981, 986, 1005, 1008, 1018,
1019, 1020.
page ins node size: 981, 1009, 1019.
page loc: 638, 640.
page max depth: 980, 982, 987, 991, 1003, 1017.
page shrink : 982, 985, 1004, 1007, 1008, 1009.
\pageshrink primitive: 983.
page so far : 421, 982, 985, 987, 1004, 1007,
1009, 1245.
page stack : 304.
\pagestretch primitive: 983.
page tail : 215, 980, 986, 991, 998, 1000, 1017,
1023, 1026, 1054.
page total : 982, 985, 1002, 1003, 1004, 1007,
1008, 1010.
\pagetotal primitive: 983.
panicking : 165, 166, 1031, 1339.
\par primitive: 334.
par end : 207, 334, 335, 1046, 1094.
par ll skip: 224, 816.
\parfillskip primitive: 226.
par ll skip code: 224, 225, 226, 816.
par indent : 247, 1091, 1093.
\parindent primitive: 248.
par indent code: 247, 248.
par loc: 333, 334, 351, 1313, 1314.
\parshape primitive: 265.
par shape loc: 230, 232, 233, 1070, 1248.
par shape ptr : 230, 232, 233, 423, 814, 847, 848,
850, 889, 1070, 1149, 1249.
par skip: 224, 1091.
\parskip primitive: 226.
par skip code: 224, 225, 226, 1091.
par token: 333, 334, 339, 392, 395, 399, 1095, 1314.
Paragraph ended before... : 396.
param: 542, 547, 558.
param base: 550, 552, 558, 566, 574, 575, 576,
578, 580, 700, 701, 1042, 1322, 1323.
param end : 558.
param ptr : 308, 323, 324, 331, 390.
param size: 11, 308, 390, 1334.
param stack : 307, 308, 324, 359, 388, 389, 390.
param start : 307, 323, 324, 359.
parameter : 307, 314, 359.
parameters for symbols: 700, 701.
Parameters...consecutively : 476.
Pascal-H: 3, 4, 9, 10, 27, 28, 33, 34.
Pascal: 1, 10, 693, 764.
pass number : 821, 845, 864.
pass text : 366, 494, 500, 509, 510.
passive: 821, 845, 846, 864, 865.
passive node size: 821, 845, 865.
Patterns can be... : 1252.
\patterns primitive: 1250.
pause for instructions : 96, 98.
pausing : 236, 363.
\pausing primitive: 238.
pausing code: 236, 237, 238.
pc : 458.
pen: 726, 761, 767, 877, 890.
penalties: 1102.
penalties : 726, 767.
penalty: 157, 158, 194, 424, 816, 866, 973, 996,
1000, 1010, 1011, 1013.
\penalty primitive: 265.
penalty node: 157, 158, 183, 202, 206, 424, 730,
761, 767, 816, 817, 837, 856, 866, 879, 899, 968,
973, 996, 1000, 1010, 1011, 1013, 1107.
pg eld : 212, 213, 218, 219, 422, 1244.
pi : 829, 831, 851, 856, 859, 970, 972, 973, 974,
994, 1000, 1005, 1006.
plain : 521, 524, 1331.
Plass, Michael Frederick: 2, 813.
Please type... : 360, 530.
Please use \mathaccent... : 1166.
PLtoTF : 561.
plus : 462.
point token: 438, 440, 448, 452.
pointer : 115, 116, 118, 120, 123, 124, 125, 130,
131, 136, 139, 144, 145, 147, 151, 152, 153, 154,
156, 158, 165, 167, 172, 198, 200, 201, 202, 204,
212, 218, 252, 256, 259, 263, 275, 276, 277, 278,
279, 281, 284, 295, 297, 305, 306, 308, 323, 325,
333, 336, 366, 382, 388, 389, 407, 450, 461, 463,
464, 465, 473, 482, 489, 497, 498, 549, 560, 582,
592, 605, 607, 615, 619, 629, 638, 647, 649, 668,
679, 686, 688, 689, 691, 692, 704, 705, 706, 709,
711, 715, 716, 717, 719, 720, 722, 726, 734, 735,
736, 737, 738, 743, 749, 752, 756, 762, 770, 772,
774, 787, 791, 799, 800, 814, 821, 826, 828, 829,
508 PART 55: INDEX T
E
X82 1380
830, 833, 862, 872, 877, 892, 900, 901, 906, 907,
912, 926, 934, 968, 970, 977, 980, 982, 993, 994,
1012, 1032, 1043, 1064, 1068, 1074, 1075, 1079,
1086, 1093, 1101, 1105, 1110, 1113, 1119, 1123,
1138, 1151, 1155, 1160, 1174, 1176, 1184, 1191,
1194, 1198, 1211, 1236, 1257, 1288, 1293, 1302,
1303, 1345, 1348, 1349, 1355, 1368, 1370, 1373.
Poirot, Hercule: 1283.
pool le: 47, 50, 51, 52, 53.
pool name: 11, 51.
pool pointer : 38, 39, 45, 46, 59, 60, 69, 70,
264, 407, 464, 465, 470, 513, 519, 602, 638,
929, 934, 1368.
pool ptr : 38, 39, 41, 42, 43, 44, 47, 52, 58, 70,
198, 260, 464, 465, 470, 516, 525, 617, 1309,
1310, 1332, 1334, 1339, 1368.
pool size: 11, 38, 42, 52, 58, 198, 525, 1310,
1334, 1339, 1368.
pop: 584, 585, 586, 590, 601, 608, 642.
pop alignment : 772, 800.
pop input : 322, 324, 329.
pop lig stack : 910, 911.
pop nest : 217, 796, 799, 812, 816, 1026, 1086,
1096, 1100, 1119, 1145, 1168, 1184, 1206.
positive: 107.
post : 583, 585, 586, 590, 591, 642.
post break : 145, 175, 195, 202, 206, 840, 858,
882, 884, 916, 1119.
post disc break : 877, 881, 884.
post display penalty: 236, 1205, 1206.
\postdisplaypenalty primitive: 238.
post display penalty code: 236, 237, 238.
post line break : 876, 877.
post post : 585, 586, 590, 591, 642.
pre: 583, 585, 586, 617.
pre break : 145, 175, 195, 202, 206, 858, 869, 882,
885, 915, 1117, 1119.
pre display penalty: 236, 1203, 1206.
\predisplaypenalty primitive: 238.
pre display penalty code: 236, 237, 238.
pre display size: 247, 1138, 1145, 1148, 1203.
\predisplaysize primitive: 248.
pre display size code: 247, 248, 1145.
preamble: 768, 774.
preamble: 770, 771, 772, 777, 786, 801, 804.
preamble of DVI le: 617.
precedes break : 148, 868, 973, 1000.
prex : 209, 1208, 1209, 1210, 1211.
prexed command : 1210, 1211, 1270.
prepare mag : 288, 457, 617, 642, 1333.
pretolerance: 236, 828, 863.
\pretolerance primitive: 238.
pretolerance code: 236, 237, 238.
prev break : 821, 845, 846, 877, 878.
prev depth: 212, 213, 215, 418, 679, 775, 786, 787,
1025, 1056, 1083, 1099, 1167, 1206, 1242, 1243.
\prevdepth primitive: 416.
prev dp: 970, 972, 973, 974, 976.
prev graf : 212, 213, 215, 216, 422, 814, 816, 864,
877, 890, 1091, 1149, 1200, 1242.
\prevgraf primitive: 265.
prev p: 862, 863, 866, 867, 868, 869, 968, 969,
970, 973, 1012, 1014, 1017, 1022.
prev prev r : 830, 832, 843, 844, 860.
prev r : 829, 830, 832, 843, 844, 845, 851, 854, 860.
prev s : 862, 894, 896.
primitive: 226, 230, 238, 248, 264, 265, 266, 298,
334, 376, 384, 411, 416, 468, 487, 491, 553,
780, 983, 1052, 1058, 1071, 1088, 1107, 1114,
1141, 1156, 1169, 1178, 1188, 1208, 1219,
1222, 1230, 1250, 1254, 1262, 1272, 1277, 1286,
1291, 1331, 1332, 1344.
print : 54, 59, 60, 62, 63, 68, 70, 71, 73, 84, 85,
86, 89, 91, 94, 95, 175, 177, 178, 182, 183, 184,
185, 186, 187, 188, 190, 191, 192, 193, 195, 211,
218, 219, 225, 233, 234, 237, 247, 251, 262, 263,
284, 288, 294, 298, 299, 306, 317, 318, 323, 336,
338, 339, 363, 373, 395, 396, 398, 400, 428, 454,
456, 459, 465, 472, 502, 509, 530, 534, 536,
561, 567, 579, 581, 617, 638, 639, 642, 660,
663, 666, 674, 675, 677, 692, 694, 697, 723,
776, 846, 856, 936, 978, 985, 986, 987, 1006,
1011, 1015, 1024, 1049, 1064, 1095, 1132, 1166,
1213, 1232, 1237, 1257, 1259, 1261, 1295, 1296,
1298, 1309, 1311, 1318, 1320, 1322, 1324, 1328,
1334, 1335, 1338, 1339, 1346, 1356.
print ASCII : 68, 174, 176, 298, 581, 691, 723.
print char : 58, 59, 60, 64, 65, 66, 67, 69, 70, 82,
91, 94, 95, 103, 114, 171, 172, 174, 175, 176,
177, 178, 184, 186, 187, 188, 189, 190, 191, 193,
218, 219, 223, 229, 233, 234, 235, 242, 251, 252,
255, 262, 284, 285, 294, 296, 299, 306, 313, 317,
362, 472, 509, 536, 537, 561, 581, 617, 638, 639,
642, 691, 723, 846, 856, 933, 1006, 1011, 1065,
1069, 1212, 1213, 1280, 1294, 1296, 1311, 1320,
1322, 1324, 1328, 1333, 1335, 1340, 1355, 1356.
print cmd chr : 223, 233, 266, 296, 298, 299, 323,
336, 418, 428, 503, 510, 1049, 1066, 1128, 1212,
1213, 1237, 1335, 1339.
print cs : 262, 293, 314, 401.
print current string : 70, 182, 692.
print delimiter : 691, 696, 697.
print err : 72, 73, 93, 94, 95, 98, 288, 336, 338,
346, 370, 373, 395, 396, 398, 403, 408, 415, 418,
1380 T
E
X82 PART 55: INDEX 509
428, 433, 434, 435, 436, 437, 442, 445, 446, 454,
456, 459, 460, 475, 476, 479, 486, 500, 503,
510, 530, 561, 577, 579, 641, 723, 776, 783,
784, 792, 826, 936, 937, 960, 961, 962, 963,
976, 978, 993, 1004, 1009, 1015, 1024, 1027,
1028, 1047, 1049, 1064, 1066, 1068, 1069, 1078,
1082, 1084, 1095, 1099, 1110, 1120, 1121, 1127,
1128, 1129, 1132, 1135, 1159, 1161, 1166, 1177,
1183, 1192, 1195, 1197, 1207, 1212, 1213, 1215,
1225, 1232, 1236, 1237, 1241, 1243, 1244, 1252,
1258, 1259, 1283, 1298, 1304, 1372.
print esc: 63, 86, 176, 184, 187, 188, 189, 190,
191, 192, 194, 195, 196, 197, 225, 227, 229, 231,
233, 234, 235, 237, 239, 242, 247, 249, 251, 262,
263, 266, 267, 292, 293, 294, 323, 335, 373, 377,
385, 412, 417, 428, 469, 486, 488, 492, 500, 579,
691, 694, 695, 696, 697, 699, 776, 781, 792, 856,
936, 960, 961, 978, 984, 986, 1009, 1015, 1028,
1053, 1059, 1065, 1069, 1072, 1089, 1095, 1099,
1108, 1115, 1120, 1129, 1132, 1135, 1143, 1157,
1166, 1179, 1189, 1192, 1209, 1213, 1220, 1223,
1231, 1241, 1244, 1251, 1255, 1263, 1273, 1278,
1287, 1292, 1295, 1322, 1335, 1346, 1355, 1356.
print fam and char : 691, 692, 696.
print le name: 518, 530, 561, 1322, 1356.
print font and char : 176, 183, 193.
print glue: 177, 178, 185, 186.
print hex : 67, 691, 1223.
print int : 65, 84, 91, 94, 103, 114, 168, 169, 170,
171, 172, 185, 188, 194, 195, 218, 219, 227, 229,
231, 233, 234, 235, 239, 242, 249, 251, 255, 285,
288, 313, 336, 400, 465, 472, 509, 536, 561, 579,
617, 638, 639, 642, 660, 663, 667, 674, 675, 678,
691, 723, 846, 856, 933, 986, 1006, 1009, 1011,
1024, 1028, 1099, 1232, 1296, 1309, 1311, 1318,
1320, 1324, 1328, 1335, 1339, 1355, 1356.
print length param: 247, 249, 251.
print ln: 57, 58, 59, 61, 62, 71, 86, 89, 90, 114,
182, 198, 218, 236, 245, 296, 306, 314, 317, 330,
360, 363, 401, 484, 534, 537, 638, 639, 660, 663,
666, 667, 674, 675, 677, 678, 692, 986, 1265,
1280, 1309, 1311, 1318, 1320, 1324, 1340, 1370.
print locs : 167.
print mark : 176, 196, 1356.
print meaning : 296, 472, 1294.
print mode: 211, 218, 299, 1049.
print nl : 62, 73, 82, 84, 85, 90, 168, 169, 170, 171,
172, 218, 219, 245, 255, 285, 288, 299, 306,
311, 313, 314, 323, 360, 400, 530, 534, 581,
638, 639, 641, 642, 660, 666, 667, 674, 677,
678, 846, 856, 857, 863, 933, 986, 987, 992,
1006, 1011, 1121, 1294, 1296, 1297, 1322, 1324,
1328, 1333, 1335, 1338, 1370.
print param: 237, 239, 242.
print plus : 985.
print plus end : 985.
print roman int : 69, 472.
print rule dimen: 176, 187.
print scaled : 103, 114, 176, 177, 178, 184, 188,
191, 192, 219, 251, 465, 472, 561, 666, 677, 697,
985, 986, 987, 1006, 1011, 1259, 1261, 1322.
print size: 699, 723, 1231.
print skip param: 189, 225, 227, 229.
print spec: 178, 188, 189, 190, 229, 465.
print style: 690, 694, 1170.
print subsidiary data: 692, 696, 697.
print the digs : 64, 65, 67.
print totals : 218, 985, 986, 1006.
print two: 66, 536, 617.
print word : 114, 1339.
print write whatsit : 1355, 1356.
printed node: 821, 856, 857, 858, 864.
privileged : 1051, 1054, 1130, 1140.
prompt le name: 530, 532, 535, 537, 1328, 1374.
prompt input : 71, 83, 87, 360, 363, 484, 530.
prune movements : 615, 619, 629.
prune page top: 968, 977, 1021.
pseudo: 54, 57, 58, 59, 316.
pstack : 388, 390, 396, 400.
pt : 453.
punct noad : 682, 690, 696, 698, 728, 752, 761,
1156, 1157.
push: 584, 585, 586, 590, 592, 601, 608, 616,
619, 629.
push alignment : 772, 774.
push input : 321, 323, 325, 328.
push math: 1136, 1139, 1145, 1153, 1172, 1174,
1191.
push nest : 216, 774, 786, 787, 1025, 1083, 1091,
1099, 1117, 1119, 1136, 1167, 1200.
put : 26, 29, 1305.
put rule: 585, 586, 633.
put1 : 585.
put2 : 585.
put3 : 585.
put4 : 585.
q: 123, 125, 130, 131, 144, 151, 152, 153, 167, 172,
202, 204, 218, 275, 292, 315, 336, 366, 389, 407,
450, 461, 463, 464, 465, 473, 482, 497, 498, 607,
649, 705, 706, 709, 712, 720, 726, 734, 735, 736,
737, 738, 743, 749, 752, 756, 762, 791, 800,
826, 830, 862, 877, 901, 906, 934, 948, 953,
957, 959, 960, 968, 970, 994, 1012, 1043, 1068,
510 PART 55: INDEX T
E
X82 1380
1079, 1093, 1105, 1119, 1123, 1138, 1184, 1198,
1211, 1236, 1302, 1303, 1348, 1370.
qi : 112, 545, 549, 564, 570, 573, 576, 582, 620,
753, 907, 908, 911, 913, 923, 958, 959, 981,
1008, 1009, 1034, 1035, 1038, 1039, 1040, 1100,
1151, 1155, 1160, 1165, 1309, 1325.
qo: 112, 159, 174, 176, 185, 188, 554, 570, 576,
602, 620, 691, 708, 722, 723, 741, 752, 755, 896,
897, 898, 903, 909, 923, 945, 981, 986, 1008,
1018, 1021, 1039, 1310, 1324, 1325.
qqqq : 110, 113, 114, 550, 554, 569, 573, 574, 683,
713, 741, 752, 909, 1039, 1181, 1305, 1306.
quad : 547, 558, 1146.
quad code: 547, 558.
quarterword : 110, 113, 144, 253, 264, 271, 276,
277, 279, 281, 298, 300, 323, 592, 681, 706,
709, 711, 712, 724, 738, 749, 877, 921, 943,
944, 947, 960, 1061, 1079, 1105.
qw: 560, 564, 570, 573, 576.
r: 108, 123, 125, 131, 204, 218, 366, 389, 465, 482,
498, 649, 668, 706, 720, 726, 752, 791, 800,
829, 862, 877, 901, 953, 966, 970, 994, 1012,
1123, 1160, 1198, 1236, 1348, 1370.
r count : 912, 914, 918.
r hyf : 891, 892, 894, 899, 902, 923, 1362.
r type: 726, 727, 728, 729, 760, 766, 767.
radical : 208, 265, 266, 1046, 1162.
\radical primitive: 265.
radical noad : 683, 690, 696, 698, 733, 761, 1163.
radical noad size: 683, 698, 761, 1163.
radix : 366, 438, 439, 440, 444, 445, 448.
radix backup: 366.
\raise primitive: 1071.
Ramshaw, Lyle Harold: 539.
rbrace ptr : 389, 399, 400.
read : 52, 53, 1338, 1339.
\read primitive: 265.
read le: 480, 485, 486, 1275.
read font info: 560, 564, 1040, 1257.
read ln: 52.
read open: 480, 481, 483, 485, 486, 501, 1275.
read sixteen: 564, 565, 568.
read to cs : 209, 265, 266, 1210, 1225.
read toks : 303, 482, 1225.
ready already: 1331, 1332.
real : 3, 109, 110, 182, 186, 619, 629, 1123, 1125.
real addition: 1125.
real division: 658, 664, 673, 676, 810, 811,
1123, 1125.
real multiplication: 114, 186, 625, 634, 809, 1125.
rebox : 715, 744, 750.
reconstitute: 905, 906, 913, 915, 916, 917, 1032.
recursion: 76, 78, 173, 180, 198, 202, 203, 366,
402, 407, 498, 527, 592, 618, 692, 719, 720,
725, 754, 949, 957, 959, 1333, 1375.
ref count : 389, 390, 401.
reference counts: 150, 200, 201, 203, 275, 291, 307.
register : 209, 411, 412, 413, 1210, 1235, 1236,
1237.
rel noad : 682, 690, 696, 698, 728, 761, 767,
1156, 1157.
rel penalty: 236, 682, 761.
\relpenalty primitive: 238.
rel penalty code: 236, 237, 238.
relax : 207, 265, 266, 358, 372, 404, 506, 1045, 1224.
\relax primitive: 265.
rem byte: 545, 554, 557, 570, 708, 713, 740,
749, 753, 911, 1040.
remainder : 104, 106, 107, 457, 458, 543, 544,
545, 716, 717.
remove item: 208, 1104, 1107, 1108.
rep: 546.
replace count : 145, 175, 195, 840, 858, 869, 882,
883, 918, 1081, 1105, 1120.
report illegal case: 1045, 1050, 1051, 1243, 1377.
reset : 26, 27, 33.
reset OK: 27.
restart : 15, 125, 126, 341, 346, 357, 359, 360, 362,
380, 752, 753, 782, 785, 789, 1151, 1215.
restore old value: 268, 276, 282.
restore trace: 283, 284.
restore zero: 268, 276, 278.
result : 45, 46.
resume after display: 800, 1199, 1200, 1206.
reswitch: 15, 341, 343, 352, 463, 619, 620, 649,
651, 652, 726, 728, 934, 935, 1029, 1030, 1036,
1045, 1138, 1147, 1151.
return: 15, 16.
rewrite: 26, 27, 33.
rewrite OK: 27.
rh: 110, 113, 114, 118, 213, 219, 221, 234, 256,
268, 685, 921, 958.
\right primitive: 1188.
right brace: 207, 289, 294, 298, 347, 357, 389, 442,
474, 477, 785, 935, 961, 1067, 1252.
right brace limit : 289, 325, 392, 399, 400, 474, 477.
right brace token: 289, 339, 1065, 1127, 1226,
1371.
right delimiter : 683, 697, 748, 1181, 1182.
right hyphen min: 236, 1091, 1200, 1376, 1377.
\righthyphenmin primitive: 238.
right hyphen min code: 236, 237, 238.
right noad : 687, 690, 696, 698, 725, 728, 760,
761, 762, 1184, 1188, 1191.
1380 T
E
X82 PART 55: INDEX 511
right ptr : 605, 606, 607, 615.
right skip: 224, 827, 880, 881.
\rightskip primitive: 226.
right skip code: 224, 225, 226, 881, 886.
right1 : 585, 586, 607, 610, 616.
right2 : 585, 610.
right3 : 585, 610.
right4 : 585, 610.
rlink : 124, 125, 126, 127, 129, 130, 131, 132, 145,
149, 164, 169, 772, 819, 821, 1311, 1312.
\romannumeral primitive: 468.
roman numeral code: 468, 469, 471, 472.
round : 3, 114, 186, 625, 634, 809, 1125.
round decimals : 102, 103, 452.
rover : 124, 125, 126, 127, 128, 129, 130, 131,
132, 164, 169, 1311, 1312.
rt hit : 906, 907, 910, 911, 1033, 1035, 1040.
rule dp: 592, 622, 624, 626, 631, 633, 635.
rule ht : 592, 622, 624, 626, 631, 633, 634, 635, 636.
rule node: 138, 139, 148, 175, 183, 202, 206, 622,
626, 631, 635, 651, 653, 669, 670, 730, 761,
805, 841, 842, 866, 870, 871, 968, 973, 1000,
1074, 1087, 1121, 1147.
rule node size: 138, 139, 202, 206.
rule save: 800, 804.
rule wd : 592, 622, 624, 625, 626, 627, 631,
633, 635.
rules aligning with characters: 589.
runaway: 120, 306, 338, 396, 486.
Runaway... : 306.
s: 45, 46, 58, 59, 60, 62, 63, 93, 94, 95, 103, 108,
125, 130, 147, 177, 178, 264, 284, 389, 407, 473,
482, 529, 530, 560, 638, 645, 649, 668, 688, 699,
706, 720, 726, 738, 791, 800, 830, 862, 877, 901,
934, 966, 987, 1012, 1060, 1061, 1123, 1138,
1198, 1236, 1257, 1279, 1349, 1355.
save cond ptr : 498, 500, 509.
save cs ptr : 774, 777.
save cur val : 450, 455.
save for after : 280, 1271.
save h: 619, 623, 627, 628, 629, 632, 637.
save index : 268, 274, 276, 280, 282.
save level : 268, 269, 274, 276, 280, 282.
save link : 830, 857.
save loc: 619, 629.
save ptr : 268, 271, 272, 273, 274, 276, 280, 282,
283, 285, 645, 804, 1086, 1099, 1100, 1117, 1120,
1142, 1153, 1168, 1172, 1174, 1186, 1194, 1304.
save scanner status : 366, 369, 389, 470, 471,
494, 498, 507.
save size: 11, 111, 271, 273, 1334.
save split top skip: 1012, 1014.
save stack : 203, 268, 270, 271, 273, 274, 275, 276,
277, 281, 282, 283, 285, 300, 372, 489, 645, 768,
1062, 1071, 1131, 1140, 1150, 1153, 1339.
save style: 720, 726, 754.
save type: 268, 274, 276, 280, 282.
save v : 619, 623, 628, 629, 632, 636, 637.
save vbadness : 1012, 1017.
save vfuzz : 1012, 1017.
save warning index : 389.
saved : 274, 645, 804, 1083, 1086, 1099, 1100, 1117,
1119, 1142, 1153, 1168, 1172, 1174, 1186, 1194.
sc: 110, 113, 114, 135, 150, 159, 164, 213, 219,
247, 250, 251, 413, 420, 425, 550, 552, 554, 557,
558, 571, 573, 575, 580, 700, 701, 775, 822, 823,
832, 843, 844, 848, 850, 860, 861, 889, 1042,
1149, 1206, 1247, 1248, 1253.
scaled : 101, 102, 103, 104, 105, 106, 107, 108, 110,
113, 147, 150, 156, 176, 177, 447, 448, 450, 453,
548, 549, 560, 584, 592, 607, 616, 619, 629,
646, 649, 668, 679, 704, 705, 706, 712, 715,
716, 717, 719, 726, 735, 736, 737, 738, 743,
749, 756, 762, 791, 800, 823, 830, 839, 847,
877, 906, 970, 971, 977, 980, 982, 994, 1012,
1068, 1086, 1123, 1138, 1198, 1257.
scaled : 1258.
scaled base: 247, 249, 251, 1224, 1237.
scan box : 1073, 1084, 1241.
scan char num: 414, 434, 935, 1030, 1038, 1123,
1124, 1151, 1154, 1224, 1232.
scan delimiter : 1160, 1163, 1182, 1183, 1191, 1192.
scan dimen: 410, 440, 447, 448, 461, 462, 1061.
scan eight bit int : 415, 420, 427, 433, 505, 1079,
1082, 1099, 1110, 1224, 1226, 1227, 1237,
1241, 1247, 1296.
scan fteen bit int : 436, 1151, 1154, 1165, 1224.
scan le name: 265, 334, 526, 527, 537, 1257,
1275, 1351.
scan font ident : 415, 426, 471, 577, 578, 1234,
1253.
scan four bit int : 435, 501, 577, 1234, 1275, 1350.
scan glue: 410, 461, 782, 1060, 1228, 1238.
scan int : 409, 410, 432, 433, 434, 435, 436, 437,
438, 440, 447, 448, 461, 471, 503, 504, 509, 578,
1103, 1225, 1228, 1232, 1238, 1240, 1243, 1244,
1246, 1248, 1253, 1258, 1350, 1377.
scan keyword : 162, 407, 453, 454, 455, 456, 458,
462, 463, 645, 1082, 1225, 1236, 1258.
scan left brace: 403, 473, 645, 785, 934, 960, 1025,
1099, 1117, 1119, 1153, 1172, 1174.
scan math: 1150, 1151, 1158, 1163, 1165, 1176.
scan normal dimen: 448, 463, 503, 645, 1073,
1082, 1182, 1183, 1228, 1238, 1243, 1245,
512 PART 55: INDEX T
E
X82 1380
1247, 1248, 1253, 1259.
scan optional equals : 405, 782, 1224, 1226, 1228,
1232, 1234, 1236, 1241, 1243, 1244, 1245, 1246,
1247, 1248, 1253, 1257, 1275, 1351.
scan rule spec: 463, 1056, 1084.
scan something internal : 409, 410, 413, 432, 440,
449, 451, 455, 461, 465.
scan spec: 645, 768, 774, 1071, 1083, 1167.
scan toks : 291, 464, 473, 960, 1101, 1218, 1226,
1279, 1288, 1352, 1354, 1371.
scan twenty seven bit int : 437, 1151, 1154, 1160.
scanned result : 413, 414, 415, 418, 422, 425,
426, 428.
scanned result end : 413.
scanner status : 305, 306, 331, 336, 339, 366,
369, 389, 391, 470, 471, 473, 482, 494, 498,
507, 777, 789.
\scriptfont primitive: 1230.
script mlist : 689, 695, 698, 731, 1174.
\scriptscriptfont primitive: 1230.
script script mlist : 689, 695, 698, 731, 1174.
script script size: 699, 756, 1195, 1230.
script script style: 688, 694, 731, 1169.
\scriptscriptstyle primitive: 1169.
script size: 699, 756, 1195, 1230.
script space: 247, 757, 758, 759.
\scriptspace primitive: 248.
script space code: 247, 248.
script style: 688, 694, 702, 703, 731, 756, 762,
766, 1169.
\scriptstyle primitive: 1169.
scripts allowed : 687, 1176.
scroll mode: 71, 73, 84, 86, 93, 530, 1262,
1263, 1281.
\scrollmode primitive: 1262.
search mem: 165, 172, 255, 1339.
second indent : 847, 848, 849, 889.
second pass : 828, 863, 866.
second width: 847, 848, 849, 850, 889.
Sedgewick, Robert: 2.
see the transcript file... : 1335.
selector : 54, 55, 57, 58, 59, 62, 71, 75, 86, 90,
92, 98, 245, 311, 312, 316, 360, 465, 470, 534,
535, 617, 638, 1257, 1265, 1279, 1298, 1328,
1333, 1335, 1368, 1370.
semi simple group: 269, 1063, 1065, 1068, 1069.
serial : 821, 845, 846, 856.
set aux : 209, 413, 416, 417, 418, 1210, 1242.
set box : 209, 265, 266, 1210, 1241.
\setbox primitive: 265.
set box allowed : 76, 77, 1241, 1270.
set box dimen: 209, 413, 416, 417, 1210, 1242.
set break width to background : 837.
set char 0 : 585, 586, 620.
set conversion: 458.
set conversion end : 458.
set cur lang : 934, 960, 1091, 1200.
set cur r : 908, 910, 911.
set font : 209, 413, 553, 577, 1210, 1217, 1257,
1261.
set glue ratio one: 109, 664, 676, 810, 811.
set glue ratio zero: 109, 136, 657, 658, 664, 672,
673, 676, 810, 811.
set height zero: 970.
set interaction: 209, 1210, 1262, 1263, 1264.
\setlanguage primitive: 1344.
set language code: 1344, 1346, 1348.
set math char : 1154, 1155.
set page dimen: 209, 413, 982, 983, 984, 1210,
1242.
set page int : 209, 413, 416, 417, 1210, 1242.
set page so far zero: 987.
set prev graf : 209, 265, 266, 413, 1210, 1242.
set rule: 583, 585, 586, 624.
set shape: 209, 265, 266, 413, 1210, 1248.
set trick count : 316, 317, 318, 320.
set1 : 585, 586, 620.
set2 : 585.
set3 : 585.
set4 : 585.
sf code: 230, 232, 1034.
\sfcode primitive: 1230.
sf code base: 230, 235, 1230, 1231, 1233.
shape ref : 210, 232, 275, 1070, 1248.
shift amount : 135, 136, 159, 184, 623, 628, 632,
637, 649, 653, 668, 670, 681, 706, 720, 737, 738,
749, 750, 756, 757, 759, 799, 806, 807, 808, 889,
1076, 1081, 1125, 1146, 1203, 1204, 1205.
shift case: 1285, 1288.
shift down: 743, 744, 745, 746, 747, 749, 751,
756, 757, 759.
shift up: 743, 744, 745, 746, 747, 749, 751,
756, 758, 759.
ship out : 211, 592, 638, 644, 1023, 1075.
\shipout primitive: 1071.
ship out ag : 1071, 1075.
short display: 173, 174, 175, 193, 663, 857, 1339.
short real : 109, 110.
shortcut : 447, 448.
shortfall : 830, 851, 852, 853.
shorthand def : 209, 1210, 1222, 1223, 1224.
\show primitive: 1291.
show activities : 218, 1293.
1380 T
E
X82 PART 55: INDEX 513
show box : 180, 182, 198, 218, 219, 236, 638, 641,
663, 675, 986, 992, 1121, 1296, 1339.
\showbox primitive: 1291.
show box breadth: 236, 1339.
\showboxbreadth primitive: 238.
show box breadth code: 236, 237, 238.
show box code: 1291, 1292, 1293.
show box depth: 236, 1339.
\showboxdepth primitive: 238.
show box depth code: 236, 237, 238.
show code: 1291, 1293.
show context : 54, 78, 82, 88, 310, 311, 318,
530, 535, 537.
show cur cmd chr : 299, 367, 1031.
show eqtb: 252, 284.
show info: 692, 693.
show lists : 1291, 1292, 1293.
\showlists primitive: 1291.
show node list : 173, 176, 180, 181, 182, 195, 198,
233, 690, 692, 693, 695, 1339.
\showthe primitive: 1291.
show the code: 1291, 1292.
show token list : 176, 223, 233, 292, 295, 306, 319,
320, 400, 1339, 1368.
show whatever : 1290, 1293.
shown mode: 213, 215, 299.
shrink : 150, 151, 164, 178, 431, 462, 625, 634, 656,
671, 716, 809, 825, 827, 838, 868, 976, 1004,
1009, 1042, 1044, 1148, 1229, 1239, 1240.
shrink order : 150, 164, 178, 462, 625, 634, 656,
671, 716, 809, 825, 826, 976, 1004, 1009,
1148, 1239.
shrinking : 135, 186, 619, 629, 664, 676, 809,
810, 811, 1148.
si : 38, 42, 69, 951, 964, 1310.
simple group: 269, 1063, 1068.
Single-character primitives: 267.
\ : 1114.
\/ : 265.
\ : 265.
single base: 222, 262, 263, 264, 354, 374, 442,
1257, 1289.
skew char : 426, 549, 552, 576, 741, 1253, 1322,
1323.
\skewchar primitive: 1254.
skip: 224, 427, 1009.
\skip primitive: 411.
skip base: 224, 227, 229, 1224, 1237.
skip blanks : 303, 344, 345, 347, 349, 354.
skip byte: 545, 557, 741, 752, 753, 909, 1039.
skip code: 1058, 1059, 1060.
\skipdef primitive: 1222.
skip def code: 1222, 1223, 1224.
skip line: 336, 493, 494.
skipping : 305, 306, 336, 494.
slant : 547, 558, 575, 1123, 1125.
slant code: 547, 558.
slow print : 60, 61, 63, 84, 518, 536, 537, 581, 642,
1261, 1280, 1283, 1328, 1333, 1339.
small char : 683, 691, 697, 706, 1160.
small fam: 683, 691, 697, 706, 1160.
small node size: 141, 144, 145, 147, 152, 153, 156,
158, 202, 206, 655, 721, 903, 910, 914, 1037,
1100, 1101, 1357, 1358, 1376, 1377.
small number : 101, 102, 147, 152, 154, 264, 366,
389, 413, 438, 440, 450, 461, 470, 482, 489, 494,
497, 498, 523, 607, 649, 668, 688, 706, 719,
720, 726, 756, 762, 829, 892, 893, 905, 906,
921, 934, 944, 960, 970, 987, 1060, 1086, 1091,
1176, 1181, 1191, 1198, 1211, 1236, 1247, 1257,
1325, 1335, 1349, 1350, 1370, 1373.
so: 38, 45, 59, 60, 69, 70, 264, 407, 464, 519,
603, 617, 766, 931, 953, 955, 956, 959, 963,
1309, 1368.
Sorry, I cant find... : 524.
sort avail : 131, 1311.
sp: 104, 587.
sp : 458.
space: 547, 558, 752, 755, 1042.
space code: 547, 558, 578, 1042.
space factor : 212, 213, 418, 786, 787, 799, 1030,
1034, 1043, 1044, 1056, 1076, 1083, 1091, 1093,
1117, 1119, 1123, 1196, 1200, 1242, 1243.
\spacefactor primitive: 416.
space shrink : 547, 558, 1042.
space shrink code: 547, 558, 578.
space skip: 224, 1041, 1043.
\spaceskip primitive: 226.
space skip code: 224, 225, 226, 1041.
space stretch: 547, 558, 1042.
space stretch code: 547, 558.
space token: 289, 393, 464, 1215.
spacer : 207, 208, 232, 289, 291, 294, 298, 303, 337,
345, 347, 348, 349, 354, 404, 406, 407, 443, 444,
452, 464, 783, 935, 961, 1030, 1045, 1221.
\span primitive: 780.
span code: 780, 781, 782, 789, 791.
span count : 136, 159, 185, 796, 801, 808.
span node size: 797, 798, 803.
spec code: 645.
\special primitive: 1344.
special node: 1341, 1344, 1346, 1348, 1354, 1356,
1357, 1358, 1373.
special out : 1368, 1373.
514 PART 55: INDEX T
E
X82 1380
split : 1011.
split bot mark : 382, 383, 977, 979.
\splitbotmark primitive: 384.
split bot mark code: 382, 384, 385, 1335.
split rst mark : 382, 383, 977, 979.
\splitfirstmark primitive: 384.
split rst mark code: 382, 384, 385.
split max depth: 140, 247, 977, 1068, 1100.
\splitmaxdepth primitive: 248.
split max depth code: 247, 248.
split top ptr : 140, 188, 202, 206, 1021, 1022, 1100.
split top skip: 140, 224, 968, 977, 1012, 1014,
1021, 1100.
\splittopskip primitive: 226.
split top skip code: 224, 225, 226, 969.
split up: 981, 986, 1008, 1010, 1020, 1021.
spotless : 76, 77, 245, 1332, 1335.
spread : 645.
sprint cs : 223, 263, 338, 395, 396, 398, 472,
479, 484, 561, 1294.
square roots: 737.
ss code: 1058, 1059, 1060.
ss glue: 162, 164, 715, 1060.
stack conventions: 300.
stack into box : 711, 713.
stack size: 11, 301, 310, 321, 1334.
start : 300, 302, 303, 307, 318, 319, 323, 324, 325,
328, 329, 331, 360, 362, 363, 369, 483, 538.
start cs : 341, 354, 355.
start eq no: 1140, 1142.
start eld : 300, 302.
start font error message: 561, 567.
start here: 5, 1332.
start input : 366, 376, 378, 537, 1337.
start of TEX: 6, 1332.
start par : 208, 1088, 1089, 1090, 1092.
stat: 7, 117, 120, 121, 122, 123, 125, 130, 252,
260, 283, 284, 639, 829, 845, 855, 863, 987,
1005, 1010, 1333.
state: 87, 300, 302, 303, 307, 311, 312, 323, 325,
328, 330, 331, 337, 341, 343, 344, 346, 347, 349,
352, 353, 354, 390, 483, 537, 1335.
state eld : 300, 302, 1131.
stomach: 402.
stop: 207, 1045, 1046, 1052, 1053, 1054, 1094.
stop ag : 545, 557, 741, 752, 753, 909, 1039.
store background : 864.
store break width: 843.
store fmt le: 1302, 1335.
store four quarters : 564, 568, 569, 573, 574.
store new token: 371, 372, 393, 397, 399, 407, 464,
466, 473, 474, 476, 477, 482, 483.
store scaled : 571, 573, 575.
str eq buf : 45, 259.
str eq str : 46, 1260.
str number : 38, 39, 43, 45, 46, 47, 62, 63, 79,
93, 94, 95, 177, 178, 264, 284, 407, 512, 519,
525, 527, 529, 530, 532, 549, 560, 926, 929,
934, 1257, 1279, 1299, 1355.
str pool : 38, 39, 42, 43, 45, 46, 47, 59, 60, 69,
70, 256, 260, 264, 303, 407, 464, 519, 602,
603, 617, 638, 764, 766, 929, 931, 934, 941,
1309, 1310, 1334, 1368.
str ptr : 38, 39, 41, 43, 44, 47, 59, 60, 70, 260,
262, 517, 525, 537, 617, 1260, 1309, 1310, 1323,
1325, 1327, 1332, 1334, 1368.
str room: 42, 180, 260, 464, 516, 525, 939, 1257,
1279, 1328, 1333, 1368.
str start : 38, 39, 40, 41, 43, 44, 45, 46, 47, 59, 60,
69, 70, 256, 260, 264, 407, 517, 519, 603, 617,
765, 929, 931, 934, 941, 1309, 1310, 1368.
str toks : 464, 465, 470.
stretch: 150, 151, 164, 178, 431, 462, 625, 634,
656, 671, 716, 809, 827, 838, 868, 976, 1004,
1009, 1042, 1044, 1148, 1229, 1239, 1240.
stretch order : 150, 164, 178, 462, 625, 634, 656,
671, 716, 809, 827, 838, 868, 976, 1004,
1009, 1148, 1239.
stretching : 135, 625, 634, 658, 673, 809, 810,
811, 1148.
string pool: 47, 1308.
\string primitive: 468.
string code: 468, 469, 471, 472.
string vacancies : 11, 52.
style: 726, 760, 761, 762.
style node: 160, 688, 690, 698, 730, 731, 761, 1169.
style node size: 688, 689, 698, 763.
sub box : 681, 687, 692, 698, 720, 734, 735, 737,
738, 749, 754, 1076, 1093, 1168.
sub drop: 700, 756.
sub mark : 207, 294, 298, 347, 1046, 1175.
sub mlist : 681, 683, 692, 720, 742, 754, 1181,
1185, 1186, 1191.
sub style: 702, 750, 757, 759.
sub sup: 1175, 1176.
subscr : 681, 683, 686, 687, 690, 696, 698, 738, 742,
749, 750, 751, 752, 753, 754, 755, 756, 757, 759,
1151, 1163, 1165, 1175, 1176, 1177, 1186.
subscripts: 754, 1175.
subtype: 133, 134, 135, 136, 139, 140, 143, 144,
145, 146, 147, 149, 150, 152, 153, 154, 155, 156,
158, 159, 188, 189, 190, 191, 192, 193, 424, 489,
495, 496, 625, 627, 634, 636, 649, 656, 668, 671,
681, 682, 686, 688, 689, 690, 696, 717, 730,
1380 T
E
X82 PART 55: INDEX 515
731, 732, 733, 749, 763, 766, 768, 786, 795,
809, 819, 820, 822, 837, 843, 844, 866, 868,
879, 881, 896, 897, 898, 899, 903, 910, 981,
986, 988, 1008, 1009, 1018, 1020, 1021, 1035,
1060, 1061, 1078, 1100, 1101, 1113, 1125, 1148,
1159, 1163, 1165, 1171, 1181, 1335, 1341, 1349,
1356, 1357, 1358, 1362, 1373, 1374.
sub1 : 700, 757.
sub2 : 700, 759.
succumb: 93, 94, 95, 1304.
sup drop: 700, 756.
sup mark : 207, 294, 298, 344, 355, 1046, 1175,
1176, 1177.
sup style: 702, 750, 758.
superscripts: 754, 1175.
supscr : 681, 683, 686, 687, 690, 696, 698, 738,
742, 750, 751, 752, 753, 754, 756, 758, 1151,
1163, 1165, 1175, 1176, 1177, 1186.
sup1 : 700, 758.
sup2 : 700, 758.
sup3 : 700, 758.
sw: 560, 571, 575.
switch: 341, 343, 344, 346, 350.
synch h: 616, 620, 624, 628, 633, 637, 1368.
synch v : 616, 620, 624, 628, 632, 633, 637, 1368.
system dependencies: 2, 3, 4, 9, 10, 11, 12, 19,
21, 23, 26, 27, 28, 32, 33, 34, 35, 37, 38, 49,
56, 59, 72, 81, 84, 96, 109, 110, 112, 113, 161,
186, 241, 304, 313, 328, 485, 511, 512, 513,
514, 515, 516, 517, 518, 519, 520, 521, 523,
525, 538, 557, 564, 591, 595, 597, 798, 1331,
1332, 1333, 1338, 1340, 1379.
s1 : 82, 88.
s2 : 82, 88.
s3 : 82, 88.
s4 : 82, 88.
t: 46, 107, 108, 125, 218, 277, 279, 280, 281, 323,
341, 366, 389, 464, 473, 704, 705, 726, 756,
800, 830, 877, 906, 934, 966, 970, 1030, 1123,
1176, 1191, 1198, 1257, 1288.
t open in: 33, 37.
t open out : 33, 1332.
tab mark : 207, 289, 294, 342, 347, 780, 781, 782,
783, 784, 788, 1126.
tab skip: 224.
\tabskip primitive: 226.
tab skip code: 224, 225, 226, 778, 782, 786,
795, 809.
tab token: 289, 1128.
tag : 543, 544, 554.
tail : 212, 213, 214, 215, 216, 424, 679, 718, 776,
786, 795, 796, 799, 812, 816, 888, 890, 995,
1017, 1023, 1026, 1034, 1035, 1036, 1037,
1040, 1041, 1043, 1054, 1060, 1061, 1076,
1078, 1080, 1081, 1091, 1096, 1100, 1101, 1105,
1110, 1113, 1117, 1119, 1120, 1123, 1125, 1145,
1150, 1155, 1158, 1159, 1163, 1165, 1168, 1171,
1174, 1176, 1177, 1181, 1184, 1186, 1187, 1191,
1196, 1205, 1206, 1349, 1350, 1351, 1352, 1353,
1354, 1375, 1376, 1377.
tail append : 214, 786, 795, 816, 1035, 1037, 1040,
1054, 1056, 1060, 1061, 1091, 1093, 1100, 1103,
1112, 1113, 1117, 1150, 1158, 1163, 1165, 1168,
1171, 1172, 1177, 1191, 1196, 1203, 1205, 1206.
tail eld : 212, 213, 995.
tally: 54, 55, 57, 58, 292, 312, 315, 316, 317.
tats: 7.
temp head : 162, 306, 391, 396, 400, 464, 466, 467,
470, 478, 719, 720, 754, 760, 816, 862, 863,
864, 877, 879, 880, 881, 887, 968, 1064, 1065,
1194, 1196, 1199, 1297.
temp ptr : 115, 154, 618, 619, 623, 628, 629, 632,
637, 640, 679, 692, 693, 969, 1001, 1021,
1037, 1041, 1335.
term and log : 54, 57, 58, 71, 75, 92, 245, 534,
1298, 1328, 1335, 1370.
term in: 32, 33, 34, 36, 37, 71, 1338, 1339.
term input : 71, 78.
term oset : 54, 55, 57, 58, 61, 62, 71, 537,
638, 1280.
term only: 54, 55, 57, 58, 71, 75, 92, 535, 1298,
1333, 1335.
term out : 32, 33, 34, 35, 36, 37, 51, 56.
terminal input : 304, 313, 328, 330, 360.
test char : 906, 909.
TEX: 4.
TeX capacity exceeded ... : 94.
buer size: 35, 328, 374.
exception dictionary: 940.
font memory: 580.
grouping levels: 274.
hash size: 260.
input stack size: 321.
main memory size: 120, 125.
number of strings: 43, 517.
parameter stack size: 390.
pattern memory: 954, 964.
pool size: 42.
save size: 273.
semantic nest size: 216.
text input levels: 328.
TEX.POOL check sum... : 53.
TEX.POOL doesnt match : 53.
TEX.POOL has no check sum : 52.
516 PART 55: INDEX T
E
X82 1380
TEX.POOL line doesnt... : 52.
TEX area: 514, 537.
TEX font area: 514, 563.
TEX format default : 520, 521, 523.
The T
E
Xbook: 1, 23, 49, 108, 207, 415, 446, 456,
459, 683, 688, 764, 1215, 1331.
TeXfonts : 514.
TeXformats : 11, 521.
TeXinputs : 514.
texput : 35, 534, 1257.
text : 256, 257, 258, 259, 260, 262, 263, 264, 265,
491, 553, 780, 1188, 1216, 1257, 1318, 1369.
Text line contains... : 346.
text char : 19, 20, 25, 47.
\textfont primitive: 1230.
text mlist : 689, 695, 698, 731, 1174.
text size: 699, 703, 732, 762, 1195, 1199.
text style: 688, 694, 703, 731, 737, 744, 745, 746,
748, 749, 758, 762, 1169, 1194, 1196.
\textstyle primitive: 1169.
T
E
X82: 1, 99.
TFM les: 539.
tfm le: 539, 560, 563, 564, 575.
TFtoPL : 561.
That makes 100 errors... : 82.
the: 210, 265, 266, 366, 367, 478.
The following...deleted : 641, 992, 1121.
\the primitive: 265.
the toks : 465, 466, 467, 478, 1297.
thick mu skip: 224.
\thickmuskip primitive: 226.
thick mu skip code: 224, 225, 226, 766.
thickness : 683, 697, 725, 743, 744, 746, 747, 1182.
thin mu skip: 224.
\thinmuskip primitive: 226.
thin mu skip code: 224, 225, 226, 229, 766.
This cant happen : 95.
align: 800.
copying: 206.
curlevel: 281.
disc1: 841.
disc2: 842.
disc3: 870.
disc4: 871.
display: 1200.
endv: 791.
ext1: 1348.
ext2: 1357.
ext3: 1358.
ext4: 1373.
ushing: 202.
if: 497.
line breaking: 877.
mlist1: 728.
mlist2: 754.
mlist3: 761.
mlist4: 766.
page: 1000.
paragraph: 866.
prex: 1211.
pruning: 968.
right: 1185.
rightbrace: 1068.
vcenter: 736.
vertbreak: 973.
vlistout: 630.
vpack: 669.
256 spans: 798.
this box : 619, 624, 625, 629, 633, 634.
this if : 498, 501, 503, 505, 506.
three codes : 645.
threshold : 828, 851, 854, 863.
Tight \hbox... : 667.
Tight \vbox... : 678.
tight t : 817, 819, 830, 833, 834, 836, 853.
time: 236, 241, 536, 617.
\time primitive: 238.
time code: 236, 237, 238.
tini: 8.
to : 645, 1082, 1225.
tok val : 410, 415, 418, 428, 465.
token: 289.
token list : 307, 311, 312, 323, 325, 330, 337, 341,
346, 390, 1131, 1335.
token ref count : 200, 203, 291, 473, 482, 979.
token show: 295, 296, 323, 401, 1279, 1284,
1297, 1370.
token type: 307, 311, 312, 314, 319, 323, 324, 325,
327, 379, 390, 1026, 1095.
toks : 230.
\toks primitive: 265.
toks base: 230, 231, 232, 233, 415, 1224, 1226,
1227.
\toksdef primitive: 1222.
toks def code: 1222, 1224.
toks register : 209, 265, 266, 413, 415, 1210,
1226, 1227.
tolerance: 236, 240, 828, 863.
\tolerance primitive: 238.
tolerance code: 236, 237, 238.
Too many }s : 1068.
too small : 1303, 1306.
top: 546.
top bot mark : 210, 296, 366, 367, 384, 385, 386.
1380 T
E
X82 PART 55: INDEX 517
top edge: 629, 636.
top mark : 382, 383, 1012.
\topmark primitive: 384.
top mark code: 382, 384, 386, 1335.
top skip: 224.
\topskip primitive: 226.
top skip code: 224, 225, 226, 1001.
total demerits : 819, 845, 846, 855, 864, 874, 875.
total height : 986.
total mathex params : 701, 1195.
total mathsy params : 700, 1195.
total pages : 592, 593, 617, 640, 642.
total shrink : 646, 650, 656, 664, 665, 666, 667,
671, 676, 677, 678, 796, 1201.
total stretch: 646, 650, 656, 658, 659, 660, 671,
673, 674, 796.
Trabb Pardo, Luis Isidoro: 2.
tracing commands : 236, 367, 498, 509, 1031.
\tracingcommands primitive: 238.
tracing commands code: 236, 237, 238.
tracing lost chars : 236, 581.
\tracinglostchars primitive: 238.
tracing lost chars code: 236, 237, 238.
tracing macros : 236, 323, 389, 400.
\tracingmacros primitive: 238.
tracing macros code: 236, 237, 238.
tracing online: 236, 245, 1293, 1298.
\tracingonline primitive: 238.
tracing online code: 236, 237, 238.
tracing output : 236, 638, 641.
\tracingoutput primitive: 238.
tracing output code: 236, 237, 238.
tracing pages : 236, 987, 1005, 1010.
\tracingpages primitive: 238.
tracing pages code: 236, 237, 238.
tracing paragraphs : 236, 845, 855, 863.
\tracingparagraphs primitive: 238.
tracing paragraphs code: 236, 237, 238.
tracing restores : 236, 283.
\tracingrestores primitive: 238.
tracing restores code: 236, 237, 238.
tracing stats : 117, 236, 639, 1326, 1333.
\tracingstats primitive: 238.
tracing stats code: 236, 237, 238.
Transcript written... : 1333.
trap zero glue: 1228, 1229, 1236.
trick buf : 54, 58, 315, 317.
trick count : 54, 58, 315, 316, 317.
Trickey, Howard Wellington: 2.
trie: 920, 921, 922, 950, 952, 953, 954, 958, 959,
966, 1324, 1325.
trie back : 950, 954, 956.
trie c: 947, 948, 951, 953, 955, 956, 959, 963, 964.
trie char : 920, 921, 923, 958, 959.
trie x : 958, 959.
trie hash: 947, 948, 949, 950, 952.
trie l : 947, 948, 949, 957, 959, 960, 963, 964.
trie link : 920, 921, 923, 950, 952, 953, 954, 955,
956, 958, 959.
trie max : 950, 952, 954, 958, 1324, 1325.
trie min: 950, 952, 953, 956.
trie node: 948, 949.
trie not ready: 891, 950, 951, 960, 966, 1324, 1325.
trie o: 947, 948, 959, 963, 964.
trie op: 920, 921, 923, 924, 943, 958, 959.
trie op hash: 943, 944, 945, 946, 948, 952.
trie op lang : 943, 944, 945, 952.
trie op ptr : 943, 944, 945, 946, 1324, 1325.
trie op size: 11, 921, 943, 944, 946, 1324, 1325.
trie op val : 943, 944, 945, 952.
trie pack : 957, 966.
trie pointer : 920, 921, 922, 947, 948, 949, 950,
953, 957, 959, 960, 966.
trie ptr : 947, 951, 952, 964.
trie r : 947, 948, 949, 955, 956, 957, 959, 963, 964.
trie ref : 950, 952, 953, 956, 957, 959.
trie root : 947, 949, 951, 952, 958, 966.
trie size: 11, 920, 948, 950, 952, 954, 964, 1325.
trie taken: 950, 952, 953, 954, 956.
trie used : 943, 944, 945, 946, 1324, 1325.
true: 4, 16, 31, 34, 37, 45, 46, 49, 51, 53, 71, 77,
88, 97, 98, 104, 105, 106, 107, 168, 169, 256,
257, 259, 311, 327, 328, 336, 346, 361, 362, 365,
374, 378, 407, 413, 430, 440, 444, 447, 453, 461,
462, 486, 501, 508, 512, 516, 524, 526, 534, 563,
578, 592, 621, 628, 637, 638, 641, 663, 675, 706,
719, 791, 827, 828, 829, 851, 854, 863, 880, 882,
884, 903, 905, 910, 911, 951, 956, 962, 963,
992, 1020, 1021, 1025, 1030, 1035, 1037, 1040,
1051, 1054, 1083, 1090, 1101, 1121, 1163, 1194,
1195, 1218, 1253, 1258, 1270, 1279, 1283, 1298,
1303, 1336, 1342, 1354, 1371, 1374.
true : 453.
try break : 828, 829, 839, 851, 858, 862, 866,
868, 869, 873, 879.
two: 101, 102.
two choices : 113.
two halves : 113, 118, 124, 172, 221, 256, 684,
921, 966.
type: 4, 133, 134, 135, 136, 137, 138, 139, 140,
141, 142, 143, 144, 145, 146, 147, 148, 149, 150,
152, 153, 155, 156, 157, 158, 159, 160, 175, 183,
184, 202, 206, 424, 489, 495, 496, 497, 505, 622,
623, 626, 628, 631, 632, 635, 637, 640, 649, 651,
518 PART 55: INDEX T
E
X82 1380
653, 655, 668, 669, 670, 680, 681, 682, 683, 686,
687, 688, 689, 696, 698, 713, 715, 720, 721, 726,
727, 728, 729, 731, 732, 736, 747, 750, 752, 761,
762, 767, 768, 796, 799, 801, 805, 807, 809, 810,
811, 816, 819, 820, 822, 830, 832, 837, 841, 842,
843, 844, 845, 856, 858, 859, 860, 861, 862, 864,
865, 866, 868, 870, 871, 874, 875, 879, 881, 896,
897, 899, 903, 914, 968, 970, 972, 973, 976, 978,
979, 981, 986, 988, 993, 996, 997, 1000, 1004,
1008, 1009, 1010, 1011, 1013, 1014, 1021, 1074,
1080, 1081, 1087, 1100, 1101, 1105, 1110, 1113,
1121, 1147, 1155, 1158, 1159, 1163, 1165, 1168,
1181, 1185, 1186, 1191, 1202, 1203, 1341, 1349.
Type <return> to proceed... : 85.
u: 69, 107, 389, 560, 706, 791, 800, 929, 934,
944, 1257.
u part : 768, 769, 779, 788, 794, 801.
u template: 307, 314, 324, 788.
uc code: 230, 232, 407.
\uccode primitive: 1230.
uc code base: 230, 235, 1230, 1231, 1286, 1288.
uc hyph: 236, 891, 896.
\uchyph primitive: 238.
uc hyph code: 236, 237, 238.
un hbox : 208, 1090, 1107, 1108, 1109.
\unhbox primitive: 1107.
\unhcopy primitive: 1107.
\unkern primitive: 1107.
\unpenalty primitive: 1107.
\unskip primitive: 1107.
un vbox : 208, 1046, 1094, 1107, 1108, 1109.
\unvbox primitive: 1107.
\unvcopy primitive: 1107.
unbalance: 389, 391, 396, 399, 473, 477.
Unbalanced output routine : 1027.
Unbalanced write... : 1372.
Undefined control sequence : 370.
undened control sequence: 222, 232, 256, 257,
259, 262, 268, 282, 290, 1318, 1319.
undened cs : 210, 222, 366, 372, 1226, 1227, 1295.
under noad : 687, 690, 696, 698, 733, 761, 1156,
1157.
Underfull \hbox... : 660.
Underfull \vbox... : 674.
\underline primitive: 1156.
undump: 1306, 1310, 1312, 1314, 1319, 1323,
1325, 1327.
undump end : 1306.
undump end end : 1306.
undump four ASCII : 1310.
undump hh: 1306, 1319, 1325.
undump int : 1306, 1308, 1312, 1317, 1319,
1323, 1327.
undump qqqq : 1306, 1310, 1323.
undump size: 1306, 1310, 1321, 1325.
undump size end : 1306.
undump size end end : 1306.
undump wd : 1306, 1312, 1317, 1321.
unoat : 109, 658, 664, 673, 676, 810, 811.
unhyphenated : 819, 829, 837, 864, 866, 868.
unity: 101, 103, 114, 164, 186, 453, 568, 1259.
unpackage: 1109, 1110.
unsave: 281, 283, 791, 800, 1026, 1063, 1068,
1086, 1100, 1119, 1133, 1168, 1174, 1186,
1191, 1194, 1196, 1200.
unset node: 136, 159, 175, 183, 184, 202, 206, 651,
669, 682, 688, 689, 768, 796, 799, 801, 805.
update active: 861.
update heights : 970, 972, 973, 994, 997, 1000.
update terminal : 34, 37, 61, 71, 86, 362, 524,
537, 638, 1280, 1338.
update width: 832, 860.
\uppercase primitive: 1286.
Use of x doesnt match... : 398.
use err help: 79, 80, 89, 90, 1283.
v: 69, 107, 389, 450, 706, 715, 736, 743, 749, 800,
830, 922, 934, 944, 960, 977, 1138.
v oset : 247, 640, 641.
\voffset primitive: 248.
v oset code: 247, 248.
v part : 768, 769, 779, 789, 794, 801.
v template: 307, 314, 325, 390, 789, 1131.
vacuous : 440, 444, 445.
vadjust : 208, 265, 266, 1097, 1098, 1099, 1100.
\vadjust primitive: 265.
valign: 208, 265, 266, 1046, 1090, 1130.
\valign primitive: 265.
var code: 232, 1151, 1155, 1165.
var delimiter : 706, 737, 748, 762.
var used : 117, 125, 130, 164, 639, 1311, 1312.
vbadness : 236, 674, 677, 678, 1012, 1017.
\vbadness primitive: 238.
vbadness code: 236, 237, 238.
\vbox primitive: 1071.
vbox group: 269, 1083, 1085.
vcenter : 208, 265, 266, 1046, 1167.
\vcenter primitive: 265.
vcenter group: 269, 1167, 1168.
vcenter noad : 687, 690, 696, 698, 733, 761, 1168.
vert break : 970, 971, 976, 977, 980, 982, 1010.
very loose t : 817, 819, 830, 833, 834, 836, 852.
vet glue: 625, 634.
\vfil primitive: 1058.
1380 T
E
X82 PART 55: INDEX 519
\vfilneg primitive: 1058.
\vfill primitive: 1058.
vfuzz : 247, 677, 1012, 1017.
\vfuzz primitive: 248.
vfuzz code: 247, 248.
VIRTEX : 1331.
virtual memory: 126.
Vitter, Jerey Scott: 261.
vlist node: 137, 148, 159, 175, 183, 184, 202, 206,
505, 618, 622, 623, 628, 629, 631, 632, 637, 640,
644, 651, 668, 669, 681, 713, 715, 720, 736, 747,
750, 807, 809, 811, 841, 842, 866, 870, 871, 968,
973, 978, 1000, 1074, 1080, 1087, 1110, 1147.
vlist out : 592, 615, 616, 618, 619, 623, 628, 629,
632, 637, 638, 640, 693, 1373.
vmode: 211, 215, 416, 417, 418, 422, 424, 501,
775, 785, 786, 804, 807, 808, 809, 812, 1025,
1029, 1045, 1046, 1048, 1056, 1057, 1071, 1072,
1073, 1076, 1078, 1079, 1080, 1083, 1090, 1091,
1094, 1098, 1099, 1103, 1105, 1109, 1110, 1111,
1130, 1167, 1243, 1244.
vmove: 208, 1048, 1071, 1072, 1073.
vpack : 236, 644, 645, 646, 668, 705, 735, 738, 759,
799, 804, 977, 1021, 1100, 1168.
vpackage: 668, 796, 977, 1017, 1086.
vrule: 208, 265, 266, 463, 1056, 1084, 1090.
\vrule primitive: 265.
vsize: 247, 980, 987.
\vsize primitive: 248.
vsize code: 247, 248.
vskip: 208, 1046, 1057, 1058, 1059, 1078, 1094.
\vskip primitive: 1058.
vsplit : 967, 977, 978, 980, 1082.
\vsplit needs a \vbox : 978.
\vsplit primitive: 1071.
vsplit code: 1071, 1072, 1079.
\vss primitive: 1058.
\vtop primitive: 1071.
vtop code: 1071, 1072, 1083, 1085, 1086.
vtop group: 269, 1083, 1085.
w: 114, 147, 156, 275, 278, 279, 607, 649, 668,
706, 715, 738, 791, 800, 906, 994, 1123, 1138,
1198, 1302, 1303, 1349, 1350.
w close: 28, 1329, 1337.
w make name string : 525, 1328.
w open in: 27, 524.
w open out : 27, 1328.
wait : 1012, 1020, 1021, 1022.
wake up terminal : 34, 37, 51, 71, 73, 363, 484,
524, 530, 1294, 1297, 1303, 1333, 1338.
warning index : 305, 331, 338, 389, 390, 395, 396,
398, 401, 473, 479, 482, 774, 777.
warning issued : 76, 245, 1335.
was free: 165, 167, 171.
was hi min: 165, 166, 167, 171.
was lo max : 165, 166, 167, 171.
was mem end : 165, 166, 167, 171.
\wd primitive: 416.
WEB : 1, 4, 38, 40, 50, 1308.
what lang : 1341, 1356, 1362, 1376, 1377.
what lhm: 1341, 1356, 1362, 1376, 1377.
what rhm: 1341, 1356, 1362, 1376, 1377.
whatsit node: 146, 148, 175, 183, 202, 206, 622,
631, 651, 669, 730, 761, 866, 896, 899, 968,
973, 1000, 1147, 1341, 1349.
widow penalty: 236, 1096.
\widowpenalty primitive: 238.
widow penalty code: 236, 237, 238.
width : 463.
width: 135, 136, 138, 139, 147, 150, 151, 155, 156,
178, 184, 187, 191, 192, 424, 429, 431, 451, 462,
463, 554, 605, 607, 611, 622, 623, 625, 626, 631,
633, 634, 635, 641, 651, 653, 656, 657, 666, 668,
669, 670, 671, 679, 683, 688, 706, 709, 714, 715,
716, 717, 731, 738, 744, 747, 749, 750, 757, 758,
759, 768, 779, 793, 796, 797, 798, 801, 802, 803,
804, 806, 807, 808, 809, 810, 811, 827, 837, 838,
841, 842, 866, 868, 870, 871, 881, 969, 976, 996,
1001, 1004, 1009, 1042, 1044, 1054, 1091, 1093,
1147, 1148, 1199, 1201, 1205, 1229, 1239, 1240.
width base: 550, 552, 554, 566, 569, 571, 576,
1322, 1323.
width index : 543, 550.
width oset : 135, 416, 417, 1247.
Wirth, Niklaus: 10.
wlog : 56, 58, 536, 1334.
wlog cr : 56, 57, 58, 1333.
wlog ln: 56, 1334.
word dene: 1214, 1228, 1232, 1236.
word le: 25, 27, 28, 113, 525, 1305.
words : 204, 205, 206, 1357.
wrap lig : 910, 911.
wrapup: 1035, 1040.
write: 37, 56, 58, 597.
\write primitive: 1344.
write dvi : 597, 598, 599.
write le: 57, 58, 1342, 1374, 1378.
write ln: 35, 37, 51, 56, 57.
write loc: 1313, 1314, 1344, 1345, 1371.
write node: 1341, 1344, 1346, 1348, 1356, 1357,
1358, 1373, 1374.
write node size: 1341, 1350, 1352, 1353, 1354,
1357, 1358.
write open: 1342, 1343, 1370, 1374, 1378.
520 PART 55: INDEX T
E
X82 1380
write out : 1370, 1374.
write stream: 1341, 1350, 1354, 1355, 1370, 1374.
write text : 307, 314, 323, 1340, 1371.
write tokens : 1341, 1352, 1353, 1354, 1356, 1357,
1358, 1368, 1371.
writing : 578.
wterm: 56, 58, 61.
wterm cr : 56, 57, 58.
wterm ln: 56, 61, 524, 1303, 1332.
Wyatt, Douglas Kirk: 2.
w0 : 585, 586, 604, 609.
w1 : 585, 586, 607.
w2 : 585.
w3 : 585.
w4 : 585.
x: 100, 105, 106, 107, 587, 600, 649, 668, 706,
720, 726, 735, 737, 738, 743, 749, 756, 1123,
1302, 1303.
x height : 547, 558, 559, 738, 1123.
x height code: 547, 558.
x leaders : 149, 190, 627, 1071, 1072.
\xleaders primitive: 1071.
x over n: 106, 703, 716, 717, 986, 1008, 1009,
1010, 1240.
x token: 364, 381, 478, 1038, 1152.
xchr : 20, 21, 23, 24, 38, 49, 58, 519.
xclause: 16.
\xdef primitive: 1208.
xeq level : 253, 254, 268, 278, 279, 283, 1304.
xn over d : 107, 455, 457, 458, 568, 716, 1044,
1260.
xord : 20, 24, 31, 52, 53, 523, 525.
xpand : 473, 477, 479.
xray: 208, 1290, 1291, 1292.
xspace skip: 224, 1043.
\xspaceskip primitive: 226.
xspace skip code: 224, 225, 226, 1043.
xxx1 : 585, 586, 1368.
xxx2 : 585.
xxx3 : 585.
xxx4 : 585, 586, 1368.
x0 : 585, 586, 604, 609.
x1 : 585, 586, 607.
x2 : 585.
x3 : 585.
x4 : 585.
y: 105, 706, 726, 735, 737, 738, 743, 749, 756.
y here: 608, 609, 611, 612, 613.
y OK: 608, 609, 612.
y seen: 611, 612.
year : 236, 241, 536, 617, 1328.
\year primitive: 238.
year code: 236, 237, 238.
You already have nine... : 476.
You cant \insert255 : 1099.
You cant dump... : 1304.
You cant use \hrule... : 1095.
You cant use \long... : 1213.
You cant use a prefix with x : 1212.
You cant use x after ... : 428, 1237.
You cant use x in y mode : 1049.
You have to increase POOLSIZE : 52.
You want to edit file x : 84.
you cant : 1049, 1050, 1080, 1106.
yz OK: 608, 609, 610, 612.
y0 : 585, 586, 594, 604, 609.
y1 : 585, 586, 607, 613.
y2 : 585, 594.
y3 : 585.
y4 : 585.
z: 560, 706, 726, 743, 749, 756, 922, 927, 953,
959, 1198.
z here: 608, 609, 611, 612, 614.
z OK: 608, 609, 612.
z seen: 611, 612.
Zabala Salelles, Ignacio Andres: 2.
zero glue: 162, 175, 224, 228, 424, 462, 732, 802,
887, 1041, 1042, 1043, 1171, 1229.
zero token: 445, 452, 473, 476, 479.
z0 : 585, 586, 604, 609.
z1 : 585, 586, 607, 614.
z2 : 585.
z3 : 585.
z4 : 585.
1380 T
E
X82 NAMES OF THE SECTIONS 521
Accumulate the constant until cur tok is not a suitable digit 445 Used in section 444.
Add the width of node s to act width 871 Used in section 869.
Add the width of node s to break width 842 Used in section 840.
Add the width of node s to disc width 870 Used in section 869.
Adjust for the magnication ratio 457 Used in section 453.
Adjust for the setting of \globaldefs 1214 Used in section 1211.
Adjust shift up and shift down for the case of a fraction line 746 Used in section 743.
Adjust shift up and shift down for the case of no fraction line 745 Used in section 743.
Advance cur p to the node following the present string of characters 867 Used in section 866.
Advance past a whatsit node in the line break loop 1362 Used in section 866.
Advance past a whatsit node in the pre-hyphenation loop 1363 Used in section 896.
Advance r; goto found if the parameter delimiter has been fully matched, otherwise goto continue 394
Used in section 392.
Allocate entire node p and goto found 129 Used in section 127.
Allocate from the top of node p and goto found 128 Used in section 127.
Apologize for inability to do the operation now, unless \unskip follows non-glue 1106 Used in section 1105.
Apologize for not loading the font, goto done 567 Used in section 566.
Append a ligature and/or kern to the translation; goto continue if the stack of inserted ligatures is
nonempty 910 Used in section 906.
Append a new leader node that uses cur box 1078 Used in section 1075.
Append a new letter or a hyphen level 962 Used in section 961.
Append a new letter or hyphen 937 Used in section 935.
Append a normal inter-word space to the current list, then goto big switch 1041 Used in section 1030.
Append a penalty node, if a nonzero penalty is appropriate 890 Used in section 880.
Append an insertion to the current page and goto contribute 1008 Used in section 1000.
Append any new hlist entries for q, and any appropriate penalties 767 Used in section 760.
Append box cur box to the current list, shifted by box context 1076 Used in section 1075.
Append character cur chr and the following characters (if any) to the current hlist in the current font;
goto reswitch when a non-character has been fetched 1034 Used in section 1030.
Append characters of hu[j . . ] to major tail , advancing j 917 Used in section 916.
Append inter-element spacing based on r type and t 766 Used in section 760.
Append tabskip glue and an empty box to list u, and update s and t as the prototype nodes are passed 809
Used in section 808.
Append the accent with appropriate kerns, then set p q 1125 Used in section 1123.
Append the current tabskip glue to the preamble list 778 Used in section 777.
Append the display and perhaps also the equation number 1204 Used in section 1199.
Append the glue or equation number following the display 1205 Used in section 1199.
Append the glue or equation number preceding the display 1203 Used in section 1199.
Append the new box to the current vertical list, followed by the list of special nodes taken out of the box
by the packager 888 Used in section 880.
Append the value n to list p 938 Used in section 937.
Assign the values depth threshold show box depth and breadth max show box breadth 236
Used in section 198.
Assignments 1217, 1218, 1221, 1224, 1225, 1226, 1228, 1232, 1234, 1235, 1241, 1242, 1248, 1252, 1253, 1256, 1264
Used in section 1211.
Attach list p to the current list, and record its length; then nish up and return 1120 Used in section 1119.
Attach the limits to y and adjust height (v), depth(v) to account for their presence 751 Used in section 750.
Back up an outer control sequence so that it can be reread 337 Used in section 336.
Basic printing procedures 57, 58, 59, 60, 62, 63, 64, 65, 262, 263, 518, 699, 1355 Used in section 4.
Break the current page at node p, put it in box 255, and put the remaining nodes on the contribution
list 1017 Used in section 1014.
522 NAMES OF THE SECTIONS T
E
X82 1380
Break the paragraph at the chosen breakpoints, justify the resulting lines to the correct widths, and
append them to the current vertical list 876 Used in section 815.
Calculate the length, l, and the shift amount, s, of the display lines 1149 Used in section 1145.
Calculate the natural width, w, by which the characters of the nal line extend to the right of the reference
point, plus two ems; or set w max dimen if the non-blank information on that line is aected by
stretching or shrinking 1146 Used in section 1145.
Call the packaging subroutine, setting just box to the justied box 889 Used in section 880.
Call try break if cur p is a legal breakpoint; on the second pass, also try to hyphenate the next word, if
cur p is a glue node; then advance cur p to the next node of the paragraph that could possibly be a
legal breakpoint 866 Used in section 863.
Carry out a ligature replacement, updating the cursor structure and possibly advancing j; goto continue
if the cursor doesnt advance, otherwise goto done 911 Used in section 909.
Case statement to copy dierent types and set words to the number of initial words not yet copied 206
Used in section 205.
Cases for noads that can follow a bin noad 733 Used in section 728.
Cases for nodes that can appear in an mlist, after which we goto done with node 730 Used in section 728.
Cases of ush node list that arise in mlists only 698 Used in section 202.
Cases of handle right brace where a right brace triggers a delayed action 1085, 1100, 1118, 1132, 1133, 1168,
1173, 1186 Used in section 1068.
Cases of main control that are for extensions to T
E
X 1347 Used in section 1045.
Cases of main control that are not part of the inner loop 1045 Used in section 1030.
Cases of main control that build boxes and lists 1056, 1057, 1063, 1067, 1073, 1090, 1092, 1094, 1097, 1102, 1104,
1109, 1112, 1116, 1122, 1126, 1130, 1134, 1137, 1140, 1150, 1154, 1158, 1162, 1164, 1167, 1171, 1175, 1180, 1190, 1193
Used in section 1045.
Cases of main control that dont depend on mode 1210, 1268, 1271, 1274, 1276, 1285, 1290 Used in section 1045.
Cases of print cmd chr for symbolic printing of primitives 227, 231, 239, 249, 266, 335, 377, 385, 412, 417, 469,
488, 492, 781, 984, 1053, 1059, 1072, 1089, 1108, 1115, 1143, 1157, 1170, 1179, 1189, 1209, 1220, 1223, 1231, 1251, 1255,
1261, 1263, 1273, 1278, 1287, 1292, 1295, 1346 Used in section 298.
Cases of show node list that arise in mlists only 690 Used in section 183.
Cases where character is ignored 345 Used in section 344.
Change buered instruction to y or w and goto found 613 Used in section 612.
Change buered instruction to z or x and goto found 614 Used in section 612.
Change current mode to vmode for \halign, hmode for \valign 775 Used in section 774.
Change discretionary to compulsory and set disc break true 882 Used in section 881.
Change font dvi f to f 621 Used in section 620.
Change state if necessary, and goto switch if the current character should be ignored, or goto reswitch if
the current character changes to another 344 Used in section 343.
Change the case of the token in p, if a change is appropriate 1289 Used in section 1288.
Change the current style and goto delete q 763 Used in section 761.
Change the interaction level and return 86 Used in section 84.
Change this node to a style node followed by the correct choice, then goto done with node 731
Used in section 730.
Character k cannot be printed 49 Used in section 48.
Character s is the current new-line character 244 Used in sections 58 and 59.
Check ags of unavailable nodes 170 Used in section 167.
Check for charlist cycle 570 Used in section 569.
Check for improper alignment in displayed math 776 Used in section 774.
Check if node p is a new champion breakpoint; then goto done if p is a forced break or if the page-so-far
is already too full 974 Used in section 972.
Check if node p is a new champion breakpoint; then if it is time for a page break, prepare for output, and
either re up the users output routine and return or ship out the page and goto done 1005
Used in section 997.
1380 T
E
X82 NAMES OF THE SECTIONS 523
Check single-word avail list 168 Used in section 167.
Check that another $ follows 1197 Used in sections 1194, 1194, and 1206.
Check that the necessary fonts for math symbols are present; if not, ush the current math lists and set
danger true 1195 Used in sections 1194 and 1194.
Check that the nodes following hb permit hyphenation and that at least l hyf + r hyf letters have been
found, otherwise goto done1 899 Used in section 894.
Check the constant values for consistency 14, 111, 290, 522, 1249 Used in section 1332.
Check the pool check sum 53 Used in section 52.
Check variable-size avail list 169 Used in section 167.
Clean up the memory by removing the break nodes 865 Used in sections 815 and 863.
Clear dimensions to zero 650 Used in sections 649 and 668.
Clear o top level from save stack 282 Used in section 281.
Close the format le 1329 Used in section 1302.
Coerce glue to a dimension 451 Used in sections 449 and 455.
Compiler directives 9 Used in section 4.
Complain about an undened family and set cur i null 723 Used in section 722.
Complain about an undened macro 370 Used in section 367.
Complain about missing \endcsname 373 Used in section 372.
Complain about unknown unit and goto done2 459 Used in section 458.
Complain that \the cant do this; give zero result 428 Used in section 413.
Complain that the user should have said \mathaccent 1166 Used in section 1165.
Compleat the incompleat noad 1185 Used in section 1184.
Complete a potentially long \show command 1298 Used in section 1293.
Compute result of multiply or divide, put it in cur val 1240 Used in section 1236.
Compute result of register or advance, put it in cur val 1238 Used in section 1236.
Compute the amount of skew 741 Used in section 738.
Compute the badness, b, of the current page, using awful bad if the box is too full 1007
Used in section 1005.
Compute the badness, b, using awful bad if the box is too full 975 Used in section 974.
Compute the demerits, d, from r to cur p 859 Used in section 855.
Compute the discretionary break width values 840 Used in section 837.
Compute the hash code h 261 Used in section 259.
Compute the magic oset 765 Used in section 1337.
Compute the minimum suitable height, w, and the corresponding number of extension steps, n; also set
width(b) 714 Used in section 713.
Compute the new line width 850 Used in section 835.
Compute the register location l and its type p; but return if invalid 1237 Used in section 1236.
Compute the sum of two glue specs 1239 Used in section 1238.
Compute the trie op code, v, and set l 0 965 Used in section 963.
Compute the values of break width 837 Used in section 836.
Consider a node with matching width; goto found if its a hit 612 Used in section 611.
Consider the demerits for a line from r to cur p; deactivate node r if it should no longer be active; then
goto continue if a line from r to cur p is infeasible, otherwise record a new feasible break 851
Used in section 829.
Constants in the outer block 11 Used in section 4.
Construct a box with limits above and below it, skewed by delta 750 Used in section 749.
Construct a sub/superscript combination box x, with the superscript oset by delta 759
Used in section 756.
Construct a subscript box x when there is no superscript 757 Used in section 756.
Construct a superscript box x 758 Used in section 756.
Construct a vlist box for the fraction, according to shift up and shift down 747 Used in section 743.
524 NAMES OF THE SECTIONS T
E
X82 1380
Construct an extensible character in a new box b, using recipe rem byte(q) and font f 713
Used in section 710.
Contribute an entire group to the current parameter 399 Used in section 392.
Contribute the recently matched tokens to the current parameter, and goto continue if a partial match is
still in eect; but abort if s = null 397 Used in section 392.
Convert a nal bin noad to an ord noad 729 Used in sections 726 and 728.
Convert cur val to a lower level 429 Used in section 413.
Convert math glue to ordinary glue 732 Used in section 730.
Convert nucleus (q) to an hlist and attach the sub/superscripts 754 Used in section 728.
Copy the tabskip glue between columns 795 Used in section 791.
Copy the templates from node cur loop into node p 794 Used in section 793.
Copy the token list 466 Used in section 465.
Create a character node p for nucleus (q), possibly followed by a kern node for the italic correction, and set
delta to the italic correction if a subscript is present 755 Used in section 754.
Create a character node q for the next character, but set q null if problems arise 1124
Used in section 1123.
Create a new glue specication whose width is cur val ; scan for its stretch and shrink components 462
Used in section 461.
Create a page insertion node with subtype(r) = qi (n), and include the glue correction for box n in the
current page state 1009 Used in section 1008.
Create an active breakpoint representing the beginning of the paragraph 864 Used in section 863.
Create and append a discretionary node as an alternative to the unhyphenated word, and continue to
develop both branches until they become equivalent 914 Used in section 913.
Create equal-width boxes x and z for the numerator and denominator, and compute the default amounts
shift up and shift down by which they are displaced from the baseline 744 Used in section 743.
Create new active nodes for the best feasible breaks just found 836 Used in section 835.
Create the format ident , open the format le, and inform the user that dumping has begun 1328
Used in section 1302.
Current mem equivalent of glue parameter number n 224 Used in sections 152 and 154.
Deactivate node r 860 Used in section 851.
Declare action procedures for use by main control 1043, 1047, 1049, 1050, 1051, 1054, 1060, 1061, 1064, 1069, 1070,
1075, 1079, 1084, 1086, 1091, 1093, 1095, 1096, 1099, 1101, 1103, 1105, 1110, 1113, 1117, 1119, 1123, 1127, 1129, 1131,
1135, 1136, 1138, 1142, 1151, 1155, 1159, 1160, 1163, 1165, 1172, 1174, 1176, 1181, 1191, 1194, 1200, 1211, 1270, 1275,
1279, 1288, 1293, 1302, 1348, 1376 Used in section 1030.
Declare math construction procedures 734, 735, 736, 737, 738, 743, 749, 752, 756, 762 Used in section 726.
Declare procedures for preprocessing hyphenation patterns 944, 948, 949, 953, 957, 959, 960, 966
Used in section 942.
Declare procedures needed for displaying the elements of mlists 691, 692, 694 Used in section 179.
Declare procedures needed in do extension 1349, 1350 Used in section 1348.
Declare procedures needed in hlist out , vlist out 1368, 1370, 1373 Used in section 619.
Declare procedures that scan font-related stu 577, 578 Used in section 409.
Declare procedures that scan restricted classes of integers 433, 434, 435, 436, 437 Used in section 409.
Declare subprocedures for line break 826, 829, 877, 895, 942 Used in section 815.
Declare subprocedures for prexed command 1215, 1229, 1236, 1243, 1244, 1245, 1246, 1247, 1257, 1265
Used in section 1211.
Declare subprocedures for var delimiter 709, 711, 712 Used in section 706.
Declare the function called n mlist 1184 Used in section 1174.
Declare the function called open fmt le 524 Used in section 1303.
Declare the function called reconstitute 906 Used in section 895.
Declare the procedure called align peek 785 Used in section 800.
Declare the procedure called re up 1012 Used in section 994.
Declare the procedure called get preamble token 782 Used in section 774.
1380 T
E
X82 NAMES OF THE SECTIONS 525
Declare the procedure called handle right brace 1068 Used in section 1030.
Declare the procedure called init span 787 Used in section 786.
Declare the procedure called insert relax 379 Used in section 366.
Declare the procedure called macro call 389 Used in section 366.
Declare the procedure called print cmd chr 298 Used in section 252.
Declare the procedure called print skip param 225 Used in section 179.
Declare the procedure called restore trace 284 Used in section 281.
Declare the procedure called runaway 306 Used in section 119.
Declare the procedure called show token list 292 Used in section 119.
Decry the invalid character and goto restart 346 Used in section 344.
Delete c "0" tokens and goto continue 88 Used in section 84.
Delete the page-insertion nodes 1019 Used in section 1014.
Destroy the t nodes following q, and make r point to the following node 883 Used in section 882.
Determine horizontal glue shrink setting, then return or goto common ending 664 Used in section 657.
Determine horizontal glue stretch setting, then return or goto common ending 658 Used in section 657.
Determine the displacement, d, of the left edge of the equation, with respect to the line size z, assuming
that l = false 1202 Used in section 1199.
Determine the shrink order 665 Used in sections 664, 676, and 796.
Determine the stretch order 659 Used in sections 658, 673, and 796.
Determine the value of height (r) and the appropriate glue setting; then return or goto
common ending 672 Used in section 668.
Determine the value of width(r) and the appropriate glue setting; then return or goto common ending 657
Used in section 649.
Determine vertical glue shrink setting, then return or goto common ending 676 Used in section 672.
Determine vertical glue stretch setting, then return or goto common ending 673 Used in section 672.
Discard erroneous prexes and return 1212 Used in section 1211.
Discard the prexes \long and \outer if they are irrelevant 1213 Used in section 1211.
Dispense with trivial cases of void or bad boxes 978 Used in section 977.
Display adjustment p 197 Used in section 183.
Display box p 184 Used in section 183.
Display choice node p 695 Used in section 690.
Display discretionary p 195 Used in section 183.
Display fraction noad p 697 Used in section 690.
Display glue p 189 Used in section 183.
Display insertion p 188 Used in section 183.
Display kern p 191 Used in section 183.
Display leaders p 190 Used in section 189.
Display ligature p 193 Used in section 183.
Display mark p 196 Used in section 183.
Display math node p 192 Used in section 183.
Display node p 183 Used in section 182.
Display normal noad p 696 Used in section 690.
Display penalty p 194 Used in section 183.
Display rule p 187 Used in section 183.
Display special elds of the unset node p 185 Used in section 184.
Display the current context 312 Used in section 311.
Display the insertion split cost 1011 Used in section 1010.
Display the page break cost 1006 Used in section 1005.
Display the token (m, c) 294 Used in section 293.
Display the value of b 502 Used in section 498.
Display the value of glue set (p) 186 Used in section 184.
Display the whatsit node p 1356 Used in section 183.
526 NAMES OF THE SECTIONS T
E
X82 1380
Display token p, and return if there are problems 293 Used in section 292.
Do rst-pass processing based on type(q); goto done with noad if a noad has been fully processed, goto
check dimensions if it has been translated into new hlist (q), or goto done with node if a node has been
fully processed 728 Used in section 727.
Do ligature or kern command, returning to main lig loop or main loop wrapup or main loop move 1040
Used in section 1039.
Do magic computation 320 Used in section 292.
Do some work that has been queued up for \write 1374 Used in section 1373.
Drop current token and complain that it was unmatched 1066 Used in section 1064.
Dump a couple more things and the closing check word 1326 Used in section 1302.
Dump constants for consistency check 1307 Used in section 1302.
Dump regions 1 to 4 of eqtb 1315 Used in section 1313.
Dump regions 5 and 6 of eqtb 1316 Used in section 1313.
Dump the array info for internal font number k 1322 Used in section 1320.
Dump the dynamic memory 1311 Used in section 1302.
Dump the font information 1320 Used in section 1302.
Dump the hash table 1318 Used in section 1313.
Dump the hyphenation tables 1324 Used in section 1302.
Dump the string pool 1309 Used in section 1302.
Dump the table of equivalents 1313 Used in section 1302.
Either append the insertion node p after node q, and remove it from the current page, or delete
node(p) 1022 Used in section 1020.
Either insert the material specied by node p into the appropriate box, or hold it for the next page; also
delete node p from the current page 1020 Used in section 1014.
Either process \ifcase or set b to the value of a boolean condition 501 Used in section 498.
Empty the last bytes out of dvi buf 599 Used in section 642.
Ensure that box 255 is empty after output 1028 Used in section 1026.
Ensure that box 255 is empty before output 1015 Used in section 1014.
Ensure that trie max h + 256 954 Used in section 953.
Enter a hyphenation exception 939 Used in section 935.
Enter all of the patterns into a linked trie, until coming to a right brace 961 Used in section 960.
Enter as many hyphenation exceptions as are listed, until coming to a right brace; then return 935
Used in section 934.
Enter skip blanks state, emit a space 349 Used in section 347.
Error handling procedures 78, 81, 82, 93, 94, 95 Used in section 4.
Examine node p in the hlist, taking account of its eect on the dimensions of the new box, or moving it to
the adjustment list; then advance p to the next node 651 Used in section 649.
Examine node p in the vlist, taking account of its eect on the dimensions of the new box; then advance p
to the next node 669 Used in section 668.
Expand a nonmacro 367 Used in section 366.
Expand macros in the token list and make link (def ref ) point to the result 1371 Used in section 1370.
Expand the next part of the input 478 Used in section 477.
Expand the token after the next token 368 Used in section 367.
Explain that too many dead cycles have occurred in a row 1024 Used in section 1012.
Express astonishment that no number was here 446 Used in section 444.
Express consternation over the fact that no alignment is in progress 1128 Used in section 1127.
Express shock at the missing left brace; goto found 475 Used in section 474.
Feed the macro body and its parameters to the scanner 390 Used in section 389.
Fetch a box dimension 420 Used in section 413.
Fetch a character code from some table 414 Used in section 413.
Fetch a font dimension 425 Used in section 413.
Fetch a font integer 426 Used in section 413.
1380 T
E
X82 NAMES OF THE SECTIONS 527
Fetch a register 427 Used in section 413.
Fetch a token list or font identier, provided that level = tok val 415 Used in section 413.
Fetch an internal dimension and goto attach sign, or fetch an internal integer 449 Used in section 448.
Fetch an item in the current node, if appropriate 424 Used in section 413.
Fetch something on the page so far 421 Used in section 413.
Fetch the dead cycles or the insert penalties 419 Used in section 413.
Fetch the par shape size 423 Used in section 413.
Fetch the prev graf 422 Used in section 413.
Fetch the space factor or the prev depth 418 Used in section 413.
Find an active node with fewest demerits 874 Used in section 873.
Find hyphen locations for the word in hc, or return 923 Used in section 895.
Find optimal breakpoints 863 Used in section 815.
Find the best active node for the desired looseness 875 Used in section 873.
Find the best way to split the insertion, and change type(r) to split up 1010 Used in section 1008.
Find the glue specication, main p, for text spaces in the current font 1042 Used in sections 1041 and 1043.
Finish an alignment in a display 1206 Used in section 812.
Finish displayed math 1199 Used in section 1194.
Finish issuing a diagnostic message for an overfull or underfull hbox 663 Used in section 649.
Finish issuing a diagnostic message for an overfull or underfull vbox 675 Used in section 668.
Finish line, emit a \par 351 Used in section 347.
Finish line, emit a space 348 Used in section 347.
Finish line, goto switch 350 Used in section 347.
Finish math in text 1196 Used in section 1194.
Finish the DVI le 642 Used in section 1333.
Finish the extensions 1378 Used in section 1333.
Fire up the users output routine and return 1025 Used in section 1012.
Fix the reference count, if any, and negate cur val if negative 430 Used in section 413.
Flush the box from memory, showing statistics if requested 639 Used in section 638.
Forbidden cases detected in main control 1048, 1098, 1111, 1144 Used in section 1045.
Generate a down or right command for w and return 610 Used in section 607.
Generate a y0 or z0 command in order to reuse a previous appearance of w 609 Used in section 607.
Get ready to compress the trie 952 Used in section 966.
Get ready to start line breaking 816, 827, 834, 848 Used in section 815.
Get the rst line of input and prepare to start 1337 Used in section 1332.
Get the next non-blank non-call token 406 Used in sections 405, 441, 455, 503, 526, 577, 785, 791, and 1045.
Get the next non-blank non-relax non-call token 404
Used in sections 403, 1078, 1084, 1151, 1160, 1211, 1226, and 1270.
Get the next non-blank non-sign token; set negative appropriately 441 Used in sections 440, 448, and 461.
Get the next token, suppressing expansion 358 Used in section 357.
Get users advice and return 83 Used in section 82.
Give diagnostic information, if requested 1031 Used in section 1030.
Give improper \hyphenation error 936 Used in section 935.
Global variables 13, 20, 26, 30, 32, 39, 50, 54, 73, 76, 79, 96, 104, 115, 116, 117, 118, 124, 165, 173, 181, 213, 246, 253,
256, 271, 286, 297, 301, 304, 305, 308, 309, 310, 333, 361, 382, 387, 388, 410, 438, 447, 480, 489, 493, 512, 513, 520, 527,
532, 539, 549, 550, 555, 592, 595, 605, 616, 646, 647, 661, 684, 719, 724, 764, 770, 814, 821, 823, 825, 828, 833, 839, 847,
872, 892, 900, 905, 907, 921, 926, 943, 947, 950, 971, 980, 982, 989, 1032, 1074, 1266, 1281, 1299, 1305, 1331, 1342, 1345
Used in section 4.
Go into display math mode 1145 Used in section 1138.
Go into ordinary math mode 1139 Used in sections 1138 and 1142.
Go through the preamble list, determining the column widths and changing the alignrecords to dummy
unset boxes 801 Used in section 800.
Grow more variable-size memory and goto restart 126 Used in section 125.
528 NAMES OF THE SECTIONS T
E
X82 1380
Handle situations involving spaces, braces, changes of state 347 Used in section 344.
If a line number class has ended, create new active nodes for the best feasible breaks in that class; then
return if r = last active, otherwise compute the new line width 835 Used in section 829.
If all characters of the family t relative to h, then goto found , otherwise goto not found 955
Used in section 953.
If an alignment entry has just ended, take appropriate action 342 Used in section 341.
If an expanded code is present, reduce it and goto start cs 355 Used in sections 354 and 356.
If dumping is not allowed, abort 1304 Used in section 1302.
If instruction cur i is a kern with cur c, attach the kern after q; or if it is a ligature with cur c, combine
noads q and p appropriately; then return if the cursor has moved past a noad, or goto restart 753
Used in section 752.
If no hyphens were found, return 902 Used in section 895.
If node cur p is a legal breakpoint, call try break ; then update the active widths by including the glue in
glue ptr (cur p) 868 Used in section 866.
If node p is a legal breakpoint, check if this break is the best known, and goto done if p is null or if the
page-so-far is already too full to accept more stu 972 Used in section 970.
If node q is a style node, change the style and goto delete q ; otherwise if it is not a noad, put it into the
hlist, advance q, and goto done; otherwise set s to the size of noad q, set t to the associated type
(ord noad . . inner noad ), and set pen to the associated penalty 761 Used in section 760.
If node r is of type delta node, update cur active width, set prev r and prev prev r , then goto continue 832
Used in section 829.
If the current list ends with a box node, delete it from the list and make cur box point to it; otherwise set
cur box null 1080 Used in section 1079.
If the current page is empty and node p is to be deleted, goto done1 ; otherwise use node p to update the
state of the current page; if this node is an insertion, goto contribute; otherwise if this node is not a
legal breakpoint, goto contribute or update heights ; otherwise set pi to the penalty associated with
this breakpoint 1000 Used in section 997.
If the cursor is immediately followed by the right boundary, goto reswitch; if its followed by an invalid
character, goto big switch; otherwise move the cursor one step to the right and goto main lig loop 1036
Used in section 1034.
If the next character is a parameter number, make cur tok a match token; but if it is a left brace, store
left brace, end match, set hash brace, and goto done 476 Used in section 474.
If the preamble list has been traversed, check that the row has ended 792 Used in section 791.
If the right-hand side is a token parameter or token register, nish the assignment and goto done 1227
Used in section 1226.
If the string hyph word [h] is less than hc[1 . . hn], goto not found ; but if the two strings are equal, set hyf
to the hyphen positions and goto found 931 Used in section 930.
If the string hyph word [h] is less than or equal to s, interchange (hyph word [h], hyph list [h]) with (s, p) 941
Used in section 940.
If theres a ligature or kern at the cursor position, update the data structures, possibly advancing j;
continue until the cursor moves 909 Used in section 906.
If theres a ligature/kern command relevant to cur l and cur r , adjust the text appropriately; exit to
main loop wrapup 1039 Used in section 1034.
If this font has already been loaded, set f to the internal font number and goto common ending 1260
Used in section 1257.
If this sup mark starts an expanded character like ^^A or ^^df, then goto reswitch, otherwise set
state mid line 352 Used in section 344.
Ignore the fraction operation and complain about this ambiguous case 1183 Used in section 1181.
Implement \closeout 1353 Used in section 1348.
Implement \immediate 1375 Used in section 1348.
Implement \openout 1351 Used in section 1348.
Implement \setlanguage 1377 Used in section 1348.
1380 T
E
X82 NAMES OF THE SECTIONS 529
Implement \special 1354 Used in section 1348.
Implement \write 1352 Used in section 1348.
Incorporate a whatsit node into a vbox 1359 Used in section 669.
Incorporate a whatsit node into an hbox 1360 Used in section 651.
Incorporate box dimensions into the dimensions of the hbox that will contain it 653 Used in section 651.
Incorporate box dimensions into the dimensions of the vbox that will contain it 670 Used in section 669.
Incorporate character dimensions into the dimensions of the hbox that will contain it, then move to the
next node 654 Used in section 651.
Incorporate glue into the horizontal totals 656 Used in section 651.
Incorporate glue into the vertical totals 671 Used in section 669.
Increase the number of parameters in the last font 580 Used in section 578.
Initialize for hyphenating a paragraph 891 Used in section 863.
Initialize table entries (done by INITEX only) 164, 222, 228, 232, 240, 250, 258, 552, 946, 951, 1216, 1301, 1369
Used in section 8.
Initialize the current page, insert the \topskip glue ahead of p, and goto continue 1001
Used in section 1000.
Initialize the input routines 331 Used in section 1337.
Initialize the output routines 55, 61, 528, 533 Used in section 1332.
Initialize the print selector based on interaction 75 Used in sections 1265 and 1337.
Initialize the special list heads and constant nodes 790, 797, 820, 981, 988 Used in section 164.
Initialize variables as ship out begins 617 Used in section 640.
Initialize whatever T
E
X might access 8 Used in section 4.
Initiate or terminate input from a le 378 Used in section 367.
Initiate the construction of an hbox or vbox, then return 1083 Used in section 1079.
Input and store tokens from the next line of the le 483 Used in section 482.
Input for \read from the terminal 484 Used in section 483.
Input from external le, goto restart if no input found 343 Used in section 341.
Input from token list, goto restart if end of list or if a parameter needs to be expanded 357
Used in section 341.
Input the rst line of read le[m] 485 Used in section 483.
Input the next line of read le[m] 486 Used in section 483.
Insert a delta node to prepare for breaks at cur p 843 Used in section 836.
Insert a delta node to prepare for the next active node 844 Used in section 836.
Insert a dummy noad to be sub/superscripted 1177 Used in section 1176.
Insert a new active node from best place[t class ] to cur p 845 Used in section 836.
Insert a new control sequence after p, then make p point to it 260 Used in section 259.
Insert a new pattern into the linked trie 963 Used in section 961.
Insert a new trie node between q and p, and make p point to it 964 Used in section 963.
Insert a token containing frozen endv 375 Used in section 366.
Insert a token saved by \afterassignment, if any 1269 Used in section 1211.
Insert glue for split top skip and set p null 969 Used in section 968.
Insert hyphens as specied in hyph list [h] 932 Used in section 931.
Insert macro parameter and goto restart 359 Used in section 357.
Insert the appropriate mark text into the scanner 386 Used in section 367.
Insert the current list into its environment 812 Used in section 800.
Insert the pair (s, p) into the exception table 940 Used in section 939.
Insert the v
j
template and goto restart 789 Used in section 342.
Insert token p into T
E
Xs input 326 Used in section 282.
Interpret code c and return if done 84 Used in section 83.
Introduce new material from the terminal and return 87 Used in section 84.
Issue an error message if cur val = fmem ptr 579 Used in section 578.
530 NAMES OF THE SECTIONS T
E
X82 1380
Justify the line ending at breakpoint cur p, and append it to the current vertical list, together with
associated penalties and other insertions 880 Used in section 877.
Labels in the outer block 6 Used in section 4.
Last-minute procedures 1333, 1335, 1336, 1338 Used in section 1330.
Lengthen the preamble periodically 793 Used in section 792.
Let cur h be the position of the rst box, and set leader wd + lx to the spacing between corresponding
parts of boxes 627 Used in section 626.
Let cur v be the position of the rst box, and set leader ht + lx to the spacing between corresponding
parts of boxes 636 Used in section 635.
Let d be the natural width of node p; if the node is visible, goto found ; if the node is glue that stretches
or shrinks, set v max dimen 1147 Used in section 1146.
Let d be the natural width of this glue; if stretching or shrinking, set v max dimen; goto found in the
case of leaders 1148 Used in section 1147.
Let d be the width of the whatsit p 1361 Used in section 1147.
Let n be the largest legal code value, based on cur chr 1233 Used in section 1232.
Link node p into the current page and goto done 998 Used in section 997.
Local variables for dimension calculations 450 Used in section 448.
Local variables for nishing a displayed formula 1198 Used in section 1194.
Local variables for formatting calculations 315 Used in section 311.
Local variables for hyphenation 901, 912, 922, 929 Used in section 895.
Local variables for initialization 19, 163, 927 Used in section 4.
Local variables for line breaking 862, 893 Used in section 815.
Look ahead for another character, or leave lig stack empty if theres none there 1038 Used in section 1034.
Look at all the marks in nodes before the break, and set the nal link to null at the break 979
Used in section 977.
Look at the list of characters starting with x in font g; set f and c whenever a better character is found;
goto found as soon as a large enough variant is encountered 708 Used in section 707.
Look at the other stack entries until deciding what sort of DVI command to generate; goto found if node
p is a hit 611 Used in section 607.
Look at the variants of (z, x); set f and c whenever a better character is found; goto found as soon as a
large enough variant is encountered 707 Used in section 706.
Look for parameter number or ## 479 Used in section 477.
Look for the word hc[1 . . hn] in the exception table, and goto found (with hyf containing the hyphens) if
an entry is found 930 Used in section 923.
Look up the characters of list r in the hash table, and set cur cs 374 Used in section 372.
Make a copy of node p in node r 205 Used in section 204.
Make a ligature node, if ligature present ; insert a null discretionary, if appropriate 1035
Used in section 1034.
Make a partial copy of the whatsit node p and make r point to it; set words to the number of initial words
not yet copied 1357 Used in section 206.
Make a second pass over the mlist, removing all noads and inserting the proper spacing and penalties 760
Used in section 726.
Make nal adjustments and goto done 576 Used in section 562.
Make node p look like a char node and goto reswitch 652 Used in sections 622, 651, and 1147.
Make sure that page max depth is not exceeded 1003 Used in section 997.
Make sure that pi is in the proper range 831 Used in section 829.
Make the contribution list empty by setting its tail to contrib head 995 Used in section 994.
Make the rst 256 strings 48 Used in section 47.
Make the height of box y equal to h 739 Used in section 738.
Make the running dimensions in rule q extend to the boundaries of the alignment 806 Used in section 805.
Make the unset node r into a vlist node of height w, setting the glue as if the height were t 811
Used in section 808.
1380 T
E
X82 NAMES OF THE SECTIONS 531
Make the unset node r into an hlist node of width w, setting the glue as if the width were t 810
Used in section 808.
Make variable b point to a box for (f, c) 710 Used in section 706.
Manufacture a control sequence name 372 Used in section 367.
Math-only cases in non-math modes, or vice versa 1046 Used in section 1045.
Merge the widths in the span nodes of q with those of p, destroying the span nodes of q 803
Used in section 801.
Modify the end of the line to reect the nature of the break and to include \rightskip; also set the proper
value of disc break 881 Used in section 880.
Modify the glue specication in main p according to the space factor 1044 Used in section 1043.
Move down or output leaders 634 Used in section 631.
Move node p to the current page; if it is time for a page break, put the nodes following the break back onto
the contribution list, and return to the users output routine if there is one 997 Used in section 994.
Move pointer s to the end of the current list, and set replace count (r) appropriately 918
Used in section 914.
Move right or output leaders 625 Used in section 622.
Move the characters of a ligature node to hu and hc; but goto done3 if they are not all letters 898
Used in section 897.
Move the cursor past a pseudo-ligature, then goto main loop lookahead or main lig loop 1037
Used in section 1034.
Move the data into trie 958 Used in section 966.
Move to next line of le, or goto restart if there is no next line, or return if a \read line has nished 360
Used in section 343.
Negate all three glue components of cur val 431 Used in section 430.
Nullify width(q) and the tabskip glue following this column 802 Used in section 801.
Numbered cases for debug help 1339 Used in section 1338.
Open tfm le for input 563 Used in section 562.
Other local variables for try break 830 Used in section 829.
Output a box in a vlist 632 Used in section 631.
Output a box in an hlist 623 Used in section 622.
Output a leader box at cur h, then advance cur h by leader wd + lx 628 Used in section 626.
Output a leader box at cur v , then advance cur v by leader ht + lx 637 Used in section 635.
Output a rule in a vlist, goto next p 633 Used in section 631.
Output a rule in an hlist 624 Used in section 622.
Output leaders in a vlist, goto n rule if a rule or to next p if done 635 Used in section 634.
Output leaders in an hlist, goto n rule if a rule or to next p if done 626 Used in section 625.
Output node p for hlist out and move to the next node, maintaining the condition cur v = base line 620
Used in section 619.
Output node p for vlist out and move to the next node, maintaining the condition cur h = left edge 630
Used in section 629.
Output statistics about this job 1334 Used in section 1333.
Output the font denitions for all fonts that were used 643 Used in section 642.
Output the font name whose internal number is f 603 Used in section 602.
Output the non-char node p for hlist out and move to the next node 622 Used in section 620.
Output the non-char node p for vlist out 631 Used in section 630.
Output the whatsit node p in a vlist 1366 Used in section 631.
Output the whatsit node p in an hlist 1367 Used in section 622.
Pack the family into trie relative to h 956 Used in section 953.
Package an unset box for the current column and record its width 796 Used in section 791.
Package the preamble list, to determine the actual tabskip glue amounts, and let p point to this prototype
box 804 Used in section 800.
Perform the default output routine 1023 Used in section 1012.
532 NAMES OF THE SECTIONS T
E
X82 1380
Ponticate about improper alignment in display 1207 Used in section 1206.
Pop the condition stack 496 Used in sections 498, 500, 509, and 510.
Prepare all the boxes involved in insertions to act as queues 1018 Used in section 1014.
Prepare to deactivate node r, and goto deactivate unless there is a reason to consider lines of text from r
to cur p 854 Used in section 851.
Prepare to insert a token that matches cur group, and print what it is 1065 Used in section 1064.
Prepare to move a box or rule node to the current page, then goto contribute 1002 Used in section 1000.
Prepare to move whatsit p to the current page, then goto contribute 1364 Used in section 1000.
Print a short indication of the contents of node p 175 Used in section 174.
Print a symbolic description of the new break node 846 Used in section 845.
Print a symbolic description of this feasible break 856 Used in section 855.
Print either definition or use or preamble or text, and insert tokens that should lead to
recovery 339 Used in section 338.
Print location of current line 313 Used in section 312.
Print newly busy locations 171 Used in section 167.
Print string s as an error message 1283 Used in section 1279.
Print string s on the terminal 1280 Used in section 1279.
Print the banner line, including the date and time 536 Used in section 534.
Print the font identier for font (p) 267 Used in sections 174 and 176.
Print the help information and goto continue 89 Used in section 84.
Print the list between printed node and cur p, then set printed node cur p 857 Used in section 856.
Print the menu of available options 85 Used in section 84.
Print the result of command c 472 Used in section 470.
Print two lines using the tricky pseudoprinted information 317 Used in section 312.
Print type of token list 314 Used in section 312.
Process an active-character control sequence and set state mid line 353 Used in section 344.
Process node-or-noad q as much as possible in preparation for the second pass of mlist to hlist , then move
to the next item in the mlist 727 Used in section 726.
Process whatsit p in vert break loop, goto not found 1365 Used in section 973.
Prune the current list, if necessary, until it contains only char node, kern node, hlist node, vlist node,
rule node, and ligature node items; set n to the length of the list, and set q to the lists tail 1121
Used in section 1119.
Prune unwanted nodes at the beginning of the next line 879 Used in section 877.
Pseudoprint the line 318 Used in section 312.
Pseudoprint the token list 319 Used in section 312.
Push the condition stack 495 Used in section 498.
Put each of T
E
Xs primitives into the hash table 226, 230, 238, 248, 265, 334, 376, 384, 411, 416, 468, 487, 491, 553,
780, 983, 1052, 1058, 1071, 1088, 1107, 1114, 1141, 1156, 1169, 1178, 1188, 1208, 1219, 1222, 1230, 1250, 1254, 1262,
1272, 1277, 1286, 1291, 1344 Used in section 1336.
Put help message on the transcript le 90 Used in section 82.
Put the characters hu[i + 1 . . ] into post break (r), appending to this list and to major tail until
synchronization has been achieved 916 Used in section 914.
Put the characters hu[l . . i] and a hyphen into pre break (r) 915 Used in section 914.
Put the fraction into a box with its delimiters, and make new hlist (q) point to it 748 Used in section 743.
Put the \leftskip glue at the left and detach this line 887 Used in section 880.
Put the optimal current page into box 255, update rst mark and bot mark , append insertions to their
boxes, and put the remaining nodes back on the contribution list 1014 Used in section 1012.
Put the (positive) at size into s 1259 Used in section 1258.
Put the \rightskip glue after node q 886 Used in section 881.
Read and check the font data; abort if the TFM le is malformed; if theres no room for this font, say so
and goto done; otherwise incr (font ptr ) and goto done 562 Used in section 560.
Read box dimensions 571 Used in section 562.
1380 T
E
X82 NAMES OF THE SECTIONS 533
Read character data 569 Used in section 562.
Read extensible character recipes 574 Used in section 562.
Read font parameters 575 Used in section 562.
Read ligature/kern program 573 Used in section 562.
Read next line of le into buer , or goto restart if the le has ended 362 Used in section 360.
Read one string, but return false if the string memory space is getting too tight for comfort 52
Used in section 51.
Read the rst line of the new le 538 Used in section 537.
Read the other strings from the TEX.POOL le and return true, or give an error message and return
false 51 Used in section 47.
Read the TFM header 568 Used in section 562.
Read the TFM size elds 565 Used in section 562.
Readjust the height and depth of cur box , for \vtop 1087 Used in section 1086.
Reconstitute nodes for the hyphenated word, inserting discretionary hyphens 913 Used in section 903.
Record a new feasible break 855 Used in section 851.
Recover from an unbalanced output routine 1027 Used in section 1026.
Recover from an unbalanced write command 1372 Used in section 1371.
Recycle node p 999 Used in section 997.
Remove the last box, unless its part of a discretionary 1081 Used in section 1080.
Replace nodes ha . . hb by a sequence of nodes that includes the discretionary hyphens 903
Used in section 895.
Replace the tail of the list by p 1187 Used in section 1186.
Replace z by z

and compute , 572 Used in section 571.

Report a runaway argument and abort 396 Used in sections 392 and 399.
Report a tight hbox and goto common ending , if this box is suciently bad 667 Used in section 664.
Report a tight vbox and goto common ending , if this box is suciently bad 678 Used in section 676.
Report an extra right brace and goto continue 395 Used in section 392.
Report an improper use of the macro and abort 398 Used in section 397.
Report an overfull hbox and goto common ending , if this box is suciently bad 666 Used in section 664.
Report an overfull vbox and goto common ending , if this box is suciently bad 677 Used in section 676.
Report an underfull hbox and goto common ending , if this box is suciently bad 660 Used in section 658.
Report an underfull vbox and goto common ending , if this box is suciently bad 674 Used in section 673.
Report overow of the input buer, and abort 35 Used in section 31.
Report that an invalid delimiter code is being changed to null; set cur val 0 1161 Used in section 1160.
Report that the font wont be loaded 561 Used in section 560.
Report that this dimension is out of range 460 Used in section 448.
Resume the page builder after an output routine has come to an end 1026 Used in section 1100.
Reverse the links of the relevant passive nodes, setting cur p to the rst breakpoint 878
Used in section 877.
Scan a control sequence and set state skip blanks or mid line 354 Used in section 344.
Scan a numeric constant 444 Used in section 440.
Scan a parameter until its delimiter string has been found; or, if s = null , simply scan the delimiter
string 392 Used in section 391.
Scan a subformula enclosed in braces and return 1153 Used in section 1151.
Scan ahead in the buer until nding a nonletter; if an expanded code is encountered, reduce it and
goto start cs ; otherwise if a multiletter control sequence is found, adjust cur cs and loc, and goto
found 356 Used in section 354.
Scan an alphabetic character code into cur val 442 Used in section 440.
Scan an optional space 443 Used in sections 442, 448, 455, and 1200.
Scan and build the body of the token list; goto found when nished 477 Used in section 473.
Scan and build the parameter part of the macro denition 474 Used in section 473.
Scan decimal fraction 452 Used in section 448.
534 NAMES OF THE SECTIONS T
E
X82 1380
Scan le name in the buer 531 Used in section 530.
Scan for all other units and adjust cur val and f accordingly; goto done in the case of scaled points 458
Used in section 453.
Scan for fil units; goto attach fraction if found 454 Used in section 453.
Scan for mu units and goto attach fraction 456 Used in section 453.
Scan for units that are internal dimensions; goto attach sign with cur val set if found 455
Used in section 453.
Scan preamble text until cur cmd is tab mark or car ret , looking for changes in the tabskip glue; append
an alignrecord to the preamble list 779 Used in section 777.
Scan the argument for command c 471 Used in section 470.
Scan the font size specication 1258 Used in section 1257.
Scan the parameters and make link (r) point to the macro body; but return if an illegal \par is
detected 391 Used in section 389.
Scan the preamble and record it in the preamble list 777 Used in section 774.
Scan the template u
j
, putting the resulting token list in hold head 783 Used in section 779.
Scan the template v
j
, putting the resulting token list in hold head 784 Used in section 779.
Scan units and set cur val to x (cur val + f/2
16
), where there are x sp per unit; goto attach sign if the
units are internal 453 Used in section 448.
Search eqtb for equivalents equal to p 255 Used in section 172.
Search hyph list for pointers to p 933 Used in section 172.
Search save stack for equivalents that point to p 285 Used in section 172.
Select the appropriate case and return or goto common ending 509 Used in section 501.
Set initial values of key variables 21, 23, 24, 74, 77, 80, 97, 166, 215, 254, 257, 272, 287, 383, 439, 481, 490, 521, 551,
556, 593, 596, 606, 648, 662, 685, 771, 928, 990, 1033, 1267, 1282, 1300, 1343 Used in section 8.
Set line length parameters in preparation for hanging indentation 849 Used in section 848.
Set the glue in all the unset boxes of the current list 805 Used in section 800.
Set the glue in node r and change it from an unset node 808 Used in section 807.
Set the unset box q and the unset boxes in it 807 Used in section 805.
Set the value of b to the badness for shrinking the line, and compute the corresponding t class 853
Used in section 851.
Set the value of b to the badness for stretching the line, and compute the corresponding t class 852
Used in section 851.
Set the value of output penalty 1013 Used in section 1012.
Set up data structures with the cursor following position j 908 Used in section 906.
Set up the values of cur size and cur mu, based on cur style 703
Used in sections 720, 726, 730, 754, 760, and 763.
Set variable c to the current escape character 243 Used in section 63.
Ship box p out 640 Used in section 638.
Show equivalent n, in region 1 or 2 223 Used in section 252.
Show equivalent n, in region 3 229 Used in section 252.
Show equivalent n, in region 4 233 Used in section 252.
Show equivalent n, in region 5 242 Used in section 252.
Show equivalent n, in region 6 251 Used in section 252.
Show the auxiliary eld, a 219 Used in section 218.
Show the current contents of a box 1296 Used in section 1293.
Show the current meaning of a token, then goto common ending 1294 Used in section 1293.
Show the current value of some parameter or register, then goto common ending 1297
Used in section 1293.
Show the font identier in eqtb[n] 234 Used in section 233.
Show the halfword code in eqtb[n] 235 Used in section 233.
Show the status of the current page 986 Used in section 218.
Show the text of the macro being expanded 401 Used in section 389.
1380 T
E
X82 NAMES OF THE SECTIONS 535
Simplify a trivial box 721 Used in section 720.
Skip to \else or \fi, then goto common ending 500 Used in section 498.
Skip to node ha, or goto done1 if no hyphenation should be attempted 896 Used in section 894.
Skip to node hb, putting letters into hu and hc 897 Used in section 894.
Sort p into the list starting at rover and advance p to rlink (p) 132 Used in section 131.
Sort the hyphenation op tables into proper order 945 Used in section 952.
Split o part of a vertical box, make cur box point to it 1082 Used in section 1079.
Squeeze the equation as much as possible; if there is an equation number that should go on a separate line
by itself, set e 0 1201 Used in section 1199.
Start a new current page 991 Used in sections 215 and 1017.
Store cur box in a box register 1077 Used in section 1075.
Store maximum values in the hyf table 924 Used in section 923.
Store save stack [save ptr ] in eqtb[p], unless eqtb[p] holds a global value 283 Used in section 282.
Store the current token, but goto continue if it is a blank space that would become an undelimited
parameter 393 Used in section 392.
Subtract glue from break width 838 Used in section 837.
Subtract the width of node v from break width 841 Used in section 840.
Suppress expansion of the next token 369 Used in section 367.
Swap the subscript and superscript into box x 742 Used in section 738.
Switch to a larger accent if available and appropriate 740 Used in section 738.
Tell the user what has run away and try to recover 338 Used in section 336.
Terminate the current conditional and skip to \fi 510 Used in section 367.
Test box register status 505 Used in section 501.
Test if an integer is odd 504 Used in section 501.
Test if two characters match 506 Used in section 501.
Test if two macro texts match 508 Used in section 507.
Test if two tokens match 507 Used in section 501.
Test relation between integers or dimensions 503 Used in section 501.
The em width for cur font 558 Used in section 455.
The x-height for cur font 559 Used in section 455.
Tidy up the parameter just scanned, and tuck it away 400 Used in section 392.
Transfer node p to the adjustment list 655 Used in section 651.
Transplant the post-break list 884 Used in section 882.
Transplant the pre-break list 885 Used in section 882.
Treat cur chr as an active character 1152 Used in sections 1151 and 1155.
Try the nal line break at the end of the paragraph, and goto done if the desired breakpoints have been
found 873 Used in section 863.
Try to allocate within node p and its physical successors, and goto found if allocation was possible 127
Used in section 125.
Try to break after a discretionary fragment, then goto done5 869 Used in section 866.
Try to get a dierent log le name 535 Used in section 534.
Try to hyphenate the following word 894 Used in section 866.
Try to recover from mismatched \right 1192 Used in section 1191.
Types in the outer block 18, 25, 38, 101, 109, 113, 150, 212, 269, 300, 548, 594, 920, 925 Used in section 4.
Undump a couple more things and the closing check word 1327 Used in section 1303.
Undump constants for consistency check 1308 Used in section 1303.
Undump regions 1 to 6 of eqtb 1317 Used in section 1314.
Undump the array info for internal font number k 1323 Used in section 1321.
Undump the dynamic memory 1312 Used in section 1303.
Undump the font information 1321 Used in section 1303.
Undump the hash table 1319 Used in section 1314.
Undump the hyphenation tables 1325 Used in section 1303.
536 NAMES OF THE SECTIONS T
E
X82 1380
Undump the string pool 1310 Used in section 1303.
Undump the table of equivalents 1314 Used in section 1303.
Update the active widths, since the rst active node has been deleted 861 Used in section 860.
Update the current height and depth measurements with respect to a glue or kern node p 976
Used in section 972.
Update the current page measurements with respect to the glue or kern specied by node p 1004
Used in section 997.
Update the value of printed node for symbolic displays 858 Used in section 829.
Update the values of rst mark and bot mark 1016 Used in section 1014.
Update the values of last glue, last penalty, and last kern 996 Used in section 994.
Update the values of max h and max v ; but if the page is too large, goto done 641 Used in section 640.
Update width entry for spanned columns 798 Used in section 796.
Use code c to distinguish between generalized fractions 1182 Used in section 1181.
Use node p to update the current height and depth measurements; if this node is not a legal breakpoint,
goto not found or update heights , otherwise set pi to the associated penalty at the break 973
Used in section 972.
Use size elds to allocate font information 566 Used in section 562.
Wipe out the whatsit node p and goto done 1358 Used in section 202.
Wrap up the box specied by node r, splitting node p if called for; set wait true if node p holds a
remainder after splitting 1021 Used in section 1020.
Section Page
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 3
2. The character set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 10
3. Input and output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 13
4. String handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 19
5. On-line and o-line printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 24
6. Reporting errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 30
7. Arithmetic with scaled dimensions . . . . . . . . . . . . . . . . . . . . . . . . 99 38
8. Packed data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110 42
9. Dynamic memory allocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 44
10. Data structures for boxes and their friends . . . . . . . . . . . . . . . 133 50
11. Memory layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162 58
12. Displaying boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173 62
13. Destroying boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199 69
14. Copying boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203 71
15. The command codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207 73
16. The semantic nest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211 77
17. The table of equivalents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220 81
18. The hash table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256 102
19. Saving and restoring equivalents . . . . . . . . . . . . . . . . . . . . . . . . 268 109
20. Token lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289 115
21. Introduction to the syntactic routines . . . . . . . . . . . . . . . . . . . . 297 119
22. Input stacks and states . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300 121
23. Maintaining the input stacks . . . . . . . . . . . . . . . . . . . . . . . . . . . 321 131
24. Getting the next token . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332 134
25. Expanding the next token . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366 144
26. Basic scanning subroutines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402 155
27. Building token lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464 174
28. Conditional processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487 181
29. File names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511 188
30. Font metric data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539 196
31. Device-independent le format . . . . . . . . . . . . . . . . . . . . . . . . . . 583 214
32. Shipping pages out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 592 220
33. Packaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 644 239
34. Data structures for math mode . . . . . . . . . . . . . . . . . . . . . . . . . 680 249
35. Subroutines for math mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 699 258
36. Typesetting math formulas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 719 265
37. Alignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 768 285
38. Breaking paragraphs into lines . . . . . . . . . . . . . . . . . . . . . . . . . . 813 302
39. Breaking paragraphs into lines, continued . . . . . . . . . . . . . . . . 862 319
40. Pre-hyphenation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 891 330
41. Post-hyphenation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 900 334
42. Hyphenation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 919 344
43. Initializing the hyphenation tables . . . . . . . . . . . . . . . . . . . . . . . 942 350
44. Breaking vertical lists into pages . . . . . . . . . . . . . . . . . . . . . . . . 967 360
45. The page builder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 980 366
46. The chief executive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1029 383
47. Building boxes and lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1055 395
48. Building math lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1136 417
49. Mode-independent processing . . . . . . . . . . . . . . . . . . . . . . . . . . 1208 435
50. Dumping and undumping the tables . . . . . . . . . . . . . . . . . . . . 1299 455
51. The main program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1330 465
52. Debugging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1338 470
53. Extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1340 472
54. System-dependent changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1379 481
55. Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1380 482