contrib/mdocml/demandoc.c

   1 /*      $Id: demandoc.c,v 1.15 2015/02/10 08:05:30 schwarze Exp $ */
   2 /*
   3  * Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
   4  *
   5  * Permission to use, copy, modify, and distribute this software for any
   6  * purpose with or without fee is hereby granted, provided that the above
   7  * copyright notice and this permission notice appear in all copies.
   8  *
   9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16  */
  17 #include "config.h"
  18
  19 #include <sys/types.h>
  20
  21 #include <assert.h>
  22 #include <ctype.h>
  23 #include <getopt.h>
  24 #include <stdio.h>
  25 #include <stdlib.h>
  26 #include <string.h>
  27 #include <unistd.h>
  28
  29 #include "man.h"
  30 #include "mdoc.h"
  31 #include "mandoc.h"
  32
  33 static  void     pline(int, int *, int *, int);
  34 static  void     pman(const struct man_node *, int *, int *, int);
  35 static  void     pmandoc(struct mparse *, int, const char *, int);
  36 static  void     pmdoc(const struct mdoc_node *, int *, int *, int);
  37 static  void     pstring(const char *, int, int *, int);
  38 static  void     usage(void);
  39
  40 static  const char       *progname;
  41
  42 int
  43 main(int argc, char *argv[])
  44 {
  45         struct mparse   *mp;
  46         struct mchars   *mchars;
  47         int              ch, fd, i, list;
  48         extern int       optind;
  49
  50         if (argc < 1)
  51                 progname = "demandoc";
  52         else if ((progname = strrchr(argv[0], '/')) == NULL)
  53                 progname = argv[0];
  54         else
  55                 ++progname;
  56
  57         mp = NULL;
  58         list = 0;
  59
  60         while (-1 != (ch = getopt(argc, argv, "ikm:pw")))
  61                 switch (ch) {
  62                 case ('i'):
  63                         /* FALLTHROUGH */
  64                 case ('k'):
  65                         /* FALLTHROUGH */
  66                 case ('m'):
  67                         /* FALLTHROUGH */
  68                 case ('p'):
  69                         break;
  70                 case ('w'):
  71                         list = 1;
  72                         break;
  73                 default:
  74                         usage();
  75                         return((int)MANDOCLEVEL_BADARG);
  76                 }
  77
  78         argc -= optind;
  79         argv += optind;
  80
  81         mchars = mchars_alloc();
  82         mp = mparse_alloc(MPARSE_SO, MANDOCLEVEL_BADARG, NULL, mchars, NULL);
  83         assert(mp);
  84
  85         if (argc < 1)
  86                 pmandoc(mp, STDIN_FILENO, "<stdin>", list);
  87
  88         for (i = 0; i < argc; i++) {
  89                 mparse_reset(mp);
  90                 if (mparse_open(mp, &fd, argv[i]) != MANDOCLEVEL_OK) {
  91                         perror(argv[i]);
  92                         continue;
  93                 }
  94                 pmandoc(mp, fd, argv[i], list);
  95         }
  96
  97         mparse_free(mp);
  98         mchars_free(mchars);
  99         return((int)MANDOCLEVEL_OK);
 100 }
 101
 102 static void
 103 usage(void)
 104 {
 105
 106         fprintf(stderr, "usage: %s [-w] [files...]\n", progname);
 107 }
 108
 109 static void
 110 pmandoc(struct mparse *mp, int fd, const char *fn, int list)
 111 {
 112         struct mdoc     *mdoc;
 113         struct man      *man;
 114         int              line, col;
 115
 116         mparse_readfd(mp, fd, fn);
 117         mparse_result(mp, &mdoc, &man, NULL);
 118         line = 1;
 119         col = 0;
 120
 121         if (mdoc)
 122                 pmdoc(mdoc_node(mdoc), &line, &col, list);
 123         else if (man)
 124                 pman(man_node(man), &line, &col, list);
 125         else
 126                 return;
 127
 128         if ( ! list)
 129                 putchar('\n');
 130 }
 131
 132 /*
 133  * Strip the escapes out of a string, emitting the results.
 134  */
 135 static void
 136 pstring(const char *p, int col, int *colp, int list)
 137 {
 138         enum mandoc_esc  esc;
 139         const char      *start, *end;
 140         int              emit;
 141
 142         /*
 143          * Print as many column spaces til we achieve parity with the
 144          * input document.
 145          */
 146
 147 again:
 148         if (list && '\0' != *p) {
 149                 while (isspace((unsigned char)*p))
 150                         p++;
 151
 152                 while ('\'' == *p || '(' == *p || '"' == *p)
 153                         p++;
 154
 155                 emit = isalpha((unsigned char)p[0]) &&
 156                         isalpha((unsigned char)p[1]);
 157
 158                 for (start = p; '\0' != *p; p++)
 159                         if ('\\' == *p) {
 160                                 p++;
 161                                 esc = mandoc_escape(&p, NULL, NULL);
 162                                 if (ESCAPE_ERROR == esc)
 163                                         return;
 164                                 emit = 0;
 165                         } else if (isspace((unsigned char)*p))
 166                                 break;
 167
 168                 end = p - 1;
 169
 170                 while (end > start)
 171                         if ('.' == *end || ',' == *end ||
 172                                         '\'' == *end || '"' == *end ||
 173                                         ')' == *end || '!' == *end ||
 174                                         '?' == *end || ':' == *end ||
 175                                         ';' == *end)
 176                                 end--;
 177                         else
 178                                 break;
 179
 180                 if (emit && end - start >= 1) {
 181                         for ( ; start <= end; start++)
 182                                 if (ASCII_HYPH == *start)
 183                                         putchar('-');
 184                                 else
 185                                         putchar((unsigned char)*start);
 186                         putchar('\n');
 187                 }
 188
 189                 if (isspace((unsigned char)*p))
 190                         goto again;
 191
 192                 return;
 193         }
 194
 195         while (*colp < col) {
 196                 putchar(' ');
 197                 (*colp)++;
 198         }
 199
 200         /*
 201          * Print the input word, skipping any special characters.
 202          */
 203         while ('\0' != *p)
 204                 if ('\\' == *p) {
 205                         p++;
 206                         esc = mandoc_escape(&p, NULL, NULL);
 207                         if (ESCAPE_ERROR == esc)
 208                                 break;
 209                 } else {
 210                         putchar((unsigned char )*p++);
 211                         (*colp)++;
 212                 }
 213 }
 214
 215 static void
 216 pline(int line, int *linep, int *col, int list)
 217 {
 218
 219         if (list)
 220                 return;
 221
 222         /*
 223          * Print out as many lines as needed to reach parity with the
 224          * original input.
 225          */
 226
 227         while (*linep < line) {
 228                 putchar('\n');
 229                 (*linep)++;
 230         }
 231
 232         *col = 0;
 233 }
 234
 235 static void
 236 pmdoc(const struct mdoc_node *p, int *line, int *col, int list)
 237 {
 238
 239         for ( ; p; p = p->next) {
 240                 if (MDOC_LINE & p->flags)
 241                         pline(p->line, line, col, list);
 242                 if (MDOC_TEXT == p->type)
 243                         pstring(p->string, p->pos, col, list);
 244                 if (p->child)
 245                         pmdoc(p->child, line, col, list);
 246         }
 247 }
 248
 249 static void
 250 pman(const struct man_node *p, int *line, int *col, int list)
 251 {
 252
 253         for ( ; p; p = p->next) {
 254                 if (MAN_LINE & p->flags)
 255                         pline(p->line, line, col, list);
 256                 if (MAN_TEXT == p->type)
 257                         pstring(p->string, p->pos, col, list);
 258                 if (p->child)
 259                         pman(p->child, line, col, list);
 260         }
 261 }