src/common/appcmn.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/common/appcmn.cpp
   3 // Purpose:     wxAppConsole and 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/list.h"
  29     #include "wx/app.h"
  30     #include "wx/bitmap.h"
  31     #include "wx/intl.h"
  32     #include "wx/log.h"
  33     #include "wx/msgdlg.h"
  34     #include "wx/confbase.h"
  35     #include "wx/utils.h"
  36 #endif
  37
  38 #include "wx/apptrait.h"
  39 #include "wx/cmdline.h"
  40 #include "wx/evtloop.h"
  41 #include "wx/msgout.h"
  42 #include "wx/thread.h"
  43 #include "wx/ptr_scpd.h"
  44
  45 #if defined(__WXMSW__)
  46     #include  "wx/msw/private.h"  // includes windows.h for LOGFONT
  47 #endif
  48
  49 #if wxUSE_FONTMAP
  50     #include "wx/fontmap.h"
  51 #endif // wxUSE_FONTMAP
  52
  53 // DLL options compatibility check:
  54 #include "wx/build.h"
  55 WX_CHECK_BUILD_OPTIONS("wxCore")
  56
  57 WXDLLIMPEXP_DATA_CORE(wxList) wxPendingDelete;
  58
  59 // ----------------------------------------------------------------------------
  60 // wxEventLoopPtr
  61 // ----------------------------------------------------------------------------
  62
  63 // this defines wxEventLoopPtr
  64 wxDEFINE_TIED_SCOPED_PTR_TYPE(wxEventLoop)
  65
  66 // ============================================================================
  67 // wxAppBase implementation
  68 // ============================================================================
  69
  70 // ----------------------------------------------------------------------------
  71 // initialization
  72 // ----------------------------------------------------------------------------
  73
  74 wxAppBase::wxAppBase()
  75 {
  76     m_topWindow = (wxWindow *)NULL;
  77     m_useBestVisual = false;
  78     m_isActive = true;
  79
  80     m_mainLoop = NULL;
  81
  82     // We don't want to exit the app if the user code shows a dialog from its
  83     // OnInit() -- but this is what would happen if we set m_exitOnFrameDelete
  84     // to Yes initially as this dialog would be the last top level window.
  85     // OTOH, if we set it to No initially we'll have to overwrite it with Yes
  86     // when we enter our OnRun() because we do want the default behaviour from
  87     // then on. But this would be a problem if the user code calls
  88     // SetExitOnFrameDelete(false) from OnInit().
  89     //
  90     // So we use the special "Later" value which is such that
  91     // GetExitOnFrameDelete() returns false for it but which we know we can
  92     // safely (i.e. without losing the effect of the users SetExitOnFrameDelete
  93     // call) overwrite in OnRun()
  94     m_exitOnFrameDelete = Later;
  95 }
  96
  97 bool wxAppBase::Initialize(int& argcOrig, wxChar **argvOrig)
  98 {
  99     if ( !wxAppConsole::Initialize(argcOrig, argvOrig) )
 100         return false;
 101
 102 #if wxUSE_THREADS
 103     wxPendingEventsLocker = new wxCriticalSection;
 104 #endif
 105
 106     wxInitializeStockLists();
 107
 108     wxBitmap::InitStandardHandlers();
 109
 110     return true;
 111 }
 112
 113 // ----------------------------------------------------------------------------
 114 // cleanup
 115 // ----------------------------------------------------------------------------
 116
 117 wxAppBase::~wxAppBase()
 118 {
 119     // this destructor is required for Darwin
 120 }
 121
 122 void wxAppBase::CleanUp()
 123 {
 124     // clean up all the pending objects
 125     DeletePendingObjects();
 126
 127     // and any remaining TLWs (they remove themselves from wxTopLevelWindows
 128     // when destroyed, so iterate until none are left)
 129     while ( !wxTopLevelWindows.empty() )
 130     {
 131         // do not use Destroy() here as it only puts the TLW in pending list
 132         // but we want to delete them now
 133         delete wxTopLevelWindows.GetFirst()->GetData();
 134     }
 135
 136     // undo everything we did in Initialize() above
 137     wxBitmap::CleanUpHandlers();
 138
 139     wxStockGDI::DeleteAll();
 140
 141     wxDeleteStockLists();
 142
 143     delete wxTheColourDatabase;
 144     wxTheColourDatabase = NULL;
 145
 146     delete wxPendingEvents;
 147     wxPendingEvents = NULL;
 148
 149 #if wxUSE_THREADS
 150     delete wxPendingEventsLocker;
 151     wxPendingEventsLocker = NULL;
 152
 153     #if wxUSE_VALIDATORS
 154         // If we don't do the following, we get an apparent memory leak.
 155         ((wxEvtHandler&) wxDefaultValidator).ClearEventLocker();
 156     #endif // wxUSE_VALIDATORS
 157 #endif // wxUSE_THREADS
 158 }
 159
 160 #if wxUSE_CMDLINE_PARSER
 161
 162 // ----------------------------------------------------------------------------
 163 // GUI-specific command line options handling
 164 // ----------------------------------------------------------------------------
 165
 166 #define OPTION_THEME   _T("theme")
 167 #define OPTION_MODE    _T("mode")
 168
 169 void wxAppBase::OnInitCmdLine(wxCmdLineParser& parser)
 170 {
 171     // first add the standard non GUI options
 172     wxAppConsole::OnInitCmdLine(parser);
 173
 174     // the standard command line options
 175     static const wxCmdLineEntryDesc cmdLineGUIDesc[] =
 176     {
 177 #ifdef __WXUNIVERSAL__
 178         {
 179             wxCMD_LINE_OPTION,
 180             wxEmptyString,
 181             OPTION_THEME,
 182             gettext_noop("specify the theme to use"),
 183             wxCMD_LINE_VAL_STRING,
 184             0x0
 185         },
 186 #endif // __WXUNIVERSAL__
 187
 188 #if defined(__WXMGL__)
 189         // VS: this is not specific to wxMGL, all fullscreen (framebuffer) ports
 190         //     should provide this option. That's why it is in common/appcmn.cpp
 191         //     and not mgl/app.cpp
 192         {
 193             wxCMD_LINE_OPTION,
 194             wxEmptyString,
 195             OPTION_MODE,
 196             gettext_noop("specify display mode to use (e.g. 640x480-16)"),
 197             wxCMD_LINE_VAL_STRING,
 198             0x0
 199         },
 200 #endif // __WXMGL__
 201
 202         // terminator
 203         {
 204             wxCMD_LINE_NONE,
 205             wxEmptyString,
 206             wxEmptyString,
 207             wxEmptyString,
 208             wxCMD_LINE_VAL_NONE,
 209             0x0
 210         }
 211     };
 212
 213     parser.SetDesc(cmdLineGUIDesc);
 214 }
 215
 216 bool wxAppBase::OnCmdLineParsed(wxCmdLineParser& parser)
 217 {
 218 #ifdef __WXUNIVERSAL__
 219     wxString themeName;
 220     if ( parser.Found(OPTION_THEME, &themeName) )
 221     {
 222         wxTheme *theme = wxTheme::Create(themeName);
 223         if ( !theme )
 224         {
 225             wxLogError(_("Unsupported theme '%s'."), themeName.c_str());
 226             return false;
 227         }
 228
 229         // Delete the defaultly created theme and set the new theme.
 230         delete wxTheme::Get();
 231         wxTheme::Set(theme);
 232     }
 233 #endif // __WXUNIVERSAL__
 234
 235 #if defined(__WXMGL__)
 236     wxString modeDesc;
 237     if ( parser.Found(OPTION_MODE, &modeDesc) )
 238     {
 239         unsigned w, h, bpp;
 240         if ( wxSscanf(modeDesc.c_str(), _T("%ux%u-%u"), &w, &h, &bpp) != 3 )
 241         {
 242             wxLogError(_("Invalid display mode specification '%s'."), modeDesc.c_str());
 243             return false;
 244         }
 245
 246         if ( !SetDisplayMode(wxVideoMode(w, h, bpp)) )
 247             return false;
 248     }
 249 #endif // __WXMGL__
 250
 251     return wxAppConsole::OnCmdLineParsed(parser);
 252 }
 253
 254 #endif // wxUSE_CMDLINE_PARSER
 255
 256 // ----------------------------------------------------------------------------
 257 // main event loop implementation
 258 // ----------------------------------------------------------------------------
 259
 260 int wxAppBase::MainLoop()
 261 {
 262     wxEventLoopTiedPtr mainLoop(&m_mainLoop, new wxEventLoop);
 263
 264     return m_mainLoop->Run();
 265 }
 266
 267 void wxAppBase::ExitMainLoop()
 268 {
 269     // we should exit from the main event loop, not just any currently active
 270     // (e.g. modal dialog) event loop
 271     if ( m_mainLoop && m_mainLoop->IsRunning() )
 272     {
 273         m_mainLoop->Exit(0);
 274     }
 275 }
 276
 277 bool wxAppBase::Pending()
 278 {
 279     // use the currently active message loop here, not m_mainLoop, because if
 280     // we're showing a modal dialog (with its own event loop) currently the
 281     // main event loop is not running anyhow
 282     wxEventLoop * const loop = wxEventLoop::GetActive();
 283
 284     return loop && loop->Pending();
 285 }
 286
 287 bool wxAppBase::Dispatch()
 288 {
 289     // see comment in Pending()
 290     wxEventLoop * const loop = wxEventLoop::GetActive();
 291
 292     return loop && loop->Dispatch();
 293 }
 294
 295 // ----------------------------------------------------------------------------
 296 // OnXXX() hooks
 297 // ----------------------------------------------------------------------------
 298
 299 bool wxAppBase::OnInitGui()
 300 {
 301 #ifdef __WXUNIVERSAL__
 302     if ( !wxTheme::Get() && !wxTheme::CreateDefault() )
 303         return false;
 304 #endif // __WXUNIVERSAL__
 305
 306     return true;
 307 }
 308
 309 int wxAppBase::OnRun()
 310 {
 311     // see the comment in ctor: if the initial value hasn't been changed, use
 312     // the default Yes from now on
 313     if ( m_exitOnFrameDelete == Later )
 314     {
 315         m_exitOnFrameDelete = Yes;
 316     }
 317     //else: it has been changed, assume the user knows what he is doing
 318
 319     return MainLoop();
 320 }
 321
 322 int wxAppBase::OnExit()
 323 {
 324 #ifdef __WXUNIVERSAL__
 325     delete wxTheme::Set(NULL);
 326 #endif // __WXUNIVERSAL__
 327
 328     return wxAppConsole::OnExit();
 329 }
 330
 331 void wxAppBase::Exit()
 332 {
 333     ExitMainLoop();
 334 }
 335
 336 wxAppTraits *wxAppBase::CreateTraits()
 337 {
 338     return new wxGUIAppTraits;
 339 }
 340
 341 // ----------------------------------------------------------------------------
 342 // misc
 343 // ----------------------------------------------------------------------------
 344
 345 void wxAppBase::SetActive(bool active, wxWindow * WXUNUSED(lastFocus))
 346 {
 347     if ( active == m_isActive )
 348         return;
 349
 350     m_isActive = active;
 351
 352     wxActivateEvent event(wxEVT_ACTIVATE_APP, active);
 353     event.SetEventObject(this);
 354
 355     (void)ProcessEvent(event);
 356 }
 357
 358 // ----------------------------------------------------------------------------
 359 // idle handling
 360 // ----------------------------------------------------------------------------
 361
 362 void wxAppBase::DeletePendingObjects()
 363 {
 364     wxList::compatibility_iterator node = wxPendingDelete.GetFirst();
 365     while (node)
 366     {
 367         wxObject *obj = node->GetData();
 368
 369         // remove it from the list first so that if we get back here somehow
 370         // during the object deletion (e.g. wxYield called from its dtor) we
 371         // wouldn't try to delete it the second time
 372         if ( wxPendingDelete.Member(obj) )
 373             wxPendingDelete.Erase(node);
 374
 375         delete obj;
 376
 377         // Deleting one object may have deleted other pending
 378         // objects, so start from beginning of list again.
 379         node = wxPendingDelete.GetFirst();
 380     }
 381 }
 382
 383 // Returns true if more time is needed.
 384 bool wxAppBase::ProcessIdle()
 385 {
 386     wxIdleEvent event;
 387     bool needMore = false;
 388     wxWindowList::compatibility_iterator node = wxTopLevelWindows.GetFirst();
 389     while (node)
 390     {
 391         wxWindow* win = node->GetData();
 392         if (SendIdleEvents(win, event))
 393             needMore = true;
 394         node = node->GetNext();
 395     }
 396
 397     event.SetEventObject(this);
 398     (void) ProcessEvent(event);
 399     if (event.MoreRequested())
 400         needMore = true;
 401
 402     wxUpdateUIEvent::ResetUpdateTime();
 403
 404     return needMore;
 405 }
 406
 407 // Send idle event to window and all subwindows
 408 bool wxAppBase::SendIdleEvents(wxWindow* win, wxIdleEvent& event)
 409 {
 410     bool needMore = false;
 411
 412     win->OnInternalIdle();
 413
 414     if (wxIdleEvent::CanSend(win))
 415     {
 416         event.SetEventObject(win);
 417         win->GetEventHandler()->ProcessEvent(event);
 418
 419         if (event.MoreRequested())
 420             needMore = true;
 421     }
 422     wxWindowList::compatibility_iterator node = win->GetChildren().GetFirst();
 423     while ( node )
 424     {
 425         wxWindow *child = node->GetData();
 426         if (SendIdleEvents(child, event))
 427             needMore = true;
 428
 429         node = node->GetNext();
 430     }
 431
 432     return needMore;
 433 }
 434
 435 void wxAppBase::OnIdle(wxIdleEvent& WXUNUSED(event))
 436 {
 437     // If there are pending events, we must process them: pending events
 438     // are either events to the threads other than main or events posted
 439     // with wxPostEvent() functions
 440     // GRG: I have moved this here so that all pending events are processed
 441     //   before starting to delete any objects. This behaves better (in
 442     //   particular, wrt wxPostEvent) and is coherent with wxGTK's current
 443     //   behaviour. Changed Feb/2000 before 2.1.14
 444     ProcessPendingEvents();
 445
 446     // 'Garbage' collection of windows deleted with Close().
 447     DeletePendingObjects();
 448
 449 #if wxUSE_LOG
 450     // flush the logged messages if any
 451     wxLog::FlushActive();
 452 #endif // wxUSE_LOG
 453
 454 }
 455
 456 // ----------------------------------------------------------------------------
 457 // exceptions support
 458 // ----------------------------------------------------------------------------
 459
 460 #if wxUSE_EXCEPTIONS
 461
 462 bool wxAppBase::OnExceptionInMainLoop()
 463 {
 464     throw;
 465
 466     // some compilers are too stupid to know that we never return after throw
 467 #if defined(__DMC__) || (defined(_MSC_VER) && _MSC_VER < 1200)
 468     return false;
 469 #endif
 470 }
 471
 472 #endif // wxUSE_EXCEPTIONS
 473
 474 // ----------------------------------------------------------------------------
 475 // wxGUIAppTraitsBase
 476 // ----------------------------------------------------------------------------
 477
 478 #if wxUSE_LOG
 479
 480 wxLog *wxGUIAppTraitsBase::CreateLogTarget()
 481 {
 482 #if wxUSE_LOGGUI
 483     return new wxLogGui;
 484 #else
 485     // we must have something!
 486     return new wxLogStderr;
 487 #endif
 488 }
 489
 490 #endif // wxUSE_LOG
 491
 492 wxMessageOutput *wxGUIAppTraitsBase::CreateMessageOutput()
 493 {
 494     // The standard way of printing help on command line arguments (app --help)
 495     // is (according to common practice):
 496     //     - console apps: to stderr (on any platform)
 497     //     - GUI apps: stderr on Unix platforms (!)
 498     //                 message box under Windows and others
 499 #ifdef __UNIX__
 500     return new wxMessageOutputStderr;
 501 #else // !__UNIX__
 502     // wxMessageOutputMessageBox doesn't work under Motif
 503     #ifdef __WXMOTIF__
 504         return new wxMessageOutputLog;
 505     #else
 506         return new wxMessageOutputMessageBox;
 507     #endif
 508 #endif // __UNIX__/!__UNIX__
 509 }
 510
 511 #if wxUSE_FONTMAP
 512
 513 wxFontMapper *wxGUIAppTraitsBase::CreateFontMapper()
 514 {
 515     return new wxFontMapper;
 516 }
 517
 518 #endif // wxUSE_FONTMAP
 519
 520 wxRendererNative *wxGUIAppTraitsBase::CreateRenderer()
 521 {
 522     // use the default native renderer by default
 523     return NULL;
 524 }
 525
 526 #ifdef __WXDEBUG__
 527
 528 bool wxGUIAppTraitsBase::ShowAssertDialog(const wxString& msg)
 529 {
 530     // under MSW we prefer to use the base class version using ::MessageBox()
 531     // even if wxMessageBox() is available because it has less chances to
 532     // double fault our app than our wxMessageBox()
 533 #if defined(__WXMSW__) || !wxUSE_MSGDLG
 534     return wxAppTraitsBase::ShowAssertDialog(msg);
 535 #else // wxUSE_MSGDLG
 536     // this message is intentionally not translated -- it is for
 537     // developpers only
 538     wxString msgDlg(msg);
 539     msgDlg += wxT("\nDo you want to stop the program?\n")
 540               wxT("You can also choose [Cancel] to suppress ")
 541               wxT("further warnings.");
 542
 543     switch ( wxMessageBox(msgDlg, wxT("wxWidgets Debug Alert"),
 544                           wxYES_NO | wxCANCEL | wxICON_STOP ) )
 545     {
 546         case wxYES:
 547             wxTrap();
 548             break;
 549
 550         case wxCANCEL:
 551             // no more asserts
 552             return true;
 553
 554         //case wxNO: nothing to do
 555     }
 556
 557     return false;
 558 #endif // !wxUSE_MSGDLG/wxUSE_MSGDLG
 559 }
 560
 561 #endif // __WXDEBUG__
 562
 563 bool wxGUIAppTraitsBase::HasStderr()
 564 {
 565     // we consider that under Unix stderr always goes somewhere, even if the
 566     // user doesn't always see it under GUI desktops
 567 #ifdef __UNIX__
 568     return true;
 569 #else
 570     return false;
 571 #endif
 572 }
 573
 574 void wxGUIAppTraitsBase::ScheduleForDestroy(wxObject *object)
 575 {
 576     if ( !wxPendingDelete.Member(object) )
 577         wxPendingDelete.Append(object);
 578 }
 579
 580 void wxGUIAppTraitsBase::RemoveFromPendingDelete(wxObject *object)
 581 {
 582     wxPendingDelete.DeleteObject(object);
 583 }
 584
 585 #if wxUSE_SOCKETS
 586
 587 #if defined(__WINDOWS__)
 588     #include "wx/msw/gsockmsw.h"
 589 #elif defined(__UNIX__) || defined(__DARWIN__) || defined(__OS2__)
 590     #include "wx/unix/gsockunx.h"
 591 #elif defined(__WXMAC__)
 592     #include <MacHeaders.c>
 593     #define OTUNIXERRORS 1
 594     #include <OpenTransport.h>
 595     #include <OpenTransportProviders.h>
 596     #include <OpenTptInternet.h>
 597
 598     #include "wx/mac/gsockmac.h"
 599 #else
 600     #error "Must include correct GSocket header here"
 601 #endif
 602
 603 GSocketGUIFunctionsTable* wxGUIAppTraitsBase::GetSocketGUIFunctionsTable()
 604 {
 605 #if defined(__WXMAC__) && !defined(__DARWIN__)
 606     // NB: wxMac CFM does not have any GUI-specific functions in gsocket.c and
 607     //     so it doesn't need this table at all
 608     return NULL;
 609 #else // !__WXMAC__ || __DARWIN__
 610     static GSocketGUIFunctionsTableConcrete table;
 611     return &table;
 612 #endif // !__WXMAC__ || __DARWIN__
 613 }
 614
 615 #endif