|
//
// VMime library (http://www.vmime.org)
// Copyright (C) 2002-2013 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_PARAMETERIZEDHEADERFIELD_HPP_INCLUDED
#define VMIME_PARAMETERIZEDHEADERFIELD_HPP_INCLUDED
#include "../vmime/base.hpp"
#include "../vmime/headerFieldFactory.hpp"
#include "../vmime/parameter.hpp"
#include "../vmime/exception.hpp"
namespace vmime
{
/** A header field that can also contain parameters (name=value pairs).
* Parameters can be created using vmime::parameterFactory.
*/
class VMIME_EXPORT parameterizedHeaderField : virtual public headerField
{
friend class vmime::creator; // create ref
protected:
// Protected constructor to prevent the user from creating
// new objects without using 'headerFieldFactory'
parameterizedHeaderField();
public:
~parameterizedHeaderField();
void copyFrom(const component& other);
parameterizedHeaderField& operator=(const parameterizedHeaderField& other);
/** Checks whether (at least) one parameter with this name exists.
*
* @return true if at least one parameter with the specified name
* exists, or false otherwise
*/
bool hasParameter(const string& paramName) const;
/** Find the first parameter that matches the specified name.
* If no parameter is found, an exception is thrown.
*
* @throw exceptions::no_such_parameter if no parameter with this name exists
* @return first parameter with the specified name
*/
ref <parameter> findParameter(const string& paramName) const;
/** Find the first parameter that matches the specified name.
* If no parameter is found, one will be created and inserted into
* the parameter list.
*
* @return first parameter with the specified name or a new field
* if no parameter is found
*/
ref <parameter> getParameter(const string& paramName);
/** Add a parameter at the end of the list.
*
* @param param parameter to append
*/
void appendParameter(ref <parameter> param);
/** Insert a new parameter before the specified parameter.
*
* @param beforeParam parameter before which the new parameter will be inserted
* @param param parameter to insert
* @throw exceptions::no_such_parameter if the parameter is not in the list
*/
void insertParameterBefore(ref <parameter> beforeParam, ref <parameter> param);
/** Insert a new parameter before the specified position.
*
* @param pos position at which to insert the new parameter (0 to insert at
* the beginning of the list)
* @param param parameter to insert
*/
void insertParameterBefore(const size_t pos, ref <parameter> param);
/** Insert a new parameter after the specified parameter.
*
* @param afterParam parameter after which the new parameter will be inserted
* @param param parameter to insert
* @throw exceptions::no_such_parameter if the parameter is not in the list
*/
void insertParameterAfter(ref <parameter> afterParam, ref <parameter> param);
/** Insert a new parameter after the specified position.
*
* @param pos position of the parameter before the new parameter
* @param param parameter to insert
*/
void insertParameterAfter(const size_t pos, ref <parameter> param);
/** Remove the specified parameter from the list.
*
* @param param parameter to remove
* @throw exceptions::no_such_parameter if the parameter is not in the list
*/
void removeParameter(ref <parameter> param);
/** Remove the parameter at the specified position.
*
* @param pos position of the parameter to remove
*/
void removeParameter(const size_t pos);
/** Remove all parameters from the list.
*/
void removeAllParameters();
/** Return the number of parameters in the list.
*
* @return number of parameters
*/
size_t getParameterCount() const;
/** Tests whether the list of parameters is empty.
*
* @return true if there is no parameter, false otherwise
*/
bool isEmpty() const;
/** Return the parameter at the specified position.
*
* @param pos position
* @return parameter at position 'pos'
*/
const ref <parameter> getParameterAt(const size_t pos);
/** Return the parameter at the specified position.
*
* @param pos position
* @return parameter at position 'pos'
*/
const ref <const parameter> getParameterAt(const size_t pos) const;
/** Return the parameter list.
*
* @return list of parameters
*/
const std::vector <ref <const parameter> > getParameterList() const;
/** Return the parameter list.
*
* @return list of parameters
*/
const std::vector <ref <parameter> > getParameterList();
const std::vector <ref <component> > getChildComponents();
private:
std::vector <ref <parameter> > m_params;
protected:
void parseImpl
(const parsingContext& ctx,
const string& buffer,
const string::size_type position,
const string::size_type end,
string::size_type* newPosition = NULL);
void generateImpl
(const generationContext& ctx,
utility::outputStream& os,
const string::size_type curLinePos = 0,
string::size_type* newLinePos = NULL) const;
};
} // vmime
#endif // VMIME_PARAMETERIZEDHEADERFIELD_HPP_INCLUDED
|
By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.
If a file you wish to view isn't highlighted, and is a text file (not binary), please
let us know and we'll add colourisation support for it.
Chris Maunder is the co-founder of
CodeProject and
ContentLab.com, and has been a prominent figure in the software development community for nearly 30 years. Hailing from Australia, Chris has a background in Mathematics, Astrophysics, Environmental Engineering and Defence Research. His programming endeavours span everything from FORTRAN on Super Computers, C++/MFC on Windows, through to to high-load .NET web applications and Python AI applications on everything from macOS to a Raspberry Pi. Chris is a full-stack developer who is as comfortable with SQL as he is with CSS.
In the late 1990s, he and his business partner David Cunningham recognized the need for a platform that would facilitate knowledge-sharing among developers, leading to the establishment of CodeProject.com in 1999. Chris's expertise in programming and his passion for fostering a collaborative environment have played a pivotal role in the success of CodeProject.com. Over the years, the website has grown into a vibrant community where programmers worldwide can connect, exchange ideas, and find solutions to coding challenges. Chris is a prolific contributor to the developer community through his articles and tutorials, and his latest passion project,
CodeProject.AI.
In addition to his work with CodeProject.com, Chris co-founded ContentLab and DeveloperMedia, two projects focussed on helping companies make their Software Projects a success. Chris's roles included Product Development, Content Creation, Client Satisfaction and Systems Automation.