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

**

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

** All rights reserved.

** Contact: Nokia Corporation (developer.feedback@nokia.com)

**

** This file is part of the HbCore module of the UI Extensions for Mobile.

**

** GNU Lesser General Public License Usage

** 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 developer.feedback@nokia.com.

**

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

#include <qglobal.h>

#include <QDate>

#include <QtDebug>

#include <qvariant.h>

#if defined(Q_OS_SYMBIAN)

#include <e32std.h>

#include <e32def.h>

#include <e32des16.h>

#include <e32const.h>

#include <e32base.h> 

#endif

#include "hbextendedlocale.h"

static const int CURRENCY_FORMAT_SIZE_STEP = 8; 

#if defined(Q_OS_SYMBIAN)

static TExtendedLocale _symbianLocale;

QT_BEGIN_NAMESPACE

TPtrC QString2TPtrC( const QString& string )

{

    return TPtrC16(static_cast<const TUint16*>(string.utf16()), string.length());

}

HBufC* QString2HBufC(const QString& aString)

{

    HBufC *buffer;

#ifdef QT_NO_UNICODE

    TPtrC8 ptr(reinterpret_cast<const TUint8*>(aString.toLocal8Bit().constData()));

#else

    TPtrC16 ptr(QString2TPtrC(aString));

#endif

    buffer = HBufC::New(ptr.Length());

    Q_CHECK_PTR(buffer);

    buffer->Des().Copy(ptr);

    return buffer;

}

QString TDesC2QString(const TDesC& aDescriptor)

{

#ifdef QT_NO_UNICODE

    return QString::fromLocal8Bit(aDescriptor.Ptr(), aDescriptor.Length());

#else

    return QString::fromUtf16(aDescriptor.Ptr(), aDescriptor.Length());

#endif

}

QT_END_NAMESPACE

#endif

/*!

    @stable

    @hbcore

    \class HbExtendedLocale

    \brief The HbExtendedLocale class is extension class to QLocale.

    It provides methods to access Symbian locale data absent from QLocale.

    Methods mainly focus to date and time related issues.

    Examples:

    \snippet{unittest_hbextendedlocale/unittest_hbextendedlocale.cpp,1}

    \snippet{unittest_hbextendedlocale/unittest_hbextendedlocale.cpp,2}

    \snippet{unittest_hbextendedlocale/unittest_hbextendedlocale.cpp,3}

    \snippet{unittest_hbextendedlocale/unittest_hbextendedlocale.cpp,4}

    \snippet{unittest_hbextendedlocale/unittest_hbextendedlocale.cpp,5}

    \snippet{unittest_hbextendedlocale/unittest_hbextendedlocale.cpp,6}

    \snippet{unittest_hbextendedlocale/unittest_hbextendedlocale.cpp,7}

    \snippet{unittest_hbextendedlocale/unittest_hbextendedlocale.cpp,8}

    \snippet{unittest_hbextendedlocale/unittest_hbextendedlocale.cpp,9}

    \snippet{unittest_hbextendedlocale/unittest_hbextendedlocale.cpp,10}

    \snippet{unittest_hbextendedlocale/unittest_hbextendedlocale.cpp,11}

    \snippet{unittest_hbextendedlocale/unittest_hbextendedlocale.cpp,12}

    \sa QLocale

*/

/*!

    Returns the date separator, which can occur in four different positions:

    Beginning of the expression;

    Between the first and second part;

    Between the second and third part;

    At the end of the expression;

    Some of the positions may contain an empty string if a separator is not used in that position in the locale in question.

    \attention Symbian specific API

    \return Symbian - One of the four characters used to separate the day,

    month and year components of the date according to the

    system locale    

    \return other platforms - Empty QChar or '\' (depending on index)

    \param index Index of the separator (0-3)

 */

QChar HbExtendedLocale::dateSeparator( int index ) const

{

#if defined(Q_OS_SYMBIAN)

    _symbianLocale.LoadSystemSettings();	

    TChar val = _symbianLocale.GetLocale()->DateSeparator(index);

    return QChar(val);

#else

    if ( index > 0 && index < 3 ) {

        return QLatin1Char('/');

    } else {

        return QChar();

    }

#endif

}

/*!

    Sets one of the four characters used to separate the day, 

    month and year components of the date according to the

    system locale.

    \attention Symbian specific API

    \param ch Character to set,

    \param index Index of the separator (0-3)

    \return true for Symbian if succesfull and false for other OS

 */

bool HbExtendedLocale::setDateSeparator( const QChar ch, const int index )

{

#if defined(Q_OS_SYMBIAN)

    if ( index < 0 || index > 3 ) {

        return false;

    }

    _symbianLocale.LoadSystemSettings();	

    TChar symbianch( ch.unicode() );

    _symbianLocale.GetLocale()->SetDateSeparator(symbianch, index);

    _symbianLocale.GetLocale()->Set();

    return true;

#else

    Q_UNUSED(ch);

    Q_UNUSED(index);

    return false;

#endif

}

