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 #include "wx/mimetype.h"
65 #include "wx/config.h"
67 #if defined(__WXWINCE__) && wxUSE_DATETIME
68 #include "wx/datetime.h"
76 #if !defined(__WATCOMC__)
77 #if !(defined(_MSC_VER) && (_MSC_VER > 800))
83 #include "wx/colordlg.h"
84 #include "wx/fontdlg.h"
85 #include "wx/notebook.h"
87 #include "wx/statusbr.h"
93 #include "wx/msw/wince/time.h"
96 #if !defined(__MWERKS__) && !defined(__WXWINCE__)
97 #include <sys/types.h>
101 #if defined(__WXMSW__)
102 #include "wx/msw/private.h"
107 // ----------------------------------------------------------------------------
109 // ----------------------------------------------------------------------------
111 #if WXWIN_COMPATIBILITY_2_2
112 const wxChar
*wxInternalErrorStr
= wxT("wxWidgets Internal Error");
113 const wxChar
*wxFatalErrorStr
= wxT("wxWidgets Fatal Error");
114 #endif // WXWIN_COMPATIBILITY_2_2
116 // ============================================================================
118 // ============================================================================
120 #if WXWIN_COMPATIBILITY_2_4
123 copystring (const wxChar
*s
)
125 if (s
== NULL
) s
= wxEmptyString
;
126 size_t len
= wxStrlen (s
) + 1;
128 wxChar
*news
= new wxChar
[len
];
129 memcpy (news
, s
, len
* sizeof(wxChar
)); // Should be the fastest
134 #endif // WXWIN_COMPATIBILITY_2_4
136 // ----------------------------------------------------------------------------
137 // String <-> Number conversions (deprecated)
138 // ----------------------------------------------------------------------------
140 #if WXWIN_COMPATIBILITY_2_4
142 WXDLLIMPEXP_DATA_BASE(const wxChar
*) wxFloatToStringStr
= wxT("%.2f");
143 WXDLLIMPEXP_DATA_BASE(const wxChar
*) wxDoubleToStringStr
= wxT("%.2f");
146 StringToFloat (const wxChar
*s
, float *number
)
148 if (s
&& *s
&& number
)
149 *number
= (float) wxStrtod (s
, (wxChar
**) NULL
);
153 StringToDouble (const wxChar
*s
, double *number
)
155 if (s
&& *s
&& number
)
156 *number
= wxStrtod (s
, (wxChar
**) NULL
);
160 FloatToString (float number
, const wxChar
*fmt
)
162 static wxChar buf
[256];
164 wxSprintf (buf
, fmt
, number
);
169 DoubleToString (double number
, const wxChar
*fmt
)
171 static wxChar buf
[256];
173 wxSprintf (buf
, fmt
, number
);
178 StringToInt (const wxChar
*s
, int *number
)
180 if (s
&& *s
&& number
)
181 *number
= (int) wxStrtol (s
, (wxChar
**) NULL
, 10);
185 StringToLong (const wxChar
*s
, long *number
)
187 if (s
&& *s
&& number
)
188 *number
= wxStrtol (s
, (wxChar
**) NULL
, 10);
192 IntToString (int number
)
194 static wxChar buf
[20];
196 wxSprintf (buf
, wxT("%d"), number
);
201 LongToString (long number
)
203 static wxChar buf
[20];
205 wxSprintf (buf
, wxT("%ld"), number
);
209 #endif // WXWIN_COMPATIBILITY_2_4
211 // Array used in DecToHex conversion routine.
212 static wxChar hexArray
[] = wxT("0123456789ABCDEF");
214 // Convert 2-digit hex number to decimal
215 int wxHexToDec(const wxString
& buf
)
217 int firstDigit
, secondDigit
;
219 if (buf
.GetChar(0) >= wxT('A'))
220 firstDigit
= buf
.GetChar(0) - wxT('A') + 10;
222 firstDigit
= buf
.GetChar(0) - wxT('0');
224 if (buf
.GetChar(1) >= wxT('A'))
225 secondDigit
= buf
.GetChar(1) - wxT('A') + 10;
227 secondDigit
= buf
.GetChar(1) - wxT('0');
229 return (firstDigit
& 0xF) * 16 + (secondDigit
& 0xF );
232 // Convert decimal integer to 2-character hex string
233 void wxDecToHex(int dec
, wxChar
*buf
)
235 int firstDigit
= (int)(dec
/16.0);
236 int secondDigit
= (int)(dec
- (firstDigit
*16.0));
237 buf
[0] = hexArray
[firstDigit
];
238 buf
[1] = hexArray
[secondDigit
];
242 // Convert decimal integer to 2-character hex string
243 wxString
wxDecToHex(int dec
)
246 wxDecToHex(dec
, buf
);
247 return wxString(buf
);
250 // ----------------------------------------------------------------------------
252 // ----------------------------------------------------------------------------
254 // Return the current date/time
259 wxDateTime now
= wxDateTime::Now();
262 return wxEmptyString
;
265 time_t now
= time((time_t *) NULL
);
266 char *date
= ctime(&now
);
268 return wxString::FromAscii(date
);
272 void wxUsleep(unsigned long milliseconds
)
274 wxMilliSleep(milliseconds
);
277 const wxChar
*wxGetInstallPrefix()
281 if ( wxGetEnv(wxT("WXPREFIX"), &prefix
) )
282 return prefix
.c_str();
284 #ifdef wxINSTALL_PREFIX
285 return wxT(wxINSTALL_PREFIX
);
287 return wxEmptyString
;
291 wxString
wxGetDataDir()
293 wxString dir
= wxGetInstallPrefix();
294 dir
<< wxFILE_SEP_PATH
<< wxT("share") << wxFILE_SEP_PATH
<< wxT("wx");
298 int wxGetOsVersion(int *verMaj
, int *verMin
)
300 // we want this function to work even if there is no wxApp
301 wxConsoleAppTraits traitsConsole
;
302 wxAppTraits
*traits
= wxTheApp
? wxTheApp
->GetTraits() : NULL
;
304 traits
= &traitsConsole
;
306 wxToolkitInfo
& info
= traits
->GetToolkitInfo();
308 *verMaj
= info
.versionMajor
;
310 *verMin
= info
.versionMinor
;
314 // ----------------------------------------------------------------------------
315 // network and user id functions
316 // ----------------------------------------------------------------------------
318 // Get Full RFC822 style email address
319 bool wxGetEmailAddress(wxChar
*address
, int maxSize
)
321 wxString email
= wxGetEmailAddress();
325 wxStrncpy(address
, email
, maxSize
- 1);
326 address
[maxSize
- 1] = wxT('\0');
331 wxString
wxGetEmailAddress()
335 wxString host
= wxGetFullHostName();
338 wxString user
= wxGetUserId();
341 email
<< user
<< wxT('@') << host
;
348 wxString
wxGetUserId()
350 static const int maxLoginLen
= 256; // FIXME arbitrary number
353 bool ok
= wxGetUserId(wxStringBuffer(buf
, maxLoginLen
), maxLoginLen
);
361 wxString
wxGetUserName()
363 static const int maxUserNameLen
= 1024; // FIXME arbitrary number
366 bool ok
= wxGetUserName(wxStringBuffer(buf
, maxUserNameLen
), maxUserNameLen
);
374 wxString
wxGetHostName()
376 static const size_t hostnameSize
= 257;
379 bool ok
= wxGetHostName(wxStringBuffer(buf
, hostnameSize
), hostnameSize
);
387 wxString
wxGetFullHostName()
389 static const size_t hostnameSize
= 257;
392 bool ok
= wxGetFullHostName(wxStringBuffer(buf
, hostnameSize
), hostnameSize
);
400 wxString
wxGetHomeDir()
410 wxString
wxGetCurrentDir()
417 ok
= getcwd(dir
.GetWriteBuf(len
+ 1), len
) != NULL
;
422 if ( errno
!= ERANGE
)
424 wxLogSysError(_T("Failed to get current directory"));
426 return wxEmptyString
;
430 // buffer was too small, retry with a larger one
442 // ----------------------------------------------------------------------------
444 // ----------------------------------------------------------------------------
446 // wxDoExecuteWithCapture() helper: reads an entire stream into one array
448 // returns true if ok, false if error
450 static bool ReadAll(wxInputStream
*is
, wxArrayString
& output
)
452 wxCHECK_MSG( is
, false, _T("NULL stream in wxExecute()?") );
454 // the stream could be already at EOF or in wxSTREAM_BROKEN_PIPE state
457 wxTextInputStream
tis(*is
);
462 wxString line
= tis
.ReadLine();
478 #endif // wxUSE_STREAMS
480 // this is a private function because it hasn't a clean interface: the first
481 // array is passed by reference, the second by pointer - instead we have 2
482 // public versions of wxExecute() below
483 static long wxDoExecuteWithCapture(const wxString
& command
,
484 wxArrayString
& output
,
485 wxArrayString
* error
,
488 // create a wxProcess which will capture the output
489 wxProcess
*process
= new wxProcess
;
492 long rc
= wxExecute(command
, wxEXEC_SYNC
| flags
, process
);
497 if ( !ReadAll(process
->GetInputStream(), output
) )
502 if ( !ReadAll(process
->GetErrorStream(), *error
) )
510 #endif // wxUSE_STREAMS/!wxUSE_STREAMS
517 long wxExecute(const wxString
& command
, wxArrayString
& output
, int flags
)
519 return wxDoExecuteWithCapture(command
, output
, NULL
, flags
);
522 long wxExecute(const wxString
& command
,
523 wxArrayString
& output
,
524 wxArrayString
& error
,
527 return wxDoExecuteWithCapture(command
, output
, &error
, flags
);
530 // ----------------------------------------------------------------------------
531 // Launch default browser
532 // ----------------------------------------------------------------------------
534 bool wxLaunchDefaultBrowser(const wxString
& url
)
536 wxString finalurl
= url
;
538 //if it isn't a full url, try appending http:// to it
539 if(wxURI(url
).IsReference())
540 finalurl
= wxString(wxT("http://")) + url
;
545 // ShellExecute() always opens in the same window,
546 // so do it manually for new window (from Mahogany)
547 wxRegKey
key(wxRegKey::HKCR
, url
.BeforeFirst(':') + wxT("\\shell\\open"));
550 wxRegKey
keyDDE(key
, wxT("DDEExec"));
551 if ( keyDDE
.Exists() )
553 wxString ddeTopic
= wxRegKey(keyDDE
, wxT("topic"));
555 // we only know the syntax of WWW_OpenURL DDE request
556 if ( ddeTopic
== wxT("WWW_OpenURL") )
558 wxString ddeCmd
= keyDDE
;
560 // this is a bit naive but should work as -1 can't appear
561 // elsewhere in the DDE topic, normally
562 if ( ddeCmd
.Replace(wxT("-1"), wxT("0"),
563 FALSE
/* only first occurence */) == 1 )
565 // and also replace the parameters
566 if ( ddeCmd
.Replace(wxT("%1"), url
, FALSE
) == 1 )
568 // magic incantation understood by wxMSW
569 command
<< wxT("WX_DDE#")
570 << wxRegKey(key
, wxT("command")).QueryDefaultValue() << wxT('#')
571 << wxRegKey(keyDDE
, wxT("application")).QueryDefaultValue()
572 << wxT('#') << ddeTopic
<< wxT('#')
580 //Try wxExecute - if it doesn't work or the regkey stuff
581 //above failed, fallback to opening the file in the same
583 if ( command
.empty() || wxExecute(command
) == -1)
585 // CYGWIN and MINGW may have problems - so load ShellExecute
587 typedef HINSTANCE (*LPShellExecute
)(HWND hwnd
, const wxChar
* lpOperation
,
588 const wxChar
* lpFile
,
589 const wxChar
* lpParameters
,
590 const wxChar
* lpDirectory
,
593 HINSTANCE hShellDll
= ::LoadLibrary(wxT("shell32.dll"));
594 if(hShellDll
== NULL
)
597 LPShellExecute lpShellExecute
=
598 (LPShellExecute
) ::GetProcAddress(hShellDll
,
599 wxString::Format(wxT("ShellExecute%s"),
607 if(lpShellExecute
== NULL
)
610 // Windows sometimes doesn't open the browser correctly when using mime
611 // types, so do ShellExecute - i.e. start <url> (from James Carroll)
612 unsigned int nResult
= (int) (*lpShellExecute
)(NULL
, NULL
, finalurl
.c_str(),
613 NULL
, wxT(""), SW_SHOWNORMAL
);
615 // Unload Shell32.dll
616 ::FreeLibrary(hShellDll
);
618 // Hack for Firefox (returns file not found for some reason)
619 // from Angelo Mandato's wxHyperlinksCtrl
620 // HINSTANCE_ERROR == 32
621 if (nResult
<= HINSTANCE_ERROR
&& nResult
!= SE_ERR_FNF
)
625 // Log something if SE_ERR_FNF happens
626 if(nResult
== SE_ERR_FNF
)
627 wxLogDebug(wxT("Got SE_ERR_FNF from ShellExecute - maybe FireFox"));
635 wxTheMimeTypesManager
->GetFileTypeFromExtension (_T("html"));
638 wxLogError(_T("No default application can open .html extension"));
643 ft
->GetMimeType(&mt
);
647 ft
->GetOpenCommand (&cmd
,
648 wxFileType::MessageParameters (finalurl
.c_str(),
654 if( wxExecute (cmd
, wxEXEC_ASYNC
) == -1 )
656 wxLogError(_T("Failed to launch application for wxLaunchDefaultBrowser"));
664 #endif //!wxUSE_MIMETYPE
668 //success - hopefully
672 // ----------------------------------------------------------------------------
673 // wxApp::Yield() wrappers for backwards compatibility
674 // ----------------------------------------------------------------------------
678 return wxTheApp
&& wxTheApp
->Yield();
681 bool wxYieldIfNeeded()
683 return wxTheApp
&& wxTheApp
->Yield(true);
688 // ============================================================================
689 // GUI-only functions from now on
690 // ============================================================================
695 static long wxCurrentId
= 100;
699 // skip the part of IDs space that contains hard-coded values:
700 if (wxCurrentId
== wxID_LOWEST
)
701 wxCurrentId
= wxID_HIGHEST
+ 1;
703 return wxCurrentId
++;
707 wxGetCurrentId(void) { return wxCurrentId
; }
710 wxRegisterId (long id
)
712 if (id
>= wxCurrentId
)
713 wxCurrentId
= id
+ 1;
718 // ----------------------------------------------------------------------------
719 // Menu accelerators related functions
720 // ----------------------------------------------------------------------------
722 wxChar
*wxStripMenuCodes(const wxChar
*in
, wxChar
*out
)
724 wxString s
= wxMenuItem::GetLabelFromText(in
);
727 // go smash their buffer if it's not big enough - I love char * params
728 memcpy(out
, s
.c_str(), s
.length() * sizeof(wxChar
));
732 // MYcopystring - for easier search...
733 out
= new wxChar
[s
.length() + 1];
734 wxStrcpy(out
, s
.c_str());
740 wxString
wxStripMenuCodes(const wxString
& in
)
744 size_t len
= in
.length();
747 for ( size_t n
= 0; n
< len
; n
++ )
752 // skip it, it is used to introduce the accel char (or to quote
753 // itself in which case it should still be skipped): note that it
754 // can't be the last character of the string
757 wxLogDebug(_T("Invalid menu string '%s'"), in
.c_str());
761 // use the next char instead
765 else if ( ch
== _T('\t') )
767 // everything after TAB is accel string, exit the loop
777 #endif // wxUSE_MENUS
779 // ----------------------------------------------------------------------------
780 // Window search functions
781 // ----------------------------------------------------------------------------
784 * If parent is non-NULL, look through children for a label or title
785 * matching the specified string. If NULL, look through all top-level windows.
790 wxFindWindowByLabel (const wxString
& title
, wxWindow
* parent
)
792 return wxWindow::FindWindowByLabel( title
, parent
);
797 * If parent is non-NULL, look through children for a name
798 * matching the specified string. If NULL, look through all top-level windows.
803 wxFindWindowByName (const wxString
& name
, wxWindow
* parent
)
805 return wxWindow::FindWindowByName( name
, parent
);
808 // Returns menu item id or wxNOT_FOUND if none.
810 wxFindMenuItemId (wxFrame
* frame
, const wxString
& menuString
, const wxString
& itemString
)
813 wxMenuBar
*menuBar
= frame
->GetMenuBar ();
815 return menuBar
->FindMenuItem (menuString
, itemString
);
816 #endif // wxUSE_MENUS
821 // Try to find the deepest child that contains 'pt'.
822 // We go backwards, to try to allow for controls that are spacially
823 // within other controls, but are still siblings (e.g. buttons within
824 // static boxes). Static boxes are likely to be created _before_ controls
825 // that sit inside them.
826 wxWindow
* wxFindWindowAtPoint(wxWindow
* win
, const wxPoint
& pt
)
831 // Hack for wxNotebook case: at least in wxGTK, all pages
832 // claim to be shown, so we must only deal with the selected one.
834 if (win
->IsKindOf(CLASSINFO(wxNotebook
)))
836 wxNotebook
* nb
= (wxNotebook
*) win
;
837 int sel
= nb
->GetSelection();
840 wxWindow
* child
= nb
->GetPage(sel
);
841 wxWindow
* foundWin
= wxFindWindowAtPoint(child
, pt
);
848 wxWindowList::compatibility_iterator node
= win
->GetChildren().GetLast();
851 wxWindow
* child
= node
->GetData();
852 wxWindow
* foundWin
= wxFindWindowAtPoint(child
, pt
);
855 node
= node
->GetPrevious();
858 wxPoint pos
= win
->GetPosition();
859 wxSize sz
= win
->GetSize();
860 if (win
->GetParent())
862 pos
= win
->GetParent()->ClientToScreen(pos
);
865 wxRect
rect(pos
, sz
);
872 wxWindow
* wxGenericFindWindowAtPoint(const wxPoint
& pt
)
874 // Go backwards through the list since windows
875 // on top are likely to have been appended most
877 wxWindowList::compatibility_iterator node
= wxTopLevelWindows
.GetLast();
880 wxWindow
* win
= node
->GetData();
881 wxWindow
* found
= wxFindWindowAtPoint(win
, pt
);
884 node
= node
->GetPrevious();
889 // ----------------------------------------------------------------------------
891 // ----------------------------------------------------------------------------
894 * N.B. these convenience functions must be separate from msgdlgg.cpp, textdlgg.cpp
895 * since otherwise the generic code may be pulled in unnecessarily.
900 int wxMessageBox(const wxString
& message
, const wxString
& caption
, long style
,
901 wxWindow
*parent
, int WXUNUSED(x
), int WXUNUSED(y
) )
903 long decorated_style
= style
;
905 if ( ( style
& ( wxICON_EXCLAMATION
| wxICON_HAND
| wxICON_INFORMATION
| wxICON_QUESTION
) ) == 0 )
907 decorated_style
|= ( style
& wxYES
) ? wxICON_QUESTION
: wxICON_INFORMATION
;
910 wxMessageDialog
dialog(parent
, message
, caption
, decorated_style
);
912 int ans
= dialog
.ShowModal();
925 wxFAIL_MSG( _T("unexpected return code from wxMessageDialog") );
930 #endif // wxUSE_MSGDLG
934 wxString
wxGetTextFromUser(const wxString
& message
, const wxString
& caption
,
935 const wxString
& defaultValue
, wxWindow
*parent
,
936 wxCoord x
, wxCoord y
, bool centre
)
939 long style
= wxTextEntryDialogStyle
;
946 wxTextEntryDialog
dialog(parent
, message
, caption
, defaultValue
, style
, wxPoint(x
, y
));
948 if (dialog
.ShowModal() == wxID_OK
)
950 str
= dialog
.GetValue();
956 wxString
wxGetPasswordFromUser(const wxString
& message
,
957 const wxString
& caption
,
958 const wxString
& defaultValue
,
960 wxCoord x
, wxCoord y
, bool centre
)
963 long style
= wxTextEntryDialogStyle
;
970 wxPasswordEntryDialog
dialog(parent
, message
, caption
, defaultValue
,
971 style
, wxPoint(x
, y
));
972 if ( dialog
.ShowModal() == wxID_OK
)
974 str
= dialog
.GetValue();
980 #endif // wxUSE_TEXTDLG
984 wxColour
wxGetColourFromUser(wxWindow
*parent
, const wxColour
& colInit
)
987 data
.SetChooseFull(true);
990 data
.SetColour((wxColour
&)colInit
); // const_cast
994 wxColourDialog
dialog(parent
, &data
);
995 if ( dialog
.ShowModal() == wxID_OK
)
997 colRet
= dialog
.GetColourData().GetColour();
999 //else: leave it invalid
1004 #endif // wxUSE_COLOURDLG
1008 wxFont
wxGetFontFromUser(wxWindow
*parent
, const wxFont
& fontInit
)
1011 if ( fontInit
.Ok() )
1013 data
.SetInitialFont(fontInit
);
1017 wxFontDialog
dialog(parent
, data
);
1018 if ( dialog
.ShowModal() == wxID_OK
)
1020 fontRet
= dialog
.GetFontData().GetChosenFont();
1022 //else: leave it invalid
1027 #endif // wxUSE_FONTDLG
1029 // ----------------------------------------------------------------------------
1030 // wxSafeYield and supporting functions
1031 // ----------------------------------------------------------------------------
1033 void wxEnableTopLevelWindows(bool enable
)
1035 wxWindowList::compatibility_iterator node
;
1036 for ( node
= wxTopLevelWindows
.GetFirst(); node
; node
= node
->GetNext() )
1037 node
->GetData()->Enable(enable
);
1040 wxWindowDisabler::wxWindowDisabler(wxWindow
*winToSkip
)
1042 // remember the top level windows which were already disabled, so that we
1043 // don't reenable them later
1044 m_winDisabled
= NULL
;
1046 wxWindowList::compatibility_iterator node
;
1047 for ( node
= wxTopLevelWindows
.GetFirst(); node
; node
= node
->GetNext() )
1049 wxWindow
*winTop
= node
->GetData();
1050 if ( winTop
== winToSkip
)
1053 // we don't need to disable the hidden or already disabled windows
1054 if ( winTop
->IsEnabled() && winTop
->IsShown() )
1060 if ( !m_winDisabled
)
1062 m_winDisabled
= new wxWindowList
;
1065 m_winDisabled
->Append(winTop
);
1070 wxWindowDisabler::~wxWindowDisabler()
1072 wxWindowList::compatibility_iterator node
;
1073 for ( node
= wxTopLevelWindows
.GetFirst(); node
; node
= node
->GetNext() )
1075 wxWindow
*winTop
= node
->GetData();
1076 if ( !m_winDisabled
|| !m_winDisabled
->Find(winTop
) )
1080 //else: had been already disabled, don't reenable
1083 delete m_winDisabled
;
1086 // Yield to other apps/messages and disable user input to all windows except
1088 bool wxSafeYield(wxWindow
*win
, bool onlyIfNeeded
)
1090 wxWindowDisabler
wd(win
);
1094 rc
= wxYieldIfNeeded();
1101 // Don't synthesize KeyUp events holding down a key and producing KeyDown
1102 // events with autorepeat. On by default and always on in wxMSW. wxGTK version
1105 bool wxSetDetectableAutoRepeat( bool WXUNUSED(flag
) )
1107 return true; // detectable auto-repeat is the only mode MSW supports