trunk/include/irc_string.h

/*
 *  ircd-hybrid: an advanced Internet Relay Chat Daemon(ircd).
 *  irc_string.h: A header for the ircd string functions.
 *
 *  Copyright (C) 2002 by the past and present ircd coders, and others.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
 *  USA
 *
 *  $Id$
 */

#ifndef INCLUDED_irc_string_h
#define INCLUDED_irc_string_h

#include "setup.h"
#include "pcre.h"

extern int ircd_pcre_exec(const pcre *, const char *);
extern pcre *ircd_pcre_compile(const char *, const char **);

/*
 * match - compare name with mask, mask may contain * and ? as wildcards
 * match - returns 1 on successful match, 0 otherwise
 *
 * match_esc - compare with support for escaping chars
 * match_chan - like match_esc with first character auto-escaped
 */
extern int match(const char *, const char *);
extern int match_esc(const char *, const char *);
extern int match_chan(const char *, const char *);

/*
 * collapse - collapse a string in place, converts multiple adjacent *'s 
 * into a single *.
 * collapse - modifies the contents of pattern 
 *
 * collapse_esc() - collapse with support for escaping chars
 */
extern char *collapse(char *);
extern char *collapse_esc(char *);

/*
 * NOTE: The following functions are NOT the same as strcasecmp
 * and strncasecmp! These functions use the Finnish (RFC1459)
 * character set. Do not replace!
 * 
 * irccmp - case insensitive comparison of s1 and s2
 */
extern int irccmp(const char *, const char *);

/*
 * ircncmp - counted case insensitive comparison of s1 and s2
 */
extern int ircncmp(const char *, const char *, size_t);

/*
 * inetntoa - optimized inet_ntoa
 */
extern const char *inetntoa(const char *);

/* XXX
 * inetntop() 
 * portable interface for inet_ntop(), kludge; please use inet_ntop if possible
 * since inet_misc has a more conformant one
 */
extern const char *inetntop(int, const void *, char *, unsigned int);
   
#ifndef HAVE_STRLCPY
extern size_t strlcpy(char *, const char *, size_t);
#endif

#ifndef HAVE_STRLCAT
extern size_t strlcat(char *, const char *, size_t);
#endif

#ifndef HAVE_SNPRINTF
extern int snprintf(char *, size_t, const char *,...);
#endif

#ifndef HAVE_VSNPRINTF
extern int vsnprintf(char *, size_t, const char *, va_list);
#endif

#ifndef HAVE_BASENAME
extern char *basename(char *);
#endif

/*
 * clean_string - cleanup control and high ascii characters
 * -Dianora
 */
extern char *clean_string(char *, const unsigned char *, size_t);

/*
 * strip_tabs - convert tabs to spaces
 * - jdc
 */
extern void strip_tabs(char *, const char *, size_t);

const char *myctime(time_t);

#define EmptyString(x) (!(x) || (*(x) == '\0'))

#ifndef HAVE_STRTOK_R
extern char *strtoken(char **, char *, const char *);
#endif

/*
 * character macros
 */
extern const unsigned char ToLowerTab[];
#define ToLower(c) (ToLowerTab[(unsigned char)(c)])

extern const unsigned char ToUpperTab[];
#define ToUpper(c) (ToUpperTab[(unsigned char)(c)])

extern const unsigned int CharAttrs[];

#define PRINT_C   0x00001
#define CNTRL_C   0x00002
#define ALPHA_C   0x00004
#define PUNCT_C   0x00008
#define DIGIT_C   0x00010
#define SPACE_C   0x00020
#define NICK_C    0x00040
#define CHAN_C    0x00080
#define KWILD_C   0x00100
#define CHANPFX_C 0x00200
#define USER_C    0x00400
#define HOST_C    0x00800
#define NONEOS_C  0x01000
#define SERV_C    0x02000
#define EOL_C     0x04000
#define MWILD_C   0x08000
#define FCHAN_C   0x10000

#define IsFchanChar(c)   (CharAttrs[(unsigned char)(c)] & FCHAN_C)
#define IsHostChar(c)   (CharAttrs[(unsigned char)(c)] & HOST_C)
#define IsUserChar(c)   (CharAttrs[(unsigned char)(c)] & USER_C)
#define IsChanPrefix(c) (CharAttrs[(unsigned char)(c)] & CHANPFX_C)
#define IsChanChar(c)   (CharAttrs[(unsigned char)(c)] & CHAN_C)
#define IsKWildChar(c)  (CharAttrs[(unsigned char)(c)] & KWILD_C)
#define IsMWildChar(c)  (CharAttrs[(unsigned char)(c)] & MWILD_C)
#define IsNickChar(c)   (CharAttrs[(unsigned char)(c)] & NICK_C)
#define IsServChar(c)   (CharAttrs[(unsigned char)(c)] & (NICK_C | SERV_C))
#define IsCntrl(c)      (CharAttrs[(unsigned char)(c)] & CNTRL_C)
#define IsAlpha(c)      (CharAttrs[(unsigned char)(c)] & ALPHA_C)
#define IsSpace(c)      (CharAttrs[(unsigned char)(c)] & SPACE_C)
#define IsLower(c)      (IsAlpha((c)) && ((unsigned char)(c) > 0x5f))
#define IsUpper(c)      (IsAlpha((c)) && ((unsigned char)(c) < 0x60))
#define IsDigit(c)      (CharAttrs[(unsigned char)(c)] & DIGIT_C)
#define IsXDigit(c) (IsDigit(c) || ('a' <= (c) && (c) <= 'f') || \
        ('A' <= (c) && (c) <= 'F'))
