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