Use the traditional name "whatis.db" for the mandocdb(8) databases.

[mandoc.git] / tbl_layout.c

diff --git a/tbl_layout.c b/tbl_layout.c
index e482328d7f9f279791f15e011113079a0fda9666..7601f146cad60fd627cc7fcb69d4cbf2e070d590 100644 (file)
--- a/tbl_layout.c
+++ b/tbl_layout.c
@@ -1,6 +1,6 @@
-/*     $Id: tbl_layout.c,v 1.4 2011/01/01 21:23:01 kristaps Exp $ */
+/*     $Id: tbl_layout.c,v 1.22 2011/09/18 14:14:15 schwarze Exp $ */

 /*
 /*

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

  *
  * 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


@@ -14,6 +14,10 @@
  * 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"
+#endif
+

 #include <assert.h>
 #include <ctype.h>
 #include <stdlib.h>
 #include <assert.h>
 #include <ctype.h>
 #include <stdlib.h>


@@ -29,6 +33,12 @@ struct       tbl_phrase {
        enum tbl_cellt   key;
 };
 
        enum tbl_cellt   key;
 };
 

+/*
+ * FIXME: we can make this parse a lot nicer by, when an error is
+ * encountered in a layout key, bailing to the next key (i.e. to the
+ * next whitespace then continuing).
+ */
+

 #define        KEYS_MAX         11
 
 static const struct tbl_phrase keys[KEYS_MAX] = {
 #define        KEYS_MAX         11
 
 static const struct tbl_phrase keys[KEYS_MAX] = {


@@ -45,19 +55,40 @@ static      const struct tbl_phrase keys[KEYS_MAX] = {
        { '|',           TBL_CELL_VERT }
 };
 
        { '|',           TBL_CELL_VERT }
 };
 

-static int      mods(struct tbl *, struct tbl_cell *, 
-                       int, const char *, int *);
-static int      cell(struct tbl *, struct tbl_row *, 
-                       int, const char *, int *);
-static void     row(struct tbl *, int, const char *, int *);
+static int              mods(struct tbl_node *, struct tbl_cell *, 
+                               int, const char *, int *);
+static int              cell(struct tbl_node *, struct tbl_row *, 
+                               int, const char *, int *);
+static void             row(struct tbl_node *, int, const char *, int *);
+static struct tbl_cell *cell_alloc(struct tbl_node *, 
+                               struct tbl_row *, enum tbl_cellt);
+static void             head_adjust(const struct tbl_cell *, 
+                               struct tbl_head *);

 
 static int
 
 static int

-mods(struct tbl *tbl, struct tbl_cell *cp, 
+mods(struct tbl_node *tbl, struct tbl_cell *cp, 

                int ln, const char *p, int *pos)
 {
        char             buf[5];
        int              i;
 
                int ln, const char *p, int *pos)
 {
        char             buf[5];
        int              i;
 

+       /* Not all types accept modifiers. */
+
+       switch (cp->pos) {
+       case (TBL_CELL_DOWN):
+               /* FALLTHROUGH */
+       case (TBL_CELL_HORIZ):
+               /* FALLTHROUGH */
+       case (TBL_CELL_DHORIZ):
+               /* FALLTHROUGH */
+       case (TBL_CELL_VERT):
+               /* FALLTHROUGH */
+       case (TBL_CELL_DVERT):
+               return(1);
+       default:
+               break;
+       }
+

 mod:
        /* 
         * XXX: since, at least for now, modifiers are non-conflicting
 mod:
        /* 
         * XXX: since, at least for now, modifiers are non-conflicting


@@ -80,6 +111,21 @@ mod:
                break;
        }
 
                break;
        }
 

+       /* Throw away parenthesised expression. */
+
+       if ('(' == p[*pos]) {
+               (*pos)++;
+               while (p[*pos] && ')' != p[*pos])
+                       (*pos)++;
+               if (')' == p[*pos]) {
+                       (*pos)++;
+                       goto mod;
+               }
+               mandoc_msg(MANDOCERR_TBLLAYOUT, 
+                               tbl->parse, ln, *pos, NULL);
+               return(0);
+       }
+

        /* Parse numerical spacing from modifier string. */
 
        if (isdigit((unsigned char)p[*pos])) {
        /* Parse numerical spacing from modifier string. */
 
        if (isdigit((unsigned char)p[*pos])) {


@@ -93,12 +139,13 @@ mod:
                /* No greater than 4 digits. */
 
                if (4 == i) {
                /* No greater than 4 digits. */
 
                if (4 == i) {

-                       TBL_MSG(tbl, MANDOCERR_TBLLAYOUT, ln, *pos);
+                       mandoc_msg(MANDOCERR_TBLLAYOUT, tbl->parse,
+                                       ln, *pos, NULL);

                        return(0);
                }
 
                *pos += i;
                        return(0);
                }
 
                *pos += i;

-               cp->spacing = atoi(buf);
+               cp->spacing = (size_t)atoi(buf);

 
                goto mod;
                /* NOTREACHED */
 
                goto mod;
                /* NOTREACHED */


@@ -106,7 +153,7 @@ mod:
 
        /* TODO: GNU has many more extensions. */
 
 
        /* TODO: GNU has many more extensions. */
 

-       switch (tolower(p[(*pos)++])) {
+       switch (tolower((unsigned char)p[(*pos)++])) {

        case ('z'):
                cp->flags |= TBL_CELL_WIGN;
                goto mod;
        case ('z'):
                cp->flags |= TBL_CELL_WIGN;
                goto mod;


@@ -122,55 +169,107 @@ mod:
        case ('d'):
                cp->flags |= TBL_CELL_BALIGN;
                goto mod;
        case ('d'):
                cp->flags |= TBL_CELL_BALIGN;
                goto mod;

+       case ('w'):  /* XXX for now, ignore minimal column width */
+               goto mod;

        case ('f'):
                break;
        case ('f'):
                break;

+       case ('r'):
+               /* FALLTHROUGH */

        case ('b'):
                /* FALLTHROUGH */
        case ('i'):
                (*pos)--;
                break;
        default:
        case ('b'):
                /* FALLTHROUGH */
        case ('i'):
                (*pos)--;
                break;
        default:

-               TBL_MSG(tbl, MANDOCERR_TBLLAYOUT, ln, *pos - 1);
+               mandoc_msg(MANDOCERR_TBLLAYOUT, tbl->parse,
+                               ln, *pos - 1, NULL);

                return(0);
        }
 
                return(0);
        }
 

-       switch (tolower(p[(*pos)++])) {
+       switch (tolower((unsigned char)p[(*pos)++])) {
+       case ('3'):
+               /* FALLTHROUGH */

        case ('b'):
                cp->flags |= TBL_CELL_BOLD;
                goto mod;
        case ('b'):
                cp->flags |= TBL_CELL_BOLD;
                goto mod;

+       case ('2'):
+               /* FALLTHROUGH */

        case ('i'):
                cp->flags |= TBL_CELL_ITALIC;
                goto mod;
        case ('i'):
                cp->flags |= TBL_CELL_ITALIC;
                goto mod;

+       case ('1'):
+               /* FALLTHROUGH */
+       case ('r'):
+               goto mod;

        default:
                break;
        }
 
        default:
                break;
        }
 

-       TBL_MSG(tbl, MANDOCERR_TBLLAYOUT, ln, *pos - 1);
+       mandoc_msg(MANDOCERR_TBLLAYOUT, tbl->parse,
+                       ln, *pos - 1, NULL);

        return(0);
 }
 
 static int
        return(0);
 }
 
 static int

-cell(struct tbl *tbl, struct tbl_row *rp, 
+cell(struct tbl_node *tbl, struct tbl_row *rp, 

                int ln, const char *p, int *pos)
 {
                int ln, const char *p, int *pos)
 {

-       struct tbl_cell *cp;

        int              i;
        enum tbl_cellt   c;
 
        /* Parse the column position (`r', `R', `|', ...). */
 
        for (i = 0; i < KEYS_MAX; i++)
        int              i;
        enum tbl_cellt   c;
 
        /* Parse the column position (`r', `R', `|', ...). */
 
        for (i = 0; i < KEYS_MAX; i++)

-               if (tolower(p[*pos]) == keys[i].name)
+               if (tolower((unsigned char)p[*pos]) == keys[i].name)

                        break;
 
        if (KEYS_MAX == i) {
                        break;
 
        if (KEYS_MAX == i) {

-               TBL_MSG(tbl, MANDOCERR_TBLLAYOUT, ln, *pos);
+               mandoc_msg(MANDOCERR_TBLLAYOUT, tbl->parse, 
+                               ln, *pos, NULL);

                return(0);
        }
 
                return(0);
        }
 

-       (*pos)++;

        c = keys[i].key;
 
        c = keys[i].key;
 

+       /*
+        * If a span cell is found first, raise a warning and abort the
+        * parse.  If a span cell is found and the last layout element
+        * isn't a "normal" layout, bail.
+        *
+        * FIXME: recover from this somehow?
+        */
+
+       if (TBL_CELL_SPAN == c) {
+               if (NULL == rp->first) {
+                       mandoc_msg(MANDOCERR_TBLLAYOUT, tbl->parse,
+                                       ln, *pos, NULL);
+                       return(0);
+               } else if (rp->last)
+                       switch (rp->last->pos) {
+                       case (TBL_CELL_VERT):
+                       case (TBL_CELL_DVERT):
+                       case (TBL_CELL_HORIZ):
+                       case (TBL_CELL_DHORIZ):
+                               mandoc_msg(MANDOCERR_TBLLAYOUT, tbl->parse,
+                                               ln, *pos, NULL);
+                               return(0);
+                       default:
+                               break;
+                       }
+       }
+
+       /*
+        * If a vertical spanner is found, we may not be in the first
+        * row.
+        */
+
+       if (TBL_CELL_DOWN == c && rp == tbl->first_row) {
+               mandoc_msg(MANDOCERR_TBLLAYOUT, tbl->parse, ln, *pos, NULL);
+               return(0);
+       }
+
+       (*pos)++;
+

        /* Extra check for the double-vertical. */
 
        if (TBL_CELL_VERT == c && '|' == p[*pos]) {
        /* Extra check for the double-vertical. */
 
        if (TBL_CELL_VERT == c && '|' == p[*pos]) {


@@ -183,27 +282,18 @@ cell(struct tbl *tbl, struct tbl_row *rp,
        if (rp->last && (TBL_CELL_VERT == c || TBL_CELL_DVERT == c) &&
                        (TBL_CELL_VERT == rp->last->pos || 
                         TBL_CELL_DVERT == rp->last->pos)) {
        if (rp->last && (TBL_CELL_VERT == c || TBL_CELL_DVERT == c) &&
                        (TBL_CELL_VERT == rp->last->pos || 
                         TBL_CELL_DVERT == rp->last->pos)) {

-               TBL_MSG(tbl, MANDOCERR_TBLLAYOUT, ln, *pos - 1);
+               mandoc_msg(MANDOCERR_TBLLAYOUT, tbl->parse, ln, *pos - 1, NULL);

                return(0);
        }
 
        /* Allocate cell then parse its modifiers. */
 
                return(0);
        }
 
        /* Allocate cell then parse its modifiers. */
 

-       cp = mandoc_calloc(1, sizeof(struct tbl_cell));
-       cp->pos = c;
-
-       if (rp->last) {
-               rp->last->next = cp;
-               rp->last = cp;
-       } else
-               rp->last = rp->first = cp;
-
-       return(mods(tbl, cp, ln, p, pos));
+       return(mods(tbl, cell_alloc(tbl, rp, c), ln, p, pos));

 }
 
 
 static void
 }
 
 
 static void

-row(struct tbl *tbl, int ln, const char *p, int *pos)
+row(struct tbl_node *tbl, int ln, const char *p, int *pos)

 {
        struct tbl_row  *rp;
 
 {
        struct tbl_row  *rp;
 


@@ -233,7 +323,8 @@ cell:
        if ('.' == p[*pos]) {
                tbl->part = TBL_PART_DATA;
                if (NULL == tbl->first_row) 
        if ('.' == p[*pos]) {
                tbl->part = TBL_PART_DATA;
                if (NULL == tbl->first_row) 

-                       TBL_MSG(tbl, MANDOCERR_TBLNOLAYOUT, ln, *pos);
+                       mandoc_msg(MANDOCERR_TBLNOLAYOUT, tbl->parse, 
+                                       ln, *pos, NULL);

                (*pos)++;
                return;
        }
                (*pos)++;
                return;
        }


@@ -253,9 +344,8 @@ cell:
        /* NOTREACHED */
 }
 
        /* NOTREACHED */
 }
 

-

 int
 int

-tbl_layout(struct tbl *tbl, int ln, const char *p)
+tbl_layout(struct tbl_node *tbl, int ln, const char *p)

 {
        int              pos;
 
 {
        int              pos;
 


@@ -265,3 +355,118 @@ tbl_layout(struct tbl *tbl, int ln, const char *p)
        /* Always succeed. */
        return(1);
 }
        /* Always succeed. */
        return(1);
 }

+
+static struct tbl_cell *
+cell_alloc(struct tbl_node *tbl, struct tbl_row *rp, enum tbl_cellt pos)
+{
+       struct tbl_cell *p, *pp;
+       struct tbl_head *h, *hp;
+
+       p = mandoc_calloc(1, sizeof(struct tbl_cell));
+
+       if (NULL != (pp = rp->last)) {
+               rp->last->next = p;
+               rp->last = p;
+       } else
+               rp->last = rp->first = p;
+
+       p->pos = pos;
+
+       /*
+        * This is a little bit complicated.  Here we determine the
+        * header the corresponds to a cell.  We add headers dynamically
+        * when need be or re-use them, otherwise.  As an example, given
+        * the following:
+        *
+        *      1  c || l 
+        *      2  | c | l
+        *      3  l l
+        *      3  || c | l |.
+        *
+        * We first add the new headers (as there are none) in (1); then
+        * in (2) we insert the first spanner (as it doesn't match up
+        * with the header); then we re-use the prior data headers,
+        * skipping over the spanners; then we re-use everything and add
+        * a last spanner.  Note that VERT headers are made into DVERT
+        * ones.
+        */
+
+       h = pp ? pp->head->next : tbl->first_head;
+
+       if (h) {
+               /* Re-use data header. */
+               if (TBL_HEAD_DATA == h->pos && 
+                               (TBL_CELL_VERT != p->pos &&
+                                TBL_CELL_DVERT != p->pos)) {
+                       p->head = h;
+                       return(p);
+               }
+
+               /* Re-use spanner header. */
+               if (TBL_HEAD_DATA != h->pos && 
+                               (TBL_CELL_VERT == p->pos ||
+                                TBL_CELL_DVERT == p->pos)) {
+                       head_adjust(p, h);
+                       p->head = h;
+                       return(p);
+               }
+
+               /* Right-shift headers with a new spanner. */
+               if (TBL_HEAD_DATA == h->pos && 
+                               (TBL_CELL_VERT == p->pos ||
+                                TBL_CELL_DVERT == p->pos)) {
+                       hp = mandoc_calloc(1, sizeof(struct tbl_head));
+                       hp->ident = tbl->opts.cols++;
+                       hp->prev = h->prev;
+                       if (h->prev)
+                               h->prev->next = hp;
+                       if (h == tbl->first_head)
+                               tbl->first_head = hp;
+                       h->prev = hp;
+                       hp->next = h;
+                       head_adjust(p, hp);
+                       p->head = hp;
+                       return(p);
+               }
+
+               if (NULL != (h = h->next)) {
+                       head_adjust(p, h);
+                       p->head = h;
+                       return(p);
+               }
+
+               /* Fall through to default case... */
+       }
+
+       hp = mandoc_calloc(1, sizeof(struct tbl_head));
+       hp->ident = tbl->opts.cols++;
+
+       if (tbl->last_head) {
+               hp->prev = tbl->last_head;
+               tbl->last_head->next = hp;
+               tbl->last_head = hp;
+       } else
+               tbl->last_head = tbl->first_head = hp;
+
+       head_adjust(p, hp);
+       p->head = hp;
+       return(p);
+}
+
+static void
+head_adjust(const struct tbl_cell *cellp, struct tbl_head *head)
+{
+       if (TBL_CELL_VERT != cellp->pos &&
+                       TBL_CELL_DVERT != cellp->pos) {
+               head->pos = TBL_HEAD_DATA;
+               return;
+       }
+
+       if (TBL_CELL_VERT == cellp->pos)
+               if (TBL_HEAD_DVERT != head->pos)
+                       head->pos = TBL_HEAD_VERT;
+
+       if (TBL_CELL_DVERT == cellp->pos)
+               head->pos = TBL_HEAD_DVERT;
+}
+