templateprogram.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_TEMPLATEPROGRAM_HPP
#define NURIA_TEMPLATEPROGRAM_HPP

#include <nuria/callback.hpp>
#include "templateerror.hpp"
#include "twig_global.hpp"
#include <QSharedData>
#include <QStringList>

namespace Nuria {

class TemplateProgramPrivate;
class TemplateEngine;

class NURIA_TWIG_EXPORT TemplateProgram {
public:
        
        TemplateProgram ();
        
        TemplateProgram (const TemplateProgram &other);
        
        TemplateProgram &operator= (const TemplateProgram &other);
        
        ~TemplateProgram ();
        
        bool isValid () const;
        
        QStringList dependencies () const;
        
        QStringList neededVariables () const;
        
        QVariant value (const QString &variable) const;
        
        bool setValue (const QString &variable, const QVariant &value);
        
        QLocale locale () const;
        
        void setLocale (const QLocale &locale);
        
        void addFunction (const QString &name, const Callback &function);
        
        bool hasFunction (const QString &name);
        
        bool canRender () const;
        
        QString render ();
        
        TemplateError lastError () const;
        
private:
        friend class TemplateEngine;
        
        TemplateProgram (TemplateProgramPrivate *dptr);
        void refNode ();
        void derefNode ();
        bool checkVariable (int index) const;
        
        QSharedDataPointer< TemplateProgramPrivate > d;
        
};

}

Q_DECLARE_METATYPE(Nuria::TemplateProgram)

#endif // NURIA_TEMPLATEPROGRAM_HPP