/*!

    Retrieves the time separator (for example, colon or full stop).

    \attention Symbian specific API

    \return Symbian - One of the four characters used to separate the hour,

    minute and second components of the date according to the

    system locale    

    \return other platforms - Empty QChar or ':' (depending on index) 

    \param index Index of the separator (0-3)

 */

QChar HbExtendedLocale::timeSeparator( int index ) const

{

#if defined(Q_OS_SYMBIAN)

    _symbianLocale.LoadSystemSettings();

    TChar val = _symbianLocale.GetLocale()->TimeSeparator(index);

    return QChar(val);

#else

    if ( index > 0 && index < 3 ) {

        return QLatin1Char(':');

    } else {

        return QChar();

    }

#endif

}

/*!

    Sets one of the four characters used to separate the hour,

    minute and second components of the date.

    \attention Symbian specific API

    \param ch Character to set,

    \param index Index of the separator (0-3)

    \return true for Symbian if succesfull and false for other OS

 */

bool HbExtendedLocale::setTimeSeparator( const QChar ch, const int index )

{

#if defined(Q_OS_SYMBIAN)

    if ( index < 0 || index > 3 ) {

        return false;

    }

    _symbianLocale.LoadSystemSettings();

    TChar symbianch( ch.unicode() );

    _symbianLocale.GetLocale()->SetTimeSeparator(symbianch, index);

    _symbianLocale.GetLocale()->Set();

    return true;

#else

    Q_UNUSED(ch);

    Q_UNUSED(index);

    return false;

#endif

}

/*! 

    \enum HbExtendedLocale::DateStyle

    returns the order of the date components: day-month-year (the most commonly used format)

    month-day-year (mostly used in the U.S. and Canada)

    or year-month-day (used, for example, in Japanese, Chinese and Swedish)

    This enum defines the order of date components.

    \value American American order (mm/dd/yyyy)

    \value European European order (dd/mm/yyyy)

    \value Japanese Japanese order (yyyy/mm/dd)

    \sa dateStyle(), setDateStyle()

 */

/*!

    Returns date style from system locale. The date style is returned according to DateStyle. 

    \attention Symbian specific API

    \return date style for Symbian and HbExtendedLocale::American for other platforms    

 */

HbExtendedLocale::DateStyle HbExtendedLocale::dateStyle() const

{

#if defined(Q_OS_SYMBIAN)

    _symbianLocale.LoadSystemSettings();

    TDateFormat val = _symbianLocale.GetLocale()->DateFormat();

    switch ( val ) {

    case EDateAmerican:

        // mm/dd/yyyy

        return HbExtendedLocale::American;

    case EDateEuropean:

        // dd/mm/yyyy

        return HbExtendedLocale::European;

    case EDateJapanese:

        // yyyy/mm/dd

        return HbExtendedLocale::Japanese;

    }

    return HbExtendedLocale::American;

#else

    return HbExtendedLocale::American;

#endif

}

/*!

    Sets date style to system locale.

    The date style is chosen according to the \a style parameter.

    \attention Symbian specific API

    \return true for Symbian and false for other OS

 */

bool HbExtendedLocale::setDateStyle( const DateStyle style )

{

#if defined(Q_OS_SYMBIAN)

    TDateFormat set;

    switch ( style ) {

    default:

    case HbExtendedLocale::American:

        set = EDateAmerican;

        break;

    case HbExtendedLocale::European:

        set = EDateEuropean;

        break;

    case HbExtendedLocale::Japanese:

        set = EDateJapanese;

        break;

    }

    _symbianLocale.LoadSystemSettings();

    _symbianLocale.GetLocale()->SetDateFormat(set);

    _symbianLocale.GetLocale()->Set();

    return true;

#else

    Q_UNUSED(style);

    return false;

#endif

}

/*! 

    \enum HbExtendedLocale::TimeStyle

    Finds out if the 12-hour or the 24-hour clock is used

    \value Time12 12 hour clock style

    \value Time24 24 hour clock style

    \sa timeStyle(), setTimeStyle()

 */

/*!

    Returns time style from system locale. The time style is returned according to TimeStyle.  

    \attention Symbian specific API

    \return time style for Symbian and HbExtendedLocale::Time12 for other platforms    

 */

HbExtendedLocale::TimeStyle HbExtendedLocale::timeStyle() const

{

#if defined(Q_OS_SYMBIAN)

    _symbianLocale.LoadSystemSettings();

    TTimeFormat val = _symbianLocale.GetLocale()->TimeFormat();

    switch ( val ) {

    case ETime12:

        return HbExtendedLocale::Time12;

    case ETime24:

        return HbExtendedLocale::Time24;

    }

    return HbExtendedLocale::Time12;

#else

    return HbExtendedLocale::Time12;

#endif

}

/*!

    Sets time style to system locale.

    The time style is chosen according to the \a style parameter.

    \attention Symbian specific API

    \return true for Symbian and false for other OS

 */

