1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: Miscellaneous utilities
4 // Author: Julian Smart
8 // Copyright: (c) 1998 Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
15 // ----------------------------------------------------------------------------
17 // ----------------------------------------------------------------------------
19 #include "wx/object.h"
21 #include "wx/filefn.h"
23 class WXDLLIMPEXP_BASE wxArrayString
;
25 // need this for wxGetDiskSpace() as we can't, unfortunately, forward declare
27 #include "wx/longlong.h"
36 // ----------------------------------------------------------------------------
37 // Forward declaration
38 // ----------------------------------------------------------------------------
40 class WXDLLIMPEXP_CORE wxProcess
;
41 class WXDLLIMPEXP_CORE wxFrame
;
42 class WXDLLIMPEXP_CORE wxWindow
;
43 class WXDLLIMPEXP_CORE wxWindowList
;
44 class WXDLLIMPEXP_CORE wxPoint
;
46 // ----------------------------------------------------------------------------
48 // ----------------------------------------------------------------------------
50 #define wxMax(a,b) (((a) > (b)) ? (a) : (b))
51 #define wxMin(a,b) (((a) < (b)) ? (a) : (b))
53 // wxGetFreeMemory can return huge amount of memory on 64-bit platforms
54 // define wxMemorySize according to the type which best fits your platform
55 #if wxUSE_LONGLONG && defined(__WIN64__)
56 // 64 bit Windowses have sizeof(long) only 32 bit long
57 // we need to use wxLongLong to express memory sizes
58 #define wxMemorySize wxLongLong
60 // 64 bit UNIX has sizeof(long) = 64
61 // assume 32 bit platforms cannnot return more than 32bits of
62 #define wxMemorySize long
65 // ----------------------------------------------------------------------------
66 // String functions (deprecated, use wxString)
67 // ----------------------------------------------------------------------------
69 // Make a copy of this string using 'new'
70 #if WXWIN_COMPATIBILITY_2_4
71 wxDEPRECATED( WXDLLIMPEXP_BASE wxChar
* copystring(const wxChar
*s
) );
74 // A shorter way of using strcmp
75 #define wxStringEq(s1, s2) (s1 && s2 && (wxStrcmp(s1, s2) == 0))
77 // ----------------------------------------------------------------------------
78 // Miscellaneous functions
79 // ----------------------------------------------------------------------------
82 #if !defined __EMX__ && \
83 (defined __WXMOTIF__ || defined __WXGTK__ || defined __WXX11__)
84 WXDLLIMPEXP_CORE
void wxBell();
86 WXDLLIMPEXP_BASE
void wxBell();
89 // Get OS description as a user-readable string
90 WXDLLIMPEXP_BASE wxString
wxGetOsDescription();
93 WXDLLIMPEXP_BASE
int wxGetOsVersion(int *majorVsn
= (int *) NULL
,
94 int *minorVsn
= (int *) NULL
);
96 // Return a string with the current date/time
97 WXDLLIMPEXP_BASE wxString
wxNow();
99 // Return path where wxWidgets is installed (mostly useful in Unices)
100 WXDLLIMPEXP_BASE
const wxChar
*wxGetInstallPrefix();
101 // Return path to wxWin data (/usr/share/wx/%{version}) (Unices)
102 WXDLLIMPEXP_BASE wxString
wxGetDataDir();
107 // Get the state of a key (true if pressed, false if not)
108 // This is generally most useful getting the state of
109 // the modifier or toggle keys.
110 WXDLLEXPORT
bool wxGetKeyState(wxKeyCode key
);
113 // Don't synthesize KeyUp events holding down a key and producing
114 // KeyDown events with autorepeat. On by default and always on
116 WXDLLEXPORT
bool wxSetDetectableAutoRepeat( bool flag
);
118 // ----------------------------------------------------------------------------
119 // Window ID management
120 // ----------------------------------------------------------------------------
122 // Generate a unique ID
123 WXDLLEXPORT
long wxNewId();
125 // Ensure subsequent IDs don't clash with this one
126 WXDLLEXPORT
void wxRegisterId(long id
);
128 // Return the current ID
129 WXDLLEXPORT
long wxGetCurrentId();
133 // ----------------------------------------------------------------------------
134 // Various conversions
135 // ----------------------------------------------------------------------------
137 // these functions are deprecated, use wxString methods instead!
138 #if WXWIN_COMPATIBILITY_2_4
140 extern WXDLLIMPEXP_DATA_BASE(const wxChar
*) wxFloatToStringStr
;
141 extern WXDLLIMPEXP_DATA_BASE(const wxChar
*) wxDoubleToStringStr
;
143 wxDEPRECATED( WXDLLIMPEXP_BASE
void StringToFloat(const wxChar
*s
, float *number
) );
144 wxDEPRECATED( WXDLLIMPEXP_BASE wxChar
* FloatToString(float number
, const wxChar
*fmt
= wxFloatToStringStr
) );
145 wxDEPRECATED( WXDLLIMPEXP_BASE
void StringToDouble(const wxChar
*s
, double *number
) );
146 wxDEPRECATED( WXDLLIMPEXP_BASE wxChar
* DoubleToString(double number
, const wxChar
*fmt
= wxDoubleToStringStr
) );
147 wxDEPRECATED( WXDLLIMPEXP_BASE
void StringToInt(const wxChar
*s
, int *number
) );
148 wxDEPRECATED( WXDLLIMPEXP_BASE
void StringToLong(const wxChar
*s
, long *number
) );
149 wxDEPRECATED( WXDLLIMPEXP_BASE wxChar
* IntToString(int number
) );
150 wxDEPRECATED( WXDLLIMPEXP_BASE wxChar
* LongToString(long number
) );
152 #endif // WXWIN_COMPATIBILITY_2_4
154 // Convert 2-digit hex number to decimal
155 WXDLLIMPEXP_BASE
int wxHexToDec(const wxString
& buf
);
157 // Convert decimal integer to 2-character hex string
158 WXDLLIMPEXP_BASE
void wxDecToHex(int dec
, wxChar
*buf
);
159 WXDLLIMPEXP_BASE wxString
wxDecToHex(int dec
);
161 // ----------------------------------------------------------------------------
162 // Process management
163 // ----------------------------------------------------------------------------
165 // NB: for backwards compatibility reasons the values of wxEXEC_[A]SYNC *must*
166 // be 0 and 1, don't change!
170 // execute the process asynchronously
173 // execute it synchronously, i.e. wait until it finishes
176 // under Windows, don't hide the child even if it's IO is redirected (this
177 // is done by default)
180 // under Unix, if the process is the group leader then passing wxKILL_CHILDREN to wxKill
181 // kills all children as well as pid
182 wxEXEC_MAKE_GROUP_LEADER
= 4,
184 // by default synchronous execution disables all program windows to avoid
185 // that the user interacts with the program while the child process is
186 // running, you can use this flag to prevent this from happening
190 // Execute another program.
192 // If flags contain wxEXEC_SYNC, return -1 on failure and the exit code of the
193 // process if everything was ok. Otherwise (i.e. if wxEXEC_ASYNC), return 0 on
194 // failure and the PID of the launched process if ok.
195 WXDLLIMPEXP_BASE
long wxExecute(wxChar
**argv
, int flags
= wxEXEC_ASYNC
,
196 wxProcess
*process
= (wxProcess
*) NULL
);
197 WXDLLIMPEXP_BASE
long wxExecute(const wxString
& command
, int flags
= wxEXEC_ASYNC
,
198 wxProcess
*process
= (wxProcess
*) NULL
);
200 // execute the command capturing its output into an array line by line, this is
201 // always synchronous
202 WXDLLIMPEXP_BASE
long wxExecute(const wxString
& command
,
203 wxArrayString
& output
,
206 // also capture stderr (also synchronous)
207 WXDLLIMPEXP_BASE
long wxExecute(const wxString
& command
,
208 wxArrayString
& output
,
209 wxArrayString
& error
,
214 wxSIGNONE
= 0, // verify if the process exists under Unix
221 wxSIGIOT
= wxSIGABRT
, // another name
232 // further signals are different in meaning between different Unix systems
237 wxKILL_OK
, // no error
238 wxKILL_BAD_SIGNAL
, // no such signal
239 wxKILL_ACCESS_DENIED
, // permission denied
240 wxKILL_NO_PROCESS
, // no such process
241 wxKILL_ERROR
// another, unspecified error
246 wxKILL_NOCHILDREN
= 0, // don't kill children
247 wxKILL_CHILDREN
= 1 // kill children
252 wxSHUTDOWN_POWEROFF
, // power off the computer
253 wxSHUTDOWN_REBOOT
// shutdown and reboot
256 // Shutdown or reboot the PC
257 WXDLLIMPEXP_BASE
bool wxShutdown(wxShutdownFlags wFlags
);
266 WXDLLIMPEXP_BASE wxPowerType
wxGetPowerType();
270 wxBATTERY_NORMAL_STATE
, // system is fully usable
271 wxBATTERY_LOW_STATE
, // start to worry
272 wxBATTERY_CRITICAL_STATE
, // save quickly
273 wxBATTERY_SHUTDOWN_STATE
, // too late
274 wxBATTERY_UNKNOWN_STATE
277 WXDLLIMPEXP_BASE wxBatteryState
wxGetBatteryState();
279 // send the given signal to the process (only NONE and KILL are supported under
280 // Windows, all others mean TERM), return 0 if ok and -1 on error
282 // return detailed error in rc if not NULL
283 WXDLLIMPEXP_BASE
int wxKill(long pid
,
284 wxSignal sig
= wxSIGTERM
,
285 wxKillError
*rc
= NULL
,
286 int flags
= wxKILL_NOCHILDREN
);
288 // Execute a command in an interactive shell window (always synchronously)
289 // If no command then just the shell
290 WXDLLIMPEXP_BASE
bool wxShell(const wxString
& command
= wxEmptyString
);
292 // As wxShell(), but must give a (non interactive) command and its output will
293 // be returned in output array
294 WXDLLIMPEXP_BASE
bool wxShell(const wxString
& command
, wxArrayString
& output
);
296 // Sleep for nSecs seconds
297 WXDLLIMPEXP_BASE
void wxSleep(int nSecs
);
299 // Sleep for a given amount of milliseconds
300 WXDLLIMPEXP_BASE
void wxMilliSleep(unsigned long milliseconds
);
302 // Sleep for a given amount of microseconds
303 WXDLLIMPEXP_BASE
void wxMicroSleep(unsigned long microseconds
);
305 // Sleep for a given amount of milliseconds (old, bad name), use wxMilliSleep
306 wxDEPRECATED( WXDLLIMPEXP_BASE
void wxUsleep(unsigned long milliseconds
) );
308 // Get the process id of the current process
309 WXDLLIMPEXP_BASE
unsigned long wxGetProcessId();
311 // Get free memory in bytes, or -1 if cannot determine amount (e.g. on UNIX)
312 WXDLLIMPEXP_BASE wxMemorySize
wxGetFreeMemory();
314 #if wxUSE_ON_FATAL_EXCEPTION
316 // should wxApp::OnFatalException() be called?
317 WXDLLIMPEXP_BASE
bool wxHandleFatalExceptions(bool doit
= true);
319 #endif // wxUSE_ON_FATAL_EXCEPTION
321 #if wxABI_VERSION >= 20601
322 // Launch url in the user's default internet browser
323 WXDLLIMPEXP_BASE
bool wxLaunchDefaultBrowser(const wxString
& url
);
326 // ----------------------------------------------------------------------------
327 // Environment variables
328 // ----------------------------------------------------------------------------
330 // returns true if variable exists (value may be NULL if you just want to check
332 WXDLLIMPEXP_BASE
bool wxGetEnv(const wxString
& var
, wxString
*value
);
334 // set the env var name to the given value, return true on success
335 WXDLLIMPEXP_BASE
bool wxSetEnv(const wxString
& var
, const wxChar
*value
);
337 // remove the env var from environment
338 inline bool wxUnsetEnv(const wxString
& var
) { return wxSetEnv(var
, NULL
); }
340 // ----------------------------------------------------------------------------
341 // Network and username functions.
342 // ----------------------------------------------------------------------------
344 // NB: "char *" functions are deprecated, use wxString ones!
347 WXDLLIMPEXP_BASE
bool wxGetEmailAddress(wxChar
*buf
, int maxSize
);
348 WXDLLIMPEXP_BASE wxString
wxGetEmailAddress();
351 WXDLLIMPEXP_BASE
bool wxGetHostName(wxChar
*buf
, int maxSize
);
352 WXDLLIMPEXP_BASE wxString
wxGetHostName();
355 WXDLLIMPEXP_BASE wxString
wxGetFullHostName();
356 WXDLLIMPEXP_BASE
bool wxGetFullHostName(wxChar
*buf
, int maxSize
);
358 // Get user ID e.g. jacs (this is known as login name under Unix)
359 WXDLLIMPEXP_BASE
bool wxGetUserId(wxChar
*buf
, int maxSize
);
360 WXDLLIMPEXP_BASE wxString
wxGetUserId();
362 // Get user name e.g. Julian Smart
363 WXDLLIMPEXP_BASE
bool wxGetUserName(wxChar
*buf
, int maxSize
);
364 WXDLLIMPEXP_BASE wxString
wxGetUserName();
366 // Get current Home dir and copy to dest (returns pstr->c_str())
367 WXDLLIMPEXP_BASE wxString
wxGetHomeDir();
368 WXDLLIMPEXP_BASE
const wxChar
* wxGetHomeDir(wxString
*pstr
);
370 // Get the user's home dir (caller must copy --- volatile)
371 // returns NULL is no HOME dir is known
372 #if defined(__UNIX__) && wxUSE_UNICODE
373 WXDLLIMPEXP_BASE
const wxMB2WXbuf
wxGetUserHome(const wxString
& user
= wxEmptyString
);
375 WXDLLIMPEXP_BASE wxChar
* wxGetUserHome(const wxString
& user
= wxEmptyString
);
378 // get number of total/free bytes on the disk where path belongs
379 WXDLLIMPEXP_BASE
bool wxGetDiskSpace(const wxString
& path
,
380 wxLongLong
*pTotal
= NULL
,
381 wxLongLong
*pFree
= NULL
);
383 #if wxUSE_GUI // GUI only things from now on
385 // ----------------------------------------------------------------------------
386 // Menu accelerators related things
387 // ----------------------------------------------------------------------------
389 WXDLLEXPORT wxChar
* wxStripMenuCodes(const wxChar
*in
, wxChar
*out
= (wxChar
*) NULL
);
390 WXDLLEXPORT wxString
wxStripMenuCodes(const wxString
& str
);
393 class WXDLLEXPORT wxAcceleratorEntry
;
394 WXDLLEXPORT wxAcceleratorEntry
*wxGetAccelFromString(const wxString
& label
);
395 #endif // wxUSE_ACCEL
397 // ----------------------------------------------------------------------------
399 // ----------------------------------------------------------------------------
401 // Returns menu item id or wxNOT_FOUND if none.
402 WXDLLEXPORT
int wxFindMenuItemId(wxFrame
*frame
, const wxString
& menuString
, const wxString
& itemString
);
404 // Find the wxWindow at the given point. wxGenericFindWindowAtPoint
405 // is always present but may be less reliable than a native version.
406 WXDLLEXPORT wxWindow
* wxGenericFindWindowAtPoint(const wxPoint
& pt
);
407 WXDLLEXPORT wxWindow
* wxFindWindowAtPoint(const wxPoint
& pt
);
409 // NB: this function is obsolete, use wxWindow::FindWindowByLabel() instead
411 // Find the window/widget with the given title or label.
412 // Pass a parent to begin the search from, or NULL to look through
414 WXDLLEXPORT wxWindow
* wxFindWindowByLabel(const wxString
& title
, wxWindow
*parent
= (wxWindow
*) NULL
);
416 // NB: this function is obsolete, use wxWindow::FindWindowByName() instead
418 // Find window by name, and if that fails, by label.
419 WXDLLEXPORT wxWindow
* wxFindWindowByName(const wxString
& name
, wxWindow
*parent
= (wxWindow
*) NULL
);
421 // ----------------------------------------------------------------------------
422 // Message/event queue helpers
423 // ----------------------------------------------------------------------------
425 // Yield to other apps/messages and disable user input
426 WXDLLEXPORT
bool wxSafeYield(wxWindow
*win
= NULL
, bool onlyIfNeeded
= false);
428 // Enable or disable input to all top level windows
429 WXDLLEXPORT
void wxEnableTopLevelWindows(bool enable
= true);
431 // Check whether this window wants to process messages, e.g. Stop button
432 // in long calculations.
433 WXDLLEXPORT
bool wxCheckForInterrupt(wxWindow
*wnd
);
435 // Consume all events until no more left
436 WXDLLEXPORT
void wxFlushEvents();
438 // a class which disables all windows (except, may be, thegiven one) in its
439 // ctor and enables them back in its dtor
440 class WXDLLEXPORT wxWindowDisabler
443 wxWindowDisabler(wxWindow
*winToSkip
= (wxWindow
*)NULL
);
447 wxWindowList
*m_winDisabled
;
449 DECLARE_NO_COPY_CLASS(wxWindowDisabler
)
452 // ----------------------------------------------------------------------------
454 // ----------------------------------------------------------------------------
456 // Set the cursor to the busy cursor for all windows
457 class WXDLLEXPORT wxCursor
;
458 extern WXDLLEXPORT_DATA(wxCursor
*) wxHOURGLASS_CURSOR
;
459 WXDLLEXPORT
void wxBeginBusyCursor(wxCursor
*cursor
= wxHOURGLASS_CURSOR
);
461 // Restore cursor to normal
462 WXDLLEXPORT
void wxEndBusyCursor();
464 // true if we're between the above two calls
465 WXDLLEXPORT
bool wxIsBusy();
467 // Convenience class so we can just create a wxBusyCursor object on the stack
468 class WXDLLEXPORT wxBusyCursor
471 wxBusyCursor(wxCursor
* cursor
= wxHOURGLASS_CURSOR
)
472 { wxBeginBusyCursor(cursor
); }
474 { wxEndBusyCursor(); }
476 // FIXME: These two methods are currently only implemented (and needed?)
477 // in wxGTK. BusyCursor handling should probably be moved to
478 // common code since the wxGTK and wxMSW implementations are very
479 // similar except for wxMSW using HCURSOR directly instead of
481 static const wxCursor
&GetStoredCursor();
482 static const wxCursor
GetBusyCursor();
486 // ----------------------------------------------------------------------------
487 // Reading and writing resources (eg WIN.INI, .Xdefaults)
488 // ----------------------------------------------------------------------------
491 WXDLLEXPORT
bool wxWriteResource(const wxString
& section
, const wxString
& entry
, const wxString
& value
, const wxString
& file
= wxEmptyString
);
492 WXDLLEXPORT
bool wxWriteResource(const wxString
& section
, const wxString
& entry
, float value
, const wxString
& file
= wxEmptyString
);
493 WXDLLEXPORT
bool wxWriteResource(const wxString
& section
, const wxString
& entry
, long value
, const wxString
& file
= wxEmptyString
);
494 WXDLLEXPORT
bool wxWriteResource(const wxString
& section
, const wxString
& entry
, int value
, const wxString
& file
= wxEmptyString
);
496 WXDLLEXPORT
bool wxGetResource(const wxString
& section
, const wxString
& entry
, wxChar
**value
, const wxString
& file
= wxEmptyString
);
497 WXDLLEXPORT
bool wxGetResource(const wxString
& section
, const wxString
& entry
, float *value
, const wxString
& file
= wxEmptyString
);
498 WXDLLEXPORT
bool wxGetResource(const wxString
& section
, const wxString
& entry
, long *value
, const wxString
& file
= wxEmptyString
);
499 WXDLLEXPORT
bool wxGetResource(const wxString
& section
, const wxString
& entry
, int *value
, const wxString
& file
= wxEmptyString
);
500 #endif // wxUSE_RESOURCES
502 void WXDLLEXPORT
wxGetMousePosition( int* x
, int* y
);
504 // MSW only: get user-defined resource from the .res file.
505 // Returns NULL or newly-allocated memory, so use delete[] to clean up.
507 extern WXDLLEXPORT
const wxChar
* wxUserResourceStr
;
508 WXDLLEXPORT wxChar
* wxLoadUserResource(const wxString
& resourceName
, const wxString
& resourceType
= wxUserResourceStr
);
511 // ----------------------------------------------------------------------------
512 // Display and colorss (X only)
513 // ----------------------------------------------------------------------------
516 void *wxGetDisplay();
520 WXDLLIMPEXP_CORE WXDisplay
*wxGetDisplay();
521 WXDLLIMPEXP_CORE
bool wxSetDisplay(const wxString
& display_name
);
522 WXDLLIMPEXP_CORE wxString
wxGetDisplayName();
527 #ifdef __VMS__ // Xlib.h for VMS is not (yet) compatible with C++
528 // The resulting warnings are switched off here
529 #pragma message disable nosimpint
531 // #include <X11/Xlib.h>
533 #pragma message enable nosimpint
540 // ----------------------------------------------------------------------------
541 // wxYield(): these functions are obsolete, please use wxApp methods instead!
542 // ----------------------------------------------------------------------------
544 // Yield to other apps/messages
545 WXDLLIMPEXP_BASE
bool wxYield();
547 // Like wxYield, but fails silently if the yield is recursive.
548 WXDLLIMPEXP_BASE
bool wxYieldIfNeeded();
550 // ----------------------------------------------------------------------------
551 // Error message functions used by wxWidgets (deprecated, use wxLog)
552 // ----------------------------------------------------------------------------
554 #if WXWIN_COMPATIBILITY_2_2
556 // Format a message on the standard error (UNIX) or the debugging
558 wxDEPRECATED( WXDLLIMPEXP_BASE
void wxDebugMsg(const wxChar
*fmt
...) ATTRIBUTE_PRINTF_1
);
560 // Non-fatal error (continues)
561 extern WXDLLIMPEXP_DATA_BASE(const wxChar
*) wxInternalErrorStr
;
562 wxDEPRECATED( WXDLLIMPEXP_BASE
void wxError(const wxString
& msg
, const wxString
& title
= wxInternalErrorStr
) );
564 // Fatal error (exits)
565 extern WXDLLIMPEXP_DATA_BASE(const wxChar
*) wxFatalErrorStr
;
566 wxDEPRECATED( WXDLLIMPEXP_BASE
void wxFatalError(const wxString
& msg
, const wxString
& title
= wxFatalErrorStr
) );
568 #endif // WXWIN_COMPATIBILITY_2_2