improve documentation of .Fa, .Va, and .Vt;

[mandoc.git] / out.c

diff --git a/out.c b/out.c
index 8dbd68ac11ad7c4d3c14dd72befaf7ab73e353bb..5b08a09abd42b6cd4923885bbc55e3fc31e939c2 100644 (file)
--- a/out.c
+++ b/out.c
@@ -1,7 +1,7 @@
-/*     $Id: out.c,v 1.43 2011/09/20 23:05:49 schwarze Exp $ */
+/*     $Id: out.c,v 1.53 2014/10/14 18:18:05 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 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,9 +15,7 @@
  * 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 <sys/types.h>
 


@@ -28,17 +26,19 @@
 #include <string.h>
 #include <time.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 *);

 static void    tblcalc_literal(struct rofftbl *, struct roffcol *,
                        const struct tbl_dat *);
 static void    tblcalc_number(struct rofftbl *, struct roffcol *,
 static void    tblcalc_literal(struct rofftbl *, struct roffcol *,
                        const struct tbl_dat *);
 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.
  */
  * Convert a `scaling unit' to a consistent form, or fail.  Scaling
  * units are documented in groff.7, mdoc.7, man.7.
  */


@@ -55,10 +55,10 @@ a2roffsu(const char *src, struct roffsu *dst, enum roffscale def)
        i = hasd = 0;
 
        switch (*src) {
        i = hasd = 0;
 
        switch (*src) {

-       case ('+'):
+       case '+':

                src++;
                break;
                src++;
                break;

-       case ('-'):
+       case '-':

                buf[i++] = *src++;
                break;
        default:
                buf[i++] = *src++;
                break;
        default:


@@ -86,39 +86,39 @@ a2roffsu(const char *src, struct roffsu *dst, enum roffscale def)
        buf[i] = '\0';
 
        switch (*src) {
        buf[i] = '\0';
 
        switch (*src) {

-       case ('c'):
+       case 'c':

                unit = SCALE_CM;
                break;
                unit = SCALE_CM;
                break;

-       case ('i'):
+       case 'i':

                unit = SCALE_IN;
                break;
                unit = SCALE_IN;
                break;

-       case ('P'):
+       case 'P':

                unit = SCALE_PC;
                break;
                unit = SCALE_PC;
                break;

-       case ('p'):
+       case 'p':

                unit = SCALE_PT;
                break;
                unit = SCALE_PT;
                break;

-       case ('f'):
+       case 'f':

                unit = SCALE_FS;
                break;
                unit = SCALE_FS;
                break;

-       case ('v'):
+       case 'v':

                unit = SCALE_VS;
                break;
                unit = SCALE_VS;
                break;

-       case ('m'):
+       case 'm':

                unit = SCALE_EM;
                break;
                unit = SCALE_EM;
                break;

-       case ('\0'):
+       case '\0':

                if (SCALE_MAX == def)
                        return(0);
                if (SCALE_MAX == def)
                        return(0);

-               unit = SCALE_BU;
+               unit = SCALE_EN;

                break;
                break;

-       case ('u'):
+       case 'u':

                unit = SCALE_BU;
                break;
                unit = SCALE_BU;
                break;

-       case ('M'):
+       case 'M':

                unit = SCALE_MM;
                break;
                unit = SCALE_MM;
                break;

-       case ('n'):
+       case 'n':

                unit = SCALE_EN;
                break;
        default:
                unit = SCALE_EN;
                break;
        default:


@@ -126,8 +126,8 @@ a2roffsu(const char *src, struct roffsu *dst, enum roffscale def)
        }
 
        /* FIXME: do this in the caller. */
        }
 
        /* FIXME: do this in the caller. */

-       if ((dst->scale = atof(buf)) < 0)
-               dst->scale = 0;
+       if ((dst->scale = atof(buf)) < 0.0)
+               dst->scale = 0.0;

        dst->unit = unit;
        return(1);
 }
        dst->unit = unit;
        return(1);
 }


@@ -139,12 +139,14 @@ 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 totalwidth)

 {
        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;

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


@@ -153,12 +155,10 @@ 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));
-
-       hp = sp->head;
+       tbl->cols = mandoc_calloc((size_t)sp->opts->cols,
+           sizeof(struct roffcol));

 
 

-       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,61 +173,103 @@ 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->head->ident;
+                       if (maxcol < icol)
+                               maxcol = icol;
+                       col = tbl->cols + icol;
+                       col->flags |= dp->layout->flags;
+                       if (dp->layout->flags & TBL_CELL_WIGN)
+                               continue;
+                       tblcalc_data(tbl, col, sp->opts, dp);

                }
        }
 
                }
        }
 

-       /* 
-        * Calculate width of the spanners.  These get one space for a
-        * vertical line, two for a double-vertical line. 
+       /*
+        * 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.

         */
 
         */
 

-       for ( ; hp; hp = hp->next) {
-               col = &tbl->cols[hp->ident];
-               switch (hp->pos) {
-               case (TBL_HEAD_VERT):
-                       col->width = (*tbl->len)(1, tbl->arg);
-                       break;
-               case (TBL_HEAD_DVERT):
-                       col->width = (*tbl->len)(2, tbl->arg);
-                       break;
-               default:
-                       break;
+       necol = nxcol = 0;
+       ewidth = xwidth = 0;
+       for (icol = 0; icol <= maxcol; icol++) {
+               col = tbl->cols + icol;
+               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 && totalwidth)
+                               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 && totalwidth) {
+               xwidth = totalwidth - 3*maxcol - xwidth;
+               for (icol = 0; icol <= maxcol; icol++) {
+                       col = tbl->cols + icol;
+                       if ( ! (col->flags & TBL_CELL_WMAX))
+                               continue;
+                       col->width = xwidth / nxcol--;
+                       xwidth -= 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           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):
+       case TBL_CELL_HORIZ:

                /* FALLTHROUGH */
                /* FALLTHROUGH */

-       case (TBL_CELL_DHORIZ):
+       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):
+       case TBL_CELL_LONG:

                /* FALLTHROUGH */
                /* FALLTHROUGH */

-       case (TBL_CELL_CENTRE):
+       case TBL_CELL_CENTRE:

                /* FALLTHROUGH */
                /* FALLTHROUGH */

-       case (TBL_CELL_LEFT):
+       case TBL_CELL_LEFT:

                /* FALLTHROUGH */
                /* FALLTHROUGH */

-       case (TBL_CELL_RIGHT):
+       case TBL_CELL_RIGHT:

                tblcalc_literal(tbl, col, dp);
                break;
                tblcalc_literal(tbl, col, dp);
                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();


@@ -251,9 +293,9 @@ tblcalc_literal(struct rofftbl *tbl, struct roffcol *col,
 
 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;


@@ -273,12 +315,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];