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 Patternist_String_H

    53 #define Patternist_String_H

    54 

    55 #include <QUrl>

    56 

    57 #include "qitem_p.h"

    58 

    59 QT_BEGIN_HEADER

    60 

    61 QT_BEGIN_NAMESPACE

    62 

    63 namespace QPatternist

    64 {

    65     /**

    66      * @short Implements the value instance of the @c xs:string type.

    67      *

    68      *

    69      * This class was originally called String, and correspondingly the header

    70      * file was called String.h. However, this broke building on OS X, which

    71      * looks up file names case insensitively, and therefore found string.h.

    72      *

    73      * @author Frans Englich <frans.englich@nokia.com>

    74      * @ingroup Patternist_xdm

    75      * @todo Documentation is missing/incomplete

    76      */

    77     class Q_AUTOTEST_EXPORT AtomicString : public AtomicValue

    78     {

    79     public:

    80         friend class CommonValues;

    81 

    82         typedef AtomicValue::Ptr Ptr;

    83 

    84         /**

    85          * Creates an instance representing @p value.

    86          *

    87          * @note This function does not remove the string literal escaping allowed in XPath 2.0

    88          */

    89         static AtomicString::Ptr fromValue(const QString &value);

    90 

    91         static inline AtomicString::Ptr fromValue(const QUrl &value)

    92         {

    93             return fromValue(value.toString());

    94         }

    95 

    96         /**

    97          * Get the Effective %Boolean Value of this string. A zero-length

    98          * string has an effective boolean value of @c false, in all other cases @c true.

    99          *

   100          * @returns @c false if the contained string has a zero-length, otherwise @c true.

   101          */

   102         virtual bool evaluateEBV(const QExplicitlySharedDataPointer<DynamicContext> &) const;

   103 

   104         /**

   105          * The string value of a AtomicString instance is the value space.

   106          */

   107         virtual QString stringValue() const;

   108 

   109         virtual ItemType::Ptr type() const;

   110 

   111     protected:

   112         friend class StringComparator;

   113         friend class CompareFN;

   114         AtomicString(const QString &value);

   115         const QString m_value;

   116     };

   117 }

   118 

   119 QT_END_NAMESPACE

   120 

   121 QT_END_HEADER

   122 

   123 #endif