textbuf.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 <http://www.gnu.org/licenses/>.
 */
 
#include "stdafx.h"
 
#include "textbuf_type.h"
#include "string_func.h"
#include "strings_func.h"
#include "gfx_type.h"
#include "gfx_func.h"
#include "gfx_layout.h"
#include "window_func.h"
 
#include "safeguards.h"
 
std::optional<std::string> GetClipboardContents();
 
int _caret_timer;
 
 
bool Textbuf::CanDelChar(bool backspace)
{
  return backspace ? this->caretpos != 0 : this->caretpos < this->buf.size();
}
 
bool Textbuf::DeleteChar(uint16_t keycode)
{
  bool word = (keycode & WKC_CTRL) != 0;
 
  keycode &= ~WKC_SPECIAL_KEYS;
  if (keycode != WKC_BACKSPACE && keycode != WKC_DELETE) return false;
 
  bool backspace = keycode == WKC_BACKSPACE;
 
  if (!CanDelChar(backspace)) return false;
 
  auto s = this->buf.begin() + this->caretpos;
  uint16_t len = 0;
 
  if (word) {
    /* Delete a complete word. */
    if (backspace) {
      /* Delete whitespace and word in front of the caret. */
      len = this->caretpos - (uint16_t)this->char_iter->Prev(StringIterator::ITER_WORD);
      s -= len;
    } else {
      /* Delete word and following whitespace following the caret. */
      len = (uint16_t)this->char_iter->Next(StringIterator::ITER_WORD) - this->caretpos;
    }
    /* Update character count. */
    for (auto ss = s; ss < s + len; Utf8Consume(ss)) {
      this->chars--;
    }
  } else {
    /* Delete a single character. */
    if (backspace) {
      /* Delete the last code point in front of the caret. */
      s = Utf8PrevChar(s);
      char32_t c;
      len = (uint16_t)Utf8Decode(&c, s);
      this->chars--;
    } else {
      /* Delete the complete character following the caret. */
      len = (uint16_t)this->char_iter->Next(StringIterator::ITER_CHARACTER) - this->caretpos;
      /* Update character count. */
      for (auto ss = s; ss < s + len; Utf8Consume(ss)) {
        this->chars--;
      }
    }
  }
 
  /* Move the remaining characters over the marker */
  this->buf.erase(s - this->buf.begin(), len);
 
  if (backspace) this->caretpos -= len;
 
  this->UpdateStringIter();
  this->UpdateWidth();
  this->UpdateCaretPosition();
  this->UpdateMarkedText();
 
  return true;
}
 
void Textbuf::DeleteAll()
{
  this->buf.clear();
  this->chars = 1;
  this->pixels = this->caretpos = this->caretxoffs = 0;
  this->markpos = this->markend = this->markxoffs = this->marklength = 0;
  this->UpdateStringIter();
}
 
bool Textbuf::InsertChar(char32_t key)
{
  uint16_t len = (uint16_t)Utf8CharLen(key);
  if (this->buf.size() + len < this->max_bytes && this->chars + 1 <= this->max_chars) {
    /* Make space in the string, then overwrite it with the Utf8 encoded character. */
    auto pos = this->buf.begin() + this->caretpos;
    pos = this->buf.insert(pos, len, '\0');
    Utf8Encode(pos, key);
    this->chars++;
    this->caretpos += len;
 
    this->UpdateStringIter();
    this->UpdateWidth();
    this->UpdateCaretPosition();
    this->UpdateMarkedText();
    return true;
  }
  return false;
}
 
