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/thread.h"
  31     #include "wx/intl.h"
  32     #include "wx/module.h"
  33 #endif
  34
  35 #include "wx/init.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     for ( int i = 0; i < argc; i++ )
 180     {
 181         wxWCharBuffer buf(wxConvLocal.cMB2WX(argv[i]));
 182         gs_initData.argv[i] = buf ? wxStrdup(buf) : NULL;
 183     }
 184
 185     gs_initData.argc = argc;
 186     gs_initData.argv[argc] = NULL;
 187 }
 188
 189 static void FreeConvertedArgs()
 190 {
 191     if ( gs_initData.argv )
 192     {
 193         for ( int i = 0; i < gs_initData.argc; i++ )
 194         {
 195             free(gs_initData.argv[i]);
 196         }
 197
 198         delete [] gs_initData.argv;
 199         gs_initData.argv = NULL;
 200         gs_initData.argc = 0;
 201     }
 202 }
 203
 204 #endif // wxUSE_UNICODE
 205
 206 // ----------------------------------------------------------------------------
 207 // start up
 208 // ----------------------------------------------------------------------------
 209
 210 // initialization which is always done (not customizable) before wxApp creation
 211 static bool DoCommonPreInit()
 212 {
 213 #if wxUSE_LOG
 214     // install temporary log sink: we can't use wxLogGui before wxApp is
 215     // constructed and if we use wxLogStderr, all messages during
 216     // initialization simply disappear under Windows
 217     //
 218     // note that we will delete this log target below
 219     delete wxLog::SetActiveTarget(new wxLogBuffer);
 220 #endif // wxUSE_LOG
 221
 222     return true;
 223 }
 224
 225 // non customizable initialization done after wxApp creation and initialization
 226 static bool DoCommonPostInit()
 227 {
 228     wxModule::RegisterModules();
 229
 230     if ( !wxModule::InitializeModules() )
 231     {
 232         wxLogError(_("Initialization failed in post init, aborting."));
 233         return false;
 234     }
 235
 236     return true;
 237 }
 238
 239 bool wxEntryStart(int& argc, wxChar **argv)
 240 {
 241     // do minimal, always necessary, initialization
 242     // --------------------------------------------
 243
 244     // initialize wxRTTI
 245     if ( !DoCommonPreInit() )
 246     {
 247         return false;
 248     }
 249
 250
 251     // first of all, we need an application object
 252     // -------------------------------------------
 253
 254     // the user might have already created it himself somehow
 255     wxAppPtr app(wxTheApp);
 256     if ( !app.get() )
 257     {
 258         // if not, he might have used IMPLEMENT_APP() to give us a function to
 259         // create it
 260         wxAppInitializerFunction fnCreate = wxApp::GetInitializerFunction();
 261
 262         if ( fnCreate )
 263         {
 264             // he did, try to create the custom wxApp object
 265             app.Set((*fnCreate)());
 266         }
 267     }
 268
 269     if ( !app.get() )
 270     {
 271         // either IMPLEMENT_APP() was not used at all or it failed -- in any
 272         // case we still need something
 273         app.Set(new wxDummyConsoleApp);
 274     }
 275
 276
 277     // wxApp initialization: this can be customized
 278     // --------------------------------------------
 279
 280     if ( !app->Initialize(argc, argv) )
 281     {
 282         return false;
 283     }
 284
 285     wxCallAppCleanup callAppCleanup(app.get());
 286
 287     // for compatibility call the old initialization function too
 288     if ( !app->OnInitGui() )
 289         return false;
 290
 291
 292     // common initialization after wxTheApp creation
 293     // ---------------------------------------------
 294
 295     if ( !DoCommonPostInit() )
 296         return false;
 297
 298
 299     // prevent the smart pointer from destroying its contents
 300     app.release();
 301
 302     // and the cleanup object from doing cleanup
 303     callAppCleanup.Dismiss();
 304
 305 #if wxUSE_LOG
 306     // now that we have a valid wxApp (wxLogGui would have crashed if we used
 307     // it before now), we can delete the temporary sink we had created for the
 308     // initialization messages -- the next time logging function is called, the
 309     // sink will be recreated but this time wxAppTraits will be used
 310     delete wxLog::SetActiveTarget(NULL);
 311 #endif // wxUSE_LOG
 312
 313     return true;
 314 }
 315
 316 #if wxUSE_UNICODE
 317
 318 // we provide a wxEntryStart() wrapper taking "char *" pointer too
 319 bool wxEntryStart(int& argc, char **argv)
 320 {
 321     ConvertArgsToUnicode(argc, argv);
 322
 323     if ( !wxEntryStart(argc, gs_initData.argv) )
 324     {
 325         FreeConvertedArgs();
 326
 327         return false;
 328     }
 329
 330     return true;
 331 }
 332
 333 #endif // wxUSE_UNICODE
 334
 335 // ----------------------------------------------------------------------------
 336 // clean up
 337 // ----------------------------------------------------------------------------
 338
 339 // cleanup done before destroying wxTheApp
 340 static void DoCommonPreCleanup()
 341 {
 342 #if wxUSE_LOG
 343     // flush the logged messages if any and install a 'safer' log target: the
 344     // default one (wxLogGui) can't be used after the resources are freed just
 345     // below and the user supplied one might be even more unsafe (using any
 346     // wxWidgets GUI function is unsafe starting from now)
 347     wxLog::DontCreateOnDemand();
 348
 349     // this will flush the old messages if any
 350     delete wxLog::SetActiveTarget(new wxLogStderr);
 351 #endif // wxUSE_LOG
 352 }
 353
 354 // cleanup done after destroying wxTheApp
 355 static void DoCommonPostCleanup()
 356 {
 357     wxModule::CleanUpModules();
 358
 359     // we can't do this in wxApp itself because it doesn't know if argv had
 360     // been allocated
 361 #if wxUSE_UNICODE
 362     FreeConvertedArgs();
 363 #endif // wxUSE_UNICODE
 364
 365     // use Set(NULL) and not Get() to avoid creating a message output object on
 366     // demand when we just want to delete it
 367     delete wxMessageOutput::Set(NULL);
 368
 369 #if wxUSE_LOG
 370     // and now delete the last logger as well
 371     delete wxLog::SetActiveTarget(NULL);
 372 #endif // wxUSE_LOG
 373 }
 374
 375 void wxEntryCleanup()
 376 {
 377     DoCommonPreCleanup();
 378
 379
 380     // delete the application object
 381     if ( wxTheApp )
 382     {
 383         wxTheApp->CleanUp();
 384
 385         delete wxTheApp;
 386         wxApp::SetInstance(NULL);
 387     }
 388
 389
 390     DoCommonPostCleanup();
 391 }
 392
 393 // ----------------------------------------------------------------------------
 394 // wxEntry
 395 // ----------------------------------------------------------------------------
 396
 397 // for MSW the real wxEntry is defined in msw/main.cpp
 398 #ifndef __WXMSW__
 399     #define wxEntryReal wxEntry
 400 #endif // !__WXMSW__
 401
 402 int wxEntryReal(int& argc, wxChar **argv)
 403 {
 404     // library initialization
 405     if ( !wxEntryStart(argc, argv) )
 406     {
 407 #if wxUSE_LOG
 408         // flush any log messages explaining why we failed
 409         delete wxLog::SetActiveTarget(NULL);
 410 #endif
 411         return -1;
 412     }
 413
 414     // if wxEntryStart succeeded, we must call wxEntryCleanup even if the code
 415     // below returns or throws
 416     wxCleanupOnExit cleanupOnExit;
 417
 418     WX_SUPPRESS_UNUSED_WARN(cleanupOnExit);
 419
 420     wxTRY
 421     {
 422
 423         // app initialization
 424         if ( !wxTheApp->CallOnInit() )
 425         {
 426             // don't call OnExit() if OnInit() failed
 427             return -1;
 428         }
 429
 430         // ensure that OnExit() is called if OnInit() had succeeded
 431         class CallOnExit
 432         {
 433         public:
 434             ~CallOnExit() { wxTheApp->OnExit(); }
 435         } callOnExit;
 436
 437         WX_SUPPRESS_UNUSED_WARN(callOnExit);
 438
 439         // app execution
 440         return wxTheApp->OnRun();
 441     }
 442     wxCATCH_ALL( wxTheApp->OnUnhandledException(); return -1; )
 443 }
 444
 445 #if wxUSE_UNICODE
 446
 447 // as with wxEntryStart, we provide an ANSI wrapper
 448 int wxEntry(int& argc, char **argv)
 449 {
 450     ConvertArgsToUnicode(argc, argv);
 451
 452     return wxEntry(argc, gs_initData.argv);
 453 }
 454
 455 #endif // wxUSE_UNICODE
 456
 457 // ----------------------------------------------------------------------------
 458 // wxInitialize/wxUninitialize
 459 // ----------------------------------------------------------------------------
 460
 461 bool wxInitialize(int argc, wxChar **argv)
 462 {
 463     wxCRIT_SECT_LOCKER(lockInit, gs_initData.csInit);
 464
 465     if ( gs_initData.nInitCount++ )
 466     {
 467         // already initialized
 468         return true;
 469     }
 470
 471     return wxEntryStart(argc, argv);
 472 }
 473
 474 void wxUninitialize()
 475 {
 476     wxCRIT_SECT_LOCKER(lockInit, gs_initData.csInit);
 477
 478     if ( --gs_initData.nInitCount == 0 )
 479     {
 480         wxEntryCleanup();
 481     }
 482 }