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

**

** 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 QtGui 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$

**

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

#include <qdebug.h>

#include "qvalidator.h"

#ifndef QT_NO_VALIDATOR

#include "private/qobject_p.h"

#include "private/qlocale_p.h"

#include <limits.h>

#include <math.h>

QT_BEGIN_NAMESPACE

/*!

    \class QValidator

    \brief The QValidator class provides validation of input text.

    The class itself is abstract. Two subclasses, \l QIntValidator and

    \l QDoubleValidator, provide basic numeric-range checking, and \l

    QRegExpValidator provides general checking using a custom regular

    expression.

    If the built-in validators aren't sufficient, you can subclass

    QValidator. The class has two virtual functions: validate() and

    fixup().

    \l validate() must be implemented by every subclass. It returns

    \l Invalid, \l Intermediate or \l Acceptable depending on whether

    its argument is valid (for the subclass's definition of valid).

    These three states require some explanation. An \l Invalid string

    is \e clearly invalid. \l Intermediate is less obvious: the

    concept of validity is difficult to apply when the string is

    incomplete (still being edited). QValidator defines \l Intermediate

    as the property of a string that is neither clearly invalid nor

    acceptable as a final result. \l Acceptable means that the string

    is acceptable as a final result. One might say that any string

    that is a plausible intermediate state during entry of an \l

    Acceptable string is \l Intermediate.

    Here are some examples:

    \list

    \i For a line edit that accepts integers from 10 to 1000 inclusive,

    42 and 123 are \l Acceptable, the empty string and 5 are \l

    Intermediate, and "asdf" and 1114 is \l Invalid.

    \i For an editable combobox that accepts URLs, any well-formed URL

    is \l Acceptable, "http://example.com/," is \l Intermediate

    (it might be a cut and paste action that accidentally took in a

    comma at the end), the empty string is \l Intermediate (the user

    might select and delete all of the text in preparation for entering

    a new URL) and "http:///./" is \l Invalid.

    \i For a spin box that accepts lengths, "11cm" and "1in" are \l

    Acceptable, "11" and the empty string are \l Intermediate, and

    "http://example.com" and "hour" are \l Invalid.

    \endlist

    \l fixup() is provided for validators that can repair some user

    errors. The default implementation does nothing. QLineEdit, for

    example, will call fixup() if the user presses Enter (or Return)

    and the content is not currently valid. This allows the fixup()

    function the opportunity of performing some magic to make an \l

    Invalid string \l Acceptable.

    A validator has a locale, set with setLocale(). It is typically used

    to parse localized data. For example, QIntValidator and QDoubleValidator

    use it to parse localized representations of integers and doubles.

    QValidator is typically used with QLineEdit, QSpinBox and

    QComboBox.

    \sa QIntValidator, QDoubleValidator, QRegExpValidator, {Line Edits Example}

*/

/*!

    \enum QValidator::State

    This enum type defines the states in which a validated string can

    exist.

    \value Invalid       The string is \e clearly invalid.

    \value Intermediate  The string is a plausible intermediate value.

    \value Acceptable    The string is acceptable as a final result;

                         i.e. it is valid.

    \omitvalue Valid

*/

class QValidatorPrivate : public QObjectPrivate{

    Q_DECLARE_PUBLIC(QValidator)

public:

    QValidatorPrivate() : QObjectPrivate()

    {

    }

    QLocale locale;

};

/*!

    Sets up the validator. The \a parent parameter is

    passed on to the QObject constructor.

*/

QValidator::QValidator(QObject * parent)

    : QObject(*new QValidatorPrivate, parent)

{

}

#ifdef QT3_SUPPORT

/*!

  \obsolete

    Sets up the validator. The \a parent and \a name parameters are

    passed on to the QObject constructor.

*/

QValidator::QValidator(QObject * parent, const char *name)

    : QObject(*new QValidatorPrivate, parent)

{

    setObjectName(QString::fromAscii(name));

}

#endif

/*!

    Destroys the validator, freeing any storage and other resources

    used.

*/

QValidator::~QValidator()

{

}

/*!

    Returns the locale for the validator. The locale is by default initialized to the same as QLocale().

    \sa setLocale()

    \sa QLocale::QLocale()

*/

QLocale QValidator::locale() const

{

    Q_D(const QValidator);

    return d->locale;

}

