Added canonical mdoc.7.

[mandoc.git] / strings.c

diff --git a/strings.c b/strings.c
index e7538cf51f74219269d80d3b987f5d8c4f93706d..b67c44b6d5acadb1a9b809749a80ce1754b4f572 100644 (file)
--- a/strings.c
+++ b/strings.c
@@ -1,4 +1,4 @@
-/* $Id: strings.c,v 1.15 2009/02/23 15:34:53 kristaps Exp $ */
+/* $Id: strings.c,v 1.28 2009/03/13 07:46:10 kristaps Exp $ */

 /*
  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
  *
 /*
  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
  *


@@ -16,25 +16,122 @@
  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  * PERFORMANCE OF THIS SOFTWARE.
  */
  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  * PERFORMANCE OF THIS SOFTWARE.
  */

+#include <sys/types.h>
+

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

-#ifndef __OpenBSD__
-#include <time.h>
-#endif
+
+#include "private.h"

 
 /*
 
 /*

- * Convert scalars to and from string format.
+ * Various string-literal operations:  converting scalars to and from
+ * strings, etc.

  */
 
  */
 

-#include "private.h"
+struct mdoc_secname {
+       const char      *name;
+       int              flag;
+#define        MSECNAME_META   (1 << 0)
+};
+
+/* Section names corresponding to mdoc_sec. */
+
+static const struct mdoc_secname secnames[] = {
+       { "PROLOGUE", MSECNAME_META },
+       { "BODY", MSECNAME_META },
+       { "NAME", 0 },
+       { "LIBRARY", 0 },
+       { "SYNOPSIS", 0 },
+       { "DESCRIPTION", 0 },
+       { "IMPLEMENTATION NOTES", 0 },
+       { "RETURN VALUES", 0 },
+       { "ENVIRONMENT", 0 },
+       { "FILES", 0 },
+       { "EXAMPLES", 0 },
+       { "DIAGNOSTICS", 0 },
+       { "COMPATIBILITY", 0 },
+       { "ERRORS", 0 },
+       { "SEE ALSO", 0 },
+       { "STANDARDS", 0 },
+       { "HISTORY", 0 },
+       { "AUTHORS", 0 },
+       { "CAVEATS", 0 },
+       { "BUGS", 0 },
+       { NULL, 0 }
+};

 
 #ifdef __linux__
 extern char            *strptime(const char *, const char *, struct tm *);
 #endif
 
 
 #ifdef __linux__
 extern char            *strptime(const char *, const char *, struct tm *);
 #endif
 

