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