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

**

** 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_Primitives_H

#define Patternist_Primitives_H

#include <QtGlobal>

#include <QtCore/QHash>

#include <QtCore/QUrl>

/**

 * @file

 * @short Contains enumerators and typedefs applying

 * for Patternist on a global scale, as well as central documentation.

 */

/**

 * @short Contains Patternist, an XPath 2.0, XQuery 1.0 and XSL-T 2.0 implementation.

 *

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

 */

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE

class QString;

/**

 * @short The namespace for the internal API of QtXmlPatterns

 * @internal

 */

namespace QPatternist

{

    /**

     * @internal

     *

     * A method to allow a QHash or QSet with QUrl

     * as key type.

     */

    inline uint qHash(const QUrl &uri)

    {

        return qHash(uri.toString());

    }

    /**

     * @defgroup Patternist_cppWXSTypes C++ Primitives for W3C XML Schema Number Types

     *

     * The implementations of W3C XML Schema's(WXS) number types, more specifically

     * their value spaces, must in the end be represented by primitive C++ types.

     * In addition, there is an extensive range of functions and classes that in

     * different ways deals with data that will end up as instances of the WXS

     * types. For this reason, a set of typedefs for these primitives exists, that

     * are used throughout the API. This ensures consistency, reduces the amount

     * of conversions, and potentially precision loss in conversions.

     *

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

     */

    /**

     * This is the native C++ scalar type holding the value space

     * for atomic values of type xs:double. Taking this type, xsDouble,

     * as parameter, is the most efficient way to integrate with xs:double.

     *

     * @ingroup Patternist_cppWXSTypes

     */

    typedef qreal xsDouble;

    /**

     * This is the native C++ scalar type holding the value space

     * for atomic values of type xs:float. Taking this type, xsFloat,

     * as parameter, is the most efficient way to integrate with xs:float.

     *

     * @ingroup Patternist_cppWXSTypes

     */

    typedef xsDouble xsFloat;

    /**

     * This is the native C++ scalar type holding the value space

     * for atomic values of type xs:decimal. Taking this type, xsDecimal,

     * as parameter, is the most efficient way to integrate with xs:decimal.

     *

     * @ingroup Patternist_cppWXSTypes

     */

    typedef xsDouble xsDecimal;

    /**

     * This is the native C++ scalar type holding the value space

     * for atomic values of type xs:integer. Taking this type, xsInteger,

     * as parameter, is the most efficient way to integrate with xs:integer.

     *

     * @ingroup Patternist_cppWXSTypes

     */

    typedef qint64 xsInteger;

    /**

     * This is the native C++ scalar type holding the value space

     * for atomic values of type xs:integer. Taking this type, xsInteger,

     * as parameter, is the most efficient way to integrate with xs:integer.

     *

     * @ingroup Patternist_cppWXSTypes

     */

    typedef qint32 VariableSlotID;

    typedef qint32  DayCountProperty;

    typedef qint32  HourCountProperty;

    typedef qint32  MinuteCountProperty;

    typedef qint32  MonthCountProperty;

    typedef qint32  SecondCountProperty;

    typedef qint64  MSecondCountProperty;

    typedef qint32  SecondProperty;

    typedef qint32  YearProperty;

    typedef qint8   DayProperty;

    typedef qint8   HourProperty;

    typedef qint8   MinuteProperty;

    typedef qint8   MonthProperty;

    /**

     * Milliseconds. 1 equals 0.001 SecondProperty.

     */

    typedef qint16  MSecondProperty;

    /**

     * The hour property of a zone offset. For example, -13 in the

     * zone offset "-13:08".

     */

    typedef qint8   ZOHourProperty;

    /**

     * The minute property of a zone offset. For example, -08 in the

     * zone offset "-13:08".

     */

    typedef qint8   ZOMinuteProperty;

    /**

     * The full zone offset in minutes.

     */

    typedef qint32  ZOTotal;

    typedef xsDouble PatternPriority;

    /**

     * Signifies the import precedence of a template. For instance, the first

     * stylesheet module has 1, the first import 2, and so forth. Smaller means

     * higher import precedence. 0 is reserved for builtin templates.

     */

    typedef int ImportPrecedence;

    /**

     * @short Similar to Qt::escape(), but also escapes apostrophes and quotes,

     * such that the result is suitable as attribute content too.

     *

     * Since Qt::escape() is in QtGui, using it creates a dependency on that

     * library. This function does not.

     *

     * The implementation resides in qpatternistlocale.cpp.

     *

     * @see Qt::escape()

     */

    QString Q_AUTOTEST_EXPORT escape(const QString &input);

}

using QPatternist::qHash;

QT_END_NAMESPACE

QT_END_HEADER

#endif