278 lines
8.6 KiB
C++
278 lines
8.6 KiB
C++
//
|
|
// 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_TEXT_HPP_INCLUDED
|
|
#define VMIME_TEXT_HPP_INCLUDED
|
|
|
|
|
|
#include "vmime/headerFieldValue.hpp"
|
|
#include "vmime/base.hpp"
|
|
#include "vmime/word.hpp"
|
|
|
|
|
|
namespace vmime
|
|
{
|
|
|
|
|
|
/** List of encoded-words, as defined in RFC-2047 (basic type).
|
|
*/
|
|
|
|
class VMIME_EXPORT text : public headerFieldValue
|
|
{
|
|
public:
|
|
|
|
text();
|
|
text(const text& t);
|
|
text(const string& t, const charset& ch);
|
|
explicit text(const string& t);
|
|
explicit text(const word& w);
|
|
~text();
|
|
|
|
public:
|
|
|
|
bool operator==(const text& t) const;
|
|
bool operator!=(const text& t) const;
|
|
|
|
shared_ptr <component> clone() const;
|
|
void copyFrom(const component& other);
|
|
text& operator=(const component& other);
|
|
text& operator=(const text& other);
|
|
|
|
const std::vector <shared_ptr <component> > getChildComponents();
|
|
|
|
/** Add a word at the end of the list.
|
|
*
|
|
* @param w word to append
|
|
*/
|
|
void appendWord(shared_ptr <word> w);
|
|
|
|
/** Insert a new word before the specified position.
|
|
*
|
|
* @param pos position at which to insert the new word (0 to insert at
|
|
* the beginning of the list)
|
|
* @param w word to insert
|
|
*/
|
|
void insertWordBefore(const size_t pos, shared_ptr <word> w);
|
|
|
|
/** Insert a new word after the specified position.
|
|
*
|
|
* @param pos position of the word before the new word
|
|
* @param w word to insert
|
|
*/
|
|
void insertWordAfter(const size_t pos, shared_ptr <word> w);
|
|
|
|
/** Remove the word at the specified position.
|
|
*
|
|
* @param pos position of the word to remove
|
|
*/
|
|
void removeWord(const size_t pos);
|
|
|
|
/** Remove all words from the list.
|
|
*/
|
|
void removeAllWords();
|
|
|
|
/** Return the number of words in the list.
|
|
*
|
|
* @return number of words
|
|
*/
|
|
size_t getWordCount() const;
|
|
|
|
/** Tests whether the list of words is empty.
|
|
*
|
|
* @return true if there is no word, false otherwise
|
|
*/
|
|
bool isEmpty() const;
|
|
|
|
/** Return the word at the specified position.
|
|
*
|
|
* @param pos position
|
|
* @return word at position 'pos'
|
|
*/
|
|
const shared_ptr <word> getWordAt(const size_t pos);
|
|
|
|
/** Return the word at the specified position.
|
|
*
|
|
* @param pos position
|
|
* @return word at position 'pos'
|
|
*/
|
|
const shared_ptr <const word> getWordAt(const size_t pos) const;
|
|
|
|
/** Return the word list.
|
|
*
|
|
* @return list of words
|
|
*/
|
|
const std::vector <shared_ptr <const word> > getWordList() const;
|
|
|
|
/** Return the word list.
|
|
*
|
|
* @return list of words
|
|
*/
|
|
const std::vector <shared_ptr <word> > getWordList();
|
|
|
|
|
|
/** Return the text converted into the specified charset.
|
|
* The encoded-words are decoded and then converted in the
|
|
* specified destination charset.
|
|
*
|
|
* @param dest output charset
|
|
* @param opts options for charset conversion
|
|
* @return text decoded in the specified charset
|
|
*/
|
|
const string getConvertedText(const charset& dest,
|
|
const charsetConverterOptions& opts = charsetConverterOptions()) const;
|
|
|
|
/** Return the unconverted (raw) data of all words. This is the
|
|
* concatenation of the results returned by getBuffer() on
|
|
* the contained words.
|
|
*
|
|
* @return raw data
|
|
*/
|
|
const string getWholeBuffer() const;
|
|
|
|
/** This function can be used to make several encoded words from a text.
|
|
* All the characters in the text must be in the same specified charset.
|
|
*
|
|
* <p>Eg: giving:</p>
|
|
* <pre> <iso-8859-1> "Linux dans un t'el'ephone mobile"
|
|
* ("=?iso-8859-1?Q?Linux_dans_un_t=E9l=E9phone_mobile?=")
|
|
* </pre><p>it will return:</p>
|
|
* <pre> <us-ascii> "Linux dans un "
|
|
* <iso-8859-1> "t'el'ephone "
|
|
* <us-ascii> "mobile"
|
|
* ("Linux dans un =?iso-8859-1?Q?t=E9l=E9phone_?= mobile")
|
|
* </pre>
|
|
*
|
|
* @param in input string
|
|
* @param ch input charset
|
|
* @return new text object
|
|
*/
|
|
static shared_ptr <text> newFromString(const string& in, const charset& ch);
|
|
|
|
/** This function can be used to make several encoded words from a text.
|
|
* All the characters in the text must be in the same specified charset.
|
|
*
|
|
* <p>Eg: giving:</p>
|
|
* <pre> <iso-8859-1> "Linux dans un t'el'ephone mobile"
|
|
* ("=?iso-8859-1?Q?Linux_dans_un_t=E9l=E9phone_mobile?=")
|
|
* </pre><p>it will return:</p>
|
|
* <pre> <us-ascii> "Linux dans un "
|
|
* <iso-8859-1> "t'el'ephone "
|
|
* <us-ascii> "mobile"
|
|
* ("Linux dans un =?iso-8859-1?Q?t=E9l=E9phone_?= mobile")
|
|
* </pre>
|
|
*
|
|
* @param in input string
|
|
* @param ch input charset
|
|
*/
|
|
void createFromString(const string& in, const charset& ch);
|
|
|
|
/** Flags used by "encodeAndFold" function.
|
|
*/
|
|
enum EncodeAndFoldFlags
|
|
{
|
|
// NOTE: If both "FORCE_NO_ENCODING" and "FORCE_ENCODING" are
|
|
// specified, "FORCE_NO_ENCODING" is used by default.
|
|
|
|
FORCE_NO_ENCODING = (1 << 0), /**< Just fold lines, don't encode them. */
|
|
FORCE_ENCODING = (1 << 1), /**< Encode lines even if they are plain ASCII text. */
|
|
NO_NEW_LINE_SEQUENCE = (1 << 2), /**< Use CRLF instead of new-line sequence (CRLF + TAB). */
|
|
QUOTE_IF_POSSIBLE = (1 << 3), /**< Use quoting instead of encoding when possible (even if FORCE_ENCODING is specified). */
|
|
QUOTE_IF_NEEDED = (1 << 4) /**< Use quoting instead of encoding if needed (eg. whitespaces and/or special chars). */
|
|
};
|
|
|
|
/** Encode and fold text in respect to RFC-2047.
|
|
*
|
|
* @param ctx generation context
|
|
* @param os output stream
|
|
* @param firstLineOffset the first line length (may be useful if the current output line is not empty)
|
|
* @param lastLineLength will receive the length of the last line written
|
|
* @param flags encoding flags (see EncodeAndFoldFlags)
|
|
*/
|
|
void encodeAndFold(const generationContext& ctx, utility::outputStream& os,
|
|
const size_t firstLineOffset, size_t* lastLineLength, const int flags) const;
|
|
|
|
/** Decode and unfold text (RFC-2047), using the default parsing context.
|
|
*
|
|
* @param in input string
|
|
* @return new text object
|
|
*/
|
|
static shared_ptr <text> decodeAndUnfold(const string& in);
|
|
|
|
/** Decode and unfold text (RFC-2047).
|
|
*
|
|
* @param ctx parsingContext
|
|
* @param in input string
|
|
* @return new text object
|
|
*/
|
|
static shared_ptr <text> decodeAndUnfold(const parsingContext& ctx, const string& in);
|
|
|
|
/** Decode and unfold text (RFC-2047), using the default parsing context.
|
|
*
|
|
* @param in input string
|
|
* @param generateInExisting if not NULL, the resulting text will be generated
|
|
* in the specified object instead of a new created object (in this case, the
|
|
* function returns the same pointer). Can be used to avoid copying the
|
|
* resulting object into an existing object.
|
|
* @return new text object or existing object if generateInExisting != NULL
|
|
*/
|
|
static text* decodeAndUnfold(const string& in, text* generateInExisting);
|
|
|
|
/** Decode and unfold text (RFC-2047).
|
|
*
|
|
* @param ctx parsing context
|
|
* @param in input string
|
|
* @param generateInExisting if not NULL, the resulting text will be generated
|
|
* in the specified object instead of a new created object (in this case, the
|
|
* function returns the same pointer). Can be used to avoid copying the
|
|
* resulting object into an existing object.
|
|
* @return new text object or existing object if generateInExisting != NULL
|
|
*/
|
|
static text* decodeAndUnfold(const parsingContext& ctx, const string& in, text* generateInExisting);
|
|
|
|
protected:
|
|
|
|
// Component parsing & assembling
|
|
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:
|
|
|
|
std::vector <shared_ptr <word> > m_words;
|
|
};
|
|
|
|
|
|
} // vmime
|
|
|
|
|
|
#endif // VMIME_TEXT_HPP_INCLUDED
|