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/ptr_scpd.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     int wargc = 0;
 180     for ( int i = 0; i < argc; i++ )
 181     {
 182 #ifdef __DARWIN__
 183         wxWCharBuffer buf(wxConvFileName->cMB2WX(argv[i]));
 184 #else
 185         wxWCharBuffer buf(wxConvLocal.cMB2WX(argv[i]));
 186 #endif
 187         if ( !buf )
 188         {
 189             wxLogWarning(_("Command line argument %d couldn't be converted to Unicode and will be ignored."),
 190                          i);
 191         }
 192         else // converted ok
 193         {
 194             gs_initData.argv[wargc++] = wxStrdup(buf);
 195         }
 196     }
 197
 198     gs_initData.argc = wargc;
 199     gs_initData.argv[wargc] = NULL;
 200 }
 201
 202 static void FreeConvertedArgs()
 203 {
 204     if ( gs_initData.argv )
 205     {
 206         for ( int i = 0; i < gs_initData.argc; i++ )
 207         {
 208             free(gs_initData.argv[i]);
 209         }
 210
 211         delete [] gs_initData.argv;
 212         gs_initData.argv = NULL;
 213         gs_initData.argc = 0;
 214     }
 215 }
 216
 217 #endif // wxUSE_UNICODE
 218
 219 // ----------------------------------------------------------------------------
 220 // start up
 221 // ----------------------------------------------------------------------------
 222
 223 // initialization which is always done (not customizable) before wxApp creation
 224 static bool DoCommonPreInit()
 225 {
 226 #if wxUSE_LOG
 227     // Reset logging in case we were cleaned up and are being reinitialized.
 228     wxLog::DoCreateOnDemand();
 229
 230     // install temporary log sink: we can't use wxLogGui before wxApp is
 231     // constructed and if we use wxLogStderr, all messages during
 232     // initialization simply disappear under Windows
 233     //
 234     // note that we will delete this log target below
 235     delete wxLog::SetActiveTarget(new wxLogBuffer);
 236 #endif // wxUSE_LOG
 237
 238     return true;
 239 }
 240
 241 // non customizable initialization done after wxApp creation and initialization
 242 static bool DoCommonPostInit()
 243 {
 244     wxModule::RegisterModules();
 245
 246     if ( !wxModule::InitializeModules() )
 247     {
 248         wxLogError(_("Initialization failed in post init, aborting."));
 249         return false;
 250     }
 251
 252     return true;
 253 }
 254
 255 bool wxEntryStart(int& argc, wxChar **argv)
 256 {
 257     // do minimal, always necessary, initialization
 258     // --------------------------------------------
 259
 260     // initialize wxRTTI
 261     if ( !DoCommonPreInit() )
 262     {
 263         return false;
 264     }
 265
 266
 267     // first of all, we need an application object
 268     // -------------------------------------------
 269
 270     // the user might have already created it himself somehow
 271     wxAppPtr app(wxTheApp);
 272     if ( !app.get() )
 273     {
 274         // if not, he might have used IMPLEMENT_APP() to give us a function to
 275         // create it
 276         wxAppInitializerFunction fnCreate = wxApp::GetInitializerFunction();
 277
 278         if ( fnCreate )
 279         {
 280             // he did, try to create the custom wxApp object
 281             app.Set((*fnCreate)());
 282         }
 283     }
 284
 285     if ( !app.get() )
 286     {
 287         // either IMPLEMENT_APP() was not used at all or it failed -- in any
 288         // case we still need something
 289         app.Set(new wxDummyConsoleApp);
 290     }
 291
 292
 293     // wxApp initialization: this can be customized
 294     // --------------------------------------------
 295
 296     if ( !app->Initialize(argc, argv) )
 297     {
 298         return false;
 299     }
 300
 301     wxCallAppCleanup callAppCleanup(app.get());
 302
 303     // for compatibility call the old initialization function too
 304     if ( !app->OnInitGui() )
 305         return false;
 306
 307
 308     // common initialization after wxTheApp creation
 309     // ---------------------------------------------
 310
 311     if ( !DoCommonPostInit() )
 312         return false;
 313
 314
 315     // prevent the smart pointer from destroying its contents
 316     app.release();
 317
 318     // and the cleanup object from doing cleanup
 319     callAppCleanup.Dismiss();
 320
 321 #if wxUSE_LOG
 322     // now that we have a valid wxApp (wxLogGui would have crashed if we used
 323     // it before now), we can delete the temporary sink we had created for the
 324     // initialization messages -- the next time logging function is called, the
 325     // sink will be recreated but this time wxAppTraits will be used
 326     delete wxLog::SetActiveTarget(NULL);
 327 #endif // wxUSE_LOG
 328
 329     return true;
 330 }
 331
 332 #if wxUSE_UNICODE
 333
 334 // we provide a wxEntryStart() wrapper taking "char *" pointer too
 335 bool wxEntryStart(int& argc, char **argv)
 336 {
 337     ConvertArgsToUnicode(argc, argv);
 338
 339     if ( !wxEntryStart(gs_initData.argc, gs_initData.argv) )
 340     {
 341         FreeConvertedArgs();
 342
 343         return false;
 344     }
 345
 346     return true;
 347 }
 348
 349 #endif // wxUSE_UNICODE
 350
 351 // ----------------------------------------------------------------------------
 352 // clean up
 353 // ----------------------------------------------------------------------------
 354
 355 // cleanup done before destroying wxTheApp
 356 static void DoCommonPreCleanup()
 357 {
 358 #if wxUSE_LOG
 359     // flush the logged messages if any and install a 'safer' log target: the
 360     // default one (wxLogGui) can't be used after the resources are freed just
 361     // below and the user supplied one might be even more unsafe (using any
 362     // wxWidgets GUI function is unsafe starting from now)
 363     wxLog::DontCreateOnDemand();
 364
 365     // this will flush the old messages if any
 366     delete wxLog::SetActiveTarget(new wxLogStderr);
 367 #endif // wxUSE_LOG
 368 }
 369
 370 // cleanup done after destroying wxTheApp
 371 static void DoCommonPostCleanup()
 372 {
 373     wxModule::CleanUpModules();
 374
 375     // we can't do this in wxApp itself because it doesn't know if argv had
 376     // been allocated
 377 #if wxUSE_UNICODE
 378     FreeConvertedArgs();
 379 #endif // wxUSE_UNICODE
 380
 381     // use Set(NULL) and not Get() to avoid creating a message output object on
 382     // demand when we just want to delete it
 383     delete wxMessageOutput::Set(NULL);
 384
 385 #if wxUSE_LOG
 386     // and now delete the last logger as well
 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
 443         // app initialization
 444         if ( !wxTheApp->CallOnInit() )
 445         {
 446             // don't call OnExit() if OnInit() failed
 447             return -1;
 448         }
 449
 450         // ensure that OnExit() is called if OnInit() had succeeded
 451         class CallOnExit
 452         {
 453         public:
 454             ~CallOnExit() { wxTheApp->OnExit(); }
 455         } callOnExit;
 456
 457         WX_SUPPRESS_UNUSED_WARN(callOnExit);
 458
 459         // app execution
 460         return wxTheApp->OnRun();
 461     }
 462     wxCATCH_ALL( wxTheApp->OnUnhandledException(); return -1; )
 463 }
 464
 465 #if wxUSE_UNICODE
 466
 467 // as with wxEntryStart, we provide an ANSI wrapper
 468 int wxEntry(int& argc, char **argv)
 469 {
 470     ConvertArgsToUnicode(argc, argv);
 471
 472     return wxEntry(gs_initData.argc, gs_initData.argv);
 473 }
 474
 475 #endif // wxUSE_UNICODE
 476
 477 // ----------------------------------------------------------------------------
 478 // wxInitialize/wxUninitialize
 479 // ----------------------------------------------------------------------------
 480
 481 bool wxInitialize(int argc, wxChar **argv)
 482 {
 483     wxCRIT_SECT_LOCKER(lockInit, gs_initData.csInit);
 484
 485     if ( gs_initData.nInitCount++ )
 486     {
 487         // already initialized
 488         return true;
 489     }
 490
 491     return wxEntryStart(argc, argv);
 492 }
 493
 494 void wxUninitialize()
 495 {
 496     wxCRIT_SECT_LOCKER(lockInit, gs_initData.csInit);
 497
 498     if ( --gs_initData.nInitCount == 0 )
 499     {
 500         wxEntryCleanup();
 501     }
 502 }