1

/* $Id$ */

     2

     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 <stdarg.h>

    14

#include <string.h>

    15

#include "console.h"

    16

#include "network.h"

    17

#include "network_data.h"

    18

#include "network_server.h"

    19

    20

#define ICON_BUFFER 79

    21

#define ICON_HISTORY_SIZE 20

    22

#define ICON_LINE_HEIGHT 12

    23

#define ICON_RIGHT_BORDERWIDTH 10

    24

#define ICON_BOTTOM_BORDERWIDTH 12

    25

#define ICON_MAX_ALIAS_LINES 40

    26

#define ICON_TOKEN_COUNT 20

    27

    28

// ** main console ** //

    29

static char *_iconsole_buffer[ICON_BUFFER + 1];

    30

static uint16 _iconsole_cbuffer[ICON_BUFFER + 1];

    31

static Textbuf _iconsole_cmdline;

    32

    33

// ** stdlib ** //

    34

byte _stdlib_developer = 1;

    35

bool _stdlib_con_developer = false;

    36

FILE *_iconsole_output_file;

    37

    38

// ** main console cmd buffer

    39

static char *_iconsole_history[ICON_HISTORY_SIZE];

    40

static byte _iconsole_historypos;

    41

    42

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

    43

/*  end of header  */

    44

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

    45

    46

static void IConsoleClearCommand(void)

    47

{

    48

	memset(_iconsole_cmdline.buf, 0, ICON_CMDLN_SIZE);

    49

	_iconsole_cmdline.length = 0;

    50

	_iconsole_cmdline.width = 0;

    51

	_iconsole_cmdline.caretpos = 0;

    52

	_iconsole_cmdline.caretxoffs = 0;

    53

	SetWindowDirty(FindWindowById(WC_CONSOLE, 0));

    54

}

    55

    56

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

    57

    58

    59

static void IConsoleHistoryAdd(const char *cmd);

    60

static void IConsoleHistoryNavigate(int direction);

    61

    62

// ** console window ** //

    63

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

    64

