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  * + wb_xyz: word buffers (wb.c)
  18  * + fmt_xyz: line formatting buffers (fmt.c)
  19  * + n_xyz: builtin number register xyz
  20  * + c_xyz: characters for requests like hc and mc
  21  *
  22  */
  23
  24 /* predefined array limits */
  25 #define PATHLEN         1024    /* path length */
  26 #define NFILES          16      /* number of input files */
  27 #define NFONTS          32      /* number of fonts */
  28 #define NGLYPHS         1024    /* glyphs in fonts */
  29 #define NLIGS           128     /* number of font ligatures */
  30 #define NKERNS          1024    /* number of font kerning pairs */
  31 #define FNLEN           32      /* font name length */
  32 #define NMLEN           32      /* macro/register/environment/glyph name length */
  33 #define GNLEN           NMLEN   /* glyph name length */
  34 #define RNLEN           NMLEN   /* register/macro name */
  35 #define ILNLEN          1000    /* line limit of input files */
  36 #define LNLEN           4000    /* line buffer length (ren.c/out.c) */
  37 #define NWORDS          1024    /* number of queued words in formatting buffer */
  38 #define NLINES          32      /* number of queued lines in formatting buffer */
  39 #define NARGS           16      /* number of macro arguments */
  40 #define NPREV           16      /* environment stack depth */
  41 #define NTRAPS          1024    /* number of traps per page */
  42 #define NIES            128     /* number of nested .ie commands */
  43 #define NTABS           16      /* number of tab stops */
  44 #define NCMAPS          512     /* number of character translations (.tr) */
  45 #define NSSTR           32      /* number of nested sstr_push() calls */
  46 #define NFIELDS         32      /* number of fields */
  47 #define MAXFRAC         100000  /* maximum value of the fractional part */
  48 #define LIGLEN          4       /* length of ligatures */
  49 #define NCDEFS          128     /* number of character definitions (.char) */
  50 #define NHYPHS          8       /* maximum hyphenations per word */
  51
  52 /* converting scales */
  53 #define SC_IN           (dev_res)       /* inch in units */
  54 #define SC_PT           (SC_IN / 72)    /* point in units */
  55 #define SC_EM           (n_s * SC_IN / 72)
  56
  57 /* escape sequences */
  58 #define ESC_Q   "bCDhHlLNoSvwxX"        /* \X'ccc' quoted escape sequences */
  59 #define ESC_P   "*fgkmns"               /* \Xc \X(cc \X[ccc] escape sequences */
  60
  61 #define MIN(a, b)       ((a) < (b) ? (a) : (b))
  62 #define MAX(a, b)       ((a) < (b) ? (b) : (a))
  63 #define LEN(a)          (sizeof(a) / sizeof((a)[0]))
  64
  65 /* special characters */
  66 extern int c_ec;        /* escape character (\) */
  67 extern int c_cc;        /* basic control character (.) */
  68 extern int c_c2;        /* no-break control character (') */
  69 #define c_ni    4       /* non-interpreted copy-mode escape */
  70 #define c_hc    env_hc()/* hyphenation character */
  71 #define c_mc    env_mc()/* margin character (.mc) */
  72 #define c_tc    env_tc()
  73 #define c_lc    env_lc()
  74 #define c_bp    "\\:"   /* zero-width word break point */
  75
  76 /* number registers */
  77 int num_get(int id, int inc);
  78 void num_set(int id, int val);
  79 void num_inc(int id, int val);
  80 void num_del(int id);
  81 char *num_str(int id);
  82 char *num_getfmt(int id);
  83 void num_setfmt(int id, char *fmt);
  84 int *nreg(int id);
  85 int eval(char *s, int unit);
  86 int eval_up(char **s, int unit);
  87 int eval_re(char *s, int orig, int unit);
  88
  89 /* string registers */
  90 void str_set(int id, char *s);
  91 void str_dset(int id, void *d);
  92 char *str_get(int id);
  93 void *str_dget(int id);
  94 void str_rm(int id);
  95 void str_rn(int src, int dst);
  96
  97 /* saving and restoring registers before and after printing diverted lines */
  98 void odiv_beg(void);
  99 void odiv_end(void);
 100
 101 /* enviroments */
 102 void env_init(void);
 103 void env_done(void);
 104 struct fmt *env_fmt(void);
 105 char *env_hc(void);
 106 char *env_mc(void);
 107 char *env_tc(void);
 108 char *env_lc(void);
 109 int tab_next(int pos);
 110 int tab_type(int pos);
 111
 112 /* device related variables */
 113 extern int dev_res;
 114 extern int dev_uwid;
 115 extern int dev_hor;
 116 extern int dev_ver;
 117
 118 struct glyph {
 119         char id[GNLEN];         /* device-dependent glyph identifier */
 120         char name[GNLEN];       /* the first character mapped to this glyph */
 121         struct font *font;      /* glyph font */
 122         int wid;                /* character width */
 123         int type;               /* character type; ascender/descender */
 124         int llx, lly, urx, ury; /* character bounding box */
 125 };
 126
 127 struct font {
 128         char name[FNLEN];
 129         char fontname[FNLEN];
 130         struct glyph glyphs[NGLYPHS];
 131         int nglyphs;
 132         int spacewid;
 133         int special;
 134         int cs, bd;                     /* for .cs and .bd requests */
 135         /* charset section characters */
 136         char c[NGLYPHS][GNLEN];         /* character names in charset */
 137         struct glyph *g[NGLYPHS];       /* character glyphs in charset */
 138         struct glyph *g_map[NGLYPHS];   /* character remapped via font_map() */
 139         int n;                          /* number of characters in charset */
 140         /* glyph table based on the first character of their id fields in glyphs[] */
 141         int ghead[256];                 /* glyph list heads */
 142         int gnext[NGLYPHS];             /* next item in glyph lists */
 143         /* character table based on the first character of glyph names in c[] */
 144         int chead[256];                 /* character list heads */
 145         int cnext[NGLYPHS];             /* next item in character lists */
 146         /* font ligatures (lg*) */
 147         char lg[NLIGS][LIGLEN * GNLEN]; /* ligatures */
 148         int lgn;                        /* number of ligatures in lg[] */
 149         /* kerning pair table per glyph (kn*) */
 150         int knhead[NGLYPHS];            /* kerning pairs of glyphs[] */
 151         int knnext[NKERNS];             /* next item in knhead[] list */
 152         int knpair[NKERNS];             /* kerning pair 2nd glyphs */
 153         int knval[NKERNS];              /* font pairwise kerning value */
 154         int knn;                        /* number of kerning pairs */
 155 };
 156
 157 /* output device functions */
 158 int dev_open(char *dir, char *dev);
 159 void dev_close(void);
 160 int dev_mnt(int pos, char *id, char *name);
 161 int dev_pos(char *id);
 162 struct font *dev_font(int pos);
 163 int dev_fontpos(struct font *fn);
 164 void dev_setcs(int fn, int cs);
 165 int dev_getcs(int fn);
 166 void dev_setbd(int fn, int bd);
 167 int dev_getbd(int fn);
 168
 169 /* font-related functions */
 170 struct font *font_open(char *path);
 171 void font_close(struct font *fn);
 172 struct glyph *font_glyph(struct font *fn, char *id);
 173 struct glyph *font_find(struct font *fn, char *name);
 174 int font_lig(struct font *fn, char **c, int n);
 175 int font_kern(struct font *fn, char *c1, char *c2);
 176 int font_islig(struct font *fn, char *s);
 177 int font_map(struct font *fn, char *name, struct glyph *gl);
 178 int font_mapped(struct font *fn, char *name);
 179
 180 /* glyph handling functions */
 181 struct glyph *dev_glyph(char *c, int fn);
 182 int charwid(int fn, int sz, int wid);
 183 int spacewid(int fn, int sz);
 184
 185 /* convert wid in device unitwidth size to size sz */
 186 #define DEVWID(sz, wid)         (((wid) * (sz) + (dev_uwid / 2)) / dev_uwid)
 187
 188 /* different layers of neatroff */
 189 int in_next(void);              /* input layer */
 190 int cp_next(void);              /* copy-mode layer */
 191 int tr_next(void);              /* troff layer */
 192
 193 void in_push(char *s, char **args);
 194 void in_pushnl(char *s, char **args);
 195 void in_so(char *path);         /* .so request */
 196 void in_nx(char *path);         /* .nx request */
 197 void in_ex(void);               /* .ex request */
 198 void in_lf(char *path, int ln); /* .lf request */
 199 void in_queue(char *path);      /* queue the given input file */
 200 char *in_arg(int i);            /* look up argument */
 201 int in_nargs(void);             /* number of arguments */
 202 void in_back(int c);            /* push back input character */
 203 int in_top(void);               /* the first pushed-back character */
 204 char *in_filename(void);        /* current filename */
 205 int in_lnum(void);              /* current line number */
 206
 207 void cp_blk(int skip);          /* skip or read the next line or block */
 208 void cp_wid(int enable);        /* control inlining \w requests */
 209 #define cp_back         in_back /* cp.c is stateless */
 210 int tr_nextreq(void);           /* read the next troff request */
 211
 212 /* variable length string buffer */
 213 struct sbuf {
 214         char *s;                /* allocated buffer */
 215         int sz;                 /* buffer size */
 216         int n;                  /* length of the string stored in s */
 217 };
 218
 219 void sbuf_init(struct sbuf *sbuf);
 220 void sbuf_done(struct sbuf *sbuf);
 221 char *sbuf_buf(struct sbuf *sbuf);
 222 void sbuf_add(struct sbuf *sbuf, int c);
 223 void sbuf_append(struct sbuf *sbuf, char *s);
 224 void sbuf_printf(struct sbuf *sbuf, char *s, ...);
 225 void sbuf_putnl(struct sbuf *sbuf);
 226 void sbuf_cut(struct sbuf *sbuf, int n);
 227 int sbuf_len(struct sbuf *sbuf);
 228 int sbuf_empty(struct sbuf *sbuf);
 229
 230 /* word buffer */
 231 struct wb {
 232         struct sbuf sbuf;
 233         int f, s, m;            /* the last output font and size */
 234         int r_f, r_s, r_m;      /* current font and size; use n_f and n_s if -1 */
 235         int part;               /* partial input (\c) */
 236         int els_neg, els_pos;   /* extra line spacing */
 237         int h, v;               /* buffer vertical and horizontal positions */
 238         int ct, sb, st;         /* \w registers */
 239         int llx, lly, urx, ury; /* bounding box */
 240         int icleft_ll;          /* len after the pending left italic correction */
 241         /* saving previous characters added via wb_put() */
 242         char prev_c[LIGLEN][GNLEN];
 243         int prev_l[LIGLEN];     /* sbuf_len(&wb->sbuf) before wb_put() calls */
 244         int prev_h[LIGLEN];     /* wb->h before wb_put() calls */
 245         int prev_n;             /* number of characters in prev_c[] */
 246         int prev_ll;            /* sbuf_len(&wb->sbuf) after the last wb_put() */
 247 };
 248
 249 void wb_init(struct wb *wb);
 250 void wb_done(struct wb *wb);
 251 void wb_hmov(struct wb *wb, int n);
 252 void wb_vmov(struct wb *wb, int n);
 253 void wb_els(struct wb *wb, int els);
 254 void wb_etc(struct wb *wb, char *x);
 255 void wb_put(struct wb *wb, char *c);
 256 void wb_putexpand(struct wb *wb, char *c);
 257 int wb_part(struct wb *wb);
 258 void wb_setpart(struct wb *wb);
 259 void wb_drawl(struct wb *wb, int c, int h, int v);
 260 void wb_drawc(struct wb *wb, int c, int r);
 261 void wb_drawe(struct wb *wb, int c, int h, int v);
 262 void wb_drawa(struct wb *wb, int c, int h1, int v1, int h2, int v2);
 263 void wb_drawxbeg(struct wb *wb, int c);
 264 void wb_drawxdot(struct wb *wb, int h, int v);
 265 void wb_drawxend(struct wb *wb);
 266 void wb_italiccorrection(struct wb *wb);
 267 void wb_italiccorrectionleft(struct wb *wb);
 268 void wb_cat(struct wb *wb, struct wb *src);
 269 int wb_hyph(char *word, int *hyidx, int *hywid, int *hydash, int flg);
 270 int wb_wid(struct wb *wb);
 271 int wb_empty(struct wb *wb);
 272 int wb_eos(struct wb *wb);
 273 void wb_wconf(struct wb *wb, int *ct, int *st, int *sb,
 274                 int *llx, int *lly, int *urx, int *ury);
 275 int wb_lig(struct wb *wb, char *c);
 276 int wb_kern(struct wb *wb, char *c);
 277 void wb_reset(struct wb *wb);
 278 char *wb_buf(struct wb *wb);
 279
 280 /* character translation (.tr) */
 281 void cmap_add(char *c1, char *c2);
 282 char *cmap_map(char *c);
 283 /* character definition (.char) */
 284 char *cdef_map(char *c, int fn);
 285 int cdef_expand(struct wb *wb, char *c, int fn);
 286
 287 /* hyphenation flags */
 288 #define HY_LAST         0x02    /* do not hyphenate last lines */
 289 #define HY_FINAL2       0x04    /* do not hyphenate the final two characters */
 290 #define HY_FIRST2       0x08    /* do not hyphenate the first two characters */
 291
 292 void hyphenate(char *hyphs, char *word, int flg);
 293
 294 /* adjustment types */
 295 #define AD_C            0       /* center */
 296 #define AD_L            1       /* adjust left margin (flag) */
 297 #define AD_R            2       /* adjust right margin (flag) */
 298 #define AD_B            3       /* adjust both margin (mask) */
 299 #define AD_P            4       /* paragraph-at-once adjustment (flag) */
 300
 301 /* line formatting */
 302 struct fmt *fmt_alloc(void);
 303 void fmt_free(struct fmt *fmt);
 304 int fmt_wid(struct fmt *fmt);
 305 void fmt_word(struct fmt *fmt, struct wb *wb);
 306 void fmt_newline(struct fmt *fmt);
 307 void fmt_space(struct fmt *fmt);
 308 void fmt_br(struct fmt *fmt);
 309 int fmt_fill(struct fmt *fmt, int all);
 310 int fmt_morelines(struct fmt *fmt);
 311 int fmt_morewords(struct fmt *fmt);
 312 int fmt_nextline(struct fmt *fmt, struct sbuf *sbuf, int *w,
 313                 int *li, int *ll, int *els_neg, int *els_pos);
 314
 315 /* rendering */
 316 int render(void);                               /* the main loop */
 317 int ren_parse(struct wb *wb, char *c);
 318 int ren_char(struct wb *wb, int (*next)(void), void (*back)(int));
 319 int ren_wid(int (*next)(void), void (*back)(int));
 320 void ren_tl(int (*next)(void), void (*back)(int));
 321 void ren_hline(struct wb *wb, int l, char *c);  /* horizontal line */
 322 void ren_hlcmd(struct wb *wb, char *arg);       /* \l */
 323 void ren_vlcmd(struct wb *wb, char *arg);       /* \L */
 324 void ren_bcmd(struct wb *wb, char *arg);        /* \b */
 325 void ren_ocmd(struct wb *wb, char *arg);        /* \o */
 326 void ren_dcmd(struct wb *wb, char *arg);        /* \D */
 327
 328 /* out.c */
 329 void out_line(char *s);                         /* output rendered line */
 330 void out(char *s, ...);                         /* output troff cmd */
 331
 332 /* troff commands */
 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_dt(char **args);
 343 void tr_em(char **args);
 344 void tr_ev(char **args);
 345 void tr_fc(char **args);
 346 void tr_fi(char **args);
 347 void tr_fp(char **args);
 348 void tr_fspecial(char **args);
 349 void tr_ft(char **args);
 350 void tr_hw(char **args);
 351 void tr_in(char **args);
 352 void tr_ll(char **args);
 353 void tr_mk(char **args);
 354 void tr_ne(char **args);
 355 void tr_nf(char **args);
 356 void tr_ns(char **args);
 357 void tr_os(char **args);
 358 void tr_pn(char **args);
 359 void tr_ps(char **args);
 360 void tr_rs(char **args);
 361 void tr_rt(char **args);
 362 void tr_sp(char **args);
 363 void tr_sv(char **args);
 364 void tr_ta(char **args);
 365 void tr_ti(char **args);
 366 void tr_wh(char **args);
 367 void tr_popren(char **args);
 368
 369 void tr_init(void);
 370
 371 /* helpers */
 372 void errmsg(char *msg, ...);
 373 void errdie(char *msg);
 374 int utf8len(int c);
 375 int utf8next(char *s, int (*next)(void));
 376 int utf8read(char **s, char *d);
 377 int utf8one(char *s);
 378 int charnext(char *c, int (*next)(void), void (*back)(int));
 379 int charread(char **s, char *c);
 380 int charnext_delim(char *c, int (*next)(void), void (*back)(int), char *delim);
 381 void charnext_str(char *d, char *c);
 382 void argnext(char *d, int cmd, int (*next)(void), void (*back)(int));
 383 void argread(char **sp, char *d, int cmd);
 384 int escread(char **s, char *d);
 385 /* string streams; nested next()/back() interface for string buffers */
 386 void sstr_push(char *s);
 387 char *sstr_pop(void);
 388 int sstr_next(void);
 389 void sstr_back(int c);
 390
 391 /* internal commands */
 392 #define TR_DIVBEG       "\07<"  /* diversion begins */
 393 #define TR_DIVEND       "\07>"  /* diversion ends */
 394 #define TR_POPREN       "\07P"  /* exit render_rec() */
 395
 396 /* mapping register, macro and environment names to indices */
 397 #define NREGS           4096    /* maximum number of mapped names */
 398 #define DOTMAP(c2)      (c2)    /* optimized mapping for ".x" names */
 399
 400 int map(char *s);               /* map name s to an index */
 401 char *map_name(int id);         /* return the name mapped to id */
 402
 403 /* colors */
 404 #define CLR_R(c)                (((c) >> 16) & 0xff)
 405 #define CLR_G(c)                (((c) >> 8) & 0xff)
 406 #define CLR_B(c)                ((c) & 0xff)
 407 #define CLR_RGB(r, g, b)        (((r) << 16) | ((g) << 8) | (b))
 408
 409 char *clr_str(int c);
 410 int clr_get(char *s);
 411
 412 /* builtin number registers; n_X for .X register */
 413 #define n_a             (*nreg(DOTMAP('a')))
 414 #define n_cp            (*nreg(DOTMAP('C')))
 415 #define n_d             (*nreg(DOTMAP('d')))
 416 #define n_f             (*nreg(DOTMAP('f')))
 417 #define n_h             (*nreg(DOTMAP('h')))
 418 #define n_i             (*nreg(DOTMAP('i')))
 419 #define n_it            (*nreg(map(".it")))     /* .it trap macro */
 420 #define n_itn           (*nreg(map(".itn")))    /* .it lines left */
 421 #define n_j             (*nreg(DOTMAP('j')))
 422 #define n_l             (*nreg(DOTMAP('l')))
 423 #define n_L             (*nreg(DOTMAP('L')))
 424 #define n_n             (*nreg(DOTMAP('n')))
 425 #define n_nI            (*nreg(map(".nI")))     /* i for .nm */
 426 #define n_nm            (*nreg(map(".nm")))     /* .nm enabled */
 427 #define n_nM            (*nreg(map(".nM")))     /* m for .nm */
 428 #define n_nn            (*nreg(map(".nn")))     /* remaining .nn */
 429 #define n_nS            (*nreg(map(".nS")))     /* s for .nm */
 430 #define n_m             (*nreg(DOTMAP('m')))
 431 #define n_mc            (*nreg(map(".mc")))     /* .mc enabled */
 432 #define n_mcn           (*nreg(map(".mcn")))    /* .mc distance */
 433 #define n_o             (*nreg(DOTMAP('o')))
 434 #define n_p             (*nreg(DOTMAP('p')))
 435 #define n_s             (*nreg(DOTMAP('s')))
 436 #define n_u             (*nreg(DOTMAP('u')))
 437 #define n_v             (*nreg(DOTMAP('v')))
 438 #define n_ct            (*nreg(map("ct")))
 439 #define n_dl            (*nreg(map("dl")))
 440 #define n_dn            (*nreg(map("dn")))
 441 #define n_ln            (*nreg(map("ln")))
 442 #define n_nl            (*nreg(map("nl")))
 443 #define n_sb            (*nreg(map("sb")))
 444 #define n_st            (*nreg(map("st")))
 445 #define n_pg            (*nreg(map("%")))       /* % */
 446 #define n_lb            (*nreg(map(".b0")))     /* input line beg */
 447 #define n_ce            (*nreg(map(".ce")))     /* .ce remaining */
 448 #define n_f0            (*nreg(map(".f0")))     /* last .f */
 449 #define n_lg            (*nreg(map(".lg")))     /* .lg mode */
 450 #define n_hy            (*nreg(map(".hy")))     /* .hy mode */
 451 #define n_hyp           (*nreg(map(".hyp")))    /* hyphenation penalty  */
 452 #define n_i0            (*nreg(map(".i0")))     /* last .i */
 453 #define n_ti            (*nreg(map(".ti")))     /* pending .ti */
 454 #define n_kn            (*nreg(map(".kern")))   /* .kn mode */
 455 #define n_l0            (*nreg(map(".l0")))     /* last .l */
 456 #define n_L0            (*nreg(map(".L0")))     /* last .L */
 457 #define n_m0            (*nreg(map(".m0")))     /* last .m */
 458 #define n_mk            (*nreg(map(".mk")))     /* .mk internal register */
 459 #define n_na            (*nreg(map(".na")))     /* .na mode */
 460 #define n_ns            (*nreg(map(".ns")))     /* .ns mode */
 461 #define n_o0            (*nreg(map(".o0")))     /* last .o */
 462 #define n_ss            (*nreg(map(".ss")))     /* .ss value */
 463 #define n_s0            (*nreg(map(".s0")))     /* last .s */
 464 #define n_sv            (*nreg(map(".sv")))     /* .sv value */
 465 #define n_lt            (*nreg(map(".lt")))     /* .lt value */
 466 #define n_t0            (*nreg(map(".lt0")))    /* previous .lt value */
 467 #define n_v0            (*nreg(map(".v0")))     /* last .v */
 468 #define n_llx           (*nreg(map("bbllx")))   /* \w bounding box */
 469 #define n_lly           (*nreg(map("bblly")))   /* \w bounding box */
 470 #define n_urx           (*nreg(map("bburx")))   /* \w bounding box */
 471 #define n_ury           (*nreg(map("bbury")))   /* \w bounding box */
 472
 473 /* functions for implementing read-only registers */
 474 int f_nexttrap(void);   /* .t */
 475 int f_divreg(void);     /* .z */
 476 int f_hpos(void);       /* .k */