1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/common/init.cpp
3 // Purpose: initialisation for the library
4 // Author: Vadim Zeitlin
8 // Copyright: (c) Vadim Zeitlin
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
20 #include "wx/wxprec.h"
28 #include "wx/filefn.h"
31 #include "wx/module.h"
35 #include "wx/thread.h"
37 #include "wx/scopedptr.h"
38 #include "wx/except.h"
40 #if defined(__WXMSW__)
41 #include "wx/msw/msvcrt.h"
43 #ifdef wxCrtSetDbgFlag
44 static struct EnableMemLeakChecking
46 EnableMemLeakChecking()
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
);
53 } gs_enableLeakChecks
;
54 #endif // wxCrtSetDbgFlag
57 // ----------------------------------------------------------------------------
59 // ----------------------------------------------------------------------------
61 // we need a dummy app object if the user doesn't want to create a real one
62 class wxDummyConsoleApp
: public wxAppConsole
65 wxDummyConsoleApp() { }
67 virtual int OnRun() { wxFAIL_MSG( _T("unreachable code") ); return 0; }
68 virtual bool DoYield(bool, long) { return true; }
70 wxDECLARE_NO_COPY_CLASS(wxDummyConsoleApp
);
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
)
78 class wxAppPtr
: public wxAppPtrBase
81 wxEXPLICIT
wxAppPtr(wxAppConsole
*ptr
= NULL
) : wxAppPtrBase(ptr
) { }
86 // the pointer is going to be deleted in the base class dtor, don't
87 // leave the dangling pointer!
88 wxApp::SetInstance(NULL
);
92 void Set(wxAppConsole
*ptr
)
96 wxApp::SetInstance(ptr
);
99 wxDECLARE_NO_COPY_CLASS(wxAppPtr
);
102 // class to ensure that wxAppBase::CleanUp() is called if our Initialize()
104 class wxCallAppCleanup
107 wxCallAppCleanup(wxAppConsole
*app
) : m_app(app
) { }
108 ~wxCallAppCleanup() { if ( m_app
) m_app
->CleanUp(); }
110 void Dismiss() { m_app
= NULL
; }
116 // another tiny class which simply exists to ensure that wxEntryCleanup is
118 class wxCleanupOnExit
121 ~wxCleanupOnExit() { wxEntryCleanup(); }
124 // ----------------------------------------------------------------------------
126 // ----------------------------------------------------------------------------
128 // suppress warnings about unused variables
129 static inline void Use(void *) { }
131 #define WX_SUPPRESS_UNUSED_WARN(x) Use(&x)
133 // ----------------------------------------------------------------------------
134 // initialization data
135 // ----------------------------------------------------------------------------
137 static struct InitData
145 // argv = NULL; -- not even really needed
146 #endif // wxUSE_UNICODE
149 // critical section protecting this struct
150 wxCRIT_SECT_DECLARE_MEMBER(csInit
);
152 // number of times wxInitialize() was called minus the number of times
153 // wxUninitialize() was
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
164 #endif // wxUSE_UNICODE
166 wxDECLARE_NO_COPY_CLASS(InitData
);
169 // ============================================================================
171 // ============================================================================
173 // ----------------------------------------------------------------------------
174 // command line arguments ANSI -> Unicode conversion
175 // ----------------------------------------------------------------------------
179 static void ConvertArgsToUnicode(int argc
, char **argv
)
181 gs_initData
.argv
= new wchar_t *[argc
+ 1];
183 for ( int i
= 0; i
< argc
; i
++ )
186 wxWCharBuffer
buf(wxConvFileName
->cMB2WX(argv
[i
]));
188 wxWCharBuffer
buf(wxConvLocal
.cMB2WX(argv
[i
]));
192 wxLogWarning(_("Command line argument %d couldn't be converted to Unicode and will be ignored."),
197 gs_initData
.argv
[wargc
++] = wxStrdup(buf
);
201 gs_initData
.argc
= wargc
;
202 gs_initData
.argv
[wargc
] = NULL
;
205 static void FreeConvertedArgs()
207 if ( gs_initData
.argv
)
209 for ( int i
= 0; i
< gs_initData
.argc
; i
++ )
211 free(gs_initData
.argv
[i
]);
214 delete [] gs_initData
.argv
;
215 gs_initData
.argv
= NULL
;
216 gs_initData
.argc
= 0;
220 #endif // wxUSE_UNICODE
222 // ----------------------------------------------------------------------------
224 // ----------------------------------------------------------------------------
226 // initialization which is always done (not customizable) before wxApp creation
227 static bool DoCommonPreInit()
230 // Reset logging in case we were cleaned up and are being reinitialized.
231 wxLog::DoCreateOnDemand();
237 // non customizable initialization done after wxApp creation and initialization
238 static bool DoCommonPostInit()
240 wxModule::RegisterModules();
242 if ( !wxModule::InitializeModules() )
244 wxLogError(_("Initialization failed in post init, aborting."));
251 bool wxEntryStart(int& argc
, wxChar
**argv
)
253 // do minimal, always necessary, initialization
254 // --------------------------------------------
257 if ( !DoCommonPreInit() )
261 // first of all, we need an application object
262 // -------------------------------------------
264 // the user might have already created it himself somehow
265 wxAppPtr
app(wxTheApp
);
268 // if not, he might have used IMPLEMENT_APP() to give us a function to
270 wxAppInitializerFunction fnCreate
= wxApp::GetInitializerFunction();
274 // he did, try to create the custom wxApp object
275 app
.Set((*fnCreate
)());
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
);
287 // wxApp initialization: this can be customized
288 // --------------------------------------------
290 if ( !app
->Initialize(argc
, argv
) )
293 // remember, possibly modified (e.g. due to removal of toolkit-specific
294 // parameters), command line arguments in member variables
298 wxCallAppCleanup
callAppCleanup(app
.get());
301 // common initialization after wxTheApp creation
302 // ---------------------------------------------
304 if ( !DoCommonPostInit() )
308 // prevent the smart pointer from destroying its contents
311 // and the cleanup object from doing cleanup
312 callAppCleanup
.Dismiss();
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
);
327 // we provide a wxEntryStart() wrapper taking "char *" pointer too
328 bool wxEntryStart(int& argc
, char **argv
)
330 ConvertArgsToUnicode(argc
, argv
);
332 if ( !wxEntryStart(gs_initData
.argc
, gs_initData
.argv
) )
342 #endif // wxUSE_UNICODE
344 // ----------------------------------------------------------------------------
346 // ----------------------------------------------------------------------------
348 // cleanup done before destroying wxTheApp
349 static void DoCommonPreCleanup()
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)
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
);
364 // cleanup done after destroying wxTheApp
365 static void DoCommonPostCleanup()
367 wxModule::CleanUpModules();
369 // we can't do this in wxApp itself because it doesn't know if argv had
373 #endif // wxUSE_UNICODE
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
);
380 // and now delete the last logger as well
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
);
391 void wxEntryCleanup()
393 DoCommonPreCleanup();
396 // delete the application object
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
);
410 DoCommonPostCleanup();
413 // ----------------------------------------------------------------------------
415 // ----------------------------------------------------------------------------
417 // for MSW the real wxEntry is defined in msw/main.cpp
419 #define wxEntryReal wxEntry
422 int wxEntryReal(int& argc
, wxChar
**argv
)
424 // library initialization
425 if ( !wxEntryStart(argc
, argv
) )
428 // flush any log messages explaining why we failed
429 delete wxLog::SetActiveTarget(NULL
);
434 // if wxEntryStart succeeded, we must call wxEntryCleanup even if the code
435 // below returns or throws
436 wxCleanupOnExit cleanupOnExit
;
438 WX_SUPPRESS_UNUSED_WARN(cleanupOnExit
);
442 // app initialization
443 if ( !wxTheApp
->CallOnInit() )
445 // don't call OnExit() if OnInit() failed
449 // ensure that OnExit() is called if OnInit() had succeeded
453 ~CallOnExit() { wxTheApp
->OnExit(); }
456 WX_SUPPRESS_UNUSED_WARN(callOnExit
);
459 return wxTheApp
->OnRun();
461 wxCATCH_ALL( wxTheApp
->OnUnhandledException(); return -1; )
466 // as with wxEntryStart, we provide an ANSI wrapper
467 int wxEntry(int& argc
, char **argv
)
469 ConvertArgsToUnicode(argc
, argv
);
471 return wxEntry(gs_initData
.argc
, gs_initData
.argv
);
474 #endif // wxUSE_UNICODE
476 // ----------------------------------------------------------------------------
477 // wxInitialize/wxUninitialize
478 // ----------------------------------------------------------------------------
480 bool wxInitialize(int argc
, wxChar
**argv
)
482 wxCRIT_SECT_LOCKER(lockInit
, gs_initData
.csInit
);
484 if ( gs_initData
.nInitCount
++ )
486 // already initialized
490 return wxEntryStart(argc
, argv
);
493 void wxUninitialize()
495 wxCRIT_SECT_LOCKER(lockInit
, gs_initData
.csInit
);
497 if ( --gs_initData
.nInitCount
== 0 )