| 1 | /* |
|---|
| 2 | * libcaca Colour ASCII-Art library |
|---|
| 3 | * Copyright (c) 2002-2006 Sam Hocevar <sam@zoy.org> |
|---|
| 4 | * All Rights Reserved |
|---|
| 5 | * |
|---|
| 6 | * $Id: caca.h 2303 2008-04-19 19:25:41Z sam $ |
|---|
| 7 | * |
|---|
| 8 | * This library is free software. It comes without any warranty, to |
|---|
| 9 | * the extent permitted by applicable law. You can redistribute it |
|---|
| 10 | * and/or modify it under the terms of the Do What The Fuck You Want |
|---|
| 11 | * To Public License, Version 2, as published by Sam Hocevar. See |
|---|
| 12 | * http://sam.zoy.org/wtfpl/COPYING for more details. |
|---|
| 13 | */ |
|---|
| 14 | |
|---|
| 15 | /** \file caca.h |
|---|
| 16 | * \version \$Id: caca.h 2303 2008-04-19 19:25:41Z sam $ |
|---|
| 17 | * \author Sam Hocevar <sam@zoy.org> |
|---|
| 18 | * \brief The \e libcaca public header. |
|---|
| 19 | * |
|---|
| 20 | * This header contains the public types and functions that applications |
|---|
| 21 | * using \e libcaca may use. |
|---|
| 22 | */ |
|---|
| 23 | |
|---|
| 24 | #ifndef __CACA_H__ |
|---|
| 25 | #define __CACA_H__ |
|---|
| 26 | |
|---|
| 27 | #include <cucul.h> |
|---|
| 28 | |
|---|
| 29 | #undef __extern |
|---|
| 30 | #if defined(_WIN32) && defined(__LIBCACA__) |
|---|
| 31 | # define __extern extern __declspec(dllexport) |
|---|
| 32 | #else |
|---|
| 33 | # define __extern extern |
|---|
| 34 | #endif |
|---|
| 35 | |
|---|
| 36 | /** libcaca API version */ |
|---|
| 37 | #define CACA_API_VERSION_1 |
|---|
| 38 | |
|---|
| 39 | #ifdef __cplusplus |
|---|
| 40 | extern "C" |
|---|
| 41 | { |
|---|
| 42 | #endif |
|---|
| 43 | |
|---|
| 44 | /** \e libcaca display context */ |
|---|
| 45 | typedef struct caca_display caca_display_t; |
|---|
| 46 | /** \e libcaca event structure */ |
|---|
| 47 | typedef struct caca_event caca_event_t; |
|---|
| 48 | |
|---|
| 49 | /** \brief User event type enumeration. |
|---|
| 50 | * |
|---|
| 51 | * This enum serves two purposes: |
|---|
| 52 | * - Build listening masks for caca_get_event(). |
|---|
| 53 | * - Define the type of a \e caca_event_t. |
|---|
| 54 | */ |
|---|
| 55 | enum caca_event_type |
|---|
| 56 | { |
|---|
| 57 | CACA_EVENT_NONE = 0x0000, /**< No event. */ |
|---|
| 58 | |
|---|
| 59 | CACA_EVENT_KEY_PRESS = 0x0001, /**< A key was pressed. */ |
|---|
| 60 | CACA_EVENT_KEY_RELEASE = 0x0002, /**< A key was released. */ |
|---|
| 61 | CACA_EVENT_MOUSE_PRESS = 0x0004, /**< A mouse button was pressed. */ |
|---|
| 62 | CACA_EVENT_MOUSE_RELEASE = 0x0008, /**< A mouse button was released. */ |
|---|
| 63 | CACA_EVENT_MOUSE_MOTION = 0x0010, /**< The mouse was moved. */ |
|---|
| 64 | CACA_EVENT_RESIZE = 0x0020, /**< The window was resized. */ |
|---|
| 65 | CACA_EVENT_QUIT = 0x0040, /**< The user requested to quit. */ |
|---|
| 66 | |
|---|
| 67 | CACA_EVENT_ANY = 0xffff /**< Bitmask for any event. */ |
|---|
| 68 | }; |
|---|
| 69 | |
|---|
| 70 | /** \brief Handling of user events. |
|---|
| 71 | * |
|---|
| 72 | * This structure is filled by caca_get_event() when an event is received. |
|---|
| 73 | * It is an opaque structure that should only be accessed through |
|---|
| 74 | * caca_event_get_type() and similar functions. The struct members may no |
|---|
| 75 | * longer be directly accessible in future versions. |
|---|
| 76 | */ |
|---|
| 77 | struct caca_event |
|---|
| 78 | { |
|---|
| 79 | enum caca_event_type type; |
|---|
| 80 | union |
|---|
| 81 | { |
|---|
| 82 | struct { unsigned int x, y, button; } mouse; |
|---|
| 83 | struct { unsigned int w, h; } resize; |
|---|
| 84 | struct { unsigned int ch; uint32_t utf32; char utf8[8]; } key; |
|---|
| 85 | } data; |
|---|
| 86 | uint8_t padding[16]; |
|---|
| 87 | }; |
|---|
| 88 | |
|---|
| 89 | /** \brief Special key values. |
|---|
| 90 | * |
|---|
| 91 | * Special key values returned by caca_get_event() for which there is no |
|---|
| 92 | * printable ASCII equivalent. |
|---|
| 93 | */ |
|---|
| 94 | enum caca_key |
|---|
| 95 | { |
|---|
| 96 | CACA_KEY_UNKNOWN = 0x00, /**< Unknown key. */ |
|---|
| 97 | |
|---|
| 98 | /* The following keys have ASCII equivalents */ |
|---|
| 99 | CACA_KEY_CTRL_A = 0x01, /**< The Ctrl-A key. */ |
|---|
| 100 | CACA_KEY_CTRL_B = 0x02, /**< The Ctrl-B key. */ |
|---|
| 101 | CACA_KEY_CTRL_C = 0x03, /**< The Ctrl-C key. */ |
|---|
| 102 | CACA_KEY_CTRL_D = 0x04, /**< The Ctrl-D key. */ |
|---|
| 103 | CACA_KEY_CTRL_E = 0x05, /**< The Ctrl-E key. */ |
|---|
| 104 | CACA_KEY_CTRL_F = 0x06, /**< The Ctrl-F key. */ |
|---|
| 105 | CACA_KEY_CTRL_G = 0x07, /**< The Ctrl-G key. */ |
|---|
| 106 | CACA_KEY_BACKSPACE = 0x08, /**< The backspace key. */ |
|---|
| 107 | CACA_KEY_TAB = 0x09, /**< The tabulation key. */ |
|---|
| 108 | CACA_KEY_CTRL_J = 0x0a, /**< The Ctrl-J key. */ |
|---|
| 109 | CACA_KEY_CTRL_K = 0x0b, /**< The Ctrl-K key. */ |
|---|
| 110 | CACA_KEY_CTRL_L = 0x0c, /**< The Ctrl-L key. */ |
|---|
| 111 | CACA_KEY_RETURN = 0x0d, /**< The return key. */ |
|---|
| 112 | CACA_KEY_CTRL_N = 0x0e, /**< The Ctrl-N key. */ |
|---|
| 113 | CACA_KEY_CTRL_O = 0x0f, /**< The Ctrl-O key. */ |
|---|
| 114 | CACA_KEY_CTRL_P = 0x10, /**< The Ctrl-P key. */ |
|---|
| 115 | CACA_KEY_CTRL_Q = 0x11, /**< The Ctrl-Q key. */ |
|---|
| 116 | CACA_KEY_CTRL_R = 0x12, /**< The Ctrl-R key. */ |
|---|
| 117 | CACA_KEY_PAUSE = 0x13, /**< The pause key. */ |
|---|
| 118 | CACA_KEY_CTRL_T = 0x14, /**< The Ctrl-T key. */ |
|---|
| 119 | CACA_KEY_CTRL_U = 0x15, /**< The Ctrl-U key. */ |
|---|
| 120 | CACA_KEY_CTRL_V = 0x16, /**< The Ctrl-V key. */ |
|---|
| 121 | CACA_KEY_CTRL_W = 0x17, /**< The Ctrl-W key. */ |
|---|
| 122 | CACA_KEY_CTRL_X = 0x18, /**< The Ctrl-X key. */ |
|---|
| 123 | CACA_KEY_CTRL_Y = 0x19, /**< The Ctrl-Y key. */ |
|---|
| 124 | CACA_KEY_CTRL_Z = 0x1a, /**< The Ctrl-Z key. */ |
|---|
| 125 | CACA_KEY_ESCAPE = 0x1b, /**< The escape key. */ |
|---|
| 126 | CACA_KEY_DELETE = 0x7f, /**< The delete key. */ |
|---|
| 127 | |
|---|
| 128 | /* The following keys do not have ASCII equivalents but have been |
|---|
| 129 | * chosen to match the SDL equivalents */ |
|---|
| 130 | CACA_KEY_UP = 0x111, /**< The up arrow key. */ |
|---|
| 131 | CACA_KEY_DOWN = 0x112, /**< The down arrow key. */ |
|---|
| 132 | CACA_KEY_LEFT = 0x113, /**< The left arrow key. */ |
|---|
| 133 | CACA_KEY_RIGHT = 0x114, /**< The right arrow key. */ |
|---|
| 134 | |
|---|
| 135 | CACA_KEY_INSERT = 0x115, /**< The insert key. */ |
|---|
| 136 | CACA_KEY_HOME = 0x116, /**< The home key. */ |
|---|
| 137 | CACA_KEY_END = 0x117, /**< The end key. */ |
|---|
| 138 | CACA_KEY_PAGEUP = 0x118, /**< The page up key. */ |
|---|
| 139 | CACA_KEY_PAGEDOWN = 0x119, /**< The page down key. */ |
|---|
| 140 | |
|---|
| 141 | CACA_KEY_F1 = 0x11a, /**< The F1 key. */ |
|---|
| 142 | CACA_KEY_F2 = 0x11b, /**< The F2 key. */ |
|---|
| 143 | CACA_KEY_F3 = 0x11c, /**< The F3 key. */ |
|---|
| 144 | CACA_KEY_F4 = 0x11d, /**< The F4 key. */ |
|---|
| 145 | CACA_KEY_F5 = 0x11e, /**< The F5 key. */ |
|---|
| 146 | CACA_KEY_F6 = 0x11f, /**< The F6 key. */ |
|---|
| 147 | CACA_KEY_F7 = 0x120, /**< The F7 key. */ |
|---|
| 148 | CACA_KEY_F8 = 0x121, /**< The F8 key. */ |
|---|
| 149 | CACA_KEY_F9 = 0x122, /**< The F9 key. */ |
|---|
| 150 | CACA_KEY_F10 = 0x123, /**< The F10 key. */ |
|---|
| 151 | CACA_KEY_F11 = 0x124, /**< The F11 key. */ |
|---|
| 152 | CACA_KEY_F12 = 0x125, /**< The F12 key. */ |
|---|
| 153 | CACA_KEY_F13 = 0x126, /**< The F13 key. */ |
|---|
| 154 | CACA_KEY_F14 = 0x127, /**< The F14 key. */ |
|---|
| 155 | CACA_KEY_F15 = 0x128 /**< The F15 key. */ |
|---|
| 156 | }; |
|---|
| 157 | |
|---|
| 158 | /** \defgroup libcaca libcaca basic functions |
|---|
| 159 | * |
|---|
| 160 | * These functions provide the basic \e libcaca routines for driver |
|---|
| 161 | * initialisation, system information retrieval and configuration. |
|---|
| 162 | * |
|---|
| 163 | * @{ */ |
|---|
| 164 | __extern caca_display_t * caca_create_display(cucul_canvas_t *); |
|---|
| 165 | __extern caca_display_t * caca_create_display_with_driver(cucul_canvas_t *, |
|---|
| 166 | char const *); |
|---|
| 167 | __extern char const * const * caca_get_display_driver_list(void); |
|---|
| 168 | __extern char const * caca_get_display_driver(caca_display_t *); |
|---|
| 169 | __extern int caca_set_display_driver(caca_display_t *, char const *); |
|---|
| 170 | __extern int caca_free_display(caca_display_t *); |
|---|
| 171 | __extern cucul_canvas_t * caca_get_canvas(caca_display_t *); |
|---|
| 172 | __extern int caca_refresh_display(caca_display_t *); |
|---|
| 173 | __extern int caca_set_display_time(caca_display_t *, unsigned int); |
|---|
| 174 | __extern unsigned int caca_get_display_time(caca_display_t const *); |
|---|
| 175 | __extern unsigned int caca_get_display_width(caca_display_t const *); |
|---|
| 176 | __extern unsigned int caca_get_display_height(caca_display_t const *); |
|---|
| 177 | __extern int caca_set_display_title(caca_display_t *, char const *); |
|---|
| 178 | __extern int caca_set_mouse(caca_display_t *, int); |
|---|
| 179 | __extern int caca_set_cursor(caca_display_t *, int); |
|---|
| 180 | __extern char const * caca_get_version(void); |
|---|
| 181 | /* @} */ |
|---|
| 182 | |
|---|
| 183 | /** \defgroup caca_event libcaca event handling |
|---|
| 184 | * |
|---|
| 185 | * These functions handle user events such as keyboard input and mouse |
|---|
| 186 | * clicks. |
|---|
| 187 | * |
|---|
| 188 | * @{ */ |
|---|
| 189 | __extern int caca_get_event(caca_display_t *, unsigned int, |
|---|
| 190 | caca_event_t *, int); |
|---|
| 191 | __extern unsigned int caca_get_mouse_x(caca_display_t const *); |
|---|
| 192 | __extern unsigned int caca_get_mouse_y(caca_display_t const *); |
|---|
| 193 | __extern enum caca_event_type caca_get_event_type(caca_event_t const *); |
|---|
| 194 | __extern unsigned int caca_get_event_key_ch(caca_event_t const *); |
|---|
| 195 | __extern uint32_t caca_get_event_key_utf32(caca_event_t const *); |
|---|
| 196 | __extern int caca_get_event_key_utf8(caca_event_t const *, char *); |
|---|
| 197 | __extern unsigned int caca_get_event_mouse_button(caca_event_t const *); |
|---|
| 198 | __extern unsigned int caca_get_event_mouse_x(caca_event_t const *); |
|---|
| 199 | __extern unsigned int caca_get_event_mouse_y(caca_event_t const *); |
|---|
| 200 | __extern unsigned int caca_get_event_resize_width(caca_event_t const *); |
|---|
| 201 | __extern unsigned int caca_get_event_resize_height(caca_event_t const *); |
|---|
| 202 | /* @} */ |
|---|
| 203 | |
|---|
| 204 | #ifdef __cplusplus |
|---|
| 205 | } |
|---|
| 206 | #endif |
|---|
| 207 | |
|---|
| 208 | #if !defined(_DOXYGEN_SKIP_ME) |
|---|
| 209 | # undef __extern |
|---|
| 210 | #endif |
|---|
| 211 | |
|---|
| 212 | #endif /* __CACA_H__ */ |
|---|
