src/guiChatConsole.cpp

   1 /*
   2 Minetest
   3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   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.
   9
  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.
  14
  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.
  18 */
  19
  20 #include "guiChatConsole.h"
  21 #include "chat.h"
  22 #include "client.h"
  23 #include "debug.h"
  24 #include "gettime.h"
  25 #include "keycode.h"
  26 #include "settings.h"
  27 #include "main.h"  // for g_settings
  28 #include "porting.h"
  29 #include "tile.h"
  30 #include "IGUIFont.h"
  31 #include <string>
  32
  33 #include "gettext.h"
  34
  35 #if USE_FREETYPE
  36 #include "xCGUITTFont.h"
  37 #endif
  38
  39 inline u32 clamp_u8(s32 value)
  40 {
  41         return (u32) MYMIN(MYMAX(value, 0), 255);
  42 }
  43
  44
  45 GUIChatConsole::GUIChatConsole(
  46                 gui::IGUIEnvironment* env,
  47                 gui::IGUIElement* parent,
  48                 s32 id,
  49                 ChatBackend* backend,
  50                 Client* client
  51 ):
  52         IGUIElement(gui::EGUIET_ELEMENT, env, parent, id,
  53                         core::rect<s32>(0,0,100,100)),
  54         m_chat_backend(backend),
  55         m_client(client),
  56         m_screensize(v2u32(0,0)),
  57         m_animate_time_old(0),
  58         m_open(false),
  59         m_height(0),
  60         m_desired_height(0),
  61         m_desired_height_fraction(0.0),
  62         m_height_speed(5.0),
  63         m_open_inhibited(0),
  64         m_cursor_blink(0.0),
  65         m_cursor_blink_speed(0.0),
  66         m_cursor_height(0.0),
  67         m_background(NULL),
  68         m_background_color(255, 0, 0, 0),
  69         m_font(NULL),
  70         m_fontsize(0, 0)
  71 {
  72         m_animate_time_old = getTimeMs();
  73
  74         // load background settings
  75         bool console_color_set = !g_settings->get("console_color").empty();
  76         s32 console_alpha = g_settings->getS32("console_alpha");
  77
  78         // load the background texture depending on settings
  79         m_background_color.setAlpha(clamp_u8(console_alpha));
  80         if (console_color_set)
  81         {
  82                 v3f console_color = g_settings->getV3F("console_color");
  83                 m_background_color.setRed(clamp_u8(myround(console_color.X)));
  84                 m_background_color.setGreen(clamp_u8(myround(console_color.Y)));
  85                 m_background_color.setBlue(clamp_u8(myround(console_color.Z)));
  86         }
  87         else
  88         {
  89                 m_background = env->getVideoDriver()->getTexture(getTexturePath("background_chat.jpg").c_str());
  90                 m_background_color.setRed(255);
  91                 m_background_color.setGreen(255);
  92                 m_background_color.setBlue(255);
  93         }
  94
  95         // load the font
  96         // FIXME should a custom texture_path be searched too?
  97         #if USE_FREETYPE
  98         std::string font_name = g_settings->get("mono_font_path");
  99         u16 font_size = g_settings->getU16("mono_font_size");
 100         m_font = gui::CGUITTFont::createTTFont(env, font_name.c_str(), font_size);
 101         #else
 102         std::string font_name = "fontdejavusansmono.png";
 103         m_font = env->getFont(getTexturePath(font_name).c_str());
 104         #endif
 105         if (m_font == NULL)
 106         {
 107                 dstream << "Unable to load font: " << font_name << std::endl;
 108         }
 109         else
 110         {
 111                 core::dimension2d<u32> dim = m_font->getDimension(L"M");
 112                 m_fontsize = v2u32(dim.Width, dim.Height);
 113                 dstream << "Font size: " << m_fontsize.X << " " << m_fontsize.Y << std::endl;
 114         }
 115         m_fontsize.X = MYMAX(m_fontsize.X, 1);
 116         m_fontsize.Y = MYMAX(m_fontsize.Y, 1);
 117
 118         // set default cursor options
 119         setCursor(true, true, 2.0, 0.1);
 120 }
 121
 122 GUIChatConsole::~GUIChatConsole()
 123 {
 124         delete m_font;
 125 }
 126
 127 void GUIChatConsole::openConsole(f32 height)
 128 {
 129         m_open = true;
 130         m_desired_height_fraction = height;
 131         m_desired_height = height * m_screensize.Y;
 132         reformatConsole();
 133 }
 134
 135 bool GUIChatConsole::isOpenInhibited() const
 136 {
 137         return m_open_inhibited > 0;
 138 }
 139
 140 void GUIChatConsole::closeConsole()
 141 {
 142         m_open = false;
 143 }
 144
 145 void GUIChatConsole::closeConsoleAtOnce()
 146 {
 147         m_open = false;
 148         m_height = 0;
 149         recalculateConsolePosition();
 150 }
 151
 152 f32 GUIChatConsole::getDesiredHeight() const
 153 {
 154         return m_desired_height_fraction;
 155 }
 156
 157 void GUIChatConsole::setCursor(
 158         bool visible, bool blinking, f32 blink_speed, f32 relative_height)
 159 {
 160         if (visible)
 161         {
 162                 if (blinking)
 163                 {
 164                         // leave m_cursor_blink unchanged
 165                         m_cursor_blink_speed = blink_speed;
 166                 }
 167                 else
 168                 {
 169                         m_cursor_blink = 0x8000;  // on
 170                         m_cursor_blink_speed = 0.0;
 171                 }
 172         }
 173         else
 174         {
 175                 m_cursor_blink = 0;  // off
 176                 m_cursor_blink_speed = 0.0;
 177         }
 178         m_cursor_height = relative_height;
 179 }
 180
 181 void GUIChatConsole::draw()
 182 {
 183         if(!IsVisible)
 184                 return;
 185
 186         video::IVideoDriver* driver = Environment->getVideoDriver();
 187
 188         // Check screen size
 189         v2u32 screensize = driver->getScreenSize();
 190         if (screensize != m_screensize)
 191         {
 192                 // screen size has changed
 193                 // scale current console height to new window size
 194                 if (m_screensize.Y != 0)
 195                         m_height = m_height * screensize.Y / m_screensize.Y;
 196                 m_desired_height = m_desired_height_fraction * m_screensize.Y;
 197                 m_screensize = screensize;
 198                 reformatConsole();
 199         }
 200
 201         // Animation
 202         u32 now = getTimeMs();
 203         animate(now - m_animate_time_old);
 204         m_animate_time_old = now;
 205
 206         // Draw console elements if visible
 207         if (m_height > 0)
 208         {
 209                 drawBackground();
 210                 drawText();
 211                 drawPrompt();
 212         }
 213
 214         gui::IGUIElement::draw();
 215 }
 216
 217 void GUIChatConsole::reformatConsole()
 218 {
 219         s32 cols = m_screensize.X / m_fontsize.X - 2; // make room for a margin (looks better)
 220         s32 rows = m_desired_height / m_fontsize.Y - 1; // make room for the input prompt
 221         if (cols <= 0 || rows <= 0)
 222                 cols = rows = 0;
 223         m_chat_backend->reformat(cols, rows);
 224 }
 225
 226 void GUIChatConsole::recalculateConsolePosition()
 227 {
 228         core::rect<s32> rect(0, 0, m_screensize.X, m_height);
 229         DesiredRect = rect;
 230         recalculateAbsolutePosition(false);
 231 }
 232
 233 void GUIChatConsole::animate(u32 msec)
 234 {
 235         // animate the console height
 236         s32 goal = m_open ? m_desired_height : 0;
 237         if (m_height != goal)
 238         {
 239                 s32 max_change = msec * m_screensize.Y * (m_height_speed / 1000.0);
 240                 if (max_change == 0)
 241                         max_change = 1;
 242
 243                 if (m_height < goal)
 244                 {
 245                         // increase height
 246                         if (m_height + max_change < goal)
 247                                 m_height += max_change;
 248                         else
 249                                 m_height = goal;
 250                 }
 251                 else
 252                 {
 253                         // decrease height
 254                         if (m_height > goal + max_change)
 255                                 m_height -= max_change;
 256                         else
 257                                 m_height = goal;
 258                 }
 259
 260                 recalculateConsolePosition();
 261         }
 262
 263         // blink the cursor
 264         if (m_cursor_blink_speed != 0.0)
 265         {
 266                 u32 blink_increase = 0x10000 * msec * (m_cursor_blink_speed / 1000.0);
 267                 if (blink_increase == 0)
 268                         blink_increase = 1;
 269                 m_cursor_blink = ((m_cursor_blink + blink_increase) & 0xffff);
 270         }
 271
 272         // decrease open inhibit counter
 273         if (m_open_inhibited > msec)
 274                 m_open_inhibited -= msec;
 275         else
 276                 m_open_inhibited = 0;
 277 }
 278
 279 void GUIChatConsole::drawBackground()
 280 {
 281         video::IVideoDriver* driver = Environment->getVideoDriver();
 282         if (m_background != NULL)
 283         {
 284                 core::rect<s32> sourcerect(0, -m_height, m_screensize.X, 0);
 285                 driver->draw2DImage(
 286                         m_background,
 287                         v2s32(0, 0),
 288                         sourcerect,
 289                         &AbsoluteClippingRect,
 290                         m_background_color,
 291                         false);
 292         }
 293         else
 294         {
 295                 driver->draw2DRectangle(
 296                         m_background_color,
 297                         core::rect<s32>(0, 0, m_screensize.X, m_height),
 298                         &AbsoluteClippingRect);
 299         }
 300 }
 301
 302 void GUIChatConsole::drawText()
 303 {
 304         if (m_font == NULL)
 305                 return;
 306
 307         ChatBuffer& buf = m_chat_backend->getConsoleBuffer();
 308         for (u32 row = 0; row < buf.getRows(); ++row)
 309         {
 310                 const ChatFormattedLine& line = buf.getFormattedLine(row);
 311                 if (line.fragments.empty())
 312                         continue;
 313
 314                 s32 line_height = m_fontsize.Y;
 315                 s32 y = row * line_height + m_height - m_desired_height;
 316                 if (y + line_height < 0)
 317                         continue;
 318
 319                 for (u32 i = 0; i < line.fragments.size(); ++i)
 320                 {
 321                         const ChatFormattedFragment& fragment = line.fragments[i];
 322                         s32 x = (fragment.column + 1) * m_fontsize.X;
 323                         core::rect<s32> destrect(
 324                                 x, y, x + m_fontsize.X * fragment.text.size(), y + m_fontsize.Y);
 325                         m_font->draw(
 326                                 fragment.text.c_str(),
 327                                 destrect,
 328                                 video::SColor(255, 255, 255, 255),
 329                                 false,
 330                                 false,
 331                                 &AbsoluteClippingRect);
 332                 }
 333         }
 334 }
 335
 336 void GUIChatConsole::drawPrompt()
 337 {
 338         if (m_font == NULL)
 339                 return;
 340
 341         u32 row = m_chat_backend->getConsoleBuffer().getRows();
 342         s32 line_height = m_fontsize.Y;
 343         s32 y = row * line_height + m_height - m_desired_height;
 344
 345         ChatPrompt& prompt = m_chat_backend->getPrompt();
 346         std::wstring prompt_text = prompt.getVisiblePortion();
 347
 348         // FIXME Draw string at once, not character by character
 349         // That will only work with the cursor once we have a monospace font
 350         for (u32 i = 0; i < prompt_text.size(); ++i)
 351         {
 352                 wchar_t ws[2] = {prompt_text[i], 0};
 353                 s32 x = (1 + i) * m_fontsize.X;
 354                 core::rect<s32> destrect(
 355                         x, y, x + m_fontsize.X, y + m_fontsize.Y);
 356                 m_font->draw(
 357                         ws,
 358                         destrect,
 359                         video::SColor(255, 255, 255, 255),
 360                         false,
 361                         false,
 362                         &AbsoluteClippingRect);
 363         }
 364
 365         // Draw the cursor during on periods
 366         if ((m_cursor_blink & 0x8000) != 0)
 367         {
 368                 s32 cursor_pos = prompt.getVisibleCursorPosition();
 369                 if (cursor_pos >= 0)
 370                 {
 371                         video::IVideoDriver* driver = Environment->getVideoDriver();
 372                         s32 x = (1 + cursor_pos) * m_fontsize.X;
 373                         core::rect<s32> destrect(
 374                                 x,
 375                                 y + (1.0-m_cursor_height) * m_fontsize.Y,
 376                                 x + m_fontsize.X,
 377                                 y + m_fontsize.Y);
 378                         video::SColor cursor_color(255,255,255,255);
 379                         driver->draw2DRectangle(
 380                                 cursor_color,
 381                                 destrect,
 382                                 &AbsoluteClippingRect);
 383                 }
 384         }
 385
 386 }
 387
 388 bool GUIChatConsole::OnEvent(const SEvent& event)
 389 {
 390         if(event.EventType == EET_KEY_INPUT_EVENT && event.KeyInput.PressedDown)
 391         {
 392                 // Key input
 393                 if(KeyPress(event.KeyInput) == getKeySetting("keymap_console"))
 394                 {
 395                         closeConsole();
 396                         Environment->removeFocus(this);
 397
 398                         // inhibit open so the_game doesn't reopen immediately
 399                         m_open_inhibited = 50;
 400                         return true;
 401                 }
 402                 else if(event.KeyInput.Key == KEY_ESCAPE)
 403                 {
 404                         closeConsoleAtOnce();
 405                         Environment->removeFocus(this);
 406                         // the_game will open the pause menu
 407                         return true;
 408                 }
 409                 else if(event.KeyInput.Key == KEY_PRIOR)
 410                 {
 411                         m_chat_backend->scrollPageUp();
 412                         return true;
 413                 }
 414                 else if(event.KeyInput.Key == KEY_NEXT)
 415                 {
 416                         m_chat_backend->scrollPageDown();
 417                         return true;
 418                 }
 419                 else if(event.KeyInput.Key == KEY_RETURN)
 420                 {
 421                         std::wstring text = m_chat_backend->getPrompt().submit();
 422                         m_client->typeChatMessage(text);
 423                         return true;
 424                 }
 425                 else if(event.KeyInput.Key == KEY_UP)
 426                 {
 427                         // Up pressed
 428                         // Move back in history
 429                         m_chat_backend->getPrompt().historyPrev();
 430                         return true;
 431                 }
 432                 else if(event.KeyInput.Key == KEY_DOWN)
 433                 {
 434                         // Down pressed
 435                         // Move forward in history
 436                         m_chat_backend->getPrompt().historyNext();
 437                         return true;
 438                 }
 439                 else if(event.KeyInput.Key == KEY_LEFT)
 440                 {
 441                         // Left or Ctrl-Left pressed
 442                         // move character / word to the left
 443                         ChatPrompt::CursorOpScope scope =
 444                                 event.KeyInput.Control ?
 445                                 ChatPrompt::CURSOROP_SCOPE_WORD :
 446                                 ChatPrompt::CURSOROP_SCOPE_CHARACTER;
 447                         m_chat_backend->getPrompt().cursorOperation(
 448                                 ChatPrompt::CURSOROP_MOVE,
 449                                 ChatPrompt::CURSOROP_DIR_LEFT,
 450                                 scope);
 451                         return true;
 452                 }
 453                 else if(event.KeyInput.Key == KEY_RIGHT)
 454                 {
 455                         // Right or Ctrl-Right pressed
 456                         // move character / word to the right
 457                         ChatPrompt::CursorOpScope scope =
 458                                 event.KeyInput.Control ?
 459                                 ChatPrompt::CURSOROP_SCOPE_WORD :
 460                                 ChatPrompt::CURSOROP_SCOPE_CHARACTER;
 461                         m_chat_backend->getPrompt().cursorOperation(
 462                                 ChatPrompt::CURSOROP_MOVE,
 463                                 ChatPrompt::CURSOROP_DIR_RIGHT,
 464                                 scope);
 465                         return true;
 466                 }
 467                 else if(event.KeyInput.Key == KEY_HOME)
 468                 {
 469                         // Home pressed
 470                         // move to beginning of line
 471                         m_chat_backend->getPrompt().cursorOperation(
 472                                 ChatPrompt::CURSOROP_MOVE,
 473                                 ChatPrompt::CURSOROP_DIR_LEFT,
 474                                 ChatPrompt::CURSOROP_SCOPE_LINE);
 475                         return true;
 476                 }
 477                 else if(event.KeyInput.Key == KEY_END)
 478                 {
 479                         // End pressed
 480                         // move to end of line
 481                         m_chat_backend->getPrompt().cursorOperation(
 482                                 ChatPrompt::CURSOROP_MOVE,
 483                                 ChatPrompt::CURSOROP_DIR_RIGHT,
 484                                 ChatPrompt::CURSOROP_SCOPE_LINE);
 485                         return true;
 486                 }
 487                 else if(event.KeyInput.Key == KEY_BACK)
 488                 {
 489                         // Backspace or Ctrl-Backspace pressed
 490                         // delete character / word to the left
 491                         ChatPrompt::CursorOpScope scope =
 492                                 event.KeyInput.Control ?
 493                                 ChatPrompt::CURSOROP_SCOPE_WORD :
 494                                 ChatPrompt::CURSOROP_SCOPE_CHARACTER;
 495                         m_chat_backend->getPrompt().cursorOperation(
 496                                 ChatPrompt::CURSOROP_DELETE,
 497                                 ChatPrompt::CURSOROP_DIR_LEFT,
 498                                 scope);
 499                         return true;
 500                 }
 501                 else if(event.KeyInput.Key == KEY_DELETE)
 502                 {
 503                         // Delete or Ctrl-Delete pressed
 504                         // delete character / word to the right
 505                         ChatPrompt::CursorOpScope scope =
 506                                 event.KeyInput.Control ?
 507                                 ChatPrompt::CURSOROP_SCOPE_WORD :
 508                                 ChatPrompt::CURSOROP_SCOPE_CHARACTER;
 509                         m_chat_backend->getPrompt().cursorOperation(
 510                                 ChatPrompt::CURSOROP_DELETE,
 511                                 ChatPrompt::CURSOROP_DIR_RIGHT,
 512                                 scope);
 513                         return true;
 514                 }
 515                 else if(event.KeyInput.Key == KEY_KEY_U && event.KeyInput.Control)
 516                 {
 517                         // Ctrl-U pressed
 518                         // kill line to left end
 519                         m_chat_backend->getPrompt().cursorOperation(
 520                                 ChatPrompt::CURSOROP_DELETE,
 521                                 ChatPrompt::CURSOROP_DIR_LEFT,
 522                                 ChatPrompt::CURSOROP_SCOPE_LINE);
 523                         return true;
 524                 }
 525                 else if(event.KeyInput.Key == KEY_KEY_K && event.KeyInput.Control)
 526                 {
 527                         // Ctrl-K pressed
 528                         // kill line to right end
 529                         m_chat_backend->getPrompt().cursorOperation(
 530                                 ChatPrompt::CURSOROP_DELETE,
 531                                 ChatPrompt::CURSOROP_DIR_RIGHT,
 532                                 ChatPrompt::CURSOROP_SCOPE_LINE);
 533                         return true;
 534                 }
 535                 else if(event.KeyInput.Key == KEY_TAB)
 536                 {
 537                         // Tab or Shift-Tab pressed
 538                         // Nick completion
 539                         std::list<std::string> names = m_client->getConnectedPlayerNames();
 540                         bool backwards = event.KeyInput.Shift;
 541                         m_chat_backend->getPrompt().nickCompletion(names, backwards);
 542                         return true;
 543                 }
 544                 else if(event.KeyInput.Char != 0 && !event.KeyInput.Control)
 545                 {
 546                         m_chat_backend->getPrompt().input(event.KeyInput.Char);
 547                         return true;
 548                 }
 549         }
 550         else if(event.EventType == EET_MOUSE_INPUT_EVENT)
 551         {
 552                 if(event.MouseInput.Event == EMIE_MOUSE_WHEEL)
 553                 {
 554                         s32 rows = myround(-3.0 * event.MouseInput.Wheel);
 555                         m_chat_backend->scroll(rows);
 556                 }
 557         }
 558
 559         return Parent ? Parent->OnEvent(event) : false;
 560 }
 561