source: libcaca/trunk/caca/caca.h @ 4333

Last change on this file since 4333 was 4333, checked in by Sam Hocevar, 10 years ago

Large source code cleanup, getting rid of spaces, tabs, and svn keywords.

  • Property svn:keywords set to Id
File size: 37.2 KB
Line 
1/*
2 *  libcaca       Colour ASCII-Art library
3 *  Copyright (c) 2002-2010 Sam Hocevar <sam@hocevar.net>
4 *                All Rights Reserved
5 *
6 *  This library is free software. It comes without any warranty, to
7 *  the extent permitted by applicable law. You can redistribute it
8 *  and/or modify it under the terms of the Do What The Fuck You Want
9 *  To Public License, Version 2, as published by Sam Hocevar. See
10 *  http://sam.zoy.org/wtfpl/COPYING for more details.
11 */
12
13/** \file caca.h
14 *  \author Sam Hocevar <sam@hocevar.net>
15 *  \brief The \e libcaca public header.
16 *
17 *  This header contains the public types and functions that applications
18 *  using \e libcaca may use.
19 */
20
21#ifndef __CACA_H__
22#define __CACA_H__
23
24#include <caca_types.h>
25
26#if !defined(__KERNEL__)
27#   include <stdarg.h>
28#endif
29
30#undef __extern
31#if defined _DOXYGEN_SKIP_ME
32#elif defined _WIN32 && defined __LIBCACA__ && defined DLL_EXPORT
33#   define __extern extern __declspec(dllexport)
34#elif defined _WIN32 && !defined __LIBCACA__
35#   define __extern extern __declspec(dllimport)
36#else
37#   define __extern extern
38#endif
39
40/** libcaca API version */
41#define CACA_API_VERSION_1
42
43#ifdef __cplusplus
44extern "C"
45{
46#endif
47
48/** \e libcaca canvas */
49typedef struct caca_canvas caca_canvas_t;
50/** dither structure */
51typedef struct caca_dither caca_dither_t;
52/** font structure */
53typedef struct caca_font caca_font_t;
54/** file handle structure */
55typedef struct caca_file caca_file_t;
56/** \e libcaca display context */
57typedef struct caca_display caca_display_t;
58/** \e libcaca event structure */
59typedef struct caca_event caca_event_t;
60
61/** \defgroup caca_attr libcaca attribute definitions
62 *
63 *  Colours and styles that can be used with caca_set_attr().
64 *
65 *  @{ */
66/** \e libcaca colour keyword */
67enum caca_color
68{
69    CACA_BLACK =        0x00, /**< The colour index for black. */
70    CACA_BLUE =         0x01, /**< The colour index for blue. */
71    CACA_GREEN =        0x02, /**< The colour index for green. */
72    CACA_CYAN =         0x03, /**< The colour index for cyan. */
73    CACA_RED =          0x04, /**< The colour index for red. */
74    CACA_MAGENTA =      0x05, /**< The colour index for magenta. */
75    CACA_BROWN =        0x06, /**< The colour index for brown. */
76    CACA_LIGHTGRAY =    0x07, /**< The colour index for light gray. */
77    CACA_DARKGRAY =     0x08, /**< The colour index for dark gray. */
78    CACA_LIGHTBLUE =    0x09, /**< The colour index for blue. */
79    CACA_LIGHTGREEN =   0x0a, /**< The colour index for light green. */
80    CACA_LIGHTCYAN =    0x0b, /**< The colour index for light cyan. */
81    CACA_LIGHTRED =     0x0c, /**< The colour index for light red. */
82    CACA_LIGHTMAGENTA = 0x0d, /**< The colour index for light magenta. */
83    CACA_YELLOW =       0x0e, /**< The colour index for yellow. */
84    CACA_WHITE =        0x0f, /**< The colour index for white. */
85    CACA_DEFAULT =      0x10, /**< The output driver's default colour. */
86    CACA_TRANSPARENT =  0x20, /**< The transparent colour. */
87};
88
89/** \e libcaca style keyword */
90enum caca_style
91{
92    CACA_BOLD =      0x01, /**< The style mask for bold. */
93    CACA_ITALICS =   0x02, /**< The style mask for italics. */
94    CACA_UNDERLINE = 0x04, /**< The style mask for underline. */
95    CACA_BLINK =     0x08, /**< The style mask for blink. */
96};
97/*  @} */
98
99/** \brief User event type enumeration.
100 *
101 *  This enum serves two purposes:
102 *  - Build listening masks for caca_get_event().
103 *  - Define the type of a \e caca_event_t.
104 */
105enum caca_event_type
106{
107    CACA_EVENT_NONE =          0x0000, /**< No event. */
108
109    CACA_EVENT_KEY_PRESS =     0x0001, /**< A key was pressed. */
110    CACA_EVENT_KEY_RELEASE =   0x0002, /**< A key was released. */
111    CACA_EVENT_MOUSE_PRESS =   0x0004, /**< A mouse button was pressed. */
112    CACA_EVENT_MOUSE_RELEASE = 0x0008, /**< A mouse button was released. */
113    CACA_EVENT_MOUSE_MOTION =  0x0010, /**< The mouse was moved. */
114    CACA_EVENT_RESIZE =        0x0020, /**< The window was resized. */
115    CACA_EVENT_QUIT =          0x0040, /**< The user requested to quit. */
116
117    CACA_EVENT_ANY =           0xffff  /**< Bitmask for any event. */
118};
119
120/** \brief Handling of user events.
121 *
122 *  This structure is filled by caca_get_event() when an event is received.
123 *  It is an opaque structure that should only be accessed through
124 *  caca_event_get_type() and similar functions. The struct members may no
125 *  longer be directly accessible in future versions.
126 */
127struct caca_event
128{
129    enum caca_event_type type; /**< The event type. */
130    union
131    {
132        struct { int x, y, button; } mouse;
133        struct { int w, h; } resize;
134        struct { int ch; uint32_t utf32; char utf8[8]; } key;
135    } data; /**< The event information data */
136#if !defined(_DOXYGEN_SKIP_ME)
137    uint8_t padding[16];
138#endif
139};
140
141/** \brief Special key values.
142 *
143 *  Special key values returned by caca_get_event() for which there is no
144 *  printable ASCII equivalent.
145 */
146enum caca_key
147{
148    CACA_KEY_UNKNOWN = 0x00, /**< Unknown key. */
149
150    /* The following keys have ASCII equivalents */
151    CACA_KEY_CTRL_A =    0x01, /**< The Ctrl-A key. */
152    CACA_KEY_CTRL_B =    0x02, /**< The Ctrl-B key. */
153    CACA_KEY_CTRL_C =    0x03, /**< The Ctrl-C key. */
154    CACA_KEY_CTRL_D =    0x04, /**< The Ctrl-D key. */
155    CACA_KEY_CTRL_E =    0x05, /**< The Ctrl-E key. */
156    CACA_KEY_CTRL_F =    0x06, /**< The Ctrl-F key. */
157    CACA_KEY_CTRL_G =    0x07, /**< The Ctrl-G key. */
158    CACA_KEY_BACKSPACE = 0x08, /**< The backspace key. */
159    CACA_KEY_TAB =       0x09, /**< The tabulation key. */
160    CACA_KEY_CTRL_J =    0x0a, /**< The Ctrl-J key. */
161    CACA_KEY_CTRL_K =    0x0b, /**< The Ctrl-K key. */
162    CACA_KEY_CTRL_L =    0x0c, /**< The Ctrl-L key. */
163    CACA_KEY_RETURN =    0x0d, /**< The return key. */
164    CACA_KEY_CTRL_N =    0x0e, /**< The Ctrl-N key. */
165    CACA_KEY_CTRL_O =    0x0f, /**< The Ctrl-O key. */
166    CACA_KEY_CTRL_P =    0x10, /**< The Ctrl-P key. */
167    CACA_KEY_CTRL_Q =    0x11, /**< The Ctrl-Q key. */
168    CACA_KEY_CTRL_R =    0x12, /**< The Ctrl-R key. */
169    CACA_KEY_PAUSE =     0x13, /**< The pause key. */
170    CACA_KEY_CTRL_T =    0x14, /**< The Ctrl-T key. */
171    CACA_KEY_CTRL_U =    0x15, /**< The Ctrl-U key. */
172    CACA_KEY_CTRL_V =    0x16, /**< The Ctrl-V key. */
173    CACA_KEY_CTRL_W =    0x17, /**< The Ctrl-W key. */
174    CACA_KEY_CTRL_X =    0x18, /**< The Ctrl-X key. */
175    CACA_KEY_CTRL_Y =    0x19, /**< The Ctrl-Y key. */
176    CACA_KEY_CTRL_Z =    0x1a, /**< The Ctrl-Z key. */
177    CACA_KEY_ESCAPE =    0x1b, /**< The escape key. */
178    CACA_KEY_DELETE =    0x7f, /**< The delete key. */
179
180    /* The following keys do not have ASCII equivalents but have been
181     * chosen to match the SDL equivalents */
182    CACA_KEY_UP =    0x111, /**< The up arrow key. */
183    CACA_KEY_DOWN =  0x112, /**< The down arrow key. */
184    CACA_KEY_LEFT =  0x113, /**< The left arrow key. */
185    CACA_KEY_RIGHT = 0x114, /**< The right arrow key. */
186
187    CACA_KEY_INSERT =   0x115, /**< The insert key. */
188    CACA_KEY_HOME =     0x116, /**< The home key. */
189    CACA_KEY_END =      0x117, /**< The end key. */
190    CACA_KEY_PAGEUP =   0x118, /**< The page up key. */
191    CACA_KEY_PAGEDOWN = 0x119, /**< The page down key. */
192
193    CACA_KEY_F1 =  0x11a, /**< The F1 key. */
194    CACA_KEY_F2 =  0x11b, /**< The F2 key. */
195    CACA_KEY_F3 =  0x11c, /**< The F3 key. */
196    CACA_KEY_F4 =  0x11d, /**< The F4 key. */
197    CACA_KEY_F5 =  0x11e, /**< The F5 key. */
198    CACA_KEY_F6 =  0x11f, /**< The F6 key. */
199    CACA_KEY_F7 =  0x120, /**< The F7 key. */
200    CACA_KEY_F8 =  0x121, /**< The F8 key. */
201    CACA_KEY_F9 =  0x122, /**< The F9 key. */
202    CACA_KEY_F10 = 0x123, /**< The F10 key. */
203    CACA_KEY_F11 = 0x124, /**< The F11 key. */
204    CACA_KEY_F12 = 0x125, /**< The F12 key. */
205    CACA_KEY_F13 = 0x126, /**< The F13 key. */
206    CACA_KEY_F14 = 0x127, /**< The F14 key. */
207    CACA_KEY_F15 = 0x128  /**< The F15 key. */
208};
209
210/** \defgroup libcaca libcaca basic functions
211 *
212 *  These functions provide the basic \e libcaca routines for library
213 *  initialisation, system information retrieval and configuration.
214 *
215 *  @{ */
216__extern caca_canvas_t * caca_create_canvas(int, int);
217__extern int caca_manage_canvas(caca_canvas_t *, int (*)(void *), void *);
218__extern int caca_unmanage_canvas(caca_canvas_t *, int (*)(void *), void *);
219__extern int caca_set_canvas_size(caca_canvas_t *, int, int);
220__extern int caca_get_canvas_width(caca_canvas_t const *);
221__extern int caca_get_canvas_height(caca_canvas_t const *);
222__extern uint32_t const * caca_get_canvas_chars(caca_canvas_t const *);
223__extern uint32_t const * caca_get_canvas_attrs(caca_canvas_t const *);
224__extern int caca_free_canvas(caca_canvas_t *);
225__extern int caca_rand(int, int);
226__extern char const * caca_get_version(void);
227/*  @} */
228
229/** \defgroup caca_canvas libcaca canvas drawing
230 *
231 *  These functions provide low-level character printing routines and
232 *  higher level graphics functions.
233 *
234 *  @{ */
235#define CACA_MAGIC_FULLWIDTH 0x000ffffe /**< Used to indicate that the previous character was a fullwidth glyph. */
236__extern int caca_gotoxy(caca_canvas_t *, int, int);
237__extern int caca_wherex(caca_canvas_t const *);
238__extern int caca_wherey(caca_canvas_t const *);
239__extern int caca_put_char(caca_canvas_t *, int, int, uint32_t);
240__extern uint32_t caca_get_char(caca_canvas_t const *, int, int);
241__extern int caca_put_str(caca_canvas_t *, int, int, char const *);
242__extern int caca_printf(caca_canvas_t *, int, int, char const *, ...);
243__extern int caca_vprintf(caca_canvas_t *, int, int, char const *, va_list);
244__extern int caca_clear_canvas(caca_canvas_t *);
245__extern int caca_set_canvas_handle(caca_canvas_t *, int, int);
246__extern int caca_get_canvas_handle_x(caca_canvas_t const *);
247__extern int caca_get_canvas_handle_y(caca_canvas_t const *);
248__extern int caca_blit(caca_canvas_t *, int, int, caca_canvas_t const *,
249                       caca_canvas_t const *);
250__extern int caca_set_canvas_boundaries(caca_canvas_t *, int, int, int, int);
251/*  @} */
252
253/** \defgroup caca_dirty libcaca dirty rectangle manipulation
254 *
255 *  These functions manipulate dirty rectangles for optimised blitting.
256 *  @{ */
257__extern int caca_disable_dirty_rect(caca_canvas_t *);
258__extern int caca_enable_dirty_rect(caca_canvas_t *);
259__extern int caca_get_dirty_rect_count(caca_canvas_t *);
260__extern int caca_get_dirty_rect(caca_canvas_t *, int, int *, int *,
261                                 int *, int *);
262__extern int caca_add_dirty_rect(caca_canvas_t *, int, int, int, int);
263__extern int caca_remove_dirty_rect(caca_canvas_t *, int, int, int, int);
264__extern int caca_clear_dirty_rect_list(caca_canvas_t *);
265/*  @} */
266
267/** \defgroup caca_transform libcaca canvas transformation
268 *
269 *  These functions perform horizontal and vertical canvas flipping.
270 *
271 *  @{ */
272__extern int caca_invert(caca_canvas_t *);
273__extern int caca_flip(caca_canvas_t *);
274__extern int caca_flop(caca_canvas_t *);
275__extern int caca_rotate_180(caca_canvas_t *);
276__extern int caca_rotate_left(caca_canvas_t *);
277__extern int caca_rotate_right(caca_canvas_t *);
278__extern int caca_stretch_left(caca_canvas_t *);
279__extern int caca_stretch_right(caca_canvas_t *);
280/*  @} */
281
282/** \defgroup caca_attributes libcaca attribute conversions
283 *
284 *  These functions perform conversions between attribute values.
285 *
286 *  @{ */
287__extern uint32_t caca_get_attr(caca_canvas_t const *, int, int);
288__extern int caca_set_attr(caca_canvas_t *, uint32_t);
289__extern int caca_unset_attr(caca_canvas_t *, uint32_t);
290__extern int caca_toggle_attr(caca_canvas_t *, uint32_t);
291__extern int caca_put_attr(caca_canvas_t *, int, int, uint32_t);
292__extern int caca_set_color_ansi(caca_canvas_t *, uint8_t, uint8_t);
293__extern int caca_set_color_argb(caca_canvas_t *, uint16_t, uint16_t);
294__extern uint8_t caca_attr_to_ansi(uint32_t);
295__extern uint8_t caca_attr_to_ansi_fg(uint32_t);
296__extern uint8_t caca_attr_to_ansi_bg(uint32_t);
297__extern uint16_t caca_attr_to_rgb12_fg(uint32_t);
298__extern uint16_t caca_attr_to_rgb12_bg(uint32_t);
299__extern void caca_attr_to_argb64(uint32_t, uint8_t[8]);
300/*  @} */
301
302/** \defgroup caca_charset libcaca character set conversions
303 *
304 *  These functions perform conversions between usual character sets.
305 *
306 *  @{ */
307__extern uint32_t caca_utf8_to_utf32(char const *, size_t *);
308__extern size_t caca_utf32_to_utf8(char *, uint32_t);
309__extern uint8_t caca_utf32_to_cp437(uint32_t);
310__extern uint32_t caca_cp437_to_utf32(uint8_t);
311__extern char caca_utf32_to_ascii(uint32_t);
312__extern int caca_utf32_is_fullwidth(uint32_t);
313/*  @} */
314
315/** \defgroup caca_primitives libcaca primitives drawing
316 *
317 *  These functions provide routines for primitive drawing, such as lines,
318 *  boxes, triangles and ellipses.
319 *
320 *  @{ */
321__extern int caca_draw_line(caca_canvas_t *, int, int, int, int, uint32_t);
322__extern int caca_draw_polyline(caca_canvas_t *, int const x[],
323                                 int const y[], int, uint32_t);
324__extern int caca_draw_thin_line(caca_canvas_t *, int, int, int, int);
325__extern int caca_draw_thin_polyline(caca_canvas_t *, int const x[],
326                                      int const y[], int);
327
328__extern int caca_draw_circle(caca_canvas_t *, int, int, int, uint32_t);
329__extern int caca_draw_ellipse(caca_canvas_t *, int, int, int, int, uint32_t);
330__extern int caca_draw_thin_ellipse(caca_canvas_t *, int, int, int, int);
331__extern int caca_fill_ellipse(caca_canvas_t *, int, int, int, int, uint32_t);
332
333__extern int caca_draw_box(caca_canvas_t *, int, int, int, int, uint32_t);
334__extern int caca_draw_thin_box(caca_canvas_t *, int, int, int, int);
335__extern int caca_draw_cp437_box(caca_canvas_t *, int, int, int, int);
336__extern int caca_fill_box(caca_canvas_t *, int, int, int, int, uint32_t);
337
338__extern int caca_draw_triangle(caca_canvas_t *, int, int, int, int, int,
339                                 int, uint32_t);
340__extern int caca_draw_thin_triangle(caca_canvas_t *, int, int, int, int,
341                                      int, int);
342__extern int caca_fill_triangle(caca_canvas_t *, int, int, int, int, int,
343                                 int, uint32_t);
344__extern int caca_fill_triangle_textured(caca_canvas_t *cv,
345                                         int coords[6],
346                                         caca_canvas_t *tex,
347                                         float uv[6]);
348/*  @} */
349
350/** \defgroup caca_frame libcaca canvas frame handling
351 *
352 *  These functions provide high level routines for canvas frame insertion,
353 *  removal, copying etc.
354 *
355 *  @{ */
356__extern int caca_get_frame_count(caca_canvas_t const *);
357__extern int caca_set_frame(caca_canvas_t *, int);
358__extern char const *caca_get_frame_name(caca_canvas_t const *);
359__extern int caca_set_frame_name(caca_canvas_t *, char const *);
360__extern int caca_create_frame(caca_canvas_t *, int);
361__extern int caca_free_frame(caca_canvas_t *, int);
362/*  @} */
363
364/** \defgroup caca_dither libcaca bitmap dithering
365 *
366 *  These functions provide high level routines for dither allocation and
367 *  rendering.
368 *
369 *  @{ */
370__extern caca_dither_t *caca_create_dither(int, int, int, int,
371                                             uint32_t, uint32_t,
372                                             uint32_t, uint32_t);
373__extern int caca_set_dither_palette(caca_dither_t *,
374                                      uint32_t r[], uint32_t g[],
375                                      uint32_t b[], uint32_t a[]);
376__extern int caca_set_dither_brightness(caca_dither_t *, float);
377__extern float caca_get_dither_brightness(caca_dither_t const *);
378__extern int caca_set_dither_gamma(caca_dither_t *, float);
379__extern float caca_get_dither_gamma(caca_dither_t const *);
380__extern int caca_set_dither_contrast(caca_dither_t *, float);
381__extern float caca_get_dither_contrast(caca_dither_t const *);
382__extern int caca_set_dither_antialias(caca_dither_t *, char const *);
383__extern char const * const * caca_get_dither_antialias_list(caca_dither_t
384                                                              const *);
385__extern char const * caca_get_dither_antialias(caca_dither_t const *);
386__extern int caca_set_dither_color(caca_dither_t *, char const *);
387__extern char const * const * caca_get_dither_color_list(caca_dither_t
388                                                          const *);
389__extern char const * caca_get_dither_color(caca_dither_t const *);
390__extern int caca_set_dither_charset(caca_dither_t *, char const *);
391__extern char const * const * caca_get_dither_charset_list(caca_dither_t
392                                                            const *);
393__extern char const * caca_get_dither_charset(caca_dither_t const *);
394__extern int caca_set_dither_algorithm(caca_dither_t *, char const *);
395__extern char const * const * caca_get_dither_algorithm_list(caca_dither_t
396                                                              const *);
397__extern char const * caca_get_dither_algorithm(caca_dither_t const *);
398__extern int caca_dither_bitmap(caca_canvas_t *, int, int, int, int,
399                         caca_dither_t const *, void const *);
400__extern int caca_free_dither(caca_dither_t *);
401/*  @} */
402
403/** \defgroup caca_font libcaca font handling
404 *
405 *  These functions provide font handling routines and high quality
406 *  canvas to bitmap rendering.
407 *
408 *  @{ */
409__extern caca_font_t *caca_load_font(void const *, size_t);
410__extern char const * const * caca_get_font_list(void);
411__extern int caca_get_font_width(caca_font_t const *);
412__extern int caca_get_font_height(caca_font_t const *);
413__extern uint32_t const *caca_get_font_blocks(caca_font_t const *);
414__extern int caca_render_canvas(caca_canvas_t const *, caca_font_t const *,
415                                 void *, int, int, int);
416__extern int caca_free_font(caca_font_t *);
417/*  @} */
418
419/** \defgroup caca_figfont libcaca FIGfont handling
420 *
421 *  These functions provide FIGlet and TOIlet font handling routines.
422 *
423 *  @{ */
424__extern int caca_canvas_set_figfont(caca_canvas_t *, char const *);
425__extern int caca_put_figchar(caca_canvas_t *, uint32_t);
426__extern int caca_flush_figlet(caca_canvas_t *);
427/*  @} */
428
429/** \defgroup caca_file libcaca file IO
430 *
431 *  These functions allow to read and write files in a platform-independent
432 *  way.
433 *  @{ */
434__extern caca_file_t *caca_file_open(char const *, const char *);
435__extern int caca_file_close(caca_file_t *);
436__extern uint64_t caca_file_tell(caca_file_t *);
437__extern size_t caca_file_read(caca_file_t *, void *, size_t);
438__extern size_t caca_file_write(caca_file_t *, const void *, size_t);
439__extern char * caca_file_gets(caca_file_t *, char *, int);
440__extern int caca_file_eof(caca_file_t *);
441/*  @} */
442
443/** \defgroup caca_importexport libcaca importers/exporters from/to various
444 *  formats
445 *
446 *  These functions import various file formats into a new canvas, or export
447 *  the current canvas to various text formats.
448 *
449 *  @{ */
450__extern ssize_t caca_import_canvas_from_memory(caca_canvas_t *, void const *,
451                                                size_t, char const *);
452__extern ssize_t caca_import_canvas_from_file(caca_canvas_t *, char const *,
453                                              char const *);
454__extern ssize_t caca_import_area_from_memory(caca_canvas_t *, int, int,
455                                              void const *, size_t,
456                                              char const *);
457__extern ssize_t caca_import_area_from_file(caca_canvas_t *, int, int,
458                                            char const *, char const *);
459__extern char const * const * caca_get_import_list(void);
460__extern void *caca_export_canvas_to_memory(caca_canvas_t const *,
461                                            char const *, size_t *);
462__extern void *caca_export_area_to_memory(caca_canvas_t const *, int, int,
463                                          int, int, char const *, size_t *);
464__extern char const * const * caca_get_export_list(void);
465/*  @} */
466
467/** \defgroup caca_display libcaca display functions
468 *
469 *  These functions provide the basic \e libcaca routines for display
470 *  initialisation, system information retrieval and configuration.
471 *
472 *  @{ */
473__extern caca_display_t * caca_create_display(caca_canvas_t *);
474__extern caca_display_t * caca_create_display_with_driver(caca_canvas_t *,
475                                                          char const *);
476__extern char const * const * caca_get_display_driver_list(void);
477__extern char const * caca_get_display_driver(caca_display_t *);
478__extern int caca_set_display_driver(caca_display_t *, char const *);
479__extern int caca_free_display(caca_display_t *);
480__extern caca_canvas_t * caca_get_canvas(caca_display_t *);
481__extern int caca_refresh_display(caca_display_t *);
482__extern int caca_set_display_time(caca_display_t *, int);
483__extern int caca_get_display_time(caca_display_t const *);
484__extern int caca_get_display_width(caca_display_t const *);
485__extern int caca_get_display_height(caca_display_t const *);
486__extern int caca_set_display_title(caca_display_t *, char const *);
487__extern int caca_set_mouse(caca_display_t *, int);
488__extern int caca_set_cursor(caca_display_t *, int);
489/*  @} */
490
491/** \defgroup caca_event libcaca event handling
492 *
493 *  These functions handle user events such as keyboard input and mouse
494 *  clicks.
495 *
496 *  @{ */
497__extern int caca_get_event(caca_display_t *, int, caca_event_t *, int);
498__extern int caca_get_mouse_x(caca_display_t const *);
499__extern int caca_get_mouse_y(caca_display_t const *);
500__extern enum caca_event_type caca_get_event_type(caca_event_t const *);
501__extern int caca_get_event_key_ch(caca_event_t const *);
502__extern uint32_t caca_get_event_key_utf32(caca_event_t const *);
503__extern int caca_get_event_key_utf8(caca_event_t const *, char *);
504__extern int caca_get_event_mouse_button(caca_event_t const *);
505__extern int caca_get_event_mouse_x(caca_event_t const *);
506__extern int caca_get_event_mouse_y(caca_event_t const *);
507__extern int caca_get_event_resize_width(caca_event_t const *);
508__extern int caca_get_event_resize_height(caca_event_t const *);
509/*  @} */
510
511/** \brief DOS colours
512 *
513 *  This enum lists the colour values for the DOS conio.h compatibility
514 *  layer.
515 */
516enum CACA_CONIO_COLORS
517{
518    CACA_CONIO_BLINK = 128,
519    CACA_CONIO_BLACK = 0,
520    CACA_CONIO_BLUE = 1,
521    CACA_CONIO_GREEN = 2,
522    CACA_CONIO_CYAN = 3,
523    CACA_CONIO_RED = 4,
524    CACA_CONIO_MAGENTA = 5,
525    CACA_CONIO_BROWN = 6,
526    CACA_CONIO_LIGHTGRAY = 7,
527    CACA_CONIO_DARKGRAY = 8,
528    CACA_CONIO_LIGHTBLUE = 9,
529    CACA_CONIO_LIGHTGREEN = 10,
530    CACA_CONIO_LIGHTCYAN = 11,
531    CACA_CONIO_LIGHTRED = 12,
532    CACA_CONIO_LIGHTMAGENTA = 13,
533    CACA_CONIO_YELLOW = 14,
534    CACA_CONIO_WHITE = 15,
535};
536
537/** \brief DOS cursor modes
538 *
539 *  This enum lists the cursor mode values for the DOS conio.h compatibility
540 *  layer.
541 */
542enum CACA_CONIO_CURSOR
543{
544    CACA_CONIO__NOCURSOR = 0,
545    CACA_CONIO__SOLIDCURSOR = 1,
546    CACA_CONIO__NORMALCURSOR = 2,
547};
548
549/** \brief DOS video modes
550 *
551 *  This enum lists the video mode values for the DOS conio.h compatibility
552 *  layer.
553 */
554enum CACA_CONIO_MODE
555{
556    CACA_CONIO_LASTMODE = -1,
557    CACA_CONIO_BW40 = 0,
558    CACA_CONIO_C40 = 1,
559    CACA_CONIO_BW80 = 2,
560    CACA_CONIO_C80 = 3,
561    CACA_CONIO_MONO = 7,
562    CACA_CONIO_C4350 = 64,
563};
564
565/** \brief DOS text area information
566 *
567 *  This structure stores text area information for the DOS conio.h
568 *  compatibility layer.
569 */
570struct caca_conio_text_info
571{
572    unsigned char winleft;        /**< left window coordinate */
573    unsigned char wintop;         /**< top window coordinate */
574    unsigned char winright;       /**< right window coordinate */
575    unsigned char winbottom;      /**< bottom window coordinate */
576    unsigned char attribute;      /**< text attribute */
577    unsigned char normattr;       /**< normal attribute */
578    unsigned char currmode;       /**< current video mode:
579                                       BW40, BW80, C40, C80, or C4350 */
580    unsigned char screenheight;   /**< text screen's height */
581    unsigned char screenwidth;    /**< text screen's width */
582    unsigned char curx;           /**< x-coordinate in current window */
583    unsigned char cury;           /**< y-coordinate in current window */
584};
585
586/** \brief DOS direct video control */
587__extern int caca_conio_directvideo;
588
589/** \brief DOS scrolling control */
590__extern int caca_conio__wscroll;
591
592/** \defgroup conio libcaca DOS conio.h compatibility layer
593 *
594 *  These functions implement DOS-like functions for high-level text
595 *  operations.
596 *
597 *  @{ */
598__extern char * caca_conio_cgets(char *str);
599__extern void   caca_conio_clreol(void);
600__extern void   caca_conio_clrscr(void);
601__extern int    caca_conio_cprintf(const char *format, ...);
602__extern int    caca_conio_cputs(const char *str);
603__extern int    caca_conio_cscanf(char *format, ...);
604__extern void   caca_conio_delay(unsigned int);
605__extern void   caca_conio_delline(void);
606__extern int    caca_conio_getch(void);
607__extern int    caca_conio_getche(void);
608__extern char * caca_conio_getpass(const char *prompt);
609__extern int    caca_conio_gettext(int left, int top, int right, int bottom,
610                                   void *destin);
611__extern void   caca_conio_gettextinfo(struct caca_conio_text_info *r);
612__extern void   caca_conio_gotoxy(int x, int y);
613__extern void   caca_conio_highvideo(void);
614__extern void   caca_conio_insline(void);
615__extern int    caca_conio_kbhit(void);
616__extern void   caca_conio_lowvideo(void);
617__extern int    caca_conio_movetext(int left, int top, int right, int bottom,
618                                    int destleft, int desttop);
619__extern void   caca_conio_normvideo(void);
620__extern void   caca_conio_nosound(void);
621__extern int    caca_conio_printf(const char *format, ...);
622__extern int    caca_conio_putch(int ch);
623__extern int    caca_conio_puttext(int left, int top, int right, int bottom,
624                                   void *destin);
625__extern void   caca_conio__setcursortype(int cur_t);
626__extern void   caca_conio_sleep(unsigned int);
627__extern void   caca_conio_sound(unsigned int);
628__extern void   caca_conio_textattr(int newattr);
629__extern void   caca_conio_textbackground(int newcolor);
630__extern void   caca_conio_textcolor(int newcolor);
631__extern void   caca_conio_textmode(int newmode);
632__extern int    caca_conio_ungetch(int ch);
633__extern int    caca_conio_wherex(void);
634__extern int    caca_conio_wherey(void);
635__extern void   caca_conio_window(int left, int top, int right, int bottom);
636/*  @} */
637
638#if !defined(_DOXYGEN_SKIP_ME)
639    /* Legacy stuff from beta versions, will probably disappear in 1.0 */
640typedef struct cucul_buffer cucul_buffer_t;
641
642#   if defined __GNUC__ && __GNUC__ >= 3
643#       define CACA_DEPRECATED __attribute__ ((__deprecated__))
644#   else
645#       define CACA_DEPRECATED
646#   endif
647
648#   if defined __GNUC__ && __GNUC__ > 3
649#       define CACA_ALIAS(x) __attribute__ ((weak, alias(#x)))
650#   else
651#       define CACA_ALIAS(x)
652#   endif
653
654
655/* Aliases from old libcaca and libcucul functions */
656__extern int cucul_putchar(caca_canvas_t *, int, int,
657                           unsigned long int) CACA_DEPRECATED;
658__extern unsigned long int cucul_getchar(caca_canvas_t *,
659                                         int, int) CACA_DEPRECATED;
660__extern int cucul_putstr(caca_canvas_t *, int, int,
661                          char const *) CACA_DEPRECATED;
662__extern int cucul_set_color(caca_canvas_t *, unsigned char,
663                             unsigned char) CACA_DEPRECATED;
664__extern int cucul_set_truecolor(caca_canvas_t *, unsigned int,
665                                 unsigned int) CACA_DEPRECATED;
666__extern unsigned int cucul_get_canvas_frame_count(caca_canvas_t *)
667                                                   CACA_DEPRECATED;
668__extern int cucul_set_canvas_frame(caca_canvas_t *,
669                                    unsigned int) CACA_DEPRECATED;
670__extern int cucul_create_canvas_frame(caca_canvas_t *,
671                                       unsigned int) CACA_DEPRECATED;
672__extern int cucul_free_canvas_frame(caca_canvas_t *,
673                                     unsigned int) CACA_DEPRECATED;
674__extern cucul_buffer_t *cucul_load_memory(void *,
675                                           unsigned long int) CACA_DEPRECATED;
676__extern cucul_buffer_t *cucul_load_file(char const *) CACA_DEPRECATED;
677__extern unsigned long int cucul_get_buffer_size(cucul_buffer_t *)
678                                                 CACA_DEPRECATED;
679__extern void * cucul_get_buffer_data(cucul_buffer_t *) CACA_DEPRECATED;
680__extern int cucul_free_buffer(cucul_buffer_t *) CACA_DEPRECATED;
681__extern cucul_buffer_t * cucul_export_canvas(caca_canvas_t *,
682                                              char const *) CACA_DEPRECATED;
683__extern caca_canvas_t * cucul_import_canvas(cucul_buffer_t *,
684                                              char const *) CACA_DEPRECATED;
685__extern ssize_t caca_import_memory(caca_canvas_t *, void const *, size_t,
686                                    char const *) CACA_DEPRECATED;
687__extern ssize_t caca_import_file(caca_canvas_t *, char const *,
688                                  char const *) CACA_DEPRECATED;
689__extern void *caca_export_memory(caca_canvas_t const *, char const *,
690                                  size_t *) CACA_DEPRECATED;
691__extern int cucul_rotate(caca_canvas_t *) CACA_DEPRECATED;
692__extern int cucul_set_dither_invert(caca_dither_t *, int) CACA_DEPRECATED;
693__extern int cucul_set_dither_mode(caca_dither_t *,
694                                   char const *) CACA_DEPRECATED;
695__extern char const * const * cucul_get_dither_mode_list(caca_dither_t const *)
696                                                         CACA_DEPRECATED;
697#   define CUCUL_COLOR_BLACK CACA_BLACK
698#   define CUCUL_COLOR_BLUE CACA_BLUE
699#   define CUCUL_COLOR_GREEN CACA_GREEN
700#   define CUCUL_COLOR_CYAN CACA_CYAN
701#   define CUCUL_COLOR_RED CACA_RED
702#   define CUCUL_COLOR_MAGENTA CACA_MAGENTA
703#   define CUCUL_COLOR_BROWN CACA_BROWN
704#   define CUCUL_COLOR_LIGHTGRAY CACA_LIGHTGRAY
705#   define CUCUL_COLOR_DARKGRAY CACA_DARKGRAY
706#   define CUCUL_COLOR_LIGHTBLUE CACA_LIGHTBLUE
707#   define CUCUL_COLOR_LIGHTGREEN CACA_LIGHTGREEN
708#   define CUCUL_COLOR_LIGHTCYAN CACA_LIGHTCYAN
709#   define CUCUL_COLOR_LIGHTRED CACA_LIGHTRED
710#   define CUCUL_COLOR_LIGHTMAGENTA CACA_LIGHTMAGENTA
711#   define CUCUL_COLOR_YELLOW CACA_YELLOW
712#   define CUCUL_COLOR_WHITE CACA_YELLOW
713#   define CUCUL_COLOR_DEFAULT CACA_DEFAULT
714#   define CUCUL_COLOR_TRANSPARENT CACA_TRANSPARENT
715
716/* Aliases from the libcucul/libcaca merge */
717#   define cucul_canvas_t caca_canvas_t
718#   define cucul_dither_t caca_dither_t
719#   define cucul_font_t caca_font_t
720#   define cucul_file_t caca_file_t
721#   define cucul_display_t caca_display_t
722#   define cucul_event_t caca_event_t
723
724#   define CUCUL_BLACK CACA_BLACK
725#   define CUCUL_BLUE CACA_BLUE
726#   define CUCUL_GREEN CACA_GREEN
727#   define CUCUL_CYAN CACA_CYAN
728#   define CUCUL_RED CACA_RED
729#   define CUCUL_MAGENTA CACA_MAGENTA
730#   define CUCUL_BROWN CACA_BROWN
731#   define CUCUL_LIGHTGRAY CACA_LIGHTGRAY
732#   define CUCUL_DARKGRAY CACA_DARKGRAY
733#   define CUCUL_LIGHTBLUE CACA_LIGHTBLUE
734#   define CUCUL_LIGHTGREEN CACA_LIGHTGREEN
735#   define CUCUL_LIGHTCYAN CACA_LIGHTCYAN
736#   define CUCUL_LIGHTRED CACA_LIGHTRED
737#   define CUCUL_LIGHTMAGENTA CACA_LIGHTMAGENTA
738#   define CUCUL_YELLOW CACA_YELLOW
739#   define CUCUL_WHITE CACA_YELLOW
740#   define CUCUL_DEFAULT CACA_DEFAULT
741#   define CUCUL_TRANSPARENT CACA_TRANSPARENT
742
743#   define CUCUL_BOLD CACA_BOLD
744#   define CUCUL_ITALICS CACA_ITALICS
745#   define CUCUL_UNDERLINE CACA_UNDERLINE
746#   define CUCUL_BLINK CACA_BLINK
747
748#   if !defined __LIBCACA__
749#       define caca_get_cursor_x caca_wherex
750#       define caca_get_cursor_y caca_wherey
751#       define cucul_draw_triangle caca_draw_triangle
752#       define cucul_draw_thin_triangle caca_draw_thin_triangle
753#       define cucul_fill_triangle caca_fill_triangle
754#       define cucul_load_font caca_load_font
755#       define cucul_get_font_list caca_get_font_list
756#       define cucul_get_font_width caca_get_font_width
757#       define cucul_get_font_height caca_get_font_height
758#       define cucul_get_font_blocks caca_get_font_blocks
759#       define cucul_render_canvas caca_render_canvas
760#       define cucul_free_font caca_free_font
761#       define cucul_gotoxy caca_gotoxy
762#       define cucul_get_cursor_x caca_wherex
763#       define cucul_get_cursor_y caca_wherey
764#       define cucul_put_char caca_put_char
765#       define cucul_get_char caca_get_char
766#       define cucul_put_str caca_put_str
767#       define cucul_printf caca_printf
768#       define cucul_clear_canvas caca_clear_canvas
769#       define cucul_set_canvas_handle caca_set_canvas_handle
770#       define cucul_get_canvas_handle_x caca_get_canvas_handle_x
771#       define cucul_get_canvas_handle_y caca_get_canvas_handle_y
772#       define cucul_blit caca_blit
773#       define cucul_set_canvas_boundaries caca_set_canvas_boundaries
774#       define cucul_import_memory caca_import_memory
775#       define cucul_import_file caca_import_file
776#       define cucul_get_import_list caca_get_import_list
777#       define cucul_create_canvas caca_create_canvas
778#       define cucul_manage_canvas caca_manage_canvas
779#       define cucul_unmanage_canvas caca_unmanage_canvas
780#       define cucul_set_canvas_size caca_set_canvas_size
781#       define cucul_get_canvas_width caca_get_canvas_width
782#       define cucul_get_canvas_height caca_get_canvas_height
783#       define cucul_get_canvas_chars caca_get_canvas_chars
784#       define cucul_get_canvas_attrs caca_get_canvas_attrs
785#       define cucul_free_canvas caca_free_canvas
786#       define cucul_rand caca_rand
787#       define cucul_export_memory caca_export_memory
788#       define cucul_get_export_list caca_get_export_list
789#       define cucul_get_version caca_get_version
790#       define cucul_utf8_to_utf32 caca_utf8_to_utf32
791#       define cucul_utf32_to_utf8 caca_utf32_to_utf8
792#       define cucul_utf32_to_cp437 caca_utf32_to_cp437
793#       define cucul_cp437_to_utf32 caca_cp437_to_utf32
794#       define cucul_utf32_to_ascii caca_utf32_to_ascii
795#       define cucul_utf32_is_fullwidth caca_utf32_is_fullwidth
796#       define cucul_draw_circle caca_draw_circle
797#       define cucul_draw_ellipse caca_draw_ellipse
798#       define cucul_draw_thin_ellipse caca_draw_thin_ellipse
799#       define cucul_fill_ellipse caca_fill_ellipse
800#       define cucul_canvas_set_figfont caca_canvas_set_figfont
801#       define cucul_put_figchar caca_put_figchar
802#       define cucul_flush_figlet caca_flush_figlet
803#       define cucul_putchar caca_putchar
804#       define cucul_getchar caca_getchar
805#       define cucul_get_attr caca_get_attr
806#       define cucul_set_attr caca_set_attr
807#       define cucul_put_attr caca_put_attr
808#       define cucul_set_color_ansi caca_set_color_ansi
809#       define cucul_set_color_argb caca_set_color_argb
810#       define cucul_attr_to_ansi caca_attr_to_ansi
811#       define cucul_attr_to_ansi_fg caca_attr_to_ansi_fg
812#       define cucul_attr_to_ansi_bg caca_attr_to_ansi_bg
813#       define cucul_attr_to_rgb12_fg caca_attr_to_rgb12_fg
814#       define cucul_attr_to_rgb12_bg caca_attr_to_rgb12_bg
815#       define cucul_attr_to_argb64 caca_attr_to_argb64
816#       define cucul_invert caca_invert
817#       define cucul_flip caca_flip
818#       define cucul_flop caca_flop
819#       define cucul_rotate_180 caca_rotate_180
820#       define cucul_rotate_left caca_rotate_left
821#       define cucul_rotate_right caca_rotate_right
822#       define cucul_stretch_left caca_stretch_left
823#       define cucul_stretch_right caca_stretch_right
824#       define cucul_file_open caca_file_open
825#       define cucul_file_close caca_file_close
826#       define cucul_file_tell caca_file_tell
827#       define cucul_file_read caca_file_read
828#       define cucul_file_write caca_file_write
829#       define cucul_file_gets caca_file_gets
830#       define cucul_file_eof caca_file_eof
831#       define cucul_create_dither caca_create_dither
832#       define cucul_set_dither_palette caca_set_dither_palette
833#       define cucul_set_dither_brightness caca_set_dither_brightness
834#       define cucul_get_dither_brightness caca_get_dither_brightness
835#       define cucul_set_dither_gamma caca_set_dither_gamma
836#       define cucul_get_dither_gamma caca_get_dither_gamma
837#       define cucul_set_dither_contrast caca_set_dither_contrast
838#       define cucul_get_dither_contrast caca_get_dither_contrast
839#       define cucul_set_dither_antialias caca_set_dither_antialias
840#       define cucul_get_dither_antialias_list caca_get_dither_antialias_list
841#       define cucul_get_dither_antialias caca_get_dither_antialias
842#       define cucul_set_dither_color caca_set_dither_color
843#       define cucul_get_dither_color_list caca_get_dither_color_list
844#       define cucul_get_dither_color caca_get_dither_color
845#       define cucul_set_dither_charset caca_set_dither_charset
846#       define cucul_get_dither_charset_list caca_get_dither_charset_list
847#       define cucul_get_dither_charset caca_get_dither_charset
848#       define cucul_set_dither_algorithm caca_set_dither_algorithm
849#       define cucul_get_dither_algorithm_list caca_get_dither_algorithm_list
850#       define cucul_get_dither_algorithm caca_get_dither_algorithm
851#       define cucul_dither_bitmap caca_dither_bitmap
852#       define cucul_free_dither caca_free_dither
853#       define cucul_draw_line caca_draw_line
854#       define cucul_draw_polyline caca_draw_polyline
855#       define cucul_draw_thin_line caca_draw_thin_line
856#       define cucul_draw_thin_polyline caca_draw_thin_polyline
857#       define cucul_draw_box caca_draw_box
858#       define cucul_draw_thin_box caca_draw_thin_box
859#       define cucul_draw_cp437_box caca_draw_cp437_box
860#       define cucul_fill_box caca_fill_box
861#       define cucul_get_frame_count caca_get_frame_count
862#       define cucul_set_frame caca_set_frame
863#       define cucul_get_frame_name caca_get_frame_name
864#       define cucul_set_frame_name caca_set_frame_name
865#       define cucul_create_frame caca_create_frame
866#       define cucul_free_frame caca_free_frame
867#   endif
868#endif
869
870#ifdef __cplusplus
871}
872#endif
873
874#undef __extern
875
876#endif /* __CACA_H__ */
Note: See TracBrowser for help on using the repository browser.