src/xmlpatterns/api/qresourcedelegator_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 QPatternist_ResourceDelegator_p_H
       
    53 #define QPatternist_ResourceDelegator_p_H
       
    54 
       
    55 #include <QSet>
       
    56 #include <QUrl>
       
    57 
       
    58 #include "qdeviceresourceloader_p.h"
       
    59 
       
    60 QT_BEGIN_HEADER
       
    61 QT_BEGIN_NAMESPACE
       
    62 
       
    63 namespace QPatternist
       
    64 {
       
    65     /**
       
    66      * @short Delegates to another ResourceLoader, but in case a URI is in an
       
    67      * exception list, it delegates to a different loader.
       
    68      *
       
    69      * This is used for handling device variables, since when a device variable
       
    70      * is rebound, a resource loader needs to carry that binding, while the
       
    71      * resource loader for the other query remains as is.
       
    72      *
       
    73      * @since 4.5
       
    74      * @author Frans Englich <frans.englich@nokia.com>
       
    75      */
       
    76     class ResourceDelegator : public DeviceResourceLoader
       
    77     {
       
    78     public:
       
    79         ResourceDelegator(const QSet<QUrl> &needsOverride,
       
    80                           const ResourceLoader::Ptr &parentLoader,
       
    81                           const ResourceLoader::Ptr &forDeviceLoader) : m_needsOverride(needsOverride)
       
    82                                                                       , m_parentLoader(parentLoader)
       
    83                                                                       , m_forDeviceLoader(forDeviceLoader)
       
    84 
       
    85         {
       
    86             Q_ASSERT(m_parentLoader);
       
    87         }
       
    88 
       
    89         virtual bool isUnparsedTextAvailable(const QUrl &uri,
       
    90                                              const QString &encoding);
       
    91         virtual ItemType::Ptr announceUnparsedText(const QUrl &uri);
       
    92         virtual Item openUnparsedText(const QUrl &uri,
       
    93                                       const QString &encoding,
       
    94                                       const ReportContext::Ptr &context,
       
    95                                       const SourceLocationReflection *const where);
       
    96         virtual Item openDocument(const QUrl &uri,
       
    97                                   const ReportContext::Ptr &context);
       
    98         virtual SequenceType::Ptr announceDocument(const QUrl &uri, const Usage usageHint);
       
    99         virtual bool isDocumentAvailable(const QUrl &uri);
       
   100         virtual Item::Iterator::Ptr openCollection(const QUrl &uri);
       
   101         virtual SequenceType::Ptr announceCollection(const QUrl &uri);
       
   102 
       
   103         /**
       
   104          * Returns the union of the deviceURIs() that ResourceDelegator's two
       
   105          * resource loaders has.
       
   106          */
       
   107         virtual QSet<QUrl> deviceURIs() const;
       
   108 
       
   109     private:
       
   110         const QSet<QUrl> m_needsOverride;
       
   111         const ResourceLoader::Ptr m_parentLoader;
       
   112         const ResourceDelegator::Ptr m_forDeviceLoader;
       
   113     };
       
   114 }
       
   115 
       
   116 QT_END_NAMESPACE
       
   117 QT_END_HEADER
       
   118 
       
   119 #endif