X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/18fd783ca852e77288a49bfdc9952e2035b4f312..bff995bf711f6df8ce080a119ef17e52ba8813ec:/include/wx/utils.h diff --git a/include/wx/utils.h b/include/wx/utils.h index 8c55231237..a737731cac 100644 --- a/include/wx/utils.h +++ b/include/wx/utils.h @@ -12,137 +12,294 @@ #ifndef _WX_UTILSH__ #define _WX_UTILSH__ +// ---------------------------------------------------------------------------- +// headers +// ---------------------------------------------------------------------------- + #ifdef __GNUG__ -#pragma interface "utils.h" + #pragma interface "utils.h" #endif #include "wx/setup.h" #include "wx/object.h" #include "wx/list.h" -#include "wx/window.h" #include "wx/filefn.h" -#include "wx/ioswrap.h" - -class wxProcess; +// need this for wxGetDiskSpace() as we can't, unfortunately, forward declare +// wxLongLong +#include "wx/longlong.h" #ifdef __X__ -#ifndef __VMS__ -/*steve: these two are not known under VMS */ -#include -#include -#endif + #include + #include #endif #include -#ifdef __GNUWIN32__ -#define stricmp strcasecmp -#define strnicmp strncasecmp -#endif - +// ---------------------------------------------------------------------------- // Forward declaration +// ---------------------------------------------------------------------------- + +class WXDLLEXPORT wxProcess; class WXDLLEXPORT wxFrame; +class WXDLLEXPORT wxWindow; +class WXDLLEXPORT wxWindowList; +class WXDLLEXPORT wxPoint; -// Stupid ASCII macros -#define wxToUpper(C) (((C) >= 'a' && (C) <= 'z')? (C) - 'a' + 'A': (C)) -#define wxToLower(C) (((C) >= 'A' && (C) <= 'Z')? (C) - 'A' + 'a': (C)) +// ---------------------------------------------------------------------------- +// Macros +// ---------------------------------------------------------------------------- -// Return a string with the current date/time -WXDLLEXPORT wxString wxNow(void); +#define wxMax(a,b) (((a) > (b)) ? (a) : (b)) +#define wxMin(a,b) (((a) < (b)) ? (a) : (b)) + +// ---------------------------------------------------------------------------- +// String functions (deprecated, use wxString) +// ---------------------------------------------------------------------------- + +// Useful buffer (FIXME VZ: To be removed!!!) +WXDLLEXPORT_DATA(extern wxChar*) wxBuffer; // Make a copy of this string using 'new' -WXDLLEXPORT char* copystring(const char *s); +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); + +// A shorter way of using strcmp +#define wxStringEq(s1, s2) (s1 && s2 && (wxStrcmp(s1, s2) == 0)) + +// ---------------------------------------------------------------------------- +// Miscellaneous functions +// ---------------------------------------------------------------------------- + +// Sound the bell +WXDLLEXPORT void wxBell(); + +// Get OS description as a user-readable string +WXDLLEXPORT wxString wxGetOsDescription(); + +// Get OS version +WXDLLEXPORT int wxGetOsVersion(int *majorVsn = (int *) NULL, + int *minorVsn = (int *) NULL); + +// 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(); + + +#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 +// ---------------------------------------------------------------------------- // Generate a unique ID -WXDLLEXPORT long wxNewId(void); -#define NewId wxNewId +WXDLLEXPORT long wxNewId(); +#if !defined(NewId) && defined(WXWIN_COMPATIBILITY) + #define NewId wxNewId +#endif // Ensure subsequent IDs don't clash with this one WXDLLEXPORT void wxRegisterId(long id); -#define RegisterId wxRegisterId +#if !defined(RegisterId) && defined(WXWIN_COMPATIBILITY) + #define RegisterId wxRegisterId +#endif // Return the current ID -WXDLLEXPORT long wxGetCurrentId(void); +WXDLLEXPORT long wxGetCurrentId(); -// Useful buffer -WXDLLEXPORT_DATA(extern char*) wxBuffer; - -WXDLLEXPORT_DATA(extern const char*) wxFloatToStringStr; -WXDLLEXPORT_DATA(extern const char*) wxDoubleToStringStr; +#endif // wxUSE_GUI +// ---------------------------------------------------------------------------- // Various conversions -WXDLLEXPORT void StringToFloat(char *s, float *number); -WXDLLEXPORT char* FloatToString(float number, const char *fmt = wxFloatToStringStr); -WXDLLEXPORT void StringToDouble(char *s, double *number); -WXDLLEXPORT char* DoubleToString(double number, const char *fmt = wxDoubleToStringStr); -WXDLLEXPORT void StringToInt(char *s, int *number); -WXDLLEXPORT void StringToLong(char *s, long *number); -WXDLLEXPORT char* IntToString(int number); -WXDLLEXPORT char* LongToString(long number); +// ---------------------------------------------------------------------------- -// Matches string one within string two regardless of case -WXDLLEXPORT bool StringMatch(char *one, char *two, bool subString = TRUE, bool exact = FALSE); +WXDLLEXPORT_DATA(extern const wxChar*) wxFloatToStringStr; +WXDLLEXPORT_DATA(extern const wxChar*) wxDoubleToStringStr; -// A shorter way of using strcmp -#define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) == 0)) +WXDLLEXPORT void StringToFloat(wxChar *s, float *number); +WXDLLEXPORT wxChar* FloatToString(float number, const wxChar *fmt = wxFloatToStringStr); +WXDLLEXPORT void StringToDouble(wxChar *s, double *number); +WXDLLEXPORT wxChar* DoubleToString(double number, const wxChar *fmt = wxDoubleToStringStr); +WXDLLEXPORT void StringToInt(wxChar *s, int *number); +WXDLLEXPORT void StringToLong(wxChar *s, long *number); +WXDLLEXPORT wxChar* IntToString(int number); +WXDLLEXPORT wxChar* LongToString(long number); // Convert 2-digit hex number to decimal WXDLLEXPORT int wxHexToDec(const wxString& buf); // Convert decimal integer to 2-character hex string -WXDLLEXPORT void wxDecToHex(int dec, char *buf); +WXDLLEXPORT void wxDecToHex(int dec, wxChar *buf); WXDLLEXPORT wxString wxDecToHex(int dec); +// ---------------------------------------------------------------------------- +// Process management +// ---------------------------------------------------------------------------- + // Execute another program. Returns 0 if there was an error, a PID otherwise. -WXDLLEXPORT long wxExecute(char **argv, bool sync = FALSE, +WXDLLEXPORT long wxExecute(wxChar **argv, bool sync = FALSE, wxProcess *process = (wxProcess *) NULL); WXDLLEXPORT long wxExecute(const wxString& command, bool sync = FALSE, wxProcess *process = (wxProcess *) NULL); -#define wxSIGTERM 1 +// execute the command capturing its output into an array line by line +WXDLLEXPORT long wxExecute(const wxString& command, + wxArrayString& output); -WXDLLEXPORT int wxKill(long pid, int sig=wxSIGTERM); +// also capture stderr +WXDLLEXPORT long wxExecute(const wxString& command, + wxArrayString& output, + wxArrayString& error); -// Execute a command in an interactive shell window +enum wxSignal +{ + wxSIGNONE = 0, // verify if the process exists under Unix + wxSIGHUP, + wxSIGINT, + wxSIGQUIT, + wxSIGILL, + wxSIGTRAP, + wxSIGABRT, + wxSIGIOT = wxSIGABRT, // another name + wxSIGEMT, + wxSIGFPE, + wxSIGKILL, + wxSIGBUS, + wxSIGSEGV, + wxSIGSYS, + wxSIGPIPE, + wxSIGALRM, + wxSIGTERM + + // further signals are different in meaning between different Unix systems +}; + +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 (always synchronously) // 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 wxUsleep(unsigned long milliseconds); + // Get free memory in bytes, or -1 if cannot determine amount (e.g. on UNIX) -WXDLLEXPORT long wxGetFreeMemory(void); +WXDLLEXPORT long wxGetFreeMemory(); -// Consume all events until no more left -WXDLLEXPORT void wxFlushEvents(void); +// should wxApp::OnFatalException() be called? +WXDLLEXPORT bool wxHandleFatalExceptions(bool doit = TRUE); + +// ---------------------------------------------------------------------------- +// Environment variables +// ---------------------------------------------------------------------------- -/* - * Network and username functions. - * - */ +// 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. +// ---------------------------------------------------------------------------- + +// NB: "char *" functions are deprecated, use wxString ones! // Get eMail address -WXDLLEXPORT bool wxGetEmailAddress(char *buf, int maxSize); +WXDLLEXPORT bool wxGetEmailAddress(wxChar *buf, int maxSize); +WXDLLEXPORT wxString wxGetEmailAddress(); // Get hostname. -WXDLLEXPORT bool wxGetHostName(char *buf, int maxSize); -WXDLLEXPORT bool wxGetHostName(wxString& buf); +WXDLLEXPORT bool wxGetHostName(wxChar *buf, int maxSize); +WXDLLEXPORT wxString wxGetHostName(); -// Get user ID e.g. jacs -WXDLLEXPORT bool wxGetUserId(char *buf, int maxSize); -WXDLLEXPORT bool wxGetUserId(wxString& buf); +// 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); +WXDLLEXPORT wxString wxGetUserId(); // Get user name e.g. Julian Smart -WXDLLEXPORT bool wxGetUserName(char *buf, int maxSize); -WXDLLEXPORT bool wxGetUserName(wxString& buf); +WXDLLEXPORT bool wxGetUserName(wxChar *buf, int maxSize); +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 +#if defined(__UNIX__) && wxUSE_UNICODE +WXDLLEXPORT const wxMB2WXbuf wxGetUserHome(const wxString& user = wxEmptyString); +#else +WXDLLEXPORT wxChar* wxGetUserHome(const wxString& user = wxEmptyString); +#endif + +#ifdef __WXMAC__ +WXDLLEXPORT wxString wxMacFindFolder(short vRefNum, + OSType folderType, + Boolean createFolder); +#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 - */ -WXDLLEXPORT char* wxStripMenuCodes(char *in, char *out = (char *) NULL); +// ---------------------------------------------------------------------------- +// Menu accelerators related things +// ---------------------------------------------------------------------------- + +WXDLLEXPORT wxChar* wxStripMenuCodes(wxChar *in, wxChar *out = (wxChar *) NULL); WXDLLEXPORT wxString wxStripMenuCodes(const wxString& str); +#if wxUSE_ACCEL +class WXDLLEXPORT wxAcceleratorEntry; +WXDLLEXPORT wxAcceleratorEntry *wxGetAccelFromString(const wxString& label); +#endif // wxUSE_ACCEL + +// ---------------------------------------------------------------------------- +// Window search +// ---------------------------------------------------------------------------- + // Find the window/widget with the given title or label. // Pass a parent to begin the search from, or NULL to look through // all windows. @@ -154,29 +311,49 @@ 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); -/* -#if (!defined(__MINMAX_DEFINED) && !defined(max)) -#define max(a,b) (((a) > (b)) ? (a) : (b)) -#define min(a,b) (((a) < (b)) ? (a) : (b)) -#define __MINMAX_DEFINED 1 -#endif -*/ +// 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); -#define wxMax(a,b) (((a) > (b)) ? (a) : (b)) -#define wxMin(a,b) (((a) < (b)) ? (a) : (b)) +// ---------------------------------------------------------------------------- +// Message/event queue helpers +// ---------------------------------------------------------------------------- // Yield to other apps/messages -WXDLLEXPORT bool wxYield(void); +WXDLLEXPORT bool wxYield(); -// Format a message on the standard error (UNIX) or the debugging -// stream (Windows) -WXDLLEXPORT void wxDebugMsg(const char *fmt ...) ; - -// Sound the bell -WXDLLEXPORT void wxBell(void) ; - -// Get OS version -WXDLLEXPORT int wxGetOsVersion(int *majorVsn= (int *) NULL,int *minorVsn= (int *) NULL) ; +// 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); + +// 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); + +// 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 +// ---------------------------------------------------------------------------- // Set the cursor to the busy cursor for all windows class WXDLLEXPORT wxCursor; @@ -184,77 +361,84 @@ WXDLLEXPORT_DATA(extern wxCursor*) wxHOURGLASS_CURSOR; WXDLLEXPORT void wxBeginBusyCursor(wxCursor *cursor = wxHOURGLASS_CURSOR); // Restore cursor to normal -WXDLLEXPORT void wxEndBusyCursor(void); - +WXDLLEXPORT void wxEndBusyCursor(); + // TRUE if we're between the above two calls -WXDLLEXPORT bool wxIsBusy(void); +WXDLLEXPORT bool wxIsBusy(); // Convenience class so we can just create a wxBusyCursor object on the stack class WXDLLEXPORT wxBusyCursor { - public: - inline wxBusyCursor(wxCursor* cursor = wxHOURGLASS_CURSOR) { wxBeginBusyCursor(cursor); } - inline ~wxBusyCursor() { wxEndBusyCursor(); } +public: + wxBusyCursor(wxCursor* cursor = wxHOURGLASS_CURSOR) + { wxBeginBusyCursor(cursor); } + ~wxBusyCursor() + { wxEndBusyCursor(); } + + // 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(); }; -/* Error message functions used by wxWindows */ - -// Non-fatal error (continues) -WXDLLEXPORT_DATA(extern const char*) wxInternalErrorStr; -WXDLLEXPORT void wxError(const wxString& msg, const wxString& title = wxInternalErrorStr); - -// Fatal error (exits) -WXDLLEXPORT_DATA(extern const char*) wxFatalErrorStr; -WXDLLEXPORT void wxFatalError(const wxString& msg, const wxString& title = wxFatalErrorStr); +// ---------------------------------------------------------------------------- // Reading and writing resources (eg WIN.INI, .Xdefaults) +// ---------------------------------------------------------------------------- + #if wxUSE_RESOURCES WXDLLEXPORT bool wxWriteResource(const wxString& section, const wxString& entry, const wxString& value, const wxString& file = wxEmptyString); WXDLLEXPORT bool wxWriteResource(const wxString& section, const wxString& entry, float value, const wxString& file = wxEmptyString); WXDLLEXPORT bool wxWriteResource(const wxString& section, const wxString& entry, long value, const wxString& file = wxEmptyString); WXDLLEXPORT bool wxWriteResource(const wxString& section, const wxString& entry, int value, const wxString& file = wxEmptyString); -WXDLLEXPORT bool wxGetResource(const wxString& section, const wxString& entry, char **value, const wxString& file = wxEmptyString); +WXDLLEXPORT bool wxGetResource(const wxString& section, const wxString& entry, wxChar **value, const wxString& file = wxEmptyString); WXDLLEXPORT bool wxGetResource(const wxString& section, const wxString& entry, float *value, const wxString& file = wxEmptyString); WXDLLEXPORT bool wxGetResource(const wxString& section, const wxString& entry, long *value, const wxString& file = wxEmptyString); WXDLLEXPORT bool wxGetResource(const wxString& section, const wxString& entry, int *value, const wxString& file = wxEmptyString); #endif // wxUSE_RESOURCES -// Get current Home dir and copy to dest (returns pstr->c_str()) -WXDLLEXPORT const char* wxGetHomeDir(wxString *pstr); - -// Get the user's home dir (caller must copy--- volatile) -// returns NULL is no HOME dir is known -WXDLLEXPORT char* wxGetUserHome(const wxString& user = wxEmptyString); - -// Check whether this window wants to process messages, e.g. Stop button -// in long calculations. -WXDLLEXPORT bool wxCheckForInterrupt(wxWindow *wnd); - 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__ -WXDLLEXPORT extern const char* wxUserResourceStr; -WXDLLEXPORT char* wxLoadUserResource(const wxString& resourceName, const wxString& resourceType = wxUserResourceStr); +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(); +#endif // MSW + +// ---------------------------------------------------------------------------- +// Display and colorss (X only) +// ---------------------------------------------------------------------------- + +#ifdef __WXGTK__ + void *wxGetDisplay(); #endif -// X only #ifdef __X__ -WXDisplay *wxGetDisplay(); -bool wxSetDisplay(const wxString& display_name); -wxString wxGetDisplayName(); -#endif + WXDisplay *wxGetDisplay(); + bool wxSetDisplay(const wxString& display_name); + wxString wxGetDisplayName(); +#endif // X or GTK+ #ifdef __X__ +#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 +#ifdef __VMS__ +#pragma message enable nosimpint +#endif #define wxMAX_RGB 0xff #define wxMAX_SV 1000 @@ -266,13 +450,10 @@ wxString wxGetDisplayName(); typedef struct wx_hsv { int h,s,v; } wxHSV; - + #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)) -#define wxMax2(x,y) ((x > y) ? x : y) -#define wxMin2(x,y) ((x < y) ? x : y) - void wxHSVToXColor(wxHSV *hsv,XColor *xcolor); void wxXColorToHSV(wxHSV *hsv,XColor *xcolor); void wxAllocNearestColor(Display *display,Colormap colormap,XColor *xcolor); @@ -280,5 +461,24 @@ void wxAllocColor(Display *display,Colormap colormap,XColor *xcolor); #endif //__X__ +#endif // wxUSE_GUI + +// ---------------------------------------------------------------------------- +// Error message functions used by wxWindows (deprecated, use wxLog) +// ---------------------------------------------------------------------------- + +// 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 // _WX_UTILSH__