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"
28 #include "client/tile.h"
29 #include "fontengine.h"
35 #include "xCGUITTFont.h"
38 inline u32 clamp_u8(s32 value)
40 return (u32) MYMIN(MYMAX(value, 0), 255);
44 GUIChatConsole::GUIChatConsole(
45 gui::IGUIEnvironment* env,
46 gui::IGUIElement* parent,
52 IGUIElement(gui::EGUIET_ELEMENT, env, parent, id,
53 core::rect<s32>(0,0,100,100)),
54 m_chat_backend(backend),
57 m_screensize(v2u32(0,0)),
58 m_animate_time_old(0),
60 m_close_on_enter(false),
63 m_desired_height_fraction(0.0),
67 m_cursor_blink_speed(0.0),
70 m_background_color(255, 0, 0, 0),
74 m_animate_time_old = getTimeMs();
76 // load background settings
77 s32 console_alpha = g_settings->getS32("console_alpha");
78 m_background_color.setAlpha(clamp_u8(console_alpha));
80 // load the background texture depending on settings
81 ITextureSource *tsrc = client->getTextureSource();
82 if (tsrc->isKnownSourceImage("background_chat.jpg")) {
83 m_background = tsrc->getTexture("background_chat.jpg");
84 m_background_color.setRed(255);
85 m_background_color.setGreen(255);
86 m_background_color.setBlue(255);
88 v3f console_color = g_settings->getV3F("console_color");
89 m_background_color.setRed(clamp_u8(myround(console_color.X)));
90 m_background_color.setGreen(clamp_u8(myround(console_color.Y)));
91 m_background_color.setBlue(clamp_u8(myround(console_color.Z)));
94 m_font = g_fontengine->getFont(FONT_SIZE_UNSPECIFIED, FM_Mono);
98 errorstream << "GUIChatConsole: Unable to load mono font ";
102 core::dimension2d<u32> dim = m_font->getDimension(L"M");
103 m_fontsize = v2u32(dim.Width, dim.Height);
106 m_fontsize.X = MYMAX(m_fontsize.X, 1);
107 m_fontsize.Y = MYMAX(m_fontsize.Y, 1);
109 // set default cursor options
110 setCursor(true, true, 2.0, 0.1);
113 GUIChatConsole::~GUIChatConsole()
119 void GUIChatConsole::openConsole(f32 scale)
121 assert(scale > 0.0f && scale <= 1.0f);
124 m_desired_height_fraction = scale;
125 m_desired_height = scale * m_screensize.Y;
127 m_animate_time_old = getTimeMs();
128 IGUIElement::setVisible(true);
129 Environment->setFocus(this);
130 m_menumgr->createdMenu(this);
133 bool GUIChatConsole::isOpen() const
138 bool GUIChatConsole::isOpenInhibited() const
140 return m_open_inhibited > 0;
143 void GUIChatConsole::closeConsole()
146 Environment->removeFocus(this);
147 m_menumgr->deletingMenu(this);
150 void GUIChatConsole::closeConsoleAtOnce()
154 recalculateConsolePosition();
157 f32 GUIChatConsole::getDesiredHeight() const
159 return m_desired_height_fraction;
162 void GUIChatConsole::replaceAndAddToHistory(std::wstring line)
164 ChatPrompt& prompt = m_chat_backend->getPrompt();
165 prompt.addToHistory(prompt.getLine());
166 prompt.replace(line);
170 void GUIChatConsole::setCursor(
171 bool visible, bool blinking, f32 blink_speed, f32 relative_height)
177 // leave m_cursor_blink unchanged
178 m_cursor_blink_speed = blink_speed;
182 m_cursor_blink = 0x8000; // on
183 m_cursor_blink_speed = 0.0;
188 m_cursor_blink = 0; // off
189 m_cursor_blink_speed = 0.0;
191 m_cursor_height = relative_height;
194 void GUIChatConsole::draw()
199 video::IVideoDriver* driver = Environment->getVideoDriver();
202 v2u32 screensize = driver->getScreenSize();
203 if (screensize != m_screensize)
205 // screen size has changed
206 // scale current console height to new window size
207 if (m_screensize.Y != 0)
208 m_height = m_height * screensize.Y / m_screensize.Y;
209 m_desired_height = m_desired_height_fraction * m_screensize.Y;
210 m_screensize = screensize;
215 u32 now = getTimeMs();
216 animate(now - m_animate_time_old);
217 m_animate_time_old = now;
219 // Draw console elements if visible
227 gui::IGUIElement::draw();
230 void GUIChatConsole::reformatConsole()
232 s32 cols = m_screensize.X / m_fontsize.X - 2; // make room for a margin (looks better)
233 s32 rows = m_desired_height / m_fontsize.Y - 1; // make room for the input prompt
234 if (cols <= 0 || rows <= 0)
236 m_chat_backend->reformat(cols, rows);
239 void GUIChatConsole::recalculateConsolePosition()
241 core::rect<s32> rect(0, 0, m_screensize.X, m_height);
243 recalculateAbsolutePosition(false);
246 void GUIChatConsole::animate(u32 msec)
248 // animate the console height
249 s32 goal = m_open ? m_desired_height : 0;
251 // Set invisible if close animation finished (reset by openConsole)
252 // This function (animate()) is never called once its visibility becomes false so do not
253 // actually set visible to false before the inhibited period is over
254 if (!m_open && m_height == 0 && m_open_inhibited == 0)
255 IGUIElement::setVisible(false);
257 if (m_height != goal)
259 s32 max_change = msec * m_screensize.Y * (m_height_speed / 1000.0);
266 if (m_height + max_change < goal)
267 m_height += max_change;
274 if (m_height > goal + max_change)
275 m_height -= max_change;
280 recalculateConsolePosition();
284 if (m_cursor_blink_speed != 0.0)
286 u32 blink_increase = 0x10000 * msec * (m_cursor_blink_speed / 1000.0);
287 if (blink_increase == 0)
289 m_cursor_blink = ((m_cursor_blink + blink_increase) & 0xffff);
292 // decrease open inhibit counter
293 if (m_open_inhibited > msec)
294 m_open_inhibited -= msec;
296 m_open_inhibited = 0;
299 void GUIChatConsole::drawBackground()
301 video::IVideoDriver* driver = Environment->getVideoDriver();
302 if (m_background != NULL)
304 core::rect<s32> sourcerect(0, -m_height, m_screensize.X, 0);
309 &AbsoluteClippingRect,
315 driver->draw2DRectangle(
317 core::rect<s32>(0, 0, m_screensize.X, m_height),
318 &AbsoluteClippingRect);
322 void GUIChatConsole::drawText()
327 ChatBuffer& buf = m_chat_backend->getConsoleBuffer();
328 for (u32 row = 0; row < buf.getRows(); ++row)
330 const ChatFormattedLine& line = buf.getFormattedLine(row);
331 if (line.fragments.empty())
334 s32 line_height = m_fontsize.Y;
335 s32 y = row * line_height + m_height - m_desired_height;
336 if (y + line_height < 0)
339 for (u32 i = 0; i < line.fragments.size(); ++i)
341 const ChatFormattedFragment& fragment = line.fragments[i];
342 s32 x = (fragment.column + 1) * m_fontsize.X;
343 core::rect<s32> destrect(
344 x, y, x + m_fontsize.X * fragment.text.size(), y + m_fontsize.Y);
348 // Draw colored text if FreeType is enabled
349 irr::gui::CGUITTFont *tmp = static_cast<irr::gui::CGUITTFont*>(m_font);
353 video::SColor(255, 255, 255, 255),
356 &AbsoluteClippingRect);
358 // Otherwise use standard text
360 fragment.text.c_str(),
362 video::SColor(255, 255, 255, 255),
365 &AbsoluteClippingRect);
371 void GUIChatConsole::drawPrompt()
376 u32 row = m_chat_backend->getConsoleBuffer().getRows();
377 s32 line_height = m_fontsize.Y;
378 s32 y = row * line_height + m_height - m_desired_height;
380 ChatPrompt& prompt = m_chat_backend->getPrompt();
381 std::wstring prompt_text = prompt.getVisiblePortion();
383 // FIXME Draw string at once, not character by character
384 // That will only work with the cursor once we have a monospace font
385 for (u32 i = 0; i < prompt_text.size(); ++i)
387 wchar_t ws[2] = {prompt_text[i], 0};
388 s32 x = (1 + i) * m_fontsize.X;
389 core::rect<s32> destrect(
390 x, y, x + m_fontsize.X, y + m_fontsize.Y);
394 video::SColor(255, 255, 255, 255),
397 &AbsoluteClippingRect);
400 // Draw the cursor during on periods
401 if ((m_cursor_blink & 0x8000) != 0)
403 s32 cursor_pos = prompt.getVisibleCursorPosition();
406 s32 cursor_len = prompt.getCursorLength();
407 video::IVideoDriver* driver = Environment->getVideoDriver();
408 s32 x = (1 + cursor_pos) * m_fontsize.X;
409 core::rect<s32> destrect(
411 y + m_fontsize.Y * (1.0 - m_cursor_height),
412 x + m_fontsize.X * MYMAX(cursor_len, 1),
413 y + m_fontsize.Y * (cursor_len ? m_cursor_height+1 : 1)
415 video::SColor cursor_color(255,255,255,255);
416 driver->draw2DRectangle(
419 &AbsoluteClippingRect);
425 bool GUIChatConsole::OnEvent(const SEvent& event)
428 ChatPrompt &prompt = m_chat_backend->getPrompt();
430 if(event.EventType == EET_KEY_INPUT_EVENT && event.KeyInput.PressedDown)
433 if(KeyPress(event.KeyInput) == getKeySetting("keymap_console"))
437 // inhibit open so the_game doesn't reopen immediately
438 m_open_inhibited = 50;
439 m_close_on_enter = false;
442 else if(event.KeyInput.Key == KEY_ESCAPE)
444 closeConsoleAtOnce();
445 m_close_on_enter = false;
446 // inhibit open so the_game doesn't reopen immediately
447 m_open_inhibited = 1; // so the ESCAPE button doesn't open the "pause menu"
450 else if(event.KeyInput.Key == KEY_PRIOR)
452 m_chat_backend->scrollPageUp();
455 else if(event.KeyInput.Key == KEY_NEXT)
457 m_chat_backend->scrollPageDown();
460 else if(event.KeyInput.Key == KEY_RETURN)
462 prompt.addToHistory(prompt.getLine());
463 std::wstring text = prompt.replace(L"");
464 m_client->typeChatMessage(text);
465 if (m_close_on_enter) {
466 closeConsoleAtOnce();
467 m_close_on_enter = false;
471 else if(event.KeyInput.Key == KEY_UP)
474 // Move back in history
475 prompt.historyPrev();
478 else if(event.KeyInput.Key == KEY_DOWN)
481 // Move forward in history
482 prompt.historyNext();
485 else if(event.KeyInput.Key == KEY_LEFT || event.KeyInput.Key == KEY_RIGHT)
487 // Left/right pressed
488 // Move/select character/word to the left depending on control and shift keys
489 ChatPrompt::CursorOp op = event.KeyInput.Shift ?
490 ChatPrompt::CURSOROP_SELECT :
491 ChatPrompt::CURSOROP_MOVE;
492 ChatPrompt::CursorOpDir dir = event.KeyInput.Key == KEY_LEFT ?
493 ChatPrompt::CURSOROP_DIR_LEFT :
494 ChatPrompt::CURSOROP_DIR_RIGHT;
495 ChatPrompt::CursorOpScope scope = event.KeyInput.Control ?
496 ChatPrompt::CURSOROP_SCOPE_WORD :
497 ChatPrompt::CURSOROP_SCOPE_CHARACTER;
498 prompt.cursorOperation(op, dir, scope);
501 else if(event.KeyInput.Key == KEY_HOME)
504 // move to beginning of line
505 prompt.cursorOperation(
506 ChatPrompt::CURSOROP_MOVE,
507 ChatPrompt::CURSOROP_DIR_LEFT,
508 ChatPrompt::CURSOROP_SCOPE_LINE);
511 else if(event.KeyInput.Key == KEY_END)
514 // move to end of line
515 prompt.cursorOperation(
516 ChatPrompt::CURSOROP_MOVE,
517 ChatPrompt::CURSOROP_DIR_RIGHT,
518 ChatPrompt::CURSOROP_SCOPE_LINE);
521 else if(event.KeyInput.Key == KEY_BACK)
523 // Backspace or Ctrl-Backspace pressed
524 // delete character / word to the left
525 ChatPrompt::CursorOpScope scope =
526 event.KeyInput.Control ?
527 ChatPrompt::CURSOROP_SCOPE_WORD :
528 ChatPrompt::CURSOROP_SCOPE_CHARACTER;
529 prompt.cursorOperation(
530 ChatPrompt::CURSOROP_DELETE,
531 ChatPrompt::CURSOROP_DIR_LEFT,
535 else if(event.KeyInput.Key == KEY_DELETE)
537 // Delete or Ctrl-Delete pressed
538 // delete character / word to the right
539 ChatPrompt::CursorOpScope scope =
540 event.KeyInput.Control ?
541 ChatPrompt::CURSOROP_SCOPE_WORD :
542 ChatPrompt::CURSOROP_SCOPE_CHARACTER;
543 prompt.cursorOperation(
544 ChatPrompt::CURSOROP_DELETE,
545 ChatPrompt::CURSOROP_DIR_RIGHT,
549 else if(event.KeyInput.Key == KEY_KEY_A && event.KeyInput.Control)
553 prompt.cursorOperation(
554 ChatPrompt::CURSOROP_SELECT,
555 ChatPrompt::CURSOROP_DIR_LEFT, // Ignored
556 ChatPrompt::CURSOROP_SCOPE_LINE);
559 else if(event.KeyInput.Key == KEY_KEY_C && event.KeyInput.Control)
562 // Copy text to clipboard
563 if (prompt.getCursorLength() <= 0)
565 std::wstring wselected = prompt.getSelection();
566 std::string selected(wselected.begin(), wselected.end());
567 Environment->getOSOperator()->copyToClipboard(selected.c_str());
570 else if(event.KeyInput.Key == KEY_KEY_V && event.KeyInput.Control)
573 // paste text from clipboard
574 if (prompt.getCursorLength() > 0) {
575 // Delete selected section of text
576 prompt.cursorOperation(
577 ChatPrompt::CURSOROP_DELETE,
578 ChatPrompt::CURSOROP_DIR_LEFT, // Ignored
579 ChatPrompt::CURSOROP_SCOPE_SELECTION);
581 IOSOperator *os_operator = Environment->getOSOperator();
582 const c8 *text = os_operator->getTextFromClipboard();
585 std::basic_string<unsigned char> str((const unsigned char*)text);
586 prompt.input(std::wstring(str.begin(), str.end()));
589 else if(event.KeyInput.Key == KEY_KEY_X && event.KeyInput.Control)
592 // Cut text to clipboard
593 if (prompt.getCursorLength() <= 0)
595 std::wstring wselected = prompt.getSelection();
596 std::string selected(wselected.begin(), wselected.end());
597 Environment->getOSOperator()->copyToClipboard(selected.c_str());
598 prompt.cursorOperation(
599 ChatPrompt::CURSOROP_DELETE,
600 ChatPrompt::CURSOROP_DIR_LEFT, // Ignored
601 ChatPrompt::CURSOROP_SCOPE_SELECTION);
604 else if(event.KeyInput.Key == KEY_KEY_U && event.KeyInput.Control)
607 // kill line to left end
608 prompt.cursorOperation(
609 ChatPrompt::CURSOROP_DELETE,
610 ChatPrompt::CURSOROP_DIR_LEFT,
611 ChatPrompt::CURSOROP_SCOPE_LINE);
614 else if(event.KeyInput.Key == KEY_KEY_K && event.KeyInput.Control)
617 // kill line to right end
618 prompt.cursorOperation(
619 ChatPrompt::CURSOROP_DELETE,
620 ChatPrompt::CURSOROP_DIR_RIGHT,
621 ChatPrompt::CURSOROP_SCOPE_LINE);
624 else if(event.KeyInput.Key == KEY_TAB)
626 // Tab or Shift-Tab pressed
628 std::list<std::string> names = m_client->getConnectedPlayerNames();
629 bool backwards = event.KeyInput.Shift;
630 prompt.nickCompletion(names, backwards);
633 else if(event.KeyInput.Char != 0 && !event.KeyInput.Control)
635 #if defined(__linux__) && (IRRLICHT_VERSION_MAJOR == 1 && IRRLICHT_VERSION_MINOR < 9)
637 mbtowc( &wc, (char *) &event.KeyInput.Char, sizeof(event.KeyInput.Char) );
640 prompt.input(event.KeyInput.Char);
645 else if(event.EventType == EET_MOUSE_INPUT_EVENT)
647 if(event.MouseInput.Event == EMIE_MOUSE_WHEEL)
649 s32 rows = myround(-3.0 * event.MouseInput.Wheel);
650 m_chat_backend->scroll(rows);
654 return Parent ? Parent->OnEvent(event) : false;
657 void GUIChatConsole::setVisible(bool visible)
660 IGUIElement::setVisible(visible);
663 recalculateConsolePosition();