src/xmlpatterns/expr/qtemplatemode_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_TemplateMode_H
       
    53 #define Patternist_TemplateMode_H
       
    54 
       
    55 #include <QtCore/QSharedData>
       
    56 #include <QXmlName>
       
    57 
       
    58 #include "qtemplatepattern_p.h"
       
    59 
       
    60 QT_BEGIN_HEADER
       
    61 QT_BEGIN_NAMESPACE
       
    62 
       
    63 namespace QPatternist
       
    64 {
       
    65     /**
       
    66      * @short Houses the data specific to the templates for a certain mode.
       
    67      *
       
    68      * @see Template
       
    69      * @see TemplatePattern
       
    70      * @author Frans Englich <frans.englich@nokia.com>
       
    71      * @ingroup Patternist_expressions
       
    72      * @since 4.5
       
    73      */
       
    74     class Q_AUTOTEST_EXPORT TemplateMode : public QSharedData
       
    75     {
       
    76     public:
       
    77         typedef QExplicitlySharedDataPointer<TemplateMode> Ptr;
       
    78 
       
    79         inline TemplateMode(const QXmlName &modeName) : m_modeName(modeName)
       
    80         {
       
    81         }
       
    82 
       
    83         TemplatePattern::Vector templatePatterns;
       
    84 
       
    85         /**
       
    86          * Adds the templates in @p mode to this TemplateMode.
       
    87          *
       
    88          * The existing name remains.
       
    89          */
       
    90         inline void addMode(const TemplateMode::Ptr &mode);
       
    91 
       
    92         inline const QXmlName &name() const;
       
    93 
       
    94         /**
       
    95          * Orders its templates by priority such that the first lookup always
       
    96          * returns the template with highest priority, and removes templates
       
    97          * shadowed by import precedence.
       
    98          */
       
    99         void finalize();
       
   100 
       
   101     private:
       
   102         const QXmlName m_modeName;
       
   103         Q_DISABLE_COPY(TemplateMode)
       
   104 
       
   105         /**
       
   106          * Operator for qSort().
       
   107          */
       
   108         static inline bool lessThanByPriority(const TemplatePattern::Ptr &t1,
       
   109                                               const TemplatePattern::Ptr &t2);
       
   110     };
       
   111 
       
   112     const QXmlName &TemplateMode::name() const
       
   113     {
       
   114         return m_modeName;
       
   115     }
       
   116 
       
   117     void TemplateMode::addMode(const TemplateMode::Ptr &mode)
       
   118     {
       
   119         templatePatterns += mode->templatePatterns;
       
   120     }
       
   121 
       
   122 }
       
   123 
       
   124 QT_END_NAMESPACE
       
   125 
       
   126 QT_END_HEADER
       
   127 
       
   128 #endif