src/common/init.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        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/debug.h"
  29     #include "wx/filefn.h"
  30     #include "wx/log.h"
  31     #include "wx/thread.h"
  32 #endif
  33
  34 #include "wx/init.h"
  35
  36 #include "wx/ptr_scpd.h"
  37 #include "wx/module.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     for ( int i = 0; i < argc; i++ )
 180     {
 181         gs_initData.argv[i] = wxStrdup(wxConvLocal.cMB2WX(argv[i]));
 182     }
 183
 184     gs_initData.argc = argc;
 185     gs_initData.argv[argc] = NULL;
 186 }
 187
 188 static void FreeConvertedArgs()
 189 {
 190     if ( gs_initData.argv )
 191     {
 192         for ( int i = 0; i < gs_initData.argc; i++ )
 193         {
 194             free(gs_initData.argv[i]);
 195         }
 196
 197         delete [] gs_initData.argv;
 198         gs_initData.argv = NULL;
 199         gs_initData.argc = 0;
 200     }
 201 }
 202
 203 #endif // wxUSE_UNICODE
 204
 205 // ----------------------------------------------------------------------------
 206 // start up
 207 // ----------------------------------------------------------------------------
 208
 209 // initialization which is always done (not customizable) before wxApp creation
 210 static bool DoCommonPreInit()
 211 {
 212 #if wxUSE_LOG
 213     // install temporary log sink: we can't use wxLogGui before wxApp is
 214     // constructed and if we use wxLogStderr, all messages during
 215     // initialization simply disappear under Windows
 216     //
 217     // note that we will delete this log target below
 218     wxLog::SetActiveTarget(new wxLogBuffer);
 219 #endif // wxUSE_LOG
 220
 221     return true;
 222 }
 223
 224 // non customizable initialization done after wxApp creation and initialization
 225 static bool DoCommonPostInit()
 226 {
 227     wxModule::RegisterModules();
 228
 229     if ( !wxModule::InitializeModules() )
 230     {
 231         wxLogError(_("Initialization failed in post init, aborting."));
 232         return false;
 233     }
 234
 235     return true;
 236 }
 237
 238 bool wxEntryStart(int& argc, wxChar **argv)
 239 {
 240     // do minimal, always necessary, initialization
 241     // --------------------------------------------
 242
 243     // initialize wxRTTI
 244     if ( !DoCommonPreInit() )
 245     {
 246         return false;
 247     }
 248
 249
 250     // first of all, we need an application object
 251     // -------------------------------------------
 252
 253     // the user might have already created it himself somehow
 254     wxAppPtr app(wxTheApp);
 255     if ( !app.get() )
 256     {
 257         // if not, he might have used IMPLEMENT_APP() to give us a function to
 258         // create it
 259         wxAppInitializerFunction fnCreate = wxApp::GetInitializerFunction();
 260
 261         if ( fnCreate )
 262         {
 263             // he did, try to create the custom wxApp object
 264             app.Set((*fnCreate)());
 265         }
 266     }
 267
 268     if ( !app.get() )
 269     {
 270         // either IMPLEMENT_APP() was not used at all or it failed -- in any
 271         // case we still need something
 272         app.Set(new wxDummyConsoleApp);
 273     }
 274
 275
 276     // wxApp initialization: this can be customized
 277     // --------------------------------------------
 278
 279     if ( !app->Initialize(argc, argv) )
 280     {
 281         return false;
 282     }
 283
 284     wxCallAppCleanup callAppCleanup(app.get());
 285
 286     // for compatibility call the old initialization function too
 287     if ( !app->OnInitGui() )
 288         return false;
 289
 290
 291     // common initialization after wxTheApp creation
 292     // ---------------------------------------------
 293
 294     if ( !DoCommonPostInit() )
 295         return false;
 296
 297
 298     // prevent the smart pointer from destroying its contents
 299     app.release();
 300
 301     // and the cleanup object from doing cleanup
 302     callAppCleanup.Dismiss();
 303
 304 #if wxUSE_LOG
 305     // now that we have a valid wxApp (wxLogGui would have crashed if we used
 306     // it before now), we can delete the temporary sink we had created for the
 307     // initialization messages -- the next time logging function is called, the
 308     // sink will be recreated but this time wxAppTraits will be used
 309     delete wxLog::SetActiveTarget(NULL);
 310 #endif // wxUSE_LOG
 311
 312     return true;
 313 }
 314
 315 #if wxUSE_UNICODE
 316
 317 // we provide a wxEntryStart() wrapper taking "char *" pointer too
 318 bool wxEntryStart(int& argc, char **argv)
 319 {
 320     ConvertArgsToUnicode(argc, argv);
 321
 322     if ( !wxEntryStart(argc, gs_initData.argv) )
 323     {
 324         FreeConvertedArgs();
 325
 326         return false;
 327     }
 328
 329     return true;
 330 }
 331
 332 #endif // wxUSE_UNICODE
 333
 334 // ----------------------------------------------------------------------------
 335 // clean up
 336 // ----------------------------------------------------------------------------
 337
 338 // cleanup done before destroying wxTheApp
 339 static void DoCommonPreCleanup()
 340 {
 341 #if wxUSE_LOG
 342     // flush the logged messages if any and install a 'safer' log target: the
 343     // default one (wxLogGui) can't be used after the resources are freed just
 344     // below and the user supplied one might be even more unsafe (using any
 345     // wxWidgets GUI function is unsafe starting from now)
 346     wxLog::DontCreateOnDemand();
 347
 348     // this will flush the old messages if any
 349     delete wxLog::SetActiveTarget(new wxLogStderr);
 350 #endif // wxUSE_LOG
 351 }
 352
 353 // cleanup done after destroying wxTheApp
 354 static void DoCommonPostCleanup()
 355 {
 356     wxModule::CleanUpModules();
 357
 358     wxClassInfo::CleanUp();
 359
 360     // we can't do this in wxApp itself because it doesn't know if argv had
 361     // been allocated
 362 #if wxUSE_UNICODE
 363     FreeConvertedArgs();
 364 #endif // wxUSE_UNICODE
 365
 366     // Note: check for memory leaks is now done via wxDebugContextDumpDelayCounter
 367 #if wxUSE_LOG
 368     // and now delete the last logger as well
 369     delete wxLog::SetActiveTarget(NULL);
 370 #endif // wxUSE_LOG
 371 }
 372
 373 void wxEntryCleanup()
 374 {
 375     DoCommonPreCleanup();
 376
 377
 378     // delete the application object
 379     if ( wxTheApp )
 380     {
 381         wxTheApp->CleanUp();
 382
 383         delete wxTheApp;
 384         wxApp::SetInstance(NULL);
 385     }
 386
 387
 388     DoCommonPostCleanup();
 389 }
 390
 391 // ----------------------------------------------------------------------------
 392 // wxEntry
 393 // ----------------------------------------------------------------------------
 394
 395 // for MSW the real wxEntry is defined in msw/main.cpp
 396 #ifndef __WXMSW__
 397     #define wxEntryReal wxEntry
 398 #endif // !__WXMSW__
 399
 400 int wxEntryReal(int& argc, wxChar **argv)
 401 {
 402 #if wxUSE_LOG
 403     // Create a non-GUI log target, to be used until GUI (if any) is ready.
 404     // Target will be reset by wxAppConsole::Initialize, when GUI logging will work.
 405     wxLog::GetActiveTarget();
 406 #endif
 407
 408     // library initialization
 409     if ( !wxEntryStart(argc, argv) )
 410     {
 411         // flush any log messages explaining why we failed
 412         delete wxLog::SetActiveTarget(NULL);
 413         return -1;
 414     }
 415
 416     // if wxEntryStart succeeded, we must call wxEntryCleanup even if the code
 417     // below returns or throws
 418     wxCleanupOnExit cleanupOnExit;
 419
 420     WX_SUPPRESS_UNUSED_WARN(cleanupOnExit);
 421
 422     wxTRY
 423     {
 424
 425         // app initialization
 426         if ( !wxTheApp->CallOnInit() )
 427         {
 428             // don't call OnExit() if OnInit() failed
 429             return -1;
 430         }
 431
 432         // ensure that OnExit() is called if OnInit() had succeeded
 433         class CallOnExit
 434         {
 435         public:
 436             ~CallOnExit() { wxTheApp->OnExit(); }
 437         } callOnExit;
 438
 439         WX_SUPPRESS_UNUSED_WARN(callOnExit);
 440
 441         // app execution
 442         return wxTheApp->OnRun();
 443     }
 444     wxCATCH_ALL( wxTheApp->OnUnhandledException(); return -1; )
 445 }
 446
 447 #if wxUSE_UNICODE
 448
 449 // as with wxEntryStart, we provide an ANSI wrapper
 450 int wxEntry(int& argc, char **argv)
 451 {
 452     ConvertArgsToUnicode(argc, argv);
 453
 454     return wxEntry(argc, gs_initData.argv);
 455 }
 456
 457 #endif // wxUSE_UNICODE
 458
 459 // ----------------------------------------------------------------------------
 460 // wxInitialize/wxUninitialize
 461 // ----------------------------------------------------------------------------
 462
 463 bool wxInitialize(int argc, wxChar **argv)
 464 {
 465     wxCRIT_SECT_LOCKER(lockInit, gs_initData.csInit);
 466
 467     if ( gs_initData.nInitCount++ )
 468     {
 469         // already initialized
 470         return true;
 471     }
 472
 473     return wxEntryStart(argc, argv);
 474 }
 475
 476 void wxUninitialize()
 477 {
 478     wxCRIT_SECT_LOCKER(lockInit, gs_initData.csInit);
 479
 480     if ( !--gs_initData.nInitCount )
 481     {
 482         wxEntryCleanup();
 483     }
 484 }
 485