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 "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_manager_face.h"
#include "strings_func.h"
#include "zoom_func.h"
#include "window_func.h"
#include "console_func.h"
#include "window_gui.h"
 
#include "widgets/error_widget.h"
 
#include "table/strings.h"
#include <list>
 
#include "safeguards.h"
 
static const 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, "error", 0, 0,
  WC_ERRMSG, WC_NONE,
  0,
  _nested_errmsg_widgets, lengthof(_nested_errmsg_widgets)
);
 
static const 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, "error_face", 0, 0,
  WC_ERRMSG, WC_NONE,
  0,
  _nested_errmsg_face_widgets, lengthof(_nested_errmsg_face_widgets)
);
 
ErrorMessageData::ErrorMessageData(const ErrorMessageData &data) :
  display_timer(data.display_timer), textref_stack_grffile(data.textref_stack_grffile), textref_stack_size(data.textref_stack_size),
  summary_msg(data.summary_msg), detailed_msg(data.detailed_msg), position(data.position), face(data.face)
{
  memcpy(this->textref_stack, data.textref_stack, sizeof(this->textref_stack));
  memcpy(this->decode_params, data.decode_params, sizeof(this->decode_params));
  memcpy(this->strings,       data.strings,       sizeof(this->strings));
  for (size_t i = 0; i < lengthof(this->strings); i++) {
    if (this->strings[i] != nullptr) {
      this->strings[i] = stredup(this->strings[i]);
      this->decode_params[i] = (size_t)this->strings[i];
    }
  }
}
 
ErrorMessageData::~ErrorMessageData()
{
  for (size_t i = 0; i < lengthof(this->strings); i++) free(this->strings[i]);
}
 
ErrorMessageData::ErrorMessageData(StringID summary_msg, StringID detailed_msg, uint duration, int x, int y, const GRFFile *textref_stack_grffile, uint textref_stack_size, const uint32 *textref_stack) :
  textref_stack_grffile(textref_stack_grffile),
  textref_stack_size(textref_stack_size),
  summary_msg(summary_msg),
  detailed_msg(detailed_msg),
  face(INVALID_COMPANY)
{
  this->position.x = x;
  this->position.y = y;
 
  memset(this->decode_params, 0, sizeof(this->decode_params));
  memset(this->strings, 0, sizeof(this->strings));
 
  if (textref_stack_size > 0) MemCpyT(this->textref_stack, textref_stack, textref_stack_size);
 
  assert(summary_msg != INVALID_STRING_ID);
 
  this->display_timer.SetInterval(duration * 3000);
}
 