bool HbExtendedLocale::setTimeStyle( const TimeStyle style )

{

#if defined(Q_OS_SYMBIAN)

    TTimeFormat set;

    switch ( style ) {

    default:

    case HbExtendedLocale::Time12:

        set = ETime12;

        break;

    case HbExtendedLocale::Time24:

        set = ETime24;

        break;

    }

    _symbianLocale.LoadSystemSettings();

    _symbianLocale.GetLocale()->SetTimeFormat(set);

    _symbianLocale.GetLocale()->Set();

    return true;

#else

    Q_UNUSED(style);

    return false;

#endif

}

/*!

    Finds out if the AM/PM symbol is separated by a space from the time expression.

    \attention Symbian specific API

    \return Symbian - True if space is inserted between the time and the preceding or trailing am/pm text; otherwise returns false.   

    \return other platforms - true

 */

bool HbExtendedLocale::amPmSpace() const

{

#if defined(Q_OS_SYMBIAN)

    _symbianLocale.LoadSystemSettings();

    return _symbianLocale.GetLocale()->AmPmSpaceBetween();

#else

    return true;

#endif

}

/*!

    Sets whether a \a space is inserted between the time and the preceding or trailing am/pm text.

    \attention Symbian specific API

    \return true for Symbian and false for other OS

 */

bool HbExtendedLocale::setAmPmSpace( const bool space )

{

#if defined(Q_OS_SYMBIAN)

    _symbianLocale.LoadSystemSettings();

    _symbianLocale.GetLocale()->SetAmPmSpaceBetween(space);

    _symbianLocale.GetLocale()->Set();

    return true;

#else

    Q_UNUSED(space);

    return false;

#endif

}

/*! 

    \enum HbExtendedLocale::SymbolPos

    \value Before

    \value After

    Retrieves the position of the AM/PM symbol (before or after the time expression)

    \sa amPmSymbolPosition(), setAmPmSymbolPosition()

    \sa currencySymbolPosition(), setCurrencySymbolPosition()

 */

/*!

    Returns HbExtendedLocale::Before if am/pm text is positioned before time; otherwise returns HbExtendedLocale::After.

    \attention Symbian specific API

    \return After/Before for Symbian and HbExtendedLocale::After for other platforms

 */

HbExtendedLocale::SymbolPos HbExtendedLocale::amPmSymbolPosition() const

{

#if defined(Q_OS_SYMBIAN)

    _symbianLocale.LoadSystemSettings();

    TLocalePos position = _symbianLocale.GetLocale()->AmPmSymbolPosition();

    if ( position == ELocaleBefore ) {

    	return HbExtendedLocale::Before;

    	return HbExtendedLocale::After;

    }

#else

    return HbExtendedLocale::After;

#endif

}

/*!

    Sets the am/pm text position.

    The position is chosen according to the \a position parameter.

    \attention Symbian specific API

    \return true for Symbian if succesfull and false for other OS

 */

bool HbExtendedLocale::setAmPmSymbolPosition( const SymbolPos position )

{

#if defined(Q_OS_SYMBIAN)

    _symbianLocale.LoadSystemSettings();

    if ( position == ( HbExtendedLocale::Before ) ) {

        _symbianLocale.GetLocale()->SetAmPmSymbolPosition(ELocaleBefore);

    } else if ( position == ( HbExtendedLocale::After ) ) {

        _symbianLocale.GetLocale()->SetAmPmSymbolPosition(ELocaleAfter);

    } else {

        return false;

    }

    _symbianLocale.GetLocale()->Set();

    return true;

#else

    Q_UNUSED(position);

    return false;

#endif

}

/*! 

    \enum HbExtendedLocale::UnitsFormat

    Retrives the  measurement system (if metric or imperial units are in use) .

    This enum defines which units are used for measurement.

    \value Imperial This value indicates imperial units, such as inches and

             miles. There are several distinct imperial systems in the world; this

             value stands for the official United States imperial units.

    \value Metric This value indicates metric units, such as meters,

             centimeters and millimeters.

    \sa unitsDistanceShort(), unitsDistanceLong()

 */

/*!

    Retrives the  measurement system (if metric or imperial units are in use). 

    \attention Symbian specific API

    \return Symbian - Short unit distance format from system locale. Format is specified by UnitsFormat.

    \return other platforms - QLocale::MetricSystem

*/

QLocale::MeasurementSystem HbExtendedLocale::unitsDistanceShort() const

{

#if defined(Q_OS_SYMBIAN)

    _symbianLocale.LoadSystemSettings();

    TUnitsFormat val = _symbianLocale.GetLocale()->UnitsDistanceShort();

    switch ( val ) {

    case EUnitsMetric:

        return QLocale::MetricSystem;

    case EUnitsImperial:

        return QLocale::ImperialSystem;

    }

    return QLocale::MetricSystem;

#else

    return QLocale::MetricSystem;

#endif

}

/*!