1
0
mirror of https://github.com/rkd77/elinks.git synced 2024-06-12 23:10:51 +00:00
elinks/src/terminal/draw.c
2022-10-17 10:04:46 +02:00

652 lines
16 KiB
C

/** Public terminal drawing API. Frontend for the screen image in memory.
* @file */
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include "elinks.h"
#include "bfu/dialog.h"
#include "config/options.h"
#include "intl/charsets.h"
#include "terminal/color.h"
#include "terminal/draw.h"
#include "terminal/screen.h"
#include "terminal/terminal.h"
#include "util/color.h"
#include "util/box.h"
/** Makes sure that @a x and @a y are within the dimensions of the terminal. */
#define check_range(term, x, y) \
do { \
int_bounds(&(x), 0, (term)->width - 1); \
int_bounds(&(y), 0, (term)->height - 1); \
} while (0)
#if SCREEN_COLOR_SIZE > 1
#define clear_screen_char_color(schar) \
do { memset((schar)->c.color, 0, SCREEN_COLOR_SIZE); } while (0)
#else
#define clear_screen_char_color(schar) \
do { (schar)->c.color[0] = 0; } while (0)
#endif
NONSTATIC_INLINE struct screen_char *
get_char(struct terminal *term, int x, int y)
{
assert(term && term->screen && term->screen->image);
if_assert_failed return NULL;
check_range(term, x, y);
return &term->screen->image[x + term->width * y];
}
void
draw_border_cross(struct terminal *term, int x, int y,
enum border_cross_direction dir, struct color_pair *color)
{
static const unsigned char border_trans[2][4] = {
/* Used for BORDER_X_{RIGHT,LEFT}: */
{ BORDER_SVLINE, BORDER_SRTEE, BORDER_SLTEE },
/* Used for BORDER_X_{DOWN,UP}: */
{ BORDER_SHLINE, BORDER_SDTEE, BORDER_SUTEE },
};
struct screen_char *screen_char = get_char(term, x, y);
unsigned int d;
if (!screen_char) return;
if (!(screen_char->attr & SCREEN_ATTR_FRAME)) return;
/* First check if there is already a horizontal/vertical line, so that
* we will have to replace with a T char. Example: if there is a '|'
* and the direction is right, replace with a '|-' T char.
*
* If this is not the case check if there is a T char and we are adding
* the direction so that we end up with a cross. Example : if there is
* a '|-' and the direction is left, replace with a '+' (cross) char. */
d = dir>>1;
if (screen_char->data == border_trans[d][0]) {
screen_char->data = border_trans[d][1 + (dir & 1)];
} else if (screen_char->data == border_trans[d][2 - (dir & 1)]) {
screen_char->data = BORDER_SCROSS;
}
set_term_color(screen_char, color, 0,
get_opt_int_tree(term->spec, "colors", NULL));
}
void
draw_border_char(struct terminal *term, int x, int y,
border_char_T border, struct color_pair *color)
{
struct screen_char *screen_char = get_char(term, x, y);
if (!screen_char) return;
screen_char->data = (unsigned char) border;
screen_char->attr = SCREEN_ATTR_FRAME;
set_term_color(screen_char, color, 0,
get_opt_int_tree(term->spec, "colors", NULL));
set_screen_dirty(term->screen, y, y);
}
void
draw_char_color(struct terminal *term, int x, int y, struct color_pair *color)
{
struct screen_char *screen_char = get_char(term, x, y);
if (!screen_char) return;
set_term_color(screen_char, color, 0,
get_opt_int_tree(term->spec, "colors", NULL));
set_screen_dirty(term->screen, y, y);
}
/*! The @a data parameter here is like screen_char.data: UCS-4 if the
* charset of the terminal is UTF-8 (possible only if CONFIG_UTF8 is
* defined), and a byte otherwise. */
void
#ifdef CONFIG_UTF8
draw_char_data(struct terminal *term, int x, int y, unicode_val_T data)
#else
draw_char_data(struct terminal *term, int x, int y, unsigned char data)
#endif /* CONFIG_UTF8 */
{
struct screen_char *screen_char = get_char(term, x, y);
if (!screen_char) return;
screen_char->data = data;
#ifdef CONFIG_UTF8
#ifdef CONFIG_DEBUG
/* Detect attempt to draw double-width char on the last
* column of terminal. The unicode_to_cell(data) call is
* in principle wrong if CONFIG_UTF8 is defined but the
* charset of the terminal is not UTF-8, because @data
* is then a byte in that charset; but unicode_to_cell
* returns 1 for U+0000...U+00FF so it's not a problem. */
if (unicode_to_cell(data) == 2 && x + 1 > term->width)
INTERNAL("Attempt to draw double-width glyph on last column!");
#endif /* CONFIG_DEBUG */
if (data == UCS_NO_CHAR)
screen_char->attr = 0;
#endif /* CONFIG_UTF8 */
set_screen_dirty(term->screen, y, y);
}
void
draw_space(struct terminal *term, int x, int y, struct screen_char *color)
{
struct screen_char *screen_char = get_char(term, x, y);
if (!screen_char) return;
screen_char->data = ' ';
if (color) screen_char->c = color->c;
}
/*! Used by viewer to copy over a document.
* When doing frame drawing @a x can be different than 0. */
void
draw_line(struct terminal *term, int x, int y, int l, struct screen_char *line)
{
struct screen_char *screen_char = get_char(term, x, y);
int size;
assert(line);
if_assert_failed return;
if (!screen_char) return;
size = int_min(l, term->width - x);
if (size == 0) return;
#ifdef CONFIG_UTF8
if (term->utf8_cp) {
struct screen_char *sc;
if (line[0].data == UCS_NO_CHAR && x == 0) {
unicode_val_T data_save;
sc = line;
data_save = sc->data;
sc->data = UCS_ORPHAN_CELL;
copy_screen_chars(screen_char, line, 1);
sc->data = data_save;
size--;
line++;
screen_char++;
}
/* Instead of displaying double-width character at last column
* display only UCS_ORPHAN_CELL. */
if (size - 1 > 0 && unicode_to_cell(line[size - 1].data) == 2) {
unicode_val_T data_save;
sc = &line[size - 1];
data_save = sc->data;
sc->data = UCS_ORPHAN_CELL;
copy_screen_chars(screen_char, line, size);
sc->data = data_save;
} else {
copy_screen_chars(screen_char, line, size);
}
} else
#endif
copy_screen_chars(screen_char, line, size);
set_screen_dirty(term->screen, y, y);
}
void
draw_border(struct terminal *term, struct el_box *box,
struct color_pair *color, int width)
{
static const border_char_T p1[] = {
BORDER_SULCORNER,
BORDER_SURCORNER,
BORDER_SDLCORNER,
BORDER_SDRCORNER,
BORDER_SVLINE,
BORDER_SHLINE,
};
static const border_char_T p2[] = {
BORDER_DULCORNER,
BORDER_DURCORNER,
BORDER_DDLCORNER,
BORDER_DDRCORNER,
BORDER_DVLINE,
BORDER_DHLINE,
};
const border_char_T *p = (width > 1) ? p2 : p1;
struct el_box borderbox;
set_box(&borderbox, box->x - 1, box->y - 1,
box->width + 2, box->height + 2);
if (borderbox.width > 2) {
struct el_box bbox;
/* Horizontal top border */
set_box(&bbox, box->x, borderbox.y, box->width, 1);
draw_box(term, &bbox, p[5], SCREEN_ATTR_FRAME, color);
/* Horizontal bottom border */
bbox.y += borderbox.height - 1;
draw_box(term, &bbox, p[5], SCREEN_ATTR_FRAME, color);
}
if (borderbox.height > 2) {
struct el_box bbox;
/* Vertical left border */
set_box(&bbox, borderbox.x, box->y, 1, box->height);
draw_box(term, &bbox, p[4], SCREEN_ATTR_FRAME, color);
/* Vertical right border */
bbox.x += borderbox.width - 1;
draw_box(term, &bbox, p[4], SCREEN_ATTR_FRAME, color);
}
if (borderbox.width > 1 && borderbox.height > 1) {
int right = borderbox.x + borderbox.width - 1;
int bottom = borderbox.y + borderbox.height - 1;
/* Upper left corner */
draw_border_char(term, borderbox.x, borderbox.y, p[0], color);
/* Upper right corner */
draw_border_char(term, right, borderbox.y, p[1], color);
/* Lower left corner */
draw_border_char(term, borderbox.x, bottom, p[2], color);
/* Lower right corner */
draw_border_char(term, right, bottom, p[3], color);
}
set_screen_dirty(term->screen, borderbox.y, borderbox.y + borderbox.height);
}
#ifdef CONFIG_UTF8
/** Checks cells left and right to the box for broken double-width chars.
* Replace it with UCS_ORPHAN_CELL.
*
* @verbatim
* 1+---+3
* 1|box|##4
* 1| |##4
* 1| |##4
* 1+---+##4
* 2#####4
* 1,2,3,4 - needs to be checked, # - shadow , +,-,| - border
* @endverbatim
*/
void
fix_dwchar_around_box(struct terminal *term, struct el_box *box, int border,
int shadow_width, int shadow_height)
{
struct screen_char *schar;
int height, x, y;
if (!term->utf8_cp)
return;
/* 1 */
x = box->x - border - 1;
if (x > 0) {
y = box->y - border;
height = box->height + 2 * border;
schar = get_char(term, x, y);
for (;height--; schar += term->width)
if (unicode_to_cell(schar->data) == 2)
schar->data = UCS_ORPHAN_CELL;
}
/* 2 */
x = box->x - border + shadow_width - 1;
if (x > 0 && x < term->width) {
y = box->y + border + box->height;
height = shadow_height;
schar = get_char(term, x, y);
for (;height--; schar += term->width)
if (unicode_to_cell(schar->data) == 2)
schar->data = UCS_ORPHAN_CELL;
}
/* 3 */
x = box->x + box->width + border;
if (x < term->width) {
y = box->y - border;
height = shadow_height;
schar = get_char(term, x, y);
for (;height--; schar += term->width)
if (schar->data == UCS_NO_CHAR)
schar->data = UCS_ORPHAN_CELL;
}
/* 4 */
x = box->x + box->width + border + shadow_width;
if (x < term->width) {
y = box->y - border + shadow_height;
height = box->height + 2 * border;
schar = get_char(term, x, y);
for (;height--; schar += term->width)
if (schar->data == UCS_NO_CHAR)
schar->data = UCS_ORPHAN_CELL;
}
}
#endif
#ifdef CONFIG_UTF8
void
draw_char(struct terminal *term, int x, int y,
unicode_val_T data, int attr,
struct color_pair *color)
#else
void
draw_char(struct terminal *term, int x, int y,
unsigned char data, int attr,
struct color_pair *color)
#endif /* CONFIG_UTF8 */
{
struct screen_char *screen_char = get_char(term, x, y);
if (!screen_char) return;
screen_char->data = data;
screen_char->attr = attr;
set_term_color(screen_char, color, 0,
get_opt_int_tree(term->spec, "colors", NULL));
set_screen_dirty(term->screen, y, y);
}
#ifdef CONFIG_UTF8
void
draw_box(struct terminal *term, struct el_box *box,
unicode_val_T data, int attr,
struct color_pair *color)
#else
void
draw_box(struct terminal *term, struct el_box *box,
unsigned char data, int attr,
struct color_pair *color)
#endif /* CONFIG_UTF8 */
{
struct screen_char *line, *pos, *end;
int width, height;
line = get_char(term, box->x, box->y);
if (!line) return;
height = int_min(box->height, term->height - box->y);
width = int_min(box->width, term->width - box->x);
if (height <= 0 || width <= 0) return;
/* Compose off the ending screen position in the areas first line. */
end = &line[width - 1];
end->attr = attr;
end->data = data;
if (color) {
set_term_color(end, color, 0,
get_opt_int_tree(term->spec, "colors", NULL));
} else {
clear_screen_char_color(end);
}
/* Draw the first area line. */
for (pos = line; pos < end; pos++) {
copy_screen_chars(pos, end, 1);
}
/* Now make @end point to the last line */
/* For the rest of the area use the first area line. */
pos = line;
while (--height) {
pos += term->width;
copy_screen_chars(pos, line, width);
}
set_screen_dirty(term->screen, box->y, box->y + box->height);
}
void
draw_shadow(struct terminal *term, struct el_box *box,
struct color_pair *color, int width, int height)
{
struct el_box dbox;
/* (horizontal) */
set_box(&dbox, box->x + width, box->y + box->height,
box->width - width, height);
draw_box(term, &dbox, ' ', 0, color);
/* (vertical) */
set_box(&dbox, box->x + box->width, box->y + height,
width, box->height);
draw_box(term, &dbox, ' ', 0, color);
}
#ifdef CONFIG_UTF8
static void
draw_text_utf8(struct terminal *term, int x, int y,
const char *text2, int length,
int attr, struct color_pair *color)
{
struct screen_char *start, *pos;
char *text = (char *)text2;
char *end = text + length;
unicode_val_T data;
assert(text && length >= 0);
if_assert_failed return;
if (length <= 0) return;
if (x >= term->width) return;
data = utf8_to_unicode(&text, end);
if (data == UCS_NO_CHAR) return;
start = get_char(term, x, y);
if (color) {
start->attr = attr;
set_term_color(start, color, 0,
get_opt_int_tree(term->spec, "colors", NULL));
}
if (start->data == UCS_NO_CHAR && x - 1 > 0)
draw_char_data(term, x - 1, y, UCS_ORPHAN_CELL);
pos = start;
if (unicode_to_cell(data) == 2) {
/* Is there enough room for whole double-width char? */
if (x + 1 < term->width) {
pos->data = data;
pos++;
x++;
pos->data = UCS_NO_CHAR;
pos->attr = 0;
} else {
pos->data = UCS_ORPHAN_CELL;
}
} else {
pos->data = data;
}
pos++;
x++;
for (; x < term->width; x++, pos++) {
data = utf8_to_unicode(&text, end);
if (data == UCS_NO_CHAR) break;
if (color) copy_screen_chars(pos, start, 1);
if (unicode_to_cell(data) == 2) {
/* Is there enough room for whole double-width char? */
if (x + 1 < term->width) {
pos->data = data;
x++;
pos++;
pos->data = UCS_NO_CHAR;
pos->attr = 0;
} else {
pos->data = UCS_ORPHAN_CELL;
}
} else {
pos->data = data;
}
}
set_screen_dirty(term->screen, y, y);
}
#endif /* CONFIG_UTF8 */
void
draw_text(struct terminal *term, int x, int y,
const char *text, int length,
int attr, struct color_pair *color)
{
int end_pos;
struct screen_char *pos, *end;
assert(text && length >= 0);
if_assert_failed return;
if (x >= term->width || y >= term->height) return;
#ifdef CONFIG_UTF8
if (term->utf8_cp) {
draw_text_utf8(term, x, y, text, length, attr, color);
return;
}
#endif /* CONFIG_UTF8 */
if (length <= 0) return;
pos = get_char(term, x, y);
if (!pos) return;
end_pos = int_min(length, term->width - x) - 1;
#ifdef CONFIG_DEBUG
/* Detect attempt to set @end to a point outside @text,
* it may occur in case of bad calculations. --Zas */
if (end_pos < 0) {
INTERNAL("end_pos < 0 !!");
end_pos = 0;
} else {
int textlen = strlen(text);
if (end_pos >= textlen) {
INTERNAL("end_pos (%d) >= text length (%d) !!", end_pos, textlen);
end_pos = textlen - 1;
}
}
#endif
end = &pos[int_max(0, end_pos)];
if (color) {
/* Use the last char as template. */
end->attr = attr;
set_term_color(end, color, 0,
get_opt_int_tree(term->spec, "colors", NULL));
for (; pos < end && *text; text++, pos++) {
end->data = *text;
copy_screen_chars(pos, end, 1);
}
end->data = *text;
} else {
for (; pos <= end && *text; text++, pos++) {
pos->data = *text;
}
}
set_screen_dirty(term->screen, y, y);
}
void
draw_dlg_text(struct dialog_data *dlg_data, int x, int y,
const char *text, int length,
int attr, struct color_pair *color)
{
struct terminal *term = dlg_data->win->term;
struct el_box *box = &dlg_data->real_box;
if (box->height) {
int y_max = box->y + box->height;
y -= dlg_data->y;
if (y < box->y || y >= y_max) return;
}
draw_text(term, x, y, text, length, attr, color);
}
void
set_cursor(struct terminal *term, int x, int y, int blockable)
{
assert(term && term->screen);
if_assert_failed return;
if (blockable && get_opt_bool_tree(term->spec, "block_cursor", NULL)) {
x = term->width - 1;
y = term->height - 1;
}
if (term->screen->cx != x || term->screen->cy != y) {
check_range(term, x, y);
set_screen_dirty(term->screen, int_min(term->screen->cy, y),
int_max(term->screen->cy, y));
term->screen->cx = x;
term->screen->cy = y;
}
}
void
set_dlg_cursor(struct terminal *term, struct dialog_data *dlg_data, int x, int y, int blockable)
{
struct el_box *box = &dlg_data->real_box;
assert(term && term->screen);
if_assert_failed return;
if (box->height) {
int y_max = box->y + box->height;
y -= dlg_data->y;
if (y < box->y || y >= y_max) return;
}
set_cursor(term, x, y, blockable);
}
void
clear_terminal(struct terminal *term)
{
struct el_box box;
int bgchar = get_opt_int("ui.background_char", NULL);
set_box(&box, 0, 0, term->width, term->height);
#ifdef CONFIG_UTF8
draw_box(term, &box, bgchar, 0, get_bfu_color(term, "desktop"));
#else
draw_box(term, &box, (unsigned char)bgchar, 0, get_bfu_color(term, "desktop"));
#endif
set_cursor(term, 0, 0, 1);
}