templates/lib/filterexpression.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_FILTEREXPRESSION_H
#define GRANTLEE_FILTEREXPRESSION_H

#include "variable.h"

#include "grantlee_templates_export.h"

namespace Grantlee
{
class Filter;
class OutputStream;
class Parser;
struct Token;

class FilterExpressionPrivate;


class GRANTLEE_TEMPLATES_EXPORT FilterExpression
{
public:
  FilterExpression();

  FilterExpression(const QString &varString, Grantlee::Parser *parser);

  FilterExpression(const FilterExpression &other);

  ~FilterExpression();

  FilterExpression &operator=(const FilterExpression &other);

  Variable variable() const;

  QVariant resolve(OutputStream *stream, Context *c) const;

  QVariant resolve(Context *c) const;

  bool isTrue(Context *c) const;

  QVariantList toList(Context *c) const;

  bool isValid() const;

#ifndef Q_QDOC

  QStringList filters() const;
#endif

private:
  Q_DECLARE_PRIVATE(FilterExpression)
  FilterExpressionPrivate *const d_ptr;
};
}

#endif