/*!

    Sets the \a locale that will be used for the validator. Unless

    setLocale has been called, the validator will use the default

    locale set with QLocale::setDefault(). If a default locale has not

    been set, it is the operating system's locale.

    \sa locale() QLocale::setDefault()

*/

void QValidator::setLocale(const QLocale &locale)

{

    Q_D(QValidator);

    d->locale = locale;

}

/*!

    \fn QValidator::State QValidator::validate(QString &input, int &pos) const

    This virtual function returns \l Invalid if \a input is invalid

    according to this validator's rules, \l Intermediate if it

    is likely that a little more editing will make the input

    acceptable (e.g. the user types "4" into a widget which accepts

    integers between 10 and 99), and \l Acceptable if the input is

    valid.

    The function can change both \a input and \a pos (the cursor position)

    if required.

*/

/*!

    \fn void QValidator::fixup(QString & input) const

    This function attempts to change \a input to be valid according to

    this validator's rules. It need not result in a valid string:

    callers of this function must re-test afterwards; the default does

    nothing.

    Reimplementations of this function can change \a input even if

    they do not produce a valid string. For example, an ISBN validator

    might want to delete every character except digits and "-", even

    if the result is still not a valid ISBN; a surname validator might

    want to remove whitespace from the start and end of the string,

    even if the resulting string is not in the list of accepted

    surnames.

*/

void QValidator::fixup(QString &) const

{

}

/*!

    \class QIntValidator

    \brief The QIntValidator class provides a validator that ensures

    a string contains a valid integer within a specified range.

    Example of use:

    \snippet doc/src/snippets/code/src_gui_widgets_qvalidator.cpp 0

    Below we present some examples of validators. In practice they would

    normally be associated with a widget as in the example above.

    \snippet doc/src/snippets/code/src_gui_widgets_qvalidator.cpp 1

    Notice that the value \c 999 returns Intermediate. Values

    consisting of a number of digits equal to or less than the max

    value are considered intermediate. This is intended because the

    digit that prevents a number to be in range is not necessarily the

    last digit typed. This also means that an intermediate number can

    have leading zeros.

    The minimum and maximum values are set in one call with setRange(),

    or individually with setBottom() and setTop().

    QIntValidator uses its locale() to interpret the number. For example,

    in Arabic locales, QIntValidator will accept Arabic digits. In addition,

    QIntValidator is always guaranteed to accept a number formatted according

    to the "C" locale.

    \sa QDoubleValidator, QRegExpValidator, {Line Edits Example}

*/

/*!

    Constructs a validator with a \a parent object that

    accepts all integers.

*/

QIntValidator::QIntValidator(QObject * parent)

    : QValidator(parent)

{

    b = INT_MIN;

    t = INT_MAX;

}

/*!

    Constructs a validator with a \a parent, that accepts integers

    from \a minimum to \a maximum inclusive.

*/

QIntValidator::QIntValidator(int minimum, int maximum,

                              QObject * parent)

    : QValidator(parent)

{

    b = minimum;

    t = maximum;

}

#ifdef QT3_SUPPORT

/*!

  \obsolete

    Constructs a validator with a \a parent object and a \a name that

    accepts all integers.

*/

QIntValidator::QIntValidator(QObject * parent, const char *name)

    : QValidator(parent)

{

    setObjectName(QString::fromAscii(name));

    b = INT_MIN;

    t = INT_MAX;

}

/*!

  \obsolete

    Constructs a validator called \a name with a \a parent, that

    accepts integers from \a minimum to \a maximum inclusive.

*/

QIntValidator::QIntValidator(int minimum, int maximum,

                              QObject * parent, const char* name)

    : QValidator(parent)

{

    setObjectName(QString::fromAscii(name));

    b = minimum;

    t = maximum;

}

#endif

/*!

    Destroys the validator.

*/

QIntValidator::~QIntValidator()

{

    // nothing

}

/*!

    \fn QValidator::State QIntValidator::validate(QString &input, int &pos) const

    Returns \l Acceptable if the \a input is an integer within the

    valid range, \l Intermediate if the \a input is a prefix of an integer in the

    valid range, and \l Invalid otherwise.

    If the valid range consists of just positive integers (e.g., 32 to 100)

    and \a input is a negative integer, then Invalid is returned. (On the other

    hand, if the range consists of negative integers (e.g., -100 to -32) and

    \a input is a positive integer, then Intermediate is returned, because

    the user might be just about to type the minus (especially for right-to-left

    languages).

    \snippet doc/src/snippets/code/src_gui_widgets_qvalidator.cpp 2

    By default, the \a pos parameter is not used by this validator.

*/

