goal_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 "industry.h"
#include "town.h"
#include "window_gui.h"
#include "strings_func.h"
#include "viewport_func.h"
#include "gui.h"
#include "goal_base.h"
#include "goal_gui.h"
#include "core/geometry_func.hpp"
#include "company_func.h"
#include "company_base.h"
#include "company_gui.h"
#include "story_base.h"
#include "command_func.h"
#include "string_func.h"
#include "goal_cmd.h"
 
#include "widgets/goal_widget.h"
 
#include "table/strings.h"
 
#include "safeguards.h"

enum GoalColumn : uint8_t {
  GC_GOAL = 0, 
  GC_PROGRESS, 
};

struct GoalListWindow : public Window {
  Scrollbar *vscroll = nullptr; 
 
  GoalListWindow(WindowDesc &desc, WindowNumber window_number) : Window(desc)
  {
    this->CreateNestedTree();
    this->vscroll = this->GetScrollbar(WID_GOAL_SCROLLBAR);
    this->FinishInitNested(window_number);
    this->owner = this->window_number;
    NWidgetStacked *wi = this->GetWidget<NWidgetStacked>(WID_GOAL_SELECT_BUTTONS);
    wi->SetDisplayedPlane(window_number == CompanyID::Invalid() ? 1 : 0);
    this->OnInvalidateData(0);
  }
 
  std::string GetWidgetString(WidgetID widget, StringID stringid) const override
  {
    if (widget != WID_GOAL_CAPTION) return this->Window::GetWidgetString(widget, stringid);
 
    if (this->window_number == CompanyID::Invalid()) {
      return GetString(STR_GOALS_SPECTATOR_CAPTION);
    }
    return GetString(STR_GOALS_CAPTION, this->window_number);
  }
 
