error_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 "core/geometry_func.hpp"
#include "core/mem_func.hpp"
#include "landscape.h"
#include "newgrf_text.h"
#include "error.h"
#include "viewport_func.h"
#include "gfx_func.h"
#include "string_func.h"
#include "company_base.h"
#include "company_func.h"
#include "company_manager_face.h"
#include "strings_func.h"
#include "zoom_func.h"
#include "window_func.h"
#include "console_func.h"
#include "window_gui.h"
#include "timer/timer.h"
#include "timer/timer_window.h"
 
#include "widgets/error_widget.h"
 
#include "table/strings.h"
 
#include "safeguards.h"
 
static constexpr NWidgetPart _nested_errmsg_widgets[] = {
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_CLOSEBOX, COLOUR_RED),
    NWidget(WWT_CAPTION, COLOUR_RED, WID_EM_CAPTION), SetDataTip(STR_ERROR_MESSAGE_CAPTION, STR_NULL),
  EndContainer(),
  NWidget(WWT_PANEL, COLOUR_RED),
    NWidget(WWT_EMPTY, COLOUR_RED, WID_EM_MESSAGE), SetPadding(WidgetDimensions::unscaled.modalpopup), SetFill(1, 0), SetMinimalSize(236, 0),
  EndContainer(),
};
 
static WindowDesc _errmsg_desc(
  WDP_MANUAL, nullptr, 0, 0,
  WC_ERRMSG, WC_NONE,
  0,
  _nested_errmsg_widgets
);
 
static constexpr NWidgetPart _nested_errmsg_face_widgets[] = {
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_CLOSEBOX, COLOUR_RED),
    NWidget(WWT_CAPTION, COLOUR_RED, WID_EM_CAPTION), SetDataTip(STR_ERROR_MESSAGE_CAPTION_OTHER_COMPANY, STR_NULL),
  EndContainer(),
  NWidget(WWT_PANEL, COLOUR_RED),
    NWidget(NWID_HORIZONTAL),
      NWidget(WWT_EMPTY, COLOUR_RED, WID_EM_FACE), SetPadding(2, 0, 2, 2), SetFill(0, 1), SetMinimalSize(92, 119),
      NWidget(WWT_EMPTY, COLOUR_RED, WID_EM_MESSAGE), SetPadding(WidgetDimensions::unscaled.modalpopup), SetFill(1, 1), SetMinimalSize(236, 0),
    EndContainer(),
  EndContainer(),
};
 
static WindowDesc _errmsg_face_desc(
  WDP_MANUAL, nullptr, 0, 0,
  WC_ERRMSG, WC_NONE,
  0,
  _nested_errmsg_face_widgets
);
 
ErrorMessageData::ErrorMessageData(const ErrorMessageData &data) :
  is_critical(data.is_critical), params(data.params), textref_stack_grffile(data.textref_stack_grffile), textref_stack_size(data.textref_stack_size),
  summary_msg(data.summary_msg), detailed_msg(data.detailed_msg), extra_msg(data.extra_msg), position(data.position), face(data.face)
{
  memcpy(this->textref_stack, data.textref_stack, sizeof(this->textref_stack));
}
 
ErrorMessageData::ErrorMessageData(StringID summary_msg, StringID detailed_msg, bool is_critical, int x, int y, const GRFFile *textref_stack_grffile, uint textref_stack_size, const uint32_t *textref_stack, StringID extra_msg) :
  is_critical(is_critical),
  textref_stack_grffile(textref_stack_grffile),
  textref_stack_size(textref_stack_size),
  summary_msg(summary_msg),
  detailed_msg(detailed_msg),
  extra_msg(extra_msg),
  face(INVALID_COMPANY)
{
  this->position.x = x;
  this->position.y = y;
 
  if (textref_stack_size > 0) MemCpyT(this->textref_stack, textref_stack, textref_stack_size);
 
  assert(summary_msg != INVALID_STRING_ID);
}
 
void ErrorMessageData::CopyOutDParams()
{
  if (this->detailed_msg == STR_ERROR_OWNED_BY) {
    /* The parameters are set by SetDParamsForOwnedBy. */
    CompanyID company = (CompanyID)GetDParam(OWNED_BY_OWNER_IN_PARAMETERS_OFFSET);
    if (company < MAX_COMPANIES) face = company;
  }
 
  /* Get parameters using type information */
  if (this->textref_stack_size > 0) StartTextRefStackUsage(this->textref_stack_grffile, this->textref_stack_size, this->textref_stack);
  CopyOutDParam(this->params, 20);
  if (this->textref_stack_size > 0) StopTextRefStackUsage();
}
 
void ErrorMessageData::SetDParam(uint n, uint64_t v)
{
  if (n >= this->params.size()) this->params.resize(n + 1);
  this->params[n] = v;
}
 
void ErrorMessageData::SetDParamStr(uint n, const char *str)
{
  if (n >= this->params.size()) this->params.resize(n + 1);
  this->params[n] = str;
}
 
