include/wx/utils.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/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_UTILS_H_
  13 #define _WX_UTILS_H_
  14
  15 // ----------------------------------------------------------------------------
  16 // headers
  17 // ----------------------------------------------------------------------------
  18
  19 #include "wx/object.h"
  20 #include "wx/list.h"
  21 #include "wx/filefn.h"
  22 #include "wx/hashmap.h"
  23 #include "wx/versioninfo.h"
  24 #include "wx/meta/implicitconversion.h"
  25
  26 #if wxUSE_GUI
  27     #include "wx/gdicmn.h"
  28     #include "wx/mousestate.h"
  29 #endif
  30
  31 class WXDLLIMPEXP_FWD_BASE wxArrayString;
  32 class WXDLLIMPEXP_FWD_BASE wxArrayInt;
  33
  34 // need this for wxGetDiskSpace() as we can't, unfortunately, forward declare
  35 // wxLongLong
  36 #include "wx/longlong.h"
  37
  38 // needed for wxOperatingSystemId, wxLinuxDistributionInfo
  39 #include "wx/platinfo.h"
  40
  41 #ifdef __WATCOMC__
  42     #include <direct.h>
  43 #elif defined(__X__)
  44     #include <dirent.h>
  45     #include <unistd.h>
  46 #endif
  47
  48 #include <stdio.h>
  49
  50 // ----------------------------------------------------------------------------
  51 // Forward declaration
  52 // ----------------------------------------------------------------------------
  53
  54 class WXDLLIMPEXP_FWD_BASE wxProcess;
  55 class WXDLLIMPEXP_FWD_CORE wxFrame;
  56 class WXDLLIMPEXP_FWD_CORE wxWindow;
  57 class WXDLLIMPEXP_FWD_CORE wxWindowList;
  58 class WXDLLIMPEXP_FWD_CORE wxEventLoop;
  59
  60 // ----------------------------------------------------------------------------
  61 // Arithmetic functions
  62 // ----------------------------------------------------------------------------
  63
  64 template<typename T1, typename T2>
  65 inline typename wxImplicitConversionType<T1,T2>::value
  66 wxMax(T1 a, T2 b)
  67 {
  68     typedef typename wxImplicitConversionType<T1,T2>::value ResultType;
  69
  70     // Cast both operands to the same type before comparing them to avoid
  71     // warnings about signed/unsigned comparisons from some compilers:
  72     return static_cast<ResultType>(a) > static_cast<ResultType>(b) ? a : b;
  73 }
  74
  75 template<typename T1, typename T2>
  76 inline typename wxImplicitConversionType<T1,T2>::value
  77 wxMin(T1 a, T2 b)
  78 {
  79     typedef typename wxImplicitConversionType<T1,T2>::value ResultType;
  80
  81     return static_cast<ResultType>(a) < static_cast<ResultType>(b) ? a : b;
  82 }
  83
  84 template<typename T1, typename T2, typename T3>
  85 inline typename wxImplicitConversionType3<T1,T2,T3>::value
  86 wxClip(T1 a, T2 b, T3 c)
  87 {
  88     typedef typename wxImplicitConversionType3<T1,T2,T3>::value ResultType;
  89
  90     if ( static_cast<ResultType>(a) < static_cast<ResultType>(b) )
  91         return b;
  92
  93     if ( static_cast<ResultType>(a) > static_cast<ResultType>(c) )
  94         return c;
  95
  96     return a;
  97 }
  98
  99 // ----------------------------------------------------------------------------
 100 // wxMemorySize
 101 // ----------------------------------------------------------------------------
 102
 103 // wxGetFreeMemory can return huge amount of memory on 32-bit platforms as well
 104 // so to always use long long for its result type on all platforms which
 105 // support it
 106 #if wxUSE_LONGLONG
 107     typedef wxLongLong wxMemorySize;
 108 #else
 109     typedef long wxMemorySize;
 110 #endif
 111
 112 // ----------------------------------------------------------------------------
 113 // String functions (deprecated, use wxString)
 114 // ----------------------------------------------------------------------------
 115
 116 #ifdef WXWIN_COMPATIBILITY_2_8
 117 // A shorter way of using strcmp
 118 wxDEPRECATED_INLINE(inline bool wxStringEq(const char *s1, const char *s2),
 119     return wxCRT_StrcmpA(s1, s2) == 0; )
 120
 121 #if wxUSE_UNICODE
 122 wxDEPRECATED_INLINE(inline bool wxStringEq(const wchar_t *s1, const wchar_t *s2),
 123     return wxCRT_StrcmpW(s1, s2) == 0; )
 124 #endif // wxUSE_UNICODE
 125
 126 #endif // WXWIN_COMPATIBILITY_2_8
 127
 128 // ----------------------------------------------------------------------------
 129 // Miscellaneous functions
 130 // ----------------------------------------------------------------------------
 131
 132 // Sound the bell
 133 #if !defined __EMX__ && \
 134     (defined __WXMOTIF__ || defined __WXGTK__ || defined __WXX11__)
 135 WXDLLIMPEXP_CORE void wxBell();
 136 #else
 137 WXDLLIMPEXP_BASE void wxBell();
 138 #endif
 139
 140 #if wxUSE_MSGDLG
 141 // Show wxWidgets information
 142 WXDLLIMPEXP_CORE void wxInfoMessageBox(wxWindow* parent);
 143 #endif // wxUSE_MSGDLG
 144
 145 WXDLLIMPEXP_CORE wxVersionInfo wxGetLibraryVersionInfo();
 146
 147 // Get OS description as a user-readable string
 148 WXDLLIMPEXP_BASE wxString wxGetOsDescription();
 149
 150 // Get OS version
 151 WXDLLIMPEXP_BASE wxOperatingSystemId wxGetOsVersion(int *majorVsn = NULL,
 152                                                     int *minorVsn = NULL);
 153
 154 // Get platform endianness
 155 WXDLLIMPEXP_BASE bool wxIsPlatformLittleEndian();
 156
 157 // Get platform architecture
 158 WXDLLIMPEXP_BASE bool wxIsPlatform64Bit();
 159
 160 #ifdef __LINUX__
 161 // Get linux-distro informations
 162 WXDLLIMPEXP_BASE wxLinuxDistributionInfo wxGetLinuxDistributionInfo();
 163 #endif
 164
 165 // Return a string with the current date/time
 166 WXDLLIMPEXP_BASE wxString wxNow();
 167
 168 // Return path where wxWidgets is installed (mostly useful in Unices)
 169 WXDLLIMPEXP_BASE const wxChar *wxGetInstallPrefix();
 170 // Return path to wxWin data (/usr/share/wx/%{version}) (Unices)
 171 WXDLLIMPEXP_BASE wxString wxGetDataDir();
 172
 173 #if wxUSE_GUI
 174
 175 // Get the state of a key (true if pressed, false if not)
 176 // This is generally most useful getting the state of
 177 // the modifier or toggle keys.
 178 WXDLLIMPEXP_CORE bool wxGetKeyState(wxKeyCode key);
 179
 180 // Don't synthesize KeyUp events holding down a key and producing
 181 // KeyDown events with autorepeat. On by default and always on
 182 // in wxMSW.
 183 WXDLLIMPEXP_CORE bool wxSetDetectableAutoRepeat( bool flag );
 184
 185 // Returns the current state of the mouse position, buttons and modifers
 186 WXDLLIMPEXP_CORE wxMouseState wxGetMouseState();
 187
 188 #endif // wxUSE_GUI
 189
 190 // ----------------------------------------------------------------------------
 191 // wxPlatform
 192 // ----------------------------------------------------------------------------
 193
 194 /*
 195  * Class to make it easier to specify platform-dependent values
 196  *
 197  * Examples:
 198  *  long val = wxPlatform::If(wxMac, 1).ElseIf(wxGTK, 2).ElseIf(stPDA, 5).Else(3);
 199  *  wxString strVal = wxPlatform::If(wxMac, wxT("Mac")).ElseIf(wxMSW, wxT("MSW")).Else(wxT("Other"));
 200  *
 201  * A custom platform symbol:
 202  *
 203  *  #define stPDA 100
 204  *  #ifdef __WXWINCE__
 205  *      wxPlatform::AddPlatform(stPDA);
 206  *  #endif
 207  *
 208  *  long windowStyle = wxCAPTION | (long) wxPlatform::IfNot(stPDA, wxRESIZE_BORDER);
 209  *
 210  */
 211
 212 class WXDLLIMPEXP_BASE wxPlatform
 213 {
 214 public:
 215     wxPlatform() { Init(); }
 216     wxPlatform(const wxPlatform& platform) { Copy(platform); }
 217     void operator = (const wxPlatform& platform) { if (&platform != this) Copy(platform); }
 218     void Copy(const wxPlatform& platform);
 219
 220     // Specify an optional default value
 221     wxPlatform(int defValue) { Init(); m_longValue = (long)defValue; }
 222     wxPlatform(long defValue) { Init(); m_longValue = defValue; }
 223     wxPlatform(const wxString& defValue) { Init(); m_stringValue = defValue; }
 224     wxPlatform(double defValue) { Init(); m_doubleValue = defValue; }
 225
 226     static wxPlatform If(int platform, long value);
 227     static wxPlatform IfNot(int platform, long value);
 228     wxPlatform& ElseIf(int platform, long value);
 229     wxPlatform& ElseIfNot(int platform, long value);
 230     wxPlatform& Else(long value);
 231
 232     static wxPlatform If(int platform, int value) { return If(platform, (long)value); }
 233     static wxPlatform IfNot(int platform, int value) { return IfNot(platform, (long)value); }
 234     wxPlatform& ElseIf(int platform, int value) { return ElseIf(platform, (long) value); }
 235     wxPlatform& ElseIfNot(int platform, int value) { return ElseIfNot(platform, (long) value); }
 236     wxPlatform& Else(int value) { return Else((long) value); }
 237
 238     static wxPlatform If(int platform, double value);
 239     static wxPlatform IfNot(int platform, double value);
 240     wxPlatform& ElseIf(int platform, double value);
 241     wxPlatform& ElseIfNot(int platform, double value);
 242     wxPlatform& Else(double value);
 243
 244     static wxPlatform If(int platform, const wxString& value);
 245     static wxPlatform IfNot(int platform, const wxString& value);
 246     wxPlatform& ElseIf(int platform, const wxString& value);
 247     wxPlatform& ElseIfNot(int platform, const wxString& value);
 248     wxPlatform& Else(const wxString& value);
 249
 250     long GetInteger() const { return m_longValue; }
 251     const wxString& GetString() const { return m_stringValue; }
 252     double GetDouble() const { return m_doubleValue; }
 253
 254     operator int() const { return (int) GetInteger(); }
 255     operator long() const { return GetInteger(); }
 256     operator double() const { return GetDouble(); }
 257     operator const wxString&() const { return GetString(); }
 258
 259     static void AddPlatform(int platform);
 260     static bool Is(int platform);
 261     static void ClearPlatforms();
 262
 263 private:
 264
 265     void Init() { m_longValue = 0; m_doubleValue = 0.0; }
 266
 267     long                m_longValue;
 268     double              m_doubleValue;
 269     wxString            m_stringValue;
 270     static wxArrayInt*  sm_customPlatforms;
 271 };
 272
 273 /// Function for testing current platform
 274 inline bool wxPlatformIs(int platform) { return wxPlatform::Is(platform); }
 275
 276 // ----------------------------------------------------------------------------
 277 // Window ID management
 278 // ----------------------------------------------------------------------------
 279
 280 // Ensure subsequent IDs don't clash with this one
 281 WXDLLIMPEXP_BASE void wxRegisterId(long id);
 282
 283 // Return the current ID
 284 WXDLLIMPEXP_BASE long wxGetCurrentId();
 285
 286 // Generate a unique ID
 287 WXDLLIMPEXP_BASE long wxNewId();
 288
 289 // ----------------------------------------------------------------------------
 290 // Various conversions
 291 // ----------------------------------------------------------------------------
 292
 293 // Convert 2-digit hex number to decimal
 294 WXDLLIMPEXP_BASE int wxHexToDec(const wxString& buf);
 295
 296 // Convert 2-digit hex number to decimal
 297 inline int wxHexToDec(const char* buf)
 298 {
 299     int firstDigit, secondDigit;
 300
 301     if (buf[0] >= 'A')
 302         firstDigit = buf[0] - 'A' + 10;
 303     else
 304         firstDigit = buf[0] - '0';
 305
 306     if (buf[1] >= 'A')
 307         secondDigit = buf[1] - 'A' + 10;
 308     else
 309         secondDigit = buf[1] - '0';
 310
 311     return (firstDigit & 0xF) * 16 + (secondDigit & 0xF );
 312 }
 313
 314
 315 // Convert decimal integer to 2-character hex string
 316 WXDLLIMPEXP_BASE void wxDecToHex(int dec, wxChar *buf);
 317 WXDLLIMPEXP_BASE void wxDecToHex(int dec, char* ch1, char* ch2);
 318 WXDLLIMPEXP_BASE wxString wxDecToHex(int dec);
 319
 320 // ----------------------------------------------------------------------------
 321 // Process management
 322 // ----------------------------------------------------------------------------
 323
 324 // NB: for backwards compatibility reasons the values of wxEXEC_[A]SYNC *must*
 325 //     be 0 and 1, don't change!
 326
 327 enum
 328 {
 329     // execute the process asynchronously
 330     wxEXEC_ASYNC    = 0,
 331
 332     // execute it synchronously, i.e. wait until it finishes
 333     wxEXEC_SYNC     = 1,
 334
 335     // under Windows, don't hide the child even if it's IO is redirected (this
 336     // is done by default)
 337     wxEXEC_SHOW_CONSOLE   = 2,
 338
 339     // deprecated synonym for wxEXEC_SHOW_CONSOLE, use the new name as it's
 340     // more clear
 341     wxEXEC_NOHIDE = wxEXEC_SHOW_CONSOLE,
 342
 343     // under Unix, if the process is the group leader then passing wxKILL_CHILDREN to wxKill
 344     // kills all children as well as pid
 345     wxEXEC_MAKE_GROUP_LEADER = 4,
 346
 347     // by default synchronous execution disables all program windows to avoid
 348     // that the user interacts with the program while the child process is
 349     // running, you can use this flag to prevent this from happening
 350     wxEXEC_NODISABLE = 8,
 351
 352     // by default, the event loop is run while waiting for synchronous execution
 353     // to complete and this flag can be used to simply block the main process
 354     // until the child process finishes
 355     wxEXEC_NOEVENTS = 16,
 356
 357     // under Windows, hide the console of the child process if it has one, even
 358     // if its IO is not redirected
 359     wxEXEC_HIDE_CONSOLE = 32,
 360
 361     // convenient synonym for flags given system()-like behaviour
 362     wxEXEC_BLOCK = wxEXEC_SYNC | wxEXEC_NOEVENTS
 363 };
 364
 365 // Map storing environment variables.
 366 typedef wxStringToStringHashMap wxEnvVariableHashMap;
 367
 368 // Used to pass additional parameters for child process to wxExecute(). Could
 369 // be extended with other fields later.
 370 struct wxExecuteEnv
 371 {
 372     wxString cwd;               // If empty, CWD is not changed.
 373     wxEnvVariableHashMap env;   // If empty, environment is unchanged.
 374 };
 375
 376 // Execute another program.
 377 //
 378 // If flags contain wxEXEC_SYNC, return -1 on failure and the exit code of the
 379 // process if everything was ok. Otherwise (i.e. if wxEXEC_ASYNC), return 0 on
 380 // failure and the PID of the launched process if ok.
 381 WXDLLIMPEXP_BASE long wxExecute(const wxString& command,
 382                                 int flags = wxEXEC_ASYNC,
 383                                 wxProcess *process = NULL,
 384                                 const wxExecuteEnv *env = NULL);
 385 WXDLLIMPEXP_BASE long wxExecute(char **argv,
 386                                 int flags = wxEXEC_ASYNC,
 387                                 wxProcess *process = NULL,
 388                                 const wxExecuteEnv *env = NULL);
 389 #if wxUSE_UNICODE
 390 WXDLLIMPEXP_BASE long wxExecute(wchar_t **argv,
 391                                 int flags = wxEXEC_ASYNC,
 392                                 wxProcess *process = NULL,
 393                                 const wxExecuteEnv *env = NULL);
 394 #endif // wxUSE_UNICODE
 395
 396 // execute the command capturing its output into an array line by line, this is
 397 // always synchronous
 398 WXDLLIMPEXP_BASE long wxExecute(const wxString& command,
 399                                 wxArrayString& output,
 400                                 int flags = 0,
 401                                 const wxExecuteEnv *env = NULL);
 402
 403 // also capture stderr (also synchronous)
 404 WXDLLIMPEXP_BASE long wxExecute(const wxString& command,
 405                                 wxArrayString& output,
 406                                 wxArrayString& error,
 407                                 int flags = 0,
 408                                 const wxExecuteEnv *env = NULL);
 409
 410 #if defined(__WXMSW__) && wxUSE_IPC
 411 // ask a DDE server to execute the DDE request with given parameters
 412 WXDLLIMPEXP_BASE bool wxExecuteDDE(const wxString& ddeServer,
 413                                    const wxString& ddeTopic,
 414                                    const wxString& ddeCommand);
 415 #endif // __WXMSW__ && wxUSE_IPC
 416
 417 enum wxSignal
 418 {
 419     wxSIGNONE = 0,  // verify if the process exists under Unix
 420     wxSIGHUP,
 421     wxSIGINT,
 422     wxSIGQUIT,
 423     wxSIGILL,
 424     wxSIGTRAP,
 425     wxSIGABRT,
 426     wxSIGIOT = wxSIGABRT,   // another name
 427     wxSIGEMT,
 428     wxSIGFPE,
 429     wxSIGKILL,
 430     wxSIGBUS,
 431     wxSIGSEGV,
 432     wxSIGSYS,
 433     wxSIGPIPE,
 434     wxSIGALRM,
 435     wxSIGTERM
 436
 437     // further signals are different in meaning between different Unix systems
 438 };
 439
 440 enum wxKillError
 441 {
 442     wxKILL_OK,              // no error
 443     wxKILL_BAD_SIGNAL,      // no such signal
 444     wxKILL_ACCESS_DENIED,   // permission denied
 445     wxKILL_NO_PROCESS,      // no such process
 446     wxKILL_ERROR            // another, unspecified error
 447 };
 448
 449 enum wxKillFlags
 450 {
 451     wxKILL_NOCHILDREN = 0,  // don't kill children
 452     wxKILL_CHILDREN = 1     // kill children
 453 };
 454
 455 enum wxShutdownFlags
 456 {
 457     wxSHUTDOWN_FORCE    = 1,// can be combined with other flags (MSW-only)
 458     wxSHUTDOWN_POWEROFF = 2,// power off the computer
 459     wxSHUTDOWN_REBOOT   = 4,// shutdown and reboot
 460     wxSHUTDOWN_LOGOFF   = 8 // close session (currently MSW-only)
 461 };
 462
 463 // Shutdown or reboot the PC
 464 WXDLLIMPEXP_BASE bool wxShutdown(int flags = wxSHUTDOWN_POWEROFF);
 465
 466 // send the given signal to the process (only NONE and KILL are supported under
 467 // Windows, all others mean TERM), return 0 if ok and -1 on error
 468 //
 469 // return detailed error in rc if not NULL
 470 WXDLLIMPEXP_BASE int wxKill(long pid,
 471                        wxSignal sig = wxSIGTERM,
 472                        wxKillError *rc = NULL,
 473                        int flags = wxKILL_NOCHILDREN);
 474
 475 // Execute a command in an interactive shell window (always synchronously)
 476 // If no command then just the shell
 477 WXDLLIMPEXP_BASE bool wxShell(const wxString& command = wxEmptyString);
 478
 479 // As wxShell(), but must give a (non interactive) command and its output will
 480 // be returned in output array
 481 WXDLLIMPEXP_BASE bool wxShell(const wxString& command, wxArrayString& output);
 482
 483 // Sleep for nSecs seconds
 484 WXDLLIMPEXP_BASE void wxSleep(int nSecs);
 485
 486 // Sleep for a given amount of milliseconds
 487 WXDLLIMPEXP_BASE void wxMilliSleep(unsigned long milliseconds);
 488
 489 // Sleep for a given amount of microseconds
 490 WXDLLIMPEXP_BASE void wxMicroSleep(unsigned long microseconds);
 491
 492 #if WXWIN_COMPATIBILITY_2_8
 493 // Sleep for a given amount of milliseconds (old, bad name), use wxMilliSleep
 494 wxDEPRECATED( WXDLLIMPEXP_BASE void wxUsleep(unsigned long milliseconds) );
 495 #endif
 496
 497 // Get the process id of the current process
 498 WXDLLIMPEXP_BASE unsigned long wxGetProcessId();
 499
 500 // Get free memory in bytes, or -1 if cannot determine amount (e.g. on UNIX)
 501 WXDLLIMPEXP_BASE wxMemorySize wxGetFreeMemory();
 502
 503 #if wxUSE_ON_FATAL_EXCEPTION
 504
 505 // should wxApp::OnFatalException() be called?
 506 WXDLLIMPEXP_BASE bool wxHandleFatalExceptions(bool doit = true);
 507
 508 #endif // wxUSE_ON_FATAL_EXCEPTION
 509
 510 // ----------------------------------------------------------------------------
 511 // Environment variables
 512 // ----------------------------------------------------------------------------
 513
 514 // returns true if variable exists (value may be NULL if you just want to check
 515 // for this)
 516 WXDLLIMPEXP_BASE bool wxGetEnv(const wxString& var, wxString *value);
 517
 518 // set the env var name to the given value, return true on success
 519 WXDLLIMPEXP_BASE bool wxSetEnv(const wxString& var, const wxString& value);
 520
 521 // remove the env var from environment
 522 WXDLLIMPEXP_BASE bool wxUnsetEnv(const wxString& var);
 523
 524 #if WXWIN_COMPATIBILITY_2_8
 525 inline bool wxSetEnv(const wxString& var, const char *value)
 526     { return wxSetEnv(var, wxString(value)); }
 527 inline bool wxSetEnv(const wxString& var, const wchar_t *value)
 528     { return wxSetEnv(var, wxString(value)); }
 529 template<typename T>
 530 inline bool wxSetEnv(const wxString& var, const wxScopedCharTypeBuffer<T>& value)
 531     { return wxSetEnv(var, wxString(value)); }
 532 inline bool wxSetEnv(const wxString& var, const wxCStrData& value)
 533     { return wxSetEnv(var, wxString(value)); }
 534
 535 // this one is for passing NULL directly - don't use it, use wxUnsetEnv instead
 536 wxDEPRECATED( inline bool wxSetEnv(const wxString& var, int value) );
 537 inline bool wxSetEnv(const wxString& var, int value)
 538 {
 539     wxASSERT_MSG( value == 0, "using non-NULL integer as string?" );
 540
 541     wxUnusedVar(value); // fix unused parameter warning in release build
 542
 543     return wxUnsetEnv(var);
 544 }
 545 #endif // WXWIN_COMPATIBILITY_2_8
 546
 547 // Retrieve the complete environment by filling specified map.
 548 // Returns true on success or false if an error occurred.
 549 WXDLLIMPEXP_BASE bool wxGetEnvMap(wxEnvVariableHashMap *map);
 550
 551 // ----------------------------------------------------------------------------
 552 // Network and username functions.
 553 // ----------------------------------------------------------------------------
 554
 555 // NB: "char *" functions are deprecated, use wxString ones!
 556
 557 // Get eMail address
 558 WXDLLIMPEXP_BASE bool wxGetEmailAddress(wxChar *buf, int maxSize);
 559 WXDLLIMPEXP_BASE wxString wxGetEmailAddress();
 560
 561 // Get hostname.
 562 WXDLLIMPEXP_BASE bool wxGetHostName(wxChar *buf, int maxSize);
 563 WXDLLIMPEXP_BASE wxString wxGetHostName();
 564
 565 // Get FQDN
 566 WXDLLIMPEXP_BASE wxString wxGetFullHostName();
 567 WXDLLIMPEXP_BASE bool wxGetFullHostName(wxChar *buf, int maxSize);
 568
 569 // Get user ID e.g. jacs (this is known as login name under Unix)
 570 WXDLLIMPEXP_BASE bool wxGetUserId(wxChar *buf, int maxSize);
 571 WXDLLIMPEXP_BASE wxString wxGetUserId();
 572
 573 // Get user name e.g. Julian Smart
 574 WXDLLIMPEXP_BASE bool wxGetUserName(wxChar *buf, int maxSize);
 575 WXDLLIMPEXP_BASE wxString wxGetUserName();
 576
 577 // Get current Home dir and copy to dest (returns pstr->c_str())
 578 WXDLLIMPEXP_BASE wxString wxGetHomeDir();
 579 WXDLLIMPEXP_BASE const wxChar* wxGetHomeDir(wxString *pstr);
 580
 581 // Get the user's (by default use the current user name) home dir,
 582 // return empty string on error
 583 WXDLLIMPEXP_BASE wxString wxGetUserHome(const wxString& user = wxEmptyString);
 584
 585
 586 #if wxUSE_LONGLONG
 587     typedef wxLongLong wxDiskspaceSize_t;
 588 #else
 589     typedef long wxDiskspaceSize_t;
 590 #endif
 591
 592 // get number of total/free bytes on the disk where path belongs
 593 WXDLLIMPEXP_BASE bool wxGetDiskSpace(const wxString& path,
 594                                      wxDiskspaceSize_t *pTotal = NULL,
 595                                      wxDiskspaceSize_t *pFree = NULL);
 596
 597
 598
 599 typedef int (*wxSortCallback)(const void* pItem1,
 600                               const void* pItem2,
 601                               const void* user_data);
 602
 603
 604 WXDLLIMPEXP_BASE void wxQsort(void* pbase, size_t total_elems,
 605                               size_t size, wxSortCallback cmp,
 606                               const void* user_data);
 607
 608
 609 #if wxUSE_GUI // GUI only things from now on
 610
 611 // ----------------------------------------------------------------------------
 612 // Launch default browser
 613 // ----------------------------------------------------------------------------
 614
 615 // flags for wxLaunchDefaultBrowser
 616 enum
 617 {
 618     wxBROWSER_NEW_WINDOW   = 0x01,
 619     wxBROWSER_NOBUSYCURSOR = 0x02
 620 };
 621
 622 // Launch url in the user's default internet browser
 623 WXDLLIMPEXP_CORE bool wxLaunchDefaultBrowser(const wxString& url, int flags = 0);
 624
 625 // Launch document in the user's default application
 626 WXDLLIMPEXP_CORE bool wxLaunchDefaultApplication(const wxString& path, int flags = 0);
 627
 628 // ----------------------------------------------------------------------------
 629 // Menu accelerators related things
 630 // ----------------------------------------------------------------------------
 631
 632 // flags for wxStripMenuCodes
 633 enum
 634 {
 635     // strip '&' characters
 636     wxStrip_Mnemonics = 1,
 637
 638     // strip everything after '\t'
 639     wxStrip_Accel = 2,
 640
 641     // strip everything (this is the default)
 642     wxStrip_All = wxStrip_Mnemonics | wxStrip_Accel
 643 };
 644
 645 // strip mnemonics and/or accelerators from the label
 646 WXDLLIMPEXP_CORE wxString
 647 wxStripMenuCodes(const wxString& str, int flags = wxStrip_All);
 648
 649 #if WXWIN_COMPATIBILITY_2_6
 650 // obsolete and deprecated version, do not use, use the above overload instead
 651 wxDEPRECATED(
 652     WXDLLIMPEXP_CORE wxChar* wxStripMenuCodes(const wxChar *in, wxChar *out = NULL)
 653 );
 654
 655 #if wxUSE_ACCEL
 656 class WXDLLIMPEXP_FWD_CORE wxAcceleratorEntry;
 657
 658 // use wxAcceleratorEntry::Create() or FromString() methods instead
 659 wxDEPRECATED(
 660     WXDLLIMPEXP_CORE wxAcceleratorEntry *wxGetAccelFromString(const wxString& label)
 661 );
 662 #endif // wxUSE_ACCEL
 663
 664 #endif // WXWIN_COMPATIBILITY_2_6
 665
 666 // ----------------------------------------------------------------------------
 667 // Window search
 668 // ----------------------------------------------------------------------------
 669
 670 // Returns menu item id or wxNOT_FOUND if none.
 671 WXDLLIMPEXP_CORE int wxFindMenuItemId(wxFrame *frame, const wxString& menuString, const wxString& itemString);
 672
 673 // Find the wxWindow at the given point. wxGenericFindWindowAtPoint
 674 // is always present but may be less reliable than a native version.
 675 WXDLLIMPEXP_CORE wxWindow* wxGenericFindWindowAtPoint(const wxPoint& pt);
 676 WXDLLIMPEXP_CORE wxWindow* wxFindWindowAtPoint(const wxPoint& pt);
 677
 678 // NB: this function is obsolete, use wxWindow::FindWindowByLabel() instead
 679 //
 680 // Find the window/widget with the given title or label.
 681 // Pass a parent to begin the search from, or NULL to look through
 682 // all windows.
 683 WXDLLIMPEXP_CORE wxWindow* wxFindWindowByLabel(const wxString& title, wxWindow *parent = NULL);
 684
 685 // NB: this function is obsolete, use wxWindow::FindWindowByName() instead
 686 //
 687 // Find window by name, and if that fails, by label.
 688 WXDLLIMPEXP_CORE wxWindow* wxFindWindowByName(const wxString& name, wxWindow *parent = NULL);
 689
 690 // ----------------------------------------------------------------------------
 691 // Message/event queue helpers
 692 // ----------------------------------------------------------------------------
 693
 694 // Yield to other apps/messages and disable user input
 695 WXDLLIMPEXP_CORE bool wxSafeYield(wxWindow *win = NULL, bool onlyIfNeeded = false);
 696
 697 // Enable or disable input to all top level windows
 698 WXDLLIMPEXP_CORE void wxEnableTopLevelWindows(bool enable = true);
 699
 700 // Check whether this window wants to process messages, e.g. Stop button
 701 // in long calculations.
 702 WXDLLIMPEXP_CORE bool wxCheckForInterrupt(wxWindow *wnd);
 703
 704 // Consume all events until no more left
 705 WXDLLIMPEXP_CORE void wxFlushEvents();
 706
 707 // a class which disables all windows (except, may be, the given one) in its
 708 // ctor and enables them back in its dtor
 709 class WXDLLIMPEXP_CORE wxWindowDisabler
 710 {
 711 public:
 712     // this ctor conditionally disables all windows: if the argument is false,
 713     // it doesn't do anything
 714     wxWindowDisabler(bool disable = true);
 715
 716     // ctor disables all windows except winToSkip
 717     wxWindowDisabler(wxWindow *winToSkip);
 718
 719     // dtor enables back all windows disabled by the ctor
 720     ~wxWindowDisabler();
 721
 722 private:
 723     // disable all windows except the given one (used by both ctors)
 724     void DoDisable(wxWindow *winToSkip = NULL);
 725
 726 #if defined(__WXOSX__) && wxOSX_USE_COCOA
 727     wxEventLoop* m_modalEventLoop;
 728 #endif
 729     wxWindowList *m_winDisabled;
 730     bool m_disabled;
 731
 732     wxDECLARE_NO_COPY_CLASS(wxWindowDisabler);
 733 };
 734
 735 // ----------------------------------------------------------------------------
 736 // Cursors
 737 // ----------------------------------------------------------------------------
 738
 739 // Set the cursor to the busy cursor for all windows
 740 WXDLLIMPEXP_CORE void wxBeginBusyCursor(const wxCursor *cursor = wxHOURGLASS_CURSOR);
 741
 742 // Restore cursor to normal
 743 WXDLLIMPEXP_CORE void wxEndBusyCursor();
 744
 745 // true if we're between the above two calls
 746 WXDLLIMPEXP_CORE bool wxIsBusy();
 747
 748 // Convenience class so we can just create a wxBusyCursor object on the stack
 749 class WXDLLIMPEXP_CORE wxBusyCursor
 750 {
 751 public:
 752     wxBusyCursor(const wxCursor* cursor = wxHOURGLASS_CURSOR)
 753         { wxBeginBusyCursor(cursor); }
 754     ~wxBusyCursor()
 755         { wxEndBusyCursor(); }
 756
 757     // FIXME: These two methods are currently only implemented (and needed?)
 758     //        in wxGTK.  BusyCursor handling should probably be moved to
 759     //        common code since the wxGTK and wxMSW implementations are very
 760     //        similar except for wxMSW using HCURSOR directly instead of
 761     //        wxCursor..  -- RL.
 762     static const wxCursor &GetStoredCursor();
 763     static const wxCursor GetBusyCursor();
 764 };
 765
 766 void WXDLLIMPEXP_CORE wxGetMousePosition( int* x, int* y );
 767
 768 // ----------------------------------------------------------------------------
 769 // X11 Display access
 770 // ----------------------------------------------------------------------------
 771
 772 #if defined(__X__) || defined(__WXGTK__)
 773
 774 #ifdef __WXGTK__
 775     WXDLLIMPEXP_CORE void *wxGetDisplay();
 776 #endif
 777
 778 #ifdef __X__
 779     WXDLLIMPEXP_CORE WXDisplay *wxGetDisplay();
 780     WXDLLIMPEXP_CORE bool wxSetDisplay(const wxString& display_name);
 781     WXDLLIMPEXP_CORE wxString wxGetDisplayName();
 782 #endif // X or GTK+
 783
 784 // use this function instead of the functions above in implementation code
 785 inline struct _XDisplay *wxGetX11Display()
 786 {
 787     return (_XDisplay *)wxGetDisplay();
 788 }
 789
 790 #endif // X11 || wxGTK
 791
 792 #endif // wxUSE_GUI
 793
 794 // ----------------------------------------------------------------------------
 795 // wxYield(): these functions are obsolete, please use wxApp methods instead!
 796 // ----------------------------------------------------------------------------
 797
 798 // avoid redeclaring this function here if it had been already declated by
 799 // wx/app.h, this results in warnings from g++ with -Wredundant-decls
 800 #ifndef wx_YIELD_DECLARED
 801 #define wx_YIELD_DECLARED
 802
 803 // Yield to other apps/messages
 804 WXDLLIMPEXP_CORE bool wxYield();
 805
 806 #endif // wx_YIELD_DECLARED
 807
 808 // Like wxYield, but fails silently if the yield is recursive.
 809 WXDLLIMPEXP_CORE bool wxYieldIfNeeded();
 810
 811 // ----------------------------------------------------------------------------
 812 // Windows resources access
 813 // ----------------------------------------------------------------------------
 814
 815 // MSW only: get user-defined resource from the .res file.
 816 #ifdef __WXMSW__
 817     // default resource type for wxLoadUserResource()
 818     extern WXDLLIMPEXP_DATA_BASE(const wxChar*) wxUserResourceStr;
 819
 820     // Return the pointer to the resource data. This pointer is read-only, use
 821     // the overload below if you need to modify the data.
 822     //
 823     // Returns true on success, false on failure. Doesn't log an error message
 824     // if the resource is not found (because this could be expected) but does
 825     // log one if any other error occurs.
 826     WXDLLIMPEXP_BASE bool
 827     wxLoadUserResource(const void **outData,
 828                        size_t *outLen,
 829                        const wxString& resourceName,
 830                        const wxString& resourceType = wxUserResourceStr,
 831                        WXHINSTANCE module = 0);
 832
 833     // This function allocates a new buffer and makes a copy of the resource
 834     // data, remember to delete[] the buffer. And avoid using it entirely if
 835     // the overload above can be used.
 836     //
 837     // Returns NULL on failure.
 838     WXDLLIMPEXP_BASE char*
 839     wxLoadUserResource(const wxString& resourceName,
 840                        const wxString& resourceType = wxUserResourceStr,
 841                        int* pLen = NULL,
 842                        WXHINSTANCE module = 0);
 843 #endif // MSW
 844
 845 #endif
 846     // _WX_UTILSH__