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

// ** console window ** //

    62

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

    63

{

    64

	switch (e->event) {

    65

		case WE_PAINT: {

    66

			int i = _iconsole_scroll;

    67

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

    68

			int delta = 0;

    69

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

    70

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

    71

				DoDrawString(_iconsole_buffer[i], 5,

    72

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

    73

				i--;

    74

			}

    75

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

    76

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

    77

			if (delta > 0) {

    78

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

    79

				delta = 0;

    80

			}

    81

    82

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

    83

    84

			if (_iconsole_cmdline.caret)

    85

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

    86

			break;

    87

		}

    88

		case WE_MOUSELOOP:

    89

			if (HandleCaret(&_iconsole_cmdline))

    90

				SetWindowDirty(w);

    91

			break;

    92

		case WE_DESTROY:

    93

			_iconsole_win = NULL;

    94

			_iconsole_mode = ICONSOLE_CLOSED;

    95

			break;

    96

		case WE_KEYPRESS:

    97

			e->keypress.cont = false;

    98

			switch (e->keypress.keycode) {

    99

				case WKC_UP:

   100

					IConsoleHistoryNavigate(+1);

   101

					SetWindowDirty(w);

   102

					break;

   103

				case WKC_DOWN:

   104

					IConsoleHistoryNavigate(-1);

   105

					SetWindowDirty(w);

   106

					break;

   107

				case WKC_SHIFT | WKC_PAGEUP:

   108

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

   109

						_iconsole_scroll = 0;

   110

					else

   111

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

   112

					SetWindowDirty(w);

   113

					break;

   114

				case WKC_SHIFT | WKC_PAGEDOWN:

   115

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

   116

						_iconsole_scroll = ICON_BUFFER;

   117

					else

   118

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

   119

					SetWindowDirty(w);

   120

					break;

   121

				case WKC_SHIFT | WKC_UP:

   122

					if (_iconsole_scroll <= 0)

   123

						_iconsole_scroll = 0;

   124

					else

   125

						--_iconsole_scroll;

   126

					SetWindowDirty(w);

   127

					break;

   128

				case WKC_SHIFT | WKC_DOWN:

   129

					if (_iconsole_scroll >= ICON_BUFFER)

   130

						_iconsole_scroll = ICON_BUFFER;

   131

					else

   132

						++_iconsole_scroll;

   133

					SetWindowDirty(w);

   134

					break;

   135

				case WKC_BACKQUOTE:

   136

					IConsoleSwitch();

   137

					break;

   138

				case WKC_RETURN: case WKC_NUM_ENTER:

   139

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

   140

					IConsoleHistoryAdd(_iconsole_cmdline.buf);

   141

   142

					IConsoleCmdExec(_iconsole_cmdline.buf);

   143

					IConsoleClearCommand();

   144

					break;

   145

				case WKC_CTRL | WKC_RETURN:

   146

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

   147

					IConsoleResize();

   148

					MarkWholeScreenDirty();

   149

					break;

   150

				case (WKC_CTRL | 'V'):

   151

					if (InsertTextBufferClipboard(&_iconsole_cmdline)) {

   152

						IConsoleResetHistoryPos();

   153

						SetWindowDirty(w);

   154

					}

   155

					break;

   156

				case (WKC_CTRL | 'L'):

   157

					IConsoleCmdExec("clear");

   158

					break;

   159

				case (WKC_CTRL | 'U'):

   160

					DeleteTextBufferAll(&_iconsole_cmdline);

   161

					SetWindowDirty(w);

   162

					break;

   163

				case WKC_BACKSPACE: case WKC_DELETE:

   164

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

   165

						IConsoleResetHistoryPos();

   166

						SetWindowDirty(w);

   167

					}

   168

					break;

   169

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

   170

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

   171

						IConsoleResetHistoryPos();

   172

						SetWindowDirty(w);

   173

					}

   174

					break;

   175

				default:

   176

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

   177

						_iconsole_scroll = ICON_BUFFER;

   178

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

   179

						IConsoleResetHistoryPos();

   180

						SetWindowDirty(w);

   181

					} else

   182

						e->keypress.cont = true;

   183

			break;

   184

		}

   185

	}

   186

}

   187

   188

static const Widget _iconsole_window_widgets[] = {

   189

	{WIDGETS_END}

   190

};

   191

   192

static const WindowDesc _iconsole_window_desc = {

   193

	0, 0, 2, 2,

   194

	WC_CONSOLE, 0,

   195

	WDF_STD_TOOLTIPS | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS,

   196

	_iconsole_window_widgets,

   197

	IConsoleWndProc,

   198

};

   199

   200

void IConsoleInit(void)

   201

{

   202

	extern const char _openttd_revision[];

   203

	_iconsole_output_file = NULL;

   204

	_icolour_def  =  1;

   205

	_icolour_err  =  3;

   206

	_icolour_warn = 13;

   207

	_icolour_dbg  =  5;

   208

	_icolour_cmd  =  2;

   209

	_iconsole_scroll = ICON_BUFFER;

   210

	_iconsole_historypos = ICON_HISTORY_SIZE - 1;

   211

	_iconsole_inited = true;

   212

	_iconsole_mode = ICONSOLE_CLOSED;

   213

	_iconsole_win = NULL;

   214

   215

#ifdef ENABLE_NETWORK /* Initialize network only variables */

   216

	_redirect_console_to_client = 0;

   217

#endif

   218

   219

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

   220

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

   221

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

   222

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

   223

	_iconsole_cmdline.maxlength = ICON_CMDLN_SIZE - 1;

   224

   225

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

   226

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

   227

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

   228

	IConsolePrint(12,  "");

   229

	IConsoleStdLibRegister();

   230

	IConsoleClearCommand();

   231

	IConsoleHistoryAdd("");

   232

}

   233

   234

