diff options
Diffstat (limited to 'src/sql/kernel/qsqlfield.cpp')
| -rw-r--r-- | src/sql/kernel/qsqlfield.cpp | 337 |
1 files changed, 152 insertions, 185 deletions
diff --git a/src/sql/kernel/qsqlfield.cpp b/src/sql/kernel/qsqlfield.cpp index 65594b35fe..0bd0ca5161 100644 --- a/src/sql/kernel/qsqlfield.cpp +++ b/src/sql/kernel/qsqlfield.cpp @@ -1,73 +1,21 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the QtSql module of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 3 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL3 included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 3 requirements -** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 2.0 or (at your option) the GNU General -** Public license version 3 or any later version approved by the KDE Free -** Qt Foundation. The licenses are as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-2.0.html and -** https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only #include "qsqlfield.h" -#include "qatomic.h" #include "qdebug.h" QT_BEGIN_NAMESPACE -class QSqlFieldPrivate +class QSqlFieldPrivate : public QSharedData { public: QSqlFieldPrivate(const QString &name, QMetaType type, const QString &tableName) : - ref(1), nm(name), table(tableName), def(QVariant()), type(type), + nm(name), table(tableName), def(QVariant()), type(type), req(QSqlField::Unknown), len(-1), prec(-1), tp(-1), ro(false), gen(true), autoval(false) {} - QSqlFieldPrivate(const QSqlFieldPrivate &other) - : ref(1), - nm(other.nm), - table(other.table), - def(other.def), - type(other.type), - req(other.req), - len(other.len), - prec(other.prec), - tp(other.tp), - ro(other.ro), - gen(other.gen), - autoval(other.autoval) - {} - bool operator==(const QSqlFieldPrivate& other) const { return (nm == other.nm @@ -82,7 +30,6 @@ public: && autoval == other.autoval); } - QAtomicInt ref; QString nm; QString table; QVariant def; @@ -95,6 +42,7 @@ public: bool gen: 1; bool autoval: 1; }; +QT_DEFINE_QESDP_SPECIALIZATION_DTOR(QSqlFieldPrivate) /*! @@ -151,19 +99,24 @@ public: \value Unknown The database driver couldn't determine whether the field is required or optional. - \sa requiredStatus() + \sa requiredStatus */ /*! \fn QSqlField::QSqlField(const QString &fieldName, QVariant::Type type, const QString &table) - \deprecated Use the constructor using a QMetaType instead. - + \deprecated [6.0] Use the constructor taking a QMetaType instead. \overload + Constructs an empty field called \a fieldName of variant type \a type in \a table. +*/ - \sa setRequiredStatus(), setLength(), setPrecision(), setDefaultValue(), - setGenerated(), setReadOnly() +/*! + \fn void QSqlField::swap(QSqlField &other) + \since 6.6 + + Swaps this field with \a other. This function is very fast and + never fails. */ /*! @@ -172,38 +125,26 @@ public: \overload Constructs an empty field called \a fieldName of type \a type in \a table. - - \sa setRequiredStatus(), setLength(), setPrecision(), setDefaultValue(), - setGenerated(), setReadOnly() */ QSqlField::QSqlField(const QString &fieldName, QMetaType type, const QString &table) + : val(QVariant(type, nullptr)), + d(new QSqlFieldPrivate(fieldName, type, table)) { - d = new QSqlFieldPrivate(fieldName, type, table); - val = QVariant(QMetaType(type), nullptr); } /*! Constructs a copy of \a other. */ -QSqlField::QSqlField(const QSqlField& other) -{ - d = other.d; - d->ref.ref(); - val = other.val; -} +QSqlField::QSqlField(const QSqlField &other) + = default; /*! Sets the field equal to \a other. */ QSqlField& QSqlField::operator=(const QSqlField& other) -{ - qAtomicAssign(d, other.d); - val = other.val; - return *this; -} - + = default; /*! \fn bool QSqlField::operator!=(const QSqlField &other) const Returns \c true if the field is unequal to \a other; otherwise returns @@ -225,16 +166,10 @@ bool QSqlField::operator==(const QSqlField& other) const */ QSqlField::~QSqlField() -{ - if (!d->ref.deref()) - delete d; -} + = default; /*! - Sets the required status of this field to \a required. - - \sa requiredStatus(), setType(), setLength(), setPrecision(), - setDefaultValue(), setGenerated(), setReadOnly() + Sets \l requiredStatus to \a required. */ void QSqlField::setRequiredStatus(RequiredStatus required) { @@ -247,16 +182,11 @@ void QSqlField::setRequiredStatus(RequiredStatus required) Sets the required status of this field to \l Required if \a required is true; otherwise sets it to \l Optional. - \sa setRequiredStatus(), requiredStatus() + \sa requiredStatus */ /*! - Sets the field's length to \a fieldLength. For strings this is the - maximum number of characters the string can hold; the meaning - varies for other types. - - \sa length(), setType(), setRequiredStatus(), setPrecision(), - setDefaultValue(), setGenerated(), setReadOnly() + Sets \l length to \a fieldLength. */ void QSqlField::setLength(int fieldLength) { @@ -265,10 +195,7 @@ void QSqlField::setLength(int fieldLength) } /*! - Sets the field's \a precision. This only affects numeric fields. - - \sa precision(), setType(), setRequiredStatus(), setLength(), - setDefaultValue(), setGenerated(), setReadOnly() + Sets \l precision to \a precision. */ void QSqlField::setPrecision(int precision) { @@ -277,10 +204,16 @@ void QSqlField::setPrecision(int precision) } /*! - Sets the default value used for this field to \a value. + \property QSqlField::defaultValue + \since 6.8 - \sa defaultValue(), value(), setType(), setRequiredStatus(), - setLength(), setPrecision(), setGenerated(), setReadOnly() + This property holds the default value for this field. + Only some database drivers supports this property. Currently + those are SQLite, PostgreSQL, Oracle and MySQL/MariaDB. +*/ + +/*! + Sets \l defaultValue to \a value. */ void QSqlField::setDefaultValue(const QVariant &value) { @@ -288,23 +221,20 @@ void QSqlField::setDefaultValue(const QVariant &value) d->def = value; } +#if QT_DEPRECATED_SINCE(6, 8) /*! \internal + \deprecated [6.8] This internal value is no longer used. */ void QSqlField::setSqlType(int type) { detach(); d->tp = type; } +#endif /*! - Sets the generated state. If \a gen is false, no SQL will - be generated for this field; otherwise, Qt classes such as - QSqlQueryModel and QSqlTableModel will generate SQL for this - field. - - \sa isGenerated(), setType(), setRequiredStatus(), setLength(), - setPrecision(), setDefaultValue(), setReadOnly() + Sets \l generated to \a gen. */ void QSqlField::setGenerated(bool gen) { @@ -314,19 +244,28 @@ void QSqlField::setGenerated(bool gen) /*! - Sets the value of the field to \a value. If the field is read-only - (isReadOnly() returns \c true), nothing happens. + \property QSqlField::value + \since 6.8 + + This property holds the \a value as a QVariant + Setting a \a value to a read-only QSqlField is a no-op. If the data type of \a value differs from the field's current data type, an attempt is made to cast it to the proper type. This preserves the data type of the field in the case of assignment, e.g. a QString to an integer data type. To set the value to NULL, use clear(). - - \sa value(), isReadOnly(), defaultValue() */ +/*! + \fn QVariant QSqlField::value() const + + Returns the value of \l value. +*/ +/*! + Sets \l value to \a value. +*/ void QSqlField::setValue(const QVariant& value) { if (isReadOnly()) @@ -337,8 +276,6 @@ void QSqlField::setValue(const QVariant& value) /*! Clears the value of the field and sets it to NULL. If the field is read-only, nothing happens. - - \sa setValue(), isReadOnly(), requiredStatus() */ void QSqlField::clear() @@ -348,12 +285,10 @@ void QSqlField::clear() val = QVariant(d->type, nullptr); } -/*! - Sets the name of the field to \a name. - \sa name() +/*! + Sets \l name to \a name. */ - void QSqlField::setName(const QString& name) { detach(); @@ -361,9 +296,7 @@ void QSqlField::setName(const QString& name) } /*! - Sets the read only flag of the field's value to \a readOnly. A - read-only field cannot have its value set with setValue() and - cannot be cleared to NULL with clear(). + Sets \l readOnly to \a readOnly. */ void QSqlField::setReadOnly(bool readOnly) { @@ -372,17 +305,14 @@ void QSqlField::setReadOnly(bool readOnly) } /*! - \fn QVariant QSqlField::value() const + \property QSqlField::name - Returns the value of the field as a QVariant. - - Use isNull() to check if the field's value is NULL. + This property holds the name of the field. + This can be the column name or a user given alias. */ /*! - Returns the name of the field. - - \sa setName() + Returns the value of \l name. */ QString QSqlField::name() const { @@ -390,13 +320,20 @@ QString QSqlField::name() const } /*! - Returns the field's type as stored in the database. + \property QSqlField::metaType + \since 6.8 + + This property holds the field's type as stored in the database. Note that the actual value might have a different type, Numerical values that are too large to store in a long int or double are usually stored as strings to prevent precision loss. - \sa setType() + \sa QSqlDatabase::numericalPrecisionPolicy +*/ + +/*! + Returns the value of \l metaType. */ QMetaType QSqlField::metaType() const { @@ -404,10 +341,7 @@ QMetaType QSqlField::metaType() const } /*! - Set's the field's variant type to \a type. - - \sa type(), setRequiredStatus(), setLength(), setPrecision(), - setDefaultValue(), setGenerated(), setReadOnly() + Sets \l metaType to \a type. */ void QSqlField::setMetaType(QMetaType type) { @@ -419,7 +353,7 @@ void QSqlField::setMetaType(QMetaType type) /*! \fn QVariant::Type QSqlField::type() const - \deprecated Use metaType() instead. + \deprecated [6.0] Use metaType() instead. Returns the field's type as stored in the database. Note that the actual value might have a different type, @@ -427,50 +361,65 @@ void QSqlField::setMetaType(QMetaType type) int or double are usually stored as strings to prevent precision loss. - \sa metaType() + \sa metaType */ /*! \fn void QSqlField::setType(QVariant::Type type) - \deprecated Use setMetaType() instead. + \deprecated [6.0] Use setMetaType() instead. - Set's the field's variant type to \a type. + Sets the field's variant type to \a type. - \sa setMetaType() + \sa metaType */ /*! - Returns \c true if the field's value is read-only; otherwise returns - false. + \property QSqlField::readOnly + \since 6.8 - \sa setReadOnly(), type(), requiredStatus(), length(), precision(), - defaultValue(), isGenerated() + When this property is \c true then this QSqlField cannot be modified. + A read-only field cannot have its value set with setValue() and + cannot be cleared to NULL with clear(). +*/ + +/*! + Returns the value of \l readOnly. */ bool QSqlField::isReadOnly() const -{ return d->ro; } +{ + return d->ro; +} /*! Returns \c true if the field's value is NULL; otherwise returns false. - \sa value() + \sa value */ bool QSqlField::isNull() const -{ return val.isNull(); } +{ + return val.isNull(); +} /*! \internal */ void QSqlField::detach() { - qAtomicDetach(d); + d.detach(); } /*! - Returns \c true if this is a required field; otherwise returns \c false. + \property QSqlField::requiredStatus + \since 6.8 + + This property holds the RequiredStatus of the field. An \c INSERT will fail if a required field does not have a value. - \sa setRequiredStatus(), type(), length(), precision(), defaultValue(), - isGenerated() + \sa RequiredStatus +*/ + +/*! + Returns the value of \l requiredStatus. */ QSqlField::RequiredStatus QSqlField::requiredStatus() const { @@ -478,13 +427,19 @@ QSqlField::RequiredStatus QSqlField::requiredStatus() const } /*! - Returns the field's length. + \property QSqlField::length + \since 6.8 - If the returned value is negative, it means that the information + This property holds the field's length. + + If the value is negative, it means that the information is not available from the database. + For strings this is the maximum number of characters the string + can hold; the meaning varies for other types. +*/ - \sa setLength(), type(), requiredStatus(), precision(), defaultValue(), - isGenerated() +/*! + Returns the value of \l length. */ int QSqlField::length() const { @@ -492,14 +447,17 @@ int QSqlField::length() const } /*! - Returns the field's precision; this is only meaningful for numeric - types. + \property QSqlField::precision + \since 6.8 + + This property holds the field's precision; this is only meaningful + for numeric types. If the returned value is negative, it means that the information is not available from the database. - - \sa setPrecision(), type(), requiredStatus(), length(), defaultValue(), - isGenerated() +*/ +/*! + Returns the value of \l precision. */ int QSqlField::precision() const { @@ -507,18 +465,17 @@ int QSqlField::precision() const } /*! - Returns the field's default value (which may be NULL). - - \sa setDefaultValue(), type(), requiredStatus(), length(), precision(), - isGenerated() + Sets the value of \l defaultValue. */ QVariant QSqlField::defaultValue() const { return d->def; } +#if QT_DEPRECATED_SINCE(6, 8) /*! \internal + \deprecated [6.8] This internal value is no longer used. Returns the type ID for the field. @@ -529,13 +486,19 @@ int QSqlField::typeID() const { return d->tp; } +#endif /*! - Returns \c true if the field is generated; otherwise returns - false. + \property QSqlField::generated + \since 6.8 - \sa setGenerated(), type(), requiredStatus(), length(), precision(), - defaultValue() + This property holds the generated state. If \a generated is \c false, + no SQL will be generated for this field; otherwise, Qt classes such as + QSqlQueryModel and QSqlTableModel will generate SQL for this field. +*/ + +/*! + Returns the value of \l generated. */ bool QSqlField::isGenerated() const { @@ -566,8 +529,6 @@ QDebug operator<<(QDebug dbg, const QSqlField &f) dbg << ", required: " << (f.requiredStatus() == QSqlField::Required ? "yes" : "no"); dbg << ", generated: " << (f.isGenerated() ? "yes" : "no"); - if (f.typeID() >= 0) - dbg << ", typeID: " << f.typeID(); if (!f.defaultValue().isNull()) dbg << ", defaultValue: \"" << f.defaultValue() << '\"'; dbg << ", autoValue: " << f.isAutoValue() @@ -577,16 +538,21 @@ QDebug operator<<(QDebug dbg, const QSqlField &f) #endif /*! - Returns \c true if the value is auto-generated by the database, - for example auto-increment primary key values. + \property QSqlField::autoValue + \since 6.8 + + If the value is auto-generated by the database, + for example auto-increment primary key values, this value is \c true. \note When using the ODBC driver, due to limitations in the ODBC API, the \c isAutoValue() field is only populated in a QSqlField resulting from a QSqlRecord obtained by executing a \c SELECT query. It is \c false in a QSqlField resulting from a QSqlRecord returned from QSqlDatabase::record() or QSqlDatabase::primaryIndex(). +*/ - \sa setAutoValue() +/*! + Returns the value of \l autoValue. */ bool QSqlField::isAutoValue() const { @@ -594,11 +560,8 @@ bool QSqlField::isAutoValue() const } /*! - Marks the field as an auto-generated value if \a autoVal - is true. - - \sa isAutoValue() - */ + Sets \l autoValue to \a autoVal. +*/ void QSqlField::setAutoValue(bool autoVal) { detach(); @@ -606,24 +569,26 @@ void QSqlField::setAutoValue(bool autoVal) } /*! - Sets the tableName of the field to \a table. - - \sa tableName() + Sets \l tableName to \a tableName. */ -void QSqlField::setTableName(const QString &table) +void QSqlField::setTableName(const QString &tableName) { detach(); - d->table = table; + d->table = tableName; } /*! - Returns the tableName of the field. + \property QSqlField::tableName + \since 6.8 + + This property holds the tableName of the field. \note When using the QPSQL driver, due to limitations in the libpq library, the \c tableName() field is not populated in a QSqlField resulting from a QSqlRecord obtained by QSqlQuery::record() of a forward-only query. - - \sa setTableName() +*/ +/*! + Returns the \l tableName. */ QString QSqlField::tableName() const { @@ -631,3 +596,5 @@ QString QSqlField::tableName() const } QT_END_NAMESPACE + +#include "moc_qsqlfield.cpp" |