ReC98/pc98.h

// ReC98
// -----
// PC-98 hardware constants not covered by master.lib

/// Spaces
/// ------
/// These don't necessarily have to be relative to the top-left corner of the
/// display.

// Display-space widths, heights, and object-space coordinates
typedef int pixel_t;
typedef unsigned int upixel_t;

// VRAM widths and object-space coordinates
typedef int vram_byte_amount_t;
typedef int vram_word_amount_t;
typedef int vram_dword_amount_t;
/// ------

/// Coordinate systems
/// ------------------
/// All of these are relative to the top-left corner of the final display.
/// MODDERS: Remove the unsigned varieties.

// Display-space coordinate, with [0; RES_X[ being the visible area.
typedef int screen_x_t;
typedef unsigned int uscreen_x_t;
// Display-space coordinate, with [0; RES_Y[ being the visible area. Does not
// care about 200- or 400-line graphics modes or vertical scrolling.
typedef int screen_y_t;
typedef unsigned int uscreen_y_t;

// VRAM X coordinate, ranging from 0 to (RES_X / BYTE_DOTS).
typedef int vram_x_t;
// VRAM Y coordinate, ranging from 0 to either 400 or 200 depending on the
// current graphics mode, and with an added vertical scrolling offset.
typedef int vram_y_t;
typedef unsigned int uvram_y_t;

// Text RAM X coordinate, ranging from 0 to (RES_X / GLYPH_HALF_W).
typedef int tram_x_t;
typedef unsigned int utram_x_t;
// Text RAM Y coordinate, ranging from 0 to (RES_Y / GLYPH_H).
typedef int tram_y_t;
typedef unsigned int utram_y_t;
/// ------------------

/// Text
/// ----
#define GAIJI_W 16
#define GAIJI_TRAM_W (GAIJI_W / 8)
#define GLYPH_HALF_W 8
#define GLYPH_FULL_W 16
#define GLYPH_H 16
/// ----

/// Graphics
/// --------
#define BYTE_DOTS 8
#define RES_X 640
#define RES_Y 400
#define ROW_SIZE (RES_X / BYTE_DOTS)
#define PLANE_SIZE (ROW_SIZE * RES_Y)

typedef bool page_t;

#define COLOR_COUNT 16

// The 16-color mode supports 4 bits per RGB component, for a total of
// 4,096 colors
typedef int8_t uint4_t;

#ifdef __cplusplus
	template <class ComponentType, int Range> union RGB {
		struct {
			ComponentType r, g, b;
		} c;
		ComponentType v[3];

		// Yes, we actually need this function in certain cases where code
		// generation calls for a 0 in the ComponentType.
		static ComponentType min() {
			return 0;
		}
		static ComponentType max() {
			return (Range - 1);
		}
	};

	template <class RGBType> struct Palette {
		RGBType colors[COLOR_COUNT];

		static int range() {
			return RGBType::Range;
		}

		RGBType& operator [](int col) {
			return colors[col];
		}

		const RGBType& operator [](int col) const {
			return colors[col];
		}
	};

	typedef RGB<uint4_t, 16> RGB4;
	typedef Palette<RGB4> Palette4;
#endif
/// --------

/// Memory segments
/// ---------------
#define SEG_PLANE_B 0xA800
#define SEG_PLANE_R 0xB000
#define SEG_PLANE_G 0xB800
#define SEG_PLANE_E 0xE000

// Segment distance between B↔R↔G
#define SEG_PLANE_DIST_BRG 0x800
// Segment distance between G↔E
#define SEG_PLANE_DIST_E 0x2800
/// ---------------

/// Keyboard
/// --------
typedef enum {
	K0_ESC = 0x01,
	K0_1 = 0x02,
	K0_2 = 0x04,
	K0_3 = 0x08,
	K0_4 = 0x10,
	K0_5 = 0x20,
	K0_6 = 0x40,
	K0_7 = 0x80
} keygroup_0;

typedef enum {
	K1_8 = 0x01,
	K1_9 = 0x02,
	K1_0 = 0x04,
	K1_MINUS = 0x08,
	K1_CIRCUMFLEX = 0x10,
	K1_YEN = 0x20,
	K1_BACKSPACE = 0x40,
	K1_TAB = 0x80
} keygroup_1;

