src/xmlpatterns/api/qxmlquery.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 #ifndef QXMLQUERY_H
  43 #define QXMLQUERY_H
  44
  45 #include <QtCore/QUrl>
  46 #include <QtXmlPatterns/QAbstractXmlNodeModel>
  47 #include <QtXmlPatterns/QAbstractXmlReceiver>
  48 #include <QtXmlPatterns/QXmlNamePool>
  49
  50 QT_BEGIN_HEADER
  51 QT_BEGIN_NAMESPACE
  52
  53 QT_MODULE(XmlPatterns)
  54
  55 class QAbstractMessageHandler;
  56 class QAbstractUriResolver;
  57 class QIODevice;
  58 class QNetworkAccessManager;
  59 class QXmlName;
  60 class QXmlNodeIndex;
  61 class QXmlQueryPrivate;
  62 class QXmlResultItems;
  63 class QXmlSerializer;
  64
  65 /* The members in the namespace QPatternistSDK are internal, not part of the public API, and
  66  * unsupported. Using them leads to undefined behavior. */
  67 namespace QPatternistSDK
  68 {
  69     class TestCase;
  70 }
  71
  72 namespace QPatternist
  73 {
  74     class XsdSchemaParser;
  75     class XsdValidatingInstanceReader;
  76     class VariableLoader;
  77 }
  78
  79 class Q_XMLPATTERNS_EXPORT QXmlQuery
  80 {
  81 public:
  82     enum QueryLanguage
  83     {
  84         XQuery10                                = 1,
  85         XSLT20                                  = 2,
  86         XmlSchema11IdentityConstraintSelector   = 1024,
  87         XmlSchema11IdentityConstraintField      = 2048,
  88         XPath20                                 = 4096
  89     };
  90
  91     QXmlQuery();
  92     QXmlQuery(const QXmlQuery &other);
  93     QXmlQuery(const QXmlNamePool &np);
  94     QXmlQuery(QueryLanguage queryLanguage,
  95               const QXmlNamePool &np = QXmlNamePool());
  96     ~QXmlQuery();
  97     QXmlQuery &operator=(const QXmlQuery &other);
  98
  99     void setMessageHandler(QAbstractMessageHandler *messageHandler);
 100     QAbstractMessageHandler *messageHandler() const;
 101
 102     void setQuery(const QString &sourceCode, const QUrl &documentURI = QUrl());
 103     void setQuery(QIODevice *sourceCode, const QUrl &documentURI = QUrl());
 104     void setQuery(const QUrl &queryURI, const QUrl &baseURI = QUrl());
 105
 106     QXmlNamePool namePool() const;
 107
 108     void bindVariable(const QXmlName &name, const QXmlItem &value);
 109     void bindVariable(const QString &localName, const QXmlItem &value);
 110
 111     void bindVariable(const QXmlName &name, QIODevice *);
 112     void bindVariable(const QString &localName, QIODevice *);
 113     void bindVariable(const QXmlName &name, const QXmlQuery &query);
 114     void bindVariable(const QString &localName, const QXmlQuery &query);
 115
 116     bool isValid() const;
 117
 118     void evaluateTo(QXmlResultItems *result) const;
 119     bool evaluateTo(QAbstractXmlReceiver *callback) const;
 120     bool evaluateTo(QStringList *target) const;
 121     bool evaluateTo(QIODevice *target) const;
 122     bool evaluateTo(QString *output) const;
 123
 124     void setUriResolver(const QAbstractUriResolver *resolver);
 125     const QAbstractUriResolver *uriResolver() const;
 126
 127     void setFocus(const QXmlItem &item);
 128     bool setFocus(const QUrl &documentURI);
 129     bool setFocus(QIODevice *document);
 130     bool setFocus(const QString &focus);
 131
 132     void setInitialTemplateName(const QXmlName &name);
 133     void setInitialTemplateName(const QString &name);
 134     QXmlName initialTemplateName() const;
 135
 136     void setNetworkAccessManager(QNetworkAccessManager *newManager);
 137     QNetworkAccessManager *networkAccessManager() const;
 138
 139     QueryLanguage queryLanguage() const;
 140 private:
 141     friend class QXmlName;
 142     friend class QXmlSerializer;
 143     friend class QPatternistSDK::TestCase;
 144     friend class QPatternist::XsdSchemaParser;
 145     friend class QPatternist::XsdValidatingInstanceReader;
 146     friend class QPatternist::VariableLoader;
 147     template<typename TInputType> friend bool setFocusHelper(QXmlQuery *const queryInstance,
 148                                                              const TInputType &focusValue);
 149     QXmlQueryPrivate *d;
 150 };
 151
 152 QT_END_NAMESPACE
 153 QT_END_HEADER
 154
 155 #endif