143 lines
4.2 KiB
C++
143 lines
4.2 KiB
C++
//
|
|
// VMime library (http://www.vmime.org)
|
|
// Copyright (C) 2002-2009 Vincent Richard <vincent@vincent-richard.net>
|
|
//
|
|
// 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_ENCODING_HPP_INCLUDED
|
|
#define VMIME_ENCODING_HPP_INCLUDED
|
|
|
|
|
|
#include "vmime/base.hpp"
|
|
#include "vmime/headerFieldValue.hpp"
|
|
|
|
#include "vmime/utility/encoder/encoder.hpp"
|
|
|
|
|
|
namespace vmime
|
|
{
|
|
|
|
|
|
class contentHandler;
|
|
|
|
|
|
/** Content encoding (basic type).
|
|
*/
|
|
|
|
class encoding : public headerFieldValue
|
|
{
|
|
public:
|
|
|
|
enum EncodingUsage
|
|
{
|
|
USAGE_TEXT, /**< Use for body text. */
|
|
USAGE_BINARY_DATA /**< Use for attachment, image... */
|
|
};
|
|
|
|
|
|
encoding();
|
|
explicit encoding(const string& name);
|
|
encoding(const encoding& enc);
|
|
|
|
public:
|
|
|
|
/** Return the name of the encoding.
|
|
* See the constants in vmime::encodingTypes.
|
|
*
|
|
* @return name of the encoding (eg. "quoted-printable")
|
|
*/
|
|
const string& getName() const;
|
|
|
|
/** Set the name of the encoding.
|
|
* See the constants in vmime::encodingTypes.
|
|
*
|
|
* @param name name of the encoding
|
|
*/
|
|
void setName(const string& name);
|
|
|
|
encoding& operator=(const encoding& other);
|
|
encoding& operator=(const string& name);
|
|
|
|
bool operator==(const encoding& value) const;
|
|
bool operator!=(const encoding& value) const;
|
|
|
|
const std::vector <ref <const component> > getChildComponents() const;
|
|
|
|
/** Decide which encoding to use based on the specified data.
|
|
*
|
|
* @param data data used to determine encoding
|
|
* @param usage context of use of data
|
|
* @return suitable encoding for specified data
|
|
*/
|
|
static const encoding decide(ref <const contentHandler> data, const EncodingUsage usage = USAGE_BINARY_DATA);
|
|
|
|
/** Decide which encoding to use based on the specified data and charset.
|
|
*
|
|
* @param data data used to determine encoding
|
|
* @param charset charset of data
|
|
* @param usage context of use of data
|
|
* @return suitable encoding for specified data and charset
|
|
*/
|
|
static const encoding decide(ref <const contentHandler> data, const charset& chset, const EncodingUsage usage = USAGE_BINARY_DATA);
|
|
|
|
|
|
ref <component> clone() const;
|
|
void copyFrom(const component& other);
|
|
|
|
/** Use encoderFactory to obtain an encoder/decoder object
|
|
* for the current encoding type.
|
|
*
|
|
* @throw exceptions::no_encoder_available if no encoder
|
|
* is registered for the encoding
|
|
* @return a new encoder object for the encoding type
|
|
*/
|
|
ref <utility::encoder::encoder> getEncoder() const;
|
|
|
|
private:
|
|
|
|
string m_name;
|
|
|
|
/** Decide which encoding to use based on the specified data.
|
|
*
|
|
* Please note: this will read the whole buffer, so it should be used only
|
|
* for small amount of data (eg. text), and not large binary attachments.
|
|
*
|
|
* @param begin start iterator in buffer
|
|
* @param end end iterator in buffer
|
|
* @return suitable encoding for specified data
|
|
*/
|
|
static const encoding decideImpl(const string::const_iterator begin, const string::const_iterator end);
|
|
|
|
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_ENCODING_HPP_INCLUDED
|