  void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
  {
    switch (widget) {
      case WID_GOAL_GLOBAL_BUTTON:
        ShowGoalsList(CompanyID::Invalid());
        break;
 
      case WID_GOAL_COMPANY_BUTTON:
        ShowGoalsList(_local_company);
        break;
 
      case WID_GOAL_LIST: {
        int y = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_GOAL_LIST, WidgetDimensions::scaled.framerect.top);
        for (const Goal *s : Goal::Iterate()) {
          if (s->company == this->window_number) {
            if (y == 0) {
              this->HandleClick(s);
              return;
            }
            y--;
          }
        }
        break;
      }
 
      default:
        break;
    }
  }

  void HandleClick(const Goal *s)
  {
    /* Determine dst coordinate for goal and try to scroll to it. */
    TileIndex xy;
    switch (s->type) {
      case GoalType::None: return;
 
      case GoalType::Company:
        /* s->dst here is not a tile, but a CompanyID.
         * Show the window with the overview of the company instead. */
        ShowCompany((CompanyID)s->dst);
        return;
 
      case GoalType::Tile:
        if (!IsValidTile(s->dst)) return;
        xy = TileIndex{s->dst};
        break;
 
      case GoalType::Industry:
        if (!Industry::IsValidID(s->dst)) return;
        xy = Industry::Get(s->dst)->location.tile;
        break;
 
      case GoalType::Town:
        if (!Town::IsValidID(s->dst)) return;
        xy = Town::Get(s->dst)->xy;
        break;
 
      case GoalType::StoryPage: {
        if (!StoryPage::IsValidID(s->dst)) return;
 
        /* Verify that:
         * - if global goal: story page must be global.
         * - if company goal: story page must be global or of the same company.
         */
        CompanyID goal_company = s->company;
        CompanyID story_company = StoryPage::Get(s->dst)->company;
        if (goal_company == CompanyID::Invalid() ? story_company != CompanyID::Invalid() : story_company != CompanyID::Invalid() && story_company != goal_company) return;
 
        ShowStoryBook(static_cast<CompanyID>(this->window_number), static_cast<StoryPageID>(s->dst));
        return;
      }
 
      default: NOT_REACHED();
    }
 
    if (_ctrl_pressed) {
      ShowExtraViewportWindow(xy);
    } else {
      ScrollMainWindowToTile(xy);
    }
  }

  uint CountLines()
  {
    /* Count number of (non) awarded goals. */
    uint num = 0;
    for (const Goal *s : Goal::Iterate()) {
      if (s->company == this->window_number) num++;
    }
 
    /* Count the 'none' lines. */
    if (num == 0) num = 1;
 
    return num;
  }
 
  void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
  {
    if (widget != WID_GOAL_LIST) return;
    Dimension d = GetStringBoundingBox(STR_GOALS_NONE);
 
    resize.width = 1;
    fill.height = resize.height = d.height;
 
    d.height *= 5;
    d.width += WidgetDimensions::scaled.framerect.Horizontal();
    d.height += WidgetDimensions::scaled.framerect.Vertical();
    size = maxdim(size, d);
  }

  void DrawListColumn(GoalColumn column, NWidgetBase *wid, uint progress_col_width) const
  {
    /* Get column draw area. */
    Rect r = wid->GetCurrentRect().Shrink(WidgetDimensions::scaled.framerect);
    bool rtl = _current_text_dir == TD_RTL;
 
    int pos = -this->vscroll->GetPosition();
    const int cap = this->vscroll->GetCapacity();
 
    uint num = 0;
    for (const Goal *s : Goal::Iterate()) {
      if (s->company == this->window_number) {
        if (IsInsideMM(pos, 0, cap)) {
          switch (column) {
            case GC_GOAL: {
              /* Display the goal. */
              uint width_reduction = progress_col_width > 0 ? progress_col_width + WidgetDimensions::scaled.framerect.Horizontal() : 0;
              DrawString(r.Indent(width_reduction, !rtl), GetString(STR_GOALS_TEXT, s->text.GetDecodedString()));
              break;
            }
 
            case GC_PROGRESS:
              if (!s->progress.empty()) {
                StringID str = s->completed ? STR_GOALS_PROGRESS_COMPLETE : STR_GOALS_PROGRESS;
                DrawString(r.WithWidth(progress_col_width, !rtl), GetString(str, s->progress.GetDecodedString()), TextColour::FromString, SA_RIGHT | SA_FORCE);
              }
              break;
          }
          r.top += GetCharacterHeight(FontSize::Normal);
        }
        pos++;
        num++;
      }
    }
 
    if (num == 0) {
      if (column == GC_GOAL && IsInsideMM(pos, 0, cap)) {
        DrawString(r, STR_GOALS_NONE);
      }
    }
  }
 
  void OnPaint() override
  {
    this->DrawWidgets();
 
    if (this->IsShaded()) return; // Don't draw anything when the window is shaded.
 
    /* Calculate progress column width. */
    uint max_width = 0;
    for (const Goal *s : Goal::Iterate()) {
      if (!s->progress.empty()) {
        StringID str = s->completed ? STR_GOALS_PROGRESS_COMPLETE : STR_GOALS_PROGRESS;
        uint str_width = GetStringBoundingBox(GetString(str, s->progress.GetDecodedString())).width;
        if (str_width > max_width) max_width = str_width;
      }
    }
 
    NWidgetBase *wid = this->GetWidget<NWidgetBase>(WID_GOAL_LIST);
    uint progress_col_width = std::min(max_width, wid->current_x);
 
    /* Draw goal list. */
    this->DrawListColumn(GC_PROGRESS, wid, progress_col_width);
    this->DrawListColumn(GC_GOAL, wid, progress_col_width);
 
  }
 
  void OnResize() override
  {
    this->vscroll->SetCapacityFromWidget(this, WID_GOAL_LIST, WidgetDimensions::scaled.framerect.Vertical());
  }

  void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
  {
    if (!gui_scope) return;
    this->vscroll->SetCount(this->CountLines());
    this->SetWidgetDisabledState(WID_GOAL_COMPANY_BUTTON, _local_company == COMPANY_SPECTATOR);
    this->SetWidgetDirty(WID_GOAL_COMPANY_BUTTON);
    this->SetWidgetDirty(WID_GOAL_LIST);
  }
};

