X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2ecd1756e4238edc910a38a18f84b4f5bf42f85c..7bd30a12ade503fd135c686ecc98a6f6d5fecbeb:/include/wx/utils.h diff --git a/include/wx/utils.h b/include/wx/utils.h index 95cf1a6ada..b539373de9 100644 --- a/include/wx/utils.h +++ b/include/wx/utils.h @@ -19,8 +19,13 @@ #include "wx/object.h" #include "wx/list.h" #include "wx/filefn.h" +#include "wx/hashmap.h" +#include "wx/versioninfo.h" +#include "wx/meta/implicitconversion.h" + #if wxUSE_GUI #include "wx/gdicmn.h" + #include "wx/mousestate.h" #endif class WXDLLIMPEXP_FWD_BASE wxArrayString; @@ -30,7 +35,7 @@ class WXDLLIMPEXP_FWD_BASE wxArrayInt; // wxLongLong #include "wx/longlong.h" -// need for wxOperatingSystemId +// needed for wxOperatingSystemId, wxLinuxDistributionInfo #include "wx/platinfo.h" #ifdef __WATCOMC__ @@ -50,14 +55,50 @@ class WXDLLIMPEXP_FWD_BASE wxProcess; class WXDLLIMPEXP_FWD_CORE wxFrame; class WXDLLIMPEXP_FWD_CORE wxWindow; class WXDLLIMPEXP_FWD_CORE wxWindowList; +class WXDLLIMPEXP_FWD_CORE wxEventLoop; // ---------------------------------------------------------------------------- -// Macros +// Arithmetic functions // ---------------------------------------------------------------------------- -#define wxMax(a,b) (((a) > (b)) ? (a) : (b)) -#define wxMin(a,b) (((a) < (b)) ? (a) : (b)) -#define wxClip(a,b,c) (((a) < (b)) ? (b) : (((a) > (c)) ? (c) : (a))) +template +inline typename wxImplicitConversionType::value +wxMax(T1 a, T2 b) +{ + typedef typename wxImplicitConversionType::value ResultType; + + // Cast both operands to the same type before comparing them to avoid + // warnings about signed/unsigned comparisons from some compilers: + return static_cast(a) > static_cast(b) ? a : b; +} + +template +inline typename wxImplicitConversionType::value +wxMin(T1 a, T2 b) +{ + typedef typename wxImplicitConversionType::value ResultType; + + return static_cast(a) < static_cast(b) ? a : b; +} + +template +inline typename wxImplicitConversionType3::value +wxClip(T1 a, T2 b, T3 c) +{ + typedef typename wxImplicitConversionType3::value ResultType; + + if ( static_cast(a) < static_cast(b) ) + return b; + + if ( static_cast(a) > static_cast(c) ) + return c; + + return a; +} + +// ---------------------------------------------------------------------------- +// wxMemorySize +// ---------------------------------------------------------------------------- // wxGetFreeMemory can return huge amount of memory on 32-bit platforms as well // so to always use long long for its result type on all platforms which @@ -72,8 +113,17 @@ class WXDLLIMPEXP_FWD_CORE wxWindowList; // String functions (deprecated, use wxString) // ---------------------------------------------------------------------------- +#ifdef WXWIN_COMPATIBILITY_2_8 // A shorter way of using strcmp -#define wxStringEq(s1, s2) (s1 && s2 && (wxStrcmp(s1, s2) == 0)) +wxDEPRECATED_INLINE(inline bool wxStringEq(const char *s1, const char *s2), + return wxCRT_StrcmpA(s1, s2) == 0; ) + +#if wxUSE_UNICODE +wxDEPRECATED_INLINE(inline bool wxStringEq(const wchar_t *s1, const wchar_t *s2), + return wxCRT_StrcmpW(s1, s2) == 0; ) +#endif // wxUSE_UNICODE + +#endif // WXWIN_COMPATIBILITY_2_8 // ---------------------------------------------------------------------------- // Miscellaneous functions @@ -92,12 +142,14 @@ WXDLLIMPEXP_BASE void wxBell(); WXDLLIMPEXP_CORE void wxInfoMessageBox(wxWindow* parent); #endif // wxUSE_MSGDLG +WXDLLIMPEXP_CORE wxVersionInfo wxGetLibraryVersionInfo(); + // Get OS description as a user-readable string WXDLLIMPEXP_BASE wxString wxGetOsDescription(); // Get OS version -WXDLLIMPEXP_BASE wxOperatingSystemId wxGetOsVersion(int *majorVsn = (int *) NULL, - int *minorVsn = (int *) NULL); +WXDLLIMPEXP_BASE wxOperatingSystemId wxGetOsVersion(int *majorVsn = NULL, + int *minorVsn = NULL); // Get platform endianness WXDLLIMPEXP_BASE bool wxIsPlatformLittleEndian(); @@ -105,6 +157,11 @@ WXDLLIMPEXP_BASE bool wxIsPlatformLittleEndian(); // Get platform architecture WXDLLIMPEXP_BASE bool wxIsPlatform64Bit(); +#ifdef __LINUX__ +// Get linux-distro informations +WXDLLIMPEXP_BASE wxLinuxDistributionInfo wxGetLinuxDistributionInfo(); +#endif + // Return a string with the current date/time WXDLLIMPEXP_BASE wxString wxNow(); @@ -113,6 +170,27 @@ WXDLLIMPEXP_BASE const wxChar *wxGetInstallPrefix(); // Return path to wxWin data (/usr/share/wx/%{version}) (Unices) WXDLLIMPEXP_BASE wxString wxGetDataDir(); +#if wxUSE_GUI + +// Get the state of a key (true if pressed, false if not) +// This is generally most useful getting the state of +// the modifier or toggle keys. +WXDLLIMPEXP_CORE bool wxGetKeyState(wxKeyCode key); + +// Don't synthesize KeyUp events holding down a key and producing +// KeyDown events with autorepeat. On by default and always on +// in wxMSW. +WXDLLIMPEXP_CORE bool wxSetDetectableAutoRepeat( bool flag ); + +// Returns the current state of the mouse position, buttons and modifers +WXDLLIMPEXP_CORE wxMouseState wxGetMouseState(); + +#endif // wxUSE_GUI + +// ---------------------------------------------------------------------------- +// wxPlatform +// ---------------------------------------------------------------------------- + /* * Class to make it easier to specify platform-dependent values * @@ -195,91 +273,6 @@ private: /// Function for testing current platform inline bool wxPlatformIs(int platform) { return wxPlatform::Is(platform); } -#if wxUSE_GUI - -// Get the state of a key (true if pressed, false if not) -// This is generally most useful getting the state of -// the modifier or toggle keys. -WXDLLEXPORT bool wxGetKeyState(wxKeyCode key); - - -// 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 ); - - -// wxMouseState is used to hold information about button and modifier state -// and is what is returned from wxGetMouseState. -class WXDLLEXPORT wxMouseState -{ -public: - wxMouseState() - : m_x(0), m_y(0), - m_leftDown(false), m_middleDown(false), m_rightDown(false), - m_aux1Down(false), m_aux2Down(false), - m_controlDown(false), m_shiftDown(false), m_altDown(false), - m_metaDown(false) - {} - - wxCoord GetX() { return m_x; } - wxCoord GetY() { return m_y; } - - bool LeftDown() { return m_leftDown; } - bool MiddleDown() { return m_middleDown; } - bool RightDown() { return m_rightDown; } - bool Aux1Down() { return m_aux1Down; } - bool Aux2Down() { return m_aux2Down; } - - bool ControlDown() { return m_controlDown; } - bool ShiftDown() { return m_shiftDown; } - bool AltDown() { return m_altDown; } - bool MetaDown() { return m_metaDown; } - bool CmdDown() - { -#if defined(__WXMAC__) || defined(__WXCOCOA__) - return MetaDown(); -#else - return ControlDown(); -#endif - } - - void SetX(wxCoord x) { m_x = x; } - void SetY(wxCoord y) { m_y = y; } - - void SetLeftDown(bool down) { m_leftDown = down; } - void SetMiddleDown(bool down) { m_middleDown = down; } - void SetRightDown(bool down) { m_rightDown = down; } - void SetAux1Down(bool down) { m_aux1Down = down; } - void SetAux2Down(bool down) { m_aux2Down = down; } - - void SetControlDown(bool down) { m_controlDown = down; } - void SetShiftDown(bool down) { m_shiftDown = down; } - void SetAltDown(bool down) { m_altDown = down; } - void SetMetaDown(bool down) { m_metaDown = down; } - -private: - wxCoord m_x; - wxCoord m_y; - - bool m_leftDown : 1; - bool m_middleDown : 1; - bool m_rightDown : 1; - bool m_aux1Down : 1; - bool m_aux2Down : 1; - - bool m_controlDown : 1; - bool m_shiftDown : 1; - bool m_altDown : 1; - bool m_metaDown : 1; -}; - - -// Returns the current state of the mouse position, buttons and modifers -WXDLLEXPORT wxMouseState wxGetMouseState(); - -#endif // wxUSE_GUI - // ---------------------------------------------------------------------------- // Window ID management // ---------------------------------------------------------------------------- @@ -300,6 +293,25 @@ WXDLLIMPEXP_BASE long wxNewId(); // Convert 2-digit hex number to decimal WXDLLIMPEXP_BASE int wxHexToDec(const wxString& buf); +// Convert 2-digit hex number to decimal +inline int wxHexToDec(const char* buf) +{ + int firstDigit, secondDigit; + + if (buf[0] >= 'A') + firstDigit = buf[0] - 'A' + 10; + else + firstDigit = buf[0] - '0'; + + if (buf[1] >= 'A') + secondDigit = buf[1] - 'A' + 10; + else + secondDigit = buf[1] - '0'; + + return (firstDigit & 0xF) * 16 + (secondDigit & 0xF ); +} + + // Convert decimal integer to 2-character hex string WXDLLIMPEXP_BASE void wxDecToHex(int dec, wxChar *buf); WXDLLIMPEXP_BASE void wxDecToHex(int dec, char* ch1, char* ch2); @@ -342,27 +354,50 @@ enum wxEXEC_BLOCK = wxEXEC_SYNC | wxEXEC_NOEVENTS }; +// Map storing environment variables. +typedef wxStringToStringHashMap wxEnvVariableHashMap; + +// Used to pass additional parameters for child process to wxExecute(). Could +// be extended with other fields later. +struct wxExecuteEnv +{ + wxString cwd; // If empty, CWD is not changed. + wxEnvVariableHashMap env; // If empty, environment is unchanged. +}; + // 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. -WXDLLIMPEXP_BASE long wxExecute(wxChar **argv, int flags = wxEXEC_ASYNC, - wxProcess *process = (wxProcess *) NULL); -WXDLLIMPEXP_BASE long wxExecute(const wxString& command, int flags = wxEXEC_ASYNC, - wxProcess *process = (wxProcess *) NULL); +WXDLLIMPEXP_BASE long wxExecute(const wxString& command, + int flags = wxEXEC_ASYNC, + wxProcess *process = NULL, + const wxExecuteEnv *env = NULL); +WXDLLIMPEXP_BASE long wxExecute(char **argv, + int flags = wxEXEC_ASYNC, + wxProcess *process = NULL, + const wxExecuteEnv *env = NULL); +#if wxUSE_UNICODE +WXDLLIMPEXP_BASE long wxExecute(wchar_t **argv, + int flags = wxEXEC_ASYNC, + wxProcess *process = NULL, + const wxExecuteEnv *env = NULL); +#endif // wxUSE_UNICODE // execute the command capturing its output into an array line by line, this is // always synchronous WXDLLIMPEXP_BASE long wxExecute(const wxString& command, wxArrayString& output, - int flags = 0); + int flags = 0, + const wxExecuteEnv *env = NULL); // also capture stderr (also synchronous) WXDLLIMPEXP_BASE long wxExecute(const wxString& command, wxArrayString& output, wxArrayString& error, - int flags = 0); + int flags = 0, + const wxExecuteEnv *env = NULL); #if defined(__WXMSW__) && wxUSE_IPC // ask a DDE server to execute the DDE request with given parameters @@ -411,12 +446,14 @@ enum wxKillFlags enum wxShutdownFlags { - wxSHUTDOWN_POWEROFF, // power off the computer - wxSHUTDOWN_REBOOT // shutdown and reboot + wxSHUTDOWN_FORCE = 1,// can be combined with other flags (MSW-only) + wxSHUTDOWN_POWEROFF = 2,// power off the computer + wxSHUTDOWN_REBOOT = 4,// shutdown and reboot + wxSHUTDOWN_LOGOFF = 8 // close session (currently MSW-only) }; // Shutdown or reboot the PC -WXDLLIMPEXP_BASE bool wxShutdown(wxShutdownFlags wFlags); +WXDLLIMPEXP_BASE bool wxShutdown(int flags = wxSHUTDOWN_POWEROFF); // 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 @@ -444,8 +481,10 @@ WXDLLIMPEXP_BASE void wxMilliSleep(unsigned long milliseconds); // Sleep for a given amount of microseconds WXDLLIMPEXP_BASE void wxMicroSleep(unsigned long microseconds); +#if WXWIN_COMPATIBILITY_2_8 // Sleep for a given amount of milliseconds (old, bad name), use wxMilliSleep wxDEPRECATED( WXDLLIMPEXP_BASE void wxUsleep(unsigned long milliseconds) ); +#endif // Get the process id of the current process WXDLLIMPEXP_BASE unsigned long wxGetProcessId(); @@ -480,7 +519,7 @@ inline bool wxSetEnv(const wxString& var, const char *value) inline bool wxSetEnv(const wxString& var, const wchar_t *value) { return wxSetEnv(var, wxString(value)); } template -inline bool wxSetEnv(const wxString& var, const wxCharTypeBuffer& value) +inline bool wxSetEnv(const wxString& var, const wxScopedCharTypeBuffer& value) { return wxSetEnv(var, wxString(value)); } inline bool wxSetEnv(const wxString& var, const wxCStrData& value) { return wxSetEnv(var, wxString(value)); } @@ -497,6 +536,10 @@ inline bool wxSetEnv(const wxString& var, int value) } #endif // WXWIN_COMPATIBILITY_2_8 +// Retrieve the complete environment by filling specified map. +// Returns true on success or false if an error occurred. +WXDLLIMPEXP_BASE bool wxGetEnvMap(wxEnvVariableHashMap *map); + // ---------------------------------------------------------------------------- // Network and username functions. // ---------------------------------------------------------------------------- @@ -564,12 +607,16 @@ WXDLLIMPEXP_BASE void wxQsort(void *const pbase, size_t total_elems, // flags for wxLaunchDefaultBrowser enum { - wxBROWSER_NEW_WINDOW = 1 + wxBROWSER_NEW_WINDOW = 0x01, + wxBROWSER_NOBUSYCURSOR = 0x02 }; // Launch url in the user's default internet browser WXDLLIMPEXP_CORE bool wxLaunchDefaultBrowser(const wxString& url, int flags = 0); +// Launch document in the user's default application +WXDLLIMPEXP_CORE bool wxLaunchDefaultApplication(const wxString& path, int flags = 0); + // ---------------------------------------------------------------------------- // Menu accelerators related things // ---------------------------------------------------------------------------- @@ -588,13 +635,13 @@ enum }; // strip mnemonics and/or accelerators from the label -WXDLLEXPORT wxString +WXDLLIMPEXP_CORE wxString wxStripMenuCodes(const wxString& str, int flags = wxStrip_All); #if WXWIN_COMPATIBILITY_2_6 // obsolete and deprecated version, do not use, use the above overload instead wxDEPRECATED( - WXDLLEXPORT wxChar* wxStripMenuCodes(const wxChar *in, wxChar *out = NULL) + WXDLLIMPEXP_CORE wxChar* wxStripMenuCodes(const wxChar *in, wxChar *out = NULL) ); #if wxUSE_ACCEL @@ -602,7 +649,7 @@ class WXDLLIMPEXP_FWD_CORE wxAcceleratorEntry; // use wxAcceleratorEntry::Create() or FromString() methods instead wxDEPRECATED( - WXDLLEXPORT wxAcceleratorEntry *wxGetAccelFromString(const wxString& label) + WXDLLIMPEXP_CORE wxAcceleratorEntry *wxGetAccelFromString(const wxString& label) ); #endif // wxUSE_ACCEL @@ -613,45 +660,45 @@ wxDEPRECATED( // ---------------------------------------------------------------------------- // Returns menu item id or wxNOT_FOUND if none. -WXDLLEXPORT int wxFindMenuItemId(wxFrame *frame, const wxString& menuString, const wxString& itemString); +WXDLLIMPEXP_CORE 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); +WXDLLIMPEXP_CORE wxWindow* wxGenericFindWindowAtPoint(const wxPoint& pt); +WXDLLIMPEXP_CORE 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); +WXDLLIMPEXP_CORE wxWindow* wxFindWindowByLabel(const wxString& title, wxWindow *parent = 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); +WXDLLIMPEXP_CORE wxWindow* wxFindWindowByName(const wxString& name, wxWindow *parent = NULL); // ---------------------------------------------------------------------------- // Message/event queue helpers // ---------------------------------------------------------------------------- // Yield to other apps/messages and disable user input -WXDLLEXPORT bool wxSafeYield(wxWindow *win = NULL, bool onlyIfNeeded = false); +WXDLLIMPEXP_CORE bool wxSafeYield(wxWindow *win = NULL, bool onlyIfNeeded = false); // Enable or disable input to all top level windows -WXDLLEXPORT void wxEnableTopLevelWindows(bool enable = true); +WXDLLIMPEXP_CORE 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); +WXDLLIMPEXP_CORE bool wxCheckForInterrupt(wxWindow *wnd); // Consume all events until no more left -WXDLLEXPORT void wxFlushEvents(); +WXDLLIMPEXP_CORE void wxFlushEvents(); // a class which disables all windows (except, may be, the given one) in its // ctor and enables them back in its dtor -class WXDLLEXPORT wxWindowDisabler +class WXDLLIMPEXP_CORE wxWindowDisabler { public: // this ctor conditionally disables all windows: if the argument is false, @@ -668,11 +715,13 @@ private: // disable all windows except the given one (used by both ctors) void DoDisable(wxWindow *winToSkip = NULL); - +#if defined(__WXOSX__) && wxOSX_USE_COCOA + wxEventLoop* m_modalEventLoop; +#endif wxWindowList *m_winDisabled; bool m_disabled; - DECLARE_NO_COPY_CLASS(wxWindowDisabler) + wxDECLARE_NO_COPY_CLASS(wxWindowDisabler); }; // ---------------------------------------------------------------------------- @@ -683,13 +732,13 @@ private: WXDLLIMPEXP_CORE void wxBeginBusyCursor(const wxCursor *cursor = wxHOURGLASS_CURSOR); // Restore cursor to normal -WXDLLEXPORT void wxEndBusyCursor(); +WXDLLIMPEXP_CORE void wxEndBusyCursor(); // true if we're between the above two calls -WXDLLEXPORT bool wxIsBusy(); +WXDLLIMPEXP_CORE bool wxIsBusy(); // Convenience class so we can just create a wxBusyCursor object on the stack -class WXDLLEXPORT wxBusyCursor +class WXDLLIMPEXP_CORE wxBusyCursor { public: wxBusyCursor(const wxCursor* cursor = wxHOURGLASS_CURSOR) @@ -706,14 +755,7 @@ public: static const wxCursor GetBusyCursor(); }; -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__ - extern WXDLLEXPORT const wxChar* wxUserResourceStr; - WXDLLEXPORT wxChar* wxLoadUserResource(const wxString& resourceName, const wxString& resourceType = wxUserResourceStr); -#endif // MSW +void WXDLLIMPEXP_CORE wxGetMousePosition( int* x, int* y ); // ---------------------------------------------------------------------------- // X11 Display access @@ -751,16 +793,46 @@ inline struct _XDisplay *wxGetX11Display() #define wx_YIELD_DECLARED // Yield to other apps/messages -WXDLLIMPEXP_BASE bool wxYield(); +WXDLLIMPEXP_CORE bool wxYield(); #endif // wx_YIELD_DECLARED // Like wxYield, but fails silently if the yield is recursive. -WXDLLIMPEXP_BASE bool wxYieldIfNeeded(); +WXDLLIMPEXP_CORE bool wxYieldIfNeeded(); // ---------------------------------------------------------------------------- -// Error message functions used by wxWidgets (deprecated, use wxLog) +// Windows resources access // ---------------------------------------------------------------------------- +// MSW only: get user-defined resource from the .res file. +#ifdef __WXMSW__ + // default resource type for wxLoadUserResource() + extern WXDLLIMPEXP_DATA_BASE(const wxChar*) wxUserResourceStr; + + // Return the pointer to the resource data. This pointer is read-only, use + // the overload below if you need to modify the data. + // + // Returns true on success, false on failure. Doesn't log an error message + // if the resource is not found (because this could be expected) but does + // log one if any other error occurs. + WXDLLIMPEXP_BASE bool + wxLoadUserResource(const void **outData, + size_t *outLen, + const wxString& resourceName, + const wxString& resourceType = wxUserResourceStr, + WXHINSTANCE module = 0); + + // This function allocates a new buffer and makes a copy of the resource + // data, remember to delete[] the buffer. And avoid using it entirely if + // the overload above can be used. + // + // Returns NULL on failure. + WXDLLIMPEXP_BASE char* + wxLoadUserResource(const wxString& resourceName, + const wxString& resourceType = wxUserResourceStr, + int* pLen = NULL, + WXHINSTANCE module = 0); +#endif // MSW + #endif // _WX_UTILSH__