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

**

** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).

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

#define Patternist_AtomicCasters_H

#include "qatomiccaster_p.h"

#include "qdecimal_p.h"

#include "qderivedinteger_p.h"

#include "qderivedstring_p.h"

#include "qinteger_p.h"

#include "qvalidationerror_p.h"

/**

 * @file

 * @short Contains classes sub-classing AtomicCaster and which

 * are responsible of casting an atomic value to another type.

 */

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE

namespace QPatternist

{

    /**

     * @short Casts any atomic value to @c xs:string.

     *

     * This class uses Item::stringValue() for retrieving a string

     * representation, and thus supports casting from atomic values

     * of any type.

     *

     * @ingroup Patternist_xdm

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

     */

    template<TypeOfDerivedString DerivedType>

    class ToStringCaster : public AtomicCaster

    {

    public:

        virtual Item castFrom(const Item &from,

                              const QExplicitlySharedDataPointer<DynamicContext> &context) const

        {

            Q_ASSERT(from);

            return DerivedString<DerivedType>::fromLexical(context->namePool(), from.stringValue());

        }

    };

    /**

     * @short Casts any atomic value to @c xs:untypedAtomic.

     *

     * This class uses Item::stringValue() for retrieving a string

     * representation, and thus supports casting from atomic values

     * of any type. The implementation is similar to ToStringCaster.

     *

     * @ingroup Patternist_xdm

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

     */

    class ToUntypedAtomicCaster : public AtomicCaster

    {

    public:

        virtual Item castFrom(const Item &from,

                              const QExplicitlySharedDataPointer<DynamicContext> &context) const;

    };

    /**

     * @short Casts a string value to @c xs:anyURI.

     *

     * @ingroup Patternist_xdm

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

     */

    class ToAnyURICaster : public AtomicCaster

    {

    public:

        virtual Item castFrom(const Item &from,

                              const QExplicitlySharedDataPointer<DynamicContext> &context) const;

    };

    /**

     * @short Casts a @c xs:hexBinary atomic value to @c xs:base64Binary.

     *

     * @ingroup Patternist_xdm

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

     */

    class HexBinaryToBase64BinaryCaster : public AtomicCaster

    {

    public:

        virtual Item castFrom(const Item &from,

                              const QExplicitlySharedDataPointer<DynamicContext> &context) const;

    };

    /**

     * @short Casts a @c xs:base64Binary atomic value to @c xs:hexBinary.

     *

     * @ingroup Patternist_xdm

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

     */

    class Base64BinaryToHexBinaryCaster : public AtomicCaster

    {

    public:

        virtual Item castFrom(const Item &from,

                              const QExplicitlySharedDataPointer<DynamicContext> &context) const;

    };

    /**

     * @short Casts a @c xs:string or @c xs:untypedAtomic atomic value to @c xs:base64Binary.

     *

     * @ingroup Patternist_xdm

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

     */

    class StringToBase64BinaryCaster : public AtomicCaster

    {

    public:

        virtual Item castFrom(const Item &from,

                              const QExplicitlySharedDataPointer<DynamicContext> &context) const;

    };

    /**

     * @short Casts a @c xs:string or @c xs:untypedAtomic atomic value to @c xs:hexBinary.

     *

     * @ingroup Patternist_xdm

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

     */

    class StringToHexBinaryCaster : public AtomicCaster

    {

    public:

        virtual Item castFrom(const Item &from,

                              const QExplicitlySharedDataPointer<DynamicContext> &context) const;

    };

    /**

     * @short Casts any @c numeric value to @c xs:boolean.

     *

     * @ingroup Patternist_xdm

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

     */

    class NumericToBooleanCaster : public AtomicCaster

    {

    public:

        virtual Item castFrom(const Item &from,

                              const QExplicitlySharedDataPointer<DynamicContext> &context) const;

    };

    /**

     * @short Casts any string value, @c xs:string or @c xs:untypedAtomic, to @c xs:boolean.

     *

     * @ingroup Patternist_xdm

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

     */

    class StringToBooleanCaster : public AtomicCaster

    {

    public:

        virtual Item castFrom(const Item &from,

                              const QExplicitlySharedDataPointer<DynamicContext> &context) const;

    };

    /**

     * @short Casts a @c numeric value, such as @c xs:double or @c xs:decimal, to @c xs:integer or

     * @c xs:decimal, depending on IsInteger.

     *

     * castFrom() uses Numeric::toInteger() for doing the actual casting.

     *

     * @ingroup Patternist_xdm

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

     */

    template <const bool IsInteger>

    class NumericToDecimalCaster : public AtomicCaster

    {

    public:

        /**

         * Used by NumericToDerivedIntegerCaster in addition to this class.

         */

