/* * Copyright © 2008 Kristian Høgsberg * * Permission is hereby granted, free of charge, to any person obtaining * a copy of this software and associated documentation files (the * "Software"), to deal in the Software without restriction, including * without limitation the rights to use, copy, modify, merge, publish, * distribute, sublicense, and/or sell copies of the Software, and to * permit persons to whom the Software is furnished to do so, subject to * the following conditions: * * The above copyright notice and this permission notice (including the * next paragraph) shall be included in all copies or substantial * portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ #ifndef WAYLAND_SERVER_CORE_H #define WAYLAND_SERVER_CORE_H #include <sys/types.h> #include <stdint.h> #include <stdbool.h> #include "wayland-util.h" #include "wayland-version.h" #ifdef __cplusplus extern "C" { #endif enum { … }; /** File descriptor dispatch function type * * Functions of this type are used as callbacks for file descriptor events. * * \param fd The file descriptor delivering the event. * \param mask Describes the kind of the event as a bitwise-or of: * \c WL_EVENT_READABLE, \c WL_EVENT_WRITABLE, \c WL_EVENT_HANGUP, * \c WL_EVENT_ERROR. * \param data The user data argument of the related wl_event_loop_add_fd() * call. * \return If the event source is registered for re-check with * wl_event_source_check(): 0 for all done, 1 for needing a re-check. * If not registered, the return value is ignored and should be zero. * * \sa wl_event_loop_add_fd() * \memberof wl_event_source */ wl_event_loop_fd_func_t; /** Timer dispatch function type * * Functions of this type are used as callbacks for timer expiry. * * \param data The user data argument of the related wl_event_loop_add_timer() * call. * \return If the event source is registered for re-check with * wl_event_source_check(): 0 for all done, 1 for needing a re-check. * If not registered, the return value is ignored and should be zero. * * \sa wl_event_loop_add_timer() * \memberof wl_event_source */ wl_event_loop_timer_func_t; /** Signal dispatch function type * * Functions of this type are used as callbacks for (POSIX) signals. * * \param signal_number * \param data The user data argument of the related wl_event_loop_add_signal() * call. * \return If the event source is registered for re-check with * wl_event_source_check(): 0 for all done, 1 for needing a re-check. * If not registered, the return value is ignored and should be zero. * * \sa wl_event_loop_add_signal() * \memberof wl_event_source */ wl_event_loop_signal_func_t; /** Idle task function type * * Functions of this type are used as callbacks before blocking in * wl_event_loop_dispatch(). * * \param data The user data argument of the related wl_event_loop_add_idle() * call. * * \sa wl_event_loop_add_idle() wl_event_loop_dispatch() * \memberof wl_event_source */ wl_event_loop_idle_func_t; /** \struct wl_event_loop * * \brief An event loop context * * Usually you create an event loop context, add sources to it, and call * wl_event_loop_dispatch() in a loop to process events. * * \sa wl_event_source */ /** \struct wl_event_source * * \brief An abstract event source * * This is the generic type for fd, timer, signal, and idle sources. * Functions that operate on specific source types must not be used with * a different type, even if the function signature allows it. */ struct wl_event_loop * wl_event_loop_create(void); void wl_event_loop_destroy(struct wl_event_loop *loop); struct wl_event_source * wl_event_loop_add_fd(struct wl_event_loop *loop, int fd, uint32_t mask, wl_event_loop_fd_func_t func, void *data); int wl_event_source_fd_update(struct wl_event_source *source, uint32_t mask); struct wl_event_source * wl_event_loop_add_timer(struct wl_event_loop *loop, wl_event_loop_timer_func_t func, void *data); struct wl_event_source * wl_event_loop_add_signal(struct wl_event_loop *loop, int signal_number, wl_event_loop_signal_func_t func, void *data); int wl_event_source_timer_update(struct wl_event_source *source, int ms_delay); int wl_event_source_remove(struct wl_event_source *source); void wl_event_source_check(struct wl_event_source *source); int wl_event_loop_dispatch(struct wl_event_loop *loop, int timeout); void wl_event_loop_dispatch_idle(struct wl_event_loop *loop); struct wl_event_source * wl_event_loop_add_idle(struct wl_event_loop *loop, wl_event_loop_idle_func_t func, void *data); int wl_event_loop_get_fd(struct wl_event_loop *loop); struct wl_listener; wl_notify_func_t; void wl_event_loop_add_destroy_listener(struct wl_event_loop *loop, struct wl_listener *listener); struct wl_listener * wl_event_loop_get_destroy_listener(struct wl_event_loop *loop, wl_notify_func_t notify); struct wl_display * wl_display_create(void); void wl_display_destroy(struct wl_display *display); struct wl_event_loop * wl_display_get_event_loop(struct wl_display *display); int wl_display_add_socket(struct wl_display *display, const char *name); const char * wl_display_add_socket_auto(struct wl_display *display); int wl_display_add_socket_fd(struct wl_display *display, int sock_fd); void wl_display_terminate(struct wl_display *display); void wl_display_run(struct wl_display *display); void wl_display_flush_clients(struct wl_display *display); void wl_display_destroy_clients(struct wl_display *display); void wl_display_set_default_max_buffer_size(struct wl_display *display, size_t max_buffer_size); struct wl_client; wl_global_bind_func_t; uint32_t wl_display_get_serial(struct wl_display *display); uint32_t wl_display_next_serial(struct wl_display *display); void wl_display_add_destroy_listener(struct wl_display *display, struct wl_listener *listener); void wl_display_add_client_created_listener(struct wl_display *display, struct wl_listener *listener); struct wl_listener * wl_display_get_destroy_listener(struct wl_display *display, wl_notify_func_t notify); struct wl_global * wl_global_create(struct wl_display *display, const struct wl_interface *interface, int version, void *data, wl_global_bind_func_t bind); void wl_global_remove(struct wl_global *global); void wl_global_destroy(struct wl_global *global); /** A filter function for wl_global objects * * \param client The client object * \param global The global object to show or hide * \param data The user data pointer * * A filter function enables the server to decide which globals to * advertise to each client. * * When a wl_global filter is set, the given callback function will be * called during wl_global advertisement and binding. * * This function should return true if the global object should be made * visible to the client or false otherwise. */ wl_display_global_filter_func_t; void wl_display_set_global_filter(struct wl_display *display, wl_display_global_filter_func_t filter, void *data); const struct wl_interface * wl_global_get_interface(const struct wl_global *global); uint32_t wl_global_get_name(const struct wl_global *global, const struct wl_client *client); uint32_t wl_global_get_version(const struct wl_global *global); struct wl_display * wl_global_get_display(const struct wl_global *global); void * wl_global_get_user_data(const struct wl_global *global); void wl_global_set_user_data(struct wl_global *global, void *data); struct wl_client * wl_client_create(struct wl_display *display, int fd); struct wl_list * wl_display_get_client_list(struct wl_display *display); struct wl_list * wl_client_get_link(struct wl_client *client); struct wl_client * wl_client_from_link(struct wl_list *link); /** Iterate over a list of clients. */ #define wl_client_for_each(client, list) … void wl_client_destroy(struct wl_client *client); void wl_client_flush(struct wl_client *client); void wl_client_get_credentials(struct wl_client *client, pid_t *pid, uid_t *uid, gid_t *gid); int wl_client_get_fd(struct wl_client *client); void wl_client_add_destroy_listener(struct wl_client *client, struct wl_listener *listener); struct wl_listener * wl_client_get_destroy_listener(struct wl_client *client, wl_notify_func_t notify); void wl_client_add_destroy_late_listener(struct wl_client *client, struct wl_listener *listener); struct wl_listener * wl_client_get_destroy_late_listener(struct wl_client *client, wl_notify_func_t notify); struct wl_resource * wl_client_get_object(struct wl_client *client, uint32_t id); void wl_client_post_no_memory(struct wl_client *client); void wl_client_post_implementation_error(struct wl_client *client, const char* msg, ...) WL_PRINTF(2,3); void wl_client_add_resource_created_listener(struct wl_client *client, struct wl_listener *listener); wl_client_for_each_resource_iterator_func_t; void wl_client_for_each_resource(struct wl_client *client, wl_client_for_each_resource_iterator_func_t iterator, void *user_data); wl_user_data_destroy_func_t; void wl_client_set_user_data(struct wl_client *client, void *data, wl_user_data_destroy_func_t dtor); void * wl_client_get_user_data(struct wl_client *client); void wl_client_set_max_buffer_size(struct wl_client *client, size_t max_buffer_size); /** \class wl_listener * * \brief A single listener for Wayland signals * * wl_listener provides the means to listen for wl_signal notifications. Many * Wayland objects use wl_listener for notification of significant events like * object destruction. * * Clients should create wl_listener objects manually and can register them as * listeners to signals using #wl_signal_add, assuming the signal is * directly accessible. For opaque structs like wl_event_loop, adding a * listener should be done through provided accessor methods. A listener can * only listen to one signal at a time. * * \code * struct wl_listener your_listener; * * your_listener.notify = your_callback_method; * * // Direct access * wl_signal_add(&some_object->destroy_signal, &your_listener); * * // Accessor access * wl_event_loop *loop = ...; * wl_event_loop_add_destroy_listener(loop, &your_listener); * \endcode * * If the listener is part of a larger struct, #wl_container_of can be used * to retrieve a pointer to it: * * \code * void your_listener(struct wl_listener *listener, void *data) * { * struct your_data *data; * * your_data = wl_container_of(listener, data, your_member_name); * } * \endcode * * If you need to remove a listener from a signal, use wl_list_remove(). * * \code * wl_list_remove(&your_listener.link); * \endcode * * \sa wl_signal */ struct wl_listener { … }; /** \class wl_signal * * \brief A source of a type of observable event * * Signals are recognized points where significant events can be observed. * Compositors as well as the server can provide signals. Observers are * wl_listener's that are added through #wl_signal_add. Signals are emitted * using #wl_signal_emit, which will invoke all listeners until that * listener is removed by wl_list_remove() (or whenever the signal is * destroyed). * * \sa wl_listener for more information on using wl_signal */ struct wl_signal { … }; /** Initialize a new \ref wl_signal for use. * * \param signal The signal that will be initialized * * \memberof wl_signal */ static inline void wl_signal_init(struct wl_signal *signal) { … } /** Add the specified listener to this signal. * * \param signal The signal that will emit events to the listener * \param listener The listener to add * * \memberof wl_signal */ static inline void wl_signal_add(struct wl_signal *signal, struct wl_listener *listener) { … } /** Gets the listener struct for the specified callback. * * \param signal The signal that contains the specified listener * \param notify The listener that is the target of this search * \return the list item that corresponds to the specified listener, or NULL * if none was found * * \memberof wl_signal */ static inline struct wl_listener * wl_signal_get(struct wl_signal *signal, wl_notify_func_t notify) { … } /** Emits this signal, notifying all registered listeners. * * \param signal The signal object that will emit the signal * \param data The data that will be emitted with the signal * * \memberof wl_signal */ static inline void wl_signal_emit(struct wl_signal *signal, void *data) { … } void wl_signal_emit_mutable(struct wl_signal *signal, void *data); wl_resource_destroy_func_t; /* * Post an event to the client's object referred to by 'resource'. * 'opcode' is the event number generated from the protocol XML * description (the event name). The variable arguments are the event * parameters, in the order they appear in the protocol XML specification. * * The variable arguments' types are: * - type=uint: uint32_t * - type=int: int32_t * - type=fixed: wl_fixed_t * - type=string: (const char *) to a nil-terminated string * - type=array: (struct wl_array *) * - type=fd: int, that is an open file descriptor * - type=new_id: (struct wl_object *) or (struct wl_resource *) * - type=object: (struct wl_object *) or (struct wl_resource *) */ void wl_resource_post_event(struct wl_resource *resource, uint32_t opcode, ...); void wl_resource_post_event_array(struct wl_resource *resource, uint32_t opcode, union wl_argument *args); void wl_resource_queue_event(struct wl_resource *resource, uint32_t opcode, ...); void wl_resource_queue_event_array(struct wl_resource *resource, uint32_t opcode, union wl_argument *args); /* msg is a printf format string, variable args are its args. */ void wl_resource_post_error(struct wl_resource *resource, uint32_t code, const char *msg, ...) WL_PRINTF(3, 4); void wl_resource_post_no_memory(struct wl_resource *resource); struct wl_display * wl_client_get_display(struct wl_client *client); struct wl_resource * wl_resource_create(struct wl_client *client, const struct wl_interface *interface, int version, uint32_t id); void wl_resource_set_implementation(struct wl_resource *resource, const void *implementation, void *data, wl_resource_destroy_func_t destroy); void wl_resource_set_dispatcher(struct wl_resource *resource, wl_dispatcher_func_t dispatcher, const void *implementation, void *data, wl_resource_destroy_func_t destroy); void wl_resource_destroy(struct wl_resource *resource); uint32_t wl_resource_get_id(struct wl_resource *resource); struct wl_list * wl_resource_get_link(struct wl_resource *resource); struct wl_resource * wl_resource_from_link(struct wl_list *resource); struct wl_resource * wl_resource_find_for_client(struct wl_list *list, struct wl_client *client); struct wl_client * wl_resource_get_client(struct wl_resource *resource); void wl_resource_set_user_data(struct wl_resource *resource, void *data); void * wl_resource_get_user_data(struct wl_resource *resource); int wl_resource_get_version(struct wl_resource *resource); void wl_resource_set_destructor(struct wl_resource *resource, wl_resource_destroy_func_t destroy); int wl_resource_instance_of(struct wl_resource *resource, const struct wl_interface *interface, const void *implementation); const char * wl_resource_get_class(struct wl_resource *resource); void wl_resource_add_destroy_listener(struct wl_resource *resource, struct wl_listener *listener); struct wl_listener * wl_resource_get_destroy_listener(struct wl_resource *resource, wl_notify_func_t notify); #define wl_resource_for_each(resource, list) … #define wl_resource_for_each_safe(resource, tmp, list) … struct wl_shm_buffer * wl_shm_buffer_get(struct wl_resource *resource); void wl_shm_buffer_begin_access(struct wl_shm_buffer *buffer); void wl_shm_buffer_end_access(struct wl_shm_buffer *buffer); void * wl_shm_buffer_get_data(struct wl_shm_buffer *buffer); int32_t wl_shm_buffer_get_stride(struct wl_shm_buffer *buffer); uint32_t wl_shm_buffer_get_format(struct wl_shm_buffer *buffer); int32_t wl_shm_buffer_get_width(struct wl_shm_buffer *buffer); int32_t wl_shm_buffer_get_height(struct wl_shm_buffer *buffer); struct wl_shm_pool * wl_shm_buffer_ref_pool(struct wl_shm_buffer *buffer); void wl_shm_pool_unref(struct wl_shm_pool *pool); int wl_display_init_shm(struct wl_display *display); uint32_t * wl_display_add_shm_format(struct wl_display *display, uint32_t format); struct wl_shm_buffer * wl_shm_buffer_create(struct wl_client *client, uint32_t id, int32_t width, int32_t height, int32_t stride, uint32_t format) WL_DEPRECATED; void wl_log_set_handler_server(wl_log_func_t handler); enum wl_protocol_logger_type { … }; struct wl_protocol_logger_message { … }; wl_protocol_logger_func_t; struct wl_protocol_logger * wl_display_add_protocol_logger(struct wl_display *display, wl_protocol_logger_func_t, void *user_data); void wl_protocol_logger_destroy(struct wl_protocol_logger *logger); #ifdef __cplusplus } #endif #endif
Codebase Browser
chromium