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 // ----------------------------------------------------------------------------
21 #pragma implementation "utils.h"
24 // For compilers that support precompilation, includes "wx.h".
25 #include "wx/wxprec.h"
33 #include "wx/string.h"
39 #include "wx/window.h"
42 #include "wx/msgdlg.h"
43 #include "wx/textdlg.h"
44 #include "wx/textctrl.h" // for wxTE_PASSWORD
46 #include "wx/menuitem.h"
52 #include "wx/apptrait.h"
54 #include "wx/process.h"
55 #include "wx/txtstrm.h"
62 #if !defined(__WATCOMC__)
63 #if !(defined(_MSC_VER) && (_MSC_VER > 800))
69 #include "wx/colordlg.h"
70 #include "wx/fontdlg.h"
71 #include "wx/notebook.h"
73 #include "wx/statusbr.h"
79 #include <sys/types.h>
88 #include "wx/msw/private.h"
93 // ----------------------------------------------------------------------------
95 // ----------------------------------------------------------------------------
97 #if WXWIN_COMPATIBILITY_2_2
98 const wxChar
*wxInternalErrorStr
= wxT("wxWindows Internal Error");
99 const wxChar
*wxFatalErrorStr
= wxT("wxWindows Fatal Error");
100 #endif // WXWIN_COMPATIBILITY_2_2
102 // ============================================================================
104 // ============================================================================
106 #if WXWIN_COMPATIBILITY_2_4
109 copystring (const wxChar
*s
)
111 if (s
== NULL
) s
= wxT("");
112 size_t len
= wxStrlen (s
) + 1;
114 wxChar
*news
= new wxChar
[len
];
115 memcpy (news
, s
, len
* sizeof(wxChar
)); // Should be the fastest
120 #endif // WXWIN_COMPATIBILITY_2_4
123 static long wxCurrentId
= 100;
128 return wxCurrentId
++;
132 wxGetCurrentId(void) { return wxCurrentId
; }
135 wxRegisterId (long id
)
137 if (id
>= wxCurrentId
)
138 wxCurrentId
= id
+ 1;
141 // ----------------------------------------------------------------------------
142 // String <-> Number conversions (deprecated)
143 // ----------------------------------------------------------------------------
145 #if WXWIN_COMPATIBILITY_2_4
147 WXDLLIMPEXP_DATA_BASE(const wxChar
*) wxFloatToStringStr
= wxT("%.2f");
148 WXDLLIMPEXP_DATA_BASE(const wxChar
*) wxDoubleToStringStr
= wxT("%.2f");
151 StringToFloat (const wxChar
*s
, float *number
)
153 if (s
&& *s
&& number
)
154 *number
= (float) wxStrtod (s
, (wxChar
**) NULL
);
158 StringToDouble (const wxChar
*s
, double *number
)
160 if (s
&& *s
&& number
)
161 *number
= wxStrtod (s
, (wxChar
**) NULL
);
165 FloatToString (float number
, const wxChar
*fmt
)
167 static wxChar buf
[256];
169 wxSprintf (buf
, fmt
, number
);
174 DoubleToString (double number
, const wxChar
*fmt
)
176 static wxChar buf
[256];
178 wxSprintf (buf
, fmt
, number
);
183 StringToInt (const wxChar
*s
, int *number
)
185 if (s
&& *s
&& number
)
186 *number
= (int) wxStrtol (s
, (wxChar
**) NULL
, 10);
190 StringToLong (const wxChar
*s
, long *number
)
192 if (s
&& *s
&& number
)
193 *number
= wxStrtol (s
, (wxChar
**) NULL
, 10);
197 IntToString (int number
)
199 static wxChar buf
[20];
201 wxSprintf (buf
, wxT("%d"), number
);
206 LongToString (long number
)
208 static wxChar buf
[20];
210 wxSprintf (buf
, wxT("%ld"), number
);
214 #endif // WXWIN_COMPATIBILITY_2_4
216 // Array used in DecToHex conversion routine.
217 static wxChar hexArray
[] = wxT("0123456789ABCDEF");
219 // Convert 2-digit hex number to decimal
220 int wxHexToDec(const wxString
& buf
)
222 int firstDigit
, secondDigit
;
224 if (buf
.GetChar(0) >= wxT('A'))
225 firstDigit
= buf
.GetChar(0) - wxT('A') + 10;
227 firstDigit
= buf
.GetChar(0) - wxT('0');
229 if (buf
.GetChar(1) >= wxT('A'))
230 secondDigit
= buf
.GetChar(1) - wxT('A') + 10;
232 secondDigit
= buf
.GetChar(1) - wxT('0');
234 return (firstDigit
& 0xF) * 16 + (secondDigit
& 0xF );
237 // Convert decimal integer to 2-character hex string
238 void wxDecToHex(int dec
, wxChar
*buf
)
240 int firstDigit
= (int)(dec
/16.0);
241 int secondDigit
= (int)(dec
- (firstDigit
*16.0));
242 buf
[0] = hexArray
[firstDigit
];
243 buf
[1] = hexArray
[secondDigit
];
247 // Convert decimal integer to 2-character hex string
248 wxString
wxDecToHex(int dec
)
251 wxDecToHex(dec
, buf
);
252 return wxString(buf
);
255 // ----------------------------------------------------------------------------
257 // ----------------------------------------------------------------------------
259 // Return the current date/time
262 time_t now
= time((time_t *) NULL
);
263 char *date
= ctime(&now
);
265 return wxString::FromAscii(date
);
268 const wxChar
*wxGetInstallPrefix()
272 if ( wxGetEnv(wxT("WXPREFIX"), &prefix
) )
273 return prefix
.c_str();
275 #ifdef wxINSTALL_PREFIX
276 return wxT(wxINSTALL_PREFIX
);
282 wxString
wxGetDataDir()
284 wxString format
= wxGetInstallPrefix();
285 format
<< wxFILE_SEP_PATH
286 << wxT("share") << wxFILE_SEP_PATH
287 << wxT("wx") << wxFILE_SEP_PATH
290 dir
.Printf(format
.c_str(), wxMAJOR_VERSION
, wxMINOR_VERSION
);
294 int wxGetOsVersion(int *verMaj
, int *verMin
)
296 // we want this function to work even if there is no wxApp
297 wxConsoleAppTraits traitsConsole
;
298 wxAppTraits
*traits
= wxTheApp
? wxTheApp
->GetTraits() : NULL
;
300 traits
= &traitsConsole
;
302 return traits
->GetOSVersion(verMaj
, verMin
);
305 // ----------------------------------------------------------------------------
306 // network and user id functions
307 // ----------------------------------------------------------------------------
309 // Get Full RFC822 style email address
310 bool wxGetEmailAddress(wxChar
*address
, int maxSize
)
312 wxString email
= wxGetEmailAddress();
316 wxStrncpy(address
, email
, maxSize
- 1);
317 address
[maxSize
- 1] = wxT('\0');
322 wxString
wxGetEmailAddress()
326 wxString host
= wxGetFullHostName();
329 wxString user
= wxGetUserId();
332 email
<< user
<< wxT('@') << host
;
339 wxString
wxGetUserId()
341 static const int maxLoginLen
= 256; // FIXME arbitrary number
344 bool ok
= wxGetUserId(buf
.GetWriteBuf(maxLoginLen
), maxLoginLen
);
353 wxString
wxGetUserName()
355 static const int maxUserNameLen
= 1024; // FIXME arbitrary number
358 bool ok
= wxGetUserName(buf
.GetWriteBuf(maxUserNameLen
), maxUserNameLen
);
367 wxString
wxGetHostName()
369 static const size_t hostnameSize
= 257;
372 bool ok
= wxGetHostName(buf
.GetWriteBuf(hostnameSize
), hostnameSize
);
382 wxString
wxGetFullHostName()
384 static const size_t hostnameSize
= 257;
387 bool ok
= wxGetFullHostName(buf
.GetWriteBuf(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
) )
503 #endif // wxUSE_STREAMS
510 long wxExecute(const wxString
& command
, wxArrayString
& output
)
512 return wxDoExecuteWithCapture(command
, output
, NULL
);
515 long wxExecute(const wxString
& command
,
516 wxArrayString
& output
,
517 wxArrayString
& error
)
519 return wxDoExecuteWithCapture(command
, output
, &error
);
522 // ----------------------------------------------------------------------------
523 // wxApp::Yield() wrappers for backwards compatibility
524 // ----------------------------------------------------------------------------
528 return wxTheApp
&& wxTheApp
->Yield();
531 bool wxYieldIfNeeded()
533 return wxTheApp
&& wxTheApp
->Yield(TRUE
);
538 // ============================================================================
539 // GUI-only functions from now on
540 // ============================================================================
546 // ----------------------------------------------------------------------------
547 // Menu accelerators related functions
548 // ----------------------------------------------------------------------------
550 wxChar
*wxStripMenuCodes(const wxChar
*in
, wxChar
*out
)
552 wxString s
= wxMenuItem::GetLabelFromText(in
);
555 // go smash their buffer if it's not big enough - I love char * params
556 memcpy(out
, s
.c_str(), s
.length() * sizeof(wxChar
));
560 // MYcopystring - for easier search...
561 out
= new wxChar
[s
.length() + 1];
562 wxStrcpy(out
, s
.c_str());
568 wxString
wxStripMenuCodes(const wxString
& in
)
572 size_t len
= in
.length();
575 for ( size_t n
= 0; n
< len
; n
++ )
580 // skip it, it is used to introduce the accel char (or to quote
581 // itself in which case it should still be skipped): note that it
582 // can't be the last character of the string
585 wxLogDebug(_T("Invalid menu string '%s'"), in
.c_str());
589 // use the next char instead
593 else if ( ch
== _T('\t') )
595 // everything after TAB is accel string, exit the loop
605 #endif // wxUSE_MENUS
607 // ----------------------------------------------------------------------------
608 // Window search functions
609 // ----------------------------------------------------------------------------
612 * If parent is non-NULL, look through children for a label or title
613 * matching the specified string. If NULL, look through all top-level windows.
618 wxFindWindowByLabel (const wxString
& title
, wxWindow
* parent
)
620 return wxWindow::FindWindowByLabel( title
, parent
);
625 * If parent is non-NULL, look through children for a name
626 * matching the specified string. If NULL, look through all top-level windows.
631 wxFindWindowByName (const wxString
& name
, wxWindow
* parent
)
633 return wxWindow::FindWindowByName( name
, parent
);
636 // Returns menu item id or -1 if none.
638 wxFindMenuItemId (wxFrame
* frame
, const wxString
& menuString
, const wxString
& itemString
)
641 wxMenuBar
*menuBar
= frame
->GetMenuBar ();
643 return menuBar
->FindMenuItem (menuString
, itemString
);
644 #endif // wxUSE_MENUS
649 // Try to find the deepest child that contains 'pt'.
650 // We go backwards, to try to allow for controls that are spacially
651 // within other controls, but are still siblings (e.g. buttons within
652 // static boxes). Static boxes are likely to be created _before_ controls
653 // that sit inside them.
654 wxWindow
* wxFindWindowAtPoint(wxWindow
* win
, const wxPoint
& pt
)
659 // Hack for wxNotebook case: at least in wxGTK, all pages
660 // claim to be shown, so we must only deal with the selected one.
662 if (win
->IsKindOf(CLASSINFO(wxNotebook
)))
664 wxNotebook
* nb
= (wxNotebook
*) win
;
665 int sel
= nb
->GetSelection();
668 wxWindow
* child
= nb
->GetPage(sel
);
669 wxWindow
* foundWin
= wxFindWindowAtPoint(child
, pt
);
676 wxWindowList::compatibility_iterator node
= win
->GetChildren().GetLast();
679 wxWindow
* child
= node
->GetData();
680 wxWindow
* foundWin
= wxFindWindowAtPoint(child
, pt
);
683 node
= node
->GetPrevious();
686 wxPoint pos
= win
->GetPosition();
687 wxSize sz
= win
->GetSize();
688 if (win
->GetParent())
690 pos
= win
->GetParent()->ClientToScreen(pos
);
693 wxRect
rect(pos
, sz
);
700 wxWindow
* wxGenericFindWindowAtPoint(const wxPoint
& pt
)
702 // Go backwards through the list since windows
703 // on top are likely to have been appended most
705 wxWindowList::compatibility_iterator node
= wxTopLevelWindows
.GetLast();
708 wxWindow
* win
= node
->GetData();
709 wxWindow
* found
= wxFindWindowAtPoint(win
, pt
);
712 node
= node
->GetPrevious();
717 // ----------------------------------------------------------------------------
719 // ----------------------------------------------------------------------------
722 * N.B. these convenience functions must be separate from msgdlgg.cpp, textdlgg.cpp
723 * since otherwise the generic code may be pulled in unnecessarily.
728 int wxMessageBox(const wxString
& message
, const wxString
& caption
, long style
,
729 wxWindow
*parent
, int WXUNUSED(x
), int WXUNUSED(y
) )
731 wxMessageDialog
dialog(parent
, message
, caption
, style
);
733 int ans
= dialog
.ShowModal();
746 wxFAIL_MSG( _T("unexpected return code from wxMessageDialog") );
751 #endif // wxUSE_MSGDLG
755 wxString
wxGetTextFromUser(const wxString
& message
, const wxString
& caption
,
756 const wxString
& defaultValue
, wxWindow
*parent
,
757 int x
, int y
, bool WXUNUSED(centre
) )
760 wxTextEntryDialog
dialog(parent
, message
, caption
, defaultValue
, wxOK
|wxCANCEL
, wxPoint(x
, y
));
761 if (dialog
.ShowModal() == wxID_OK
)
763 str
= dialog
.GetValue();
769 wxString
wxGetPasswordFromUser(const wxString
& message
,
770 const wxString
& caption
,
771 const wxString
& defaultValue
,
775 wxTextEntryDialog
dialog(parent
, message
, caption
, defaultValue
,
776 wxOK
| wxCANCEL
| wxTE_PASSWORD
);
777 if ( dialog
.ShowModal() == wxID_OK
)
779 str
= dialog
.GetValue();
785 #endif // wxUSE_TEXTDLG
789 wxColour
wxGetColourFromUser(wxWindow
*parent
, const wxColour
& colInit
)
792 data
.SetChooseFull(TRUE
);
795 data
.SetColour((wxColour
&)colInit
); // const_cast
799 wxColourDialog
dialog(parent
, &data
);
800 if ( dialog
.ShowModal() == wxID_OK
)
802 colRet
= dialog
.GetColourData().GetColour();
804 //else: leave it invalid
809 #endif // wxUSE_COLOURDLG
813 wxFont
wxGetFontFromUser(wxWindow
*parent
, const wxFont
& fontInit
)
818 data
.SetInitialFont(fontInit
);
822 wxFontDialog
dialog(parent
, data
);
823 if ( dialog
.ShowModal() == wxID_OK
)
825 fontRet
= dialog
.GetFontData().GetChosenFont();
827 //else: leave it invalid
832 #endif // wxUSE_FONTDLG
834 // ----------------------------------------------------------------------------
835 // wxSafeYield and supporting functions
836 // ----------------------------------------------------------------------------
838 void wxEnableTopLevelWindows(bool enable
)
840 wxWindowList::compatibility_iterator node
;
841 for ( node
= wxTopLevelWindows
.GetFirst(); node
; node
= node
->GetNext() )
842 node
->GetData()->Enable(enable
);
845 wxWindowDisabler::wxWindowDisabler(wxWindow
*winToSkip
)
847 // remember the top level windows which were already disabled, so that we
848 // don't reenable them later
849 m_winDisabled
= NULL
;
851 wxWindowList::compatibility_iterator node
;
852 for ( node
= wxTopLevelWindows
.GetFirst(); node
; node
= node
->GetNext() )
854 wxWindow
*winTop
= node
->GetData();
855 if ( winTop
== winToSkip
)
858 // we don't need to disable the hidden or already disabled windows
859 if ( winTop
->IsEnabled() && winTop
->IsShown() )
865 if ( !m_winDisabled
)
867 m_winDisabled
= new wxWindowList
;
870 m_winDisabled
->Append(winTop
);
875 wxWindowDisabler::~wxWindowDisabler()
877 wxWindowList::compatibility_iterator node
;
878 for ( node
= wxTopLevelWindows
.GetFirst(); node
; node
= node
->GetNext() )
880 wxWindow
*winTop
= node
->GetData();
881 if ( !m_winDisabled
|| !m_winDisabled
->Find(winTop
) )
885 //else: had been already disabled, don't reenable
888 delete m_winDisabled
;
891 // Yield to other apps/messages and disable user input to all windows except
893 bool wxSafeYield(wxWindow
*win
, bool onlyIfNeeded
)
895 wxWindowDisabler
wd(win
);
899 rc
= wxYieldIfNeeded();
906 // Don't synthesize KeyUp events holding down a key and producing KeyDown
907 // events with autorepeat. On by default and always on in wxMSW. wxGTK version
910 bool wxSetDetectableAutoRepeat( bool WXUNUSED(flag
) )
912 return TRUE
; // detectable auto-repeat is the only mode MSW supports