        static inline QString errorMessage()

        {

            return QtXmlPatterns::tr("When casting to %1 from %2, the source value cannot be %3.");

        }

        virtual Item castFrom(const Item &from,

                              const QExplicitlySharedDataPointer<DynamicContext> &context) const

        {

            const ItemType::Ptr t(from.type());

            const Numeric *const num = from.template as<Numeric>();

            if(BuiltinTypes::xsDouble->xdtTypeMatches(t) || BuiltinTypes::xsFloat->xdtTypeMatches(t))

            {

                if(num->isInf() || num->isNaN())

                {

                    return ValidationError::createError(errorMessage()

                                                        .arg(formatType(context->namePool(), IsInteger ? BuiltinTypes::xsInteger : BuiltinTypes::xsDecimal))

                                                        .arg(formatType(context->namePool(), t))

                                                        .arg(formatData(num->stringValue())),

                                                        ReportContext::FOCA0002);

                }

            }

            if(IsInteger)

                return Integer::fromValue(num->toInteger());

            else

                return toItem(Decimal::fromValue(num->toDecimal()));

        }

    };

    /**

     * @short Casts a string value, @c xs:string or @c xs:untypedAtomic, to @c xs:decimal.

     *

     * @ingroup Patternist_xdm

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

     */

    class StringToDecimalCaster : public AtomicCaster

    {

    public:

        virtual Item castFrom(const Item &from,

                              const QExplicitlySharedDataPointer<DynamicContext> &context) const;

    };

    /**

     * @short Casts a string value, @c xs:string or @c xs:untypedAtomic, to @c xs:integer.

     *

     * @ingroup Patternist_xdm

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

     */

    class StringToIntegerCaster : public AtomicCaster

    {

    public:

        virtual Item castFrom(const Item &from,

                              const QExplicitlySharedDataPointer<DynamicContext> &context) const;

    };

    /**

     * @short Casts a value of type @c xs:boolean to @c xs:decimal.

     *

     * @ingroup Patternist_xdm

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

     */

    class BooleanToDecimalCaster : public AtomicCaster

    {

    public:

        virtual Item castFrom(const Item &from,

                              const QExplicitlySharedDataPointer<DynamicContext> &context) const;

    };

    /**

     * @short Casts a value of type @c xs:boolean to @c xs:integer.

     *

     * @ingroup Patternist_xdm

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

     */

    class BooleanToIntegerCaster : public AtomicCaster

    {

    public:

        virtual Item castFrom(const Item &from,

                              const QExplicitlySharedDataPointer<DynamicContext> &context) const;

    };

    /**

     * @short Casts a value to itself. Essentially, this AtomicCaster does nothing.

     *

     * Casting a value to the type of itself is defined to be a noop,

     * no operation. When it can be statically detected that will be done,

     * CastAs rewrites itself appropriately during compilation, but

     * in some cases insufficent data is available at compile time and then

     * is this class need on a case-per-case base at evaluation time.

     *

     * @ingroup Patternist_xdm

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

     */

    class SelfToSelfCaster : public AtomicCaster

    {

    public:

        /**

         * This function simply returns @p from.

         */

        virtual Item castFrom(const Item &from,

                              const QExplicitlySharedDataPointer<DynamicContext> &context) const;

    };

    /**

     * @short Casts a @c xs:string or @c xs:untypedAtomic atomic value to @c xs:gYear.

     *

     * @ingroup Patternist_xdm

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

     */

    class StringToGYearCaster : public AtomicCaster

    {

    public:

        virtual Item castFrom(const Item &from,

                              const QExplicitlySharedDataPointer<DynamicContext> &context) const;

    };

    /**

     * @short Casts a @c xs:string or @c xs:untypedAtomic atomic value to @c xs:gDay.

     *

     * @ingroup Patternist_xdm

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

     */

    class StringToGDayCaster : public AtomicCaster

    {

    public:

        virtual Item castFrom(const Item &from,

                              const QExplicitlySharedDataPointer<DynamicContext> &context) const;

    };

    /**

     * @short Casts a @c xs:string or @c xs:untypedAtomic atomic value to @c xs:gMonth.

     *

     * @ingroup Patternist_xdm

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

     */

    class StringToGMonthCaster : public AtomicCaster

    {

    public:

        virtual Item castFrom(const Item &from,

                              const QExplicitlySharedDataPointer<DynamicContext> &context) const;

    };

    /**

     * @short Casts a @c xs:string or @c xs:untypedAtomic atomic value to @c xs:gYearMonth.

     *

     * @ingroup Patternist_xdm

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

     */

    class StringToGYearMonthCaster : public AtomicCaster

