// 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/filefn.h"
+// need this for wxGetDiskSpace() as we can't, unfortunately, forward declare
+// wxLongLong
+#include "wx/longlong.h"
+
#ifdef __X__
#include <dirent.h>
#include <unistd.h>
class WXDLLEXPORT wxProcess;
class WXDLLEXPORT wxFrame;
class WXDLLEXPORT wxWindow;
-
-// FIXME should use wxStricmp() instead
-#if defined(__GNUWIN32__)
- #define stricmp strcasecmp
- #define strnicmp strncasecmp
-#endif
+class WXDLLEXPORT wxWindowList;
+class WXDLLEXPORT wxPoint;
// ----------------------------------------------------------------------------
// Macros
// String functions (deprecated, use wxString)
// ----------------------------------------------------------------------------
-// Useful buffer (FIXME VZ: yeah, that is. To be removed!)
+// Useful buffer (FIXME VZ: To be removed!!!)
+// Now only needed in MSW port
+#if !defined(__WXMOTIF__) && !defined(__WXGTK__) && !defined(__WXX11__) && !defined(__WXMGL__) && !defined(__WXMAC__)
WXDLLEXPORT_DATA(extern wxChar*) wxBuffer;
+#endif
// Make a copy of this string using 'new'
WXDLLEXPORT wxChar* copystring(const wxChar *s);
+#if WXWIN_COMPATIBILITY_2
// 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);
+#endif
// A shorter way of using strcmp
#define wxStringEq(s1, s2) (s1 && s2 && (wxStrcmp(s1, s2) == 0))
// 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) ;
+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
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 void StringToDouble(wxChar *s, double *number);
+WXDLLEXPORT void StringToDouble(const 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 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);
// Process management
// ----------------------------------------------------------------------------
-// Execute another program. Returns 0 if there was an error, a PID otherwise.
-WXDLLEXPORT long wxExecute(wxChar **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
// 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
+};
-// Execute a command in an interactive shell window
+// 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 (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.
// ----------------------------------------------------------------------------
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)
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
// ----------------------------------------------------------------------------
// 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);
#if 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);
+WXDLLEXPORT bool wxSafeYield(wxWindow *win = NULL, bool onlyIfNeeded = FALSE);
// Enable or disable input to all top level windows
WXDLLEXPORT void wxEnableTopLevelWindows(bool enable = TRUE);
// 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
// ----------------------------------------------------------------------------
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 wxChar *fmt ...) ;
-
-// Non-fatal error (continues)
-WXDLLEXPORT_DATA(extern const wxChar*) 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 wxChar*) wxFatalErrorStr;
-WXDLLEXPORT void wxFatalError(const wxString& msg, const wxString& title = wxFatalErrorStr);
// ----------------------------------------------------------------------------
// Reading and writing resources (eg WIN.INI, .Xdefaults)
// 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
// ----------------------------------------------------------------------------
#ifdef __X__
-#include <X11/Xlib.h>
-
-#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
-
-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))
-
-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);
+#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
#endif //__X__
+#endif // wxUSE_GUI
+
// ----------------------------------------------------------------------------
-// font-related functions (X and GTK)
+// Error message functions used by wxWindows (deprecated, use wxLog)
// ----------------------------------------------------------------------------
-#if defined(__X__) || defined(__WXGTK__)
+#if WXWIN_COMPATIBILITY_2_2
-#ifdef __X__
- typedef XFontStruct *wxNativeFont;
-#else // GDK
- typedef GdkFont *wxNativeFont;
-#endif
+// Format a message on the standard error (UNIX) or the debugging
+// stream (Windows)
+WXDLLEXPORT void wxDebugMsg(const wxChar *fmt ...) ATTRIBUTE_PRINTF_1;
-#include "wx/font.h" // for wxFontEncoding
-
-// returns the handle of the nearest available font or 0
-extern wxNativeFont wxLoadQueryNearestFont(int pointSize,
- int family,
- int style,
- int weight,
- bool underlined,
- const wxString &facename,
- wxFontEncoding encoding);
+// Non-fatal error (continues)
+WXDLLEXPORT_DATA(extern const wxChar*) wxInternalErrorStr;
+WXDLLEXPORT void wxError(const wxString& msg, const wxString& title = wxInternalErrorStr);
-#endif // X || GTK
+// Fatal error (exits)
+WXDLLEXPORT_DATA(extern const wxChar*) wxFatalErrorStr;
+WXDLLEXPORT void wxFatalError(const wxString& msg, const wxString& title = wxFatalErrorStr);
-#endif // wxUSE_GUI
+#endif // WXWIN_COMPATIBILITY_2_2
#endif
// _WX_UTILSH__
projects / wxWidgets.git / blobdiff