network_chat_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 <http://www.gnu.org/licenses/>.
 */
 
#include "../stdafx.h"
#include "../strings_func.h"
#include "../blitter/factory.hpp"
#include "../console_func.h"
#include "../video/video_driver.hpp"
#include "../querystring_gui.h"
#include "../town.h"
#include "../window_func.h"
#include "../toolbar_gui.h"
#include "../core/geometry_func.hpp"
#include "../zoom_func.h"
#include "../timer/timer.h"
#include "../timer/timer_window.h"
#include "network.h"
#include "network_client.h"
#include "network_base.h"
 
#include "../widgets/network_chat_widget.h"
 
#include "table/strings.h"
 
#include "../safeguards.h"
 
static const uint NETWORK_CHAT_LINE_SPACING = 3;
 
struct ChatMessage {
  std::string message; 
  TextColour colour;  
  std::chrono::steady_clock::time_point remove_time; 
};
 
/* used for chat window */
static std::deque<ChatMessage> _chatmsg_list; 
static bool _chatmessage_dirty = false;   
static bool _chatmessage_visible = false; 
static bool _chat_tab_completion_active;  
static uint MAX_CHAT_MESSAGES = 0;        
 
static std::chrono::steady_clock::time_point _chatmessage_dirty_time;
 
static PointDimension _chatmsg_box;
static ReusableBuffer<uint8_t> _chatmessage_backup; 
 
static inline bool HaveChatMessages(bool show_all)
{
  if (show_all) return !_chatmsg_list.empty();
 
  auto now = std::chrono::steady_clock::now();
  for (auto &cmsg : _chatmsg_list) {
    if (cmsg.remove_time >= now) return true;
  }
 
  return false;
}
 
void CDECL NetworkAddChatMessage(TextColour colour, uint duration, const std::string &message)
{
  if (_chatmsg_list.size() == MAX_CHAT_MESSAGES) {
    _chatmsg_list.pop_back();
  }
 
  ChatMessage *cmsg = &_chatmsg_list.emplace_front();
  cmsg->message = message;
  cmsg->colour = colour;
  cmsg->remove_time = std::chrono::steady_clock::now() + std::chrono::seconds(duration);
 
  _chatmessage_dirty_time = std::chrono::steady_clock::now();
  _chatmessage_dirty = true;
}
 
void NetworkReInitChatBoxSize()
{
  _chatmsg_box.y       = 3 * GetCharacterHeight(FS_NORMAL);
  _chatmsg_box.height  = MAX_CHAT_MESSAGES * (GetCharacterHeight(FS_NORMAL) + ScaleGUITrad(NETWORK_CHAT_LINE_SPACING)) + ScaleGUITrad(4);
}
 
void NetworkInitChatMessage()
{
  MAX_CHAT_MESSAGES    = _settings_client.gui.network_chat_box_height;
 
  _chatmsg_list.clear();
  _chatmsg_box.x       = ScaleGUITrad(10);
  _chatmsg_box.width   = _settings_client.gui.network_chat_box_width_pct * _screen.width / 100;
  NetworkReInitChatBoxSize();
  _chatmessage_visible = false;
}
 
void NetworkUndrawChatMessage()
{
  /* Sometimes we also need to hide the cursor
   *   This is because both textmessage and the cursor take a shot of the
   *   screen before drawing.
   *   Now the textmessage takes its shot and paints its data before the cursor
   *   does, so in the shot of the cursor is the screen-data of the textmessage
   *   included when the cursor hangs somewhere over the textmessage. To
   *   avoid wrong repaints, we undraw the cursor in that case, and everything
   *   looks nicely ;)
   * (and now hope this story above makes sense to you ;))
   */
  if (_cursor.visible &&
      _cursor.draw_pos.x + _cursor.draw_size.x >= _chatmsg_box.x &&
      _cursor.draw_pos.x <= _chatmsg_box.x + _chatmsg_box.width &&
      _cursor.draw_pos.y + _cursor.draw_size.y >= _screen.height - _chatmsg_box.y - _chatmsg_box.height &&
      _cursor.draw_pos.y <= _screen.height - _chatmsg_box.y) {
    UndrawMouseCursor();
  }
 
  if (_chatmessage_visible) {
    Blitter *blitter = BlitterFactory::GetCurrentBlitter();
    int x      = _chatmsg_box.x;
    int y      = _screen.height - _chatmsg_box.y - _chatmsg_box.height;
    int width  = _chatmsg_box.width;
    int height = _chatmsg_box.height;
    if (y < 0) {
      height = std::max(height + y, std::min(_chatmsg_box.height, _screen.height));
      y = 0;
    }
    if (x + width >= _screen.width) {
      width = _screen.width - x;
    }
    if (width <= 0 || height <= 0) return;
 
    _chatmessage_visible = false;
    /* Put our 'shot' back to the screen */
    blitter->CopyFromBuffer(blitter->MoveTo(_screen.dst_ptr, x, y), _chatmessage_backup.GetBuffer(), width, height);
    /* And make sure it is updated next time */
    VideoDriver::GetInstance()->MakeDirty(x, y, width, height);
 
    _chatmessage_dirty_time = std::chrono::steady_clock::now();
    _chatmessage_dirty = true;
  }
}
 