void ErrorMessageData::SetDParamStr(uint n, const std::string &str)
{
  if (n >= this->params.size()) this->params.resize(n + 1);
  this->params[n] = str;
}
 
static ErrorList _error_list;
bool _window_system_initialized = false;
 
struct ErrmsgWindow : public Window, ErrorMessageData {
private:
  uint height_summary;            
  uint height_detailed;           
  uint height_extra;              
  TimeoutTimer<TimerWindow> display_timeout;
 
public:
  ErrmsgWindow(const ErrorMessageData &data) :
    Window(data.HasFace() ? _errmsg_face_desc : _errmsg_desc),
    ErrorMessageData(data),
    display_timeout(std::chrono::seconds(3 * _settings_client.gui.errmsg_duration), [this]() {
      this->Close();
    })
  {
    this->InitNested();
 
    /* Only start the timeout if the message is not critical. */
    if (!this->is_critical) {
      this->display_timeout.Reset();
    }
  }
 
  void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
  {
    switch (widget) {
      case WID_EM_MESSAGE: {
        CopyInDParam(this->params);
        if (this->textref_stack_size > 0) StartTextRefStackUsage(this->textref_stack_grffile, this->textref_stack_size, this->textref_stack);
 
        this->height_summary = GetStringHeight(this->summary_msg, size.width);
        this->height_detailed = (this->detailed_msg == INVALID_STRING_ID) ? 0 : GetStringHeight(this->detailed_msg, size.width);
        this->height_extra = (this->extra_msg == INVALID_STRING_ID) ? 0 : GetStringHeight(this->extra_msg, size.width);
 
        if (this->textref_stack_size > 0) StopTextRefStackUsage();
 
        uint panel_height = this->height_summary;
        if (this->detailed_msg != INVALID_STRING_ID) panel_height += this->height_detailed + WidgetDimensions::scaled.vsep_wide;
        if (this->extra_msg != INVALID_STRING_ID) panel_height += this->height_extra + WidgetDimensions::scaled.vsep_wide;
 
        size.height = std::max(size.height, panel_height);
        break;
      }
      case WID_EM_FACE:
        size = maxdim(size, GetScaledSpriteSize(SPR_GRADIENT));
        break;
    }
  }
 
  Point OnInitialPosition([[maybe_unused]] int16_t sm_width, [[maybe_unused]] int16_t sm_height, [[maybe_unused]] int window_number) override
  {
    /* Position (0, 0) given, center the window. */
    if (this->position.x == 0 && this->position.y == 0) {
      Point pt = {(_screen.width - sm_width) >> 1, (_screen.height - sm_height) >> 1};
      return pt;
    }
 
    constexpr int distance_to_cursor = 200;
 
    /* Position the error window just above the cursor. This makes the
     * error window clearly visible, without being in the way of what
     * the user is doing. */
    Point pt;
    pt.x = _cursor.pos.x - sm_width / 2;
    pt.y = _cursor.pos.y - (distance_to_cursor + sm_height);
 
    if (pt.y < GetMainViewTop()) {
      /* Window didn't fit above cursor, so place it below. */
      pt.y = _cursor.pos.y + distance_to_cursor;
    }
 
    return pt;
  }
 
  void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
  {
    /* If company gets shut down, while displaying an error about it, remove the error message. */
    if (this->face != INVALID_COMPANY && !Company::IsValidID(this->face)) this->Close();
  }
 
  void SetStringParameters(WidgetID widget) const override
  {
    if (widget == WID_EM_CAPTION) CopyInDParam(this->params);
  }
 
  void DrawWidget(const Rect &r, WidgetID widget) const override
  {
    switch (widget) {
      case WID_EM_FACE: {
        const Company *c = Company::Get(this->face);
        DrawCompanyManagerFace(c->face, c->colour, r);
        break;
      }
 
      case WID_EM_MESSAGE:
        CopyInDParam(this->params);
        if (this->textref_stack_size > 0) StartTextRefStackUsage(this->textref_stack_grffile, this->textref_stack_size, this->textref_stack);
 
        if (this->detailed_msg == INVALID_STRING_ID) {
          DrawStringMultiLine(r, this->summary_msg, TC_FROMSTRING, SA_CENTER);
        } else if (this->extra_msg == INVALID_STRING_ID) {
          /* Extra space when message is shorter than company face window */
          int extra = (r.Height() - this->height_summary - this->height_detailed - WidgetDimensions::scaled.vsep_wide) / 2;
 
          /* Note: NewGRF supplied error message often do not start with a colour code, so default to white. */
          DrawStringMultiLine(r.WithHeight(this->height_summary + extra, false), this->summary_msg, TC_WHITE, SA_CENTER);
          DrawStringMultiLine(r.WithHeight(this->height_detailed + extra, true), this->detailed_msg, TC_WHITE, SA_CENTER);
        } else {
          /* Extra space when message is shorter than company face window */
          int extra = (r.Height() - this->height_summary - this->height_detailed - this->height_extra - (WidgetDimensions::scaled.vsep_wide * 2)) / 3;
 
          /* Note: NewGRF supplied error message often do not start with a colour code, so default to white. */
          Rect top_section = r.WithHeight(this->height_summary + extra, false);
          Rect bottom_section = r.WithHeight(this->height_extra + extra, true);
          Rect middle_section = { top_section.left, top_section.bottom, top_section.right, bottom_section.top };
          DrawStringMultiLine(top_section, this->summary_msg, TC_WHITE, SA_CENTER);
          DrawStringMultiLine(middle_section, this->detailed_msg, TC_WHITE, SA_CENTER);
          DrawStringMultiLine(bottom_section, this->extra_msg, TC_WHITE, SA_CENTER);
        }
 
        if (this->textref_stack_size > 0) StopTextRefStackUsage();
        break;
 
      default:
        break;
    }
  }
 
