src/statusbar_gui.cpp

   1 /* $Id$ */
   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
  10 /** @file statusbar_gui.cpp The GUI for the bottom status bar. */
  11
  12 #include "stdafx.h"
  13 #include "date_func.h"
  14 #include "gfx_func.h"
  15 #include "news_func.h"
  16 #include "company_func.h"
  17 #include "string_func.h"
  18 #include "strings_func.h"
  19 #include "company_base.h"
  20 #include "tilehighlight_func.h"
  21 #include "news_gui.h"
  22 #include "company_gui.h"
  23 #include "window_gui.h"
  24 #include "saveload/saveload.h"
  25 #include "window_func.h"
  26 #include "statusbar_gui.h"
  27 #include "toolbar_gui.h"
  28 #include "core/geometry_func.hpp"
  29 #include "guitimer_func.h"
  30
  31 #include "widgets/statusbar_widget.h"
  32
  33 #include "table/strings.h"
  34 #include "table/sprites.h"
  35
  36 #include "safeguards.h"
  37
  38 static bool DrawScrollingStatusText(const NewsItem *ni, int scroll_pos, int left, int right, int top, int bottom)
  39 {
  40         CopyInDParam(0, ni->params, lengthof(ni->params));
  41         StringID str = ni->string_id;
  42
  43         char buf[512];
  44         GetString(buf, str, lastof(buf));
  45         const char *s = buf;
  46
  47         char buffer[256];
  48         char *d = buffer;
  49         const char *last = lastof(buffer);
  50
  51         for (;;) {
  52                 WChar c = Utf8Consume(&s);
  53                 if (c == 0) {
  54                         break;
  55                 } else if (c == '\n') {
  56                         if (d + 4 >= last) break;
  57                         d[0] = d[1] = d[2] = d[3] = ' ';
  58                         d += 4;
  59                 } else if (IsPrintable(c)) {
  60                         if (d + Utf8CharLen(c) >= last) break;
  61                         d += Utf8Encode(d, c);
  62                 }
  63         }
  64         *d = '\0';
  65
  66         DrawPixelInfo tmp_dpi;
  67         if (!FillDrawPixelInfo(&tmp_dpi, left, top, right - left, bottom)) return true;
  68
  69         int width = GetStringBoundingBox(buffer).width;
  70         int pos = (_current_text_dir == TD_RTL) ? (scroll_pos - width) : (right - scroll_pos - left);
  71
  72         DrawPixelInfo *old_dpi = _cur_dpi;
  73         _cur_dpi = &tmp_dpi;
  74         DrawString(pos, INT16_MAX, 0, buffer, TC_LIGHT_BLUE, SA_LEFT | SA_FORCE);
  75         _cur_dpi = old_dpi;
  76
  77         return (_current_text_dir == TD_RTL) ? (pos < right - left) : (pos + width > 0);
  78 }
  79
  80 struct StatusBarWindow : Window {
  81         bool saving;
  82         int ticker_scroll;
  83         GUITimer ticker_timer;
  84         GUITimer reminder_timeout;
  85
  86         static const int TICKER_STOP    = 1640; ///< scrolling is finished when counter reaches this value
  87         static const int REMINDER_START = 1350; ///< time in ms for reminder notification (red dot on the right) to stay
  88         static const int REMINDER_STOP  =    0; ///< reminder disappears when counter reaches this value
  89         static const int COUNTER_STEP   =    2; ///< this is subtracted from active counters every tick
  90
  91         StatusBarWindow(WindowDesc *desc) : Window(desc)
  92         {
  93                 this->ticker_scroll = TICKER_STOP;
  94                 this->ticker_timer.SetInterval(15);
  95                 this->reminder_timeout.SetInterval(REMINDER_STOP);
  96
  97                 this->InitNested();
  98                 CLRBITS(this->flags, WF_WHITE_BORDER);
  99                 PositionStatusbar(this);
 100         }
 101
 102         Point OnInitialPosition(int16 sm_width, int16 sm_height, int window_number) override
 103         {
 104                 Point pt = { 0, _screen.height - sm_height };
 105                 return pt;
 106         }
 107
 108         void FindWindowPlacementAndResize(int def_width, int def_height) override
 109         {
 110                 Window::FindWindowPlacementAndResize(_toolbar_width, def_height);
 111         }
 112
 113         void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
 114         {
 115                 Dimension d;
 116                 switch (widget) {
 117                         case WID_S_LEFT:
 118                                 SetDParamMaxValue(0, MAX_YEAR * DAYS_IN_YEAR);
 119                                 d = GetStringBoundingBox(STR_WHITE_DATE_LONG);
 120                                 break;
 121
 122                         case WID_S_RIGHT: {
 123                                 int64 max_money = UINT32_MAX;
 124                                 const Company *c;
 125                                 FOR_ALL_COMPANIES(c) max_money = max<int64>(c->money, max_money);
 126                                 SetDParam(0, 100LL * max_money);
 127                                 d = GetStringBoundingBox(STR_COMPANY_MONEY);
 128                                 break;
 129                         }
 130
 131                         default:
 132                                 return;
 133                 }
 134
 135                 d.width += padding.width;
 136                 d.height += padding.height;
 137                 *size = maxdim(d, *size);
 138         }
 139
 140         void DrawWidget(const Rect &r, int widget) const override
 141         {
 142                 switch (widget) {
 143                         case WID_S_LEFT:
 144                                 /* Draw the date */
 145                                 SetDParam(0, _date);
 146                                 DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, r.top + WD_FRAMERECT_TOP, STR_WHITE_DATE_LONG, TC_FROMSTRING, SA_HOR_CENTER);
 147                                 break;
 148
 149                         case WID_S_RIGHT: {
 150                                 /* Draw company money, if any */
 151                                 const Company *c = Company::GetIfValid(_local_company);
 152                                 if (c != nullptr) {
 153                                         SetDParam(0, c->money);
 154                                         DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, r.top + WD_FRAMERECT_TOP, STR_COMPANY_MONEY, TC_FROMSTRING, SA_HOR_CENTER);
 155                                 }
 156                                 break;
 157                         }
 158
 159                         case WID_S_MIDDLE:
 160                                 /* Draw status bar */
 161                                 if (this->saving) { // true when saving is active
 162                                         DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, r.top + WD_FRAMERECT_TOP, STR_STATUSBAR_SAVING_GAME, TC_FROMSTRING, SA_HOR_CENTER);
 163                                 } else if (_do_autosave) {
 164                                         DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, r.top + WD_FRAMERECT_TOP, STR_STATUSBAR_AUTOSAVE, TC_FROMSTRING, SA_HOR_CENTER);
 165                                 } else if (_pause_mode != PM_UNPAUSED) {
 166                                         DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, r.top + WD_FRAMERECT_TOP, STR_STATUSBAR_PAUSED, TC_FROMSTRING, SA_HOR_CENTER);
 167                                 } else if (this->ticker_scroll < TICKER_STOP && FindWindowById(WC_NEWS_WINDOW, 0) == nullptr && _statusbar_news_item != nullptr && _statusbar_news_item->string_id != 0) {
 168                                         /* Draw the scrolling news text */
 169                                         if (!DrawScrollingStatusText(_statusbar_news_item, this->ticker_scroll, r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, r.top + WD_FRAMERECT_TOP, r.bottom)) {
 170                                                 InvalidateWindowData(WC_STATUS_BAR, 0, SBI_NEWS_DELETED);
 171                                                 if (Company::IsValidID(_local_company)) {
 172                                                         /* This is the default text */
 173                                                         SetDParam(0, _local_company);
 174                                                         DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, r.top + WD_FRAMERECT_TOP, STR_STATUSBAR_COMPANY_NAME, TC_FROMSTRING, SA_HOR_CENTER);
 175                                                 }
 176                                         }
 177                                 } else {
 178                                         if (Company::IsValidID(_local_company)) {
 179                                                 /* This is the default text */
 180                                                 SetDParam(0, _local_company);
 181                                                 DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, r.top + WD_FRAMERECT_TOP, STR_STATUSBAR_COMPANY_NAME, TC_FROMSTRING, SA_HOR_CENTER);
 182                                         }
 183                                 }
 184
 185                                 if (!this->reminder_timeout.HasElapsed()) {
 186                                         Dimension icon_size = GetSpriteSize(SPR_UNREAD_NEWS);
 187                                         DrawSprite(SPR_UNREAD_NEWS, PAL_NONE, r.right - WD_FRAMERECT_RIGHT - icon_size.width, r.top + WD_FRAMERECT_TOP + (int)(FONT_HEIGHT_NORMAL - icon_size.height) / 2);
 188                                 }
 189                                 break;
 190                 }
 191         }
 192
 193         /**
 194          * Some data on this window has become invalid.
 195          * @param data Information about the changed data.
 196          * @param gui_scope Whether the call is done from GUI scope. You may not do everything when not in GUI scope. See #InvalidateWindowData() for details.
 197          */
 198         void OnInvalidateData(int data = 0, bool gui_scope = true) override
 199         {
 200                 if (!gui_scope) return;
 201                 switch (data) {
 202                         default: NOT_REACHED();
 203                         case SBI_SAVELOAD_START:  this->saving = true;  break;
 204                         case SBI_SAVELOAD_FINISH: this->saving = false; break;
 205                         case SBI_SHOW_TICKER:     this->ticker_scroll = 0; break;
 206                         case SBI_SHOW_REMINDER:   this->reminder_timeout.SetInterval(REMINDER_START); break;
 207                         case SBI_NEWS_DELETED:
 208                                 this->ticker_scroll    =   TICKER_STOP; // reset ticker ...
 209                                 this->reminder_timeout.SetInterval(REMINDER_STOP); // ... and reminder
 210                                 break;
 211                 }
 212         }
 213
 214         void OnClick(Point pt, int widget, int click_count) override
 215         {
 216                 switch (widget) {
 217                         case WID_S_MIDDLE: ShowLastNewsMessage(); break;
 218                         case WID_S_RIGHT:  if (_local_company != COMPANY_SPECTATOR) ShowCompanyFinances(_local_company); break;
 219                         default: ResetObjectToPlace();
 220                 }
 221         }
 222
 223         void OnRealtimeTick(uint delta_ms) override
 224         {
 225                 if (_pause_mode != PM_UNPAUSED) return;
 226
 227                 if (this->ticker_scroll < TICKER_STOP) { // Scrolling text
 228                         uint count = this->ticker_timer.CountElapsed(delta_ms);
 229                         if (count > 0) {
 230                                 this->ticker_scroll += count;
 231                                 this->SetWidgetDirty(WID_S_MIDDLE);
 232                         }
 233                 }
 234
 235                 // Red blot to show there are new unread newsmessages
 236                 if (this->reminder_timeout.Elapsed(delta_ms)) {
 237                         this->SetWidgetDirty(WID_S_MIDDLE);
 238                 }
 239         }
 240 };
 241
 242 static const NWidgetPart _nested_main_status_widgets[] = {
 243         NWidget(NWID_HORIZONTAL),
 244                 NWidget(WWT_PANEL, COLOUR_GREY, WID_S_LEFT), SetMinimalSize(140, 12), EndContainer(),
 245                 NWidget(WWT_PUSHBTN, COLOUR_GREY, WID_S_MIDDLE), SetMinimalSize(40, 12), SetDataTip(0x0, STR_STATUSBAR_TOOLTIP_SHOW_LAST_NEWS), SetResize(1, 0),
 246                 NWidget(WWT_PUSHBTN, COLOUR_GREY, WID_S_RIGHT), SetMinimalSize(140, 12),
 247         EndContainer(),
 248 };
 249
 250 static WindowDesc _main_status_desc(
 251         WDP_MANUAL, nullptr, 0, 0,
 252         WC_STATUS_BAR, WC_NONE,
 253         WDF_NO_FOCUS,
 254         _nested_main_status_widgets, lengthof(_nested_main_status_widgets)
 255 );
 256
 257 /**
 258  * Checks whether the news ticker is currently being used.
 259  */
 260 bool IsNewsTickerShown()
 261 {
 262         const StatusBarWindow *w = dynamic_cast<StatusBarWindow*>(FindWindowById(WC_STATUS_BAR, 0));
 263         return w != nullptr && w->ticker_scroll < StatusBarWindow::TICKER_STOP;
 264 }
 265
 266 /**
 267  * Show our status bar.
 268  */
 269 void ShowStatusBar()
 270 {
 271         new StatusBarWindow(&_main_status_desc);
 272 }