qt-creator/src/libs/cplusplus/SimpleLexer.h

/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** Commercial Usage
**
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
**
** GNU Lesser General Public License Usage
**
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at http://qt.nokia.com/contact.
**
**************************************************************************/
#ifndef CPLUSPLUS_SIMPLELEXER_H
#define CPLUSPLUS_SIMPLELEXER_H

#include <CPlusPlusForwardDeclarations.h>

#include <QString>
#include <QList>

namespace CPlusPlus {

class SimpleLexer;
class Token;

class CPLUSPLUS_EXPORT SimpleToken
{
public:
    SimpleToken(const Token &token);

    SimpleToken()
        : _kind(0)
        , _flags(0)
        , _position(0)
        , _length(0)
    { }

    inline int kind() const
    { return _kind; }

    inline int position() const
    { return _position; }

    inline int length() const
    { return _length; }

    inline int begin() const
    { return _position; }

    inline int end() const
    { return _position + _length; }

    inline bool followsNewline() const
    { return f._newline; }

    inline bool followsWhitespace() const
    { return f._whitespace; }

    inline bool is(int k) const    { return _kind == k; }
    inline bool isNot(int k) const { return _kind != k; }

    bool isLiteral() const;
    bool isOperator() const;
    bool isKeyword() const;
    bool isComment() const;
    bool isObjCAtKeyword() const;
    bool isObjCTypeQualifier() const { return f._objcTypeQualifier; }

    const char *name() const;

    // internal
    inline void setPosition(int position)
    { _position = position; }

public:
    short _kind;
    union {
        short _flags;

        struct {
            unsigned _newline: 1;
            unsigned _whitespace: 1;
            unsigned _objcTypeQualifier: 1;
        } f;
    };

    int _position;
    int _length;

    friend class SimpleLexer;
};

class CPLUSPLUS_EXPORT SimpleLexer
{
public:
    SimpleLexer();
    ~SimpleLexer();

    bool skipComments() const;
    void setSkipComments(bool skipComments);

    bool qtMocRunEnabled() const;
    void setQtMocRunEnabled(bool enabled);

    bool objCEnabled() const;
    void setObjCEnabled(bool onoff);

    QList<SimpleToken> operator()(const QString &text, int state = 0);

    int state() const
    { return _lastState; }

    static int tokenAt(const QList<SimpleToken> &tokens, int offset);
    static SimpleToken tokenAt(const QString &text, int offset, int state, bool qtMocRunEnabled = false);

    static int tokenBefore(const QList<SimpleToken> &tokens, int offset);

private:
    int _lastState;
    bool _skipComments: 1;
    bool _qtMocRunEnabled: 1;
    bool _objCEnabled: 1;
};

} // end of namespace CPlusPlus

#endif // CPLUSPLUS_SIMPLELEXER_H