Various small fixes

[wxWidgets.git] / include / wx / utils.h

diff --git a/include/wx/utils.h b/include/wx/utils.h
index 530e38f3099f4f91845cc0c267b4e44e7db5ced6..483e0caf07c84f753d2a600b07bbaa018d356633 100644 (file)
--- a/include/wx/utils.h
+++ b/include/wx/utils.h
@@ -9,8 +9,8 @@
 // Licence:    wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:    wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 

-#ifndef __UTILSH__
-#define __UTILSH__
+#ifndef _WX_UTILSH__
+#define _WX_UTILSH__

 
 #ifdef __GNUG__
 #pragma interface "utils.h"
 
 #ifdef __GNUG__
 #pragma interface "utils.h"


@@ -21,11 +21,15 @@
 #include "wx/list.h"
 #include "wx/window.h"
 #include "wx/filefn.h"
 #include "wx/list.h"
 #include "wx/window.h"
 #include "wx/filefn.h"

+#include "wx/process.h"

 
 

-#if USE_IOSTREAMH
+#if wxUSE_IOSTREAMH

 #include <iostream.h>
 #else
 #include <iostream>
 #include <iostream.h>
 #else
 #include <iostream>

+#  ifdef _MSC_VER
+      using namespace std;
+#  endif

 #endif
 
 #ifdef __X__
 #endif
 
 #ifdef __X__


@@ -51,21 +55,21 @@ class WXDLLEXPORT wxFrame;
 #define   wxToLower(C)      (((C) >= 'A' && (C) <= 'Z')? (C) - 'A' + 'a': (C))
 
 // Return a string with the current date/time
 #define   wxToLower(C)      (((C) >= 'A' && (C) <= 'Z')? (C) - 'A' + 'a': (C))
 
 // Return a string with the current date/time

-wxString WXDLLEXPORT wxNow(void);
+WXDLLEXPORT wxString wxNow(void);

 
 // Make a copy of this string using 'new'
 
 // Make a copy of this string using 'new'

-char* WXDLLEXPORT copystring(const char *s);
+WXDLLEXPORT char* copystring(const char *s);

 
 // Generate a unique ID
 
 // Generate a unique ID

-long WXDLLEXPORT wxNewId(void);
+WXDLLEXPORT long wxNewId(void);

 #define NewId wxNewId
 
 // Ensure subsequent IDs don't clash with this one
 #define NewId wxNewId
 
 // Ensure subsequent IDs don't clash with this one

-void WXDLLEXPORT wxRegisterId(long id);
+WXDLLEXPORT void wxRegisterId(long id);

 #define RegisterId wxRegisterId
 
 // Return the current ID
 #define RegisterId wxRegisterId
 
 // Return the current ID

-long WXDLLEXPORT wxGetCurrentId(void);
+WXDLLEXPORT long wxGetCurrentId(void);

 
 // Useful buffer
 WXDLLEXPORT_DATA(extern char*) wxBuffer;
 
 // Useful buffer
 WXDLLEXPORT_DATA(extern char*) wxBuffer;


@@ -74,47 +78,50 @@ WXDLLEXPORT_DATA(extern const char*) wxFloatToStringStr;
 WXDLLEXPORT_DATA(extern const char*) wxDoubleToStringStr;
 
 // Various conversions
 WXDLLEXPORT_DATA(extern const char*) wxDoubleToStringStr;
 
 // 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);
+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);

 
 // Matches string one within string two regardless of case
 
 // Matches string one within string two regardless of case

-bool WXDLLEXPORT StringMatch(char *one, char *two, bool subString = TRUE, bool exact = FALSE);
+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
 
 // A shorter way of using strcmp
 #define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) == 0))
 
 // 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
 
 // Convert decimal integer to 2-character hex string

-void WXDLLEXPORT wxDecToHex(int dec, char *buf);
+WXDLLEXPORT void wxDecToHex(int dec, char *buf);
+WXDLLEXPORT wxString wxDecToHex(int dec);

 
 // Execute another program. Returns 0 if there was an error, a PID otherwise.
 
 // Execute another program. Returns 0 if there was an error, a PID otherwise.

-long WXDLLEXPORT wxExecute(char **argv, bool Async = FALSE);
-long WXDLLEXPORT wxExecute(const wxString& command, bool Async = FALSE);
+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
 
 
 #define wxSIGTERM 1
 

-int WXDLLEXPORT wxKill(long pid, int sig=wxSIGTERM);
+WXDLLEXPORT int wxKill(long pid, int sig=wxSIGTERM);

 
 // Execute a command in an interactive shell window
 // If no command then just the shell
 
 // 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
 
 // Sleep for nSecs seconds under UNIX, do nothing under Windows

