uwac.h

/*
 * Copyright © 2014-2015 David FORT <contact@hardening-consulting.com>
 *
 * Permission to use, copy, modify, distribute, and sell this software and its
 * documentation for any purpose is hereby granted without fee, provided that
 * the above copyright notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting documentation, and
 * that the name of the copyright holders not be used in advertising or
 * publicity pertaining to distribution of the software without specific,
 * written prior permission.  The copyright holders make no representations
 * about the suitability of this software for any purpose.  It is provided "as
 * is" without express or implied warranty.
 *
 * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
 * OF THIS SOFTWARE.
 */
 
#ifndef UWAC_H_
#define UWAC_H_
 
#include <wayland-client.h>
#include <stdbool.h>
 
#if defined(__GNUC__) && (__GNUC__ >= 4)
#define UWAC_API __attribute__((visibility("default")))
#else
#define UWAC_API
#endif
 
typedef struct uwac_position UwacPosition;
typedef struct uwac_size UwacSize;
typedef struct uwac_display UwacDisplay;
typedef struct uwac_output UwacOutput;
typedef struct uwac_window UwacWindow;
typedef struct uwac_seat UwacSeat;
typedef uint32_t UwacSeatId;
 
typedef enum
{
  UWAC_SUCCESS = 0,
  UWAC_ERROR_NOMEMORY,
  UWAC_ERROR_UNABLE_TO_CONNECT,
  UWAC_ERROR_INVALID_DISPLAY,
  UWAC_NOT_ENOUGH_RESOURCES,
  UWAC_TIMEDOUT,
  UWAC_NOT_FOUND,
  UWAC_ERROR_CLOSED,
  UWAC_ERROR_INTERNAL,
 
  UWAC_ERROR_LAST,
} UwacReturnCode;
 
enum
{
  UWAC_MOD_SHIFT_MASK = 0x01,
  UWAC_MOD_ALT_MASK = 0x02,
  UWAC_MOD_CONTROL_MASK = 0x04,
  UWAC_MOD_CAPS_MASK = 0x08,
  UWAC_MOD_NUM_MASK = 0x10,
};
 
struct uwac_position
{
  int x;
  int y;
};
 
struct uwac_size
{
  int width;
  int height;
};
 
enum
{
  UWAC_EVENT_NEW_SEAT = 0,
  UWAC_EVENT_REMOVED_SEAT,
  UWAC_EVENT_NEW_OUTPUT,
  UWAC_EVENT_CONFIGURE,
  UWAC_EVENT_POINTER_ENTER,
  UWAC_EVENT_POINTER_LEAVE,
  UWAC_EVENT_POINTER_MOTION,
  UWAC_EVENT_POINTER_BUTTONS,
  UWAC_EVENT_POINTER_AXIS,
  UWAC_EVENT_KEYBOARD_ENTER,
  UWAC_EVENT_KEYBOARD_MODIFIERS,
  UWAC_EVENT_KEY,
  UWAC_EVENT_TOUCH_FRAME_BEGIN,
  UWAC_EVENT_TOUCH_UP,
  UWAC_EVENT_TOUCH_DOWN,
  UWAC_EVENT_TOUCH_MOTION,
  UWAC_EVENT_TOUCH_CANCEL,
  UWAC_EVENT_TOUCH_FRAME_END,
  UWAC_EVENT_FRAME_DONE,
  UWAC_EVENT_CLOSE,
  UWAC_EVENT_CLIPBOARD_AVAILABLE,
  UWAC_EVENT_CLIPBOARD_SELECT,
  UWAC_EVENT_CLIPBOARD_OFFER,
  UWAC_EVENT_OUTPUT_GEOMETRY,
  UWAC_EVENT_POINTER_AXIS_DISCRETE,
  UWAC_EVENT_POINTER_FRAME,
  UWAC_EVENT_POINTER_SOURCE
};
 
enum
{
  UWAC_WINDOW_MAXIMIZED = 0x1,
  UWAC_WINDOW_RESIZING = 0x2,
  UWAC_WINDOW_FULLSCREEN = 0x4,
  UWAC_WINDOW_ACTIVATED = 0x8,
};
 
struct uwac_new_output_event
{
  int type;
  UwacOutput* output;
};
typedef struct uwac_new_output_event UwacOutputNewEvent;
 
struct uwac_new_seat_event
{
  int type;
  UwacSeat* seat;
};
typedef struct uwac_new_seat_event UwacSeatNewEvent;
 
struct uwac_removed_seat_event
{
  int type;
  UwacSeatId id;
};
typedef struct uwac_removed_seat_event UwacSeatRemovedEvent;
 
struct uwac_keyboard_enter_event
{
  int type;
  UwacWindow* window;
  UwacSeat* seat;
};
typedef struct uwac_keyboard_enter_event UwacKeyboardEnterLeaveEvent;
 
