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