-/* $Id: out.c,v 1.15 2010/04/07 11:29:55 kristaps Exp $ */
+/* $Id: out.c,v 1.72 2018/08/18 20:18:14 schwarze Exp $ */
/*
- * Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2011,2014,2015,2017,2018 Ingo Schwarze <schwarze@openbsd.org>
*
* Permission to use, copy, modify, and distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
-#ifdef HAVE_CONFIG_H
#include "config.h"
-#endif
#include <sys/types.h>
#include <assert.h>
-#include <ctype.h>
-#include <stdio.h>
+#include <stdint.h>
#include <stdlib.h>
#include <string.h>
#include <time.h>
+#include "mandoc_aux.h"
+#include "mandoc.h"
#include "out.h"
-/* See a2roffdeco(). */
-#define C2LIM(c, l) do { \
- (l) = 1; \
- if ('[' == (c) || '\'' == (c)) \
- (l) = 0; \
- else if ('(' == (c)) \
- (l) = 2; } \
- while (/* CONSTCOND */ 0)
-
-/* See a2roffdeco(). */
-#define C2TERM(c, t) do { \
- (t) = 0; \
- if ('\'' == (c)) \
- (t) = 1; \
- else if ('[' == (c)) \
- (t) = 2; \
- else if ('(' == (c)) \
- (t) = 3; } \
- while (/* CONSTCOND */ 0)
-
-/*
- * Convert a `scaling unit' to a consistent form, or fail. Scaling
- * units are documented in groff.7, mdoc.7, man.7.
+static void tblcalc_data(struct rofftbl *, struct roffcol *,
+ const struct tbl_opts *, const struct tbl_dat *,
+ size_t);
+static void tblcalc_literal(struct rofftbl *, struct roffcol *,
+ const struct tbl_dat *, size_t);
+static void tblcalc_number(struct rofftbl *, struct roffcol *,
+ const struct tbl_opts *, const struct tbl_dat *);
+
+
+/*
+ * Parse the *src string and store a scaling unit into *dst.
+ * If the string doesn't specify the unit, use the default.
+ * If no default is specified, fail.
+ * Return a pointer to the byte after the last byte used,
+ * or NULL on total failure.
*/
-int
+const char *
a2roffsu(const char *src, struct roffsu *dst, enum roffscale def)
{
- char buf[BUFSIZ], hasd;
- int i;
- enum roffscale unit;
-
- if ('\0' == *src)
- return(0);
+ char *endptr;
- i = hasd = 0;
+ dst->unit = def == SCALE_MAX ? SCALE_BU : def;
+ dst->scale = strtod(src, &endptr);
+ if (endptr == src)
+ return NULL;
- switch (*src) {
- case ('+'):
- src++;
+ switch (*endptr++) {
+ case 'c':
+ dst->unit = SCALE_CM;
break;
- case ('-'):
- buf[i++] = *src++;
+ case 'i':
+ dst->unit = SCALE_IN;
break;
- default:
+ case 'f':
+ dst->unit = SCALE_FS;
break;
- }
-
- if ('\0' == *src)
- return(0);
-
- while (i < BUFSIZ) {
- if ( ! isdigit((u_char)*src)) {
- if ('.' != *src)
- break;
- else if (hasd)
- break;
- else
- hasd = 1;
- }
- buf[i++] = *src++;
- }
-
- if (BUFSIZ == i || (*src && *(src + 1)))
- return(0);
-
- buf[i] = '\0';
-
- switch (*src) {
- case ('c'):
- unit = SCALE_CM;
+ case 'M':
+ dst->unit = SCALE_MM;
break;
- case ('i'):
- unit = SCALE_IN;
+ case 'm':
+ dst->unit = SCALE_EM;
break;
- case ('P'):
- unit = SCALE_PC;
+ case 'n':
+ dst->unit = SCALE_EN;
break;
- case ('p'):
- unit = SCALE_PT;
+ case 'P':
+ dst->unit = SCALE_PC;
break;
- case ('f'):
- unit = SCALE_FS;
+ case 'p':
+ dst->unit = SCALE_PT;
break;
- case ('v'):
- unit = SCALE_VS;
+ case 'u':
+ dst->unit = SCALE_BU;
break;
- case ('m'):
- unit = SCALE_EM;
+ case 'v':
+ dst->unit = SCALE_VS;
break;
- case ('\0'):
+ default:
+ endptr--;
if (SCALE_MAX == def)
- return(0);
- unit = SCALE_BU;
- break;
- case ('u'):
- unit = SCALE_BU;
- break;
- case ('M'):
- unit = SCALE_MM;
- break;
- case ('n'):
- unit = SCALE_EN;
+ return NULL;
+ dst->unit = def;
break;
- default:
- return(0);
}
-
- if ((dst->scale = atof(buf)) < 0)
- dst->scale = 0;
- dst->unit = unit;
- dst->pt = hasd;
-
- return(1);
+ return endptr;
}
-
/*
- * Correctly writes the time in nroff form, which differs from standard
- * form in that a space isn't printed in lieu of the extra %e field for
- * single-digit dates.
+ * Calculate the abstract widths and decimal positions of columns in a
+ * table. This routine allocates the columns structures then runs over
+ * all rows and cells in the table. The function pointers in "tbl" are
+ * used for the actual width calculations.
*/
void
-time2a(time_t t, char *dst, size_t sz)
+tblcalc(struct rofftbl *tbl, const struct tbl_span *sp,
+ size_t offset, size_t rmargin)
{
- struct tm tm;
- char buf[5];
- char *p;
- size_t nsz;
-
- assert(sz > 1);
- localtime_r(&t, &tm);
-
- p = dst;
- nsz = 0;
-
- dst[0] = '\0';
-
- if (0 == (nsz = strftime(p, sz, "%B ", &tm)))
- return;
-
- p += (int)nsz;
- sz -= nsz;
-
- if (0 == strftime(buf, sizeof(buf), "%e, ", &tm))
- return;
-
- nsz = strlcat(p, buf + (' ' == buf[0] ? 1 : 0), sz);
-
- if (nsz >= sz)
- return;
-
- p += (int)nsz;
- sz -= nsz;
-
- (void)strftime(p, sz, "%Y", &tm);
-}
-
-
-/*
- * Returns length of parsed string (the leading "\" should NOT be
- * included). This can be zero if the current character is the nil
- * terminator. "d" is set to the type of parsed decorator, which may
- * have an adjoining "word" of size "sz" (e.g., "(ab" -> "ab", 2).
- */
-int
-a2roffdeco(enum roffdeco *d,
- const char **word, size_t *sz)
-{
- int j, term, lim;
- char set;
- const char *wp, *sp;
-
- *d = DECO_NONE;
- wp = *word;
-
- switch ((set = *wp)) {
- case ('\0'):
- return(0);
-
- case ('('):
- if ('\0' == *(++wp))
- return(1);
- if ('\0' == *(wp + 1))
- return(2);
-
- *d = DECO_SPECIAL;
- *sz = 2;
- *word = wp;
- return(3);
-
- case ('F'):
- /* FALLTHROUGH */
- case ('f'):
+ struct roffsu su;
+ const struct tbl_opts *opts;
+ const struct tbl_dat *dp;
+ struct roffcol *col;
+ size_t ewidth, xwidth;
+ int spans;
+ int icol, maxcol, necol, nxcol, quirkcol;
+
+ /*
+ * Allocate the master column specifiers. These will hold the
+ * widths and decimal positions for all cells in the column. It
+ * must be freed and nullified by the caller.
+ */
+
+ assert(NULL == tbl->cols);
+ tbl->cols = mandoc_calloc((size_t)sp->opts->cols,
+ sizeof(struct roffcol));
+ opts = sp->opts;
+
+ for (maxcol = -1; sp; sp = sp->next) {
+ if (TBL_SPAN_DATA != sp->pos)
+ continue;
+ spans = 1;
/*
- * FIXME: this needs work and consolidation (it should
- * follow the sequence that special characters do, for
- * one), but isn't a priority at the moment. Note, for
- * one, that in reality \fB != \FB, although here we let
- * these slip by.
+ * Account for the data cells in the layout, matching it
+ * to data cells in the data section.
*/
- switch (*(++wp)) {
- case ('\0'):
- return(1);
- case ('3'):
- /* FALLTHROUGH */
- case ('B'):
- *d = DECO_BOLD;
- return(2);
- case ('2'):
- /* FALLTHROUGH */
- case ('I'):
- *d = DECO_ITALIC;
- return(2);
- case ('P'):
- *d = DECO_PREVIOUS;
- return(2);
- case ('1'):
- /* FALLTHROUGH */
- case ('R'):
- *d = DECO_ROMAN;
- return(2);
- case ('('):
- if ('\0' == *(++wp))
- return(2);
- if ('\0' == *(wp + 1))
- return(3);
-
- *d = 'F' == set ? DECO_FFONT : DECO_FONT;
- *sz = 2;
- *word = wp;
- return(4);
- case ('['):
- *word = ++wp;
- for (j = 0; *wp && ']' != *wp; wp++, j++)
- /* Loop... */ ;
-
- if ('\0' == *wp)
- return(j + 2);
-
- *d = 'F' == set ? DECO_FFONT : DECO_FONT;
- *sz = (size_t)j;
- return(j + 3);
- default:
- break;
+ for (dp = sp->first; dp; dp = dp->next) {
+ /* Do not used spanned cells in the calculation. */
+ if (0 < --spans)
+ continue;
+ spans = dp->spans;
+ if (1 < spans)
+ continue;
+ icol = dp->layout->col;
+ while (maxcol < icol)
+ tbl->cols[++maxcol].spacing = SIZE_MAX;
+ col = tbl->cols + icol;
+ col->flags |= dp->layout->flags;
+ if (dp->layout->flags & TBL_CELL_WIGN)
+ continue;
+ if (dp->layout->wstr != NULL &&
+ dp->layout->width == 0 &&
+ a2roffsu(dp->layout->wstr, &su, SCALE_EN)
+ != NULL)
+ dp->layout->width =
+ (*tbl->sulen)(&su, tbl->arg);
+ if (col->width < dp->layout->width)
+ col->width = dp->layout->width;
+ if (dp->layout->spacing != SIZE_MAX &&
+ (col->spacing == SIZE_MAX ||
+ col->spacing < dp->layout->spacing))
+ col->spacing = dp->layout->spacing;
+ tblcalc_data(tbl, col, opts, dp,
+ dp->block == 0 ? 0 :
+ dp->layout->width ? dp->layout->width :
+ rmargin ? (rmargin + sp->opts->cols / 2)
+ / (sp->opts->cols + 1) : 0);
}
+ }
- *d = 'F' == set ? DECO_FFONT : DECO_FONT;
- *sz = 1;
- *word = wp;
- return(2);
-
- case ('*'):
- switch (*(++wp)) {
- case ('\0'):
- return(1);
-
- case ('('):
- if ('\0' == *(++wp))
- return(2);
- if ('\0' == *(wp + 1))
- return(3);
-
- *d = DECO_RESERVED;
- *sz = 2;
- *word = wp;
- return(4);
-
- case ('['):
- *word = ++wp;
- for (j = 0; *wp && ']' != *wp; wp++, j++)
- /* Loop... */ ;
-
- if ('\0' == *wp)
- return(j + 2);
-
- *d = DECO_RESERVED;
- *sz = (size_t)j;
- return(j + 3);
-
- default:
- break;
+ /*
+ * Align numbers with text.
+ * Count columns to equalize and columns to maximize.
+ * Find maximum width of the columns to equalize.
+ * Find total width of the columns *not* to maximize.
+ */
+
+ necol = nxcol = 0;
+ ewidth = xwidth = 0;
+ for (icol = 0; icol <= maxcol; icol++) {
+ col = tbl->cols + icol;
+ if (col->width > col->nwidth)
+ col->decimal += (col->width - col->nwidth) / 2;
+ else
+ col->width = col->nwidth;
+ if (col->spacing == SIZE_MAX || icol == maxcol)
+ col->spacing = 3;
+ if (col->flags & TBL_CELL_EQUAL) {
+ necol++;
+ if (ewidth < col->width)
+ ewidth = col->width;
}
+ if (col->flags & TBL_CELL_WMAX)
+ nxcol++;
+ else
+ xwidth += col->width;
+ }
- *d = DECO_RESERVED;
- *sz = 1;
- *word = wp;
- return(2);
-
- case ('s'):
- sp = wp;
- if ('\0' == *(++wp))
- return(1);
-
- C2LIM(*wp, lim);
- C2TERM(*wp, term);
-
- if (term)
- wp++;
-
- *word = wp;
-
- if (*wp == '+' || *wp == '-')
- ++wp;
-
- switch (*wp) {
- case ('\''):
- /* FALLTHROUGH */
- case ('['):
- /* FALLTHROUGH */
- case ('('):
- if (term)
- return((int)(wp - sp));
-
- C2LIM(*wp, lim);
- C2TERM(*wp, term);
- wp++;
- break;
- default:
- break;
+ /*
+ * Equalize columns, if requested for any of them.
+ * Update total width of the columns not to maximize.
+ */
+
+ if (necol) {
+ for (icol = 0; icol <= maxcol; icol++) {
+ col = tbl->cols + icol;
+ if ( ! (col->flags & TBL_CELL_EQUAL))
+ continue;
+ if (col->width == ewidth)
+ continue;
+ if (nxcol && rmargin)
+ xwidth += ewidth - col->width;
+ col->width = ewidth;
}
+ }
- if ( ! isdigit((u_char)*wp))
- return((int)(wp - sp));
+ /*
+ * If there are any columns to maximize, find the total
+ * available width, deducting 3n margins between columns.
+ * Distribute the available width evenly.
+ */
- for (j = 0; isdigit((u_char)*wp); j++) {
- if (lim && j >= lim)
- break;
- ++wp;
- }
+ if (nxcol && rmargin) {
+ xwidth += 3*maxcol +
+ (opts->opts & (TBL_OPT_BOX | TBL_OPT_DBOX) ?
+ 2 : !!opts->lvert + !!opts->rvert);
+ if (rmargin <= offset + xwidth)
+ return;
+ xwidth = rmargin - offset - xwidth;
- if (term && term < 3) {
- if (1 == term && *wp != '\'')
- return((int)(wp - sp));
- if (2 == term && *wp != ']')
- return((int)(wp - sp));
- ++wp;
- }
-
- *d = DECO_SIZE;
- return((int)(wp - sp));
+ /*
+ * Emulate a bug in GNU tbl width calculation that
+ * manifests itself for large numbers of x-columns.
+ * Emulating it for 5 x-columns gives identical
+ * behaviour for up to 6 x-columns.
+ */
- case ('['):
- *word = ++wp;
+ if (nxcol == 5) {
+ quirkcol = xwidth % nxcol + 2;
+ if (quirkcol != 3 && quirkcol != 4)
+ quirkcol = -1;
+ } else
+ quirkcol = -1;
+
+ necol = 0;
+ ewidth = 0;
+ for (icol = 0; icol <= maxcol; icol++) {
+ col = tbl->cols + icol;
+ if ( ! (col->flags & TBL_CELL_WMAX))
+ continue;
+ col->width = (double)xwidth * ++necol / nxcol
+ - ewidth + 0.4995;
+ if (necol == quirkcol)
+ col->width--;
+ ewidth += col->width;
+ }
+ }
+}
- for (j = 0; *wp && ']' != *wp; wp++, j++)
- /* Loop... */ ;
+static void
+tblcalc_data(struct rofftbl *tbl, struct roffcol *col,
+ const struct tbl_opts *opts, const struct tbl_dat *dp, size_t mw)
+{
+ size_t sz;
- if ('\0' == *wp)
- return(j + 1);
+ /* Branch down into data sub-types. */
- *d = DECO_SPECIAL;
- *sz = (size_t)j;
- return(j + 2);
+ switch (dp->layout->pos) {
+ case TBL_CELL_HORIZ:
+ case TBL_CELL_DHORIZ:
+ sz = (*tbl->len)(1, tbl->arg);
+ if (col->width < sz)
+ col->width = sz;
+ break;
+ case TBL_CELL_LONG:
+ case TBL_CELL_CENTRE:
+ case TBL_CELL_LEFT:
+ case TBL_CELL_RIGHT:
+ tblcalc_literal(tbl, col, dp, mw);
+ break;
+ case TBL_CELL_NUMBER:
+ tblcalc_number(tbl, col, opts, dp);
+ break;
+ case TBL_CELL_DOWN:
+ break;
+ default:
+ abort();
+ }
+}
- case ('c'):
- *d = DECO_NOSPACE;
- *sz = 1;
- return(1);
+static void
+tblcalc_literal(struct rofftbl *tbl, struct roffcol *col,
+ const struct tbl_dat *dp, size_t mw)
+{
+ const char *str; /* Beginning of the first line. */
+ const char *beg; /* Beginning of the current line. */
+ char *end; /* End of the current line. */
+ size_t lsz; /* Length of the current line. */
+ size_t wsz; /* Length of the current word. */
- default:
- break;
+ if (dp->string == NULL || *dp->string == '\0')
+ return;
+ str = mw ? mandoc_strdup(dp->string) : dp->string;
+ lsz = 0;
+ for (beg = str; beg != NULL && *beg != '\0'; beg = end) {
+ end = mw ? strchr(beg, ' ') : NULL;
+ if (end != NULL) {
+ *end++ = '\0';
+ while (*end == ' ')
+ end++;
+ }
+ wsz = (*tbl->slen)(beg, tbl->arg);
+ if (mw && lsz && lsz + 1 + wsz <= mw)
+ lsz += 1 + wsz;
+ else
+ lsz = wsz;
+ if (col->width < lsz)
+ col->width = lsz;
}
+ if (mw)
+ free((void *)str);
+}
- *d = DECO_SPECIAL;
- *word = wp;
- *sz = 1;
- return(1);
+static void
+tblcalc_number(struct rofftbl *tbl, struct roffcol *col,
+ const struct tbl_opts *opts, const struct tbl_dat *dp)
+{
+ int i;
+ size_t sz, ssz, d;
+ const char *str;
+ char *cp;
+ char buf[2];
+
+ /*
+ * First calculate number width and decimal place (last + 1 for
+ * non-decimal numbers). If the stored decimal is subsequent to
+ * ours, make our size longer by that difference
+ * (right-"shifting"); similarly, if ours is subsequent the
+ * stored, then extend the stored size by the difference.
+ * Finally, re-assign the stored values.
+ */
+
+ str = dp->string ? dp->string : "";
+ sz = (*tbl->slen)(str, tbl->arg);
+
+ /* FIXME: TBL_DATA_HORIZ et al.? */
+
+ buf[0] = opts->decimal;
+ buf[1] = '\0';
+
+ if (NULL != (cp = strrchr(str, opts->decimal))) {
+ buf[1] = '\0';
+ for (ssz = 0, i = 0; cp != &str[i]; i++) {
+ buf[0] = str[i];
+ ssz += (*tbl->slen)(buf, tbl->arg);
+ }
+ d = ssz;
+ } else
+ d = sz;
+
+ /* Adjust the settings for this column. */
+
+ if (col->decimal > d) {
+ sz += col->decimal - d;
+ d = col->decimal;
+ } else
+ col->nwidth += d - col->decimal;
+
+ if (sz > col->nwidth)
+ col->nwidth = sz;
+ if (d > col->decimal)
+ col->decimal = d;
}