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
  39 #if defined(__WXMSW__) && defined(__WXDEBUG__)
  40     #include "wx/msw/msvcrt.h"
  41
  42     static struct EnableMemLeakChecking
  43     {
  44         EnableMemLeakChecking()
  45         {
  46             // do check for memory leaks on program exit (another useful flag
  47             // is _CRTDBG_DELAY_FREE_MEM_DF which doesn't free deallocated
  48             // memory which may be used to simulate low-memory condition)
  49             wxCrtSetDbgFlag(_CRTDBG_LEAK_CHECK_DF);
  50         }
  51     } gs_enableLeakChecks;
  52 #endif // __WXMSW__ && __WXDEBUG__
  53
  54 // ----------------------------------------------------------------------------
  55 // private classes
  56 // ----------------------------------------------------------------------------
  57
  58 // we need a dummy app object if the user doesn't want to create a real one
  59 class wxDummyConsoleApp : public wxAppConsole
  60 {
  61 public:
  62     wxDummyConsoleApp() { }
  63
  64     virtual int OnRun() { wxFAIL_MSG( _T("unreachable code") ); return 0; }
  65
  66     DECLARE_NO_COPY_CLASS(wxDummyConsoleApp)
  67 };
  68
  69 // we need a special kind of auto pointer to wxApp which not only deletes the
  70 // pointer it holds in its dtor but also resets the global application pointer
  71 wxDECLARE_SCOPED_PTR(wxAppConsole, wxAppPtrBase);
  72 wxDEFINE_SCOPED_PTR(wxAppConsole, wxAppPtrBase);
  73
  74 class wxAppPtr : public wxAppPtrBase
  75 {
  76 public:
  77     wxEXPLICIT wxAppPtr(wxAppConsole *ptr = NULL) : wxAppPtrBase(ptr) { }
  78     ~wxAppPtr()
  79     {
  80         if ( get() )
  81         {
  82             // the pointer is going to be deleted in the base class dtor, don't
  83             // leave the dangling pointer!
  84             wxApp::SetInstance(NULL);
  85         }
  86     }
  87
  88     void Set(wxAppConsole *ptr)
  89     {
  90         reset(ptr);
  91
  92         wxApp::SetInstance(ptr);
  93     }
  94
  95     DECLARE_NO_COPY_CLASS(wxAppPtr)
  96 };
  97
  98 // class to ensure that wxAppBase::CleanUp() is called if our Initialize()
  99 // fails
 100 class wxCallAppCleanup
 101 {
 102 public:
 103     wxCallAppCleanup(wxAppConsole *app) : m_app(app) { }
 104     ~wxCallAppCleanup() { if ( m_app ) m_app->CleanUp(); }
 105
 106     void Dismiss() { m_app = NULL; }
 107
 108 private:
 109     wxAppConsole *m_app;
 110 };
 111
 112 // another tiny class which simply exists to ensure that wxEntryCleanup is
 113 // always called
 114 class wxCleanupOnExit
 115 {
 116 public:
 117     ~wxCleanupOnExit() { wxEntryCleanup(); }
 118 };
 119
 120 // ----------------------------------------------------------------------------
 121 // private functions
 122 // ----------------------------------------------------------------------------
 123
 124 // suppress warnings about unused variables
 125 static inline void Use(void *) { }
 126
 127 #define WX_SUPPRESS_UNUSED_WARN(x) Use(&x)
 128
 129 // ----------------------------------------------------------------------------
 130 // initialization data
 131 // ----------------------------------------------------------------------------
 132
 133 static struct InitData
 134 {
 135     InitData()
 136     {
 137         nInitCount = 0;
 138
 139 #if wxUSE_UNICODE
 140         argc = 0;
 141         // argv = NULL; -- not even really needed
 142 #endif // wxUSE_UNICODE
 143     }
 144
 145     // critical section protecting this struct
 146     wxCRIT_SECT_DECLARE_MEMBER(csInit);
 147
 148     // number of times wxInitialize() was called minus the number of times
 149     // wxUninitialize() was
 150     size_t nInitCount;
 151
 152 #if wxUSE_UNICODE
 153     int argc;
 154
 155     // if we receive the command line arguments as ASCII and have to convert
 156     // them to Unicode ourselves (this is the case under Unix but not Windows,
 157     // for example), we remember the converted argv here because we'll have to
 158     // free it when doing cleanup to avoid memory leaks
 159     wchar_t **argv;
 160 #endif // wxUSE_UNICODE
 161
 162     DECLARE_NO_COPY_CLASS(InitData)
 163 } gs_initData;
 164
 165 // ============================================================================
 166 // implementation
 167 // ============================================================================
 168
 169 // ----------------------------------------------------------------------------
 170 // command line arguments ANSI -> Unicode conversion
 171 // ----------------------------------------------------------------------------
 172
 173 #if wxUSE_UNICODE
 174
 175 static void ConvertArgsToUnicode(int argc, char **argv)
 176 {
 177     gs_initData.argv = new wchar_t *[argc + 1];
 178     for ( int i = 0; i < argc; i++ )
 179     {
 180         gs_initData.argv[i] = wxStrdup(wxConvLocal.cMB2WX(argv[i]));
 181     }
 182
 183     gs_initData.argv[argc] = NULL;
 184 }
 185
 186 static void FreeConvertedArgs()
 187 {
 188     if ( gs_initData.argv )
 189     {
 190         for ( int i = 0; i < gs_initData.argc; i++ )
 191         {
 192             free(gs_initData.argv[i]);
 193         }
 194
 195         delete [] gs_initData.argv;
 196         gs_initData.argv = NULL;
 197     }
 198 }
 199
 200 #endif // wxUSE_UNICODE
 201
 202 // ----------------------------------------------------------------------------
 203 // start up
 204 // ----------------------------------------------------------------------------
 205
 206 // initialization which is always done (not customizable) before wxApp creation
 207 static bool DoCommonPreInit()
 208 {
 209     return true;
 210 }
 211
 212 // non customizable initialization done after wxApp creation and initialization
 213 static bool DoCommonPostInit()
 214 {
 215     wxModule::RegisterModules();
 216
 217     return wxModule::InitializeModules();
 218 }
 219
 220 bool wxEntryStart(int& argc, wxChar **argv)
 221 {
 222     // do minimal, always necessary, initialization
 223     // --------------------------------------------
 224
 225     // initialize wxRTTI
 226     if ( !DoCommonPreInit() )
 227     {
 228         return false;
 229     }
 230
 231
 232     // first of all, we need an application object
 233     // -------------------------------------------
 234
 235     // the user might have already created it himself somehow
 236     wxAppPtr app(wxTheApp);
 237     if ( !app.get() )
 238     {
 239         // if not, he might have used IMPLEMENT_APP() to give us a function to
 240         // create it
 241         wxAppInitializerFunction fnCreate = wxApp::GetInitializerFunction();
 242
 243         if ( fnCreate )
 244         {
 245             // he did, try to create the custom wxApp object
 246             app.Set((*fnCreate)());
 247         }
 248     }
 249
 250     if ( !app.get() )
 251     {
 252         // either IMPLEMENT_APP() was not used at all or it failed -- in any
 253         // case we still need something
 254         app.Set(new wxDummyConsoleApp);
 255     }
 256
 257
 258     // wxApp initialization: this can be customized
 259     // --------------------------------------------
 260
 261     if ( !app->Initialize(argc, argv) )
 262     {
 263         return false;
 264     }
 265
 266     wxCallAppCleanup callAppCleanup(app.get());
 267
 268     // for compatibility call the old initialization function too
 269     if ( !app->OnInitGui() )
 270         return false;
 271
 272
 273     // common initialization after wxTheApp creation
 274     // ---------------------------------------------
 275
 276     if ( !DoCommonPostInit() )
 277         return false;
 278
 279
 280     // prevent the smart pointer from destroying its contents
 281     app.release();
 282
 283     // and the cleanup object from doing cleanup
 284     callAppCleanup.Dismiss();
 285
 286     return true;
 287 }
 288
 289 #if wxUSE_UNICODE
 290
 291 // we provide a wxEntryStart() wrapper taking "char *" pointer too
 292 bool wxEntryStart(int& argc, char **argv)
 293 {
 294     ConvertArgsToUnicode(argc, argv);
 295
 296     if ( !wxEntryStart(argc, gs_initData.argv) )
 297     {
 298         FreeConvertedArgs();
 299
 300         return false;
 301     }
 302
 303     return true;
 304 }
 305
 306 #endif // wxUSE_UNICODE
 307
 308 // ----------------------------------------------------------------------------
 309 // clean up
 310 // ----------------------------------------------------------------------------
 311
 312 // cleanup done before destroying wxTheApp
 313 static void DoCommonPreCleanup()
 314 {
 315 #if wxUSE_LOG
 316     // flush the logged messages if any and install a 'safer' log target: the
 317     // default one (wxLogGui) can't be used after the resources are freed just
 318     // below and the user supplied one might be even more unsafe (using any
 319     // wxWindows GUI function is unsafe starting from now)
 320     wxLog::DontCreateOnDemand();
 321
 322     // this will flush the old messages if any
 323     delete wxLog::SetActiveTarget(new wxLogStderr);
 324 #endif // wxUSE_LOG
 325
 326     wxModule::CleanUpModules();
 327 }
 328
 329 // cleanup done after destroying wxTheApp
 330 static void DoCommonPostCleanup()
 331 {
 332     wxClassInfo::CleanUp();
 333
 334     // we can't do this in wxApp itself because it doesn't know if argv had
 335     // been allocated
 336 #if wxUSE_UNICODE
 337     FreeConvertedArgs();
 338 #endif // wxUSE_UNICODE
 339
 340     // check for memory leaks
 341 #if (defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING) || wxUSE_DEBUG_CONTEXT
 342     if (wxDebugContext::CountObjectsLeft(TRUE) > 0)
 343     {
 344         wxLogDebug(wxT("There were memory leaks.\n"));
 345         wxDebugContext::Dump();
 346         wxDebugContext::PrintStatistics();
 347     }
 348 #endif // Debug
 349
 350 #if wxUSE_LOG
 351     // and now delete the last logger as well
 352     delete wxLog::SetActiveTarget(NULL);
 353 #endif // wxUSE_LOG
 354 }
 355
 356 void wxEntryCleanup()
 357 {
 358     DoCommonPreCleanup();
 359
 360
 361     // delete the application object
 362     if ( wxTheApp )
 363     {
 364         wxTheApp->CleanUp();
 365
 366         delete wxTheApp;
 367         wxApp::SetInstance(NULL);
 368     }
 369
 370
 371     DoCommonPostCleanup();
 372 }
 373
 374 // ----------------------------------------------------------------------------
 375 // wxEntry
 376 // ----------------------------------------------------------------------------
 377
 378 #if !defined(__WXMSW__) || !wxUSE_ON_FATAL_EXCEPTION
 379     #define wxEntryReal wxEntry
 380 #endif // !(__WXMSW__ && wxUSE_ON_FATAL_EXCEPTION)
 381
 382 int wxEntryReal(int& argc, wxChar **argv)
 383 {
 384     // library initialization
 385     if ( !wxEntryStart(argc, argv) )
 386     {
 387         return -1;
 388     }
 389
 390     // if wxEntryStart succeeded, we must call wxEntryCleanup even if the code
 391     // below returns or throws
 392     wxCleanupOnExit cleanupOnExit;
 393
 394     WX_SUPPRESS_UNUSED_WARN(cleanupOnExit);
 395
 396     // app initialization
 397     if ( !wxTheApp->CallOnInit() )
 398     {
 399         // don't call OnExit() if OnInit() failed
 400         return -1;
 401     }
 402
 403     // app execution
 404     int retValue = wxTheApp->OnRun();
 405
 406     // app clean up
 407     wxTheApp->OnExit();
 408
 409     return retValue;
 410 }
 411
 412 // wrap real wxEntry in a try-except block to be able to call
 413 // OnFatalException() if necessary
 414 #if defined(__WXMSW__) && wxUSE_ON_FATAL_EXCEPTION
 415
 416 #ifdef __WXWINCE__
 417 // For ExitThread
 418 #include "wx/msw/private.h"
 419 #endif
 420
 421 extern unsigned long wxGlobalSEHandler(EXCEPTION_POINTERS *pExcPtrs);
 422
 423 int wxEntry(int& argc, wxChar **argv)
 424 {
 425     __try
 426     {
 427         return wxEntryReal(argc, argv);
 428     }
 429     __except ( wxGlobalSEHandler(GetExceptionInformation()) )
 430     {
 431 #ifdef __WXWINCE__
 432         ::ExitThread(3); // the same exit code as abort()
 433 #else
 434         ::ExitProcess(3); // the same exit code as abort()
 435 #endif
 436
 437 #if !defined(_MSC_VER) || _MSC_VER < 1300
 438         // this code is unreachable but put it here to suppress warnings
 439         // from some compilers
 440         return -1;
 441 #endif
 442     }
 443 }
 444
 445 #endif // __WXMSW__ && wxUSE_ON_FATAL_EXCEPTION
 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