libosso.h

Go to the documentation of this file.

#ifndef LIBOSSO_H_
#define LIBOSSO_H_

#include <glib.h>
#include <time.h>
#include <syslog.h>

#define DBUS_API_SUBJECT_TO_CHANGE

#include <dbus/dbus.h>
#include <dbus/dbus-protocol.h>

G_BEGIN_DECLS


typedef enum {
  OSSO_OK = 0, 
  OSSO_ERROR = -1, 
  OSSO_INVALID = -2, 
  OSSO_RPC_ERROR = -4, 
  OSSO_ERROR_NAME = -3,
  OSSO_ERROR_NO_STATE = -5, 
  OSSO_ERROR_STATE_SIZE = -6 
} osso_return_t;


typedef struct osso_af_context_t osso_context_t;

osso_context_t * osso_initialize(const gchar *application,
                                 const gchar* version,
                                 gboolean activation,
                                 GMainContext *context);
void osso_deinitialize(osso_context_t *osso);

/* @} */
/************************************************************************/
/* @{*/

typedef struct {
  int type; 
  union {
    guint32 u; 
    gint32 i; 
    gboolean b; 
    gdouble d; 
    gchar *s; 
  } value; 
}
osso_rpc_t;

void osso_rpc_free_val (osso_rpc_t *rpc);

typedef gint (osso_rpc_cb_f)(const gchar *interface, const gchar *method,
                             GArray *arguments, gpointer data,
                             osso_rpc_t *retval);

typedef void (osso_rpc_async_f)(const gchar *interface,
                                const gchar *method,
                                osso_rpc_t *retval, gpointer data);

osso_return_t osso_rpc_run (osso_context_t * osso, const gchar * service,
                            const gchar * object_path,
                            const gchar * interface, const gchar * method,
                            osso_rpc_t * retval, int argument_type, ...);

typedef void osso_rpc_argfill (DBusMessage *msg, void *data);

osso_return_t osso_rpc_run_with_argfill (osso_context_t * osso,
                                         const gchar * service,
                                         const gchar * object_path,
                                         const gchar * interface,
                                         const gchar * method,
                                         osso_rpc_t * retval,
                                         osso_rpc_argfill *argfill,
                                         gpointer argfill_data);

osso_return_t osso_rpc_run_system (osso_context_t * osso, const gchar * service,
                            const gchar * object_path,
                            const gchar * interface, const gchar * method,
                            osso_rpc_t * retval, int argument_type, ...);

/* See #osso_rpc_run_with_argfill.  The RPC call is sent on the system
 * bus instead.
 *
 * WARNING: Using this function is not recommended, because it will
 * make your program more dependent on the DBus API due to the
 * appending of arguments to a DBusMessage.
 */
osso_return_t osso_rpc_run_system_with_argfill (osso_context_t * osso,
                                                const gchar * service,
                                                const gchar * object_path,
                                                const gchar * interface,
                                                const gchar * method,
                                                osso_rpc_t *retval,
                                                osso_rpc_argfill *argfill,
                                                gpointer argfill_data);

osso_return_t osso_rpc_run_with_defaults (osso_context_t * osso,
                                          const gchar * application,
                                          const gchar * method,
                                          osso_rpc_t * retval,
                                          int argument_type, ...);

osso_return_t osso_rpc_async_run (osso_context_t * osso,
                                  const gchar * service,
                                  const gchar * object_path,
                                  const gchar * interface,
                                  const gchar * method,
                                  osso_rpc_async_f * async_cb, gpointer data,
                                  int argument_type, ...);

osso_return_t osso_rpc_async_run_with_argfill (osso_context_t * osso,
                                               const gchar * service,
                                               const gchar * object_path,
                                               const gchar * interface,
                                               const gchar * method,
                                               osso_rpc_async_f * async_cb,
                                               gpointer data,
                                               osso_rpc_argfill *argfill,
                                               gpointer argfill_data);

