aboutsummaryrefslogtreecommitdiffstats
path: root/src/parameter.hpp
blob: 8e718a26d9d6e69e9d8ad556494cc3901c917921 (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
//
// 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_PARAMETER_HPP_INCLUDED
#define VMIME_PARAMETER_HPP_INCLUDED


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


namespace vmime
{


class parameter : public component
{
	friend class parameterFactory;

public:

	parameter* clone() const;
	void copyFrom(const component& other);
	parameter& operator=(const parameter& other);

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

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

	/** Return the read-only value object attached to this field.
	  *
	  * @return read-only value object
	  */
	virtual const component& getValue() const = 0;

	/** Return the value object attached to this field.
	  *
	  * @return value object
	  */
	virtual component& getValue() = 0;

	/** Set the value of the parameter.
	  *
	  * @throw std::bad_cast_exception if the value type is
	  * incompatible with the parameter type
	  * @param value value object
	  */
	virtual void setValue(const component& value) = 0;

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

	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;

private:

	string m_name;

	void generateValue(utility::outputStream& os, const string::size_type maxLineLength, const string::size_type curLinePos, string::size_type* newLinePos) const;
};


} // vmime


#endif // VMIME_PARAMETER_HPP_INCLUDED