src/common/appcmn.cpp

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