1/*
2 * Copyright © 2008 Kristian Høgsberg
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining
5 * a copy of this software and associated documentation files (the
6 * "Software"), to deal in the Software without restriction, including
7 * without limitation the rights to use, copy, modify, merge, publish,
8 * distribute, sublicense, and/or sell copies of the Software, and to
9 * permit persons to whom the Software is furnished to do so, subject to
10 * the following conditions:
11 *
12 * The above copyright notice and this permission notice (including the
13 * next paragraph) shall be included in all copies or substantial
14 * portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
20 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
21 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 * SOFTWARE.
24 */
25
26#ifndef WAYLAND_SERVER_CORE_H
27#define WAYLAND_SERVER_CORE_H
28
29#include <sys/types.h>
30#include <stdint.h>
31#include <stdbool.h>
32#include "wayland-util.h"
33#include "wayland-version.h"
34
35#ifdef __cplusplus
36extern "C" {
37#endif
38
39enum {
40 WL_EVENT_READABLE = 0x01,
41 WL_EVENT_WRITABLE = 0x02,
42 WL_EVENT_HANGUP = 0x04,
43 WL_EVENT_ERROR = 0x08
44};
45
46/** File descriptor dispatch function type
47 *
48 * Functions of this type are used as callbacks for file descriptor events.
49 *
50 * \param fd The file descriptor delivering the event.
51 * \param mask Describes the kind of the event as a bitwise-or of:
52 * \c WL_EVENT_READABLE, \c WL_EVENT_WRITABLE, \c WL_EVENT_HANGUP,
53 * \c WL_EVENT_ERROR.
54 * \param data The user data argument of the related wl_event_loop_add_fd()
55 * call.
56 * \return If the event source is registered for re-check with
57 * wl_event_source_check(): 0 for all done, 1 for needing a re-check.
58 * If not registered, the return value is ignored and should be zero.
59 *
60 * \sa wl_event_loop_add_fd()
61 * \memberof wl_event_source
62 */
63typedef int (*wl_event_loop_fd_func_t)(int fd, uint32_t mask, void *data);
64
65/** Timer dispatch function type
66 *
67 * Functions of this type are used as callbacks for timer expiry.
68 *
69 * \param data The user data argument of the related wl_event_loop_add_timer()
70 * call.
71 * \return If the event source is registered for re-check with
72 * wl_event_source_check(): 0 for all done, 1 for needing a re-check.
73 * If not registered, the return value is ignored and should be zero.
74 *
75 * \sa wl_event_loop_add_timer()
76 * \memberof wl_event_source
77 */
78typedef int (*wl_event_loop_timer_func_t)(void *data);
79
80/** Signal dispatch function type
81 *
82 * Functions of this type are used as callbacks for (POSIX) signals.
83 *
84 * \param signal_number
85 * \param data The user data argument of the related wl_event_loop_add_signal()
86 * call.
87 * \return If the event source is registered for re-check with
88 * wl_event_source_check(): 0 for all done, 1 for needing a re-check.
89 * If not registered, the return value is ignored and should be zero.
90 *
91 * \sa wl_event_loop_add_signal()
92 * \memberof wl_event_source
93 */
94typedef int (*wl_event_loop_signal_func_t)(int signal_number, void *data);
95
96/** Idle task function type
97 *
98 * Functions of this type are used as callbacks before blocking in
99 * wl_event_loop_dispatch().
100 *
101 * \param data The user data argument of the related wl_event_loop_add_idle()
102 * call.
103 *
104 * \sa wl_event_loop_add_idle() wl_event_loop_dispatch()
105 * \memberof wl_event_source
106 */
107typedef void (*wl_event_loop_idle_func_t)(void *data);
108
109/** \struct wl_event_loop
110 *
111 * \brief An event loop context
112 *
113 * Usually you create an event loop context, add sources to it, and call
114 * wl_event_loop_dispatch() in a loop to process events.
115 *
116 * \sa wl_event_source
117 */
118
119/** \struct wl_event_source
120 *
121 * \brief An abstract event source
122 *
123 * This is the generic type for fd, timer, signal, and idle sources.
124 * Functions that operate on specific source types must not be used with
125 * a different type, even if the function signature allows it.
126 */
127
128struct wl_event_loop *
129wl_event_loop_create(void);
130
131void
132wl_event_loop_destroy(struct wl_event_loop *loop);
133
134struct wl_event_source *
135wl_event_loop_add_fd(struct wl_event_loop *loop,
136 int fd, uint32_t mask,
137 wl_event_loop_fd_func_t func,
138 void *data);
139
140int
141wl_event_source_fd_update(struct wl_event_source *source, uint32_t mask);
142
143struct wl_event_source *
144wl_event_loop_add_timer(struct wl_event_loop *loop,
145 wl_event_loop_timer_func_t func,
146 void *data);
147
148struct wl_event_source *
149wl_event_loop_add_signal(struct wl_event_loop *loop,
150 int signal_number,
151 wl_event_loop_signal_func_t func,
152 void *data);
153
154int
155wl_event_source_timer_update(struct wl_event_source *source,
156 int ms_delay);
157
158int
159wl_event_source_remove(struct wl_event_source *source);
160
161void
162wl_event_source_check(struct wl_event_source *source);
163
164int
165wl_event_loop_dispatch(struct wl_event_loop *loop, int timeout);
166
167void
168wl_event_loop_dispatch_idle(struct wl_event_loop *loop);
169
170struct wl_event_source *
171wl_event_loop_add_idle(struct wl_event_loop *loop,
172 wl_event_loop_idle_func_t func,
173 void *data);
174
175int
176wl_event_loop_get_fd(struct wl_event_loop *loop);
177
178struct wl_listener;
179
180typedef void (*wl_notify_func_t)(struct wl_listener *listener, void *data);
181
182void
183wl_event_loop_add_destroy_listener(struct wl_event_loop *loop,
184 struct wl_listener *listener);
185
186struct wl_listener *
187wl_event_loop_get_destroy_listener(struct wl_event_loop *loop,
188 wl_notify_func_t notify);
189
190struct wl_display *
191wl_display_create(void);
192
193void
194wl_display_destroy(struct wl_display *display);
195
196struct wl_event_loop *
197wl_display_get_event_loop(struct wl_display *display);
198
199int
200wl_display_add_socket(struct wl_display *display, const char *name);
201
202const char *
203wl_display_add_socket_auto(struct wl_display *display);
204
205int
206wl_display_add_socket_fd(struct wl_display *display, int sock_fd);
207
208void
209wl_display_terminate(struct wl_display *display);
210
211void
212wl_display_run(struct wl_display *display);
213
214void
215wl_display_flush_clients(struct wl_display *display);
216
217void
218wl_display_destroy_clients(struct wl_display *display);
219
220struct wl_client;
221
222typedef void (*wl_global_bind_func_t)(struct wl_client *client, void *data,
223 uint32_t version, uint32_t id);
224
225uint32_t
226wl_display_get_serial(struct wl_display *display);
227
228uint32_t
229wl_display_next_serial(struct wl_display *display);
230
231void
232wl_display_add_destroy_listener(struct wl_display *display,
233 struct wl_listener *listener);
234
235void
236wl_display_add_client_created_listener(struct wl_display *display,
237 struct wl_listener *listener);
238
239struct wl_listener *
240wl_display_get_destroy_listener(struct wl_display *display,
241 wl_notify_func_t notify);
242
243struct wl_global *
244wl_global_create(struct wl_display *display,
245 const struct wl_interface *interface,
246 int version,
247 void *data, wl_global_bind_func_t bind);
248
249void
250wl_global_destroy(struct wl_global *global);
251
252/** A filter function for wl_global objects
253 *
254 * \param client The client object
255 * \param global The global object to show or hide
256 * \param data The user data pointer
257 *
258 * A filter function enables the server to decide which globals to
259 * advertise to each client.
260 *
261 * When a wl_global filter is set, the given callback funtion will be
262 * called during wl_global advertisment and binding.
263 *
264 * This function should return true if the global object should be made
265 * visible to the client or false otherwise.
266 */
267typedef bool (*wl_display_global_filter_func_t)(const struct wl_client *client,
268 const struct wl_global *global,
269 void *data);
270
271void
272wl_display_set_global_filter(struct wl_display *display,
273 wl_display_global_filter_func_t filter,
274 void *data);
275
276const struct wl_interface *
277wl_global_get_interface(const struct wl_global *global);
278
279void *
280wl_global_get_user_data(const struct wl_global *global);
281
282struct wl_client *
283wl_client_create(struct wl_display *display, int fd);
284
285struct wl_list *
286wl_display_get_client_list(struct wl_display *display);
287
288struct wl_list *
289wl_client_get_link(struct wl_client *client);
290
291struct wl_client *
292wl_client_from_link(struct wl_list *link);
293
294/** Iterate over a list of clients. */
295#define wl_client_for_each(client, list) \
296 for (client = wl_client_from_link((list)->next); \
297 wl_client_get_link(client) != (list); \
298 client = wl_client_from_link(wl_client_get_link(client)->next))
299
300void
301wl_client_destroy(struct wl_client *client);
302
303void
304wl_client_flush(struct wl_client *client);
305
306void
307wl_client_get_credentials(struct wl_client *client,
308 pid_t *pid, uid_t *uid, gid_t *gid);
309
310int
311wl_client_get_fd(struct wl_client *client);
312
313void
314wl_client_add_destroy_listener(struct wl_client *client,
315 struct wl_listener *listener);
316
317struct wl_listener *
318wl_client_get_destroy_listener(struct wl_client *client,
319 wl_notify_func_t notify);
320
321struct wl_resource *
322wl_client_get_object(struct wl_client *client, uint32_t id);
323
324void
325wl_client_post_no_memory(struct wl_client *client);
326
327void
328wl_client_add_resource_created_listener(struct wl_client *client,
329 struct wl_listener *listener);
330
331typedef enum wl_iterator_result (*wl_client_for_each_resource_iterator_func_t)(
332 struct wl_resource *resource,
333 void *user_data);
334
335void
336wl_client_for_each_resource(struct wl_client *client,
337 wl_client_for_each_resource_iterator_func_t iterator,
338 void *user_data);
339
340/** \class wl_listener
341 *
342 * \brief A single listener for Wayland signals
343 *
344 * wl_listener provides the means to listen for wl_signal notifications. Many
345 * Wayland objects use wl_listener for notification of significant events like
346 * object destruction.
347 *
348 * Clients should create wl_listener objects manually and can register them as
349 * listeners to signals using #wl_signal_add, assuming the signal is
350 * directly accessible. For opaque structs like wl_event_loop, adding a
351 * listener should be done through provided accessor methods. A listener can
352 * only listen to one signal at a time.
353 *
354 * \code
355 * struct wl_listener your_listener;
356 *
357 * your_listener.notify = your_callback_method;
358 *
359 * // Direct access
360 * wl_signal_add(&some_object->destroy_signal, &your_listener);
361 *
362 * // Accessor access
363 * wl_event_loop *loop = ...;
364 * wl_event_loop_add_destroy_listener(loop, &your_listener);
365 * \endcode
366 *
367 * If the listener is part of a larger struct, #wl_container_of can be used
368 * to retrieve a pointer to it:
369 *
370 * \code
371 * void your_listener(struct wl_listener *listener, void *data)
372 * {
373 * struct your_data *data;
374 *
375 * your_data = wl_container_of(listener, data, your_member_name);
376 * }
377 * \endcode
378 *
379 * If you need to remove a listener from a signal, use wl_list_remove().
380 *
381 * \code
382 * wl_list_remove(&your_listener.link);
383 * \endcode
384 *
385 * \sa wl_signal
386 */
387struct wl_listener {
388 struct wl_list link;
389 wl_notify_func_t notify;
390};
391
392/** \class wl_signal
393 *
394 * \brief A source of a type of observable event
395 *
396 * Signals are recognized points where significant events can be observed.
397 * Compositors as well as the server can provide signals. Observers are
398 * wl_listener's that are added through #wl_signal_add. Signals are emitted
399 * using #wl_signal_emit, which will invoke all listeners until that
400 * listener is removed by wl_list_remove() (or whenever the signal is
401 * destroyed).
402 *
403 * \sa wl_listener for more information on using wl_signal
404 */
405struct wl_signal {
406 struct wl_list listener_list;
407};
408
409/** Initialize a new \ref wl_signal for use.
410 *
411 * \param signal The signal that will be initialized
412 *
413 * \memberof wl_signal
414 */
415static inline void
416wl_signal_init(struct wl_signal *signal)
417{
418 wl_list_init(&signal->listener_list);
419}
420
421/** Add the specified listener to this signal.
422 *
423 * \param signal The signal that will emit events to the listener
424 * \param listener The listener to add
425 *
426 * \memberof wl_signal
427 */
428static inline void
429wl_signal_add(struct wl_signal *signal, struct wl_listener *listener)
430{
431 wl_list_insert(signal->listener_list.prev, &listener->link);
432}
433
434/** Gets the listener struct for the specified callback.
435 *
436 * \param signal The signal that contains the specified listener
437 * \param notify The listener that is the target of this search
438 * \return the list item that corresponds to the specified listener, or NULL
439 * if none was found
440 *
441 * \memberof wl_signal
442 */
443static inline struct wl_listener *
444wl_signal_get(struct wl_signal *signal, wl_notify_func_t notify)
445{
446 struct wl_listener *l;
447
448 wl_list_for_each(l, &signal->listener_list, link)
449 if (l->notify == notify)
450 return l;
451
452 return NULL;
453}
454
455/** Emits this signal, notifying all registered listeners.
456 *
457 * \param signal The signal object that will emit the signal
458 * \param data The data that will be emitted with the signal
459 *
460 * \memberof wl_signal
461 */
462static inline void
463wl_signal_emit(struct wl_signal *signal, void *data)
464{
465 struct wl_listener *l, *next;
466
467 wl_list_for_each_safe(l, next, &signal->listener_list, link)
468 l->notify(l, data);
469}
470
471typedef void (*wl_resource_destroy_func_t)(struct wl_resource *resource);
472
473/*
474 * Post an event to the client's object referred to by 'resource'.
475 * 'opcode' is the event number generated from the protocol XML
476 * description (the event name). The variable arguments are the event
477 * parameters, in the order they appear in the protocol XML specification.
478 *
479 * The variable arguments' types are:
480 * - type=uint: uint32_t
481 * - type=int: int32_t
482 * - type=fixed: wl_fixed_t
483 * - type=string: (const char *) to a nil-terminated string
484 * - type=array: (struct wl_array *)
485 * - type=fd: int, that is an open file descriptor
486 * - type=new_id: (struct wl_object *) or (struct wl_resource *)
487 * - type=object: (struct wl_object *) or (struct wl_resource *)
488 */
489void
490wl_resource_post_event(struct wl_resource *resource,
491 uint32_t opcode, ...);
492
493void
494wl_resource_post_event_array(struct wl_resource *resource,
495 uint32_t opcode, union wl_argument *args);
496
497void
498wl_resource_queue_event(struct wl_resource *resource,
499 uint32_t opcode, ...);
500
501void
502wl_resource_queue_event_array(struct wl_resource *resource,
503 uint32_t opcode, union wl_argument *args);
504
505/* msg is a printf format string, variable args are its args. */
506void
507wl_resource_post_error(struct wl_resource *resource,
508 uint32_t code, const char *msg, ...) WL_PRINTF(3, 4);
509
510void
511wl_resource_post_no_memory(struct wl_resource *resource);
512
513struct wl_display *
514wl_client_get_display(struct wl_client *client);
515
516struct wl_resource *
517wl_resource_create(struct wl_client *client,
518 const struct wl_interface *interface,
519 int version, uint32_t id);
520
521void
522wl_resource_set_implementation(struct wl_resource *resource,
523 const void *implementation,
524 void *data,
525 wl_resource_destroy_func_t destroy);
526
527void
528wl_resource_set_dispatcher(struct wl_resource *resource,
529 wl_dispatcher_func_t dispatcher,
530 const void *implementation,
531 void *data,
532 wl_resource_destroy_func_t destroy);
533
534void
535wl_resource_destroy(struct wl_resource *resource);
536
537uint32_t
538wl_resource_get_id(struct wl_resource *resource);
539
540struct wl_list *
541wl_resource_get_link(struct wl_resource *resource);
542
543struct wl_resource *
544wl_resource_from_link(struct wl_list *resource);
545
546struct wl_resource *
547wl_resource_find_for_client(struct wl_list *list, struct wl_client *client);
548
549struct wl_client *
550wl_resource_get_client(struct wl_resource *resource);
551
552void
553wl_resource_set_user_data(struct wl_resource *resource, void *data);
554
555void *
556wl_resource_get_user_data(struct wl_resource *resource);
557
558int
559wl_resource_get_version(struct wl_resource *resource);
560
561void
562wl_resource_set_destructor(struct wl_resource *resource,
563 wl_resource_destroy_func_t destroy);
564
565int
566wl_resource_instance_of(struct wl_resource *resource,
567 const struct wl_interface *interface,
568 const void *implementation);
569const char *
570wl_resource_get_class(struct wl_resource *resource);
571
572void
573wl_resource_add_destroy_listener(struct wl_resource *resource,
574 struct wl_listener *listener);
575
576struct wl_listener *
577wl_resource_get_destroy_listener(struct wl_resource *resource,
578 wl_notify_func_t notify);
579
580#define wl_resource_for_each(resource, list) \
581 for (resource = 0, resource = wl_resource_from_link((list)->next); \
582 wl_resource_get_link(resource) != (list); \
583 resource = wl_resource_from_link(wl_resource_get_link(resource)->next))
584
585#define wl_resource_for_each_safe(resource, tmp, list) \
586 for (resource = 0, tmp = 0, \
587 resource = wl_resource_from_link((list)->next), \
588 tmp = wl_resource_from_link((list)->next->next); \
589 wl_resource_get_link(resource) != (list); \
590 resource = tmp, \
591 tmp = wl_resource_from_link(wl_resource_get_link(resource)->next))
592
593struct wl_shm_buffer *
594wl_shm_buffer_get(struct wl_resource *resource);
595
596void
597wl_shm_buffer_begin_access(struct wl_shm_buffer *buffer);
598
599void
600wl_shm_buffer_end_access(struct wl_shm_buffer *buffer);
601
602void *
603wl_shm_buffer_get_data(struct wl_shm_buffer *buffer);
604
605int32_t
606wl_shm_buffer_get_stride(struct wl_shm_buffer *buffer);
607
608uint32_t
609wl_shm_buffer_get_format(struct wl_shm_buffer *buffer);
610
611int32_t
612wl_shm_buffer_get_width(struct wl_shm_buffer *buffer);
613
614int32_t
615wl_shm_buffer_get_height(struct wl_shm_buffer *buffer);
616
617struct wl_shm_pool *
618wl_shm_buffer_ref_pool(struct wl_shm_buffer *buffer);
619
620void
621wl_shm_pool_unref(struct wl_shm_pool *pool);
622
623int
624wl_display_init_shm(struct wl_display *display);
625
626uint32_t *
627wl_display_add_shm_format(struct wl_display *display, uint32_t format);
628
629struct wl_shm_buffer *
630wl_shm_buffer_create(struct wl_client *client,
631 uint32_t id, int32_t width, int32_t height,
632 int32_t stride, uint32_t format) WL_DEPRECATED;
633
634void
635wl_log_set_handler_server(wl_log_func_t handler);
636
637enum wl_protocol_logger_type {
638 WL_PROTOCOL_LOGGER_REQUEST,
639 WL_PROTOCOL_LOGGER_EVENT,
640};
641
642struct wl_protocol_logger_message {
643 struct wl_resource *resource;
644 int message_opcode;
645 const struct wl_message *message;
646 int arguments_count;
647 const union wl_argument *arguments;
648};
649
650typedef void (*wl_protocol_logger_func_t)(void *user_data,
651 enum wl_protocol_logger_type direction,
652 const struct wl_protocol_logger_message *message);
653
654struct wl_protocol_logger *
655wl_display_add_protocol_logger(struct wl_display *display,
656 wl_protocol_logger_func_t, void *user_data);
657
658void
659wl_protocol_logger_destroy(struct wl_protocol_logger *logger);
660
661#ifdef __cplusplus
662}
663#endif
664
665#endif
666