win_console.cpp File Reference

console functions for windows ports More...

#include "../../common/common.h"
#include "win_local.h"

Go to the source code of this file.

Data Structures
struct	sysConsole_t

Macros
#define	CONSOLE_WINDOW_STYLE   (WS_OVERLAPPED|WS_BORDER|WS_CAPTION|WS_SYSMENU|WS_MINIMIZEBOX|WS_CLIPCHILDREN|WS_GROUP)
#define	CONSOLE_WINDOW_CLASS_NAME   GAME_TITLE" Console"
#define	CONSOLE_WINDOW_NAME   CONSOLE_WINDOW_CLASS_NAME
#define	MAX_OUTPUT   32768
#define	MAX_PRINTMSG   8192

Functions
int	SV_CountPlayers (void)
	Returns the number of spawned players. More...
static void	Sys_ConsoleLoop (bool error)
	Dispatch window messages. More...
const char *	Sys_ConsoleInput (void)
	Handles input for the console window. More...
void	Sys_ConsoleOutput (const char *text)
void	Sys_Backtrace (void)
	On platforms supporting it, print a backtrace. More...
void	Sys_Error (const char *error,...)
void	Sys_ShowConsole (bool show)
static LRESULT CALLBACK	Sys_ConsoleProc (HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam)
static LONG WINAPI	Sys_ConsoleEditProc (HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam)
void	Sys_ConsoleShutdown (void)
	Shutdown the console. More...
void	Sys_ConsoleInit (void)
	Initialize the console input (tty mode if possible) More...

Variables
static sysConsole_t	sys_console

Detailed Description

console functions for windows ports

Definition in file win_console.cpp.

Macro Definition Documentation

#define CONSOLE_WINDOW_CLASS_NAME   GAME_TITLE" Console"

Definition at line 30 of file win_console.cpp.

Referenced by Sys_ConsoleInit(), and Sys_ConsoleShutdown().

#define CONSOLE_WINDOW_NAME   CONSOLE_WINDOW_CLASS_NAME

Definition at line 35 of file win_console.cpp.

Referenced by Sys_ConsoleInit().

#define CONSOLE_WINDOW_STYLE   (WS_OVERLAPPED|WS_BORDER|WS_CAPTION|WS_SYSMENU|WS_MINIMIZEBOX|WS_CLIPCHILDREN|WS_GROUP)

Definition at line 29 of file win_console.cpp.

Referenced by Sys_ConsoleInit().

#define MAX_OUTPUT   32768

Definition at line 38 of file win_console.cpp.

Referenced by Sys_ConsoleOutput().

#define MAX_PRINTMSG   8192

Definition at line 39 of file win_console.cpp.

Referenced by Sys_ConsoleOutput().

Function Documentation

int SV_CountPlayers

(

void

)

Returns the number of spawned players.

See also

SV_ShutdownWhenEmpty

Definition at line 1096 of file sv_main.cpp.

Referenced by Sys_ConsoleProc().

void Sys_Backtrace

(

void

)

On platforms supporting it, print a backtrace.

Note

For windows this is not handled here - see Sys_BacktraceInit

Definition at line 162 of file win_console.cpp.

References androidDumpBacktrace(), BUILDSTRING, Com_BreakIntoDebugger(), Com_UploadCrashDump(), CPUSTRING, FILE, Sys_Fopen(), and UFO_VERSION.

Referenced by Sys_Error().

static LONG WINAPI Sys_ConsoleEditProc ( HWND  hWnd, UINT  uMsg, WPARAM  wParam, LPARAM  lParam  )

static

Definition at line 304 of file win_console.cpp.

References sysConsole_t::cmdBuffer, Com_ConsoleCompleteCommand(), Com_Printf(), sysConsole_t::defInputProc, sysConsole_t::defOutputProc, sysConsole_t::hWndInput, and sysConsole_t::hWndOutput.

Referenced by Sys_ConsoleInit().

void Sys_ConsoleInit

(

void

)

Initialize the console input (tty mode if possible)

