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 Window *_iconsole_win; // Pointer to console window

    30

static bool _iconsole_inited;

    31

static char *_iconsole_buffer[ICON_BUFFER + 1];

    32

static uint16 _iconsole_cbuffer[ICON_BUFFER + 1];

    33

static Textbuf _iconsole_cmdline;

    34

static byte _iconsole_scroll;

    35

    36

// ** stdlib ** //

    37

byte _stdlib_developer = 1;

    38

bool _stdlib_con_developer = false;

    39

FILE *_iconsole_output_file;

    40

    41

// ** main console cmd buffer

    42

static char *_iconsole_history[ICON_HISTORY_SIZE];

    43

static byte _iconsole_historypos;

    44

    45

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

    46

/*  end of header  */

    47

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

    48

    49

static void IConsoleClearCommand(void)

    50

{

    51

	memset(_iconsole_cmdline.buf, 0, ICON_CMDLN_SIZE);

    52

	_iconsole_cmdline.length = 0;

    53

	_iconsole_cmdline.width = 0;

    54

	_iconsole_cmdline.caretpos = 0;

    55

	_iconsole_cmdline.caretxoffs = 0;

    56

	SetWindowDirty(_iconsole_win);

    57

}

    58

    59

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

    60

    61

    62

static void IConsoleHistoryAdd(const char* cmd);

    63

static void IConsoleHistoryNavigate(int direction);

    64

    65

// ** console window ** //

    66

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

    67

{

    68

	switch (e->event) {

    69

		case WE_PAINT: {

    70

			int i = _iconsole_scroll;

    71

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

    72

			int delta = 0;

    73

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

    74

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

    75

				DoDrawString(_iconsole_buffer[i], 5,

    76

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

    77

				i--;

    78

			}

    79

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

    80

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

    81

			if (delta > 0) {

    82

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

    83

				delta = 0;

    84

			}

    85

    86

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

    87

    88

			if (_iconsole_cmdline.caret)

    89

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

    90

			break;

    91

		}

    92

		case WE_MOUSELOOP:

    93

			if (HandleCaret(&_iconsole_cmdline))

    94

				SetWindowDirty(w);

    95

			break;

    96

		case WE_DESTROY:

    97

			_iconsole_win = NULL;

    98

			_iconsole_mode = ICONSOLE_CLOSED;

    99

			break;

   100

		case WE_KEYPRESS:

   101

			e->keypress.cont = false;

   102

			switch (e->keypress.keycode) {

   103

				case WKC_UP:

   104

					IConsoleHistoryNavigate(+1);

   105

					SetWindowDirty(w);

   106

					break;

   107

				case WKC_DOWN:

   108

					IConsoleHistoryNavigate(-1);

   109

					SetWindowDirty(w);

   110

					break;

   111

				case WKC_SHIFT | WKC_PAGEUP:

   112

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

   113

						_iconsole_scroll = 0;

   114

					else

   115

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

   116

					SetWindowDirty(w);

   117

					break;

   118

				case WKC_SHIFT | WKC_PAGEDOWN:

   119

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

   120

						_iconsole_scroll = ICON_BUFFER;

   121

					else

   122

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

   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

					SetWindowDirty(w);

   131

					break;

   132

				case WKC_SHIFT | WKC_DOWN:

   133

					if (_iconsole_scroll >= ICON_BUFFER)

   134

						_iconsole_scroll = ICON_BUFFER;

   135

					else

   136

						++_iconsole_scroll;

   137

					SetWindowDirty(w);

   138

					break;

   139

				case WKC_BACKQUOTE:

   140

					IConsoleSwitch();

   141

					break;

   142

				case WKC_RETURN: case WKC_NUM_ENTER:

   143

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

   144

					IConsoleHistoryAdd(_iconsole_cmdline.buf);

   145

   146

					IConsoleCmdExec(_iconsole_cmdline.buf);

   147

					IConsoleClearCommand();

   148

					break;

   149

				case WKC_CTRL | WKC_RETURN:

   150

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

   151

					IConsoleResize();

   152

					MarkWholeScreenDirty();

   153

					break;

   154

				case (WKC_CTRL | 'V'):

   155

					if (InsertTextBufferClipboard(&_iconsole_cmdline)) {

   156

						IConsoleResetHistoryPos();

   157

						SetWindowDirty(w);

   158

					}

   159

					break;

   160

				case (WKC_CTRL | 'L'):

   161

					IConsoleCmdExec("clear");

   162

					break;

   163

				case (WKC_CTRL | 'U'):

   164

					DeleteTextBufferAll(&_iconsole_cmdline);

   165

					SetWindowDirty(w);

   166

					break;

   167

				case WKC_BACKSPACE: case WKC_DELETE:

   168

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

   169

						IConsoleResetHistoryPos();

   170

						SetWindowDirty(w);

   171

					}

   172

					break;

   173

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

   174

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

   175

						IConsoleResetHistoryPos();

   176

						SetWindowDirty(w);

   177

					}

   178

					break;

   179

				default:

   180

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

   181

						_iconsole_scroll = ICON_BUFFER;

   182

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

   183

						IConsoleResetHistoryPos();

   184

						SetWindowDirty(w);

   185

					} else

   186

						e->keypress.cont = true;

   187

			break;

   188

		}

   189

	}

   190

}

   191

   192

