3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "table/strings.h"

     6

#include "functions.h"

     7

#include "window.h"

     8

#include "gui.h"

     9

#include "gfx.h"

    10

#include "player.h"

    11

#include "variables.h"

    12

#include "string.h"

    13

#include "hal.h"

    14

#include <stdarg.h>

    15

#include <string.h>

    16

#include "console.h"

    17

#include "network.h"

    18

#include "network_data.h"

    19

#include "network_server.h"

    20

    21

#define ICON_BUFFER 79

    22

#define ICON_HISTORY_SIZE 20

    23

#define ICON_LINE_HEIGHT 12

    24

#define ICON_RIGHT_BORDERWIDTH 10

    25

#define ICON_BOTTOM_BORDERWIDTH 12

    26

#define ICON_MAX_ALIAS_LINES 40

    27

#define ICON_TOKEN_COUNT 20

    28

    29

// ** main console ** //

    30

static Window *_iconsole_win; // Pointer to console window

    31

static bool _iconsole_inited;

    32

static char *_iconsole_buffer[ICON_BUFFER + 1];

    33

static uint16 _iconsole_cbuffer[ICON_BUFFER + 1];

    34

static Textbuf _iconsole_cmdline;

    35

static byte _iconsole_scroll;

    36

    37

// ** stdlib ** //

    38

byte _stdlib_developer = 1;

    39

bool _stdlib_con_developer = false;

    40

FILE *_iconsole_output_file;

    41

    42

// ** main console cmd buffer

    43

static char *_iconsole_history[ICON_HISTORY_SIZE];

    44

static byte _iconsole_historypos;

    45

    46

/* *************** */

    47

/*  end of header  */

    48

/* *************** */

    49

    50

static void IConsoleClearCommand(void)

    51

{

    52

	memset(_iconsole_cmdline.buf, 0, ICON_CMDLN_SIZE);

    53

	_iconsole_cmdline.length = 0;

    54

	_iconsole_cmdline.width = 0;

    55

	_iconsole_cmdline.caretpos = 0;

    56

	_iconsole_cmdline.caretxoffs = 0;

    57

	SetWindowDirty(_iconsole_win);

    58

}

    59

    60

static inline void IConsoleResetHistoryPos(void) {_iconsole_historypos = ICON_HISTORY_SIZE - 1;}

    61

    62

// ** console window ** //

    63

static void IConsoleWndProc(Window* w, WindowEvent* e)

    64

