src/xmlpatterns/schema/qxsdreference_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   5 **
   6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** Commercial License Usage
  10 ** Licensees holding valid commercial Qt licenses may use this file in
  11 ** accordance with the commercial license agreement provided with the
  12 ** Software or, alternatively, in accordance with the terms contained in
  13 ** a written agreement between you and Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/contact-us.
  16 **
  17 ** GNU Lesser General Public License Usage
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  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_XsdReference_H
  53 #define Patternist_XsdReference_H
  54
  55 #include <private/qxsdterm_p.h>
  56
  57 #include <QtXmlPatterns/QSourceLocation>
  58
  59 QT_BEGIN_HEADER
  60
  61 QT_BEGIN_NAMESPACE
  62
  63 namespace QPatternist
  64 {
  65     /**
  66      * @short A helper class for element and group reference resolving.
  67      *
  68      * For easy resolving of element and group references, we have this class
  69      * that can be used as a place holder for the real element or group
  70      * object it is referring to.
  71      * So whenever the parser detects an element or group reference, it creates
  72      * a XsdReference and returns it instead of the XsdElement or XsdModelGroup.
  73      * During a later phase, the resolver will look for all XsdReferences
  74      * in the schema and will replace them with their referring XsdElement or
  75      * XsdModelGroup objects.
  76      *
  77      * @ingroup Patternist_schema
  78      * @author Tobias Koenig <tobias.koenig@nokia.com>
  79      */
  80     class XsdReference : public XsdTerm
  81     {
  82         public:
  83             typedef QExplicitlySharedDataPointer<XsdReference> Ptr;
  84
  85             /**
  86              * Describes the type of the reference.
  87              */
  88             enum Type
  89             {
  90                 Element,        ///< The reference points to an element.
  91                 ModelGroup      ///< The reference points to a model group.
  92             };
  93
  94             /**
  95              * Returns always @c true, used to avoid dynamic casts.
  96              */
  97             virtual bool isReference() const;
  98
  99             /**
 100              * Sets the @p type of the reference.
 101              *
 102              * @see Type
 103              */
 104             void setType(Type type);
 105
 106             /**
 107              * Returns the type of the reference.
 108              */
 109             Type type() const;
 110
 111             /**
 112              * Sets the @p name of the referenced object.
 113              *
 114              * The name can either be a top-level element declaration
 115              * or a top-level group declaration.
 116              */
 117             void setReferenceName(const QXmlName &ame);
 118
 119             /**
 120              * Returns the name of the referenced object.
 121              */
 122             QXmlName referenceName() const;
 123
 124             /**
 125              * Sets the source @p location where the reference is located.
 126              */
 127             void setSourceLocation(const QSourceLocation &location);
 128
 129             /**
 130              * Returns the source location where the reference is located.
 131              */
 132             QSourceLocation sourceLocation() const;
 133
 134         private:
 135             Type            m_type;
 136             QXmlName        m_referenceName;
 137             QSourceLocation m_sourceLocation;
 138     };
 139 }
 140
 141 QT_END_NAMESPACE
 142
 143 QT_END_HEADER
 144
 145 #endif