void ErrorMessageData::CopyOutDParams()
{
  /* Reset parameters */
  for (size_t i = 0; i < lengthof(this->strings); i++) free(this->strings[i]);
  memset(this->decode_params, 0, sizeof(this->decode_params));
  memset(this->strings, 0, sizeof(this->strings));
 
  /* 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->decode_params, this->strings, this->detailed_msg == INVALID_STRING_ID ? this->summary_msg : this->detailed_msg, lengthof(this->decode_params));
  if (this->textref_stack_size > 0) StopTextRefStackUsage();
 
  if (this->detailed_msg == STR_ERROR_OWNED_BY) {
    CompanyID company = (CompanyID)GetDParamX(this->decode_params, 2);
    if (company < MAX_COMPANIES) face = company;
  }
}
 
void ErrorMessageData::SetDParam(uint n, uint64 v)
{
  this->decode_params[n] = v;
}
 
void ErrorMessageData::SetDParamStr(uint n, const char *str)
{
  free(this->strings[n]);
  this->strings[n] = stredup(str);
}
 
void ErrorMessageData::SetDParamStr(uint n, const std::string &str)
{
  this->SetDParamStr(n, str.c_str());
}
 
typedef std::list<ErrorMessageData> ErrorList;
ErrorList _error_list;
bool _window_system_initialized = false;
 
struct ErrmsgWindow : public Window, ErrorMessageData {
private:
  uint height_summary;            
  uint height_detailed;           
 
public:
  ErrmsgWindow(const ErrorMessageData &data) : Window(data.HasFace() ? &_errmsg_face_desc : &_errmsg_desc), ErrorMessageData(data)
  {
    this->InitNested();
  }
 
  void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
  {
    switch (widget) {
      case WID_EM_MESSAGE: {
        CopyInDParam(0, this->decode_params, lengthof(this->decode_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);
 
        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;
 
        size->height = std::max(size->height, panel_height);
        break;
      }
      case WID_EM_FACE: {
        Dimension face_size = GetSpriteSize(SPR_GRADIENT);
        size->width = std::max(size->width, face_size.width);
        size->height = std::max(size->height, face_size.height);
        break;
      }
    }
  }
 
  Point OnInitialPosition(int16 sm_width, int16 sm_height, 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;
    }
 
    /* Find the free screen space between the main toolbar at the top, and the statusbar at the bottom.
     * Add a fixed distance 20 to make it less cluttered.
     */
    int scr_top = GetMainViewTop() + 20;
    int scr_bot = GetMainViewBottom() - 20;
 
    Point pt = RemapCoords(this->position.x, this->position.y, GetSlopePixelZOutsideMap(this->position.x, this->position.y));
    const Viewport *vp = FindWindowById(WC_MAIN_WINDOW, 0)->viewport;
    if (this->face == INVALID_COMPANY) {
      /* move x pos to opposite corner */
      pt.x = UnScaleByZoom(pt.x - vp->virtual_left, vp->zoom) + vp->left;
      pt.x = (pt.x < (_screen.width >> 1)) ? _screen.width - sm_width - 20 : 20; // Stay 20 pixels away from the edge of the screen.
 
      /* move y pos to opposite corner */
      pt.y = UnScaleByZoom(pt.y - vp->virtual_top, vp->zoom) + vp->top;
      pt.y = (pt.y < (_screen.height >> 1)) ? scr_bot - sm_height : scr_top;
    } else {
      pt.x = std::min(std::max(UnScaleByZoom(pt.x - vp->virtual_left, vp->zoom) + vp->left - (sm_width / 2), 0), _screen.width - sm_width);
      pt.y = std::min(std::max(UnScaleByZoom(pt.y - vp->virtual_top,  vp->zoom) + vp->top  - (sm_height / 2), scr_top), scr_bot - sm_height);
    }
    return pt;
  }
 
  void OnInvalidateData(int data = 0, 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(int widget) const override
  {
    if (widget == WID_EM_CAPTION) CopyInDParam(0, this->decode_params, lengthof(this->decode_params));
  }
 
  void DrawWidget(const Rect &r, int widget) const override
  {
    switch (widget) {
      case WID_EM_FACE: {
        const Company *c = Company::Get(this->face);
        DrawCompanyManagerFace(c->face, c->colour, r.left, r.top);
        break;
      }
 
      case WID_EM_MESSAGE:
        CopyInDParam(0, this->decode_params, lengthof(this->decode_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 {
          /* 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);
        }
 
        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->display_timer.HasElapsed()) this->Close();
  }
 
  void OnRealtimeTick(uint delta_ms) override
  {
    if (this->display_timer.CountElapsed(delta_ms) == 0) return;
 
    this->Close();
  }
 
  void Close() override
  {
    SetRedErrorSquare(INVALID_TILE);
    if (_window_system_initialized) ShowFirstError();
    this->Window::Close();
  }
 
  bool IsCritical()
  {
    return this->display_timer.HasElapsed();
  }
};
 
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 = (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, StringID detailed_msg, WarningLevel wl, int x, int y, const GRFFile *textref_stack_grffile, uint textref_stack_size, const uint32 *textref_stack)
{
  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 */
    char buf[DRAW_STRING_BUFFER];
 
    if (textref_stack_size > 0) StartTextRefStackUsage(textref_stack_grffile, textref_stack_size, textref_stack);
 
    char *b = GetString(buf, summary_msg, lastof(buf));
    if (detailed_msg != INVALID_STRING_ID) {
      b += seprintf(b, lastof(buf), " ");
      GetString(b, detailed_msg, lastof(buf));
    }
 
    if (textref_stack_size > 0) StopTextRefStackUsage();
 
    IConsolePrint(wl == WL_WARNING ? CC_WARNING : CC_ERROR, buf);
  }
 
  bool no_timeout = wl == WL_CRITICAL;
 
  if (_game_mode == GM_BOOTSTRAP) return;
  if (_settings_client.gui.errmsg_duration == 0 && !no_timeout) return;
 
  ErrorMessageData data(summary_msg, detailed_msg, no_timeout ? 0 : _settings_client.gui.errmsg_duration, x, y, textref_stack_grffile, textref_stack_size, textref_stack);
  data.CopyOutDParams();
 
  ErrmsgWindow *w = (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 = (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);
}