bool Textbuf::InsertString(const char *str, bool marked, const char *caret, const char *insert_location, const char *replacement_end)
{
  uint16_t insertpos = (marked && this->marklength != 0) ? this->markpos : this->caretpos;
  if (insert_location != nullptr) {
    insertpos = insert_location - this->buf.data();
    if (insertpos >= this->buf.size()) return false;
 
    if (replacement_end != nullptr) {
      this->DeleteText(insertpos, replacement_end - this->buf.data(), str == nullptr);
    }
  } else {
    if (marked) this->DiscardMarkedText(str == nullptr);
  }
 
  if (str == nullptr) return false;
 
  uint16_t bytes = 0, chars = 0;
  char32_t c;
  for (const char *ptr = str; (c = Utf8Consume(&ptr)) != '\0';) {
    if (!IsValidChar(c, this->afilter)) break;
 
    uint8_t len = Utf8CharLen(c);
    if (this->buf.size() + bytes + len >= this->max_bytes) break;
    if (this->chars + chars + 1   > this->max_chars) break;
 
    bytes += len;
    chars++;
 
    /* Move caret if needed. */
    if (ptr == caret) this->caretpos = insertpos + bytes;
  }
 
  if (bytes == 0) return false;
 
  if (marked) {
    this->markpos = insertpos;
    this->markend = insertpos + bytes;
  }
 
  this->buf.insert(insertpos, str, bytes);
 
  this->chars += chars;
  if (!marked && caret == nullptr) this->caretpos += bytes;
  assert(this->buf.size() < this->max_bytes);
  assert(this->chars <= this->max_chars);
 
  this->UpdateStringIter();
  this->UpdateWidth();
  this->UpdateCaretPosition();
  this->UpdateMarkedText();
 
  return true;
}
 
bool Textbuf::InsertClipboard()
{
  auto contents = GetClipboardContents();
  if (!contents.has_value()) return false;
 
  return this->InsertString(contents.value().c_str(), false);
}
 
void Textbuf::DeleteText(uint16_t from, uint16_t to, bool update)
{
  uint c = 0;
  auto s = this->buf.begin() + from;
  auto end = this->buf.begin() + to;
  while (s < end) {
    Utf8Consume(s);
    c++;
  }
 
  /* Strip marked characters from buffer. */
  this->buf.erase(from, to - from);
  this->chars -= c;
 
  auto fixup = [&](uint16_t &pos) {
    if (pos <= from) return;
    if (pos <= to) {
      pos = from;
    } else {
      pos -= to - from;
    }
  };
 
  /* Fixup caret if needed. */
  fixup(this->caretpos);
 
  /* Fixup marked text if needed. */
  fixup(this->markpos);
  fixup(this->markend);
 
  if (update) {
    this->UpdateStringIter();
    this->UpdateCaretPosition();
    this->UpdateMarkedText();
  }
}
 
void Textbuf::DiscardMarkedText(bool update)
{
  if (this->markend == 0) return;
 
  this->DeleteText(this->markpos, this->markend, update);
  this->markpos = this->markend = this->markxoffs = this->marklength = 0;
}
 
const char *Textbuf::GetText() const
{
  return this->buf.c_str();
}
 
void Textbuf::UpdateStringIter()
{
  this->char_iter->SetString(this->buf.c_str());
  size_t pos = this->char_iter->SetCurPosition(this->caretpos);
  this->caretpos = pos == StringIterator::END ? 0 : (uint16_t)pos;
}
 
void Textbuf::UpdateWidth()
{
  this->pixels = GetStringBoundingBox(this->buf, FS_NORMAL).width;
}
 
void Textbuf::UpdateCaretPosition()
{
  const auto pos = GetCharPosInString(this->buf, &this->buf[this->caretpos], FS_NORMAL);
  this->caretxoffs = _current_text_dir == TD_LTR ? pos.left : pos.right;
}
 
void Textbuf::UpdateMarkedText()
{
  if (this->markend != 0) {
    const auto pos = GetCharPosInString(this->buf, &this->buf[this->markpos], FS_NORMAL);
    const auto end = GetCharPosInString(this->buf, &this->buf[this->markend], FS_NORMAL);
    this->markxoffs = std::min(pos.left, end.left);
    this->marklength = std::max(pos.right, end.right) - this->markxoffs;
  } else {
    this->markxoffs = this->marklength = 0;
  }
}
 
bool Textbuf::MovePrev(StringIterator::IterType what)
{
  if (this->caretpos == 0) return false;
 
  size_t pos = this->char_iter->Prev(what);
  if (pos == StringIterator::END) return true;
 
  this->caretpos = static_cast<uint16_t>(pos);
  this->UpdateCaretPosition();
  return true;
}
 
bool Textbuf::MoveNext(StringIterator::IterType what)
{
  if (this->caretpos >= this->buf.size()) return false;
 
  size_t pos = this->char_iter->Next(what);
  if (pos == StringIterator::END) return true;
 
  this->caretpos = static_cast<uint16_t>(pos);
  this->UpdateCaretPosition();
  return true;
}
 
