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_SCOPED_PTR_TYPE(wxEventLoop);
  69
  70 // but we need a smart pointer tied to wxAppBase::m_mainLoop, so we define
  71 // another helper class
  72 class wxTiedEventLoopPtr : public wxEventLoopPtr
  73 {
  74 public:
  75     wxTiedEventLoopPtr(wxEventLoop **ppEvtLoop, wxEventLoop *pLoop)
  76         : wxEventLoopPtr(*ppEvtLoop = pLoop), m_ppEvtLoop(ppEvtLoop)
  77         {
  78         }
  79
  80     ~wxTiedEventLoopPtr() { *m_ppEvtLoop = NULL; }
  81
  82 private:
  83     wxEventLoop **m_ppEvtLoop;
  84 };
  85
  86 // ============================================================================
  87 // wxAppBase implementation
  88 // ============================================================================
  89
  90 // ----------------------------------------------------------------------------
  91 // initialization
  92 // ----------------------------------------------------------------------------
  93
  94 wxAppBase::wxAppBase()
  95 {
  96     m_topWindow = (wxWindow *)NULL;
  97     m_useBestVisual = FALSE;
  98     m_isActive = TRUE;
  99
 100     m_mainLoop = NULL;
 101
 102     // We don't want to exit the app if the user code shows a dialog from its
 103     // OnInit() -- but this is what would happen if we set m_exitOnFrameDelete
 104     // to Yes initially as this dialog would be the last top level window.
 105     // OTOH, if we set it to No initially we'll have to overwrite it with Yes
 106     // when we enter our OnRun() because we do want the default behaviour from
 107     // then on. But this would be a problem if the user code calls
 108     // SetExitOnFrameDelete(FALSE) from OnInit().
 109     //
 110     // So we use the special "Later" value which is such that
 111     // GetExitOnFrameDelete() returns FALSE for it but which we know we can
 112     // safely (i.e. without losing the effect of the users SetExitOnFrameDelete
 113     // call) overwrite in OnRun()
 114     m_exitOnFrameDelete = Later;
 115 }
 116
 117 bool wxAppBase::Initialize(int& argc, wxChar **argv)
 118 {
 119     if ( !wxAppConsole::Initialize(argc, argv) )
 120         return false;
 121
 122 #if wxUSE_THREADS
 123     wxPendingEventsLocker = new wxCriticalSection;
 124 #endif
 125
 126     wxInitializeStockLists();
 127     wxInitializeStockObjects();
 128
 129     wxBitmap::InitStandardHandlers();
 130
 131     return true;
 132 }
 133
 134 // ----------------------------------------------------------------------------
 135 // cleanup
 136 // ----------------------------------------------------------------------------
 137
 138 wxAppBase::~wxAppBase()
 139 {
 140     // this destructor is required for Darwin
 141 }
 142
 143 void wxAppBase::CleanUp()
 144 {
 145     // one last chance for pending objects to be cleaned up
 146     DeletePendingObjects();
 147
 148     wxBitmap::CleanUpHandlers();
 149
 150     wxDeleteStockObjects();
 151
 152     wxDeleteStockLists();
 153
 154     delete wxTheColourDatabase;
 155     wxTheColourDatabase = NULL;
 156
 157 #if wxUSE_THREADS
 158     delete wxPendingEvents;
 159     wxPendingEvents = NULL;
 160
 161     delete wxPendingEventsLocker;
 162     wxPendingEventsLocker = NULL;
 163
 164     #if wxUSE_VALIDATORS
 165         // If we don't do the following, we get an apparent memory leak.
 166         ((wxEvtHandler&) wxDefaultValidator).ClearEventLocker();
 167     #endif // wxUSE_VALIDATORS
 168 #endif // wxUSE_THREADS
 169 }
 170
 171 #if wxUSE_CMDLINE_PARSER
 172
 173 // ----------------------------------------------------------------------------
 174 // GUI-specific command line options handling
 175 // ----------------------------------------------------------------------------
 176
 177 #define OPTION_THEME   _T("theme")
 178 #define OPTION_MODE    _T("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             _T(""),
 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             _T(""),
 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         {
 215             wxCMD_LINE_NONE,
 216             _T(""),
 217             _T(""),
 218             _T(""),
 219             wxCMD_LINE_VAL_NONE,
 220             0x0
 221         }
 222     };
 223
 224     parser.SetDesc(cmdLineGUIDesc);
 225 }
 226
 227 bool wxAppBase::OnCmdLineParsed(wxCmdLineParser& parser)
 228 {
 229 #ifdef __WXUNIVERSAL__
 230     wxString themeName;
 231     if ( parser.Found(OPTION_THEME, &themeName) )
 232     {
 233         wxTheme *theme = wxTheme::Create(themeName);
 234         if ( !theme )
 235         {
 236             wxLogError(_("Unsupported theme '%s'."), themeName.c_str());
 237             return FALSE;
 238         }
 239
 240         // Delete the defaultly created theme and set the new theme.
 241         delete wxTheme::Get();
 242         wxTheme::Set(theme);
 243     }
 244 #endif // __WXUNIVERSAL__
 245
 246 #if defined(__WXMGL__)
 247     wxString modeDesc;
 248     if ( parser.Found(OPTION_MODE, &modeDesc) )
 249     {
 250         unsigned w, h, bpp;
 251         if ( wxSscanf(modeDesc.c_str(), _T("%ux%u-%u"), &w, &h, &bpp) != 3 )
 252         {
 253             wxLogError(_("Invalid display mode specification '%s'."), modeDesc.c_str());
 254             return FALSE;
 255         }
 256
 257         if ( !SetDisplayMode(wxDisplayModeInfo(w, h, bpp)) )
 258             return FALSE;
 259     }
 260 #endif // __WXMGL__
 261
 262     return wxAppConsole::OnCmdLineParsed(parser);
 263 }
 264
 265 #endif // wxUSE_CMDLINE_PARSER
 266
 267 // ----------------------------------------------------------------------------
 268 // main event loop implementation
 269 // ----------------------------------------------------------------------------
 270
 271 int wxAppBase::MainLoop()
 272 {
 273     wxTiedEventLoopPtr mainLoop(&m_mainLoop, new wxEventLoop);
 274
 275     return m_mainLoop->Run();
 276 }
 277
 278 void wxAppBase::ExitMainLoop()
 279 {
 280     // we should exit from the main event loop, not just any currently active
 281     // (e.g. modal dialog) event loop
 282     if ( m_mainLoop )
 283     {
 284         m_mainLoop->Exit(0);
 285     }
 286 }
 287
 288 bool wxAppBase::Pending()
 289 {
 290     // use the currently active message loop here, not m_mainLoop, because if
 291     // we're showing a modal dialog (with its own event loop) currently the
 292     // main event loop is not running anyhow
 293     wxEventLoop * const loop = wxEventLoop::GetActive();
 294
 295     return loop && loop->Pending();
 296 }
 297
 298 bool wxAppBase::Dispatch()
 299 {
 300     // see comment in Pending()
 301     wxEventLoop * const loop = wxEventLoop::GetActive();
 302
 303     return loop ? loop->Dispatch() : true;
 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     return new wxLogGui;
 469 }
 470
 471 #endif // wxUSE_LOG
 472
 473 wxMessageOutput *wxGUIAppTraitsBase::CreateMessageOutput()
 474 {
 475     // The standard way of printing help on command line arguments (app --help)
 476     // is (according to common practice):
 477     //     - console apps: to stderr (on any platform)
 478     //     - GUI apps: stderr on Unix platforms (!)
 479     //                 message box under Windows and others
 480 #ifdef __UNIX__
 481     return new wxMessageOutputStderr;
 482 #else // !__UNIX__
 483     // wxMessageOutputMessageBox doesn't work under Motif
 484     #ifdef __WXMOTIF__
 485         return new wxMessageOutputLog;
 486     #else
 487         return new wxMessageOutputMessageBox;
 488     #endif
 489 #endif // __UNIX__/!__UNIX__
 490 }
 491
 492 #if wxUSE_FONTMAP
 493
 494 wxFontMapper *wxGUIAppTraitsBase::CreateFontMapper()
 495 {
 496     return new wxFontMapper;
 497 }
 498
 499 #endif // wxUSE_FONTMAP
 500
 501 wxRendererNative *wxGUIAppTraitsBase::CreateRenderer()
 502 {
 503     // use the default native renderer by default
 504     return NULL;
 505 }
 506
 507 #ifdef __WXDEBUG__
 508
 509 bool wxGUIAppTraitsBase::ShowAssertDialog(const wxString& msg)
 510 {
 511     // under MSW we prefer to use the base class version using ::MessageBox()
 512     // even if wxMessageBox() is available because it has less chances to
 513     // double fault our app than our wxMessageBox()
 514 #if defined(__WXMSW__) || !wxUSE_MSGDLG
 515     return wxAppTraitsBase::ShowAssertDialog(msg);
 516 #else // wxUSE_MSGDLG
 517     // this message is intentionally not translated -- it is for
 518     // developpers only
 519     wxString msgDlg(msg);
 520     msgDlg += wxT("\nDo you want to stop the program?\n")
 521               wxT("You can also choose [Cancel] to suppress ")
 522               wxT("further warnings.");
 523
 524     switch ( wxMessageBox(msgDlg, wxT("wxWindows Debug Alert"),
 525                           wxYES_NO | wxCANCEL | wxICON_STOP ) )
 526     {
 527         case wxYES:
 528             wxTrap();
 529             break;
 530
 531         case wxCANCEL:
 532             // no more asserts
 533             return true;
 534
 535         //case wxNO: nothing to do
 536     }
 537
 538     return false;
 539 #endif // !wxUSE_MSGDLG/wxUSE_MSGDLG
 540 }
 541
 542 #endif // __WXDEBUG__
 543
 544 bool wxGUIAppTraitsBase::HasStderr()
 545 {
 546     // we consider that under Unix stderr always goes somewhere, even if the
 547     // user doesn't always see it under GUI desktops
 548 #ifdef __UNIX__
 549     return true;
 550 #else
 551     return false;
 552 #endif
 553 }
 554
 555 void wxGUIAppTraitsBase::ScheduleForDestroy(wxObject *object)
 556 {
 557     if ( !wxPendingDelete.Member(object) )
 558         wxPendingDelete.Append(object);
 559 }
 560
 561 void wxGUIAppTraitsBase::RemoveFromPendingDelete(wxObject *object)
 562 {
 563     wxPendingDelete.DeleteObject(object);
 564 }
 565
 566 #if wxUSE_SOCKETS
 567
 568 #if defined(__UNIX__) || defined(__DARWIN__) || defined(__OS2__)
 569     #include "wx/unix/gsockunx.h"
 570 #elif defined(__WINDOWS__)
 571     #include "wx/msw/gsockmsw.h"
 572 #elif defined(__WXMAC__)
 573   #include <MacHeaders.c>
 574   #define OTUNIXERRORS 1
 575   #include <OpenTransport.h>
 576   #include <OpenTransportProviders.h>
 577   #include <OpenTptInternet.h>
 578
 579   #include "wx/mac/gsockmac.h"
 580 #else
 581     #error "Must include correct GSocket header here"
 582 #endif
 583
 584 GSocketGUIFunctionsTable* wxGUIAppTraitsBase::GetSocketGUIFunctionsTable()
 585 {
 586 #ifdef __WXMAC__
 587     // NB: wxMac does not have any GUI-specific functions in gsocket.c and
 588     //     so it doesn't need this table at all
 589     return NULL;
 590 #else // !__WXMAC__
 591     static GSocketGUIFunctionsTable table =
 592     {
 593         _GSocket_GUI_Init,
 594         _GSocket_GUI_Cleanup,
 595         _GSocket_GUI_Init_Socket,
 596         _GSocket_GUI_Destroy_Socket,
 597 #ifndef __WINDOWS__
 598         _GSocket_Install_Callback,
 599         _GSocket_Uninstall_Callback,
 600 #endif
 601         _GSocket_Enable_Events,
 602         _GSocket_Disable_Events
 603     };
 604     return &table;
 605 #endif // __WXMAC__/!__WXMAC__
 606 }
 607
 608 #endif
 609