+
+size_t
+mdoc_isescape(const char *p)
+{
+       size_t           c;
+       
+       if ('\\' != *p++)
+               return(0);
+
+       switch (*p) {
+       case ('\\'):
+               /* FALLTHROUGH */
+       case ('\''):
+               /* FALLTHROUGH */
+       case ('`'):
+               /* FALLTHROUGH */
+       case ('q'):
+               /* FALLTHROUGH */
+       case ('-'):
+               /* FALLTHROUGH */
+       case (' '):
+               /* FALLTHROUGH */
+       case ('&'):
+               /* FALLTHROUGH */
+       case ('.'):
+               /* FALLTHROUGH */
+       case ('e'):
+               return(2);
+       case ('*'):
+               if (0 == *++p || ! isgraph((u_char)*p))
+                       return(0);
+               switch (*p) {
+               case ('('):
+                       if (0 == *++p || ! isgraph((u_char)*p))
+                               return(0);
+                       return(4);
+               case ('['):
+                       for (c = 3, p++; *p && ']' != *p; p++, c++)
+                               if ( ! isgraph((u_char)*p))
+                                       break;
+                       return(*p == ']' ? c : 0);
+               default:
+                       break;
+               }
+               return(3);
+       case ('('):
+               if (0 == *++p || ! isgraph((u_char)*p))
+                       return(0);
+               if (0 == *++p || ! isgraph((u_char)*p))
+                       return(0);
+               return(4);
+       case ('['):
+               break;
+       default:
+               return(0);
+       }
+
+       for (c = 3, p++; *p && ']' != *p; p++, c++)
+               if ( ! isgraph((u_char)*p))
+                       break;
+
+       return(*p == ']' ? c : 0);
+}
+
+

 int
 mdoc_iscdelim(char p)
 {
 int
 mdoc_iscdelim(char p)
 {


@@ -87,38 +184,13 @@ mdoc_isdelim(const char *p)
 enum mdoc_sec 
 mdoc_atosec(const char *p)
 {
 enum mdoc_sec 
 mdoc_atosec(const char *p)
 {

+       const struct mdoc_secname *n;
+       int                        i;

 
 

-       assert(p);
-       if (0 == strcmp(p, "NAME"))
-               return(SEC_NAME);
-       else if (0 == strcmp(p, "RETURN VALUES"))
-               return(SEC_RETURN_VALUES);
-       else if (0 == strcmp(p, "SEE ALSO"))
-               return(SEC_SEE_ALSO);
-       else if (0 == strcmp(p, "SYNOPSIS"))
-               return(SEC_SYNOPSIS);
-       else if (0 == strcmp(p, "DESCRIPTION"))
-               return(SEC_DESCRIPTION);
-       else if (0 == strcmp(p, "ENVIRONMENT"))
-               return(SEC_ENVIRONMENT);
-       else if (0 == strcmp(p, "FILES"))
-               return(SEC_FILES);
-       else if (0 == strcmp(p, "EXAMPLES"))
-               return(SEC_EXAMPLES);
-       else if (0 == strcmp(p, "DIAGNOSTICS"))
-               return(SEC_DIAGNOSTICS);
-       else if (0 == strcmp(p, "ERRORS"))
-               return(SEC_ERRORS);
-       else if (0 == strcmp(p, "STANDARDS"))
-               return(SEC_STANDARDS);
-       else if (0 == strcmp(p, "HISTORY"))
-               return(SEC_HISTORY);
-       else if (0 == strcmp(p, "AUTHORS"))
-               return(SEC_AUTHORS);
-       else if (0 == strcmp(p, "CAVEATS"))
-               return(SEC_CAVEATS);
-       else if (0 == strcmp(p, "BUGS"))
-               return(SEC_BUGS);
+       for (i = 0, n = secnames; n->name; n++, i++)
+               if ( ! (n->flag & MSECNAME_META))
+                       if (xstrcmp(p, n->name))
+                               return((enum mdoc_sec)i);

 
        return(SEC_CUSTOM);
 }
 
        return(SEC_CUSTOM);
 }


@@ -132,9 +204,9 @@ mdoc_atotime(const char *p)
 
        (void)memset(&tm, 0, sizeof(struct tm));
 
 
        (void)memset(&tm, 0, sizeof(struct tm));
 

-       if (xstrcmp(p, "$Mdocdate: February 23 2009 $"))
+       if (xstrcmp(p, "$Mdocdate: March 13 2009 $"))

                return(time(NULL));
                return(time(NULL));

-       if ((pp = strptime(p, "$Mdocdate: February 23 2009 $", &tm)) && 0 == *pp)
+       if ((pp = strptime(p, "$Mdocdate: March 13 2009 $", &tm)) && 0 == *pp)

                return(mktime(&tm));
        /* XXX - this matches "June 1999", which is wrong. */
        if ((pp = strptime(p, "%b %d %Y", &tm)) && 0 == *pp)
                return(mktime(&tm));
        /* XXX - this matches "June 1999", which is wrong. */
        if ((pp = strptime(p, "%b %d %Y", &tm)) && 0 == *pp)


@@ -146,350 +218,95 @@ mdoc_atotime(const char *p)
 }
 
 
 }
 
 

