templateengine.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_TEMPLATEENGINE_HPP
#define NURIA_TEMPLATEENGINE_HPP

#include <nuria/callback.hpp>
#include "twig_global.hpp"
#include <QVariant>
#include <QObject>

#include "templateprogram.hpp"
#include "templateerror.hpp"

namespace Nuria {

class TemplateEnginePrivate;
class TemplateLoader;
class TemplateStack;

class NURIA_TWIG_EXPORT TemplateEngine : public QObject {
        Q_OBJECT
public:
        
        explicit TemplateEngine (QObject *parent = 0);
        
        ~TemplateEngine () override;
        
        QLocale locale () const;
        
        void setLocale (const QLocale &locale);
        
        TemplateLoader *loader () const;
        
        int maxCacheSize () const;
        
        void setMaxCacheSize (int size);
        
        int currentCacheSize () const;
        
        bool isTemplateInCache (const QString &templateName) const;
        
        void setLoader (TemplateLoader *loader);
        
        QVariant value (const QString &name) const;
        
        QVariantMap values () const;
        
        void setValues (const QVariantMap &map);
        
        void mergeValues (const QVariantMap &map);
        
        void setValue (const QString &name, const QVariant &value);
        
        void addFunction (const QString &name, const Callback &function, bool isConstant = false);
        
        bool hasFunction (const QString &name);
        
        TemplateProgram program (const QString &templateName);
        
        QString render (const QString &templateName);
        
        TemplateError lastError () const;
        
        bool isProgramOutdated (const TemplateProgram &program);
        
        void flushCache ();
        
private:
        
        TemplateProgramPrivate *createProgram (const QString &templateName);
        void removeChangedTemplateFromCache (const QString &templateName);
        TemplateProgram updateProgramVariables (const QString &templateName, TemplateProgram *prog);
        void connectToLoaderSignals ();
        
        TemplateEnginePrivate *d_ptr;
        
};

}

#endif // NURIA_TEMPLATEENGINE_HPP