src/xmlpatterns/data/qcomparisonfactory_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 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 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  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_ComparisonFactory_H
  53 #define Patternist_ComparisonFactory_H
  54
  55 #include <private/qatomiccomparator_p.h>
  56 #include <private/qderivedstring_p.h>
  57 #include <private/qitem_p.h>
  58 #include <private/qreportcontext_p.h>
  59 #include <private/qschematype_p.h>
  60
  61 QT_BEGIN_HEADER
  62 QT_BEGIN_NAMESPACE
  63
  64 namespace QPatternist
  65 {
  66     /**
  67      * @short Provides compare(), which is a high-level helper function for
  68      * comparing atomic values.
  69      *
  70      * This class wraps the helper class ComparisonPlatform with a more specific,
  71      * high-level API.
  72      *
  73      * @see ComparisonPlatform
  74      * @author Frans Englich <frans.englich@nokia.com>
  75      * @ingroup Patternist_schema
  76      */
  77     class ComparisonFactory
  78     {
  79     public:
  80         /**
  81          * @short Returns the result of evaluating operator @p op applied to the atomic
  82          * values @p operand1 and @p operand2.
  83          *
  84          * The caller guarantees that both values are of type @p type.
  85          *
  86          * ComparisonFactory does not take ownership of @p sourceLocationReflection.
  87          */
  88         static bool compare(const AtomicValue::Ptr &operand1,
  89                             const AtomicComparator::Operator op,
  90                             const AtomicValue::Ptr &operand2,
  91                             const SchemaType::Ptr &type,
  92                             const ReportContext::Ptr &context,
  93                             const SourceLocationReflection *const sourceLocationReflection);
  94
  95         /**
  96          * @short Returns the result of evaluating operator @p op applied to the atomic
  97          * values @p operand1 and @p operand2.
  98          *
  99          * In opposite to compare() it converts the operands from string type
 100          * to @p type and compares these constructed types.
 101          *
 102          * The caller guarantees that both values are of type @p type.
 103          *
 104          * ComparisonFactory does not take ownership of @p sourceLocationReflection.
 105          */
 106         static bool constructAndCompare(const DerivedString<TypeString>::Ptr &operand1,
 107                                         const AtomicComparator::Operator op,
 108                                         const DerivedString<TypeString>::Ptr &operand2,
 109                                         const SchemaType::Ptr &type,
 110                                         const ReportContext::Ptr &context,
 111                                         const SourceLocationReflection *const sourceLocationReflection);
 112
 113     private:
 114         Q_DISABLE_COPY(ComparisonFactory)
 115     };
 116 }
 117
 118 QT_END_NAMESPACE
 119 QT_END_HEADER
 120
 121 #endif