src/common/init.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/common/init.cpp
   3 // Purpose:     initialisation for the library
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     04.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 #include "wx/wxprec.h"
  21
  22 #ifdef    __BORLANDC__
  23     #pragma hdrstop
  24 #endif  //__BORLANDC__
  25
  26 #ifndef WX_PRECOMP
  27     #include "wx/app.h"
  28     #include "wx/filefn.h"
  29     #include "wx/log.h"
  30     #include "wx/intl.h"
  31     #include "wx/module.h"
  32 #endif
  33
  34 #include "wx/init.h"
  35 #include "wx/thread.h"
  36
  37 #include "wx/ptr_scpd.h"
  38 #include "wx/except.h"
  39
  40 #if defined(__WXMSW__) && defined(__WXDEBUG__)
  41     #include "wx/msw/msvcrt.h"
  42
  43     static struct EnableMemLeakChecking
  44     {
  45         EnableMemLeakChecking()
  46         {
  47             // do check for memory leaks on program exit (another useful flag
  48             // is _CRTDBG_DELAY_FREE_MEM_DF which doesn't free deallocated
  49             // memory which may be used to simulate low-memory condition)
  50             wxCrtSetDbgFlag(_CRTDBG_LEAK_CHECK_DF);
  51         }
  52     } gs_enableLeakChecks;
  53 #endif // __WXMSW__ && __WXDEBUG__
  54
  55 // ----------------------------------------------------------------------------
  56 // private classes
  57 // ----------------------------------------------------------------------------
  58
  59 // we need a dummy app object if the user doesn't want to create a real one
  60 class wxDummyConsoleApp : public wxAppConsole
  61 {
  62 public:
  63     wxDummyConsoleApp() { }
  64
  65     virtual int OnRun() { wxFAIL_MSG( _T("unreachable code") ); return 0; }
  66
  67     DECLARE_NO_COPY_CLASS(wxDummyConsoleApp)
  68 };
  69
  70 // we need a special kind of auto pointer to wxApp which not only deletes the
  71 // pointer it holds in its dtor but also resets the global application pointer
  72 wxDECLARE_SCOPED_PTR(wxAppConsole, wxAppPtrBase)
  73 wxDEFINE_SCOPED_PTR(wxAppConsole, wxAppPtrBase)
  74
  75 class wxAppPtr : public wxAppPtrBase
  76 {
  77 public:
  78     wxEXPLICIT wxAppPtr(wxAppConsole *ptr = NULL) : wxAppPtrBase(ptr) { }
  79     ~wxAppPtr()
  80     {
  81         if ( get() )
  82         {
  83             // the pointer is going to be deleted in the base class dtor, don't
  84             // leave the dangling pointer!
  85             wxApp::SetInstance(NULL);
  86         }
  87     }
  88
  89     void Set(wxAppConsole *ptr)
  90     {
  91         reset(ptr);
  92
  93         wxApp::SetInstance(ptr);
  94     }
  95
  96     DECLARE_NO_COPY_CLASS(wxAppPtr)
  97 };
  98
  99 // class to ensure that wxAppBase::CleanUp() is called if our Initialize()
 100 // fails
 101 class wxCallAppCleanup
 102 {
 103 public:
 104     wxCallAppCleanup(wxAppConsole *app) : m_app(app) { }
 105     ~wxCallAppCleanup() { if ( m_app ) m_app->CleanUp(); }
 106
 107     void Dismiss() { m_app = NULL; }
 108
 109 private:
 110     wxAppConsole *m_app;
 111 };
 112
 113 // another tiny class which simply exists to ensure that wxEntryCleanup is
 114 // always called
 115 class wxCleanupOnExit
 116 {
 117 public:
 118     ~wxCleanupOnExit() { wxEntryCleanup(); }
 119 };
 120
 121 // ----------------------------------------------------------------------------
 122 // private functions
 123 // ----------------------------------------------------------------------------
 124
 125 // suppress warnings about unused variables
 126 static inline void Use(void *) { }
 127
 128 #define WX_SUPPRESS_UNUSED_WARN(x) Use(&x)
 129
 130 // ----------------------------------------------------------------------------
 131 // initialization data
 132 // ----------------------------------------------------------------------------
 133
 134 static struct InitData
 135 {
 136     InitData()
 137     {
 138         nInitCount = 0;
 139
 140 #if wxUSE_UNICODE
 141         argc = 0;
 142         // argv = NULL; -- not even really needed
 143 #endif // wxUSE_UNICODE
 144     }
 145
 146     // critical section protecting this struct
 147     wxCRIT_SECT_DECLARE_MEMBER(csInit);
 148
 149     // number of times wxInitialize() was called minus the number of times
 150     // wxUninitialize() was
 151     size_t nInitCount;
 152
 153 #if wxUSE_UNICODE
 154     int argc;
 155
 156     // if we receive the command line arguments as ASCII and have to convert
 157     // them to Unicode ourselves (this is the case under Unix but not Windows,
 158     // for example), we remember the converted argv here because we'll have to
 159     // free it when doing cleanup to avoid memory leaks
 160     wchar_t **argv;
 161 #endif // wxUSE_UNICODE
 162
 163     DECLARE_NO_COPY_CLASS(InitData)
 164 } gs_initData;
 165
 166 // ============================================================================
 167 // implementation
 168 // ============================================================================
 169
 170 // ----------------------------------------------------------------------------
 171 // command line arguments ANSI -> Unicode conversion
 172 // ----------------------------------------------------------------------------
 173
 174 #if wxUSE_UNICODE
 175
 176 static void ConvertArgsToUnicode(int argc, char **argv)
 177 {
 178     gs_initData.argv = new wchar_t *[argc + 1];
 179     int wargc = 0;
 180     for ( int i = 0; i < argc; i++ )
 181     {
 182 #ifdef __DARWIN__
 183         wxWCharBuffer buf(wxConvFileName->cMB2WX(argv[i]));
 184 #else
 185         wxWCharBuffer buf(wxConvLocal.cMB2WX(argv[i]));
 186 #endif
 187         if ( !buf )
 188         {
 189             wxLogWarning(_("Command line argument %d couldn't be converted to Unicode and will be ignored."),
 190                          i);
 191         }
 192         else // converted ok
 193         {
 194             gs_initData.argv[wargc++] = wxStrdup(buf);
 195         }
 196     }
 197
 198     gs_initData.argc = wargc;
 199     gs_initData.argv[wargc] = NULL;
 200 }
 201
 202 static void FreeConvertedArgs()
 203 {
 204     if ( gs_initData.argv )
 205     {
 206         for ( int i = 0; i < gs_initData.argc; i++ )
 207         {
 208             free(gs_initData.argv[i]);
 209         }
 210
 211         delete [] gs_initData.argv;
 212         gs_initData.argv = NULL;
 213         gs_initData.argc = 0;
 214     }
 215 }
 216
 217 #endif // wxUSE_UNICODE
 218
 219 // ----------------------------------------------------------------------------
 220 // start up
 221 // ----------------------------------------------------------------------------
 222
 223 // initialization which is always done (not customizable) before wxApp creation
 224 static bool DoCommonPreInit()
 225 {
 226 #if wxUSE_LOG
 227     // Reset logging in case we were cleaned up and are being reinitialized.
 228     wxLog::DoCreateOnDemand();
 229
 230     // install temporary log sink: we can't use wxLogGui before wxApp is
 231     // constructed and if we use wxLogStderr, all messages during
 232     // initialization simply disappear under Windows
 233     //
 234     // note that we will delete this log target below
 235     delete wxLog::SetActiveTarget(new wxLogBuffer);
 236 #endif // wxUSE_LOG
 237
 238     return true;
 239 }
 240
 241 // non customizable initialization done after wxApp creation and initialization
 242 static bool DoCommonPostInit()
 243 {
 244     wxModule::RegisterModules();
 245
 246     if ( !wxModule::InitializeModules() )
 247     {
 248         wxLogError(_("Initialization failed in post init, aborting."));
 249         return false;
 250     }
 251
 252 #if defined(__WXDEBUG__)
 253     // check if event classes implement Clone() correctly
 254     // NOTE: the check is done against _all_ event classes which are linked to
 255     //       the executable currently running, which are not necessarily all
 256     //       wxWidgets event classes.
 257     const wxClassInfo *ci = wxClassInfo::GetFirst();
 258     for (; ci; ci = ci->GetNext())
 259     {
 260         // is this class derived from wxEvent?
 261         if (!ci->IsKindOf(CLASSINFO(wxEvent)) || wxString(ci->GetClassName()) == "wxEvent")
 262             continue;
 263
 264         if (!ci->IsDynamic())
 265         {
 266             wxLogWarning("The event class '%s' should have a DECLARE_DYNAMIC_CLASS macro!",
 267                          ci->GetClassName());
 268             continue;
 269         }
 270
 271         // yes; test if it implements Clone() correctly
 272         wxEvent* test = dynamic_cast<wxEvent*>(ci->CreateObject());
 273         if (test == NULL)
 274         {
 275             wxLogWarning("The event class '%s' should have a DECLARE_DYNAMIC_CLASS macro!",
 276                          ci->GetClassName());
 277             continue;
 278         }
 279
 280         wxEvent* cloned = test->Clone();
 281         if (!cloned || cloned->GetClassInfo() != ci)
 282             wxLogWarning("The event class '%s' does not correctly implement Clone()!",
 283                          ci->GetClassName());
 284
 285         delete test;
 286     }
 287 #endif
 288
 289     return true;
 290 }
 291
 292 bool wxEntryStart(int& argc, wxChar **argv)
 293 {
 294     // do minimal, always necessary, initialization
 295     // --------------------------------------------
 296
 297     // initialize wxRTTI
 298     if ( !DoCommonPreInit() )
 299     {
 300         return false;
 301     }
 302
 303
 304     // first of all, we need an application object
 305     // -------------------------------------------
 306
 307     // the user might have already created it himself somehow
 308     wxAppPtr app(wxTheApp);
 309     if ( !app.get() )
 310     {
 311         // if not, he might have used IMPLEMENT_APP() to give us a function to
 312         // create it
 313         wxAppInitializerFunction fnCreate = wxApp::GetInitializerFunction();
 314
 315         if ( fnCreate )
 316         {
 317             // he did, try to create the custom wxApp object
 318             app.Set((*fnCreate)());
 319         }
 320     }
 321
 322     if ( !app.get() )
 323     {
 324         // either IMPLEMENT_APP() was not used at all or it failed -- in any
 325         // case we still need something
 326         app.Set(new wxDummyConsoleApp);
 327     }
 328
 329
 330     // wxApp initialization: this can be customized
 331     // --------------------------------------------
 332
 333     if ( !app->Initialize(argc, argv) )
 334     {
 335         return false;
 336     }
 337
 338     // remember, possibly modified (e.g. due to removal of toolkit-specific
 339     // parameters), command line arguments in member variables
 340     app->argc = argc;
 341     app->argv = argv;
 342
 343
 344     wxCallAppCleanup callAppCleanup(app.get());
 345
 346     // for compatibility call the old initialization function too
 347     if ( !app->OnInitGui() )
 348         return false;
 349
 350
 351     // common initialization after wxTheApp creation
 352     // ---------------------------------------------
 353
 354     if ( !DoCommonPostInit() )
 355         return false;
 356
 357
 358     // prevent the smart pointer from destroying its contents
 359     app.release();
 360
 361     // and the cleanup object from doing cleanup
 362     callAppCleanup.Dismiss();
 363
 364 #if wxUSE_LOG
 365     // now that we have a valid wxApp (wxLogGui would have crashed if we used
 366     // it before now), we can delete the temporary sink we had created for the
 367     // initialization messages -- the next time logging function is called, the
 368     // sink will be recreated but this time wxAppTraits will be used
 369     delete wxLog::SetActiveTarget(NULL);
 370 #endif // wxUSE_LOG
 371
 372     return true;
 373 }
 374
 375 #if wxUSE_UNICODE
 376
 377 // we provide a wxEntryStart() wrapper taking "char *" pointer too
 378 bool wxEntryStart(int& argc, char **argv)
 379 {
 380     ConvertArgsToUnicode(argc, argv);
 381
 382     if ( !wxEntryStart(gs_initData.argc, gs_initData.argv) )
 383     {
 384         FreeConvertedArgs();
 385
 386         return false;
 387     }
 388
 389     return true;
 390 }
 391
 392 #endif // wxUSE_UNICODE
 393
 394 // ----------------------------------------------------------------------------
 395 // clean up
 396 // ----------------------------------------------------------------------------
 397
 398 // cleanup done before destroying wxTheApp
 399 static void DoCommonPreCleanup()
 400 {
 401 #if wxUSE_LOG
 402     // flush the logged messages if any and install a 'safer' log target: the
 403     // default one (wxLogGui) can't be used after the resources are freed just
 404     // below and the user supplied one might be even more unsafe (using any
 405     // wxWidgets GUI function is unsafe starting from now)
 406     wxLog::DontCreateOnDemand();
 407
 408     // this will flush the old messages if any
 409     delete wxLog::SetActiveTarget(new wxLogStderr);
 410 #endif // wxUSE_LOG
 411 }
 412
 413 // cleanup done after destroying wxTheApp
 414 static void DoCommonPostCleanup()
 415 {
 416     wxModule::CleanUpModules();
 417
 418     // we can't do this in wxApp itself because it doesn't know if argv had
 419     // been allocated
 420 #if wxUSE_UNICODE
 421     FreeConvertedArgs();
 422 #endif // wxUSE_UNICODE
 423
 424     // use Set(NULL) and not Get() to avoid creating a message output object on
 425     // demand when we just want to delete it
 426     delete wxMessageOutput::Set(NULL);
 427
 428 #if wxUSE_LOG
 429     // and now delete the last logger as well
 430     delete wxLog::SetActiveTarget(NULL);
 431 #endif // wxUSE_LOG
 432 }
 433
 434 void wxEntryCleanup()
 435 {
 436     DoCommonPreCleanup();
 437
 438
 439     // delete the application object
 440     if ( wxTheApp )
 441     {
 442         wxTheApp->CleanUp();
 443
 444         // reset the global pointer to it to NULL before destroying it as in
 445         // some circumstances this can result in executing the code using
 446         // wxTheApp and using half-destroyed object is no good
 447         wxAppConsole * const app = wxApp::GetInstance();
 448         wxApp::SetInstance(NULL);
 449         delete app;
 450     }
 451
 452
 453     DoCommonPostCleanup();
 454 }
 455
 456 // ----------------------------------------------------------------------------
 457 // wxEntry
 458 // ----------------------------------------------------------------------------
 459
 460 // for MSW the real wxEntry is defined in msw/main.cpp
 461 #ifndef __WXMSW__
 462     #define wxEntryReal wxEntry
 463 #endif // !__WXMSW__
 464
 465 int wxEntryReal(int& argc, wxChar **argv)
 466 {
 467     // library initialization
 468     if ( !wxEntryStart(argc, argv) )
 469     {
 470 #if wxUSE_LOG
 471         // flush any log messages explaining why we failed
 472         delete wxLog::SetActiveTarget(NULL);
 473 #endif
 474         return -1;
 475     }
 476
 477     // if wxEntryStart succeeded, we must call wxEntryCleanup even if the code
 478     // below returns or throws
 479     wxCleanupOnExit cleanupOnExit;
 480
 481     WX_SUPPRESS_UNUSED_WARN(cleanupOnExit);
 482
 483     wxTRY
 484     {
 485
 486         // app initialization
 487         if ( !wxTheApp->CallOnInit() )
 488         {
 489             // don't call OnExit() if OnInit() failed
 490             return -1;
 491         }
 492
 493         // ensure that OnExit() is called if OnInit() had succeeded
 494         class CallOnExit
 495         {
 496         public:
 497             ~CallOnExit() { wxTheApp->OnExit(); }
 498         } callOnExit;
 499
 500         WX_SUPPRESS_UNUSED_WARN(callOnExit);
 501
 502         // app execution
 503         return wxTheApp->OnRun();
 504     }
 505     wxCATCH_ALL( wxTheApp->OnUnhandledException(); return -1; )
 506 }
 507
 508 #if wxUSE_UNICODE
 509
 510 // as with wxEntryStart, we provide an ANSI wrapper
 511 int wxEntry(int& argc, char **argv)
 512 {
 513     ConvertArgsToUnicode(argc, argv);
 514
 515     return wxEntry(gs_initData.argc, gs_initData.argv);
 516 }
 517
 518 #endif // wxUSE_UNICODE
 519
 520 // ----------------------------------------------------------------------------
 521 // wxInitialize/wxUninitialize
 522 // ----------------------------------------------------------------------------
 523
 524 bool wxInitialize(int argc, wxChar **argv)
 525 {
 526     wxCRIT_SECT_LOCKER(lockInit, gs_initData.csInit);
 527
 528     if ( gs_initData.nInitCount++ )
 529     {
 530         // already initialized
 531         return true;
 532     }
 533
 534     return wxEntryStart(argc, argv);
 535 }
 536
 537 void wxUninitialize()
 538 {
 539     wxCRIT_SECT_LOCKER(lockInit, gs_initData.csInit);
 540
 541     if ( --gs_initData.nInitCount == 0 )
 542     {
 543         wxEntryCleanup();
 544     }
 545 }