Kexi API Documentation (2.0 alpha)
	Overview Class Hierarchy Classes Classes (annotated) Members Source Files

kexidb/utils.h

Go to the documentation of this file.

/* This file is part of the KDE project
   Copyright (C) 2004-2006 Jaroslaw Staniek <js@iidea.pl>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
*/


#ifndef KEXIDB_UTILS_H
#define KEXIDB_UTILS_H

#include <qvaluelist.h>
#include <qvariant.h>

#include <kexidb/connection.h>
#include <kexidb/driver.h>

class QDomNode;
class QDomElement;
class QDomDocument;

namespace KexiDB
{
    inline KEXI_DB_EXPORT bool deleteRow(Connection &conn, TableSchema *table, 
        const QString &keyname, const QString &keyval)
    {
        return table!=0 && conn.executeSQL("DELETE FROM " + table->name() + " WHERE " 
            + keyname + "=" + conn.driver()->valueToSQL( Field::Text, QVariant(keyval) ));
    }

    inline KEXI_DB_EXPORT bool deleteRow(Connection &conn, const QString &tableName, 
        const QString &keyname, const QString &keyval)
    {
        return conn.executeSQL("DELETE FROM " + tableName + " WHERE " 
            + keyname + "=" + conn.driver()->valueToSQL( Field::Text, QVariant(keyval) ));
    }

    inline KEXI_DB_EXPORT bool deleteRow(Connection &conn, TableSchema *table, 
        const QString &keyname, int keyval)
    {
        return table!=0 && conn.executeSQL("DELETE FROM " + table->name() + " WHERE " 
            + keyname + "=" + conn.driver()->valueToSQL( Field::Integer, QVariant(keyval) ));
    }

    inline KEXI_DB_EXPORT bool deleteRow(Connection &conn, const QString &tableName, 
        const QString &keyname, int keyval)
    {
        return conn.executeSQL("DELETE FROM " + tableName + " WHERE " 
            + keyname + "=" + conn.driver()->valueToSQL( Field::Integer, QVariant(keyval) ));
    }

    inline KEXI_DB_EXPORT bool deleteRow(Connection &conn, const QString &tableName, 
        const QString &keyname1, Field::Type keytype1, const QVariant& keyval1, 
        const QString &keyname2, Field::Type keytype2, const QVariant& keyval2)
    {
        return conn.executeSQL("DELETE FROM " + tableName + " WHERE " 
            + keyname1 + "=" + conn.driver()->valueToSQL( keytype1, keyval1 )
            + " AND " + keyname2 + "=" + conn.driver()->valueToSQL( keytype2, keyval2 ));
    }

    inline KEXI_DB_EXPORT bool replaceRow(Connection &conn, TableSchema *table, 
        const QString &keyname, const QString &keyval, const QString &valname, QVariant val, int ftype)
    {
        if (!table || !KexiDB::deleteRow(conn, table, keyname, keyval))
            return false;
        return conn.executeSQL("INSERT INTO " + table->name() 
            + " (" + keyname + "," + valname + ") VALUES (" 
            + conn.driver()->valueToSQL( Field::Text, QVariant(keyval) ) + "," 
            + conn.driver()->valueToSQL( ftype, val) + ")");
    }

    typedef QValueList<uint> TypeGroupList;

    KEXI_DB_EXPORT const TypeGroupList typesForGroup(Field::TypeGroup typeGroup);

    KEXI_DB_EXPORT QStringList typeNamesForGroup(Field::TypeGroup typeGroup);

    KEXI_DB_EXPORT QStringList typeStringsForGroup(Field::TypeGroup typeGroup);

    KEXI_DB_EXPORT Field::Type defaultTypeForGroup(Field::TypeGroup typeGroup);

    inline bool isEmptyValue(Field *f, const QVariant &v) {
        if (f->hasEmptyProperty() && v.toString().isEmpty() && !v.toString().isNull())
            return true;
        return v.isNull();
    }

    KEXI_DB_EXPORT void getHTMLErrorMesage(Object* obj, QString& msg, QString &details);

    KEXI_DB_EXPORT void getHTMLErrorMesage(Object* obj, QString& msg);

    KEXI_DB_EXPORT void getHTMLErrorMesage(Object* obj, ResultInfo *result);

    inline KEXI_DB_EXPORT QString sqlWhere(Driver *drv, Field::Type t, 
        const QString fieldName, const QVariant value)
    {
        if (value.isNull())
            return fieldName + " is NULL";
        return fieldName + "=" + drv->valueToSQL( t, value );
    }

    KEXI_DB_EXPORT int idForObjectName( Connection &conn, const QString& objName, int objType );

    class KEXI_DB_EXPORT TableOrQuerySchema {
        public:
            TableOrQuerySchema(Connection *conn, const QCString& name);

            TableOrQuerySchema(Connection *conn, const QCString& name, bool table);

            TableOrQuerySchema(FieldList &tableOrQuery);
            
            TableOrQuerySchema(Connection *conn, int id);

            TableOrQuerySchema(TableSchema* table);

            TableOrQuerySchema(QuerySchema* query);

            QuerySchema* query() const { return m_query; }

            TableSchema* table() const { return m_table; }

            QCString name() const;

