src/xmlpatterns/schema/qxsdwildcard_p.h
changeset 0 1918ee327afb
equal deleted inserted replaced
-1:000000000000 0:1918ee327afb
       
     1 /****************************************************************************
       
     2 **
       
     3 ** Copyright (C) 2008 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_XsdWildcard_H
       
    53 #define Patternist_XsdWildcard_H
       
    54 
       
    55 #include "qxsdterm_p.h"
       
    56 
       
    57 #include <QtCore/QSet>
       
    58 
       
    59 QT_BEGIN_HEADER
       
    60 
       
    61 QT_BEGIN_NAMESPACE
       
    62 
       
    63 namespace QPatternist
       
    64 {
       
    65     /**
       
    66      * @short Represents a XSD wildcard object.
       
    67      *
       
    68      * This class represents the <em>wildcard</em> object of a XML schema as described
       
    69      * <a href="http://www.w3.org/TR/xmlschema11-1/#Wildcards">here</a>.
       
    70      *
       
    71      * It contains information from either an <em>any</em> object or an <em>anyAttribute</em> object.
       
    72      *
       
    73      * @see <a href="http://www.w3.org/Submission/2004/SUBM-xmlschema-api-20040309/xml-schema-api.html#Interface-XSWildcard">XML Schema API reference</a>
       
    74      * @ingroup Patternist_schema
       
    75      * @author Tobias Koenig <tobias.koenig@nokia.com>
       
    76      */
       
    77     class XsdWildcard : public XsdTerm
       
    78     {
       
    79         public:
       
    80             typedef QExplicitlySharedDataPointer<XsdWildcard> Ptr;
       
    81 
       
    82             /**
       
    83              * Defines the absent namespace that is used in wildcards.
       
    84              */
       
    85             static QString absentNamespace();
       
    86 
       
    87             /**
       
    88              * Describes the <a href="http://www.w3.org/TR/xmlschema11-1/#w-namespace_constraint">namespace constraint</a> of the wildcard.
       
    89              */
       
    90             class NamespaceConstraint : public QSharedData
       
    91             {
       
    92                 public:
       
    93                     typedef QExplicitlySharedDataPointer<NamespaceConstraint> Ptr;
       
    94 
       
    95                     /**
       
    96                      * Describes the variety of the namespace constraint.
       
    97                      *
       
    98                      * @see <a href="http://www.w3.org/TR/xmlschema11-1/#nc-variety">Variety Definition</a>
       
    99                      */
       
   100                     enum Variety
       
   101                     {
       
   102                         Any,         ///< Any namespace is allowed.
       
   103                         Enumeration, ///< Namespaces in the namespaces set are allowed.
       
   104                         Not          ///< Namespaces in the namespaces set are not allowed.
       
   105                     };
       
   106 
       
   107                     /**
       
   108                      * Sets the @p variety of the namespace constraint.
       
   109                      *
       
   110                      * @see <a href="http://www.w3.org/TR/xmlschema11-1/#nc-variety">Variety Definition</a>
       
   111                      */
       
   112                     void setVariety(Variety variety);
       
   113 
       
   114                     /**
       
   115                      * Returns the variety of the namespace constraint.
       
   116                      */
       
   117                     Variety variety() const;
       
   118 
       
   119                     /**
       
   120                      * Sets the set of @p namespaces of the namespace constraint.
       
   121                      */
       
   122                     void setNamespaces(const QSet<QString> &namespaces);
       
   123 
       
   124                     /**
       
   125                      * Returns the set of namespaces of the namespace constraint.
       
   126                      */
       
   127                     QSet<QString> namespaces() const;
       
   128 
       
   129                     /**
       
   130                      * Sets the set of disallowed @p names of the namespace constraint.
       
   131                      */
       
   132                     void setDisallowedNames(const QSet<QString> &names);
       
   133 
       
   134                     /**
       
   135                      * Returns the set of disallowed names of the namespace constraint.
       
   136                      */
       
   137                     QSet<QString> disallowedNames() const;
       
   138 
       
   139                 private:
       
   140                     Variety       m_variety;
       
   141                     QSet<QString> m_namespaces;
       
   142                     QSet<QString> m_disallowedNames;
       
   143             };
       
   144 
       
   145             /**
       
   146              * Describes the <a href="http://www.w3.org/TR/xmlschema11-1/#w-process_contents">type of content processing</a> of the wildcard.
       
   147              */
       
   148             enum ProcessContents
       
   149             {
       
   150                 Strict,      ///< There must be a top-level declaration for the item available, or the item must have an xsi:type, and the item must be valid as appropriate.
       
   151                 Lax,         ///< If the item has a uniquely determined declaration available, it must be valid with respect to that definition.
       
   152                 Skip         ///< No constraints at all: the item must simply be well-formed XML.
       
   153             };
       
   154 
       
   155             /**
       
   156              * Creates a new wildcard object.
       
   157              */
       
   158             XsdWildcard();
       
   159 
       
   160             /**
       
   161              * Returns always @c true, used to avoid dynamic casts.
       
   162              */
       
   163             virtual bool isWildcard() const;
       
   164 
       
   165             /**
       
   166              * Sets the namespace @p constraint of the wildcard.
       
   167              *
       
   168              * @see <a href="http://www.w3.org/TR/xmlschema11-1/#w-namespace_constraint">Namespace Constraint Definition</a>
       
   169              */
       
   170             void setNamespaceConstraint(const NamespaceConstraint::Ptr &constraint);
       
   171 
       
   172             /**
       
   173              * Returns the namespace constraint of the wildcard.
       
   174              */
       
   175             NamespaceConstraint::Ptr namespaceConstraint() const;
       
   176 
       
   177             /**
       
   178              * Sets the process @p contents of the wildcard.
       
   179              *
       
   180              * @see <a href="http://www.w3.org/TR/xmlschema11-1/#w-process_contents">Process Contents Definition</a>
       
   181              */
       
   182             void setProcessContents(ProcessContents contents);
       
   183 
       
   184             /**
       
   185              * Returns the process contents of the wildcard.
       
   186              */
       
   187             ProcessContents processContents() const;
       
   188 
       
   189         private:
       
   190             NamespaceConstraint::Ptr m_namespaceConstraint;
       
   191             ProcessContents          m_processContents;
       
   192     };
       
   193 }
       
   194 
       
   195 QT_END_NAMESPACE
       
   196 
       
   197 QT_END_HEADER
       
   198 
       
   199 #endif