include/regex.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1992 Henry Spencer.
   5  * Copyright (c) 1992, 1993
   6  *      The Regents of the University of California.  All rights reserved.
   7  *
   8  * This code is derived from software contributed to Berkeley by
   9  * Henry Spencer of the University of Toronto.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  * 3. Neither the name of the University nor the names of its contributors
  20  *    may be used to endorse or promote products derived from this software
  21  *    without specific prior written permission.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33  * SUCH DAMAGE.
  34  */
  35
  36 #ifndef _REGEX_H_
  37 #define _REGEX_H_
  38
  39 #include <sys/cdefs.h>
  40 #include <sys/_types.h>
  41
  42 /* types */
  43 typedef __off_t         regoff_t;
  44
  45 #ifndef _SIZE_T_DECLARED
  46 typedef __size_t        size_t;
  47 #define _SIZE_T_DECLARED
  48 #endif
  49
  50 typedef struct {
  51         int re_magic;
  52         size_t re_nsub;         /* number of parenthesized subexpressions */
  53         const char *re_endp;    /* end pointer for REG_PEND */
  54         struct re_guts *re_g;   /* none of your business :-) */
  55 } regex_t;
  56
  57 typedef struct {
  58         regoff_t rm_so;         /* start of match */
  59         regoff_t rm_eo;         /* end of match */
  60 } regmatch_t;
  61
  62 /* regcomp() flags */
  63 #define REG_BASIC       0000
  64 #define REG_EXTENDED    0001
  65 #define REG_ICASE       0002
  66 #define REG_NOSUB       0004
  67 #define REG_NEWLINE     0010
  68 #define REG_NOSPEC      0020
  69 #define REG_PEND        0040
  70 #define REG_DUMP        0200
  71 #define REG_POSIX       0400    /* only POSIX-compliant regex (libregex) */
  72
  73 /* regerror() flags */
  74 #define REG_ENOSYS      (-1)
  75 #define REG_NOMATCH      1
  76 #define REG_BADPAT       2
  77 #define REG_ECOLLATE     3
  78 #define REG_ECTYPE       4
  79 #define REG_EESCAPE      5
  80 #define REG_ESUBREG      6
  81 #define REG_EBRACK       7
  82 #define REG_EPAREN       8
  83 #define REG_EBRACE       9
  84 #define REG_BADBR       10
  85 #define REG_ERANGE      11
  86 #define REG_ESPACE      12
  87 #define REG_BADRPT      13
  88 #define REG_EMPTY       14
  89 #define REG_ASSERT      15
  90 #define REG_INVARG      16
  91 #define REG_ILLSEQ      17
  92 #define REG_ATOI        255     /* convert name to number (!) */
  93 #define REG_ITOA        0400    /* convert number to name (!) */
  94
  95 /* regexec() flags */
  96 #define REG_NOTBOL      00001
  97 #define REG_NOTEOL      00002
  98 #define REG_STARTEND    00004
  99 #define REG_TRACE       00400   /* tracing of execution */
 100 #define REG_LARGE       01000   /* force large representation */
 101 #define REG_BACKR       02000   /* force use of backref code */
 102
 103 __BEGIN_DECLS
 104 int     regcomp(regex_t * __restrict, const char * __restrict, int);
 105 size_t  regerror(int, const regex_t * __restrict, char * __restrict, size_t);
 106 /*
 107  * XXX forth parameter should be `regmatch_t [__restrict]', but isn't because
 108  * of a bug in GCC 3.2 (when -std=c99 is specified) which perceives this as a
 109  * syntax error.
 110  */
 111 int     regexec(const regex_t * __restrict, const char * __restrict, size_t,
 112             regmatch_t * __restrict, int);
 113 void    regfree(regex_t *);
 114 __END_DECLS
 115
 116 #endif /* !_REGEX_H_ */