static int numDigits(qlonglong n)

{

    if (n == 0)

        return 1;

    return (int)log10(double(n)) + 1;

}

static qlonglong pow10(int exp)

{

    qlonglong result = 1;

    for (int i = 0; i < exp; ++i)

        result *= 10;

    return result;

}

QValidator::State QIntValidator::validate(QString & input, int&) const

{

    QByteArray buff;

    if (!locale().d()->validateChars(input, QLocalePrivate::IntegerMode, &buff)) {

        QLocale cl(QLocale::C);

        if (!cl.d()->validateChars(input, QLocalePrivate::IntegerMode, &buff))

            return Invalid;

    }

    if (buff.isEmpty())

        return Intermediate;

    if (b >= 0 && buff.startsWith('-'))

        return Invalid;

    if (t < 0 && buff.startsWith('+'))

        return Invalid;

    if (buff.size() == 1 && (buff.at(0) == '+' || buff.at(0) == '-'))

        return Intermediate;

    bool ok, overflow;

    qlonglong entered = QLocalePrivate::bytearrayToLongLong(buff.constData(), 10, &ok, &overflow);

    if (overflow || !ok)

        return Invalid;

    if (entered >= b && entered <= t)

        return Acceptable;

    if (entered >= 0) {

        // the -entered < b condition is necessary to allow people to type

        // the minus last (e.g. for right-to-left languages)

        return (entered > t && -entered < b) ? Invalid : Intermediate;

    } else {

        return (entered < b) ? Invalid : Intermediate;

    }

}

/*!

    Sets the range of the validator to only accept integers between \a

    bottom and \a top inclusive.

*/

void QIntValidator::setRange(int bottom, int top)

{

    b = bottom;

    t = top;

}

/*!

    \property QIntValidator::bottom

    \brief the validator's lowest acceptable value

    By default, this property's value is derived from the lowest signed

    integer available (typically -2147483647).

    \sa setRange()

*/

void QIntValidator::setBottom(int bottom)

{

    setRange(bottom, top());

}

/*!

    \property QIntValidator::top

    \brief the validator's highest acceptable value

    By default, this property's value is derived from the highest signed

    integer available (typically 2147483647).

    \sa setRange()

*/

void QIntValidator::setTop(int top)

{

    setRange(bottom(), top);

}

#ifndef QT_NO_REGEXP

/*!

    \internal

*/

QValidator::QValidator(QObjectPrivate &d, QObject *parent)

        : QObject(d, parent)

{

}

/*!

    \internal

*/

QValidator::QValidator(QValidatorPrivate &d, QObject *parent)

        : QObject(d, parent)

{

}

class QDoubleValidatorPrivate : public QValidatorPrivate

{

    Q_DECLARE_PUBLIC(QDoubleValidator)

public:

    QDoubleValidatorPrivate()

        : QValidatorPrivate()

        , notation(QDoubleValidator::ScientificNotation)

    {

    }

    QDoubleValidator::Notation notation;

};

/*!

    \class QDoubleValidator

    \brief The QDoubleValidator class provides range checking of

    floating-point numbers.

    QDoubleValidator provides an upper bound, a lower bound, and a

    limit on the number of digits after the decimal point. It does not

    provide a fixup() function.

    You can set the acceptable range in one call with setRange(), or

    with setBottom() and setTop(). Set the number of decimal places

    with setDecimals(). The validate() function returns the validation

    state.

    QDoubleValidator uses its locale() to interpret the number. For example,

    in the German locale, "1,234" will be accepted as the fractional number

    1.234. In Arabic locales, QDoubleValidator will accept Arabic digits.

    In addition, QDoubleValidator is always guaranteed to accept a number

    formatted according to the "C" locale. QDoubleValidator will not accept

    numbers with thousand-seperators.

    \sa QIntValidator, QRegExpValidator, {Line Edits Example}

*/

 /*!

    \enum QDoubleValidator::Notation

    \since 4.3

    This enum defines the allowed notations for entering a double.

    \value StandardNotation      The string is written as a standard number

                                 (i.e. 0.015).

    \value ScientificNotation    The string is written in scientific

                                 form. It may have an exponent part(i.e. 1.5E-2).

*/

/*!

    Constructs a validator object with a \a parent object

    that accepts any double.