Escape slashes.

[wxWidgets.git] / src / regex / regex.h

diff --git a/src/regex/regex.h b/src/regex/regex.h
index 6b7539ba8b3612eff6a42db3af944808c827a8b3..0120ac30181ac8507ac5b585ba82b508a18df987 100644 (file)
--- a/src/regex/regex.h
+++ b/src/regex/regex.h
@@ -1,16 +1,15 @@
 #ifndef _REGEX_H_
 #define        _REGEX_H_       /* never again */
 #ifndef _REGEX_H_
 #define        _REGEX_H_       /* never again */

-

 /*
  * regular expressions
  *
 /*
  * regular expressions
  *

- * Copyright (c) 1998, 1999 Henry Spencer.     All rights reserved.
- *
+ * Copyright (c) 1998, 1999 Henry Spencer.  All rights reserved.
+ * 

  * Development of this software was funded, in part, by Cray Research Inc.,
  * UUNET Communications Services Inc., Sun Microsystems Inc., and Scriptics
  * Corporation, none of whom are responsible for the results.  The author
  * Development of this software was funded, in part, by Cray Research Inc.,
  * UUNET Communications Services Inc., Sun Microsystems Inc., and Scriptics
  * Corporation, none of whom are responsible for the results.  The author

- * thanks all of them.
- *
+ * thanks all of them. 
+ * 

  * Redistribution and use in source and binary forms -- with or without
  * modification -- are permitted for any purpose, provided that
  * redistributions in source form retain this entire copyright notice and
  * Redistribution and use in source and binary forms -- with or without
  * modification -- are permitted for any purpose, provided that
  * redistributions in source form retain this entire copyright notice and


@@ -18,7 +17,7 @@
  *
  * I'd appreciate being given credit for this package in the documentation
  * of software which uses it, but that is not a requirement.
  *
  * I'd appreciate being given credit for this package in the documentation
  * of software which uses it, but that is not a requirement.

- *
+ * 

  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL


@@ -30,36 +29,94 @@
  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  *
  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  *

- * $Id$
+ *
+ *
+ * Prototypes etc. marked with "^" within comments get gathered up (and
+ * possibly edited) by the regfwd program and inserted near the bottom of
+ * this file.
+ *
+ * We offer the option of declaring one wide-character version of the
+ * RE functions as well as the char versions.  To do that, define
+ * __REG_WIDE_T to the type of wide characters (unfortunately, there
+ * is no consensus that wchar_t is suitable) and __REG_WIDE_COMPILE and
+ * __REG_WIDE_EXEC to the names to be used for the compile and execute
+ * functions (suggestion:  re_Xcomp and re_Xexec, where X is a letter
+ * suggestive of the wide type, e.g. re_ucomp and re_uexec for Unicode).
+ * For cranky old compilers, it may be necessary to do something like:
+ * #define     __REG_WIDE_COMPILE(a,b,c,d)     re_Xcomp(a,b,c,d)
+ * #define     __REG_WIDE_EXEC(a,b,c,d,e,f,g)  re_Xexec(a,b,c,d,e,f,g)
+ * rather than just #defining the names as parameterless macros.
+ *
+ * For some specialized purposes, it may be desirable to suppress the
+ * declarations of the "front end" functions, regcomp() and regexec(),
+ * or of the char versions of the compile and execute functions.  To
+ * suppress the front-end functions, define __REG_NOFRONT.  To suppress
+ * the char versions, define __REG_NOCHAR.
+ *
+ * The right place to do those defines (and some others you may want, see
+ * below) would be <sys/types.h>.  If you don't have control of that file,
+ * the right place to add your own defines to this file is marked below.
+ * This is normally done automatically, by the makefile and regmkhdr, based
+ * on the contents of regcustom.h.

  */
 
  */
 

