templates/lib/filter.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/>.

*/

// krazy:excludeall=dpointer

#ifndef GRANTLEE_FILTER_H
#define GRANTLEE_FILTER_H

#include "grantlee_templates_export.h"
#include "outputstream.h"
#include "safestring.h"

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

namespace Grantlee
{


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

#ifndef Q_QDOC

  void setStream(OutputStream *stream);
#endif

  SafeString escape(const QString &input) const;

  SafeString escape(const SafeString &input) const;

  SafeString conditionalEscape(const SafeString &input) const;

  virtual QVariant doFilter(const QVariant &input,
                            const QVariant &argument = QVariant(),
                            bool autoescape = false) const = 0;

  virtual bool isSafe() const;

private:
#ifndef Q_QDOC
  OutputStream *m_stream;
#endif
};
}

#endif