src/wayland-private.h

   1 /*
   2  * Copyright © 2008-2011 Kristian Høgsberg
   3  * Copyright © 2011 Intel Corporation
   4  * Copyright © 2013 Jason Ekstrand
   5  *
   6  * Permission to use, copy, modify, distribute, and sell this software and its
   7  * documentation for any purpose is hereby granted without fee, provided that
   8  * the above copyright notice appear in all copies and that both that copyright
   9  * notice and this permission notice appear in supporting documentation, and
  10  * that the name of the copyright holders not be used in advertising or
  11  * publicity pertaining to distribution of the software without specific,
  12  * written prior permission.  The copyright holders make no representations
  13  * about the suitability of this software for any purpose.  It is provided "as
  14  * is" without express or implied warranty.
  15  *
  16  * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  17  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
  18  * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  19  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  20  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  21  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  22  * OF THIS SOFTWARE.
  23  */
  24
  25 #ifndef WAYLAND_PRIVATE_H
  26 #define WAYLAND_PRIVATE_H
  27
  28 #include <stdarg.h>
  29 #include "wayland-util.h"
  30
  31 #define ARRAY_LENGTH(a) (sizeof (a) / sizeof (a)[0])
  32
  33 #define container_of(ptr, type, member) ({                              \
  34         const __typeof__( ((type *)0)->member ) *__mptr = (ptr);        \
  35         (type *)( (char *)__mptr - offsetof(type,member) );})
  36
  37 #define WL_ZOMBIE_OBJECT ((void *) 2)
  38
  39 #define WL_MAP_SERVER_SIDE 0
  40 #define WL_MAP_CLIENT_SIDE 1
  41 #define WL_SERVER_ID_START 0xff000000
  42 #define WL_CLOSURE_MAX_ARGS 20
  43
  44 struct wl_map {
  45         struct wl_array client_entries;
  46         struct wl_array server_entries;
  47         uint32_t free_list;
  48 };
  49
  50 typedef void (*wl_iterator_func_t)(void *element, void *data);
  51
  52 void wl_map_init(struct wl_map *map);
  53 void wl_map_release(struct wl_map *map);
  54 uint32_t wl_map_insert_new(struct wl_map *map, uint32_t side, void *data);
  55 int wl_map_insert_at(struct wl_map *map, uint32_t i, void *data);
  56 int wl_map_reserve_new(struct wl_map *map, uint32_t i);
  57 void wl_map_remove(struct wl_map *map, uint32_t i);
  58 void *wl_map_lookup(struct wl_map *map, uint32_t i);
  59 void wl_map_for_each(struct wl_map *map, wl_iterator_func_t func, void *data);
  60
  61 struct wl_connection;
  62 struct wl_closure;
  63 struct wl_proxy;
  64
  65 struct wl_connection *wl_connection_create(int fd);
  66 void wl_connection_destroy(struct wl_connection *connection);
  67 void wl_connection_copy(struct wl_connection *connection, void *data, size_t size);
  68 void wl_connection_consume(struct wl_connection *connection, size_t size);
  69
  70 int wl_connection_flush(struct wl_connection *connection);
  71 int wl_connection_read(struct wl_connection *connection);
  72
  73 int wl_connection_write(struct wl_connection *connection, const void *data, size_t count);
  74 int wl_connection_queue(struct wl_connection *connection,
  75                         const void *data, size_t count);
  76
  77 union wl_argument {
  78         int32_t i;
  79         uint32_t u;
  80         wl_fixed_t f;
  81         const char *s;
  82         struct wl_object *o;
  83         uint32_t n;
  84         struct wl_array *a;
  85         int32_t h;
  86 };
  87
  88 struct wl_closure {
  89         int count;
  90         const struct wl_message *message;
  91         uint32_t opcode;
  92         uint32_t sender_id;
  93         union wl_argument args[WL_CLOSURE_MAX_ARGS];
  94         struct wl_list link;
  95         struct wl_proxy *proxy;
  96         struct wl_array extra[0];
  97 };
  98
  99 struct argument_details {
 100         char type;
 101         int nullable;
 102 };
 103
 104 const char *
 105 get_next_argument(const char *signature, struct argument_details *details);
 106
 107 int
 108 arg_count_for_signature(const char *signature);
 109
 110 void
 111 wl_argument_from_va_list(const char *signature, union wl_argument *args,
 112                          int count, va_list ap);
 113
 114 struct wl_closure *
 115 wl_closure_marshal(struct wl_object *sender,
 116                     uint32_t opcode, union wl_argument *args,
 117                     const struct wl_message *message);
 118 struct wl_closure *
 119 wl_closure_vmarshal(struct wl_object *sender,
 120                     uint32_t opcode, va_list ap,
 121                     const struct wl_message *message);
 122
 123 struct wl_closure *
 124 wl_connection_demarshal(struct wl_connection *connection,
 125                         uint32_t size,
 126                         struct wl_map *objects,
 127                         const struct wl_message *message);
 128
 129 int
 130 wl_closure_lookup_objects(struct wl_closure *closure, struct wl_map *objects);
 131
 132 enum wl_closure_invoke_flag {
 133         WL_CLOSURE_INVOKE_CLIENT = (1 << 0),
 134         WL_CLOSURE_INVOKE_SERVER = (1 << 1)
 135 };
 136
 137 void
 138 wl_closure_invoke(struct wl_closure *closure, uint32_t flags,
 139                   struct wl_object *target, void (*func)(void), void *data);
 140 int
 141 wl_closure_send(struct wl_closure *closure, struct wl_connection *connection);
 142 int
 143 wl_closure_queue(struct wl_closure *closure, struct wl_connection *connection);
 144 void
 145 wl_closure_print(struct wl_closure *closure, struct wl_object *target, int send);
 146 void
 147 wl_closure_destroy(struct wl_closure *closure);
 148
 149 extern wl_log_func_t wl_log_handler;
 150
 151 void wl_log(const char *fmt, ...);
 152
 153 #endif