  void OnMouseLoop() override
  {
    /* Disallow closing the window too easily, if timeout is disabled */
    if (_right_button_down && !this->is_critical) this->Close();
  }
 
  void Close([[maybe_unused]] int data = 0) override
  {
    SetRedErrorSquare(INVALID_TILE);
    if (_window_system_initialized) ShowFirstError();
    this->Window::Close();
  }
 
  bool IsCritical()
  {
    return this->is_critical;
  }
};
 
void ClearErrorMessages()
{
  UnshowCriticalError();
  _error_list.clear();
}
 
void ShowFirstError()
{
  _window_system_initialized = true;
  if (!_error_list.empty()) {
    new ErrmsgWindow(_error_list.front());
    _error_list.pop_front();
  }
}
 
void UnshowCriticalError()
{
  ErrmsgWindow *w = dynamic_cast<ErrmsgWindow *>(FindWindowById(WC_ERRMSG, 0));
  if (_window_system_initialized && w != nullptr) {
    if (w->IsCritical()) _error_list.push_front(*w);
    _window_system_initialized = false;
    w->Close();
  }
}
 
void ShowErrorMessage(StringID summary_msg, int x, int y, CommandCost cc)
{
  ShowErrorMessage(summary_msg, cc.GetErrorMessage(), WL_INFO, x, y, cc.GetTextRefStackGRF(), cc.GetTextRefStackSize(), cc.GetTextRefStack(), cc.GetExtraErrorMessage());
}
 
void ShowErrorMessage(StringID summary_msg, StringID detailed_msg, WarningLevel wl, int x, int y, const GRFFile *textref_stack_grffile, uint textref_stack_size, const uint32_t *textref_stack, StringID extra_msg)
{
  assert(textref_stack_size == 0 || (textref_stack_grffile != nullptr && textref_stack != nullptr));
  if (summary_msg == STR_NULL) summary_msg = STR_EMPTY;
 
  if (wl != WL_INFO) {
    /* Print message to console */
 
    if (textref_stack_size > 0) StartTextRefStackUsage(textref_stack_grffile, textref_stack_size, textref_stack);
 
    std::string message = GetString(summary_msg);
    if (detailed_msg != INVALID_STRING_ID) {
      message += " ";
      AppendStringInPlace(message, detailed_msg);
    }
    if (extra_msg != INVALID_STRING_ID) {
      message += " ";
      AppendStringInPlace(message, extra_msg);
    }
 
    if (textref_stack_size > 0) StopTextRefStackUsage();
 
    IConsolePrint(wl == WL_WARNING ? CC_WARNING : CC_ERROR, message);
  }
 
  bool is_critical = wl == WL_CRITICAL;
 
  if (_game_mode == GM_BOOTSTRAP) return;
  if (_settings_client.gui.errmsg_duration == 0 && !is_critical) return;
 
  ErrorMessageData data(summary_msg, detailed_msg, is_critical, x, y, textref_stack_grffile, textref_stack_size, textref_stack, extra_msg);
  data.CopyOutDParams();
 
  ErrmsgWindow *w = dynamic_cast<ErrmsgWindow *>(FindWindowById(WC_ERRMSG, 0));
  if (w != nullptr) {
    if (w->IsCritical()) {
      /* A critical error is currently shown. */
      if (wl == WL_CRITICAL) {
        /* Push another critical error in the queue of errors,
         * but do not put other errors in the queue. */
        _error_list.push_back(data);
      }
      return;
    }
    /* A non-critical error was shown. */
    w->Close();
  }
  new ErrmsgWindow(data);
}
 
 
bool HideActiveErrorMessage()
{
  ErrmsgWindow *w = dynamic_cast<ErrmsgWindow *>(FindWindowById(WC_ERRMSG, 0));
  if (w == nullptr) return false;
  w->Close();
  return true;
}
 
void ScheduleErrorMessage(ErrorList &datas)
{
  _error_list.splice(_error_list.end(), datas);
}
 
void ScheduleErrorMessage(const ErrorMessageData &data)
{
  _error_list.push_back(data);
}