-
Notifications
You must be signed in to change notification settings - Fork 65
/
dvigen.c
1573 lines (1357 loc) · 58.9 KB
/
dvigen.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
dvigen.w
Copyright 2009-2013 Taco Hoekwater <taco@luatex.org>
This file is part of LuaTeX.
LuaTeX is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation; either version 2 of the License, or (at your
option) any later version.
LuaTeX is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
License for more details.
You should have received a copy of the GNU General Public License along
with LuaTeX; if not, see <http://www.gnu.org/licenses/>.
*/
#include "ptexlib.h"
#undef write_dvi
/*tex This is the current mode: */
#define mode cur_list.mode_field
/*tex
The most important output produced by a run of \TeX\ is the ``device
independent'' (\.{DVI}) file that specifies where characters and rules are to
appear on printed pages. The form of these files was designed by David R. Fuchs
in 1979. Almost any reasonable typesetting device can be driven by a program that
takes \.{DVI} files as input, and dozens of such \.{DVI}-to-whatever programs
have been written. Thus, it is possible to print the output of \TeX\ on many
different kinds of equipment, using \TeX\ as a device-independent ``front end.''
A \.{DVI} file is a stream of 8-bit bytes, which may be regarded as a series of
commands in a machine-like language. The first 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 two's
complement notation. For example, a two-byte-long distance parameter has a value
between $-2^{15}$ and $2^{15}-1$. As in \.{TFM} files, numbers that occupy more
than one byte position appear in BigEndian order.
A \.{DVI} file 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 define the dimensions used in the file; this must come
first. 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 \TeX\ generated them. If
we ignore |nop| commands and \\{fnt\_def} commands (which are allowed between any
two commands in the file), 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 file, 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 file; the
first 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} file occupies bytes 0 to 99. Now if the first 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 first |bop|, i.e., the one starting in byte 100, has a pointer
of~$-1$.)
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 flipped; 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; \TeX\ sets things up so that its \.{DVI} output is in sp units,
i.e., scaled points, in agreement with all the |scaled| dimensions in \TeX's data
structures.
Here is a list of all the commands that may appear in a \.{DVI} file. Each
command is specified 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.
\startitemize
\startitem
|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.
\stopitem
\startitem
\\{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.
\stopitem
\startitem
|set1| 128 |c[1]|. Same as |set_char_0|, except that character number~|c| is
typeset. \TeX82 uses this command for characters in the range |128<=c<256|.
\stopitem
\startitem
|set2| 129 |c[2]|. Same as |set1|, except that |c|~is two bytes long, so it
is in the range |0<=c<65536|. \TeX82 never uses this command, but it should
come in handy for extensions of \TeX\ that deal with oriental languages.
\stopitem
\startitem
|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.
\stopitem
\startitem
|set4| 131 |c[4]|. Same as |set1|, except that |c|~is four bytes long.
Imagine that.
\stopitem
\startitem
|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 \MF\ is
guaranteed.
\stopitem
\startitem
|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.)
\stopitem
\startitem
|put2| 134 |c[2]|. Same as |set2|, except that |h| is not changed.
\stopitem
\startitem
|put3| 135 |c[3]|. Same as |set3|, except that |h| is not changed.
\stopitem
\startitem
|put4| 136 |c[4]|. Same as |set4|, except that |h| is not changed.
\stopitem
\startitem
|put_rule| 137 |a[4]| |b[4]|. Same as |set_rule|, except that |h| is not
changed.
\stopitem
\startitem
|nop| 138. No operation, do nothing. Any number of |nop|'s may occur between
\.{DVI} commands, but a |nop| cannot be inserted between a command and its
parameters or between two parameters.
\stopitem
\startitem
|bop| 139 $c_0[4]$ $c_1[4]$ $\ldots$ $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 undefined value. The ten $c_i$ parameters hold the values of
\.{\\count0} $\ldots$ \.{\\count9} in \TeX\ 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} file. The parameter |p| points to the previous
|bop| in the file; the first |bop| has $p=-1$.
\stopitem
\startitem
|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 buffer 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 fixed |v|) by |h|~coordinate;
so it usually needs to be sorted into some order that is appropriate for the
device in question.)
\stopitem
\startitem
|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.
\stopitem
\startitem
|pop| 142. Pop the top six values off 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.
\startitem
|right1| 143 |b[1]|. Set |h:=h+b|, i.e., move right |b| units. The parameter
is a signed number in two's complement notation, |-128<=b<128|; if |b<0|, the
reference point moves left.
\stopitem
\startitem
|right2| 144 |b[2]|. Same as |right1|, except that |b| is a two-byte quantity
in the range |-32768<=b<32768|.
\stopitem
\startitem
|right3| 145 |b[3]|. Same as |right1|, except that |b| is a three-byte
quantity in the range |@t$-2^{23}$@><=b<@t$2^{23}$@>|.
\stopitem
\startitem
|right4| 146 |b[4]|. Same as |right1|, except that |b| is a four-byte
quantity in the range |@t$-2^{31}$@><=b<@t$2^{31}$@>|.
\stopitem
\startitem
|w0| 147. Set |h:=h+w|; i.e., move right |w| units. With luck, this
parameterless command will usually suffice, because the same kind of motion
will occur several times in succession; the following commands explain how
|w| gets particular values.
\stopitem
\startitem
|w1| 148 |b[1]|. Set |w:=b| and |h:=h+b|. The value of |b| is a signed
quantity in two's complement notation, |-128<=b<128|. This command changes
the current |w|~spacing and moves right by |b|.
\stopitem
\startitem
|w2| 149 |b[2]|. Same as |w1|, but |b| is two bytes long, |-32768<=b<32768|.
\stopitem
\startitem
|w3| 150 |b[3]|. Same as |w1|, but |b| is three bytes long,
|@t$-2^{23}$@><=b<@t$2^{23}$@>|.
\stopitem
\startitem
|w4| 151 |b[4]|. Same as |w1|, but |b| is four bytes long,
|@t$-2^{31}$@><=b<@t$2^{31}$@>|.
\stopitem
\startitem
|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|.
\stopitem
\startitem
|x1| 153 |b[1]|. Set |x:=b| and |h:=h+b|. The value of |b| is a signed
quantity in two's complement notation, |-128<=b<128|. This command changes
the current |x|~spacing and moves right by |b|.
\stopitem
\startitem
|x2| 154 |b[2]|. Same as |x1|, but |b| is two bytes long, |-32768<=b<32768|.
\stopitem
\startitem
|x3| 155 |b[3]|. Same as |x1|, but |b| is three bytes long,
|@t$-2^{23}$@><=b<@t$2^{23}$@>|.
\stopitem
\startitem
|x4| 156 |b[4]|. Same as |x1|, but |b| is four bytes long,
|@t$-2^{31}$@><=b<@t$2^{31}$@>|.
\stopitem
\startitem
|down1| 157 |a[1]|. Set |v:=v+a|, i.e., move down |a| units. The parameter is
a signed number in two's complement notation, |-128<=a<128|; if |a<0|, the
reference point moves up.
\stopitem
\startitem
|down2| 158 |a[2]|. Same as |down1|, except that |a| is a two-byte quantity
in the range |-32768<=a<32768|.
\stopitem
\startitem
|down3| 159 |a[3]|. Same as |down1|, except that |a| is a three-byte quantity
in the range |@t$-2^{23}$@><=a<@t$2^{23}$@>|.
\stopitem
\startitem
|down4| 160 |a[4]|. Same as |down1|, except that |a| is a four-byte quantity
in the range |@t$-2^{31}$@><=a<@t$2^{31}$@>|.
\stopitem
\startitem
|y0| 161. Set |v:=v+y|; i.e., move down |y| units. With luck, this
parameterless command will usually suffice, because the same kind of motion
will occur several times in succession; the following commands explain how
|y| gets particular values.
\stopitem
\startitem
|y1| 162 |a[1]|. Set |y:=a| and |v:=v+a|. The value of |a| is a signed
quantity in two's complement notation, |-128<=a<128|. This command changes
the current |y|~spacing and moves down by |a|.
\stopitem
\startitem
|y2| 163 |a[2]|. Same as |y1|, but |a| is two bytes long, |-32768<=a<32768|.
\stopitem
\startitem
|y3| 164 |a[3]|. Same as |y1|, but |a| is three bytes long,
|@t$-2^{23}$@><=a<@t$2^{23}$@>|.
\stopitem
\startitem
|y4| 165 |a[4]|. Same as |y1|, but |a| is four bytes long,
|@t$-2^{31}$@><=a<@t$2^{31}$@>|.
\stopitem
\startitem
|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|.
\stopitem
\startitem
|z1| 167 |a[1]|. Set |z:=a| and |v:=v+a|. The value of |a| is a signed
quantity in two's complement notation, |-128<=a<128|. This command changes
the current |z|~spacing and moves down by |a|.
\stopitem
\startitem
|z2| 168 |a[2]|. Same as |z1|, but |a| is two bytes long, |-32768<=a<32768|.
\stopitem
\startitem
|z3| 169 |a[3]|. Same as |z1|, but |a| is three bytes long,
|@t$-2^{23}$@><=a<@t$2^{23}$@>|.
\stopitem
\startitem
|z4| 170 |a[4]|. Same as |z1|, but |a| is four bytes long,
|@t$-2^{31}$@><=a<@t$2^{31}$@>|.
\stopitem
\startitem
|fnt_num_0| 171. Set |f:=0|. Font 0 must previously have been defined by a
\\{fnt\_def} instruction, as explained below.
\stopitem
\startitem
\\{fnt\_num\_1} through \\{fnt\_num\_63} (opcodes 172 to 234). Set |f:=1|,
\dots, \hbox{|f:=63|}, respectively.
\stopitem
\startitem
|fnt1| 235 |k[1]|. Set |f:=k|. \TeX82 uses this command for font numbers in
the range |64<=k<256|.
\stopitem
\startitem
|fnt2| 236 |k[2]|. Same as |fnt1|, except that |k|~is two bytes long, so it
is in the range |0<=k<65536|. \TeX82 never generates this command, but large
font numbers may prove useful for specifications of color or texture, or they
may be used for special fonts that have fixed numbers in some external coding
scheme.
\stopitem
\startitem
|fnt3| 237 |k[3]|. Same as |fnt1|, except that |k|~is three bytes long, so it
can be as large as $2^{24}-1$.
\stopitem
\startitem
|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).
\stopitem
\startitem
|xxx1| 239 |k[1]| |x[k]|. This command is undefined in general; it functions
as a $(k+2)$-byte |nop| unless special \.{DVI}-reading programs are being
used. \TeX82 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.
\stopitem
\startitem
|xxx2| 240 |k[2]| |x[k]|. Like |xxx1|, but |0<=k<65536|.
\stopitem
\startitem
|xxx3| 241 |k[3]| |x[k]|. Like |xxx1|, but |0<=k<@t$2^{24}$@>|.
\stopitem
\startitem
|xxx4| 242 |k[4]| |x[k]|. Like |xxx1|, but |k| can be ridiculously large.
\TeX82 uses |xxx4| when sending a string of length 256 or more.
\stopitem
\startitem
|fnt_def1| 243 |k[1]| |c[4]| |s[4]| |d[4]| |a[1]| |l[1]| |n[a+l]|. Define
font |k|, where |0<=k<256|; font definitions will be explained shortly.
\stopitem
\startitem
|fnt_def2| 244 |k[2]| |c[4]| |s[4]| |d[4]| |a[1]| |l[1]| |n[a+l]|. Define
font |k|, where |0<=k<65536|.
\stopitem
\startitem
|fnt_def3| 245 |k[3]| |c[4]| |s[4]| |d[4]| |a[1]| |l[1]| |n[a+l]|. Define
font |k|, where |0<=k<@t$2^{24}$@>|.
\stopitem
\startitem
|fnt_def4| 246 |k[4]| |c[4]| |s[4]| |d[4]| |a[1]| |l[1]| |n[a+l]|. Define
font |k|, where |@t$-2^{31}$@><=k<@t$2^{31}$@>|.
\stopitem
\startitem
|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 file. Parameters |i|,
|num|, |den|, |mag|, |k|, and |x| are explained below.
\stopitem
\startitem
|post| 248. Beginning of the postamble, see below.
\stopitem
\startitem
|post_post| 249. Ending of the postamble, see below.
\stopitem
\startitem
Commands 250--255 are undefined at the present time.
\stopitem
*/
#define set_char_0 0 /* typeset character 0 and move right */
#define set1 128 /* typeset a character and move right */
#define set_rule 132 /* typeset a rule and move right */
#define put1 133 /* typeset a character without moving */
#define put_rule 137 /* typeset a rule */
#define nop 138 /* no operation */
#define bop 139 /* beginning of page */
#define eop 140 /* ending of page */
#define push 141 /* save the current positions */
#define pop 142 /* restore previous positions */
#define right1 143 /* move right */
#define right4 146 /* move right, 4 bytes */
#define w0 147 /* move right by |w| */
#define w1 148 /* move right and set |w| */
#define x0 152 /* move right by |x| */
#define x1 153 /* move right and set |x| */
#define down1 157 /* move down */
#define down4 160 /* move down, 4 bytes */
#define y0 161 /* move down by |y| */
#define y1 162 /* move down and set |y| */
#define z0 166 /* move down by |z| */
#define z1 167 /* move down and set |z| */
#define fnt_num_0 171 /* set current font to 0 */
#define fnt1 235 /* set current font */
#define xxx1 239 /* extension to \.{DVI} primitives */
#define xxx4 242 /* potentially long extension to \.{DVI} primitives */
#define fnt_def1 243 /* define the meaning of a font number */
#define pre 247 /* preamble */
#define post 248 /* postamble beginning */
#define post_post 249 /* postamble ending */
/*tex
The preamble contains basic information about the file as a whole. As stated
above, there are six parameters: $$\hbox{|i[1]| |num[4]| |den[4]|
|mag[4]| |k[1]| |x[k]|.}$$ The |i| byte identifies \.{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 change---perhaps in the year 2048.)
The next two parameters, |num| and |den|, are positive integers that define the
units of measurement; they are the numerator and denominator of a fraction by
which all dimensions in the \.{DVI} file could be multiplied in order to get
lengths in units of $10^{-7}$ meters. Since $\rm 7227{pt} = 254{cm}$, and since
\TeX\ works with scaled points where there are $2^{16}$ sp in a point, \TeX\ sets
$|num|/|den|=(254\cdot10^5)/(7227\cdot2^{16})=25400000/473628672$.
The |mag| parameter is what \TeX\ calls \.{\\mag}, i.e., 1000 times the desired
magnification. The actual fraction by which dimensions are multiplied is
therefore $|mag|\cdot|num|/1000|den|$. Note that if a \TeX\ source document does
not call for any `\.{true}' dimensions, and if you change it only by specifying a
different \.{\\mag} setting, the \.{DVI} file that \TeX\ 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} file 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|.
The next macro identifies the kind of \.{DVI} files described here.
*/
#define id_byte 2
/*tex
Font definitions for a given font number |k| contain further parameters
$$\hbox{|c[4]| |s[4]| |d[4]| |a[1]| |l[1]| |n[a+l]|.}$$ The four-byte value |c|
is the check sum that \TeX\ found in the \.{TFM} file for this font; |c| should
match the check sum of the font found by programs that read this \.{DVI} file.
Parameter |s| contains a fixed-point scale factor that is applied to the
character widths in font |k|; font dimensions in \.{TFM} files and other font
files 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
\TeX82 has made the file. 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|\cdot s/1000d$ times its normal size.
The remaining part of a font definition 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| field
contains the area in its first |a| bytes.
Font definitions must appear before the first use of a particular font number.
Once font |k| is defined, it must not be defined again; however, we
shall see below that font definitions appear in the postamble as well as
in the pages, so in this sense each font number is defined exactly twice,
if at all. Like |nop| commands, font definitions can
appear before the first |bop|, or between an |eop| and a |bop|.
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 \MF\ by
adhering to the following principles: (1)~The \MF\ 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 \MF\ raster. This ensures that the position of the rule will
not be rounded differently when the pixel size is not a perfect multiple of the
units of measurement in the \.{DVI} file. (2)~A typeset rule of height $a>0$ and
width $b>0$ should be equivalent to a \MF-generated character having black pixels
in precisely those raster positions whose \MF\ coordinates satisfy
|0<=x<@t$\alpha$@>b| and |0<=y<@t$\alpha$@>a|, where $\alpha$ is the number of
pixels per \.{DVI} unit.
The last page in a \.{DVI} file is followed by `|post|'; this command introduces
the postamble, which summarizes important facts that \TeX\ has accumulated about
the file, making it possible to print subsets of the data with reasonable
efficiency. The postamble has the form
$$\vbox{\halign{\hbox{#\hfil}\cr
|post| |p[4]| |num[4]| |den[4]| |mag[4]| |l[4]| |u[4]| |s[2]| |t[2]|\cr
$\langle\,$font definitions$\,\rangle$\cr
|post_post| |q[4]| |i[1]| 223's$[{\G}4]$\cr}}$$
Here |p| is a pointer to the final |bop| in the file. 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 file. These numbers might be used by a \.{DVI}-reading program to position
individual ``pages'' on large sheets of film 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 fixed 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 file. Then comes |t|,
the total number of pages (|bop| commands) present.
The postamble continues with font definitions, 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} file must be defined
exactly twice: Once before it is first selected by a \\{fnt} command, and once in
the postamble.
The last part of the postamble, following the |post_post| byte that signifies the
end of the font definitions, contains |q|, a pointer to the |post| command that
started the postamble. An identification 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). \TeX\ puts out four to seven of these trailing
bytes, until the total length of the file is a multiple of four bytes, since this
works out best on machines that pack four bytes per word; but any number of 223's
is allowed, as long as there are at least four of them. In effect, 223 is a sort
of signature that is added at the very end.
This curious way to finish off a \.{DVI} file makes it feasible for
\.{DVI}-reading programs to find the postamble first, on most computers, even
though \TeX\ wants to write the postamble last. Most operating systems permit
random access to individual words or bytes of a file, so the \.{DVI} reader can
start at the end and skip backwards over the 223's until finding the
identification byte. Then it can back up four bytes, read |q|, and move to byte
|q| of the file. 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} file at reasonably high speed to locate a particular page, if that
proves desirable. This saves a lot of time, since \.{DVI} files used in
production jobs tend to be large.
Unfortunately, however, standard \PASCAL\ does not include the ability to access
a random position in a file, or even to determine the length of a file. Almost
all systems nowadays provide the necessary capabilities, so \.{DVI} format has
been designed to work most efficiently with modern operating systems. But if
\.{DVI} files 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 definitions. (The |l| and
|u| and |s| and |t| parameters, which appear only in the postamble, are
``frills'' that are handy but not absolutely necessary.)
After considering \TeX's 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_file|. 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 defined 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.
*/
/* Some global variables are defined in |backend| module. */
static int max_push = 0; /* deepest nesting of |push| commands encountered so far */
static int last_bop = -1; /* location of previous |bop| in the \.{DVI} output */
static int oval, ocmd; /* used by |out_cmd| for generating |set|, |fnt| and |fnt_def| commands */
pointer g; /* current glue specification */
/*tex
The \.{DVI} bytes are output to a buffer instead of being written directly to the
output file. 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 \TeX's inner loop. And it has another advantage as well, since we can
change instructions in the buffer 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 buffer is divided into two parts of equal size; the bytes found in
|dvi_buf[0..half_buf-1]| constitute the first 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 buffer 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 buffer's worth of information present, except at the very
beginning of the job.
Bytes of the \.{DVI} file are numbered sequentially starting with 0; the next
byte to be generated will be number |dvi_offset+dvi_ptr|. A byte is present in
the buffer only if its number is |>=dvi_gone|.
Some systems may find it more efficient to make |dvi_buf| a |packed| array, since
output of four bytes at once may be facilitated.
Initially the buffer is all in one piece; we will output half of it only after it
first fills up.
*/
int dvi_buf_size = 800; /* size of the output buffer; must be a multiple of 8 */
eight_bits *dvi_buf; /* buffer for \.{DVI} output */
static int half_buf = 0; /* half of |dvi_buf_size| */
static int dvi_limit = 0; /* end of the current half buffer */
static int dvi_ptr = 0; /* the next available buffer address */
static int dvi_offset = 0; /* |dvi_buf_size| times the number of times the output buffer has been fully emptied */
static int dvi_gone = 0; /* the number of bytes already output to |dvi_file| */
/*
To put a byte in the buffer without paying the cost of invoking a procedure
each time, we use the macro |dvi_out|.
*/
#define dvi_out(A) do { \
dvi_buf[dvi_ptr++]=(eight_bits)(A); \
if (dvi_ptr==dvi_limit) dvi_swap(); \
} while (0)
#define dvi_set(A,B) do { \
oval=A; ocmd=set1; out_cmd(); dvi.h += (B); \
} while (0)
#define dvi_put(A) do { \
oval=A; ocmd=put1; out_cmd(); \
} while (0)
/*
The |vinfo| fields 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_fixed| means it must stay
\\{down}.
The four settings |yz_OK|, |y_OK|, |z_OK|, |d_fixed| would not need to
be distinguished from each other if we were simply solving the
digit-subscripting problem mentioned above. But in \TeX's case there is
a complication because of the nested structure of |push| and |pop|
commands. Suppose we add parentheses to the digit-subscripting problem,
redefining hits so that $\delta_y\ldots \delta_y$ is a hit if all $y$'s between
the $\delta$'s are enclosed in properly nested parentheses, and if the
parenthesis level of the right-hand $\delta_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 final 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\ldots2_y$ hit. But we can change it to $1_z$, scoring a hit
since the intervening $8_z$'s are enclosed in parentheses.
*/
typedef enum {
y_here = 1, /* |vinfo| when the movement entry points to a |y| command */
z_here = 2, /* |vinfo| when the movement entry points to a |z| command */
yz_OK = 3, /* |vinfo| corresponding to an unconstrained \\{down} command */
y_OK = 4, /* |vinfo| corresponding to a \\{down} that can't become a |z| */
z_OK = 5, /* |vinfo| corresponding to a \\{down} that can't become a |y| */
d_fixed = 6, /* |vinfo| corresponding to a \\{down} that can't change */
} movement_codes;
/* 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| fields for quick
decision-making. */
# define none_seen 0 /* no |y_here| or |z_here| nodes have been encountered yet */
# define y_seen 6 /* we have seen |y_here| but not |z_here| */
# define z_seen 12 /* we have seen |z_here| but not |y_here| */
void movement(scaled w, eight_bits o);
/*
extern void prune_movements(int l);
*/
/*
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} file to lump these
three quantities together into a single motion.
Therefore, \TeX\ 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} file, 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 reflected
in the output, until such a change becomes necessary or desirable; we
can call the |movement| procedure whenever we want to make |dvi.h=pos.h|
or |dvi.v=pos.v|.
The current font reflected 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.
*/
/*tex A \.{DVI} position in page coordinates, in sync with DVI file: */
static scaledpos dvi;
# define synch_h(p) do { \
if (p.h != dvi.h) { \
movement(p.h - dvi.h, right1); \
dvi.h = p.h; \
} \
} while (0)
# define synch_v(p) do { \
if (p.v != dvi.v) { \
movement(dvi.v - p.v, down1); \
dvi.v = p.v; \
} \
} while (0)
# define synch_dvi_with_pos(p) do {synch_h(p); synch_v(p); } while (0)
/*tex
The actual output of |dvi_buf[a..b]| to |dvi_file| 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 \TeX's 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
efficient methods to pack four bytes per word and to output an array of words
with one system call.
*/
static void write_dvi(int a, int b)
{
int k;
for (k = a; k <= b; k++)
fputc(dvi_buf[k], static_pdf->file);
}
/*tex This outputs half of the buffer: */
static void dvi_swap(void)
{
if (dvi_limit == dvi_buf_size) {
write_dvi(0, half_buf - 1);
dvi_limit = half_buf;
dvi_offset = dvi_offset + dvi_buf_size;
dvi_ptr = 0;
} else {
write_dvi(half_buf, dvi_buf_size - 1);
dvi_limit = dvi_buf_size;
}
dvi_gone = dvi_gone + half_buf;
}
/*tex
The |dvi_four| procedure outputs four bytes in two's complement notation, without
risking arithmetic overflow.
*/
static void dvi_four(int x)
{
if (x >= 0) {
dvi_out(x / 0100000000);
} else {
x = x + 010000000000;
x = x + 010000000000;
dvi_out((x / 0100000000) + 128);
}
x = x % 0100000000;
dvi_out(x / 0200000);
x = x % 0200000;
dvi_out(x / 0400);
dvi_out(x % 0400);
}
/*tex
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|.
*/
static void dvi_push(void)
{
dvi_out(push);
}
static void dvi_pop(int l)
{
if ((l == dvi_offset + dvi_ptr) && (dvi_ptr > 0))
decr(dvi_ptr);
else
dvi_out(pop);
}
/*tex
Here's a procedure that outputs a font definition. $\Omega$ allows more than 256
different fonts per job, so the right font definition command must be selected.
*/
static void out_cmd(void)
{
if ((oval < 0x100) && (oval >= 0)) {
if ((ocmd != set1) || (oval > 127)) {
if ((ocmd == fnt1) && (oval < 64))
oval += fnt_num_0;
else
dvi_out(ocmd);
}
} else {
if ((oval < 0x10000) && (oval >= 0)) {
dvi_out(ocmd + 1);
} else {
if ((oval < 0x1000000) && (oval >= 0)) {
dvi_out(ocmd + 2);
} else {
dvi_out(ocmd + 3);
if (oval >= 0) {
dvi_out(oval / 0x1000000);
} else {
oval += 0x40000000;
oval += 0x40000000;
dvi_out((oval / 0x1000000) + 128);
oval = oval % 0x1000000;
}
dvi_out(oval / 0x10000);
oval = oval % 0x10000;
}
dvi_out(oval / 0x10000);
oval = oval % 0x10000;
}
dvi_out(oval / 0x100);
oval = oval % 0x100;
}
dvi_out(oval);
}
static void dvi_font_def(internal_font_number f)
{
char *fa;
oval = f - 1;
ocmd = fnt_def1;
out_cmd();
dvi_out(font_check_0(f));
dvi_out(font_check_1(f));
dvi_out(font_check_2(f));
dvi_out(font_check_3(f));
dvi_four(font_size(f));
dvi_four(font_dsize(f));
dvi_out(0); /* |font_area(f)| is unused */
dvi_out(strlen(font_name(f)));
/* Output the font name whose internal number is |f| */
fa = font_name(f);
while (*fa != '\0') {
dvi_out(*fa++);
}
}
/*tex
Versions of \TeX\ 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
effective, and it takes comparatively little time.
We can best understand the basic idea by first 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 $y$'s intervene between the two appearances, and a
$z$-hit is defined 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\ldots1_y$ and $5_y\ldots5_y\ldots5_y$) and one $z$-hit
($3_z\ldots3_z$); there are no $d$-hits, since the two appearances of $9_d$ have
$d$'s between them, but we don't count $d$-hits so it doesn't matter how many
there are. These subscripts are analogous to the \.{DVI} commands called
\\{down}, $y$, and $z$, and the digits are analogous to different 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} file.
\TeX's method of assigning subscripts works like this: Append a new digit, say
$\delta$, to the right of the sequence. Now look back through the sequence until