static const Widget _iconsole_window_widgets[] = {

   193

	{WIDGETS_END}

   194

};

   195

   196

static const WindowDesc _iconsole_window_desc = {

   197

	0, 0, 2, 2,

   198

	WC_CONSOLE, 0,

   199

	WDF_STD_TOOLTIPS | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS,

   200

	_iconsole_window_widgets,

   201

	IConsoleWndProc,

   202

};

   203

   204

void IConsoleInit(void)

   205

{

   206

	extern const char _openttd_revision[];

   207

	_iconsole_output_file = NULL;

   208

	_icolour_def  =  1;

   209

	_icolour_err  =  3;

   210

	_icolour_warn = 13;

   211

	_icolour_dbg  =  5;

   212

	_icolour_cmd  =  2;

   213

	_iconsole_scroll = ICON_BUFFER;

   214

	_iconsole_historypos = ICON_HISTORY_SIZE - 1;

   215

	_iconsole_inited = true;

   216

	_iconsole_mode = ICONSOLE_CLOSED;

   217

	_iconsole_win = NULL;

   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 - 1;

   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

	_iconsole_inited = false;

   277

	IConsoleClear();

   278

	CloseConsoleLogIfActive();

   279

}

   280

   281

void IConsoleResize(void)

   282

{

   283

	_iconsole_win = FindWindowById(WC_CONSOLE, 0);

   284

   285

	switch (_iconsole_mode) {

   286

		case ICONSOLE_OPENED:

   287

			_iconsole_win->height = _screen.height / 3;

   288

			_iconsole_win->width = _screen.width;

   289

			break;

   290

		case ICONSOLE_FULL:

   291

			_iconsole_win->height = _screen.height - ICON_BOTTOM_BORDERWIDTH;

   292

			_iconsole_win->width = _screen.width;

   293

			break;

   294

		default: break;

   295

	}

   296

   297

	MarkWholeScreenDirty();

   298

}

   299

   300

void IConsoleSwitch(void)

   301

{

   302

	switch (_iconsole_mode) {

   303

		case ICONSOLE_CLOSED:

   304

			_iconsole_win = AllocateWindowDesc(&_iconsole_window_desc);

   305

			_iconsole_win->height = _screen.height / 3;

   306

			_iconsole_win->width = _screen.width;

   307

			_iconsole_mode = ICONSOLE_OPENED;

   308

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

   309

			break;

   310

		case ICONSOLE_OPENED: case ICONSOLE_FULL:

   311

			DeleteWindowById(WC_CONSOLE, 0);

   312

			_iconsole_win = NULL;

   313

			_iconsole_mode = ICONSOLE_CLOSED;

   314

			CLRBIT(_no_scroll, SCROLL_CON);

   315

			break;

   316

	}

   317

   318

	MarkWholeScreenDirty();

   319

}

   320

   321

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

   322

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

   323

   324

