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