struct uwac_keyboard_modifiers_event
{
  int type;
  uint32_t modifiers;
};
typedef struct uwac_keyboard_modifiers_event UwacKeyboardModifiersEvent;
 
struct uwac_pointer_enter_event
{
  int type;
  UwacWindow* window;
  UwacSeat* seat;
  uint32_t x, y;
};
typedef struct uwac_pointer_enter_event UwacPointerEnterLeaveEvent;
 
struct uwac_pointer_motion_event
{
  int type;
  UwacWindow* window;
  UwacSeat* seat;
  uint32_t x, y;
};
typedef struct uwac_pointer_motion_event UwacPointerMotionEvent;
 
struct uwac_pointer_button_event
{
  int type;
  UwacWindow* window;
  UwacSeat* seat;
  uint32_t x, y;
  uint32_t button;
  enum wl_pointer_button_state state;
};
typedef struct uwac_pointer_button_event UwacPointerButtonEvent;
 
struct uwac_pointer_axis_event
{
  int type;
  UwacWindow* window;
  UwacSeat* seat;
  uint32_t x, y;
  uint32_t axis;
  wl_fixed_t value;
};
typedef struct uwac_pointer_axis_event UwacPointerAxisEvent;
 
struct uwac_pointer_frame_event
{
  int type;
  UwacWindow* window;
  UwacSeat* seat;
};
typedef struct uwac_pointer_frame_event UwacPointerFrameEvent;
 
struct uwac_pointer_source_event
{
  int type;
  UwacWindow* window;
  UwacSeat* seat;
  enum wl_pointer_axis_source axis_source;
};
typedef struct uwac_pointer_source_event UwacPointerSourceEvent;
 
struct uwac_touch_frame_event
{
  int type;
  UwacWindow* window;
  UwacSeat* seat;
};
typedef struct uwac_touch_frame_event UwacTouchFrameBegin;
typedef struct uwac_touch_frame_event UwacTouchFrameEnd;
typedef struct uwac_touch_frame_event UwacTouchCancel;
 
struct uwac_touch_data
{
  int type;
  UwacWindow* window;
  UwacSeat* seat;
  int32_t id;
  wl_fixed_t x;
  wl_fixed_t y;
};
typedef struct uwac_touch_data UwacTouchUp;
typedef struct uwac_touch_data UwacTouchDown;
typedef struct uwac_touch_data UwacTouchMotion;
 
struct uwac_frame_done_event
{
  int type;
  UwacWindow* window;
};
typedef struct uwac_frame_done_event UwacFrameDoneEvent;
 
struct uwac_configure_event
{
  int type;
  UwacWindow* window;
  int32_t width;
  int32_t height;
  int states;
};
typedef struct uwac_configure_event UwacConfigureEvent;
 
struct uwac_key_event
{
  int type;
  UwacWindow* window;
  uint32_t raw_key;
  uint32_t sym;
  bool pressed;
  bool repeated;
};
typedef struct uwac_key_event UwacKeyEvent;
 
struct uwac_close_event
{
  int type;
  UwacWindow* window;
};
typedef struct uwac_close_event UwacCloseEvent;
 
struct uwac_clipboard_event
{
  int type;
  UwacSeat* seat;
  char mime[64];
};
typedef struct uwac_clipboard_event UwacClipboardEvent;
 
struct uwac_output_geometry_event
{
  int type;
  UwacOutput* output;
  int x;
  int y;
  int physical_width;
  int physical_height;
  int subpixel;
  const char* make;
  const char* model;
  int transform;
};
typedef struct uwac_output_geometry_event UwacOutputGeometryEvent;
 
union uwac_event
{
  int type;
  UwacOutputNewEvent output_new;
  UwacOutputGeometryEvent output_geometry;
  UwacSeatNewEvent seat_new;
  UwacSeatRemovedEvent seat_removed;
  UwacPointerEnterLeaveEvent mouse_enter_leave;
  UwacPointerMotionEvent mouse_motion;
  UwacPointerButtonEvent mouse_button;
  UwacPointerAxisEvent mouse_axis;
  UwacPointerFrameEvent mouse_frame;
  UwacPointerSourceEvent mouse_source;
  UwacKeyboardEnterLeaveEvent keyboard_enter_leave;
  UwacKeyboardModifiersEvent keyboard_modifiers;
  UwacClipboardEvent clipboard;
  UwacKeyEvent key;
  UwacTouchFrameBegin touchFrameBegin;
  UwacTouchUp touchUp;
  UwacTouchDown touchDown;
  UwacTouchMotion touchMotion;
  UwacTouchFrameEnd touchFrameEnd;
  UwacTouchCancel touchCancel;
  UwacFrameDoneEvent frame_done;
  UwacConfigureEvent configure;
  UwacCloseEvent close;
};
typedef union uwac_event UwacEvent;
 
typedef bool (*UwacErrorHandler)(UwacDisplay* d, UwacReturnCode code, const char* msg, ...);
typedef void (*UwacDataTransferHandler)(UwacSeat* seat, void* context, const char* mime, int fd);
typedef void (*UwacCancelDataTransferHandler)(UwacSeat* seat, void* context);
 
