A little different fix for how to delay the call to __wxCleanup

[wxWidgets.git] / include / wx / utils.h

diff --git a/include/wx/utils.h b/include/wx/utils.h
index a6d2991cc692c52823e7b236d24e19e14792d7e0..f3cb1257fb8f2883290235cf1742fb7d2d1eefbd 100644 (file)
--- a/include/wx/utils.h
+++ b/include/wx/utils.h
@@ -20,13 +20,13 @@
     #pragma interface "utils.h"
 #endif
 
     #pragma interface "utils.h"
 #endif
 

-#include "wx/setup.h"

 #include "wx/object.h"
 #include "wx/list.h"
 #include "wx/object.h"
 #include "wx/list.h"

-#include "wx/window.h"

 #include "wx/filefn.h"
 
 #include "wx/filefn.h"
 

-#include "wx/ioswrap.h"
+// need this for wxGetDiskSpace() as we can't, unfortunately, forward declare
+// wxLongLong
+#include "wx/longlong.h"

 
 #ifdef __X__
     #include <dirent.h>
 
 #ifdef __X__
     #include <dirent.h>


@@ -41,12 +41,9 @@
 
 class WXDLLEXPORT wxProcess;
 class WXDLLEXPORT wxFrame;
 
 class WXDLLEXPORT wxProcess;
 class WXDLLEXPORT wxFrame;

-
-// FIXME should use wxStricmp() instead
-#ifdef __GNUWIN32__
-    #define stricmp strcasecmp
-    #define strnicmp strncasecmp
-#endif
+class WXDLLEXPORT wxWindow;
+class WXDLLEXPORT wxWindowList;
+class WXDLLEXPORT wxPoint;

 
 // ----------------------------------------------------------------------------
 // Macros
 
 // ----------------------------------------------------------------------------
 // Macros


@@ -59,14 +56,14 @@ class WXDLLEXPORT wxFrame;
 // String functions (deprecated, use wxString)
 // ----------------------------------------------------------------------------
 
 // String functions (deprecated, use wxString)
 // ----------------------------------------------------------------------------
 

-// Useful buffer (FIXME VZ: yeah, that is. To be removed!)
+// Useful buffer (FIXME VZ: To be removed!!!)

 WXDLLEXPORT_DATA(extern wxChar*) wxBuffer;
 
 // Make a copy of this string using 'new'
 WXDLLEXPORT wxChar* copystring(const wxChar *s);
 
 // Matches string one within string two regardless of case
 WXDLLEXPORT_DATA(extern wxChar*) wxBuffer;
 
 // Make a copy of this string using 'new'
 WXDLLEXPORT wxChar* copystring(const wxChar *s);
 
 // Matches string one within string two regardless of case

-WXDLLEXPORT bool StringMatch(wxChar *one, wxChar *two, bool subString = TRUE, bool exact = FALSE);
+WXDLLEXPORT bool StringMatch(const wxChar *one, const wxChar *two, bool subString = TRUE, bool exact = FALSE);

 
 // A shorter way of using strcmp
 #define wxStringEq(s1, s2) (s1 && s2 && (wxStrcmp(s1, s2) == 0))
 
 // A shorter way of using strcmp
 #define wxStringEq(s1, s2) (s1 && s2 && (wxStrcmp(s1, s2) == 0))


