[BACK]Return to out.c CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/out.c, Revision 1.63

1.63    ! schwarze    1: /*     $Id: out.c,v 1.62 2015/10/12 00:08:16 schwarze Exp $ */
1.1       kristaps    2: /*
1.36      schwarze    3:  * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.63    ! schwarze    4:  * Copyright (c) 2011, 2014, 2015, 2017 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.
                     17:  */
1.12      kristaps   18: #include "config.h"
                     19:
1.1       kristaps   20: #include <sys/types.h>
                     21:
1.6       kristaps   22: #include <assert.h>
1.1       kristaps   23: #include <stdlib.h>
1.6       kristaps   24: #include <string.h>
1.7       kristaps   25: #include <time.h>
1.1       kristaps   26:
1.47      schwarze   27: #include "mandoc_aux.h"
1.30      kristaps   28: #include "mandoc.h"
1.1       kristaps   29: #include "out.h"
                     30:
1.30      kristaps   31: static void    tblcalc_data(struct rofftbl *, struct roffcol *,
1.45      schwarze   32:                        const struct tbl_opts *, const struct tbl_dat *);
1.30      kristaps   33: static void    tblcalc_literal(struct rofftbl *, struct roffcol *,
                     34:                        const struct tbl_dat *);
                     35: static void    tblcalc_number(struct rofftbl *, struct roffcol *,
1.45      schwarze   36:                        const struct tbl_opts *, const struct tbl_dat *);
1.30      kristaps   37:
1.48      schwarze   38:
                     39: /*
1.55      schwarze   40:  * Parse the *src string and store a scaling unit into *dst.
                     41:  * If the string doesn't specify the unit, use the default.
                     42:  * If no default is specified, fail.
1.56      schwarze   43:  * Return 2 on complete success, 1 when a conversion was done,
                     44:  * but there was trailing garbage, and 0 on total failure.
1.3       kristaps   45:  */
1.1       kristaps   46: int
1.5       kristaps   47: a2roffsu(const char *src, struct roffsu *dst, enum roffscale def)
1.1       kristaps   48: {
1.55      schwarze   49:        char            *endptr;
1.1       kristaps   50:
1.56      schwarze   51:        dst->unit = def == SCALE_MAX ? SCALE_BU : def;
                     52:        dst->scale = strtod(src, &endptr);
                     53:        if (endptr == src)
1.61      schwarze   54:                return 0;
1.5       kristaps   55:
1.56      schwarze   56:        switch (*endptr++) {
1.48      schwarze   57:        case 'c':
1.56      schwarze   58:                dst->unit = SCALE_CM;
1.3       kristaps   59:                break;
1.48      schwarze   60:        case 'i':
1.56      schwarze   61:                dst->unit = SCALE_IN;
                     62:                break;
                     63:        case 'f':
                     64:                dst->unit = SCALE_FS;
                     65:                break;
                     66:        case 'M':
                     67:                dst->unit = SCALE_MM;
                     68:                break;
                     69:        case 'm':
                     70:                dst->unit = SCALE_EM;
                     71:                break;
                     72:        case 'n':
                     73:                dst->unit = SCALE_EN;
1.3       kristaps   74:                break;
1.48      schwarze   75:        case 'P':
1.56      schwarze   76:                dst->unit = SCALE_PC;
1.3       kristaps   77:                break;
1.48      schwarze   78:        case 'p':
1.56      schwarze   79:                dst->unit = SCALE_PT;
1.3       kristaps   80:                break;
1.56      schwarze   81:        case 'u':
                     82:                dst->unit = SCALE_BU;
1.3       kristaps   83:                break;
1.48      schwarze   84:        case 'v':
1.56      schwarze   85:                dst->unit = SCALE_VS;
1.3       kristaps   86:                break;
1.48      schwarze   87:        case '\0':
1.56      schwarze   88:                endptr--;
                     89:                /* FALLTHROUGH */
                     90:        default:
1.5       kristaps   91:                if (SCALE_MAX == def)
1.61      schwarze   92:                        return 0;
1.56      schwarze   93:                dst->unit = def;
1.3       kristaps   94:                break;
                     95:        }
1.1       kristaps   96:
1.61      schwarze   97:        return *endptr == '\0' ? 2 : 1;
1.8       kristaps   98: }
1.30      kristaps   99:
                    100: /*
                    101:  * Calculate the abstract widths and decimal positions of columns in a
                    102:  * table.  This routine allocates the columns structures then runs over
                    103:  * all rows and cells in the table.  The function pointers in "tbl" are
                    104:  * used for the actual width calculations.
                    105:  */
                    106: void
1.52      schwarze  107: tblcalc(struct rofftbl *tbl, const struct tbl_span *sp,
                    108:        size_t totalwidth)
