1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
|
/*
* libjingle
* Copyright 2004--2005, Google Inc.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* 3. The name of the author may not be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
* EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
* OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef TALK_BASE_STRINGENCODE_H__
#define TALK_BASE_STRINGENCODE_H__
#include <string>
#include <sstream>
namespace talk_base {
//////////////////////////////////////////////////////////////////////
// String Encoding Utilities
//////////////////////////////////////////////////////////////////////
// Convert an unsigned value from 0 to 15 to the hex character equivalent...
char hex_encode(unsigned char val);
// ...and vice-versa.
unsigned char hex_decode(char ch);
// Convert an unsigned value to it's utf8 representation. Returns the length
// of the encoded string, or 0 if the encoding is longer than buflen - 1.
size_t utf8_encode(char* buffer, size_t buflen, unsigned long value);
// Decode the utf8 encoded value pointed to by source. Returns the number of
// bytes used by the encoding, or 0 if the encoding is invalid.
size_t utf8_decode(const char* source, size_t srclen, unsigned long* value);
// Escaping prefixes illegal characters with the escape character. Compact, but
// illegal characters still appear in the string.
size_t escape(char * buffer, size_t buflen,
const char * source, size_t srclen,
const char * illegal, char escape);
// Note: in-place unescaping (buffer == source) is allowed.
size_t unescape(char * buffer, size_t buflen,
const char * source, size_t srclen,
char escape);
// Encoding replaces illegal characters with the escape character and 2 hex
// chars, so it's a little less compact than escape, but completely removes
// illegal characters. note that hex digits should not be used as illegal
// characters.
size_t encode(char * buffer, size_t buflen,
const char * source, size_t srclen,
const char * illegal, char escape);
// Note: in-place decoding (buffer == source) is allowed.
size_t decode(char * buffer, size_t buflen,
const char * source, size_t srclen,
char escape);
// Returns a list of characters that may be unsafe for use in the name of a
// file, suitable for passing to the 'illegal' member of escape or encode.
const char* unsafe_filename_characters();
// url_encode is an encode operation with a predefined set of illegal characters
// and escape character (for use in URLs, obviously).
size_t url_encode(char * buffer, size_t buflen,
const char * source, size_t srclen);
// Note: in-place decoding (buffer == source) is allowed.
size_t url_decode(char * buffer, size_t buflen,
const char * source, size_t srclen);
// html_encode prevents data embedded in html from containing markup.
size_t html_encode(char * buffer, size_t buflen,
const char * source, size_t srclen);
// Note: in-place decoding (buffer == source) is allowed.
size_t html_decode(char * buffer, size_t buflen,
const char * source, size_t srclen);
// xml_encode makes data suitable for inside xml attributes and values.
size_t xml_encode(char * buffer, size_t buflen,
const char * source, size_t srclen);
// Note: in-place decoding (buffer == source) is allowed.
size_t xml_decode(char * buffer, size_t buflen,
const char * source, size_t srclen);
// hex_encode shows the hex representation of binary data in ascii.
size_t hex_encode(char * buffer, size_t buflen,
const char * source, size_t srclen);
size_t hex_decode(char * buffer, size_t buflen,
const char * source, size_t srclen);
// Apply any suitable string transform (including the ones above) to an STL
// string. Stack-allocated temporary space is used for the transformation,
// so value and source may refer to the same string.
typedef size_t (*Transform)(char * buffer, size_t buflen,
const char * source, size_t srclen);
void transform(std::string& value, size_t maxlen, const std::string& source,
Transform t);
// Return the result of applying transform t to source.
std::string s_transform(const std::string& source, Transform t);
// Convenience wrappers
inline std::string s_url_encode(const std::string& source) {
return s_transform(source, url_encode);
}
inline std::string s_url_decode(const std::string& source) {
return s_transform(source, url_decode);
}
// Safe sprintf to std::string
//void sprintf(std::string& value, size_t maxlen, const char * format, ...)
// PRINTF_FORMAT(3);
// Convert arbitrary values to/from a string.
template <class T>
static bool ToString(const T &t, std::string* s) {
std::ostringstream oss;
oss << t;
*s = oss.str();
return !oss.fail();
}
template <class T>
static bool FromString(const std::string& s, T* t) {
std::istringstream iss(s);
iss >> *t;
return !iss.fail();
}
// Inline versions of the string conversion routines.
template<typename T>
static inline std::string ToString(T val) {
std::string str; ToString(val, &str); return str;
}
template<typename T>
static inline T FromString(const std::string& str) {
T val; FromString(str, &val); return val;
}
// simple function to strip out characters which shouldn't be
// used in filenames
char make_char_safe_for_filename(char c);
//////////////////////////////////////////////////////////////////////
} // namespace talk_base
#endif // TALK_BASE_STRINGENCODE_H__
|
