Return to out.h CVS log

Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/out.h, Revision 1.35

1.35    ! schwarze    1: /* $Id: out.h,v 1.34 2020/04/03 11:35:01 schwarze Exp $ */
1.1       kristaps    2: /*
1.16      schwarze    3:  * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.33      schwarze    4:  * Copyright (c) 2014, 2017, 2018 Ingo Schwarze <schwarze@openbsd.org>
1.1       kristaps    5:  *
                      6:  * Permission to use, copy, modify, and distribute this software for any
                      7:  * purpose with or without fee is hereby granted, provided that the above
                      8:  * copyright notice and this permission notice appear in all copies.
                      9:  *
                     10:  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
                     11:  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
                     12:  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
                     13:  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
                     14:  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
                     15:  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
                     16:  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.34      schwarze   17:  *
                     18:  * Utilities for use by multiple mandoc(1) formatters.
1.1       kristaps   19:  */
1.6       kristaps   20:
1.3       kristaps   21: enum   roffscale {
1.18      kristaps   22:        SCALE_CM, /* centimeters (c) */
                     23:        SCALE_IN, /* inches (i) */
                     24:        SCALE_PC, /* pica (P) */
                     25:        SCALE_PT, /* points (p) */
                     26:        SCALE_EM, /* ems (m) */
                     27:        SCALE_MM, /* mini-ems (M) */
                     28:        SCALE_EN, /* ens (n) */
                     29:        SCALE_BU, /* default horizontal (u) */
                     30:        SCALE_VS, /* default vertical (v) */
                     31:        SCALE_FS, /* syn. for u (f) */
1.3       kristaps   32:        SCALE_MAX
                     33: };
                     34:
1.18      kristaps   35: struct roffcol {
                     36:        size_t           width; /* width of cell */
1.33      schwarze   37:        size_t           nwidth; /* max. width of number in cell */
1.18      kristaps   38:        size_t           decimal; /* decimal position in cell */
1.31      schwarze   39:        size_t           spacing; /* spacing after the column */
1.24      schwarze   40:        int              flags; /* layout flags, see tbl_cell */
1.18      kristaps   41: };
                     42:
1.3       kristaps   43: struct roffsu {
                     44:        enum roffscale    unit;
1.4       kristaps   45:        double            scale;
1.3       kristaps   46: };
                     47:
1.29      schwarze   48: typedef        size_t  (*tbl_sulen)(const struct roffsu *, void *);
1.18      kristaps   49: typedef        size_t  (*tbl_strlen)(const char *, void *);
                     50: typedef        size_t  (*tbl_len)(size_t, void *);
                     51:
                     52: struct rofftbl {
1.29      schwarze   53:        tbl_sulen        sulen; /* calculate scaling unit length */
1.18      kristaps   54:        tbl_strlen       slen; /* calculate string length */
                     55:        tbl_len          len; /* produce width of empty space */
                     56:        struct roffcol  *cols; /* master column specifiers */
1.29      schwarze   57:        void            *arg; /* passed to sulen, slen, and len */
1.18      kristaps   58: };
1.26      schwarze   59:
                     60:
                     61: struct tbl_span;
1.3       kristaps   62:
1.28      schwarze   63: const char      *a2roffsu(const char *, struct roffsu *, enum roffscale);
1.34      schwarze   64: void             tblcalc(struct rofftbl *,
1.30      schwarze   65:                        const struct tbl_span *, size_t, size_t);