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

**

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

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the QtDBus 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 for the convenience

// of the QLibrary class.  This header file may change from

// version to version without notice, or even be removed.

//

// We mean it.

//

#ifndef QDBUSUTIL_H

#define QDBUSUTIL_H

#include <QtCore/qstring.h>

#include <QtCore/qvariant.h>

#include <QtDBus/qdbusmacros.h>

#include <QtDBus/qdbuserror.h>

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE

namespace QDBusUtil

{

    QDBUS_EXPORT bool isValidInterfaceName(const QString &ifaceName);

    QDBUS_EXPORT bool isValidUniqueConnectionName(const QString &busName);

    QDBUS_EXPORT bool isValidBusName(const QString &busName);

    QDBUS_EXPORT bool isValidMemberName(const QString &memberName);

    QDBUS_EXPORT bool isValidErrorName(const QString &errorName);

    QDBUS_EXPORT bool isValidPartOfObjectPath(const QString &path);

    QDBUS_EXPORT bool isValidObjectPath(const QString &path);

    QDBUS_EXPORT bool isValidSignature(const QString &signature);

    QDBUS_EXPORT bool isValidSingleSignature(const QString &signature);

    QDBUS_EXPORT QString argumentToString(const QVariant &variant);

    enum AllowEmptyFlag {

        EmptyAllowed,

        EmptyNotAllowed

    };

    inline bool checkInterfaceName(const QString &name, AllowEmptyFlag empty, QDBusError *error)

    {

        if (name.isEmpty()) {

            if (empty == EmptyAllowed) return true;

            *error = QDBusError(QDBusError::InvalidInterface, QLatin1String("Interface name cannot be empty"));

            return false;

        }

        if (isValidInterfaceName(name)) return true;

        *error = QDBusError(QDBusError::InvalidInterface, QString::fromLatin1("Invalid interface class: %1").arg(name));

        return false;

    }

    inline bool checkBusName(const QString &name, AllowEmptyFlag empty, QDBusError *error)

    {

        if (name.isEmpty()) {

            if (empty == EmptyAllowed) return true;

            *error = QDBusError(QDBusError::InvalidService, QLatin1String("Service name cannot be empty"));

            return false;

        }

        if (isValidBusName(name)) return true;

        *error = QDBusError(QDBusError::InvalidService, QString::fromLatin1("Invalid service name: %1").arg(name));

        return false;

    }

    inline bool checkObjectPath(const QString &path, AllowEmptyFlag empty, QDBusError *error)

    {

        if (path.isEmpty()) {

            if (empty == EmptyAllowed) return true;

            *error = QDBusError(QDBusError::InvalidObjectPath, QLatin1String("Object path cannot be empty"));

            return false;

        }

        if (isValidObjectPath(path)) return true;

        *error = QDBusError(QDBusError::InvalidObjectPath, QString::fromLatin1("Invalid object path: %1").arg(path));

        return false;

    }

    inline bool checkMemberName(const QString &name, AllowEmptyFlag empty, QDBusError *error, const char *nameType = 0)

    {

        if (!nameType) nameType = "member";

        if (name.isEmpty()) {

            if (empty == EmptyAllowed) return true;

            *error = QDBusError(QDBusError::InvalidMember, QLatin1String(nameType) + QLatin1String(" name cannot be empty"));

            return false;

        }

        if (isValidMemberName(name)) return true;

        *error = QDBusError(QDBusError::InvalidMember, QString::fromLatin1("Invalid %1 name: %2")

                            .arg(QString::fromLatin1(nameType), name));

        return false;

    }

    inline bool checkErrorName(const QString &name, AllowEmptyFlag empty, QDBusError *error)

    {

        if (name.isEmpty()) {

            if (empty == EmptyAllowed) return true;

            *error = QDBusError(QDBusError::InvalidInterface, QLatin1String("Error name cannot be empty"));

            return false;

        }

        if (isValidErrorName(name)) return true;

        *error = QDBusError(QDBusError::InvalidInterface, QString::fromLatin1("Invalid error name: %1").arg(name));

        return false;

    }

}

QT_END_NAMESPACE

QT_END_HEADER

#endif