static constexpr std::initializer_list<NWidgetPart> _nested_goals_list_widgets = {
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_CLOSEBOX, Colours::Brown),
    NWidget(WWT_CAPTION, Colours::Brown, WID_GOAL_CAPTION),
    NWidget(NWID_SELECTION, Colours::Invalid, WID_GOAL_SELECT_BUTTONS),
      NWidget(WWT_PUSHTXTBTN, Colours::Brown, WID_GOAL_GLOBAL_BUTTON), SetMinimalSize(50, 0), SetStringTip(STR_GOALS_GLOBAL_BUTTON, STR_GOALS_GLOBAL_BUTTON_HELPTEXT),
      NWidget(WWT_PUSHTXTBTN, Colours::Brown, WID_GOAL_COMPANY_BUTTON), SetMinimalSize(50, 0), SetStringTip(STR_GOALS_COMPANY_BUTTON, STR_GOALS_COMPANY_BUTTON_HELPTEXT),
    EndContainer(),
    NWidget(WWT_SHADEBOX, Colours::Brown),
    NWidget(WWT_DEFSIZEBOX, Colours::Brown),
    NWidget(WWT_STICKYBOX, Colours::Brown),
  EndContainer(),
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_PANEL, Colours::Brown, WID_GOAL_LIST), SetToolTip(STR_GOALS_TOOLTIP_CLICK_ON_SERVICE_TO_CENTER), SetScrollbar(WID_GOAL_SCROLLBAR), SetResize(1, 1), SetMinimalTextLines(2, 0),
    EndContainer(),
    NWidget(NWID_VERTICAL),
      NWidget(NWID_VSCROLLBAR, Colours::Brown, WID_GOAL_SCROLLBAR),
      NWidget(WWT_RESIZEBOX, Colours::Brown),
    EndContainer(),
  EndContainer(),
};

static WindowDesc _goals_list_desc(
  WindowPosition::Automatic, "list_goals", 500, 127,
  WindowClass::GoalList, WindowClass::None,
  {},
  _nested_goals_list_widgets
);

void ShowGoalsList(CompanyID company)
{
  if (!Company::IsValidID(company)) company = (CompanyID)CompanyID::Invalid();
 
  AllocateWindowDescFront<GoalListWindow>(_goals_list_desc, company);
}

struct GoalQuestionWindow : public Window {
  EncodedString question; 
  GoalQuestionButtons buttons; 
  TextColour colour; 

  GoalQuestionWindow(WindowDesc &desc, WindowNumber window_number, TextColour colour, GoalQuestionButtons buttons, const EncodedString &question)
    : Window(desc), question(question), buttons(buttons), colour(colour)
  {
    assert(this->buttons.Count() < 4);
 
    this->CreateNestedTree();
    if (this->buttons.None()) {
      this->GetWidget<NWidgetStacked>(WID_GQ_BUTTONS)->SetDisplayedPlane(SZSP_HORIZONTAL);
    } else {
      this->GetWidget<NWidgetStacked>(WID_GQ_BUTTONS)->SetDisplayedPlane(this->buttons.Count() - 1);
    }
    this->FinishInitNested(window_number);
  }
 
  std::string GetWidgetString(WidgetID widget, StringID stringid) const override
  {
    switch (widget) {
      case WID_GQ_BUTTON_1:
      case WID_GQ_BUTTON_2:
      case WID_GQ_BUTTON_3:
        return GetString(STR_GOAL_QUESTION_BUTTON_CANCEL + to_underlying(this->buttons.GetNthSetBit(widget - WID_GQ_BUTTON_1).value_or(GoalQuestionButton::Cancel)));
 
      default:
        return this->Window::GetWidgetString(widget, stringid);
    }
  }
 
  void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
  {
    switch (widget) {
      case WID_GQ_BUTTON_1:
      case WID_GQ_BUTTON_2:
      case WID_GQ_BUTTON_3:
        Command<Commands::GoalQuestionAnswer>::Post(this->window_number, this->buttons.GetNthSetBit(widget - WID_GQ_BUTTON_1).value_or(GoalQuestionButton::Cancel));
        this->Close();
        break;
    }
  }
 
  void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
  {
    if (widget != WID_GQ_QUESTION) return;
 
    size.height = GetStringHeight(this->question.GetDecodedString(), size.width);
  }
 
  void DrawWidget(const Rect &r, WidgetID widget) const override
  {
    if (widget != WID_GQ_QUESTION) return;
 
    DrawStringMultiLine(r, this->question.GetDecodedString(), this->colour, SA_TOP | SA_HOR_CENTER);
  }
};

