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

Diff for /mandoc/out.c between version 1.44 and 1.77

version 1.44, 2012/05/27 17:54:54 version 1.77, 2018/12/13 11:55:47
Line 1 
Line 1 
 /*      $Id$ */  /*      $Id$ */
 /*  /*
  * 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,2018 Ingo Schwarze <schwarze@openbsd.org>
  *   *
  * Permission to use, copy, modify, and distribute this software for any   * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above   * purpose with or without fee is hereby granted, provided that the above
Line 15 
Line 15 
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF   * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.   * 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>
   
 #include <assert.h>  #include <assert.h>
 #include <ctype.h>  #include <ctype.h>
 #include <stdio.h>  #include <stdint.h>
 #include <stdlib.h>  #include <stdlib.h>
 #include <string.h>  #include <string.h>
 #include <time.h>  #include <time.h>
   
 #include "mandoc.h"  #include "mandoc_aux.h"
   #include "tbl.h"
 #include "out.h"  #include "out.h"
   
 static  void    tblcalc_data(struct rofftbl *, struct roffcol *,  struct  tbl_colgroup {
                         const struct tbl *, const struct tbl_dat *);          struct tbl_colgroup     *next;
 static  void    tblcalc_literal(struct rofftbl *, struct roffcol *,          size_t                   wanted;
                         const struct tbl_dat *);          int                      startcol;
 static  void    tblcalc_number(struct rofftbl *, struct roffcol *,          int                      endcol;
                         const struct tbl *, const struct tbl_dat *);  };
   
 /*  static  size_t  tblcalc_data(struct rofftbl *, struct roffcol *,
  * Convert a `scaling unit' to a consistent form, or fail.  Scaling                          const struct tbl_opts *, const struct tbl_dat *,
  * units are documented in groff.7, mdoc.7, man.7.                          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 *);
   
   
   /*
    * 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;          char            *endptr;
         int              i;  
         enum roffscale   unit;  
   
         if ('\0' == *src)          dst->unit = def == SCALE_MAX ? SCALE_BU : def;
                 return(0);          dst->scale = strtod(src, &endptr);
           if (endptr == src)
                   return NULL;
   
         i = hasd = 0;          switch (*endptr++) {
           case 'c':
         switch (*src) {                  dst->unit = SCALE_CM;
         case ('+'):  
                 src++;  
                 break;                  break;
         case ('-'):          case 'i':
                 buf[i++] = *src++;                  dst->unit = SCALE_IN;
                 break;                  break;
         default:          case 'f':
                   dst->unit = SCALE_FS;
                 break;                  break;
         }          case 'M':
                   dst->unit = SCALE_MM;
         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;  
                 break;                  break;
         case ('i'):          case 'm':
                 unit = SCALE_IN;                  dst->unit = SCALE_EM;
                 break;                  break;
         case ('P'):          case 'n':
                 unit = SCALE_PC;                  dst->unit = SCALE_EN;
                 break;                  break;
         case ('p'):          case 'P':
                 unit = SCALE_PT;                  dst->unit = SCALE_PC;
                 break;                  break;
         case ('f'):          case 'p':
                 unit = SCALE_FS;                  dst->unit = SCALE_PT;
                 break;                  break;
         case ('v'):          case 'u':
                 unit = SCALE_VS;                  dst->unit = SCALE_BU;
                 break;                  break;
         case ('m'):          case 'v':
                 unit = SCALE_EM;                  dst->unit = SCALE_VS;
                 break;                  break;
         case ('\0'):          default:
                   endptr--;
                 if (SCALE_MAX == def)                  if (SCALE_MAX == def)
                         return(0);                          return NULL;
                 unit = SCALE_BU;                  dst->unit = def;
                 break;                  break;
         case ('u'):  
                 unit = SCALE_BU;  
                 break;  
         case ('M'):  
                 unit = SCALE_MM;  
                 break;  
         case ('n'):  
                 unit = SCALE_EN;  
                 break;  
         default:  
                 return(0);  
         }          }
           return endptr;
         /* FIXME: do this in the caller. */  
         if ((dst->scale = atof(buf)) < 0)  
                 dst->scale = 0;  
         dst->unit = unit;  
         return(1);  
 }  }
   
 /*  /*
Line 139  a2roffsu(const char *src, struct roffsu *dst, enum rof
Line 111  a2roffsu(const char *src, struct roffsu *dst, enum rof
  * used for the actual width calculations.   * used for the actual width calculations.
  */   */
 void  void
 tblcalc(struct rofftbl *tbl, const struct tbl_span *sp)  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_span   *sp;
         const struct tbl_dat    *dp;          const struct tbl_dat    *dp;
         const struct tbl_head   *hp;  
         struct roffcol          *col;          struct roffcol          *col;
         int                      spans;          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