void IConsoleClearBuffer(void)

   235

{

   236

	uint i;

   237

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

   238

		free(_iconsole_buffer[i]);

   239

		_iconsole_buffer[i] = NULL;

   240

	}

   241

}

   242

   243

static void IConsoleClear(void)

   244

{

   245

	free(_iconsole_cmdline.buf);

   246

	IConsoleClearBuffer();

   247

}

   248

   249

static void IConsoleWriteToLogFile(const char* string)

   250

{

   251

	if (_iconsole_output_file != NULL) {

   252

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

   253

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

   254

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

   255

	}

   256

}

   257

   258

bool CloseConsoleLogIfActive(void)

   259

{

   260

	if (_iconsole_output_file != NULL) {

   261

		IConsolePrintF(_icolour_def, "file output complete");

   262

		fclose(_iconsole_output_file);

   263

		_iconsole_output_file = NULL;

   264

		return true;

   265

	}

   266

   267

	return false;

   268

}

   269

   270

void IConsoleFree(void)

   271

{

   272

	_iconsole_inited = false;

   273

	IConsoleClear();

   274

	CloseConsoleLogIfActive();

   275

}

   276

   277

void IConsoleResize(void)

   278

{

   279

	_iconsole_win = FindWindowById(WC_CONSOLE, 0);

   280

   281

	switch (_iconsole_mode) {

   282

		case ICONSOLE_OPENED:

   283

			_iconsole_win->height = _screen.height / 3;

   284

			_iconsole_win->width = _screen.width;

   285

			break;

   286

		case ICONSOLE_FULL:

   287

			_iconsole_win->height = _screen.height - ICON_BOTTOM_BORDERWIDTH;

   288

			_iconsole_win->width = _screen.width;

   289

			break;

   290

		default: break;

   291

	}

   292

   293

	MarkWholeScreenDirty();

   294

}

   295

   296

void IConsoleSwitch(void)

   297

{

   298

	switch (_iconsole_mode) {

   299

		case ICONSOLE_CLOSED:

   300

			_iconsole_win = AllocateWindowDesc(&_iconsole_window_desc);

   301

			_iconsole_win->height = _screen.height / 3;

   302

			_iconsole_win->width = _screen.width;

   303

			_iconsole_mode = ICONSOLE_OPENED;

   304

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

   305

			break;

   306

		case ICONSOLE_OPENED: case ICONSOLE_FULL:

   307

			DeleteWindowById(WC_CONSOLE, 0);

   308

			_iconsole_win = NULL;

   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

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

void IConsoleHistoryNavigate(signed char 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

#ifdef ENABLE_NETWORK

   373

	if (_redirect_console_to_client != 0) {

   374

		/* Redirect the string to the client */

   375

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

   376

		return;

   377

	}

   378

#endif

   379

   380

	if (_network_dedicated) {

   381

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

   382

		IConsoleWriteToLogFile(string);

   383

		return;

   384

	}

   385

   386

	if (!_iconsole_inited) return;

   387

   388

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

   389

	 * to accomodate for the new command/message */

   390

	free(_iconsole_buffer[0]);

   391

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

   392

	_iconsole_buffer[ICON_BUFFER] = strdup(string);

   393

   394

	{ // filter out unprintable characters

   395

		char *i;

   396

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

   397

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

   398

	}

   399

   400

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

   401

	_iconsole_cbuffer[ICON_BUFFER] = color_code;

   402

   403

	IConsoleWriteToLogFile(string);

   404

   405

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

   406

}

   407

   408

/**

   409

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

   410

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

   411

 * at @IConsolePrint()

   412

 */

   413

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

   414

{

   415

	va_list va;

   416

	char buf[ICON_MAX_STREAMSIZE];

   417

   418

	va_start(va, s);

   419

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

   420

	va_end(va);

   421

   422

	IConsolePrint(color_code, buf);

   423

}

   424

   425

/**

   426

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

   427

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

   428

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

   429

 * messages to show up

   430

 */

   431

void IConsoleDebug(const char* string)

   432

{

   433

	if (_stdlib_developer > 1)

   434

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

   435

}

   436

   437

/**

   438

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

   439

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

   440

 * debugging messages to show up

   441

 */

   442

void IConsoleWarning(const char* string)

   443

{

   444

	if (_stdlib_developer > 0)

   445

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

   446

}

   447

   448

/**

   449

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

   450

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

   451

 */

   452

void IConsoleError(const char* string)

   453

{

   454

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

   455

}

   456

   457

/**

   458

 * Change a string into its number representation. Supports

   459

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

   460

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

   461

 * @param *arg the string to be converted

   462

 * @return Return true on success or false on failure

   463

 */

   464

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

   465

{

   466

	char *endptr;

   467

   468

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

   469

		*value = 1;

   470

		return true;

   471

	}

   472

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

   473

		*value = 0;

   474

		return true;

   475

	}

   476

   477

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

   478

	return arg != endptr;

   479

}

   480

   481

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