roff.h

   1 /*
   2  * Most functions and variables in neatroff are prefixed with tokens
   3  * that indicate their purpose, such as:
   4  *
   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
  22  *
  23  */
  24
  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 NGLYPHS         1024    /* glyphs in fonts */
  30 #define FNLEN           32      /* font name length */
  31 #define NMLEN           32      /* macro/register/environment/glyph name length */
  32 #define GNLEN           NMLEN   /* glyph name length */
  33 #define RNLEN           NMLEN   /* register/macro name */
  34 #define ILNLEN          1000    /* line limit of input files */
  35 #define LNLEN           4000    /* line buffer length (ren.c/out.c) */
  36 #define NWORDS          1024    /* number of queued words in formatting buffer */
  37 #define NLINES          32      /* number of queued lines in formatting buffer */
  38 #define NARGS           16      /* number of macro arguments */
  39 #define NPREV           16      /* environment stack depth */
  40 #define NTRAPS          1024    /* number of traps per page */
  41 #define NIES            128     /* number of nested .ie commands */
  42 #define NTABS           16      /* number of tab stops */
  43 #define NCMAPS          512     /* number of character translations (.tr) */
  44 #define NSSTR           32      /* number of nested sstr_push() calls */
  45 #define NFIELDS         32      /* number of fields */
  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 */
  53 #define NGRULES         4096    /* number of gsub/gpos rules per font */
  54
  55 /* converting scales */
  56 #define SC_IN           (dev_res)       /* inch in units */
  57 #define SC_PT           (SC_IN / 72)    /* point in units */
  58 #define SC_EM           (n_s * SC_IN / 72)
  59
  60 /* escape sequences */
  61 #define ESC_Q   "bCDhHlLNoRSvwxXZ?"     /* \X'ccc' quoted escape sequences */
  62 #define ESC_P   "*fgkmns"               /* \Xc \X(cc \X[ccc] escape sequences */
  63
  64 #define MIN(a, b)       ((a) < (b) ? (a) : (b))
  65 #define MAX(a, b)       ((a) < (b) ? (b) : (a))
  66 #define LEN(a)          (sizeof(a) / sizeof((a)[0]))
  67
  68 /* special characters */
  69 extern int c_ec;        /* escape character (\) */
  70 extern int c_cc;        /* basic control character (.) */
  71 extern int c_c2;        /* no-break control 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) */
  75 #define c_tc    env_tc()
  76 #define c_lc    env_lc()
  77 #define c_bp    "\\:"   /* zero-width word break point */
  78
  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);
  83 void num_del(int id);
  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);
  88 int *nreg(int id);
  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);
  92
  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);
  98 void str_rm(int id);
  99 void str_rn(int src, int dst);
 100
 101 /* saving and restoring registers before and after printing diverted lines */
 102 void odiv_beg(void);
 103 void odiv_end(void);
 104
 105 /* enviroments */
 106 void env_init(void);
 107 void env_done(void);
 108 struct fmt *env_fmt(void);
 109 struct wb *env_wb(void);
 110 char *env_hc(void);
 111 char *env_mc(void);
 112 char *env_tc(void);
 113 char *env_lc(void);
 114 int tab_next(int pos);
 115 int tab_type(int pos);
 116
 117 /* dictionary */
 118 struct dict {
 119         int *head;
 120         char **key;
 121         long *val;
 122         int *next;
 123         int size;
 124         int n;
 125         char *buf;              /* buffer for keys */
 126         int buflen;
 127         int level2;             /* use two characters for hashing */
 128         long notfound;          /* the value returned for missing keys */
 129 };
 130
 131 void dict_init(struct dict *d, int size, long notfound, int dupkeys, int level2);
 132 void dict_done(struct dict *d);
 133 void dict_put(struct dict *d, char *key, long val);
 134 long dict_get(struct dict *d, char *key);
 135 int dict_idx(struct dict *d, char *key);
 136 char *dict_key(struct dict *d, int idx);
 137 long dict_val(struct dict *d, int idx);
 138 long dict_prefix(struct dict *d, char *key, int *idx);
 139
 140 /* device related variables */
 141 extern int dev_res;
 142 extern int dev_uwid;
 143 extern int dev_hor;
 144 extern int dev_ver;
 145
 146 struct glyph {
 147         char id[GNLEN];         /* device-dependent glyph identifier */
 148         char name[GNLEN];       /* the first character mapped to this glyph */
 149         struct font *font;      /* glyph font */
 150         short wid;              /* character width */
 151         short llx, lly, urx, ury;       /* character bounding box */
 152         short type;             /* character type; ascender/descender */
 153 };
 154
 155 /* output device functions */
 156 int dev_open(char *dir, char *dev);
 157 void dev_close(void);
 158 int dev_mnt(int pos, char *id, char *name);
 159 int dev_pos(char *id);
 160 struct font *dev_font(int pos);
 161 int dev_fontpos(struct font *fn);
 162 struct glyph *dev_glyph(char *c, int fn);
 163
 164 /* font-related functions */
 165 struct font *font_open(char *path);
 166 void font_close(struct font *fn);
 167 struct glyph *font_glyph(struct font *fn, char *id);
 168 struct glyph *font_find(struct font *fn, char *name);
 169 int font_map(struct font *fn, char *name, char *id);
 170 int font_mapped(struct font *fn, char *name);
 171 int font_special(struct font *fn);
 172 int font_wid(struct font *fn, int sz, int w);
 173 int font_gwid(struct font *fn, struct font *cfn, int sz, int w);
 174 int font_swid(struct font *fn, int sz, int ss);
 175 void font_setcs(struct font *fn, int cs, int ps);
 176 int font_getcs(struct font *fn);
 177 void font_setbd(struct font *fn, int bd);
 178 int font_getbd(struct font *fn);
 179 void font_setzoom(struct font *fn, int zoom);
 180 int font_zoom(struct font *fn, int sz);
 181 int font_feat(struct font *fn, char *name, int val);
 182 int font_layout(struct font *fn, struct glyph **src, int nsrc, int sz,
 183                 struct glyph **dst, int *dmap,
 184                 int *x, int *y, int *xadv, int *yadv, int lg, int kn);
 185
 186 /* different layers of neatroff */
 187 int in_next(void);              /* input layer */
 188 int cp_next(void);              /* copy-mode layer */
 189 int tr_next(void);              /* troff layer */
 190
 191 void in_push(char *s, char **args);
 192 void in_so(char *path);         /* .so request */
 193 void in_nx(char *path);         /* .nx request */
 194 void in_ex(void);               /* .ex request */
 195 void in_lf(char *path, int ln); /* .lf request */
 196 void in_queue(char *path);      /* queue the given input file */
 197 char *in_arg(int i);            /* look up argument */
 198 int in_nargs(void);             /* number of arguments */
 199 void in_back(int c);            /* push back input character */
 200 int in_top(void);               /* the first pushed-back character */
 201 char *in_filename(void);        /* current filename */
 202 int in_lnum(void);              /* current line number */
 203
 204 void cp_blk(int skip);          /* skip or read the next line or block */
 205 void cp_reqbeg(void);           /* beginning of a request line */
 206 void cp_copymode(int mode);     /* do not interpret \w and \E */
 207 #define cp_back         in_back /* cp.c is stateless */
 208 int tr_nextreq(void);           /* read the next troff request */
 209
 210 /* variable length string buffer */
 211 struct sbuf {
 212         char *s;                /* allocated buffer */
 213         int sz;                 /* buffer size */
 214         int n;                  /* length of the string stored in s */
 215 };
 216
 217 void sbuf_init(struct sbuf *sbuf);
 218 void sbuf_done(struct sbuf *sbuf);
 219 char *sbuf_buf(struct sbuf *sbuf);
 220 void sbuf_add(struct sbuf *sbuf, int c);
 221 void sbuf_append(struct sbuf *sbuf, char *s);
 222 void sbuf_printf(struct sbuf *sbuf, char *s, ...);
 223 void sbuf_putnl(struct sbuf *sbuf);
 224 void sbuf_cut(struct sbuf *sbuf, int n);
 225 int sbuf_len(struct sbuf *sbuf);
 226 int sbuf_empty(struct sbuf *sbuf);
 227
 228 /* word buffer */
 229 struct wb {
 230         struct sbuf sbuf;
 231         int f, s, m;            /* the last output font and size */
 232         int r_f, r_s, r_m;      /* current font and size; use n_f and n_s if -1 */
 233         int part;               /* partial input (\c) */
 234         int els_neg, els_pos;   /* extra line spacing */
 235         int h, v;               /* buffer vertical and horizontal positions */
 236         int ct, sb, st;         /* \w registers */
 237         int llx, lly, urx, ury; /* bounding box */
 238         int icleft;             /* pending left italic correction */
 239         /* queued subword */
 240         char sub_c[WORDLEN][GNLEN];     /* the collected subword */
 241         int sub_n;              /* collected subword length */
 242         int sub_collect;        /* enable subword collection */
 243 };
 244
 245 void wb_init(struct wb *wb);
 246 void wb_done(struct wb *wb);
 247 void wb_hmov(struct wb *wb, int n);
 248 void wb_vmov(struct wb *wb, int n);
 249 void wb_els(struct wb *wb, int els);
 250 void wb_etc(struct wb *wb, char *x);
 251 void wb_put(struct wb *wb, char *c);
 252 void wb_putraw(struct wb *wb, char *c);
 253 void wb_putexpand(struct wb *wb, char *c);
 254 int wb_part(struct wb *wb);
 255 void wb_setpart(struct wb *wb);
 256 void wb_drawl(struct wb *wb, int c, int h, int v);
 257 void wb_drawc(struct wb *wb, int c, int r);
 258 void wb_drawe(struct wb *wb, int c, int h, int v);
 259 void wb_drawa(struct wb *wb, int c, int h1, int v1, int h2, int v2);
 260 void wb_drawxbeg(struct wb *wb, int c);
 261 void wb_drawxdot(struct wb *wb, int h, int v);
 262 void wb_drawxend(struct wb *wb);
 263 void wb_italiccorrection(struct wb *wb);
 264 void wb_italiccorrectionleft(struct wb *wb);
 265 void wb_cat(struct wb *wb, struct wb *src);
 266 void wb_catstr(struct wb *wb, char *beg, char *end);
 267 int wb_wid(struct wb *wb);
 268 int wb_hpos(struct wb *wb);
 269 int wb_vpos(struct wb *wb);
 270 int wb_empty(struct wb *wb);
 271 int wb_eos(struct wb *wb);
 272 void wb_wconf(struct wb *wb, int *ct, int *st, int *sb,
 273                 int *llx, int *lly, int *urx, int *ury);
 274 void wb_reset(struct wb *wb);
 275 char *wb_buf(struct wb *wb);
 276 void wb_fnszget(struct wb *wb, int *fn, int *sz, int *m);
 277 void wb_fnszset(struct wb *wb, int fn, int sz, int m);
 278 int wb_dashwid(struct wb *wb);
 279 int c_isdash(char *c);
 280
 281 /* character translation (.tr) */
 282 void cmap_add(char *c1, char *c2);
 283 char *cmap_map(char *c);
 284 /* character definition (.char) */
 285 char *cdef_map(char *c, int fn);
 286 int cdef_expand(struct wb *wb, char *c, int fn);
 287
 288 /* hyphenation flags */
 289 #define HY_LAST         0x02    /* do not hyphenate last lines */
 290 #define HY_FINAL2       0x04    /* do not hyphenate the final two characters */
 291 #define HY_FIRST2       0x08    /* do not hyphenate the first two characters */
 292
 293 void hyphenate(char *hyphs, char *word, int flg);
 294 void hyph_init(void);
 295
 296 /* adjustment types */
 297 #define AD_C            0       /* center */
 298 #define AD_L            1       /* adjust left margin (flag) */
 299 #define AD_R            2       /* adjust right margin (flag) */
 300 #define AD_B            3       /* adjust both margin (mask) */
 301 #define AD_P            4       /* paragraph-at-once adjustment (flag) */
 302
 303 /* line formatting */
 304 struct fmt *fmt_alloc(void);
 305 void fmt_free(struct fmt *fmt);
 306 int fmt_wid(struct fmt *fmt);
 307 void fmt_space(struct fmt *fmt);
 308 void fmt_suppressnl(struct fmt *fmt);
 309 int fmt_word(struct fmt *fmt, struct wb *wb);
 310 int fmt_newline(struct fmt *fmt);
 311 int fmt_fillreq(struct fmt *f);
 312 int fmt_br(struct fmt *fmt);
 313 int fmt_fill(struct fmt *fmt);
 314 int fmt_morelines(struct fmt *fmt);
 315 int fmt_morewords(struct fmt *fmt);
 316 int fmt_nextline(struct fmt *fmt, struct sbuf *sbuf, int *w,
 317                 int *li, int *ll, int *els_neg, int *els_pos);
 318
 319 /* rendering */
 320 int render(void);                               /* the main loop */
 321 int ren_parse(struct wb *wb, char *c);
 322 int ren_char(struct wb *wb, int (*next)(void), void (*back)(int));
 323 int ren_wid(int (*next)(void), void (*back)(int));
 324 void ren_tl(int (*next)(void), void (*back)(int));
 325 void ren_hline(struct wb *wb, int l, char *c);  /* horizontal line */
 326 void ren_hlcmd(struct wb *wb, char *arg);       /* \l */
 327 void ren_vlcmd(struct wb *wb, char *arg);       /* \L */
 328 void ren_bcmd(struct wb *wb, char *arg);        /* \b */
 329 void ren_ocmd(struct wb *wb, char *arg);        /* \o */
 330 void ren_dcmd(struct wb *wb, char *arg);        /* \D */
 331 void ren_zcmd(struct wb *wb, char *arg);        /* \Z */
 332
 333 /* out.c */
 334 void out_line(char *s);                         /* output rendered line */
 335 void out(char *s, ...);                         /* output troff cmd */
 336
 337 /* troff commands */
 338 void tr_ab(char **args);
 339 void tr_bp(char **args);
 340 void tr_br(char **args);
 341 void tr_ce(char **args);
 342 void tr_ch(char **args);
 343 void tr_cl(char **args);
 344 void tr_di(char **args);
 345 void tr_divbeg(char **args);
 346 void tr_divend(char **args);
 347 void tr_dt(char **args);
 348 void tr_em(char **args);
 349 void tr_ev(char **args);
 350 void tr_fc(char **args);
 351 void tr_fi(char **args);
 352 void tr_fp(char **args);
 353 void tr_fspecial(char **args);
 354 void tr_ft(char **args);
 355 void tr_hcode(char **args);
 356 void tr_hpf(char **args);
 357 void tr_hpfa(char **args);
 358 void tr_hw(char **args);
 359 void tr_in(char **args);
 360 void tr_ll(char **args);
 361 void tr_mk(char **args);
 362 void tr_ne(char **args);
 363 void tr_nf(char **args);
 364 void tr_ns(char **args);
 365 void tr_os(char **args);
 366 void tr_pn(char **args);
 367 void tr_ps(char **args);
 368 void tr_rs(char **args);
 369 void tr_rt(char **args);
 370 void tr_sp(char **args);
 371 void tr_sv(char **args);
 372 void tr_ta(char **args);
 373 void tr_ti(char **args);
 374 void tr_wh(char **args);
 375 void tr_popren(char **args);
 376 void tr_transparent(char **args);
 377
 378 void tr_init(void);
 379 int tr_readargs(char **args, struct sbuf *sbuf,
 380                 int (*next)(void), void (*back)(int));
 381
 382 /* helpers */
 383 void errmsg(char *msg, ...);
 384 void errdie(char *msg);
 385 void *xmalloc(long len);
 386 int utf8len(int c);
 387 int utf8next(char *s, int (*next)(void));
 388 int utf8read(char **s, char *d);
 389 int utf8one(char *s);
 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);
 401 int sstr_next(void);
 402 void sstr_back(int c);
 403
 404 /* internal commands */
 405 #define TR_DIVBEG       "\07<"  /* diversion begins */
 406 #define TR_DIVEND       "\07>"  /* diversion ends */
 407 #define TR_POPREN       "\07P"  /* exit render_rec() */
 408
 409 /* mapping register, macro and environment names to indices */
 410 #define NREGS           4096    /* maximum number of mapped names */
 411 #define DOTMAP(c2)      (c2)    /* optimized mapping for ".x" names */
 412
 413 int map(char *s);               /* map name s to an index */
 414 char *map_name(int id);         /* return the name mapped to id */
 415
 416 /* colors */
 417 #define CLR_R(c)                (((c) >> 16) & 0xff)
 418 #define CLR_G(c)                (((c) >> 8) & 0xff)
 419 #define CLR_B(c)                ((c) & 0xff)
 420 #define CLR_RGB(r, g, b)        (((r) << 16) | ((g) << 8) | (b))
 421
 422 char *clr_str(int c);
 423 int clr_get(char *s);
 424
 425 /* builtin number registers; n_X for .X register */
 426 #define n_a             (*nreg(DOTMAP('a')))
 427 #define n_cp            (*nreg(DOTMAP('C')))
 428 #define n_d             (*nreg(DOTMAP('d')))
 429 #define n_f             (*nreg(DOTMAP('f')))
 430 #define n_h             (*nreg(DOTMAP('h')))
 431 #define n_i             (*nreg(DOTMAP('i')))
 432 #define n_it            (*nreg(map(".it")))     /* .it trap macro */
 433 #define n_itn           (*nreg(map(".itn")))    /* .it lines left */
 434 #define n_j             (*nreg(DOTMAP('j')))
 435 #define n_l             (*nreg(DOTMAP('l')))
 436 #define n_L             (*nreg(DOTMAP('L')))
 437 #define n_n             (*nreg(DOTMAP('n')))
 438 #define n_nI            (*nreg(map(".nI")))     /* i for .nm */
 439 #define n_nm            (*nreg(map(".nm")))     /* .nm enabled */
 440 #define n_nM            (*nreg(map(".nM")))     /* m for .nm */
 441 #define n_nn            (*nreg(map(".nn")))     /* remaining .nn */
 442 #define n_nS            (*nreg(map(".nS")))     /* s for .nm */
 443 #define n_m             (*nreg(DOTMAP('m')))
 444 #define n_mc            (*nreg(map(".mc")))     /* .mc enabled */
 445 #define n_mcn           (*nreg(map(".mcn")))    /* .mc distance */
 446 #define n_o             (*nreg(DOTMAP('o')))
 447 #define n_p             (*nreg(DOTMAP('p')))
 448 #define n_s             (*nreg(DOTMAP('s')))
 449 #define n_u             (*nreg(DOTMAP('u')))
 450 #define n_v             (*nreg(DOTMAP('v')))
 451 #define n_ct            (*nreg(map("ct")))
 452 #define n_dl            (*nreg(map("dl")))
 453 #define n_dn            (*nreg(map("dn")))
 454 #define n_ln            (*nreg(map("ln")))
 455 #define n_nl            (*nreg(map("nl")))
 456 #define n_sb            (*nreg(map("sb")))
 457 #define n_st            (*nreg(map("st")))
 458 #define n_pg            (*nreg(map("%")))       /* % */
 459 #define n_lb            (*nreg(map(".b0")))     /* input line beg */
 460 #define n_ce            (*nreg(map(".ce")))     /* .ce remaining */
 461 #define n_f0            (*nreg(map(".f0")))     /* last .f */
 462 #define n_lg            (*nreg(map(".lg")))     /* .lg mode */
 463 #define n_hy            (*nreg(map(".hy")))     /* .hy mode */
 464 #define n_hyp           (*nreg(map(".hyp")))    /* hyphenation penalty  */
 465 #define n_i0            (*nreg(map(".i0")))     /* last .i */
 466 #define n_ti            (*nreg(map(".ti")))     /* pending .ti */
 467 #define n_kn            (*nreg(map(".kern")))   /* .kn mode */
 468 #define n_l0            (*nreg(map(".l0")))     /* last .l */
 469 #define n_L0            (*nreg(map(".L0")))     /* last .L */
 470 #define n_m0            (*nreg(map(".m0")))     /* last .m */
 471 #define n_mk            (*nreg(map(".mk")))     /* .mk internal register */
 472 #define n_na            (*nreg(map(".na")))     /* .na mode */
 473 #define n_ns            (*nreg(map(".ns")))     /* .ns mode */
 474 #define n_o0            (*nreg(map(".o0")))     /* last .o */
 475 #define n_ss            (*nreg(map(".ss")))     /* word space (.ss) */
 476 #define n_sss           (*nreg(map(".sss")))    /* sentence space (.ss) */
 477 #define n_ssh           (*nreg(map(".ssh")))    /* word space compression (.ssh) */
 478 #define n_s0            (*nreg(map(".s0")))     /* last .s */
 479 #define n_sv            (*nreg(map(".sv")))     /* .sv value */
 480 #define n_lt            (*nreg(map(".lt")))     /* .lt value */
 481 #define n_t0            (*nreg(map(".lt0")))    /* previous .lt value */
 482 #define n_v0            (*nreg(map(".v0")))     /* last .v */
 483 #define n_llx           (*nreg(map("bbllx")))   /* \w bounding box */
 484 #define n_lly           (*nreg(map("bblly")))   /* \w bounding box */
 485 #define n_urx           (*nreg(map("bburx")))   /* \w bounding box */
 486 #define n_ury           (*nreg(map("bbury")))   /* \w bounding box */
 487
 488 /* functions for implementing read-only registers */
 489 int f_nexttrap(void);   /* .t */
 490 int f_divreg(void);     /* .z */
 491 int f_hpos(void);       /* .k */