osk_gui.cpp

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

 
#include "stdafx.h"
#include "string_func.h"
#include "strings_func.h"
#include "debug.h"
#include "window_func.h"
#include "gfx_func.h"
#include "querystring_gui.h"
#include "video/video_driver.hpp"
#include "zoom_func.h"
#include "core/string_consumer.hpp"
 
#include "widgets/osk_widget.h"
 
#include "table/sprites.h"
#include "table/strings.h"
 
#include "safeguards.h"
 
std::string _keyboard_opt[2];
static char32_t _keyboard[2][OSK_KEYBOARD_ENTRIES];

enum class KeyState : uint8_t {
  Shift, 
  Capslock, 
};

using KeyStates = EnumBitSet<KeyState, uint8_t>;
 
struct OskWindow : public Window {
  StringID caption{}; 
  QueryString *qs = nullptr; 
  WidgetID text_btn{}; 
  Textbuf *text = nullptr; 
  std::string orig_str{}; 
  bool shift = false; 

  static inline KeyStates keystate{};
 
  OskWindow(WindowDesc &desc, Window *parent, WidgetID button) : Window(desc)
  {
    this->parent = parent;
    assert(parent != nullptr);
 
    NWidgetCore *par_wid = parent->GetWidget<NWidgetCore>(button);
    assert(par_wid != nullptr);
 
    assert(parent->querystrings.count(button) != 0);
    this->qs         = parent->querystrings.find(button)->second;
    this->caption = (par_wid->GetString() != STR_NULL) ? par_wid->GetString() : this->qs->caption;
    this->text_btn   = button;
    this->text       = &this->qs->text;
    this->querystrings[WID_OSK_TEXT] = this->qs;
 
    /* make a copy in case we need to reset later */
    this->orig_str = this->qs->text.GetText();
 
    this->InitNested(0);
    this->SetFocusedWidget(WID_OSK_TEXT);
 
    /* Not needed by default. */
    this->DisableWidget(WID_OSK_SPECIAL);
 
    this->UpdateOskState();
  }

  void UpdateOskState()
  {
    this->shift = OskWindow::keystate.Test(KeyState::Capslock) ^ OskWindow::keystate.Test(KeyState::Shift);
 
    for (uint i = 0; i < OSK_KEYBOARD_ENTRIES; i++) {
      this->SetWidgetDisabledState(WID_OSK_LETTERS + i,
          !IsValidChar(_keyboard[this->shift][i], this->qs->text.afilter) || _keyboard[this->shift][i] == ' ');
    }
    this->SetWidgetDisabledState(WID_OSK_SPACE, !IsValidChar(' ', this->qs->text.afilter));
 
    this->SetWidgetLoweredState(WID_OSK_SHIFT, OskWindow::keystate.Test(KeyState::Shift));
    this->SetWidgetLoweredState(WID_OSK_CAPS, OskWindow::keystate.Test(KeyState::Capslock));
  }
 
  std::string GetWidgetString(WidgetID widget, StringID stringid) const override
  {
    if (widget == WID_OSK_CAPTION) return GetString(this->caption);
 
    return this->Window::GetWidgetString(widget, stringid);
  }
 
  void DrawWidget(const Rect &r, WidgetID widget) const override
  {
    if (widget < WID_OSK_LETTERS) return;
 
    widget -= WID_OSK_LETTERS;
    DrawCharCentered(_keyboard[this->shift][widget], r, TextColour::Black);
  }
 
