aboutsummaryrefslogtreecommitdiffstats
path: root/src/charset.hpp
blob: 8de7532931e1619e078cd6fac191be683b364a23 (plain)
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
//
// VMime library (http://vmime.sourceforge.net)
// Copyright (C) 2002-2004 Vincent Richard <[email protected]>
//
// 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 2 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., 675 Mass Ave, Cambridge, MA 02139, USA.
//

#ifndef VMIME_CHARSET_HPP_INCLUDED
#define VMIME_CHARSET_HPP_INCLUDED


#include "base.hpp"
#include "component.hpp"


namespace vmime
{


/** Charset description (basic type).
  */

class charset : public component
{
public:

	charset();
	charset(const string& name);

public:

	/** Return the ISO name of the charset.
	  *
	  * @return charset name
	  */
	const string& getName() const;

	charset& operator=(const charset& other);
	charset& operator=(const string& name);

	const bool operator==(const charset& value) const;
	const bool operator!=(const charset& value) const;

	const std::vector <const component*> getChildComponents() const;

	/** Returns the default charset used on the system.
	  *
	  * This function simply calls <code>platformDependantHandler::getLocaleCharset()</code>
	  * and is provided for convenience.
	  *
	  * @return system default charset
	  */
	static const charset getLocaleCharset();

#if VMIME_WIDE_CHAR_SUPPORT
	/** Convert a string buffer in the specified charset to a wide-char
	  * string buffer.
	  *
	  * @param in input buffer
	  * @param out output buffer
	  * @param ch input charset
	  */
	static void decode(const string& in, wstring& out, const charset& ch);

	/** Convert a wide-char string buffer to a string buffer in the
	  * specified charset.
	  *
	  * @param in input buffer
	  * @param out output buffer
	  * @param ch output charset
	  */
	static void encode(const wstring& in, string& out, const charset& ch);
#endif

	/** 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
	  */
	static void convert(const string& in, string& out, const charset& source, const charset& dest);

	/** 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
	  */
	static void convert(utility::inputStream& in, utility::outputStream& out, const charset& source, const charset& dest);

	charset* clone() const;
	void copyFrom(const component& other);

private:

	string m_name;

	template <class STRINGF, class STRINGT>
	static void iconvert(const STRINGF& in, STRINGT& out, const charset& from, const charset& to);

public:

	using component::parse;
	using component::generate;

	// Component parsing & assembling
	void parse(const string& buffer, const string::size_type position, const string::size_type end, string::size_type* newPosition = NULL);
	void generate(utility::outputStream& os, const string::size_type maxLineLength = lineLengthLimits::infinite, const string::size_type curLinePos = 0, string::size_type* newLinePos = NULL) const;
};


} // vmime


#endif // VMIME_CHARSET_HPP_INCLUDED