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 "template.h"
#include "grantlee_core_export.h"
 
#include <QtCore/QSharedPointer>
 
namespace Grantlee
{
 
class AbstractLocalizer;
 
 
class GRANTLEE_CORE_EXPORT AbstractTemplateLoader
{
public:
  typedef QSharedPointer<AbstractTemplateLoader> Ptr;
 
  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 GRANTLEE_CORE_EXPORT FileSystemTemplateLoader : public AbstractTemplateLoader
{
public:
#ifndef Q_QDOC
  typedef QSharedPointer<FileSystemTemplateLoader> Ptr;
#endif
 
  FileSystemTemplateLoader();
 
  virtual ~FileSystemTemplateLoader();
 
  /* reimp */ Template loadByName( const QString &name, Engine const *engine ) const;
 
  /* reimp */ bool canLoadTemplate( const QString &name ) const;
 
  /* reimp */ QPair<QString, QString> getMediaUri( const QString& fileName ) const;
 
  void setTheme( const QString &themeName );
 
  QString themeName() const;
 
  void setTemplateDirs( const QStringList &dirs );
 
  QStringList templateDirs() const;
 
private:
  QString m_themeName;
  QStringList m_templateDirs;
};
 
class LocalizedFileSystemTemplateLoaderPrivate;
 
// ### BIC: Make l10n part of the AbstractTemplateLoader, making this class unneeded.
class GRANTLEE_CORE_EXPORT LocalizedFileSystemTemplateLoader : public FileSystemTemplateLoader
{
public:
#ifndef Q_QDOC
  typedef QSharedPointer<LocalizedFileSystemTemplateLoader> Ptr;
#endif
 
  LocalizedFileSystemTemplateLoader( const AbstractLocalizer::Ptr localizer );
 
  virtual ~LocalizedFileSystemTemplateLoader();
 
  void setTheme( const QString &themeName );
 
  void setTemplateDirs( const QStringList &dirs );
 
private:
  Q_DECLARE_PRIVATE( LocalizedFileSystemTemplateLoader )
  LocalizedFileSystemTemplateLoaderPrivate * const d_ptr;
};
 
 
class GRANTLEE_CORE_EXPORT InMemoryTemplateLoader : public AbstractTemplateLoader
{
public:
#ifndef Q_QDOC
  typedef QSharedPointer<InMemoryTemplateLoader> Ptr;
#endif
 
  InMemoryTemplateLoader();
  virtual ~InMemoryTemplateLoader();
 
  /* reimp */ Template loadByName( const QString &name, Engine const *engine ) const;
 
  /* reimp */ bool canLoadTemplate( const QString &name ) const;
 
  /* reimp */ QPair<QString, QString> getMediaUri( const QString& fileName ) const;
 
  void setTemplate( const QString &name, const QString &content );
 
private:
  QHash<QString, QString> m_namedTemplates;
};
 
}
 
#endif