You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
179 lines
3.7 KiB
179 lines
3.7 KiB
#ifndef SCREEN_H
|
|
#define SCREEN_H
|
|
|
|
#include <stdint.h>
|
|
#include <stdbool.h>
|
|
#include <esp8266.h>
|
|
#include <httpd.h>
|
|
|
|
/**
|
|
* This module handles the virtual screen and operations on it.
|
|
*
|
|
* It is interfaced by calls from the ANSI parser, and the screen
|
|
* data can be rendered for the front-end.
|
|
*
|
|
* ---
|
|
*
|
|
* Colors are 0-15, 0-7 dim, 8-15 bright.
|
|
*
|
|
* NORMAL
|
|
* 0 black, 1 red, 2 green, 3 yellow
|
|
* 4 blue, 5 mag, 6 cyan, 7 white
|
|
*
|
|
* BRIGHT
|
|
* 8 black, 9 red, 10 green, 11 yellow
|
|
* 12 blue, 13 mag, 14 cyan, 15 white
|
|
*
|
|
* ints are 0-based, left-top is the origin.
|
|
* X grows to the right, Y to the bottom.
|
|
*
|
|
* +---->
|
|
* | X
|
|
* |
|
|
* V Y
|
|
*
|
|
*/
|
|
|
|
// Size designed for the wifi config structure
|
|
// Must be constant to avoid corrupting user config after upgrade
|
|
#define TERMCONF_SIZE 200
|
|
|
|
#define TERM_BTN_LEN 10
|
|
#define TERM_TITLE_LEN 64
|
|
|
|
typedef struct {
|
|
u32 width;
|
|
u32 height;
|
|
u8 default_bg;
|
|
u8 default_fg;
|
|
char title[TERM_TITLE_LEN];
|
|
char btn1[TERM_BTN_LEN];
|
|
char btn2[TERM_BTN_LEN];
|
|
char btn3[TERM_BTN_LEN];
|
|
char btn4[TERM_BTN_LEN];
|
|
char btn5[TERM_BTN_LEN];
|
|
|
|
u8 _filler[
|
|
TERMCONF_SIZE
|
|
- 4
|
|
- 4
|
|
- 1
|
|
- 1
|
|
- TERM_TITLE_LEN
|
|
- TERM_BTN_LEN * 5
|
|
];
|
|
|
|
} TerminalConfigBundle;
|
|
|
|
// Live config
|
|
extern TerminalConfigBundle * const termconf;
|
|
|
|
/**
|
|
* Transient live config with no persist, can be modified via esc sequences.
|
|
* terminal_apply_settings() copies termconf to this struct, erasing old scratch changes
|
|
*/
|
|
extern TerminalConfigBundle termconf_scratch;
|
|
|
|
void terminal_restore_defaults(void);
|
|
void terminal_apply_settings(void);
|
|
|
|
/**
|
|
* Maximum screen size (determines size of the static data array)
|
|
*
|
|
* TODO May need adjusting if there are size problems when flashing the ESP.
|
|
* We could also try to pack the Cell struct to a single 32bit word.
|
|
*/
|
|
#define MAX_SCREEN_SIZE (80*25)
|
|
|
|
typedef enum {
|
|
CLEAR_TO_CURSOR=0, CLEAR_FROM_CURSOR=1, CLEAR_ALL=2
|
|
} ClearMode;
|
|
|
|
typedef uint8_t Color;
|
|
|
|
httpd_cgi_state screenSerializeToBuffer(char *buffer, size_t buf_len, void **data);
|
|
|
|
/** Init the screen */
|
|
void screen_init(void);
|
|
|
|
/** Change the screen size */
|
|
void screen_resize(int rows, int cols);
|
|
|
|
/** Check if coord is valid */
|
|
bool screen_isCoordValid(int y, int x);
|
|
|
|
// --- Clearing ---
|
|
|
|
/** Screen reset to default state */
|
|
void screen_reset(void);
|
|
|
|
/** Clear entire screen, set all to 7 on 0 */
|
|
void screen_clear(ClearMode mode);
|
|
|
|
/** Line reset to gray-on-white, empty */
|
|
void screen_clear_line(ClearMode mode);
|
|
|
|
/** Shift screen upwards */
|
|
void screen_scroll_up(unsigned int lines);
|
|
|
|
/** Shift screen downwards */
|
|
void screen_scroll_down(unsigned int lines);
|
|
|
|
// --- Cursor control ---
|
|
|
|
/** Set cursor position */
|
|
void screen_cursor_set(int y, int x);
|
|
|
|
/** Read cursor pos to given vars */
|
|
void screen_cursor_get(int *y, int *x);
|
|
|
|
/** Set cursor X position */
|
|
void screen_cursor_set_x(int x);
|
|
|
|
/** Set cursor Y position */
|
|
void screen_cursor_set_y(int y);
|
|
|
|
/** Relative cursor move */
|
|
void screen_cursor_move(int dy, int dx);
|
|
|
|
/** Save the cursor pos */
|
|
void screen_cursor_save(bool withAttrs);
|
|
|
|
/** Restore the cursor pos */
|
|
void screen_cursor_restore(bool withAttrs);
|
|
|
|
/** Enable cursor display */
|
|
void screen_cursor_enable(bool enable);
|
|
|
|
/** Enable auto wrap */
|
|
void screen_wrap_enable(bool enable);
|
|
|
|
// --- Colors ---
|
|
|
|
/** Set cursor foreground color */
|
|
void screen_set_fg(Color color);
|
|
|
|
/** Set cursor background coloor */
|
|
void screen_set_bg(Color color);
|
|
|
|
/** make foreground bright */
|
|
void screen_set_bright_fg(void);
|
|
|
|
/** Set cursor foreground and background color */
|
|
void screen_set_colors(Color fg, Color bg);
|
|
|
|
/** Invert colors */
|
|
void screen_inverse(bool inverse);
|
|
|
|
|
|
/** Set a character in the cursor color, move to right with wrap. */
|
|
void screen_putchar(char c);
|
|
|
|
#if 0
|
|
/** Debug dump */
|
|
void screen_dd(void);
|
|
#endif
|
|
|
|
extern void screen_notifyChange(void);
|
|
|
|
#endif // SCREEN_H
|
|
|