Files
@ r21336:6222d0b5e244
Branch filter:
Location: cpp/openttd-patchpack/source/src/console.cpp - annotation
r21336:6222d0b5e244
14.4 KiB
text/x-c
(svn r26431) -Update from WebTranslator v3.0:
english_AU - 2 changes by mrtux
italian - 1 changes by lorenzodv
japanese - 10 changes by guppy
lithuanian - 1 changes by Stabilitronas
polish - 21 changes by Kilian
english_AU - 2 changes by mrtux
italian - 1 changes by lorenzodv
japanese - 10 changes by guppy
lithuanian - 1 changes by Stabilitronas
polish - 21 changes by Kilian
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 | r5584:545d748cc681 r5584:545d748cc681 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r9111:983de9c5a848 r6123:049e9624d068 r5584:545d748cc681 r9428:6800206a6c0d r18882:b2227172c2cf r18882:b2227172c2cf r16263:61b0e0090f37 r18882:b2227172c2cf r14248:a9050881acd7 r14501:2d9a7f4bac26 r5584:545d748cc681 r9339:78ad2d03d291 r9339:78ad2d03d291 r16940:b48fa0f0db37 r5584:545d748cc681 r8268:4e9851bbf247 r14502:ced0a904f0d6 r14502:ced0a904f0d6 r8268:4e9851bbf247 r5584:545d748cc681 r5584:545d748cc681 r6247:96e840dbefcc r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r10454:ba5e39738ffa r16263:61b0e0090f37 r5584:545d748cc681 r5584:545d748cc681 r9339:78ad2d03d291 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r6123:049e9624d068 r12984:b9c53ed05d55 r14663:60d42e2f38ef r12984:b9c53ed05d55 r9100:cfc164ed4480 r9100:cfc164ed4480 r9100:cfc164ed4480 r9337:eae33d9f73f5 r9100:cfc164ed4480 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r6247:96e840dbefcc r5584:545d748cc681 r5584:545d748cc681 r9337:eae33d9f73f5 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r6247:96e840dbefcc r5584:545d748cc681 r9339:78ad2d03d291 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r10207:a1fc2f2a33db r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r11085:c87a330fb4c2 r5584:545d748cc681 r5584:545d748cc681 r16955:558d50c26a94 r5584:545d748cc681 r16942:11d12798d937 r16942:11d12798d937 r5584:545d748cc681 r5584:545d748cc681 r10454:ba5e39738ffa r5584:545d748cc681 r11085:c87a330fb4c2 r5584:545d748cc681 r5584:545d748cc681 r16263:61b0e0090f37 r16263:61b0e0090f37 r16263:61b0e0090f37 r16263:61b0e0090f37 r16263:61b0e0090f37 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r11272:411ffa5b815a r5584:545d748cc681 r5584:545d748cc681 r16266:b8988cb576de r16264:1f7e2ab6252c r16266:b8988cb576de r12984:b9c53ed05d55 r7031:2fd9f058743b r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r9339:78ad2d03d291 r11085:c87a330fb4c2 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r6422:5983361e241a r5584:545d748cc681 r16955:558d50c26a94 r5584:545d748cc681 r16942:11d12798d937 r16942:11d12798d937 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r11870:92eb16f6d311 r11870:92eb16f6d311 r5584:545d748cc681 r5584:545d748cc681 r11085:c87a330fb4c2 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r6416:1409210e5613 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r14501:2d9a7f4bac26 r14501:2d9a7f4bac26 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r14501:2d9a7f4bac26 r14501:2d9a7f4bac26 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r9337:eae33d9f73f5 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r7372:a3bbd9f434e7 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r14904:3e524d0a3be3 r14904:3e524d0a3be3 r14904:3e524d0a3be3 r5584:545d748cc681 r14904:3e524d0a3be3 r14904:3e524d0a3be3 r14904:3e524d0a3be3 r14904:3e524d0a3be3 r14904:3e524d0a3be3 r14904:3e524d0a3be3 r14904:3e524d0a3be3 r14904:3e524d0a3be3 r14904:3e524d0a3be3 r14904:3e524d0a3be3 r14904:3e524d0a3be3 r14904:3e524d0a3be3 r14904:3e524d0a3be3 r14904:3e524d0a3be3 r14904:3e524d0a3be3 r14904:3e524d0a3be3 r14904:3e524d0a3be3 r14904:3e524d0a3be3 r14904:3e524d0a3be3 r14904:3e524d0a3be3 r14904:3e524d0a3be3 r14904:3e524d0a3be3 r14904:3e524d0a3be3 r14904:3e524d0a3be3 r14904:3e524d0a3be3 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r15826:ae8e8209155d r15826:ae8e8209155d r15826:ae8e8209155d r15826:ae8e8209155d r15826:ae8e8209155d r15826:ae8e8209155d r15826:ae8e8209155d r15826:ae8e8209155d r15826:ae8e8209155d r15826:ae8e8209155d r15826:ae8e8209155d r15826:ae8e8209155d r15826:ae8e8209155d r15826:ae8e8209155d r15826:ae8e8209155d r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r14504:48ad1703d7ec r5584:545d748cc681 r5609:a56ae00a9125 r15826:ae8e8209155d r5584:545d748cc681 r5584:545d748cc681 r14504:48ad1703d7ec r5584:545d748cc681 r14904:3e524d0a3be3 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r14905:b3c3b22637cc r14905:b3c3b22637cc r14905:b3c3b22637cc r14905:b3c3b22637cc r14905:b3c3b22637cc r15826:ae8e8209155d r5584:545d748cc681 r5609:a56ae00a9125 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r14904:3e524d0a3be3 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r10647:62911ec68e89 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r21020:2682f5e8a105 r21020:2682f5e8a105 r5584:545d748cc681 r14512:54f059802e55 r5584:545d748cc681 r21020:2682f5e8a105 r5584:545d748cc681 r15607:2d0c25dbce47 r21020:2682f5e8a105 r15607:2d0c25dbce47 r15607:2d0c25dbce47 r21020:2682f5e8a105 r21020:2682f5e8a105 r21020:2682f5e8a105 r21020:2682f5e8a105 r21020:2682f5e8a105 r21020:2682f5e8a105 r15607:2d0c25dbce47 r15607:2d0c25dbce47 r5584:545d748cc681 r15607:2d0c25dbce47 r15607:2d0c25dbce47 r15607:2d0c25dbce47 r19944:25a78576fb5e r21020:2682f5e8a105 r21020:2682f5e8a105 r21020:2682f5e8a105 r21020:2682f5e8a105 r21020:2682f5e8a105 r15607:2d0c25dbce47 r15607:2d0c25dbce47 r15607:2d0c25dbce47 r5584:545d748cc681 r15607:2d0c25dbce47 r21020:2682f5e8a105 r21020:2682f5e8a105 r21020:2682f5e8a105 r21020:2682f5e8a105 r15607:2d0c25dbce47 r21020:2682f5e8a105 r15607:2d0c25dbce47 r15607:2d0c25dbce47 r15607:2d0c25dbce47 r15607:2d0c25dbce47 r15607:2d0c25dbce47 r5584:545d748cc681 r15607:2d0c25dbce47 r15607:2d0c25dbce47 r15607:2d0c25dbce47 r15607:2d0c25dbce47 r15607:2d0c25dbce47 r5584:545d748cc681 r21020:2682f5e8a105 r21020:2682f5e8a105 r21020:2682f5e8a105 r15607:2d0c25dbce47 r15607:2d0c25dbce47 r15607:2d0c25dbce47 r15607:2d0c25dbce47 r15607:2d0c25dbce47 r15607:2d0c25dbce47 r21020:2682f5e8a105 r21020:2682f5e8a105 r15607:2d0c25dbce47 r5584:545d748cc681 r21020:2682f5e8a105 r21020:2682f5e8a105 r21020:2682f5e8a105 r21020:2682f5e8a105 r21020:2682f5e8a105 r5584:545d748cc681 r5584:545d748cc681 r21020:2682f5e8a105 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r19944:25a78576fb5e r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r9337:eae33d9f73f5 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r14498:ba88afbc611b r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r19944:25a78576fb5e r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r19944:25a78576fb5e r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r6123:049e9624d068 r5584:545d748cc681 r15218:cfb867a486b1 r15218:cfb867a486b1 r15218:cfb867a486b1 r15218:cfb867a486b1 r5584:545d748cc681 r6123:049e9624d068 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r15569:7f2810d85ccf r6123:049e9624d068 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r14498:ba88afbc611b r14512:54f059802e55 r5584:545d748cc681 r5584:545d748cc681 r21197:0ac0863ce5fb r14502:ced0a904f0d6 r14502:ced0a904f0d6 r5584:545d748cc681 r5584:545d748cc681 r15826:ae8e8209155d r15368:571fd357919c r5584:545d748cc681 r14907:1fcac3638575 r14907:1fcac3638575 r14907:1fcac3638575 r14907:1fcac3638575 r14907:1fcac3638575 r14907:1fcac3638575 r14907:1fcac3638575 r14907:1fcac3638575 r14907:1fcac3638575 r14907:1fcac3638575 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r14502:ced0a904f0d6 r15368:571fd357919c r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r14502:ced0a904f0d6 r5584:545d748cc681 | /* $Id$ */
/*
* This file is part of OpenTTD.
* OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
* OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
*/
/** @file console.cpp Handling of the in-game console. */
#include "stdafx.h"
#include "console_internal.h"
#include "network/network.h"
#include "network/network_func.h"
#include "network/network_admin.h"
#include "debug.h"
#include "console_func.h"
#include "settings_type.h"
#include <stdarg.h>
static const uint ICON_TOKEN_COUNT = 20; ///< Maximum number of tokens in one command
/* console parser */
IConsoleCmd *_iconsole_cmds; ///< list of registered commands
IConsoleAlias *_iconsole_aliases; ///< list of registered aliases
FILE *_iconsole_output_file;
void IConsoleInit()
{
_iconsole_output_file = NULL;
#ifdef ENABLE_NETWORK /* Initialize network only variables */
_redirect_console_to_client = INVALID_CLIENT_ID;
_redirect_console_to_admin = INVALID_ADMIN_ID;
#endif
IConsoleGUIInit();
IConsoleStdLibRegister();
}
static void IConsoleWriteToLogFile(const char *string)
{
if (_iconsole_output_file != NULL) {
/* if there is an console output file ... also print it there */
const char *header = GetLogPrefix();
if ((strlen(header) != 0 && fwrite(header, strlen(header), 1, _iconsole_output_file) != 1) ||
fwrite(string, strlen(string), 1, _iconsole_output_file) != 1 ||
fwrite("\n", 1, 1, _iconsole_output_file) != 1) {
fclose(_iconsole_output_file);
_iconsole_output_file = NULL;
IConsolePrintF(CC_DEFAULT, "cannot write to log file");
}
}
}
bool CloseConsoleLogIfActive()
{
if (_iconsole_output_file != NULL) {
IConsolePrintF(CC_DEFAULT, "file output complete");
fclose(_iconsole_output_file);
_iconsole_output_file = NULL;
return true;
}
return false;
}
void IConsoleFree()
{
IConsoleGUIFree();
CloseConsoleLogIfActive();
}
/**
* Handle the printing of text entered into the console or redirected there
* by any other means. Text can be redirected to other clients in a network game
* as well as to a logfile. If the network server is a dedicated server, all activities
* are also logged. All lines to print are added to a temporary buffer which can be
* used as a history to print them onscreen
* @param colour_code the colour of the command. Red in case of errors, etc.
* @param string the message entered or output on the console (notice, error, etc.)
*/
void IConsolePrint(TextColour colour_code, const char *string)
{
assert(IsValidConsoleColour(colour_code));
char *str;
#ifdef ENABLE_NETWORK
if (_redirect_console_to_client != INVALID_CLIENT_ID) {
/* Redirect the string to the client */
NetworkServerSendRcon(_redirect_console_to_client, colour_code, string);
return;
}
if (_redirect_console_to_admin != INVALID_ADMIN_ID) {
NetworkServerSendAdminRcon(_redirect_console_to_admin, colour_code, string);
return;
}
#endif
/* Create a copy of the string, strip if of colours and invalid
* characters and (when applicable) assign it to the console buffer */
str = strdup(string);
str_strip_colours(str);
str_validate(str, str + strlen(str));
if (_network_dedicated) {
#ifdef ENABLE_NETWORK
NetworkAdminConsole("console", str);
#endif /* ENABLE_NETWORK */
fprintf(stdout, "%s%s\n", GetLogPrefix(), str);
fflush(stdout);
IConsoleWriteToLogFile(str);
free(str); // free duplicated string since it's not used anymore
return;
}
IConsoleWriteToLogFile(str);
IConsoleGUIPrint(colour_code, str);
}
/**
* Handle the printing of text entered into the console or redirected there
* by any other means. Uses printf() style format, for more information look
* at IConsolePrint()
*/
void CDECL IConsolePrintF(TextColour colour_code, const char *format, ...)
{
assert(IsValidConsoleColour(colour_code));
va_list va;
char buf[ICON_MAX_STREAMSIZE];
va_start(va, format);
vsnprintf(buf, sizeof(buf), format, va);
va_end(va);
IConsolePrint(colour_code, buf);
}
/**
* It is possible to print debugging information to the console,
* which is achieved by using this function. Can only be used by
* debug() in debug.cpp. You need at least a level 2 (developer) for debugging
* messages to show up
* @param dbg debugging category
* @param string debugging message
*/
void IConsoleDebug(const char *dbg, const char *string)
{
if (_settings_client.gui.developer <= 1) return;
IConsolePrintF(CC_DEBUG, "dbg: [%s] %s", dbg, string);
}
/**
* It is possible to print warnings to the console. These are mostly
* errors or mishaps, but non-fatal. You need at least a level 1 (developer) for
* debugging messages to show up
*/
void IConsoleWarning(const char *string)
{
if (_settings_client.gui.developer == 0) return;
IConsolePrintF(CC_WARNING, "WARNING: %s", string);
}
/**
* It is possible to print error information to the console. This can include
* game errors, or errors in general you would want the user to notice
*/
void IConsoleError(const char *string)
{
IConsolePrintF(CC_ERROR, "ERROR: %s", string);
}
/**
* Change a string into its number representation. Supports
* decimal and hexadecimal numbers as well as 'on'/'off' 'true'/'false'
* @param *value the variable a successful conversion will be put in
* @param *arg the string to be converted
* @return Return true on success or false on failure
*/
bool GetArgumentInteger(uint32 *value, const char *arg)
{
char *endptr;
if (strcmp(arg, "on") == 0 || strcmp(arg, "true") == 0) {
*value = 1;
return true;
}
if (strcmp(arg, "off") == 0 || strcmp(arg, "false") == 0) {
*value = 0;
return true;
}
*value = strtoul(arg, &endptr, 0);
return arg != endptr;
}
/**
* Add an item to an alphabetically sorted list.
* @param base first item of the list
* @param item_new the item to add
*/
template<class T>
void IConsoleAddSorted(T **base, T *item_new)
{
if (*base == NULL) {
*base = item_new;
return;
}
T *item_before = NULL;
T *item = *base;
/* The list is alphabetically sorted, insert the new item at the correct location */
while (item != NULL) {
if (strcmp(item->name, item_new->name) > 0) break; // insert here
item_before = item;
item = item->next;
}
if (item_before == NULL) {
*base = item_new;
} else {
item_before->next = item_new;
}
item_new->next = item;
}
/**
* Remove underscores from a string; the string will be modified!
* @param name The string to remove the underscores from.
* @return #name.
*/
char *RemoveUnderscores(char *name)
{
char *q = name;
for (const char *p = name; *p != '\0'; p++) {
if (*p != '_') *q++ = *p;
}
*q = '\0';
return name;
}
/**
* Register a new command to be used in the console
* @param name name of the command that will be used
* @param proc function that will be called upon execution of command
*/
void IConsoleCmdRegister(const char *name, IConsoleCmdProc *proc, IConsoleHook *hook)
{
IConsoleCmd *item_new = MallocT<IConsoleCmd>(1);
item_new->name = RemoveUnderscores(strdup(name));
item_new->next = NULL;
item_new->proc = proc;
item_new->hook = hook;
IConsoleAddSorted(&_iconsole_cmds, item_new);
}
/**
* Find the command pointed to by its string
* @param name command to be found
* @return return Cmdstruct of the found command, or NULL on failure
*/
IConsoleCmd *IConsoleCmdGet(const char *name)
{
IConsoleCmd *item;
for (item = _iconsole_cmds; item != NULL; item = item->next) {
if (strcmp(item->name, name) == 0) return item;
}
return NULL;
}
/**
* Register a an alias for an already existing command in the console
* @param name name of the alias that will be used
* @param cmd name of the command that 'name' will be alias of
*/
void IConsoleAliasRegister(const char *name, const char *cmd)
{
if (IConsoleAliasGet(name) != NULL) {
IConsoleError("an alias with this name already exists; insertion aborted");
return;
}
char *new_alias = RemoveUnderscores(strdup(name));
char *cmd_aliased = strdup(cmd);
IConsoleAlias *item_new = MallocT<IConsoleAlias>(1);
item_new->next = NULL;
item_new->cmdline = cmd_aliased;
item_new->name = new_alias;
IConsoleAddSorted(&_iconsole_aliases, item_new);
}
/**
* Find the alias pointed to by its string
* @param name alias to be found
* @return return Aliasstruct of the found alias, or NULL on failure
*/
IConsoleAlias *IConsoleAliasGet(const char *name)
{
IConsoleAlias *item;
for (item = _iconsole_aliases; item != NULL; item = item->next) {
if (strcmp(item->name, name) == 0) return item;
}
return NULL;
}
/**
* An alias is just another name for a command, or for more commands
* Execute it as well.
* @param *alias is the alias of the command
* @param tokencount the number of parameters passed
* @param *tokens are the parameters given to the original command (0 is the first param)
*/
static void IConsoleAliasExec(const IConsoleAlias *alias, byte tokencount, char *tokens[ICON_TOKEN_COUNT])
{
char alias_buffer[ICON_MAX_STREAMSIZE] = { '\0' };
char *alias_stream = alias_buffer;
DEBUG(console, 6, "Requested command is an alias; parsing...");
for (const char *cmdptr = alias->cmdline; *cmdptr != '\0'; cmdptr++) {
switch (*cmdptr) {
case '\'': // ' will double for ""
alias_stream = strecpy(alias_stream, "\"", lastof(alias_buffer));
break;
case ';': // Cmd separator; execute previous and start new command
IConsoleCmdExec(alias_buffer);
alias_stream = alias_buffer;
*alias_stream = '\0'; // Make sure the new command is terminated.
cmdptr++;
break;
case '%': // Some or all parameters
cmdptr++;
switch (*cmdptr) {
case '+': { // All parameters separated: "[param 1]" "[param 2]"
for (uint i = 0; i != tokencount; i++) {
if (i != 0) alias_stream = strecpy(alias_stream, " ", lastof(alias_buffer));
alias_stream = strecpy(alias_stream, "\"", lastof(alias_buffer));
alias_stream = strecpy(alias_stream, tokens[i], lastof(alias_buffer));
alias_stream = strecpy(alias_stream, "\"", lastof(alias_buffer));
}
break;
}
case '!': { // Merge the parameters to one: "[param 1] [param 2] [param 3...]"
alias_stream = strecpy(alias_stream, "\"", lastof(alias_buffer));
for (uint i = 0; i != tokencount; i++) {
if (i != 0) alias_stream = strecpy(alias_stream, " ", lastof(alias_buffer));
alias_stream = strecpy(alias_stream, tokens[i], lastof(alias_buffer));
}
alias_stream = strecpy(alias_stream, "\"", lastof(alias_buffer));
break;
}
default: { // One specific parameter: %A = [param 1] %B = [param 2] ...
int param = *cmdptr - 'A';
if (param < 0 || param >= tokencount) {
IConsoleError("too many or wrong amount of parameters passed to alias, aborting");
IConsolePrintF(CC_WARNING, "Usage of alias '%s': %s", alias->name, alias->cmdline);
return;
}
alias_stream = strecpy(alias_stream, "\"", lastof(alias_buffer));
alias_stream = strecpy(alias_stream, tokens[param], lastof(alias_buffer));
alias_stream = strecpy(alias_stream, "\"", lastof(alias_buffer));
break;
}
}
break;
default:
*alias_stream++ = *cmdptr;
*alias_stream = '\0';
break;
}
if (alias_stream >= lastof(alias_buffer) - 1) {
IConsoleError("Requested alias execution would overflow execution buffer");
return;
}
}
IConsoleCmdExec(alias_buffer);
}
/**
* Execute a given command passed to us. First chop it up into
* individual tokens (separated by spaces), then execute it if possible
* @param cmdstr string to be parsed and executed
*/
void IConsoleCmdExec(const char *cmdstr)
{
const char *cmdptr;
char *tokens[ICON_TOKEN_COUNT], tokenstream[ICON_MAX_STREAMSIZE];
uint t_index, tstream_i;
bool longtoken = false;
bool foundtoken = false;
if (cmdstr[0] == '#') return; // comments
for (cmdptr = cmdstr; *cmdptr != '\0'; cmdptr++) {
if (!IsValidChar(*cmdptr, CS_ALPHANUMERAL)) {
IConsoleError("command contains malformed characters, aborting");
IConsolePrintF(CC_ERROR, "ERROR: command was: '%s'", cmdstr);
return;
}
}
DEBUG(console, 4, "Executing cmdline: '%s'", cmdstr);
memset(&tokens, 0, sizeof(tokens));
memset(&tokenstream, 0, sizeof(tokenstream));
/* 1. Split up commandline into tokens, separated by spaces, commands
* enclosed in "" are taken as one token. We can only go as far as the amount
* of characters in our stream or the max amount of tokens we can handle */
for (cmdptr = cmdstr, t_index = 0, tstream_i = 0; *cmdptr != '\0'; cmdptr++) {
if (t_index >= lengthof(tokens) || tstream_i >= lengthof(tokenstream)) break;
switch (*cmdptr) {
case ' ': // Token separator
if (!foundtoken) break;
if (longtoken) {
tokenstream[tstream_i] = *cmdptr;
} else {
tokenstream[tstream_i] = '\0';
foundtoken = false;
}
tstream_i++;
break;
case '"': // Tokens enclosed in "" are one token
longtoken = !longtoken;
if (!foundtoken) {
tokens[t_index++] = &tokenstream[tstream_i];
foundtoken = true;
}
break;
case '\\': // Escape character for ""
if (cmdptr[1] == '"' && tstream_i + 1 < lengthof(tokenstream)) {
tokenstream[tstream_i++] = *++cmdptr;
break;
}
/* FALL THROUGH */
default: // Normal character
tokenstream[tstream_i++] = *cmdptr;
if (!foundtoken) {
tokens[t_index++] = &tokenstream[tstream_i - 1];
foundtoken = true;
}
break;
}
}
for (uint i = 0; tokens[i] != NULL; i++) {
DEBUG(console, 8, "Token %d is: '%s'", i, tokens[i]);
}
if (StrEmpty(tokens[0])) return; // don't execute empty commands
/* 2. Determine type of command (cmd or alias) and execute
* First try commands, then aliases. Execute
* the found action taking into account its hooking code
*/
RemoveUnderscores(tokens[0]);
IConsoleCmd *cmd = IConsoleCmdGet(tokens[0]);
if (cmd != NULL) {
ConsoleHookResult chr = (cmd->hook == NULL ? CHR_ALLOW : cmd->hook(true));
switch (chr) {
case CHR_ALLOW:
if (!cmd->proc(t_index, tokens)) { // index started with 0
cmd->proc(0, NULL); // if command failed, give help
}
return;
case CHR_DISALLOW: return;
case CHR_HIDE: break;
}
}
t_index--;
IConsoleAlias *alias = IConsoleAliasGet(tokens[0]);
if (alias != NULL) {
IConsoleAliasExec(alias, t_index, &tokens[1]);
return;
}
IConsoleError("command not found");
}
|