-void WXDLLEXPORT wxSleep(int nSecs);
+WXDLLEXPORT void wxSleep(int nSecs);

 
 // Get free memory in bytes, or -1 if cannot determine amount (e.g. on UNIX)
 
 // Get free memory in bytes, or -1 if cannot determine amount (e.g. on UNIX)

-long WXDLLEXPORT wxGetFreeMemory(void);
+WXDLLEXPORT long wxGetFreeMemory(void);

 
 // Consume all events until no more left
 
 // Consume all events until no more left

-void WXDLLEXPORT wxFlushEvents(void);
+WXDLLEXPORT void wxFlushEvents(void);

 
 /*
  * Network and username functions.
 
 /*
  * Network and username functions.


@@ -122,72 +129,36 @@ void WXDLLEXPORT wxFlushEvents(void);
  */
 
 // Get eMail address
  */
 
 // Get eMail address

-bool WXDLLEXPORT wxGetEmailAddress(char *buf, int maxSize);
+WXDLLEXPORT bool wxGetEmailAddress(char *buf, int maxSize);

 
 // Get hostname.
 
 // Get hostname.

-bool WXDLLEXPORT wxGetHostName(char *buf, int maxSize);
+WXDLLEXPORT bool wxGetHostName(char *buf, int maxSize);
+WXDLLEXPORT bool wxGetHostName(wxString& buf);

 
 // Get user ID e.g. jacs
 
 // Get user ID e.g. jacs

-bool WXDLLEXPORT wxGetUserId(char *buf, int maxSize);
+WXDLLEXPORT bool wxGetUserId(char *buf, int maxSize);
+WXDLLEXPORT bool wxGetUserId(wxString& buf);

 
 // Get user name e.g. Julian Smart
 
 // Get user name e.g. Julian Smart

-bool WXDLLEXPORT wxGetUserName(char *buf, int maxSize);
+WXDLLEXPORT bool wxGetUserName(char *buf, int maxSize);
+WXDLLEXPORT bool wxGetUserName(wxString& buf);

 
 /*
  * Strip out any menu codes
  */
 
 /*
  * Strip out any menu codes
  */

-char* WXDLLEXPORT wxStripMenuCodes(char *in, char *out = NULL);
+WXDLLEXPORT char* wxStripMenuCodes(char *in, char *out = (char *) NULL);
+WXDLLEXPORT wxString wxStripMenuCodes(const wxString& str);

 
 // 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.
 
 // 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);
+WXDLLEXPORT wxWindow* wxFindWindowByLabel(const wxString& title, wxWindow *parent = (wxWindow *) NULL);

 
 // Find window by name, and if that fails, by label.
 
 // Find window by name, and if that fails, by label.

-wxWindow* WXDLLEXPORT wxFindWindowByName(const wxString& name, wxWindow *parent = NULL);
+WXDLLEXPORT wxWindow* wxFindWindowByName(const wxString& name, wxWindow *parent = (wxWindow *) NULL);

 
 // Returns menu item id or -1 if none.
 
 // Returns menu item id or -1 if none.

-int WXDLLEXPORT wxFindMenuItemId(wxFrame *frame, const wxString& menuString, const wxString& itemString);
-
-// A debugging stream buffer.
-// Under Windows, this writes to the Windows debug output.
-// Under other platforms, it writes to cerr.
-
-// 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 defined(__BORLANDC__) && defined(__BCOPT__) && !defined(_RTL_ALLOW_po) && !defined(__FLAT__)
-#pragma option -po-
-#endif
-
-// Can't export a class derived from a non-export class
-#if !defined(_WINDLL) && !defined(WXUSINGDLL)
-
-#ifdef new
-#undef new
-#endif
-
-class WXDLLEXPORT wxDebugStreamBuf: public streambuf
-{
-  public:
-    wxDebugStreamBuf(void);
-    ~wxDebugStreamBuf(void) {}
-
-    int overflow(int i);
-    inline int underflow(void) { return EOF; }
-    int sync(void);
-};
-
-#if DEBUG && USE_GLOBAL_MEMORY_OPERATORS
-#define new WXDEBUG_NEW
-#endif
-
-#endif
-
-#if defined(__BORLANDC__) && defined(__BCOPT__) && !defined(_RTL_ALLOW_po) && !defined(__FLAT__)
-#pragma option -po.
-#endif
+WXDLLEXPORT int wxFindMenuItemId(wxFrame *frame, const wxString& menuString, const wxString& itemString);

 
 /*
 #if (!defined(__MINMAX_DEFINED) && !defined(max))
 
 /*
 #if (!defined(__MINMAX_DEFINED) && !defined(max))


@@ -196,85 +167,95 @@ class WXDLLEXPORT wxDebugStreamBuf: public streambuf
 #define __MINMAX_DEFINED 1
 #endif
 */
 #define __MINMAX_DEFINED 1
 #endif
 */