1.30      kristaps  109: {
1.58      schwarze  110:        const struct tbl_opts   *opts;
1.30      kristaps  111:        const struct tbl_dat    *dp;
                    112:        struct roffcol          *col;
1.52      schwarze  113:        size_t                   ewidth, xwidth;
1.43      schwarze  114:        int                      spans;
1.58      schwarze  115:        int                      icol, maxcol, necol, nxcol, quirkcol;
1.30      kristaps  116:
                    117:        /*
                    118:         * Allocate the master column specifiers.  These will hold the
                    119:         * widths and decimal positions for all cells in the column.  It
                    120:         * must be freed and nullified by the caller.
                    121:         */
                    122:
                    123:        assert(NULL == tbl->cols);
1.48      schwarze  124:        tbl->cols = mandoc_calloc((size_t)sp->opts->cols,
                    125:            sizeof(struct roffcol));
1.58      schwarze  126:        opts = sp->opts;
1.30      kristaps  127:
1.53      schwarze  128:        for (maxcol = -1; sp; sp = sp->next) {
1.30      kristaps  129:                if (TBL_SPAN_DATA != sp->pos)
                    130:                        continue;
1.43      schwarze  131:                spans = 1;
1.30      kristaps  132:                /*
                    133:                 * Account for the data cells in the layout, matching it
                    134:                 * to data cells in the data section.
                    135:                 */
                    136:                for (dp = sp->first; dp; dp = dp->next) {
1.43      schwarze  137:                        /* Do not used spanned cells in the calculation. */
                    138:                        if (0 < --spans)
                    139:                                continue;
                    140:                        spans = dp->spans;
                    141:                        if (1 < spans)
                    142:                                continue;
1.59      schwarze  143:                        icol = dp->layout->col;
1.52      schwarze  144:                        if (maxcol < icol)
                    145:                                maxcol = icol;
                    146:                        col = tbl->cols + icol;
                    147:                        col->flags |= dp->layout->flags;
                    148:                        if (dp->layout->flags & TBL_CELL_WIGN)
                    149:                                continue;
1.58      schwarze  150:                        tblcalc_data(tbl, col, opts, dp);
1.52      schwarze  151:                }
                    152:        }
                    153:
                    154:        /*
                    155:         * Count columns to equalize and columns to maximize.
                    156:         * Find maximum width of the columns to equalize.
                    157:         * Find total width of the columns *not* to maximize.
                    158:         */
                    159:
                    160:        necol = nxcol = 0;
                    161:        ewidth = xwidth = 0;
                    162:        for (icol = 0; icol <= maxcol; icol++) {
                    163:                col = tbl->cols + icol;
                    164:                if (col->flags & TBL_CELL_EQUAL) {
                    165:                        necol++;
                    166:                        if (ewidth < col->width)
                    167:                                ewidth = col->width;
                    168:                }
                    169:                if (col->flags & TBL_CELL_WMAX)
                    170:                        nxcol++;
                    171:                else
                    172:                        xwidth += col->width;
                    173:        }
                    174:
                    175:        /*
                    176:         * Equalize columns, if requested for any of them.
                    177:         * Update total width of the columns not to maximize.
                    178:         */
                    179:
                    180:        if (necol) {
                    181:                for (icol = 0; icol <= maxcol; icol++) {
                    182:                        col = tbl->cols + icol;
                    183:                        if ( ! (col->flags & TBL_CELL_EQUAL))
                    184:                                continue;
                    185:                        if (col->width == ewidth)
                    186:                                continue;
                    187:                        if (nxcol && totalwidth)
                    188:                                xwidth += ewidth - col->width;
                    189:                        col->width = ewidth;
                    190:                }
                    191:        }
                    192:
                    193:        /*
                    194:         * If there are any columns to maximize, find the total
                    195:         * available width, deducting 3n margins between columns.
                    196:         * Distribute the available width evenly.
                    197:         */
                    198:
                    199:        if (nxcol && totalwidth) {
1.63    ! schwarze  200:                xwidth += 3*maxcol +
1.58      schwarze  201:                    (opts->opts & (TBL_OPT_BOX | TBL_OPT_DBOX) ?
                    202:                     2 : !!opts->lvert + !!opts->rvert);
1.63    ! schwarze  203:                if (xwidth >= totalwidth)
        !           204:                        return;
        !           205:                xwidth = totalwidth - xwidth;
1.58      schwarze  206:
                    207:                /*
                    208:                 * Emulate a bug in GNU tbl width calculation that
                    209:                 * manifests itself for large numbers of x-columns.
                    210:                 * Emulating it for 5 x-columns gives identical
                    211:                 * behaviour for up to 6 x-columns.
                    212:                 */
                    213:
                    214:                if (nxcol == 5) {
                    215:                        quirkcol = xwidth % nxcol + 2;
                    216:                        if (quirkcol != 3 && quirkcol != 4)
                    217:                                quirkcol = -1;
                    218:                } else
                    219:                        quirkcol = -1;
                    220:
                    221:                necol = 0;
                    222:                ewidth = 0;
1.52      schwarze  223:                for (icol = 0; icol <= maxcol; icol++) {
                    224:                        col = tbl->cols + icol;
                    225:                        if ( ! (col->flags & TBL_CELL_WMAX))
                    226:                                continue;
1.58      schwarze  227:                        col->width = (double)xwidth * ++necol / nxcol
                    228:                            - ewidth + 0.4995;
                    229:                        if (necol == quirkcol)
                    230:                                col->width--;
                    231:                        ewidth += col->width;
1.30      kristaps  232:                }
                    233:        }
                    234: }
                    235:
                    236: static void
                    237: tblcalc_data(struct rofftbl *tbl, struct roffcol *col,
1.45      schwarze  238:                const struct tbl_opts *opts, const struct tbl_dat *dp)
1.30      kristaps  239: {
                    240:        size_t           sz;
                    241:
                    242:        /* Branch down into data sub-types. */
                    243:
                    244:        switch (dp->layout->pos) {
1.48      schwarze  245:        case TBL_CELL_HORIZ:
                    246:        case TBL_CELL_DHORIZ:
1.30      kristaps  247:                sz = (*tbl->len)(1, tbl->arg);
                    248:                if (col->width < sz)
                    249:                        col->width = sz;
                    250:                break;
1.48      schwarze  251:        case TBL_CELL_LONG:
                    252:        case TBL_CELL_CENTRE:
                    253:        case TBL_CELL_LEFT:
                    254:        case TBL_CELL_RIGHT:
1.30      kristaps  255:                tblcalc_literal(tbl, col, dp);
                    256:                break;
1.48      schwarze  257:        case TBL_CELL_NUMBER:
1.45      schwarze  258:                tblcalc_number(tbl, col, opts, dp);
1.35      kristaps  259:                break;
1.48      schwarze  260:        case TBL_CELL_DOWN:
1.30      kristaps  261:                break;
                    262:        default:
                    263:                abort();
                    264:        }
                    265: }
                    266:
                    267: static void
                    268: tblcalc_literal(struct rofftbl *tbl, struct roffcol *col,
                    269:                const struct tbl_dat *dp)
                    270: {
1.43      schwarze  271:        size_t           sz;
1.34      kristaps  272:        const char      *str;
1.30      kristaps  273:
1.34      kristaps  274:        str = dp->string ? dp->string : "";
                    275:        sz = (*tbl->slen)(str, tbl->arg);
                    276:
1.30      kristaps  277:        if (col->width < sz)
                    278:                col->width = sz;
                    279: }
                    280:
                    281: static void
                    282: tblcalc_number(struct rofftbl *tbl, struct roffcol *col,
1.45      schwarze  283:                const struct tbl_opts *opts, const struct tbl_dat *dp)
1.30      kristaps  284: {
1.48      schwarze  285:        int              i;
1.34      kristaps  286:        size_t           sz, psz, ssz, d;
                    287:        const char      *str;
1.30      kristaps  288:        char            *cp;
                    289:        char             buf[2];
                    290:
                    291:        /*
                    292:         * First calculate number width and decimal place (last + 1 for
1.43      schwarze  293:         * non-decimal numbers).  If the stored decimal is subsequent to
1.30      kristaps  294:         * ours, make our size longer by that difference
                    295:         * (right-"shifting"); similarly, if ours is subsequent the
                    296:         * stored, then extend the stored size by the difference.
                    297:         * Finally, re-assign the stored values.
                    298:         */
                    299:
1.34      kristaps  300:        str = dp->string ? dp->string : "";
                    301:        sz = (*tbl->slen)(str, tbl->arg);
1.30      kristaps  302:
1.34      kristaps  303:        /* FIXME: TBL_DATA_HORIZ et al.? */
1.30      kristaps  304:
1.45      schwarze  305:        buf[0] = opts->decimal;
1.30      kristaps  306:        buf[1] = '\0';
                    307:
                    308:        psz = (*tbl->slen)(buf, tbl->arg);
                    309:
1.45      schwarze  310:        if (NULL != (cp = strrchr(str, opts->decimal))) {
1.30      kristaps  311:                buf[1] = '\0';
                    312:                for (ssz = 0, i = 0; cp != &str[i]; i++) {
                    313:                        buf[0] = str[i];
                    314:                        ssz += (*tbl->slen)(buf, tbl->arg);
                    315:                }
                    316:                d = ssz + psz;
                    317:        } else
                    318:                d = sz + psz;
                    319:
                    320:        /* Adjust the settings for this column. */
                    321:
                    322:        if (col->decimal > d) {
                    323:                sz += col->decimal - d;
                    324:                d = col->decimal;
                    325:        } else
                    326:                col->width += d - col->decimal;
                    327:
                    328:        if (sz > col->width)
                    329:                col->width = sz;
                    330:        if (d > col->decimal)
                    331:                col->decimal = d;
                    332: }

CVSweb