  void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
  {
    /* clicked a letter */
    if (widget >= WID_OSK_LETTERS) {
      char32_t c = _keyboard[this->shift][widget - WID_OSK_LETTERS];
 
      if (!IsValidChar(c, this->qs->text.afilter)) return;
 
      if (this->qs->text.InsertChar(c)) this->OnEditboxChanged(WID_OSK_TEXT);
 
      if (OskWindow::keystate.Test(KeyState::Shift)) {
        OskWindow::keystate.Flip(KeyState::Shift);
        this->UpdateOskState();
        this->SetDirty();
      }
      return;
    }
 
    switch (widget) {
      case WID_OSK_BACKSPACE:
        if (this->qs->text.DeleteChar(WKC_BACKSPACE)) this->OnEditboxChanged(WID_OSK_TEXT);
        break;
 
      case WID_OSK_SPECIAL:
        /*
         * Anything device specific can go here.
         * The button itself is hidden by default, and when you need it you
         * can not hide it in the create event.
         */
        break;
 
      case WID_OSK_CAPS:
        OskWindow::keystate.Flip(KeyState::Capslock);
        this->UpdateOskState();
        this->SetDirty();
        break;
 
      case WID_OSK_SHIFT:
        OskWindow::keystate.Flip(KeyState::Shift);
        this->UpdateOskState();
        this->SetDirty();
        break;
 
      case WID_OSK_SPACE:
        if (this->qs->text.InsertChar(' ')) this->OnEditboxChanged(WID_OSK_TEXT);
        break;
 
      case WID_OSK_LEFT:
        if (this->qs->text.MovePos(WKC_LEFT)) this->InvalidateData();
        break;
 
      case WID_OSK_RIGHT:
        if (this->qs->text.MovePos(WKC_RIGHT)) this->InvalidateData();
        break;
 
      case WID_OSK_OK:
        if (!this->qs->orig.has_value() || this->qs->text.GetText() != this->qs->orig) {
          /* pass information by simulating a button press on parent window */
          if (this->qs->ok_button >= 0) {
            this->parent->OnClick(pt, this->qs->ok_button, 1);
            /* Window gets deleted when the parent window removes itself. */
            return;
          }
        }
        this->Close();
        break;
 
      case WID_OSK_CANCEL:
        if (this->qs->cancel_button >= 0) { // pass a cancel event to the parent window
          this->parent->OnClick(pt, this->qs->cancel_button, 1);
          /* Window gets deleted when the parent window removes itself. */
          return;
        } else { // or reset to original string
          qs->text.Assign(this->orig_str);
          qs->text.MovePos(WKC_END);
          this->OnEditboxChanged(WID_OSK_TEXT);
          this->Close();
        }
        break;
    }
  }
 
  void OnEditboxChanged(WidgetID widget) override
  {
    if (widget == WID_OSK_TEXT) {
      this->SetWidgetDirty(WID_OSK_TEXT);
      this->parent->OnEditboxChanged(this->text_btn);
      this->parent->SetWidgetDirty(this->text_btn);
    }
  }
 
  void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
  {
    if (!gui_scope) return;
    this->SetWidgetDirty(WID_OSK_TEXT);
    this->parent->SetWidgetDirty(this->text_btn);
  }
 
  void OnFocusLost(bool closing) override
  {
    VideoDriver::GetInstance()->EditBoxLostFocus();
    if (!closing) this->Close();
  }
};
 
static const int HALF_KEY_WIDTH = 7; 
static const int INTER_KEY_SPACE = 2; 
 
static const int TOP_KEY_PADDING = 2; 
static const int KEY_PADDING = 6; 

static void AddKey(std::unique_ptr<NWidgetHorizontal> &hor, int pad_y, int num_half, WidgetType widtype, WidgetID widnum, const WidgetData &widdata)
{
  int key_width = HALF_KEY_WIDTH + (INTER_KEY_SPACE + HALF_KEY_WIDTH) * (num_half - 1);
 
  if (widtype == NWID_SPACER) {
    auto spc = std::make_unique<NWidgetSpacer>(key_width, 0);
    spc->SetMinimalTextLines(1, pad_y, FontSize::Normal);
    hor->Add(std::move(spc));
  } else {
    auto leaf = std::make_unique<NWidgetLeaf>(widtype, Colours::Grey, widnum, widdata, STR_NULL);
    leaf->SetMinimalSize(key_width, 0);
    leaf->SetMinimalTextLines(1, pad_y, FontSize::Normal);
    hor->Add(std::move(leaf));
  }
}

