/****************************************************************************

**

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the QtXmlPatterns module of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 2.1 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

** packaging of this file.  Please review the following information to

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

//

//  W A R N I N G

//  -------------

//

// This file is not part of the Qt API.  It exists purely as an

// implementation detail.  This header file may change from version to

// version without notice, or even be removed.

//

// We mean it.

#ifndef Patternist_String_H

#define Patternist_String_H

#include <QUrl>

#include "qitem_p.h"

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE

namespace QPatternist

{

    /**

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

     *

     *

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

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

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

     *

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

     * @ingroup Patternist_xdm

     * @todo Documentation is missing/incomplete

     */

    class Q_AUTOTEST_EXPORT AtomicString : public AtomicValue

    {

    public:

        friend class CommonValues;

        typedef AtomicValue::Ptr Ptr;

        /**

         * Creates an instance representing @p value.

         *

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

         */

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

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

        {

            return fromValue(value.toString());

        }

        /**

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

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

         *

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

         */

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

        /**

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

         */

        virtual QString stringValue() const;

        virtual ItemType::Ptr type() const;

    protected:

        friend class StringComparator;

        friend class CompareFN;

        AtomicString(const QString &value);

        const QString m_value;

    };

}

QT_END_NAMESPACE

QT_END_HEADER

#endif