Change JNLIB license to LGPLv3+ or GPLv2+.
[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 const char *memistr (const void *buf, size_t buflen, const char *sub);
38 char *mem2str( char *, const void *, size_t);
39 char *trim_spaces( char *string );
40 char *trim_trailing_spaces( char *string );
41 unsigned int trim_trailing_chars( unsigned char *line, unsigned len,
42                                               const char *trimchars);
43 unsigned int trim_trailing_ws( unsigned char *line, unsigned len );
44 size_t length_sans_trailing_chars (const unsigned char *line, size_t len,
45                                    const char *trimchars );
46 size_t length_sans_trailing_ws (const unsigned char *line, size_t len);
47
48
49 char *make_basename(const char *filepath, const char *inputpath);
50 char *make_dirname(const char *filepath);
51 char *make_filename( const char *first_part, ... ) GNUPG_GCC_A_SENTINEL(0);
52 char *make_filename_try (const char *first_part, ... ) GNUPG_GCC_A_SENTINEL(0);
53 int compare_filenames( const char *a, const char *b );
54
55 int hextobyte (const char *s);
56
57 size_t print_sanitized_buffer (FILE *fp, const void *buffer, size_t length,
58                                int delim);
59 size_t print_sanitized_buffer2 (FILE *fp, const void *buffer, size_t length,
60                                 int delim, int delim2);
61 size_t print_sanitized_utf8_buffer (FILE *fp, const void *buffer,
62                                     size_t length, int delim);
63 size_t print_sanitized_string (FILE *fp, const char *string, int delim);
64 size_t print_sanitized_string2 (FILE *fp, const char *string,
65                                 int delim, int delim2);
66 size_t print_sanitized_utf8_string (FILE *fp, const char *string, int delim);
67 char *sanitize_buffer (const void *p, size_t n, int delim);
68
69
70 size_t utf8_charcount (const char *s);
71
72
73 #ifdef HAVE_W32_SYSTEM
74 const char *w32_strerror (int ec);
75 #endif
76
77
78 int ascii_isupper (int c);
79 int ascii_islower (int c);
80 int ascii_toupper (int c);
81 int ascii_tolower (int c);
82 int ascii_strcasecmp( const char *a, const char *b );
83 int ascii_strncasecmp (const char *a, const char *b, size_t n);
84 int ascii_memcasecmp( const void *a, const void *b, size_t n );
85 const char *ascii_memistr ( const void *buf, size_t buflen, const char *sub);
86 void *ascii_memcasemem (const void *haystack, size_t nhaystack,
87                         const void *needle, size_t nneedle);
88
89
90 #ifndef HAVE_MEMICMP
91 int memicmp( const char *a, const char *b, size_t n );
92 #endif
93 #ifndef HAVE_STPCPY
94 char *stpcpy(char *a,const char *b);
95 #endif
96 #ifndef HAVE_STRSEP
97 char *strsep (char **stringp, const char *delim);
98 #endif
99 #ifndef HAVE_STRLWR
100 char *strlwr(char *a);
101 #endif
102 #ifndef HAVE_STRTOUL
103 #  define strtoul(a,b,c)  ((unsigned long)strtol((a),(b),(c)))
104 #endif
105 #ifndef HAVE_MEMMOVE
106 #  define memmove(d, s, n) bcopy((s), (d), (n))
107 #endif
108 #ifndef HAVE_STRICMP
109 #  define stricmp(a,b)   strcasecmp( (a), (b) )
110 #endif
111 #ifndef HAVE_MEMRCHR
112 void *memrchr (const void *buffer, int c, size_t n);
113 #endif
114
115
116 #ifndef HAVE_ISASCII
117 static inline int
118 isascii (int c)
119 {
120   return (((c) & ~0x7f) == 0);
121 }
122 #endif /* !HAVE_ISASCII */
123
124
125 #ifndef STR
126 #  define STR(v) #v
127 #endif
128 #define STR2(v) STR(v)
129
130 /* Percent-escape the string STR by replacing colons with '%3a'.  If
131    EXTRA is not NULL, also replace all characters given in EXTRA.  The
132    "try_" variant fails with NULL if not enough memory can be
133    allocated.  */
134 char *percent_escape (const char *str, const char *extra);
135 char *try_percent_escape (const char *str, const char *extra);
136
137
138 /* Concatenate the string S1 with all the following strings up to a
139    NULL.  Returns a malloced buffer with the new string or NULL on a
140    malloc error or if too many arguments are given.  */
141 char *strconcat (const char *s1, ...) GNUPG_GCC_A_SENTINEL(0);
142 /* Ditto, but die on error.  */
143 char *xstrconcat (const char *s1, ...) GNUPG_GCC_A_SENTINEL(0);
144
145
146
147 #endif /*LIBJNLIB_STRINGHELP_H*/