/**

   325

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

   326

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

   327

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

   328

 */

   329

static void IConsoleHistoryAdd(const char* cmd)

   330

{

   331

	free(_iconsole_history[ICON_HISTORY_SIZE - 1]);

   332

   333

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

   334

	_iconsole_history[0] = strdup(cmd);

   335

	IConsoleResetHistoryPos();

   336

}

   337

   338

/**

   339

 * Navigate Up/Down in the history of typed commands

   340

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

   341

 */

   342

static void IConsoleHistoryNavigate(int direction)

   343

{

   344

	int i = _iconsole_historypos + direction;

   345

   346

	// watch out for overflows, just wrap around

   347

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

   348

	if (i >= ICON_HISTORY_SIZE) i = 0;

   349

   350

	if (direction > 0)

   351

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

   352

   353

	if (direction < 0) {

   354

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

   355

	}

   356

   357

	_iconsole_historypos = i;

   358

	IConsoleClearCommand();

   359

	// copy history to 'command prompt / bash'

   360

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

   361

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

   362

	UpdateTextBufferSize(&_iconsole_cmdline);

   363

}

   364

   365

/**

   366

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

   367

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

   368

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

   369

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

   370

 * used as a history to print them onscreen

   371

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

   372

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

   373

 */

   374

void IConsolePrint(uint16 color_code, const char* string)

   375

{

   376

#ifdef ENABLE_NETWORK

   377

	if (_redirect_console_to_client != 0) {

   378

		/* Redirect the string to the client */

   379

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

   380

		return;

   381

	}

   382

#endif

   383

   384

	if (_network_dedicated) {

   385

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

   386

		IConsoleWriteToLogFile(string);

   387

		return;

   388

	}

   389

   390

	if (!_iconsole_inited) return;

   391

   392

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

   393

	 * to accomodate for the new command/message */

   394

	free(_iconsole_buffer[0]);

   395

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

   396

	_iconsole_buffer[ICON_BUFFER] = strdup(string);

   397

   398

	{ // filter out unprintable characters

   399

		char *i;

   400

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

   401

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

   402

	}

   403

   404

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

   405

	_iconsole_cbuffer[ICON_BUFFER] = color_code;

   406

   407

	IConsoleWriteToLogFile(string);

   408

   409

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

   410

}

   411

   412

/**

   413

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

   414

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

   415

 * at @IConsolePrint()

   416

 */

   417

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

   418

{

   419

	va_list va;

   420

	char buf[ICON_MAX_STREAMSIZE];

   421

   422

	va_start(va, s);

   423

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

   424

	va_end(va);

   425

   426

	IConsolePrint(color_code, buf);

   427

}

   428

   429

/**

   430

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

   431

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

   432

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

   433

 * messages to show up

   434

 */

   435

void IConsoleDebug(const char* string)

   436

{

   437

	if (_stdlib_developer > 1)

   438

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

   439

}

   440

   441

/**

   442

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

   443

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

   444

 * debugging messages to show up

   445

 */

   446

void IConsoleWarning(const char* string)

   447

{

   448

	if (_stdlib_developer > 0)

   449

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

   450

}

   451

   452

/**

   453

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

   454

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

   455

 */

   456

void IConsoleError(const char* string)

   457

{

   458

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

   459

}

   460

   461

/**

   462

 * Change a string into its number representation. Supports

   463

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

   464

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

   465

 * @param *arg the string to be converted

   466

 * @return Return true on success or false on failure

   467

 */

   468

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

   469

{

   470

	char *endptr;

   471

   472

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

   473

		*value = 1;

   474

		return true;

   475

	}

   476

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

   477

		*value = 0;

   478

		return true;

   479

	}

   480

   481

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