templateerror.hpp

/* Copyright (c) 2014-2015, The Nuria Project
 * The NuriaProject Framework is free software: you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the License,
 * or (at your option) any later version.
 * 
 * The NuriaProject Framework 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 Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with The NuriaProject Framework.
 * If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef NURIA_TEMPLATEERROR_HPP
#define NURIA_TEMPLATEERROR_HPP

#include "twig_global.hpp"
#include <QSharedData>
#include <QDebug>

namespace Nuria {

class TemplateErrorPrivate;

namespace Template {

struct NURIA_TWIG_EXPORT Location {
        constexpr Location (int row = 0, int column = 0)
                : row (row), column (column)
        { }
        
        int row;
        
        int column;
        
        bool operator< (const Location &right) const;
        
};

}

class NURIA_TWIG_EXPORT TemplateError {
public:
        
        enum Component {
                None = 0,
                Engine,
                Loader,
                Tokenizer,
                Parser,
                Compiler,
                Renderer
        };
        
        enum Error {
                NoError = 0,
                
                TemplateNotFound = 100,
                
                UnknownToken = 200,
                
                SyntaxError = 300,
                
                BadEndblockName,
                
                NonConstantExpression = 400,
                
                EmptyTemplateName,
                
                NoParentBlock,
                
                InvalidRegularExpression,
                
                InvalidEscapeMode,
                
                NoProgram = 500,
                
                VariableNotSet,
                
        };
        
        TemplateError (Component component = None, Error error = NoError, const QString &what = QString(),
                       Template::Location location = Template::Location ());
        
        TemplateError (const TemplateError &other);
        
        TemplateError (TemplateError &&other);
        
        ~TemplateError ();
        
        TemplateError &operator= (const TemplateError &other);
        
        TemplateError &operator= (TemplateError &&other);
        
        bool hasFailed () const;
        
        Component component () const;
        
        QString componentName () const;
        
        Error error () const;
        
        QString errorName () const;
        
        QString what () const;
        
        Template::Location location () const;
        
        static QString componentName (Component component);
        
        static QString errorName (Error error);
        
private:
        QExplicitlySharedDataPointer< TemplateErrorPrivate > d;
};

}

NURIA_TWIG_EXPORT QDebug operator<< (QDebug dbg, const Nuria::TemplateError &error);

#endif // NURIA_TEMPLATEERROR_HPP