aboutsummaryrefslogtreecommitdiff
path: root/vmime-master/src/vmime/utility/encoder/encoderFactory.hpp
blob: e475f8e8f0280cf48ef1bc438d1ed8ee2ec36a8d (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
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
//
// 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_UTILITY_ENCODER_ENCODERFACTORY_HPP_INCLUDED
#define VMIME_UTILITY_ENCODER_ENCODERFACTORY_HPP_INCLUDED


#include "vmime/utility/encoder/encoder.hpp"
#include "vmime/utility/stringUtils.hpp"


namespace vmime {
namespace utility {
namespace encoder {


/** A factory to create 'encoder' objects for the specified encoding.
  */
class VMIME_EXPORT encoderFactory
{
private:

	encoderFactory();
	~encoderFactory();

public:

	static shared_ptr <encoderFactory> getInstance();

	/** Information about a registered encoder. */
	class VMIME_EXPORT registeredEncoder : public object {

	protected:

		virtual ~registeredEncoder() { }

	public:

		virtual shared_ptr <encoder> create() const = 0;

		virtual const string& getName() const = 0;
	};

private:

	template <class E>
	class registeredEncoderImpl : public registeredEncoder {

	public:

		registeredEncoderImpl(const string& name) : m_name(name) { }

		shared_ptr <encoder> create() const {

			return vmime::make_shared <E>();
		}

		const string& getName() const {

			return m_name;
		}

	private:

		const string m_name;
	};


	std::vector <shared_ptr <registeredEncoder> > m_encoders;
	shared_ptr <encoder> m_defaultEncoder;

public:

	/** Register a new encoder by its encoding name.
	  *
	  * @param name encoding name
	  */
	template <class E>
	void registerName(const string& name) {

		m_encoders.push_back(
			vmime::make_shared <registeredEncoderImpl <E> >(utility::stringUtils::toLower(name))
		);
	}

	/** Create a new encoder instance from an encoding name.
	  *
	  * @param name encoding name (eg. "base64")
	  * @return a new encoder instance for the specified encoding
	  * @throw exceptions::no_encoder_available if no encoder is registered
	  * for this encoding
	  */
	shared_ptr <encoder> create(const string& name);

	/** Return information about a registered encoder.
	  *
	  * @param name encoding name
	  * @return information about this encoder
	  * @throw exceptions::no_encoder_available if no encoder is registered
	  * for this encoding
	  */
	const shared_ptr <const registeredEncoder> getEncoderByName(const string& name) const;

	/** Return the number of registered encoders.
	  *
	  * @return number of registered encoders
	  */
	size_t getEncoderCount() const;

	/** Return the registered encoder at the specified position.
	  *
	  * @param pos position of the registered encoder to return
	  * @return registered encoder at the specified position
	  */
	const shared_ptr <const registeredEncoder> getEncoderAt(const size_t pos) const;

	/** Return a list of all registered encoders.
	  *
	  * @return list of registered encoders
	  */
	const std::vector <shared_ptr <const registeredEncoder> > getEncoderList() const;

	/** Set the default encoder to use when no other encoder
	  * is registered for an encoding (fallback).
	  *
	  * @param enc default encoder
	  */
	void setDefaultEncoder(const shared_ptr <encoder>& enc);

	/** Return the default encoder to use when no other encoder
	  * is registered for an encoding (fallback).
	  *
	  * @return default encoder
	  */
	shared_ptr <encoder> getDefaultEncoder() const;
};


} // encoder
} // utility
} // vmime


#endif // VMIME_UTILITY_ENCODER_ENCODERFACTORY_HPP_INCLUDED