{

    65

	switch (e->event) {

    66

		case WE_PAINT: {

    67

			int i = _iconsole_scroll;

    68

			int max = (w->height / ICON_LINE_HEIGHT) - 1;

    69

			int delta = 0;

    70

			GfxFillRect(w->left, w->top, w->width, w->height - 1, 0);

    71

			while ((i > 0) && (i > _iconsole_scroll - max) && (_iconsole_buffer[i] != NULL)) {

    72

				DoDrawString(_iconsole_buffer[i], 5,

    73

					w->height - (_iconsole_scroll + 2 - i) * ICON_LINE_HEIGHT, _iconsole_cbuffer[i]);

    74

				i--;

    75

			}

    76

			/* If the text is longer than the window, don't show the starting ']' */

    77

			delta = w->width - 10 - _iconsole_cmdline.width - ICON_RIGHT_BORDERWIDTH;

    78

			if (delta > 0) {

    79

				DoDrawString("]", 5, w->height - ICON_LINE_HEIGHT, _icolour_cmd);

    80

				delta = 0;

    81

			}

    82

    83

			DoDrawString(_iconsole_cmdline.buf, 10 + delta, w->height - ICON_LINE_HEIGHT, _icolour_cmd);

    84

    85

			if (_iconsole_cmdline.caret)

    86

				DoDrawString("_", 10 + delta + _iconsole_cmdline.caretxoffs, w->height - ICON_LINE_HEIGHT, 12);

    87

			break;

    88

		}

    89

		case WE_MOUSELOOP:

    90

			if (HandleCaret(&_iconsole_cmdline))

    91

				SetWindowDirty(w);

    92

			break;

    93

		case WE_DESTROY:

    94

			_iconsole_win = NULL;

    95

			_iconsole_mode = ICONSOLE_CLOSED;

    96

			break;

    97

		case WE_KEYPRESS:

    98

			e->keypress.cont = false;

    99

			switch (e->keypress.keycode) {

   100

				case WKC_UP:

   101

					IConsoleHistoryNavigate(+1);

   102

					SetWindowDirty(w);

   103

					break;

   104

				case WKC_DOWN:

   105

					IConsoleHistoryNavigate(-1);

   106

					SetWindowDirty(w);

   107

					break;

   108

				case WKC_SHIFT | WKC_PAGEUP:

   109

					if (_iconsole_scroll - (w->height / ICON_LINE_HEIGHT) - 1 < 0)

   110

						_iconsole_scroll = 0;

   111

					else

   112

						_iconsole_scroll -= (w->height / ICON_LINE_HEIGHT) - 1;

   113

					SetWindowDirty(w);

   114

					break;

   115

				case WKC_SHIFT | WKC_PAGEDOWN:

   116

					if (_iconsole_scroll + (w->height / ICON_LINE_HEIGHT) - 1 > ICON_BUFFER)

   117

						_iconsole_scroll = ICON_BUFFER;

   118

					else

   119

						_iconsole_scroll += (w->height / ICON_LINE_HEIGHT) - 1;

   120

					SetWindowDirty(w);

   121

					break;

   122

				case WKC_SHIFT | WKC_UP:

   123

					if (_iconsole_scroll <= 0)

   124

						_iconsole_scroll = 0;

   125

					else

   126

						--_iconsole_scroll;

   127

					SetWindowDirty(w);

   128

					break;

   129

				case WKC_SHIFT | WKC_DOWN:

   130

					if (_iconsole_scroll >= ICON_BUFFER)

   131

						_iconsole_scroll = ICON_BUFFER;

   132

					else

   133

						++_iconsole_scroll;

   134

					SetWindowDirty(w);

   135

					break;

   136

				case WKC_BACKQUOTE:

   137

					IConsoleSwitch();

   138

					break;

   139

				case WKC_RETURN: case WKC_NUM_ENTER:

   140

					IConsolePrintF(_icolour_cmd, "] %s", _iconsole_cmdline.buf);

   141

					IConsoleHistoryAdd(_iconsole_cmdline.buf);

   142

   143

					IConsoleCmdExec(_iconsole_cmdline.buf);

   144

					IConsoleClearCommand();

   145

					break;

   146

				case WKC_CTRL | WKC_RETURN:

   147

					_iconsole_mode = (_iconsole_mode == ICONSOLE_FULL) ? ICONSOLE_OPENED : ICONSOLE_FULL;

   148

					IConsoleResize();

   149

					MarkWholeScreenDirty();

   150

					break;

   151

				case (WKC_CTRL | 'V'):

   152

					if (InsertTextBufferClipboard(&_iconsole_cmdline)) {

   153

						IConsoleResetHistoryPos();

   154

						SetWindowDirty(w);

   155

					}

   156

					break;

   157

				case (WKC_CTRL | 'L'):

   158

					IConsoleCmdExec("clear");

   159

					break;

   160

				case (WKC_CTRL | 'U'):

   161

					DeleteTextBufferAll(&_iconsole_cmdline);

   162

					SetWindowDirty(w);

   163

					break;

   164

				case WKC_BACKSPACE: case WKC_DELETE:

   165

					if (DeleteTextBufferChar(&_iconsole_cmdline, e->keypress.keycode)) {

   166

						IConsoleResetHistoryPos();

   167

						SetWindowDirty(w);

   168

					}

   169

					break;

   170

				case WKC_LEFT: case WKC_RIGHT: case WKC_END: case WKC_HOME:

   171

					if (MoveTextBufferPos(&_iconsole_cmdline, e->keypress.keycode)) {

   172

						IConsoleResetHistoryPos();

   173

						SetWindowDirty(w);

   174

					}

   175

					break;

   176

				default:

   177

					if (IsValidAsciiChar(e->keypress.ascii)) {

   178

						_iconsole_scroll = ICON_BUFFER;

   179

						InsertTextBufferChar(&_iconsole_cmdline, e->keypress.ascii);

   180

						IConsoleResetHistoryPos();

   181

						SetWindowDirty(w);

   182

					} else

   183

						e->keypress.cont = true;

   184

			break;

   185

		}

   186

	}

   187

}

   188

   189