osso_return_t osso_rpc_async_run_with_defaults (osso_context_t * osso,
                                                const gchar * application,
                                                const gchar * method,
                                                osso_rpc_async_f * async_cb,
                                                gpointer data,
                                                int argument_type, ...);

typedef void osso_rpc_retval_free_f (osso_rpc_t *retval);

osso_return_t osso_rpc_set_cb_f_with_free (osso_context_t * osso, const gchar * service,
                                           const gchar * object_path,
                                           const gchar * interface, osso_rpc_cb_f * cb,
                                           gpointer data,
                                           osso_rpc_retval_free_f *retval_free);

osso_return_t osso_rpc_set_cb_f (osso_context_t * osso, const gchar * service,
                                 const gchar * object_path,
                                 const gchar * interface, osso_rpc_cb_f * cb,
                                 gpointer data);

osso_return_t osso_rpc_set_default_cb_f_with_free (osso_context_t * osso,
                                                   osso_rpc_cb_f * cb, gpointer data,
                                                   osso_rpc_retval_free_f *retval_free);

osso_return_t osso_rpc_set_default_cb_f (osso_context_t * osso,
                                         osso_rpc_cb_f * cb, gpointer data);


osso_return_t osso_rpc_unset_cb_f (osso_context_t * osso,
                                   const gchar * service,
                                   const gchar * object_path,
                                   const gchar * interface,
                                   osso_rpc_cb_f * cb, gpointer data);

osso_return_t osso_rpc_unset_default_cb_f (osso_context_t * osso,
                                           osso_rpc_cb_f * cb, gpointer data);

osso_return_t osso_rpc_get_timeout (osso_context_t * osso, gint * timeout);

osso_return_t osso_rpc_set_timeout(osso_context_t * osso, gint timeout);

/* @}*/
/**********************************************************************/
osso_return_t osso_application_top(osso_context_t *osso,
                                   const gchar *application,
                                   const gchar *arguments);

typedef void(osso_application_top_cb_f)(const gchar *arguments,
                                        gpointer data);

osso_return_t osso_application_set_top_cb(osso_context_t *osso,
                                          osso_application_top_cb_f *cb,
                                          gpointer data);

osso_return_t osso_application_unset_top_cb(osso_context_t *osso,
                                            osso_application_top_cb_f *cb,
                                            gpointer data);

/**********************************************************************/
/* @}*/

typedef void(osso_application_autosave_cb_f)(gpointer data);

osso_return_t osso_application_set_autosave_cb(osso_context_t *osso,
                                               osso_application_autosave_cb_f *cb,
                                               gpointer data);

osso_return_t osso_application_unset_autosave_cb(osso_context_t *osso,
                                                 osso_application_autosave_cb_f *cb,
                                                 gpointer data);

osso_return_t osso_application_userdata_changed(osso_context_t *osso);

osso_return_t osso_application_autosave_force(osso_context_t *osso);

/*
 * Returns the application name of a Libosso context.
 * @param osso The library context as returned by #osso_initialize.
 * @return The name of the parent application, or NULL if the context
 * is invalid.
 */
const gchar * osso_application_name_get(osso_context_t *osso);

/*
 * Returns the application version of a Libosso context.
 * @param osso The library context as returned by #osso_initialize.
 * @return The version of the application, or NULL if the context is
 * invalid.
 */
const gchar * osso_application_version_get(osso_context_t *osso);

/**********************************************************************/
/* @{*/

osso_return_t osso_statusbar_send_event(osso_context_t *osso,
                                        const gchar *name,
                                        gint argument1, gint argument2,
                                        const gchar *argument3,
                                        osso_rpc_t *retval);

/* @}*/
/* @{*/

typedef void(osso_time_cb_f)(gpointer data);

osso_return_t osso_time_set_notification_cb(osso_context_t *osso,
                                            osso_time_cb_f *cb,
                                            gpointer data);
osso_return_t osso_time_set(osso_context_t *osso, time_t new_time);

