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

Diff for /mandoc/roff.c between version 1.5 and 1.70

version 1.5, 2008/11/25 16:49:57 version 1.70, 2010/05/15 20:51:40
Line 1 
Line 1 
 /* $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>   * Copyright (c) 2010 Kristaps Dzonsons <kristaps@bsd.lv>
  *   *
  * 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   * purpose with or without fee is hereby granted, provided that the above
  * above copyright notice and this permission notice appear in all   * copyright notice and this permission notice appear in all copies.
  * copies.  
  *   *
  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL   * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED   * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE   * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL   * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR   * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER   * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR   * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  * PERFORMANCE OF THIS SOFTWARE.  
  */   */
   #ifdef HAVE_CONFIG_H
   #include "config.h"
   #endif
   
 #include <assert.h>  #include <assert.h>
 #include <ctype.h>  
 #include <err.h>  
 #include <stdlib.h>  #include <stdlib.h>
 #include <stdio.h>  
 #include <string.h>  #include <string.h>
 #include <time.h>  
   
 #include "libmdocml.h"  #include "mandoc.h"
 #include "private.h"  #include "roff.h"
   
 #define ROFF_MAXARG       10  enum    rofft {
           ROFF_de,
 /* Whether we're entering or leaving a roff scope. */          ROFF_dei,
 enum    roffd {          ROFF_am,
         ROFF_ENTER = 0,          ROFF_ami,
         ROFF_EXIT          ROFF_ig,
           ROFF_close,
           ROFF_MAX
 };  };
   
 /* The type of a macro (see mdoc(7) for more). */  struct  roff {
 enum    rofftype {          struct roffnode *last; /* leaf of stack */
         ROFF_COMMENT,          mandocmsg        msg; /* err/warn/fatal messages */
         ROFF_TEXT,          void            *data; /* privdata for messages */
         ROFF_LAYOUT  
 };  };
   
 /* Arguments passed to a macro callback. */  struct  roffnode {
 #define ROFFCALL_ARGS \          enum rofft       tok; /* type of node */
         int tok, struct rofftree *tree, \          struct roffnode *parent; /* up one in stack */
         const char *argv[], enum roffd type          int              line; /* parse line */
           int              col; /* parse col */
 struct  rofftree;  
   
 /* Describes a roff token (like D1 or Sh). */  
 struct  rofftok {  
         int             (*cb)(ROFFCALL_ARGS);   /* Callback. */  
         const int        *args;                 /* Args (or NULL). */  
         enum rofftype     type;                 /* Type of macro. */  
         int               symm;                 /* FIXME */  
         int               flags;  
 #define ROFF_NESTED      (1 << 0)               /* Nested-layout. */  
 #define ROFF_PARSED      (1 << 1)               /* "Parsed". */  
 #define ROFF_CALLABLE    (1 << 2)               /* "Callable". */  
 #define ROFF_QUOTES      (1 << 3)               /* Quoted args. */  
 };  };
   
 /* An argument to a roff token (like -split or -enum). */  #define ROFF_ARGS        struct roff *r, /* parse ctx */ \
 struct  roffarg {                           char **bufp, /* input buffer */ \
         int               flags;                           size_t *szp, /* size of input buffer */ \
 #define ROFF_VALUE       (1 << 0)               /* Has a value. */                           int ln, /* parse line */ \
 };                           int ppos /* current pos in buffer */
   
 /* mdocml remembers only the current parse node and the chain leading to  typedef enum rofferr (*roffproc)(ROFF_ARGS);
  * the document root (scopes).  
  */  
 struct  roffnode {  
         int               tok;                  /* Token id. */  
         struct roffnode  *parent;               /* Parent (or NULL). */  
         size_t            line;                 /* Parsed at line. */  
 };  
   
 /* State of file parse. */  struct  roffmac {
 struct  rofftree {          const char      *name; /* macro name */
         struct roffnode  *last;                 /* Last parsed node. */          roffproc         sub; /* child of control black */
         time_t            date;                 /* `Dd' results. */          roffproc         new; /* root of stack (type = ROFF_MAX) */
         char              os[64];               /* `Os' results. */  
         char              title[64];            /* `Dt' results. */  
         char              section[64];          /* `Dt' results. */  
         char              volume[64];           /* `Dt' results. */  
         int               state;  
 #define ROFF_PRELUDE     (1 << 1)               /* In roff prelude. */  
         /* FIXME: if we had prev ptrs, this wouldn't be necessary. */  
 #define ROFF_PRELUDE_Os  (1 << 2)               /* `Os' is parsed. */  
 #define ROFF_PRELUDE_Dt  (1 << 3)               /* `Dt' is parsed. */  
 #define ROFF_PRELUDE_Dd  (1 << 4)               /* `Dd' is parsed. */  
 #define ROFF_BODY        (1 << 5)               /* In roff body. */  
         roffin           roffin;                /* Text-macro cb. */  
         roffblkin        roffblkin;             /* Block-macro cb. */  
         roffout          roffout;               /* Text-macro cb. */  
         roffblkout       roffblkout;            /* Block-macro cb. */  
         struct md_mbuf          *mbuf;          /* Output (or NULL). */  
         const struct md_args    *args;          /* Global args. */  
         const struct md_rbuf    *rbuf;          /* Input. */  
 };  };
   
 static  int               roff_Dd(ROFFCALL_ARGS);  static  enum rofferr     roff_ignore(ROFF_ARGS);
 static  int               roff_Dt(ROFFCALL_ARGS);  static  enum rofferr     roff_new_close(ROFF_ARGS);
 static  int               roff_Os(ROFFCALL_ARGS);  static  enum rofferr     roff_new_ig(ROFF_ARGS);
 static  int               roff_layout(ROFFCALL_ARGS);  static  enum rofferr     roff_sub_ig(ROFF_ARGS);
 static  int               roff_text(ROFFCALL_ARGS);  
   
 static  struct roffnode  *roffnode_new(int, struct rofftree *);  const   struct roffmac   roffs[ROFF_MAX] = {
 static  void              roffnode_free(int, struct rofftree *);          { "de", NULL, roff_ignore },
           { "dei", NULL, roff_ignore },
 static  int               rofffindtok(const char *);          { "am", NULL, roff_ignore },
 static  int               rofffindarg(const char *);          { "ami", NULL, roff_ignore },
 static  int               rofffindcallable(const char *);          { "ig", roff_sub_ig, roff_new_ig },
 static  int               roffargs(int, char *, char **);          { ".", NULL, roff_new_close },
 static  int               roffargok(int, int);  
 static  int               roffnextopt(int, const char ***, char **);  
 static  int               roffparse(struct rofftree *, char *, size_t);  
 static  int               textparse(const struct rofftree *,  
                                 const char *, size_t);  
   
 /* Arguments for `An' macro. */  
 static  const int roffarg_An[] = {  
         ROFF_Split, ROFF_Nosplit, ROFF_ARGMAX };  
 /* Arguments for `Bd' macro. */  
 static  const int roffarg_Bd[] = {  
         ROFF_Ragged, ROFF_Unfilled, ROFF_Literal, ROFF_File,  
         ROFF_Offset, ROFF_ARGMAX };  
 /* Arguments for `Bl' macro. */  
 static  const int roffarg_Bl[] = {  
         ROFF_Bullet, ROFF_Dash, ROFF_Hyphen, ROFF_Item, ROFF_Enum,  
         ROFF_Tag, ROFF_Diag, ROFF_Hang, ROFF_Ohang, ROFF_Inset,  
         ROFF_Column, ROFF_Offset, ROFF_ARGMAX };  
   
 /* FIXME: a big list of fixes that must occur.  
  *  
  * (1) Distinction not between ROFF_TEXT and ROFF_LAYOUT, but instead  
  *     ROFF_ATOM and ROFF_NODE, which designate line spacing.  If  
  *     ROFF_ATOM, we need not remember any state.  
  *  
  * (2) Have a maybe-NULL list of possible subsequent children for each  
  *     node.  Bl, e.g., can only have It children (roffparse).  
  *  
  * (3) Have a maybe-NULL list of possible parents for each node.  It,  
  *     e.g., can only have Bl as a parent (roffparse).  
  *  
  *     (N.B. If (2) were complete, (3) wouldn't be necessary.)  
  *  
  * (4) Scope rules.  If Pp exists, it closes the scope out from the  
  *     previous Pp (if it exists).  Same with Sh and Ss.  If El exists,  
  *     it closes out Bl and interim It.  
  *  
  * (5) Nesting.  Sh cannot be any descendant of Sh.  Bl, however, can be  
  *     nested within an It.  
  *  
  * Once that's done, we're golden.  
  */  
   
 /* Table of all known tokens. */  
 static  const struct rofftok tokens[ROFF_MAX] = {  
         {        NULL,       NULL, 0, ROFF_COMMENT, 0 },        /* \" */  
         {     roff_Dd,       NULL, 0, ROFF_TEXT, 0 },   /* Dd */  
         {     roff_Dt,       NULL, 0, ROFF_TEXT, 0 },   /* Dt */  
         {     roff_Os,       NULL, 0, ROFF_TEXT, 0 },   /* Os */  
         { roff_layout,       NULL, ROFF_Sh, ROFF_LAYOUT, ROFF_PARSED }, /* Sh */  
         { roff_layout,       NULL, ROFF_Ss, ROFF_LAYOUT, ROFF_PARSED }, /* Ss */  
         { roff_layout,       NULL, ROFF_Pp, ROFF_LAYOUT, 0 },   /* Pp */  
         { roff_layout,       NULL, 0, ROFF_TEXT, 0 },           /* D1 */  
         { roff_layout,       NULL, 0, ROFF_TEXT, 0 },           /* Dl */  
         { roff_layout, roffarg_Bd, 0, ROFF_LAYOUT, 0 },         /* Bd */  
         { roff_layout,       NULL, ROFF_Bd, ROFF_LAYOUT, 0 },   /* Ed */  
         { roff_layout, roffarg_Bl, 0, ROFF_LAYOUT, 0 },         /* Bl */  
         { roff_layout,       NULL, ROFF_Bl, ROFF_LAYOUT, 0 },   /* El */  
         { roff_layout,       NULL, ROFF_It, ROFF_LAYOUT, 0 },   /* It */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ad */  
         {   roff_text, roffarg_An, 0, ROFF_TEXT, ROFF_PARSED }, /* An */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ar */  
         {   roff_text,       NULL, 0, ROFF_TEXT, 0 },   /* Cd */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Cm */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Dv */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Er */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ev */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ex */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Fa */  
         {   roff_text,       NULL, 0, ROFF_TEXT, 0 },   /* Fd */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Fl */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Fn */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ft */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ic */  
         {   roff_text,       NULL, 0, ROFF_TEXT, 0 },   /* In */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Li */  
         {   roff_text,       NULL, 0, ROFF_TEXT, 0 },   /* Nd */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Nm */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Op */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ot */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Pa */  
         {   roff_text,       NULL, 0, ROFF_TEXT, 0 },   /* Rv */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* St */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Va */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Vt */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Xr */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* %A */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE}, /* %B */  
         {   roff_text,       NULL, 0, ROFF_TEXT, 0 },   /* %D */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE}, /* %I */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE}, /* %J */  
         {   roff_text,       NULL, 0, ROFF_TEXT, 0 },   /* %N */  
         {   roff_text,       NULL, 0, ROFF_TEXT, 0 },   /* %O */  
         {   roff_text,       NULL, 0, ROFF_TEXT, 0 },   /* %P */  
         {   roff_text,       NULL, 0, ROFF_TEXT, 0 },   /* %R */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* %T */  
         {   roff_text,       NULL, 0, ROFF_TEXT, 0 },   /* %V */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ac */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ao */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Aq */  
         {   roff_text,       NULL, 0, ROFF_TEXT, 0 },   /* At */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Bc */  
         {   roff_text,       NULL, 0, ROFF_TEXT, 0 },   /* Bf */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Bo */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Bq */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Bsx */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Bx */  
         {   roff_text,       NULL, 0, ROFF_TEXT, 0 },   /* Db */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Dc */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Do */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Dq */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ec */  
         {   roff_text,       NULL, 0, ROFF_TEXT, 0 },   /* Ef */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Em */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Eo */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Fx */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Ms */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* No */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ns */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Nx */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Ox */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Pc */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Pf */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Po */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Pq */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Qc */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ql */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Qo */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Qq */  
         {   roff_text,       NULL, 0, ROFF_TEXT, 0 },   /* Re */  
         {   roff_text,       NULL, 0, ROFF_TEXT, 0 },   /* Rs */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Sc */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* So */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Sq */  
         {   roff_text,       NULL, 0, ROFF_TEXT, 0 },   /* Sm */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Sx */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Sy */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Tn */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Ux */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Xc */  
         {   roff_text,       NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Xo */  
 };  };
   
 /* Table of all known token arguments. */  static  void             roff_free1(struct roff *);
 static  const struct roffarg tokenargs[ROFF_ARGMAX] = {  static  enum rofft       roff_hash_find(const char *);
         { 0 },                                          /* split */  static  int              roffnode_push(struct roff *,
         { 0 },                                          /* nosplit */                                  enum rofft, int, int);
         { 0 },                                          /* ragged */  static  void             roffnode_pop(struct roff *);
         { 0 },                                          /* unfilled */  static  enum rofft       roff_parse(const char *, int *);
         { 0 },                                          /* literal */  
         { ROFF_VALUE },                                 /* file */  
         { ROFF_VALUE },                                 /* offset */  
         { 0 },                                          /* bullet */  
         { 0 },                                          /* dash */  
         { 0 },                                          /* hyphen */  
         { 0 },                                          /* item */  
         { 0 },                                          /* enum */  
         { 0 },                                          /* tag */  
         { 0 },                                          /* diag */  
         { 0 },                                          /* hang */  
         { 0 },                                          /* ohang */  
         { 0 },                                          /* inset */  
         { 0 },                                          /* column */  
         { 0 },                                          /* width */  
         { 0 },                                          /* compact */  
 };  
   
 const   char *const toknamesp[ROFF_MAX] =  
         {  
         "\\\"",  
         "Dd",   /* Title macros. */  
         "Dt",  
         "Os",  
         "Sh",   /* Layout macros */  
         "Ss",  
         "Pp",  
         "D1",  
         "Dl",  
         "Bd",  
         "Ed",  
         "Bl",  
         "El",  
         "It",  
         "Ad",   /* Text macros. */  
         "An",  
         "Ar",  
         "Cd",  
         "Cm",  
         "Dr",  
         "Er",  
         "Ev",  
         "Ex",  
         "Fa",  
         "Fd",  
         "Fl",  
         "Fn",  
         "Ft",  
         "Ex",  
         "Ic",  
         "In",  
         "Li",  
         "Nd",  
         "Nm",  
         "Op",  
         "Ot",  
         "Pa",  
         "Rv",  
         "St",  
         "Va",  
         "Vt",  
         "Xr",  
         "\%A",  /* General text macros. */  
         "\%B",  
         "\%D",  
         "\%I",  
         "\%J",  
         "\%N",  
         "\%O",  
         "\%P",  
         "\%R",  
         "\%T",  
         "\%V",  
         "Ac",  
         "Ao",  
         "Aq",  
         "At",  
         "Bc",  
         "Bf",  
         "Bo",  
         "Bq",  
         "Bsx",  
         "Bx",  
         "Db",  
         "Dc",  
         "Do",  
         "Dq",  
         "Ec",  
         "Ef",  
         "Em",  
         "Eo",  
         "Fx",  
         "Ms",  
         "No",  
         "Ns",  
         "Nx",  
         "Ox",  
         "Pc",  
         "Pf",  
         "Po",  
         "Pq",  
         "Qc",  
         "Ql",  
         "Qo",  
         "Qq",  
         "Re",  
         "Rs",  
         "Sc",  
         "So",  
         "Sq",  
         "Sm",  
         "Sx",  
         "Sy",  
         "Tn",  
         "Ux",  
         "Xc",   /* FIXME: do not support! */  
         "Xo",   /* FIXME: do not support! */  
         };  
   
 const   char *const tokargnamesp[ROFF_ARGMAX] =  /*
         {   * Look up a roff token by its name.  Returns ROFF_MAX if no macro by
         "split",   * the nil-terminated string name could be found.
         "nosplit",   */
         "ragged",  static enum rofft
         "unfilled",  roff_hash_find(const char *p)
         "literal",  
         "file",  
         "offset",  
         "bullet",  
         "dash",  
         "hyphen",  
         "item",  
         "enum",  
         "tag",  
         "diag",  
         "hang",  
         "ohang",  
         "inset",  
         "column",  
         "width",  
         "compact",  
         };  
   
 const   char *const *toknames = toknamesp;  
 const   char *const *tokargnames = tokargnamesp;  
   
   
 int  
 roff_free(struct rofftree *tree, int flush)  
 {  {
         int              error;          int              i;
   
         assert(tree->mbuf);          /* FIXME: make this be fast and efficient. */
         if ( ! flush)  
                 tree->mbuf = NULL;  
   
         /* LINTED */          for (i = 0; i < (int)ROFF_MAX; i++)
         while (tree->last)                  if (0 == strcmp(roffs[i].name, p))
                 if ( ! (*tokens[tree->last->tok].cb)                          return((enum rofft)i);
                                 (tree->last->tok, tree, NULL, ROFF_EXIT))  
                         /* Disallow flushing. */  
                         tree->mbuf = NULL;  
   
         error = tree->mbuf ? 0 : 1;          return(ROFF_MAX);
   
         if (tree->mbuf && (ROFF_PRELUDE & tree->state)) {  
                 warnx("%s: prelude never finished",  
                                 tree->rbuf->name);  
                 error = 1;  
         }  
   
         free(tree);  
         return(error ? 0 : 1);  
 }  }
   
   
 struct rofftree *  /*
 roff_alloc(const struct md_args *args, struct md_mbuf *out,   * Pop the current node off of the stack of roff instructions currently
                 const struct md_rbuf *in, roffin textin,   * pending.
                 roffout textout, roffblkin blkin, roffblkout blkout)   */
   static void
   roffnode_pop(struct roff *r)
 {  {
         struct rofftree *tree;          struct roffnode *p;
   
         if (NULL == (tree = calloc(1, sizeof(struct rofftree)))) {          if (NULL == (p = r->last))
                 warn("malloc");                  return;
                 return(NULL);          r->last = p->parent;
         }          free(p);
   
         tree->state = ROFF_PRELUDE;  
         tree->args = args;  
         tree->mbuf = out;  
         tree->rbuf = in;  
         tree->roffin = textin;  
         tree->roffout = textout;  
         tree->roffblkin = blkin;  
         tree->roffblkout = blkout;  
   
         return(tree);  
 }  }
   
   
 int  /*
 roff_engine(struct rofftree *tree, char *buf, size_t sz)   * Push a roff node onto the instruction stack.  This must later be
    * removed with roffnode_pop().
    */
   static int
   roffnode_push(struct roff *r, enum rofft tok, int line, int col)
 {  {
           struct roffnode *p;
   
         if (0 == sz) {          if (NULL == (p = calloc(1, sizeof(struct roffnode)))) {
                 warnx("%s: blank line (line %zu)",                  (*r->msg)(MANDOCERR_MEM, r->data, line, col, NULL);
                                 tree->rbuf->name,  
                                 tree->rbuf->line);  
                 return(0);                  return(0);
         } else if ('.' != *buf)  
                 return(textparse(tree, buf, sz));  
   
         return(roffparse(tree, buf, sz));  
 }  
   
   
 static int  
 textparse(const struct rofftree *tree, const char *buf, size_t sz)  
 {  
   
         if (NULL == tree->last) {  
                 warnx("%s: unexpected text (line %zu)",  
                                 tree->rbuf->name,  
                                 tree->rbuf->line);  
                 return(0);  
         } else if (NULL == tree->last->parent) {  
                 warnx("%s: disallowed text (line %zu)",  
                                 tree->rbuf->name,  
                                 tree->rbuf->line);  
                 return(0);  
         }          }
   
         /* Print text. */          p->tok = tok;
           p->parent = r->last;
           p->line = line;
           p->col = col;
   
           r->last = p;
         return(1);          return(1);
 }  }
   
   
 static int  static void
 roffargs(int tok, char *buf, char **argv)  roff_free1(struct roff *r)
 {  {
         int              i;  
   
         (void)tok;/* FIXME: quotable strings? */          while (r->last)
                   roffnode_pop(r);
         assert(tok >= 0 && tok < ROFF_MAX);  
         assert('.' == *buf);  
   
         /* LINTED */  
         for (i = 0; *buf && i < ROFF_MAXARG; i++) {  
                 argv[i] = buf++;  
                 while (*buf && ! isspace(*buf))  
                         buf++;  
                 if (0 == *buf) {  
                         continue;  
                 }  
                 *buf++ = 0;  
                 while (*buf && isspace(*buf))  
                         buf++;  
         }  
   
         assert(i > 0);  
         if (i < ROFF_MAXARG)  
                 argv[i] = NULL;  
   
         return(ROFF_MAXARG > i);  
 }  }
   
   
 static int  void
 roffparse(struct rofftree *tree, char *buf, size_t sz)  roff_reset(struct roff *r)
 {  {
         int               tok, t;  
         struct roffnode  *node;  
         char             *argv[ROFF_MAXARG];  
         const char      **argvp;  
   
         assert(sz > 0);          roff_free1(r);
   
         /*  
          * Extract the token identifier from the buffer.  If there's no  
          * callback for the token (comment, etc.) then exit immediately.  
          * We don't do any error handling (yet), so if the token doesn't  
          * exist, die.  
          */  
   
         if (3 > sz) {  
                 warnx("%s: malformed line (line %zu)",  
                                 tree->rbuf->name,  
                                 tree->rbuf->line);  
                 return(0);  
   
         /* FIXME: .Bsx is three letters! */  
         } else if (ROFF_MAX == (tok = rofffindtok(buf + 1))) {  
                 warnx("%s: unknown line token `%c%c' (line %zu)",  
                                 tree->rbuf->name,  
                                 *(buf + 1), *(buf + 2),  
                                 tree->rbuf->line);  
                 return(0);  
         } else if (ROFF_COMMENT == tokens[tok].type)  
                 /* Ignore comment tokens. */  
                 return(1);  
   
         if ( ! roffargs(tok, buf, argv)) {  
                 warnx("%s: too many arguments to `%s' (line %zu)",  
                                 tree->rbuf->name, toknames[tok],  
                                 tree->rbuf->line);  
                 return(0);  
         }  
   
         /*  
          * If this is a non-nestable layout token and we're below a  
          * token of the same type, then recurse upward to the token,  
          * closing out the interim scopes.  
          *  
          * If there's a nested token on the chain, then raise an error  
          * as nested tokens have corresponding "ending" tokens and we're  
          * breaking their scope.  
          */  
   
         node = NULL;  
   
         if (ROFF_LAYOUT == tokens[tok].type &&  
                         ! (ROFF_NESTED & tokens[tok].flags)) {  
                 for (node = tree->last; node; node = node->parent) {  
                         if (node->tok == tok)  
                                 break;  
   
                         /* Don't break nested scope. */  
   
                         if ( ! (ROFF_NESTED & tokens[node->tok].flags))  
                                 continue;  
                         warnx("%s: scope of %s (line %zu) broken by "  
                                         "%s (line %zu)",  
                                         tree->rbuf->name,  
                                         toknames[tok], node->line,  
                                         toknames[node->tok],  
                                         tree->rbuf->line);  
                         return(0);  
                 }  
         }  
   
         if (node) {  
                 assert(ROFF_LAYOUT == tokens[tok].type);  
                 assert( ! (ROFF_NESTED & tokens[tok].flags));  
                 assert(node->tok == tok);  
   
                 /* Clear up to last scoped token. */  
   
                 /* LINTED */  
                 do {  
                         t = tree->last->tok;  
                         if ( ! (*tokens[tree->last->tok].cb)  
                                         (tree->last->tok, tree, NULL, ROFF_EXIT))  
                                 return(0);  
                 } while (t != tok);  
         }  
   
         /* Proceed with actual token processing. */  
   
         argvp = (const char **)&argv[1];  
         return((*tokens[tok].cb)(tok, tree, argvp, ROFF_ENTER));  
 }  }
   
   
 static int  void
 rofffindarg(const char *name)  roff_free(struct roff *r)
 {  {
         size_t           i;  
   
         /* FIXME: use a table, this is slow but ok for now. */          roff_free1(r);
           free(r);
         /* LINTED */  
         for (i = 0; i < ROFF_ARGMAX; i++)  
                 /* LINTED */  
                 if (0 == strcmp(name, tokargnames[i]))  
                         return((int)i);  
   
         return(ROFF_ARGMAX);  
 }  }
   
   
 static int  struct roff *
 rofffindtok(const char *name)  roff_alloc(const mandocmsg msg, void *data)
 {  {
         size_t           i;          struct roff     *r;
   
         /* FIXME: use a table, this is slow but ok for now. */          if (NULL == (r = calloc(1, sizeof(struct roff)))) {
                   (*msg)(MANDOCERR_MEM, data, 0, 0, NULL);
                   return(0);
           }
   
         /* LINTED */          r->msg = msg;
         for (i = 0; i < ROFF_MAX; i++)          r->data = data;
                 /* LINTED */          return(r);
                 if (0 == strncmp(name, toknames[i], 2))  
                         return((int)i);  
   
         return(ROFF_MAX);  
 }  }
   
   
 static int  enum rofferr
 rofffindcallable(const char *name)  roff_parseln(struct roff *r, int ln, char **bufp, size_t *szp)
 {  {
         int              c;          enum rofft       t;
           int              ppos;
   
         if (ROFF_MAX == (c = rofffindtok(name)))          if (NULL != r->last) {
                 return(ROFF_MAX);                  /*
         return(ROFF_CALLABLE & tokens[c].flags ? c : ROFF_MAX);                   * If there's a node on the stack, then jump directly
 }                   * into its processing function.
                    */
                   t = r->last->tok;
                   assert(roffs[t].sub);
                   return((*roffs[t].sub)(r, bufp, szp, ln, 0));
           } else if ('.' != (*bufp)[0] && NULL == r->last)
                   /* Return when in free text without a context. */
                   return(ROFF_CONT);
   
           /* There's nothing on the stack: make us anew. */
   
 static struct roffnode *          if (ROFF_MAX == (t = roff_parse(*bufp, &ppos)))
 roffnode_new(int tokid, struct rofftree *tree)                  return(ROFF_CONT);
 {  
         struct roffnode *p;  
   
         if (NULL == (p = malloc(sizeof(struct roffnode)))) {  
                 warn("malloc");  
                 return(NULL);  
         }  
   
         p->line = tree->rbuf->line;          assert(roffs[t].new);
         p->tok = tokid;          return((*roffs[t].new)(r, bufp, szp, ln, ppos));
         p->parent = tree->last;  
         tree->last = p;  
         return(p);  
 }  }
   
   
 static int  /*
 roffargok(int tokid, int argid)   * Parse a roff node's type from the input buffer.  This must be in the
    * form of ".foo xxx" in the usual way.
    */
   static enum rofft
   roff_parse(const char *buf, int *pos)
 {  {
         const int       *c;          int              j;
           char             mac[5];
           enum rofft       t;
   
         if (NULL == (c = tokens[tokid].args))          assert('.' == buf[0]);
                 return(0);          *pos = 1;
   
         for ( ; ROFF_ARGMAX != *c; c++)          while (buf[*pos] && (' ' == buf[*pos] || '\t' == buf[*pos]))
                 if (argid == *c)                  (*pos)++;
                         return(1);  
   
         return(0);          if ('\0' == buf[*pos])
 }                  return(ROFF_MAX);
   
           for (j = 0; j < 4; j++, (*pos)++)
                   if ('\0' == (mac[j] = buf[*pos]))
                           break;
                   else if (' ' == buf[*pos])
                           break;
   
 static void          if (j == 4 || j < 1)
 roffnode_free(int tokid, struct rofftree *tree)                  return(ROFF_MAX);
 {  
         struct roffnode *p;  
   
         assert(tree->last);          mac[j] = '\0';
         assert(tree->last->tok == tokid);  
   
         p = tree->last;          if (ROFF_MAX == (t = roff_hash_find(mac)))
         tree->last = tree->last->parent;                  return(t);
         free(p);  
 }  
   
           while (buf[*pos] && ' ' == buf[*pos])
                   (*pos)++;
   
 /* ARGSUSED */          return(t);
 static  int  
 roff_Dd(ROFFCALL_ARGS)  
 {  
   
         if (ROFF_BODY & tree->state) {  
                 assert( ! (ROFF_PRELUDE & tree->state));  
                 assert(ROFF_PRELUDE_Dd & tree->state);  
                 return(roff_text(tok, tree, argv, type));  
         }  
   
         assert(ROFF_PRELUDE & tree->state);  
         assert( ! (ROFF_BODY & tree->state));  
   
         if (ROFF_PRELUDE_Dd & tree->state ||  
                         ROFF_PRELUDE_Dt & tree->state) {  
                 warnx("%s: prelude `Dd' out-of-order (line %zu)",  
                                 tree->rbuf->name, tree->rbuf->line);  
                 return(0);  
         }  
   
         /* TODO: parse date. */  
   
         assert(NULL == tree->last);  
         tree->state |= ROFF_PRELUDE_Dd;  
   
         return(1);  
 }  }
   
   
 /* ARGSUSED */  /* ARGSUSED */
 static  int  static enum rofferr
 roff_Dt(ROFFCALL_ARGS)  roff_ignore(ROFF_ARGS)
 {  {
   
         if (ROFF_BODY & tree->state) {          return(ROFF_IGN);
                 assert( ! (ROFF_PRELUDE & tree->state));  
                 assert(ROFF_PRELUDE_Dt & tree->state);  
                 return(roff_text(tok, tree, argv, type));  
         }  
   
         assert(ROFF_PRELUDE & tree->state);  
         assert( ! (ROFF_BODY & tree->state));  
   
         if ( ! (ROFF_PRELUDE_Dd & tree->state) ||  
                         (ROFF_PRELUDE_Dt & tree->state)) {  
                 warnx("%s: prelude `Dt' out-of-order (line %zu)",  
                                 tree->rbuf->name, tree->rbuf->line);  
                 return(0);  
         }  
   
         /* TODO: parse date. */  
   
         assert(NULL == tree->last);  
         tree->state |= ROFF_PRELUDE_Dt;  
   
         return(1);  
 }  }
   
   
 /* ARGSUSED */  /* ARGSUSED */
 static  int  static enum rofferr
 roff_Os(ROFFCALL_ARGS)  roff_sub_ig(ROFF_ARGS)
 {  {
           enum rofft       t;
           int              pos;
   
         if (ROFF_EXIT == type) {          /* Ignore free-text lines. */
                 assert(ROFF_PRELUDE_Os & tree->state);  
                 return(roff_layout(tok, tree, argv, type));  
         } else if (ROFF_BODY & tree->state) {  
                 assert( ! (ROFF_PRELUDE & tree->state));  
                 assert(ROFF_PRELUDE_Os & tree->state);  
                 return(roff_text(tok, tree, argv, type));  
         }  
   
         assert(ROFF_PRELUDE & tree->state);          if ('.' != (*bufp)[ppos])
         if ( ! (ROFF_PRELUDE_Dt & tree->state) ||                  return(ROFF_IGN);
                         ! (ROFF_PRELUDE_Dd & tree->state)) {  
                 warnx("%s: prelude `Os' out-of-order (line %zu)",  
                                 tree->rbuf->name, tree->rbuf->line);  
                 return(0);  
         }  
   
         /* TODO: extract OS. */          /* Ignore macros unless it's a closing macro. */
   
         tree->state |= ROFF_PRELUDE_Os;          t = roff_parse(*bufp, &pos);
         tree->state &= ~ROFF_PRELUDE;          if (ROFF_close != t)
         tree->state |= ROFF_BODY;                  return(ROFF_IGN);
   
         assert(NULL == tree->last);          roffnode_pop(r);
           return(ROFF_IGN);
         return(roff_layout(tok, tree, argv, type));  
 }  }
   
   
 /* ARGUSED */  /* ARGSUSED */
 static int  static enum rofferr
 roffnextopt(int tok, const char ***in, char **val)  roff_new_close(ROFF_ARGS)
 {  {
         const char      *arg, **argv;  
         int              v;  
   
         *val = NULL;          /*
         argv = *in;          if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
         assert(argv);                  return(ROFF_ERR);
           */
         if (NULL == (arg = *argv))          return(ROFF_IGN);
                 return(-1);  
         if ('-' != *arg)  
                 return(-1);  
   
         /* FIXME: should we let this slide... ? */  
   
         if (ROFF_ARGMAX == (v = rofffindarg(&arg[1])))  
                 return(-1);  
   
         /* FIXME: should we let this slide... ? */  
   
         if ( ! roffargok(tok, v))  
                 return(-1);  
         if ( ! (ROFF_VALUE & tokenargs[v].flags))  
                 return(v);  
   
         *in = ++argv;  
   
         /* FIXME: what if this looks like a roff token or argument? */  
   
         return(*argv ? v : ROFF_ARGMAX);  
 }  }
   
   
 /* ARGSUSED */  /* ARGSUSED */
 static int  static enum rofferr
 roff_layout(ROFFCALL_ARGS)  roff_new_ig(ROFF_ARGS)
 {  {
         int              i, c, argcp[ROFF_MAXARG];  
         char            *v, *argvp[ROFF_MAXARG];  
   
         if (ROFF_PRELUDE & tree->state) {          return(roffnode_push(r, ROFF_ig, ln, ppos) ?
                 warnx("%s: macro `%s' called in prelude (line %zu)",                          ROFF_IGN : ROFF_ERR);
                                 tree->rbuf->name,  
                                 toknames[tok],  
                                 tree->rbuf->line);  
                 return(0);  
         }  
   
         if (ROFF_EXIT == type) {  
                 roffnode_free(tok, tree);  
                 return((*tree->roffblkout)(tok));  
         }  
   
         i = 0;  
   
         while (-1 != (c = roffnextopt(tok, &argv, &v))) {  
                 if (ROFF_ARGMAX == c) {  
                         warnx("%s: error parsing `%s' args (line %zu)",  
                                         tree->rbuf->name,  
                                         toknames[tok],  
                                         tree->rbuf->line);  
                         return(0);  
                 } else if ( ! roffargok(tok, c)) {  
                         warnx("%s: arg `%s' not for `%s' (line %zu)",  
                                         tree->rbuf->name,  
                                         tokargnames[c],  
                                         toknames[tok],  
                                         tree->rbuf->line);  
                         return(0);  
                 }  
                 argcp[i] = c;  
                 argvp[i] = v;  
                 i++;  
                 argv++;  
         }  
   
         argcp[i] = ROFF_ARGMAX;  
         argvp[i] = NULL;  
   
         if (NULL == roffnode_new(tok, tree))  
                 return(0);  
   
         if ( ! (*tree->roffin)(tok, argcp, argvp))  
                 return(0);  
   
         if ( ! (ROFF_PARSED & tokens[tok].flags)) {  
                 /* TODO: print all tokens. */  
   
                 if ( ! ((*tree->roffout)(tok)))  
                         return(0);  
                 return((*tree->roffblkin)(tok));  
         }  
   
         while (*argv) {  
                 if (2 >= strlen(*argv) && ROFF_MAX !=  
                                 (c = rofffindcallable(*argv)))  
                         if ( ! (*tokens[c].cb)(c, tree,  
                                                 argv + 1, ROFF_ENTER))  
                                 return(0);  
   
                 /* TODO: print token. */  
                 argv++;  
         }  
   
         if ( ! ((*tree->roffout)(tok)))  
                 return(0);  
   
         return((*tree->roffblkin)(tok));  
 }  }
   
   
 /* ARGSUSED */  int
 static int  roff_endparse(struct roff *r)
 roff_text(ROFFCALL_ARGS)  
 {  {
         int              i, c, argcp[ROFF_MAXARG];  
         char            *v, *argvp[ROFF_MAXARG];  
   
         if (ROFF_PRELUDE & tree->state) {          if (NULL == r->last)
                 warnx("%s: macro `%s' called in prelude (line %zu)",                  return(1);
                                 tree->rbuf->name,          return((*r->msg)(MANDOCERR_SCOPEEXIT, r->data,
                                 toknames[tok],                                  r->last->line, r->last->col, NULL));
                                 tree->rbuf->line);  
                 return(0);  
         }  
   
         i = 0;  
   
         while (-1 != (c = roffnextopt(tok, &argv, &v))) {  
                 if (ROFF_ARGMAX == c) {  
                         warnx("%s: error parsing `%s' args (line %zu)",  
                                         tree->rbuf->name,  
                                         toknames[tok],  
                                         tree->rbuf->line);  
                         return(0);  
                 }  
                 argcp[i] = c;  
                 argvp[i] = v;  
                 i++;  
                 argv++;  
         }  
   
         argcp[i] = ROFF_ARGMAX;  
         argvp[i] = NULL;  
   
         if ( ! (*tree->roffin)(tok, argcp, argvp))  
                 return(0);  
   
         if ( ! (ROFF_PARSED & tokens[tok].flags)) {  
                 /* TODO: print all tokens. */  
                 return((*tree->roffout)(tok));  
         }  
   
         while (*argv) {  
                 if (2 >= strlen(*argv) && ROFF_MAX !=  
                                 (c = rofffindcallable(*argv)))  
                         if ( ! (*tokens[c].cb)(c, tree,  
                                                 argv + 1, ROFF_ENTER))  
                                 return(0);  
   
                 /* TODO: print token. */  
                 argv++;  
         }  
   
         return((*tree->roffout)(tok));  
 }  }
Legend:
Removed from v.1.5  
changed lines
  Added in v.1.70
CVSweb