Вы не можете выбрать более 25 тем Темы должны начинаться с буквы или цифры, могут содержать дефисы(-) и должны содержать не более 35 символов.
 
 
 
 
 
 

923 строки
38 KiB

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