src/core/linux/SDL_dbus.h
author Sam Lantinga <slouken@libsdl.org>
Wed, 03 Jan 2018 10:03:25 -0800
changeset 11811 5d94cb6b24d3
parent 11043 5be3faa49e54
child 12201 8bdc4d340419
permissions -rw-r--r--
Updated copyright for 2018
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2018 Sam Lantinga <slouken@libsdl.org>
     4 
     5   This software is provided 'as-is', without any express or implied
     6   warranty.  In no event will the authors be held liable for any damages
     7   arising from the use of this software.
     8 
     9   Permission is granted to anyone to use this software for any purpose,
    10   including commercial applications, and to alter it and redistribute it
    11   freely, subject to the following restrictions:
    12 
    13   1. The origin of this software must not be misrepresented; you must not
    14      claim that you wrote the original software. If you use this software
    15      in a product, an acknowledgment in the product documentation would be
    16      appreciated but is not required.
    17   2. Altered source versions must be plainly marked as such, and must not be
    18      misrepresented as being the original software.
    19   3. This notice may not be removed or altered from any source distribution.
    20 */
    21 
    22 #include "../../SDL_internal.h"
    23 
    24 #ifndef SDL_dbus_h_
    25 #define SDL_dbus_h_
    26 
    27 #ifdef HAVE_DBUS_DBUS_H
    28 #define SDL_USE_LIBDBUS 1
    29 #include "SDL_stdinc.h"
    30 #include <dbus/dbus.h>
    31 
    32 
    33 typedef struct SDL_DBusContext {
    34     DBusConnection *session_conn;
    35     DBusConnection *system_conn;
    36 
    37     DBusConnection *(*bus_get_private)(DBusBusType, DBusError *);
    38     dbus_bool_t (*bus_register)(DBusConnection *, DBusError *);
    39     void (*bus_add_match)(DBusConnection *, const char *, DBusError *);
    40     DBusConnection * (*connection_open_private)(const char *, DBusError *);
    41     void (*connection_set_exit_on_disconnect)(DBusConnection *, dbus_bool_t);
    42     dbus_bool_t (*connection_get_is_connected)(DBusConnection *); 	
    43     dbus_bool_t (*connection_add_filter)(DBusConnection *, DBusHandleMessageFunction,
    44 	    void *, DBusFreeFunction);
    45     dbus_bool_t (*connection_try_register_object_path)(DBusConnection *, const char *,
    46         const DBusObjectPathVTable *, void *, DBusError *);
    47     dbus_bool_t (*connection_send)(DBusConnection *, DBusMessage *, dbus_uint32_t *);
    48     DBusMessage *(*connection_send_with_reply_and_block)(DBusConnection *, DBusMessage *, int, DBusError *);
    49     void (*connection_close)(DBusConnection *);
    50     void (*connection_unref)(DBusConnection *);
    51     void (*connection_flush)(DBusConnection *);
    52     dbus_bool_t (*connection_read_write)(DBusConnection *, int);
    53     DBusDispatchStatus (*connection_dispatch)(DBusConnection *);
    54     dbus_bool_t (*message_is_signal)(DBusMessage *, const char *, const char *); 	
    55     DBusMessage *(*message_new_method_call)(const char *, const char *, const char *, const char *);
    56     dbus_bool_t (*message_append_args)(DBusMessage *, int, ...);
    57     dbus_bool_t (*message_append_args_valist)(DBusMessage *, int, va_list);
    58     dbus_bool_t (*message_get_args)(DBusMessage *, DBusError *, int, ...);
    59     dbus_bool_t (*message_get_args_valist)(DBusMessage *, DBusError *, int, va_list);
    60     dbus_bool_t (*message_iter_init)(DBusMessage *, DBusMessageIter *);
    61     dbus_bool_t (*message_iter_next)(DBusMessageIter *);
    62     void (*message_iter_get_basic)(DBusMessageIter *, void *);
    63     int (*message_iter_get_arg_type)(DBusMessageIter *);
    64     void (*message_iter_recurse)(DBusMessageIter *, DBusMessageIter *); 	 	
    65     void (*message_unref)(DBusMessage *);
    66     void (*error_init)(DBusError *);
    67     dbus_bool_t (*error_is_set)(const DBusError *);
    68     void (*error_free)(DBusError *);
    69     char *(*get_local_machine_id)(void);
    70     void (*free)(void *);
    71     void (*free_string_array)(char **);
    72     void (*shutdown)(void);
    73 
    74 } SDL_DBusContext;
    75 
    76 extern void SDL_DBus_Init(void);
    77 extern void SDL_DBus_Quit(void);
    78 extern SDL_DBusContext * SDL_DBus_GetContext(void);
    79 
    80 /* These use the built-in Session connection. */
    81 extern SDL_bool SDL_DBus_CallMethod(const char *node, const char *path, const char *interface, const char *method, ...);
    82 extern SDL_bool SDL_DBus_CallVoidMethod(const char *node, const char *path, const char *interface, const char *method, ...);
    83 extern SDL_bool SDL_DBus_QueryProperty(const char *node, const char *path, const char *interface, const char *property, const int expectedtype, void *result);
    84 
    85 /* These use whatever connection you like. */
    86 extern SDL_bool SDL_DBus_CallMethodOnConnection(DBusConnection *conn, const char *node, const char *path, const char *interface, const char *method, ...);
    87 extern SDL_bool SDL_DBus_CallVoidMethodOnConnection(DBusConnection *conn, const char *node, const char *path, const char *interface, const char *method, ...);
    88 extern SDL_bool SDL_DBus_QueryPropertyOnConnection(DBusConnection *conn, const char *node, const char *path, const char *interface, const char *property, const int expectedtype, void *result);
    89 
    90 extern void SDL_DBus_ScreensaverTickle(void);
    91 extern SDL_bool SDL_DBus_ScreensaverInhibit(SDL_bool inhibit);
    92 
    93 #endif /* HAVE_DBUS_DBUS_H */
    94 
    95 #endif /* SDL_dbus_h_ */
    96 
    97 /* vi: set ts=4 sw=4 expandtab: */