annotate src/dbus-server.h @ 11080:f54740547c95

[gaim-migrate @ 13092] All gaim signals are automatically relayed to dbus. committer: Tailor Script <[e-mail]>

/**
 * @file dbus-server.h Gaim DBUS Server
 * @ingroup core
 *
 * gaim
 *
 * Gaim is the legal property of its developers, whose names are too numerous
 * to list here.  Please refer to the COPYRIGHT file distributed with this
 * source distribution.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */

#ifndef _GAIM_DBUS_SERVER_H_
#define _GAIM_DBUS_SERVER_H_

#include <glib-object.h>
#include "value.h"

G_BEGIN_DECLS

/* These are the categories of codes used by gaim dbus implementation
   for remote calls.  In practice, they don't matter
 */
typedef enum {
  DBUS_ERROR_NONE = 0,
  DBUS_ERROR_NOT_FOUND = 1
} DbusErrorCodes;

/* Types of pointers that can be registered with the gaim dbus pointer
   registration engine.  See below */
typedef enum {
  DBUS_POINTER_GROUP,
  DBUS_POINTER_CONTACT,
  DBUS_POINTER_BUDDY,
  DBUS_POINTER_CHAT,
  DBUS_POINTER_ACCOUNT
} GaimDBusPointerType;

typedef struct _GaimObject GaimObject;

/** The main GaimObject  */
GaimObject * gaim_dbus_object;

/**
 * Starts the gaim DBUS server.  It is responsible for handling DBUS
 * requests from other applications.
 *
 * @return TRUE if successful, FALSE otherwise.
 */
gboolean gaim_dbus_init(void);

gboolean gaim_dbus_connect(GaimObject *object);

/**
   Initializes gaim dbus pointer registration engine.

   Remote dbus applications need a way of addressing objects exposed
   by gaim to the outside world.  In gaim itself, these objects (such
   as GaimBuddy and company) are identified by pointers.  The gaim
   dbus pointer registration engine converts pointers to handles and
   back.

   In order for an object to participate in the scheme, it must
   register itself and its type with the engine.  This registration
   allocates an integer id which can be resolved to the pointer and
   back.  

   Handles are not persistent.  They are reissued every time gaim is
   started.  This is not good; external applications that use gaim
   should work even whether gaim was restarted in the middle of the
   interaction.

   Pointer registration is only a temporary solution.  When GaimBuddy
   and similar structures have been converted into gobjects, this
   registration will be done automatically by objects themselves.
   
   By the way, this kind of object-handle translation should be so
   common that there must be a library (maybe even glib) that
   implements it.  I feel a bit like reinventing the wheel here.
*/
void gaim_dbus_init_ids(void);

/** 
    Registers a typed pointer.

    @node   The pointer to register.
    @type   Type of that pointer.
 */
void gaim_dbus_register_pointer(gpointer node, GaimDBusPointerType type);

/** 
    Unregisters a pointer previously registered with
    gaim_dbus_register_pointer.

    @node   The pointer to register.
 */
void gaim_dbus_unregister_pointer(gpointer node);

/**
    Registers a gaim signal with a #GaimObject.  

    @param object      The #GaimObject (usually #gaim_dbus_object)
    @param name        Name of the signal
    @param marshaller  Marshaller for the signal.
    @param num_values  The number of parameters.
    @param values      Array of pointers to #GaimValue objects representing
                       the types of the parameters.
    @result            The dbus id of the registered signal.

    This function is intended to be used in signal.h, where it
    automatically registers all gaim signals with dbus.  For your own
    dbus signals, use #gaim_dbus_register.

    The name of the signal, usually in the form "aaa-bbb-ccc", is
    converted into DBus standard, "AaaBbbCcc", because "aaa-bbb-ccc"
    doesn't work with DBus GObject binding version 0.34 (cvs version is ok).

    The #marshaller can be set to gaim_dbus_invalid_marshaller because
    DBus signals are never passed to any local handler.
  */
int gaim_dbus_signal_register_gaim(GaimObject *object, const char *name, 
				   GSignalCMarshaller marshaller, 
				   int num_values, GaimValue **values);

/**
    Emits a dbus signal.

    @param object      The #GaimObject (usually #gaim_dbus_object)
    @param dbus_id     Id of the signal.
    @param num_values  The number of parameters.
    @param values      Array of pointers to #GaimValue objects representing
                       the types of the parameters.
    @param vargs       A va_list containing the actual parameters.

    This function is intended to be used in signal.h, where it
    automatically emits all gaim signals to dbus.  For your own dbus
    signals, use #gaim_dbus_emit.
  */
void gaim_dbus_signal_emit_gaim(GaimObject *object, int dbus_id, 
				int num_values, GaimValue **values, va_list vargs);

/**
    A marshaller that emits an "assertion failed" message if called.  

    This marshaller is intended to use with signal that will never need to be marshalled.
  */
void gaim_dbus_invalid_marshaller(GClosure *closure,
				  GValue *return_value,
				  guint n_param_values,
				  const GValue *param_values,
				  gpointer invocation_hint,
				  gpointer marshal_data);

/**
    Registers a gaim signal with a #GaimObject.  

    @param object      The #GaimObject (usually #gaim_dbus_object)
    @param name        Name of the signal
    @param marshaller  Marshaller for the signal.
    @param num_values  The number of parameters.
    @param ...         List of GType of the parameter types.

    @result            The dbus id of the registered signal.
  */
int gaim_dbus_signal_register(GaimObject *object, const char *name, 
			      GSignalCMarshaller marshaller, 
			      int num_values, ...);

/**
    Emits a dbus signal.

    @param object      The #GaimObject (usually #gaim_dbus_object)
    @param dbus_id     Id of the signal.
    @param ...         Actual parameters.
  */
void gaim_dbus_signal_emit(GaimObject *object, int dbus_id, ...);

/**
    Emits a dbus signal.

    @param object      The #GaimObject (usually #gaim_dbus_object)
    @param dbus_id     Id of the signal.
    @param vargs       A va_list containing the actual parameters.
  */
void gaim_dbus_signal_emit_valist(GaimObject *object, int dbus_id, va_list args);


G_END_DECLS

#endif	/* _GAIM_DBUS_SERVER_H_ */