1 /////////////////////////////////////////////////////////////////////////////
2 // Name: 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"
29 #include "wx/filefn.h"
31 #include "wx/thread.h"
37 #include "wx/ptr_scpd.h"
38 #include "wx/module.h"
39 #include "wx/except.h"
41 #if defined(__WXMSW__) && defined(__WXDEBUG__)
42 #include "wx/msw/msvcrt.h"
44 static struct EnableMemLeakChecking
46 EnableMemLeakChecking()
48 // do 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 // __WXMSW__ && __WXDEBUG__
56 // ----------------------------------------------------------------------------
58 // ----------------------------------------------------------------------------
60 // we need a dummy app object if the user doesn't want to create a real one
61 class wxDummyConsoleApp
: public wxAppConsole
64 wxDummyConsoleApp() { }
66 virtual int OnRun() { wxFAIL_MSG( _T("unreachable code") ); return 0; }
68 DECLARE_NO_COPY_CLASS(wxDummyConsoleApp
)
71 // we need a special kind of auto pointer to wxApp which not only deletes the
72 // pointer it holds in its dtor but also resets the global application pointer
73 wxDECLARE_SCOPED_PTR(wxAppConsole
, wxAppPtrBase
)
74 wxDEFINE_SCOPED_PTR(wxAppConsole
, wxAppPtrBase
)
76 class wxAppPtr
: public wxAppPtrBase
79 wxEXPLICIT
wxAppPtr(wxAppConsole
*ptr
= NULL
) : wxAppPtrBase(ptr
) { }
84 // the pointer is going to be deleted in the base class dtor, don't
85 // leave the dangling pointer!
86 wxApp::SetInstance(NULL
);
90 void Set(wxAppConsole
*ptr
)
94 wxApp::SetInstance(ptr
);
97 DECLARE_NO_COPY_CLASS(wxAppPtr
)
100 // class to ensure that wxAppBase::CleanUp() is called if our Initialize()
102 class wxCallAppCleanup
105 wxCallAppCleanup(wxAppConsole
*app
) : m_app(app
) { }
106 ~wxCallAppCleanup() { if ( m_app
) m_app
->CleanUp(); }
108 void Dismiss() { m_app
= NULL
; }
114 // another tiny class which simply exists to ensure that wxEntryCleanup is
116 class wxCleanupOnExit
119 ~wxCleanupOnExit() { wxEntryCleanup(); }
122 // ----------------------------------------------------------------------------
124 // ----------------------------------------------------------------------------
126 // suppress warnings about unused variables
127 static inline void Use(void *) { }
129 #define WX_SUPPRESS_UNUSED_WARN(x) Use(&x)
131 // ----------------------------------------------------------------------------
132 // initialization data
133 // ----------------------------------------------------------------------------
135 static struct InitData
143 // argv = NULL; -- not even really needed
144 #endif // wxUSE_UNICODE
147 // critical section protecting this struct
148 wxCRIT_SECT_DECLARE_MEMBER(csInit
);
150 // number of times wxInitialize() was called minus the number of times
151 // wxUninitialize() was
157 // if we receive the command line arguments as ASCII and have to convert
158 // them to Unicode ourselves (this is the case under Unix but not Windows,
159 // for example), we remember the converted argv here because we'll have to
160 // free it when doing cleanup to avoid memory leaks
162 #endif // wxUSE_UNICODE
164 DECLARE_NO_COPY_CLASS(InitData
)
167 // ============================================================================
169 // ============================================================================
171 // ----------------------------------------------------------------------------
172 // command line arguments ANSI -> Unicode conversion
173 // ----------------------------------------------------------------------------
177 static void ConvertArgsToUnicode(int argc
, char **argv
)
179 gs_initData
.argv
= new wchar_t *[argc
+ 1];
180 for ( int i
= 0; i
< argc
; i
++ )
182 wxWCharBuffer
buf(wxConvLocal
.cMB2WX(argv
[i
]));
183 gs_initData
.argv
[i
] = buf
? wxStrdup(buf
) : NULL
;
186 gs_initData
.argc
= argc
;
187 gs_initData
.argv
[argc
] = NULL
;
190 static void FreeConvertedArgs()
192 if ( gs_initData
.argv
)
194 for ( int i
= 0; i
< gs_initData
.argc
; i
++ )
196 free(gs_initData
.argv
[i
]);
199 delete [] gs_initData
.argv
;
200 gs_initData
.argv
= NULL
;
201 gs_initData
.argc
= 0;
205 #endif // wxUSE_UNICODE
207 // ----------------------------------------------------------------------------
209 // ----------------------------------------------------------------------------
211 // initialization which is always done (not customizable) before wxApp creation
212 static bool DoCommonPreInit()
215 // install temporary log sink: we can't use wxLogGui before wxApp is
216 // constructed and if we use wxLogStderr, all messages during
217 // initialization simply disappear under Windows
219 // note that we will delete this log target below
220 wxLog::SetActiveTarget(new wxLogBuffer
);
226 // non customizable initialization done after wxApp creation and initialization
227 static bool DoCommonPostInit()
229 wxModule::RegisterModules();
231 if ( !wxModule::InitializeModules() )
233 wxLogError(_("Initialization failed in post init, aborting."));
240 bool wxEntryStart(int& argc
, wxChar
**argv
)
242 // do minimal, always necessary, initialization
243 // --------------------------------------------
246 if ( !DoCommonPreInit() )
252 // first of all, we need an application object
253 // -------------------------------------------
255 // the user might have already created it himself somehow
256 wxAppPtr
app(wxTheApp
);
259 // if not, he might have used IMPLEMENT_APP() to give us a function to
261 wxAppInitializerFunction fnCreate
= wxApp::GetInitializerFunction();
265 // he did, try to create the custom wxApp object
266 app
.Set((*fnCreate
)());
272 // either IMPLEMENT_APP() was not used at all or it failed -- in any
273 // case we still need something
274 app
.Set(new wxDummyConsoleApp
);
278 // wxApp initialization: this can be customized
279 // --------------------------------------------
281 if ( !app
->Initialize(argc
, argv
) )
286 wxCallAppCleanup
callAppCleanup(app
.get());
288 // for compatibility call the old initialization function too
289 if ( !app
->OnInitGui() )
293 // common initialization after wxTheApp creation
294 // ---------------------------------------------
296 if ( !DoCommonPostInit() )
300 // prevent the smart pointer from destroying its contents
303 // and the cleanup object from doing cleanup
304 callAppCleanup
.Dismiss();
307 // now that we have a valid wxApp (wxLogGui would have crashed if we used
308 // it before now), we can delete the temporary sink we had created for the
309 // initialization messages -- the next time logging function is called, the
310 // sink will be recreated but this time wxAppTraits will be used
311 delete wxLog::SetActiveTarget(NULL
);
319 // we provide a wxEntryStart() wrapper taking "char *" pointer too
320 bool wxEntryStart(int& argc
, char **argv
)
322 ConvertArgsToUnicode(argc
, argv
);
324 if ( !wxEntryStart(argc
, gs_initData
.argv
) )
334 #endif // wxUSE_UNICODE
336 // ----------------------------------------------------------------------------
338 // ----------------------------------------------------------------------------
340 // cleanup done before destroying wxTheApp
341 static void DoCommonPreCleanup()
344 // flush the logged messages if any and install a 'safer' log target: the
345 // default one (wxLogGui) can't be used after the resources are freed just
346 // below and the user supplied one might be even more unsafe (using any
347 // wxWidgets GUI function is unsafe starting from now)
348 wxLog::DontCreateOnDemand();
350 // this will flush the old messages if any
351 delete wxLog::SetActiveTarget(new wxLogStderr
);
355 // cleanup done after destroying wxTheApp
356 static void DoCommonPostCleanup()
358 wxModule::CleanUpModules();
360 // we can't do this in wxApp itself because it doesn't know if argv had
364 #endif // wxUSE_UNICODE
366 // use Set(NULL) and not Get() to avoid creating a message output object on
367 // demand when we just want to delete it
368 delete wxMessageOutput::Set(NULL
);
371 // and now delete the last logger as well
372 delete wxLog::SetActiveTarget(NULL
);
376 void wxEntryCleanup()
378 DoCommonPreCleanup();
381 // delete the application object
387 wxApp::SetInstance(NULL
);
391 DoCommonPostCleanup();
394 // ----------------------------------------------------------------------------
396 // ----------------------------------------------------------------------------
398 // for MSW the real wxEntry is defined in msw/main.cpp
400 #define wxEntryReal wxEntry
403 int wxEntryReal(int& argc
, wxChar
**argv
)
405 // library initialization
406 if ( !wxEntryStart(argc
, argv
) )
409 // flush any log messages explaining why we failed
410 delete wxLog::SetActiveTarget(NULL
);
415 // if wxEntryStart succeeded, we must call wxEntryCleanup even if the code
416 // below returns or throws
417 wxCleanupOnExit cleanupOnExit
;
419 WX_SUPPRESS_UNUSED_WARN(cleanupOnExit
);
424 // app initialization
425 if ( !wxTheApp
->CallOnInit() )
427 // don't call OnExit() if OnInit() failed
431 // ensure that OnExit() is called if OnInit() had succeeded
435 ~CallOnExit() { wxTheApp
->OnExit(); }
438 WX_SUPPRESS_UNUSED_WARN(callOnExit
);
441 return wxTheApp
->OnRun();
443 wxCATCH_ALL( wxTheApp
->OnUnhandledException(); return -1; )
448 // as with wxEntryStart, we provide an ANSI wrapper
449 int wxEntry(int& argc
, char **argv
)
451 ConvertArgsToUnicode(argc
, argv
);
453 return wxEntry(argc
, gs_initData
.argv
);
456 #endif // wxUSE_UNICODE
458 // ----------------------------------------------------------------------------
459 // wxInitialize/wxUninitialize
460 // ----------------------------------------------------------------------------
462 bool wxInitialize(int argc
, wxChar
**argv
)
464 wxCRIT_SECT_LOCKER(lockInit
, gs_initData
.csInit
);
466 if ( gs_initData
.nInitCount
++ )
468 // already initialized
472 return wxEntryStart(argc
, argv
);
475 void wxUninitialize()
477 wxCRIT_SECT_LOCKER(lockInit
, gs_initData
.csInit
);
479 if ( --gs_initData
.nInitCount
== 0 )