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
177
178
179
180
|
//
// 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_ENCODING_HPP_INCLUDED
#define VMIME_ENCODING_HPP_INCLUDED
#include "vmime/base.hpp"
#include "vmime/headerFieldValue.hpp"
#include "vmime/utility/encoder/encoder.hpp"
namespace vmime {
class contentHandler;
/** Content encoding (basic type).
*/
class VMIME_EXPORT encoding : public headerFieldValue {
public:
enum EncodingUsage {
USAGE_UNKNOWN,
USAGE_TEXT, /**< Use for body text. */
USAGE_BINARY_DATA /**< Use for attachment, image... */
};
encoding();
explicit encoding(const string& name);
encoding(const string& name, const EncodingUsage usage);
encoding(const encoding& enc);
/** Return the name of the encoding.
* See the constants in vmime::encodingTypes.
*
* @return name of the encoding (eg. "quoted-printable")
*/
const string& getName() const;
/** Set the name of the encoding.
* See the constants in vmime::encodingTypes.
*
* @param name name of the encoding
*/
void setName(const string& name);
/** Return the type of contents this encoding is used for.
* See the EncodingUsage enum.
*/
EncodingUsage getUsage() const;
/** Set the type of contents this encoding is used for.
* See the EncodingUsage enum.
*
* @param usage type of contents
*/
void setUsage(const EncodingUsage usage);
encoding& operator=(const encoding& other);
encoding& operator=(const string& name);
bool operator==(const encoding& value) const;
bool operator!=(const encoding& value) const;
const std::vector <shared_ptr <component> > getChildComponents();
/** Decide which encoding to use based on the specified data.
*
* @param data data used to determine encoding
* @param usage context of use of data
* @return suitable encoding for specified data
*/
static const encoding decide(
const shared_ptr <const contentHandler>& data,
const EncodingUsage usage = USAGE_BINARY_DATA
);
/** Decide which encoding to use based on the specified data and charset.
*
* @param data data used to determine encoding
* @param chset charset of data
* @param usage context of use of data
* @return suitable encoding for specified data and charset
*/
static const encoding decide(
const shared_ptr <const contentHandler>& data,
const charset& chset,
const EncodingUsage usage = USAGE_BINARY_DATA
);
shared_ptr <component> clone() const;
void copyFrom(const component& other);
/** Use encoderFactory to obtain an encoder/decoder object
* for the current encoding type.
*
* @throw exceptions::no_encoder_available if no encoder
* is registered for the encoding
* @return a new encoder object for the encoding type
*/
shared_ptr <utility::encoder::encoder> getEncoder() const;
private:
string m_name;
EncodingUsage m_usage;
/** Determine whether data encoded using this encoding should
* be re-encoded if needed.
*
* @return true if data should be re-encoded, false otherwise
*/
bool shouldReencode() const;
/** Decide which encoding to use based on the specified data.
*
* Please note: this will read the whole buffer, so it should be used only
* for small amount of data (eg. text), and not large binary attachments.
*
* @param begin start iterator in buffer
* @param end end iterator in buffer
* @return suitable encoding for specified data
*/
static const encoding decideImpl(
const string::const_iterator begin,
const string::const_iterator end
);
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_ENCODING_HPP_INCLUDED
|
