gpg: Fix buffering problem in --list-config.
[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 char *make_absfilename (const char *first_part, ...) GNUPG_GCC_A_SENTINEL(0);
57 char *make_absfilename_try (const char *first_part,
58                             ...) GNUPG_GCC_A_SENTINEL(0);
59 int compare_filenames( const char *a, const char *b );
60
61 int hextobyte (const char *s);
62
63 char *sanitize_buffer (const void *p, size_t n, int delim);
64
65
66 size_t utf8_charcount (const char *s);
67
68
69 #ifdef HAVE_W32_SYSTEM
70 const char *w32_strerror (int ec);
71 #endif
72
73
74 int ascii_isupper (int c);
75 int ascii_islower (int c);
76 int ascii_toupper (int c);
77 int ascii_tolower (int c);
78 int ascii_strcasecmp( const char *a, const char *b );
79 int ascii_strncasecmp (const char *a, const char *b, size_t n);
80 int ascii_memcasecmp( const void *a, const void *b, size_t n );
81 const char *ascii_memistr ( const void *buf, size_t buflen, const char *sub);
82 void *ascii_memcasemem (const void *haystack, size_t nhaystack,
83                         const void *needle, size_t nneedle);
84
85
86 #ifndef HAVE_MEMICMP
87 int memicmp( const char *a, const char *b, size_t n );
88 #endif
89 #ifndef HAVE_STPCPY
90 char *stpcpy(char *a,const char *b);
91 #endif
92 #ifndef HAVE_STRPBRK
93 char *strpbrk (const char *s, const char *accept);
94 #endif
95 #ifndef HAVE_STRSEP
96 char *strsep (char **stringp, const char *delim);
97 #endif
98 #ifndef HAVE_STRLWR
99 char *strlwr(char *a);
100 #endif
101 #ifndef HAVE_STRTOUL
102 #  define strtoul(a,b,c)  ((unsigned long)strtol((a),(b),(c)))
103 #endif
104 #ifndef HAVE_MEMMOVE
105 #  define memmove(d, s, n) bcopy((s), (d), (n))
106 #endif
107 #ifndef HAVE_STRICMP
108 #  define stricmp(a,b)   strcasecmp( (a), (b) )
109 #endif
110 #ifndef HAVE_MEMRCHR
111 void *memrchr (const void *buffer, int c, size_t n);
112 #endif
113
114
115 #ifndef HAVE_ISASCII
116 static inline int
117 isascii (int c)
118 {
119   return (((c) & ~0x7f) == 0);
120 }
121 #endif /* !HAVE_ISASCII */
122
123
124 #ifndef STR
125 #  define STR(v) #v
126 #endif
127 #define STR2(v) STR(v)
128
129 /* Percent-escape the string STR by replacing colons with '%3a'.  If
130    EXTRA is not NULL, also replace all characters given in EXTRA.  The
131    "try_" variant fails with NULL if not enough memory can be
132    allocated.  */
133 char *percent_escape (const char *str, const char *extra);
134 char *try_percent_escape (const char *str, const char *extra);
135
136
137 /* Concatenate the string S1 with all the following strings up to a
138    NULL.  Returns a malloced buffer with the new string or NULL on a
139    malloc error or if too many arguments are given.  */
140 char *strconcat (const char *s1, ...) GNUPG_GCC_A_SENTINEL(0);
141 /* Ditto, but die on error.  */
142 char *xstrconcat (const char *s1, ...) GNUPG_GCC_A_SENTINEL(0);
143
144
145 /*-- mapstrings.c --*/
146 const char *map_static_macro_string (const char *string);
147
148
149 #endif /*LIBJNLIB_STRINGHELP_H*/