8b90786fab
This is possible under DOS as well by writing to the appropriate VGA registers, and the vanilla setup tool actually does this in earlier versions to set "Romero Blue".
201 lines
6.3 KiB
C
201 lines
6.3 KiB
C
//
|
|
// Copyright(C) 2005-2014 Simon Howard
|
|
//
|
|
// This program is free software; you can redistribute it and/or
|
|
// modify it under the terms of the GNU General Public License
|
|
// as published by the Free Software Foundation; either version 2
|
|
// of the License, or (at your option) any later version.
|
|
//
|
|
// This program is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
//
|
|
// Base interface that abstracts the text mode screen.
|
|
//
|
|
|
|
#ifndef TXT_MAIN_H
|
|
#define TXT_MAIN_H
|
|
|
|
// For the moment, txt_sdl.c is the only implementation of the base
|
|
// text mode screen API:
|
|
|
|
#include "txt_sdl.h"
|
|
|
|
// textscreen key values:
|
|
// Key values are difficult because we have to support multiple conflicting
|
|
// address spaces.
|
|
// First, Doom's key constants use 0-127 as ASCII and extra values from
|
|
// 128-255 to represent special keys. Second, mouse buttons are represented
|
|
// as buttons. Finally, we want to be able to support Unicode.
|
|
//
|
|
// So we define different ranges:
|
|
// 0-255: Doom key constants, including ASCII.
|
|
// 256-511: Mouse buttons and other reserved.
|
|
// >=512: Unicode values greater than 127 are offset up into this range.
|
|
|
|
// Special keypress values that correspond to mouse button clicks
|
|
|
|
#define TXT_MOUSE_BASE 256
|
|
#define TXT_MOUSE_LEFT (TXT_MOUSE_BASE + 0)
|
|
#define TXT_MOUSE_RIGHT (TXT_MOUSE_BASE + 1)
|
|
#define TXT_MOUSE_MIDDLE (TXT_MOUSE_BASE + 2)
|
|
#define TXT_MOUSE_SCROLLUP (TXT_MOUSE_BASE + 3)
|
|
#define TXT_MOUSE_SCROLLDOWN (TXT_MOUSE_BASE + 4)
|
|
#define TXT_MAX_MOUSE_BUTTONS 16
|
|
|
|
#define TXT_KEY_TO_MOUSE_BUTTON(x) \
|
|
( (x) >= TXT_MOUSE_BASE \
|
|
&& (x) < TXT_MOUSE_BASE + TXT_MAX_MOUSE_BUTTONS ? \
|
|
(x) - TXT_MOUSE_BASE : -1 )
|
|
|
|
// Unicode offset. Unicode values from 128 onwards are offset up into
|
|
// this range, so TXT_UNICODE_BASE = Unicode character #128, and so on.
|
|
|
|
#define TXT_UNICODE_BASE 512
|
|
|
|
// Convert a key value to a Unicode character:
|
|
|
|
#define TXT_KEY_TO_UNICODE(x) \
|
|
( (x) < 128 ? (x) : \
|
|
(x) >= TXT_UNICODE_BASE ? ((x) - TXT_UNICODE_BASE + 128) : 0 )
|
|
|
|
// Convert a Unicode character to a key value:
|
|
|
|
#define TXT_UNICODE_TO_KEY(u) \
|
|
( (u) < 128 ? (u) : ((u) - 128 + TXT_UNICODE_BASE) )
|
|
|
|
// Screen size
|
|
|
|
#define TXT_SCREEN_W 80
|
|
#define TXT_SCREEN_H 25
|
|
|
|
#define TXT_COLOR_BLINKING (1 << 3)
|
|
|
|
typedef enum
|
|
{
|
|
TXT_COLOR_BLACK,
|
|
TXT_COLOR_BLUE,
|
|
TXT_COLOR_GREEN,
|
|
TXT_COLOR_CYAN,
|
|
TXT_COLOR_RED,
|
|
TXT_COLOR_MAGENTA,
|
|
TXT_COLOR_BROWN,
|
|
TXT_COLOR_GREY,
|
|
TXT_COLOR_DARK_GREY,
|
|
TXT_COLOR_BRIGHT_BLUE,
|
|
TXT_COLOR_BRIGHT_GREEN,
|
|
TXT_COLOR_BRIGHT_CYAN,
|
|
TXT_COLOR_BRIGHT_RED,
|
|
TXT_COLOR_BRIGHT_MAGENTA,
|
|
TXT_COLOR_YELLOW,
|
|
TXT_COLOR_BRIGHT_WHITE,
|
|
} txt_color_t;
|
|
|
|
// Modifier keys.
|
|
|
|
typedef enum
|
|
{
|
|
TXT_MOD_SHIFT,
|
|
TXT_MOD_CTRL,
|
|
TXT_MOD_ALT,
|
|
TXT_NUM_MODIFIERS
|
|
} txt_modifier_t;
|
|
|
|
// Due to the way the SDL API works, we provide different ways of configuring
|
|
// how we read input events, each of which is useful in different scenarios.
|
|
typedef enum
|
|
{
|
|
// "Localized" output that takes software keyboard layout into account,
|
|
// but key shifting has no effect.
|
|
TXT_INPUT_NORMAL,
|
|
|
|
// "Raw" input; the keys correspond to physical keyboard layout and
|
|
// software keyboard layout has no effect.
|
|
TXT_INPUT_RAW,
|
|
|
|
// Used for full text input. Events are fully shifted and localized.
|
|
// However, not all keyboard keys will generate input.
|
|
// Setting this mode may activate the on-screen keyboard, depending on
|
|
// device and OS.
|
|
TXT_INPUT_TEXT,
|
|
} txt_input_mode_t;
|
|
|
|
|
|
#ifdef __GNUC__
|
|
|
|
#define PRINTF_ATTR(fmt, first) __attribute__((format(printf, fmt, first)))
|
|
|
|
#else // __GNUC__
|
|
|
|
#define PRINTF_ATTR(fmt, first)
|
|
|
|
#endif // __GNUC__
|
|
|
|
// Initialize the screen
|
|
// Returns 1 if successful, 0 if failed.
|
|
int TXT_Init(void);
|
|
|
|
// Shut down text mode emulation
|
|
void TXT_Shutdown(void);
|
|
|
|
// Get a pointer to the buffer containing the raw screen data.
|
|
unsigned char *TXT_GetScreenData(void);
|
|
|
|
// Update an area of the screen
|
|
void TXT_UpdateScreenArea(int x, int y, int w, int h);
|
|
|
|
// Update the whole screen
|
|
void TXT_UpdateScreen(void);
|
|
|
|
// Set the RGB value for a particular entry in the color palette:
|
|
void TXT_SetColor(txt_color_t color, int r, int g, int b);
|
|
|
|
// Read a character from the keyboard
|
|
int TXT_GetChar(void);
|
|
|
|
// Given a Unicode character, get a character that can be used to represent
|
|
// it on the code page being displayed on the screen. If the character cannot
|
|
// be represented, this returns -1.
|
|
int TXT_UnicodeCharacter(unsigned int c);
|
|
|
|
// Read the current state of modifier keys that are held down.
|
|
int TXT_GetModifierState(txt_modifier_t mod);
|
|
|
|
// Provides a short description of a key code, placing into the provided
|
|
// buffer. Note that the key is assumed to represent a physical key on the
|
|
// keyboard (like that returned by TXT_INPUT_RAW), and the resulting string
|
|
// takes keyboard layout into consideration. For example,
|
|
// TXT_GetKeyDescription('q') on a French keyboard returns "A".
|
|
// The contents of the filled buffer will be in UTF-8 format, but will never
|
|
// contain characters which can't be shown on the screen.
|
|
void TXT_GetKeyDescription(int key, char *buf, size_t buf_len);
|
|
|
|
// Retrieve the current position of the mouse
|
|
void TXT_GetMousePosition(int *x, int *y);
|
|
|
|
// Sleep until an event is received or the screen needs updating
|
|
// Optional timeout in ms (timeout == 0 : sleep forever)
|
|
void TXT_Sleep(int timeout);
|
|
|
|
// Change mode for text input.
|
|
void TXT_SetInputMode(txt_input_mode_t mode);
|
|
|
|
// Set the window title of the window containing the text mode screen
|
|
void TXT_SetWindowTitle(const char *title);
|
|
|
|
// Safe string copy.
|
|
void TXT_StringCopy(char *dest, const char *src, size_t dest_len);
|
|
|
|
// Safe string concatenate.
|
|
void TXT_StringConcat(char *dest, const char *src, size_t dest_len);
|
|
|
|
// Safe version of vsnprintf().
|
|
int TXT_vsnprintf(char *buf, size_t buf_len, const char *s, va_list args);
|
|
|
|
// Safe version of snprintf().
|
|
int TXT_snprintf(char *buf, size_t buf_len, const char *s, ...) PRINTF_ATTR(3, 4);
|
|
|
|
#endif /* #ifndef TXT_MAIN_H */
|
|
|