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_PARAMETER_HPP_INCLUDED
#define VMIME_PARAMETER_HPP_INCLUDED
#include "vmime/base.hpp"
#include "vmime/component.hpp"
#include "vmime/word.hpp"
namespace vmime {
class VMIME_EXPORT parameter : public component {
friend class parameterizedHeaderField;
private:
parameter(const parameter&);
public:
/** Construct a parameter with no value.
* Charset is set to the current locale charset.
*
* @param name parameter name
*/
parameter(const string& name);
/** Construct a parameter given a name and a value.
*
* @param name parameter name
* @param value parameter value
*/
parameter(const string& name, const word& value);
/** Construct a parameter given a name and a string value
* expressed in the current locale charset.
*
* @param name parameter name
* @param value parameter value
*/
parameter(const string& name, const string& value);
#ifndef VMIME_BUILDING_DOC
/** A single section of a multi-section parameter,
* as defined in RFC-2231/3. This is used when
* calling parse() on the parameter.
*/
struct valueChunk {
bool encoded;
string data;
};
#endif // VMIME_BUILDING_DOC
shared_ptr <component> clone() const;
void copyFrom(const component& other);
parameter& operator=(const parameter& other);
size_t getGeneratedSize(const generationContext& ctx);
const std::vector <shared_ptr <component> > getChildComponents();
/** Return the name of this parameter.
*
* @return name of this parameter
*/
const string& getName() const;
/** Return the raw value of this parameter.
*
* @return read-only value
*/
const word& getValue() const;
/** Return the value of this object in the specified type.
* For example, the following code:
*
* <pre>
* getParameter("creation-date")->getValueAs <vmime::dateTime>()
* </pre>
*
* is equivalent to:
*
* <pre>
* shared_ptr <vmime::word> rawValue = getParameter("creation-date");
*
* vmime::dateTime theDate;
* theDate.parse(rawValue->getBuffer());
* </pre>
*
* @param T type to which convert the value
* @return value
*/
template <typename T>
const T getValueAs() const {
T ret;
ret.parse(m_value->getBuffer());
return ret;
}
/** Set the value of this parameter.
*
* @param value new value
*/
void setValue(const component& value);
/** Set the raw value of this parameter.
*
* @param value new value
*/
void setValue(const word& value);
protected:
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;
private:
void parse(
const parsingContext& ctx,
const std::vector <valueChunk>& chunks
);
string m_name;
shared_ptr <word> m_value;
};
} // vmime
#endif // VMIME_PARAMETER_HPP_INCLUDED
|
