source: libcaca/trunk/cucul/cucul.h @ 2406

Last change on this file since 2406 was 2406, checked in by Sam Hocevar, 12 years ago
  • Export cucul_file_t operations in the public header.
  • Implement cucul_file_read() and cucul_file_write().
  • Property svn:keywords set to Id
File size: 16.6 KB
Line 
1/*
2 *  libcucul      Canvas for ultrafast compositing of Unicode letters
3 *  Copyright (c) 2002-2006 Sam Hocevar <sam@zoy.org>
4 *                All Rights Reserved
5 *
6 *  $Id: cucul.h 2406 2008-06-15 13:50:02Z 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 cucul.h
16 *  \version \$Id: cucul.h 2406 2008-06-15 13:50:02Z sam $
17 *  \author Sam Hocevar <sam@zoy.org>
18 *  \brief The \e libcucul public header.
19 *
20 *  This header contains the public types and functions that applications
21 *  using \e libcucul may use.
22 */
23
24#ifndef __CUCUL_H__
25#define __CUCUL_H__
26
27#include <cucul_types.h>
28
29#undef __extern
30#if defined(_DOXYGEN_SKIP_ME)
31#elif defined(_WIN32) && defined(__LIBCUCUL__)
32#   define __extern extern __declspec(dllexport)
33#else
34#   define __extern extern
35#endif
36
37/** libcucul API version */
38#define CUCUL_API_VERSION_1
39
40#ifdef __cplusplus
41extern "C"
42{
43#endif
44
45/** \e libcucul canvas */
46typedef struct cucul_canvas cucul_canvas_t;
47/** dither structure */
48typedef struct cucul_dither cucul_dither_t;
49/** font structure */
50typedef struct cucul_font cucul_font_t;
51/** file handle structure */
52typedef struct cucul_file cucul_file_t;
53
54/** \defgroup cucul_attr libcucul attribute definitions
55 *
56 *  Colours and styles that can be used with cucul_set_attr().
57 *
58 *  @{ */
59#define CUCUL_BLACK 0x00 /**< The colour index for black. */
60#define CUCUL_BLUE 0x01 /**< The colour index for blue. */
61#define CUCUL_GREEN 0x02 /**< The colour index for green. */
62#define CUCUL_CYAN 0x03 /**< The colour index for cyan. */
63#define CUCUL_RED 0x04 /**< The colour index for red. */
64#define CUCUL_MAGENTA 0x05 /**< The colour index for magenta. */
65#define CUCUL_BROWN 0x06 /**< The colour index for brown. */
66#define CUCUL_LIGHTGRAY 0x07 /**< The colour index for light gray. */
67#define CUCUL_DARKGRAY 0x08 /**< The colour index for dark gray. */
68#define CUCUL_LIGHTBLUE 0x09 /**< The colour index for blue. */
69#define CUCUL_LIGHTGREEN 0x0a /**< The colour index for light green. */
70#define CUCUL_LIGHTCYAN 0x0b /**< The colour index for light cyan. */
71#define CUCUL_LIGHTRED 0x0c /**< The colour index for light red. */
72#define CUCUL_LIGHTMAGENTA 0x0d /**< The colour index for light magenta. */
73#define CUCUL_YELLOW 0x0e /**< The colour index for yellow. */
74#define CUCUL_WHITE 0x0f /**< The colour index for white. */
75#define CUCUL_DEFAULT 0x10 /**< The output driver's default colour. */
76#define CUCUL_TRANSPARENT 0x20 /**< The transparent colour. */
77
78#define CUCUL_BOLD 0x01 /**< The style mask for bold. */
79#define CUCUL_ITALICS 0x02 /**< The style mask for italics. */
80#define CUCUL_UNDERLINE 0x04 /**< The style mask for underline. */
81#define CUCUL_BLINK 0x08 /**< The style mask for blink. */
82/*  @} */
83
84/** \defgroup libcucul libcucul basic functions
85 *
86 *  These functions provide the basic \e libcaca routines for library
87 *  initialisation, system information retrieval and configuration.
88 *
89 *  @{ */
90__extern cucul_canvas_t * cucul_create_canvas(int, int);
91__extern int cucul_manage_canvas(cucul_canvas_t *, int (*)(void *), void *);
92__extern int cucul_unmanage_canvas(cucul_canvas_t *, int (*)(void *), void *);
93__extern int cucul_set_canvas_size(cucul_canvas_t *, int, int);
94__extern int cucul_get_canvas_width(cucul_canvas_t const *);
95__extern int cucul_get_canvas_height(cucul_canvas_t const *);
96__extern uint8_t const * cucul_get_canvas_chars(cucul_canvas_t const *);
97__extern uint8_t const * cucul_get_canvas_attrs(cucul_canvas_t const *);
98__extern int cucul_free_canvas(cucul_canvas_t *);
99__extern int cucul_rand(int, int);
100__extern char const * cucul_get_version(void);
101/*  @} */
102
103/** \defgroup cucul_canvas libcucul canvas drawing
104 *
105 *  These functions provide low-level character printing routines and
106 *  higher level graphics functions.
107 *
108 *  @{ */
109#define CUCUL_MAGIC_FULLWIDTH 0x000ffffe /**< Used to indicate that the previous character was a fullwidth glyph. */
110__extern int cucul_gotoxy(cucul_canvas_t *, int, int);
111__extern int cucul_get_cursor_x(cucul_canvas_t const *);
112__extern int cucul_get_cursor_y(cucul_canvas_t const *);
113__extern int cucul_put_char(cucul_canvas_t *, int, int, uint32_t);
114__extern uint32_t cucul_get_char(cucul_canvas_t const *, int, int);
115__extern int cucul_put_str(cucul_canvas_t *, int, int, char const *);
116__extern uint32_t cucul_get_attr(cucul_canvas_t const *, int, int);
117__extern int cucul_set_attr(cucul_canvas_t *, uint32_t);
118__extern int cucul_put_attr(cucul_canvas_t *, int, int, uint32_t);
119__extern int cucul_set_color_ansi(cucul_canvas_t *, uint8_t, uint8_t);
120__extern int cucul_set_color_argb(cucul_canvas_t *, uint16_t, uint16_t);
121__extern int cucul_printf(cucul_canvas_t *, int, int, char const *, ...);
122__extern int cucul_clear_canvas(cucul_canvas_t *);
123__extern int cucul_set_canvas_handle(cucul_canvas_t *, int, int);
124__extern int cucul_get_canvas_handle_x(cucul_canvas_t const *);
125__extern int cucul_get_canvas_handle_y(cucul_canvas_t const *);
126__extern int cucul_blit(cucul_canvas_t *, int, int, cucul_canvas_t const *,
127                        cucul_canvas_t const *);
128__extern int cucul_set_canvas_boundaries(cucul_canvas_t *, int, int, int, int);
129/*  @} */
130
131/** \defgroup cucul_transform libcucul canvas transformation
132 *
133 *  These functions perform horizontal and vertical canvas flipping.
134 *
135 *  @{ */
136__extern int cucul_invert(cucul_canvas_t *);
137__extern int cucul_flip(cucul_canvas_t *);
138__extern int cucul_flop(cucul_canvas_t *);
139__extern int cucul_rotate_180(cucul_canvas_t *);
140__extern int cucul_rotate_left(cucul_canvas_t *);
141__extern int cucul_rotate_right(cucul_canvas_t *);
142__extern int cucul_stretch_left(cucul_canvas_t *);
143__extern int cucul_stretch_right(cucul_canvas_t *);
144/*  @} */
145
146/** \defgroup cucul_attributes libcucul attribute conversions
147 *
148 *  These functions perform conversions between attribute values.
149 *
150 *  @{ */
151__extern uint8_t cucul_attr_to_ansi(uint32_t);
152__extern uint8_t cucul_attr_to_ansi_fg(uint32_t);
153__extern uint8_t cucul_attr_to_ansi_bg(uint32_t);
154__extern uint16_t cucul_attr_to_rgb12_fg(uint32_t);
155__extern uint16_t cucul_attr_to_rgb12_bg(uint32_t);
156__extern void cucul_attr_to_argb64(uint32_t, uint8_t[8]);
157/*  @} */
158
159/** \defgroup cucul_charset libcucul character set conversions
160 *
161 *  These functions perform conversions between usual character sets.
162 *
163 *  @{ */
164__extern uint32_t cucul_utf8_to_utf32(char const *, size_t *);
165__extern size_t cucul_utf32_to_utf8(char *, uint32_t);
166__extern uint8_t cucul_utf32_to_cp437(uint32_t);
167__extern uint32_t cucul_cp437_to_utf32(uint8_t);
168__extern char cucul_utf32_to_ascii(uint32_t);
169__extern int cucul_utf32_is_fullwidth(uint32_t);
170/*  @} */
171
172/** \defgroup cucul_primitives libcucul primitives drawing
173 *
174 *  These functions provide routines for primitive drawing, such as lines,
175 *  boxes, triangles and ellipses.
176 *
177 *  @{ */
178__extern int cucul_draw_line(cucul_canvas_t *, int, int, int, int, uint32_t);
179__extern int cucul_draw_polyline(cucul_canvas_t *, int const x[],
180                                 int const y[], int, uint32_t);
181__extern int cucul_draw_thin_line(cucul_canvas_t *, int, int, int, int);
182__extern int cucul_draw_thin_polyline(cucul_canvas_t *, int const x[],
183                                      int const y[], int);
184
185__extern int cucul_draw_circle(cucul_canvas_t *, int, int, int, uint32_t);
186__extern int cucul_draw_ellipse(cucul_canvas_t *, int, int, int, int, uint32_t);
187__extern int cucul_draw_thin_ellipse(cucul_canvas_t *, int, int, int, int);
188__extern int cucul_fill_ellipse(cucul_canvas_t *, int, int, int, int, uint32_t);
189
190__extern int cucul_draw_box(cucul_canvas_t *, int, int, int, int, uint32_t);
191__extern int cucul_draw_thin_box(cucul_canvas_t *, int, int, int, int);
192__extern int cucul_draw_cp437_box(cucul_canvas_t *, int, int, int, int);
193__extern int cucul_fill_box(cucul_canvas_t *, int, int, int, int, uint32_t);
194
195__extern int cucul_draw_triangle(cucul_canvas_t *, int, int, int, int, int,
196                                 int, uint32_t);
197__extern int cucul_draw_thin_triangle(cucul_canvas_t *, int, int, int, int,
198                                      int, int);
199__extern int cucul_fill_triangle(cucul_canvas_t *, int, int, int, int, int,
200                                 int, uint32_t);
201/*  @} */
202
203/** \defgroup cucul_frame libcucul canvas frame handling
204 *
205 *  These functions provide high level routines for canvas frame insertion,
206 *  removal, copying etc.
207 *
208 *  @{ */
209__extern int cucul_get_frame_count(cucul_canvas_t const *);
210__extern int cucul_set_frame(cucul_canvas_t *, int);
211__extern char const *cucul_get_frame_name(cucul_canvas_t const *);
212__extern int cucul_set_frame_name(cucul_canvas_t *, char const *);
213__extern int cucul_create_frame(cucul_canvas_t *, int);
214__extern int cucul_free_frame(cucul_canvas_t *, int);
215/*  @} */
216
217/** \defgroup cucul_dither libcucul bitmap dithering
218 *
219 *  These functions provide high level routines for dither allocation and
220 *  rendering.
221 *
222 *  @{ */
223__extern cucul_dither_t *cucul_create_dither(int, int, int, int,
224                                             uint32_t, uint32_t,
225                                             uint32_t, uint32_t);
226__extern int cucul_set_dither_palette(cucul_dither_t *,
227                                      uint32_t r[], uint32_t g[],
228                                      uint32_t b[], uint32_t a[]);
229__extern int cucul_set_dither_brightness(cucul_dither_t *, float);
230__extern float cucul_get_dither_brightness(cucul_dither_t const *);
231__extern int cucul_set_dither_gamma(cucul_dither_t *, float);
232__extern float cucul_get_dither_gamma(cucul_dither_t const *);
233__extern int cucul_set_dither_contrast(cucul_dither_t *, float);
234__extern float cucul_get_dither_contrast(cucul_dither_t const *);
235__extern int cucul_set_dither_antialias(cucul_dither_t *, char const *);
236__extern char const * const * cucul_get_dither_antialias_list(cucul_dither_t
237                                                              const *);
238__extern char const * cucul_get_dither_antialias(cucul_dither_t const *);
239__extern int cucul_set_dither_color(cucul_dither_t *, char const *);
240__extern char const * const * cucul_get_dither_color_list(cucul_dither_t
241                                                          const *);
242__extern char const * cucul_get_dither_color(cucul_dither_t const *);
243__extern int cucul_set_dither_charset(cucul_dither_t *, char const *);
244__extern char const * const * cucul_get_dither_charset_list(cucul_dither_t
245                                                            const *);
246__extern char const * cucul_get_dither_charset(cucul_dither_t const *);
247__extern int cucul_set_dither_algorithm(cucul_dither_t *, char const *);
248__extern char const * const * cucul_get_dither_algorithm_list(cucul_dither_t
249                                                              const *);
250__extern char const * cucul_get_dither_algorithm(cucul_dither_t const *);
251__extern int cucul_dither_bitmap(cucul_canvas_t *, int, int, int, int,
252                         cucul_dither_t const *, void *);
253__extern int cucul_free_dither(cucul_dither_t *);
254/*  @} */
255
256/** \defgroup cucul_font libcucul font handling
257 *
258 *  These functions provide font handling routines and high quality
259 *  canvas to bitmap rendering.
260 *
261 *  @{ */
262__extern cucul_font_t *cucul_load_font(void const *, size_t);
263__extern char const * const * cucul_get_font_list(void);
264__extern int cucul_get_font_width(cucul_font_t const *);
265__extern int cucul_get_font_height(cucul_font_t const *);
266__extern uint32_t const *cucul_get_font_blocks(cucul_font_t const *);
267__extern int cucul_render_canvas(cucul_canvas_t const *, cucul_font_t const *,
268                                 void *, int, int, int);
269__extern int cucul_free_font(cucul_font_t *);
270/*  @} */
271
272/** \defgroup cucul_figfont libcucul FIGfont handling
273 *
274 *  These functions provide FIGlet and TOIlet font handling routines.
275 *
276 *  @{ */
277__extern int cucul_canvas_set_figfont(cucul_canvas_t *, char const *);
278__extern int cucul_put_figchar(cucul_canvas_t *, uint32_t);
279/*  @} */
280
281/** \defgroup cucul_file libcucul file IO
282 *
283 *  These functions allow to read and write files in a platform-independent
284 *  way.
285 *  @{ */
286__extern cucul_file_t *cucul_file_open(char const *, const char *);
287__extern int cucul_file_close(cucul_file_t *);
288__extern size_t cucul_file_read(cucul_file_t *, void *, size_t);
289__extern size_t cucul_file_write(cucul_file_t *, const void *, size_t);
290__extern char * cucul_file_gets(cucul_file_t *, char *, int);
291__extern int cucul_file_eof(cucul_file_t *);
292/*  @} */
293
294/** \defgroup cucul_importexport libcucul importers/exporters from/to various
295 *  formats
296 *
297 *  These functions import various file formats into a new canvas, or export
298 *  the current canvas to various text formats.
299 *
300 *  @{ */
301__extern ssize_t cucul_import_memory(cucul_canvas_t *, void const *,
302                                     size_t, char const *);
303__extern ssize_t cucul_import_file(cucul_canvas_t *, char const *,
304                                   char const *);
305__extern char const * const * cucul_get_import_list(void);
306__extern void *cucul_export_memory(cucul_canvas_t const *, char const *,
307                                   size_t *);
308__extern char const * const * cucul_get_export_list(void);
309/*  @} */
310
311#if !defined(_DOXYGEN_SKIP_ME)
312    /* Legacy stuff from beta versions, will probably disappear in 1.0 */
313typedef struct cucul_buffer cucul_buffer_t;
314#   if defined __GNUC__ && __GNUC__ >= 3
315#       define CUCUL_DEPRECATED __attribute__ ((__deprecated__))
316#   else
317#       define CUCUL_DEPRECATED
318#   endif
319__extern int cucul_putchar(cucul_canvas_t *, int, int,
320                           unsigned long int) CUCUL_DEPRECATED;
321__extern unsigned long int cucul_getchar(cucul_canvas_t *,
322                                         int, int) CUCUL_DEPRECATED;
323__extern int cucul_putstr(cucul_canvas_t *, int, int,
324                          char const *) CUCUL_DEPRECATED;
325__extern int cucul_set_color(cucul_canvas_t *, unsigned char,
326                             unsigned char) CUCUL_DEPRECATED;
327__extern int cucul_set_truecolor(cucul_canvas_t *, unsigned int,
328                                 unsigned int) CUCUL_DEPRECATED;
329__extern unsigned int cucul_get_canvas_frame_count(cucul_canvas_t *)
330                                                   CUCUL_DEPRECATED;
331__extern int cucul_set_canvas_frame(cucul_canvas_t *,
332                                    unsigned int) CUCUL_DEPRECATED;
333__extern int cucul_create_canvas_frame(cucul_canvas_t *,
334                                       unsigned int) CUCUL_DEPRECATED;
335__extern int cucul_free_canvas_frame(cucul_canvas_t *,
336                                     unsigned int) CUCUL_DEPRECATED;
337__extern cucul_buffer_t *cucul_load_memory(void *,
338                                           unsigned long int) CUCUL_DEPRECATED;
339__extern cucul_buffer_t *cucul_load_file(char const *) CUCUL_DEPRECATED;
340__extern unsigned long int cucul_get_buffer_size(cucul_buffer_t *)
341                                                 CUCUL_DEPRECATED;
342__extern void * cucul_get_buffer_data(cucul_buffer_t *) CUCUL_DEPRECATED;
343__extern int cucul_free_buffer(cucul_buffer_t *) CUCUL_DEPRECATED;
344__extern cucul_buffer_t * cucul_export_canvas(cucul_canvas_t *,
345                                              char const *) CUCUL_DEPRECATED;
346__extern cucul_canvas_t * cucul_import_canvas(cucul_buffer_t *,
347                                              char const *) CUCUL_DEPRECATED;
348__extern int cucul_rotate(cucul_canvas_t *) CUCUL_DEPRECATED;
349__extern int cucul_set_dither_invert(cucul_dither_t *, int) CUCUL_DEPRECATED;
350__extern int cucul_set_dither_mode(cucul_dither_t *,
351                                   char const *) CUCUL_DEPRECATED;
352__extern char const * const * cucul_get_dither_mode_list(cucul_dither_t
353                                                         const *)
354                                                         CUCUL_DEPRECATED;
355#   define CUCUL_COLOR_BLACK CUCUL_BLACK
356#   define CUCUL_COLOR_BLUE CUCUL_BLUE
357#   define CUCUL_COLOR_GREEN CUCUL_GREEN
358#   define CUCUL_COLOR_CYAN CUCUL_CYAN
359#   define CUCUL_COLOR_RED CUCUL_RED
360#   define CUCUL_COLOR_MAGENTA CUCUL_MAGENTA
361#   define CUCUL_COLOR_BROWN CUCUL_BROWN
362#   define CUCUL_COLOR_LIGHTGRAY CUCUL_LIGHTGRAY
363#   define CUCUL_COLOR_DARKGRAY CUCUL_DARKGRAY
364#   define CUCUL_COLOR_LIGHTBLUE CUCUL_LIGHTBLUE
365#   define CUCUL_COLOR_LIGHTGREEN CUCUL_LIGHTGREEN
366#   define CUCUL_COLOR_LIGHTCYAN CUCUL_LIGHTCYAN
367#   define CUCUL_COLOR_LIGHTRED CUCUL_LIGHTRED
368#   define CUCUL_COLOR_LIGHTMAGENTA CUCUL_LIGHTMAGENTA
369#   define CUCUL_COLOR_YELLOW CUCUL_YELLOW
370#   define CUCUL_COLOR_WHITE CUCUL_YELLOW
371#   define CUCUL_COLOR_DEFAULT CUCUL_DEFAULT
372#   define CUCUL_COLOR_TRANSPARENT CUCUL_TRANSPARENT
373#endif
374
375#ifdef __cplusplus
376}
377#endif
378
379#undef __extern
380
381#endif /* __CUCUL_H__ */
Note: See TracBrowser for help on using the repository browser.