typedef enum {
	K2_Q = 0x01,
	K2_W = 0x02,
	K2_E = 0x04,
	K2_R = 0x08,
	K2_T = 0x10,
	K2_Y = 0x20,
	K2_U = 0x40,
	K2_I = 0x80
} keygroup_2;

typedef enum {
	K3_O = 0x01,
	K3_P = 0x02,
	K3_AT = 0x04,
	K3_LBRACKET = 0x08,
	K3_RETURN = 0x10,
	K3_A = 0x20,
	K3_S = 0x40,
	K3_D = 0x80
} keygroup_3;

typedef enum {
	K4_F = 0x01,
	K4_G = 0x02,
	K4_H = 0x04,
	K4_J = 0x08,
	K4_K = 0x10,
	K4_L = 0x20,
	K4_PLUS = 0x40,
	K4_ASTERISK = 0x80
} keygroup_4;

typedef enum {
	K5_RBRACKET = 0x01,
	K5_Z = 0x02,
	K5_X = 0x04,
	K5_C = 0x08,
	K5_V = 0x10,
	K5_B = 0x20,
	K5_N = 0x40,
	K5_M = 0x80
} keygroup_5;

typedef enum {
	K6_COMMA = 0x01,
	K6_PERIOD = 0x02,
	K6_SLASH = 0x04,
	K6_UNDERSCORE = 0x08,
	K6_SPACE = 0x10,
	K6_XFER = 0x20,
	K6_ROLL_UP = 0x40,
	K6_ROLL_DOWN = 0x80
} keygroup_6;

typedef enum {
	K7_INS = 0x01,
	K7_DEL = 0x02,
	K7_ARROW_UP = 0x04,
	K7_ARROW_LEFT = 0x08,
	K7_ARROW_RIGHT = 0x10,
	K7_ARROW_DOWN = 0x20,
	K7_HOME_CLR = 0x40,
	K7_END = 0x80
} keygroup_7;

typedef enum {
	K8_NUM_MINUS = 0x01,
	K8_NUM_DIV = 0x02,
	K8_NUM_7 = 0x04,
	K8_NUM_8 = 0x08,
	K8_NUM_9 = 0x10,
	K8_NUM_MUL = 0x20,
	K8_NUM_4 = 0x40,
	K8_NUM_5 = 0x80
} keygroup_8;

typedef enum {
	K9_NUM_6 = 0x01,
	K9_NUM_PLUS = 0x02,
	K9_NUM_1 = 0x04,
	K9_NUM_2 = 0x08,
	K9_NUM_3 = 0x10,
	K9_NUM_EQUALS = 0x20,
	K9_NUM_0 = 0x40,
	K9_NUM_COMMA = 0x80
} keygroup_9;

typedef enum {
	K10_NUM_PERIOD = 0x01,
	K10_NFER = 0x02,
	K10_VF1 = 0x04,
	K10_VF2 = 0x08,
	K10_VF3 = 0x10,
	K10_VF4 = 0x20,
	K10_VF5 = 0x40
} keygroup_10;

typedef enum {
	K11_NUM = 0x02,

	// Couldn't find any info whatsoever on the next three, but they're
	// listed in MEMSYS.TXT, so...
	K11_SYMBOL_SHIFT = 0x04,
	K11_VOWEL_SHIFT = 0x08,
	K11_CONSONANT_SHIFT = 0x10,

	K11_HOME = 0x40
} keygroup_11;

typedef enum {
	K12_STOP = 0x01,
	K12_COPY = 0x02,
	K12_F1 = 0x04,
	K12_F2 = 0x08,
	K12_F3 = 0x10,
	K12_F4 = 0x20,
	K12_F5 = 0x40,
	K12_F6 = 0x80
} keygroup_12;

typedef enum {
	K13_F7 = 0x01,
	K13_F8 = 0x02,
	K13_F9 = 0x04,
	K13_F10 = 0x08
} keygroup_13;

typedef enum {
	K14_SHIFT = 0x01,
	K14_CAPS = 0x02,
	K14_KANA = 0x04,
	K14_GRPH = 0x08,
	K14_CTRL = 0x10
} keygroup_14;
/// --------