src/xmlpatterns/api/qxmlnamepool.cpp

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #include "qnamepool_p.h"
  43 #include "qxmlnamepool.h"
  44
  45 QT_BEGIN_NAMESPACE
  46
  47 /*!
  48   \class QXmlNamePool
  49   \brief The QXmlNamePool class is a table of shared strings referenced by instances of QXmlName.
  50   \reentrant
  51   \since 4.4
  52   \ingroup xml-tools
  53
  54   QXmlNamePool is used to optimize operations on instances of
  55   QXmlName. An instance of QXmlName represents an XML name in
  56   a way that allows the XML name to be compared and passed around
  57   efficiently. The efficiency is achieved by storing the strings
  58   comprising the XML names in an instance of QXmlNamePool, where
  59   they are mapped to binary identifiers, which are then packed
  60   into a key which is stored in the QXmlName.
  61
  62   This means that each instance of QXmlName is tied to the name
  63   pool it was created with, and that name pool should be kept in
  64   scope and used to create all instances of QXmlName that might
  65   be compared. Note also that the name pool is required if you
  66   must reconstitute the QXmlName as text, or if you must access
  67   any of its component strings, so although instances of
  68   QXmlName can be compared without reference to a name pool, the
  69   name pool must be kept in scope if the name's strings must be
  70   accessed later.
  71
  72   \sa QXmlName
  73   \sa QXmlQuery::namePool()
  74  */
  75
  76 /*!
  77   Constructs an empty name pool.
  78  */
  79 QXmlNamePool::QXmlNamePool() : d(new QPatternist::NamePool())
  80 {
  81 }
  82
  83 /*!
  84   Constructs a copy of the \a other name pool.
  85  */
  86 QXmlNamePool::QXmlNamePool(const QXmlNamePool &other) : d(other.d)
  87 {
  88 }
  89
  90 /*!
  91   Destroys the name pool. Instances of QXmlName constructed
  92   with this name pool can still be compared after this destructor
  93   is called, but their text strings cannot be accessed.
  94  */
  95 QXmlNamePool::~QXmlNamePool()
  96 {
  97 }
  98
  99 QXmlNamePool::QXmlNamePool(QPatternist::NamePool *namePool) : d(QExplicitlySharedDataPointer<QPatternist::NamePool>(namePool))
 100 {
 101 }
 102
 103 /*!
 104   Assigns the \a other name pool to this one.
 105  */
 106 QXmlNamePool &QXmlNamePool::operator=(const QXmlNamePool &other)
 107 {
 108     d = other.d;
 109     return *this;
 110 }
 111
 112 QT_END_NAMESPACE
 113