OpenTTD
goal_gui.cpp
Go to the documentation of this file.
1 /* $Id: goal_gui.cpp 26509 2014-04-25 15:40:32Z rubidium $ */
2 
3 /*
4  * This file is part of OpenTTD.
5  * 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.
6  * 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.
7  * 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/>.
8  */
9 
12 #include "stdafx.h"
13 #include "industry.h"
14 #include "town.h"
15 #include "window_gui.h"
16 #include "strings_func.h"
17 #include "date_func.h"
18 #include "viewport_func.h"
19 #include "gui.h"
20 #include "goal_base.h"
21 #include "core/geometry_func.hpp"
22 #include "company_func.h"
23 #include "company_base.h"
24 #include "story_base.h"
25 #include "command_func.h"
26 #include "string_func.h"
27 
28 #include "widgets/goal_widget.h"
29 
30 #include "table/strings.h"
31 
32 #include "safeguards.h"
33 
35 enum GoalColumn {
36  GC_GOAL = 0,
38 };
39 
41 struct GoalListWindow : public Window {
43 
45  {
46  this->CreateNestedTree();
48  this->FinishInitNested(window_number);
49  this->owner = (Owner)this->window_number;
50  this->OnInvalidateData(0);
51  }
52 
53  /* virtual */ void SetStringParameters(int widget) const
54  {
55  if (widget != WID_GOAL_CAPTION) return;
56 
57  if (this->window_number == INVALID_COMPANY) {
58  SetDParam(0, STR_GOALS_SPECTATOR_CAPTION);
59  } else {
60  SetDParam(0, STR_GOALS_CAPTION);
61  SetDParam(1, this->window_number);
62  }
63  }
64 
65  /* virtual */ void OnClick(Point pt, int widget, int click_count)
66  {
67  if (widget != WID_GOAL_LIST) return;
68 
70  int num = 0;
71  const Goal *s;
72  FOR_ALL_GOALS(s) {
73  if (s->company == INVALID_COMPANY) {
74  y--;
75  if (y == 0) {
76  this->HandleClick(s);
77  return;
78  }
79  num++;
80  }
81  }
82 
83  if (num == 0) {
84  y--; // "None" line.
85  if (y < 0) return;
86  }
87 
88  y -= 2; // "Company specific goals:" line.
89  if (y < 0) return;
90 
91  FOR_ALL_GOALS(s) {
92  if (s->company == this->window_number) {
93  y--;
94  if (y == 0) {
95  this->HandleClick(s);
96  return;
97  }
98  }
99  }
100  }
101 
106  void HandleClick(const Goal *s)
107  {
108  /* Determine dst coordinate for goal and try to scroll to it. */
109  TileIndex xy;
110  switch (s->type) {
111  case GT_NONE: return;
112  case GT_COMPANY: return;
113 
114  case GT_TILE:
115  if (!IsValidTile(s->dst)) return;
116  xy = s->dst;
117  break;
118 
119  case GT_INDUSTRY:
120  if (!Industry::IsValidID(s->dst)) return;
121  xy = Industry::Get(s->dst)->location.tile;
122  break;
123 
124  case GT_TOWN:
125  if (!Town::IsValidID(s->dst)) return;
126  xy = Town::Get(s->dst)->xy;
127  break;
128 
129  case GT_STORY_PAGE: {
130  if (!StoryPage::IsValidID(s->dst)) return;
131 
132  /* Verify that:
133  * - if global goal: story page must be global.
134  * - if company goal: story page must be global or of the same company.
135  */
136  CompanyID goal_company = s->company;
137  CompanyID story_company = StoryPage::Get(s->dst)->company;
138  if (goal_company == INVALID_COMPANY ? story_company != INVALID_COMPANY : story_company != INVALID_COMPANY && story_company != goal_company) return;
139 
141  return;
142  }
143 
144  default: NOT_REACHED();
145  }
146 
147  if (_ctrl_pressed) {
149  } else {
151  }
152  }
153 
158  uint CountLines()
159  {
160  /* Count number of (non) awarded goals. */
161  uint num_global = 0;
162  uint num_company = 0;
163  const Goal *s;
164  FOR_ALL_GOALS(s) {
165  if (s->company == INVALID_COMPANY) {
166  num_global++;
167  } else if (s->company == this->window_number) {
168  num_company++;
169  }
170  }
171 
172  /* Count the 'none' lines. */
173  if (num_global == 0) num_global = 1;
174  if (num_company == 0) num_company = 1;
175 
176  /* Global, company and an empty line before the accepted ones. */
177  return 3 + num_global + num_company;
178  }
179 
180  /* virtual */ void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
181  {
182  if (widget != WID_GOAL_LIST) return;
183  Dimension d = maxdim(GetStringBoundingBox(STR_GOALS_GLOBAL_TITLE), GetStringBoundingBox(STR_GOALS_COMPANY_TITLE));
184 
185  resize->height = d.height;
186 
187  d.height *= 5;
188  d.width += padding.width + WD_FRAMERECT_RIGHT + WD_FRAMERECT_LEFT;
189  d.height += padding.height + WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM;
190  *size = maxdim(*size, d);
191  }
192 
204  void DrawPartialGoalList(int &pos, const int cap, int x, int y, int right, uint progress_col_width, bool global_section, GoalColumn column) const
205  {
206  if (column == GC_GOAL && IsInsideMM(pos, 0, cap)) DrawString(x, right, y + pos * FONT_HEIGHT_NORMAL, global_section ? STR_GOALS_GLOBAL_TITLE : STR_GOALS_COMPANY_TITLE);
207  pos++;
208 
209  bool rtl = _current_text_dir == TD_RTL;
210 
211  uint num = 0;
212  const Goal *s;
213  FOR_ALL_GOALS(s) {
214  if (global_section ? s->company == INVALID_COMPANY : (s->company == this->window_number && s->company != INVALID_COMPANY)) {
215  if (IsInsideMM(pos, 0, cap)) {
216  switch (column) {
217  case GC_GOAL: {
218  /* Display the goal. */
219  SetDParamStr(0, s->text);
220  uint width_reduction = progress_col_width > 0 ? progress_col_width + WD_FRAMERECT_LEFT + WD_FRAMERECT_RIGHT : 0;
221  DrawString(x + (rtl ? width_reduction : 0), right - (rtl ? 0 : width_reduction), y + pos * FONT_HEIGHT_NORMAL, STR_GOALS_TEXT);
222  break;
223  }
224 
225  case GC_PROGRESS:
226  if (s->progress != NULL) {
227  SetDParamStr(0, s->progress);
228  StringID str = s->completed ? STR_GOALS_PROGRESS_COMPLETE : STR_GOALS_PROGRESS;
229  int progress_x = x;
230  int progress_right = rtl ? x + progress_col_width : right;
231  DrawString(progress_x, progress_right, y + pos * FONT_HEIGHT_NORMAL, str, TC_FROMSTRING, SA_RIGHT | SA_FORCE);
232  }
233  break;
234  }
235  }
236  pos++;
237  num++;
238  }
239  }
240 
241  if (num == 0) {
242  if (column == GC_GOAL && IsInsideMM(pos, 0, cap)) {
243  StringID str = !global_section && this->window_number == INVALID_COMPANY ? STR_GOALS_SPECTATOR_NONE : STR_GOALS_NONE;
244  DrawString(x, right, y + pos * FONT_HEIGHT_NORMAL, str);
245  }
246  pos++;
247  }
248  }
249 
257  void DrawListColumn(GoalColumn column, NWidgetBase *wid, uint progress_col_width) const
258  {
259  /* Get column draw area. */
260  int y = wid->pos_y + WD_FRAMERECT_TOP;
261  int x = wid->pos_x + WD_FRAMERECT_LEFT;
262  int right = x + wid->current_x - WD_FRAMERECT_RIGHT;
263 
264  int pos = -this->vscroll->GetPosition();
265  const int cap = this->vscroll->GetCapacity();
266 
267  /* Draw partial list with global goals. */
268  DrawPartialGoalList(pos, cap, x, y, right, progress_col_width, true, column);
269 
270  /* Draw partial list with company goals. */
271  pos++;
272  DrawPartialGoalList(pos, cap, x, y, right, progress_col_width, false, column);
273  }
274 
275  /* virtual */ void OnPaint()
276  {
277  this->DrawWidgets();
278 
279  if (this->IsShaded()) return; // Don't draw anything when the window is shaded.
280 
281  /* Calculate progress column width. */
282  uint max_width = 0;
283  Goal *s;
284  FOR_ALL_GOALS(s) {
285  if (s->progress != NULL) {
286  SetDParamStr(0, s->progress);
287  StringID str = s->completed ? STR_GOALS_PROGRESS_COMPLETE : STR_GOALS_PROGRESS;
288  uint str_width = GetStringBoundingBox(str).width;
289  if (str_width > max_width) max_width = str_width;
290  }
291  }
292 
293  NWidgetBase *wid = this->GetWidget<NWidgetBase>(WID_GOAL_LIST);
294  uint progress_col_width = min(max_width, wid->current_x);
295 
296  /* Draw goal list. */
297  this->DrawListColumn(GC_PROGRESS, wid, progress_col_width);
298  this->DrawListColumn(GC_GOAL, wid, progress_col_width);
299 
300  }
301 
302  /* virtual */ void OnResize()
303  {
305  }
306 
312  /* virtual */ void OnInvalidateData(int data = 0, bool gui_scope = true)
313  {
314  if (!gui_scope) return;
315  this->vscroll->SetCount(this->CountLines());
317  }
318 };
319 
323  NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
324  NWidget(WWT_CAPTION, COLOUR_BROWN, WID_GOAL_CAPTION), SetDataTip(STR_JUST_STRING, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
325  NWidget(WWT_SHADEBOX, COLOUR_BROWN),
326  NWidget(WWT_DEFSIZEBOX, COLOUR_BROWN),
327  NWidget(WWT_STICKYBOX, COLOUR_BROWN),
328  EndContainer(),
330  NWidget(WWT_PANEL, COLOUR_BROWN), SetDataTip(0x0, STR_GOALS_TOOLTIP_CLICK_ON_SERVICE_TO_CENTER), SetScrollbar(WID_GOAL_SCROLLBAR),
332  EndContainer(),
335  NWidget(WWT_RESIZEBOX, COLOUR_BROWN),
336  EndContainer(),
337  EndContainer(),
338 };
339 
340 static WindowDesc _goals_list_desc(
341  WDP_AUTO, "list_goals", 500, 127,
343  0,
344  _nested_goals_list_widgets, lengthof(_nested_goals_list_widgets)
345 );
346 
352 {
353  if (!Company::IsValidID(company)) company = (CompanyID)INVALID_COMPANY;
354 
355  AllocateWindowDescFront<GoalListWindow>(&_goals_list_desc, company);
356 }
357 
359 struct GoalQuestionWindow : public Window {
360  char *question;
361  int buttons;
362  int button[3];
363  byte type;
364 
365  GoalQuestionWindow(WindowDesc *desc, WindowNumber window_number, byte type, uint32 button_mask, const char *question) : Window(desc), type(type)
366  {
367  assert(type < GOAL_QUESTION_TYPE_COUNT);
368  this->question = stredup(question);
369 
370  /* Figure out which buttons we have to enable. */
371  uint bit;
372  int n = 0;
373  FOR_EACH_SET_BIT(bit, button_mask) {
374  if (bit >= GOAL_QUESTION_BUTTON_COUNT) break;
375  this->button[n++] = bit;
376  if (n == 3) break;
377  }
378  this->buttons = n;
379  assert(this->buttons > 0 && this->buttons < 4);
380 
381  this->CreateNestedTree();
382  this->GetWidget<NWidgetStacked>(WID_GQ_BUTTONS)->SetDisplayedPlane(this->buttons - 1);
383  this->FinishInitNested(window_number);
384  }
385 
387  {
388  free(this->question);
389  }
390 
391  /* virtual */ void SetStringParameters(int widget) const
392  {
393  switch (widget) {
394  case WID_GQ_CAPTION:
395  SetDParam(0, STR_GOAL_QUESTION_CAPTION_QUESTION + this->type);
396  break;
397 
398  case WID_GQ_BUTTON_1:
399  SetDParam(0, STR_GOAL_QUESTION_BUTTON_CANCEL + this->button[0]);
400  break;
401 
402  case WID_GQ_BUTTON_2:
403  SetDParam(0, STR_GOAL_QUESTION_BUTTON_CANCEL + this->button[1]);
404  break;
405 
406  case WID_GQ_BUTTON_3:
407  SetDParam(0, STR_GOAL_QUESTION_BUTTON_CANCEL + this->button[2]);
408  break;
409  }
410  }
411 
412  /* virtual */ void OnClick(Point pt, int widget, int click_count)
413  {
414  switch (widget) {
415  case WID_GQ_BUTTON_1:
417  delete this;
418  break;
419 
420  case WID_GQ_BUTTON_2:
422  delete this;
423  break;
424 
425  case WID_GQ_BUTTON_3:
427  delete this;
428  break;
429  }
430  }
431 
432  /* virtual */ void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
433  {
434  if (widget != WID_GQ_QUESTION) return;
435 
436  SetDParamStr(0, this->question);
437  size->height = GetStringHeight(STR_JUST_RAW_STRING, size->width) + WD_PAR_VSEP_WIDE;
438  }
439 
440  /* virtual */ void DrawWidget(const Rect &r, int widget) const
441  {
442  if (widget != WID_GQ_QUESTION) return;
443 
444  SetDParamStr(0, this->question);
445  DrawStringMultiLine(r.left, r.right, r.top, UINT16_MAX, STR_JUST_RAW_STRING, TC_BLACK, SA_TOP | SA_HOR_CENTER);
446  }
447 };
448 
452  NWidget(WWT_CLOSEBOX, COLOUR_LIGHT_BLUE),
453  NWidget(WWT_CAPTION, COLOUR_LIGHT_BLUE, WID_GQ_CAPTION), SetDataTip(STR_WHITE_STRING, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
454  EndContainer(),
455  NWidget(WWT_PANEL, COLOUR_LIGHT_BLUE),
456  NWidget(WWT_EMPTY, INVALID_COLOUR, WID_GQ_QUESTION), SetMinimalSize(300, 0), SetPadding(8, 8, 8, 8), SetFill(1, 0),
457  NWidget(NWID_SELECTION, INVALID_COLOUR, WID_GQ_BUTTONS),
459  NWidget(WWT_PUSHTXTBTN, COLOUR_LIGHT_BLUE, WID_GQ_BUTTON_1), SetDataTip(STR_BLACK_STRING, STR_NULL), SetFill(1, 0),
460  EndContainer(),
462  NWidget(WWT_PUSHTXTBTN, COLOUR_LIGHT_BLUE, WID_GQ_BUTTON_1), SetDataTip(STR_BLACK_STRING, STR_NULL), SetFill(1, 0),
463  NWidget(WWT_PUSHTXTBTN, COLOUR_LIGHT_BLUE, WID_GQ_BUTTON_2), SetDataTip(STR_BLACK_STRING, STR_NULL), SetFill(1, 0),
464  EndContainer(),
466  NWidget(WWT_PUSHTXTBTN, COLOUR_LIGHT_BLUE, WID_GQ_BUTTON_1), SetDataTip(STR_BLACK_STRING, STR_NULL), SetFill(1, 0),
467  NWidget(WWT_PUSHTXTBTN, COLOUR_LIGHT_BLUE, WID_GQ_BUTTON_2), SetDataTip(STR_BLACK_STRING, STR_NULL), SetFill(1, 0),
468  NWidget(WWT_PUSHTXTBTN, COLOUR_LIGHT_BLUE, WID_GQ_BUTTON_3), SetDataTip(STR_BLACK_STRING, STR_NULL), SetFill(1, 0),
469  EndContainer(),
470  EndContainer(),
472  EndContainer(),
473 };
474 
475 static WindowDesc _goal_question_list_desc(
476  WDP_CENTER, NULL, 0, 0,
479  _nested_goal_question_widgets, lengthof(_nested_goal_question_widgets)
480 );
481 
489 void ShowGoalQuestion(uint16 id, byte type, uint32 button_mask, const char *question)
490 {
491  new GoalQuestionWindow(&_goal_question_list_desc, id, type, button_mask, question);
492 }