clarify the difference between .Cm and .Ic;

[mandoc.git] / out.c

diff --git a/out.c b/out.c
index 25aa2d475dac9cbf15ec18fa7cf6db009e519883..d0b0d0a2ace3c1c86ef330e2456660e7ef985b78 100644 (file)
--- a/out.c
+++ b/out.c
@@ -1,7 +1,7 @@
-/*     $Id: out.c,v 1.64 2017/06/08 12:54:58 schwarze Exp $ */
+/*     $Id: out.c,v 1.78 2019/03/29 21:27:06 schwarze Exp $ */

 /*
  * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
 /*
  * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>

- * Copyright (c) 2011, 2014, 2015, 2017 Ingo Schwarze <schwarze@openbsd.org>
+ * 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
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above


@@ -20,19 +20,29 @@
 #include <sys/types.h>
 
 #include <assert.h>
 #include <sys/types.h>
 
 #include <assert.h>

+#include <ctype.h>
+#include <stdint.h>

 #include <stdlib.h>
 #include <string.h>
 #include <time.h>
 
 #include "mandoc_aux.h"
 #include <stdlib.h>
 #include <string.h>
 #include <time.h>
 
 #include "mandoc_aux.h"

-#include "mandoc.h"
+#include "tbl.h"

 #include "out.h"
 
 #include "out.h"
 

-static void    tblcalc_data(struct rofftbl *, struct roffcol *,
-                       const struct tbl_opts *, const struct tbl_dat *);
-static void    tblcalc_literal(struct rofftbl *, struct roffcol *,
-                       const struct tbl_dat *);
-static void    tblcalc_number(struct rofftbl *, struct roffcol *,
+struct tbl_colgroup {
+       struct tbl_colgroup     *next;
+       size_t                   wanted;
+       int                      startcol;
+       int                      endcol;
+};
+
+static size_t  tblcalc_data(struct rofftbl *, struct roffcol *,
+                       const struct tbl_opts *, const struct tbl_dat *,
+                       size_t);
+static size_t  tblcalc_literal(struct rofftbl *, struct roffcol *,
+                       const struct tbl_dat *, size_t);
+static size_t  tblcalc_number(struct rofftbl *, struct roffcol *,

                        const struct tbl_opts *, const struct tbl_dat *);
 
 
                        const struct tbl_opts *, const struct tbl_dat *);
 
 


@@ -84,10 +94,8 @@ a2roffsu(const char *src, struct roffsu *dst, enum roffscale def)
        case 'v':
                dst->unit = SCALE_VS;
                break;
        case 'v':
                dst->unit = SCALE_VS;
                break;

-       case '\0':
-               endptr--;
-               /* FALLTHROUGH */

        default:
        default:

+               endptr--;

                if (SCALE_MAX == def)
                        return NULL;
                dst->unit = def;
                if (SCALE_MAX == def)
                        return NULL;
                dst->unit = def;


@@ -103,15 +111,18 @@ a2roffsu(const char *src, struct roffsu *dst, enum roffscale def)
  * used for the actual width calculations.
  */
 void
  * used for the actual width calculations.
  */
 void

