usr/src/man/man3head/regex.h.3head

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
  44 .\" Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
  45 .\"
  46 .TH REGEX.H 3HEAD "Sep 9, 2004"
  47 .SH NAME
  48 regex.h, regex \- regular expression matching types
  49 .SH SYNOPSIS
  50 .LP
  51 .nf
  52 #include <\fBregex.h\fR>
  53 .fi
  54
  55 .SH DESCRIPTION
  56 .sp
  57 .LP
  58 The <\fBregex.h\fR> header defines the structures and symbolic constants used
  59 by the \fBregcomp()\fR, \fBregexec()\fR, \fBregerror()\fR, and \fBregfree()\fR
  60 functions. See \fBregcomp\fR(3C).
  61 .sp
  62 .LP
  63 The structure type \fBregex_t\fR contains the following member:
  64 .sp
  65 .in +2
  66 .nf
  67 size_t re_nsub     number of parenthesized subexpressions
  68 .fi
  69 .in -2
  70
  71 .sp
  72 .LP
  73 The type \fBsize_t\fR is defined as described in <\fBsys/types.h\fR>. See
  74 \fBtypes.h\fR(3HEAD).
  75 .sp
  76 .LP
  77 The type \fBregoff_t\fR is defined as a signed integer type that can hold the
  78 largest value that can be stored in either a type \fBoff_t\fR or type
  79 \fBssize_t\fR. The structure type \fBregmatch_t\fR contains the following
  80 members:
  81 .sp
  82 .in +2
  83 .nf
  84 regoff_t rm_so     byte offset from start of string to start
  85                    of substring
  86 regoff_t rm_eo     byte offset from start of string of the
  87                    first character after the end of substring
  88 .fi
  89 .in -2
  90
  91 .sp
  92 .LP
  93 Values for the \fIcflags\fR parameter to the \fBregcomp\fR function are as
  94 follows:
  95 .sp
  96 .ne 2
  97 .na
  98 \fB\fBREG_EXTENDED\fR\fR
  99 .ad
 100 .RS 16n
 101 use extended regular expressions
 102 .RE
 103
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fBREG_ICASE\fR\fR
 108 .ad
 109 .RS 16n
 110 ignore case in match
 111 .RE
 112
 113 .sp
 114 .ne 2
 115 .na
 116 \fB\fBREG_NOSUB\fR\fR
 117 .ad
 118 .RS 16n
 119 report only success or fail in \fBregexec()\fR
 120 .RE
 121
 122 .sp
 123 .ne 2
 124 .na
 125 \fB\fBREG_NEWLINE\fR\fR
 126 .ad
 127 .RS 16n
 128 change the handling of \fBNEWLINE\fR character
 129 .RE
 130
 131 .sp
 132 .LP
 133 Values for the \fIeflags\fR parameter to the \fBregexec()\fR function are as
 134 follows:
 135 .sp
 136 .ne 2
 137 .na
 138 \fB\fBREG_NOTBOL\fR\fR
 139 .ad
 140 .RS 14n
 141 The circumflex character (^), when taken as a special character, does not match
 142 the beginning of string.
 143 .RE
 144
 145 .sp
 146 .ne 2
 147 .na
 148 \fB\fBREG_NOTEOL\fR\fR
 149 .ad
 150 .RS 14n
 151 The dollar sign ($), when taken as a special character, does not match the end
 152 of string.
 153 .RE
 154
 155 .sp
 156 .LP
 157 The following constants are defined as error return values:
 158 .sp
 159 .ne 2
 160 .na
 161 \fB\fBREG_NOMATCH\fR\fR
 162 .ad
 163 .RS 16n
 164 \fBregexec()\fR failed to match.
 165 .RE
 166
 167 .sp
 168 .ne 2
 169 .na
 170 \fB\fBREG_BADPAT\fR\fR
 171 .ad
 172 .RS 16n
 173 Invalid regular expression.
 174 .RE
 175
 176 .sp
 177 .ne 2
 178 .na
 179 \fB\fBREG_ECOLLATE\fR\fR
 180 .ad
 181 .RS 16n
 182 Invalid collating element referenced.
 183 .RE
 184
 185 .sp
 186 .ne 2
 187 .na
 188 \fB\fBREG_ECTYPE\fR\fR
 189 .ad
 190 .RS 16n
 191 Invalid character class type referenced.
 192 .RE
 193
 194 .sp
 195 .ne 2
 196 .na
 197 \fB\fBREG_EESCAPE\fR\fR
 198 .ad
 199 .RS 16n
 200 Trailing '\e' in pattern.
 201 .RE
 202
 203 .sp
 204 .ne 2
 205 .na
 206 \fB\fBREG_ESUBREG\fR\fR
 207 .ad
 208 .RS 16n
 209 Number in \fIdigit\fR invalid or in error.
 210 .RE
 211
 212 .sp
 213 .ne 2
 214 .na
 215 \fB\fBREG_EBRACK\fR\fR
 216 .ad
 217 .RS 16n
 218 "[]" imbalance.
 219 .RE
 220
 221 .sp
 222 .ne 2
 223 .na
 224 \fB\fBREG_EPAREN\fR\fR
 225 .ad
 226 .RS 16n
 227 "\e(\e)" or "()" imbalance.
 228 .RE
 229
 230 .sp
 231 .ne 2
 232 .na
 233 \fB\fBREG_EBRACE\fR\fR
 234 .ad
 235 .RS 16n
 236 "\{\}" imbalance.
 237 .RE
 238
 239 .sp
 240 .ne 2
 241 .na
 242 \fB\fBREG_BADBR\fR\fR
 243 .ad
 244 .RS 16n
 245 Content of "\{\}" invalid: not a  number, number too large, more than two
 246 numbers, first larger than second.
 247 .RE
 248
 249 .sp
 250 .ne 2
 251 .na
 252 \fB\fBREG_ERANGE\fR\fR
 253 .ad
 254 .RS 16n
 255 Invalid endpoint in range expression.
 256 .RE
 257
 258 .sp
 259 .ne 2
 260 .na
 261 \fB\fBREG_ESPACE\fR\fR
 262 .ad
 263 .RS 16n
 264 Out of memory.
 265 .RE
 266
 267 .sp
 268 .ne 2
 269 .na
 270 \fB\fBREG_BADRPT\fR\fR
 271 .ad
 272 .RS 16n
 273 \&'?', '*', or '+' not preceded by valid regular expression.
 274 .RE
 275
 276 .sp
 277 .ne 2
 278 .na
 279 \fB\fBREG_ENOSYS\fR\fR
 280 .ad
 281 .RS 16n
 282 Reserved.
 283 .RE
 284
 285 .SH ATTRIBUTES
 286 .sp
 287 .LP
 288 See \fBattributes\fR(5) for descriptions of the following attributes:
 289 .sp
 290
 291 .sp
 292 .TS
 293 box;
 294 c | c
 295 l | l .
 296 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 297 _
 298 Interface Stability     Standard
 299 .TE
 300
 301 .SH SEE ALSO
 302 .sp
 303 .LP
 304 \fBregcomp\fR(3C), \fBtypes.h\fR(3HEAD), \fBattributes\fR(5),
 305 \fBstandards\fR(5)