2 * Most functions and variables in neatroff are prefixed with tokens
3 * that indicate their purpose, such as:
5 * + tr_xyz: the implementation of troff request .xyz (mostly tr.c)
6 * + in_xyz: input layer (in.c)
7 * + cp_xyz: copy-mode interpretation layer (cp.c)
8 * + ren_xyz: rendering characters into lines (ren.c)
9 * + out_xyz: output layer for generating troff output (out.c)
10 * + dev_xyz: output devices (dev.c)
11 * + num_xyz: number registers (reg.c)
12 * + str_xyz: string registers (reg.c)
13 * + env_xyz: environments (reg.c)
14 * + eval_xyz: integer expression evaluation (eval.c)
15 * + font_xyz: fonts (font.c)
16 * + sbuf_xyz: variable length string buffers (sbuf.c)
17 * + dict_xyz: dictionaries (dict.c)
18 * + wb_xyz: word buffers (wb.c)
19 * + fmt_xyz: line formatting buffers (fmt.c)
20 * + n_xyz: builtin number register xyz
21 * + c_xyz: characters for requests like hc and mc
25 /* predefined array limits */
26 #define PATHLEN 1024 /* path length */
27 #define NFILES 16 /* number of input files */
28 #define NFONTS 32 /* number of fonts */
29 #define FNLEN 32 /* font name length */
30 #define NMLEN 32 /* macro/register/environment/glyph name length */
31 #define GNLEN NMLEN /* glyph name length */
32 #define RNLEN NMLEN /* register/macro name */
33 #define ILNLEN 1000 /* line limit of input files */
34 #define LNLEN 4000 /* line buffer length (ren.c/out.c) */
35 #define NWORDS 1024 /* number of queued words in formatting buffer */
36 #define NLINES 32 /* number of queued lines in formatting buffer */
37 #define NARGS 16 /* number of macro arguments */
38 #define NPREV 16 /* environment stack depth */
39 #define NTRAPS 1024 /* number of traps per page */
40 #define NIES 128 /* number of nested .ie commands */
41 #define NTABS 16 /* number of tab stops */
42 #define NCMAPS 512 /* number of character translations (.tr) */
43 #define NSSTR 32 /* number of nested sstr_push() calls */
44 #define NFIELDS 32 /* number of fields */
45 #define NEOS 32 /* number of end of sentence characters */
46 #define MAXFRAC 100000 /* maximum value of the fractional part */
47 #define NCDEFS 128 /* number of character definitions (.char) */
48 #define NHYPHS 16384 /* hyphenation dictionary/patterns (.hw) */
49 #define NHYPHSWORD 16 /* number of hyphenations per word */
50 #define NHCODES 512 /* number of .hcode characters */
51 #define WORDLEN 256 /* word length (for hyph.c) */
52 #define NFEATS 128 /* number of features per font */
54 /* converting scales */
55 #define SC_IN (dev_res) /* inch in units */
56 #define SC_PT (SC_IN / 72) /* point in units */
57 #define SC_EM (n_s * SC_IN / 72)
59 /* escape sequences */
60 #define ESC_Q "bCDhHlLNoRSvwxXZ?" /* \X'ccc' quoted escape sequences */
61 #define ESC_P "*fgkmns" /* \Xc \X(cc \X[ccc] escape sequences */
63 #define MIN(a, b) ((a) < (b) ? (a) : (b))
64 #define MAX(a, b) ((a) < (b) ? (b) : (a))
65 #define LEN(a) (sizeof(a) / sizeof((a)[0]))
67 /* special characters */
68 extern int c_ec
; /* escape character (\) */
69 extern int c_cc
; /* basic control character (.) */
70 extern int c_c2
; /* no-break control character (') */
71 extern char c_pc
[]; /* page number character (%) */
72 #define c_ni 4 /* non-interpreted copy-mode escape */
73 #define c_hc env_hc()/* hyphenation character */
74 #define c_mc env_mc()/* margin character (.mc) */
77 #define c_bp "\\:" /* zero-width word break point */
79 /* number registers */
80 #define num_get(id) (*nreg(id))
81 void num_set(int id
, int val
);
82 void num_inc(int id
, int pos
);
84 char *num_str(int id
);
85 char *num_getfmt(int id
);
86 void num_setfmt(int id
, char *fmt
);
87 void num_setinc(int id
, int val
);
89 int eval(char *s
, int unit
);
90 int eval_up(char **s
, int unit
);
91 int eval_re(char *s
, int orig
, int unit
);
93 /* string registers */
94 void str_set(int id
, char *s
);
95 void str_dset(int id
, void *d
);
96 char *str_get(int id
);
97 void *str_dget(int id
);
99 void str_rn(int src
, int dst
);
101 /* saving and restoring registers before and after printing diverted lines */
108 struct fmt
*env_fmt(void);
109 struct wb
*env_wb(void);
114 int tab_next(int pos
);
115 int tab_type(int pos
);
117 /* mapping integers to sets */
118 struct iset
*iset_make(void);
119 void iset_free(struct iset
*iset
);
120 int *iset_get(struct iset
*iset
, int key
);
121 void iset_put(struct iset
*iset
, int key
, int ent
);
122 int iset_len(struct iset
*iset
, int key
);
124 /* mapping strings to longs */
125 struct dict
*dict_make(int notfound
, int dupkeys
, int level2
);
126 void dict_free(struct dict
*d
);
127 void dict_put(struct dict
*d
, char *key
, int val
);
128 int dict_get(struct dict
*d
, char *key
);
129 int dict_idx(struct dict
*d
, char *key
);
130 char *dict_key(struct dict
*d
, int idx
);
131 int dict_val(struct dict
*d
, int idx
);
132 int dict_prefix(struct dict
*d
, char *key
, int *idx
);
134 /* device related variables */
141 char id
[GNLEN
]; /* device-dependent glyph identifier */
142 char name
[GNLEN
]; /* the first character mapped to this glyph */
143 struct font
*font
; /* glyph font */
144 short wid
; /* character width */
145 short llx
, lly
, urx
, ury
; /* character bounding box */
146 short type
; /* character type; ascender/descender */
149 /* output device functions */
150 int dev_open(char *dir
, char *dev
);
151 void dev_close(void);
152 int dev_mnt(int pos
, char *id
, char *name
);
153 int dev_pos(char *id
);
154 struct font
*dev_font(int pos
);
155 int dev_fontpos(struct font
*fn
);
156 struct glyph
*dev_glyph(char *c
, int fn
);
158 /* font-related functions */
159 struct font
*font_open(char *path
);
160 void font_close(struct font
*fn
);
161 struct glyph
*font_glyph(struct font
*fn
, char *id
);
162 struct glyph
*font_find(struct font
*fn
, char *name
);
163 int font_map(struct font
*fn
, char *name
, char *id
);
164 int font_mapped(struct font
*fn
, char *name
);
165 int font_special(struct font
*fn
);
166 int font_wid(struct font
*fn
, int sz
, int w
);
167 int font_gwid(struct font
*fn
, struct font
*cfn
, int sz
, int w
);
168 int font_swid(struct font
*fn
, int sz
, int ss
);
169 void font_setcs(struct font
*fn
, int cs
, int ps
);
170 int font_getcs(struct font
*fn
);
171 void font_setbd(struct font
*fn
, int bd
);
172 int font_getbd(struct font
*fn
);
173 void font_setzoom(struct font
*fn
, int zoom
);
174 int font_zoom(struct font
*fn
, int sz
);
175 int font_feat(struct font
*fn
, char *name
, int val
);
176 int font_layout(struct font
*fn
, struct glyph
**src
, int nsrc
, int sz
,
177 struct glyph
**dst
, int *dmap
,
178 int *x
, int *y
, int *xadv
, int *yadv
, int lg
, int kn
);
180 /* different layers of neatroff */
181 int in_next(void); /* input layer */
182 int cp_next(void); /* copy-mode layer */
183 int tr_next(void); /* troff layer */
185 void in_push(char *s
, char **args
);
186 void in_so(char *path
); /* .so request */
187 void in_nx(char *path
); /* .nx request */
188 void in_ex(void); /* .ex request */
189 void in_lf(char *path
, int ln
); /* .lf request */
190 void in_queue(char *path
); /* queue the given input file */
191 char *in_arg(int i
); /* look up argument */
192 int in_nargs(void); /* number of arguments */
193 void in_back(int c
); /* push back input character */
194 int in_top(void); /* the first pushed-back character */
195 char *in_filename(void); /* current filename */
196 int in_lnum(void); /* current line number */
198 void cp_blk(int skip
); /* skip or read the next line or block */
199 void cp_reqbeg(void); /* beginning of a request line */
200 void cp_copymode(int mode
); /* do not interpret \w and \E */
201 #define cp_back in_back /* cp.c is stateless */
202 int tr_nextreq(void); /* read the next troff request */
204 /* variable length string buffer */
206 char *s
; /* allocated buffer */
207 int sz
; /* buffer size */
208 int n
; /* length of the string stored in s */
211 void sbuf_init(struct sbuf
*sbuf
);
212 void sbuf_done(struct sbuf
*sbuf
);
213 char *sbuf_buf(struct sbuf
*sbuf
);
214 void sbuf_add(struct sbuf
*sbuf
, int c
);
215 void sbuf_append(struct sbuf
*sbuf
, char *s
);
216 void sbuf_printf(struct sbuf
*sbuf
, char *s
, ...);
217 void sbuf_cut(struct sbuf
*sbuf
, int n
);
218 int sbuf_len(struct sbuf
*sbuf
);
219 int sbuf_empty(struct sbuf
*sbuf
);
224 int f
, s
, m
; /* the last output font and size */
225 int r_f
, r_s
, r_m
; /* current font and size; use n_f and n_s if -1 */
226 int part
; /* partial input (\c) */
227 int els_neg
, els_pos
; /* extra line spacing */
228 int h
, v
; /* buffer vertical and horizontal positions */
229 int ct
, sb
, st
; /* \w registers */
230 int llx
, lly
, urx
, ury
; /* bounding box */
231 int icleft
; /* pending left italic correction */
233 char sub_c
[WORDLEN
][GNLEN
]; /* the collected subword */
234 int sub_n
; /* collected subword length */
235 int sub_collect
; /* enable subword collection */
238 void wb_init(struct wb
*wb
);
239 void wb_done(struct wb
*wb
);
240 void wb_hmov(struct wb
*wb
, int n
);
241 void wb_vmov(struct wb
*wb
, int n
);
242 void wb_els(struct wb
*wb
, int els
);
243 void wb_etc(struct wb
*wb
, char *x
);
244 void wb_put(struct wb
*wb
, char *c
);
245 void wb_putraw(struct wb
*wb
, char *c
);
246 void wb_putexpand(struct wb
*wb
, char *c
);
247 int wb_part(struct wb
*wb
);
248 void wb_setpart(struct wb
*wb
);
249 void wb_drawl(struct wb
*wb
, int c
, int h
, int v
);
250 void wb_drawc(struct wb
*wb
, int c
, int r
);
251 void wb_drawe(struct wb
*wb
, int c
, int h
, int v
);
252 void wb_drawa(struct wb
*wb
, int c
, int h1
, int v1
, int h2
, int v2
);
253 void wb_drawxbeg(struct wb
*wb
, int c
);
254 void wb_drawxdot(struct wb
*wb
, int h
, int v
);
255 void wb_drawxend(struct wb
*wb
);
256 void wb_italiccorrection(struct wb
*wb
);
257 void wb_italiccorrectionleft(struct wb
*wb
);
258 void wb_cat(struct wb
*wb
, struct wb
*src
);
259 void wb_catstr(struct wb
*wb
, char *beg
, char *end
);
260 int wb_wid(struct wb
*wb
);
261 int wb_hpos(struct wb
*wb
);
262 int wb_vpos(struct wb
*wb
);
263 int wb_empty(struct wb
*wb
);
264 int wb_eos(struct wb
*wb
);
265 void wb_wconf(struct wb
*wb
, int *ct
, int *st
, int *sb
,
266 int *llx
, int *lly
, int *urx
, int *ury
);
267 void wb_reset(struct wb
*wb
);
268 char *wb_buf(struct wb
*wb
);
269 void wb_fnszget(struct wb
*wb
, int *fn
, int *sz
, int *m
);
270 void wb_fnszset(struct wb
*wb
, int fn
, int sz
, int m
);
271 int wb_dashwid(struct wb
*wb
);
273 int c_eossent(char *s
);
274 int c_eostran(char *s
);
276 /* character translation (.tr) */
277 void cmap_add(char *c1
, char *c2
);
278 char *cmap_map(char *c
);
279 /* character definition (.char) */
280 char *cdef_map(char *c
, int fn
);
281 int cdef_expand(struct wb
*wb
, char *c
, int fn
);
283 /* hyphenation flags */
284 #define HY_LAST 0x02 /* do not hyphenate last lines */
285 #define HY_FINAL2 0x04 /* do not hyphenate the final two characters */
286 #define HY_FIRST2 0x08 /* do not hyphenate the first two characters */
288 void hyphenate(char *hyphs
, char *word
, int flg
);
289 void hyph_init(void);
290 void hyph_done(void);
292 /* adjustment types */
293 #define AD_C 0 /* center */
294 #define AD_L 1 /* adjust left margin (flag) */
295 #define AD_R 2 /* adjust right margin (flag) */
296 #define AD_B 3 /* adjust both margin (mask) */
297 #define AD_P 4 /* paragraph-at-once adjustment (flag) */
299 /* line formatting */
300 struct fmt
*fmt_alloc(void);
301 void fmt_free(struct fmt
*fmt
);
302 int fmt_wid(struct fmt
*fmt
);
303 void fmt_space(struct fmt
*fmt
);
304 void fmt_suppressnl(struct fmt
*fmt
);
305 int fmt_word(struct fmt
*fmt
, struct wb
*wb
);
306 int fmt_newline(struct fmt
*fmt
);
307 int fmt_fillreq(struct fmt
*f
);
308 int fmt_fill(struct fmt
*fmt
, int br
);
309 int fmt_morelines(struct fmt
*fmt
);
310 int fmt_morewords(struct fmt
*fmt
);
311 int fmt_nextline(struct fmt
*fmt
, struct sbuf
*sbuf
, int *w
,
312 int *li
, int *ll
, int *els_neg
, int *els_pos
);
315 int render(void); /* the main loop */
316 int ren_parse(struct wb
*wb
, char *c
);
317 int ren_char(struct wb
*wb
, int (*next
)(void), void (*back
)(int));
318 int ren_wid(int (*next
)(void), void (*back
)(int));
319 void ren_tl(int (*next
)(void), void (*back
)(int));
320 void ren_hline(struct wb
*wb
, int l
, char *c
); /* horizontal line */
321 void ren_hlcmd(struct wb
*wb
, char *arg
); /* \l */
322 void ren_vlcmd(struct wb
*wb
, char *arg
); /* \L */
323 void ren_bcmd(struct wb
*wb
, char *arg
); /* \b */
324 void ren_ocmd(struct wb
*wb
, char *arg
); /* \o */
325 void ren_dcmd(struct wb
*wb
, char *arg
); /* \D */
326 void ren_zcmd(struct wb
*wb
, char *arg
); /* \Z */
329 void out_line(char *s
); /* output rendered line */
330 void out(char *s
, ...); /* output troff cmd */
333 void tr_ab(char **args
);
334 void tr_bp(char **args
);
335 void tr_br(char **args
);
336 void tr_ce(char **args
);
337 void tr_ch(char **args
);
338 void tr_cl(char **args
);
339 void tr_di(char **args
);
340 void tr_divbeg(char **args
);
341 void tr_divend(char **args
);
342 void tr_divvs(char **args
);
343 void tr_dt(char **args
);
344 void tr_em(char **args
);
345 void tr_ev(char **args
);
346 void tr_fc(char **args
);
347 void tr_fi(char **args
);
348 void tr_fp(char **args
);
349 void tr_fspecial(char **args
);
350 void tr_ft(char **args
);
351 void tr_hcode(char **args
);
352 void tr_hpf(char **args
);
353 void tr_hpfa(char **args
);
354 void tr_hw(char **args
);
355 void tr_in(char **args
);
356 void tr_ll(char **args
);
357 void tr_mk(char **args
);
358 void tr_ne(char **args
);
359 void tr_nf(char **args
);
360 void tr_ns(char **args
);
361 void tr_os(char **args
);
362 void tr_pn(char **args
);
363 void tr_ps(char **args
);
364 void tr_rs(char **args
);
365 void tr_rt(char **args
);
366 void tr_sp(char **args
);
367 void tr_sv(char **args
);
368 void tr_ta(char **args
);
369 void tr_ti(char **args
);
370 void tr_wh(char **args
);
371 void tr_popren(char **args
);
372 void tr_transparent(char **args
);
376 int tr_readargs(char **args
, struct sbuf
*sbuf
,
377 int (*next
)(void), void (*back
)(int));
380 void errmsg(char *msg
, ...);
381 void errdie(char *msg
);
382 void *xmalloc(long len
);
383 void *mextend(void *old
, long oldsz
, long newsz
, int memsz
);
386 int utf8next(char *s
, int (*next
)(void));
387 int utf8read(char **s
, char *d
);
388 int utf8one(char *s
);
389 /* reading escapes and characters */
390 int charnext(char *c
, int (*next
)(void), void (*back
)(int));
391 int charread(char **s
, char *c
);
392 int charnext_delim(char *c
, int (*next
)(void), void (*back
)(int), char *delim
);
393 int charread_delim(char **s
, char *c
, char *delim
);
394 void charnext_str(char *d
, char *c
);
395 void quotednext(char *d
, int (*next
)(void), void (*back
)(int));
396 void unquotednext(char *d
, int cmd
, int (*next
)(void), void (*back
)(int));
397 int escread(char **s
, char *d
);
398 /* string streams; nested next()/back() interface for string buffers */
399 void sstr_push(char *s
);
400 char *sstr_pop(void);
402 void sstr_back(int c
);
404 /* internal commands */
405 #define TR_DIVBEG "\07<" /* diversion begins */
406 #define TR_DIVEND "\07>" /* diversion ends */
407 #define TR_DIVVS "\07V" /* the amount of \n(.v inside diversions */
408 #define TR_POPREN "\07P" /* exit render_rec() */
410 /* mapping register, macro and environment names to indices */
411 #define NREGS 4096 /* maximum number of mapped names */
412 #define DOTMAP(c2) (c2) /* optimized mapping for ".x" names */
414 int map(char *s
); /* map name s to an index */
415 char *map_name(int id
); /* return the name mapped to id */
419 #define CLR_R(c) (((c) >> 16) & 0xff)
420 #define CLR_G(c) (((c) >> 8) & 0xff)
421 #define CLR_B(c) ((c) & 0xff)
422 #define CLR_RGB(r, g, b) (((r) << 16) | ((g) << 8) | (b))
424 char *clr_str(int c
);
425 int clr_get(char *s
);
427 /* builtin number registers; n_X for .X register */
428 #define n_a (*nreg(DOTMAP('a')))
429 #define n_cp (*nreg(DOTMAP('C')))
430 #define n_d (*nreg(DOTMAP('d')))
431 #define n_f (*nreg(DOTMAP('f')))
432 #define n_h (*nreg(DOTMAP('h')))
433 #define n_i (*nreg(DOTMAP('i')))
434 #define n_it (*nreg(map(".it"))) /* .it trap macro */
435 #define n_itn (*nreg(map(".itn"))) /* .it lines left */
436 #define n_j (*nreg(DOTMAP('j')))
437 #define n_l (*nreg(DOTMAP('l')))
438 #define n_L (*nreg(DOTMAP('L')))
439 #define n_n (*nreg(DOTMAP('n')))
440 #define n_nI (*nreg(map(".nI"))) /* i for .nm */
441 #define n_nm (*nreg(map(".nm"))) /* .nm enabled */
442 #define n_nM (*nreg(map(".nM"))) /* m for .nm */
443 #define n_nn (*nreg(map(".nn"))) /* remaining .nn */
444 #define n_nS (*nreg(map(".nS"))) /* s for .nm */
445 #define n_m (*nreg(DOTMAP('m')))
446 #define n_mc (*nreg(map(".mc"))) /* .mc enabled */
447 #define n_mcn (*nreg(map(".mcn"))) /* .mc distance */
448 #define n_o (*nreg(DOTMAP('o')))
449 #define n_p (*nreg(DOTMAP('p')))
450 #define n_s (*nreg(DOTMAP('s')))
451 #define n_u (*nreg(DOTMAP('u')))
452 #define n_v (*nreg(DOTMAP('v')))
453 #define n_ct (*nreg(map("ct")))
454 #define n_dl (*nreg(map("dl")))
455 #define n_dn (*nreg(map("dn")))
456 #define n_ln (*nreg(map("ln")))
457 #define n_nl (*nreg(map("nl")))
458 #define n_sb (*nreg(map("sb")))
459 #define n_st (*nreg(map("st")))
460 #define n_pg (*nreg(map("%"))) /* % */
461 #define n_lb (*nreg(map(".b0"))) /* input line beg */
462 #define n_ce (*nreg(map(".ce"))) /* .ce remaining */
463 #define n_f0 (*nreg(map(".f0"))) /* last .f */
464 #define n_lg (*nreg(map(".lg"))) /* .lg mode */
465 #define n_hy (*nreg(map(".hy"))) /* .hy mode */
466 #define n_hyp (*nreg(map(".hyp"))) /* hyphenation penalty */
467 #define n_i0 (*nreg(map(".i0"))) /* last .i */
468 #define n_ti (*nreg(map(".ti"))) /* pending .ti */
469 #define n_kn (*nreg(map(".kern"))) /* .kn mode */
470 #define n_l0 (*nreg(map(".l0"))) /* last .l */
471 #define n_L0 (*nreg(map(".L0"))) /* last .L */
472 #define n_m0 (*nreg(map(".m0"))) /* last .m */
473 #define n_mk (*nreg(map(".mk"))) /* .mk internal register */
474 #define n_na (*nreg(map(".na"))) /* .na mode */
475 #define n_ns (*nreg(map(".ns"))) /* .ns mode */
476 #define n_o0 (*nreg(map(".o0"))) /* last .o */
477 #define n_pmll (*nreg(map(".pmll"))) /* minimum last line (.pmll) */
478 #define n_ss (*nreg(map(".ss"))) /* word space (.ss) */
479 #define n_sss (*nreg(map(".sss"))) /* sentence space (.ss) */
480 #define n_ssh (*nreg(map(".ssh"))) /* word space compression (.ssh) */
481 #define n_s0 (*nreg(map(".s0"))) /* last .s */
482 #define n_sv (*nreg(map(".sv"))) /* .sv value */
483 #define n_lt (*nreg(map(".lt"))) /* .lt value */
484 #define n_t0 (*nreg(map(".lt0"))) /* previous .lt value */
485 #define n_v0 (*nreg(map(".v0"))) /* last .v */
486 #define n_llx (*nreg(map("bbllx"))) /* \w bounding box */
487 #define n_lly (*nreg(map("bblly"))) /* \w bounding box */
488 #define n_urx (*nreg(map("bburx"))) /* \w bounding box */
489 #define n_ury (*nreg(map("bbury"))) /* \w bounding box */
491 /* functions for implementing read-only registers */
492 int f_nexttrap(void); /* .t */
493 int f_divreg(void); /* .z */
494 int f_hpos(void); /* .k */