static std::unique_ptr<NWidgetBase> MakeTopKeys()
{
  auto hor = std::make_unique<NWidgetHorizontal>();
  hor->SetPIP(0, INTER_KEY_SPACE, 0);
 
  AddKey(hor, TOP_KEY_PADDING, 6 * 2, WWT_TEXTBTN,    WID_OSK_CANCEL,    WidgetData{.string = STR_BUTTON_CANCEL});
  AddKey(hor, TOP_KEY_PADDING, 6 * 2, WWT_TEXTBTN,    WID_OSK_OK,        WidgetData{.string = STR_BUTTON_OK});
  AddKey(hor, TOP_KEY_PADDING, 2 * 2, WWT_PUSHIMGBTN, WID_OSK_BACKSPACE, WidgetData{.sprite = SPR_OSK_BACKSPACE});
  return hor;
}

static std::unique_ptr<NWidgetBase> MakeNumberKeys()
{
  std::unique_ptr<NWidgetHorizontal> hor = std::make_unique<NWidgetHorizontalLTR>();
  hor->SetPIP(0, INTER_KEY_SPACE, 0);
 
  for (WidgetID widnum = WID_OSK_NUMBERS_FIRST; widnum <= WID_OSK_NUMBERS_LAST; widnum++) {
    AddKey(hor, KEY_PADDING, 2, WWT_PUSHBTN, widnum, {});
  }
  return hor;
}

static std::unique_ptr<NWidgetBase> MakeQwertyKeys()
{
  std::unique_ptr<NWidgetHorizontal> hor = std::make_unique<NWidgetHorizontalLTR>();
  hor->SetPIP(0, INTER_KEY_SPACE, 0);
 
  AddKey(hor, KEY_PADDING, 3, WWT_PUSHIMGBTN, WID_OSK_SPECIAL, WidgetData{.sprite = SPR_OSK_SPECIAL});
  for (WidgetID widnum = WID_OSK_QWERTY_FIRST; widnum <= WID_OSK_QWERTY_LAST; widnum++) {
    AddKey(hor, KEY_PADDING, 2, WWT_PUSHBTN, widnum, {});
  }
  AddKey(hor, KEY_PADDING, 1, NWID_SPACER, 0, {});
  return hor;
}

static std::unique_ptr<NWidgetBase> MakeAsdfgKeys()
{
  std::unique_ptr<NWidgetHorizontal> hor = std::make_unique<NWidgetHorizontalLTR>();
  hor->SetPIP(0, INTER_KEY_SPACE, 0);
 
  AddKey(hor, KEY_PADDING, 4, WWT_IMGBTN, WID_OSK_CAPS, WidgetData{.sprite = SPR_OSK_CAPS});
  for (WidgetID widnum = WID_OSK_ASDFG_FIRST; widnum <= WID_OSK_ASDFG_LAST; widnum++) {
    AddKey(hor, KEY_PADDING, 2, WWT_PUSHBTN, widnum, {});
  }
  return hor;
}

static std::unique_ptr<NWidgetBase> MakeZxcvbKeys()
{
  std::unique_ptr<NWidgetHorizontal> hor = std::make_unique<NWidgetHorizontalLTR>();
  hor->SetPIP(0, INTER_KEY_SPACE, 0);
 
  AddKey(hor, KEY_PADDING, 3, WWT_IMGBTN, WID_OSK_SHIFT, WidgetData{.sprite = SPR_OSK_SHIFT});
  for (WidgetID widnum = WID_OSK_ZXCVB_FIRST; widnum <= WID_OSK_ZXCVB_LAST; widnum++) {
    AddKey(hor, KEY_PADDING, 2, WWT_PUSHBTN, widnum, {});
  }
  AddKey(hor, KEY_PADDING, 1, NWID_SPACER, 0, {});
  return hor;
}

