summaryrefslogtreecommitdiffstats
path: root/libkmime/kmime_header_parsing.h
diff options
context:
space:
mode:
Diffstat (limited to 'libkmime/kmime_header_parsing.h')
-rw-r--r--libkmime/kmime_header_parsing.h196
1 files changed, 196 insertions, 0 deletions
diff --git a/libkmime/kmime_header_parsing.h b/libkmime/kmime_header_parsing.h
new file mode 100644
index 000000000..326a7e1ba
--- /dev/null
+++ b/libkmime/kmime_header_parsing.h
@@ -0,0 +1,196 @@
+/* -*- c++ -*-
+ kmime_header_parsing.h
+
+ This file is part of KMime, the KDE internet mail/usenet news message library.
+ Copyright (c) 2001-2002 Marc Mutz <mutz@kde.org>
+
+ KMime is free software; you can redistribute it and/or modify it
+ under the terms of the GNU General Public License, version 2, as
+ published by the Free Software Foundation.
+
+ KMime 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 library; if not, write to the Free Software
+ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+
+ In addition, as a special exception, the copyright holders give
+ permission to link the code of this library with any edition of
+ the Qt library by Trolltech AS, Norway (or with modified versions
+ of Qt that use the same license as Qt), and distribute linked
+ combinations including the two. You must obey the GNU General
+ Public License in all respects for all of the code used other than
+ Qt. If you modify this file, you may extend this exception to
+ your version of the file, but you are not obligated to do so. If
+ you do not wish to do so, delete this exception statement from
+ your version.
+*/
+
+#ifndef __KMIME_HEADER_PARSING_H__
+#define __KMIME_HEADER_PARSING_H__
+
+#include <qstring.h>
+#include <qpair.h>
+#include <qvaluelist.h>
+
+#include <time.h>
+
+#include <kdepimmacros.h>
+
+template <typename K, typename V> class QMap;
+class QStringList;
+
+namespace KMime {
+
+namespace Types {
+
+ // for when we can't make up our mind what to use...
+ struct KDE_EXPORT QStringOrQPair {
+ QStringOrQPair() : qstring(), qpair(0,0) {}
+ QString qstring;
+ QPair<const char*,int> qpair;
+ };
+
+ struct KDE_EXPORT AddrSpec {
+ QString asString() const;
+ QString localPart;
+ QString domain;
+ };
+ typedef QValueList<AddrSpec> AddrSpecList;
+
+ struct KDE_EXPORT Mailbox {
+ QString displayName;
+ AddrSpec addrSpec;
+ };
+ typedef QValueList<Mailbox> MailboxList;
+
+ struct KDE_EXPORT Address {
+ QString displayName;
+ MailboxList mailboxList;
+ };
+ typedef QValueList<Address> AddressList;
+
+ struct KDE_EXPORT DateTime {
+ time_t time; // secs since 1.1.1970, 0:00 UTC/GMT
+ long int secsEastOfGMT; // timezone
+ bool timeZoneKnown; // do we know the timezone? (e.g. on -0000)
+ };
+
+} // namespace KMime::Types
+
+namespace HeaderParsing {
+
+ /** Parse the encoded word in @p str pointed to by @p pos
+ (actually, @p pos-2, see below).
+
+ @param str the source string
+ @param pos in: the starting position (must already point to the
+ character following the initial '=?';
+ out: the new postion
+ @param ok only out: if true, the encoded-word was correct up
+ to and including the encoding specifier. The
+ encoded-text is quite generously parsed and @p ok
+ is still set to @p true when e.g. the encoded-word
+ appears to be truncated or contains whitespace.
+ @return the decoded string the encoded word represented.
+ */
+ bool parseEncodedWord( const char* & scursor, const char * const send,
+ QString & result, QCString & language ) KDE_EXPORT;
+ //
+ // The parsing squad:
+ //
+
+ /** You may or may not have already started parsing into the
+ atom. This function will go on where you left off. */
+ bool parseAtom( const char* & scursor, const char * const send,
+ QString & result, bool allow8Bit=false ) KDE_EXPORT;
+ bool parseAtom( const char* & scursor, const char * const send,
+ QPair<const char*,int> & result, bool allow8Bit=false ) KDE_EXPORT;
+ /** You may or may not have already started parsing into the
+ token. This function will go on where you left off. */
+ bool parseToken( const char* & scursor, const char * const send,
+ QString & result, bool allow8Bit=false ) KDE_EXPORT;
+ bool parseToken( const char* & scursor, const char * const send,
+ QPair<const char*,int> & result, bool allow8Bit=false ) KDE_EXPORT;
+ /** @p scursor must be positioned after the opening openChar. */
+ bool parseGenericQuotedString( const char* & scursor, const char* const send,
+ QString & result, bool isCRLF,
+ const char openChar='"',
+ const char closeChar='"' ) KDE_EXPORT;
+ /** @p scursor must be positioned right after the opening '(' */
+ bool parseComment( const char* & scursor, const char * const send,
+ QString & result, bool isCRLF=false, bool reallySave=true ) KDE_EXPORT;
+ /** You may or may not have already started parsing into the phrase,
+ but only if it starts with atext. If you setup this function to
+ parse a phrase starting with an encoded-word or quoted-string,
+ @p scursor has to point to the char introducing the encoded-word
+ or quoted-string, resp. */
+ bool parsePhrase( const char* & scursor, const char * const send,
+ QString & result, bool isCRLF=false ) KDE_EXPORT;
+ /** You may or may not have already started parsing into the initial
+ atom, but not up to it's end. */
+ bool parseDotAtom( const char* & scursor, const char * const send,
+ QString & result, bool isCRLF=false ) KDE_EXPORT;
+
+ /** Eats comment-folding-white-space, skips whitespace, folding and
+ comments (even nested ones) and stops at the next non-CFWS
+ character. After calling this function, you should check whether
+ @p scursor == @p send (end of header reached).
+
+ If a comment with unbalanced parantheses is encountered, @p
+ scursor is being positioned on the opening '(' of the outmost
+ comment.
+ */
+ void eatCFWS( const char* & scursor, const char * const send, bool isCRLF ) KDE_EXPORT;
+
+ bool parseDomain( const char* & scursor, const char * const send,
+ QString & result, bool isCRLF=false ) KDE_EXPORT;
+ bool parseObsRoute( const char* & scursor, const char * const send,
+ QStringList & result,
+ bool isCRLF=false, bool save=false ) KDE_EXPORT;
+ bool parseAddrSpec( const char* & scursor, const char * const send,
+ Types::AddrSpec & result, bool isCRLF=false ) KDE_EXPORT;
+ bool parseAngleAddr( const char* & scursor, const char * const send,
+ Types::AddrSpec & result, bool isCRLF=false ) KDE_EXPORT;
+ bool parseMailbox( const char* & scursor, const char * const send,
+ Types::Mailbox & result, bool isCRLF=false ) KDE_EXPORT;
+ bool parseGroup( const char* & scursor, const char * const send,
+ Types::Address & result, bool isCRLF=false ) KDE_EXPORT;
+ bool parseAddress( const char* & scursor, const char * const send,
+ Types::Address & result, bool isCRLF=false ) KDE_EXPORT;
+ bool parseAddressList( const char* & scursor, const char * const send,
+ Types::AddressList & result, bool isCRLF=false ) KDE_EXPORT;
+
+ bool parseParameter( const char* & scursor, const char * const send,
+ QPair<QString,Types::QStringOrQPair> & result,
+ bool isCRLF=false ) KDE_EXPORT;
+ bool parseParameterList( const char* & scursor, const char * const send,
+ QMap<QString,QString> & result, bool isCRLF=false ) KDE_EXPORT;
+
+ bool parseRawParameterList( const char* & scursor, const char * const send,
+ QMap<QString,Types::QStringOrQPair> & result,
+ bool isCRLF=false ) KDE_EXPORT;
+
+ bool parseTime( const char* & scursor, const char * const send,
+ int & hour, int & min, int & sec, long int & secsEastOfGMT,
+ bool & timeZoneKnown, bool isCRLF=false ) KDE_EXPORT;
+
+ bool parseDateTime( const char* & scursor, const char * const send,
+ Types::DateTime & result, bool isCRLF=false ) KDE_EXPORT;
+
+#if 0
+ bool tryToMakeAnySenseOfDateString( const char* & scursor,
+ const char * const send,
+ time_t & result, bool isCRLF=false );
+#endif
+
+} // namespace HeaderParsing
+
+} // namespace KMime
+
+
+#endif // __KMIME_HEADER_PARSING_H__
+