static IntervalTimer<TimerWindow> network_message_expired_interval(std::chrono::seconds(1), [](auto) {
  auto now = std::chrono::steady_clock::now();
  for (auto &cmsg : _chatmsg_list) {
    /* Message has expired, remove from the list */
    if (now > cmsg.remove_time && _chatmessage_dirty_time < cmsg.remove_time) {
      _chatmessage_dirty_time = now;
      _chatmessage_dirty = true;
      break;
    }
  }
});
 
void NetworkDrawChatMessage()
{
  Blitter *blitter = BlitterFactory::GetCurrentBlitter();
  if (!_chatmessage_dirty) return;
 
  const Window *w = FindWindowByClass(WC_SEND_NETWORK_MSG);
  bool show_all = (w != nullptr);
 
  /* First undraw if needed */
  NetworkUndrawChatMessage();
 
  if (_iconsole_mode == ICONSOLE_FULL) return;
 
  /* Check if we have anything to draw at all */
  if (!HaveChatMessages(show_all)) return;
 
  int x      = _chatmsg_box.x;
  int y      = _screen.height - _chatmsg_box.y - _chatmsg_box.height;
  int width  = _chatmsg_box.width;
  int height = _chatmsg_box.height;
  if (y < 0) {
    height = std::max(height + y, std::min(_chatmsg_box.height, _screen.height));
    y = 0;
  }
  if (x + width >= _screen.width) {
    width = _screen.width - x;
  }
  if (width <= 0 || height <= 0) return;
 
  /* Make a copy of the screen as it is before painting (for undraw) */
  uint8_t *buffer = _chatmessage_backup.Allocate(BlitterFactory::GetCurrentBlitter()->BufferSize(width, height));
  blitter->CopyToBuffer(blitter->MoveTo(_screen.dst_ptr, x, y), buffer, width, height);
 
  _cur_dpi = &_screen; // switch to _screen painting
 
  auto now = std::chrono::steady_clock::now();
  int string_height = 0;
  for (auto &cmsg : _chatmsg_list) {
    if (!show_all && cmsg.remove_time < now) continue;
    SetDParamStr(0, cmsg.message);
    string_height += GetStringLineCount(STR_JUST_RAW_STRING, width - 1) * GetCharacterHeight(FS_NORMAL) + NETWORK_CHAT_LINE_SPACING;
  }
 
  string_height = std::min<uint>(string_height, MAX_CHAT_MESSAGES * (GetCharacterHeight(FS_NORMAL) + NETWORK_CHAT_LINE_SPACING));
 
  int top = _screen.height - _chatmsg_box.y - string_height - 2;
  int bottom = _screen.height - _chatmsg_box.y - 2;
  /* Paint a half-transparent box behind the chat messages */
  GfxFillRect(_chatmsg_box.x, top - 2, _chatmsg_box.x + _chatmsg_box.width - 1, bottom,
      PALETTE_TO_TRANSPARENT, FILLRECT_RECOLOUR // black, but with some alpha for background
    );
 
  /* Paint the chat messages starting with the lowest at the bottom */
  int ypos = bottom - 2;
 
  for (auto &cmsg : _chatmsg_list) {
    if (!show_all && cmsg.remove_time < now) continue;
    ypos = DrawStringMultiLine(_chatmsg_box.x + ScaleGUITrad(3), _chatmsg_box.x + _chatmsg_box.width - 1, top, ypos, cmsg.message, cmsg.colour, SA_LEFT | SA_BOTTOM | SA_FORCE) - NETWORK_CHAT_LINE_SPACING;
    if (ypos < top) break;
  }
 
  /* Make sure the data is updated next flush */
  VideoDriver::GetInstance()->MakeDirty(x, y, width, height);
 
  _chatmessage_visible = true;
  _chatmessage_dirty = false;
}
 