static std::unique_ptr<NWidgetBase> MakeSpacebarKeys()
{
  auto hor = std::make_unique<NWidgetHorizontal>();
  hor->SetPIP(0, INTER_KEY_SPACE, 0);
 
  AddKey(hor, KEY_PADDING,  8, NWID_SPACER, 0, {});
  AddKey(hor, KEY_PADDING, 13, WWT_PUSHTXTBTN, WID_OSK_SPACE, WidgetData{.string = STR_EMPTY});
  AddKey(hor, KEY_PADDING,  3, NWID_SPACER, 0, {});
  AddKey(hor, KEY_PADDING,  2, WWT_PUSHIMGBTN, WID_OSK_LEFT,  WidgetData{.sprite = SPR_OSK_LEFT});
  AddKey(hor, KEY_PADDING,  2, WWT_PUSHIMGBTN, WID_OSK_RIGHT, WidgetData{.sprite = SPR_OSK_RIGHT});
  return hor;
}
 
 
static constexpr std::initializer_list<NWidgetPart> _nested_osk_widgets = {
  NWidget(WWT_CAPTION, Colours::Grey, WID_OSK_CAPTION), SetTextStyle(TextColour::White),
  NWidget(WWT_PANEL, Colours::Grey),
    NWidget(WWT_EDITBOX, Colours::Grey, WID_OSK_TEXT), SetMinimalSize(252, 0), SetPadding(2, 2, 2, 2),
  EndContainer(),
  NWidget(WWT_PANEL, Colours::Grey),
    NWidget(NWID_VERTICAL), SetPadding(3), SetPIP(0, INTER_KEY_SPACE, 0),
      NWidgetFunction(MakeTopKeys),
      NWidgetFunction(MakeNumberKeys),
      NWidgetFunction(MakeQwertyKeys),
      NWidgetFunction(MakeAsdfgKeys),
      NWidgetFunction(MakeZxcvbKeys),
      NWidgetFunction(MakeSpacebarKeys),
    EndContainer(),
  EndContainer(),
};

static WindowDesc _osk_desc(
  WindowPosition::Center, {}, 0, 0,
  WindowClass::OnScreenKeyboard, WindowClass::None,
  {},
  _nested_osk_widgets
);

void GetKeyboardLayout()
{
  std::string keyboard[2];
  std::string errormark[2]; // used for marking invalid chars
  bool has_error = false; // true when an invalid char is detected
 
  keyboard[0] = _keyboard_opt[0].empty() ? GetString(STR_OSK_KEYBOARD_LAYOUT) : _keyboard_opt[0];
  keyboard[1] = _keyboard_opt[1].empty() ? GetString(STR_OSK_KEYBOARD_LAYOUT_CAPS) : _keyboard_opt[1];
 
  for (uint j = 0; j < 2; j++) {
    StringConsumer consumer(keyboard[j]);
    for (uint i = 0; i < OSK_KEYBOARD_ENTRIES; i++) {
      /* Be lenient when the last characters are missing (is quite normal) */
      _keyboard[j][i] = consumer.AnyBytesLeft() ? consumer.ReadUtf8() : ' ';
 
      if (IsPrintable(_keyboard[j][i])) {
        errormark[j] += ' ';
      } else {
        has_error = true;
        errormark[j] += '^';
        _keyboard[j][i] = ' ';
      }
    }
  }
 
  if (has_error) {
    ShowInfo("The keyboard layout you selected contains invalid chars. Please check those chars marked with ^.");
    ShowInfo("Normal keyboard:  {}", keyboard[0]);
    ShowInfo("                  {}", errormark[0]);
    ShowInfo("Caps Lock:        {}", keyboard[1]);
    ShowInfo("                  {}", errormark[1]);
  }
}

void ShowOnScreenKeyboard(Window *parent, WidgetID button)
{
  CloseWindowById(WindowClass::OnScreenKeyboard, 0);
 
  GetKeyboardLayout();
  new OskWindow(_osk_desc, parent, button);
}

void UpdateOSKOriginalText(const Window *parent, WidgetID button)
{
  OskWindow *osk = dynamic_cast<OskWindow *>(FindWindowById(WindowClass::OnScreenKeyboard, 0));
  if (osk == nullptr || osk->parent != parent || osk->text_btn != button) return;
 
  osk->orig_str = osk->qs->text.GetText();
 
  osk->SetDirty();
}

bool IsOSKOpenedFor(const Window *w, WidgetID button)
{
  OskWindow *osk = dynamic_cast<OskWindow *>(FindWindowById(WindowClass::OnScreenKeyboard, 0));
  return osk != nullptr && osk->parent == w && osk->text_btn == button;
}