static const Widget _iconsole_window_widgets[] = {

   190

	{WIDGETS_END}

   191

};

   192

   193

static const WindowDesc _iconsole_window_desc = {

   194

	0, 0, 2, 2,

   195

	WC_CONSOLE, 0,

   196

	WDF_STD_TOOLTIPS | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS,

   197

	_iconsole_window_widgets,

   198

	IConsoleWndProc,

   199

};

   200

   201

void IConsoleInit(void)

   202

{

   203

	extern const char _openttd_revision[];

   204

	_iconsole_output_file = NULL;

   205

	_icolour_def  =  1;

   206

	_icolour_err  =  3;

   207

	_icolour_warn = 13;

   208

	_icolour_dbg  =  5;

   209

	_icolour_cmd  =  2;

   210

	_iconsole_scroll = ICON_BUFFER;

   211

	_iconsole_historypos = ICON_HISTORY_SIZE - 1;

   212

	_iconsole_inited = true;

   213

	_iconsole_mode = ICONSOLE_CLOSED;

   214

	_iconsole_win = NULL;

   215

   216

#ifdef ENABLE_NETWORK /* Initialize network only variables */

   217

	_redirect_console_to_client = 0;

   218

#endif

   219

   220

	memset(_iconsole_history, 0, sizeof(_iconsole_history));

   221

	memset(_iconsole_buffer, 0, sizeof(_iconsole_buffer));

   222

	memset(_iconsole_cbuffer, 0, sizeof(_iconsole_cbuffer));

   223

	_iconsole_cmdline.buf = calloc(ICON_CMDLN_SIZE, sizeof(*_iconsole_cmdline.buf)); // create buffer and zero it

   224

	_iconsole_cmdline.maxlength = ICON_CMDLN_SIZE - 1;

   225

   226

	IConsolePrintF(13, "OpenTTD Game Console Revision 7 - %s", _openttd_revision);

   227

	IConsolePrint(12,  "------------------------------------");

   228

	IConsolePrint(12,  "use \"help\" for more information");

   229

	IConsolePrint(12,  "");

   230

	IConsoleStdLibRegister();

   231

	IConsoleClearCommand();

   232

	IConsoleHistoryAdd("");

   233

}

   234

   235

void IConsoleClearBuffer(void)

   236

{

   237

	uint i;

   238

	for (i = 0; i <= ICON_BUFFER; i++) {

   239

		free(_iconsole_buffer[i]);

   240

		_iconsole_buffer[i] = NULL;

   241

	}

   242

}

   243

   244

static void IConsoleClear(void)

   245

{

   246

	free(_iconsole_cmdline.buf);

   247

	IConsoleClearBuffer();

   248

}

   249

   250

static void IConsoleWriteToLogFile(const char* string)

   251

{

   252

	if (_iconsole_output_file != NULL) {

   253

		// if there is an console output file ... also print it there

   254

		fwrite(string, strlen(string), 1, _iconsole_output_file);

   255

		fwrite("\n", 1, 1, _iconsole_output_file);

   256

	}

   257

}

   258

   259

bool CloseConsoleLogIfActive(void)

   260

{

   261

	if (_iconsole_output_file != NULL) {

   262

		IConsolePrintF(_icolour_def, "file output complete");

   263

		fclose(_iconsole_output_file);

   264

		_iconsole_output_file = NULL;

   265

		return true;

   266

	}

   267

   268

	return false;

   269

}

   270

   271

void IConsoleFree(void)

   272

{

   273

	_iconsole_inited = false;

   274

	IConsoleClear();

   275

	CloseConsoleLogIfActive();

   276

}

   277

   278

void IConsoleResize(void)

   279

{

   280

	_iconsole_win = FindWindowById(WC_CONSOLE, 0);

   281

   282

	switch (_iconsole_mode) {

   283

		case ICONSOLE_OPENED:

   284

			_iconsole_win->height = _screen.height / 3;

   285

			_iconsole_win->width = _screen.width;

   286

			break;

   287

		case ICONSOLE_FULL:

   288

			_iconsole_win->height = _screen.height - ICON_BOTTOM_BORDERWIDTH;

   289

			_iconsole_win->width = _screen.width;

   290

			break;

   291

		default: break;

   292

	}

   293

   294

	MarkWholeScreenDirty();

   295

}

   296

   297