static void SendChat(const std::string &buf, DestType type, int dest)
{
  if (buf.empty()) return;
  if (!_network_server) {
    MyClient::SendChat((NetworkAction)(NETWORK_ACTION_CHAT + type), type, dest, buf, 0);
  } else {
    NetworkServerSendChat((NetworkAction)(NETWORK_ACTION_CHAT + type), type, dest, buf, CLIENT_ID_SERVER);
  }
}
 
struct NetworkChatWindow : public Window {
  DestType dtype;       
  int dest;             
  QueryString message_editbox; 
 
  NetworkChatWindow(WindowDesc *desc, DestType type, int dest) : Window(desc), message_editbox(NETWORK_CHAT_LENGTH)
  {
    this->dtype   = type;
    this->dest    = dest;
    this->querystrings[WID_NC_TEXTBOX] = &this->message_editbox;
    this->message_editbox.cancel_button = WID_NC_CLOSE;
    this->message_editbox.ok_button = WID_NC_SENDBUTTON;
 
    static const StringID chat_captions[] = {
      STR_NETWORK_CHAT_ALL_CAPTION,
      STR_NETWORK_CHAT_COMPANY_CAPTION,
      STR_NETWORK_CHAT_CLIENT_CAPTION
    };
    assert((uint)this->dtype < lengthof(chat_captions));
 
    this->CreateNestedTree();
    this->GetWidget<NWidgetCore>(WID_NC_DESTINATION)->widget_data = chat_captions[this->dtype];
    this->FinishInitNested(type);
 
    this->SetFocusedWidget(WID_NC_TEXTBOX);
    InvalidateWindowData(WC_NEWS_WINDOW, 0, this->height);
    _chat_tab_completion_active = false;
 
    PositionNetworkChatWindow(this);
  }
 
  void Close([[maybe_unused]] int data = 0) override
  {
    InvalidateWindowData(WC_NEWS_WINDOW, 0, 0);
    this->Window::Close();
  }
 
  void FindWindowPlacementAndResize([[maybe_unused]] int def_width, [[maybe_unused]] int def_height) override
  {
    Window::FindWindowPlacementAndResize(_toolbar_width, def_height);
  }
 
  std::optional<std::string> ChatTabCompletionNextItem(uint *item)
  {
    /* First, try clients */
    if (*item < MAX_CLIENT_SLOTS) {
      /* Skip inactive clients */
      for (NetworkClientInfo *ci : NetworkClientInfo::Iterate(*item)) {
        *item = ci->index;
        return ci->client_name;
      }
      *item = MAX_CLIENT_SLOTS;
    }
 
    /* Then, try townnames
     * Not that the following assumes all town indices are adjacent, ie no
     * towns have been deleted. */
    if (*item < (uint)MAX_CLIENT_SLOTS + Town::GetPoolSize()) {
      for (const Town *t : Town::Iterate(*item - MAX_CLIENT_SLOTS)) {
        /* Get the town-name via the string-system */
        SetDParam(0, t->index);
        return GetString(STR_TOWN_NAME);
      }
    }
 
    return std::nullopt;
  }
 
  static std::string_view ChatTabCompletionFindText(std::string_view &buf)
  {
    auto it = buf.find_last_of(' ');
    if (it == std::string_view::npos) return buf;
 
    std::string_view res = buf.substr(it + 1);
    buf.remove_suffix(res.size() + 1);
    return res;
  }
 
