tdepim/libksieve/impl/lexer.h

/*  -*- c++ -*-
    impl/lexer.h

    Internal header file. Subject to change without notice. DO NOT USE.

    This file is part of KSieve,
    the KDE internet mail/usenet news message filtering library.
    Copyright (c) 2003 Marc Mutz <mutz@kde.org>

    KSieve 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.

    KSieve 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

    In addition, as a special exception, the copyright holders give
    permission to link the code of this program 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 __KSIEVE_IMPL_LEXER_H__
#define __KSIEVE_IMPL_LEXER_H__

#include <ksieve/lexer.h>
#include <ksieve/error.h>

#include <tqvaluestack.h>
#include <tqcstring.h>

namespace KSieve {

  class Lexer::Impl {
  public:
    Impl( const char * scursor, const char * send, int options );

    bool ignoreComments() const {
      return mIgnoreComments;
    }

    bool ignoreLineFeeds() const {
      return mIgnoreLF;
    }

    const Error & error() const {
      return mState.error;
    }

    bool atEnd() const {
      return mState.cursor >= mEnd;
    }

    int column() const {
      return mState.cursor - mState.beginOfLine;
    }

    int line() const {
      return mState.line;
    }

    void save() {
      mStateStack.push( mState );
    }

    void restore() {
      mState = mStateStack.pop();
    }

    Lexer::Token nextToken( TQString & tokenValue );

  private:
    /** Cursor must be positioned on the \r or the \n. */
    bool eatCRLF();

    /** Cursor must be positioned after the opening hash (#). If
	parsing is successful, cursor is positioned behind the CRLF
	that ended the comment's line (or past the end). */
    bool parseHashComment( TQString & result, bool reallySave=false );
    
    /** Cursor must be positioned after the opening slash-asterisk */
    bool parseBracketComment( TQString & result, bool reallySave=false );
    
    /** Cursor must be positioned on the opening '/'or '#' */
    bool parseComment( TQString & result, bool reallySave=false );

    /** Eats whitespace, but not comments */
    bool eatWS();

    /** Eats comments and whitespace */
    bool eatCWS();

    /** Cursor must be positioned on the first character */
    bool parseIdentifier( TQString & result );

    /** Cursor must be positioned after the initial ':' */
    bool parseTag( TQString & result );

    /** Cursor must be positioned on the first digit */
    bool parseNumber( TQString & result );

    /** Cursor must be positioned after the "text:" token. */
    bool parseMultiLine( TQString & result );

    /** Cursor must be positioned after the initial " */
    bool parseQuotedString( TQString & result );

    struct State {
      State( const char * s=0 )
	: cursor( s ), line( 0 ), beginOfLine( s ), error() {}
      const char * cursor;
      int line;
      const char * beginOfLine;
      Error error;
    } mState;

    const char * const mEnd;
    const bool mIgnoreComments : 1;
    const bool mIgnoreLF : 1;
    TQValueStack<State> mStateStack;

    const char * beginOfLine() const { return mState.beginOfLine; }

    int _strnicmp( const char * left, const char * right, size_t len ) const {
      return charsLeft() >= len ? qstrnicmp( left, right, len ) : 1 ;
    }

    void clearErrors() { mState.error = Error(); }

    unsigned int charsLeft() const {
      return mEnd - mState.cursor < 0 ? 0 : mEnd - mState.cursor ;
    }
    void makeError( Error::Type e ) {
      makeError( e, line(), column() );
    }
    void makeError( Error::Type e, int errorLine, int errorCol ) {
      mState.error = Error( e, errorLine, errorCol );
    }
    void makeIllegalCharError( char ch );
    void makeIllegalCharError() {
      makeIllegalCharError( *mState.cursor );
    }
    /** Defines the current char to end a line.
	Warning: increases @p mCursor!
    **/
    void newLine() {
      ++mState.line;
      mState.beginOfLine = ++mState.cursor;
    }
    bool skipTo( char c, bool acceptEnd=false ) {
      while( !atEnd() ) {
	if ( *mState.cursor == '\n' || *mState.cursor == '\r' ) {
	  if ( !eatCRLF() ) return false;
	} else if ( *mState.cursor == c ) {
	  return true;
	} else {
	  ++mState.cursor;
	}
      }
      return acceptEnd;
    }
    bool skipToCRLF( bool acceptEnd=true ) {
      for ( ; !atEnd() ; ++mState.cursor )
	if ( *mState.cursor == '\n' || *mState.cursor == '\r' )
	  return eatCRLF();
      return acceptEnd;
    }
    void skipTo8BitEnd() {
      while ( !atEnd() && (signed char)*mState.cursor < 0 )
	++mState.cursor;
    }
    void skipToDelim();
  };

}

#endif // __KSIEVE_IMPL_LEXER_H__