1 ///////////////////////////////////////////////////////////////////////////////
2 // Name:        wx/init.h
3 // Purpose:     wxWidgets initialization and finalization functions
4 // Author:      Vadim Zeitlin
5 // Modified by:
6 // Created:     29.06.2003
7 // Copyright:   (c) 2003 Vadim Zeitlin <vadim@wxwidgets.org>
8 // Licence:     wxWindows licence
9 ///////////////////////////////////////////////////////////////////////////////
10 
11 #ifndef _WX_INIT_H_
12 #define _WX_INIT_H_
13 
14 #include "wx/defs.h"
15 #include "wx/chartype.h"
16 
17 // ----------------------------------------------------------------------------
18 // wxEntry helper functions which allow to have more fine grained control
19 // ----------------------------------------------------------------------------
20 
21 // do common initialization, return true if ok (in this case wxEntryCleanup
22 // must be called later), otherwise the program can't use wxWidgets at all
23 //
24 // this function also creates wxTheApp as a side effect, if wxIMPLEMENT_APP
25 // hadn't been used a dummy default application object is created
26 //
27 // note that the parameters may be modified, this is why we pass them by
28 // reference!
29 extern bool WXDLLIMPEXP_BASE wxEntryStart(int& argc, wxChar **argv);
30 
31 // free the resources allocated by the library in wxEntryStart() and shut it
32 // down (wxEntryStart() may be called again afterwards if necessary)
33 extern void WXDLLIMPEXP_BASE wxEntryCleanup();
34 
35 
36 // ----------------------------------------------------------------------------
37 // wxEntry: this function initializes the library, runs the main event loop
38 //          and cleans it up
39 // ----------------------------------------------------------------------------
40 
41 // note that other, platform-specific, overloads of wxEntry may exist as well
42 // but this one always exists under all platforms
43 //
44 // returns the program exit code
45 extern int WXDLLIMPEXP_BASE wxEntry(int& argc, wxChar **argv);
46 
47 // we overload wxEntry[Start]() to take "char **" pointers too
48 #if wxUSE_UNICODE
49 
50 extern bool WXDLLIMPEXP_BASE wxEntryStart(int& argc, char **argv);
51 extern int WXDLLIMPEXP_BASE wxEntry(int& argc, char **argv);
52 
53 #endif// wxUSE_UNICODE
54 
55 // Under Windows we define additional wxEntry() overloads with signature
56 // compatible with WinMain() and not the traditional main().
57 #ifdef __WINDOWS__
58     #include "wx/msw/init.h"
59 #endif
60 
61 // ----------------------------------------------------------------------------
62 // Using the library without (explicit) application object: you may avoid using
63 // wxDECLARE_APP and wxIMPLEMENT_APP macros and call the functions below instead at
64 // the program startup and termination
65 // ----------------------------------------------------------------------------
66 
67 // initialize the library (may be called as many times as needed, but each
68 // call to wxInitialize() must be matched by wxUninitialize())
69 extern bool WXDLLIMPEXP_BASE wxInitialize();
70 extern bool WXDLLIMPEXP_BASE wxInitialize(int& argc, wxChar **argv);
71 #if wxUSE_UNICODE
72 extern bool WXDLLIMPEXP_BASE wxInitialize(int& argc, char **argv);
73 #endif
74 
75 // clean up -- the library can't be used any more after the last call to
76 // wxUninitialize()
77 extern void WXDLLIMPEXP_BASE wxUninitialize();
78 
79 // create an object of this class on stack to initialize/cleanup the library
80 // automatically
81 class WXDLLIMPEXP_BASE wxInitializer
82 {
83 public:
84     // initialize the library
wxInitializer()85     wxInitializer()
86     {
87         m_ok = wxInitialize();
88     }
89 
wxInitializer(int & argc,wxChar ** argv)90     wxInitializer(int& argc, wxChar **argv)
91     {
92         m_ok = wxInitialize(argc, argv);
93     }
94 
95 #if wxUSE_UNICODE
wxInitializer(int & argc,char ** argv)96     wxInitializer(int& argc, char **argv)
97     {
98         m_ok = wxInitialize(argc, argv);
99     }
100 #endif // wxUSE_UNICODE
101 
102     // has the initialization been successful? (explicit test)
IsOk()103     bool IsOk() const { return m_ok; }
104 
105     // has the initialization been successful? (implicit test)
106     operator bool() const { return m_ok; }
107 
108     // dtor only does clean up if we initialized the library properly
~wxInitializer()109     ~wxInitializer() { if ( m_ok ) wxUninitialize(); }
110 
111 private:
112     bool m_ok;
113 };
114 
115 #endif // _WX_INIT_H_
116 
117