1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: Miscellaneous utility functions and classes
4 // Author: Julian Smart
8 // Copyright: (c) 1998 Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
20 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) && !defined(__EMX__)
21 // Some older compilers (such as EMX) cannot handle
22 // #pragma interface/implementation correctly, iff
23 // #pragma implementation is used in _two_ translation
24 // units (as created by e.g. event.cpp compiled for
25 // libwx_base and event.cpp compiled for libwx_gui_core).
26 // So we must not use those pragmas for those compilers in
28 #pragma implementation "utils.h"
31 // For compilers that support precompilation, includes "wx.h".
32 #include "wx/wxprec.h"
40 #include "wx/string.h"
46 #include "wx/window.h"
49 #include "wx/msgdlg.h"
50 #include "wx/textdlg.h"
51 #include "wx/textctrl.h" // for wxTE_PASSWORD
53 #include "wx/menuitem.h"
59 #include "wx/apptrait.h"
61 #include "wx/process.h"
62 #include "wx/txtstrm.h"
64 #if defined(__WXWINCE__) && wxUSE_DATETIME
65 #include "wx/datetime.h"
73 #if !defined(__WATCOMC__)
74 #if !(defined(_MSC_VER) && (_MSC_VER > 800))
80 #include "wx/colordlg.h"
81 #include "wx/fontdlg.h"
82 #include "wx/notebook.h"
84 #include "wx/statusbr.h"
90 #include "wx/msw/wince/time.h"
93 #if !defined(__MWERKS__) && !defined(__WXWINCE__)
94 #include <sys/types.h>
98 #if defined(__WXMSW__) && !defined(__PALMOS__)
99 #include "wx/msw/private.h"
104 // ----------------------------------------------------------------------------
106 // ----------------------------------------------------------------------------
108 #if WXWIN_COMPATIBILITY_2_2
109 const wxChar
*wxInternalErrorStr
= wxT("wxWidgets Internal Error");
110 const wxChar
*wxFatalErrorStr
= wxT("wxWidgets Fatal Error");
111 #endif // WXWIN_COMPATIBILITY_2_2
113 // ============================================================================
115 // ============================================================================
117 #if WXWIN_COMPATIBILITY_2_4
120 copystring (const wxChar
*s
)
122 if (s
== NULL
) s
= wxT("");
123 size_t len
= wxStrlen (s
) + 1;
125 wxChar
*news
= new wxChar
[len
];
126 memcpy (news
, s
, len
* sizeof(wxChar
)); // Should be the fastest
131 #endif // WXWIN_COMPATIBILITY_2_4
133 // ----------------------------------------------------------------------------
134 // String <-> Number conversions (deprecated)
135 // ----------------------------------------------------------------------------
137 #if WXWIN_COMPATIBILITY_2_4
139 WXDLLIMPEXP_DATA_BASE(const wxChar
*) wxFloatToStringStr
= wxT("%.2f");
140 WXDLLIMPEXP_DATA_BASE(const wxChar
*) wxDoubleToStringStr
= wxT("%.2f");
143 StringToFloat (const wxChar
*s
, float *number
)
145 if (s
&& *s
&& number
)
146 *number
= (float) wxStrtod (s
, (wxChar
**) NULL
);
150 StringToDouble (const wxChar
*s
, double *number
)
152 if (s
&& *s
&& number
)
153 *number
= wxStrtod (s
, (wxChar
**) NULL
);
157 FloatToString (float number
, const wxChar
*fmt
)
159 static wxChar buf
[256];
161 wxSprintf (buf
, fmt
, number
);
166 DoubleToString (double number
, const wxChar
*fmt
)
168 static wxChar buf
[256];
170 wxSprintf (buf
, fmt
, number
);
175 StringToInt (const wxChar
*s
, int *number
)
177 if (s
&& *s
&& number
)
178 *number
= (int) wxStrtol (s
, (wxChar
**) NULL
, 10);
182 StringToLong (const wxChar
*s
, long *number
)
184 if (s
&& *s
&& number
)
185 *number
= wxStrtol (s
, (wxChar
**) NULL
, 10);
189 IntToString (int number
)
191 static wxChar buf
[20];
193 wxSprintf (buf
, wxT("%d"), number
);
198 LongToString (long number
)
200 static wxChar buf
[20];
202 wxSprintf (buf
, wxT("%ld"), number
);
206 #endif // WXWIN_COMPATIBILITY_2_4
208 // Array used in DecToHex conversion routine.
209 static wxChar hexArray
[] = wxT("0123456789ABCDEF");
211 // Convert 2-digit hex number to decimal
212 int wxHexToDec(const wxString
& buf
)
214 int firstDigit
, secondDigit
;
216 if (buf
.GetChar(0) >= wxT('A'))
217 firstDigit
= buf
.GetChar(0) - wxT('A') + 10;
219 firstDigit
= buf
.GetChar(0) - wxT('0');
221 if (buf
.GetChar(1) >= wxT('A'))
222 secondDigit
= buf
.GetChar(1) - wxT('A') + 10;
224 secondDigit
= buf
.GetChar(1) - wxT('0');
226 return (firstDigit
& 0xF) * 16 + (secondDigit
& 0xF );
229 // Convert decimal integer to 2-character hex string
230 void wxDecToHex(int dec
, wxChar
*buf
)
232 int firstDigit
= (int)(dec
/16.0);
233 int secondDigit
= (int)(dec
- (firstDigit
*16.0));
234 buf
[0] = hexArray
[firstDigit
];
235 buf
[1] = hexArray
[secondDigit
];
239 // Convert decimal integer to 2-character hex string
240 wxString
wxDecToHex(int dec
)
243 wxDecToHex(dec
, buf
);
244 return wxString(buf
);
247 // ----------------------------------------------------------------------------
249 // ----------------------------------------------------------------------------
251 // Return the current date/time
256 wxDateTime now
= wxDateTime::Now();
259 return wxEmptyString
;
262 time_t now
= time((time_t *) NULL
);
263 char *date
= ctime(&now
);
265 return wxString::FromAscii(date
);
269 void wxUsleep(unsigned long milliseconds
)
271 wxMilliSleep(milliseconds
);
274 const wxChar
*wxGetInstallPrefix()
278 if ( wxGetEnv(wxT("WXPREFIX"), &prefix
) )
279 return prefix
.c_str();
281 #ifdef wxINSTALL_PREFIX
282 return wxT(wxINSTALL_PREFIX
);
288 wxString
wxGetDataDir()
290 wxString dir
= wxGetInstallPrefix();
291 dir
<< wxFILE_SEP_PATH
<< wxT("share") << wxFILE_SEP_PATH
<< wxT("wx");
295 int wxGetOsVersion(int *verMaj
, int *verMin
)
297 // we want this function to work even if there is no wxApp
298 wxConsoleAppTraits traitsConsole
;
299 wxAppTraits
*traits
= wxTheApp
? wxTheApp
->GetTraits() : NULL
;
301 traits
= &traitsConsole
;
303 wxToolkitInfo
& info
= traits
->GetToolkitInfo();
305 *verMaj
= info
.versionMajor
;
307 *verMin
= info
.versionMinor
;
311 // ----------------------------------------------------------------------------
312 // network and user id functions
313 // ----------------------------------------------------------------------------
315 // Get Full RFC822 style email address
316 bool wxGetEmailAddress(wxChar
*address
, int maxSize
)
318 wxString email
= wxGetEmailAddress();
322 wxStrncpy(address
, email
, maxSize
- 1);
323 address
[maxSize
- 1] = wxT('\0');
328 wxString
wxGetEmailAddress()
332 wxString host
= wxGetFullHostName();
333 if ( !host
.IsEmpty() )
335 wxString user
= wxGetUserId();
336 if ( !user
.IsEmpty() )
338 email
<< user
<< wxT('@') << host
;
345 wxString
wxGetUserId()
347 static const int maxLoginLen
= 256; // FIXME arbitrary number
350 bool ok
= wxGetUserId(wxStringBuffer(buf
, maxLoginLen
), maxLoginLen
);
358 wxString
wxGetUserName()
360 static const int maxUserNameLen
= 1024; // FIXME arbitrary number
363 bool ok
= wxGetUserName(wxStringBuffer(buf
, maxUserNameLen
), maxUserNameLen
);
371 wxString
wxGetHostName()
373 static const size_t hostnameSize
= 257;
376 bool ok
= wxGetHostName(wxStringBuffer(buf
, hostnameSize
), hostnameSize
);
384 wxString
wxGetFullHostName()
386 static const size_t hostnameSize
= 257;
389 bool ok
= wxGetFullHostName(wxStringBuffer(buf
, hostnameSize
), hostnameSize
);
397 wxString
wxGetHomeDir()
407 wxString
wxGetCurrentDir()
414 ok
= getcwd(dir
.GetWriteBuf(len
+ 1), len
) != NULL
;
419 if ( errno
!= ERANGE
)
421 wxLogSysError(_T("Failed to get current directory"));
423 return wxEmptyString
;
427 // buffer was too small, retry with a larger one
439 // ----------------------------------------------------------------------------
441 // ----------------------------------------------------------------------------
443 // wxDoExecuteWithCapture() helper: reads an entire stream into one array
445 // returns true if ok, false if error
447 static bool ReadAll(wxInputStream
*is
, wxArrayString
& output
)
449 wxCHECK_MSG( is
, false, _T("NULL stream in wxExecute()?") );
451 // the stream could be already at EOF or in wxSTREAM_BROKEN_PIPE state
454 wxTextInputStream
tis(*is
);
459 wxString line
= tis
.ReadLine();
475 #endif // wxUSE_STREAMS
477 // this is a private function because it hasn't a clean interface: the first
478 // array is passed by reference, the second by pointer - instead we have 2
479 // public versions of wxExecute() below
480 static long wxDoExecuteWithCapture(const wxString
& command
,
481 wxArrayString
& output
,
482 wxArrayString
* error
)
484 // create a wxProcess which will capture the output
485 wxProcess
*process
= new wxProcess
;
488 long rc
= wxExecute(command
, wxEXEC_SYNC
, process
);
493 if ( !ReadAll(process
->GetInputStream(), output
) )
498 if ( !ReadAll(process
->GetErrorStream(), *error
) )
506 #endif // wxUSE_STREAMS/!wxUSE_STREAMS
513 long wxExecute(const wxString
& command
, wxArrayString
& output
)
515 return wxDoExecuteWithCapture(command
, output
, NULL
);
518 long wxExecute(const wxString
& command
,
519 wxArrayString
& output
,
520 wxArrayString
& error
)
522 return wxDoExecuteWithCapture(command
, output
, &error
);
525 // ----------------------------------------------------------------------------
526 // wxApp::Yield() wrappers for backwards compatibility
527 // ----------------------------------------------------------------------------
531 return wxTheApp
&& wxTheApp
->Yield();
534 bool wxYieldIfNeeded()
536 return wxTheApp
&& wxTheApp
->Yield(true);
541 // ============================================================================
542 // GUI-only functions from now on
543 // ============================================================================
548 static long wxCurrentId
= 100;
553 return wxCurrentId
++;
557 wxGetCurrentId(void) { return wxCurrentId
; }
560 wxRegisterId (long id
)
562 if (id
>= wxCurrentId
)
563 wxCurrentId
= id
+ 1;
568 // ----------------------------------------------------------------------------
569 // Menu accelerators related functions
570 // ----------------------------------------------------------------------------
572 wxChar
*wxStripMenuCodes(const wxChar
*in
, wxChar
*out
)
574 wxString s
= wxMenuItem::GetLabelFromText(in
);
577 // go smash their buffer if it's not big enough - I love char * params
578 memcpy(out
, s
.c_str(), s
.length() * sizeof(wxChar
));
582 // MYcopystring - for easier search...
583 out
= new wxChar
[s
.length() + 1];
584 wxStrcpy(out
, s
.c_str());
590 wxString
wxStripMenuCodes(const wxString
& in
)
594 size_t len
= in
.length();
597 for ( size_t n
= 0; n
< len
; n
++ )
602 // skip it, it is used to introduce the accel char (or to quote
603 // itself in which case it should still be skipped): note that it
604 // can't be the last character of the string
607 wxLogDebug(_T("Invalid menu string '%s'"), in
.c_str());
611 // use the next char instead
615 else if ( ch
== _T('\t') )
617 // everything after TAB is accel string, exit the loop
627 #endif // wxUSE_MENUS
629 // ----------------------------------------------------------------------------
630 // Window search functions
631 // ----------------------------------------------------------------------------
634 * If parent is non-NULL, look through children for a label or title
635 * matching the specified string. If NULL, look through all top-level windows.
640 wxFindWindowByLabel (const wxString
& title
, wxWindow
* parent
)
642 return wxWindow::FindWindowByLabel( title
, parent
);
647 * If parent is non-NULL, look through children for a name
648 * matching the specified string. If NULL, look through all top-level windows.
653 wxFindWindowByName (const wxString
& name
, wxWindow
* parent
)
655 return wxWindow::FindWindowByName( name
, parent
);
658 // Returns menu item id or wxNOT_FOUND if none.
660 wxFindMenuItemId (wxFrame
* frame
, const wxString
& menuString
, const wxString
& itemString
)
663 wxMenuBar
*menuBar
= frame
->GetMenuBar ();
665 return menuBar
->FindMenuItem (menuString
, itemString
);
666 #endif // wxUSE_MENUS
671 // Try to find the deepest child that contains 'pt'.
672 // We go backwards, to try to allow for controls that are spacially
673 // within other controls, but are still siblings (e.g. buttons within
674 // static boxes). Static boxes are likely to be created _before_ controls
675 // that sit inside them.
676 wxWindow
* wxFindWindowAtPoint(wxWindow
* win
, const wxPoint
& pt
)
681 // Hack for wxNotebook case: at least in wxGTK, all pages
682 // claim to be shown, so we must only deal with the selected one.
684 if (win
->IsKindOf(CLASSINFO(wxNotebook
)))
686 wxNotebook
* nb
= (wxNotebook
*) win
;
687 int sel
= nb
->GetSelection();
690 wxWindow
* child
= nb
->GetPage(sel
);
691 wxWindow
* foundWin
= wxFindWindowAtPoint(child
, pt
);
698 wxWindowList::compatibility_iterator node
= win
->GetChildren().GetLast();
701 wxWindow
* child
= node
->GetData();
702 wxWindow
* foundWin
= wxFindWindowAtPoint(child
, pt
);
705 node
= node
->GetPrevious();
708 wxPoint pos
= win
->GetPosition();
709 wxSize sz
= win
->GetSize();
710 if (win
->GetParent())
712 pos
= win
->GetParent()->ClientToScreen(pos
);
715 wxRect
rect(pos
, sz
);
722 wxWindow
* wxGenericFindWindowAtPoint(const wxPoint
& pt
)
724 // Go backwards through the list since windows
725 // on top are likely to have been appended most
727 wxWindowList::compatibility_iterator node
= wxTopLevelWindows
.GetLast();
730 wxWindow
* win
= node
->GetData();
731 wxWindow
* found
= wxFindWindowAtPoint(win
, pt
);
734 node
= node
->GetPrevious();
739 // ----------------------------------------------------------------------------
741 // ----------------------------------------------------------------------------
744 * N.B. these convenience functions must be separate from msgdlgg.cpp, textdlgg.cpp
745 * since otherwise the generic code may be pulled in unnecessarily.
750 int wxMessageBox(const wxString
& message
, const wxString
& caption
, long style
,
751 wxWindow
*parent
, int WXUNUSED(x
), int WXUNUSED(y
) )
753 long decorated_style
= style
;
755 if ( ( style
& ( wxICON_EXCLAMATION
| wxICON_HAND
| wxICON_INFORMATION
| wxICON_QUESTION
) ) == 0 )
757 decorated_style
|= ( style
& wxYES
) ? wxICON_QUESTION
: wxICON_INFORMATION
;
760 wxMessageDialog
dialog(parent
, message
, caption
, decorated_style
);
762 int ans
= dialog
.ShowModal();
775 wxFAIL_MSG( _T("unexpected return code from wxMessageDialog") );
780 #endif // wxUSE_MSGDLG
784 wxString
wxGetTextFromUser(const wxString
& message
, const wxString
& caption
,
785 const wxString
& defaultValue
, wxWindow
*parent
,
786 wxCoord x
, wxCoord y
, bool centre
)
789 long style
= wxTextEntryDialogStyle
;
796 wxTextEntryDialog
dialog(parent
, message
, caption
, defaultValue
, style
, wxPoint(x
, y
));
798 if (dialog
.ShowModal() == wxID_OK
)
800 str
= dialog
.GetValue();
806 wxString
wxGetPasswordFromUser(const wxString
& message
,
807 const wxString
& caption
,
808 const wxString
& defaultValue
,
812 wxTextEntryDialog
dialog(parent
, message
, caption
, defaultValue
,
813 wxOK
| wxCANCEL
| wxTE_PASSWORD
);
814 if ( dialog
.ShowModal() == wxID_OK
)
816 str
= dialog
.GetValue();
822 #endif // wxUSE_TEXTDLG
826 wxColour
wxGetColourFromUser(wxWindow
*parent
, const wxColour
& colInit
)
829 data
.SetChooseFull(true);
832 data
.SetColour((wxColour
&)colInit
); // const_cast
836 wxColourDialog
dialog(parent
, &data
);
837 if ( dialog
.ShowModal() == wxID_OK
)
839 colRet
= dialog
.GetColourData().GetColour();
841 //else: leave it invalid
846 #endif // wxUSE_COLOURDLG
850 wxFont
wxGetFontFromUser(wxWindow
*parent
, const wxFont
& fontInit
)
855 data
.SetInitialFont(fontInit
);
859 wxFontDialog
dialog(parent
, data
);
860 if ( dialog
.ShowModal() == wxID_OK
)
862 fontRet
= dialog
.GetFontData().GetChosenFont();
864 //else: leave it invalid
869 #endif // wxUSE_FONTDLG
871 // ----------------------------------------------------------------------------
872 // wxSafeYield and supporting functions
873 // ----------------------------------------------------------------------------
875 void wxEnableTopLevelWindows(bool enable
)
877 wxWindowList::compatibility_iterator node
;
878 for ( node
= wxTopLevelWindows
.GetFirst(); node
; node
= node
->GetNext() )
879 node
->GetData()->Enable(enable
);
882 wxWindowDisabler::wxWindowDisabler(wxWindow
*winToSkip
)
884 // remember the top level windows which were already disabled, so that we
885 // don't reenable them later
886 m_winDisabled
= NULL
;
888 wxWindowList::compatibility_iterator node
;
889 for ( node
= wxTopLevelWindows
.GetFirst(); node
; node
= node
->GetNext() )
891 wxWindow
*winTop
= node
->GetData();
892 if ( winTop
== winToSkip
)
895 // we don't need to disable the hidden or already disabled windows
896 if ( winTop
->IsEnabled() && winTop
->IsShown() )
902 if ( !m_winDisabled
)
904 m_winDisabled
= new wxWindowList
;
907 m_winDisabled
->Append(winTop
);
912 wxWindowDisabler::~wxWindowDisabler()
914 wxWindowList::compatibility_iterator node
;
915 for ( node
= wxTopLevelWindows
.GetFirst(); node
; node
= node
->GetNext() )
917 wxWindow
*winTop
= node
->GetData();
918 if ( !m_winDisabled
|| !m_winDisabled
->Find(winTop
) )
922 //else: had been already disabled, don't reenable
925 delete m_winDisabled
;
928 // Yield to other apps/messages and disable user input to all windows except
930 bool wxSafeYield(wxWindow
*win
, bool onlyIfNeeded
)
932 wxWindowDisabler
wd(win
);
936 rc
= wxYieldIfNeeded();
943 // Don't synthesize KeyUp events holding down a key and producing KeyDown
944 // events with autorepeat. On by default and always on in wxMSW. wxGTK version
947 bool wxSetDetectableAutoRepeat( bool WXUNUSED(flag
) )
949 return true; // detectable auto-repeat is the only mode MSW supports