#define IsAlNum(c) (CharAttrs[(unsigned char)(c)] & (DIGIT_C | ALPHA_C))
#define IsPrint(c) (CharAttrs[(unsigned char)(c)] & PRINT_C)
#define IsAscii(c) ((unsigned char)(c) < 0x80)
#define IsGraph(c) (IsPrint((c)) && ((unsigned char)(c) != 0x32))
#define IsPunct(c) (!(CharAttrs[(unsigned char)(c)] & \
                                           (CNTRL_C | ALPHA_C | DIGIT_C)))

#define IsNonEOS(c) (CharAttrs[(unsigned char)(c)] & NONEOS_C)
#define IsEol(c) (CharAttrs[(unsigned char)(c)] & EOL_C)

#endif /* INCLUDED_irc_string_h */
Revision:	632
Committed:	Thu Jun 1 10:53:00 2006 UTC (19 years, 3 months ago) by michael
Content type:	text/x-chdr
Original Path:	*ircd-hybrid-7.2/include/irc_string.h*
File size:	5719 byte(s)
Log Message:	- Added channel::disable_fake_channels which disallows creation of channels that have ascii 2, 3, 31 and 160 in their names. - Minor improvements and cleanups to channel name validation routines backported from 7.3
#	User	Rev	Content
1	adx	30	/*
2			* ircd-hybrid: an advanced Internet Relay Chat Daemon(ircd).
3			* irc_string.h: A header for the ircd string functions.
4			*
5			* Copyright (C) 2002 by the past and present ircd coders, and others.
6			*
7			* This program is free software; you can redistribute it and/or modify
8			* it under the terms of the GNU General Public License as published by
9			* the Free Software Foundation; either version 2 of the License, or
10			* (at your option) any later version.
11			*
12			* This program is distributed in the hope that it will be useful,
13			* but WITHOUT ANY WARRANTY; without even the implied warranty of
14			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15			* GNU General Public License for more details.
16			*
17			* You should have received a copy of the GNU General Public License
18			* along with this program; if not, write to the Free Software
19			* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
20			* USA
21			*
22	knight	31	* $Id$
23	adx	30	*/
24
25			#ifndef INCLUDED_irc_string_h
26			#define INCLUDED_irc_string_h
27
28			#include "setup.h"
29			#include "pcre.h"
30
31			extern int ircd_pcre_exec(const pcre , const char );
32			extern pcre ircd_pcre_compile(const char , const char **);
33
34			/*
35			* match - compare name with mask, mask may contain * and ? as wildcards
36			* match - returns 1 on successful match, 0 otherwise
37			*
38			* match_esc - compare with support for escaping chars
39			* match_chan - like match_esc with first character auto-escaped
40			*/
41			extern int match(const char , const char );
42			extern int match_esc(const char , const char );
43			extern int match_chan(const char , const char );
44
45			/*
46			* collapse - collapse a string in place, converts multiple adjacent *'s
47			* into a single *.
48			* collapse - modifies the contents of pattern
49			*
50			* collapse_esc() - collapse with support for escaping chars
51			*/
52			extern char collapse(char );
53			extern char collapse_esc(char );
54
55			/*
56			* NOTE: The following functions are NOT the same as strcasecmp
57			* and strncasecmp! These functions use the Finnish (RFC1459)
58			* character set. Do not replace!
59			*
60			* irccmp - case insensitive comparison of s1 and s2
61			*/
62			extern int irccmp(const char , const char );
63
64			/*
65			* ircncmp - counted case insensitive comparison of s1 and s2
66			*/
67			extern int ircncmp(const char , const char , size_t);
68
69			/*
70			* inetntoa - optimized inet_ntoa
71			*/
72			extern const char inetntoa(const char );
73
74			/* XXX
75			* inetntop()
76			* portable interface for inet_ntop(), kludge; please use inet_ntop if possible
77			* since inet_misc has a more conformant one
78			*/
79			extern const char inetntop(int, const void , char *, unsigned int);
80
81			#ifndef HAVE_STRLCPY
82			extern size_t strlcpy(char , const char , size_t);
83			#endif
84
85			#ifndef HAVE_STRLCAT
86			extern size_t strlcat(char , const char , size_t);
87			#endif
88
89			#ifndef HAVE_SNPRINTF
90			extern int snprintf(char , size_t, const char ,...);
91			#endif
92
93			#ifndef HAVE_VSNPRINTF
94			extern int vsnprintf(char , size_t, const char , va_list);
95			#endif
96
97			#ifndef HAVE_BASENAME
98			extern char basename(char );
99			#endif
100
101			/*
102			* clean_string - cleanup control and high ascii characters
103			* -Dianora
104			*/
105			extern char clean_string(char , const unsigned char *, size_t);
106
107			/*
108			* strip_tabs - convert tabs to spaces
109			* - jdc
110			*/
111			extern void strip_tabs(char , const char , size_t);
112
113			const char *myctime(time_t);
114
115			#define EmptyString(x) (!(x) \|\| (*(x) == '\0'))
116
117			#ifndef HAVE_STRTOK_R
118			extern char strtoken(char , char , const char *);
119			#endif
120
121			/*
122			* character macros
123			*/
124			extern const unsigned char ToLowerTab[];
125			#define ToLower(c) (ToLowerTab[(unsigned char)(c)])
126
127			extern const unsigned char ToUpperTab[];
128			#define ToUpper(c) (ToUpperTab[(unsigned char)(c)])
129
130			extern const unsigned int CharAttrs[];
131
132	michael	632	#define PRINT_C 0x00001
133			#define CNTRL_C 0x00002
134			#define ALPHA_C 0x00004
135			#define PUNCT_C 0x00008
136			#define DIGIT_C 0x00010
137			#define SPACE_C 0x00020
138			#define NICK_C 0x00040
139			#define CHAN_C 0x00080
140			#define KWILD_C 0x00100
141			#define CHANPFX_C 0x00200
142			#define USER_C 0x00400
143			#define HOST_C 0x00800
144			#define NONEOS_C 0x01000
145			#define SERV_C 0x02000
146			#define EOL_C 0x04000
147			#define MWILD_C 0x08000
148			#define FCHAN_C 0x10000
149	adx	30
150	michael	632	#define IsFchanChar(c) (CharAttrs[(unsigned char)(c)] & FCHAN_C)
151	adx	30	#define IsHostChar(c) (CharAttrs[(unsigned char)(c)] & HOST_C)
152			#define IsUserChar(c) (CharAttrs[(unsigned char)(c)] & USER_C)
153			#define IsChanPrefix(c) (CharAttrs[(unsigned char)(c)] & CHANPFX_C)
154			#define IsChanChar(c) (CharAttrs[(unsigned char)(c)] & CHAN_C)
155			#define IsKWildChar(c) (CharAttrs[(unsigned char)(c)] & KWILD_C)
156			#define IsMWildChar(c) (CharAttrs[(unsigned char)(c)] & MWILD_C)
157			#define IsNickChar(c) (CharAttrs[(unsigned char)(c)] & NICK_C)
158			#define IsServChar(c) (CharAttrs[(unsigned char)(c)] & (NICK_C \| SERV_C))
159			#define IsCntrl(c) (CharAttrs[(unsigned char)(c)] & CNTRL_C)
160			#define IsAlpha(c) (CharAttrs[(unsigned char)(c)] & ALPHA_C)
161			#define IsSpace(c) (CharAttrs[(unsigned char)(c)] & SPACE_C)
162			#define IsLower(c) (IsAlpha((c)) && ((unsigned char)(c) > 0x5f))
163			#define IsUpper(c) (IsAlpha((c)) && ((unsigned char)(c) < 0x60))
164			#define IsDigit(c) (CharAttrs[(unsigned char)(c)] & DIGIT_C)
165			#define IsXDigit(c) (IsDigit(c) \|\| ('a' <= (c) && (c) <= 'f') \|\| \
166			('A' <= (c) && (c) <= 'F'))
167			#define IsAlNum(c) (CharAttrs[(unsigned char)(c)] & (DIGIT_C \| ALPHA_C))
168			#define IsPrint(c) (CharAttrs[(unsigned char)(c)] & PRINT_C)
169			#define IsAscii(c) ((unsigned char)(c) < 0x80)
170			#define IsGraph(c) (IsPrint((c)) && ((unsigned char)(c) != 0x32))
171			#define IsPunct(c) (!(CharAttrs[(unsigned char)(c)] & \
172			(CNTRL_C \| ALPHA_C \| DIGIT_C)))
173
174			#define IsNonEOS(c) (CharAttrs[(unsigned char)(c)] & NONEOS_C)
175			#define IsEol(c) (CharAttrs[(unsigned char)(c)] & EOL_C)
176
177			#endif /* INCLUDED_irc_string_h */