libio/string/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$
 */

LIBIO_EXTERN int ircd_pcre_exec(const pcre *, const char *);
LIBIO_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
 * match_cidr - compares u!h@addr with u!h@addr/cidr
 */
LIBIO_EXTERN int match(const char *, const char *);
LIBIO_EXTERN int match_esc(const char *, const char *);
LIBIO_EXTERN int match_chan(const char *, const char *);
LIBIO_EXTERN int match_cidr(const char *, const char *);

LIBIO_EXTERN int has_wildcards(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
 */
LIBIO_EXTERN char *collapse(char *);
LIBIO_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
 */
LIBIO_EXTERN int irccmp(const char *, const char *);

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

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

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

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

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

LIBIO_EXTERN const char *libio_basename(const char *);

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

LIBIO_EXTERN char *stripws(char *);

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

LIBIO_EXTERN const char *myctime(time_t);

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

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

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

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

LIBIO_EXTERN const unsigned int CharAttrs[];

#define PRINT_C   0x001
#define CNTRL_C   0x002
#define ALPHA_C   0x004
#define PUNCT_C   0x008
#define DIGIT_C   0x010
#define SPACE_C   0x020
#define NICK_C    0x040
#define CHAN_C    0x080
#define KWILD_C   0x100
#define CHANPFX_C 0x200
#define USER_C    0x400
#define HOST_C    0x800
#define NONEOS_C 0x1000
#define SERV_C   0x2000
#define EOL_C    0x4000
#define MWILD_C  0x8000
#define VCHAN_C   0x10000

#define IsVisibleChanChar(c)   (CharAttrs[(unsigned char)(c)] & VCHAN_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)
Revision:	641
Committed:	Wed Jun 7 10:51:31 2006 UTC (17 years, 10 months ago) by michael
Content type:	text/x-chdr
File size:	5795 byte(s)
Log Message:	- Renamed basename() to libio_basename() and use it everywhere instead of glibc's basename - Updated configure.ac accordingly
#	Content
1	/*
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	* $Id$
23	*/
24
25	LIBIO_EXTERN int ircd_pcre_exec(const pcre , const char );
26	LIBIO_EXTERN pcre ircd_pcre_compile(const char , const char **);
27
28	/*
29	* match - compare name with mask, mask may contain * and ? as wildcards
30	* match - returns 1 on successful match, 0 otherwise
31	*
32	* match_esc - compare with support for escaping chars
33	* match_chan - like match_esc with first character auto-escaped
34	* match_cidr - compares u!h@addr with u!h@addr/cidr
35	*/
36	LIBIO_EXTERN int match(const char , const char );
37	LIBIO_EXTERN int match_esc(const char , const char );
38	LIBIO_EXTERN int match_chan(const char , const char );
39	LIBIO_EXTERN int match_cidr(const char , const char );
40
41	LIBIO_EXTERN int has_wildcards(const char *);
42
43	/*
44	* collapse - collapse a string in place, converts multiple adjacent *'s
45	* into a single *.
46	* collapse - modifies the contents of pattern
47	*
48	* collapse_esc() - collapse with support for escaping chars
49	*/
50	LIBIO_EXTERN char collapse(char );
51	LIBIO_EXTERN char collapse_esc(char );
52
53	/*
54	* NOTE: The following functions are NOT the same as strcasecmp
55	* and strncasecmp! These functions use the Finnish (RFC1459)
56	* character set. Do not replace!
57	*
58	* irccmp - case insensitive comparison of s1 and s2
59	*/
60	LIBIO_EXTERN int irccmp(const char , const char );
61
62	/*
63	* ircncmp - counted case insensitive comparison of s1 and s2
64	*/
65	LIBIO_EXTERN int ircncmp(const char , const char , size_t);
66
67	/* XXX
68	* inetntop()
69	* portable interface for inet_ntop(), kludge; please use inet_ntop if possible
70	* since inet_misc has a more conformant one
71	*/
72	LIBIO_EXTERN const char inetntop(int, const void , char *, unsigned int);
73
74	#ifndef HAVE_STRLCPY
75	LIBIO_EXTERN size_t strlcpy(char , const char , size_t);
76	#endif
77
78	#ifndef HAVE_STRLCAT
79	LIBIO_EXTERN size_t strlcat(char , const char , size_t);
80	#endif
81
82	#ifndef HAVE_SNPRINTF
83	LIBIO_EXTERN int snprintf(char , size_t, const char ,...);
84	#endif
85
86	#ifndef HAVE_VSNPRINTF
87	LIBIO_EXTERN int vsnprintf(char , size_t, const char , va_list);
88	#endif
89
90	LIBIO_EXTERN const char libio_basename(const char );
91
92	/*
93	* clean_string - cleanup control and high ascii characters
94	* -Dianora
95	*/
96	LIBIO_EXTERN char clean_string(char , const unsigned char *, size_t);
97
98	LIBIO_EXTERN char stripws(char );
99
100	/*
101	* strip_tabs - convert tabs to spaces
102	* - jdc
103	*/
104	LIBIO_EXTERN void strip_tabs(char , const char , size_t);
105
106	LIBIO_EXTERN const char *myctime(time_t);
107
108	#define EmptyString(x) (!(x) \|\| (*(x) == '\0'))
109
110	#ifndef HAVE_STRTOK_R
111	LIBIO_EXTERN char strtoken(char , char , const char *);
112	#endif
113
114	/*
115	* character macros
116	*/
117	LIBIO_EXTERN const unsigned char ToLowerTab[];
118	#define ToLower(c) (ToLowerTab[(unsigned char)(c)])
119
120	LIBIO_EXTERN const unsigned char ToUpperTab[];
121	#define ToUpper(c) (ToUpperTab[(unsigned char)(c)])
122
123	LIBIO_EXTERN const unsigned int CharAttrs[];
124
125	#define PRINT_C 0x001
126	#define CNTRL_C 0x002
127	#define ALPHA_C 0x004
128	#define PUNCT_C 0x008
129	#define DIGIT_C 0x010
130	#define SPACE_C 0x020
131	#define NICK_C 0x040
132	#define CHAN_C 0x080
133	#define KWILD_C 0x100
134	#define CHANPFX_C 0x200
135	#define USER_C 0x400
136	#define HOST_C 0x800
137	#define NONEOS_C 0x1000
138	#define SERV_C 0x2000
139	#define EOL_C 0x4000
140	#define MWILD_C 0x8000
141	#define VCHAN_C 0x10000
142
143	#define IsVisibleChanChar(c) (CharAttrs[(unsigned char)(c)] & VCHAN_C)
144	#define IsHostChar(c) (CharAttrs[(unsigned char)(c)] & HOST_C)
145	#define IsUserChar(c) (CharAttrs[(unsigned char)(c)] & USER_C)
146	#define IsChanPrefix(c) (CharAttrs[(unsigned char)(c)] & CHANPFX_C)
147	#define IsChanChar(c) (CharAttrs[(unsigned char)(c)] & CHAN_C)
148	#define IsKWildChar(c) (CharAttrs[(unsigned char)(c)] & KWILD_C)
149	#define IsMWildChar(c) (CharAttrs[(unsigned char)(c)] & MWILD_C)
150	#define IsNickChar(c) (CharAttrs[(unsigned char)(c)] & NICK_C)
151	#define IsServChar(c) (CharAttrs[(unsigned char)(c)] & (NICK_C \| SERV_C))
152	#define IsCntrl(c) (CharAttrs[(unsigned char)(c)] & CNTRL_C)
153	#define IsAlpha(c) (CharAttrs[(unsigned char)(c)] & ALPHA_C)
154	#define IsSpace(c) (CharAttrs[(unsigned char)(c)] & SPACE_C)
155	#define IsLower(c) (IsAlpha((c)) && ((unsigned char)(c) > 0x5f))
156	#define IsUpper(c) (IsAlpha((c)) && ((unsigned char)(c) < 0x60))
157	#define IsDigit(c) (CharAttrs[(unsigned char)(c)] & DIGIT_C)
158	#define IsXDigit(c) (IsDigit(c) \|\| ('a' <= (c) && (c) <= 'f') \|\| \
159	('A' <= (c) && (c) <= 'F'))
160	#define IsAlNum(c) (CharAttrs[(unsigned char)(c)] & (DIGIT_C \| ALPHA_C))
161	#define IsPrint(c) (CharAttrs[(unsigned char)(c)] & PRINT_C)
162	#define IsAscii(c) ((unsigned char)(c) < 0x80)
163	#define IsGraph(c) (IsPrint((c)) && ((unsigned char)(c) != 0x32))
164	#define IsPunct(c) (!(CharAttrs[(unsigned char)(c)] & \
165	(CNTRL_C \| ALPHA_C \| DIGIT_C)))
166
167	#define IsNonEOS(c) (CharAttrs[(unsigned char)(c)] & NONEOS_C)
168	#define IsEol(c) (CharAttrs[(unsigned char)(c)] & EOL_C)