/* @}*/
/* @{*/

typedef void(osso_locale_change_cb_f)(const char *new_locale, gpointer data);

osso_return_t osso_locale_change_set_notification_cb(osso_context_t *osso,
                                            osso_locale_change_cb_f *cb,
                                            gpointer data);

osso_return_t osso_locale_set(osso_context_t *osso, char *new_locale);

/* @}*/
/* @{*/

typedef enum {
  OSSO_GN_WARNING = 0, 
  OSSO_GN_ERROR,         
  OSSO_GN_NOTICE,        
  OSSO_GN_WAIT
} osso_system_note_type_t;

osso_return_t osso_system_note_dialog(osso_context_t *osso,
                                      const gchar *message,
                                      osso_system_note_type_t type,
                                      osso_rpc_t *retval);

osso_return_t osso_system_note_infoprint(osso_context_t *osso,
                                         const gchar *text,
                                         osso_rpc_t *retval);

/* @}*/
/**********************************************************************/
/* @{*/

typedef struct {
  guint32 state_size; 
  gpointer state_data; 
} osso_state_t;

osso_return_t osso_state_write(osso_context_t *osso, osso_state_t *state);

osso_return_t osso_state_read(osso_context_t *osso, osso_state_t *state);


/* @}*/
/**********************************************************************/
/* @{*/
osso_return_t osso_cp_plugin_execute(osso_context_t *osso,
                                     const gchar *filename,
                                     gpointer data, gboolean user_activated);

osso_return_t osso_cp_plugin_save_state(osso_context_t *osso,
                                        const gchar *filename,
                                        gpointer data);
/* @}*/
/**********************************************************************/
typedef enum {
  OSSO_DEVMODE_NORMAL = 0, /* Normal mode */
  OSSO_DEVMODE_FLIGHT,     /* Flight mode */
  OSSO_DEVMODE_OFFLINE,    /* Offline mode; unsupported! */
  OSSO_DEVMODE_INVALID     /* Should *never* occur! */
} osso_devmode_t;


typedef struct {
  gboolean shutdown_ind; 
  gboolean save_unsaved_data_ind; 
  gboolean memory_low_ind; 
  gboolean system_inactivity_ind; 
  osso_devmode_t sig_device_mode_ind; 
} osso_hw_state_t;


osso_return_t osso_display_state_on(osso_context_t *osso);

osso_return_t osso_display_blanking_pause(osso_context_t *osso);

typedef void (osso_hw_cb_f)(osso_hw_state_t *state, gpointer data);

osso_return_t osso_hw_set_event_cb(osso_context_t *osso,
                                   osso_hw_state_t *state,
                                   osso_hw_cb_f *cb, gpointer data);

osso_return_t osso_hw_unset_event_cb(osso_context_t *osso,
                                     osso_hw_state_t *state);


typedef enum {
  OSSO_DISPLAY_ON,
  OSSO_DISPLAY_OFF,
  OSSO_DISPLAY_DIMMED
} osso_display_state_t;

typedef void(osso_display_event_cb_f)(osso_display_state_t state,
                                      gpointer data);

osso_return_t osso_hw_set_display_event_cb(osso_context_t *osso,
                                           osso_display_event_cb_f *cb,
                                           gpointer data);

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

typedef void (osso_mime_cb_f)(gpointer data, int argc, gchar **argv);

osso_return_t osso_mime_set_cb(osso_context_t *osso, osso_mime_cb_f *cb,
                               gpointer data);

osso_return_t osso_mime_unset_cb(osso_context_t *osso);

osso_return_t osso_mime_unset_cb_full(osso_context_t *osso,
                                      osso_mime_cb_f *cb, gpointer data);
gpointer osso_get_dbus_connection(osso_context_t *osso);


gpointer osso_get_sys_dbus_connection(osso_context_t *osso);

G_END_DECLS

#endif /* LIBOSSO_H_*/

---