src/PopupMessage.cpp

   1 /*
   2
   3 Copyright_License {
   4
   5   XCSoar Glide Computer - http://www.xcsoar.org/
   6   Copyright (C) 2000-2012 The XCSoar Project
   7   A detailed list of copyright holders can be found in the file "AUTHORS".
   8
   9   This program is free software; you can redistribute it and/or
  10   modify it under the terms of the GNU General Public License
  11   as published by the Free Software Foundation; either version 2
  12   of the License, or (at your option) any later version.
  13
  14   This program is distributed in the hope that it will be useful,
  15   but WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17   GNU General Public License for more details.
  18
  19   You should have received a copy of the GNU General Public License
  20   along with this program; if not, write to the Free Software
  21   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  22 }
  23
  24 */
  25
  26 #include "PopupMessage.hpp"
  27 #include "Protection.hpp"
  28 #include "Screen/AnyCanvas.hpp"
  29 #include "Screen/Fonts.hpp"
  30 #include "Screen/SingleWindow.hpp"
  31 #include "Screen/Layout.hpp"
  32 #include "LocalPath.hpp"
  33 #include "Audio/Sound.hpp"
  34 #include "LogFile.hpp"
  35 #include "ComputerSettings.hpp"
  36 #include "Language/Language.hpp"
  37 #include "StatusMessage.hpp"
  38 #include "UISettings.hpp"
  39
  40 #include <tchar.h>
  41 #include <stdio.h>
  42 #include <algorithm>
  43
  44 using std::min;
  45 using std::max;
  46
  47 void
  48 PopupMessage::Message::Set(int _type, int _tshow, const TCHAR *_text, int now)
  49 {
  50   type = _type;
  51   tshow = _tshow;
  52   tstart = now;
  53   texpiry = now;
  54   text = _text;
  55 }
  56
  57 bool
  58 PopupMessage::Message::Update(int now)
  59 {
  60   if (IsUnknown())
  61     // ignore unknown messages
  62     return false;
  63
  64   if (IsNewlyExpired(now))
  65     // this message has expired for first time
  66     return true;
  67
  68   // new message has been added
  69   if (IsNew()) {
  70     // set new expiry time.
  71     texpiry = now + tshow;
  72     // this is a new message..
  73     return true;
  74   }
  75
  76   return false;
  77 }
  78
  79 bool
  80 PopupMessage::Message::AppendTo(TCHAR *buffer, int now)
  81 {
  82   if (IsUnknown())
  83     // ignore unknown messages
  84     return false;
  85
  86   if (texpiry < now) {
  87     texpiry = tstart - 1;
  88     // reset expiry so we don't refresh
  89     return false;
  90   }
  91
  92   if (buffer[0] != _T('\0'))
  93     _tcscat(buffer, _T("\r\n"));
  94   _tcscat(buffer, text);
  95   return true;
  96 }
  97
  98 PopupMessage::PopupMessage(const StatusMessageList &_status_messages,
  99                            SingleWindow &_parent, const UISettings &_settings)
 100   :status_messages(_status_messages),
 101    parent(_parent),
 102    settings(_settings),
 103    nvisible(0),
 104    enable_sound(true)
 105 {
 106   clock.Update();
 107 }
 108
 109 void
 110 PopupMessage::set(const PixelRect _rc)
 111 {
 112   rc = _rc;
 113
 114   EditWindowStyle style;
 115   style.Border();
 116   style.center();
 117   style.multiline();
 118   style.read_only();
 119   style.Hide();
 120
 121   EditWindow::set(parent, GetRect(100), style);
 122
 123   set_font(Fonts::map_bold);
 124   InstallWndProc();
 125 }
 126
 127 bool
 128 PopupMessage::OnMouseDown(PixelScalar x, PixelScalar y)
 129 {
 130   // acknowledge with click/touch
 131   Acknowledge(0);
 132
 133   return true;
 134 }
 135
 136 PixelRect
 137 PopupMessage::GetRect(UPixelScalar height) const
 138 {
 139   PixelRect rthis;
 140
 141   if (settings.popup_message_position == UISettings::smAlignTopLeft){
 142     rthis.top = 0;
 143     rthis.left = 0;
 144     rthis.bottom = height;
 145     rthis.right = Layout::FastScale(206);
 146     // TODO code: this shouldn't be hard-coded
 147   } else {
 148     PixelScalar width =// min((rc.right-rc.left)*0.8,tsize.cx);
 149       (PixelScalar)((rc.right - rc.left) * 0.9);
 150     PixelScalar midx = (rc.right + rc.left) / 2;
 151     PixelScalar midy = (rc.bottom + rc.top) / 2;
 152     PixelScalar h1 = height / 2;
 153     PixelScalar h2 = height - h1;
 154     rthis.left = midx-width/2;
 155     rthis.right = midx+width/2;
 156     rthis.top = midy-h1;
 157     rthis.bottom = midy+h2;
 158   }
 159
 160   return rthis;
 161 }
 162
 163 void
 164 PopupMessage::Resize()
 165 {
 166   if (*msgText == _T('\0')) {
 167     hide();
 168   } else {
 169     set_text(msgText);
 170
 171     AnyCanvas canvas;
 172     canvas.Select(Fonts::map_bold);
 173     PixelSize tsize = canvas.CalcTextSize(msgText);
 174
 175     int linecount = max((unsigned)nvisible, max((unsigned)1, get_row_count()));
 176
 177     PixelScalar height = min((PixelScalar)((rc.bottom-rc.top) * 0.8),
 178                              (PixelScalar)(tsize.cy * (linecount + 1)));
 179
 180     PixelRect rthis = GetRect(height);
 181 #ifdef USE_GDI
 182     PixelRect old_rc = get_position();
 183     if (rthis.left != old_rc.left || rthis.right != old_rc.right) {
 184       /* on Windows, the TEXT control can never change its text style
 185          after it has been created, so we have to destroy it and
 186          create a new one */
 187       reset();
 188       set(rc);
 189       set_text(msgText);
 190     }
 191 #endif
 192
 193     move(rthis.left, rthis.top,
 194          rthis.right - rthis.left,
 195          rthis.bottom - rthis.top);
 196     show_on_top();
 197   }
 198 }
 199
 200 bool
 201 PopupMessage::Render()
 202 {
 203   if (!globalRunningEvent.Test())
 204     return false;
 205
 206   mutex.Lock();
 207   if (parent.HasDialog()) {
 208     mutex.Unlock();
 209     return false;
 210   }
 211
 212   int fpsTime = clock.Elapsed();
 213
 214   // this has to be done quickly, since it happens in GUI thread
 215   // at subsecond interval
 216
 217   // first loop through all messages, and determine which should be
 218   // made invisible that were previously visible, or
 219   // new messages
 220
 221   bool changed = false;
 222   for (unsigned i = 0; i < MAXMESSAGES; ++i)
 223     changed = messages[i].Update(fpsTime) || changed;
 224
 225   static bool doresize = false;
 226
 227   if (!changed) {
 228     mutex.Unlock();
 229
 230     if (doresize) {
 231       doresize = false;
 232       // do one extra resize after display so we are sure we get all
 233       // the text (workaround bug in getlinecount)
 234       Resize();
 235     }
 236     return false;
 237   }
 238
 239   // ok, we've changed the visible messages, so need to regenerate the
 240   // text box
 241
 242   doresize = true;
 243   msgText[0] = _T('\0');
 244   nvisible = 0;
 245   for (unsigned i = 0; i < MAXMESSAGES; ++i)
 246     if (messages[i].AppendTo(msgText, fpsTime))
 247       nvisible++;
 248
 249   mutex.Unlock();
 250
 251   Resize();
 252
 253   return true;
 254 }
 255
 256 int
 257 PopupMessage::GetEmptySlot()
 258 {
 259   // find oldest message that is no longer visible
 260
 261   // todo: make this more robust with respect to message types and if can't
 262   // find anything to remove..
 263   int i;
 264   int tmin = 0;
 265   int imin = 0;
 266   for (i = 0; i < MAXMESSAGES; i++) {
 267     if (i == 0 || messages[i].tstart < tmin) {
 268       tmin = messages[i].tstart;
 269       imin = i;
 270     }
 271   }
 272   return imin;
 273 }
 274
 275 void
 276 PopupMessage::AddMessage(int tshow, int type, const TCHAR *Text)
 277 {
 278   int i;
 279   int fpsTime = clock.Elapsed();
 280   i = GetEmptySlot();
 281
 282   messages[i].Set(type, tshow, Text, fpsTime);
 283 }
 284
 285 void
 286 PopupMessage::Repeat(int type)
 287 {
 288   int i;
 289   int tmax = 0;
 290   int imax = -1;
 291
 292   mutex.Lock();
 293
 294   int fpsTime = clock.Elapsed();
 295
 296   // find most recent non-visible message
 297
 298   for (i = 0; i < MAXMESSAGES; i++) {
 299     if (messages[i].texpiry < fpsTime &&
 300         messages[i].tstart > tmax &&
 301         (messages[i].type == type || type == 0)) {
 302       imax = i;
 303       tmax = messages[i].tstart;
 304     }
 305   }
 306
 307   if (imax >= 0) {
 308     messages[imax].tstart = fpsTime;
 309     messages[imax].texpiry = messages[imax].tstart;
 310   }
 311
 312   mutex.Unlock();
 313 }
 314
 315 bool
 316 PopupMessage::Acknowledge(int type)
 317 {
 318   ScopeLock protect(mutex);
 319   int i;
 320   int fpsTime = clock.Elapsed();
 321
 322   for (i = 0; i < MAXMESSAGES; i++) {
 323     if (messages[i].texpiry > messages[i].tstart &&
 324         (type == 0 || type == messages[i].type)) {
 325       // message was previously visible, so make it expire now.
 326       messages[i].texpiry = fpsTime - 1;
 327       return true;
 328     }
 329   }
 330   return false;
 331 }
 332
 333 // DoMessage is designed to delegate what to do for a message
 334 // The "what to do" can be defined in a configuration file
 335 // Defaults for each message include:
 336 //      - Text to display (including multiple languages)
 337 //      - Text to display extra - NOT multiple language
 338 //              (eg: If Airspace Warning - what details - airfield name is in data file, already
 339 //              covers multiple languages).
 340 //      - ShowStatusMessage - including font size and delay
 341 //      - Sound to play - What sound to play
 342 //      - Log - Keep the message on the log/history window (goes to log file and history)
 343 //
 344 // TODO code: (need to discuss) Consider moving almost all this functionality into AddMessage ?
 345
 346 void
 347 PopupMessage::AddMessage(const TCHAR* text, const TCHAR *data)
 348 {
 349   ScopeLock protect(mutex);
 350
 351   StatusMessageSTRUCT LocalMessage = status_messages.First();
 352   const StatusMessageSTRUCT *found = status_messages.Find(text);
 353   if (found != NULL)
 354     LocalMessage = *found;
 355
 356   if (enable_sound && LocalMessage.doSound)
 357     PlayResource(LocalMessage.sound);
 358
 359   // TODO code: consider what is a sensible size?
 360   TCHAR msgcache[1024];
 361   if (LocalMessage.doStatus) {
 362
 363     _tcscpy(msgcache, text);
 364     if (data != NULL) {
 365       _tcscat(msgcache, _T(" "));
 366       _tcscat(msgcache, data);
 367     }
 368
 369     AddMessage(LocalMessage.delay_ms, MSG_USERINTERFACE, msgcache);
 370   }
 371 }