src/xmlpatterns/parser/qtokensource_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_TokenSource_H
       
    53 #define Patternist_TokenSource_H
       
    54 
       
    55 #include "qatomiccomparator_p.h"
       
    56 #include "qatomicmathematician_p.h"
       
    57 #include "qcombinenodes_p.h"
       
    58 #include "qfunctionargument_p.h"
       
    59 #include "qitem_p.h"
       
    60 #include "qitemtype_p.h"
       
    61 #include "qorderby_p.h"
       
    62 #include "qpath_p.h"
       
    63 #include "qquerytransformparser_p.h"
       
    64 #include "qvalidate_p.h"
       
    65 
       
    66 QT_BEGIN_HEADER
       
    67 
       
    68 QT_BEGIN_NAMESPACE
       
    69 
       
    70 template<typename T> class QQueue;
       
    71 
       
    72 namespace QPatternist
       
    73 {
       
    74     /**
       
    75      * @short A union of all the enums the parser uses.
       
    76      */
       
    77     union EnumUnion
       
    78     {
       
    79         AtomicComparator::Operator              valueOperator;
       
    80         AtomicMathematician::Operator           mathOperator;
       
    81         CombineNodes::Operator                  combinedNodeOp;
       
    82         QXmlNodeModelIndex::Axis                axis;
       
    83         QXmlNodeModelIndex::DocumentOrder       nodeOperator;
       
    84         StaticContext::BoundarySpacePolicy      boundarySpacePolicy;
       
    85         StaticContext::ConstructionMode         constructionMode;
       
    86         StaticContext::OrderingEmptySequence    orderingEmptySequence;
       
    87         StaticContext::OrderingMode             orderingMode;
       
    88         OrderBy::OrderSpec::Direction           sortDirection;
       
    89         Validate::Mode                          validationMode;
       
    90         VariableSlotID                          slot;
       
    91         int                                     tokenizerPosition;
       
    92         qint16                                  zeroer;
       
    93         bool                                    Bool;
       
    94         xsDouble                                Double;
       
    95         Path::Kind                              pathKind;
       
    96     };
       
    97 
       
    98     /**
       
    99      * @short Base class for components that needs to return tokens.
       
   100      *
       
   101      * TokenSource represents a stream of Token instances. The end
       
   102      * is reached when readNext() returns a Token constructed with
       
   103      * END_OF_FILE.
       
   104      *
       
   105      * @see <a href="http://www.w3.org/TR/xquery-xpath-parsing/">Building a
       
   106      * Tokenizer for XPath or XQuery</a>
       
   107      * @author Frans Englich <frans.englich@nokia.com>
       
   108      */
       
   109     class TokenSource : public QSharedData
       
   110     {
       
   111     public:
       
   112         /**
       
   113          * typedef for the enum Bison generates that contains
       
   114          * the token symbols.
       
   115          */
       
   116         typedef yytokentype TokenType;
       
   117 
       
   118         /**
       
   119          * Represents a token by carrying its name and value.
       
   120          */
       
   121         class Token
       
   122         {
       
   123         public:
       
   124             /**
       
   125              * Constructs an invalid Token. This default constructor
       
   126              * is need in Qt's container classes.
       
   127              */
       
   128             inline Token() {}
       
   129             inline Token(const TokenType t) : type(t) {}
       
   130             inline Token(const TokenType t, const QString &val) : type(t), value(val) {}
       
   131 
       
   132             bool hasError() const
       
   133             {
       
   134                 return type == ERROR;
       
   135             }
       
   136 
       
   137             TokenType type;
       
   138             QString value;
       
   139         };
       
   140 
       
   141         typedef QExplicitlySharedDataPointer<TokenSource> Ptr;
       
   142         typedef QQueue<Ptr> Queue;
       
   143 
       
   144         /**
       
   145          * The C++ compiler cannot synthesize it when we use the
       
   146          * Q_DISABLE_COPY() macro.
       
   147          */
       
   148         inline TokenSource()
       
   149         {
       
   150         }
       
   151 
       
   152         virtual ~TokenSource();
       
   153 
       
   154         /**
       
   155          * @returns the next token.
       
   156          */
       
   157 
       
   158             virtual Token nextToken(YYLTYPE *const sourceLocator) = 0;
       
   159 
       
   160     private:
       
   161         Q_DISABLE_COPY(TokenSource)
       
   162     };
       
   163 }
       
   164 
       
   165 QT_END_NAMESPACE
       
   166 
       
   167 QT_END_HEADER
       
   168 
       
   169 #endif