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