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

Diff for /mandoc/Attic/mdocterm.c between version 1.1 and 1.3

version 1.1, 2009/02/21 21:00:06 version 1.3, 2009/02/23 07:09:13
Line 16 
Line 16 
  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR   * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  * PERFORMANCE OF THIS SOFTWARE.   * PERFORMANCE OF THIS SOFTWARE.
  */   */
 #include <sys/stat.h>  
 #include <sys/param.h>  
   
 #include <assert.h>  #include <assert.h>
 #include <fcntl.h>  #include <ctype.h>
 #include <err.h>  #include <err.h>
 #include <getopt.h>  #include <getopt.h>
 #include <stdio.h>  #include <stdio.h>
 #include <stdlib.h>  #include <stdlib.h>
 #include <string.h>  #include <string.h>
 #include <unistd.h>  
   
 #include "mdoc.h"  #include "mmain.h"
 #include "term.h"  #include "term.h"
   
 #define MD_LINE_SZ      (256)           /* Max input line size. */  enum    termstyle {
           STYLE_CLEAR,
 struct  md_parse {          STYLE_BOLD,
         int               warn;         /* Warning flags. */          STYLE_UNDERLINE
 #define MD_WARN_SYNTAX   (1 << 0)       /* Show syntax warnings. */  
 #define MD_WARN_COMPAT   (1 << 1)       /* Show compat warnings. */  
 #define MD_WARN_ALL      (0x03)         /* Show all warnings. */  
 #define MD_WARN_ERR      (1 << 2)       /* Make warnings->errors. */  
         int               dbg;          /* Debug level. */  
         struct mdoc      *mdoc;         /* Active parser. */  
         char             *buf;          /* Input buffer. */  
         u_long            bufsz;        /* Input buffer size. */  
         char             *in;           /* Input file name. */  
         int               fdin;         /* Input file desc. */  
 };  };
   
 extern  char             *__progname;  static  void              body(struct termp *,
                                   const struct mdoc_meta *,
                                   const struct mdoc_node *);
   static  void              header(struct termp *,
                                   const struct mdoc_meta *);
   static  void              footer(struct termp *,
                                   const struct mdoc_meta *);
   
 static  void              usage(void);  static  void              pword(struct termp *, const char *, size_t);
 static  int               getsopts(struct md_parse *, char *);  static  void              pescape(struct termp *,
 static  int               parse(struct md_parse *);                                  const char *, size_t *, size_t);
 static  void              msg_msg(void *, int, int, const char *);  static  void              chara(struct termp *, char);
 static  int               msg_err(void *, int, int, const char *);  static  void              style(struct termp *, enum termstyle);
 static  int               msg_warn(void *, int, int,  
                                 enum mdoc_warn, const char *);  
   
 #ifdef __linux__  #ifdef __linux__
 extern  int               getsubopt(char **, char *const *, char **);  extern  size_t            strlcat(char *, const char *, size_t);
   extern  size_t            strlcpy(char *, const char *, size_t);
 #endif  #endif
   
   
 int  int
 main(int argc, char *argv[])  main(int argc, char *argv[])
 {  {
         struct md_parse  p;          struct mmain    *p;
         struct mdoc_cb   cb;          const struct mdoc *mdoc;
         struct stat      st;          struct termp     termp;
         int              c;  
         extern char     *optarg;          extern int       optreset;
         extern int       optind;          extern int       optind;
   
         (void)memset(&p, 0, sizeof(struct md_parse));          p = mmain_alloc();
   
         while (-1 != (c = getopt(argc, argv, "vW:")))          if ( ! mmain_getopt(p, argc, argv, NULL, NULL, NULL, NULL))
                 switch (c) {                  mmain_exit(p, 1);
                 case ('v'):  
                         p.dbg++;  
                         break;  
                 case ('W'):  
                         if ( ! getsopts(&p, optarg))  
                                 return(0);  
                         break;  
                 default:  
                         usage();  
                         return(0);  
                 }  
   
         argv += optind;          if (NULL == (mdoc = mmain_mdoc(p)))
         argc -= optind;                  mmain_exit(p, 1);
   
         /* Initialise the input file. */          termp.maxrmargin = 80; /* XXX */
           termp.rmargin = termp.maxrmargin;
           termp.maxcols = 1024;
           termp.offset = termp.col = 0;
           termp.flags = TERMP_NOSPACE;
   
         p.in = "-";          if (NULL == (termp.buf = malloc(termp.maxcols)))
         p.fdin = STDIN_FILENO;                  err(1, "malloc");
   
         if (argc > 0) {          header(&termp, mdoc_meta(mdoc));
                 p.in = *argv++;          body(&termp, mdoc_meta(mdoc), mdoc_node(mdoc));
                 p.fdin = open(p.in, O_RDONLY, 0);          footer(&termp, mdoc_meta(mdoc));
                 if (-1 == p.fdin)  
                         err(1, "%s", p.in);  
         }  
   
         /* Allocate a buffer to be BUFSIZ/block size. */          free(termp.buf);
   
         if (-1 == fstat(p.fdin, &st)) {          mmain_exit(p, 0);
                 warn("%s", p.in);          /* NOTREACHED */
                 p.bufsz = BUFSIZ;  }
         } else  
                 p.bufsz = MAX(st.st_blksize, BUFSIZ);  
   
         p.buf = malloc(p.bufsz);  
         if (NULL == p.buf)  
                 err(1, "malloc");  
   
         /* Allocate the parser. */  void
   flushln(struct termp *p)
   {
           size_t           i, j, vsz, vis, maxvis;
   
         cb.mdoc_err = msg_err;          /*
         cb.mdoc_warn = msg_warn;           * First, establish the maximum columns of "visible" content.
         cb.mdoc_msg = msg_msg;           * This is usually the difference between the right-margin and
            * an indentation, but can be, for tagged lists or columns, a
            * small set of values.
            */
   
         p.mdoc = mdoc_alloc(&p, &cb);          assert(p->offset < p->rmargin);
           maxvis = p->rmargin - p->offset;
           vis = 0;
   
         /* Parse the input file. */          /*
            * If in the standard case (left-justified), then begin with our
            * indentation, otherwise (columns, etc.) just start spitting
            * out text.
            */
   
         c = parse(&p);          if ( ! (p->flags & TERMP_NOLPAD))
         free(p.buf);                  /* LINTED */
                   for (j = 0; j < p->offset; j++)
                           putchar(' ');
   
         if (STDIN_FILENO != p.fdin && -1 == close(p.fdin))          /*
                 warn("%s", p.in);           * If we're literal, print out verbatim.
            */
           if (p->flags & TERMP_LITERAL) {
                   /* FIXME: count non-printing chars. */
                   for (i = 0; i < p->col; i++)
                           putchar(p->buf[i]);
                   putchar('\n');
                   p->col = 0;
                   return;
           }
   
         if (0 == c) {          for (i = 0; i < p->col; i++) {
                 mdoc_free(p.mdoc);                  /*
                 return(EXIT_FAILURE);                   * Count up visible word characters.  Control sequences
                    * (starting with the CSI) aren't counted.
                    */
                   assert( ! isspace(p->buf[i]));
   
                   /* LINTED */
                   for (j = i, vsz = 0; j < p->col; j++) {
                           if (isspace(p->buf[j]))
                                   break;
                           else if (27 == p->buf[j]) {
                                   assert(j + 4 <= p->col);
                                   j += 3;
                           } else
                                   vsz++;
                   }
                   assert(vsz > 0);
   
                   /*
                    * If a word is too long and we're within a line, put it
                    * on the next line.  Puke if we're being asked to write
                    * something that will exceed the right margin (i.e.,
                    * from a fresh line or when we're not allowed to break
                    * the line with TERMP_NOBREAK).
                    */
   
                   if (vis && vis + vsz >= maxvis) {
                           /* FIXME */
                           if (p->flags & TERMP_NOBREAK)
                                   errx(1, "word breaks right margin");
                           putchar('\n');
                           for (j = 0; j < p->offset; j++)
                                   putchar(' ');
                           vis = 0;
                   } else if (vis + vsz >= maxvis) {
                           /* FIXME */
                           errx(1, "word breaks right margin");
                   }
   
                   /*
                    * Write out the word and a trailing space.  Omit the
                    * space if we're the last word in the line.
                    */
   
                   for ( ; i < p->col; i++) {
                           if (isspace(p->buf[i]))
                                   break;
                           putchar(p->buf[i]);
                   }
                   vis += vsz;
                   if (i < p->col) {
                           putchar(' ');
                           vis++;
                   }
         }          }
   
         /* If the parse succeeded, print it out. */          /*
            * If we're not to right-marginalise it (newline), then instead
            * pad to the right margin and stay off.
            */
   
         termprint(mdoc_node(p.mdoc), mdoc_meta(p.mdoc));          if (p->flags & TERMP_NOBREAK) {
         mdoc_free(p.mdoc);                  for ( ; vis <= maxvis; vis++)
                           putchar(' ');
           } else
                   putchar('\n');
   
         return(EXIT_SUCCESS);          p->col = 0;
 }  }
   
   
 static int  void
 getsopts(struct md_parse *p, char *arg)  newln(struct termp *p)
 {  {
         char            *v;  
         char            *toks[] = { "all", "compat",  
                                 "syntax", "error", NULL };  
   
         while (*arg)          /*
                 switch (getsubopt(&arg, toks, &v)) {           * A newline only breaks an existing line; it won't assert
                 case (0):           * vertical space.
                         p->warn |= MD_WARN_ALL;           */
                         break;          p->flags |= TERMP_NOSPACE;
                 case (1):          if (0 == p->col)
                         p->warn |= MD_WARN_COMPAT;                  return;
                         break;          flushln(p);
                 case (2):  
                         p->warn |= MD_WARN_SYNTAX;  
                         break;  
                 case (3):  
                         p->warn |= MD_WARN_ERR;  
                         break;  
                 default:  
                         usage();  
                         return(0);  
                 }  
   
         return(1);  
 }  }
   
   
 static int  void
 parse(struct md_parse *p)  vspace(struct termp *p)
 {  {
         ssize_t          sz, i;  
         size_t           pos;  
         char             line[MD_LINE_SZ];  
         int              lnn;  
   
         /*          /*
          * This is a little more complicated than fgets.  TODO: have           * Asserts a vertical space (a full, empty line-break between
          * some benchmarks that show it's faster (note that I want to           * lines).
          * check many, many manuals simultaneously, so speed is  
          * important).  Fill a buffer (sized to the block size) with a  
          * single read, then parse \n-terminated lines into a line  
          * buffer, which is passed to the parser.  Hard-code the line  
          * buffer to a particular size -- a reasonable assumption.  
          */           */
           newln(p);
           putchar('\n');
   }
   
         for (lnn = 1, pos = 0; ; ) {  
                 if (-1 == (sz = read(p->fdin, p->buf, p->bufsz))) {  static void
                         warn("%s", p->in);  chara(struct termp *p, char c)
                         return(0);  {
                 } else if (0 == sz)  
           /* TODO: dynamically expand the buffer. */
           if (p->col + 1 >= p->maxcols)
                   errx(1, "line overrun");
           p->buf[(p->col)++] = c;
   }
   
   
   static void
   style(struct termp *p, enum termstyle esc)
   {
   
           if (p->col + 4 >= p->maxcols)
                   errx(1, "line overrun");
   
           p->buf[(p->col)++] = 27;
           p->buf[(p->col)++] = '[';
           switch (esc) {
           case (STYLE_CLEAR):
                   p->buf[(p->col)++] = '0';
                   break;
           case (STYLE_BOLD):
                   p->buf[(p->col)++] = '1';
                   break;
           case (STYLE_UNDERLINE):
                   p->buf[(p->col)++] = '4';
                   break;
           default:
                   abort();
                   /* NOTREACHED */
           }
           p->buf[(p->col)++] = 'm';
   }
   
   
   static void
   pescape(struct termp *p, const char *word, size_t *i, size_t len)
   {
   
           (*i)++;
           assert(*i < len);
   
           if ('(' == word[*i]) {
                   /* Two-character escapes. */
                   (*i)++;
                   assert(*i + 1 < len);
   
                   if ('r' == word[*i] && 'B' == word[*i + 1])
                           chara(p, ']');
                   else if ('l' == word[*i] && 'B' == word[*i + 1])
                           chara(p, '[');
   
                   (*i)++;
                   return;
   
           } else if ('[' != word[*i]) {
                   /* One-character escapes. */
                   switch (word[*i]) {
                   case ('\\'):
                           /* FALLTHROUGH */
                   case ('\''):
                           /* FALLTHROUGH */
                   case ('`'):
                           /* FALLTHROUGH */
                   case ('-'):
                           /* FALLTHROUGH */
                   case ('.'):
                           chara(p, word[*i]);
                   default:
                         break;                          break;
                   }
                   return;
           }
           /* n-character escapes. */
   }
   
                 for (i = 0; i < sz; i++) {  
                         if ('\n' != p->buf[i]) {  
                                 if (pos < sizeof(line)) {  
                                         line[(int)pos++] = p->buf[(int)i];  
                                         continue;  
                                 }  
                                 warnx("%s: line %d too long", p->in, lnn);  
                                 return(0);  
                         }  
   
                         line[(int)pos] = 0;  
                         if ( ! mdoc_parseln(p->mdoc, lnn, line))  
                                 return(0);  
   
                         lnn++;  static void
                         pos = 0;  pword(struct termp *p, const char *word, size_t len)
   {
           size_t           i;
   
           /*assert(len > 0);*/ /* Can be, if literal. */
   
           if ( ! (p->flags & TERMP_NOSPACE) &&
                           ! (p->flags & TERMP_LITERAL))
                   chara(p, ' ');
   
           p->flags &= ~TERMP_NOSPACE;
   
           if (p->flags & TERMP_BOLD)
                   style(p, STYLE_BOLD);
           if (p->flags & TERMP_UNDERLINE)
                   style(p, STYLE_UNDERLINE);
   
           for (i = 0; i < len; i++) {
                   if ('\\' == word[i]) {
                           pescape(p, word, &i, len);
                           continue;
                 }                  }
                   chara(p, word[i]);
         }          }
   
         return(mdoc_endparse(p->mdoc));          if (p->flags & TERMP_BOLD ||
                           p->flags & TERMP_UNDERLINE)
                   style(p, STYLE_CLEAR);
 }  }
   
   
 static int  void
 msg_err(void *arg, int line, int col, const char *msg)  word(struct termp *p, const char *word)
 {  {
         struct md_parse  *p;          size_t           i, j, len;
   
         p = (struct md_parse *)arg;          if (p->flags & TERMP_LITERAL) {
                   pword(p, word, strlen(word));
                   return;
           }
   
         warnx("%s:%d: error: %s (column %d)",          len = strlen(word);
                         p->in, line, msg, col);          assert(len > 0);
         return(0);  
           if (mdoc_isdelim(word)) {
                   if ( ! (p->flags & TERMP_IGNDELIM))
                           p->flags |= TERMP_NOSPACE;
                   p->flags &= ~TERMP_IGNDELIM;
           }
   
           /* LINTED */
           for (j = i = 0; i < len; i++) {
                   if ( ! isspace(word[i])) {
                           j++;
                           continue;
                   }
                   if (0 == j)
                           continue;
                   assert(i >= j);
                   pword(p, &word[i - j], j);
                   j = 0;
           }
           if (j > 0) {
                   assert(i >= j);
                   pword(p, &word[i - j], j);
           }
 }  }
   
   
 static void  static void
 msg_msg(void *arg, int line, int col, const char *msg)  body(struct termp *p, const struct mdoc_meta *meta,
                   const struct mdoc_node *node)
 {  {
         struct md_parse  *p;          int              dochild;
   
         p = (struct md_parse *)arg;          /* Pre-processing. */
   
         if (0 == p->dbg)          dochild = 1;
                 return;  
   
         warnx("%s:%d: debug: %s (column %d)",          if (MDOC_TEXT != node->type) {
                         p->in, line, msg, col);                  if (termacts[node->tok].pre)
                           if ( ! (*termacts[node->tok].pre)(p, meta, node))
                                   dochild = 0;
           } else /* MDOC_TEXT == node->type */
                   word(p, node->data.text.string);
   
           /* Children. */
   
           if (dochild && node->child)
                   body(p, meta, node->child);
   
           /* Post-processing. */
   
           if (MDOC_TEXT != node->type)
                   if (termacts[node->tok].post)
                           (*termacts[node->tok].post)(p, meta, node);
   
           /* Siblings. */
   
           if (node->next)
                   body(p, meta, node->next);
 }  }
   
   
 static int  static void
 msg_warn(void *arg, int line, int col,  footer(struct termp *p, const struct mdoc_meta *meta)
                 enum mdoc_warn type, const char *msg)  
 {  {
         struct md_parse  *p;          struct tm       *tm;
           char            *buf, *os;
           size_t           sz, osz, ssz, i;
   
         p = (struct md_parse *)arg;          if (NULL == (buf = malloc(p->rmargin)))
                   err(1, "malloc");
           if (NULL == (os = malloc(p->rmargin)))
                   err(1, "malloc");
   
         switch (type) {          tm = localtime(&meta->date);
         case (WARN_COMPAT):  
                 if (p->warn & MD_WARN_COMPAT)  
                         break;  
                 return(1);  
         case (WARN_SYNTAX):  
                 if (p->warn & MD_WARN_SYNTAX)  
                         break;  
                 return(1);  
         }  
   
         warnx("%s:%d: warning: %s (column %d)",  #ifdef __linux__
                         p->in, line, msg, col);          if (0 == strftime(buf, p->rmargin, "%B %d, %Y", tm))
   #else
           if (NULL == strftime(buf, p->rmargin, "%B %d, %Y", tm))
   #endif
                   err(1, "strftime");
   
         if ( ! (p->warn & MD_WARN_ERR))          osz = strlcpy(os, meta->os, p->rmargin);
                 return(1);  
   
         warnx("%s: considering warnings as errors", __progname);          sz = strlen(buf);
         return(0);          ssz = sz + osz + 1;
   
           if (ssz > p->rmargin) {
                   ssz -= p->rmargin;
                   assert(ssz <= osz);
                   os[osz - ssz] = 0;
                   ssz = 1;
           } else
                   ssz = p->rmargin - ssz + 1;
   
           printf("\n");
           printf("%s", os);
           for (i = 0; i < ssz; i++)
                   printf(" ");
   
           printf("%s\n", buf);
           fflush(stdout);
   
           free(buf);
           free(os);
 }  }
   
   
 static void  static void
 usage(void)  header(struct termp *p, const struct mdoc_meta *meta)
 {  {
           char            *buf, *title;
           const char      *pp, *msec;
           size_t           ssz, tsz, ttsz, i;;
   
         warnx("usage: %s [-v] [-Wwarn...] [infile]", __progname);          if (NULL == (buf = malloc(p->rmargin)))
 }                  err(1, "malloc");
           if (NULL == (title = malloc(p->rmargin)))
                   err(1, "malloc");
   
           if (NULL == (pp = mdoc_vol2a(meta->vol)))
                   switch (meta->msec) {
                   case (MSEC_1):
                           /* FALLTHROUGH */
                   case (MSEC_6):
                           /* FALLTHROUGH */
                   case (MSEC_7):
                           pp = mdoc_vol2a(VOL_URM);
                           break;
                   case (MSEC_8):
                           pp = mdoc_vol2a(VOL_SMM);
                           break;
                   case (MSEC_2):
                           /* FALLTHROUGH */
                   case (MSEC_3):
                           /* FALLTHROUGH */
                   case (MSEC_4):
                           /* FALLTHROUGH */
                   case (MSEC_5):
                           pp = mdoc_vol2a(VOL_PRM);
                           break;
                   case (MSEC_9):
                           pp = mdoc_vol2a(VOL_KM);
                           break;
                   default:
                           /* FIXME: capitalise. */
                           if (NULL == (pp = mdoc_msec2a(meta->msec)))
                                   pp = mdoc_msec2a(MSEC_local);
                           break;
                   }
           assert(pp);
   
           tsz = strlcpy(buf, pp, p->rmargin);
           assert(tsz < p->rmargin);
   
           if ((pp = mdoc_arch2a(meta->arch))) {
                   tsz = strlcat(buf, " (", p->rmargin);
                   assert(tsz < p->rmargin);
                   tsz = strlcat(buf, pp, p->rmargin);
                   assert(tsz < p->rmargin);
                   tsz = strlcat(buf, ")", p->rmargin);
                   assert(tsz < p->rmargin);
           }
   
           ttsz = strlcpy(title, meta->title, p->rmargin);
   
           if (NULL == (msec = mdoc_msec2a(meta->msec)))
                   msec = "";
   
           ssz = (2 * (ttsz + 2 + strlen(msec))) + tsz + 2;
   
           if (ssz > p->rmargin) {
                   if ((ssz -= p->rmargin) % 2)
                           ssz++;
                   ssz /= 2;
   
                   assert(ssz <= ttsz);
                   title[ttsz - ssz] = 0;
                   ssz = 1;
           } else
                   ssz = ((p->rmargin - ssz) / 2) + 1;
   
           printf("%s(%s)", title, msec);
   
           for (i = 0; i < ssz; i++)
                   printf(" ");
   
           printf("%s", buf);
   
           for (i = 0; i < ssz; i++)
                   printf(" ");
   
           printf("%s(%s)\n", title, msec);
           fflush(stdout);
   
           free(title);
           free(buf);
   }
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.3
CVSweb