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