            QString captionOrName() const;

            const QueryColumnInfo::Vector columns(bool unique = false);

            Field* field(const QString& name);

            QueryColumnInfo* columnInfo(const QString& name);

            Connection* connection() const;

            QString debugString();

            void debug();

        protected:
            QCString m_name; 

            TableSchema* m_table;
            QuerySchema* m_query;
    };


    int rowCount(Connection &conn, const QString& sql);


    KEXI_DB_EXPORT int rowCount(const TableSchema& tableSchema);


    KEXI_DB_EXPORT int rowCount(QuerySchema& querySchema);


    KEXI_DB_EXPORT int rowCount(TableOrQuerySchema& tableOrQuery);

    KEXI_DB_EXPORT int fieldCount(TableOrQuerySchema& tableOrQuery);

    KEXI_DB_EXPORT void connectionTestDialog(QWidget* parent, const ConnectionData& data, 
        MessageHandler& msgHandler);

    KEXI_DB_EXPORT QMap<QString,QString> toMap( const ConnectionData& data );

    KEXI_DB_EXPORT void fromMap( const QMap<QString,QString>& map, ConnectionData& data );

    enum SplitToTableAndFieldPartsOptions {
        FailIfNoTableOrFieldName = 0, 
        SetFieldNameIfNoTableName = 1 
    };

    KEXI_DB_EXPORT bool splitToTableAndFieldParts(const QString& string, 
        QString& tableName, QString& fieldName, 
        SplitToTableAndFieldPartsOptions option = FailIfNoTableOrFieldName);

    KEXI_DB_EXPORT bool supportsVisibleDecimalPlacesProperty(Field::Type type);

    KEXI_DB_EXPORT QString formatNumberForVisibleDecimalPlaces(double value, int decimalPlaces);

    KEXI_DB_EXPORT bool isBuiltinTableFieldProperty( const QCString& propertyName );

    KEXI_DB_EXPORT bool isExtendedTableFieldProperty( const QCString& propertyName );

    KEXI_DB_EXPORT Field::Type intToFieldType( int type );

    KEXI_DB_EXPORT bool setFieldProperties( Field& field, const QMap<QCString, QVariant>& values );

    KEXI_DB_EXPORT bool setFieldProperty(Field& field, const QCString& propertyName, 
        const QVariant& value);

    KEXI_DB_EXPORT QVariant loadPropertyValueFromDom( const QDomNode& node );

    KEXI_DB_EXPORT int loadIntPropertyValueFromDom( const QDomNode& node, bool* ok );

    KEXI_DB_EXPORT QString loadStringPropertyValueFromDom( const QDomNode& node, bool* ok );

    QDomElement saveNumberElementToDom(QDomDocument& doc, QDomElement& parentEl, 
        const QString& elementName, int value);

    QDomElement saveBooleanElementToDom(QDomDocument& doc, QDomElement& parentEl, 
        const QString& elementName, bool value);

    KEXI_DB_EXPORT QVariant emptyValueForType( Field::Type type );

    KEXI_DB_EXPORT QVariant notEmptyValueForType( Field::Type type );

    enum BLOBEscapingType {
        BLOBEscapeXHex = 1,        
        BLOBEscape0xHex,           
        BLOBEscapeHex,              
        BLOBEscapeOctal           


    };


    KEXI_DB_EXPORT QString escapeBLOB(const QByteArray& array, BLOBEscapingType type);

    KEXI_DB_EXPORT QByteArray pgsqlByteaToByteArray(const char* data, int length);

    KEXI_DB_EXPORT QString variantToString( const QVariant& v );

    KEXI_DB_EXPORT QVariant stringToVariant( const QString& s, QVariant::Type type, bool &ok );

    KEXI_DB_EXPORT bool isDefaultValueAllowed( Field* field );


    KEXI_DB_EXPORT void getLimitsForType(Field::Type type, int &minValue, int &maxValue);

    KEXI_DB_EXPORT void debugRowData(const RowData& rowData);

    KEXI_DB_EXPORT Field::Type maximumForIntegerTypes(Field::Type t1, Field::Type t2);

    inline QVariant cstringToVariant(const char* data, KexiDB::Field* f, int length = -1)
    {
        if (!data)
            return QVariant();
        // from mo st to least frequently used types:

        if (!f || f->isTextType())
            return QString::fromUtf8(data, length);
        if (f->isIntegerType()) {
            if (f->type()==KexiDB::Field::BigInteger)
                return QVariant( QString::fromLatin1(data, length).toLongLong() );
            return QVariant( QString::fromLatin1(data, length).toInt() );
        }
        if (f->isFPNumericType())
            return QString::fromLatin1(data, length).toDouble();
        if (f->type()==KexiDB::Field::BLOB) {
            QByteArray ba;
            ba.duplicate(data, length);
            return ba;
        }
        // the default
        QVariant result(QString::fromUtf8(data, length));
        if (!result.cast( KexiDB::Field::variantType(f->type()) ))
            return QVariant();
        return result;
    }
}

#endif

This file is part of the documentation for Kexi 2.0 alpha.

Documentation copyright © 2002-2007 the Kexi Team.
Generated on Tue Apr 1 20:48:57 2008 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2003