@@ -76,14 +73,30 @@ WXDLLEXPORT bool StringMatch(wxChar *one, wxChar *two, bool subString = TRUE, bo
 // ----------------------------------------------------------------------------
 
 // Sound the bell
 // ----------------------------------------------------------------------------
 
 // Sound the bell

-WXDLLEXPORT void wxBell(void) ;
+WXDLLEXPORT void wxBell();
+
+// Get OS description as a user-readable string
+WXDLLEXPORT wxString wxGetOsDescription();

 
 // Get OS version
 
 // Get OS version

-WXDLLEXPORT int wxGetOsVersion(int *majorVsn= (int *) NULL,int *minorVsn= (int *) NULL) ;
+WXDLLEXPORT int wxGetOsVersion(int *majorVsn = (int *) NULL,
+                               int *minorVsn = (int *) NULL);

 
 // Return a string with the current date/time
 WXDLLEXPORT wxString wxNow();
 
 
 // Return a string with the current date/time
 WXDLLEXPORT wxString wxNow();
 

+// Return path where wxWindows is installed (mostly useful in Unices)
+WXDLLEXPORT const wxChar *wxGetInstallPrefix();
+// Return path to wxWin data (/usr/share/wx/%{version}) (Unices)
+WXDLLEXPORT wxString wxGetDataDir();
+
+
+#if wxUSE_GUI
+// Don't synthesize KeyUp events holding down a key and producing
+// KeyDown events with autorepeat. On by default and always on
+// in wxMSW.
+WXDLLEXPORT bool wxSetDetectableAutoRepeat( bool flag );
+

 // ----------------------------------------------------------------------------
 // Window ID management
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // Window ID management
 // ----------------------------------------------------------------------------


@@ -103,6 +116,8 @@ WXDLLEXPORT void wxRegisterId(long id);
 // Return the current ID
 WXDLLEXPORT long wxGetCurrentId();
 
 // Return the current ID
 WXDLLEXPORT long wxGetCurrentId();
 

+#endif // wxUSE_GUI
+

 // ----------------------------------------------------------------------------
 // Various conversions
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // Various conversions
 // ----------------------------------------------------------------------------


@@ -110,12 +125,12 @@ WXDLLEXPORT long wxGetCurrentId();
 WXDLLEXPORT_DATA(extern const wxChar*) wxFloatToStringStr;
 WXDLLEXPORT_DATA(extern const wxChar*) wxDoubleToStringStr;
 
 WXDLLEXPORT_DATA(extern const wxChar*) wxFloatToStringStr;
 WXDLLEXPORT_DATA(extern const wxChar*) wxDoubleToStringStr;
 

-WXDLLEXPORT void StringToFloat(wxChar *s, float *number);
+WXDLLEXPORT void StringToFloat(const wxChar *s, float *number);

 WXDLLEXPORT wxChar* FloatToString(float number, const wxChar *fmt = wxFloatToStringStr);
 WXDLLEXPORT wxChar* FloatToString(float number, const wxChar *fmt = wxFloatToStringStr);

-WXDLLEXPORT void StringToDouble(wxChar *s, double *number);
+WXDLLEXPORT void StringToDouble(const wxChar *s, double *number);

 WXDLLEXPORT wxChar* DoubleToString(double number, const wxChar *fmt = wxDoubleToStringStr);
 WXDLLEXPORT wxChar* DoubleToString(double number, const wxChar *fmt = wxDoubleToStringStr);

-WXDLLEXPORT void StringToInt(wxChar *s, int *number);
-WXDLLEXPORT void StringToLong(wxChar *s, long *number);
+WXDLLEXPORT void StringToInt(const wxChar *s, int *number);
+WXDLLEXPORT void StringToLong(const wxChar *s, long *number);

 WXDLLEXPORT wxChar* IntToString(int number);
 WXDLLEXPORT wxChar* LongToString(long number);
 
 WXDLLEXPORT wxChar* IntToString(int number);
 WXDLLEXPORT wxChar* LongToString(long number);
 


@@ -136,6 +151,15 @@ WXDLLEXPORT long wxExecute(wxChar **argv, bool sync = FALSE,
 WXDLLEXPORT long wxExecute(const wxString& command, bool sync = FALSE,
                            wxProcess *process = (wxProcess *) NULL);
 
 WXDLLEXPORT long wxExecute(const wxString& command, bool sync = FALSE,
                            wxProcess *process = (wxProcess *) NULL);
 

+// execute the command capturing its output into an array line by line
+WXDLLEXPORT long wxExecute(const wxString& command,
+                           wxArrayString& output);
+
+// also capture stderr
+WXDLLEXPORT long wxExecute(const wxString& command,
+                           wxArrayString& output,
+                           wxArrayString& error);
+

 enum wxSignal
 {
     wxSIGNONE = 0,  // verify if the process exists under Unix
 enum wxSignal
 {
     wxSIGNONE = 0,  // verify if the process exists under Unix


@@ -159,14 +183,32 @@ enum wxSignal
     // further signals are different in meaning between different Unix systems
 };
 
     // further signals are different in meaning between different Unix systems
 };
 

-// the argument is ignored under Windows - the process is always killed
-WXDLLEXPORT int wxKill(long pid, wxSignal sig = wxSIGTERM);
+enum wxKillError
+{
+    wxKILL_OK,              // no error
+    wxKILL_BAD_SIGNAL,      // no such signal
+    wxKILL_ACCESS_DENIED,   // permission denied
+    wxKILL_NO_PROCESS,      // no such process
+    wxKILL_ERROR            // another, unspecified error
+};
+
+// send the given signal to the process (only NONE and KILL are supported under
+// Windows, all others mean TERM), return 0 if ok and -1 on error
+//
+// return detailed error in rc if not NULL
+WXDLLEXPORT int wxKill(long pid,
+                       wxSignal sig = wxSIGTERM,
+                       wxKillError *rc = NULL);

 
 

-// Execute a command in an interactive shell window
+// Execute a command in an interactive shell window (always synchronously)

 // If no command then just the shell
 WXDLLEXPORT bool wxShell(const wxString& command = wxEmptyString);
 
 // If no command then just the shell
 WXDLLEXPORT bool wxShell(const wxString& command = wxEmptyString);
 

-// Sleep for nSecs seconds under UNIX, do nothing under Windows
+// As wxShell(), but must give a (non interactive) command and its output will
+// be returned in output array
+WXDLLEXPORT bool wxShell(const wxString& command, wxArrayString& output);
+
+// Sleep for nSecs seconds

 WXDLLEXPORT void wxSleep(int nSecs);
 
 // Sleep for a given amount of milliseconds
 WXDLLEXPORT void wxSleep(int nSecs);
 
 // Sleep for a given amount of milliseconds


@@ -175,6 +217,23 @@ WXDLLEXPORT void wxUsleep(unsigned long milliseconds);
 // Get free memory in bytes, or -1 if cannot determine amount (e.g. on UNIX)
 WXDLLEXPORT long wxGetFreeMemory();
 
 // Get free memory in bytes, or -1 if cannot determine amount (e.g. on UNIX)
 WXDLLEXPORT long wxGetFreeMemory();
 

+// should wxApp::OnFatalException() be called?
+WXDLLEXPORT bool wxHandleFatalExceptions(bool doit = TRUE);
+
+// ----------------------------------------------------------------------------
+// Environment variables
+// ----------------------------------------------------------------------------
+
+// returns TRUE if variable exists (value may be NULL if you just want to check
+// for this)
+WXDLLEXPORT bool wxGetEnv(const wxString& var, wxString *value);
+
+// set the env var name to the given value, return TRUE on success
+WXDLLEXPORT bool wxSetEnv(const wxString& var, const wxChar *value);
+
+// remove the env var from environment
+inline bool wxUnsetEnv(const wxString& var) { return wxSetEnv(var, NULL); }
+

 // ----------------------------------------------------------------------------
 // Network and username functions.
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // Network and username functions.
 // ----------------------------------------------------------------------------


@@ -191,6 +250,7 @@ WXDLLEXPORT wxString wxGetHostName();
 
 // Get FQDN
 WXDLLEXPORT wxString wxGetFullHostName();
 
 // Get FQDN
 WXDLLEXPORT wxString wxGetFullHostName();

+WXDLLEXPORT bool wxGetFullHostName(wxChar *buf, int maxSize);

 
 // Get user ID e.g. jacs (this is known as login name under Unix)
 WXDLLEXPORT bool wxGetUserId(wxChar *buf, int maxSize);
 
 // Get user ID e.g. jacs (this is known as login name under Unix)
 WXDLLEXPORT bool wxGetUserId(wxChar *buf, int maxSize);


@@ -201,19 +261,36 @@ WXDLLEXPORT bool wxGetUserName(wxChar *buf, int maxSize);
 WXDLLEXPORT wxString wxGetUserName();
 
 // Get current Home dir and copy to dest (returns pstr->c_str())
 WXDLLEXPORT wxString wxGetUserName();
 
 // Get current Home dir and copy to dest (returns pstr->c_str())

+WXDLLEXPORT wxString wxGetHomeDir();

 WXDLLEXPORT const wxChar* wxGetHomeDir(wxString *pstr);
 
 // Get the user's home dir (caller must copy --- volatile)
 // returns NULL is no HOME dir is known
 WXDLLEXPORT const wxChar* wxGetHomeDir(wxString *pstr);
 
 // Get the user's home dir (caller must copy --- volatile)
 // returns NULL is no HOME dir is known

+#if defined(__UNIX__) && wxUSE_UNICODE
+WXDLLEXPORT const wxMB2WXbuf wxGetUserHome(const wxString& user = wxEmptyString);
+#else

 WXDLLEXPORT wxChar* wxGetUserHome(const wxString& user = wxEmptyString);
 WXDLLEXPORT wxChar* wxGetUserHome(const wxString& user = wxEmptyString);

+#endif
+
+// get number of total/free bytes on the disk where path belongs
+WXDLLEXPORT bool wxGetDiskSpace(const wxString& path,
+                                wxLongLong *pTotal = NULL,
+                                wxLongLong *pFree = NULL);
+
+#if wxUSE_GUI // GUI only things from now on

 
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------

-// Strip out any menu codes
+// Menu accelerators related things

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-WXDLLEXPORT wxChar* wxStripMenuCodes(wxChar *in, wxChar *out = (wxChar *) NULL);
+WXDLLEXPORT wxChar* wxStripMenuCodes(const wxChar *in, wxChar *out = (wxChar *) NULL);

 WXDLLEXPORT wxString wxStripMenuCodes(const wxString& str);
 
 WXDLLEXPORT wxString wxStripMenuCodes(const wxString& str);
 

+#if wxUSE_ACCEL
+class WXDLLEXPORT wxAcceleratorEntry;
+WXDLLEXPORT wxAcceleratorEntry *wxGetAccelFromString(const wxString& label);
+#endif // wxUSE_ACCEL
+

 // ----------------------------------------------------------------------------
 // Window search
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // Window search
 // ----------------------------------------------------------------------------


@@ -229,6 +306,11 @@ WXDLLEXPORT wxWindow* wxFindWindowByName(const wxString& name, wxWindow *parent
 // Returns menu item id or -1 if none.
 WXDLLEXPORT int wxFindMenuItemId(wxFrame *frame, const wxString& menuString, const wxString& itemString);
 
 // Returns menu item id or -1 if none.
 WXDLLEXPORT int wxFindMenuItemId(wxFrame *frame, const wxString& menuString, const wxString& itemString);
 

+// Find the wxWindow at the given point. wxGenericFindWindowAtPoint
+// is always present but may be less reliable than a native version.
+WXDLLEXPORT wxWindow* wxGenericFindWindowAtPoint(const wxPoint& pt);
+WXDLLEXPORT wxWindow* wxFindWindowAtPoint(const wxPoint& pt);
+

 // ----------------------------------------------------------------------------
 // Message/event queue helpers
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // Message/event queue helpers
 // ----------------------------------------------------------------------------


@@ -236,9 +318,15 @@ WXDLLEXPORT int wxFindMenuItemId(wxFrame *frame, const wxString& menuString, con
 // Yield to other apps/messages
 WXDLLEXPORT bool wxYield();
 
 // Yield to other apps/messages
 WXDLLEXPORT bool wxYield();
 

+// Like wxYield, but fails silently if the yield is recursive.
+WXDLLEXPORT bool wxYieldIfNeeded();
+

 // Yield to other apps/messages and disable user input
 WXDLLEXPORT bool wxSafeYield(wxWindow *win = NULL);
 
 // Yield to other apps/messages and disable user input
 WXDLLEXPORT bool wxSafeYield(wxWindow *win = NULL);
 

+// Enable or disable input to all top level windows
+WXDLLEXPORT void wxEnableTopLevelWindows(bool enable = TRUE);
+

 // Check whether this window wants to process messages, e.g. Stop button
 // in long calculations.
 WXDLLEXPORT bool wxCheckForInterrupt(wxWindow *wnd);
 // Check whether this window wants to process messages, e.g. Stop button
 // in long calculations.
 WXDLLEXPORT bool wxCheckForInterrupt(wxWindow *wnd);


@@ -246,6 +334,18 @@ WXDLLEXPORT bool wxCheckForInterrupt(wxWindow *wnd);
 // Consume all events until no more left
 WXDLLEXPORT void wxFlushEvents();
 
 // Consume all events until no more left
 WXDLLEXPORT void wxFlushEvents();
 

+// a class which disables all windows (except, may be, thegiven one) in its
+// ctor and enables them back in its dtor
+class WXDLLEXPORT wxWindowDisabler
+{
+public:
+    wxWindowDisabler(wxWindow *winToSkip = (wxWindow *)NULL);
+    ~wxWindowDisabler();
+
+private:
+    wxWindowList *m_winDisabled;
+};
+

 // ----------------------------------------------------------------------------
 // Cursors
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // Cursors
 // ----------------------------------------------------------------------------


@@ -267,25 +367,18 @@ class WXDLLEXPORT wxBusyCursor
 public:
     wxBusyCursor(wxCursor* cursor = wxHOURGLASS_CURSOR)
         { wxBeginBusyCursor(cursor); }
 public:
     wxBusyCursor(wxCursor* cursor = wxHOURGLASS_CURSOR)
         { wxBeginBusyCursor(cursor); }

-   ~wxBusyCursor()
+    ~wxBusyCursor()

         { wxEndBusyCursor(); }
         { wxEndBusyCursor(); }

-};

 
 

-// ----------------------------------------------------------------------------
-// Error message functions used by wxWindows (deprecated, use wxLog)
-// ----------------------------------------------------------------------------
+    // FIXME: These two methods are currently only implemented (and needed?)
+    //        in wxGTK.  BusyCursor handling should probably be moved to
+    //        common code since the wxGTK and wxMSW implementations are very
+    //        similar except for wxMSW using HCURSOR directly instead of
+    //        wxCursor..  -- RL.
+    static const wxCursor &GetStoredCursor();
+    static const wxCursor GetBusyCursor();
+};

 
 

-// Format a message on the standard error (UNIX) or the debugging
-// stream (Windows)
-WXDLLEXPORT void wxDebugMsg(const wxChar *fmt ...) ;
-
-// Non-fatal error (continues)
-WXDLLEXPORT_DATA(extern const wxChar*) wxInternalErrorStr;
-WXDLLEXPORT void wxError(const wxString& msg, const wxString& title = wxInternalErrorStr);
-
-// Fatal error (exits)
-WXDLLEXPORT_DATA(extern const wxChar*) wxFatalErrorStr;
-WXDLLEXPORT void wxFatalError(const wxString& msg, const wxString& title = wxFatalErrorStr);

 
 // ----------------------------------------------------------------------------
 // Reading and writing resources (eg WIN.INI, .Xdefaults)
 
 // ----------------------------------------------------------------------------
 // Reading and writing resources (eg WIN.INI, .Xdefaults)


@@ -308,49 +401,55 @@ void WXDLLEXPORT wxGetMousePosition( int* x, int* y );
 // MSW only: get user-defined resource from the .res file.
 // Returns NULL or newly-allocated memory, so use delete[] to clean up.
 #ifdef __WXMSW__
 // MSW only: get user-defined resource from the .res file.
 // Returns NULL or newly-allocated memory, so use delete[] to clean up.
 #ifdef __WXMSW__

-WXDLLEXPORT extern const wxChar* wxUserResourceStr;
-WXDLLEXPORT wxChar* wxLoadUserResource(const wxString& resourceName, const wxString& resourceType = wxUserResourceStr);
-
-// Implemented in utils.cpp: VC++, Win95 only. Sets up a console for standard
-// input/output
-WXDLLEXPORT void wxRedirectIOToConsole();
-
+    WXDLLEXPORT extern const wxChar* wxUserResourceStr;
+    WXDLLEXPORT wxChar* wxLoadUserResource(const wxString& resourceName, const wxString& resourceType = wxUserResourceStr);

 #endif // MSW
 
 // ----------------------------------------------------------------------------
 // Display and colorss (X only)
 // ----------------------------------------------------------------------------
 
 #endif // MSW
 
 // ----------------------------------------------------------------------------
 // Display and colorss (X only)
 // ----------------------------------------------------------------------------
 

+#ifdef __WXGTK__
+    void *wxGetDisplay();
+#endif
+

 #ifdef __X__
     WXDisplay *wxGetDisplay();
     bool wxSetDisplay(const wxString& display_name);
     wxString wxGetDisplayName();
 #ifdef __X__
     WXDisplay *wxGetDisplay();
     bool wxSetDisplay(const wxString& display_name);
     wxString wxGetDisplayName();

-#endif
+#endif // X or GTK+

 
 #ifdef __X__
 
 
 #ifdef __X__
 

-#include <X11/Xlib.h>
+#ifdef __VMS__ // Xlib.h for VMS is not (yet) compatible with C++
+               // The resulting warnings are switched off here
+#pragma message disable nosimpint
+#endif
+// #include <X11/Xlib.h>
+#ifdef __VMS__
+#pragma message enable nosimpint
+#endif

 
 

-#define wxMAX_RGB           0xff
-#define wxMAX_SV            1000
-#define wxSIGN(x)           ((x < 0) ? -x : x)
-#define wxH_WEIGHT          4
-#define wxS_WEIGHT          1
-#define wxV_WEIGHT          2
+#endif //__X__

 
 

-typedef struct wx_hsv {
-                        int h,s,v;
-                      } wxHSV;
+#endif // wxUSE_GUI

 
 

-#define wxMax3(x,y,z) ((x > y) ? ((x > z) ? x : z) : ((y > z) ? y : z))
-#define wxMin3(x,y,z) ((x < y) ? ((x < z) ? x : z) : ((y < z) ? y : z))
+// ----------------------------------------------------------------------------
+// Error message functions used by wxWindows (deprecated, use wxLog)
+// ----------------------------------------------------------------------------

 
 

-void wxHSVToXColor(wxHSV *hsv,XColor *xcolor);
-void wxXColorToHSV(wxHSV *hsv,XColor *xcolor);
-void wxAllocNearestColor(Display *display,Colormap colormap,XColor *xcolor);
-void wxAllocColor(Display *display,Colormap colormap,XColor *xcolor);
+// Format a message on the standard error (UNIX) or the debugging
+// stream (Windows)
+WXDLLEXPORT void wxDebugMsg(const wxChar *fmt ...);
+
+// Non-fatal error (continues)
+WXDLLEXPORT_DATA(extern const wxChar*) wxInternalErrorStr;
+WXDLLEXPORT void wxError(const wxString& msg, const wxString& title = wxInternalErrorStr);
+
+// Fatal error (exits)
+WXDLLEXPORT_DATA(extern const wxChar*) wxFatalErrorStr;
+WXDLLEXPORT void wxFatalError(const wxString& msg, const wxString& title = wxFatalErrorStr);

 
 

-#endif //__X__

 
 #endif
     // _WX_UTILSH__
 
 #endif
     // _WX_UTILSH__