OpenTTD Source: src/console_gui.cpp Source File

OpenTTD Source 12.2

console_gui.cpp
Go to the documentation of this file.
1 /*
2 * This file is part of OpenTTD.
3 * 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.
4 * 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.
5 * 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/>.
6 */
7
10 #include "stdafx.h"
11 #include "textbuf_type.h"
12 #include "window_gui.h"
13 #include "console_gui.h"
14 #include "console_internal.h"
15 #include "guitimer_func.h"
16 #include "window_func.h"
17 #include "string_func.h"
18 #include "strings_func.h"
19 #include "gfx_func.h"
20 #include "settings_type.h"
21 #include "console_func.h"
22 #include "rev.h"
23 #include "video/video_driver.hpp"
24
25 #include "widgets/console_widget.h"
26
27 #include "table/strings.h"
28
29 #include "safeguards.h"
30
31 static const uint ICON_HISTORY_SIZE = 20;
32 static const uint ICON_LINE_SPACING = 2;
33 static const uint ICON_RIGHT_BORDERWIDTH = 10;
34 static const uint ICON_BOTTOM_BORDERWIDTH = 12;
35
39 struct IConsoleLine {
40 static IConsoleLine *front;
41 static int size;
42
43 IConsoleLine *previous;
44 char *buffer;
45 TextColour colour;
46 uint16 time;
47
53 IConsoleLine(char *buffer, TextColour colour) :
54 previous(IConsoleLine::front),
55 buffer(buffer),
56 colour(colour),
57 time(0)
58 {
59 IConsoleLine::front = this;
60 IConsoleLine::size++;
61 }
62
66 ~IConsoleLine()
67 {
68 IConsoleLine::size--;
69 free(buffer);
70
71 delete previous;
72 }
73
77 static const IConsoleLine *Get(uint index)
78 {
79 const IConsoleLine *item = IConsoleLine::front;
80 while (index != 0 && item != nullptr) {
81 index--;
82 item = item->previous;
83 }
84
85 return item;
86 }
87
95 static bool Truncate()
96 {
97 IConsoleLine *cur = IConsoleLine::front;
98 if (cur == nullptr) return false;
99
100 int count = 1;
101 for (IConsoleLine *item = cur->previous; item != nullptr; count++, cur = item, item = item->previous) {
102 if (item->time > _settings_client.gui.console_backlog_timeout &&
103 count > _settings_client.gui.console_backlog_length) {
104 delete item;
105 cur->previous = nullptr;
106 return true;
107 }
108
109 if (item->time != MAX_UVALUE(uint16)) item->time++;
110 }
111
112 return false;
113 }
114
118 static void Reset()
119 {
120 delete IConsoleLine::front;
121 IConsoleLine::front = nullptr;
122 IConsoleLine::size = 0;
123 }
124 };
125
126 /* static */ IConsoleLine *IConsoleLine::front = nullptr;
127 /* static */ int IConsoleLine::size = 0;
128
129
130 /* ** main console cmd buffer ** */
131 static Textbuf _iconsole_cmdline(ICON_CMDLN_SIZE);
132 static char *_iconsole_history[ICON_HISTORY_SIZE];
133 static int _iconsole_historypos;
134 IConsoleModes _iconsole_mode;
135
136 /* *************** *
137 * end of header *
138 * *************** */
139
140 static void IConsoleClearCommand()
141 {
142 memset(_iconsole_cmdline.buf, 0, ICON_CMDLN_SIZE);
143 _iconsole_cmdline.chars = _iconsole_cmdline.bytes = 1; // only terminating zero
144 _iconsole_cmdline.pixels = 0;
145 _iconsole_cmdline.caretpos = 0;
146 _iconsole_cmdline.caretxoffs = 0;
147 SetWindowDirty(WC_CONSOLE, 0);
148 }
149
150 static inline void IConsoleResetHistoryPos()
151 {
152 _iconsole_historypos = -1;
153 }
154
155
156 static const char *IConsoleHistoryAdd(const char *cmd);
157 static void IConsoleHistoryNavigate(int direction);
158
159 static const struct NWidgetPart _nested_console_window_widgets[] = {
160 NWidget(WWT_EMPTY, INVALID_COLOUR, WID_C_BACKGROUND), SetResize(1, 1),
161 };
162
163 static WindowDesc _console_window_desc(
164 WDP_MANUAL, nullptr, 0, 0,
165 WC_CONSOLE, WC_NONE,
166 0,
167 _nested_console_window_widgets, lengthof(_nested_console_window_widgets)
168 );
169
170 struct IConsoleWindow : Window
171 {
172 static int scroll;
173 int line_height;
174 int line_offset;
175 GUITimer truncate_timer;
176
177 IConsoleWindow() : Window(&_console_window_desc)
178 {
179 _iconsole_mode = ICONSOLE_OPENED;
180 this->line_height = FONT_HEIGHT_NORMAL + ICON_LINE_SPACING;
181 this->line_offset = GetStringBoundingBox("] ").width + 5;
182
183 this->InitNested(0);
184 this->truncate_timer.SetInterval(3000);
185 ResizeWindow(this, _screen.width, _screen.height / 3);
186 }
187
188 void Close() override
189 {
190 _iconsole_mode = ICONSOLE_CLOSED;
191 VideoDriver::GetInstance()->EditBoxLostFocus();
192 this->Window::Close();
193 }
194
199 void Scroll(int amount)
200 {
201 int max_scroll = std::max(0, IConsoleLine::size + 1 - this->height / this->line_height);
202 IConsoleWindow::scroll = Clamp<int>(IConsoleWindow::scroll + amount, 0, max_scroll);
203 this->SetDirty();
204 }
205
206 void OnPaint() override
207 {
208 const int right = this->width - 5;
209
210 GfxFillRect(0, 0, this->width - 1, this->height - 1, PC_BLACK);
211 int ypos = this->height - this->line_height;
212 for (const IConsoleLine *print = IConsoleLine::Get(IConsoleWindow::scroll); print != nullptr; print = print->previous) {
213 SetDParamStr(0, print->buffer);
214 ypos = DrawStringMultiLine(5, right, -this->line_height, ypos, STR_JUST_RAW_STRING, print->colour, SA_LEFT | SA_BOTTOM | SA_FORCE) - ICON_LINE_SPACING;
215 if (ypos < 0) break;
216 }
217 /* If the text is longer than the window, don't show the starting ']' */
218 int delta = this->width - this->line_offset - _iconsole_cmdline.pixels - ICON_RIGHT_BORDERWIDTH;
219 if (delta > 0) {
220 DrawString(5, right, this->height - this->line_height, "]", (TextColour)CC_COMMAND, SA_LEFT | SA_FORCE);
221 delta = 0;
222 }
223
224 /* If we have a marked area, draw a background highlight. */
225 if (_iconsole_cmdline.marklength != 0) GfxFillRect(this->line_offset + delta + _iconsole_cmdline.markxoffs, this->height - this->line_height, this->line_offset + delta + _iconsole_cmdline.markxoffs + _iconsole_cmdline.marklength, this->height - 1, PC_DARK_RED);
226
227 DrawString(this->line_offset + delta, right, this->height - this->line_height, _iconsole_cmdline.buf, (TextColour)CC_COMMAND, SA_LEFT | SA_FORCE);
228
229 if (_focused_window == this && _iconsole_cmdline.caret) {
230 DrawString(this->line_offset + delta + _iconsole_cmdline.caretxoffs, right, this->height - this->line_height, "_", TC_WHITE, SA_LEFT | SA_FORCE);
231 }
232 }
233
234 void OnRealtimeTick(uint delta_ms) override
235 {
236 if (this->truncate_timer.CountElapsed(delta_ms) == 0) return;
237
238 if (IConsoleLine::Truncate() &&
239 (IConsoleWindow::scroll > IConsoleLine::size)) {
240 IConsoleWindow::scroll = std::max(0, IConsoleLine::size - (this->height / this->line_height) + 1);
241 this->SetDirty();
242 }
243 }
244
245 void OnMouseLoop() override
246 {
247 if (_iconsole_cmdline.HandleCaret()) this->SetDirty();
248 }
249
250 EventState OnKeyPress(WChar key, uint16 keycode) override
251 {
252 if (_focused_window != this) return ES_NOT_HANDLED;
253
254 const int scroll_height = (this->height / this->line_height) - 1;
255 switch (keycode) {
256 case WKC_UP:
257 IConsoleHistoryNavigate(1);
258 this->SetDirty();
259 break;
260
261 case WKC_DOWN:
262 IConsoleHistoryNavigate(-1);
263 this->SetDirty();
264 break;
265
266 case WKC_SHIFT | WKC_PAGEDOWN:
267 this->Scroll(-scroll_height);
268 break;
269
270 case WKC_SHIFT | WKC_PAGEUP:
271 this->Scroll(scroll_height);
272 break;
273
274 case WKC_SHIFT | WKC_DOWN:
275 this->Scroll(-1);
276 break;
277
278 case WKC_SHIFT | WKC_UP:
279 this->Scroll(1);
280 break;
281
282 case WKC_BACKQUOTE:
283 IConsoleSwitch();
284 break;
285
286 case WKC_RETURN: case WKC_NUM_ENTER: {
287 /* We always want the ] at the left side; we always force these strings to be left
288 * aligned anyway. So enforce this in all cases by adding a left-to-right marker,
289 * otherwise it will be drawn at the wrong side with right-to-left texts. */
290 IConsolePrint(CC_COMMAND, LRM "] {}", _iconsole_cmdline.buf);
291 const char *cmd = IConsoleHistoryAdd(_iconsole_cmdline.buf);
292 IConsoleClearCommand();
293
294 if (cmd != nullptr) IConsoleCmdExec(cmd);
295 break;
296 }
297
298 case WKC_CTRL | WKC_RETURN:
299 _iconsole_mode = (_iconsole_mode == ICONSOLE_FULL) ? ICONSOLE_OPENED : ICONSOLE_FULL;
300 IConsoleResize(this);
301 MarkWholeScreenDirty();
302 break;
303
304 case (WKC_CTRL | 'L'):
305 IConsoleCmdExec("clear");
306 break;
307
308 default:
309 if (_iconsole_cmdline.HandleKeyPress(key, keycode) != HKPR_NOT_HANDLED) {
310 IConsoleWindow::scroll = 0;
311 IConsoleResetHistoryPos();
312 this->SetDirty();
313 } else {
314 return ES_NOT_HANDLED;
315 }
316 break;
317 }
318 return ES_HANDLED;
319 }
320
321 void InsertTextString(int wid, const char *str, bool marked, const char *caret, const char *insert_location, const char *replacement_end) override
322 {
323 if (_iconsole_cmdline.InsertString(str, marked, caret, insert_location, replacement_end)) {
324 IConsoleWindow::scroll = 0;
325 IConsoleResetHistoryPos();
326 this->SetDirty();
327 }
328 }
329
330 const char *GetFocusedText() const override
331 {
332 return _iconsole_cmdline.buf;
333 }
334
335 const char *GetCaret() const override
336 {
337 return _iconsole_cmdline.buf + _iconsole_cmdline.caretpos;
338 }
339
340 const char *GetMarkedText(size_t *length) const override
341 {
342 if (_iconsole_cmdline.markend == 0) return nullptr;
343
344 *length = _iconsole_cmdline.markend - _iconsole_cmdline.markpos;
345 return _iconsole_cmdline.buf + _iconsole_cmdline.markpos;
346 }
347
348 Point GetCaretPosition() const override
349 {
350 int delta = std::min<int>(this->width - this->line_offset - _iconsole_cmdline.pixels - ICON_RIGHT_BORDERWIDTH, 0);
351 Point pt = {this->line_offset + delta + _iconsole_cmdline.caretxoffs, this->height - this->line_height};
352
353 return pt;
354 }
355
356 Rect GetTextBoundingRect(const char *from, const char *to) const override
357 {
358 int delta = std::min<int>(this->width - this->line_offset - _iconsole_cmdline.pixels - ICON_RIGHT_BORDERWIDTH, 0);
359
360 Point p1 = GetCharPosInString(_iconsole_cmdline.buf, from, FS_NORMAL);
361 Point p2 = from != to ? GetCharPosInString(_iconsole_cmdline.buf, from) : p1;
362
363 Rect r = {this->line_offset + delta + p1.x, this->height - this->line_height, this->line_offset + delta + p2.x, this->height};
364 return r;
365 }
366
367 const char *GetTextCharacterAtPosition(const Point &pt) const override
368 {
369 int delta = std::min<int>(this->width - this->line_offset - _iconsole_cmdline.pixels - ICON_RIGHT_BORDERWIDTH, 0);
370
371 if (!IsInsideMM(pt.y, this->height - this->line_height, this->height)) return nullptr;
372
373 return GetCharAtPosition(_iconsole_cmdline.buf, pt.x - delta);
374 }
375
376 void OnMouseWheel(int wheel) override
377 {
378 this->Scroll(-wheel);
379 }
380
381 void OnFocus() override
382 {
383 VideoDriver::GetInstance()->EditBoxGainedFocus();
384 }
385
386 void OnFocusLost() override
387 {
388 VideoDriver::GetInstance()->EditBoxLostFocus();
389 }
390 };
391
392 int IConsoleWindow::scroll = 0;
393
394 void IConsoleGUIInit()
395 {
396 IConsoleResetHistoryPos();
397 _iconsole_mode = ICONSOLE_CLOSED;
398
399 IConsoleLine::Reset();
400 memset(_iconsole_history, 0, sizeof(_iconsole_history));
401
402 IConsolePrint(TC_LIGHT_BLUE, "OpenTTD Game Console Revision 7 - {}", _openttd_revision);
403 IConsolePrint(CC_WHITE, "------------------------------------");
404 IConsolePrint(CC_WHITE, "use \"help\" for more information.");
405 IConsolePrint(CC_WHITE, "");
406 IConsoleClearCommand();
407 }
408
409 void IConsoleClearBuffer()
410 {
411 IConsoleLine::Reset();
412 }
413
414 void IConsoleGUIFree()
415 {
416 IConsoleClearBuffer();
417 }
418
420 void IConsoleResize(Window *w)
421 {
422 switch (_iconsole_mode) {
423 case ICONSOLE_OPENED:
424 w->height = _screen.height / 3;
425 w->width = _screen.width;
426 break;
427 case ICONSOLE_FULL:
428 w->height = _screen.height - ICON_BOTTOM_BORDERWIDTH;
429 w->width = _screen.width;
430 break;
431 default: return;
432 }
433
434 MarkWholeScreenDirty();
435 }
436
438 void IConsoleSwitch()
439 {
440 switch (_iconsole_mode) {
441 case ICONSOLE_CLOSED:
442 new IConsoleWindow();
443 break;
444
445 case ICONSOLE_OPENED: case ICONSOLE_FULL:
446 CloseWindowById(WC_CONSOLE, 0);
447 break;
448 }
449
450 MarkWholeScreenDirty();
451 }
452
454 void IConsoleClose()
455 {
456 if (_iconsole_mode == ICONSOLE_OPENED) IConsoleSwitch();
457 }
458
465 static const char *IConsoleHistoryAdd(const char *cmd)
466 {
467 /* Strip all spaces at the begin */
468 while (IsWhitespace(*cmd)) cmd++;
469
470 /* Do not put empty command in history */
471 if (StrEmpty(cmd)) return nullptr;
472
473 /* Do not put in history if command is same as previous */
474 if (_iconsole_history[0] == nullptr || strcmp(_iconsole_history[0], cmd) != 0) {
475 free(_iconsole_history[ICON_HISTORY_SIZE - 1]);
476 memmove(&_iconsole_history[1], &_iconsole_history[0], sizeof(_iconsole_history[0]) * (ICON_HISTORY_SIZE - 1));
477 _iconsole_history[0] = stredup(cmd);
478 }
479
480 /* Reset the history position */
481 IConsoleResetHistoryPos();
482 return _iconsole_history[0];
483 }
484
489 static void IConsoleHistoryNavigate(int direction)
490 {
491 if (_iconsole_history[0] == nullptr) return; // Empty history
492 _iconsole_historypos = Clamp(_iconsole_historypos + direction, -1, ICON_HISTORY_SIZE - 1);
493
494 if (direction > 0 && _iconsole_history[_iconsole_historypos] == nullptr) _iconsole_historypos--;
495
496 if (_iconsole_historypos == -1) {
497 _iconsole_cmdline.DeleteAll();
498 } else {
499 _iconsole_cmdline.Assign(_iconsole_history[_iconsole_historypos]);
500 }
501 }
502
512 void IConsoleGUIPrint(TextColour colour_code, char *str)
513 {
514 new IConsoleLine(str, colour_code);
515 SetWindowDirty(WC_CONSOLE, 0);
516 }
517
518
524 bool IsValidConsoleColour(TextColour c)
525 {
526 /* A normal text colour is used. */
527 if (!(c & TC_IS_PALETTE_COLOUR)) return TC_BEGIN <= c && c < TC_END;
528
529 /* A text colour from the palette is used; must be the company
530 * colour gradient, so it must be one of those. */
531 c &= ~TC_IS_PALETTE_COLOUR;
532 for (uint i = COLOUR_BEGIN; i < COLOUR_END; i++) {
533 if (_colour_gradient[i][4] == c) return true;
534 }
535
536 return false;
537 }
ES_HANDLED
@ ES_HANDLED
The passed event is handled.
Definition: window_type.h:718
IConsoleWindow::GetMarkedText
const char * GetMarkedText(size_t *length) const override
Get the range of the currently marked input text.
Definition: console_gui.cpp:340
ICONSOLE_OPENED
@ ICONSOLE_OPENED
In-game console is opened, upper 1/3 of the screen.
Definition: console_type.h:18
IConsoleLine::Reset
static void Reset()
Reset the complete console line backlog.
Definition: console_gui.cpp:118
WChar
char32_t WChar
Type for wide characters, i.e.
Definition: string_type.h:35
SetWindowDirty
void SetWindowDirty(WindowClass cls, WindowNumber number)
Mark window as dirty (in need of repainting)
Definition: window.cpp:3136
IConsoleLine::front
static IConsoleLine * front
The front of the console backlog buffer.
Definition: console_gui.cpp:40
IConsoleLine::size
static int size
The amount of items in the backlog.
Definition: console_gui.cpp:41
textbuf_type.h
IConsoleLine
Container for a single line of console output.
Definition: console_gui.cpp:39
PC_DARK_RED
static const uint8 PC_DARK_RED
Dark red palette colour.
Definition: gfx_func.h:198
console_widget.h
guitimer_func.h
IConsoleLine::time
uint16 time
The amount of time the line is in the backlog.
Definition: console_gui.cpp:46
ICON_CMDLN_SIZE
static const uint ICON_CMDLN_SIZE
maximum length of a typed in command
Definition: console_internal.h:16
Textbuf::Assign
void Assign(StringID string)
Render a string into the textbuffer.
Definition: textbuf.cpp:396
IConsoleWindow::OnRealtimeTick
void OnRealtimeTick(uint delta_ms) override
Called periodically.
Definition: console_gui.cpp:234
IConsoleLine::buffer
char * buffer
The data to store.
Definition: console_gui.cpp:44
IConsoleHistoryAdd
static const char * IConsoleHistoryAdd(const char *cmd)
Add the entered line into the history so you can look it back scroll, etc.
Definition: console_gui.cpp:465
Textbuf::caretpos
uint16 caretpos
the current position of the caret in the buffer, in bytes
Definition: textbuf_type.h:39
IConsoleWindow::GetCaret
const char * GetCaret() const override
Get the string at the caret if an edit box has the focus.
Definition: console_gui.cpp:335
IConsoleWindow::Scroll
void Scroll(int amount)
Scroll the content of the console.
Definition: console_gui.cpp:199
IConsoleWindow::InsertTextString
void InsertTextString(int wid, const char *str, bool marked, const char *caret, const char *insert_location, const char *replacement_end) override
Insert a text string at the cursor position into the edit box widget.
Definition: console_gui.cpp:321
IConsoleWindow::OnFocus
void OnFocus() override
Called when window gains focus.
Definition: console_gui.cpp:381
TextColour
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition: gfx_type.h:250
Textbuf::caretxoffs
uint16 caretxoffs
the current position of the caret in pixels
Definition: textbuf_type.h:40
SetResize
static NWidgetPart SetResize(int16 dx, int16 dy)
Widget part function for setting the resize step.
Definition: widget_type.h:993
SA_BOTTOM
@ SA_BOTTOM
Bottom align the text.
Definition: gfx_type.h:335
_settings_client
ClientSettings _settings_client
The current settings for this game.
Definition: settings.cpp:52
IConsoleWindow::GetTextBoundingRect
Rect GetTextBoundingRect(const char *from, const char *to) const override
Get the bounding rectangle for a text range if an edit box has the focus.
Definition: console_gui.cpp:356
DrawString
int DrawString(int left, int right, int top, const char *str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly truncated to make it fit in its allocated space.
Definition: gfx.cpp:643
WWT_EMPTY
@ WWT_EMPTY
Empty widget, place holder to reserve space in widget array.
Definition: widget_type.h:46
IConsoleModes
IConsoleModes
Modes of the in-game console.
Definition: console_type.h:16
Textbuf::markpos
uint16 markpos
the start position of the marked area in the buffer, in bytes
Definition: textbuf_type.h:41
IConsoleGUIPrint
void IConsoleGUIPrint(TextColour colour_code, char *str)
Handle the printing of text entered into the console or redirected there by any other means.
Definition: console_gui.cpp:512
_colour_gradient
byte _colour_gradient[COLOUR_END][8]
All 16 colour gradients 8 colours per gradient from darkest (0) to lightest (7)
Definition: gfx.cpp:53
NWidgetPart
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:971
Textbuf::InsertString
bool InsertString(const char *str, bool marked, const char *caret=nullptr, const char *insert_location=nullptr, const char *replacement_end=nullptr)
Insert a string into the text buffer.
Definition: textbuf.cpp:162
GUISettings::console_backlog_timeout
uint16 console_backlog_timeout
the minimum amount of time items should be in the console backlog before they will be removed in ~3 s...
Definition: settings_type.h:176
Textbuf::pixels
uint16 pixels
the current size of the string in pixels
Definition: textbuf_type.h:37
GetStringBoundingBox
Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition: gfx.cpp:889
Textbuf::buf
char *const buf
buffer in which text is saved
Definition: textbuf_type.h:32
IConsoleLine::Truncate
static bool Truncate()
Truncate the list removing everything older than/more than the amount as specified in the config file...
Definition: console_gui.cpp:95
DrawStringMultiLine
int DrawStringMultiLine(int left, int right, int top, int bottom, const char *str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly over multiple lines.
Definition: gfx.cpp:788
IsInsideMM
static bool IsInsideMM(const T x, const size_t min, const size_t max)
Checks if a value is in an interval.
Definition: math_func.hpp:204
gfx_func.h
ICONSOLE_FULL
@ ICONSOLE_FULL
In-game console is opened, whole screen.
Definition: console_type.h:17
WindowDesc
High level window description.
Definition: window_gui.h:168
window_gui.h
Textbuf::HandleCaret
bool HandleCaret()
Handle the flashing of the caret.
Definition: textbuf.cpp:456
GUITimer
Definition: guitimer_func.h:13
IConsoleWindow::GetFocusedText
const char * GetFocusedText() const override
Get the current input text if an edit box has the focus.
Definition: console_gui.cpp:330
ICONSOLE_CLOSED
@ ICONSOLE_CLOSED
In-game console is closed.
Definition: console_type.h:19
FS_NORMAL
@ FS_NORMAL
Index of the normal font in the font tables.
Definition: gfx_type.h:207
Window::InitNested
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
Definition: window.cpp:1789
GUISettings::console_backlog_length
uint16 console_backlog_length
the minimum amount of items in the console backlog before items will be removed.
Definition: settings_type.h:177
Window::height
int height
Height of the window (number of pixels down in y direction)
Definition: window_gui.h:315
Textbuf::marklength
uint16 marklength
the length of the marked area in pixels
Definition: textbuf_type.h:44
Window::SetDirty
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
Definition: window.cpp:993
console_internal.h
IConsoleHistoryNavigate
static void IConsoleHistoryNavigate(int direction)
Navigate Up/Down in the history of typed commands.
Definition: console_gui.cpp:489
IConsoleWindow::line_height
int line_height
Height of one line of text in the console.
Definition: console_gui.cpp:173
IConsoleWindow::GetCaretPosition
Point GetCaretPosition() const override
Get the current caret position if an edit box has the focus.
Definition: console_gui.cpp:348
ES_NOT_HANDLED
@ ES_NOT_HANDLED
The passed event is not handled.
Definition: window_type.h:719
IConsoleWindow::Close
void Close() override
Hide the window and all its child windows, and mark them for a later deletion.
Definition: console_gui.cpp:188
TC_IS_PALETTE_COLOUR
@ TC_IS_PALETTE_COLOUR
Colour value is already a real palette colour index, not an index of a StringColour.
Definition: gfx_type.h:273
SA_FORCE
@ SA_FORCE
Force the alignment, i.e. don't swap for RTL languages.
Definition: gfx_type.h:340
GetCharAtPosition
const char * GetCharAtPosition(const char *str, int x, FontSize start_fontsize)
Get the character from a string that is drawn at a specific position.
Definition: gfx.cpp:945
IConsoleWindow::OnMouseLoop
void OnMouseLoop() override
Called for every mouse loop run, which is at least once per (game) tick.
Definition: console_gui.cpp:245
safeguards.h
IConsoleLine::colour
TextColour colour
The colour of the line.
Definition: console_gui.cpp:45
Textbuf::caret
bool caret
is the caret ("_") visible or not
Definition: textbuf_type.h:38
StrEmpty
static bool StrEmpty(const char *s)
Check if a string buffer is empty.
Definition: string_func.h:64
IConsoleResize
void IConsoleResize(Window *w)
Change the size of the in-game console window after the screen size changed, or the window state chan...
Definition: console_gui.cpp:420
IConsoleLine::~IConsoleLine
~IConsoleLine()
Clear this console line and any further ones.
Definition: console_gui.cpp:66
settings_type.h
Point
Coordinates of a point in 2D.
Definition: geometry_type.hpp:21
IConsoleLine::Get
static const IConsoleLine * Get(uint index)
Get the index-ed item in the list.
Definition: console_gui.cpp:77
stdafx.h
PC_BLACK
static const uint8 PC_BLACK
Black palette colour.
Definition: gfx_func.h:192
GfxFillRect
void GfxFillRect(int left, int top, int right, int bottom, int colour, FillRectMode mode)
Applies a certain FillRectMode-operation to a rectangle [left, right] x [top, bottom] on the screen.
Definition: gfx.cpp:117
CC_COMMAND
static const TextColour CC_COMMAND
Colour for the console's commands.
Definition: console_type.h:29
VideoDriver::GetInstance
static VideoDriver * GetInstance()
Get the currently active instance of the video driver.
Definition: video_driver.hpp:199
WC_NONE
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
Definition: window_type.h:37
IConsoleClose
void IConsoleClose()
Close the in-game console.
Definition: console_gui.cpp:454
IConsoleWindow::GetTextCharacterAtPosition
const char * GetTextCharacterAtPosition(const Point &pt) const override
Get the character that is rendered at a position by the focused edit box.
Definition: console_gui.cpp:367
LRM
#define LRM
A left-to-right marker, marks the next character as left-to-right.
Definition: string_type.h:21
Textbuf::markend
uint16 markend
the end position of the marked area in the buffer, in bytes
Definition: textbuf_type.h:42
string_func.h
Textbuf::bytes
uint16 bytes
the current size of the string in bytes (including terminating '\0')
Definition: textbuf_type.h:35
rev.h
Clamp
static T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
Definition: math_func.hpp:77
strings_func.h
IConsoleWindow::OnMouseWheel
void OnMouseWheel(int wheel) override
The mouse wheel has been turned.
Definition: console_gui.cpp:376
IConsoleWindow
Definition: console_gui.cpp:170
FONT_HEIGHT_NORMAL
#define FONT_HEIGHT_NORMAL
Height of characters in the normal (FS_NORMAL) font.
Definition: gfx_func.h:167
video_driver.hpp
NWidget
static NWidgetPart NWidget(WidgetType tp, Colours col, int16 idx=-1)
Widget part function for starting a new 'real' widget.
Definition: widget_type.h:1207
IConsoleLine::IConsoleLine
IConsoleLine(char *buffer, TextColour colour)
Initialize the console line.
Definition: console_gui.cpp:53
WC_CONSOLE
@ WC_CONSOLE
Console; Window numbers:
Definition: window_type.h:629
IConsoleLine::previous
IConsoleLine * previous
The previous console message.
Definition: console_gui.cpp:43
WID_C_BACKGROUND
@ WID_C_BACKGROUND
Background of the console.
Definition: console_widget.h:15
EventState
EventState
State of handling an event.
Definition: window_type.h:717
MAX_UVALUE
#define MAX_UVALUE(type)
The largest value that can be entered in a variable.
Definition: stdafx.h:469
GUITimer::CountElapsed
uint CountElapsed(uint delta)
Count how many times the interval has elapsed.
Definition: guitimer_func.h:40
stredup
char * stredup(const char *s, const char *last)
Create a duplicate of the given string.
Definition: string.cpp:137
SA_LEFT
@ SA_LEFT
Left align the text.
Definition: gfx_type.h:328
window_func.h
lengthof
#define lengthof(x)
Return the length of an fixed size array.
Definition: stdafx.h:378
Window::width
int width
width of the window (number of pixels to the right in x direction)
Definition: window_gui.h:314
MarkWholeScreenDirty
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
Definition: gfx.cpp:1751
WDP_MANUAL
@ WDP_MANUAL
Manually align the window (so no automatic location finding)
Definition: window_gui.h:155
CloseWindowById
void CloseWindowById(WindowClass cls, WindowNumber number, bool force)
Close a window by its class and window number (if it is open).
Definition: window.cpp:1176
Textbuf::chars
uint16 chars
the current size of the string in characters (including terminating '\0')
Definition: textbuf_type.h:36
IsWhitespace
static bool IsWhitespace(WChar c)
Check whether UNICODE character is whitespace or not, i.e.
Definition: string_func.h:257
console_gui.h
IConsoleCmdExec
void IConsoleCmdExec(const char *cmdstr, const uint recurse_count)
Execute a given command passed to us.
Definition: console.cpp:302
VideoDriver::EditBoxLostFocus
virtual void EditBoxLostFocus()
An edit box lost the input focus.
Definition: video_driver.hpp:153
Window
Data structure for an opened window.
Definition: window_gui.h:279
IConsoleSwitch
void IConsoleSwitch()
Toggle in-game console between opened and closed.
Definition: console_gui.cpp:438
IConsoleWindow::OnFocusLost
void OnFocusLost() override
Called when window loses focus.
Definition: console_gui.cpp:386
IsValidConsoleColour
bool IsValidConsoleColour(TextColour c)
Check whether the given TextColour is valid for console usage.
Definition: console_gui.cpp:524
console_func.h
HKPR_NOT_HANDLED
@ HKPR_NOT_HANDLED
Key does not affect editboxes.
Definition: textbuf_type.h:26
free
static void free(const void *ptr)
Version of the standard free that accepts const pointers.
Definition: stdafx.h:460
IConsoleWindow::OnPaint
void OnPaint() override
The window must be repainted.
Definition: console_gui.cpp:206
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition: geometry_type.hpp:47
CC_WHITE
static const TextColour CC_WHITE
White console lines for various things such as the welcome.
Definition: console_type.h:30
GetCharPosInString
Point GetCharPosInString(const char *str, const char *ch, FontSize start_fontsize)
Get the leading corner of a character in a single-line string relative to the start of the string.
Definition: gfx.cpp:932
IConsoleWindow::OnKeyPress
EventState OnKeyPress(WChar key, uint16 keycode) override
A key has been pressed.
Definition: console_gui.cpp:250
Textbuf::DeleteAll
void CDECL void DeleteAll()
Delete every character in the textbuffer.
Definition: textbuf.cpp:116
SetDParamStr
void SetDParamStr(uint n, const char *str)
This function is used to "bind" a C string to a OpenTTD dparam slot.
Definition: strings.cpp:296
ClientSettings::gui
GUISettings gui
settings related to the GUI
Definition: settings_type.h:594
VideoDriver::EditBoxGainedFocus
virtual void EditBoxGainedFocus()
An edit box gained the input focus.
Definition: video_driver.hpp:158
ResizeWindow
void ResizeWindow(Window *w, int delta_x, int delta_y, bool clamp_to_screen)
Resize the window.
Definition: window.cpp:2069
Textbuf
Helper/buffer for input fields.
Definition: textbuf_type.h:30
Window::Close
virtual void Close()
Hide the window and all its child windows, and mark them for a later deletion.
Definition: window.cpp:1092
IConsolePrint
void IConsolePrint(TextColour colour_code, const std::string &string)
Handle the printing of text entered into the console or redirected there by any other means.
Definition: console.cpp:94
Textbuf::markxoffs
uint16 markxoffs
the start position of the marked area in pixels
Definition: textbuf_type.h:43