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     return true;
 213 }
 214
 215 // non customizable initialization done after wxApp creation and initialization
 216 static bool DoCommonPostInit()
 217 {
 218     wxModule::RegisterModules();
 219
 220     return wxModule::InitializeModules();
 221 }
 222
 223 bool wxEntryStart(int& argc, wxChar **argv)
 224 {
 225     // do minimal, always necessary, initialization
 226     // --------------------------------------------
 227
 228     // initialize wxRTTI
 229     if ( !DoCommonPreInit() )
 230     {
 231         return false;
 232     }
 233
 234
 235     // first of all, we need an application object
 236     // -------------------------------------------
 237
 238     // the user might have already created it himself somehow
 239     wxAppPtr app(wxTheApp);
 240     if ( !app.get() )
 241     {
 242         // if not, he might have used IMPLEMENT_APP() to give us a function to
 243         // create it
 244         wxAppInitializerFunction fnCreate = wxApp::GetInitializerFunction();
 245
 246         if ( fnCreate )
 247         {
 248             // he did, try to create the custom wxApp object
 249             app.Set((*fnCreate)());
 250         }
 251     }
 252
 253     if ( !app.get() )
 254     {
 255         // either IMPLEMENT_APP() was not used at all or it failed -- in any
 256         // case we still need something
 257         app.Set(new wxDummyConsoleApp);
 258     }
 259
 260
 261     // wxApp initialization: this can be customized
 262     // --------------------------------------------
 263
 264     if ( !app->Initialize(argc, argv) )
 265     {
 266         return false;
 267     }
 268
 269     wxCallAppCleanup callAppCleanup(app.get());
 270
 271     // for compatibility call the old initialization function too
 272     if ( !app->OnInitGui() )
 273         return false;
 274
 275
 276     // common initialization after wxTheApp creation
 277     // ---------------------------------------------
 278
 279     if ( !DoCommonPostInit() )
 280         return false;
 281
 282
 283     // prevent the smart pointer from destroying its contents
 284     app.release();
 285
 286     // and the cleanup object from doing cleanup
 287     callAppCleanup.Dismiss();
 288
 289     return true;
 290 }
 291
 292 #if wxUSE_UNICODE
 293
 294 // we provide a wxEntryStart() wrapper taking "char *" pointer too
 295 bool wxEntryStart(int& argc, char **argv)
 296 {
 297     ConvertArgsToUnicode(argc, argv);
 298
 299     if ( !wxEntryStart(argc, gs_initData.argv) )
 300     {
 301         FreeConvertedArgs();
 302
 303         return false;
 304     }
 305
 306     return true;
 307 }
 308
 309 #endif // wxUSE_UNICODE
 310
 311 // ----------------------------------------------------------------------------
 312 // clean up
 313 // ----------------------------------------------------------------------------
 314
 315 // cleanup done before destroying wxTheApp
 316 static void DoCommonPreCleanup()
 317 {
 318 #if wxUSE_LOG
 319     // flush the logged messages if any and install a 'safer' log target: the
 320     // default one (wxLogGui) can't be used after the resources are freed just
 321     // below and the user supplied one might be even more unsafe (using any
 322     // wxWidgets GUI function is unsafe starting from now)
 323     wxLog::DontCreateOnDemand();
 324
 325     // this will flush the old messages if any
 326     delete wxLog::SetActiveTarget(new wxLogStderr);
 327 #endif // wxUSE_LOG
 328 }
 329
 330 // cleanup done after destroying wxTheApp
 331 static void DoCommonPostCleanup()
 332 {
 333     wxModule::CleanUpModules();
 334
 335     wxClassInfo::CleanUp();
 336
 337     // we can't do this in wxApp itself because it doesn't know if argv had
 338     // been allocated
 339 #if wxUSE_UNICODE
 340     FreeConvertedArgs();
 341 #endif // wxUSE_UNICODE
 342
 343     // Note: check for memory leaks is now done via wxDebugContextDumpDelayCounter
 344 #if wxUSE_LOG
 345     // and now delete the last logger as well
 346     delete wxLog::SetActiveTarget(NULL);
 347 #endif // wxUSE_LOG
 348 }
 349
 350 void wxEntryCleanup()
 351 {
 352     DoCommonPreCleanup();
 353
 354
 355     // delete the application object
 356     if ( wxTheApp )
 357     {
 358         wxTheApp->CleanUp();
 359
 360         delete wxTheApp;
 361         wxApp::SetInstance(NULL);
 362     }
 363
 364
 365     DoCommonPostCleanup();
 366 }
 367
 368 // ----------------------------------------------------------------------------
 369 // wxEntry
 370 // ----------------------------------------------------------------------------
 371
 372 #if !defined(__WXMSW__) || !wxUSE_ON_FATAL_EXCEPTION
 373     #define wxEntryReal wxEntry
 374 #endif // !(__WXMSW__ && wxUSE_ON_FATAL_EXCEPTION)
 375
 376 int wxEntryReal(int& argc, wxChar **argv)
 377 {
 378     // library initialization
 379     if ( !wxEntryStart(argc, argv) )
 380     {
 381         return -1;
 382     }
 383
 384     // if wxEntryStart succeeded, we must call wxEntryCleanup even if the code
 385     // below returns or throws
 386     wxCleanupOnExit cleanupOnExit;
 387
 388     WX_SUPPRESS_UNUSED_WARN(cleanupOnExit);
 389
 390     wxTRY
 391     {
 392
 393         // app initialization
 394         if ( !wxTheApp->CallOnInit() )
 395         {
 396             // don't call OnExit() if OnInit() failed
 397             return -1;
 398         }
 399
 400         // ensure that OnExit() is called if OnInit() had succeeded
 401         class CallOnExit
 402         {
 403         public:
 404             ~CallOnExit() { wxTheApp->OnExit(); }
 405         } callOnExit;
 406
 407         WX_SUPPRESS_UNUSED_WARN(callOnExit);
 408
 409         // app execution
 410         return wxTheApp->OnRun();
 411     }
 412     wxCATCH_ALL( wxTheApp->OnUnhandledException(); return -1; )
 413 }
 414
 415 // wrap real wxEntry in a try-except block to be able to call
 416 // OnFatalException() if necessary
 417 #if defined(__WXMSW__) && wxUSE_ON_FATAL_EXCEPTION
 418
 419 #ifdef __WXWINCE__
 420 // For ExitThread
 421 #include "wx/msw/private.h"
 422 #endif
 423
 424 extern unsigned long wxGlobalSEHandler(EXCEPTION_POINTERS *pExcPtrs);
 425
 426 int wxEntry(int& argc, wxChar **argv)
 427 {
 428     __try
 429     {
 430         return wxEntryReal(argc, argv);
 431     }
 432     __except ( wxGlobalSEHandler(GetExceptionInformation()) )
 433     {
 434 #ifdef __WXWINCE__
 435         ::ExitThread(3); // the same exit code as abort()
 436 #else
 437         ::ExitProcess(3); // the same exit code as abort()
 438 #endif
 439
 440 #if !defined(_MSC_VER) || _MSC_VER < 1300
 441         // this code is unreachable but put it here to suppress warnings
 442         // from some compilers
 443         return -1;
 444 #endif
 445     }
 446 }
 447
 448 #endif // __WXMSW__ && wxUSE_ON_FATAL_EXCEPTION
 449
 450 #if wxUSE_UNICODE
 451
 452 // as with wxEntryStart, we provide an ANSI wrapper
 453 int wxEntry(int& argc, char **argv)
 454 {
 455     ConvertArgsToUnicode(argc, argv);
 456
 457     return wxEntry(argc, gs_initData.argv);
 458 }
 459
 460 #endif // wxUSE_UNICODE
 461
 462 // ----------------------------------------------------------------------------
 463 // wxInitialize/wxUninitialize
 464 // ----------------------------------------------------------------------------
 465
 466 bool wxInitialize(int argc, wxChar **argv)
 467 {
 468     wxCRIT_SECT_LOCKER(lockInit, gs_initData.csInit);
 469
 470     if ( gs_initData.nInitCount++ )
 471     {
 472         // already initialized
 473         return true;
 474     }
 475
 476     return wxEntryStart(argc, argv);
 477 }
 478
 479 void wxUninitialize()
 480 {
 481     wxCRIT_SECT_LOCKER(lockInit, gs_initData.csInit);
 482
 483     if ( !--gs_initData.nInitCount )
 484     {
 485         wxEntryCleanup();
 486     }
 487 }
 488