X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/816e2c288c5b349289d0962e8e4ff26478ebbd96..30f1b5f3ef80156808e5a96b2abd63c62a1f5894:/include/wx/utils.h diff --git a/include/wx/utils.h b/include/wx/utils.h index 483e0caf07..7a72994f53 100644 --- a/include/wx/utils.h +++ b/include/wx/utils.h @@ -6,14 +6,18 @@ // Created: 29/01/98 // RCS-ID: $Id$ // Copyright: (c) 1998 Julian Smart -// Licence: wxWindows license +// Licence: wxWindows license ///////////////////////////////////////////////////////////////////////////// #ifndef _WX_UTILSH__ #define _WX_UTILSH__ +// ---------------------------------------------------------------------------- +// headers +// ---------------------------------------------------------------------------- + #ifdef __GNUG__ -#pragma interface "utils.h" + #pragma interface "utils.h" #endif #include "wx/setup.h" @@ -21,63 +25,91 @@ #include "wx/list.h" #include "wx/window.h" #include "wx/filefn.h" -#include "wx/process.h" - -#if wxUSE_IOSTREAMH -#include -#else -#include -# ifdef _MSC_VER - using namespace std; -# endif -#endif + +#include "wx/ioswrap.h" #ifdef __X__ -#ifndef __VMS__ -/*steve: these two are not known under VMS */ -#include -#include -#endif + #include + #include #endif #include +// ---------------------------------------------------------------------------- +// Forward declaration +// ---------------------------------------------------------------------------- + +class WXDLLEXPORT wxProcess; +class WXDLLEXPORT wxFrame; + +// FIXME should use wxStricmp() instead #ifdef __GNUWIN32__ -#define stricmp strcasecmp -#define strnicmp strncasecmp + #define stricmp strcasecmp + #define strnicmp strncasecmp #endif -// Forward declaration -class WXDLLEXPORT wxFrame; +// ---------------------------------------------------------------------------- +// Macros +// ---------------------------------------------------------------------------- + +#define wxMax(a,b) (((a) > (b)) ? (a) : (b)) +#define wxMin(a,b) (((a) < (b)) ? (a) : (b)) -// 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)) +// ---------------------------------------------------------------------------- +// String functions (deprecated, use wxString) +// ---------------------------------------------------------------------------- -// Return a string with the current date/time -WXDLLEXPORT wxString wxNow(void); +// Useful buffer (FIXME VZ: yeah, that is. To be removed!) +WXDLLEXPORT_DATA(extern char*) wxBuffer; // Make a copy of this string using 'new' WXDLLEXPORT char* copystring(const char *s); +// Matches string one within string two regardless of case +WXDLLEXPORT bool StringMatch(char *one, char *two, bool subString = TRUE, bool exact = FALSE); + +// A shorter way of using strcmp +#define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) == 0)) + +// ---------------------------------------------------------------------------- +// Miscellaneous functions +// ---------------------------------------------------------------------------- + +// Sound the bell +WXDLLEXPORT void wxBell(void) ; + +// 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(); + +// ---------------------------------------------------------------------------- +// 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; +// ---------------------------------------------------------------------------- +// Various conversions +// ---------------------------------------------------------------------------- WXDLLEXPORT_DATA(extern const char*) wxFloatToStringStr; WXDLLEXPORT_DATA(extern const char*) wxDoubleToStringStr; -// 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); @@ -87,12 +119,6 @@ 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); - -// A shorter way of using strcmp -#define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) == 0)) - // Convert 2-digit hex number to decimal WXDLLEXPORT int wxHexToDec(const wxString& buf); @@ -100,15 +126,41 @@ WXDLLEXPORT int wxHexToDec(const wxString& buf); WXDLLEXPORT void wxDecToHex(int dec, char *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, wxProcess *process = (wxProcess *) NULL); WXDLLEXPORT long wxExecute(const wxString& command, bool sync = FALSE, wxProcess *process = (wxProcess *) NULL); -#define wxSIGTERM 1 +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 +}; -WXDLLEXPORT int wxKill(long pid, int sig=wxSIGTERM); +// the argument is ignored under Windows - the process is always killed +WXDLLEXPORT int wxKill(long pid, wxSignal sig = wxSIGTERM); // Execute a command in an interactive shell window // If no command then just the shell @@ -117,38 +169,55 @@ WXDLLEXPORT bool wxShell(const wxString& command = wxEmptyString); // Sleep for nSecs seconds under UNIX, do nothing under Windows 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); +// ---------------------------------------------------------------------------- +// Network and username functions. +// ---------------------------------------------------------------------------- -/* - * Network and username functions. - * - */ +// NB: "char *" functions are deprecated, use wxString ones! // Get eMail address WXDLLEXPORT bool wxGetEmailAddress(char *buf, int maxSize); +WXDLLEXPORT wxString wxGetEmailAddress(); // Get hostname. WXDLLEXPORT bool wxGetHostName(char *buf, int maxSize); -WXDLLEXPORT bool wxGetHostName(wxString& buf); +WXDLLEXPORT wxString wxGetHostName(); -// Get user ID e.g. jacs +// Get FQDN +WXDLLEXPORT wxString wxGetFullHostName(); + +// Get user ID e.g. jacs (this is known as login name under Unix) WXDLLEXPORT bool wxGetUserId(char *buf, int maxSize); -WXDLLEXPORT bool wxGetUserId(wxString& buf); +WXDLLEXPORT wxString wxGetUserId(); // Get user name e.g. Julian Smart WXDLLEXPORT bool wxGetUserName(char *buf, int maxSize); -WXDLLEXPORT bool wxGetUserName(wxString& buf); +WXDLLEXPORT wxString wxGetUserName(); + +// 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); + +// ---------------------------------------------------------------------------- +// Strip out any menu codes +// ---------------------------------------------------------------------------- -/* - * Strip out any menu codes - */ WXDLLEXPORT char* wxStripMenuCodes(char *in, char *out = (char *) NULL); WXDLLEXPORT wxString wxStripMenuCodes(const wxString& str); +// ---------------------------------------------------------------------------- +// 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. @@ -160,29 +229,26 @@ 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 -*/ - -#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) ; +// Yield to other apps/messages and disable user input +WXDLLEXPORT bool wxSafeYield(wxWindow *win = NULL); + +// 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(); + +// ---------------------------------------------------------------------------- +// Cursors +// ---------------------------------------------------------------------------- // Set the cursor to the busy cursor for all windows class WXDLLEXPORT wxCursor; @@ -190,20 +256,28 @@ 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(); } }; -/* Error message functions used by wxWindows */ +// ---------------------------------------------------------------------------- +// 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; @@ -213,7 +287,10 @@ WXDLLEXPORT void wxError(const wxString& msg, const wxString& title = wxInternal 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); @@ -226,17 +303,6 @@ WXDLLEXPORT bool wxGetResource(const wxString& section, const wxString& entry, l 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. @@ -249,13 +315,16 @@ WXDLLEXPORT char* wxLoadUserResource(const wxString& resourceName, const wxStrin // input/output WXDLLEXPORT void wxRedirectIOToConsole(); -#endif +#endif // MSW + +// ---------------------------------------------------------------------------- +// Display and colorss (X only) +// ---------------------------------------------------------------------------- -// X only #ifdef __X__ -WXDisplay *wxGetDisplay(); -bool wxSetDisplay(const wxString& display_name); -wxString wxGetDisplayName(); + WXDisplay *wxGetDisplay(); + bool wxSetDisplay(const wxString& display_name); + wxString wxGetDisplayName(); #endif #ifdef __X__ @@ -272,13 +341,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);