templates/lib/templateloader.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_TEMPLATELOADER_H
#define GRANTLEE_TEMPLATELOADER_H

#include "grantlee_templates_export.h"
#include "template.h"

#include <QtCore/QSharedPointer>

namespace Grantlee
{

class AbstractLocalizer;


class GRANTLEE_TEMPLATES_EXPORT AbstractTemplateLoader
{
public:
  virtual ~AbstractTemplateLoader();

  virtual Template loadByName(const QString &name,
                              Engine const *engine) const = 0;

  virtual QPair<QString, QString>
  getMediaUri(const QString &fileName) const = 0;

  virtual bool canLoadTemplate(const QString &name) const = 0;
};


class FileSystemTemplateLoaderPrivate;

class GRANTLEE_TEMPLATES_EXPORT FileSystemTemplateLoader
    : public AbstractTemplateLoader
{
public:
  FileSystemTemplateLoader(const QSharedPointer<AbstractLocalizer> localizer
                           = QSharedPointer<AbstractLocalizer>());

  ~FileSystemTemplateLoader() override;

  Template loadByName(const QString &name, Engine const *engine) const override;

  bool canLoadTemplate(const QString &name) const override;

  QPair<QString, QString> getMediaUri(const QString &fileName) const override;

  void setTheme(const QString &themeName);

  QString themeName() const;

  void setTemplateDirs(const QStringList &dirs);

  QStringList templateDirs() const;

private:
  Q_DECLARE_PRIVATE(FileSystemTemplateLoader)
  FileSystemTemplateLoaderPrivate *const d_ptr;
};


class GRANTLEE_TEMPLATES_EXPORT InMemoryTemplateLoader
    : public AbstractTemplateLoader
{
public:
  InMemoryTemplateLoader();
  ~InMemoryTemplateLoader() override;

  Template loadByName(const QString &name, Engine const *engine) const override;

  bool canLoadTemplate(const QString &name) const override;

  QPair<QString, QString> getMediaUri(const QString &fileName) const override;

  void setTemplate(const QString &name, const QString &content);

private:
  QHash<QString, QString> m_namedTemplates;
};
}

#endif