+

 #define wxMax(a,b)            (((a) > (b)) ? (a) : (b))
 #define wxMin(a,b)            (((a) < (b)) ? (a) : (b))
 
 // Yield to other apps/messages
 #define wxMax(a,b)            (((a) > (b)) ? (a) : (b))
 #define wxMin(a,b)            (((a) < (b)) ? (a) : (b))
 
 // Yield to other apps/messages

-bool WXDLLEXPORT wxYield(void);
+WXDLLEXPORT bool wxYield(void);

 
 // Format a message on the standard error (UNIX) or the debugging
 // stream (Windows)
 
 // Format a message on the standard error (UNIX) or the debugging
 // stream (Windows)

-void WXDLLEXPORT wxDebugMsg(const char *fmt ...) ;
+WXDLLEXPORT void wxDebugMsg(const char *fmt ...) ;

  
 // Sound the bell
  
 // Sound the bell

-void WXDLLEXPORT wxBell(void) ;
+WXDLLEXPORT void wxBell(void) ;

   
 // Get OS version
   
 // Get OS version

-int WXDLLEXPORT wxGetOsVersion(int *majorVsn=NULL,int *minorVsn=NULL) ;
+WXDLLEXPORT int wxGetOsVersion(int *majorVsn= (int *) NULL,int *minorVsn= (int *) NULL) ;

 
 // Set the cursor to the busy cursor for all windows
 class WXDLLEXPORT wxCursor;
 WXDLLEXPORT_DATA(extern wxCursor*) wxHOURGLASS_CURSOR;
 
 // 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
 // Restore cursor to normal

-void WXDLLEXPORT wxEndBusyCursor(void);
+WXDLLEXPORT void wxEndBusyCursor(void);

  
 // TRUE if we're between the above two calls
  
 // TRUE if we're between the above two calls

-bool WXDLLEXPORT wxIsBusy(void);
+WXDLLEXPORT bool wxIsBusy(void);
+
+// 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(); }
+};

 
 /* Error message functions used by wxWindows */
 
 // Non-fatal error (continues)
 WXDLLEXPORT_DATA(extern const char*) wxInternalErrorStr;
 
 /* Error message functions used by wxWindows */
 
 // Non-fatal error (continues)
 WXDLLEXPORT_DATA(extern const char*) wxInternalErrorStr;

-void WXDLLEXPORT wxError(const wxString& msg, const wxString& title = wxInternalErrorStr);
+WXDLLEXPORT void wxError(const wxString& msg, const wxString& title = wxInternalErrorStr);

 
 // Fatal error (exits)
 WXDLLEXPORT_DATA(extern const char*) wxFatalErrorStr;
 
 // Fatal error (exits)
 WXDLLEXPORT_DATA(extern const char*) wxFatalErrorStr;

-void WXDLLEXPORT wxFatalError(const wxString& msg, const wxString& title = wxFatalErrorStr);
+WXDLLEXPORT void wxFatalError(const wxString& msg, const wxString& title = wxFatalErrorStr);

 
 // Reading and writing resources (eg WIN.INI, .Xdefaults)
 
 // 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
+#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, char **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
+
+// 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
 // Get the user's home dir (caller must copy--- volatile)
 // returns NULL is no HOME dir is known

-char* WXDLLEXPORT wxGetUserHome(const wxString& user = "");
+WXDLLEXPORT char* wxGetUserHome(const wxString& user = wxEmptyString);

 
 // Check whether this window wants to process messages, e.g. Stop button
 // in long calculations.
 
 // Check whether this window wants to process messages, e.g. Stop button
 // in long calculations.

-bool WXDLLEXPORT wxCheckForInterrupt(wxWindow *wnd);
+WXDLLEXPORT bool wxCheckForInterrupt(wxWindow *wnd);

 
 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.
 
 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 __WINDOWS__
-extern const char* WXDLLEXPORT wxUserResourceStr;
-char* WXDLLEXPORT wxLoadUserResource(const wxString& resourceName, const wxString& resourceType = wxUserResourceStr);
+#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();
+

 #endif
 
 // X only
 #ifdef __X__
 #endif
 
 // X only
 #ifdef __X__

-// Get X display: often needed in the wxWindows implementation.
-Display *wxGetDisplay(void);
-/* Matthew Flatt: Added wxSetDisplay and wxGetDisplayName */
+WXDisplay *wxGetDisplay();

 bool wxSetDisplay(const wxString& display_name);
 bool wxSetDisplay(const wxString& display_name);

-wxString wxGetDisplayName(void);
+wxString wxGetDisplayName();

 #endif
 
 #ifdef __X__
 #endif
 
 #ifdef __X__


@@ -306,4 +287,4 @@ void wxAllocColor(Display *display,Colormap colormap,XColor *xcolor);
 #endif //__X__
 
 #endif
 #endif //__X__
 
 #endif

-    // __UTILSH__
+    // _WX_UTILSH__