templates/lib/template.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_TEMPLATE_H
#define GRANTLEE_TEMPLATE_H

#include "exception.h"
#include "grantlee_templates_export.h"
#include "node.h"

#include <QtCore/QSharedPointer>
#include <QtCore/QStringList>

namespace Grantlee
{
class Context;
class Engine;
class TemplateImpl;
class OutputStream;

#ifdef Q_QDOC
#define TemplateImpl Template
#else
typedef QSharedPointer<TemplateImpl> Template;
#endif

class TemplatePrivate;


class GRANTLEE_TEMPLATES_EXPORT TemplateImpl : public QObject
{
  Q_OBJECT
public:
  ~TemplateImpl() override;

  QString render(Context *c) const;

  OutputStream *render(OutputStream *stream, Context *c) const;

#ifndef Q_QDOC

  NodeList nodeList() const;

  void setNodeList(const NodeList &list);
#endif

  Error error() const;

  QString errorString() const;

  Engine const *engine() const;

#ifndef Q_QDOC
protected:
  TemplateImpl(Engine const *engine, QObject *parent = 0);
  TemplateImpl(Engine const *engine, bool smartTrim, QObject *parent = 0);

  void setContent(const QString &templateString);
#endif

private:
  // Don't allow setting the parent on a Template, which is memory managed as
  // a
  // QSharedPointer.
  using QObject::setParent;

private:
  Q_DECLARE_PRIVATE(Template)
  TemplatePrivate *const d_ptr;
#ifndef Q_QDOC
  friend class Engine;
  friend class Parser;
#endif
};
}

#endif