-enum mdoc_msec
-mdoc_atomsec(const char *p)
-{
-
-       if (0 == strcmp(p, "1"))
-               return(MSEC_1);
-       else if (0 == strcmp(p, "2"))
-               return(MSEC_2);
-       else if (0 == strcmp(p, "3"))
-               return(MSEC_3);
-       else if (0 == strcmp(p, "3f"))
-               return(MSEC_3f);
-       else if (0 == strcmp(p, "3p"))
-               return(MSEC_3p);
-       else if (0 == strcmp(p, "4"))
-               return(MSEC_4);
-       else if (0 == strcmp(p, "5"))
-               return(MSEC_5);
-       else if (0 == strcmp(p, "6"))
-               return(MSEC_6);
-       else if (0 == strcmp(p, "7"))
-               return(MSEC_7);
-       else if (0 == strcmp(p, "8"))
-               return(MSEC_8);
-       else if (0 == strcmp(p, "9"))
-               return(MSEC_9);
-       else if (0 == strcmp(p, "X11"))
-               return(MSEC_X11);
-       else if (0 == strcmp(p, "X11R6"))
-               return(MSEC_X11R6);
-       else if (0 == strcmp(p, "local"))
-               return(MSEC_local);
-       else if (0 == strcmp(p, "n"))
-               return(MSEC_n);
-       else if (0 == strcmp(p, "unass"))
-               return(MSEC_unass);
-       else if (0 == strcmp(p, "draft"))
-               return(MSEC_draft);
-       else if (0 == strcmp(p, "paper"))
-               return(MSEC_paper);
-
-       return(MSEC_DEFAULT);
-}
-
-
-enum mdoc_vol
-mdoc_atovol(const char *p)
-{
-
-       if (0 == strcmp(p, "AMD"))
-               return(VOL_AMD);
-       else if (0 == strcmp(p, "IND"))
-               return(VOL_IND);
-       else if (0 == strcmp(p, "KM"))
-               return(VOL_KM);
-       else if (0 == strcmp(p, "LOCAL"))
-               return(VOL_LOCAL);
-       else if (0 == strcmp(p, "PRM"))
-               return(VOL_PRM);
-       else if (0 == strcmp(p, "PS1"))
-               return(VOL_PS1);
-       else if (0 == strcmp(p, "SMM"))
-               return(VOL_SMM);
-       else if (0 == strcmp(p, "URM"))
-               return(VOL_URM);
-       else if (0 == strcmp(p, "USD"))
-               return(VOL_USD);
-
-       return(VOL_DEFAULT);
-}
-
-
-enum mdoc_arch
-mdoc_atoarch(const char *p)
-{
-
-       if (0 == strcmp(p, "alpha"))
-               return(ARCH_alpha);
-       else if (0 == strcmp(p, "amd64"))
-               return(ARCH_amd64);
-       else if (0 == strcmp(p, "amiga"))
-               return(ARCH_amiga);
-       else if (0 == strcmp(p, "arc"))
-               return(ARCH_arc);
-       else if (0 == strcmp(p, "arm"))
-               return(ARCH_arm);
-       else if (0 == strcmp(p, "armish"))
-               return(ARCH_armish);
-       else if (0 == strcmp(p, "aviion"))
-               return(ARCH_aviion);
-       else if (0 == strcmp(p, "hp300"))
-               return(ARCH_hp300);
-       else if (0 == strcmp(p, "hppa"))
-               return(ARCH_hppa);
-       else if (0 == strcmp(p, "hppa64"))
-               return(ARCH_hppa64);
-       else if (0 == strcmp(p, "i386"))
-               return(ARCH_i386);
-       else if (0 == strcmp(p, "landisk"))
-               return(ARCH_landisk);
-       else if (0 == strcmp(p, "luna88k"))
-               return(ARCH_luna88k);
-       else if (0 == strcmp(p, "mac68k"))
-               return(ARCH_mac68k);
-       else if (0 == strcmp(p, "macppc"))
-               return(ARCH_macppc);
-       else if (0 == strcmp(p, "mvme68k"))
-               return(ARCH_mvme68k);
-       else if (0 == strcmp(p, "mvme88k"))
-               return(ARCH_mvme88k);
-       else if (0 == strcmp(p, "mvmeppc"))
-               return(ARCH_mvmeppc);
-       else if (0 == strcmp(p, "pmax"))
-               return(ARCH_pmax);
-       else if (0 == strcmp(p, "sgi"))
-               return(ARCH_sgi);
-       else if (0 == strcmp(p, "socppc"))
-               return(ARCH_socppc);
-       else if (0 == strcmp(p, "sparc"))
-               return(ARCH_sparc);
-       else if (0 == strcmp(p, "sparc64"))
-               return(ARCH_sparc64);
-       else if (0 == strcmp(p, "sun3"))
-               return(ARCH_sun3);
-       else if (0 == strcmp(p, "vax"))
-               return(ARCH_vax);
-       else if (0 == strcmp(p, "zaurus"))
-               return(ARCH_zaurus);
-
-       return(ARCH_DEFAULT);
-}
-
-
-enum mdoc_att
-mdoc_atoatt(const char *p)
+size_t
+mdoc_macro2len(int macro)

 {
 
 {
 

-       assert(p);
-       if (0 == strcmp(p, "v1"))
-               return(ATT_v1);
-       else if (0 == strcmp(p, "v2"))
-               return(ATT_v2);
-       else if (0 == strcmp(p, "v3"))
-               return(ATT_v3);
-       else if (0 == strcmp(p, "v4"))
-               return(ATT_v4);
-       else if (0 == strcmp(p, "v5"))
-               return(ATT_v5);
-       else if (0 == strcmp(p, "v6"))
-               return(ATT_v6);
-       else if (0 == strcmp(p, "v7"))
-               return(ATT_v7);
-       else if (0 == strcmp(p, "32v"))
-               return(ATT_32v);
-       else if (0 == strcmp(p, "V.1"))
-               return(ATT_V1);
-       else if (0 == strcmp(p, "V.2"))
-               return(ATT_V2);
-       else if (0 == strcmp(p, "V.3"))
-               return(ATT_V3);
-       else if (0 == strcmp(p, "V.4"))
-               return(ATT_V4);
-       
-       return(ATT_DEFAULT);
-}
-
-
-char *
-mdoc_type2a(enum mdoc_type type)
-{
-       switch (type) {
-       case (MDOC_ROOT):
-               return("root");
-       case (MDOC_BLOCK):
-               return("block");
-       case (MDOC_HEAD):
-               return("block-head");
-       case (MDOC_BODY):
-               return("block-body");
-       case (MDOC_TAIL):
-               return("block-tail");
-       case (MDOC_ELEM):
-               return("elem");
-       case (MDOC_TEXT):
-               return("text");
+       switch (macro) {
+       case(MDOC_Ad):
+               return(12);
+       case(MDOC_Ao):
+               return(12);
+       case(MDOC_An):
+               return(12);
+       case(MDOC_Aq):
+               return(12);
+       case(MDOC_Ar):
+               return(12);
+       case(MDOC_Bo):
+               return(12);
+       case(MDOC_Bq):
+               return(12);
+       case(MDOC_Cd):
+               return(12);
+       case(MDOC_Cm):
+               return(10);
+       case(MDOC_Do):
+               return(10);
+       case(MDOC_Dq):
+               return(12);
+       case(MDOC_Dv):
+               return(12);
+       case(MDOC_Eo):
+               return(12);
+       case(MDOC_Em):
+               return(10);
+       case(MDOC_Er):
+               return(12);
+       case(MDOC_Ev):
+               return(15);
+       case(MDOC_Fa):
+               return(12);
+       case(MDOC_Fl):
+               return(10);
+       case(MDOC_Fo):
+               return(16);
+       case(MDOC_Fn):
+               return(16);
+       case(MDOC_Ic):
+               return(10);
+       case(MDOC_Li):
+               return(16);
+       case(MDOC_Ms):
+               return(6);
+       case(MDOC_Nm):
+               return(10);
+       case(MDOC_No):
+               return(12);
+       case(MDOC_Oo):
+               return(10);
+       case(MDOC_Op):
+               return(14);
+       case(MDOC_Pa):
+               return(32);
+       case(MDOC_Pf):
+               return(12);
+       case(MDOC_Po):
+               return(12);
+       case(MDOC_Pq):
+               return(12);
+       case(MDOC_Ql):
+               return(16);
+       case(MDOC_Qo):
+               return(12);
+       case(MDOC_So):
+               return(12);
+       case(MDOC_Sq):
+               return(12);
+       case(MDOC_Sy):
+               return(6);
+       case(MDOC_Sx):
+               return(16);
+       case(MDOC_Tn):
+               return(10);
+       case(MDOC_Va):
+               return(12);
+       case(MDOC_Vt):
+               return(12);
+       case(MDOC_Xr):
+               return(10);

        default:
                break;
        default:
                break;

-       }
-
-       abort();
-       /* NOTREACHED */
-}
-
-
-const char *
-mdoc_arch2a(enum mdoc_arch arch)
-{
-
-       switch (arch) {
-       case (ARCH_alpha):
-               return("Alpha");
-       case (ARCH_amd64):
-               return("AMD64");
-       case (ARCH_amiga):
-               return("Amiga");
-       case (ARCH_arc):
-               return("ARC");
-       case (ARCH_arm):
-               return("ARM");
-       case (ARCH_armish):
-               return("ARMISH");
-       case (ARCH_aviion):
-               return("AViion");
-       case (ARCH_hp300):
-               return("HP300");
-       case (ARCH_hppa):
-               return("HPPA");
-       case (ARCH_hppa64):
-               return("HPPA64");
-       case (ARCH_i386):
-               return("i386");
-       case (ARCH_landisk):
-               return("LANDISK");
-       case (ARCH_luna88k):
-               return("Luna88k");
-       case (ARCH_mac68k):
-               return("Mac68k");
-       case (ARCH_macppc):
-               return("MacPPC");
-       case (ARCH_mvme68k):
-               return("MVME68k");
-       case (ARCH_mvme88k):
-               return("MVME88k");
-       case (ARCH_mvmeppc):
-               return("MVMEPPC");
-       case (ARCH_pmax):
-               return("PMAX");
-       case (ARCH_sgi):
-               return("SGI");
-       case (ARCH_socppc):
-               return("SOCPPC");
-       case (ARCH_sparc):
-               return("SPARC");
-       case (ARCH_sparc64):
-               return("SPARC64");
-       case (ARCH_sun3):
-               return("Sun3");
-       case (ARCH_vax):
-               return("VAX");
-       case (ARCH_zaurus):
-               return("Zaurus");
-       case (ARCH_DEFAULT):
-               return(NULL);
-       default:
-               break;
-       }
-
-       abort();
-       /* NOTREACHED */
-}
-
-
-const char *
-mdoc_vol2a(enum mdoc_vol vol)
-{
-
-       switch (vol) {
-       case (VOL_AMD):
-               return("OpenBSD Ancestral Manual Documents");
-       case (VOL_IND):
-               return("OpenBSD Manual Master Index");
-       case (VOL_KM):
-               return("OpenBSD Kernel Manual");
-       case (VOL_LOCAL):
-               return("OpenBSD Local Manual");
-       case (VOL_PRM):
-               return("OpenBSD Programmer's Manual");
-       case (VOL_PS1):
-               return("OpenBSD Programmer's Supplementary Documents");
-       case (VOL_SMM):
-               return("OpenBSD System Manager's Manual");
-       case (VOL_URM):
-               return("OpenBSD Reference Manual");
-       case (VOL_USD):
-               return("OpenBSD User's Supplementary Documents");
-       case (VOL_DEFAULT):
-               return(NULL);
-       default:
-               break;
-       }
-
-       abort();
-       /* NOTREACHED */
-}
-
-
-const char *
-mdoc_msec2a(enum mdoc_msec msec)
-{
-
-       switch (msec) {
-       case(MSEC_1):
-               return("1");
-       case(MSEC_2):
-               return("2");
-       case(MSEC_3):
-               return("3");
-       case(MSEC_3f):
-               return("3f");
-       case(MSEC_3p):
-               return("3p");
-       case(MSEC_4):
-               return("4");
-       case(MSEC_5):
-               return("5");
-       case(MSEC_6):
-               return("6");
-       case(MSEC_7):
-               return("7");
-       case(MSEC_8):
-               return("8");
-       case(MSEC_9):
-               return("9");
-       case(MSEC_X11):
-               return("X11");
-       case(MSEC_X11R6):
-               return("X11R6");
-       case(MSEC_local):
-               return("local");
-       case(MSEC_n):
-               return("n");
-       case(MSEC_unass):
-               /* FALLTHROUGH */
-       case(MSEC_draft):
-               return("draft");
-       case(MSEC_paper):
-               return("paper");
-       case(MSEC_DEFAULT):
-               return(NULL);
-       default:
-               break;
-       }
-
-       abort();
-       /* NOTREACHED */
+       };
+       return(0);

 }
 }

-