For .Do/.Dq, use the documented and portable \(lq and \(rq

[mandoc.git] / out.c

diff --git a/out.c b/out.c
index 6f41f3bccaab576973883b2790d340744678f833..b2b643787ec1f401cacb944f839bf9ac44056ec0 100644 (file)
--- a/out.c
+++ b/out.c
@@ -1,7 +1,7 @@
-/*     $Id: out.c,v 1.44 2012/05/27 17:54:54 schwarze Exp $ */
+/*     $Id: out.c,v 1.70 2017/06/27 18:25:02 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 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2011, 2014, 2015, 2017 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


@@ -15,121 +15,85 @@
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
  * 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"
 #include "config.h"

-#endif

 
 #include <sys/types.h>
 
 #include <assert.h>
 
 #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 <stdlib.h>
 #include <string.h>
 #include <time.h>
 

+#include "mandoc_aux.h"

 #include "mandoc.h"
 #include "out.h"
 
 static void    tblcalc_data(struct rofftbl *, struct roffcol *,
 #include "mandoc.h"
 #include "out.h"
 
 static void    tblcalc_data(struct rofftbl *, struct roffcol *,

-                       const struct tbl *, const struct tbl_dat *);
+                       const struct tbl_opts *, const struct tbl_dat *,
+                       size_t);

 static void    tblcalc_literal(struct rofftbl *, struct roffcol *,
 static void    tblcalc_literal(struct rofftbl *, struct roffcol *,

-                       const struct tbl_dat *);
+                       const struct tbl_dat *, size_t);

 static void    tblcalc_number(struct rofftbl *, struct roffcol *,
 static void    tblcalc_number(struct rofftbl *, struct roffcol *,

-                       const struct tbl *, const struct tbl_dat *);
+                       const struct tbl_opts *, const struct tbl_dat *);

 
 

-/* 
- * Convert a `scaling unit' to a consistent form, or fail.  Scaling
- * units are documented in groff.7, mdoc.7, man.7.
+
+/*
+ * 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)
 {
 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;
                break;

-       case ('-'):
-               buf[i++] = *src++;
+       case 'i':
+               dst->unit = SCALE_IN;

                break;
                break;

-       default:
+       case 'f':
+               dst->unit = SCALE_FS;

                break;
                break;

-       }
-
-       if ('\0' == *src)
-               return(0);
-
-       while (i < BUFSIZ) {
-               if ( ! isdigit((unsigned 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;
                break;

-       case ('i'):
-               unit = SCALE_IN;
+       case 'm':
+               dst->unit = SCALE_EM;

                break;
                break;

-       case ('P'):
-               unit = SCALE_PC;
+       case 'n':
+               dst->unit = SCALE_EN;

                break;
                break;

-       case ('p'):
-               unit = SCALE_PT;
+       case 'P':
+               dst->unit = SCALE_PC;

                break;
                break;

-       case ('f'):
-               unit = SCALE_FS;
+       case 'p':
+               dst->unit = SCALE_PT;

                break;
                break;

-       case ('v'):
-               unit = SCALE_VS;
+       case 'u':
+               dst->unit = SCALE_BU;

                break;
                break;

-       case ('m'):
-               unit = SCALE_EM;
+       case 'v':
+               dst->unit = SCALE_VS;

                break;
                break;

-       case ('\0'):
+       default:
+               endptr--;

                if (SCALE_MAX == def)
                if (SCALE_MAX == def)

-                       return(0);
-               unit = SCALE_BU;
-               break;
-       case ('u'):
-               unit = SCALE_BU;
+                       return NULL;
+               dst->unit = def;

                break;
                break;

-       case ('M'):
-               unit = SCALE_MM;
-               break;
-       case ('n'):
-               unit = SCALE_EN;
-               break;
-       default:
-               return(0);

        }
        }

-
-       /* FIXME: do this in the caller. */
-       if ((dst->scale = atof(buf)) < 0)
-               dst->scale = 0;
-       dst->unit = unit;
-       return(1);
+       return endptr;

 }
 
 /*
 }
 
 /*


@@ -139,12 +103,16 @@ 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)
+tblcalc(struct rofftbl *tbl, const struct tbl_span *sp,
+    size_t offset, size_t rmargin)

 {
 {

+       struct roffsu            su;
+       const struct tbl_opts   *opts;

        const struct tbl_dat    *dp;
        const struct tbl_dat    *dp;

-       const struct tbl_head   *hp;

        struct roffcol          *col;
        struct roffcol          *col;

+       size_t                   ewidth, xwidth;

        int                      spans;
        int                      spans;

+       int                      icol, maxcol, necol, nxcol, quirkcol;

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


@@ -153,12 +121,11 @@ tblcalc(struct rofftbl *tbl, const struct tbl_span *sp)
         */
 
        assert(NULL == tbl->cols);
         */
 
        assert(NULL == tbl->cols);

-       tbl->cols = mandoc_calloc
-               ((size_t)sp->tbl->cols, sizeof(struct roffcol));
+       tbl->cols = mandoc_calloc((size_t)sp->opts->cols,
+           sizeof(struct roffcol));
+       opts = sp->opts;

 
 

-       hp = sp->head;
-
-       for ( ; sp; sp = sp->next) {
+       for (maxcol = -1; sp; sp = sp->next) {

                if (TBL_SPAN_DATA != sp->pos)
                        continue;
                spans = 1;
                if (TBL_SPAN_DATA != sp->pos)
                        continue;
                spans = 1;


@@ -173,68 +140,186 @@ tblcalc(struct rofftbl *tbl, const struct tbl_span *sp)
                        spans = dp->spans;
                        if (1 < spans)
                                continue;
                        spans = dp->spans;
                        if (1 < spans)
                                continue;

-                       assert(dp->layout);
-                       col = &tbl->cols[dp->layout->head->ident];
-                       tblcalc_data(tbl, col, sp->tbl, dp);
+                       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);
+               }
+       }
+
+       /*
+        * 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->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;
+       }
+
+       /*
+        * 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 there are any columns to maximize, find the total
+        * available width, deducting 3n margins between columns.
+        * Distribute the available width evenly.
+        */
+
+       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;
+
+               /*
+                * 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.
+                */
+
+               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;

                }
        }
 }
 
 static void
 tblcalc_data(struct rofftbl *tbl, struct roffcol *col,
                }
        }
 }
 
 static void
 tblcalc_data(struct rofftbl *tbl, struct roffcol *col,

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

 {
        size_t           sz;
 
        /* Branch down into data sub-types. */
 
        switch (dp->layout->pos) {
 {
        size_t           sz;
 
        /* Branch down into data sub-types. */
 
        switch (dp->layout->pos) {

-       case (TBL_CELL_HORIZ):
-               /* FALLTHROUGH */
-       case (TBL_CELL_DHORIZ):
+       case TBL_CELL_HORIZ:
+       case TBL_CELL_DHORIZ:

                sz = (*tbl->len)(1, tbl->arg);
                if (col->width < sz)
                        col->width = sz;
                break;
                sz = (*tbl->len)(1, tbl->arg);
                if (col->width < sz)
                        col->width = sz;
                break;

-       case (TBL_CELL_LONG):
-               /* FALLTHROUGH */
-       case (TBL_CELL_CENTRE):
-               /* FALLTHROUGH */
-       case (TBL_CELL_LEFT):
-               /* FALLTHROUGH */
-       case (TBL_CELL_RIGHT):
-               tblcalc_literal(tbl, col, dp);
+       case TBL_CELL_LONG:
+       case TBL_CELL_CENTRE:
+       case TBL_CELL_LEFT:
+       case TBL_CELL_RIGHT:
+               tblcalc_literal(tbl, col, dp, mw);

                break;
                break;

-       case (TBL_CELL_NUMBER):
-               tblcalc_number(tbl, col, tp, dp);
+       case TBL_CELL_NUMBER:
+               tblcalc_number(tbl, col, opts, dp);

                break;
                break;

-       case (TBL_CELL_DOWN):
+       case TBL_CELL_DOWN:

                break;
        default:
                abort();
                break;
        default:
                abort();

-               /* NOTREACHED */

        }
 }
 
 static void
 tblcalc_literal(struct rofftbl *tbl, struct roffcol *col,
        }
 }
 
 static void
 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. */
+
+       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);

 }
 
 static void
 tblcalc_number(struct rofftbl *tbl, struct roffcol *col,
 }
 
 static void
 tblcalc_number(struct rofftbl *tbl, struct roffcol *col,

-               const struct tbl *tp, const struct tbl_dat *dp)
+               const struct tbl_opts *opts, const struct tbl_dat *dp)

 {
 {

-       int              i;
+       int              i;

        size_t           sz, psz, ssz, d;
        const char      *str;
        char            *cp;
        size_t           sz, psz, ssz, d;
        const char      *str;
        char            *cp;


@@ -254,12 +339,12 @@ tblcalc_number(struct rofftbl *tbl, struct roffcol *col,
 
        /* FIXME: TBL_DATA_HORIZ et al.? */
 
 
        /* FIXME: TBL_DATA_HORIZ et al.? */
 

-       buf[0] = tp->decimal;
+       buf[0] = opts->decimal;

        buf[1] = '\0';
 
        psz = (*tbl->slen)(buf, tbl->arg);
 
        buf[1] = '\0';
 
        psz = (*tbl->slen)(buf, tbl->arg);
 

-       if (NULL != (cp = strrchr(str, tp->decimal))) {
+       if (NULL != (cp = strrchr(str, opts->decimal))) {

                buf[1] = '\0';
                for (ssz = 0, i = 0; cp != &str[i]; i++) {
                        buf[0] = str[i];
                buf[1] = '\0';
                for (ssz = 0, i = 0; cp != &str[i]; i++) {
                        buf[0] = str[i];