minilexer.hpp

/* Copyright (c) 2014, The Nuria Project
 * This software is provided 'as-is', without any express or implied
 * warranty. In no event will the authors be held liable for any damages
 * arising from the use of this software.
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *    1. The origin of this software must not be misrepresented; you must not
 *       claim that you wrote the original software. If you use this software
 *       in a product, an acknowledgment in the product documentation would be
 *       appreciated but is not required.
 *    2. Altered source versions must be plainly marked as such, and must not be
 *       misrepresented as being the original software.
 *    3. This notice may not be removed or altered from any source
 *       distribution.
 */

#ifndef NURIA_MINILEXER_HPP
#define NURIA_MINILEXER_HPP

#include "essentials.hpp"
#include <QVariant>
#include <QObject>
#include <QRegExp>

#if (QT_VERSION >= QT_VERSION_CHECK(5, 0, 0))
#include <QRegularExpression>
#endif

namespace Nuria {
class MiniLexerPrivate;

class NURIA_CORE_EXPORT LexerRule {
public:
    inline LexerRule (const QString &name = QString ()) : m_name (name) { }
    inline LexerRule (const char *name) : m_name (QLatin1String (name)) { }
    inline const QString &name () const { return this->m_name; }
    inline void setName (const QString &name) { this->m_name = name; }
private:
    QString m_name;
};

class NURIA_CORE_EXPORT LexerDefinition {
public:
    inline LexerDefinition (const QString &name = QString ()) : m_name (name) { }
    inline LexerDefinition (const char *name) : m_name (QLatin1String (name)) { }
    inline const QString &name () const { return this->m_name; }
    inline void setName (const QString &name) { this->m_name = name; }
private:
    QString m_name;
};

class NURIA_CORE_EXPORT MiniLexer : public QObject {
    Q_OBJECT
public:
    typedef QPair< int, QString > TokenValue;
    typedef QList< TokenValue >  TokenValueList;
    
    explicit MiniLexer (QObject *parent = 0);
    ~MiniLexer ();
    
    Qt::CaseSensitivity matchSensitivity () const;
    
    void setMatchSensitivity (Qt::CaseSensitivity value);
    
    int length () const;
    
    TokenValueList tokenValueList () const;
    
    TokenValue tokenValue (int at) const;
    
    const QString &value (int at) const;
    
    int token (int at) const;
    
    void addRule (const QString &name, const QRegExp &regExp, int token);
    
    void addRule (const QString &name, const QString &string, int token);
    
#if (QT_VERSION >= QT_VERSION_CHECK(5, 0, 0))

    void addRule (const QString &name, const QRegularExpression &regExp, int token);
#endif
    
    void addDefinition (const QString &name, const QVariantList &def);
    
    bool lex (const QString &data);
    
    QString lastError () const;
    
    int errorPosition () const;
    
    bool hasStartDefinition () const;
    
    bool hasRule (const QString &name) const;
    
    bool hasDefinition (const QString &name) const;
    
    static MiniLexer *createInstanceFromDefinition (const QString &definition, QString &error);
    
private:
    
    void chopValueList (int lastValidLength);
    
    bool lexDefinition (const QVariantList &def, const QString &data, int &pos);
    
    // 
    MiniLexerPrivate *d_ptr;
    
};

}

Q_DECLARE_METATYPE(Nuria::LexerRule)
Q_DECLARE_METATYPE(Nuria::LexerDefinition)

#endif // NURIA_MINILEXER_HPP