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
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);
102 dstream << "Font size: " << m_fontsize.X << " " << m_fontsize.Y << std::endl;
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()
114 void GUIChatConsole::openConsole(f32 height)
117 m_desired_height_fraction = height;
118 m_desired_height = height * m_screensize.Y;
122 bool GUIChatConsole::isOpen() const
127 bool GUIChatConsole::isOpenInhibited() const
129 return m_open_inhibited > 0;
132 void GUIChatConsole::closeConsole()
137 void GUIChatConsole::closeConsoleAtOnce()
141 recalculateConsolePosition();
144 f32 GUIChatConsole::getDesiredHeight() const
146 return m_desired_height_fraction;
149 void GUIChatConsole::setCursor(
150 bool visible, bool blinking, f32 blink_speed, f32 relative_height)
156 // leave m_cursor_blink unchanged
157 m_cursor_blink_speed = blink_speed;
161 m_cursor_blink = 0x8000; // on
162 m_cursor_blink_speed = 0.0;
167 m_cursor_blink = 0; // off
168 m_cursor_blink_speed = 0.0;
170 m_cursor_height = relative_height;
173 void GUIChatConsole::draw()
178 video::IVideoDriver* driver = Environment->getVideoDriver();
181 v2u32 screensize = driver->getScreenSize();
182 if (screensize != m_screensize)
184 // screen size has changed
185 // scale current console height to new window size
186 if (m_screensize.Y != 0)
187 m_height = m_height * screensize.Y / m_screensize.Y;
188 m_desired_height = m_desired_height_fraction * m_screensize.Y;
189 m_screensize = screensize;
194 u32 now = getTimeMs();
195 animate(now - m_animate_time_old);
196 m_animate_time_old = now;
198 // Draw console elements if visible
206 gui::IGUIElement::draw();
209 void GUIChatConsole::reformatConsole()
211 s32 cols = m_screensize.X / m_fontsize.X - 2; // make room for a margin (looks better)
212 s32 rows = m_desired_height / m_fontsize.Y - 1; // make room for the input prompt
213 if (cols <= 0 || rows <= 0)
215 m_chat_backend->reformat(cols, rows);
218 void GUIChatConsole::recalculateConsolePosition()
220 core::rect<s32> rect(0, 0, m_screensize.X, m_height);
222 recalculateAbsolutePosition(false);
225 void GUIChatConsole::animate(u32 msec)
227 // animate the console height
228 s32 goal = m_open ? m_desired_height : 0;
229 if (m_height != goal)
231 s32 max_change = msec * m_screensize.Y * (m_height_speed / 1000.0);
238 if (m_height + max_change < goal)
239 m_height += max_change;
246 if (m_height > goal + max_change)
247 m_height -= max_change;
252 recalculateConsolePosition();
256 if (m_cursor_blink_speed != 0.0)
258 u32 blink_increase = 0x10000 * msec * (m_cursor_blink_speed / 1000.0);
259 if (blink_increase == 0)
261 m_cursor_blink = ((m_cursor_blink + blink_increase) & 0xffff);
264 // decrease open inhibit counter
265 if (m_open_inhibited > msec)
266 m_open_inhibited -= msec;
268 m_open_inhibited = 0;
271 void GUIChatConsole::drawBackground()
273 video::IVideoDriver* driver = Environment->getVideoDriver();
274 if (m_background != NULL)
276 core::rect<s32> sourcerect(0, -m_height, m_screensize.X, 0);
281 &AbsoluteClippingRect,
287 driver->draw2DRectangle(
289 core::rect<s32>(0, 0, m_screensize.X, m_height),
290 &AbsoluteClippingRect);
294 void GUIChatConsole::drawText()
299 ChatBuffer& buf = m_chat_backend->getConsoleBuffer();
300 for (u32 row = 0; row < buf.getRows(); ++row)
302 const ChatFormattedLine& line = buf.getFormattedLine(row);
303 if (line.fragments.empty())
306 s32 line_height = m_fontsize.Y;
307 s32 y = row * line_height + m_height - m_desired_height;
308 if (y + line_height < 0)
311 for (u32 i = 0; i < line.fragments.size(); ++i)
313 const ChatFormattedFragment& fragment = line.fragments[i];
314 s32 x = (fragment.column + 1) * m_fontsize.X;
315 core::rect<s32> destrect(
316 x, y, x + m_fontsize.X * fragment.text.size(), y + m_fontsize.Y);
318 fragment.text.c_str(),
320 video::SColor(255, 255, 255, 255),
323 &AbsoluteClippingRect);
328 void GUIChatConsole::drawPrompt()
333 u32 row = m_chat_backend->getConsoleBuffer().getRows();
334 s32 line_height = m_fontsize.Y;
335 s32 y = row * line_height + m_height - m_desired_height;
337 ChatPrompt& prompt = m_chat_backend->getPrompt();
338 std::wstring prompt_text = prompt.getVisiblePortion();
340 // FIXME Draw string at once, not character by character
341 // That will only work with the cursor once we have a monospace font
342 for (u32 i = 0; i < prompt_text.size(); ++i)
344 wchar_t ws[2] = {prompt_text[i], 0};
345 s32 x = (1 + i) * m_fontsize.X;
346 core::rect<s32> destrect(
347 x, y, x + m_fontsize.X, y + m_fontsize.Y);
351 video::SColor(255, 255, 255, 255),
354 &AbsoluteClippingRect);
357 // Draw the cursor during on periods
358 if ((m_cursor_blink & 0x8000) != 0)
360 s32 cursor_pos = prompt.getVisibleCursorPosition();
363 video::IVideoDriver* driver = Environment->getVideoDriver();
364 s32 x = (1 + cursor_pos) * m_fontsize.X;
365 core::rect<s32> destrect(
367 y + (1.0-m_cursor_height) * m_fontsize.Y,
370 video::SColor cursor_color(255,255,255,255);
371 driver->draw2DRectangle(
374 &AbsoluteClippingRect);
380 bool GUIChatConsole::OnEvent(const SEvent& event)
382 if(event.EventType == EET_KEY_INPUT_EVENT && event.KeyInput.PressedDown)
385 if(KeyPress(event.KeyInput) == getKeySetting("keymap_console"))
388 Environment->removeFocus(this);
390 // inhibit open so the_game doesn't reopen immediately
391 m_open_inhibited = 50;
394 else if(event.KeyInput.Key == KEY_ESCAPE)
396 closeConsoleAtOnce();
397 Environment->removeFocus(this);
398 // the_game will open the pause menu
401 else if(event.KeyInput.Key == KEY_PRIOR)
403 m_chat_backend->scrollPageUp();
406 else if(event.KeyInput.Key == KEY_NEXT)
408 m_chat_backend->scrollPageDown();
411 else if(event.KeyInput.Key == KEY_RETURN)
413 std::wstring text = m_chat_backend->getPrompt().submit();
414 m_client->typeChatMessage(text);
417 else if(event.KeyInput.Key == KEY_UP)
420 // Move back in history
421 m_chat_backend->getPrompt().historyPrev();
424 else if(event.KeyInput.Key == KEY_DOWN)
427 // Move forward in history
428 m_chat_backend->getPrompt().historyNext();
431 else if(event.KeyInput.Key == KEY_LEFT)
433 // Left or Ctrl-Left pressed
434 // move character / word to the left
435 ChatPrompt::CursorOpScope scope =
436 event.KeyInput.Control ?
437 ChatPrompt::CURSOROP_SCOPE_WORD :
438 ChatPrompt::CURSOROP_SCOPE_CHARACTER;
439 m_chat_backend->getPrompt().cursorOperation(
440 ChatPrompt::CURSOROP_MOVE,
441 ChatPrompt::CURSOROP_DIR_LEFT,
445 else if(event.KeyInput.Key == KEY_RIGHT)
447 // Right or Ctrl-Right pressed
448 // move character / word to the right
449 ChatPrompt::CursorOpScope scope =
450 event.KeyInput.Control ?
451 ChatPrompt::CURSOROP_SCOPE_WORD :
452 ChatPrompt::CURSOROP_SCOPE_CHARACTER;
453 m_chat_backend->getPrompt().cursorOperation(
454 ChatPrompt::CURSOROP_MOVE,
455 ChatPrompt::CURSOROP_DIR_RIGHT,
459 else if(event.KeyInput.Key == KEY_HOME)
462 // move to beginning of line
463 m_chat_backend->getPrompt().cursorOperation(
464 ChatPrompt::CURSOROP_MOVE,
465 ChatPrompt::CURSOROP_DIR_LEFT,
466 ChatPrompt::CURSOROP_SCOPE_LINE);
469 else if(event.KeyInput.Key == KEY_END)
472 // move to end of line
473 m_chat_backend->getPrompt().cursorOperation(
474 ChatPrompt::CURSOROP_MOVE,
475 ChatPrompt::CURSOROP_DIR_RIGHT,
476 ChatPrompt::CURSOROP_SCOPE_LINE);
479 else if(event.KeyInput.Key == KEY_BACK)
481 // Backspace or Ctrl-Backspace pressed
482 // delete character / word to the left
483 ChatPrompt::CursorOpScope scope =
484 event.KeyInput.Control ?
485 ChatPrompt::CURSOROP_SCOPE_WORD :
486 ChatPrompt::CURSOROP_SCOPE_CHARACTER;
487 m_chat_backend->getPrompt().cursorOperation(
488 ChatPrompt::CURSOROP_DELETE,
489 ChatPrompt::CURSOROP_DIR_LEFT,
493 else if(event.KeyInput.Key == KEY_DELETE)
495 // Delete or Ctrl-Delete pressed
496 // delete character / word to the right
497 ChatPrompt::CursorOpScope scope =
498 event.KeyInput.Control ?
499 ChatPrompt::CURSOROP_SCOPE_WORD :
500 ChatPrompt::CURSOROP_SCOPE_CHARACTER;
501 m_chat_backend->getPrompt().cursorOperation(
502 ChatPrompt::CURSOROP_DELETE,
503 ChatPrompt::CURSOROP_DIR_RIGHT,
507 else if(event.KeyInput.Key == KEY_KEY_V && event.KeyInput.Control)
510 // paste text from clipboard
511 IOSOperator *os_operator = Environment->getOSOperator();
512 const c8 *text = os_operator->getTextFromClipboard();
515 std::wstring wtext = narrow_to_wide(text);
516 m_chat_backend->getPrompt().input(wtext);
520 else if(event.KeyInput.Key == KEY_KEY_U && event.KeyInput.Control)
523 // kill line to left end
524 m_chat_backend->getPrompt().cursorOperation(
525 ChatPrompt::CURSOROP_DELETE,
526 ChatPrompt::CURSOROP_DIR_LEFT,
527 ChatPrompt::CURSOROP_SCOPE_LINE);
530 else if(event.KeyInput.Key == KEY_KEY_K && event.KeyInput.Control)
533 // kill line to right end
534 m_chat_backend->getPrompt().cursorOperation(
535 ChatPrompt::CURSOROP_DELETE,
536 ChatPrompt::CURSOROP_DIR_RIGHT,
537 ChatPrompt::CURSOROP_SCOPE_LINE);
540 else if(event.KeyInput.Key == KEY_TAB)
542 // Tab or Shift-Tab pressed
544 std::list<std::string> names = m_client->getConnectedPlayerNames();
545 bool backwards = event.KeyInput.Shift;
546 m_chat_backend->getPrompt().nickCompletion(names, backwards);
549 else if(event.KeyInput.Char != 0 && !event.KeyInput.Control)
551 #if (defined(linux) || defined(__linux))
553 mbtowc( &wc, (char *) &event.KeyInput.Char, sizeof(event.KeyInput.Char) );
554 m_chat_backend->getPrompt().input(wc);
556 m_chat_backend->getPrompt().input(event.KeyInput.Char);
561 else if(event.EventType == EET_MOUSE_INPUT_EVENT)
563 if(event.MouseInput.Event == EMIE_MOUSE_WHEEL)
565 s32 rows = myround(-3.0 * event.MouseInput.Wheel);
566 m_chat_backend->scroll(rows);
570 return Parent ? Parent->OnEvent(event) : false;