]> git.cameronkatri.com Git - mandoc.git/blobdiff - mandoc.c
Render roff escape sequences contained in manual page descriptions
[mandoc.git] / mandoc.c
index b3928ae46c46a555995b4fd4d60ae54046753a66..5eed472736fd316f3a7271acd473887bf1e42fc6 100644 (file)
--- a/mandoc.c
+++ b/mandoc.c
@@ -1,7 +1,7 @@
-/*     $Id: mandoc.c,v 1.75 2013/12/31 23:23:10 schwarze Exp $ */
+/*     $Id: mandoc.c,v 1.79 2014/04/20 16:46:04 schwarze Exp $ */
 /*
  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
- * Copyright (c) 2011, 2012, 2013 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2011, 2012, 2013, 2014 Ingo Schwarze <schwarze@openbsd.org>
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
@@ -31,6 +31,7 @@
 #include <time.h>
 
 #include "mandoc.h"
+#include "mandoc_aux.h"
 #include "libmandoc.h"
 
 #define DATESIZE 32
@@ -45,7 +46,7 @@ mandoc_escape(const char **end, const char **start, int *sz)
        const char      *local_start;
        int              local_sz;
        char             term;
-       enum mandoc_esc  gly; 
+       enum mandoc_esc  gly;
 
        /*
         * When the caller doesn't provide return storage,
@@ -74,11 +75,11 @@ mandoc_escape(const char **end, const char **start, int *sz)
         * these, but each eventually returns a substring of the glyph
         * name.
         */
-       case ('('):
+       case '(':
                gly = ESCAPE_SPECIAL;
                *sz = 2;
                break;
-       case ('['):
+       case '[':
                gly = ESCAPE_SPECIAL;
                /*
                 * Unicode escapes are defined in groff as \[uXXXX] to
@@ -90,7 +91,7 @@ mandoc_escape(const char **end, const char **start, int *sz)
                        gly = ESCAPE_UNICODE;
                term = ']';
                break;
-       case ('C'):
+       case 'C':
                if ('\'' != **start)
                        return(ESCAPE_ERROR);
                *start = ++*end;
@@ -104,50 +105,50 @@ mandoc_escape(const char **end, const char **start, int *sz)
        /*
         * Escapes taking no arguments at all.
         */
-       case ('d'):
+       case 'd':
                /* FALLTHROUGH */
-       case ('u'):
+       case 'u':
                return(ESCAPE_IGNORE);
 
        /*
         * The \z escape is supposed to output the following
-        * character without advancing the cursor position.  
+        * character without advancing the cursor position.
         * Since we are mostly dealing with terminal mode,
         * let us just skip the next character.
         */
-       case ('z'):
+       case 'z':
                return(ESCAPE_SKIPCHAR);
 
        /*
         * Handle all triggers matching \X(xy, \Xx, and \X[xxxx], where
         * 'X' is the trigger.  These have opaque sub-strings.
         */
-       case ('F'):
+       case 'F':
                /* FALLTHROUGH */
-       case ('g'):
+       case 'g':
                /* FALLTHROUGH */
-       case ('k'):
+       case 'k':
                /* FALLTHROUGH */
-       case ('M'):
+       case 'M':
                /* FALLTHROUGH */
-       case ('m'):
+       case 'm':
                /* FALLTHROUGH */
-       case ('n'):
+       case 'n':
                /* FALLTHROUGH */
-       case ('V'):
+       case 'V':
                /* FALLTHROUGH */
-       case ('Y'):
+       case 'Y':
                gly = ESCAPE_IGNORE;
                /* FALLTHROUGH */