#ifdef __cplusplus
extern "C"
{
#endif
 
  UWAC_API void UwacInstallErrorHandler(UwacErrorHandler handler);
 
  UWAC_API UwacDisplay* UwacOpenDisplay(const char* name, UwacReturnCode* err);
 
  UWAC_API UwacReturnCode UwacCloseDisplay(UwacDisplay** pdisplay);
 
  UWAC_API int UwacDisplayGetFd(UwacDisplay* display);
 
  UWAC_API const char* UwacErrorString(UwacReturnCode error);
 
  UWAC_API UwacReturnCode UwacDisplayGetLastError(const UwacDisplay* display);
 
  UWAC_API UwacReturnCode UwacDisplayQueryInterfaceVersion(const UwacDisplay* display,
                                                           const char* name, uint32_t* version);
 
  UWAC_API uint32_t UwacDisplayQueryGetNbShmFormats(UwacDisplay* display);
 
  UWAC_API UwacReturnCode UwacDisplayQueryShmFormats(const UwacDisplay* display,
                                                     enum wl_shm_format* formats,
                                                     int formats_size, int* filled);
 
  UWAC_API uint32_t UwacDisplayGetNbOutputs(const UwacDisplay* display);
 
  UWAC_API const UwacOutput* UwacDisplayGetOutput(UwacDisplay* display, int index);
 
  UWAC_API UwacReturnCode UwacOutputGetResolution(const UwacOutput* output, UwacSize* resolution);
 
  UWAC_API UwacReturnCode UwacOutputGetPosition(const UwacOutput* output, UwacPosition* pos);
 
  UWAC_API UwacWindow* UwacCreateWindowShm(UwacDisplay* display, uint32_t width, uint32_t height,
                                           enum wl_shm_format format);
 
  UWAC_API UwacReturnCode UwacDestroyWindow(UwacWindow** window);
 
  UWAC_API UwacReturnCode UwacWindowSetOpaqueRegion(UwacWindow* window, uint32_t x, uint32_t y,
                                                    uint32_t width, uint32_t height);
 
  UWAC_API UwacReturnCode UwacWindowSetInputRegion(UwacWindow* window, uint32_t x, uint32_t y,
                                                   uint32_t width, uint32_t height);
 
  UWAC_API void* UwacWindowGetDrawingBuffer(UwacWindow* window);
 
  UWAC_API UwacReturnCode UwacWindowAddDamage(UwacWindow* window, uint32_t x, uint32_t y,
                                              uint32_t width, uint32_t height);
 
  UWAC_API UwacReturnCode UwacWindowGetDrawingBufferGeometry(UwacWindow* window,
                                                             UwacSize* geometry, size_t* stride);
 
  UWAC_API UwacReturnCode UwacWindowSubmitBuffer(UwacWindow* window,
                                                 bool copyContentForNextFrame);
 
  UWAC_API UwacReturnCode UwacWindowGetGeometry(UwacWindow* window, UwacSize* geometry);
 
  UWAC_API UwacReturnCode UwacWindowSetFullscreenState(UwacWindow* window, UwacOutput* output,
                                                       bool isFullscreen);
 
  UWAC_API void UwacWindowSetTitle(UwacWindow* window, const char* name);
 
  UWAC_API void UwacWindowSetAppId(UwacWindow* window, const char* app_id);
 
  UWAC_API int UwacDisplayDispatch(UwacDisplay* display, int timeout);
 
  UWAC_API bool UwacHasEvent(UwacDisplay* display);
 
  UWAC_API UwacReturnCode UwacNextEvent(UwacDisplay* display, UwacEvent* event);
 
  UWAC_API const char* UwacSeatGetName(const UwacSeat* seat);
 
  UWAC_API UwacSeatId UwacSeatGetId(const UwacSeat* seat);
 
  UWAC_API UwacReturnCode UwacClipboardOfferDestroy(UwacSeat* seat);
  UWAC_API UwacReturnCode UwacClipboardOfferCreate(UwacSeat* seat, const char* mime);
  UWAC_API UwacReturnCode UwacClipboardOfferAnnounce(UwacSeat* seat, void* context,
                                                     UwacDataTransferHandler transfer,
                                                     UwacCancelDataTransferHandler cancel);
  UWAC_API void* UwacClipboardDataGet(UwacSeat* seat, const char* mime, size_t* size);
 
  UWAC_API UwacReturnCode UwacSeatInhibitShortcuts(UwacSeat* seat, bool inhibit);
 
  UWAC_API UwacReturnCode UwacSeatSetMouseCursor(UwacSeat* seat, const void* data, size_t length,
                                                 size_t width, size_t height, size_t hot_x,
                                                 size_t hot_y);
 
#ifdef __cplusplus
}
#endif
 
#endif /* UWAC_H_ */