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

Last change on this file since 3606 was 3606, checked in by Sam Hocevar, 11 years ago

Make the libcaca color values an enum again.

  • Property svn:keywords set to Id
File size: 36.7 KB
Line 
1/*
2 *  libcaca       Colour ASCII-Art library
3 *  Copyright (c) 2002-2009 Sam Hocevar <sam@hocevar.net>
4 *                All Rights Reserved
5 *
6 *  $Id: caca.h 3606 2009-08-02 11:09:35Z 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 3606 2009-08-02 11:09:35Z sam $
17 *  \author Sam Hocevar <sam@hocevar.net>
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 <caca_types.h>
28
29#if !defined(__KERNEL__)
30#   include <stdarg.h>
31#   include <stdio.h>
32#endif
33
34#undef __extern
35#if defined(_DOXYGEN_SKIP_ME)
36#elif defined(_WIN32) && defined(__LIBCACA__)
37#   define __extern extern __declspec(dllexport)
38#elif defined(_WIN32)
39#   define __extern extern __declspec(dllimport)
40#else
41#   define __extern extern
42#endif
43
44/** libcaca API version */
45#define CACA_API_VERSION_1
46
47#ifdef __cplusplus
48extern "C"
49{
50#endif
51
52/** \e libcaca canvas */
53typedef struct caca_canvas caca_canvas_t;
54/** dither structure */
55typedef struct caca_dither caca_dither_t;
56/** font structure */
57typedef struct caca_font caca_font_t;
58/** file handle structure */
59typedef struct caca_file caca_file_t;
60/** \e libcaca display context */
61typedef struct caca_display caca_display_t;
62/** \e libcaca event structure */
63typedef struct caca_event caca_event_t;
64
65/** \defgroup caca_attr libcaca attribute definitions
66 *
67 *  Colours and styles that can be used with caca_set_attr().
68 *
69 *  @{ */
70enum caca_color
71{
72    CACA_BLACK =        0x00, /**< The colour index for black. */
73    CACA_BLUE =         0x01, /**< The colour index for blue. */
74    CACA_GREEN =        0x02, /**< The colour index for green. */
75    CACA_CYAN =         0x03, /**< The colour index for cyan. */
76    CACA_RED =          0x04, /**< The colour index for red. */
77    CACA_MAGENTA =      0x05, /**< The colour index for magenta. */
78    CACA_BROWN =        0x06, /**< The colour index for brown. */
79    CACA_LIGHTGRAY =    0x07, /**< The colour index for light gray. */
80    CACA_DARKGRAY =     0x08, /**< The colour index for dark gray. */
81    CACA_LIGHTBLUE =    0x09, /**< The colour index for blue. */
82    CACA_LIGHTGREEN =   0x0a, /**< The colour index for light green. */
83    CACA_LIGHTCYAN =    0x0b, /**< The colour index for light cyan. */
84    CACA_LIGHTRED =     0x0c, /**< The colour index for light red. */
85    CACA_LIGHTMAGENTA = 0x0d, /**< The colour index for light magenta. */
86    CACA_YELLOW =       0x0e, /**< The colour index for yellow. */
87    CACA_WHITE =        0x0f, /**< The colour index for white. */
88    CACA_DEFAULT =      0x10, /**< The output driver's default colour. */
89    CACA_TRANSPARENT =  0x20, /**< The transparent colour. */
90};
91
92enum caca_style
93{
94    CACA_BOLD =      0x01, /**< The style mask for bold. */
95    CACA_ITALICS =   0x02, /**< The style mask for italics. */
96    CACA_UNDERLINE = 0x04, /**< The style mask for underline. */
97    CACA_BLINK =     0x08, /**< The style mask for blink. */
98};
99/*  @} */
100
101/** \brief User event type enumeration.
102 *
103 *  This enum serves two purposes:
104 *  - Build listening masks for caca_get_event().
105 *  - Define the type of a \e caca_event_t.
106 */
107enum caca_event_type
108{
109    CACA_EVENT_NONE =          0x0000, /**< No event. */
110
111    CACA_EVENT_KEY_PRESS =     0x0001, /**< A key was pressed. */
112    CACA_EVENT_KEY_RELEASE =   0x0002, /**< A key was released. */
113    CACA_EVENT_MOUSE_PRESS =   0x0004, /**< A mouse button was pressed. */
114    CACA_EVENT_MOUSE_RELEASE = 0x0008, /**< A mouse button was released. */
115    CACA_EVENT_MOUSE_MOTION =  0x0010, /**< The mouse was moved. */
116    CACA_EVENT_RESIZE =        0x0020, /**< The window was resized. */
117    CACA_EVENT_QUIT =          0x0040, /**< The user requested to quit. */
118
119    CACA_EVENT_ANY =           0xffff  /**< Bitmask for any event. */
120};
121
122/** \brief Handling of user events.
123 *
124 *  This structure is filled by caca_get_event() when an event is received.
125 *  It is an opaque structure that should only be accessed through
126 *  caca_event_get_type() and similar functions. The struct members may no
127 *  longer be directly accessible in future versions.
128 */
129struct caca_event
130{
131    enum caca_event_type type;
132    union
133    {
134        struct { int x, y, button; } mouse;
135        struct { int w, h; } resize;
136        struct { int ch; uint32_t utf32; char utf8[8]; } key;
137    } data;
138    uint8_t padding[16];
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 uint8_t const * caca_get_canvas_chars(caca_canvas_t const *);
223__extern uint8_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_put_attr(caca_canvas_t *, int, int, uint32_t);
290__extern int caca_set_color_ansi(caca_canvas_t *, uint8_t, uint8_t);
291__extern int caca_set_color_argb(caca_canvas_t *, uint16_t, uint16_t);
292__extern uint8_t caca_attr_to_ansi(uint32_t);
293__extern uint8_t caca_attr_to_ansi_fg(uint32_t);
294__extern uint8_t caca_attr_to_ansi_bg(uint32_t);
295__extern uint16_t caca_attr_to_rgb12_fg(uint32_t);
296__extern uint16_t caca_attr_to_rgb12_bg(uint32_t);
297__extern void caca_attr_to_argb64(uint32_t, uint8_t[8]);
298/*  @} */
299
300/** \defgroup caca_charset libcaca character set conversions
301 *
302 *  These functions perform conversions between usual character sets.
303 *
304 *  @{ */
305__extern uint32_t caca_utf8_to_utf32(char const *, size_t *);
306__extern size_t caca_utf32_to_utf8(char *, uint32_t);
307__extern uint8_t caca_utf32_to_cp437(uint32_t);
308__extern uint32_t caca_cp437_to_utf32(uint8_t);
309__extern char caca_utf32_to_ascii(uint32_t);
310__extern int caca_utf32_is_fullwidth(uint32_t);
311/*  @} */
312
313/** \defgroup caca_primitives libcaca primitives drawing
314 *
315 *  These functions provide routines for primitive drawing, such as lines,
316 *  boxes, triangles and ellipses.
317 *
318 *  @{ */
319__extern int caca_draw_line(caca_canvas_t *, int, int, int, int, uint32_t);
320__extern int caca_draw_polyline(caca_canvas_t *, int const x[],
321                                 int const y[], int, uint32_t);
322__extern int caca_draw_thin_line(caca_canvas_t *, int, int, int, int);
323__extern int caca_draw_thin_polyline(caca_canvas_t *, int const x[],
324                                      int const y[], int);
325
326__extern int caca_draw_circle(caca_canvas_t *, int, int, int, uint32_t);
327__extern int caca_draw_ellipse(caca_canvas_t *, int, int, int, int, uint32_t);
328__extern int caca_draw_thin_ellipse(caca_canvas_t *, int, int, int, int);
329__extern int caca_fill_ellipse(caca_canvas_t *, int, int, int, int, uint32_t);
330
331__extern int caca_draw_box(caca_canvas_t *, int, int, int, int, uint32_t);
332__extern int caca_draw_thin_box(caca_canvas_t *, int, int, int, int);
333__extern int caca_draw_cp437_box(caca_canvas_t *, int, int, int, int);
334__extern int caca_fill_box(caca_canvas_t *, int, int, int, int, uint32_t);
335
336__extern int caca_draw_triangle(caca_canvas_t *, int, int, int, int, int,
337                                 int, uint32_t);
338__extern int caca_draw_thin_triangle(caca_canvas_t *, int, int, int, int,
339                                      int, int);
340__extern int caca_fill_triangle(caca_canvas_t *, int, int, int, int, int,
341                                 int, uint32_t);
342/*  @} */
343
344/** \defgroup caca_frame libcaca canvas frame handling
345 *
346 *  These functions provide high level routines for canvas frame insertion,
347 *  removal, copying etc.
348 *
349 *  @{ */
350__extern int caca_get_frame_count(caca_canvas_t const *);
351__extern int caca_set_frame(caca_canvas_t *, int);
352__extern char const *caca_get_frame_name(caca_canvas_t const *);
353__extern int caca_set_frame_name(caca_canvas_t *, char const *);
354__extern int caca_create_frame(caca_canvas_t *, int);
355__extern int caca_free_frame(caca_canvas_t *, int);
356/*  @} */
357
358/** \defgroup caca_dither libcaca bitmap dithering
359 *
360 *  These functions provide high level routines for dither allocation and
361 *  rendering.
362 *
363 *  @{ */
364__extern caca_dither_t *caca_create_dither(int, int, int, int,
365                                             uint32_t, uint32_t,
366                                             uint32_t, uint32_t);
367__extern int caca_set_dither_palette(caca_dither_t *,
368                                      uint32_t r[], uint32_t g[],
369                                      uint32_t b[], uint32_t a[]);
370__extern int caca_set_dither_brightness(caca_dither_t *, float);
371__extern float caca_get_dither_brightness(caca_dither_t const *);
372__extern int caca_set_dither_gamma(caca_dither_t *, float);
373__extern float caca_get_dither_gamma(caca_dither_t const *);
374__extern int caca_set_dither_contrast(caca_dither_t *, float);
375__extern float caca_get_dither_contrast(caca_dither_t const *);
376__extern int caca_set_dither_antialias(caca_dither_t *, char const *);
377__extern char const * const * caca_get_dither_antialias_list(caca_dither_t
378                                                              const *);
379__extern char const * caca_get_dither_antialias(caca_dither_t const *);
380__extern int caca_set_dither_color(caca_dither_t *, char const *);
381__extern char const * const * caca_get_dither_color_list(caca_dither_t
382                                                          const *);
383__extern char const * caca_get_dither_color(caca_dither_t const *);
384__extern int caca_set_dither_charset(caca_dither_t *, char const *);
385__extern char const * const * caca_get_dither_charset_list(caca_dither_t
386                                                            const *);
387__extern char const * caca_get_dither_charset(caca_dither_t const *);
388__extern int caca_set_dither_algorithm(caca_dither_t *, char const *);
389__extern char const * const * caca_get_dither_algorithm_list(caca_dither_t
390                                                              const *);
391__extern char const * caca_get_dither_algorithm(caca_dither_t const *);
392__extern int caca_dither_bitmap(caca_canvas_t *, int, int, int, int,
393                         caca_dither_t const *, void *);
394__extern int caca_free_dither(caca_dither_t *);
395/*  @} */
396
397/** \defgroup caca_font libcaca font handling
398 *
399 *  These functions provide font handling routines and high quality
400 *  canvas to bitmap rendering.
401 *
402 *  @{ */
403__extern caca_font_t *caca_load_font(void const *, size_t);
404__extern char const * const * caca_get_font_list(void);
405__extern int caca_get_font_width(caca_font_t const *);
406__extern int caca_get_font_height(caca_font_t const *);
407__extern uint32_t const *caca_get_font_blocks(caca_font_t const *);
408__extern int caca_render_canvas(caca_canvas_t const *, caca_font_t const *,
409                                 void *, int, int, int);
410__extern int caca_free_font(caca_font_t *);
411/*  @} */
412
413/** \defgroup caca_figfont libcaca FIGfont handling
414 *
415 *  These functions provide FIGlet and TOIlet font handling routines.
416 *
417 *  @{ */
418__extern int caca_canvas_set_figfont(caca_canvas_t *, char const *);
419__extern int caca_put_figchar(caca_canvas_t *, uint32_t);
420__extern int caca_flush_figlet(caca_canvas_t *);
421/*  @} */
422
423/** \defgroup caca_file libcaca file IO
424 *
425 *  These functions allow to read and write files in a platform-independent
426 *  way.
427 *  @{ */
428__extern caca_file_t *caca_file_open(char const *, const char *);
429__extern int caca_file_close(caca_file_t *);
430__extern uint64_t caca_file_tell(caca_file_t *);
431__extern size_t caca_file_read(caca_file_t *, void *, size_t);
432__extern size_t caca_file_write(caca_file_t *, const void *, size_t);
433__extern char * caca_file_gets(caca_file_t *, char *, int);
434__extern int caca_file_eof(caca_file_t *);
435/*  @} */
436
437/** \defgroup caca_importexport libcaca importers/exporters from/to various
438 *  formats
439 *
440 *  These functions import various file formats into a new canvas, or export
441 *  the current canvas to various text formats.
442 *
443 *  @{ */
444__extern ssize_t caca_import_canvas_from_memory(caca_canvas_t *, void const *,
445                                                size_t, char const *);
446__extern ssize_t caca_import_canvas_from_file(caca_canvas_t *, char const *,
447                                              char const *);
448__extern ssize_t caca_import_area_from_memory(caca_canvas_t *, int, int,
449                                              void const *, size_t,
450                                              char const *);
451__extern ssize_t caca_import_area_from_file(caca_canvas_t *, int, int,
452                                            char const *, char const *);
453__extern char const * const * caca_get_import_list(void);
454__extern void *caca_export_canvas_to_memory(caca_canvas_t const *,
455                                            char const *, size_t *);
456__extern void *caca_export_area_to_memory(caca_canvas_t const *, int, int,
457                                          int, int, char const *, size_t *);
458__extern char const * const * caca_get_export_list(void);
459/*  @} */
460
461/** \defgroup caca_display libcaca display functions
462 *
463 *  These functions provide the basic \e libcaca routines for display
464 *  initialisation, system information retrieval and configuration.
465 *
466 *  @{ */
467__extern caca_display_t * caca_create_display(caca_canvas_t *);
468__extern caca_display_t * caca_create_display_with_driver(caca_canvas_t *,
469                                                          char const *);
470__extern char const * const * caca_get_display_driver_list(void);
471__extern char const * caca_get_display_driver(caca_display_t *);
472__extern int caca_set_display_driver(caca_display_t *, char const *);
473__extern int caca_free_display(caca_display_t *);
474__extern caca_canvas_t * caca_get_canvas(caca_display_t *);
475__extern int caca_refresh_display(caca_display_t *);
476__extern int caca_set_display_time(caca_display_t *, int);
477__extern int caca_get_display_time(caca_display_t const *);
478__extern int caca_get_display_width(caca_display_t const *);
479__extern int caca_get_display_height(caca_display_t const *);
480__extern int caca_set_display_title(caca_display_t *, char const *);
481__extern int caca_set_mouse(caca_display_t *, int);
482__extern int caca_set_cursor(caca_display_t *, int);
483/*  @} */
484
485/** \defgroup caca_event libcaca event handling
486 *
487 *  These functions handle user events such as keyboard input and mouse
488 *  clicks.
489 *
490 *  @{ */
491__extern int caca_get_event(caca_display_t *, int, caca_event_t *, int);
492__extern int caca_get_mouse_x(caca_display_t const *);
493__extern int caca_get_mouse_y(caca_display_t const *);
494__extern enum caca_event_type caca_get_event_type(caca_event_t const *);
495__extern int caca_get_event_key_ch(caca_event_t const *);
496__extern uint32_t caca_get_event_key_utf32(caca_event_t const *);
497__extern int caca_get_event_key_utf8(caca_event_t const *, char *);
498__extern int caca_get_event_mouse_button(caca_event_t const *);
499__extern int caca_get_event_mouse_x(caca_event_t const *);
500__extern int caca_get_event_mouse_y(caca_event_t const *);
501__extern int caca_get_event_resize_width(caca_event_t const *);
502__extern int caca_get_event_resize_height(caca_event_t const *);
503/*  @} */
504
505/** \brief DOS colours
506 *
507 *  This enum lists the colour values for the DOS conio.h compatibility
508 *  layer.
509 */
510enum CACA_CONIO_COLORS
511{
512    CACA_CONIO_BLINK = 128,
513    CACA_CONIO_BLACK = 0,
514    CACA_CONIO_BLUE = 1,
515    CACA_CONIO_GREEN = 2,
516    CACA_CONIO_CYAN = 3,
517    CACA_CONIO_RED = 4,
518    CACA_CONIO_MAGENTA = 5,
519    CACA_CONIO_BROWN = 6,
520    CACA_CONIO_LIGHTGRAY = 7,
521    CACA_CONIO_DARKGRAY = 8,
522    CACA_CONIO_LIGHTBLUE = 9,
523    CACA_CONIO_LIGHTGREEN = 10,
524    CACA_CONIO_LIGHTCYAN = 11,
525    CACA_CONIO_LIGHTRED = 12,
526    CACA_CONIO_LIGHTMAGENTA = 13,
527    CACA_CONIO_YELLOW = 14,
528    CACA_CONIO_WHITE = 15,
529};
530
531/** \brief DOS cursor modes
532 *
533 *  This enum lists the cursor mode values for the DOS conio.h compatibility
534 *  layer.
535 */
536enum CACA_CONIO_CURSOR
537{
538    CACA_CONIO__NOCURSOR = 0,
539    CACA_CONIO__SOLIDCURSOR = 1,
540    CACA_CONIO__NORMALCURSOR = 2,
541};
542
543/** \brief DOS video modes
544 *
545 *  This enum lists the video mode values for the DOS conio.h compatibility
546 *  layer.
547 */
548enum CACA_CONIO_MODE
549{
550    CACA_CONIO_LASTMODE = -1,
551    CACA_CONIO_BW40 = 0,
552    CACA_CONIO_C40 = 1,
553    CACA_CONIO_BW80 = 2,
554    CACA_CONIO_C80 = 3,
555    CACA_CONIO_MONO = 7,
556    CACA_CONIO_C4350 = 64,
557};
558
559/** \brief DOS text area information
560 *
561 *  This structure stores text area information for the DOS conio.h
562 *  compatibility layer.
563 */
564struct caca_conio_text_info
565{
566    unsigned char winleft;        /* left window coordinate */
567    unsigned char wintop;         /* top window coordinate */
568    unsigned char winright;       /* right window coordinate */
569    unsigned char winbottom;      /* bottom window coordinate */
570    unsigned char attribute;      /* text attribute */
571    unsigned char normattr;       /* normal attribute */
572    unsigned char currmode;       /* current video mode:
573                                     BW40, BW80, C40, C80, or C4350 */
574    unsigned char screenheight;   /* text screen's height */
575    unsigned char screenwidth;    /* text screen's width */
576    unsigned char curx;           /* x-coordinate in current window */
577    unsigned char cury;           /* y-coordinate in current window */
578};
579
580/** \brief DOS direct video control */
581__extern int caca_conio_directvideo;
582
583/** \brief DOS scrolling control */
584__extern int caca_conio__wscroll;
585
586/** \defgroup conio libcaca DOS conio.h compatibility layer
587 *
588 *  These functions implement DOS-like functions for high-level text
589 *  operations.
590 *
591 *  @{ */
592__extern char * caca_conio_cgets(char *str);
593__extern void   caca_conio_clreol(void);
594__extern void   caca_conio_clrscr(void);
595__extern int    caca_conio_cprintf(const char *format, ...);
596__extern int    caca_conio_cputs(const char *str);
597__extern int    caca_conio_cscanf(char *format, ...);
598__extern void   caca_conio_delay(unsigned int);
599__extern void   caca_conio_delline(void);
600__extern int    caca_conio_getch(void);
601__extern int    caca_conio_getche(void);
602__extern char * caca_conio_getpass(const char *prompt);
603__extern int    caca_conio_gettext(int left, int top, int right, int bottom,
604                                   void *destin);
605__extern void   caca_conio_gettextinfo(struct caca_conio_text_info *r);
606__extern void   caca_conio_gotoxy(int x, int y);
607__extern void   caca_conio_highvideo(void);
608__extern void   caca_conio_insline(void);
609__extern int    caca_conio_kbhit(void);
610__extern void   caca_conio_lowvideo(void);
611__extern int    caca_conio_movetext(int left, int top, int right, int bottom,
612                                    int destleft, int desttop);
613__extern void   caca_conio_normvideo(void);
614__extern void   caca_conio_nosound(void);
615__extern int    caca_conio_printf(const char *format, ...);
616__extern int    caca_conio_putch(int ch);
617__extern int    caca_conio_puttext(int left, int top, int right, int bottom,
618                                   void *destin);
619__extern void   caca_conio__setcursortype(int cur_t);
620__extern void   caca_conio_sleep(unsigned int);
621__extern void   caca_conio_sound(unsigned int);
622__extern void   caca_conio_textattr(int newattr);
623__extern void   caca_conio_textbackground(int newcolor);
624__extern void   caca_conio_textcolor(int newcolor);
625__extern void   caca_conio_textmode(int newmode);
626__extern int    caca_conio_ungetch(int ch);
627__extern int    caca_conio_wherex(void);
628__extern int    caca_conio_wherey(void);
629__extern void   caca_conio_window(int left, int top, int right, int bottom);
630/*  @} */
631
632#if !defined(_DOXYGEN_SKIP_ME)
633    /* Legacy stuff from beta versions, will probably disappear in 1.0 */
634typedef struct cucul_buffer cucul_buffer_t;
635
636#   if defined __GNUC__ && __GNUC__ >= 3
637#       define CACA_DEPRECATED __attribute__ ((__deprecated__))
638#       define CACA_ALIAS(x) __attribute__ ((weak, alias(#x)))
639#   else
640#       define CACA_DEPRECATED
641#       define CACA_ALIAS(x)
642#   endif
643
644
645/* Aliases from old libcaca and libcucul functions */
646__extern int cucul_putchar(caca_canvas_t *, int, int,
647                           unsigned long int) CACA_DEPRECATED;
648__extern unsigned long int cucul_getchar(caca_canvas_t *,
649                                         int, int) CACA_DEPRECATED;
650__extern int cucul_putstr(caca_canvas_t *, int, int,
651                          char const *) CACA_DEPRECATED;
652__extern int cucul_set_color(caca_canvas_t *, unsigned char,
653                             unsigned char) CACA_DEPRECATED;
654__extern int cucul_set_truecolor(caca_canvas_t *, unsigned int,
655                                 unsigned int) CACA_DEPRECATED;
656__extern unsigned int cucul_get_canvas_frame_count(caca_canvas_t *)
657                                                   CACA_DEPRECATED;
658__extern int cucul_set_canvas_frame(caca_canvas_t *,
659                                    unsigned int) CACA_DEPRECATED;
660__extern int cucul_create_canvas_frame(caca_canvas_t *,
661                                       unsigned int) CACA_DEPRECATED;
662__extern int cucul_free_canvas_frame(caca_canvas_t *,
663                                     unsigned int) CACA_DEPRECATED;
664__extern cucul_buffer_t *cucul_load_memory(void *,
665                                           unsigned long int) CACA_DEPRECATED;
666__extern cucul_buffer_t *cucul_load_file(char const *) CACA_DEPRECATED;
667__extern unsigned long int cucul_get_buffer_size(cucul_buffer_t *)
668                                                 CACA_DEPRECATED;
669__extern void * cucul_get_buffer_data(cucul_buffer_t *) CACA_DEPRECATED;
670__extern int cucul_free_buffer(cucul_buffer_t *) CACA_DEPRECATED;
671__extern cucul_buffer_t * cucul_export_canvas(caca_canvas_t *,
672                                              char const *) CACA_DEPRECATED;
673__extern caca_canvas_t * cucul_import_canvas(cucul_buffer_t *,
674                                              char const *) CACA_DEPRECATED;
675__extern ssize_t caca_import_memory(caca_canvas_t *, void const *, size_t,
676                                    char const *) CACA_DEPRECATED;
677__extern ssize_t caca_import_file(caca_canvas_t *, char const *,
678                                  char const *) CACA_DEPRECATED;
679__extern void *caca_export_memory(caca_canvas_t const *, char const *,
680                                  size_t *) CACA_DEPRECATED;
681__extern int cucul_rotate(caca_canvas_t *) CACA_DEPRECATED;
682__extern int cucul_set_dither_invert(caca_dither_t *, int) CACA_DEPRECATED;
683__extern int cucul_set_dither_mode(caca_dither_t *,
684                                   char const *) CACA_DEPRECATED;
685__extern char const * const * cucul_get_dither_mode_list(caca_dither_t const *)
686                                                         CACA_DEPRECATED;
687#   define CUCUL_COLOR_BLACK CACA_BLACK
688#   define CUCUL_COLOR_BLUE CACA_BLUE
689#   define CUCUL_COLOR_GREEN CACA_GREEN
690#   define CUCUL_COLOR_CYAN CACA_CYAN
691#   define CUCUL_COLOR_RED CACA_RED
692#   define CUCUL_COLOR_MAGENTA CACA_MAGENTA
693#   define CUCUL_COLOR_BROWN CACA_BROWN
694#   define CUCUL_COLOR_LIGHTGRAY CACA_LIGHTGRAY
695#   define CUCUL_COLOR_DARKGRAY CACA_DARKGRAY
696#   define CUCUL_COLOR_LIGHTBLUE CACA_LIGHTBLUE
697#   define CUCUL_COLOR_LIGHTGREEN CACA_LIGHTGREEN
698#   define CUCUL_COLOR_LIGHTCYAN CACA_LIGHTCYAN
699#   define CUCUL_COLOR_LIGHTRED CACA_LIGHTRED
700#   define CUCUL_COLOR_LIGHTMAGENTA CACA_LIGHTMAGENTA
701#   define CUCUL_COLOR_YELLOW CACA_YELLOW
702#   define CUCUL_COLOR_WHITE CACA_YELLOW
703#   define CUCUL_COLOR_DEFAULT CACA_DEFAULT
704#   define CUCUL_COLOR_TRANSPARENT CACA_TRANSPARENT
705
706/* Aliases from the libcucul/libcaca merge */
707#   define cucul_canvas_t caca_canvas_t
708#   define cucul_dither_t caca_dither_t
709#   define cucul_font_t caca_font_t
710#   define cucul_file_t caca_file_t
711#   define cucul_display_t caca_display_t
712#   define cucul_event_t caca_event_t
713
714#   define CUCUL_BLACK CACA_BLACK
715#   define CUCUL_BLUE CACA_BLUE
716#   define CUCUL_GREEN CACA_GREEN
717#   define CUCUL_CYAN CACA_CYAN
718#   define CUCUL_RED CACA_RED
719#   define CUCUL_MAGENTA CACA_MAGENTA
720#   define CUCUL_BROWN CACA_BROWN
721#   define CUCUL_LIGHTGRAY CACA_LIGHTGRAY
722#   define CUCUL_DARKGRAY CACA_DARKGRAY
723#   define CUCUL_LIGHTBLUE CACA_LIGHTBLUE
724#   define CUCUL_LIGHTGREEN CACA_LIGHTGREEN
725#   define CUCUL_LIGHTCYAN CACA_LIGHTCYAN
726#   define CUCUL_LIGHTRED CACA_LIGHTRED
727#   define CUCUL_LIGHTMAGENTA CACA_LIGHTMAGENTA
728#   define CUCUL_YELLOW CACA_YELLOW
729#   define CUCUL_WHITE CACA_YELLOW
730#   define CUCUL_DEFAULT CACA_DEFAULT
731#   define CUCUL_TRANSPARENT CACA_TRANSPARENT
732
733#   define CUCUL_BOLD CACA_BOLD
734#   define CUCUL_ITALICS CACA_ITALICS
735#   define CUCUL_UNDERLINE CACA_UNDERLINE
736#   define CUCUL_BLINK CACA_BLINK
737
738#   if !defined __LIBCACA__
739#       define caca_get_cursor_x caca_wherex
740#       define caca_get_cursor_y caca_wherey
741#       define cucul_draw_triangle caca_draw_triangle
742#       define cucul_draw_thin_triangle caca_draw_thin_triangle
743#       define cucul_fill_triangle caca_fill_triangle
744#       define cucul_load_font caca_load_font
745#       define cucul_get_font_list caca_get_font_list
746#       define cucul_get_font_width caca_get_font_width
747#       define cucul_get_font_height caca_get_font_height
748#       define cucul_get_font_blocks caca_get_font_blocks
749#       define cucul_render_canvas caca_render_canvas
750#       define cucul_free_font caca_free_font
751#       define cucul_gotoxy caca_gotoxy
752#       define cucul_get_cursor_x caca_wherex
753#       define cucul_get_cursor_y caca_wherey
754#       define cucul_put_char caca_put_char
755#       define cucul_get_char caca_get_char
756#       define cucul_put_str caca_put_str
757#       define cucul_printf caca_printf
758#       define cucul_clear_canvas caca_clear_canvas
759#       define cucul_set_canvas_handle caca_set_canvas_handle
760#       define cucul_get_canvas_handle_x caca_get_canvas_handle_x
761#       define cucul_get_canvas_handle_y caca_get_canvas_handle_y
762#       define cucul_blit caca_blit
763#       define cucul_set_canvas_boundaries caca_set_canvas_boundaries
764#       define cucul_import_memory caca_import_memory
765#       define cucul_import_file caca_import_file
766#       define cucul_get_import_list caca_get_import_list
767#       define cucul_create_canvas caca_create_canvas
768#       define cucul_manage_canvas caca_manage_canvas
769#       define cucul_unmanage_canvas caca_unmanage_canvas
770#       define cucul_set_canvas_size caca_set_canvas_size
771#       define cucul_get_canvas_width caca_get_canvas_width
772#       define cucul_get_canvas_height caca_get_canvas_height
773#       define cucul_get_canvas_chars caca_get_canvas_chars
774#       define cucul_get_canvas_attrs caca_get_canvas_attrs
775#       define cucul_free_canvas caca_free_canvas
776#       define cucul_rand caca_rand
777#       define cucul_export_memory caca_export_memory
778#       define cucul_get_export_list caca_get_export_list
779#       define cucul_get_version caca_get_version
780#       define cucul_utf8_to_utf32 caca_utf8_to_utf32
781#       define cucul_utf32_to_utf8 caca_utf32_to_utf8
782#       define cucul_utf32_to_cp437 caca_utf32_to_cp437
783#       define cucul_cp437_to_utf32 caca_cp437_to_utf32
784#       define cucul_utf32_to_ascii caca_utf32_to_ascii
785#       define cucul_utf32_is_fullwidth caca_utf32_is_fullwidth
786#       define cucul_draw_circle caca_draw_circle
787#       define cucul_draw_ellipse caca_draw_ellipse
788#       define cucul_draw_thin_ellipse caca_draw_thin_ellipse
789#       define cucul_fill_ellipse caca_fill_ellipse
790#       define cucul_canvas_set_figfont caca_canvas_set_figfont
791#       define cucul_put_figchar caca_put_figchar
792#       define cucul_flush_figlet caca_flush_figlet
793#       define cucul_putchar caca_putchar
794#       define cucul_getchar caca_getchar
795#       define cucul_get_attr caca_get_attr
796#       define cucul_set_attr caca_set_attr
797#       define cucul_put_attr caca_put_attr
798#       define cucul_set_color_ansi caca_set_color_ansi
799#       define cucul_set_color_argb caca_set_color_argb
800#       define cucul_attr_to_ansi caca_attr_to_ansi
801#       define cucul_attr_to_ansi_fg caca_attr_to_ansi_fg
802#       define cucul_attr_to_ansi_bg caca_attr_to_ansi_bg
803#       define cucul_attr_to_rgb12_fg caca_attr_to_rgb12_fg
804#       define cucul_attr_to_rgb12_bg caca_attr_to_rgb12_bg
805#       define cucul_attr_to_argb64 caca_attr_to_argb64
806#       define cucul_invert caca_invert
807#       define cucul_flip caca_flip
808#       define cucul_flop caca_flop
809#       define cucul_rotate_180 caca_rotate_180
810#       define cucul_rotate_left caca_rotate_left
811#       define cucul_rotate_right caca_rotate_right
812#       define cucul_stretch_left caca_stretch_left
813#       define cucul_stretch_right caca_stretch_right
814#       define cucul_file_open caca_file_open
815#       define cucul_file_close caca_file_close
816#       define cucul_file_tell caca_file_tell
817#       define cucul_file_read caca_file_read
818#       define cucul_file_write caca_file_write
819#       define cucul_file_gets caca_file_gets
820#       define cucul_file_eof caca_file_eof
821#       define cucul_create_dither caca_create_dither
822#       define cucul_set_dither_palette caca_set_dither_palette
823#       define cucul_set_dither_brightness caca_set_dither_brightness
824#       define cucul_get_dither_brightness caca_get_dither_brightness
825#       define cucul_set_dither_gamma caca_set_dither_gamma
826#       define cucul_get_dither_gamma caca_get_dither_gamma
827#       define cucul_set_dither_contrast caca_set_dither_contrast
828#       define cucul_get_dither_contrast caca_get_dither_contrast
829#       define cucul_set_dither_antialias caca_set_dither_antialias
830#       define cucul_get_dither_antialias_list caca_get_dither_antialias_list
831#       define cucul_get_dither_antialias caca_get_dither_antialias
832#       define cucul_set_dither_color caca_set_dither_color
833#       define cucul_get_dither_color_list caca_get_dither_color_list
834#       define cucul_get_dither_color caca_get_dither_color
835#       define cucul_set_dither_charset caca_set_dither_charset
836#       define cucul_get_dither_charset_list caca_get_dither_charset_list
837#       define cucul_get_dither_charset caca_get_dither_charset
838#       define cucul_set_dither_algorithm caca_set_dither_algorithm
839#       define cucul_get_dither_algorithm_list caca_get_dither_algorithm_list
840#       define cucul_get_dither_algorithm caca_get_dither_algorithm
841#       define cucul_dither_bitmap caca_dither_bitmap
842#       define cucul_free_dither caca_free_dither
843#       define cucul_draw_line caca_draw_line
844#       define cucul_draw_polyline caca_draw_polyline
845#       define cucul_draw_thin_line caca_draw_thin_line
846#       define cucul_draw_thin_polyline caca_draw_thin_polyline
847#       define cucul_draw_box caca_draw_box
848#       define cucul_draw_thin_box caca_draw_thin_box
849#       define cucul_draw_cp437_box caca_draw_cp437_box
850#       define cucul_fill_box caca_fill_box
851#       define cucul_get_frame_count caca_get_frame_count
852#       define cucul_set_frame caca_set_frame
853#       define cucul_get_frame_name caca_get_frame_name
854#       define cucul_set_frame_name caca_set_frame_name
855#       define cucul_create_frame caca_create_frame
856#       define cucul_free_frame caca_free_frame
857#   endif
858#endif
859
860#ifdef __cplusplus
861}
862#endif
863
864#undef __extern
865
866#endif /* __CACA_H__ */
Note: See TracBrowser for help on using the repository browser.