    {

    public:

        virtual Item castFrom(const Item &from,

                              const QExplicitlySharedDataPointer<DynamicContext> &context) const;

    };

    /**

     * @short Casts a @c xs:string or @c xs:untypedAtomic atomic value to @c xs:gYearMonth.

     *

     * @ingroup Patternist_xdm

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

     */

    class StringToGMonthDayCaster : public AtomicCaster

    {

    public:

        virtual Item castFrom(const Item &from,

                              const QExplicitlySharedDataPointer<DynamicContext> &context) const;

    };

    /**

     * @short Casts a @c xs:string or @c xs:untypedAtomic atomic value to @c xs:dateTime.

     *

     * @ingroup Patternist_xdm

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

     */

    class StringToDateTimeCaster : public AtomicCaster

    {

    public:

        virtual Item castFrom(const Item &from,

                              const QExplicitlySharedDataPointer<DynamicContext> &context) const;

    };

    /**

     * @short Casts a @c xs:string or @c xs:untypedAtomic atomic value to @c xs:time.

     *

     * @ingroup Patternist_xdm

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

     */

    class StringToTimeCaster : public AtomicCaster

    {

    public:

        virtual Item castFrom(const Item &from,

                              const QExplicitlySharedDataPointer<DynamicContext> &context) const;

    };

    /**

     * @short Casts a @c xs:string or @c xs:untypedAtomic atomic value to @c xs:date.

     *

     * @ingroup Patternist_xdm

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

     */

    class StringToDateCaster : public AtomicCaster

    {

    public:

        virtual Item castFrom(const Item &from,

                              const QExplicitlySharedDataPointer<DynamicContext> &context) const;

    };

    /**

     * @short Casts a @c xs:string or @c xs:untypedAtomic atomic value to @c xs:duration.

     *

     * @ingroup Patternist_xdm

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

     */

    class StringToDurationCaster : public AtomicCaster

    {

    public:

        virtual Item castFrom(const Item &from,

                              const QExplicitlySharedDataPointer<DynamicContext> &context) const;

    };

    /**

     * @short Casts a @c xs:string or @c xs:untypedAtomic atomic value to @c xs:dayTimeDuration.

     *

     * @ingroup Patternist_xdm

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

     */

    class StringToDayTimeDurationCaster : public AtomicCaster

    {

    public:

        virtual Item castFrom(const Item &from,

                              const QExplicitlySharedDataPointer<DynamicContext> &context) const;

    };

    /**

     * @short Casts a @c xs:string or @c xs:untypedAtomic atomic value to @c xs:yearMonthDuration.

     *

     * @ingroup Patternist_xdm

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

     */

    class StringToYearMonthDurationCaster : public AtomicCaster

    {

    public:

        virtual Item castFrom(const Item &from,

                              const QExplicitlySharedDataPointer<DynamicContext> &context) const;

    };

    /**

     * @short Casts a @c xs:date or @c xs:dateTime atomic value to @c xs:gYear.

     *

     * @ingroup Patternist_xdm

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

     */

    class AbstractDateTimeToGYearCaster : public AtomicCaster

    {

    public:

        virtual Item castFrom(const Item &from,

                              const QExplicitlySharedDataPointer<DynamicContext> &context) const;

    };

    /**

     * @short Casts a @c xs:date or @c xs:dateTime atomic value to @c xs:gYearMonth.

     *

     * @ingroup Patternist_xdm

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

     */

    class AbstractDateTimeToGYearMonthCaster : public AtomicCaster

    {

    public:

        virtual Item castFrom(const Item &from,

                              const QExplicitlySharedDataPointer<DynamicContext> &context) const;

    };

    /**

     * @short Casts a @c xs:date or @c xs:dateTime atomic value to @c xs:gMonth.

     *

     * @ingroup Patternist_xdm

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

     */

    class AbstractDateTimeToGMonthCaster : public AtomicCaster

    {

    public:

        virtual Item castFrom(const Item &from,

                              const QExplicitlySharedDataPointer<DynamicContext> &context) const;

    };

    /**

     * @short Casts a @c xs:date or @c xs:dateTime atomic value to @c xs:gMonthDay.

     *

     * @ingroup Patternist_xdm

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

     */

    class AbstractDateTimeToGMonthDayCaster : public AtomicCaster

    {

    public:

        virtual Item castFrom(const Item &from,

                              const QExplicitlySharedDataPointer<DynamicContext> &context) const;

    };

    /**

     * @short Casts a @c xs:date or @c xs:dateTime atomic value to @c xs:gDay.

     *

     * @ingroup Patternist_xdm

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

     */

    class AbstractDateTimeToGDayCaster : public AtomicCaster