void IConsoleSwitch(void)

   298

{

   299

	switch (_iconsole_mode) {

   300

		case ICONSOLE_CLOSED:

   301

			_iconsole_win = AllocateWindowDesc(&_iconsole_window_desc);

   302

			_iconsole_win->height = _screen.height / 3;

   303

			_iconsole_win->width = _screen.width;

   304

			_iconsole_mode = ICONSOLE_OPENED;

   305

			SETBIT(_no_scroll, SCROLL_CON); // override cursor arrows; the gamefield will not scroll

   306

			break;

   307

		case ICONSOLE_OPENED: case ICONSOLE_FULL:

   308

			DeleteWindowById(WC_CONSOLE, 0);

   309

			_iconsole_win = NULL;

   310

			_iconsole_mode = ICONSOLE_CLOSED;

   311

			CLRBIT(_no_scroll, SCROLL_CON);

   312

			break;

   313

	}

   314

   315

	MarkWholeScreenDirty();

   316

}

   317

   318

void IConsoleClose(void) {if (_iconsole_mode == ICONSOLE_OPENED) IConsoleSwitch();}

   319

void IConsoleOpen(void)  {if (_iconsole_mode == ICONSOLE_CLOSED) IConsoleSwitch();}

   320

   321

/**

   322

 * Add the entered line into the history so you can look it back

   323

 * scroll, etc. Put it to the beginning as it is the latest text

   324

 * @param cmd Text to be entered into the 'history'

   325

 */

   326

void IConsoleHistoryAdd(const char *cmd)

   327

{

   328

	free(_iconsole_history[ICON_HISTORY_SIZE - 1]);

   329

   330

	memmove(&_iconsole_history[1], &_iconsole_history[0], sizeof(_iconsole_history[0]) * (ICON_HISTORY_SIZE - 1));

   331

	_iconsole_history[0] = strdup(cmd);

   332

	IConsoleResetHistoryPos();

   333

}

   334

   335

/**

   336

 * Navigate Up/Down in the history of typed commands

   337

 * @param direction Go further back in history (+1), go to recently typed commands (-1)

   338

 */

   339

void IConsoleHistoryNavigate(signed char direction)

   340

{

   341

	int i = _iconsole_historypos + direction;

   342

   343

	// watch out for overflows, just wrap around

   344

	if (i < 0) i = ICON_HISTORY_SIZE - 1;

   345

	if (i >= ICON_HISTORY_SIZE) i = 0;

   346

   347

	if (direction > 0)

   348

		if (_iconsole_history[i] == NULL) i = 0;

   349

   350

	if (direction < 0) {

   351

		while (i > 0 && _iconsole_history[i] == NULL) i--;

   352

	}

   353

   354

	_iconsole_historypos = i;

   355

	IConsoleClearCommand();

   356

	// copy history to 'command prompt / bash'

   357

	assert(_iconsole_history[i] != NULL && IS_INT_INSIDE(i, 0, ICON_HISTORY_SIZE));

   358

	ttd_strlcpy(_iconsole_cmdline.buf, _iconsole_history[i], _iconsole_cmdline.maxlength);

   359

	UpdateTextBufferSize(&_iconsole_cmdline);

   360

}

   361

   362

/**

   363

 * Handle the printing of text entered into the console or redirected there

   364

 * by any other means. Text can be redirected to other players in a network game

   365

 * as well as to a logfile. If the network server is a dedicated server, all activities

   366

 * are also logged. All lines to print are added to a temporary buffer which can be

   367

 * used as a history to print them onscreen

   368

 * @param color_code the colour of the command. Red in case of errors, etc.

   369

 * @param string the message entered or output on the console (notice, error, etc.)

   370

 */

   371

void IConsolePrint(uint16 color_code, const char* string)

   372