+
+

 /*
 /*

- * Add your own defines, if needed, here.
+ * voodoo for C++

  */
 #ifdef __cplusplus
 extern "C" {
 #endif
 
  */
 #ifdef __cplusplus
 extern "C" {
 #endif
 

-/*****************************
-    WXWINDOWS CUSTOM 
-*****************************/
-#ifndef _REGEX_CUSTOM_H_
-#   define wxUSE_BUILTIN_REGEX
-#   define wx_wchar wxChar
-/*  FreeBSD, Watcom and DMars require this, CW doesn't have nor need it. */
-/*  Others also don't seem to need it. If you have an error related to */
-/*  (not) including <sys/types.h> please report details to */
-/*  wx-dev@lists.wxwindows.org */
-#   if defined(__UNIX__) || defined(__WATCOMC__) || defined(__DIGITALMARS__)
-#       include <sys/types.h>
-#   endif
-#endif /* ndef _REGEX_CUSTOM_H_ */
-/*****************************
-    END WXWINDOWS CUSTOM
-*****************************/
-
-#include <stdio.h>
-#include <stdlib.h>
+
+
+/*
+ * Add your own defines, if needed, here.
+ */
+
+
+
+/*
+ * Location where a chunk of regcustom.h is automatically spliced into
+ * this file (working from its prototype, regproto.h).
+ */
+/* --- begin --- */
+/* ensure certain things don't sneak in from system headers */
+#ifdef __REG_WIDE_T
+#undef __REG_WIDE_T
+#endif
+#ifdef __REG_WIDE_COMPILE
+#undef __REG_WIDE_COMPILE
+#endif
+#ifdef __REG_WIDE_EXEC
+#undef __REG_WIDE_EXEC
+#endif
+#ifdef __REG_REGOFF_T
+#undef __REG_REGOFF_T
+#endif
+#ifdef __REG_VOID_T
+#undef __REG_VOID_T
+#endif
+#ifdef __REG_CONST
+#undef __REG_CONST
+#endif
+#ifdef __REG_NOFRONT
+#undef __REG_NOFRONT
+#endif
+#ifdef __REG_NOCHAR
+#undef __REG_NOCHAR
+#endif
+#if wxUSE_UNICODE
+#   define  __REG_WIDE_T        wxChar
+#   define  __REG_WIDE_COMPILE  wx_re_comp
+#   define  __REG_WIDE_EXEC     wx_re_exec
+#   define  __REG_NOCHAR        /* don't want the char versions */
+#endif
+#define __REG_NOFRONT           /* don't want regcomp() and regexec() */
+#define _ANSI_ARGS_(x)          x
+/* --- end --- */
+

 
 /*
  * interface types etc.
 
 /*
  * interface types etc.


@@ -67,136 +124,214 @@ extern "C" {
 
 /*
  * regoff_t has to be large enough to hold either off_t or ssize_t,
 
 /*
  * regoff_t has to be large enough to hold either off_t or ssize_t,

- * and must be signed; it's only a guess that long is suitable.
+ * and must be signed; it's only a guess that long is suitable, so we
+ * offer <sys/types.h> an override.

  */
  */

+#ifdef __REG_REGOFF_T
+typedef __REG_REGOFF_T regoff_t;
+#else

 typedef long regoff_t;
 typedef long regoff_t;

+#endif
+
+/*
+ * For benefit of old compilers, we offer <sys/types.h> the option of
+ * overriding the `void' type used to declare nonexistent return types.
+ */
+#ifdef __REG_VOID_T
+typedef __REG_VOID_T re_void;
+#else
+typedef void re_void;
+#endif
+
+/*
+ * Also for benefit of old compilers, <sys/types.h> can supply a macro
+ * which expands to a substitute for `const'.
+ */
+#ifndef __REG_CONST
+#define        __REG_CONST     const
+#endif
+
+

 
 /*
  * other interface types
  */
 
 /* the biggie, a compiled RE (or rather, a front end to same) */
 
 /*
  * other interface types
  */
 
 /* the biggie, a compiled RE (or rather, a front end to same) */

-typedef struct
-{
-       int                     re_magic;               /* magic number */
-       size_t          re_nsub;                /* number of subexpressions */
-       long            re_info;                /* information about RE */
-#define  REG_UBACKREF           000001
-#define  REG_ULOOKAHEAD                 000002
-#define  REG_UBOUNDS    000004
-#define  REG_UBRACES    000010
-#define  REG_UBSALNUM           000020
-#define  REG_UPBOTCH    000040
-#define  REG_UBBS               000100
-#define  REG_UNONPOSIX          000200
-#define  REG_UUNSPEC    000400
-#define  REG_UUNPORT    001000
-#define  REG_ULOCALE    002000
-#define  REG_UEMPTYMATCH        004000
-#define  REG_UIMPOSSIBLE        010000
-#define  REG_USHORTEST          020000
-       int                     re_csize;               /* sizeof(character) */
-       char       *re_endp;            /* backward compatibility kludge */
+typedef struct {
+       int re_magic;           /* magic number */
+       size_t re_nsub;         /* number of subexpressions */
+       long re_info;           /* information about RE */
+#              define  REG_UBACKREF            000001
+#              define  REG_ULOOKAHEAD          000002
+#              define  REG_UBOUNDS             000004
+#              define  REG_UBRACES             000010
+#              define  REG_UBSALNUM            000020
+#              define  REG_UPBOTCH             000040
+#              define  REG_UBBS                000100
+#              define  REG_UNONPOSIX           000200
+#              define  REG_UUNSPEC             000400
+#              define  REG_UUNPORT             001000
+#              define  REG_ULOCALE             002000
+#              define  REG_UEMPTYMATCH         004000
+#              define  REG_UIMPOSSIBLE         010000
+#              define  REG_USHORTEST           020000
+       int re_csize;           /* sizeof(character) */
+       char *re_endp;          /* backward compatibility kludge */

        /* the rest is opaque pointers to hidden innards */
        /* the rest is opaque pointers to hidden innards */

-       char       *re_guts;            /* `char *' is more portable than `void *' */
-       char       *re_fns;
+       char *re_guts;          /* `char *' is more portable than `void *' */
+       char *re_fns;

 } regex_t;
 
 /* result reporting (may acquire more fields later) */
 } regex_t;
 
 /* result reporting (may acquire more fields later) */

-typedef struct
-{
-       regoff_t        rm_so;                  /* start of substring */
-       regoff_t        rm_eo;                  /* end of substring */
+typedef struct {
+       regoff_t rm_so;         /* start of substring */
+       regoff_t rm_eo;         /* end of substring */

 } regmatch_t;
 
 /* supplementary control and reporting */
 } regmatch_t;
 
 /* supplementary control and reporting */

-typedef struct
-{
-       regmatch_t      rm_extend;              /* see REG_EXPECT */
+typedef struct {
+       regmatch_t rm_extend;   /* see REG_EXPECT */

 } rm_detail_t;
 
 
 
 /*
 } rm_detail_t;
 
 
 
 /*

- * regex compilation flags
+ * compilation
+ ^ #ifndef __REG_NOCHAR
+ ^ int re_comp(regex_t *, __REG_CONST char *, size_t, int);
+ ^ #endif
+ ^ #ifndef __REG_NOFRONT
+ ^ int regcomp(regex_t *, __REG_CONST char *, int);
+ ^ #endif
+ ^ #ifdef __REG_WIDE_T
+ ^ int __REG_WIDE_COMPILE(regex_t *, __REG_CONST __REG_WIDE_T *, size_t, int);
+ ^ #endif
+ */
+#define        REG_BASIC       000000  /* BREs (convenience) */
+#define        REG_EXTENDED    000001  /* EREs */
+#define        REG_ADVF        000002  /* advanced features in EREs */
+#define        REG_ADVANCED    000003  /* AREs (which are also EREs) */
+#define        REG_QUOTE       000004  /* no special characters, none */
+#define        REG_NOSPEC      REG_QUOTE       /* historical synonym */
+#define        REG_ICASE       000010  /* ignore case */
+#define        REG_NOSUB       000020  /* don't care about subexpressions */
+#define        REG_EXPANDED    000040  /* expanded format, white space & comments */
+#define        REG_NLSTOP      000100  /* \n doesn't match . or [^ ] */
+#define        REG_NLANCH      000200  /* ^ matches after \n, $ before */
+#define        REG_NEWLINE     000300  /* newlines are line terminators */
+#define        REG_PEND        000400  /* ugh -- backward-compatibility hack */
+#define        REG_EXPECT      001000  /* report details on partial/limited matches */
+#define        REG_BOSONLY     002000  /* temporary kludge for BOS-only matches */
+#define        REG_DUMP        004000  /* none of your business :-) */
+#define        REG_FAKE        010000  /* none of your business :-) */
+#define        REG_PROGRESS    020000  /* none of your business :-) */
+
+
+
+/*
+ * execution
+ ^ #ifndef __REG_NOCHAR
+ ^ int re_exec(regex_t *, __REG_CONST char *, size_t,
+ ^                             rm_detail_t *, size_t, regmatch_t [], int);
+ ^ #endif
+ ^ #ifndef __REG_NOFRONT
+ ^ int regexec(regex_t *, __REG_CONST char *, size_t, regmatch_t [], int);
+ ^ #endif
+ ^ #ifdef __REG_WIDE_T
+ ^ int __REG_WIDE_EXEC(regex_t *, __REG_CONST __REG_WIDE_T *, size_t,
+ ^                             rm_detail_t *, size_t, regmatch_t [], int);
+ ^ #endif

  */
  */

-#define REG_BASIC      000000          /* BREs (convenience) */
-#define REG_EXTENDED   000001  /* EREs */
-#define REG_ADVF       000002          /* advanced features in EREs */
-#define REG_ADVANCED   000003  /* AREs (which are also EREs) */
-#define REG_QUOTE      000004          /* no special characters, none */
-#define REG_NOSPEC     REG_QUOTE       /* historical synonym */
-#define REG_ICASE      000010          /* ignore case */
-#define REG_NOSUB      000020          /* don't care about subexpressions */
-#define REG_EXPANDED   000040  /* expanded format, white space & comments */
-#define REG_NLSTOP     000100          /* \n doesn't match . or [^ ] */
-#define REG_NLANCH     000200          /* ^ matches after \n, $ before */
-#define REG_NEWLINE 000300             /* newlines are line terminators */
-#define REG_PEND       000400          /* ugh -- backward-compatibility hack */
-#define REG_EXPECT     001000          /* report details on partial/limited
-                                                                * matches */
-#define REG_BOSONLY 002000             /* temporary kludge for BOS-only matches */
-#define REG_DUMP       004000          /* none of your business :-) */
-#define REG_FAKE       010000          /* none of your business :-) */
-#define REG_PROGRESS   020000  /* none of your business :-) */
+#define        REG_NOTBOL      0001    /* BOS is not BOL */
+#define        REG_NOTEOL      0002    /* EOS is not EOL */
+#define        REG_STARTEND    0004    /* backward compatibility kludge */
+#define        REG_FTRACE      0010    /* none of your business */
+#define        REG_MTRACE      0020    /* none of your business */
+#define        REG_SMALL       0040    /* none of your business */

 
 
 
 /*
 
 
 
 /*

- * regex execution flags
+ * misc generics (may be more functions here eventually)
+ ^ re_void regfree(regex_t *);

  */
  */

-#define REG_NOTBOL     0001            /* BOS is not BOL */
-#define REG_NOTEOL     0002            /* EOS is not EOL */
-#define REG_STARTEND   0004    /* backward compatibility kludge */
-#define REG_FTRACE     0010            /* none of your business */
-#define REG_MTRACE     0020            /* none of your business */
-#define REG_SMALL      0040            /* none of your business */
+

 
 
 /*
  * error reporting
  * Be careful if modifying the list of error codes -- the table used by
  * regerror() is generated automatically from this file!
 
 
 /*
  * error reporting
  * Be careful if modifying the list of error codes -- the table used by
  * regerror() is generated automatically from this file!

+ *
+ * Note that there is no wide-char variant of regerror at this time; what
+ * kind of character is used for error reports is independent of what kind
+ * is used in matching.
+ *
+ ^ extern size_t regerror(int, __REG_CONST regex_t *, char *, size_t);

  */
  */

-#define REG_OKAY        0                      /* no errors detected */
-#define REG_NOMATCH  1                 /* failed to match */
-#define REG_BADPAT      2                      /* invalid regexp */
-#define REG_ECOLLATE    3              /* invalid collating element */
-#define REG_ECTYPE      4                      /* invalid character class */
-#define REG_EESCAPE  5                 /* invalid escape \ sequence */
-#define REG_ESUBREG  6                 /* invalid backreference number */
-#define REG_EBRACK      7                      /* brackets [] not balanced */
-#define REG_EPAREN      8                      /* parentheses () not balanced */
-#define REG_EBRACE      9                      /* braces {} not balanced */
-#define REG_BADBR      10                      /* invalid repetition count(s) */
-#define REG_ERANGE     11                      /* invalid character range */
-#define REG_ESPACE     12                      /* out of memory */
-#define REG_BADRPT     13                      /* quantifier operand invalid */
-#define REG_ASSERT     15                      /* "can't happen" -- you found a bug */
-#define REG_INVARG     16                      /* invalid argument to regex function */
-#define REG_MIXED      17                      /* character widths of regex and string
-                                                                * differ */
-#define REG_BADOPT     18                      /* invalid embedded option */
+#define        REG_OKAY         0      /* no errors detected */
+#define        REG_NOMATCH      1      /* failed to match */
+#define        REG_BADPAT       2      /* invalid regexp */
+#define        REG_ECOLLATE     3      /* invalid collating element */
+#define        REG_ECTYPE       4      /* invalid character class */
+#define        REG_EESCAPE      5      /* invalid escape \ sequence */
+#define        REG_ESUBREG      6      /* invalid backreference number */
+#define        REG_EBRACK       7      /* brackets [] not balanced */
+#define        REG_EPAREN       8      /* parentheses () not balanced */
+#define        REG_EBRACE       9      /* braces {} not balanced */
+#define        REG_BADBR       10      /* invalid repetition count(s) */
+#define        REG_ERANGE      11      /* invalid character range */
+#define        REG_ESPACE      12      /* out of memory */
+#define        REG_BADRPT      13      /* quantifier operand invalid */
+#define        REG_ASSERT      15      /* "can't happen" -- you found a bug */
+#define        REG_INVARG      16      /* invalid argument to regex function */
+#define        REG_MIXED       17      /* character widths of regex and string differ */
+#define        REG_BADOPT      18      /* invalid embedded option */

 /* two specials for debugging and testing */
 /* two specials for debugging and testing */

-#define REG_ATOI       101                     /* convert error-code name to number */
-#define REG_ITOA       102                     /* convert error-code number to name */
+#define        REG_ATOI        101     /* convert error-code name to number */
+#define        REG_ITOA        102     /* convert error-code number to name */

 
 
 
 /*
 
 
 
 /*

- * the prototypes for exported functions
+ * the prototypes, as possibly munched by regfwd

  */
  */

-extern int     wx_regcomp(regex_t *, const wx_wchar *, size_t, int);
-extern int     regcomp(regex_t *, const wx_wchar *, int);
-extern int     wx_regexec(regex_t *, const wx_wchar *, size_t, rm_detail_t *, size_t, regmatch_t[], int);
-extern int     regexec(regex_t *, const wx_wchar *, size_t, regmatch_t[], int);
-extern void regfree(regex_t *);
-extern size_t regerror(int, const regex_t *, char *, size_t);
-extern void wx_regfree(regex_t *);
-extern size_t wx_regerror(int, const regex_t *, char *, size_t);
+/* =====^!^===== begin forwards =====^!^===== */
+/* automatically gathered by fwd; do not hand-edit */
+/* === regproto.h === */
+#ifndef __REG_NOCHAR
+int wx_re_comp _ANSI_ARGS_((regex_t *, __REG_CONST char *, size_t, int));
+#endif
+#ifndef __REG_NOFRONT
+int regcomp _ANSI_ARGS_((regex_t *, __REG_CONST char *, int));
+#endif
+#ifdef __REG_WIDE_T
+int __REG_WIDE_COMPILE _ANSI_ARGS_((regex_t *, __REG_CONST __REG_WIDE_T *, size_t, int));
+#endif
+#ifndef __REG_NOCHAR
+int wx_re_exec _ANSI_ARGS_((regex_t *, __REG_CONST char *, size_t, rm_detail_t *, size_t, regmatch_t [], int));
+#endif
+#ifndef __REG_NOFRONT
+int regexec _ANSI_ARGS_((regex_t *, __REG_CONST char *, size_t, regmatch_t [], int));
+#endif
+#ifdef __REG_WIDE_T
+int __REG_WIDE_EXEC _ANSI_ARGS_((regex_t *, __REG_CONST __REG_WIDE_T *, size_t, rm_detail_t *, size_t, regmatch_t [], int));
+#endif
+re_void wx_regfree _ANSI_ARGS_((regex_t *));
+extern size_t wx_regerror _ANSI_ARGS_((int, __REG_CONST regex_t *, char *, size_t));
+/* automatically gathered by fwd; do not hand-edit */
+/* =====^!^===== end forwards =====^!^===== */
+

 
 

+
+/*
+ * more C++ voodoo
+ */

 #ifdef __cplusplus
 }
 #endif
 
 #ifdef __cplusplus
 }
 #endif
 

-#endif   /* _REGEX_H_ */
+
+
+#endif