raze/source/build/include/osd.h

295 lines
7 KiB
C

// On-screen display (ie. console)
// for the Build Engine
// by Jonathon Fowler (jf@jonof.id.au)
#ifndef osd_h_
#define osd_h_
#include <functional>
#include "compat.h"
#include "mutex.h"
struct osdfuncparm_t
{
int32_t numparms;
const char* name;
const char** parms;
const char* raw;
};
using osdcmdptr_t = osdfuncparm_t const * const;
const char *OSD_StripColors(char *outBuf, const char *inBuf);
#define OSDDEFAULTMAXLINES 128
#define OSDEDITLENGTH 512
#define OSDMINHISTORYDEPTH 32
#define OSDMAXHISTORYDEPTH 256
#define OSDBUFFERSIZE 32768
#define OSDDEFAULTROWS 20
#define OSDDEFAULTCOLS 60
#define OSDLOGCUTOFF 131072
#define OSDMAXSYMBOLS 512
enum cvartype_t
{
CVAR_FLOAT = 0x00000001,
CVAR_INT = 0x00000002,
CVAR_UINT = 0x00000004,
CVAR_BOOL = 0x00000008,
CVAR_STRING = 0x00000010,
CVAR_DOUBLE = 0x00000020,
CVAR_READONLY = 0x00000040,
CVAR_MULTI = 0x00000080,
CVAR_FUNCPTR = 0x00000200,
CVAR_RESTARTVID = 0x00000400,
CVAR_INVALIDATEALL = 0x00000800,
CVAR_INVALIDATEART = 0x00001000,
CVAR_MODIFIED = 0x00002000,
CVAR_TYPEMASK = CVAR_FLOAT | CVAR_DOUBLE | CVAR_INT | CVAR_UINT | CVAR_BOOL | CVAR_STRING
};
typedef struct _symbol
{
const char *name;
struct _symbol *next;
const char *help;
int32_t(*func)(osdcmdptr_t);
} osdsymbol_t;
typedef struct
{
const char *name;
const char *desc;
union
{
void * ptr;
int32_t * i32;
uint32_t * u32;
float * f;
double * d;
char *const string;
};
uint32_t flags; // see cvartype_t
int32_t const min;
int32_t const max; // for string, is the length
} osdcvardata_t;
typedef struct
{
osdcvardata_t *pData;
// default value for cvar, assigned when var is registered
union
{
int32_t i32;
uint32_t u32;
float f;
double d;
} defaultValue;
} osdcvar_t;
// version string
typedef struct
{
char *buf;
uint8_t len;
uint8_t shade;
uint8_t pal;
} osdstr_t;
// command prompt editing
typedef struct
{
char *buf; // [OSDEDITLENGTH+1]; // editing buffer
char *tmp; // [OSDEDITLENGTH+1]; // editing buffer temporary workspace
int16_t len, pos; // length of characters and position of cursor in buffer
int16_t start, end;
} osdedit_t;
// main text buffer
typedef struct
{
// each character in the buffer also has a format byte containing shade and color
char *buf;
char *fmt;
int32_t pos; // position next character will be written at
int32_t lines; // total number of lines in buffer
int32_t maxlines; // max lines in buffer
} osdtext_t;
// history display
typedef struct
{
char *buf[OSDMAXHISTORYDEPTH];
int32_t maxlines; // max entries in buffer, ranges from OSDMINHISTORYDEPTH to OSDMAXHISTORYDEPTH
int32_t pos; // current buffer position
int32_t lines; // entries currently in buffer
int32_t total; // total number of entries
int32_t exec; // number of lines from the head of the history buffer to execute
} osdhist_t;
// active display parameters
typedef struct
{
char const *errorfmt;
char const *highlight;
int32_t promptshade, promptpal;
int32_t editshade, editpal;
int32_t textshade, textpal;
int32_t mode;
int32_t rows; // # lines of the buffer that are visible
int32_t cols; // width of onscreen display in text columns
uint16_t head; // topmost visible line number
int8_t scrolling;
} osddraw_t;
typedef struct
{
FILE *fp;
int32_t cutoff;
int32_t errors;
int32_t lines;
} osdlog_t;
typedef struct
{
osdtext_t text;
osdedit_t editor;
osdhist_t history;
osddraw_t draw;
osdstr_t version;
uint32_t flags; // controls initialization, etc
osdcvar_t *cvars;
int32_t numcvars;
osdsymbol_t *symbols;
osdsymbol_t *symbptrs[OSDMAXSYMBOLS];
int32_t numsymbols;
int32_t execdepth; // keeps track of nested execution
mutex_t mutex;
int32_t keycode;
osdlog_t log;
} osdmain_t;
extern osdmain_t *osd;
extern FILE * osdlog;
extern const char* osdlogfn;
enum osdflags_t
{
// OSD_INITIALIZED = 0x00000001,
OSD_DRAW = 0x00000002,
OSD_CAPTURE = 0x00000004,
OSD_OVERTYPE = 0x00000008,
OSD_SHIFT = 0x00000010,
OSD_CTRL = 0x00000020,
OSD_CAPS = 0x00000040,
OSD_PROTECTED = 0x00000080,
};
#define OSD_ALIAS (int (*)(osdcmdptr_t))0x1337
#define OSD_UNALIASED (int (*)(osdcmdptr_t))0xDEAD
#define OSDCMD_OK 0
#define OSDCMD_SHOWHELP 1
int OSD_ParsingScript(void);
int OSD_OSDKey(void);
int OSD_GetTextMode(void);
void OSD_SetTextMode(int mode);
int OSD_Exec(const char *szScript);
// Get shade and pal index from the OSD format buffer.
void OSD_GetShadePal(const char *ch, int *shd, int *pal);
int OSD_GetCols(void);
int OSD_IsMoving(void);
int OSD_GetRowsCur(void);
// initializes things
void OSD_Init(void);
// cleans things up. these comments are retarded.
void OSD_Cleanup(void);
// sets the file to echo output to
void OSD_SetLogFile(const char *fn);
// sets the parameters for presenting the text
void OSD_SetParameters(int promptShade, int promptPal, int editShade, int editPal, int textShade, int textPal,
char const *errorStr, char const *highlight, uint32_t flags);
// sets the scancode for the key which activates the onscreen display
void OSD_CaptureKey(uint8_t scanCode);
// handles keyboard input when capturing input. returns 0 if key was handled
// or the scancode if it should be handled by the game.
int OSD_HandleScanCode(uint8_t scanCode, int keyDown);
int OSD_HandleChar(char ch);
// handles the readjustment when screen resolution changes
void OSD_ResizeDisplay(int w,int h);
// captures and frees osd input
void OSD_CaptureInput(int cap);
// sets the console version string
void OSD_SetVersion(const char *pszVersion, int osdShade, int osdPal);
// shows or hides the onscreen display
void OSD_ShowDisplay(int onf);
// draw the osd to the screen
void OSD_Draw(void);
// just like printf
void OSD_Printf(const char *fmt, ...) ATTRIBUTE((format(printf,1,2)));
// just like puts
void OSD_Puts(const char *str);
// executes buffered commands
void OSD_DispatchQueued(void);
// executes a string
void OSD_Dispatch(const char *cmd);
// registers a function
// name = name of the function
// help = a short help string
// func = the entry point to the function
int OSD_RegisterFunction(const char *pszName, const char *pszDesc, int (*func)(osdcmdptr_t));
int osdcmd_cvar_set(osdcmdptr_t parm);
void OSD_RegisterCvar(osdcvardata_t * cvar, int (*func)(osdcmdptr_t));
static inline void OSD_SetHistory(int idx, const char *src)
{
osd->history.buf[idx] = (char *)malloc(OSDEDITLENGTH);
strncpy(osd->history.buf[idx], src, OSDEDITLENGTH);
}
extern int osdcmd_restartvid(osdcmdptr_t parm);
extern void M32RunScript(const char *s);
#endif // osd_h_