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