libvmime-dev 0.9.2-5build2 / usr / include / vmime / base.hpp

//
// 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_BASE_HPP_INCLUDED
#define VMIME_BASE_HPP_INCLUDED


#include <string>
#include <vector>
#include <map>
#include <sstream>
#include <cctype>
#include <locale>

#include "vmime/config.hpp"
#include "vmime/types.hpp"
#include "vmime/constants.hpp"


namespace vmime
{
	class text;
	class word;
	class charset;


	// "Null" strings
	extern VMIME_EXPORT const string NULL_STRING;

	extern VMIME_EXPORT const text NULL_TEXT;
	extern VMIME_EXPORT const word NULL_WORD;

#ifndef VMIME_BUILDING_DOC

	// Null pointer
	struct nullPtrType
	{
		template<typename T>
	    operator shared_ptr <T>() { return shared_ptr <T>(); }
	};

	extern nullPtrType VMIME_EXPORT null;

#endif // VMIME_BUILDING_DOC


	//
	// Library name and version
	//

	const string VMIME_EXPORT libname();
	const string VMIME_EXPORT libversion();
	const string VMIME_EXPORT libapi();


	//
	// Helpful functions used for array -> iterator conversion
	//

	template <typename T, size_t N>
	inline T const* cbegin(T const (&array)[N])
	{
		return (array);
	}

	template <typename T, size_t N>
	inline T const* cend(T const (&array)[N])
	{
		return (array + N);
	}

	template <typename T, size_t N>
	inline T* begin(T (&array)[N])
	{
		return (array);
	}

	template <typename T, size_t N>
	inline T* end(T (&array)[N])
	{
		return (array + N);
	}

	template <typename T, size_t N>
	inline size_t count(T const (&/* array */)[N])
	{
		return (N);
	}


	// Copy one vector to another, with type conversion

	template <class T1, class T2>
	void copy_vector(const T1& v1, T2& v2)
	{
		const typename T1::size_type count = v1.size();

		v2.resize(count);

		for (typename T1::size_type i = 0 ; i < count ; ++i)
			v2[i] = v1[i];
	}


	/*

	RFC#2822
	2.1.1. Line Length Limits

	There are two limits that this standard places on the number of
	characters in a line. Each line of characters MUST be no more than
	998 characters, and SHOULD be no more than 78 characters, excluding
	the CRLF.

	The 998 character limit is due to limitations in many implementations
	which send, receive, or store Internet Message Format messages that
	simply cannot handle more than 998 characters on a line. Receiving
	implementations would do well to handle an arbitrarily large number
	of characters in a line for robustness sake. However, there are so
	many implementations which (in compliance with the transport
	requirements of [RFC2821]) do not accept messages containing more
	than 1000 character including the CR and LF per line, it is important
	for implementations not to create such messages.

	The more conservative 78 character recommendation is to accommodate
	the many implementations of user interfaces that display these
	messages which may truncate, or disastrously wrap, the display of
	more than 78 characters per line, in spite of the fact that such
	implementations are non-conformant to the intent of this specification
	(and that of [RFC2821] if they actually cause information to be lost).
	Again, even though this limitation is put on messages, it is encumbant
	upon implementations which display messages to handle an arbitrarily
	large number of characters in a line (certainly at least up to the 998
	character limit) for the sake of robustness.
	*/

	namespace lineLengthLimits
	{
		extern VMIME_EXPORT const size_t infinite;

		enum
		{
			max = 998,
			convenient = 78
		};
	}


	// New line sequence to be used when folding header fields.
	extern VMIME_EXPORT const string NEW_LINE_SEQUENCE;
	extern VMIME_EXPORT const size_t NEW_LINE_SEQUENCE_LENGTH;


	// CR-LF sequence
	extern VMIME_EXPORT const string CRLF;


	// Mime version
	extern VMIME_EXPORT const string SUPPORTED_MIME_VERSION;

	/** Utility classes. */
	namespace utility { }


	/** Constant value with the greatest possible value for an element
	  * of type size_t. The meaning is "infinite" or "until the end".
	  */
	extern VMIME_EXPORT const size_t npos;


	/** Clone helper (using a shared_ptr).
	  * This is an alias for dynamic_pointer_cast <T>(obj->clone()).
	  */
	template <class T>
	shared_ptr <T> clone(shared_ptr <T> obj)
	{
		return dynamic_pointer_cast <T>(obj->clone());
	}

	/** Clone helper (using a const shared_ptr).
	  * This is an alias for dynamic_pointer_cast <T>(obj->clone()).
	  */
	template <class T>
	shared_ptr <T> clone(shared_ptr <const T> obj)
	{
		return dynamic_pointer_cast <T>(obj->clone());
	}

	/** Clone helper (using a const reference).
	  * This is an alias for dynamic_pointer_cast <T>(obj.clone()).
	  */
	template <class T>
	shared_ptr <T> clone(const T& obj)
	{
		return dynamic_pointer_cast <T>(obj.clone());
	}

	/** Downcast helper.
	  * Usage: vmime::dynamicCast <DerivedType>(obj), where 'obj' is of
	  * type Type, and DerivedType is derived from Type.
	  */
	template <class X, class Y>
	shared_ptr <X> dynamicCast(shared_ptr <Y> obj)
	{
		return dynamic_pointer_cast <X, Y>(obj);
	}

	/** Const cast helper.
	  */
	template <class X, class Y>
	shared_ptr <X> constCast(const shared_ptr <Y>& obj)
	{
		return const_pointer_cast <X, Y>(obj);
	}

	/** Inherit from this class to indicate the subclass is not copyable,
	  * ie. you want to prohibit copy construction and copy assignment.
	  */
	class VMIME_EXPORT noncopyable
	{
	protected:

		noncopyable() { }
		virtual ~noncopyable() { }

	private:

		noncopyable(const noncopyable&);
		void operator=(const noncopyable&);
	};

} // vmime


#include "vmime/utility/stream.hpp"


#endif // VMIME_BASE_HPP_INCLUDED