xref: /netbsd-src/external/ibm-public/postfix/dist/src/util/stringops.h (revision c48c605c14fd8622b523d1d6a3f0c0bad133ea89)
1 /*	$NetBSD: stringops.h,v 1.5 2023/12/23 20:30:46 christos Exp $	*/
2 
3 #ifndef _STRINGOPS_H_INCLUDED_
4 #define _STRINGOPS_H_INCLUDED_
5 
6 /*++
7 /* NAME
8 /*	stringops 3h
9 /* SUMMARY
10 /*	string operations
11 /* SYNOPSIS
12 /*	#include <stringops.h>
13 /* DESCRIPTION
14 /* .nf
15 
16  /*
17   * Utility library.
18   */
19 #include <vstring.h>
20 
21  /*
22   * External interface.
23   */
24 extern int util_utf8_enable;
25 extern char *printable_except(char *, int, const char *);
26 extern char *neuter(char *, const char *, int);
27 extern char *lowercase(char *);
28 extern char *casefoldx(int, VSTRING *, const char *, ssize_t);
29 extern char *uppercase(char *);
30 extern char *skipblanks(const char *);
31 extern char *trimblanks(char *, ssize_t);
32 extern char *concatenate(const char *,...);
33 extern char *mystrtok(char **, const char *);
34 extern char *mystrtokq(char **, const char *, const char *);
35 extern char *mystrtokdq(char **, const char *);
36 extern char *mystrtok_cw(char **, const char *, const char *);
37 extern char *mystrtokq_cw(char **, const char *, const char *, const char *);
38 extern char *mystrtokdq_cw(char **, const char *, const char *);
39 extern char *translit(char *, const char *, const char *);
40 
41 #define mystrtok(cp, sp) mystrtok_cw((cp), (sp), (char *) 0)
42 #define mystrtokq(cp, sp, pp) mystrtokq_cw((cp), (sp), (pp), (char *) 0)
43 #define mystrtokdq(cp, sp) mystrtokdq_cw((cp), (sp), (char *) 0)
44 
45 #define printable(string, replacement) \
46 	printable_except((string), (replacement), (char *) 0)
47 
48 #ifndef HAVE_BASENAME
49 #define basename postfix_basename
50 extern char *basename(const char *);
51 
52 #endif
53 extern char *sane_basename(VSTRING *, const char *);
54 extern char *sane_dirname(VSTRING *, const char *);
55 extern VSTRING *unescape(VSTRING *, const char *);
56 extern VSTRING *escape(VSTRING *, const char *, ssize_t);
57 extern int alldig(const char *);
58 extern int allalnum(const char *);
59 extern int allprint(const char *);
60 extern int allspace(const char *);
61 extern int allascii_len(const char *, ssize_t);
62 extern const char *WARN_UNUSED_RESULT split_nameval(char *, char **, char **);
63 extern const char *WARN_UNUSED_RESULT split_qnameval(char *, char **, char **);
64 extern int valid_utf8_string(const char *, ssize_t);
65 extern size_t balpar(const char *, const char *);
66 extern char *WARN_UNUSED_RESULT extpar(char **, const char *, int);
67 extern int strcasecmp_utf8x(int, const char *, const char *);
68 extern int strncasecmp_utf8x(int, const char *, const char *, ssize_t);
69 
70 #define EXTPAR_FLAG_NONE	(0)
71 #define EXTPAR_FLAG_STRIP	(1<<0)	/* "{ text }" -> "text" */
72 #define EXTPAR_FLAG_EXTRACT	(1<<1)	/* hint from caller's caller */
73 
74 #define CASEF_FLAG_UTF8		(1<<0)
75 #define CASEF_FLAG_APPEND	(1<<1)
76 
77  /*
78   * Convenience wrappers for most-common use cases.
79   */
80 #define allascii(s)	allascii_len((s), -1)
81 #define casefold(dst, src) \
82     casefoldx(util_utf8_enable ? CASEF_FLAG_UTF8 : 0, (dst), (src), -1)
83 #define casefold_len(dst, src, len) \
84     casefoldx(util_utf8_enable ? CASEF_FLAG_UTF8 : 0, (dst), (src), (len))
85 #define casefold_append(dst, src) \
86     casefoldx((util_utf8_enable ? CASEF_FLAG_UTF8 : 0) | CASEF_FLAG_APPEND, \
87 		(dst), (src), -1)
88 
89 #define strcasecmp_utf8(s1, s2) \
90     strcasecmp_utf8x(util_utf8_enable ? CASEF_FLAG_UTF8 : 0, (s1), (s2))
91 #define strncasecmp_utf8(s1, s2, l) \
92     strncasecmp_utf8x(util_utf8_enable ? CASEF_FLAG_UTF8 : 0, (s1), (s2), (l))
93 
94  /*
95   * Use STRREF(x) instead of x, to shut up compiler warnings when the operand
96   * is a string literal.
97   */
98 #define STRREF(x)		(&x[0])
99 
100 /* LICENSE
101 /* .ad
102 /* .fi
103 /*	The Secure Mailer license must be distributed with this software.
104 /* AUTHOR(S)
105 /*	Wietse Venema
106 /*	IBM T.J. Watson Research
107 /*	P.O. Box 704
108 /*	Yorktown Heights, NY 10598, USA
109 /*
110 /*	Wietse Venema
111 /*	Google, Inc.
112 /*	111 8th Avenue
113 /*	New York, NY 10011, USA
114 /*--*/
115 
116 #endif
117