1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/common/utilscmn.cpp
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 // For compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
29 #include "wx/string.h"
35 #include "wx/window.h"
38 #include "wx/msgdlg.h"
39 #include "wx/textdlg.h"
40 #include "wx/textctrl.h" // for wxTE_PASSWORD
42 #include "wx/menuitem.h"
48 #include "wx/apptrait.h"
50 #include "wx/process.h"
51 #include "wx/txtstrm.h"
53 #include "wx/mimetype.h"
54 #include "wx/config.h"
56 #if defined(__WXWINCE__) && wxUSE_DATETIME
57 #include "wx/datetime.h"
65 #if !defined(__WATCOMC__)
66 #if !(defined(_MSC_VER) && (_MSC_VER > 800))
72 #include "wx/colordlg.h"
73 #include "wx/fontdlg.h"
74 #include "wx/notebook.h"
76 #include "wx/statusbr.h"
82 #include "wx/msw/wince/time.h"
85 #if !defined(__MWERKS__) && !defined(__WXWINCE__)
86 #include <sys/types.h>
90 #if defined(__WXMSW__)
91 #include "wx/msw/private.h"
92 #include "wx/msw/registry.h"
97 // ----------------------------------------------------------------------------
99 // ----------------------------------------------------------------------------
101 // ============================================================================
103 // ============================================================================
105 #if WXWIN_COMPATIBILITY_2_4
108 copystring (const wxChar
*s
)
110 if (s
== NULL
) s
= wxEmptyString
;
111 size_t len
= wxStrlen (s
) + 1;
113 wxChar
*news
= new wxChar
[len
];
114 memcpy (news
, s
, len
* sizeof(wxChar
)); // Should be the fastest
119 #endif // WXWIN_COMPATIBILITY_2_4
121 // ----------------------------------------------------------------------------
122 // String <-> Number conversions (deprecated)
123 // ----------------------------------------------------------------------------
125 #if WXWIN_COMPATIBILITY_2_4
127 WXDLLIMPEXP_DATA_BASE(const wxChar
*) wxFloatToStringStr
= wxT("%.2f");
128 WXDLLIMPEXP_DATA_BASE(const wxChar
*) wxDoubleToStringStr
= wxT("%.2f");
131 StringToFloat (const wxChar
*s
, float *number
)
133 if (s
&& *s
&& number
)
134 *number
= (float) wxStrtod (s
, (wxChar
**) NULL
);
138 StringToDouble (const wxChar
*s
, double *number
)
140 if (s
&& *s
&& number
)
141 *number
= wxStrtod (s
, (wxChar
**) NULL
);
145 FloatToString (float number
, const wxChar
*fmt
)
147 static wxChar buf
[256];
149 wxSprintf (buf
, fmt
, number
);
154 DoubleToString (double number
, const wxChar
*fmt
)
156 static wxChar buf
[256];
158 wxSprintf (buf
, fmt
, number
);
163 StringToInt (const wxChar
*s
, int *number
)
165 if (s
&& *s
&& number
)
166 *number
= (int) wxStrtol (s
, (wxChar
**) NULL
, 10);
170 StringToLong (const wxChar
*s
, long *number
)
172 if (s
&& *s
&& number
)
173 *number
= wxStrtol (s
, (wxChar
**) NULL
, 10);
177 IntToString (int number
)
179 static wxChar buf
[20];
181 wxSprintf (buf
, wxT("%d"), number
);
186 LongToString (long number
)
188 static wxChar buf
[20];
190 wxSprintf (buf
, wxT("%ld"), number
);
194 #endif // WXWIN_COMPATIBILITY_2_4
196 // Array used in DecToHex conversion routine.
197 static wxChar hexArray
[] = wxT("0123456789ABCDEF");
199 // Convert 2-digit hex number to decimal
200 int wxHexToDec(const wxString
& buf
)
202 int firstDigit
, secondDigit
;
204 if (buf
.GetChar(0) >= wxT('A'))
205 firstDigit
= buf
.GetChar(0) - wxT('A') + 10;
207 firstDigit
= buf
.GetChar(0) - wxT('0');
209 if (buf
.GetChar(1) >= wxT('A'))
210 secondDigit
= buf
.GetChar(1) - wxT('A') + 10;
212 secondDigit
= buf
.GetChar(1) - wxT('0');
214 return (firstDigit
& 0xF) * 16 + (secondDigit
& 0xF );
217 // Convert decimal integer to 2-character hex string
218 void wxDecToHex(int dec
, wxChar
*buf
)
220 int firstDigit
= (int)(dec
/16.0);
221 int secondDigit
= (int)(dec
- (firstDigit
*16.0));
222 buf
[0] = hexArray
[firstDigit
];
223 buf
[1] = hexArray
[secondDigit
];
227 // Convert decimal integer to 2-character hex string
228 wxString
wxDecToHex(int dec
)
231 wxDecToHex(dec
, buf
);
232 return wxString(buf
);
235 // ----------------------------------------------------------------------------
237 // ----------------------------------------------------------------------------
239 // Return the current date/time
244 wxDateTime now
= wxDateTime::Now();
247 return wxEmptyString
;
250 time_t now
= time((time_t *) NULL
);
251 char *date
= ctime(&now
);
253 return wxString::FromAscii(date
);
257 void wxUsleep(unsigned long milliseconds
)
259 wxMilliSleep(milliseconds
);
262 const wxChar
*wxGetInstallPrefix()
266 if ( wxGetEnv(wxT("WXPREFIX"), &prefix
) )
267 return prefix
.c_str();
269 #ifdef wxINSTALL_PREFIX
270 return wxT(wxINSTALL_PREFIX
);
272 return wxEmptyString
;
276 wxString
wxGetDataDir()
278 wxString dir
= wxGetInstallPrefix();
279 dir
<< wxFILE_SEP_PATH
<< wxT("share") << wxFILE_SEP_PATH
<< wxT("wx");
283 int wxGetOsVersion(int *verMaj
, int *verMin
)
285 // we want this function to work even if there is no wxApp
286 wxConsoleAppTraits traitsConsole
;
287 wxAppTraits
*traits
= wxTheApp
? wxTheApp
->GetTraits() : NULL
;
289 traits
= &traitsConsole
;
291 wxToolkitInfo
& info
= traits
->GetToolkitInfo();
293 *verMaj
= info
.versionMajor
;
295 *verMin
= info
.versionMinor
;
299 // ----------------------------------------------------------------------------
300 // network and user id functions
301 // ----------------------------------------------------------------------------
303 // Get Full RFC822 style email address
304 bool wxGetEmailAddress(wxChar
*address
, int maxSize
)
306 wxString email
= wxGetEmailAddress();
310 wxStrncpy(address
, email
, maxSize
- 1);
311 address
[maxSize
- 1] = wxT('\0');
316 wxString
wxGetEmailAddress()
320 wxString host
= wxGetFullHostName();
323 wxString user
= wxGetUserId();
326 email
<< user
<< wxT('@') << host
;
333 wxString
wxGetUserId()
335 static const int maxLoginLen
= 256; // FIXME arbitrary number
338 bool ok
= wxGetUserId(wxStringBuffer(buf
, maxLoginLen
), maxLoginLen
);
346 wxString
wxGetUserName()
348 static const int maxUserNameLen
= 1024; // FIXME arbitrary number
351 bool ok
= wxGetUserName(wxStringBuffer(buf
, maxUserNameLen
), maxUserNameLen
);
359 wxString
wxGetHostName()
361 static const size_t hostnameSize
= 257;
364 bool ok
= wxGetHostName(wxStringBuffer(buf
, hostnameSize
), hostnameSize
);
372 wxString
wxGetFullHostName()
374 static const size_t hostnameSize
= 257;
377 bool ok
= wxGetFullHostName(wxStringBuffer(buf
, hostnameSize
), hostnameSize
);
385 wxString
wxGetHomeDir()
395 wxString
wxGetCurrentDir()
402 ok
= getcwd(dir
.GetWriteBuf(len
+ 1), len
) != NULL
;
407 if ( errno
!= ERANGE
)
409 wxLogSysError(_T("Failed to get current directory"));
411 return wxEmptyString
;
415 // buffer was too small, retry with a larger one
427 // ----------------------------------------------------------------------------
429 // ----------------------------------------------------------------------------
431 // wxDoExecuteWithCapture() helper: reads an entire stream into one array
433 // returns true if ok, false if error
435 static bool ReadAll(wxInputStream
*is
, wxArrayString
& output
)
437 wxCHECK_MSG( is
, false, _T("NULL stream in wxExecute()?") );
439 // the stream could be already at EOF or in wxSTREAM_BROKEN_PIPE state
442 wxTextInputStream
tis(*is
);
447 wxString line
= tis
.ReadLine();
463 #endif // wxUSE_STREAMS
465 // this is a private function because it hasn't a clean interface: the first
466 // array is passed by reference, the second by pointer - instead we have 2
467 // public versions of wxExecute() below
468 static long wxDoExecuteWithCapture(const wxString
& command
,
469 wxArrayString
& output
,
470 wxArrayString
* error
,
473 // create a wxProcess which will capture the output
474 wxProcess
*process
= new wxProcess
;
477 long rc
= wxExecute(command
, wxEXEC_SYNC
| flags
, process
);
482 if ( !ReadAll(process
->GetInputStream(), output
) )
487 if ( !ReadAll(process
->GetErrorStream(), *error
) )
495 #endif // wxUSE_STREAMS/!wxUSE_STREAMS
502 long wxExecute(const wxString
& command
, wxArrayString
& output
, int flags
)
504 return wxDoExecuteWithCapture(command
, output
, NULL
, flags
);
507 long wxExecute(const wxString
& command
,
508 wxArrayString
& output
,
509 wxArrayString
& error
,
512 return wxDoExecuteWithCapture(command
, output
, &error
, flags
);
515 // ----------------------------------------------------------------------------
516 // Launch default browser
517 // ----------------------------------------------------------------------------
519 bool wxLaunchDefaultBrowser(const wxString
& urlOrig
, int flags
)
523 // set the scheme of url to http if it does not have one
524 wxString
url(urlOrig
);
525 if ( !wxURI(url
).HasScheme() )
526 url
.Prepend(wxT("http://"));
528 #if defined(__WXMSW__)
529 if ( flags
& wxBROWSER_NEW_WINDOW
)
531 // ShellExecuteEx() opens the URL in an existing window by default so
532 // we can't use it if we need a new window
533 wxRegKey
key(wxRegKey::HKCR
, url
.BeforeFirst(':') + _T("\\shell\\open"));
536 wxRegKey
keyDDE(key
, wxT("DDEExec"));
537 if ( keyDDE
.Exists() )
539 const wxString ddeTopic
= wxRegKey(keyDDE
, wxT("topic"));
541 // we only know the syntax of WWW_OpenURL DDE request for IE,
542 // optimistically assume that all other browsers are compatible
545 bool ok
= ddeTopic
== wxT("WWW_OpenURL");
548 ddeCmd
= keyDDE
.QueryDefaultValue();
549 ok
= !ddeCmd
.empty();
554 // for WWW_OpenURL, the index of the window to open the URL
555 // in is -1 (meaning "current") by default, replace it with
556 // 0 which means "new" (see KB article 160957)
557 ok
= ddeCmd
.Replace(wxT("-1"), wxT("0"),
558 false /* only first occurence */) == 1;
563 // and also replace the parameters: the topic should
564 // contain a placeholder for the URL
565 ok
= ddeCmd
.Replace(wxT("%1"), url
, false) == 1;
570 // try to send it the DDE request now but ignore the errors
573 const wxString ddeServer
= wxRegKey(keyDDE
, wxT("application"));
574 if ( wxExecuteDDE(ddeServer
, ddeTopic
, ddeCmd
) )
577 // this is not necessarily an error: maybe browser is
578 // simply not running, but no matter, in any case we're
579 // going to launch it using ShellExecuteEx() below now and
580 // we shouldn't try to open a new window if we open a new
587 WinStruct
<SHELLEXECUTEINFO
> sei
;
588 sei
.lpFile
= url
.c_str();
589 sei
.lpVerb
= _T("open");
590 sei
.nShow
= SW_SHOWNORMAL
;
592 ::ShellExecuteEx(&sei
);
594 const int nResult
= (int) sei
.hInstApp
;
596 // Firefox returns file not found for some reason, so make an exception
598 if ( nResult
> 32 || nResult
== SE_ERR_FNF
)
601 // Log something if SE_ERR_FNF happens
602 if ( nResult
== SE_ERR_FNF
)
603 wxLogDebug(wxT("SE_ERR_FNF from ShellExecute -- maybe FireFox?"));
604 #endif // __WXDEBUG__
609 wxFileType
*ft
= wxTheMimeTypesManager
->GetFileTypeFromExtension (_T("html"));
613 ft
->GetMimeType(&mt
);
616 bool ok
= ft
->GetOpenCommand(&cmd
, wxFileType::MessageParameters(url
));
619 if ( !ok
|| cmd
.empty() )
621 // fallback to checking for the BROWSER environment variable
622 cmd
= wxGetenv(wxT("BROWSER"));
624 cmd
<< _T(' ') << url
;
627 if ( !cmd
.empty() && wxExecute(cmd
) )
630 else // no file type for html extension
632 wxLogError(_T("No default application configured for HTML files."));
634 #endif // !wxUSE_MIMETYPE && !__WXMSW__
636 wxLogSysError(_T("Failed to open URL \"%s\" in default browser."),
642 // ----------------------------------------------------------------------------
643 // wxApp::Yield() wrappers for backwards compatibility
644 // ----------------------------------------------------------------------------
648 return wxTheApp
&& wxTheApp
->Yield();
651 bool wxYieldIfNeeded()
653 return wxTheApp
&& wxTheApp
->Yield(true);
658 // ============================================================================
659 // GUI-only functions from now on
660 // ============================================================================
665 static long wxCurrentId
= 100;
669 // skip the part of IDs space that contains hard-coded values:
670 if (wxCurrentId
== wxID_LOWEST
)
671 wxCurrentId
= wxID_HIGHEST
+ 1;
673 return wxCurrentId
++;
677 wxGetCurrentId(void) { return wxCurrentId
; }
680 wxRegisterId (long id
)
682 if (id
>= wxCurrentId
)
683 wxCurrentId
= id
+ 1;
688 // ----------------------------------------------------------------------------
689 // Menu accelerators related functions
690 // ----------------------------------------------------------------------------
692 wxChar
*wxStripMenuCodes(const wxChar
*in
, wxChar
*out
)
694 wxString s
= wxMenuItem::GetLabelFromText(in
);
697 // go smash their buffer if it's not big enough - I love char * params
698 memcpy(out
, s
.c_str(), s
.length() * sizeof(wxChar
));
702 // MYcopystring - for easier search...
703 out
= new wxChar
[s
.length() + 1];
704 wxStrcpy(out
, s
.c_str());
710 wxString
wxStripMenuCodes(const wxString
& in
)
714 size_t len
= in
.length();
717 for ( size_t n
= 0; n
< len
; n
++ )
722 // skip it, it is used to introduce the accel char (or to quote
723 // itself in which case it should still be skipped): note that it
724 // can't be the last character of the string
727 wxLogDebug(_T("Invalid menu string '%s'"), in
.c_str());
731 // use the next char instead
735 else if ( ch
== _T('\t') )
737 // everything after TAB is accel string, exit the loop
747 #endif // wxUSE_MENUS
749 // ----------------------------------------------------------------------------
750 // Window search functions
751 // ----------------------------------------------------------------------------
754 * If parent is non-NULL, look through children for a label or title
755 * matching the specified string. If NULL, look through all top-level windows.
760 wxFindWindowByLabel (const wxString
& title
, wxWindow
* parent
)
762 return wxWindow::FindWindowByLabel( title
, parent
);
767 * If parent is non-NULL, look through children for a name
768 * matching the specified string. If NULL, look through all top-level windows.
773 wxFindWindowByName (const wxString
& name
, wxWindow
* parent
)
775 return wxWindow::FindWindowByName( name
, parent
);
778 // Returns menu item id or wxNOT_FOUND if none.
780 wxFindMenuItemId (wxFrame
* frame
, const wxString
& menuString
, const wxString
& itemString
)
783 wxMenuBar
*menuBar
= frame
->GetMenuBar ();
785 return menuBar
->FindMenuItem (menuString
, itemString
);
786 #endif // wxUSE_MENUS
791 // Try to find the deepest child that contains 'pt'.
792 // We go backwards, to try to allow for controls that are spacially
793 // within other controls, but are still siblings (e.g. buttons within
794 // static boxes). Static boxes are likely to be created _before_ controls
795 // that sit inside them.
796 wxWindow
* wxFindWindowAtPoint(wxWindow
* win
, const wxPoint
& pt
)
801 // Hack for wxNotebook case: at least in wxGTK, all pages
802 // claim to be shown, so we must only deal with the selected one.
804 if (win
->IsKindOf(CLASSINFO(wxNotebook
)))
806 wxNotebook
* nb
= (wxNotebook
*) win
;
807 int sel
= nb
->GetSelection();
810 wxWindow
* child
= nb
->GetPage(sel
);
811 wxWindow
* foundWin
= wxFindWindowAtPoint(child
, pt
);
818 wxWindowList::compatibility_iterator node
= win
->GetChildren().GetLast();
821 wxWindow
* child
= node
->GetData();
822 wxWindow
* foundWin
= wxFindWindowAtPoint(child
, pt
);
825 node
= node
->GetPrevious();
828 wxPoint pos
= win
->GetPosition();
829 wxSize sz
= win
->GetSize();
830 if (win
->GetParent())
832 pos
= win
->GetParent()->ClientToScreen(pos
);
835 wxRect
rect(pos
, sz
);
842 wxWindow
* wxGenericFindWindowAtPoint(const wxPoint
& pt
)
844 // Go backwards through the list since windows
845 // on top are likely to have been appended most
847 wxWindowList::compatibility_iterator node
= wxTopLevelWindows
.GetLast();
850 wxWindow
* win
= node
->GetData();
851 wxWindow
* found
= wxFindWindowAtPoint(win
, pt
);
854 node
= node
->GetPrevious();
859 // ----------------------------------------------------------------------------
861 // ----------------------------------------------------------------------------
864 * N.B. these convenience functions must be separate from msgdlgg.cpp, textdlgg.cpp
865 * since otherwise the generic code may be pulled in unnecessarily.
870 int wxMessageBox(const wxString
& message
, const wxString
& caption
, long style
,
871 wxWindow
*parent
, int WXUNUSED(x
), int WXUNUSED(y
) )
873 long decorated_style
= style
;
875 if ( ( style
& ( wxICON_EXCLAMATION
| wxICON_HAND
| wxICON_INFORMATION
| wxICON_QUESTION
) ) == 0 )
877 decorated_style
|= ( style
& wxYES
) ? wxICON_QUESTION
: wxICON_INFORMATION
;
880 wxMessageDialog
dialog(parent
, message
, caption
, decorated_style
);
882 int ans
= dialog
.ShowModal();
895 wxFAIL_MSG( _T("unexpected return code from wxMessageDialog") );
900 #endif // wxUSE_MSGDLG
904 wxString
wxGetTextFromUser(const wxString
& message
, const wxString
& caption
,
905 const wxString
& defaultValue
, wxWindow
*parent
,
906 wxCoord x
, wxCoord y
, bool centre
)
909 long style
= wxTextEntryDialogStyle
;
916 wxTextEntryDialog
dialog(parent
, message
, caption
, defaultValue
, style
, wxPoint(x
, y
));
918 if (dialog
.ShowModal() == wxID_OK
)
920 str
= dialog
.GetValue();
926 wxString
wxGetPasswordFromUser(const wxString
& message
,
927 const wxString
& caption
,
928 const wxString
& defaultValue
,
930 wxCoord x
, wxCoord y
, bool centre
)
933 long style
= wxTextEntryDialogStyle
;
940 wxPasswordEntryDialog
dialog(parent
, message
, caption
, defaultValue
,
941 style
, wxPoint(x
, y
));
942 if ( dialog
.ShowModal() == wxID_OK
)
944 str
= dialog
.GetValue();
950 #endif // wxUSE_TEXTDLG
954 wxColour
wxGetColourFromUser(wxWindow
*parent
, const wxColour
& colInit
)
957 data
.SetChooseFull(true);
960 data
.SetColour((wxColour
&)colInit
); // const_cast
964 wxColourDialog
dialog(parent
, &data
);
965 if ( dialog
.ShowModal() == wxID_OK
)
967 colRet
= dialog
.GetColourData().GetColour();
969 //else: leave it invalid
974 #endif // wxUSE_COLOURDLG
978 wxFont
wxGetFontFromUser(wxWindow
*parent
, const wxFont
& fontInit
)
983 data
.SetInitialFont(fontInit
);
987 wxFontDialog
dialog(parent
, data
);
988 if ( dialog
.ShowModal() == wxID_OK
)
990 fontRet
= dialog
.GetFontData().GetChosenFont();
992 //else: leave it invalid
997 #endif // wxUSE_FONTDLG
999 // ----------------------------------------------------------------------------
1000 // wxSafeYield and supporting functions
1001 // ----------------------------------------------------------------------------
1003 void wxEnableTopLevelWindows(bool enable
)
1005 wxWindowList::compatibility_iterator node
;
1006 for ( node
= wxTopLevelWindows
.GetFirst(); node
; node
= node
->GetNext() )
1007 node
->GetData()->Enable(enable
);
1010 wxWindowDisabler::wxWindowDisabler(wxWindow
*winToSkip
)
1012 // remember the top level windows which were already disabled, so that we
1013 // don't reenable them later
1014 m_winDisabled
= NULL
;
1016 wxWindowList::compatibility_iterator node
;
1017 for ( node
= wxTopLevelWindows
.GetFirst(); node
; node
= node
->GetNext() )
1019 wxWindow
*winTop
= node
->GetData();
1020 if ( winTop
== winToSkip
)
1023 // we don't need to disable the hidden or already disabled windows
1024 if ( winTop
->IsEnabled() && winTop
->IsShown() )
1030 if ( !m_winDisabled
)
1032 m_winDisabled
= new wxWindowList
;
1035 m_winDisabled
->Append(winTop
);
1040 wxWindowDisabler::~wxWindowDisabler()
1042 wxWindowList::compatibility_iterator node
;
1043 for ( node
= wxTopLevelWindows
.GetFirst(); node
; node
= node
->GetNext() )
1045 wxWindow
*winTop
= node
->GetData();
1046 if ( !m_winDisabled
|| !m_winDisabled
->Find(winTop
) )
1050 //else: had been already disabled, don't reenable
1053 delete m_winDisabled
;
1056 // Yield to other apps/messages and disable user input to all windows except
1058 bool wxSafeYield(wxWindow
*win
, bool onlyIfNeeded
)
1060 wxWindowDisabler
wd(win
);
1064 rc
= wxYieldIfNeeded();
1071 // Don't synthesize KeyUp events holding down a key and producing KeyDown
1072 // events with autorepeat. On by default and always on in wxMSW. wxGTK version
1075 bool wxSetDetectableAutoRepeat( bool WXUNUSED(flag
) )
1077 return true; // detectable auto-repeat is the only mode MSW supports