// 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"
#include "wx/object.h"
#include "wx/list.h"
-#include "wx/window.h"
#include "wx/filefn.h"
-#include "wx/process.h"
-
-#if USE_IOSTREAMH
-#include <iostream.h>
-#else
-#include <iostream>
-#endif
#ifdef __X__
-#ifndef __VMS__
-/*steve: these two are not known under VMS */
-#include <dirent.h>
-#include <unistd.h>
-#endif
+ #include <dirent.h>
+ #include <unistd.h>
#endif
#include <stdio.h>
-#ifdef __GNUWIN32__
-#define stricmp strcasecmp
-#define strnicmp strncasecmp
-#endif
-
+// ----------------------------------------------------------------------------
// Forward declaration
+// ----------------------------------------------------------------------------
+
+class WXDLLEXPORT wxProcess;
class WXDLLEXPORT wxFrame;
+class WXDLLEXPORT wxWindow;
-// 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))
+// FIXME should use wxStricmp() instead
+#if defined(__GNUWIN32__)
+ #define stricmp strcasecmp
+ #define strnicmp strncasecmp
+#endif
-// Return a string with the current date/time
-wxString WXDLLEXPORT wxNow(void);
+// ----------------------------------------------------------------------------
+// Macros
+// ----------------------------------------------------------------------------
+
+#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: yeah, that is. To be removed!)
+WXDLLEXPORT_DATA(extern wxChar*) wxBuffer;
// Make a copy of this string using 'new'
-char* WXDLLEXPORT 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 version
+WXDLLEXPORT int wxGetOsVersion(int *majorVsn= (int *) NULL,int *minorVsn= (int *) NULL) ;
+
+// Return a string with the current date/time
+WXDLLEXPORT wxString wxNow();
+
+#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
-long WXDLLEXPORT 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
-void WXDLLEXPORT wxRegisterId(long id);
-#define RegisterId wxRegisterId
+WXDLLEXPORT void wxRegisterId(long id);
+#if !defined(RegisterId) && defined(WXWIN_COMPATIBILITY)
+ #define RegisterId wxRegisterId
+#endif
// Return the current ID
-long WXDLLEXPORT wxGetCurrentId(void);
-
-// Useful buffer
-WXDLLEXPORT_DATA(extern char*) wxBuffer;
+WXDLLEXPORT long wxGetCurrentId();
-WXDLLEXPORT_DATA(extern const char*) wxFloatToStringStr;
-WXDLLEXPORT_DATA(extern const char*) wxDoubleToStringStr;
+#endif // wxUSE_GUI
+// ----------------------------------------------------------------------------
// Various conversions
-void WXDLLEXPORT StringToFloat(char *s, float *number);
-char* WXDLLEXPORT FloatToString(float number, const char *fmt = wxFloatToStringStr);
-void WXDLLEXPORT StringToDouble(char *s, double *number);
-char* WXDLLEXPORT DoubleToString(double number, const char *fmt = wxDoubleToStringStr);
-void WXDLLEXPORT StringToInt(char *s, int *number);
-void WXDLLEXPORT StringToLong(char *s, long *number);
-char* WXDLLEXPORT IntToString(int number);
-char* WXDLLEXPORT LongToString(long number);
+// ----------------------------------------------------------------------------
-// Matches string one within string two regardless of case
-bool WXDLLEXPORT 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
-int WXDLLEXPORT wxHexToDec(char *buf);
+WXDLLEXPORT int wxHexToDec(const wxString& buf);
// Convert decimal integer to 2-character hex string
-void WXDLLEXPORT 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.
-long WXDLLEXPORT wxExecute(char **argv, bool Async = FALSE,
- wxProcess *process = NULL);
-long WXDLLEXPORT wxExecute(const wxString& command, bool Async = FALSE,
- wxProcess *process = NULL);
+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
+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
+};
-int WXDLLEXPORT 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
-bool WXDLLEXPORT wxShell(const wxString& command = "");
+WXDLLEXPORT bool wxShell(const wxString& command = wxEmptyString);
// Sleep for nSecs seconds under UNIX, do nothing under Windows
-void WXDLLEXPORT wxSleep(int nSecs);
+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)
-long WXDLLEXPORT wxGetFreeMemory(void);
+WXDLLEXPORT long wxGetFreeMemory();
-// Consume all events until no more left
-void WXDLLEXPORT wxFlushEvents(void);
+// ----------------------------------------------------------------------------
+// Network and username functions.
+// ----------------------------------------------------------------------------
-/*
- * Network and username functions.
- *
- */
+// NB: "char *" functions are deprecated, use wxString ones!
// Get eMail address
-bool WXDLLEXPORT wxGetEmailAddress(char *buf, int maxSize);
+WXDLLEXPORT bool wxGetEmailAddress(wxChar *buf, int maxSize);
+WXDLLEXPORT wxString wxGetEmailAddress();
// Get hostname.
-bool WXDLLEXPORT wxGetHostName(char *buf, int maxSize);
+WXDLLEXPORT bool wxGetHostName(wxChar *buf, int maxSize);
+WXDLLEXPORT wxString wxGetHostName();
-// Get user ID e.g. jacs
-bool WXDLLEXPORT wxGetUserId(char *buf, int maxSize);
+// 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
-bool WXDLLEXPORT wxGetUserName(char *buf, int maxSize);
+WXDLLEXPORT bool wxGetUserName(wxChar *buf, int maxSize);
+WXDLLEXPORT wxString wxGetUserName();
-/*
- * Strip out any menu codes
- */
-char* WXDLLEXPORT wxStripMenuCodes(char *in, char *out = NULL);
+// Get current Home dir and copy to dest (returns pstr->c_str())
+WXDLLEXPORT const wxChar* wxGetHomeDir(wxString *pstr);
-// 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.
-wxWindow* WXDLLEXPORT wxFindWindowByLabel(const wxString& title, wxWindow *parent = NULL);
+// 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
-// Find window by name, and if that fails, by label.
-wxWindow* WXDLLEXPORT wxFindWindowByName(const wxString& name, wxWindow *parent = NULL);
+#if wxUSE_GUI // GUI only things from now on
-// Returns menu item id or -1 if none.
-int WXDLLEXPORT wxFindMenuItemId(wxFrame *frame, const wxString& menuString, const wxString& itemString);
+// ----------------------------------------------------------------------------
+// Menu accelerators related things
+// ----------------------------------------------------------------------------
-// A debugging stream buffer.
-// Under Windows, this writes to the Windows debug output.
-// Under other platforms, it writes to cerr.
+WXDLLEXPORT wxChar* wxStripMenuCodes(wxChar *in, wxChar *out = (wxChar *) NULL);
+WXDLLEXPORT wxString wxStripMenuCodes(const wxString& str);
-// ALl this horrible gubbins required for Borland, because the calling
-// convention needs to be the same as for streambuf.
-// Thanks to Gerhard.Vogt@embl-heidelberg.de for this solution.
+#if wxUSE_ACCEL
+class WXDLLEXPORT wxAcceleratorEntry;
+WXDLLEXPORT wxAcceleratorEntry *wxGetAccelFromString(const wxString& label);
+#endif // wxUSE_ACCEL
-#if defined(__BORLANDC__) && defined(__BCOPT__) && !defined(_RTL_ALLOW_po) && !defined(__FLAT__)
-#pragma option -po-
-#endif
+// ----------------------------------------------------------------------------
+// Window search
+// ----------------------------------------------------------------------------
-// Can't export a class derived from a non-export class
-#if !defined(_WINDLL) && !defined(WXUSINGDLL)
+// 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);
-#ifdef new
-#undef new
-#endif
+// Find window by name, and if that fails, by label.
+WXDLLEXPORT wxWindow* wxFindWindowByName(const wxString& name, wxWindow *parent = (wxWindow *) NULL);
-class WXDLLEXPORT wxDebugStreamBuf: public streambuf
-{
- public:
- wxDebugStreamBuf(void);
- ~wxDebugStreamBuf(void) {}
+// Returns menu item id or -1 if none.
+WXDLLEXPORT int wxFindMenuItemId(wxFrame *frame, const wxString& menuString, const wxString& itemString);
- int overflow(int i);
- inline int underflow(void) { return EOF; }
- int sync(void);
-};
+// ----------------------------------------------------------------------------
+// Message/event queue helpers
+// ----------------------------------------------------------------------------
-#if WXDEBUG && USE_GLOBAL_MEMORY_OPERATORS
-#define new WXDEBUG_NEW
-#endif
+// Yield to other apps/messages
+WXDLLEXPORT bool wxYield();
-#endif
+// Yield to other apps/messages and disable user input
+WXDLLEXPORT bool wxSafeYield(wxWindow *win = NULL);
-#if defined(__BORLANDC__) && defined(__BCOPT__) && !defined(_RTL_ALLOW_po) && !defined(__FLAT__)
-#pragma option -po.
-#endif
+// Enable or disable input to all top level windows
+WXDLLEXPORT void wxEnableTopLevelWindows(bool enable = TRUE);
-/*
-#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))
+// Check whether this window wants to process messages, e.g. Stop button
+// in long calculations.
+WXDLLEXPORT bool wxCheckForInterrupt(wxWindow *wnd);
-// Yield to other apps/messages
-bool WXDLLEXPORT wxYield(void);
+// Consume all events until no more left
+WXDLLEXPORT void wxFlushEvents();
-// Format a message on the standard error (UNIX) or the debugging
-// stream (Windows)
-void WXDLLEXPORT wxDebugMsg(const char *fmt ...) ;
-
-// Sound the bell
-void WXDLLEXPORT wxBell(void) ;
-
-// Get OS version
-int WXDLLEXPORT wxGetOsVersion(int *majorVsn=NULL,int *minorVsn=NULL) ;
+// ----------------------------------------------------------------------------
+// Cursors
+// ----------------------------------------------------------------------------
// Set the cursor to the busy cursor for all windows
class WXDLLEXPORT wxCursor;
WXDLLEXPORT_DATA(extern wxCursor*) wxHOURGLASS_CURSOR;
-void WXDLLEXPORT wxBeginBusyCursor(wxCursor *cursor = wxHOURGLASS_CURSOR);
-
+WXDLLEXPORT void wxBeginBusyCursor(wxCursor *cursor = wxHOURGLASS_CURSOR);
+
// Restore cursor to normal
-void WXDLLEXPORT wxEndBusyCursor(void);
-
+WXDLLEXPORT void wxEndBusyCursor();
+
// TRUE if we're between the above two calls
-bool WXDLLEXPORT wxIsBusy(void);
+WXDLLEXPORT bool wxIsBusy();
+
+// Convenience class so we can just create a wxBusyCursor object on the stack
+class WXDLLEXPORT wxBusyCursor
+{
+public:
+ wxBusyCursor(wxCursor* cursor = wxHOURGLASS_CURSOR)
+ { wxBeginBusyCursor(cursor); }
+ ~wxBusyCursor()
+ { wxEndBusyCursor(); }
+};
+
+// ----------------------------------------------------------------------------
+// Error message functions used by wxWindows (deprecated, use wxLog)
+// ----------------------------------------------------------------------------
-/* Error message functions used by wxWindows */
+// 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 char*) wxInternalErrorStr;
-void WXDLLEXPORT wxError(const wxString& msg, const wxString& title = wxInternalErrorStr);
+WXDLLEXPORT_DATA(extern const wxChar*) wxInternalErrorStr;
+WXDLLEXPORT void wxError(const wxString& msg, const wxString& title = wxInternalErrorStr);
// Fatal error (exits)
-WXDLLEXPORT_DATA(extern const char*) wxFatalErrorStr;
-void WXDLLEXPORT wxFatalError(const wxString& msg, const wxString& title = wxFatalErrorStr);
+WXDLLEXPORT_DATA(extern const wxChar*) wxFatalErrorStr;
+WXDLLEXPORT void wxFatalError(const wxString& msg, const wxString& title = wxFatalErrorStr);
+// ----------------------------------------------------------------------------
// Reading and writing resources (eg WIN.INI, .Xdefaults)
-#if USE_RESOURCES
-bool WXDLLEXPORT wxWriteResource(const wxString& section, const wxString& entry, const wxString& value, const wxString& file = "");
-bool WXDLLEXPORT wxWriteResource(const wxString& section, const wxString& entry, float value, const wxString& file = "");
-bool WXDLLEXPORT wxWriteResource(const wxString& section, const wxString& entry, long value, const wxString& file = "");
-bool WXDLLEXPORT wxWriteResource(const wxString& section, const wxString& entry, int value, const wxString& file = "");
-
-bool WXDLLEXPORT wxGetResource(const wxString& section, const wxString& entry, char **value, const wxString& file = "");
-bool WXDLLEXPORT wxGetResource(const wxString& section, const wxString& entry, float *value, const wxString& file = "");
-bool WXDLLEXPORT wxGetResource(const wxString& section, const wxString& entry, long *value, const wxString& file = "");
-bool WXDLLEXPORT wxGetResource(const wxString& section, const wxString& entry, int *value, const wxString& file = "");
-#endif // USE_RESOURCES
-
-#ifdef __UNIX__
-// 'X' Only, will soon vanish....
-// Get current Home dir and copy to dest
-char* WXDLLEXPORT wxGetHomeDir( char *dest );
-#endif
-// Get the user's home dir (caller must copy--- volatile)
-// returns NULL is no HOME dir is known
-char* WXDLLEXPORT wxGetUserHome(const wxString& user = "");
+// ----------------------------------------------------------------------------
-// Check whether this window wants to process messages, e.g. Stop button
-// in long calculations.
-bool WXDLLEXPORT wxCheckForInterrupt(wxWindow *wnd);
+#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, 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
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 const char* WXDLLEXPORT wxUserResourceStr;
-char* WXDLLEXPORT 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__
-// Get X display: often needed in the wxWindows implementation.
-Display *wxGetDisplay(void);
-/* Matthew Flatt: Added wxSetDisplay and wxGetDisplayName */
-bool wxSetDisplay(const wxString& display_name);
-wxString wxGetDisplayName(void);
-#endif
+ WXDisplay *wxGetDisplay();
+ bool wxSetDisplay(const wxString& display_name);
+ wxString wxGetDisplayName();
+#endif // X or GTK+
#ifdef __X__
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);
#endif //__X__
+#endif // wxUSE_GUI
+
#endif
// _WX_UTILSH__
projects / wxWidgets.git / blobdiff