template <Colours bg_colour, Colours btn_colour, StringID caption>
struct NestedGoalWidgets {
  static constexpr auto widgetparts = {
    NWidget(NWID_HORIZONTAL),
      NWidget(WWT_CLOSEBOX, bg_colour),
      NWidget(WWT_CAPTION, bg_colour, WID_GQ_CAPTION), SetStringTip(caption, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
    EndContainer(),
    NWidget(WWT_PANEL, bg_colour),
      NWidget(NWID_VERTICAL), SetPadding(WidgetDimensions::unscaled.modalpopup), SetPIP(0, WidgetDimensions::unscaled.vsep_wide, 0),
        NWidget(WWT_EMPTY, Colours::Invalid, WID_GQ_QUESTION), SetMinimalSize(300, 0), SetFill(1, 0),
        NWidget(NWID_SELECTION, Colours::Invalid, WID_GQ_BUTTONS),
          NWidget(NWID_HORIZONTAL, NWidContainerFlag::EqualSize), SetPIP(85, WidgetDimensions::unscaled.hsep_wide, 85),
            NWidget(WWT_PUSHTXTBTN, btn_colour, WID_GQ_BUTTON_1), SetFill(1, 0),
          EndContainer(),
          NWidget(NWID_HORIZONTAL, NWidContainerFlag::EqualSize), SetPIP(65, WidgetDimensions::unscaled.hsep_wide, 65),
            NWidget(WWT_PUSHTXTBTN, btn_colour, WID_GQ_BUTTON_1), SetFill(1, 0),
            NWidget(WWT_PUSHTXTBTN, btn_colour, WID_GQ_BUTTON_2), SetFill(1, 0),
          EndContainer(),
          NWidget(NWID_HORIZONTAL, NWidContainerFlag::EqualSize), SetPIP(25, WidgetDimensions::unscaled.hsep_wide, 25),
            NWidget(WWT_PUSHTXTBTN, btn_colour, WID_GQ_BUTTON_1), SetFill(1, 0),
            NWidget(WWT_PUSHTXTBTN, btn_colour, WID_GQ_BUTTON_2), SetFill(1, 0),
            NWidget(WWT_PUSHTXTBTN, btn_colour, WID_GQ_BUTTON_3), SetFill(1, 0),
          EndContainer(),
        EndContainer(),
      EndContainer(),
    EndContainer(),
  };
};
 
static constexpr auto _nested_goal_question_widgets_question = NestedGoalWidgets<Colours::LightBlue, Colours::LightBlue, STR_GOAL_QUESTION_CAPTION_QUESTION>::widgetparts;
static constexpr auto _nested_goal_question_widgets_info     = NestedGoalWidgets<Colours::LightBlue, Colours::LightBlue, STR_GOAL_QUESTION_CAPTION_INFORMATION>::widgetparts;
static constexpr auto _nested_goal_question_widgets_warning  = NestedGoalWidgets<Colours::Yellow,     Colours::Yellow,     STR_GOAL_QUESTION_CAPTION_WARNING>::widgetparts;
static constexpr auto _nested_goal_question_widgets_error    = NestedGoalWidgets<Colours::Red,        Colours::Yellow,     STR_GOAL_QUESTION_CAPTION_ERROR>::widgetparts;

static EnumIndexArray<WindowDesc, GoalQuestionType, GoalQuestionType::End> _goal_question_list_desc{{{
  {
    WindowPosition::Center, {}, 0, 0,
    WindowClass::GoalQuestion, WindowClass::None,
    WindowDefaultFlag::Construction,
    _nested_goal_question_widgets_question,
  },
  {
    WindowPosition::Center, {}, 0, 0,
    WindowClass::GoalQuestion, WindowClass::None,
    WindowDefaultFlag::Construction,
    _nested_goal_question_widgets_info,
  },
  {
    WindowPosition::Center, {}, 0, 0,
    WindowClass::GoalQuestion, WindowClass::None,
    WindowDefaultFlag::Construction,
    _nested_goal_question_widgets_warning,
  },
  {
    WindowPosition::Center, {}, 0, 0,
    WindowClass::GoalQuestion, WindowClass::None,
    WindowDefaultFlag::Construction,
    _nested_goal_question_widgets_error,
  },
}}};

void ShowGoalQuestion(uint16_t id, GoalQuestionType type, GoalQuestionButtons buttons, const EncodedString &question)
{
  assert(type < GoalQuestionType::End);
  new GoalQuestionWindow(_goal_question_list_desc[type], id, type == GoalQuestionType::Error ? TextColour::White : TextColour::Black, buttons, question);
}