src/common/appcmn.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/common/appcmn.cpp
   3 // Purpose:     wxAppBase methods common to all platforms
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     18.10.99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Vadim Zeitlin
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ---------------------------------------------------------------------------
  17 // headers
  18 // ---------------------------------------------------------------------------
  19
  20 // For compilers that support precompilation, includes "wx.h".
  21 #include "wx/wxprec.h"
  22
  23 #if defined(__BORLANDC__)
  24     #pragma hdrstop
  25 #endif
  26
  27 #ifndef WX_PRECOMP
  28     #include "wx/app.h"
  29     #include "wx/window.h"
  30     #include "wx/bitmap.h"
  31     #include "wx/log.h"
  32     #include "wx/msgdlg.h"
  33     #include "wx/confbase.h"
  34     #include "wx/utils.h"
  35     #include "wx/wxcrtvararg.h"
  36 #endif
  37
  38 #include "wx/apptrait.h"
  39 #include "wx/cmdline.h"
  40 #include "wx/msgout.h"
  41 #include "wx/thread.h"
  42 #include "wx/vidmode.h"
  43 #include "wx/evtloop.h"
  44
  45 #if wxUSE_FONTMAP
  46     #include "wx/fontmap.h"
  47 #endif // wxUSE_FONTMAP
  48
  49 // DLL options compatibility check:
  50 #include "wx/build.h"
  51 WX_CHECK_BUILD_OPTIONS("wxCore")
  52
  53 // ============================================================================
  54 // wxAppBase implementation
  55 // ============================================================================
  56
  57 // ----------------------------------------------------------------------------
  58 // initialization
  59 // ----------------------------------------------------------------------------
  60
  61 wxAppBase::wxAppBase()
  62 {
  63     m_topWindow = NULL;
  64
  65     m_useBestVisual = false;
  66     m_forceTrueColour = false;
  67
  68     m_isActive = true;
  69
  70     // We don't want to exit the app if the user code shows a dialog from its
  71     // OnInit() -- but this is what would happen if we set m_exitOnFrameDelete
  72     // to Yes initially as this dialog would be the last top level window.
  73     // OTOH, if we set it to No initially we'll have to overwrite it with Yes
  74     // when we enter our OnRun() because we do want the default behaviour from
  75     // then on. But this would be a problem if the user code calls
  76     // SetExitOnFrameDelete(false) from OnInit().
  77     //
  78     // So we use the special "Later" value which is such that
  79     // GetExitOnFrameDelete() returns false for it but which we know we can
  80     // safely (i.e. without losing the effect of the users SetExitOnFrameDelete
  81     // call) overwrite in OnRun()
  82     m_exitOnFrameDelete = Later;
  83 }
  84
  85 bool wxAppBase::Initialize(int& argcOrig, wxChar **argvOrig)
  86 {
  87     if ( !wxAppConsole::Initialize(argcOrig, argvOrig) )
  88         return false;
  89
  90     wxInitializeStockLists();
  91
  92     wxBitmap::InitStandardHandlers();
  93
  94     // for compatibility call the old initialization function too
  95     if ( !OnInitGui() )
  96         return false;
  97
  98     return true;
  99 }
 100
 101 // ----------------------------------------------------------------------------
 102 // cleanup
 103 // ----------------------------------------------------------------------------
 104
 105 wxAppBase::~wxAppBase()
 106 {
 107     // this destructor is required for Darwin
 108 }
 109
 110 void wxAppBase::CleanUp()
 111 {
 112     // clean up all the pending objects
 113     DeletePendingObjects();
 114
 115     // and any remaining TLWs (they remove themselves from wxTopLevelWindows
 116     // when destroyed, so iterate until none are left)
 117     while ( !wxTopLevelWindows.empty() )
 118     {
 119         // do not use Destroy() here as it only puts the TLW in pending list
 120         // but we want to delete them now
 121         delete wxTopLevelWindows.GetFirst()->GetData();
 122     }
 123
 124     // undo everything we did in Initialize() above
 125     wxBitmap::CleanUpHandlers();
 126
 127     wxStockGDI::DeleteAll();
 128
 129     wxDeleteStockLists();
 130
 131     wxDELETE(wxTheColourDatabase);
 132
 133     wxAppConsole::CleanUp();
 134 }
 135
 136 // ----------------------------------------------------------------------------
 137 // various accessors
 138 // ----------------------------------------------------------------------------
 139
 140 wxWindow* wxAppBase::GetTopWindow() const
 141 {
 142     wxWindow* window = m_topWindow;
 143     if (window == NULL && wxTopLevelWindows.GetCount() > 0)
 144         window = wxTopLevelWindows.GetFirst()->GetData();
 145     return window;
 146 }
 147
 148 wxVideoMode wxAppBase::GetDisplayMode() const
 149 {
 150     return wxVideoMode();
 151 }
 152
 153 wxLayoutDirection wxAppBase::GetLayoutDirection() const
 154 {
 155 #if wxUSE_INTL
 156     const wxLocale *const locale = wxGetLocale();
 157     if ( locale )
 158     {
 159         const wxLanguageInfo *const
 160             info = wxLocale::GetLanguageInfo(locale->GetLanguage());
 161
 162         if ( info )
 163             return info->LayoutDirection;
 164     }
 165 #endif // wxUSE_INTL
 166
 167     // we don't know
 168     return wxLayout_Default;
 169 }
 170
 171 #if wxUSE_CMDLINE_PARSER
 172
 173 // ----------------------------------------------------------------------------
 174 // GUI-specific command line options handling
 175 // ----------------------------------------------------------------------------
 176
 177 #define OPTION_THEME   "theme"
 178 #define OPTION_MODE    "mode"
 179
 180 void wxAppBase::OnInitCmdLine(wxCmdLineParser& parser)
 181 {
 182     // first add the standard non GUI options
 183     wxAppConsole::OnInitCmdLine(parser);
 184
 185     // the standard command line options
 186     static const wxCmdLineEntryDesc cmdLineGUIDesc[] =
 187     {
 188 #ifdef __WXUNIVERSAL__
 189         {
 190             wxCMD_LINE_OPTION,
 191             NULL,
 192             OPTION_THEME,
 193             gettext_noop("specify the theme to use"),
 194             wxCMD_LINE_VAL_STRING,
 195             0x0
 196         },
 197 #endif // __WXUNIVERSAL__
 198
 199 #if defined(__WXMGL__)
 200         // VS: this is not specific to wxMGL, all fullscreen (framebuffer) ports
 201         //     should provide this option. That's why it is in common/appcmn.cpp
 202         //     and not mgl/app.cpp
 203         {
 204             wxCMD_LINE_OPTION,
 205             NULL,
 206             OPTION_MODE,
 207             gettext_noop("specify display mode to use (e.g. 640x480-16)"),
 208             wxCMD_LINE_VAL_STRING,
 209             0x0
 210         },
 211 #endif // __WXMGL__
 212
 213         // terminator
 214         wxCMD_LINE_DESC_END
 215     };
 216
 217     parser.SetDesc(cmdLineGUIDesc);
 218 }
 219
 220 bool wxAppBase::OnCmdLineParsed(wxCmdLineParser& parser)
 221 {
 222 #ifdef __WXUNIVERSAL__
 223     wxString themeName;
 224     if ( parser.Found(OPTION_THEME, &themeName) )
 225     {
 226         wxTheme *theme = wxTheme::Create(themeName);
 227         if ( !theme )
 228         {
 229             wxLogError(_("Unsupported theme '%s'."), themeName.c_str());
 230             return false;
 231         }
 232
 233         // Delete the defaultly created theme and set the new theme.
 234         delete wxTheme::Get();
 235         wxTheme::Set(theme);
 236     }
 237 #endif // __WXUNIVERSAL__
 238
 239 #if defined(__WXMGL__)
 240     wxString modeDesc;
 241     if ( parser.Found(OPTION_MODE, &modeDesc) )
 242     {
 243         unsigned w, h, bpp;
 244         if ( wxSscanf(modeDesc.c_str(), wxT("%ux%u-%u"), &w, &h, &bpp) != 3 )
 245         {
 246             wxLogError(_("Invalid display mode specification '%s'."), modeDesc.c_str());
 247             return false;
 248         }
 249
 250         if ( !SetDisplayMode(wxVideoMode(w, h, bpp)) )
 251             return false;
 252     }
 253 #endif // __WXMGL__
 254
 255     return wxAppConsole::OnCmdLineParsed(parser);
 256 }
 257
 258 #endif // wxUSE_CMDLINE_PARSER
 259
 260 // ----------------------------------------------------------------------------
 261 // OnXXX() hooks
 262 // ----------------------------------------------------------------------------
 263
 264 bool wxAppBase::OnInitGui()
 265 {
 266 #ifdef __WXUNIVERSAL__
 267     if ( !wxTheme::Get() && !wxTheme::CreateDefault() )
 268         return false;
 269 #endif // __WXUNIVERSAL__
 270
 271     return true;
 272 }
 273
 274 int wxAppBase::OnRun()
 275 {
 276     // see the comment in ctor: if the initial value hasn't been changed, use
 277     // the default Yes from now on
 278     if ( m_exitOnFrameDelete == Later )
 279     {
 280         m_exitOnFrameDelete = Yes;
 281     }
 282     //else: it has been changed, assume the user knows what he is doing
 283
 284     return wxAppConsole::OnRun();
 285 }
 286
 287 int wxAppBase::OnExit()
 288 {
 289 #ifdef __WXUNIVERSAL__
 290     delete wxTheme::Set(NULL);
 291 #endif // __WXUNIVERSAL__
 292
 293     return wxAppConsole::OnExit();
 294 }
 295
 296 wxAppTraits *wxAppBase::CreateTraits()
 297 {
 298     return new wxGUIAppTraits;
 299 }
 300
 301 // ----------------------------------------------------------------------------
 302 // misc
 303 // ----------------------------------------------------------------------------
 304
 305 void wxAppBase::SetActive(bool active, wxWindow * WXUNUSED(lastFocus))
 306 {
 307     if ( active == m_isActive )
 308         return;
 309
 310     m_isActive = active;
 311
 312     wxActivateEvent event(wxEVT_ACTIVATE_APP, active);
 313     event.SetEventObject(this);
 314
 315     (void)ProcessEvent(event);
 316 }
 317
 318 bool wxAppBase::SafeYield(wxWindow *win, bool onlyIfNeeded)
 319 {
 320     wxWindowDisabler wd(win);
 321
 322     wxEventLoopBase * const loop = wxEventLoopBase::GetActive();
 323
 324     return loop && loop->Yield(onlyIfNeeded);
 325 }
 326
 327 bool wxAppBase::SafeYieldFor(wxWindow *win, long eventsToProcess)
 328 {
 329     wxWindowDisabler wd(win);
 330
 331     wxEventLoopBase * const loop = wxEventLoopBase::GetActive();
 332
 333     return loop && loop->YieldFor(eventsToProcess);
 334 }
 335
 336
 337 // ----------------------------------------------------------------------------
 338 // idle handling
 339 // ----------------------------------------------------------------------------
 340
 341 // Returns true if more time is needed.
 342 bool wxAppBase::ProcessIdle()
 343 {
 344     // call the base class version first to send the idle event to wxTheApp
 345     // itself
 346     bool needMore = wxAppConsoleBase::ProcessIdle();
 347     wxIdleEvent event;
 348     wxWindowList::compatibility_iterator node = wxTopLevelWindows.GetFirst();
 349     while (node)
 350     {
 351         wxWindow* win = node->GetData();
 352         if (SendIdleEvents(win, event))
 353             needMore = true;
 354         node = node->GetNext();
 355     }
 356
 357     wxUpdateUIEvent::ResetUpdateTime();
 358
 359     return needMore;
 360 }
 361
 362 // Send idle event to window and all subwindows
 363 bool wxAppBase::SendIdleEvents(wxWindow* win, wxIdleEvent& event)
 364 {
 365     bool needMore = false;
 366
 367     win->OnInternalIdle();
 368
 369     // should we send idle event to this window?
 370     if ( wxIdleEvent::GetMode() == wxIDLE_PROCESS_ALL ||
 371             win->HasExtraStyle(wxWS_EX_PROCESS_IDLE) )
 372     {
 373         event.SetEventObject(win);
 374         win->HandleWindowEvent(event);
 375
 376         if (event.MoreRequested())
 377             needMore = true;
 378     }
 379     wxWindowList::compatibility_iterator node = win->GetChildren().GetFirst();
 380     while ( node )
 381     {
 382         wxWindow *child = node->GetData();
 383         if (SendIdleEvents(child, event))
 384             needMore = true;
 385
 386         node = node->GetNext();
 387     }
 388
 389     return needMore;
 390 }
 391
 392 // ----------------------------------------------------------------------------
 393 // wxGUIAppTraitsBase
 394 // ----------------------------------------------------------------------------
 395
 396 #if wxUSE_LOG
 397
 398 wxLog *wxGUIAppTraitsBase::CreateLogTarget()
 399 {
 400 #if wxUSE_LOGGUI
 401 #ifndef __WXOSX_IPHONE__
 402     return new wxLogGui;
 403 #else
 404     return new wxLogStderr;
 405 #endif
 406 #else
 407     // we must have something!
 408     return new wxLogStderr;
 409 #endif
 410 }
 411
 412 #endif // wxUSE_LOG
 413
 414 wxMessageOutput *wxGUIAppTraitsBase::CreateMessageOutput()
 415 {
 416     // The standard way of printing help on command line arguments (app --help)
 417     // is (according to common practice):
 418     //     - console apps: to stderr (on any platform)
 419     //     - GUI apps: stderr on Unix platforms (!)
 420     //                 stderr if available and message box otherwise on others
 421     //                 (currently stderr only Windows if app running from console)
 422 #ifdef __UNIX__
 423     return new wxMessageOutputStderr;
 424 #else // !__UNIX__
 425     // wxMessageOutputMessageBox doesn't work under Motif
 426     #ifdef __WXMOTIF__
 427         return new wxMessageOutputLog;
 428     #elif wxUSE_MSGDLG
 429         return new wxMessageOutputBest(wxMSGOUT_PREFER_STDERR);
 430     #else
 431         return new wxMessageOutputStderr;
 432     #endif
 433 #endif // __UNIX__/!__UNIX__
 434 }
 435
 436 #if wxUSE_FONTMAP
 437
 438 wxFontMapper *wxGUIAppTraitsBase::CreateFontMapper()
 439 {
 440     return new wxFontMapper;
 441 }
 442
 443 #endif // wxUSE_FONTMAP
 444
 445 wxRendererNative *wxGUIAppTraitsBase::CreateRenderer()
 446 {
 447     // use the default native renderer by default
 448     return NULL;
 449 }
 450
 451 bool wxGUIAppTraitsBase::ShowAssertDialog(const wxString& msg)
 452 {
 453 #if wxDEBUG_LEVEL
 454     // under MSW we prefer to use the base class version using ::MessageBox()
 455     // even if wxMessageBox() is available because it has less chances to
 456     // double fault our app than our wxMessageBox()
 457     //
 458     // under DFB the message dialog is not always functional right now
 459     //
 460     // and finally we can't use wxMessageBox() if it wasn't compiled in, of
 461     // course
 462 #if !defined(__WXMSW__) && !defined(__WXDFB__) && wxUSE_MSGDLG
 463
 464     // we can't (safely) show the GUI dialog from another thread, only do it
 465     // for the asserts in the main thread
 466     if ( wxIsMainThread() )
 467     {
 468         wxString msgDlg = msg;
 469
 470 #if wxUSE_STACKWALKER
 471         const wxString stackTrace = GetAssertStackTrace();
 472         if ( !stackTrace.empty() )
 473             msgDlg << wxT("\n\nCall stack:\n") << stackTrace;
 474 #endif // wxUSE_STACKWALKER
 475
 476         // this message is intentionally not translated -- it is for
 477         // developpers only
 478         msgDlg += wxT("\nDo you want to stop the program?\n")
 479                   wxT("You can also choose [Cancel] to suppress ")
 480                   wxT("further warnings.");
 481
 482         switch ( wxMessageBox(msgDlg, wxT("wxWidgets Debug Alert"),
 483                               wxYES_NO | wxCANCEL | wxICON_STOP ) )
 484         {
 485             case wxYES:
 486                 wxTrap();
 487                 break;
 488
 489             case wxCANCEL:
 490                 // no more asserts
 491                 return true;
 492
 493             //case wxNO: nothing to do
 494         }
 495
 496         return false;
 497     }
 498 #endif // wxUSE_MSGDLG
 499 #endif // wxDEBUG_LEVEL
 500
 501     return wxAppTraitsBase::ShowAssertDialog(msg);
 502 }
 503
 504 bool wxGUIAppTraitsBase::HasStderr()
 505 {
 506     // we consider that under Unix stderr always goes somewhere, even if the
 507     // user doesn't always see it under GUI desktops
 508 #ifdef __UNIX__
 509     return true;
 510 #else
 511     return false;
 512 #endif
 513 }
 514