Line 152  tblcalc(struct rofftbl *tbl, const struct tbl_span *sp
Line 130  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);          assert(tbl->cols == NULL);
         tbl->cols = mandoc_calloc          tbl->cols = mandoc_calloc((size_t)sp_first->opts->cols,
                 ((size_t)sp->tbl->cols, sizeof(struct roffcol));              sizeof(struct roffcol));
           opts = sp_first->opts;
   
         hp = sp->head;          maxcol = -1;
           first_group = NULL;
         for ( ; sp; sp = sp->next) {          for (sp = sp_first; sp != NULL; sp = sp->next) {
                 if (TBL_SPAN_DATA != sp->pos)                  if (sp->pos != TBL_SPAN_DATA)
                         continue;                          continue;
                 spans = 1;  
                 /*                  /*
                  * Account for the data cells in the layout, matching it                   * Account for the data cells in the layout, matching it
                  * to data cells in the data section.                   * to data cells in the data section.
                  */                   */
                 for (dp = sp->first; dp; dp = dp->next) {  
                         /* Do not used spanned cells in the calculation. */                  gp = &first_group;
                         if (0 < --spans)                  for (dp = sp->first; dp != NULL; dp = dp->next) {
                           icol = dp->layout->col;
                           while (icol > maxcol)
                                   tbl->cols[++maxcol].spacing = SIZE_MAX;
                           col = tbl->cols + icol;
                           col->flags |= dp->layout->flags;
                           if (dp->layout->flags & TBL_CELL_WIGN)
                                 continue;                                  continue;
                         spans = dp->spans;  
                         if (1 < spans)                          /* 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;                                  continue;
                         assert(dp->layout);  
                         col = &tbl->cols[dp->layout->head->ident];                          /*
                         tblcalc_data(tbl, col, sp->tbl, dp);                           * 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.
            */
   
           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->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  static size_t
 tblcalc_data(struct rofftbl *tbl, struct roffcol *col,  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;          size_t           sz;
   
         /* Branch down into data sub-types. */          /* Branch down into data sub-types. */
   
         switch (dp->layout->pos) {          switch (dp->layout->pos) {
         case (TBL_CELL_HORIZ):          case TBL_CELL_HORIZ:
                 /* FALLTHROUGH */          case TBL_CELL_DHORIZ:
         case (TBL_CELL_DHORIZ):  
                 sz = (*tbl->len)(1, tbl->arg);                  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_LONG:
                 /* FALLTHROUGH */          case TBL_CELL_CENTRE:
         case (TBL_CELL_CENTRE):          case TBL_CELL_LEFT:
                 /* FALLTHROUGH */          case TBL_CELL_RIGHT:
         case (TBL_CELL_LEFT):                  return tblcalc_literal(tbl, col, dp, mw);
                 /* FALLTHROUGH */          case TBL_CELL_NUMBER:
         case (TBL_CELL_RIGHT):                  return tblcalc_number(tbl, col, opts, dp);
                 tblcalc_literal(tbl, col, dp);          case TBL_CELL_DOWN:
                 break;                  return 0;
         case (TBL_CELL_NUMBER):  
                 tblcalc_number(tbl, col, tp, dp);  
                 break;  
         case (TBL_CELL_DOWN):  
                 break;  
         default:          default:
                 abort();                  abort();
                 /* NOTREACHED */  
         }          }
 }  }
   
 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;   /* Beginning of the first line. */
         const char      *str;          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. */
   
         str = dp->string ? dp->string : "";          if (dp->string == NULL || *dp->string == '\0')
         sz = (*tbl->slen)(str, tbl->arg);                  return 0;
           str = mw ? mandoc_strdup(dp->string) : dp->string;
         if (col->width < sz)          msz = lsz = 0;
                 col->width = sz;          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,  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;          const char      *cp, *lastdigit, *lastpoint;
         size_t           sz, psz, ssz, d;          size_t           intsz, totsz;
         const char      *str;  
         char            *cp;  
         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           * Find the last digit and
          * non-decimal numbers).  If the stored decimal is subsequent to           * the last decimal point that is adjacent to a digit.
          * ours, make our size longer by that difference           * The alignment indicator "\&" overrides everything.
          * (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 : "";          lastdigit = lastpoint = NULL;
         sz = (*tbl->slen)(str, tbl->arg);          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] = tp->decimal;          if (lastdigit == NULL) {
         buf[1] = '\0';                  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, tp->decimal))) {          if (lastpoint == NULL)
                 buf[1] = '\0';                  lastpoint = lastdigit + 1;
                 for (ssz = 0, i = 0; cp != &str[i]; i++) {          intsz = 0;
                         buf[0] = str[i];          buf[1] = '\0';
                         ssz += (*tbl->slen)(buf, tbl->arg);          for (cp = dp->string; cp < lastpoint; cp++) {
                 }                  buf[0] = cp[0];
                 d = ssz + psz;                  intsz += (*tbl->slen)(buf, tbl->arg);
         } else          }
                 d = sz + psz;  
   
         /* 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) {          if (intsz > col->decimal) {
                 sz += col->decimal - d;                  col->nwidth += intsz - col->decimal;
                 d = col->decimal;                  col->decimal = intsz;
         } else          } else
                 col->width += d - col->decimal;                  totsz += col->decimal - intsz;
   
         if (sz > col->width)          /* Update the maximum total width seen so far. */
                 col->width = sz;  
         if (d > col->decimal)          if (totsz > col->nwidth)
                 col->decimal = d;                  col->nwidth = totsz;
           return totsz;
 }  }
Legend:
Removed from v.1.44  
changed lines
  Added in v.1.77
CVSweb