  void ChatTabCompletion()
  {
    static std::string _chat_tab_completion_buf;
 
    Textbuf *tb = &this->message_editbox.text;
    uint item = 0;
    bool second_scan = false;
 
    /* Create views, so we do not need to copy the data for now. */
    std::string_view pre_buf = _chat_tab_completion_active ? std::string_view(_chat_tab_completion_buf) : std::string_view(tb->buf);
    std::string_view tb_buf = ChatTabCompletionFindText(pre_buf);
 
    /*
     * Comparing pointers of the data, as both "Hi:<tab>" and "Hi: Hi:<tab>" will result in
     * tb_buf and pre_buf being "Hi:", which would be equal in content but not in context.
     */
    bool begin_of_line = tb_buf.data() == pre_buf.data();
 
    std::optional<std::string> cur_item;
    while ((cur_item = ChatTabCompletionNextItem(&item)).has_value()) {
      std::string_view cur_name = cur_item.value();
      item++;
 
      if (_chat_tab_completion_active) {
        /* We are pressing TAB again on the same name, is there another name
         *  that starts with this? */
        if (!second_scan) {
          std::string_view view;
 
          /* If we are completing at the begin of the line, skip the ': ' we added */
          if (begin_of_line) {
            view = std::string_view(tb->buf, (tb->bytes - 1) - 2);
          } else {
            /* Else, find the place we are completing at */
            size_t offset = pre_buf.size() + 1;
            view = std::string_view(tb->buf + offset, (tb->bytes - 1) - offset);
          }
 
          /* Compare if we have a match */
          if (cur_name == view) second_scan = true;
 
          continue;
        }
 
        /* Now any match we make on _chat_tab_completion_buf after this, is perfect */
      }
 
      if (tb_buf.size() < cur_name.size() && cur_name.starts_with(tb_buf)) {
        /* Save the data it was before completion */
        if (!second_scan) _chat_tab_completion_buf = tb->buf;
        _chat_tab_completion_active = true;
 
        /* Change to the found name. Add ': ' if we are at the start of the line (pretty) */
        if (begin_of_line) {
          this->message_editbox.text.Assign(fmt::format("{}: ", cur_name));
        } else {
          this->message_editbox.text.Assign(fmt::format("{} {}", pre_buf, cur_name));
        }
 
        this->SetDirty();
        return;
      }
    }
 
    if (second_scan) {
      /* We walked all possibilities, and the user presses tab again.. revert to original text */
      this->message_editbox.text.Assign(_chat_tab_completion_buf);
      _chat_tab_completion_active = false;
 
      this->SetDirty();
    }
  }
 
  Point OnInitialPosition([[maybe_unused]] int16_t sm_width, [[maybe_unused]] int16_t sm_height, [[maybe_unused]] int window_number) override
  {
    Point pt = { 0, _screen.height - sm_height - FindWindowById(WC_STATUS_BAR, 0)->height };
    return pt;
  }
 
  void SetStringParameters(WidgetID widget) const override
  {
    if (widget != WID_NC_DESTINATION) return;
 
    if (this->dtype == DESTTYPE_CLIENT) {
      SetDParamStr(0, NetworkClientInfo::GetByClientID((ClientID)this->dest)->client_name);
    }
  }
 
  void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
  {
    switch (widget) {
      case WID_NC_SENDBUTTON: /* Send */
        SendChat(this->message_editbox.text.buf, this->dtype, this->dest);
        [[fallthrough]];
 
      case WID_NC_CLOSE: /* Cancel */
        this->Close();
        break;
    }
  }
 
  EventState OnKeyPress([[maybe_unused]] char32_t key, uint16_t keycode) override
  {
    EventState state = ES_NOT_HANDLED;
    if (keycode == WKC_TAB) {
      ChatTabCompletion();
      state = ES_HANDLED;
    }
    return state;
  }
 
  void OnEditboxChanged(WidgetID widget) override
  {
    if (widget == WID_NC_TEXTBOX) {
      _chat_tab_completion_active = false;
    }
  }
 
  void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
  {
    if (data == this->dest) this->Close();
  }
};
 
static constexpr NWidgetPart _nested_chat_window_widgets[] = {
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_CLOSEBOX, COLOUR_GREY, WID_NC_CLOSE),
    NWidget(WWT_PANEL, COLOUR_GREY, WID_NC_BACKGROUND),
      NWidget(NWID_HORIZONTAL),
        NWidget(WWT_TEXT, COLOUR_GREY, WID_NC_DESTINATION), SetMinimalSize(62, 12), SetPadding(1, 0, 1, 0), SetAlignment(SA_VERT_CENTER | SA_RIGHT), SetDataTip(STR_NULL, STR_NULL),
        NWidget(WWT_EDITBOX, COLOUR_GREY, WID_NC_TEXTBOX), SetMinimalSize(100, 12), SetPadding(1, 0, 1, 0), SetResize(1, 0),
                                  SetDataTip(STR_NETWORK_CHAT_OSKTITLE, STR_NULL),
        NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_NC_SENDBUTTON), SetMinimalSize(62, 12), SetPadding(1, 0, 1, 0), SetDataTip(STR_NETWORK_CHAT_SEND, STR_NULL),
      EndContainer(),
    EndContainer(),
  EndContainer(),
};
 
static WindowDesc _chat_window_desc(__FILE__, __LINE__,
  WDP_MANUAL, nullptr, 0, 0,
  WC_SEND_NETWORK_MSG, WC_NONE,
  0,
  std::begin(_nested_chat_window_widgets), std::end(_nested_chat_window_widgets)
);
 
 
void ShowNetworkChatQueryWindow(DestType type, int dest)
{
  CloseWindowByClass(WC_SEND_NETWORK_MSG);
  new NetworkChatWindow(&_chat_window_desc, type, dest);
}