client: Keep track of proxy validity and number of reference holders
[profile/ivi/wayland.git] / src / wayland-private.h
1 /*
2  * Copyright © 2008-2011 Kristian Høgsberg
3  * Copyright © 2011 Intel Corporation
4  *
5  * Permission to use, copy, modify, distribute, and sell this software and its
6  * documentation for any purpose is hereby granted without fee, provided that
7  * the above copyright notice appear in all copies and that both that copyright
8  * notice and this permission notice appear in supporting documentation, and
9  * that the name of the copyright holders not be used in advertising or
10  * publicity pertaining to distribution of the software without specific,
11  * written prior permission.  The copyright holders make no representations
12  * about the suitability of this software for any purpose.  It is provided "as
13  * is" without express or implied warranty.
14  *
15  * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
16  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
17  * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
18  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
19  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
20  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
21  * OF THIS SOFTWARE.
22  */
23
24 #ifndef WAYLAND_PRIVATE_H
25 #define WAYLAND_PRIVATE_H
26
27 #include <stdarg.h>
28 #include <ffi.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
43 struct wl_map {
44         struct wl_array client_entries;
45         struct wl_array server_entries;
46         uint32_t free_list;
47 };
48
49 typedef void (*wl_iterator_func_t)(void *element, void *data);
50
51 void wl_map_init(struct wl_map *map);
52 void wl_map_release(struct wl_map *map);
53 uint32_t wl_map_insert_new(struct wl_map *map, uint32_t side, void *data);
54 int wl_map_insert_at(struct wl_map *map, uint32_t i, void *data);
55 int wl_map_reserve_new(struct wl_map *map, uint32_t i);
56 void wl_map_remove(struct wl_map *map, uint32_t i);
57 void *wl_map_lookup(struct wl_map *map, uint32_t i);
58 void wl_map_for_each(struct wl_map *map, wl_iterator_func_t func, void *data);
59
60 struct wl_connection;
61 struct wl_closure;
62 struct wl_proxy;
63
64 struct wl_connection *wl_connection_create(int fd);
65 void wl_connection_destroy(struct wl_connection *connection);
66 void wl_connection_copy(struct wl_connection *connection, void *data, size_t size);
67 void wl_connection_consume(struct wl_connection *connection, size_t size);
68
69 int wl_connection_flush(struct wl_connection *connection);
70 int wl_connection_read(struct wl_connection *connection);
71
72 int wl_connection_write(struct wl_connection *connection, const void *data, size_t count);
73 int wl_connection_queue(struct wl_connection *connection,
74                         const void *data, size_t count);
75
76 struct wl_closure {
77         int count;
78         const struct wl_message *message;
79         ffi_type *types[20];
80         ffi_cif cif;
81         void *args[20];
82         uint32_t *start;
83         struct wl_list link;
84         struct wl_proxy *proxy;
85         uint32_t buffer[0];
86 };
87
88 struct argument_details {
89         char type;
90         int nullable;
91 };
92
93 const char *
94 get_next_argument(const char *signature, struct argument_details *details);
95
96 int
97 arg_count_for_signature(const char *signature);
98
99 struct wl_closure *
100 wl_closure_vmarshal(struct wl_object *sender,
101                     uint32_t opcode, va_list ap,
102                     const struct wl_message *message);
103
104 struct wl_closure *
105 wl_connection_demarshal(struct wl_connection *connection,
106                         uint32_t size,
107                         struct wl_map *objects,
108                         const struct wl_message *message);
109
110 int
111 wl_closure_lookup_objects(struct wl_closure *closure, struct wl_map *objects);
112
113 void
114 wl_closure_invoke(struct wl_closure *closure,
115                   struct wl_object *target, void (*func)(void), void *data);
116 int
117 wl_closure_send(struct wl_closure *closure, struct wl_connection *connection);
118 int
119 wl_closure_queue(struct wl_closure *closure, struct wl_connection *connection);
120 void
121 wl_closure_print(struct wl_closure *closure, struct wl_object *target, int send);
122 void
123 wl_closure_destroy(struct wl_closure *closure);
124
125 extern wl_log_func_t wl_log_handler;
126
127 void wl_log(const char *fmt, ...);
128
129 #endif