console.h

Go to the documentation of this file.

/*
 * This file is part of the Ultibo project, https://ultibo.org/
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2026 Garry Wood <garry@softoz.com.au>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
#ifndef _ULTIBO_CONSOLE_H
#define _ULTIBO_CONSOLE_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "ultibo/globaltypes.h"
#include "ultibo/globalconst.h"
#include "ultibo/devices.h"

#define CONSOLE_NAME_PREFIX "Console" 

#define CONSOLE_TYPE_NONE   0
#define CONSOLE_TYPE_FRAMEBUFFER    1
#define CONSOLE_TYPE_SERIAL 2
#define CONSOLE_TYPE_REMOTE 3
#define CONSOLE_TYPE_LCD    4
 
#define CONSOLE_TYPE_MAX    4

#define CONSOLE_STATE_CLOSED    0
#define CONSOLE_STATE_OPEN  1
 
#define CONSOLE_STATE_MAX   1

#define CONSOLE_FLAG_NONE   0x00000000
#define CONSOLE_FLAG_LINE_WRAP  0x00000001 
#define CONSOLE_FLAG_DMA_BOX    0x00000002 
#define CONSOLE_FLAG_DMA_LINE   0x00000004 
#define CONSOLE_FLAG_DMA_FILL   0x00000008 
#define CONSOLE_FLAG_DMA_CLEAR  0x00000010 
#define CONSOLE_FLAG_DMA_SCROLL 0x00000020 
#define CONSOLE_FLAG_SINGLE_WINDOW  0x00000040 
#define CONSOLE_FLAG_HARDWARE_CURSOR    0x00000080 
#define CONSOLE_FLAG_HARDWARE_CARET 0x00000100 
#define CONSOLE_FLAG_BLINK_CARET    0x00000200 
#define CONSOLE_FLAG_TEXT_MODE  0x00000400 
#define CONSOLE_FLAG_TEXT_BLINK 0x00000800 
#define CONSOLE_FLAG_COLOR  0x00001000 
#define CONSOLE_FLAG_FONT   0x00002000 
#define CONSOLE_FLAG_FULLSCREEN 0x00004000 
#define CONSOLE_FLAG_AUTO_SCROLL    0x00008000 
#define CONSOLE_FLAG_DMA_TEXT   0x00010000 
#define CONSOLE_FLAG_COLOR_REVERSE  0x00020000 
#define CONSOLE_FLAG_TEXT_CARET 0x00040000 
#define CONSOLE_FLAG_FOCUS_CARET    0x00080000 
 
#define CONSOLE_FLAG_DMA_MASK   CONSOLE_FLAG_DMA_BOX | CONSOLE_FLAG_DMA_LINE | CONSOLE_FLAG_DMA_FILL | CONSOLE_FLAG_DMA_CLEAR | CONSOLE_FLAG_DMA_SCROLL | CONSOLE_FLAG_DMA_TEXT

#define CONSOLE_FLAG_INTERNAL   CONSOLE_FLAG_SINGLE_WINDOW | CONSOLE_FLAG_HARDWARE_CURSOR | CONSOLE_FLAG_HARDWARE_CARET | CONSOLE_FLAG_BLINK_CARET | CONSOLE_FLAG_TEXT_MODE | CONSOLE_FLAG_TEXT_BLINK | CONSOLE_FLAG_COLOR | CONSOLE_FLAG_FONT | CONSOLE_FLAG_FULLSCREEN | CONSOLE_FLAG_COLOR_REVERSE | CONSOLE_FLAG_TEXT_CARET

#define CONSOLE_MODE_NONE   0
#define CONSOLE_MODE_PIXEL  1
#define CONSOLE_MODE_CHARACTER  2

#define CARET_SIGNATURE 0x9A2D40E3

#define WINDOW_SIGNATURE    0xDE3A5C04

#define WINDOW_STATE_INVISIBLE  0
#define WINDOW_STATE_VISIBLE    1
 
#define WINDOW_STATE_MAX    1

#define WINDOW_MODE_NONE    0
#define WINDOW_MODE_TEXT    1
#define WINDOW_MODE_GRAPHICS    2
 
#define WINDOW_MODE_MAX 2

#define WINDOW_FLAG_NONE    0x00000000
#define WINDOW_FLAG_LINE_WRAP   0x00000001 
#define WINDOW_FLAG_BUFFERED    0x00000002 
#define WINDOW_FLAG_FULLSCREEN  0x00000004 
#define WINDOW_FLAG_AUTO_SCROLL 0x00000008 
#define WINDOW_FLAG_CHARACTER   0x00000010 
#define WINDOW_FLAG_AUTO_UPDATE 0x00000020 
#define WINDOW_FLAG_FOCUS_CURSOR    0x00000040 

#define WINDOW_FLAG_INTERNAL    WINDOW_FLAG_FULLSCREEN | WINDOW_FLAG_CHARACTER

#define WINDOW_DRAW_FLAG_NONE   0x00000000
#define WINDOW_DRAW_FLAG_BODY   0x00000001 
#define WINDOW_DRAW_FLAG_TITLE  0x00000002 
#define WINDOW_DRAW_FLAG_BORDER 0x00000004 
 
#define WINDOW_DRAW_FLAG_ALL    WINDOW_DRAW_FLAG_BODY | WINDOW_DRAW_FLAG_TITLE | WINDOW_DRAW_FLAG_BORDER

#define WINDOW_HISTORY_MAX_COUNT    100

#define FRAMEBUFFER_CONSOLE_DESCRIPTION "Framebuffer Console" 

typedef enum
{
 CURSOR_MODE_INSERT,
 CURSOR_MODE_OVERWRITE
} CURSOR_MODE;
 
typedef enum
{
 CURSOR_STATE_ON,
 CURSOR_STATE_OFF
} CURSOR_STATE;
 
typedef enum
{
 CURSOR_SHAPE_LINE, 
 CURSOR_SHAPE_BAR, 
 CURSOR_SHAPE_BLOCK 
} CURSOR_SHAPE;
 
typedef struct _CONSOLE_CHAR CONSOLE_CHAR;
struct _CONSOLE_CHAR
{
    char ch;
    uint32_t forecolor;
    uint32_t backcolor;
};
 
typedef struct
{
    uint32_t x;
    uint32_t y;
} CONSOLE_POINT;
 
typedef struct
{
    uint32_t x1;
    uint32_t y1;
    uint32_t x2;
    uint32_t y2;
} CONSOLE_RECT;
 
typedef struct _CONSOLE_PROPERTIES CONSOLE_PROPERTIES;
struct _CONSOLE_PROPERTIES
{
    uint32_t flags; 
    uint32_t mode; 
    uint32_t width; 
    uint32_t height; 
    uint32_t format; 
};
 
typedef struct _CONSOLE_DEVICE CONSOLE_DEVICE;

typedef uint32_t STDCALL (*console_enumerate_cb)(CONSOLE_DEVICE *console, void *data);
typedef uint32_t STDCALL (*console_notification_cb)(DEVICE *device, void *data, uint32_t notification);

typedef uint32_t STDCALL (*console_device_open_proc)(CONSOLE_DEVICE *console);
typedef uint32_t STDCALL (*console_device_close_proc)(CONSOLE_DEVICE *console);
typedef uint32_t STDCALL (*console_device_clear_proc)(CONSOLE_DEVICE *console, uint32_t color);
typedef uint32_t STDCALL (*console_device_scroll_proc)(CONSOLE_DEVICE *console, uint32_t x1, uint32_t y1, uint32_t x2, uint32_t y2, uint32_t count, uint32_t direction);
typedef uint32_t STDCALL (*console_device_draw_box_proc)(CONSOLE_DEVICE *console, uint32_t x1, uint32_t y1, uint32_t x2, uint32_t y2, uint32_t color, uint32_t width);
typedef uint32_t STDCALL (*console_device_draw_line_proc)(CONSOLE_DEVICE *console, uint32_t x1, uint32_t y1, uint32_t x2, uint32_t y2, uint32_t color, uint32_t width);
typedef uint32_t STDCALL (*console_device_plot_line_proc)(CONSOLE_DEVICE *console, uint32_t x1, uint32_t y1, uint32_t x2, uint32_t y2, uint32_t color, uint32_t width);
typedef uint32_t STDCALL (*console_device_draw_char_proc)(CONSOLE_DEVICE *console, FONT_HANDLE handle, char ch, uint32_t x, uint32_t y, uint32_t forecolor, uint32_t backcolor);
typedef uint32_t STDCALL (*console_device_draw_text_proc)(CONSOLE_DEVICE *console, FONT_HANDLE handle, const char *text, uint32_t x, uint32_t y, uint32_t forecolor, uint32_t backcolor, uint32_t len);
typedef uint32_t STDCALL (*console_device_draw_pixel_proc)(CONSOLE_DEVICE *console, uint32_t x, uint32_t y, uint32_t color);
typedef uint32_t STDCALL (*console_device_draw_block_proc)(CONSOLE_DEVICE *console, uint32_t x1, uint32_t y1, uint32_t x2, uint32_t y2, uint32_t color);
typedef uint32_t STDCALL (*console_device_draw_circle_proc)(CONSOLE_DEVICE *console, uint32_t x, uint32_t y, uint32_t color, uint32_t width, uint32_t radius);
typedef uint32_t STDCALL (*console_device_draw_image_proc)(CONSOLE_DEVICE *console, uint32_t x, uint32_t y, void *buffer, uint32_t width, uint32_t height, uint32_t format, uint32_t skip);
typedef uint32_t STDCALL (*console_device_draw_window_proc)(CONSOLE_DEVICE *console, WINDOW_HANDLE handle, uint32_t flags);
 
typedef uint32_t STDCALL (*console_device_get_pixel_proc)(CONSOLE_DEVICE *console, uint32_t x, uint32_t y, uint32_t *color);
typedef uint32_t STDCALL (*console_device_get_image_proc)(CONSOLE_DEVICE *console, uint32_t x, uint32_t y, void *buffer, uint32_t width, uint32_t height, uint32_t format, uint32_t skip);
 
typedef uint32_t STDCALL (*console_device_put_text_proc)(CONSOLE_DEVICE *console, FONT_HANDLE handle, CONSOLE_POINT *source, CONSOLE_POINT *dest, CONSOLE_CHAR *buffer, uint32_t width, uint32_t height, uint32_t skip);
 
typedef uint32_t STDCALL (*console_device_copy_image_proc)(CONSOLE_DEVICE *console, CONSOLE_POINT *source, CONSOLE_POINT *dest, uint32_t width, uint32_t height);
 
typedef HANDLE STDCALL (*console_device_add_caret_proc)(CONSOLE_DEVICE *console, uint32_t width, uint32_t height, uint32_t offsetx, uint32_t offsety);
typedef uint32_t STDCALL (*console_device_delete_caret_proc)(CONSOLE_DEVICE *console, HANDLE handle);
typedef uint32_t STDCALL (*console_device_update_caret_proc)(CONSOLE_DEVICE *console, HANDLE handle, uint32_t x, uint32_t y, BOOL visible, BOOL blink);
typedef uint32_t STDCALL (*console_device_update_caret_ex_proc)(CONSOLE_DEVICE *console, HANDLE handle, uint32_t x, uint32_t y, uint32_t forecolor, uint32_t backcolor, BOOL visible, BOOL blink, BOOL reverse);
 
typedef uint32_t STDCALL (*console_device_set_cursor_proc)(CONSOLE_DEVICE *console, uint32_t width, uint32_t height, char *chars);
typedef uint32_t STDCALL (*console_device_update_cursor_proc)(CONSOLE_DEVICE *console, BOOL enabled, int32_t x, int32_t y, BOOL relative);
 
typedef uint32_t STDCALL (*console_device_get_position_proc)(CONSOLE_DEVICE *console, uint32_t position, uint32_t *x1, uint32_t *y1, uint32_t *x2, uint32_t *y2);
typedef uint32_t STDCALL (*console_device_get_properties_proc)(CONSOLE_DEVICE *console, CONSOLE_PROPERTIES *properties);
 
typedef struct _CONSOLE_CARET CONSOLE_CARET;
typedef struct _CONSOLE_WINDOW CONSOLE_WINDOW;
typedef struct _CONSOLE_HISTORY CONSOLE_HISTORY;

struct _CONSOLE_DEVICE
{
    // Device Properties
    DEVICE device; 
    // Console Properties
    uint32_t consoleid; 
    uint32_t consolestate; 
    uint32_t consolemode; 
    console_device_open_proc deviceopen; 
    console_device_close_proc deviceclose; 
    console_device_clear_proc deviceclear; 
    console_device_scroll_proc devicescroll; 
    console_device_draw_box_proc devicedrawbox; 
    console_device_draw_line_proc devicedrawline; 
    console_device_plot_line_proc deviceplotline; 
    console_device_draw_char_proc devicedrawchar; 
    console_device_draw_text_proc devicedrawtext; 
    console_device_draw_pixel_proc devicedrawpixel; 
    console_device_draw_block_proc devicedrawblock; 
    console_device_draw_circle_proc devicedrawcircle; 
    console_device_draw_image_proc devicedrawimage; 
    console_device_draw_window_proc devicedrawwindow; 
    console_device_get_pixel_proc devicegetpixel; 
    console_device_get_image_proc devicegetimage; 
    console_device_put_text_proc deviceputtext; 
    console_device_copy_image_proc devicecopyimage; 
    console_device_add_caret_proc deviceaddcaret; 
    console_device_delete_caret_proc devicedeletecaret; 
    console_device_update_caret_proc deviceupdatecaret; 
    console_device_update_caret_ex_proc deviceupdatecaretex; 
    console_device_set_cursor_proc devicesetcursor; 
    console_device_update_cursor_proc deviceupdatecursor; 
    console_device_get_position_proc devicegetposition; 
    console_device_get_properties_proc devicegetproperties; 
    // Statistics Properties
    uint32_t opencount;
    uint32_t closecount;
    uint32_t clearcount;
    uint32_t scrollcount;
    uint32_t drawcount;
    uint32_t getcount;
    uint32_t putcount;
    uint32_t copycount;
    // Driver Properties
    MUTEX_HANDLE lock; 
    uint32_t width; 
    uint32_t height; 
    uint32_t format; 
    uint32_t forecolor; 
    uint32_t backcolor; 
    uint32_t borderwidth; 
    uint32_t bordercolor; 
    // Font Properties
    FONT_HANDLE font; 
    uint32_t fontratio; 
    // Cursor Properties
    LONGBOOL cursorupdate; 
    uint32_t cursorx; 
    uint32_t cursory; 
    uint32_t cursorwidth; 
    uint32_t cursorheight; 
    LONGBOOL cursorvisible; 
    char *cursorchars; 
    char *cursorbuffer; 
    // Caret Properties
    CONSOLE_CARET *caretfirst;
    CRITICAL_SECTION_HANDLE caretlock;
    uint32_t caretcount;
    // Window Properties
    CONSOLE_WINDOW *windowfirst;
    CRITICAL_SECTION_HANDLE windowlock;
    uint32_t windowcount;
    CONSOLE_WINDOW *windowactive; 
    WINDOW_HANDLE windowdefault; 
    // Internal Properties
    CONSOLE_DEVICE *prev; 
    CONSOLE_DEVICE *next; 
};

struct _CONSOLE_CARET
{
    // Caret Properties
    uint32_t signature; 
    uint32_t x; 
    uint32_t y; 
    uint32_t width; 
    uint32_t height; 
    uint32_t offsetx; 
    uint32_t offsety; 
    LONGBOOL visible; 
    LONGBOOL blink; 
    LONGBOOL reverse; 
    uint32_t forecolor; 
    uint32_t backcolor; 
    CONSOLE_DEVICE *console; 
    // Driver Properties
    HANDLE handle; 
    LONGBOOL active; 
    void *image; 
    void *buffer; 
    void *output; 
    // Internal Properties
    CONSOLE_CARET *prev; 
    CONSOLE_CARET *next; 
};
 
typedef struct _WINDOW_PROPERTIES WINDOW_PROPERTIES;
struct _WINDOW_PROPERTIES
{
    uint32_t position; 
    uint32_t state; 
    uint32_t mode; 
    uint32_t flags; 
    uint32_t x1; 
    uint32_t y1; 
    uint32_t x2; 
    uint32_t y2; 
    uint32_t width; 
    uint32_t height; 
    uint32_t offsetx; 
    uint32_t offsety; 
    uint32_t fontwidth; 
    uint32_t fontheight; 
    uint32_t borderwidth; 
    FONT_HANDLE font; 
    CONSOLE_DEVICE *console; 
};

typedef uint32_t STDCALL (*console_window_enumerate_cb)(CONSOLE_DEVICE *console, WINDOW_HANDLE handle, void *data);

typedef uint32_t STDCALL (*console_window_completion_cb)(WINDOW_HANDLE handle, char *buffer, void *data);

struct _CONSOLE_WINDOW
{
    // Window Properties
    uint32_t signature; 
    uint32_t position; 
    uint32_t windowstate; 
    uint32_t windowmode; 
    uint32_t windowflags; 
    uint32_t x1; 
    uint32_t y1; 
    uint32_t x2; 
    uint32_t y2; 
    uint32_t width; 
    uint32_t height; 
    uint32_t offsetx; 
    uint32_t offsety; 
    uint32_t minx; 
    uint32_t miny; 
    uint32_t maxx; 
    uint32_t maxy; 
    uint32_t x; 
    uint32_t y; 
    uint32_t cols; 
    uint32_t rows; 
    uint32_t format; 
    uint32_t forecolor; 
    uint32_t backcolor; 
    uint32_t borderwidth; 
    uint32_t bordercolor; 
    // Font Properties
    FONT_HANDLE font; 
    uint32_t fontwidth; 
    uint32_t fontheight; 
    // Cursor Properties
    uint32_t cursorx; 
    uint32_t cursory; 
    CURSOR_MODE cursormode; 
    LONGBOOL cursorblink; 
    CURSOR_STATE cursorstate; 
    CURSOR_SHAPE cursorshape; 
    LONGBOOL cursorreverse; 
    uint32_t cursorforecolor; 
    uint32_t cursorbackcolor; 
    // Caret Properties
    uint32_t caretx; 
    uint32_t carety; 
    HANDLE carethandle; 
    // History Properties
    CONSOLE_HISTORY *historyfirst;
    CONSOLE_HISTORY *historylast;
    CONSOLE_HISTORY *historycurrent;
    uint32_t historycount;
    // Driver Properties
    MUTEX_HANDLE lock; 
    CONSOLE_DEVICE *console; 
    // Internal Properties
    CONSOLE_WINDOW *prev; 
    CONSOLE_WINDOW *next; 
};
 
struct _CONSOLE_HISTORY
{
    // History Properties
    char *value;
    int length;
    // Internal Properties
    CONSOLE_HISTORY *prev; 
    CONSOLE_HISTORY *next; 
};


uint32_t STDCALL console_device_open(CONSOLE_DEVICE *console);

uint32_t STDCALL console_device_close(CONSOLE_DEVICE *console);

uint32_t STDCALL console_device_clear(CONSOLE_DEVICE *console, uint32_t color);

uint32_t STDCALL console_device_scroll(CONSOLE_DEVICE *console, uint32_t x1, uint32_t y1, uint32_t x2, uint32_t y2, uint32_t count, uint32_t direction);

uint32_t STDCALL console_device_draw_box(CONSOLE_DEVICE *console, uint32_t x1, uint32_t y1, uint32_t x2, uint32_t y2, uint32_t color, uint32_t width);

uint32_t STDCALL console_device_draw_line(CONSOLE_DEVICE *console, uint32_t x1, uint32_t y1, uint32_t x2, uint32_t y2, uint32_t color, uint32_t width);

uint32_t STDCALL console_device_plot_line(CONSOLE_DEVICE *console, uint32_t x1, uint32_t y1, uint32_t x2, uint32_t y2, uint32_t color, uint32_t width);

uint32_t STDCALL console_device_draw_char(CONSOLE_DEVICE *console, FONT_HANDLE handle, char ch, uint32_t x, uint32_t y, uint32_t forecolor, uint32_t backcolor);

uint32_t STDCALL console_device_draw_text(CONSOLE_DEVICE *console, FONT_HANDLE handle, const char *text, uint32_t x, uint32_t y, uint32_t forecolor, uint32_t backcolor, uint32_t len);

uint32_t STDCALL console_device_draw_pixel(CONSOLE_DEVICE *console, uint32_t x, uint32_t y, uint32_t color);

uint32_t STDCALL console_device_draw_block(CONSOLE_DEVICE *console, uint32_t x1, uint32_t y1, uint32_t x2, uint32_t y2, uint32_t color);

uint32_t STDCALL console_device_draw_circle(CONSOLE_DEVICE *console, uint32_t x, uint32_t y, uint32_t color, uint32_t width, uint32_t radius);

uint32_t STDCALL console_device_draw_image(CONSOLE_DEVICE *console, uint32_t x, uint32_t y, void *buffer, uint32_t width, uint32_t height, uint32_t format, uint32_t skip);

uint32_t STDCALL console_device_draw_window(CONSOLE_DEVICE *console, WINDOW_HANDLE handle, uint32_t flags);

uint32_t STDCALL console_device_get_pixel(CONSOLE_DEVICE *console, uint32_t x, uint32_t y, uint32_t *color);

uint32_t STDCALL console_device_get_image(CONSOLE_DEVICE *console, uint32_t x, uint32_t y, void *buffer, uint32_t width, uint32_t height, uint32_t format, uint32_t skip);

uint32_t STDCALL console_device_put_text(CONSOLE_DEVICE *console, FONT_HANDLE handle, CONSOLE_POINT *source, CONSOLE_POINT *dest, CONSOLE_CHAR *buffer, uint32_t width, uint32_t height, uint32_t skip);

uint32_t STDCALL console_device_copy_image(CONSOLE_DEVICE *console, CONSOLE_POINT *source, CONSOLE_POINT *dest, uint32_t width, uint32_t height);

HANDLE STDCALL console_device_add_caret(CONSOLE_DEVICE *console, uint32_t width, uint32_t height, uint32_t offsetx, uint32_t offsety);

uint32_t STDCALL console_device_delete_caret(CONSOLE_DEVICE *console, HANDLE handle);

uint32_t STDCALL console_device_update_caret(CONSOLE_DEVICE *console, HANDLE handle, uint32_t x, uint32_t y, BOOL visible, BOOL blink);

uint32_t STDCALL console_device_update_caret_ex(CONSOLE_DEVICE *console, HANDLE handle, uint32_t x, uint32_t y, uint32_t forecolor, uint32_t backcolor, BOOL visible, BOOL blink, BOOL reverse);

uint32_t STDCALL console_device_set_cursor(CONSOLE_DEVICE *console, uint32_t width, uint32_t height, char *chars);

uint32_t STDCALL console_device_update_cursor(CONSOLE_DEVICE *console, BOOL enabled, int32_t x, int32_t y, BOOL relative);

uint32_t STDCALL console_device_get_position(CONSOLE_DEVICE *console, uint32_t position, uint32_t *x1, uint32_t *y1, uint32_t *x2, uint32_t *y2);

uint32_t STDCALL console_device_get_properties(CONSOLE_DEVICE *console, CONSOLE_PROPERTIES *properties);

BOOL STDCALL console_device_check_flag(CONSOLE_DEVICE *console, uint32_t flag);

uint32_t STDCALL console_device_update_flag(CONSOLE_DEVICE *console, uint32_t flag, BOOL clear);

uint32_t STDCALL console_device_get_mode(CONSOLE_DEVICE *console);

uint32_t STDCALL console_device_get_state(CONSOLE_DEVICE *console);

CONSOLE_DEVICE * STDCALL console_device_create(void);

CONSOLE_DEVICE * STDCALL console_device_create_ex(uint32_t size);

uint32_t STDCALL console_device_destroy(CONSOLE_DEVICE *console);

uint32_t STDCALL console_device_register(CONSOLE_DEVICE *console);

uint32_t STDCALL console_device_deregister(CONSOLE_DEVICE *console);

CONSOLE_DEVICE * STDCALL console_device_find(uint32_t consoleid);

CONSOLE_DEVICE * STDCALL console_device_find_by_device(DEVICE *device);

CONSOLE_DEVICE * STDCALL console_device_find_by_name(const char *name);

CONSOLE_DEVICE * STDCALL console_device_find_by_description(const char *description);

uint32_t STDCALL console_device_enumerate(console_enumerate_cb callback, void *data);

uint32_t STDCALL console_device_notification(CONSOLE_DEVICE *console, console_notification_cb callback, void *data, uint32_t notification, uint32_t flags);


WINDOW_HANDLE STDCALL console_window_create(CONSOLE_DEVICE *console, uint32_t position, BOOL _default);

WINDOW_HANDLE STDCALL console_window_create_ex(CONSOLE_DEVICE *console, FONT_HANDLE font, uint32_t size, uint32_t state, uint32_t mode, uint32_t position, BOOL _default);

uint32_t STDCALL console_window_destroy(WINDOW_HANDLE handle);

uint32_t STDCALL console_window_show(WINDOW_HANDLE handle);

uint32_t STDCALL console_window_hide(WINDOW_HANDLE handle);

uint32_t STDCALL console_window_activate(WINDOW_HANDLE handle);

uint32_t STDCALL console_window_deactivate(WINDOW_HANDLE handle);

WINDOW_HANDLE STDCALL console_window_next(CONSOLE_DEVICE *console, BOOL visible);

WINDOW_HANDLE STDCALL console_window_previous(CONSOLE_DEVICE *console, BOOL visible);

WINDOW_HANDLE STDCALL console_window_at(CONSOLE_DEVICE *console, uint32_t x, uint32_t y, BOOL visible);

WINDOW_HANDLE STDCALL console_window_find(CONSOLE_DEVICE *console, uint32_t position);

uint32_t STDCALL console_window_enumerate(CONSOLE_DEVICE *console, console_window_enumerate_cb callback, void *data);

BOOL STDCALL console_window_check_flag(WINDOW_HANDLE handle, uint32_t flag);

uint32_t STDCALL console_window_update_flag(WINDOW_HANDLE handle, uint32_t flag, BOOL clear);

uint32_t STDCALL console_window_get_mode(WINDOW_HANDLE handle);

uint32_t STDCALL console_window_get_state(WINDOW_HANDLE handle);

uint32_t STDCALL console_window_get_position(WINDOW_HANDLE handle);

uint32_t STDCALL console_window_set_position(WINDOW_HANDLE handle, uint32_t position);

uint32_t STDCALL console_window_get_properties(WINDOW_HANDLE handle, WINDOW_PROPERTIES *properties);

uint32_t STDCALL console_window_get_min_x(WINDOW_HANDLE handle);

uint32_t STDCALL console_window_get_min_y(WINDOW_HANDLE handle);

uint32_t STDCALL console_window_get_max_x(WINDOW_HANDLE handle);

uint32_t STDCALL console_window_get_max_y(WINDOW_HANDLE handle);

CONSOLE_RECT STDCALL console_window_get_rect(WINDOW_HANDLE handle);

uint32_t STDCALL console_window_set_rect(WINDOW_HANDLE handle, CONSOLE_RECT *rect);

uint32_t STDCALL console_window_reset_rect(WINDOW_HANDLE handle);

uint32_t STDCALL console_window_get_viewport(WINDOW_HANDLE handle, uint32_t *x1, uint32_t *y1, uint32_t *x2, uint32_t *y2);

uint32_t STDCALL console_window_set_viewport(WINDOW_HANDLE handle, uint32_t x1, uint32_t y1, uint32_t x2, uint32_t y2);

uint32_t STDCALL console_window_reset_viewport(WINDOW_HANDLE handle);

uint32_t STDCALL console_window_get_x(WINDOW_HANDLE handle);

uint32_t STDCALL console_window_set_x(WINDOW_HANDLE handle, uint32_t x);

uint32_t STDCALL console_window_get_y(WINDOW_HANDLE handle);

uint32_t STDCALL console_window_set_y(WINDOW_HANDLE handle, uint32_t y);

uint32_t STDCALL console_window_get_xy(WINDOW_HANDLE handle, uint32_t *x, uint32_t *y);

uint32_t STDCALL console_window_set_xy(WINDOW_HANDLE handle, uint32_t x, uint32_t y);

CONSOLE_POINT STDCALL console_window_get_point(WINDOW_HANDLE handle);

uint32_t STDCALL console_window_set_point(WINDOW_HANDLE handle, CONSOLE_POINT *point);

uint32_t STDCALL console_window_get_cols(WINDOW_HANDLE handle);

uint32_t STDCALL console_window_get_rows(WINDOW_HANDLE handle);

uint32_t STDCALL console_window_get_width(WINDOW_HANDLE handle);

uint32_t STDCALL console_window_get_height(WINDOW_HANDLE handle);

uint32_t STDCALL console_window_get_format(WINDOW_HANDLE handle);

uint32_t STDCALL console_window_get_forecolor(WINDOW_HANDLE handle);

uint32_t STDCALL console_window_set_forecolor(WINDOW_HANDLE handle, uint32_t color);

uint32_t STDCALL console_window_get_backcolor(WINDOW_HANDLE handle);

uint32_t STDCALL console_window_set_backcolor(WINDOW_HANDLE handle, uint32_t color);

FONT_HANDLE STDCALL console_window_get_font(WINDOW_HANDLE handle);

uint32_t STDCALL console_window_set_font(WINDOW_HANDLE handle, FONT_HANDLE font);

uint32_t STDCALL console_window_get_cursor_xy(WINDOW_HANDLE handle, uint32_t *x, uint32_t *y);

uint32_t STDCALL console_window_set_cursor_xy(WINDOW_HANDLE handle, uint32_t x, uint32_t y);

CURSOR_MODE STDCALL console_window_get_cursor_mode(WINDOW_HANDLE handle);

uint32_t STDCALL console_window_set_cursor_mode(WINDOW_HANDLE handle, CURSOR_MODE cursormode);

BOOL STDCALL console_window_get_cursor_blink(WINDOW_HANDLE handle);

uint32_t STDCALL console_window_set_cursor_blink(WINDOW_HANDLE handle, BOOL cursorblink);

CURSOR_STATE STDCALL console_window_get_cursor_state(WINDOW_HANDLE handle);

uint32_t STDCALL console_window_set_cursor_state(WINDOW_HANDLE handle, CURSOR_STATE cursorstate);

CURSOR_SHAPE STDCALL console_window_get_cursor_shape(WINDOW_HANDLE handle);

uint32_t STDCALL console_window_set_cursor_shape(WINDOW_HANDLE handle, CURSOR_SHAPE cursorshape);

uint32_t STDCALL console_window_get_cursor_color(WINDOW_HANDLE handle);

uint32_t STDCALL console_window_set_cursor_color(WINDOW_HANDLE handle, uint32_t color);

BOOL STDCALL console_window_get_cursor_reverse(WINDOW_HANDLE handle);

uint32_t STDCALL console_window_set_cursor_reverse(WINDOW_HANDLE handle, BOOL cursorreverse);

uint32_t STDCALL console_window_cursor_on(WINDOW_HANDLE handle);

uint32_t STDCALL console_window_cursor_off(WINDOW_HANDLE handle);

uint32_t STDCALL console_window_cursor_line(WINDOW_HANDLE handle);

uint32_t STDCALL console_window_cursor_bar(WINDOW_HANDLE handle);

uint32_t STDCALL console_window_cursor_block(WINDOW_HANDLE handle);

uint32_t STDCALL console_window_cursor_move(WINDOW_HANDLE handle, uint32_t x, uint32_t y);

uint32_t STDCALL console_window_cursor_blink(WINDOW_HANDLE handle, BOOL enabled);

uint32_t STDCALL console_window_cursor_color(WINDOW_HANDLE handle, uint32_t color);

uint32_t STDCALL console_window_cursor_reverse(WINDOW_HANDLE handle, BOOL enabled);

uint32_t STDCALL console_window_add_history(WINDOW_HANDLE handle, const char *value);

uint32_t STDCALL console_window_clear_history(WINDOW_HANDLE handle);

uint32_t STDCALL console_window_first_history(WINDOW_HANDLE handle, char *value, uint32_t len);

uint32_t STDCALL console_window_last_history(WINDOW_HANDLE handle, char *value, uint32_t len);

uint32_t STDCALL console_window_next_history(WINDOW_HANDLE handle, char *value, uint32_t len);

uint32_t STDCALL console_window_previous_history(WINDOW_HANDLE handle, char *value, uint32_t len);

uint32_t STDCALL console_window_current_history(WINDOW_HANDLE handle, char *value, uint32_t len);

uint32_t STDCALL console_window_scroll_up(WINDOW_HANDLE handle, uint32_t row, uint32_t lines);

uint32_t STDCALL console_window_scroll_down(WINDOW_HANDLE handle, uint32_t row, uint32_t lines);

uint32_t STDCALL console_window_scroll_left(WINDOW_HANDLE handle, uint32_t row, uint32_t col, uint32_t lines, uint32_t chars);

uint32_t STDCALL console_window_scroll_right(WINDOW_HANDLE handle, uint32_t row, uint32_t col, uint32_t lines, uint32_t chars);

uint32_t STDCALL console_window_clear(WINDOW_HANDLE handle);

uint32_t STDCALL console_window_clear_ex(WINDOW_HANDLE handle, uint32_t x1, uint32_t y1, uint32_t x2, uint32_t y2, BOOL cursor);

uint32_t STDCALL console_window_write(WINDOW_HANDLE handle, const char *text);

uint32_t STDCALL console_window_write_ex(WINDOW_HANDLE handle, const char *text, uint32_t x, uint32_t y, uint32_t forecolor, uint32_t backcolor);

uint32_t STDCALL console_window_write_ln(WINDOW_HANDLE handle, const char *text);

uint32_t STDCALL console_window_write_ln_ex(WINDOW_HANDLE handle, const char *text, uint32_t x, uint32_t y, uint32_t forecolor, uint32_t backcolor);

uint32_t STDCALL console_window_write_chr(WINDOW_HANDLE handle, char ch);

uint32_t STDCALL console_window_write_chr_ex(WINDOW_HANDLE handle, char ch, uint32_t x, uint32_t y, uint32_t forecolor, uint32_t backcolor);

uint32_t STDCALL console_window_output(WINDOW_HANDLE handle, CONSOLE_POINT *source, CONSOLE_POINT *dest, CONSOLE_CHAR *buffer, uint32_t width, uint32_t height, uint32_t skip);

uint32_t STDCALL console_window_read(WINDOW_HANDLE handle, char *text, uint32_t *len);

uint32_t STDCALL console_window_read_ln(WINDOW_HANDLE handle, char *text, uint32_t *len);

uint32_t STDCALL console_window_read_ln_ex(WINDOW_HANDLE handle, char *text, uint32_t *len, char *prompt, uint32_t x, uint32_t y, uint32_t forecolor, uint32_t backcolor, BOOL scroll, BOOL history, console_window_completion_cb completion, void *data);

uint32_t STDCALL console_window_read_chr(WINDOW_HANDLE handle, char *ch);

uint32_t STDCALL console_window_read_chr_ex(WINDOW_HANDLE handle, char *ch, char *prompt, uint32_t x, uint32_t y, uint32_t forecolor, uint32_t backcolor, BOOL echo, BOOL scroll);

int STDCALL console_window_printf(WINDOW_HANDLE handle, const char *format, ...) _ATTRIBUTE ((__format__ (__printf__, 2, 3)));


void STDCALL console_clr_eol(void);

void STDCALL console_clr_scr(void);

void STDCALL console_delay(uint16_t ms);

void STDCALL console_del_line(void);

void STDCALL console_goto_xy(int x, int y);

void STDCALL console_high_video(void);

void STDCALL console_ins_line(void);

BOOL STDCALL console_keypressed(void);

void STDCALL console_low_video(void);

void STDCALL console_norm_video(void);

void STDCALL console_no_sound(void);

char STDCALL console_read_key(void);

void STDCALL console_sound(uint16_t hz);

void STDCALL console_text_background(uint32_t color);

void STDCALL console_text_color(uint32_t color);

void STDCALL console_text_mode(int mode);

int STDCALL console_where_x(void);

int STDCALL console_where_y(void);

void STDCALL console_window(int x1, int y1, int x2, int y2);

void STDCALL console_scroll_up(int row, int lines);

void STDCALL console_scroll_down(int row, int lines);

void STDCALL console_write(const char *text);

void STDCALL console_write_ln(const char *text);

void STDCALL console_write_chr(char ch);

void STDCALL console_read(char *text, uint32_t *len);

void STDCALL console_read_ln(char *text, uint32_t *len);

void STDCALL console_read_chr(char *ch);

int STDCALL console_printf(const char *format, ...) _ATTRIBUTE ((__format__ (__printf__, 1, 2)));


uint32_t STDCALL console_device_get_count(void);

CONSOLE_DEVICE * STDCALL console_device_get_default(void);

uint32_t STDCALL console_device_set_default(CONSOLE_DEVICE *console);

CONSOLE_DEVICE * STDCALL console_device_check(CONSOLE_DEVICE *console);

CONSOLE_CARET * STDCALL console_device_caret_check(CONSOLE_DEVICE *console, CONSOLE_CARET *caret);

uint32_t STDCALL console_type_to_string(uint32_t consoletype, char *value, uint32_t len);

uint32_t STDCALL console_state_to_string(uint32_t consolestate, char *value, uint32_t len);

FONT_HANDLE STDCALL console_device_get_default_font(void);
uint32_t STDCALL console_position_to_string(uint32_t position, char *value, uint32_t len);


uint32_t STDCALL console_window_get_count(CONSOLE_DEVICE *console);

WINDOW_HANDLE STDCALL console_window_get_active(CONSOLE_DEVICE *console);

WINDOW_HANDLE STDCALL console_window_get_default(CONSOLE_DEVICE *console);

uint32_t STDCALL console_window_set_default(CONSOLE_DEVICE *console, WINDOW_HANDLE handle);

CONSOLE_WINDOW * STDCALL console_window_check(CONSOLE_DEVICE *console, CONSOLE_WINDOW *window);

uint32_t STDCALL console_window_state_to_string(uint32_t windowstate, char *value, uint32_t len);

uint32_t STDCALL console_window_mode_to_string(uint32_t windowmode, char *value, uint32_t len);

FONT_HANDLE STDCALL console_window_get_default_font(void);

BOOL STDCALL console_window_redirect_output(WINDOW_HANDLE handle);
 
#ifdef __cplusplus
}
#endif
 
#endif // _ULTIBO_CONSOLE_H