src/xmlpatterns/expr/qemptysequence_p.h
changeset 0 1918ee327afb
child 4 3b1da2848fc7
equal deleted inserted replaced
-1:000000000000 0:1918ee327afb
       
     1 /****************************************************************************
       
     2 **
       
     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
       
     4 ** All rights reserved.
       
     5 ** Contact: Nokia Corporation (qt-info@nokia.com)
       
     6 **
       
     7 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
       
     8 **
       
     9 ** $QT_BEGIN_LICENSE:LGPL$
       
    10 ** No Commercial Usage
       
    11 ** This file contains pre-release code and may not be distributed.
       
    12 ** You may use this file in accordance with the terms and conditions
       
    13 ** contained in the Technology Preview License Agreement accompanying
       
    14 ** this package.
       
    15 **
       
    16 ** GNU Lesser General Public License Usage
       
    17 ** Alternatively, this file may be used under the terms of the GNU Lesser
       
    18 ** General Public License version 2.1 as published by the Free Software
       
    19 ** Foundation and appearing in the file LICENSE.LGPL included in the
       
    20 ** packaging of this file.  Please review the following information to
       
    21 ** ensure the GNU Lesser General Public License version 2.1 requirements
       
    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
       
    23 **
       
    24 ** In addition, as a special exception, Nokia gives you certain additional
       
    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
       
    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
       
    27 **
       
    28 ** If you have questions regarding the use of this file, please contact
       
    29 ** Nokia at qt-info@nokia.com.
       
    30 **
       
    31 **
       
    32 **
       
    33 **
       
    34 **
       
    35 **
       
    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_EmptySequence_H
       
    53 #define Patternist_EmptySequence_H
       
    54 
       
    55 #include "qemptycontainer_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 empty sequence: <tt>()</tt>.
       
    65      *
       
    66      * @author Frans Englich <frans.englich@nokia.com>
       
    67      * @ingroup Patternist_xdm
       
    68      */
       
    69     class EmptySequence : public EmptyContainer
       
    70     {
       
    71     public:
       
    72         /**
       
    73          * @short Creates an EmptySequence that is a replacement for @p
       
    74          * replacementFor.
       
    75          *
       
    76          * @see EmptySequence()
       
    77          */
       
    78         static Expression::Ptr create(const Expression *const replacementFor,
       
    79                                       const StaticContext::Ptr &context);
       
    80 
       
    81 
       
    82         /**
       
    83          * @short Creates an instance of EmptySequence.
       
    84          *
       
    85          * @note In most cases create() should be used, since it takes care of
       
    86          * adjusting source location annotations.
       
    87          *
       
    88          * @see create()
       
    89          */
       
    90         inline EmptySequence()
       
    91         {
       
    92         }
       
    93 
       
    94         virtual QString stringValue() const;
       
    95 
       
    96         /**
       
    97          * @returns always an empty iterator, an instance of EmptyIterator.
       
    98          */
       
    99         virtual Item::Iterator::Ptr evaluateSequence(const DynamicContext::Ptr &) const;
       
   100 
       
   101         /**
       
   102          * @returns always @c null.
       
   103          */
       
   104         virtual Item evaluateSingleton(const DynamicContext::Ptr &) const;
       
   105 
       
   106         /**
       
   107          * Does nothing.
       
   108          */
       
   109         virtual void evaluateToSequenceReceiver(const DynamicContext::Ptr &) const;
       
   110 
       
   111         /**
       
   112          * @returns always @c false.
       
   113          */
       
   114         virtual bool evaluateEBV(const DynamicContext::Ptr &context) const;
       
   115 
       
   116         /**
       
   117          * @returns always CommonSequenceTypes::Empty
       
   118          */
       
   119         virtual ItemType::Ptr type() const;
       
   120 
       
   121         /**
       
   122          * @returns always CommonSequenceTypes::Empty
       
   123          */
       
   124         virtual SequenceType::Ptr staticType() const;
       
   125 
       
   126         virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
       
   127         virtual ID id() const;
       
   128         virtual Properties properties() const;
       
   129     };
       
   130 }
       
   131 
       
   132 QT_END_NAMESPACE
       
   133 
       
   134 QT_END_HEADER
       
   135 
       
   136 #endif