Return to structs_type_regex.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / libpdel / structs / type

libpdel

.\" Copyright (c) 2001-2002 Packet Design, LLC.
.\" All rights reserved.
.\" 
.\" Subject to the following obligations and disclaimer of warranty,
.\" use and redistribution of this software, in source or object code
.\" forms, with or without modifications are expressly permitted by
.\" Packet Design; provided, however, that:
.\" 
.\"    (i)  Any and all reproductions of the source or object code
.\"         must include the copyright notice above and the following
.\"         disclaimer of warranties; and
.\"    (ii) No rights are granted, in any manner or form, to use
.\"         Packet Design trademarks, including the mark "PACKET DESIGN"
.\"         on advertising, endorsements, or otherwise except as such
.\"         appears in the above copyright notice or in the software.
.\" 
.\" THIS SOFTWARE IS BEING PROVIDED BY PACKET DESIGN "AS IS", AND
.\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, PACKET DESIGN MAKES NO
.\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING
.\" THIS SOFTWARE, INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED
.\" WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
.\" OR NON-INFRINGEMENT.  PACKET DESIGN DOES NOT WARRANT, GUARANTEE,
.\" OR MAKE ANY REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS
.\" OF THE USE OF THIS SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY,
.\" RELIABILITY OR OTHERWISE.  IN NO EVENT SHALL PACKET DESIGN BE
.\" LIABLE FOR ANY DAMAGES RESULTING FROM OR ARISING OUT OF ANY USE
.\" OF THIS SOFTWARE, INCLUDING WITHOUT LIMITATION, ANY DIRECT,
.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, PUNITIVE, OR CONSEQUENTIAL
.\" DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, LOSS OF
.\" USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY THEORY OF
.\" LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
.\" THE USE OF THIS SOFTWARE, EVEN IF PACKET DESIGN IS ADVISED OF
.\" THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" Author: Archie Cobbs <archie@freebsd.org>
.\"
.\" $Id: structs_type_regex.3,v 1.1.1.1 2012/02/21 23:25:53 misho Exp $
.\"
.Dd April 22, 2002
.Dt STRUCTS_TYPE_REGEX 3
.Os
.Sh NAME
.Nm structs_type_regex
.Nd structs type for regular expressions
.Sh LIBRARY
PDEL Library (libpdel, \-lpdel)
.Sh SYNOPSIS
.In sys/types.h
.In regex.h
.In pdel/structs/structs.h
.In pdel/structs/type/regex.h
.Fn STRUCTS_REGEX_TYPE mtype flags
.Vt extern const struct structs_type structs_type_regex ;
.Vt extern const struct structs_type structs_type_regex_icase ;
.Sh DESCRIPTION
The
.Fn STRUCTS_REGEX_TYPE
macro defines a
.Xr structs 3
type (i.e., a
.Dv "struct structs_type" )
for describing regular expressions.
The data structure described by this type is a
.Li "struct structs_regex" :
.Pp
.Bd -literal -compact -offset 3n
struct structs_regex {
    const char  *pat;       /* ascii pattern */
    regex_t     reg;        /* compiled pattern */
};
.Ed
.Pp
.Fa pat
points to the ASCII form of the regular expression pattern, which is
stored in a buffer allocated using
.Xr typed_mem 3
type
.Fa mtype .
.Fa reg
is the compiled form of the pattern.
.Pp
The
.Fa flags
parameter is passed to
.Xr regcomp 3 .
.Pp
The default value for this type is the pattern represented by
the empty string.
.Pp
Two pre-defined types are included.
.Nm structs_type_regex
is defined with memory type
.Dv STRUCTS_REGEX_MTYPE
and flags
.Dv REG_EXTENDED.
.Pp
.Nm structs_type_regex_icase
is defined with memory type
.Dv STRUCTS_REGEX_MTYPE
and flags
.Li "REG_EXTENDED | REG_ICASE" .
.Sh SEE ALSO
.Xr libpdel 3 ,
.Xr regex 3 ,
.Xr structs 3 ,
.Xr structs_type 3 ,
.Xr typed_mem 3
.Sh HISTORY
The PDEL library was developed at Packet Design, LLC.
.Dv "http://www.packetdesign.com/"
.Sh AUTHORS
.An Archie Cobbs Aq archie@freebsd.org