Definition at line 380 of file win_console.cpp.

References CONSOLE_WINDOW_CLASS_NAME, CONSOLE_WINDOW_NAME, CONSOLE_WINDOW_STYLE, sysConsole_t::defInputProc, sysConsole_t::defOutputProc, global_hInstance, sysConsole_t::hBrushInput, sysConsole_t::hBrushMsg, sysConsole_t::hBrushOutput, sysConsole_t::hFont, sysConsole_t::hFontBold, sysConsole_t::hWnd, sysConsole_t::hWndClear, sysConsole_t::hWndCopy, sysConsole_t::hWndInput, sysConsole_t::hWndMsg, sysConsole_t::hWndOutput, sysConsole_t::hWndQuit, MAXCMDLINE, Sys_BacktraceInit(), Sys_ConsoleEditProc(), Sys_ConsoleProc(), and Sys_ShowConsole().

const char* Sys_ConsoleInput

(

void

)

Handles input for the console window.

Returns

nullptr if there is no input in the input box

Definition at line 92 of file win_console.cpp.

References sysConsole_t::cmdBuffer, MAXCMDLINE, Q_strncpyz(), and Sys_ConsoleLoop().

static void Sys_ConsoleLoop ( bool  error )

static

Dispatch window messages.

Definition at line 71 of file win_console.cpp.

References Sys_Quit().

Referenced by Sys_ConsoleInput(), and Sys_Error().

void Sys_ConsoleOutput

(

const char *

text

)

Definition at line 115 of file win_console.cpp.

References sysConsole_t::hWndOutput, len, MAX_OUTPUT, MAX_PRINTMSG, and sysConsole_t::outLen.

Referenced by Sys_Error().

static LRESULT CALLBACK Sys_ConsoleProc ( HWND  hWnd, UINT  uMsg, WPARAM  wParam, LPARAM  lParam  )

static

Definition at line 229 of file win_console.cpp.

References sysConsole_t::flashColor, sysConsole_t::hBrushInput, sysConsole_t::hBrushMsg, sysConsole_t::hBrushOutput, sysConsole_t::hWnd, sysConsole_t::hWndClear, sysConsole_t::hWndCopy, sysConsole_t::hWndInput, sysConsole_t::hWndMsg, sysConsole_t::hWndOutput, sysConsole_t::hWndQuit, SV_CountPlayers(), and Sys_Quit().

Referenced by Sys_ConsoleInit().

void Sys_ConsoleShutdown

(

void

)

Shutdown the console.

Note

Never exit without calling this, or your terminal will be left in a pretty bad state

Definition at line 351 of file win_console.cpp.

References CONSOLE_WINDOW_CLASS_NAME, sysConsole_t::defInputProc, sysConsole_t::defOutputProc, global_hInstance, sysConsole_t::hBrushInput, sysConsole_t::hBrushMsg, sysConsole_t::hBrushOutput, sysConsole_t::hFont, sysConsole_t::hFontBold, sysConsole_t::hWnd, sysConsole_t::hWndInput, sysConsole_t::hWndOutput, Sys_BacktraceShutdown(), and sysConsole_t::timerActive.

void Sys_Error	(	const char *	error,
			...
	)

Definition at line 169 of file win_console.cpp.

References sysConsole_t::hWnd, sysConsole_t::hWndInput, sysConsole_t::hWndMsg, Mem_Shutdown(), Q_vsnprintf(), Sys_Backtrace(), Sys_ConsoleLoop(), Sys_ConsoleOutput(), Sys_ShowConsole(), Sys_Sleep(), and sysConsole_t::timerActive.

void Sys_ShowConsole

(

bool

show

)

Definition at line 209 of file win_console.cpp.

References sysConsole_t::hWnd, sysConsole_t::hWndInput, and sysConsole_t::hWndOutput.

Referenced by Sys_ConsoleInit(), and Sys_Error().

Variable Documentation

sysConsole_t sys_console

static

Definition at line 64 of file win_console.cpp.