-       case ('f'):
+       case 'f':
                if (ESCAPE_ERROR == gly)
                        gly = ESCAPE_FONT;
                switch (**start) {
-               case ('('):
+               case '(':
                        *start = ++*end;
                        *sz = 2;
                        break;
-               case ('['):
+               case '[':
                        *start = ++*end;
                        term = ']';
                        break;
@@ -160,60 +161,57 @@ mandoc_escape(const char **end, const char **start, int *sz)
        /*
         * These escapes are of the form \X'Y', where 'X' is the trigger
         * and 'Y' is any string.  These have opaque sub-strings.
+        * The \B and \w escapes are handled in roff.c, roff_res().
         */
-       case ('A'):
+       case 'A':
                /* FALLTHROUGH */
-       case ('b'):
+       case 'b':
                /* FALLTHROUGH */
-       case ('B'):
+       case 'D':
                /* FALLTHROUGH */
-       case ('D'):
+       case 'o':
                /* FALLTHROUGH */
-       case ('o'):
+       case 'R':
                /* FALLTHROUGH */
-       case ('R'):
+       case 'X':
                /* FALLTHROUGH */
-       case ('w'):
-               /* FALLTHROUGH */
-       case ('X'):
-               /* FALLTHROUGH */
-       case ('Z'):
-               if ('\'' != **start)
+       case 'Z':
+               if ('\0' == **start)
                        return(ESCAPE_ERROR);
                gly = ESCAPE_IGNORE;
+               term = **start;
                *start = ++*end;
-               term = '\'';
                break;
 
        /*
         * These escapes are of the form \X'N', where 'X' is the trigger
         * and 'N' resolves to a numerical expression.
         */
-       case ('h'):
+       case 'h':
                /* FALLTHROUGH */
-       case ('H'):
+       case 'H':
                /* FALLTHROUGH */
-       case ('L'):
+       case 'L':
                /* FALLTHROUGH */
-       case ('l'):
+       case 'l':
                /* FALLTHROUGH */
-       case ('S'):
+       case 'S':
                /* FALLTHROUGH */
-       case ('v'):
+       case 'v':
                /* FALLTHROUGH */
-       case ('x'):
-               if ('\'' != **start)
+       case 'x':
+               if (strchr("\0 %&()*+-./0123456789:<=>", **start))
                        return(ESCAPE_ERROR);
                gly = ESCAPE_IGNORE;
+               term = **start;
                *start = ++*end;
-               term = '\'';
                break;
 
        /*
         * Special handling for the numbered character escape.
         * XXX Do any other escapes need similar handling?
         */
-       case ('N'):
+       case 'N':
                if ('\0' == **start)
                        return(ESCAPE_ERROR);
                (*end)++;
@@ -229,10 +227,10 @@ mandoc_escape(const char **end, const char **start, int *sz)
                        (*end)++;
                return(ESCAPE_NUMBERED);
 
-       /* 
+       /*
         * Sizes get a special category of their own.
         */
-       case ('s'):
+       case 's':
                gly = ESCAPE_IGNORE;
 
                /* See +/- counts as a sign. */
@@ -240,15 +238,15 @@ mandoc_escape(const char **end, const char **start, int *sz)
                        (*end)++;
 
                switch (**end) {
-               case ('('):
+               case '(':
                        *start = ++*end;
                        *sz = 2;
                        break;
-               case ('['):
+               case '[':
                        *start = ++*end;
                        term = ']';
                        break;
-               case ('\''):
+               case '\'':
                        *start = ++*end;
                        term = '\'';
                        break;
@@ -280,9 +278,9 @@ mandoc_escape(const char **end, const char **start, int *sz)
        if ('\0' != term) {
                while (**end != term) {
                        switch (**end) {
-                       case ('\0'):
+                       case '\0':
                                return(ESCAPE_ERROR);
-                       case ('\\'):
+                       case '\\':
                                (*end)++;
                                if (ESCAPE_ERROR ==
                                    mandoc_escape(end, NULL, NULL))
@@ -304,7 +302,7 @@ mandoc_escape(const char **end, const char **start, int *sz)
        /* Run post-processors. */
 
        switch (gly) {
-       case (ESCAPE_FONT):
+       case ESCAPE_FONT:
                if (2 == *sz) {
                        if ('C' == **start) {
                                /*
@@ -322,27 +320,27 @@ mandoc_escape(const char **end, const char **start, int *sz)
                        break;
 
                switch (**start) {
-               case ('3'):
+               case '3':
                        /* FALLTHROUGH */
-               case ('B'):
+               case 'B':
                        gly = ESCAPE_FONTBOLD;
                        break;
-               case ('2'):
+               case '2':
                        /* FALLTHROUGH */
-               case ('I'):
+               case 'I':
                        gly = ESCAPE_FONTITALIC;
                        break;
-               case ('P'):
+               case 'P':
                        gly = ESCAPE_FONTPREV;
                        break;
-               case ('1'):
+               case '1':
                        /* FALLTHROUGH */
-               case ('R'):
+               case 'R':
                        gly = ESCAPE_FONTROMAN;
                        break;
                }
                break;
-       case (ESCAPE_SPECIAL):
+       case ESCAPE_SPECIAL:
                if (1 == *sz && 'c' == **start)
                        gly = ESCAPE_NOSPACE;
                break;
@@ -353,74 +351,6 @@ mandoc_escape(const char **end, const char **start, int *sz)
        return(gly);
 }
 
-void *
-mandoc_calloc(size_t num, size_t size)
-{
-       void            *ptr;
-
-       ptr = calloc(num, size);
-       if (NULL == ptr) {
-               perror(NULL);
-               exit((int)MANDOCLEVEL_SYSERR);
-       }
-
-       return(ptr);
-}
-
-
-void *
-mandoc_malloc(size_t size)
-{
-       void            *ptr;
-
-       ptr = malloc(size);
-       if (NULL == ptr) {
-               perror(NULL);
-               exit((int)MANDOCLEVEL_SYSERR);
-       }
-
-       return(ptr);
-}
-
-
-void *
-mandoc_realloc(void *ptr, size_t size)
-{
-
-       ptr = realloc(ptr, size);
-       if (NULL == ptr) {
-               perror(NULL);
-               exit((int)MANDOCLEVEL_SYSERR);
-       }
-
-       return(ptr);
-}
-
-char *
-mandoc_strndup(const char *ptr, size_t sz)
-{
-       char            *p;
-
-       p = mandoc_malloc(sz + 1);
-       memcpy(p, ptr, sz);
-       p[(int)sz] = '\0';
-       return(p);
-}
-
-char *
-mandoc_strdup(const char *ptr)
-{
-       char            *p;
-
-       p = strdup(ptr);
-       if (NULL == p) {
-               perror(NULL);
-               exit((int)MANDOCLEVEL_SYSERR);
-       }
-
-       return(p);
-}
-
 /*
  * Parse a quoted or unquoted roff-style request or macro argument.
  * Return a pointer to the parsed argument, which is either the original
@@ -442,7 +372,7 @@ mandoc_getarg(struct mparse *parse, char **cpp, int ln, int *pos)
        if ('"' == *start) {
                quoted = 1;
                start++;
-       } 
+       }
 
        pairs = 0;
        white = 0;
@@ -461,14 +391,14 @@ mandoc_getarg(struct mparse *parse, char **cpp, int ln, int *pos)
                         * backslashes and backslash-t to literal tabs.
                         */
                        switch (cp[1]) {
-                       case ('t'):
+                       case 't':
                                cp[0] = '\t';
                                /* FALLTHROUGH */
-                       case ('\\'):
+                       case '\\':
                                pairs++;
                                cp++;
                                break;
-                       case (' '):
+                       case ' ':
                                /* Skip escaped blanks. */
                                if (0 == quoted)
                                        cp++;
@@ -611,21 +541,21 @@ mandoc_eos(const char *p, size_t sz)
        enclosed = found = 0;
        for (q = p + (int)sz - 1; q >= p; q--) {
                switch (*q) {
-               case ('\"'):
+               case '\"':
                        /* FALLTHROUGH */
-               case ('\''):
+               case '\'':
                        /* FALLTHROUGH */
-               case (']'):
+               case ']':
                        /* FALLTHROUGH */
-               case (')'):
+               case ')':
                        if (0 == found)
                                enclosed = 1;
                        break;
-               case ('.'):
+               case '.':
                        /* FALLTHROUGH */
-               case ('!'):
+               case '!':
                        /* FALLTHROUGH */
-               case ('?'):
+               case '?':
                        found = 1;
                        break;
                default: