sbDBus.h

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set sw=2 :miv */
/*
 *=BEGIN SONGBIRD GPL
 *
 * This file is part of the Songbird web player.
 *
 * Copyright(c) 2005-2010 POTI, Inc.
 * http://www.songbirdnest.com
 *
 * This file may be licensed under the terms of of the
 * GNU General Public License Version 2 (the ``GPL'').
 *
 * Software distributed under the License is distributed
 * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
 * express or implied. See the GPL for the specific language
 * governing rights and limitations.
 *
 * You should have received a copy of the GPL along with this
 * program. If not, go to http://www.gnu.org/licenses/gpl.html
 * or write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 *=END SONGBIRD GPL
 */

#ifndef _SB_DBUS_H_
#define _SB_DBUS_H_

//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
//
// Songbird D-Bus service defs.
//
//   For D-Bus API documentation, see
// http://dbus.freedesktop.org/doc/api/html/index.html.
//
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------

//------------------------------------------------------------------------------
//
// Songbird D-Bus imported services.
//
//------------------------------------------------------------------------------

// Mozilla imports.
#include <nsStringGlue.h>

// D-Bus imports.
#include <dbus/dbus.h>


//------------------------------------------------------------------------------
//
// Songbird D-Bus service classes.
//
//------------------------------------------------------------------------------

class sbDBusMessage
{
  //----------------------------------------------------------------------------
  //
  // Public interface.
  //
  //----------------------------------------------------------------------------

public:

  static nsresult NewMethodCall(sbDBusMessage** aMessage,
                                const char*     aDestination,
                                const char*     aPath,
                                const char*     aInterface,
                                const char*     aMethod);

  nsresult GetArgs(int aFirstArgType,
                   ...);

  void Assign(DBusMessage* aMessage);

  DBusMessage* get() const
  {
    return mBaseMessage;
  }

  sbDBusMessage(DBusMessage* aMessage = NULL) : mBaseMessage(aMessage) {}

  virtual ~sbDBusMessage();


  //----------------------------------------------------------------------------
  //
  // Private interface.
  //
  //----------------------------------------------------------------------------

private:

  //
  //   mBaseMessage             Base D-Bus message data record.
  //

  DBusMessage*                  mBaseMessage;
};


class sbDBusConnection
{
  //----------------------------------------------------------------------------
  //
  // Public interface.
  //
  //----------------------------------------------------------------------------

public:

  static nsresult New(sbDBusConnection** aConnection,
                      DBusBusType        aBusType,
                      const char*        aDestination,
                      const char*        aPath,
                      const char*        aInterface);

  nsresult InvokeMethod(const char*     aMethod,
                        sbDBusMessage** aReply,
                        int             aFirstArgType,
                        ...);

  DBusConnection* get() const
  {
    return mBaseConnection;
  }

  virtual ~sbDBusConnection();


  //----------------------------------------------------------------------------
  //
  // Private interface.
  //
  //----------------------------------------------------------------------------

private:

  //
  // Private constants.
  //
  //   sMethodCallTimeoutMS     Amount of time in milliseconds to wait for
  //                            D-Bus method calls to complete.
  //

  static const PRUint32 sMethodCallTimeoutMS = 1000;


  //
  // Private fields.
  //
  //   mBaseConnection          Base D-Bus connection data record.
  //   mDestination             Default message destination.
  //   mPath                    Default message path.
  //   mInterface               Default message interface.
  //

  DBusConnection*               mBaseConnection;
  nsCString                     mDestination;
  nsCString                     mPath;
  nsCString                     mInterface;

  nsresult Initialize(DBusBusType aBusType,
                      const char* aDestination,
                      const char* aPath,
                      const char* aInterface);

  sbDBusConnection();
};


class sbDBusError : public DBusError
{
public:

  sbDBusError();

  virtual ~sbDBusError();
};


//------------------------------------------------------------------------------
//
// Songbird D-Bus service macros.
//
//------------------------------------------------------------------------------

#if defined(DEBUG)

#define SB_DBUS_ENSURE_SUCCESS_BODY(aError, aReturnValue)                      \
  char* msg = PR_smprintf("SB_DBUS_ENSURE_SUCCESS(%s, %s) failed with "        \
                          "result %s",                                         \
                          #aError,                                             \
                          #aReturnValue,                                       \
                          aError.message);                                     \
  NS_WARNING(msg);                                                             \
  PR_smprintf_free(msg);

#else

#define SB_DBUS_ENSURE_SUCCESS_BODY(aError, aReturnValue)                      \
  NS_WARNING("SB_DBUS_ENSURE_SUCCESS(" #aError ", " #aReturnValue ") failed");

#endif


#define SB_DBUS_ENSURE_SUCCESS(aError, aReturnValue)                           \
  PR_BEGIN_MACRO                                                               \
    if (dbus_error_is_set(&aError)) {                                          \
      SB_DBUS_ENSURE_SUCCESS_BODY(aError, aReturnValue)                        \
      return aReturnValue;                                                     \
    }                                                                          \
  PR_END_MACRO


#endif // _SB_DBUS_H_