templates/lib/engine.h

/*
  This file is part of the Grantlee template system.

  Copyright (c) 2009,2010 Stephen Kelly <steveire@gmail.com>

  This library 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
  2.1 of the Licence, or (at your option) any later version.

  This library 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 this library.  If not, see <http://www.gnu.org/licenses/>.

*/

#ifndef GRANTLEE_ENGINE_H
#define GRANTLEE_ENGINE_H

#include "template.h"
#include "templateloader.h"

namespace Grantlee
{
class TagLibraryInterface;

class EnginePrivate;


class GRANTLEE_TEMPLATES_EXPORT Engine : public QObject
{
  Q_OBJECT
public:
  Engine(QObject *parent = 0);

  ~Engine() override;

  QList<QSharedPointer<AbstractTemplateLoader>> templateLoaders();

  void addTemplateLoader(QSharedPointer<AbstractTemplateLoader> loader);

  void setPluginPaths(const QStringList &dirs);

  void addPluginPath(const QString &dir);

  void removePluginPath(const QString &dir);

  QStringList pluginPaths() const;

  QPair<QString, QString> mediaUri(const QString &fileName) const;

  Template loadByName(const QString &name) const;

  Template newTemplate(const QString &content, const QString &name) const;

  QStringList defaultLibraries() const;

  void addDefaultLibrary(const QString &libName);

  void removeDefaultLibrary(const QString &libName);

  bool smartTrimEnabled() const;

  void setSmartTrimEnabled(bool enabled);

#ifndef Q_QDOC

  void loadDefaultLibraries();

  TagLibraryInterface *loadLibrary(const QString &name);
#endif

private:
  Q_DECLARE_PRIVATE(Engine)
  EnginePrivate *const d_ptr;
};
}

#endif