X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d6b9496a96223cc5164e5785485d7d622fd9b5e6..01cb1c26171efc494b94d77e4351362bb0eb2e7d:/include/wx/utils.h?ds=sidebyside diff --git a/include/wx/utils.h b/include/wx/utils.h index 7a72994f53..076d32c6d7 100644 --- a/include/wx/utils.h +++ b/include/wx/utils.h @@ -16,17 +16,17 @@ // headers // ---------------------------------------------------------------------------- -#ifdef __GNUG__ +#if defined(__GNUG__) && !defined(__APPLE__) #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" +// need this for wxGetDiskSpace() as we can't, unfortunately, forward declare +// wxLongLong +#include "wx/longlong.h" #ifdef __X__ #include @@ -41,12 +41,9 @@ 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 @@ -59,31 +56,50 @@ class WXDLLEXPORT wxFrame; // String functions (deprecated, use wxString) // ---------------------------------------------------------------------------- -// Useful buffer (FIXME VZ: yeah, that is. To be removed!) -WXDLLEXPORT_DATA(extern char*) wxBuffer; +// Useful buffer (FIXME VZ: To be removed!!!) +// Now only needed in Mac and MSW ports +#if !defined(__WXMOTIF__) && !defined(__WXGTK__) && !defined(__WXX11__) && !defined(__WXMGL__) +WXDLLEXPORT_DATA(extern wxChar*) wxBuffer; +#endif // 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(char *one, char *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 && (strcmp(s1, s2) == 0)) +#define wxStringEq(s1, s2) (s1 && s2 && (wxStrcmp(s1, s2) == 0)) // ---------------------------------------------------------------------------- // Miscellaneous functions // ---------------------------------------------------------------------------- // Sound the bell -WXDLLEXPORT void wxBell(void) ; +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) ; +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(); +// 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 // ---------------------------------------------------------------------------- @@ -103,39 +119,75 @@ WXDLLEXPORT void wxRegisterId(long id); // Return the current ID WXDLLEXPORT long wxGetCurrentId(); +#endif // wxUSE_GUI + // ---------------------------------------------------------------------------- // Various conversions // ---------------------------------------------------------------------------- -WXDLLEXPORT_DATA(extern const char*) wxFloatToStringStr; -WXDLLEXPORT_DATA(extern const char*) wxDoubleToStringStr; +WXDLLEXPORT_DATA(extern const wxChar*) wxFloatToStringStr; +WXDLLEXPORT_DATA(extern const wxChar*) wxDoubleToStringStr; -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); +WXDLLEXPORT void StringToFloat(const wxChar *s, float *number); +WXDLLEXPORT wxChar* FloatToString(float number, const wxChar *fmt = wxFloatToStringStr); +WXDLLEXPORT void StringToDouble(const wxChar *s, double *number); +WXDLLEXPORT wxChar* DoubleToString(double number, const wxChar *fmt = wxDoubleToStringStr); +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); // 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, +// NB: for backwars compatibility reasons the values of wxEXEC_[A]SYNC *must* +// be 0 and 1, don't change! + +enum +{ + // execute the process asynchronously + wxEXEC_ASYNC = 0, + + // execute it synchronously, i.e. wait until it finishes + wxEXEC_SYNC = 1, + + // under Windows, don't hide the child even if it's IO is redirected (this + // is done by default) + wxEXEC_NOHIDE = 2, + + // under Unix, if the process is the group leader then killing -pid kills + // all children as well as pid + wxEXEC_MAKE_GROUP_LEADER = 4 +}; + +// Execute another program. +// +// If flags contain wxEXEC_SYNC, return -1 on failure and the exit code of the +// process if everything was ok. Otherwise (i.e. if wxEXEC_ASYNC), return 0 on +// failure and the PID of the launched process if ok. +WXDLLEXPORT long wxExecute(wxChar **argv, int flags = wxEXEC_ASYNC, wxProcess *process = (wxProcess *) NULL); -WXDLLEXPORT long wxExecute(const wxString& command, bool sync = FALSE, +WXDLLEXPORT long wxExecute(const wxString& command, int flags = wxEXEC_ASYNC, wxProcess *process = (wxProcess *) NULL); +// execute the command capturing its output into an array line by line, this is +// always synchronous +WXDLLEXPORT long wxExecute(const wxString& command, + wxArrayString& output); + +// also capture stderr (also synchronous) +WXDLLEXPORT long wxExecute(const wxString& command, + wxArrayString& output, + wxArrayString& error); + enum wxSignal { wxSIGNONE = 0, // verify if the process exists under Unix @@ -159,22 +211,69 @@ enum wxSignal // 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 +}; + +enum wxShutdownFlags +{ + wxSHUTDOWN_POWEROFF, // power off the computer + wxSHUTDOWN_REBOOT // shutdown and reboot +}; + +// Shutdown or reboot the PC +WXDLLEXPORT bool wxShutdown(wxShutdownFlags wFlags); + +// 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); -// 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 the process id of the current process +WXDLLEXPORT unsigned long wxGetProcessId(); + // 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. // ---------------------------------------------------------------------------- @@ -182,63 +281,98 @@ WXDLLEXPORT long wxGetFreeMemory(); // 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(wxChar *buf, int maxSize); WXDLLEXPORT wxString wxGetHostName(); // 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(char *buf, int maxSize); +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(wxChar *buf, int maxSize); WXDLLEXPORT wxString wxGetUserName(); // Get current Home dir and copy to dest (returns pstr->c_str()) -WXDLLEXPORT const char* wxGetHomeDir(wxString *pstr); +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 char* wxGetUserHome(const wxString& user = wxEmptyString); +#if defined(__UNIX__) && wxUSE_UNICODE +WXDLLEXPORT const wxMB2WXbuf wxGetUserHome(const wxString& user = wxEmptyString); +#else +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 char* wxStripMenuCodes(char *in, char *out = (char *) NULL); +WXDLLEXPORT wxChar* wxStripMenuCodes(const 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 // ---------------------------------------------------------------------------- +// 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); + +// NB: this function is obsolete, use wxWindow::FindWindowByLabel() instead +// // 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. WXDLLEXPORT wxWindow* wxFindWindowByLabel(const wxString& title, wxWindow *parent = (wxWindow *) NULL); +// NB: this function is obsolete, use wxWindow::FindWindowByName() instead +// // Find window by name, and if that fails, by label. WXDLLEXPORT wxWindow* wxFindWindowByName(const wxString& name, wxWindow *parent = (wxWindow *) NULL); -// Returns menu item id or -1 if none. -WXDLLEXPORT int wxFindMenuItemId(wxFrame *frame, const wxString& menuString, const wxString& itemString); - // ---------------------------------------------------------------------------- // Message/event queue helpers // ---------------------------------------------------------------------------- +// NB: these functions are obsolete, please use wxApp methods instead! + // 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); +// 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); @@ -246,6 +380,20 @@ 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; + + DECLARE_NO_COPY_CLASS(wxWindowDisabler) +}; + // ---------------------------------------------------------------------------- // Cursors // ---------------------------------------------------------------------------- @@ -267,25 +415,18 @@ class WXDLLEXPORT wxBusyCursor public: wxBusyCursor(wxCursor* cursor = wxHOURGLASS_CURSOR) { wxBeginBusyCursor(cursor); } - ~wxBusyCursor() + ~wxBusyCursor() { wxEndBusyCursor(); } -}; - -// ---------------------------------------------------------------------------- -// 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 char *fmt ...) ; -// Non-fatal error (continues) -WXDLLEXPORT_DATA(extern const char*) wxInternalErrorStr; -WXDLLEXPORT void wxError(const wxString& msg, const wxString& title = wxInternalErrorStr); + // 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(); +}; -// 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) @@ -297,7 +438,7 @@ WXDLLEXPORT bool wxWriteResource(const wxString& section, const wxString& entry, 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); @@ -308,49 +449,58 @@ 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); - -// 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) // ---------------------------------------------------------------------------- +#ifdef __WXGTK__ + void *wxGetDisplay(); +#endif + #ifdef __X__ WXDisplay *wxGetDisplay(); bool wxSetDisplay(const wxString& display_name); wxString wxGetDisplayName(); -#endif +#endif // X or GTK+ #ifdef __X__ -#include +#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 -#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); +#if WXWIN_COMPATIBILITY_2_2 -#endif //__X__ +// Format a message on the standard error (UNIX) or the debugging +// stream (Windows) +WXDLLEXPORT void wxDebugMsg(const wxChar *fmt ...) ATTRIBUTE_PRINTF_1; + +// 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 // WXWIN_COMPATIBILITY_2_2 #endif // _WX_UTILSH__