common: New function map_static_macro_string.
[gnupg.git] / common / stringhelp.h
1 /* stringhelp.h
2  * Copyright (C) 1998, 1999, 2000, 2001, 2003,
3  *               2006, 2007, 2009  Free Software Foundation, Inc.
4  *
5  * This file is part of JNLIB, which is a subsystem of GnuPG.
6  *
7  * JNLIB is free software; you can redistribute it and/or modify it
8  * under the terms of either
9  *
10  *   - the GNU Lesser General Public License as published by the Free
11  *     Software Foundation; either version 3 of the License, or (at
12  *     your option) any later version.
13  *
14  * or
15  *
16  *   - the GNU General Public License as published by the Free
17  *     Software Foundation; either version 2 of the License, or (at
18  *     your option) any later version.
19  *
20  * or both in parallel, as here.
21  *
22  * JNLIB is distributed in the hope that it will be useful, but
23  * WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
25  * General Public License for more details.
26  *
27  * You should have received a copies of the GNU General Public License
28  * and the GNU Lesser General Public License along with this program;
29  * if not, see <http://www.gnu.org/licenses/>.
30  */
31
32 #ifndef LIBJNLIB_STRINGHELP_H
33 #define LIBJNLIB_STRINGHELP_H
34
35 #include "types.h"
36
37 /*-- stringhelp.c --*/
38 char *has_leading_keyword (const char *string, const char *keyword);
39
40 const char *memistr (const void *buf, size_t buflen, const char *sub);
41 char *mem2str( char *, const void *, size_t);
42 char *trim_spaces( char *string );
43 char *trim_trailing_spaces( char *string );
44 unsigned int trim_trailing_chars( unsigned char *line, unsigned len,
45                                               const char *trimchars);
46 unsigned int trim_trailing_ws( unsigned char *line, unsigned len );
47 size_t length_sans_trailing_chars (const unsigned char *line, size_t len,
48                                    const char *trimchars );
49 size_t length_sans_trailing_ws (const unsigned char *line, size_t len);
50
51
52 char *make_basename(const char *filepath, const char *inputpath);
53 char *make_dirname(const char *filepath);
54 char *make_filename( const char *first_part, ... ) GNUPG_GCC_A_SENTINEL(0);
55 char *make_filename_try (const char *first_part, ... ) GNUPG_GCC_A_SENTINEL(0);
56 int compare_filenames( const char *a, const char *b );
57
58 int hextobyte (const char *s);
59
60 size_t print_sanitized_buffer (FILE *fp, const void *buffer, size_t length,
61                                int delim);
62 size_t print_sanitized_buffer2 (FILE *fp, const void *buffer, size_t length,
63                                 int delim, int delim2);
64 size_t print_sanitized_utf8_buffer (FILE *fp, const void *buffer,
65                                     size_t length, int delim);
66 size_t print_sanitized_string (FILE *fp, const char *string, int delim);
67 size_t print_sanitized_string2 (FILE *fp, const char *string,
68                                 int delim, int delim2);
69 size_t print_sanitized_utf8_string (FILE *fp, const char *string, int delim);
70 char *sanitize_buffer (const void *p, size_t n, int delim);
71
72
73 size_t utf8_charcount (const char *s);
74
75
76 #ifdef HAVE_W32_SYSTEM
77 const char *w32_strerror (int ec);
78 #endif
79
80
81 int ascii_isupper (int c);
82 int ascii_islower (int c);
83 int ascii_toupper (int c);
84 int ascii_tolower (int c);
85 int ascii_strcasecmp( const char *a, const char *b );
86 int ascii_strncasecmp (const char *a, const char *b, size_t n);
87 int ascii_memcasecmp( const void *a, const void *b, size_t n );
88 const char *ascii_memistr ( const void *buf, size_t buflen, const char *sub);
89 void *ascii_memcasemem (const void *haystack, size_t nhaystack,
90                         const void *needle, size_t nneedle);
91
92
93 #ifndef HAVE_MEMICMP
94 int memicmp( const char *a, const char *b, size_t n );
95 #endif
96 #ifndef HAVE_STPCPY
97 char *stpcpy(char *a,const char *b);
98 #endif
99 #ifndef HAVE_STRSEP
100 char *strsep (char **stringp, const char *delim);
101 #endif
102 #ifndef HAVE_STRLWR
103 char *strlwr(char *a);
104 #endif
105 #ifndef HAVE_STRTOUL
106 #  define strtoul(a,b,c)  ((unsigned long)strtol((a),(b),(c)))
107 #endif
108 #ifndef HAVE_MEMMOVE
109 #  define memmove(d, s, n) bcopy((s), (d), (n))
110 #endif
111 #ifndef HAVE_STRICMP
112 #  define stricmp(a,b)   strcasecmp( (a), (b) )
113 #endif
114 #ifndef HAVE_MEMRCHR
115 void *memrchr (const void *buffer, int c, size_t n);
116 #endif
117
118
119 #ifndef HAVE_ISASCII
120 static inline int
121 isascii (int c)
122 {
123   return (((c) & ~0x7f) == 0);
124 }
125 #endif /* !HAVE_ISASCII */
126
127
128 #ifndef STR
129 #  define STR(v) #v
130 #endif
131 #define STR2(v) STR(v)
132
133 /* Percent-escape the string STR by replacing colons with '%3a'.  If
134    EXTRA is not NULL, also replace all characters given in EXTRA.  The
135    "try_" variant fails with NULL if not enough memory can be
136    allocated.  */
137 char *percent_escape (const char *str, const char *extra);
138 char *try_percent_escape (const char *str, const char *extra);
139
140
141 /* Concatenate the string S1 with all the following strings up to a
142    NULL.  Returns a malloced buffer with the new string or NULL on a
143    malloc error or if too many arguments are given.  */
144 char *strconcat (const char *s1, ...) GNUPG_GCC_A_SENTINEL(0);
145 /* Ditto, but die on error.  */
146 char *xstrconcat (const char *s1, ...) GNUPG_GCC_A_SENTINEL(0);
147
148
149 /*-- mapstrings.c --*/
150 const char *map_static_macro_string (const char *string);
151
152
153 #endif /*LIBJNLIB_STRINGHELP_H*/