bool Textbuf::MovePos(uint16_t keycode)
{
  switch (keycode) {
    case WKC_LEFT:
    case WKC_CTRL | WKC_LEFT: {
      auto move_type = (keycode & WKC_CTRL) != 0 ? StringIterator::ITER_WORD : StringIterator::ITER_CHARACTER;
      return (_current_text_dir == TD_LTR) ? this->MovePrev(move_type) : this->MoveNext(move_type);
    }
 
    case WKC_RIGHT:
    case WKC_CTRL | WKC_RIGHT: {
      auto move_type = (keycode & WKC_CTRL) != 0 ? StringIterator::ITER_WORD : StringIterator::ITER_CHARACTER;
      return (_current_text_dir == TD_LTR) ? this->MoveNext(move_type) : this->MovePrev(move_type);
    }
 
    case WKC_HOME:
      this->caretpos = 0;
      this->char_iter->SetCurPosition(this->caretpos);
      this->UpdateCaretPosition();
      return true;
 
    case WKC_END:
      this->caretpos = static_cast<uint16_t>(this->buf.size());
      this->char_iter->SetCurPosition(this->caretpos);
      this->UpdateCaretPosition();
      return true;
 
    default:
      break;
  }
 
  return false;
}
 
Textbuf::Textbuf(uint16_t max_bytes, uint16_t max_chars)
  : char_iter(StringIterator::Create())
{
  assert(max_bytes != 0);
  assert(max_chars != 0);
 
  this->afilter    = CS_ALPHANUMERAL;
  this->max_bytes  = max_bytes;
  this->max_chars  = max_chars == UINT16_MAX ? max_bytes : max_chars;
  this->caret      = true;
  this->DeleteAll();
}
 
void Textbuf::Assign(const std::string_view text)
{
  size_t bytes = std::min<size_t>(this->max_bytes - 1, text.size());
  this->buf = StrMakeValid(text.substr(0, bytes));
 
  /* Make sure the name isn't too long for the text buffer in the number of
   * characters (not bytes). max_chars also counts the '\0' characters. */
  auto iter = this->buf.begin();
  for (size_t len = 1; len < this->max_chars && iter != this->buf.end(); ++len) Utf8Consume(iter);
 
  if (iter != this->buf.end()) {
    this->buf.erase(iter, this->buf.end());
  }
 
  this->UpdateSize();
}
 
 
void Textbuf::UpdateSize()
{
  this->chars = static_cast<uint16_t>(Utf8StringLength(this->buf.data()) + 1); // terminating zero
  assert(this->buf.size() < this->max_bytes);
  assert(this->chars <= this->max_chars);
 
  this->caretpos = static_cast<uint16_t>(this->buf.size());
  this->UpdateStringIter();
  this->UpdateWidth();
  this->UpdateMarkedText();
 
  this->UpdateCaretPosition();
}
 
bool Textbuf::HandleCaret()
{
  /* caret changed? */
  bool b = !!(_caret_timer & 0x20);
 
  if (b != this->caret) {
    this->caret = b;
    return true;
  }
  return false;
}
 
HandleKeyPressResult Textbuf::HandleKeyPress(char32_t key, uint16_t keycode)
{
  bool edited = false;
 
  switch (keycode) {
    case WKC_ESC: return HKPR_CANCEL;
 
    case WKC_RETURN: case WKC_NUM_ENTER: return HKPR_CONFIRM;
 
    case (WKC_CTRL | 'V'):
    case (WKC_SHIFT | WKC_INSERT):
      edited = this->InsertClipboard();
      break;
 
    case (WKC_CTRL | 'U'):
      this->DeleteAll();
      edited = true;
      break;
 
    case WKC_BACKSPACE: case WKC_DELETE:
    case WKC_CTRL | WKC_BACKSPACE: case WKC_CTRL | WKC_DELETE:
      edited = this->DeleteChar(keycode);
      break;
 
    case WKC_LEFT: case WKC_RIGHT: case WKC_END: case WKC_HOME:
    case WKC_CTRL | WKC_LEFT: case WKC_CTRL | WKC_RIGHT:
      this->MovePos(keycode);
      break;
 
    default:
      if (IsValidChar(key, this->afilter)) {
        edited = this->InsertChar(key);
      } else {
        return HKPR_NOT_HANDLED;
      }
      break;
  }
 
  return edited ? HKPR_EDITING : HKPR_CURSOR;
}