-tblcalc(struct rofftbl *tbl, const struct tbl_span *sp,
-       size_t totalwidth)
+tblcalc(struct rofftbl *tbl, const struct tbl_span *sp_first,
+    size_t offset, size_t rmargin)

 {
 {

+       struct roffsu            su;

        const struct tbl_opts   *opts;
        const struct tbl_opts   *opts;

+       const struct tbl_span   *sp;

        const struct tbl_dat    *dp;
        struct roffcol          *col;
        const struct tbl_dat    *dp;
        struct roffcol          *col;

-       size_t                   ewidth, xwidth;
-       int                      spans;
-       int                      icol, maxcol, necol, nxcol, quirkcol;
+       struct tbl_colgroup     *first_group, **gp, *g;
+       size_t                  *colwidth;
+       size_t                   ewidth, min1, min2, wanted, width, xwidth;
+       int                      done, icol, maxcol, necol, nxcol, quirkcol;

 
        /*
         * Allocate the master column specifiers.  These will hold the
 
        /*
         * Allocate the master column specifiers.  These will hold the


@@ -119,38 +130,205 @@ tblcalc(struct rofftbl *tbl, const struct tbl_span *sp,
         * must be freed and nullified by the caller.
         */
 
         * must be freed and nullified by the caller.
         */
 

-       assert(NULL == tbl->cols);
-       tbl->cols = mandoc_calloc((size_t)sp->opts->cols,
+       assert(tbl->cols == NULL);
+       tbl->cols = mandoc_calloc((size_t)sp_first->opts->cols,

            sizeof(struct roffcol));
            sizeof(struct roffcol));

-       opts = sp->opts;
+       opts = sp_first->opts;

 
 

-       for (maxcol = -1; sp; sp = sp->next) {
-               if (TBL_SPAN_DATA != sp->pos)
+       maxcol = -1;
+       first_group = NULL;
+       for (sp = sp_first; sp != NULL; sp = sp->next) {
+               if (sp->pos != TBL_SPAN_DATA)

                        continue;
                        continue;

-               spans = 1;
+

                /*
                 * Account for the data cells in the layout, matching it
                 * to data cells in the data section.
                 */
                /*
                 * Account for the data cells in the layout, matching it
                 * to data cells in the data section.
                 */

-               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;
+
+               gp = &first_group;
+               for (dp = sp->first; dp != NULL; dp = dp->next) {

                        icol = dp->layout->col;
                        icol = dp->layout->col;

-                       if (maxcol < icol)
-                               maxcol = icol;
+                       while (maxcol < icol + dp->hspans)
+                               tbl->cols[++maxcol].spacing = SIZE_MAX;

                        col = tbl->cols + icol;
                        col->flags |= dp->layout->flags;
                        if (dp->layout->flags & TBL_CELL_WIGN)
                                continue;
                        col = tbl->cols + icol;
                        col->flags |= dp->layout->flags;
                        if (dp->layout->flags & TBL_CELL_WIGN)
                                continue;

-                       tblcalc_data(tbl, col, opts, dp);
+
+                       /* Handle explicit width specifications. */
+
+                       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;
+
+                       /*
+                        * Calculate an automatic width.
+                        * Except for spanning cells, apply it.
+                        */
+
+                       width = tblcalc_data(tbl,
+                           dp->hspans == 0 ? col : NULL,
+                           opts, dp,
+                           dp->block == 0 ? 0 :
+                           dp->layout->width ? dp->layout->width :
+                           rmargin ? (rmargin + sp->opts->cols / 2)
+                           / (sp->opts->cols + 1) : 0);
+                       if (dp->hspans == 0)
+                               continue;
+
+                       /*
+                        * Build an ordered, singly linked list
+                        * of all groups of columns joined by spans,
+                        * recording the minimum width for each group.
+                        */
+
+                       while (*gp != NULL && ((*gp)->startcol < icol ||
+                           (*gp)->endcol < icol + dp->hspans))
+                               gp = &(*gp)->next;
+                       if (*gp == NULL || (*gp)->startcol > icol ||
+                            (*gp)->endcol > icol + dp->hspans) {
+                               g = mandoc_malloc(sizeof(*g));
+                               g->next = *gp;
+                               g->wanted = width;
+                               g->startcol = icol;
+                               g->endcol = icol + dp->hspans;
+                               *gp = g;
+                       } else if ((*gp)->wanted < width)
+                               (*gp)->wanted = width;

                }
        }
 
        /*
                }
        }
 
        /*

+        * Column spacings are needed for span width calculations,
+        * so set the default values now.
+        */
+
+       for (icol = 0; icol <= maxcol; icol++)
+               if (tbl->cols[icol].spacing == SIZE_MAX || icol == maxcol)
+                       tbl->cols[icol].spacing = 3;
+
+       /*
+        * Replace the minimum widths with the missing widths,
+        * and dismiss groups that are already wide enough.
+        */
+
+       gp = &first_group;
+       while ((g = *gp) != NULL) {
+               done = 0;
+               for (icol = g->startcol; icol <= g->endcol; icol++) {
+                       width = tbl->cols[icol].width;
+                       if (icol < g->endcol)
+                               width += tbl->cols[icol].spacing;
+                       if (g->wanted <= width) {
+                               done = 1;
+                               break;
+                       } else
+                               (*gp)->wanted -= width;
+               }
+               if (done) {
+                       *gp = g->next;
+                       free(g);
+               } else
+                       gp = &(*gp)->next;
+       }
+
+       colwidth = mandoc_reallocarray(NULL, maxcol + 1, sizeof(*colwidth));
+       while (first_group != NULL) {
+
+               /*
+                * Rebuild the array of the widths of all columns
+                * participating in spans that require expansion.
+                */
+
+               for (icol = 0; icol <= maxcol; icol++)
+                       colwidth[icol] = SIZE_MAX;
+               for (g = first_group; g != NULL; g = g->next)
+                       for (icol = g->startcol; icol <= g->endcol; icol++)
+                               colwidth[icol] = tbl->cols[icol].width;
+
+               /*
+                * Find the smallest and second smallest column width
+                * among the columns which may need expamsion.
+                */
+
+               min1 = min2 = SIZE_MAX;
+               for (icol = 0; icol <= maxcol; icol++) {
+                       if (min1 > colwidth[icol]) {
+                               min2 = min1;
+                               min1 = colwidth[icol];
+                       } else if (min1 < colwidth[icol] &&
+                           min2 > colwidth[icol])
+                               min2 = colwidth[icol];
+               }
+
+               /*
+                * Find the minimum wanted width
+                * for any one of the narrowest columns,
+                * and mark the columns wanting that width.
+                */
+
+               wanted = min2;
+               for (g = first_group; g != NULL; g = g->next) {
+                       necol = 0;
+                       for (icol = g->startcol; icol <= g->endcol; icol++)
+                               if (tbl->cols[icol].width == min1)
+                                       necol++;
+                       if (necol == 0)
+                               continue;
+                       width = min1 + (g->wanted - 1) / necol + 1;
+                       if (width > min2)
+                               width = min2;
+                       if (wanted > width)
+                               wanted = width;
+                       for (icol = g->startcol; icol <= g->endcol; icol++)
+                               if (colwidth[icol] == min1 ||
+                                   (colwidth[icol] < min2 &&
+                                    colwidth[icol] > width))
+                                       colwidth[icol] = width;
+               }
+
+               /* Record the effect of the widening on the group list. */
+
+               gp = &first_group;
+               while ((g = *gp) != NULL) {
+                       done = 0;
+                       for (icol = g->startcol; icol <= g->endcol; icol++) {
+                               if (colwidth[icol] != wanted ||
+                                   tbl->cols[icol].width == wanted)
+                                       continue;
+                               if (g->wanted <= wanted - min1) {
+                                       done = 1;
+                                       break;
+                               }
+                               g->wanted -= wanted - min1;
+                       }
+                       if (done) {
+                               *gp = g->next;
+                               free(g);
+                       } else
+                               gp = &(*gp)->next;
+               }
+
+               /* Record the effect of the widening on the columns. */
+
+               for (icol = 0; icol <= maxcol; icol++)
+                       if (colwidth[icol] == wanted)
+                               tbl->cols[icol].width = wanted;
+       }
+       free(colwidth);
+
+       /*
+        * 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.
         * 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.


@@ -160,6 +338,10 @@ tblcalc(struct rofftbl *tbl, const struct tbl_span *sp,
        ewidth = xwidth = 0;
        for (icol = 0; icol <= maxcol; icol++) {
                col = tbl->cols + icol;
        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->flags & TBL_CELL_EQUAL) {
                        necol++;
                        if (ewidth < col->width)
                if (col->flags & TBL_CELL_EQUAL) {
                        necol++;
                        if (ewidth < col->width)


@@ -183,7 +365,7 @@ tblcalc(struct rofftbl *tbl, const struct tbl_span *sp,
                                continue;
                        if (col->width == ewidth)
                                continue;
                                continue;
                        if (col->width == ewidth)
                                continue;

-                       if (nxcol && totalwidth)
+                       if (nxcol && rmargin)

                                xwidth += ewidth - col->width;
                        col->width = ewidth;
                }
                                xwidth += ewidth - col->width;
                        col->width = ewidth;
                }


@@ -195,13 +377,13 @@ tblcalc(struct rofftbl *tbl, const struct tbl_span *sp,
         * Distribute the available width evenly.
         */
 
         * Distribute the available width evenly.
         */
 

-       if (nxcol && totalwidth) {
+       if (nxcol && rmargin) {

                xwidth += 3*maxcol +
                    (opts->opts & (TBL_OPT_BOX | TBL_OPT_DBOX) ?
                     2 : !!opts->lvert + !!opts->rvert);
                xwidth += 3*maxcol +
                    (opts->opts & (TBL_OPT_BOX | TBL_OPT_DBOX) ?
                     2 : !!opts->lvert + !!opts->rvert);

-               if (xwidth >= totalwidth)
+               if (rmargin <= offset + xwidth)

                        return;
                        return;

-               xwidth = totalwidth - xwidth;
+               xwidth = rmargin - offset - xwidth;

 
                /*
                 * Emulate a bug in GNU tbl width calculation that
 
                /*
                 * Emulate a bug in GNU tbl width calculation that


@@ -232,9 +414,9 @@ tblcalc(struct rofftbl *tbl, const struct tbl_span *sp,
        }
 }
 
        }
 }
 

-static void
+static size_t

 tblcalc_data(struct rofftbl *tbl, struct roffcol *col,
 tblcalc_data(struct rofftbl *tbl, struct roffcol *col,

-               const struct tbl_opts *opts, const struct tbl_dat *dp)
+    const struct tbl_opts *opts, const struct tbl_dat *dp, size_t mw)

 {
        size_t           sz;
 
 {
        size_t           sz;
 


@@ -244,88 +426,128 @@ tblcalc_data(struct rofftbl *tbl, struct roffcol *col,
        case TBL_CELL_HORIZ:
        case TBL_CELL_DHORIZ:
                sz = (*tbl->len)(1, tbl->arg);
        case TBL_CELL_HORIZ:
        case TBL_CELL_DHORIZ:
                sz = (*tbl->len)(1, tbl->arg);

-               if (col->width < sz)
+               if (col != NULL && col->width < sz)

                        col->width = sz;
                        col->width = sz;

-               break;
+               return sz;

        case TBL_CELL_LONG:
        case TBL_CELL_CENTRE:
        case TBL_CELL_LEFT:
        case TBL_CELL_RIGHT:
        case TBL_CELL_LONG:
        case TBL_CELL_CENTRE:
        case TBL_CELL_LEFT:
        case TBL_CELL_RIGHT:

-               tblcalc_literal(tbl, col, dp);
-               break;
+               return tblcalc_literal(tbl, col, dp, mw);

        case TBL_CELL_NUMBER:
        case TBL_CELL_NUMBER:

-               tblcalc_number(tbl, col, opts, dp);
-               break;
+               return tblcalc_number(tbl, col, opts, dp);

        case TBL_CELL_DOWN:
        case TBL_CELL_DOWN:

-               break;
+               return 0;

        default:
                abort();
        }
 }
 
        default:
                abort();
        }
 }
 

-static void
+static size_t

 tblcalc_literal(struct rofftbl *tbl, struct roffcol *col,
 tblcalc_literal(struct rofftbl *tbl, struct roffcol *col,

-               const struct tbl_dat *dp)
+    const struct tbl_dat *dp, size_t mw)

 {
 {

-       size_t           sz;
-       const char      *str;
-
-       str = dp->string ? dp->string : "";
-       sz = (*tbl->slen)(str, tbl->arg);
-
-       if (col->width < sz)
-               col->width = sz;
+       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. */
+       size_t           msz;   /* Length of the longest line. */
+
+       if (dp->string == NULL || *dp->string == '\0')
+               return 0;
+       str = mw ? mandoc_strdup(dp->string) : dp->string;
+       msz = 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 (msz < lsz)
+                       msz = lsz;
+       }
+       if (mw)
+               free((void *)str);
+       if (col != NULL && col->width < msz)
+               col->width = msz;
+       return msz;

 }
 
 }
 

-static void
+static size_t

 tblcalc_number(struct rofftbl *tbl, struct roffcol *col,
                const struct tbl_opts *opts, const struct tbl_dat *dp)
 {
 tblcalc_number(struct rofftbl *tbl, struct roffcol *col,
                const struct tbl_opts *opts, const struct tbl_dat *dp)
 {

-       int              i;
-       size_t           sz, psz, ssz, d;
-       const char      *str;
-       char            *cp;
+       const char      *cp, *lastdigit, *lastpoint;
+       size_t           intsz, totsz;

        char             buf[2];
 
        char             buf[2];
 

+       if (dp->string == NULL || *dp->string == '\0')
+               return 0;
+
+       totsz = (*tbl->slen)(dp->string, tbl->arg);
+       if (col == NULL)
+               return totsz;
+

        /*
        /*

-        * 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.
+        * Find the last digit and
+        * the last decimal point that is adjacent to a digit.
+        * The alignment indicator "\&" overrides everything.

         */
 
         */
 

-       str = dp->string ? dp->string : "";
-       sz = (*tbl->slen)(str, tbl->arg);
+       lastdigit = lastpoint = NULL;
+       for (cp = dp->string; cp[0] != '\0'; cp++) {
+               if (cp[0] == '\\' && cp[1] == '&') {
+                       lastdigit = lastpoint = cp;
+                       break;
+               } else if (cp[0] == opts->decimal &&
+                   (isdigit((unsigned char)cp[1]) ||
+                    (cp > dp->string && isdigit((unsigned char)cp[-1]))))
+                       lastpoint = cp;
+               else if (isdigit((unsigned char)cp[0]))
+                       lastdigit = cp;
+       }

 
 

-       /* FIXME: TBL_DATA_HORIZ et al.? */
+       /* Not a number, treat as a literal string. */

 
 

-       buf[0] = opts->decimal;
-       buf[1] = '\0';
+       if (lastdigit == NULL) {
+               if (col != NULL && col->width < totsz)
+                       col->width = totsz;
+               return totsz;
+       }

 
 

-       psz = (*tbl->slen)(buf, tbl->arg);
+       /* Measure the width of the integer part. */

 
 

-       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 + psz;
-       } else
-               d = sz + psz;
+       if (lastpoint == NULL)
+               lastpoint = lastdigit + 1;
+       intsz = 0;
+       buf[1] = '\0';
+       for (cp = dp->string; cp < lastpoint; cp++) {
+               buf[0] = cp[0];
+               intsz += (*tbl->slen)(buf, tbl->arg);
+       }

 
 

-       /* Adjust the settings for this column. */
+       /*
+         * If this number has more integer digits than all numbers
+         * seen on earlier lines, shift them all to the right.
+        * If it has fewer, shift this number to the right.
+        */

 
 

-       if (col->decimal > d) {
-               sz += col->decimal - d;
-               d = col->decimal;
+       if (intsz > col->decimal) {
+               col->nwidth += intsz - col->decimal;
+               col->decimal = intsz;

        } else
        } else

-               col->width += d - col->decimal;
+               totsz += col->decimal - intsz;
+
+       /* Update the maximum total width seen so far. */

 
 

-       if (sz > col->width)
-               col->width = sz;
-       if (d > col->decimal)
-               col->decimal = d;
+       if (totsz > col->nwidth)
+               col->nwidth = totsz;
+       return totsz;

 }
 }