{

   373

#ifdef ENABLE_NETWORK

   374

	if (_redirect_console_to_client != 0) {

   375

		/* Redirect the string to the client */

   376

		SEND_COMMAND(PACKET_SERVER_RCON)(NetworkFindClientStateFromIndex(_redirect_console_to_client), color_code, string);

   377

		return;

   378

	}

   379

#endif

   380

   381

	if (_network_dedicated) {

   382

		printf("%s\n", string);

   383

		IConsoleWriteToLogFile(string);

   384

		return;

   385

	}

   386

   387

	if (!_iconsole_inited) return;

   388

   389

	/* move up all the strings in the buffer one place and do the same for colour

   390

	 * to accomodate for the new command/message */

   391

	free(_iconsole_buffer[0]);

   392

	memmove(&_iconsole_buffer[0], &_iconsole_buffer[1], sizeof(_iconsole_buffer[0]) * ICON_BUFFER);

   393

	_iconsole_buffer[ICON_BUFFER] = strdup(string);

   394

   395

	{ // filter out unprintable characters

   396

		char *i;

   397

		for (i = _iconsole_buffer[ICON_BUFFER]; *i != '\0'; i++)

   398

			if (!IsValidAsciiChar((byte)*i)) *i = ' ';

   399

	}

   400

   401

	memmove(&_iconsole_cbuffer[0], &_iconsole_cbuffer[1], sizeof(_iconsole_cbuffer[0]) * ICON_BUFFER);

   402

	_iconsole_cbuffer[ICON_BUFFER] = color_code;

   403

   404

	IConsoleWriteToLogFile(string);

   405

   406

	if (_iconsole_win != NULL) SetWindowDirty(_iconsole_win);

   407

}

   408

   409

/**

   410

 * Handle the printing of text entered into the console or redirected there

   411

 * by any other means. Uses printf() style format, for more information look

   412

 * at @IConsolePrint()

   413

 */

   414

void CDECL IConsolePrintF(uint16 color_code, const char *s, ...)

   415

{

   416

	va_list va;

   417

	char buf[ICON_MAX_STREAMSIZE];

   418

   419

	va_start(va, s);

   420

	vsnprintf(buf, sizeof(buf), s, va);

   421

	va_end(va);

   422

   423

	IConsolePrint(color_code, buf);

   424

}

   425

   426

/**

   427

 * It is possible to print debugging information to the console,

   428

 * which is achieved by using this function. Can only be used by

   429

 * @debug() in debug.c. You need at least a level 2 (developer) for debugging

   430

 * messages to show up

   431

 */

   432

void IConsoleDebug(const char* string)

   433

{

   434

	if (_stdlib_developer > 1)

   435

		IConsolePrintF(_icolour_dbg, "dbg: %s", string);

   436

}

   437

   438

/**

   439

 * It is possible to print warnings to the console. These are mostly

   440

 * errors or mishaps, but non-fatal. You need at least a level 1 (developer) for

   441

 * debugging messages to show up

   442

 */

   443

void IConsoleWarning(const char* string)

   444

{

   445

	if (_stdlib_developer > 0)

   446

		IConsolePrintF(_icolour_warn, "WARNING: %s", string);

   447

}

   448

   449

/**

   450

 * It is possible to print error information to the console. This can include

   451

 * game errors, or errors in general you would want the user to notice

   452

 */

   453

void IConsoleError(const char* string)

   454

{

   455

	IConsolePrintF(_icolour_err, "ERROR: %s", string);

   456

}

   457

   458

/**

   459

 * Change a string into its number representation. Supports

   460

 * decimal and hexadecimal numbers as well as 'on'/'off' 'true'/'false'

   461

 * @param *value the variable a successfull conversion will be put in

   462

 * @param *arg the string to be converted

   463

 * @return Return true on success or false on failure

   464

 */

   465

bool GetArgumentInteger(uint32 *value, const char *arg)

   466

{

   467

	char *endptr;

   468

   469

	if (strcmp(arg, "on") == 0 || strcmp(arg, "true") == 0) {

   470

		*value = 1;

   471

		return true;

   472

	}

   473

	if (strcmp(arg, "off") == 0 || strcmp(arg, "false") == 0) {

   474

		*value = 0;

   475

		return true;

   476

	}

   477

   478

	*value = strtoul(arg, &endptr, 0);

   479

	return arg != endptr;

   480

}

   481