src/gui/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/client.h"
  23 #include "debug.h"
  24 #include "gettime.h"
  25 #include "client/keycode.h"
  26 #include "settings.h"
  27 #include "porting.h"
  28 #include "client/tile.h"
  29 #include "client/fontengine.h"
  30 #include "log.h"
  31 #include "gettext.h"
  32 #include <string>
  33
  34 #if USE_FREETYPE
  35         #include "irrlicht_changes/CGUITTFont.h"
  36 #endif
  37
  38 inline u32 clamp_u8(s32 value)
  39 {
  40         return (u32) MYMIN(MYMAX(value, 0), 255);
  41 }
  42
  43
  44 GUIChatConsole::GUIChatConsole(
  45                 gui::IGUIEnvironment* env,
  46                 gui::IGUIElement* parent,
  47                 s32 id,
  48                 ChatBackend* backend,
  49                 Client* client,
  50                 IMenuManager* menumgr
  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_menumgr(menumgr),
  57         m_animate_time_old(porting::getTimeMs())
  58 {
  59         // load background settings
  60         s32 console_alpha = g_settings->getS32("console_alpha");
  61         m_background_color.setAlpha(clamp_u8(console_alpha));
  62
  63         // load the background texture depending on settings
  64         ITextureSource *tsrc = client->getTextureSource();
  65         if (tsrc->isKnownSourceImage("background_chat.jpg")) {
  66                 m_background = tsrc->getTexture("background_chat.jpg");
  67                 m_background_color.setRed(255);
  68                 m_background_color.setGreen(255);
  69                 m_background_color.setBlue(255);
  70         } else {
  71                 v3f console_color = g_settings->getV3F("console_color");
  72                 m_background_color.setRed(clamp_u8(myround(console_color.X)));
  73                 m_background_color.setGreen(clamp_u8(myround(console_color.Y)));
  74                 m_background_color.setBlue(clamp_u8(myround(console_color.Z)));
  75         }
  76
  77         m_font = g_fontengine->getFont(FONT_SIZE_UNSPECIFIED, FM_Mono);
  78
  79         if (!m_font) {
  80                 errorstream << "GUIChatConsole: Unable to load mono font" << std::endl;
  81         } else {
  82                 core::dimension2d<u32> dim = m_font->getDimension(L"M");
  83                 m_fontsize = v2u32(dim.Width, dim.Height);
  84                 m_font->grab();
  85         }
  86         m_fontsize.X = MYMAX(m_fontsize.X, 1);
  87         m_fontsize.Y = MYMAX(m_fontsize.Y, 1);
  88
  89         // set default cursor options
  90         setCursor(true, true, 2.0, 0.1);
  91 }
  92
  93 GUIChatConsole::~GUIChatConsole()
  94 {
  95         if (m_font)
  96                 m_font->drop();
  97 }
  98
  99 void GUIChatConsole::openConsole(f32 scale)
 100 {
 101         assert(scale > 0.0f && scale <= 1.0f);
 102
 103         m_open = true;
 104         m_desired_height_fraction = scale;
 105         m_desired_height = scale * m_screensize.Y;
 106         reformatConsole();
 107         m_animate_time_old = porting::getTimeMs();
 108         IGUIElement::setVisible(true);
 109         Environment->setFocus(this);
 110         m_menumgr->createdMenu(this);
 111 }
 112
 113 bool GUIChatConsole::isOpen() const
 114 {
 115         return m_open;
 116 }
 117
 118 bool GUIChatConsole::isOpenInhibited() const
 119 {
 120         return m_open_inhibited > 0;
 121 }
 122
 123 void GUIChatConsole::closeConsole()
 124 {
 125         m_open = false;
 126         Environment->removeFocus(this);
 127         m_menumgr->deletingMenu(this);
 128 }
 129
 130 void GUIChatConsole::closeConsoleAtOnce()
 131 {
 132         closeConsole();
 133         m_height = 0;
 134         recalculateConsolePosition();
 135 }
 136
 137 f32 GUIChatConsole::getDesiredHeight() const
 138 {
 139         return m_desired_height_fraction;
 140 }
 141
 142 void GUIChatConsole::replaceAndAddToHistory(const std::wstring &line)
 143 {
 144         ChatPrompt& prompt = m_chat_backend->getPrompt();
 145         prompt.addToHistory(prompt.getLine());
 146         prompt.replace(line);
 147 }
 148
 149
 150 void GUIChatConsole::setCursor(
 151         bool visible, bool blinking, f32 blink_speed, f32 relative_height)
 152 {
 153         if (visible)
 154         {
 155                 if (blinking)
 156                 {
 157                         // leave m_cursor_blink unchanged
 158                         m_cursor_blink_speed = blink_speed;
 159                 }
 160                 else
 161                 {
 162                         m_cursor_blink = 0x8000;  // on
 163                         m_cursor_blink_speed = 0.0;
 164                 }
 165         }
 166         else
 167         {
 168                 m_cursor_blink = 0;  // off
 169                 m_cursor_blink_speed = 0.0;
 170         }
 171         m_cursor_height = relative_height;
 172 }
 173
 174 void GUIChatConsole::draw()
 175 {
 176         if(!IsVisible)
 177                 return;
 178
 179         video::IVideoDriver* driver = Environment->getVideoDriver();
 180
 181         // Check screen size
 182         v2u32 screensize = driver->getScreenSize();
 183         if (screensize != m_screensize)
 184         {
 185                 // screen size has changed
 186                 // scale current console height to new window size
 187                 if (m_screensize.Y != 0)
 188                         m_height = m_height * screensize.Y / m_screensize.Y;
 189                 m_screensize = screensize;
 190                 m_desired_height = m_desired_height_fraction * m_screensize.Y;
 191                 reformatConsole();
 192         }
 193
 194         // Animation
 195         u64 now = porting::getTimeMs();
 196         animate(now - m_animate_time_old);
 197         m_animate_time_old = now;
 198
 199         // Draw console elements if visible
 200         if (m_height > 0)
 201         {
 202                 drawBackground();
 203                 drawText();
 204                 drawPrompt();
 205         }
 206
 207         gui::IGUIElement::draw();
 208 }
 209
 210 void GUIChatConsole::reformatConsole()
 211 {
 212         s32 cols = m_screensize.X / m_fontsize.X - 2; // make room for a margin (looks better)
 213         s32 rows = m_desired_height / m_fontsize.Y - 1; // make room for the input prompt
 214         if (cols <= 0 || rows <= 0)
 215                 cols = rows = 0;
 216         recalculateConsolePosition();
 217         m_chat_backend->reformat(cols, rows);
 218 }
 219
 220 void GUIChatConsole::recalculateConsolePosition()
 221 {
 222         core::rect<s32> rect(0, 0, m_screensize.X, m_height);
 223         DesiredRect = rect;
 224         recalculateAbsolutePosition(false);
 225 }
 226
 227 void GUIChatConsole::animate(u32 msec)
 228 {
 229         // animate the console height
 230         s32 goal = m_open ? m_desired_height : 0;
 231
 232         // Set invisible if close animation finished (reset by openConsole)
 233         // This function (animate()) is never called once its visibility becomes false so do not
 234         //              actually set visible to false before the inhibited period is over
 235         if (!m_open && m_height == 0 && m_open_inhibited == 0)
 236                 IGUIElement::setVisible(false);
 237
 238         if (m_height != goal)
 239         {
 240                 s32 max_change = msec * m_screensize.Y * (m_height_speed / 1000.0);
 241                 if (max_change == 0)
 242                         max_change = 1;
 243
 244                 if (m_height < goal)
 245                 {
 246                         // increase height
 247                         if (m_height + max_change < goal)
 248                                 m_height += max_change;
 249                         else
 250                                 m_height = goal;
 251                 }
 252                 else
 253                 {
 254                         // decrease height
 255                         if (m_height > goal + max_change)
 256                                 m_height -= max_change;
 257                         else
 258                                 m_height = goal;
 259                 }
 260
 261                 recalculateConsolePosition();
 262         }
 263
 264         // blink the cursor
 265         if (m_cursor_blink_speed != 0.0)
 266         {
 267                 u32 blink_increase = 0x10000 * msec * (m_cursor_blink_speed / 1000.0);
 268                 if (blink_increase == 0)
 269                         blink_increase = 1;
 270                 m_cursor_blink = ((m_cursor_blink + blink_increase) & 0xffff);
 271         }
 272
 273         // decrease open inhibit counter
 274         if (m_open_inhibited > msec)
 275                 m_open_inhibited -= msec;
 276         else
 277                 m_open_inhibited = 0;
 278 }
 279
 280 void GUIChatConsole::drawBackground()
 281 {
 282         video::IVideoDriver* driver = Environment->getVideoDriver();
 283         if (m_background != NULL)
 284         {
 285                 core::rect<s32> sourcerect(0, -m_height, m_screensize.X, 0);
 286                 driver->draw2DImage(
 287                         m_background,
 288                         v2s32(0, 0),
 289                         sourcerect,
 290                         &AbsoluteClippingRect,
 291                         m_background_color,
 292                         false);
 293         }
 294         else
 295         {
 296                 driver->draw2DRectangle(
 297                         m_background_color,
 298                         core::rect<s32>(0, 0, m_screensize.X, m_height),
 299                         &AbsoluteClippingRect);
 300         }
 301 }
 302
 303 void GUIChatConsole::drawText()
 304 {
 305         if (m_font == NULL)
 306                 return;
 307
 308         ChatBuffer& buf = m_chat_backend->getConsoleBuffer();
 309         for (u32 row = 0; row < buf.getRows(); ++row)
 310         {
 311                 const ChatFormattedLine& line = buf.getFormattedLine(row);
 312                 if (line.fragments.empty())
 313                         continue;
 314
 315                 s32 line_height = m_fontsize.Y;
 316                 s32 y = row * line_height + m_height - m_desired_height;
 317                 if (y + line_height < 0)
 318                         continue;
 319
 320                 for (const ChatFormattedFragment &fragment : line.fragments) {
 321                         s32 x = (fragment.column + 1) * m_fontsize.X;
 322                         core::rect<s32> destrect(
 323                                 x, y, x + m_fontsize.X * fragment.text.size(), y + m_fontsize.Y);
 324
 325 #if USE_FREETYPE
 326                         if (m_font->getType() == irr::gui::EGFT_CUSTOM) {
 327                                 // Draw colored text if FreeType is enabled
 328                                 irr::gui::CGUITTFont *tmp = dynamic_cast<irr::gui::CGUITTFont *>(m_font);
 329                                 tmp->draw(
 330                                         fragment.text,
 331                                         destrect,
 332                                         video::SColor(255, 255, 255, 255),
 333                                         false,
 334                                         false,
 335                                         &AbsoluteClippingRect);
 336                         } else
 337 #endif
 338                         {
 339                                 // Otherwise use standard text
 340                                 m_font->draw(
 341                                         fragment.text.c_str(),
 342                                         destrect,
 343                                         video::SColor(255, 255, 255, 255),
 344                                         false,
 345                                         false,
 346                                         &AbsoluteClippingRect);
 347                         }
 348                 }
 349         }
 350 }
 351
 352 void GUIChatConsole::drawPrompt()
 353 {
 354         if (!m_font)
 355                 return;
 356
 357         u32 row = m_chat_backend->getConsoleBuffer().getRows();
 358         s32 line_height = m_fontsize.Y;
 359         s32 y = row * line_height + m_height - m_desired_height;
 360
 361         ChatPrompt& prompt = m_chat_backend->getPrompt();
 362         std::wstring prompt_text = prompt.getVisiblePortion();
 363
 364         // FIXME Draw string at once, not character by character
 365         // That will only work with the cursor once we have a monospace font
 366         for (u32 i = 0; i < prompt_text.size(); ++i)
 367         {
 368                 wchar_t ws[2] = {prompt_text[i], 0};
 369                 s32 x = (1 + i) * m_fontsize.X;
 370                 core::rect<s32> destrect(
 371                         x, y, x + m_fontsize.X, y + m_fontsize.Y);
 372                 m_font->draw(
 373                         ws,
 374                         destrect,
 375                         video::SColor(255, 255, 255, 255),
 376                         false,
 377                         false,
 378                         &AbsoluteClippingRect);
 379         }
 380
 381         // Draw the cursor during on periods
 382         if ((m_cursor_blink & 0x8000) != 0)
 383         {
 384                 s32 cursor_pos = prompt.getVisibleCursorPosition();
 385                 if (cursor_pos >= 0)
 386                 {
 387                         s32 cursor_len = prompt.getCursorLength();
 388                         video::IVideoDriver* driver = Environment->getVideoDriver();
 389                         s32 x = (1 + cursor_pos) * m_fontsize.X;
 390                         core::rect<s32> destrect(
 391                                 x,
 392                                 y + m_fontsize.Y * (1.0 - m_cursor_height),
 393                                 x + m_fontsize.X * MYMAX(cursor_len, 1),
 394                                 y + m_fontsize.Y * (cursor_len ? m_cursor_height+1 : 1)
 395                         );
 396                         video::SColor cursor_color(255,255,255,255);
 397                         driver->draw2DRectangle(
 398                                 cursor_color,
 399                                 destrect,
 400                                 &AbsoluteClippingRect);
 401                 }
 402         }
 403
 404 }
 405
 406 bool GUIChatConsole::OnEvent(const SEvent& event)
 407 {
 408
 409         ChatPrompt &prompt = m_chat_backend->getPrompt();
 410
 411         if(event.EventType == EET_KEY_INPUT_EVENT && event.KeyInput.PressedDown)
 412         {
 413                 // Key input
 414                 if (KeyPress(event.KeyInput) == getKeySetting("keymap_console")) {
 415                         closeConsole();
 416
 417                         // inhibit open so the_game doesn't reopen immediately
 418                         m_open_inhibited = 50;
 419                         m_close_on_enter = false;
 420                         return true;
 421                 }
 422
 423                 if (event.KeyInput.Key == KEY_ESCAPE) {
 424                         closeConsoleAtOnce();
 425                         m_close_on_enter = false;
 426                         // inhibit open so the_game doesn't reopen immediately
 427                         m_open_inhibited = 1; // so the ESCAPE button doesn't open the "pause menu"
 428                         return true;
 429                 }
 430                 else if(event.KeyInput.Key == KEY_PRIOR)
 431                 {
 432                         m_chat_backend->scrollPageUp();
 433                         return true;
 434                 }
 435                 else if(event.KeyInput.Key == KEY_NEXT)
 436                 {
 437                         m_chat_backend->scrollPageDown();
 438                         return true;
 439                 }
 440                 else if(event.KeyInput.Key == KEY_RETURN)
 441                 {
 442                         prompt.addToHistory(prompt.getLine());
 443                         std::wstring text = prompt.replace(L"");
 444                         m_client->typeChatMessage(text);
 445                         if (m_close_on_enter) {
 446                                 closeConsoleAtOnce();
 447                                 m_close_on_enter = false;
 448                         }
 449                         return true;
 450                 }
 451                 else if(event.KeyInput.Key == KEY_UP)
 452                 {
 453                         // Up pressed
 454                         // Move back in history
 455                         prompt.historyPrev();
 456                         return true;
 457                 }
 458                 else if(event.KeyInput.Key == KEY_DOWN)
 459                 {
 460                         // Down pressed
 461                         // Move forward in history
 462                         prompt.historyNext();
 463                         return true;
 464                 }
 465                 else if(event.KeyInput.Key == KEY_LEFT || event.KeyInput.Key == KEY_RIGHT)
 466                 {
 467                         // Left/right pressed
 468                         // Move/select character/word to the left depending on control and shift keys
 469                         ChatPrompt::CursorOp op = event.KeyInput.Shift ?
 470                                 ChatPrompt::CURSOROP_SELECT :
 471                                 ChatPrompt::CURSOROP_MOVE;
 472                         ChatPrompt::CursorOpDir dir = event.KeyInput.Key == KEY_LEFT ?
 473                                 ChatPrompt::CURSOROP_DIR_LEFT :
 474                                 ChatPrompt::CURSOROP_DIR_RIGHT;
 475                         ChatPrompt::CursorOpScope scope = event.KeyInput.Control ?
 476                                 ChatPrompt::CURSOROP_SCOPE_WORD :
 477                                 ChatPrompt::CURSOROP_SCOPE_CHARACTER;
 478                         prompt.cursorOperation(op, dir, scope);
 479                         return true;
 480                 }
 481                 else if(event.KeyInput.Key == KEY_HOME)
 482                 {
 483                         // Home pressed
 484                         // move to beginning of line
 485                         prompt.cursorOperation(
 486                                 ChatPrompt::CURSOROP_MOVE,
 487                                 ChatPrompt::CURSOROP_DIR_LEFT,
 488                                 ChatPrompt::CURSOROP_SCOPE_LINE);
 489                         return true;
 490                 }
 491                 else if(event.KeyInput.Key == KEY_END)
 492                 {
 493                         // End pressed
 494                         // move to end of line
 495                         prompt.cursorOperation(
 496                                 ChatPrompt::CURSOROP_MOVE,
 497                                 ChatPrompt::CURSOROP_DIR_RIGHT,
 498                                 ChatPrompt::CURSOROP_SCOPE_LINE);
 499                         return true;
 500                 }
 501                 else if(event.KeyInput.Key == KEY_BACK)
 502                 {
 503                         // Backspace or Ctrl-Backspace pressed
 504                         // delete character / word to the left
 505                         ChatPrompt::CursorOpScope scope =
 506                                 event.KeyInput.Control ?
 507                                 ChatPrompt::CURSOROP_SCOPE_WORD :
 508                                 ChatPrompt::CURSOROP_SCOPE_CHARACTER;
 509                         prompt.cursorOperation(
 510                                 ChatPrompt::CURSOROP_DELETE,
 511                                 ChatPrompt::CURSOROP_DIR_LEFT,
 512                                 scope);
 513                         return true;
 514                 }
 515                 else if(event.KeyInput.Key == KEY_DELETE)
 516                 {
 517                         // Delete or Ctrl-Delete pressed
 518                         // delete character / word to the right
 519                         ChatPrompt::CursorOpScope scope =
 520                                 event.KeyInput.Control ?
 521                                 ChatPrompt::CURSOROP_SCOPE_WORD :
 522                                 ChatPrompt::CURSOROP_SCOPE_CHARACTER;
 523                         prompt.cursorOperation(
 524                                 ChatPrompt::CURSOROP_DELETE,
 525                                 ChatPrompt::CURSOROP_DIR_RIGHT,
 526                                 scope);
 527                         return true;
 528                 }
 529                 else if(event.KeyInput.Key == KEY_KEY_A && event.KeyInput.Control)
 530                 {
 531                         // Ctrl-A pressed
 532                         // Select all text
 533                         prompt.cursorOperation(
 534                                 ChatPrompt::CURSOROP_SELECT,
 535                                 ChatPrompt::CURSOROP_DIR_LEFT, // Ignored
 536                                 ChatPrompt::CURSOROP_SCOPE_LINE);
 537                         return true;
 538                 }
 539                 else if(event.KeyInput.Key == KEY_KEY_C && event.KeyInput.Control)
 540                 {
 541                         // Ctrl-C pressed
 542                         // Copy text to clipboard
 543                         if (prompt.getCursorLength() <= 0)
 544                                 return true;
 545                         std::wstring wselected = prompt.getSelection();
 546                         std::string selected(wselected.begin(), wselected.end());
 547                         Environment->getOSOperator()->copyToClipboard(selected.c_str());
 548                         return true;
 549                 }
 550                 else if(event.KeyInput.Key == KEY_KEY_V && event.KeyInput.Control)
 551                 {
 552                         // Ctrl-V pressed
 553                         // paste text from clipboard
 554                         if (prompt.getCursorLength() > 0) {
 555                                 // Delete selected section of text
 556                                 prompt.cursorOperation(
 557                                         ChatPrompt::CURSOROP_DELETE,
 558                                         ChatPrompt::CURSOROP_DIR_LEFT, // Ignored
 559                                         ChatPrompt::CURSOROP_SCOPE_SELECTION);
 560                         }
 561                         IOSOperator *os_operator = Environment->getOSOperator();
 562                         const c8 *text = os_operator->getTextFromClipboard();
 563                         if (!text)
 564                                 return true;
 565                         std::basic_string<unsigned char> str((const unsigned char*)text);
 566                         prompt.input(std::wstring(str.begin(), str.end()));
 567                         return true;
 568                 }
 569                 else if(event.KeyInput.Key == KEY_KEY_X && event.KeyInput.Control)
 570                 {
 571                         // Ctrl-X pressed
 572                         // Cut text to clipboard
 573                         if (prompt.getCursorLength() <= 0)
 574                                 return true;
 575                         std::wstring wselected = prompt.getSelection();
 576                         std::string selected(wselected.begin(), wselected.end());
 577                         Environment->getOSOperator()->copyToClipboard(selected.c_str());
 578                         prompt.cursorOperation(
 579                                 ChatPrompt::CURSOROP_DELETE,
 580                                 ChatPrompt::CURSOROP_DIR_LEFT, // Ignored
 581                                 ChatPrompt::CURSOROP_SCOPE_SELECTION);
 582                         return true;
 583                 }
 584                 else if(event.KeyInput.Key == KEY_KEY_U && event.KeyInput.Control)
 585                 {
 586                         // Ctrl-U pressed
 587                         // kill line to left end
 588                         prompt.cursorOperation(
 589                                 ChatPrompt::CURSOROP_DELETE,
 590                                 ChatPrompt::CURSOROP_DIR_LEFT,
 591                                 ChatPrompt::CURSOROP_SCOPE_LINE);
 592                         return true;
 593                 }
 594                 else if(event.KeyInput.Key == KEY_KEY_K && event.KeyInput.Control)
 595                 {
 596                         // Ctrl-K pressed
 597                         // kill line to right end
 598                         prompt.cursorOperation(
 599                                 ChatPrompt::CURSOROP_DELETE,
 600                                 ChatPrompt::CURSOROP_DIR_RIGHT,
 601                                 ChatPrompt::CURSOROP_SCOPE_LINE);
 602                         return true;
 603                 }
 604                 else if(event.KeyInput.Key == KEY_TAB)
 605                 {
 606                         // Tab or Shift-Tab pressed
 607                         // Nick completion
 608                         std::list<std::string> names = m_client->getConnectedPlayerNames();
 609                         bool backwards = event.KeyInput.Shift;
 610                         prompt.nickCompletion(names, backwards);
 611                         return true;
 612                 } else if (!iswcntrl(event.KeyInput.Char) && !event.KeyInput.Control) {
 613                         #if defined(__linux__) && (IRRLICHT_VERSION_MAJOR == 1 && IRRLICHT_VERSION_MINOR < 9)
 614                                 wchar_t wc = L'_';
 615                                 mbtowc( &wc, (char *) &event.KeyInput.Char, sizeof(event.KeyInput.Char) );
 616                                 prompt.input(wc);
 617                         #else
 618                                 prompt.input(event.KeyInput.Char);
 619                         #endif
 620                         return true;
 621                 }
 622         }
 623         else if(event.EventType == EET_MOUSE_INPUT_EVENT)
 624         {
 625                 if(event.MouseInput.Event == EMIE_MOUSE_WHEEL)
 626                 {
 627                         s32 rows = myround(-3.0 * event.MouseInput.Wheel);
 628                         m_chat_backend->scroll(rows);
 629                 }
 630         }
 631
 632         return Parent ? Parent->OnEvent(event) : false;
 633 }
 634
 635 void GUIChatConsole::setVisible(bool visible)
 636 {
 637         m_open = visible;
 638         IGUIElement::setVisible(visible);
 639         if (!visible) {
 640                 m_height = 0;
 641                 recalculateConsolePosition();
 642         }
 643 }
 644