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
167
168
169
170
171
172
173
174
175
176
|
//
// VMime library (http://www.vmime.org)
// Copyright (C) 2002 Vincent Richard <vincent@vmime.org>
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License as
// published by the Free Software Foundation; either version 3 of
// the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
// Linking this library statically or dynamically with other modules is making
// a combined work based on this library. Thus, the terms and conditions of
// the GNU General Public License cover the whole combination.
//
#ifndef VMIME_CHARSET_HPP_INCLUDED
#define VMIME_CHARSET_HPP_INCLUDED
#include "vmime/base.hpp"
#include "vmime/utility/inputStream.hpp"
#include "vmime/utility/outputStream.hpp"
#include "vmime/charsetConverterOptions.hpp"
#include "vmime/component.hpp"
namespace vmime {
class encoding; // forward reference
/** Charset description (basic type).
*/
class VMIME_EXPORT charset : public component {
public:
charset();
charset(const string& name);
charset(const char* name); // to allow creation from vmime::charsets constants
public:
/** Return the ISO name of the charset.
*
* @return charset name
*/
const string& getName() const;
charset& operator=(const charset& other);
bool operator==(const charset& value) const;
bool operator!=(const charset& value) const;
const std::vector <shared_ptr <component> > getChildComponents();
/** Gets the recommended encoding for this charset.
* Note: there may be no recommended encoding.
*
* @param enc output parameter that will hold recommended encoding
* @return true if an encoding is recommended (the encoding is stored
* in the enc parameter), false otherwise (in this case, the enc
* parameter is not modified)
*/
bool getRecommendedEncoding(encoding& enc) const;
/** Returns the default charset used on the system.
*
* This function simply calls <code>platformHandler::getLocalCharset()</code>
* and is provided for convenience.
*
* @return system default charset
*/
static const charset getLocalCharset();
/** Convert a string buffer from one charset to another
* charset (in-memory conversion)
*
* \deprecated Use the new convert() method, which takes
* an outputStream parameter.
*
* @param in input buffer
* @param out output buffer
* @param source input charset
* @param dest output charset
* @param opts conversion options
* @throws exceptions::illegal_byte_sequence_for_charset if an illegal
* byte sequence was found in the input bytes, and the
* 'silentlyReplaceInvalidSequences' flag is set to false in
* the charsetConverterOptions
* @throws exceptions::charset_conv_error if an unexpected error occurred
* during the conversion
*/
static void convert(
const string& in,
string& out,
const charset& source,
const charset& dest,
const charsetConverterOptions& opts = charsetConverterOptions()
);
/** Convert the contents of an input stream in a specified charset
* to another charset and write the result to an output stream.
*
* @param in input stream to read data from
* @param out output stream to write the converted data
* @param source input charset
* @param dest output charset
* @param opts conversion options
* @throws exceptions::illegal_byte_sequence_for_charset if an illegal
* byte sequence was found in the input bytes, and the
* 'silentlyReplaceInvalidSequences' flag is set to false in
* the charsetConverterOptions
* @throws exceptions::charset_conv_error if an unexpected error occurred
* during the conversion
*/
static void convert(
utility::inputStream& in,
utility::outputStream& out,
const charset& source,
const charset& dest,
const charsetConverterOptions& opts = charsetConverterOptions()
);
/** Checks whether the specified text is valid in this charset.
*
* @param text input text
* @param firstInvalidByte if the function returns false, will contain
* the index of the first invalid byte in the string. Can be NULL if
* not used.
* @return true if the text is perfectly valid in this charset,
* or false otherwise (eg. it contains illegal sequences)
*/
bool isValidText(const string& text, string::size_type* firstInvalidByte) const;
shared_ptr <component> clone() const;
void copyFrom(const component& other);
private:
string m_name;
protected:
// Component parsing & assembling
void parseImpl(
const parsingContext& ctx,
const string& buffer,
const size_t position,
const size_t end,
size_t* newPosition = NULL
);
void generateImpl(
const generationContext& ctx,
utility::outputStream& os,
const size_t curLinePos = 0,
size_t* newLinePos = NULL
) const;
};
} // vmime
#endif // VMIME_CHARSET_HPP_INCLUDED
|
