3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU Lesser General Public License as published by
7 the Free Software Foundation; either version 2.1 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 #include "guiChatConsole.h"
27 #include "main.h" // for g_settings
29 #include "client/tile.h"
30 #include "fontengine.h"
36 #include "xCGUITTFont.h"
39 inline u32 clamp_u8(s32 value)
41 return (u32) MYMIN(MYMAX(value, 0), 255);
45 GUIChatConsole::GUIChatConsole(
46 gui::IGUIEnvironment* env,
47 gui::IGUIElement* parent,
52 IGUIElement(gui::EGUIET_ELEMENT, env, parent, id,
53 core::rect<s32>(0,0,100,100)),
54 m_chat_backend(backend),
56 m_screensize(v2u32(0,0)),
57 m_animate_time_old(0),
61 m_desired_height_fraction(0.0),
65 m_cursor_blink_speed(0.0),
68 m_background_color(255, 0, 0, 0),
72 m_animate_time_old = getTimeMs();
74 // load background settings
75 s32 console_alpha = g_settings->getS32("console_alpha");
76 m_background_color.setAlpha(clamp_u8(console_alpha));
78 // load the background texture depending on settings
79 ITextureSource *tsrc = client->getTextureSource();
80 if (tsrc->isKnownSourceImage("background_chat.jpg")) {
81 m_background = tsrc->getTexture("background_chat.jpg");
82 m_background_color.setRed(255);
83 m_background_color.setGreen(255);
84 m_background_color.setBlue(255);
86 v3f console_color = g_settings->getV3F("console_color");
87 m_background_color.setRed(clamp_u8(myround(console_color.X)));
88 m_background_color.setGreen(clamp_u8(myround(console_color.Y)));
89 m_background_color.setBlue(clamp_u8(myround(console_color.Z)));
92 m_font = g_fontengine->getFont(FONT_SIZE_UNSPECIFIED, FM_Mono);
96 errorstream << "GUIChatConsole: Unable to load mono font ";
100 core::dimension2d<u32> dim = m_font->getDimension(L"M");
101 m_fontsize = v2u32(dim.Width, dim.Height);
104 m_fontsize.X = MYMAX(m_fontsize.X, 1);
105 m_fontsize.Y = MYMAX(m_fontsize.Y, 1);
107 // set default cursor options
108 setCursor(true, true, 2.0, 0.1);
111 GUIChatConsole::~GUIChatConsole()
117 void GUIChatConsole::openConsole(f32 height)
120 m_desired_height_fraction = height;
121 m_desired_height = height * m_screensize.Y;
125 bool GUIChatConsole::isOpen() const
130 bool GUIChatConsole::isOpenInhibited() const
132 return m_open_inhibited > 0;
135 void GUIChatConsole::closeConsole()
140 void GUIChatConsole::closeConsoleAtOnce()
144 recalculateConsolePosition();
147 f32 GUIChatConsole::getDesiredHeight() const
149 return m_desired_height_fraction;
152 void GUIChatConsole::setCursor(
153 bool visible, bool blinking, f32 blink_speed, f32 relative_height)
159 // leave m_cursor_blink unchanged
160 m_cursor_blink_speed = blink_speed;
164 m_cursor_blink = 0x8000; // on
165 m_cursor_blink_speed = 0.0;
170 m_cursor_blink = 0; // off
171 m_cursor_blink_speed = 0.0;
173 m_cursor_height = relative_height;
176 void GUIChatConsole::draw()
181 video::IVideoDriver* driver = Environment->getVideoDriver();
184 v2u32 screensize = driver->getScreenSize();
185 if (screensize != m_screensize)
187 // screen size has changed
188 // scale current console height to new window size
189 if (m_screensize.Y != 0)
190 m_height = m_height * screensize.Y / m_screensize.Y;
191 m_desired_height = m_desired_height_fraction * m_screensize.Y;
192 m_screensize = screensize;
197 u32 now = getTimeMs();
198 animate(now - m_animate_time_old);
199 m_animate_time_old = now;
201 // Draw console elements if visible
209 gui::IGUIElement::draw();
212 void GUIChatConsole::reformatConsole()
214 s32 cols = m_screensize.X / m_fontsize.X - 2; // make room for a margin (looks better)
215 s32 rows = m_desired_height / m_fontsize.Y - 1; // make room for the input prompt
216 if (cols <= 0 || rows <= 0)
218 m_chat_backend->reformat(cols, rows);
221 void GUIChatConsole::recalculateConsolePosition()
223 core::rect<s32> rect(0, 0, m_screensize.X, m_height);
225 recalculateAbsolutePosition(false);
228 void GUIChatConsole::animate(u32 msec)
230 // animate the console height
231 s32 goal = m_open ? m_desired_height : 0;
232 if (m_height != goal)
234 s32 max_change = msec * m_screensize.Y * (m_height_speed / 1000.0);
241 if (m_height + max_change < goal)
242 m_height += max_change;
249 if (m_height > goal + max_change)
250 m_height -= max_change;
255 recalculateConsolePosition();
259 if (m_cursor_blink_speed != 0.0)
261 u32 blink_increase = 0x10000 * msec * (m_cursor_blink_speed / 1000.0);
262 if (blink_increase == 0)
264 m_cursor_blink = ((m_cursor_blink + blink_increase) & 0xffff);
267 // decrease open inhibit counter
268 if (m_open_inhibited > msec)
269 m_open_inhibited -= msec;
271 m_open_inhibited = 0;
274 void GUIChatConsole::drawBackground()
276 video::IVideoDriver* driver = Environment->getVideoDriver();
277 if (m_background != NULL)
279 core::rect<s32> sourcerect(0, -m_height, m_screensize.X, 0);
284 &AbsoluteClippingRect,
290 driver->draw2DRectangle(
292 core::rect<s32>(0, 0, m_screensize.X, m_height),
293 &AbsoluteClippingRect);
297 void GUIChatConsole::drawText()
302 ChatBuffer& buf = m_chat_backend->getConsoleBuffer();
303 for (u32 row = 0; row < buf.getRows(); ++row)
305 const ChatFormattedLine& line = buf.getFormattedLine(row);
306 if (line.fragments.empty())
309 s32 line_height = m_fontsize.Y;
310 s32 y = row * line_height + m_height - m_desired_height;
311 if (y + line_height < 0)
314 for (u32 i = 0; i < line.fragments.size(); ++i)
316 const ChatFormattedFragment& fragment = line.fragments[i];
317 s32 x = (fragment.column + 1) * m_fontsize.X;
318 core::rect<s32> destrect(
319 x, y, x + m_fontsize.X * fragment.text.size(), y + m_fontsize.Y);
321 fragment.text.c_str(),
323 video::SColor(255, 255, 255, 255),
326 &AbsoluteClippingRect);
331 void GUIChatConsole::drawPrompt()
336 u32 row = m_chat_backend->getConsoleBuffer().getRows();
337 s32 line_height = m_fontsize.Y;
338 s32 y = row * line_height + m_height - m_desired_height;
340 ChatPrompt& prompt = m_chat_backend->getPrompt();
341 std::wstring prompt_text = prompt.getVisiblePortion();
343 // FIXME Draw string at once, not character by character
344 // That will only work with the cursor once we have a monospace font
345 for (u32 i = 0; i < prompt_text.size(); ++i)
347 wchar_t ws[2] = {prompt_text[i], 0};
348 s32 x = (1 + i) * m_fontsize.X;
349 core::rect<s32> destrect(
350 x, y, x + m_fontsize.X, y + m_fontsize.Y);
354 video::SColor(255, 255, 255, 255),
357 &AbsoluteClippingRect);
360 // Draw the cursor during on periods
361 if ((m_cursor_blink & 0x8000) != 0)
363 s32 cursor_pos = prompt.getVisibleCursorPosition();
366 video::IVideoDriver* driver = Environment->getVideoDriver();
367 s32 x = (1 + cursor_pos) * m_fontsize.X;
368 core::rect<s32> destrect(
370 y + (1.0-m_cursor_height) * m_fontsize.Y,
373 video::SColor cursor_color(255,255,255,255);
374 driver->draw2DRectangle(
377 &AbsoluteClippingRect);
383 bool GUIChatConsole::OnEvent(const SEvent& event)
385 if(event.EventType == EET_KEY_INPUT_EVENT && event.KeyInput.PressedDown)
388 if(KeyPress(event.KeyInput) == getKeySetting("keymap_console"))
391 Environment->removeFocus(this);
393 // inhibit open so the_game doesn't reopen immediately
394 m_open_inhibited = 50;
397 else if(event.KeyInput.Key == KEY_ESCAPE)
399 closeConsoleAtOnce();
400 Environment->removeFocus(this);
401 // the_game will open the pause menu
404 else if(event.KeyInput.Key == KEY_PRIOR)
406 m_chat_backend->scrollPageUp();
409 else if(event.KeyInput.Key == KEY_NEXT)
411 m_chat_backend->scrollPageDown();
414 else if(event.KeyInput.Key == KEY_RETURN)
416 std::wstring text = m_chat_backend->getPrompt().submit();
417 m_client->typeChatMessage(text);
420 else if(event.KeyInput.Key == KEY_UP)
423 // Move back in history
424 m_chat_backend->getPrompt().historyPrev();
427 else if(event.KeyInput.Key == KEY_DOWN)
430 // Move forward in history
431 m_chat_backend->getPrompt().historyNext();
434 else if(event.KeyInput.Key == KEY_LEFT)
436 // Left or Ctrl-Left pressed
437 // move character / word to the left
438 ChatPrompt::CursorOpScope scope =
439 event.KeyInput.Control ?
440 ChatPrompt::CURSOROP_SCOPE_WORD :
441 ChatPrompt::CURSOROP_SCOPE_CHARACTER;
442 m_chat_backend->getPrompt().cursorOperation(
443 ChatPrompt::CURSOROP_MOVE,
444 ChatPrompt::CURSOROP_DIR_LEFT,
448 else if(event.KeyInput.Key == KEY_RIGHT)
450 // Right or Ctrl-Right pressed
451 // move character / word to the right
452 ChatPrompt::CursorOpScope scope =
453 event.KeyInput.Control ?
454 ChatPrompt::CURSOROP_SCOPE_WORD :
455 ChatPrompt::CURSOROP_SCOPE_CHARACTER;
456 m_chat_backend->getPrompt().cursorOperation(
457 ChatPrompt::CURSOROP_MOVE,
458 ChatPrompt::CURSOROP_DIR_RIGHT,
462 else if(event.KeyInput.Key == KEY_HOME)
465 // move to beginning of line
466 m_chat_backend->getPrompt().cursorOperation(
467 ChatPrompt::CURSOROP_MOVE,
468 ChatPrompt::CURSOROP_DIR_LEFT,
469 ChatPrompt::CURSOROP_SCOPE_LINE);
472 else if(event.KeyInput.Key == KEY_END)
475 // move to end of line
476 m_chat_backend->getPrompt().cursorOperation(
477 ChatPrompt::CURSOROP_MOVE,
478 ChatPrompt::CURSOROP_DIR_RIGHT,
479 ChatPrompt::CURSOROP_SCOPE_LINE);
482 else if(event.KeyInput.Key == KEY_BACK)
484 // Backspace or Ctrl-Backspace pressed
485 // delete character / word to the left
486 ChatPrompt::CursorOpScope scope =
487 event.KeyInput.Control ?
488 ChatPrompt::CURSOROP_SCOPE_WORD :
489 ChatPrompt::CURSOROP_SCOPE_CHARACTER;
490 m_chat_backend->getPrompt().cursorOperation(
491 ChatPrompt::CURSOROP_DELETE,
492 ChatPrompt::CURSOROP_DIR_LEFT,
496 else if(event.KeyInput.Key == KEY_DELETE)
498 // Delete or Ctrl-Delete pressed
499 // delete character / word to the right
500 ChatPrompt::CursorOpScope scope =
501 event.KeyInput.Control ?
502 ChatPrompt::CURSOROP_SCOPE_WORD :
503 ChatPrompt::CURSOROP_SCOPE_CHARACTER;
504 m_chat_backend->getPrompt().cursorOperation(
505 ChatPrompt::CURSOROP_DELETE,
506 ChatPrompt::CURSOROP_DIR_RIGHT,
510 else if(event.KeyInput.Key == KEY_KEY_V && event.KeyInput.Control)
513 // paste text from clipboard
514 IOSOperator *os_operator = Environment->getOSOperator();
515 const c8 *text = os_operator->getTextFromClipboard();
518 std::wstring wtext = narrow_to_wide(text);
519 m_chat_backend->getPrompt().input(wtext);
523 else if(event.KeyInput.Key == KEY_KEY_U && event.KeyInput.Control)
526 // kill line to left end
527 m_chat_backend->getPrompt().cursorOperation(
528 ChatPrompt::CURSOROP_DELETE,
529 ChatPrompt::CURSOROP_DIR_LEFT,
530 ChatPrompt::CURSOROP_SCOPE_LINE);
533 else if(event.KeyInput.Key == KEY_KEY_K && event.KeyInput.Control)
536 // kill line to right end
537 m_chat_backend->getPrompt().cursorOperation(
538 ChatPrompt::CURSOROP_DELETE,
539 ChatPrompt::CURSOROP_DIR_RIGHT,
540 ChatPrompt::CURSOROP_SCOPE_LINE);
543 else if(event.KeyInput.Key == KEY_TAB)
545 // Tab or Shift-Tab pressed
547 std::list<std::string> names = m_client->getConnectedPlayerNames();
548 bool backwards = event.KeyInput.Shift;
549 m_chat_backend->getPrompt().nickCompletion(names, backwards);
552 else if(event.KeyInput.Char != 0 && !event.KeyInput.Control)
554 #if (defined(linux) || defined(__linux))
556 mbtowc( &wc, (char *) &event.KeyInput.Char, sizeof(event.KeyInput.Char) );
557 m_chat_backend->getPrompt().input(wc);
559 m_chat_backend->getPrompt().input(event.KeyInput.Char);
564 else if(event.EventType == EET_MOUSE_INPUT_EVENT)
566 if(event.MouseInput.Event == EMIE_MOUSE_WHEEL)
568 s32 rows = myround(-3.0 * event.MouseInput.Wheel);
569 m_chat_backend->scroll(rows);
573 return Parent ? Parent->OnEvent(event) : false;