include/wx/utils.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        utils.h
   3 // Purpose:     Miscellaneous utilities
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     29/01/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1998 Julian Smart
   9 // Licence:     wxWindows license
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_UTILSH__
  13 #define _WX_UTILSH__
  14
  15 // ----------------------------------------------------------------------------
  16 // headers
  17 // ----------------------------------------------------------------------------
  18
  19 #ifdef __GNUG__
  20     #pragma interface "utils.h"
  21 #endif
  22
  23 #include "wx/object.h"
  24 #include "wx/list.h"
  25 #include "wx/filefn.h"
  26
  27 // need this for wxGetDiskSpace() as we can't, unfortunately, forward declare
  28 // wxLongLong
  29 #include "wx/longlong.h"
  30
  31 #ifdef __X__
  32     #include <dirent.h>
  33     #include <unistd.h>
  34 #endif
  35
  36 #include <stdio.h>
  37
  38 // ----------------------------------------------------------------------------
  39 // Forward declaration
  40 // ----------------------------------------------------------------------------
  41
  42 class WXDLLEXPORT wxProcess;
  43 class WXDLLEXPORT wxFrame;
  44 class WXDLLEXPORT wxWindow;
  45 class WXDLLEXPORT wxWindowList;
  46 class WXDLLEXPORT wxPoint;
  47
  48 // ----------------------------------------------------------------------------
  49 // Macros
  50 // ----------------------------------------------------------------------------
  51
  52 #define wxMax(a,b)            (((a) > (b)) ? (a) : (b))
  53 #define wxMin(a,b)            (((a) < (b)) ? (a) : (b))
  54
  55 // ----------------------------------------------------------------------------
  56 // String functions (deprecated, use wxString)
  57 // ----------------------------------------------------------------------------
  58
  59 // Useful buffer (FIXME VZ: To be removed!!!)
  60 WXDLLEXPORT_DATA(extern wxChar*) wxBuffer;
  61
  62 // Make a copy of this string using 'new'
  63 WXDLLEXPORT wxChar* copystring(const wxChar *s);
  64
  65 // Matches string one within string two regardless of case
  66 WXDLLEXPORT bool StringMatch(const wxChar *one, const wxChar *two, bool subString = TRUE, bool exact = FALSE);
  67
  68 // A shorter way of using strcmp
  69 #define wxStringEq(s1, s2) (s1 && s2 && (wxStrcmp(s1, s2) == 0))
  70
  71 // ----------------------------------------------------------------------------
  72 // Miscellaneous functions
  73 // ----------------------------------------------------------------------------
  74
  75 // Sound the bell
  76 WXDLLEXPORT void wxBell();
  77
  78 // Get OS description as a user-readable string
  79 WXDLLEXPORT wxString wxGetOsDescription();
  80
  81 // Get OS version
  82 WXDLLEXPORT int wxGetOsVersion(int *majorVsn = (int *) NULL,
  83                                int *minorVsn = (int *) NULL);
  84
  85 // Return a string with the current date/time
  86 WXDLLEXPORT wxString wxNow();
  87
  88 // Return path where wxWindows is installed (mostly useful in Unices)
  89 WXDLLEXPORT const wxChar *wxGetInstallPrefix();
  90 // Return path to wxWin data (/usr/share/wx/%{version}) (Unices)
  91 WXDLLEXPORT wxString wxGetDataDir();
  92
  93
  94 #if wxUSE_GUI
  95 // Don't synthesize KeyUp events holding down a key and producing
  96 // KeyDown events with autorepeat. On by default and always on
  97 // in wxMSW.
  98 WXDLLEXPORT bool wxSetDetectableAutoRepeat( bool flag );
  99
 100 // ----------------------------------------------------------------------------
 101 // Window ID management
 102 // ----------------------------------------------------------------------------
 103
 104 // Generate a unique ID
 105 WXDLLEXPORT long wxNewId();
 106 #if !defined(NewId) && defined(WXWIN_COMPATIBILITY)
 107     #define NewId wxNewId
 108 #endif
 109
 110 // Ensure subsequent IDs don't clash with this one
 111 WXDLLEXPORT void wxRegisterId(long id);
 112 #if !defined(RegisterId) && defined(WXWIN_COMPATIBILITY)
 113     #define RegisterId wxRegisterId
 114 #endif
 115
 116 // Return the current ID
 117 WXDLLEXPORT long wxGetCurrentId();
 118
 119 #endif // wxUSE_GUI
 120
 121 // ----------------------------------------------------------------------------
 122 // Various conversions
 123 // ----------------------------------------------------------------------------
 124
 125 WXDLLEXPORT_DATA(extern const wxChar*) wxFloatToStringStr;
 126 WXDLLEXPORT_DATA(extern const wxChar*) wxDoubleToStringStr;
 127
 128 WXDLLEXPORT void StringToFloat(const wxChar *s, float *number);
 129 WXDLLEXPORT wxChar* FloatToString(float number, const wxChar *fmt = wxFloatToStringStr);
 130 WXDLLEXPORT void StringToDouble(const wxChar *s, double *number);
 131 WXDLLEXPORT wxChar* DoubleToString(double number, const wxChar *fmt = wxDoubleToStringStr);
 132 WXDLLEXPORT void StringToInt(const wxChar *s, int *number);
 133 WXDLLEXPORT void StringToLong(const wxChar *s, long *number);
 134 WXDLLEXPORT wxChar* IntToString(int number);
 135 WXDLLEXPORT wxChar* LongToString(long number);
 136
 137 // Convert 2-digit hex number to decimal
 138 WXDLLEXPORT int wxHexToDec(const wxString& buf);
 139
 140 // Convert decimal integer to 2-character hex string
 141 WXDLLEXPORT void wxDecToHex(int dec, wxChar *buf);
 142 WXDLLEXPORT wxString wxDecToHex(int dec);
 143
 144 // ----------------------------------------------------------------------------
 145 // Process management
 146 // ----------------------------------------------------------------------------
 147
 148 // Execute another program. Returns 0 if there was an error, a PID otherwise.
 149 WXDLLEXPORT long wxExecute(wxChar **argv, bool sync = FALSE,
 150                            wxProcess *process = (wxProcess *) NULL);
 151 WXDLLEXPORT long wxExecute(const wxString& command, bool sync = FALSE,
 152                            wxProcess *process = (wxProcess *) NULL);
 153
 154 // execute the command capturing its output into an array line by line
 155 WXDLLEXPORT long wxExecute(const wxString& command,
 156                            wxArrayString& output);
 157
 158 // also capture stderr
 159 WXDLLEXPORT long wxExecute(const wxString& command,
 160                            wxArrayString& output,
 161                            wxArrayString& error);
 162
 163 enum wxSignal
 164 {
 165     wxSIGNONE = 0,  // verify if the process exists under Unix
 166     wxSIGHUP,
 167     wxSIGINT,
 168     wxSIGQUIT,
 169     wxSIGILL,
 170     wxSIGTRAP,
 171     wxSIGABRT,
 172     wxSIGIOT = wxSIGABRT,   // another name
 173     wxSIGEMT,
 174     wxSIGFPE,
 175     wxSIGKILL,
 176     wxSIGBUS,
 177     wxSIGSEGV,
 178     wxSIGSYS,
 179     wxSIGPIPE,
 180     wxSIGALRM,
 181     wxSIGTERM
 182
 183     // further signals are different in meaning between different Unix systems
 184 };
 185
 186 enum wxKillError
 187 {
 188     wxKILL_OK,              // no error
 189     wxKILL_BAD_SIGNAL,      // no such signal
 190     wxKILL_ACCESS_DENIED,   // permission denied
 191     wxKILL_NO_PROCESS,      // no such process
 192     wxKILL_ERROR            // another, unspecified error
 193 };
 194
 195 // send the given signal to the process (only NONE and KILL are supported under
 196 // Windows, all others mean TERM), return 0 if ok and -1 on error
 197 //
 198 // return detailed error in rc if not NULL
 199 WXDLLEXPORT int wxKill(long pid,
 200                        wxSignal sig = wxSIGTERM,
 201                        wxKillError *rc = NULL);
 202
 203 // Execute a command in an interactive shell window (always synchronously)
 204 // If no command then just the shell
 205 WXDLLEXPORT bool wxShell(const wxString& command = wxEmptyString);
 206
 207 // As wxShell(), but must give a (non interactive) command and its output will
 208 // be returned in output array
 209 WXDLLEXPORT bool wxShell(const wxString& command, wxArrayString& output);
 210
 211 // Sleep for nSecs seconds
 212 WXDLLEXPORT void wxSleep(int nSecs);
 213
 214 // Sleep for a given amount of milliseconds
 215 WXDLLEXPORT void wxUsleep(unsigned long milliseconds);
 216
 217 // Get free memory in bytes, or -1 if cannot determine amount (e.g. on UNIX)
 218 WXDLLEXPORT long wxGetFreeMemory();
 219
 220 // should wxApp::OnFatalException() be called?
 221 WXDLLEXPORT bool wxHandleFatalExceptions(bool doit = TRUE);
 222
 223 // ----------------------------------------------------------------------------
 224 // Environment variables
 225 // ----------------------------------------------------------------------------
 226
 227 // returns TRUE if variable exists (value may be NULL if you just want to check
 228 // for this)
 229 WXDLLEXPORT bool wxGetEnv(const wxString& var, wxString *value);
 230
 231 // set the env var name to the given value, return TRUE on success
 232 WXDLLEXPORT bool wxSetEnv(const wxString& var, const wxChar *value);
 233
 234 // remove the env var from environment
 235 inline bool wxUnsetEnv(const wxString& var) { return wxSetEnv(var, NULL); }
 236
 237 // ----------------------------------------------------------------------------
 238 // Network and username functions.
 239 // ----------------------------------------------------------------------------
 240
 241 // NB: "char *" functions are deprecated, use wxString ones!
 242
 243 // Get eMail address
 244 WXDLLEXPORT bool wxGetEmailAddress(wxChar *buf, int maxSize);
 245 WXDLLEXPORT wxString wxGetEmailAddress();
 246
 247 // Get hostname.
 248 WXDLLEXPORT bool wxGetHostName(wxChar *buf, int maxSize);
 249 WXDLLEXPORT wxString wxGetHostName();
 250
 251 // Get FQDN
 252 WXDLLEXPORT wxString wxGetFullHostName();
 253 WXDLLEXPORT bool wxGetFullHostName(wxChar *buf, int maxSize);
 254
 255 // Get user ID e.g. jacs (this is known as login name under Unix)
 256 WXDLLEXPORT bool wxGetUserId(wxChar *buf, int maxSize);
 257 WXDLLEXPORT wxString wxGetUserId();
 258
 259 // Get user name e.g. Julian Smart
 260 WXDLLEXPORT bool wxGetUserName(wxChar *buf, int maxSize);
 261 WXDLLEXPORT wxString wxGetUserName();
 262
 263 // Get current Home dir and copy to dest (returns pstr->c_str())
 264 WXDLLEXPORT wxString wxGetHomeDir();
 265 WXDLLEXPORT const wxChar* wxGetHomeDir(wxString *pstr);
 266
 267 // Get the user's home dir (caller must copy --- volatile)
 268 // returns NULL is no HOME dir is known
 269 #if defined(__UNIX__) && wxUSE_UNICODE
 270 WXDLLEXPORT const wxMB2WXbuf wxGetUserHome(const wxString& user = wxEmptyString);
 271 #else
 272 WXDLLEXPORT wxChar* wxGetUserHome(const wxString& user = wxEmptyString);
 273 #endif
 274
 275 #ifdef __WXMAC__
 276 WXDLLEXPORT wxString wxMacFindFolder(short vRefNum,
 277                                      OSType folderType,
 278                                      Boolean createFolder);
 279 #endif
 280
 281 // get number of total/free bytes on the disk where path belongs
 282 WXDLLEXPORT bool wxGetDiskSpace(const wxString& path,
 283                                 wxLongLong *pTotal = NULL,
 284                                 wxLongLong *pFree = NULL);
 285
 286 #if wxUSE_GUI // GUI only things from now on
 287
 288 // ----------------------------------------------------------------------------
 289 // Menu accelerators related things
 290 // ----------------------------------------------------------------------------
 291
 292 WXDLLEXPORT wxChar* wxStripMenuCodes(const wxChar *in, wxChar *out = (wxChar *) NULL);
 293 WXDLLEXPORT wxString wxStripMenuCodes(const wxString& str);
 294
 295 #if wxUSE_ACCEL
 296 class WXDLLEXPORT wxAcceleratorEntry;
 297 WXDLLEXPORT wxAcceleratorEntry *wxGetAccelFromString(const wxString& label);
 298 #endif // wxUSE_ACCEL
 299
 300 // ----------------------------------------------------------------------------
 301 // Window search
 302 // ----------------------------------------------------------------------------
 303
 304 // Find the window/widget with the given title or label.
 305 // Pass a parent to begin the search from, or NULL to look through
 306 // all windows.
 307 WXDLLEXPORT wxWindow* wxFindWindowByLabel(const wxString& title, wxWindow *parent = (wxWindow *) NULL);
 308
 309 // Find window by name, and if that fails, by label.
 310 WXDLLEXPORT wxWindow* wxFindWindowByName(const wxString& name, wxWindow *parent = (wxWindow *) NULL);
 311
 312 // Returns menu item id or -1 if none.
 313 WXDLLEXPORT int wxFindMenuItemId(wxFrame *frame, const wxString& menuString, const wxString& itemString);
 314
 315 // Find the wxWindow at the given point. wxGenericFindWindowAtPoint
 316 // is always present but may be less reliable than a native version.
 317 WXDLLEXPORT wxWindow* wxGenericFindWindowAtPoint(const wxPoint& pt);
 318 WXDLLEXPORT wxWindow* wxFindWindowAtPoint(const wxPoint& pt);
 319
 320 // ----------------------------------------------------------------------------
 321 // Message/event queue helpers
 322 // ----------------------------------------------------------------------------
 323
 324 // Yield to other apps/messages
 325 WXDLLEXPORT bool wxYield();
 326
 327 // Like wxYield, but fails silently if the yield is recursive.
 328 WXDLLEXPORT bool wxYieldIfNeeded();
 329
 330 // Yield to other apps/messages and disable user input
 331 WXDLLEXPORT bool wxSafeYield(wxWindow *win = NULL);
 332
 333 // Enable or disable input to all top level windows
 334 WXDLLEXPORT void wxEnableTopLevelWindows(bool enable = TRUE);
 335
 336 // Check whether this window wants to process messages, e.g. Stop button
 337 // in long calculations.
 338 WXDLLEXPORT bool wxCheckForInterrupt(wxWindow *wnd);
 339
 340 // Consume all events until no more left
 341 WXDLLEXPORT void wxFlushEvents();
 342
 343 // a class which disables all windows (except, may be, thegiven one) in its
 344 // ctor and enables them back in its dtor
 345 class WXDLLEXPORT wxWindowDisabler
 346 {
 347 public:
 348     wxWindowDisabler(wxWindow *winToSkip = (wxWindow *)NULL);
 349     ~wxWindowDisabler();
 350
 351 private:
 352     wxWindowList *m_winDisabled;
 353 };
 354
 355 // ----------------------------------------------------------------------------
 356 // Cursors
 357 // ----------------------------------------------------------------------------
 358
 359 // Set the cursor to the busy cursor for all windows
 360 class WXDLLEXPORT wxCursor;
 361 WXDLLEXPORT_DATA(extern wxCursor*) wxHOURGLASS_CURSOR;
 362 WXDLLEXPORT void wxBeginBusyCursor(wxCursor *cursor = wxHOURGLASS_CURSOR);
 363
 364 // Restore cursor to normal
 365 WXDLLEXPORT void wxEndBusyCursor();
 366
 367 // TRUE if we're between the above two calls
 368 WXDLLEXPORT bool wxIsBusy();
 369
 370 // Convenience class so we can just create a wxBusyCursor object on the stack
 371 class WXDLLEXPORT wxBusyCursor
 372 {
 373 public:
 374     wxBusyCursor(wxCursor* cursor = wxHOURGLASS_CURSOR)
 375         { wxBeginBusyCursor(cursor); }
 376     ~wxBusyCursor()
 377         { wxEndBusyCursor(); }
 378
 379     // FIXME: These two methods are currently only implemented (and needed?)
 380     //        in wxGTK.  BusyCursor handling should probably be moved to
 381     //        common code since the wxGTK and wxMSW implementations are very
 382     //        similar except for wxMSW using HCURSOR directly instead of
 383     //        wxCursor..  -- RL.
 384     static const wxCursor &GetStoredCursor();
 385     static const wxCursor GetBusyCursor();
 386 };
 387
 388
 389 // ----------------------------------------------------------------------------
 390 // Reading and writing resources (eg WIN.INI, .Xdefaults)
 391 // ----------------------------------------------------------------------------
 392
 393 #if wxUSE_RESOURCES
 394 WXDLLEXPORT bool wxWriteResource(const wxString& section, const wxString& entry, const wxString& value, const wxString& file = wxEmptyString);
 395 WXDLLEXPORT bool wxWriteResource(const wxString& section, const wxString& entry, float value, const wxString& file = wxEmptyString);
 396 WXDLLEXPORT bool wxWriteResource(const wxString& section, const wxString& entry, long value, const wxString& file = wxEmptyString);
 397 WXDLLEXPORT bool wxWriteResource(const wxString& section, const wxString& entry, int value, const wxString& file = wxEmptyString);
 398
 399 WXDLLEXPORT bool wxGetResource(const wxString& section, const wxString& entry, wxChar **value, const wxString& file = wxEmptyString);
 400 WXDLLEXPORT bool wxGetResource(const wxString& section, const wxString& entry, float *value, const wxString& file = wxEmptyString);
 401 WXDLLEXPORT bool wxGetResource(const wxString& section, const wxString& entry, long *value, const wxString& file = wxEmptyString);
 402 WXDLLEXPORT bool wxGetResource(const wxString& section, const wxString& entry, int *value, const wxString& file = wxEmptyString);
 403 #endif // wxUSE_RESOURCES
 404
 405 void WXDLLEXPORT wxGetMousePosition( int* x, int* y );
 406
 407 // MSW only: get user-defined resource from the .res file.
 408 // Returns NULL or newly-allocated memory, so use delete[] to clean up.
 409 #ifdef __WXMSW__
 410 WXDLLEXPORT extern const wxChar* wxUserResourceStr;
 411 WXDLLEXPORT wxChar* wxLoadUserResource(const wxString& resourceName, const wxString& resourceType = wxUserResourceStr);
 412
 413 // Implemented in utils.cpp: VC++, Win95 only. Sets up a console for standard
 414 // input/output
 415 WXDLLEXPORT void wxRedirectIOToConsole();
 416
 417 #endif // MSW
 418
 419 // ----------------------------------------------------------------------------
 420 // Display and colorss (X only)
 421 // ----------------------------------------------------------------------------
 422
 423 #ifdef __WXGTK__
 424     void *wxGetDisplay();
 425 #endif
 426
 427 #ifdef __X__
 428     WXDisplay *wxGetDisplay();
 429     bool wxSetDisplay(const wxString& display_name);
 430     wxString wxGetDisplayName();
 431 #endif // X or GTK+
 432
 433 #ifdef __X__
 434
 435 #ifdef __VMS__ // Xlib.h for VMS is not (yet) compatible with C++
 436                // The resulting warnings are switched off here
 437 #pragma message disable nosimpint
 438 #endif
 439 #include <X11/Xlib.h>
 440 #ifdef __VMS__
 441 #pragma message enable nosimpint
 442 #endif
 443
 444 #define wxMAX_RGB           0xff
 445 #define wxMAX_SV            1000
 446 #define wxSIGN(x)           ((x < 0) ? -x : x)
 447 #define wxH_WEIGHT          4
 448 #define wxS_WEIGHT          1
 449 #define wxV_WEIGHT          2
 450
 451 typedef struct wx_hsv {
 452                         int h,s,v;
 453                       } wxHSV;
 454
 455 #define wxMax3(x,y,z) ((x > y) ? ((x > z) ? x : z) : ((y > z) ? y : z))
 456 #define wxMin3(x,y,z) ((x < y) ? ((x < z) ? x : z) : ((y < z) ? y : z))
 457
 458 void wxHSVToXColor(wxHSV *hsv,XColor *xcolor);
 459 void wxXColorToHSV(wxHSV *hsv,XColor *xcolor);
 460 void wxAllocNearestColor(Display *display,Colormap colormap,XColor *xcolor);
 461 void wxAllocColor(Display *display,Colormap colormap,XColor *xcolor);
 462
 463 #endif //__X__
 464
 465 #endif // wxUSE_GUI
 466
 467 // ----------------------------------------------------------------------------
 468 // Error message functions used by wxWindows (deprecated, use wxLog)
 469 // ----------------------------------------------------------------------------
 470
 471 // Format a message on the standard error (UNIX) or the debugging
 472 // stream (Windows)
 473 WXDLLEXPORT void wxDebugMsg(const wxChar *fmt ...);
 474
 475 // Non-fatal error (continues)
 476 WXDLLEXPORT_DATA(extern const wxChar*) wxInternalErrorStr;
 477 WXDLLEXPORT void wxError(const wxString& msg, const wxString& title = wxInternalErrorStr);
 478
 479 // Fatal error (exits)
 480 WXDLLEXPORT_DATA(extern const wxChar*) wxFatalErrorStr;
 481 WXDLLEXPORT void wxFatalError(const wxString& msg, const wxString& title = wxFatalErrorStr);
 482
 483
 484 #endif
 485     // _WX_UTILSH__