src/xmlpatterns/data/qboolean_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   5 **
   6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** Commercial License Usage
  10 ** Licensees holding valid commercial Qt licenses may use this file in
  11 ** accordance with the commercial license agreement provided with the
  12 ** Software or, alternatively, in accordance with the terms contained in
  13 ** a written agreement between you and Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/contact-us.
  16 **
  17 ** GNU Lesser General Public License Usage
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 //
  43 //  W A R N I N G
  44 //  -------------
  45 //
  46 // This file is not part of the Qt API.  It exists purely as an
  47 // implementation detail.  This header file may change from version to
  48 // version without notice, or even be removed.
  49 //
  50 // We mean it.
  51
  52 #ifndef Patternist_Boolean_H
  53 #define Patternist_Boolean_H
  54
  55 #include <private/qitem_p.h>
  56
  57 QT_BEGIN_HEADER
  58
  59 QT_BEGIN_NAMESPACE
  60
  61 namespace QPatternist
  62 {
  63     /**
  64      * @short Implements the value instance of the @c xs:boolean type.
  65      *
  66      * @author Frans Englich <frans.englich@nokia.com>
  67      * @ingroup Patternist_xdm
  68      */
  69     class Q_AUTOTEST_EXPORT Boolean : public AtomicValue
  70     {
  71     public:
  72         typedef AtomicValue::Ptr Ptr;
  73
  74         /**
  75          * @returns the boolean value this Boolean represents
  76          */
  77         static bool evaluateEBV(const Item::Iterator::Ptr &e,
  78                                 const QExplicitlySharedDataPointer<DynamicContext> &);
  79
  80         static bool evaluateEBV(const Item &first,
  81                                 const Item::Iterator::Ptr &e,
  82                                 const QExplicitlySharedDataPointer<DynamicContext> &);
  83
  84         static bool evaluateEBV(const Item &item,
  85                                 const QExplicitlySharedDataPointer<DynamicContext> &context);
  86
  87         virtual QString stringValue() const;
  88
  89         /**
  90          * @returns a Boolean object instantiating @p value. Use True() or False()
  91          * if you already know what value you need.
  92          */
  93         static Boolean::Ptr fromValue(const bool value);
  94
  95         /**
  96          * Creates a boolean value from a lexical representation. "true" and "1"
  97          * becomes @c true, while "false" and "0" becomes @c false.
  98          */
  99         static AtomicValue::Ptr fromLexical(const QString &val);
 100
 101         /**
 102          * Get the Effective %Boolean Value of this boolean value. For <tt>xs:boolean</tt>, this
 103          * is simply the value.
 104          */
 105         virtual bool evaluateEBV(const QExplicitlySharedDataPointer<DynamicContext> &) const;
 106
 107         virtual ItemType::Ptr type() const;
 108
 109         inline bool value() const
 110         {
 111             return m_value;
 112         }
 113
 114     protected:
 115         friend class CommonValues;
 116         Boolean(const bool value);
 117
 118     private:
 119         const bool m_value;
 120     };
 121 }
 122
 123 QT_END_NAMESPACE
 124 QT_END_HEADER
 125
 126 #endif