{

    65

	static byte iconsole_scroll = ICON_BUFFER;

    66

    67

	switch (e->event) {

    68

		case WE_PAINT: {

    69

			int i = iconsole_scroll;

    70

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

    71

			int delta = 0;

    72

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

    73

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

    74

				DoDrawString(_iconsole_buffer[i], 5,

    75

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

    76

				i--;

    77

			}

    78

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

    79

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

    80

			if (delta > 0) {

    81

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

    82

				delta = 0;

    83

			}

    84

    85

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

    86

    87

			if (_iconsole_cmdline.caret)

    88

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

    89

			break;

    90

		}

    91

		case WE_MOUSELOOP:

    92

			if (HandleCaret(&_iconsole_cmdline))

    93

				SetWindowDirty(w);

    94

			break;

    95

		case WE_DESTROY:

    96

			_iconsole_mode = ICONSOLE_CLOSED;

    97

			break;

    98

		case WE_KEYPRESS:

    99

			e->we.keypress.cont = false;

   100

			switch (e->we.keypress.keycode) {

   101

				case WKC_UP:

   102

					IConsoleHistoryNavigate(+1);

   103

					SetWindowDirty(w);

   104

					break;

   105

				case WKC_DOWN:

   106

					IConsoleHistoryNavigate(-1);

   107

					SetWindowDirty(w);

   108

					break;

   109

				case WKC_SHIFT | WKC_PAGEUP:

   110

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

   111

						iconsole_scroll = 0;

   112

					} else {

   113

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

   114

					}

   115

					SetWindowDirty(w);

   116

					break;

   117

				case WKC_SHIFT | WKC_PAGEDOWN:

   118

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

   119

						iconsole_scroll = ICON_BUFFER;

   120

					} else {

   121

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

   122

					}

   123

					SetWindowDirty(w);

   124

					break;

   125

				case WKC_SHIFT | WKC_UP:

   126

					if (iconsole_scroll <= 0) {

   127

						iconsole_scroll = 0;

   128

					} else {

   129

						--iconsole_scroll;

   130

					}

   131

					SetWindowDirty(w);

   132

					break;

   133

				case WKC_SHIFT | WKC_DOWN:

   134

					if (iconsole_scroll >= ICON_BUFFER) {

   135

						iconsole_scroll = ICON_BUFFER;

   136

					} else {

   137

						++iconsole_scroll;

   138

					}

   139

					SetWindowDirty(w);

   140

					break;

   141

				case WKC_BACKQUOTE:

   142

					IConsoleSwitch();

   143

					break;

   144

				case WKC_RETURN: case WKC_NUM_ENTER:

   145

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

   146

					IConsoleHistoryAdd(_iconsole_cmdline.buf);

   147

   148

					IConsoleCmdExec(_iconsole_cmdline.buf);

   149

					IConsoleClearCommand();

   150

					break;

   151

				case WKC_CTRL | WKC_RETURN:

   152

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

   153

					IConsoleResize(w);

   154

					MarkWholeScreenDirty();

   155

					break;

   156

				case (WKC_CTRL | 'V'):

   157

					if (InsertTextBufferClipboard(&_iconsole_cmdline)) {

   158

						IConsoleResetHistoryPos();

   159

						SetWindowDirty(w);

   160

					}

   161

					break;

   162

				case (WKC_CTRL | 'L'):

   163

					IConsoleCmdExec("clear");

   164

					break;

   165

				case (WKC_CTRL | 'U'):

   166

					DeleteTextBufferAll(&_iconsole_cmdline);

   167

					SetWindowDirty(w);

   168

					break;

   169

				case WKC_BACKSPACE: case WKC_DELETE:

   170

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

   171

						IConsoleResetHistoryPos();

   172

						SetWindowDirty(w);

   173

					}

   174

					break;

   175

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

   176

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

   177

						IConsoleResetHistoryPos();

   178

						SetWindowDirty(w);

   179

					}

   180

					break;

   181

				default:

   182

					if (IsValidChar(e->we.keypress.key, CS_ALPHANUMERAL)) {

   183

						iconsole_scroll = ICON_BUFFER;

   184

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

   185

						IConsoleResetHistoryPos();

   186

						SetWindowDirty(w);

   187

					} else {

   188

						e->we.keypress.cont = true;

   189

					}

   190

			break;

   191

		}

   192

	}

   193

}

   194

   195

static const Widget _iconsole_window_widgets[] = {

   196

	{WIDGETS_END}

   197

};

   198

   199

static const WindowDesc _iconsole_window_desc = {

   200

	0, 0, 2, 2,

   201

	WC_CONSOLE, 0,

   202

	WDF_STD_TOOLTIPS | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS,

   203

	_iconsole_window_widgets,

   204

	IConsoleWndProc,

   205

};

   206

   207

void IConsoleInit(void)

   208

{

   209

	extern const char _openttd_revision[];

   210

	_iconsole_output_file = NULL;

   211

	_icolour_def  =  1;

   212

	_icolour_err  =  3;

   213

	_icolour_warn = 13;

   214

	_icolour_dbg  =  5;

   215

	_icolour_cmd  =  2;

   216

	_iconsole_historypos = ICON_HISTORY_SIZE - 1;

   217

	_iconsole_mode = ICONSOLE_CLOSED;

   218

   219

#ifdef ENABLE_NETWORK /* Initialize network only variables */

   220

	_redirect_console_to_client = 0;

   221

#endif

   222

   223

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

   224

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

   225

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

   226

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

   227

	_iconsole_cmdline.maxlength = ICON_CMDLN_SIZE;

   228

   229

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

   230

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

   231

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

   232

	IConsolePrint(12,  "");

   233

	IConsoleStdLibRegister();

   234

	IConsoleClearCommand();

   235

	IConsoleHistoryAdd("");

   236

}

   237

   238

void IConsoleClearBuffer(void)

   239

{

   240

	uint i;

   241

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

   242

		free(_iconsole_buffer[i]);

   243

		_iconsole_buffer[i] = NULL;

   244

	}

   245

}

   246

   247

static void IConsoleClear(void)

   248

{

   249

	free(_iconsole_cmdline.buf);

   250

	IConsoleClearBuffer();

   251

}

   252

   253

