3 Copyright (C) 2011 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
35 inline u32 clamp_u8(s32 value)
37 return (u32) MYMIN(MYMAX(value, 0), 255);
41 GUIChatConsole::GUIChatConsole(
42 gui::IGUIEnvironment* env,
43 gui::IGUIElement* parent,
48 IGUIElement(gui::EGUIET_ELEMENT, env, parent, id,
49 core::rect<s32>(0,0,100,100)),
50 m_chat_backend(backend),
52 m_screensize(v2u32(0,0)),
53 m_animate_time_old(0),
57 m_desired_height_fraction(0.0),
61 m_cursor_blink_speed(0.0),
64 m_background_color(255, 0, 0, 0),
68 m_animate_time_old = getTimeMs();
70 // load background settings
71 bool console_color_set = !g_settings->get("console_color").empty();
72 s32 console_alpha = g_settings->getS32("console_alpha");
74 // load the background texture depending on settings
75 m_background_color.setAlpha(clamp_u8(console_alpha));
76 if (console_color_set)
78 v3f console_color = g_settings->getV3F("console_color");
79 m_background_color.setRed(clamp_u8(myround(console_color.X)));
80 m_background_color.setGreen(clamp_u8(myround(console_color.Y)));
81 m_background_color.setBlue(clamp_u8(myround(console_color.Z)));
85 m_background = env->getVideoDriver()->getTexture(getTexturePath("background_chat.jpg").c_str());
86 m_background_color.setRed(255);
87 m_background_color.setGreen(255);
88 m_background_color.setBlue(255);
92 // FIXME should a custom texture_path be searched too?
93 std::string font_name = "fontdejavusansmono.png";
94 m_font = env->getFont(getTexturePath(font_name).c_str());
97 dstream << "Unable to load font: " << font_name << std::endl;
101 core::dimension2d<u32> dim = m_font->getDimension(L"M");
102 m_fontsize = v2u32(dim.Width, dim.Height);
103 dstream << "Font size: " << m_fontsize.X << " " << m_fontsize.Y << std::endl;
105 m_fontsize.X = MYMAX(m_fontsize.X, 1);
106 m_fontsize.Y = MYMAX(m_fontsize.Y, 1);
108 // set default cursor options
109 setCursor(true, true, 2.0, 0.1);
112 GUIChatConsole::~GUIChatConsole()
116 void GUIChatConsole::openConsole(f32 height)
119 m_desired_height_fraction = height;
120 m_desired_height = height * m_screensize.Y;
124 bool GUIChatConsole::isOpenInhibited() const
126 return m_open_inhibited > 0;
129 void GUIChatConsole::closeConsole()
134 void GUIChatConsole::closeConsoleAtOnce()
138 recalculateConsolePosition();
141 f32 GUIChatConsole::getDesiredHeight() const
143 return m_desired_height_fraction;
146 void GUIChatConsole::setCursor(
147 bool visible, bool blinking, f32 blink_speed, f32 relative_height)
153 // leave m_cursor_blink unchanged
154 m_cursor_blink_speed = blink_speed;
158 m_cursor_blink = 0x8000; // on
159 m_cursor_blink_speed = 0.0;
164 m_cursor_blink = 0; // off
165 m_cursor_blink_speed = 0.0;
167 m_cursor_height = relative_height;
170 void GUIChatConsole::draw()
175 video::IVideoDriver* driver = Environment->getVideoDriver();
178 v2u32 screensize = driver->getScreenSize();
179 if (screensize != m_screensize)
181 // screen size has changed
182 // scale current console height to new window size
183 if (m_screensize.Y != 0)
184 m_height = m_height * screensize.Y / m_screensize.Y;
185 m_desired_height = m_desired_height_fraction * m_screensize.Y;
186 m_screensize = screensize;
191 u32 now = getTimeMs();
192 animate(now - m_animate_time_old);
193 m_animate_time_old = now;
195 // Draw console elements if visible
203 gui::IGUIElement::draw();
206 void GUIChatConsole::reformatConsole()
208 s32 cols = m_screensize.X / m_fontsize.X - 2; // make room for a margin (looks better)
209 s32 rows = m_desired_height / m_fontsize.Y - 1; // make room for the input prompt
210 if (cols <= 0 || rows <= 0)
212 m_chat_backend->reformat(cols, rows);
215 void GUIChatConsole::recalculateConsolePosition()
217 core::rect<s32> rect(0, 0, m_screensize.X, m_height);
219 recalculateAbsolutePosition(false);
222 void GUIChatConsole::animate(u32 msec)
224 // animate the console height
225 s32 goal = m_open ? m_desired_height : 0;
226 if (m_height != goal)
228 s32 max_change = msec * m_screensize.Y * (m_height_speed / 1000.0);
235 if (m_height + max_change < goal)
236 m_height += max_change;
243 if (m_height > goal + max_change)
244 m_height -= max_change;
249 recalculateConsolePosition();
253 if (m_cursor_blink_speed != 0.0)
255 u32 blink_increase = 0x10000 * msec * (m_cursor_blink_speed / 1000.0);
256 if (blink_increase == 0)
258 m_cursor_blink = ((m_cursor_blink + blink_increase) & 0xffff);
261 // decrease open inhibit counter
262 if (m_open_inhibited > msec)
263 m_open_inhibited -= msec;
265 m_open_inhibited = 0;
268 void GUIChatConsole::drawBackground()
270 video::IVideoDriver* driver = Environment->getVideoDriver();
271 if (m_background != NULL)
273 core::rect<s32> sourcerect(0, -m_height, m_screensize.X, 0);
278 &AbsoluteClippingRect,
284 driver->draw2DRectangle(
286 core::rect<s32>(0, 0, m_screensize.X, m_height),
287 &AbsoluteClippingRect);
291 void GUIChatConsole::drawText()
296 ChatBuffer& buf = m_chat_backend->getConsoleBuffer();
297 for (u32 row = 0; row < buf.getRows(); ++row)
299 const ChatFormattedLine& line = buf.getFormattedLine(row);
300 if (line.fragments.empty())
303 s32 line_height = m_fontsize.Y;
304 s32 y = row * line_height + m_height - m_desired_height;
305 if (y + line_height < 0)
308 for (u32 i = 0; i < line.fragments.size(); ++i)
310 const ChatFormattedFragment& fragment = line.fragments[i];
311 s32 x = (fragment.column + 1) * m_fontsize.X;
312 core::rect<s32> destrect(
313 x, y, x + m_fontsize.X * fragment.text.size(), y + m_fontsize.Y);
315 fragment.text.c_str(),
317 video::SColor(255, 255, 255, 255),
320 &AbsoluteClippingRect);
325 void GUIChatConsole::drawPrompt()
330 u32 row = m_chat_backend->getConsoleBuffer().getRows();
331 s32 line_height = m_fontsize.Y;
332 s32 y = row * line_height + m_height - m_desired_height;
334 ChatPrompt& prompt = m_chat_backend->getPrompt();
335 std::wstring prompt_text = prompt.getVisiblePortion();
337 // FIXME Draw string at once, not character by character
338 // That will only work with the cursor once we have a monospace font
339 for (u32 i = 0; i < prompt_text.size(); ++i)
341 wchar_t ws[2] = {prompt_text[i], 0};
342 s32 x = (1 + i) * m_fontsize.X;
343 core::rect<s32> destrect(
344 x, y, x + m_fontsize.X, y + m_fontsize.Y);
348 video::SColor(255, 255, 255, 255),
351 &AbsoluteClippingRect);
354 // Draw the cursor during on periods
355 if ((m_cursor_blink & 0x8000) != 0)
357 s32 cursor_pos = prompt.getVisibleCursorPosition();
360 video::IVideoDriver* driver = Environment->getVideoDriver();
361 s32 x = (1 + cursor_pos) * m_fontsize.X;
362 core::rect<s32> destrect(
364 y + (1.0-m_cursor_height) * m_fontsize.Y,
367 video::SColor cursor_color(255,255,255,255);
368 driver->draw2DRectangle(
371 &AbsoluteClippingRect);
377 bool GUIChatConsole::OnEvent(const SEvent& event)
379 if(event.EventType == EET_KEY_INPUT_EVENT && event.KeyInput.PressedDown)
382 if(KeyPress(event.KeyInput) == getKeySetting("keymap_console"))
385 Environment->removeFocus(this);
387 // inhibit open so the_game doesn't reopen immediately
388 m_open_inhibited = 50;
391 else if(event.KeyInput.Key == KEY_ESCAPE)
393 closeConsoleAtOnce();
394 Environment->removeFocus(this);
395 // the_game will open the pause menu
398 else if(event.KeyInput.Key == KEY_PRIOR)
400 m_chat_backend->scrollPageUp();
403 else if(event.KeyInput.Key == KEY_NEXT)
405 m_chat_backend->scrollPageDown();
408 else if(event.KeyInput.Key == KEY_RETURN)
410 std::wstring text = m_chat_backend->getPrompt().submit();
411 m_client->typeChatMessage(text);
414 else if(event.KeyInput.Key == KEY_UP)
417 // Move back in history
418 m_chat_backend->getPrompt().historyPrev();
421 else if(event.KeyInput.Key == KEY_DOWN)
424 // Move forward in history
425 m_chat_backend->getPrompt().historyNext();
428 else if(event.KeyInput.Key == KEY_LEFT)
430 // Left or Ctrl-Left pressed
431 // move character / word to the left
432 ChatPrompt::CursorOpScope scope =
433 event.KeyInput.Control ?
434 ChatPrompt::CURSOROP_SCOPE_WORD :
435 ChatPrompt::CURSOROP_SCOPE_CHARACTER;
436 m_chat_backend->getPrompt().cursorOperation(
437 ChatPrompt::CURSOROP_MOVE,
438 ChatPrompt::CURSOROP_DIR_LEFT,
442 else if(event.KeyInput.Key == KEY_RIGHT)
444 // Right or Ctrl-Right pressed
445 // move character / word to the right
446 ChatPrompt::CursorOpScope scope =
447 event.KeyInput.Control ?
448 ChatPrompt::CURSOROP_SCOPE_WORD :
449 ChatPrompt::CURSOROP_SCOPE_CHARACTER;
450 m_chat_backend->getPrompt().cursorOperation(
451 ChatPrompt::CURSOROP_MOVE,
452 ChatPrompt::CURSOROP_DIR_RIGHT,
456 else if(event.KeyInput.Key == KEY_HOME)
459 // move to beginning of line
460 m_chat_backend->getPrompt().cursorOperation(
461 ChatPrompt::CURSOROP_MOVE,
462 ChatPrompt::CURSOROP_DIR_LEFT,
463 ChatPrompt::CURSOROP_SCOPE_LINE);
466 else if(event.KeyInput.Key == KEY_END)
469 // move to end of line
470 m_chat_backend->getPrompt().cursorOperation(
471 ChatPrompt::CURSOROP_MOVE,
472 ChatPrompt::CURSOROP_DIR_RIGHT,
473 ChatPrompt::CURSOROP_SCOPE_LINE);
476 else if(event.KeyInput.Key == KEY_BACK)
478 // Backspace or Ctrl-Backspace pressed
479 // delete character / word to the left
480 ChatPrompt::CursorOpScope scope =
481 event.KeyInput.Control ?
482 ChatPrompt::CURSOROP_SCOPE_WORD :
483 ChatPrompt::CURSOROP_SCOPE_CHARACTER;
484 m_chat_backend->getPrompt().cursorOperation(
485 ChatPrompt::CURSOROP_DELETE,
486 ChatPrompt::CURSOROP_DIR_LEFT,
490 else if(event.KeyInput.Key == KEY_DELETE)
492 // Delete or Ctrl-Delete pressed
493 // delete character / word to the right
494 ChatPrompt::CursorOpScope scope =
495 event.KeyInput.Control ?
496 ChatPrompt::CURSOROP_SCOPE_WORD :
497 ChatPrompt::CURSOROP_SCOPE_CHARACTER;
498 m_chat_backend->getPrompt().cursorOperation(
499 ChatPrompt::CURSOROP_DELETE,
500 ChatPrompt::CURSOROP_DIR_RIGHT,
504 else if(event.KeyInput.Key == KEY_KEY_U && event.KeyInput.Control)
507 // kill line to left end
508 m_chat_backend->getPrompt().cursorOperation(
509 ChatPrompt::CURSOROP_DELETE,
510 ChatPrompt::CURSOROP_DIR_LEFT,
511 ChatPrompt::CURSOROP_SCOPE_LINE);
514 else if(event.KeyInput.Key == KEY_KEY_K && event.KeyInput.Control)
517 // kill line to right end
518 m_chat_backend->getPrompt().cursorOperation(
519 ChatPrompt::CURSOROP_DELETE,
520 ChatPrompt::CURSOROP_DIR_RIGHT,
521 ChatPrompt::CURSOROP_SCOPE_LINE);
524 else if(event.KeyInput.Key == KEY_TAB)
526 // Tab or Shift-Tab pressed
528 core::list<std::wstring> names = m_client->getConnectedPlayerNames();
529 bool backwards = event.KeyInput.Shift;
530 m_chat_backend->getPrompt().nickCompletion(names, backwards);
533 else if(event.KeyInput.Char != 0 && !event.KeyInput.Control)
535 m_chat_backend->getPrompt().input(event.KeyInput.Char);
539 else if(event.EventType == EET_MOUSE_INPUT_EVENT)
541 if(event.MouseInput.Event == EMIE_MOUSE_WHEEL)
543 s32 rows = myround(-3.0 * event.MouseInput.Wheel);
544 m_chat_backend->scroll(rows);
548 return Parent ? Parent->OnEvent(event) : false;