static void IConsoleWriteToLogFile(const char *string)

   254

{

   255

	if (_iconsole_output_file != NULL) {

   256

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

   257

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

   258

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

   259

	}

   260

}

   261

   262

bool CloseConsoleLogIfActive(void)

   263

{

   264

	if (_iconsole_output_file != NULL) {

   265

		IConsolePrintF(_icolour_def, "file output complete");

   266

		fclose(_iconsole_output_file);

   267

		_iconsole_output_file = NULL;

   268

		return true;

   269

	}

   270

   271

	return false;

   272

}

   273

   274

void IConsoleFree(void)

   275

{

   276

	IConsoleClear();

   277

	CloseConsoleLogIfActive();

   278

}

   279

   280

void IConsoleResize(Window *w)

   281

{

   282

	switch (_iconsole_mode) {

   283

		case ICONSOLE_OPENED:

   284

			w->height = _screen.height / 3;

   285

			w->width = _screen.width;

   286

			break;

   287

		case ICONSOLE_FULL:

   288

			w->height = _screen.height - ICON_BOTTOM_BORDERWIDTH;

   289

			w->width = _screen.width;

   290

			break;

   291

		default: return;

   292

	}

   293

   294

	MarkWholeScreenDirty();

   295

}

   296

   297

void IConsoleSwitch(void)

   298

{

   299

	switch (_iconsole_mode) {

   300

		case ICONSOLE_CLOSED: {

   301

			Window *w = AllocateWindowDesc(&_iconsole_window_desc);

   302

			w->height = _screen.height / 3;

   303

			w->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_mode = ICONSOLE_CLOSED;

   310

			CLRBIT(_no_scroll, SCROLL_CON);

   311

			break;

   312

	}

   313

   314

	MarkWholeScreenDirty();

   315

}

   316

   317

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

   318

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

   319

   320

/**

   321

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

   322

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

   323

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

   324

 */

   325

static void IConsoleHistoryAdd(const char *cmd)

   326

{

   327

	free(_iconsole_history[ICON_HISTORY_SIZE - 1]);

   328

   329

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

   330

	_iconsole_history[0] = strdup(cmd);

   331

	IConsoleResetHistoryPos();

   332

}

   333

   334

/**

   335

 * Navigate Up/Down in the history of typed commands

   336

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

   337

 */

   338

static void IConsoleHistoryNavigate(int direction)

   339

{

   340

	int i = _iconsole_historypos + direction;

   341

   342

	// watch out for overflows, just wrap around

   343

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

   344

	if (i >= ICON_HISTORY_SIZE) i = 0;

   345

   346

	if (direction > 0)

   347

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

   348

   349

	if (direction < 0) {

   350

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

   351

	}

   352

   353

	_iconsole_historypos = i;

   354

	IConsoleClearCommand();

   355

	// copy history to 'command prompt / bash'

   356

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

   357

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

   358

	UpdateTextBufferSize(&_iconsole_cmdline);

   359

}

   360

   361

/**

   362

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

   363

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

   364

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

   365

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

   366

 * used as a history to print them onscreen

   367

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

   368

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

   369

 */

   370

void IConsolePrint(uint16 color_code, const char *string)

   371

{

   372

	char *str;

   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

	/* Create a copy of the string, strip if of colours and invalid

   382

	 * characters and (when applicable) assign it to the console buffer */

   383

	str = strdup(string);

   384

	str_strip_colours(str);

   385

	str_validate(str);

   386

   387

	if (_network_dedicated) {

   388

		fprintf(stdout, "%s\n", str);

   389

		fflush(stdout);

   390

		IConsoleWriteToLogFile(str);

   391

		free(str); // free duplicated string since it's not used anymore

   392

		return;

   393

	}

   394

   395

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

   396

	 * to accomodate for the new command/message */

   397

	free(_iconsole_buffer[0]);

   398

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

   399

	_iconsole_buffer[ICON_BUFFER] = str;

   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(_iconsole_buffer[ICON_BUFFER]);

   405

   406

	SetWindowDirty(FindWindowById(WC_CONSOLE, 0));

   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;