]> git.saurik.com Git - wxWidgets.git/blob - src/common/utilscmn.cpp
compilation fix for wxUSE_INTL=0
[wxWidgets.git] / src / common / utilscmn.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/common/utilscmn.cpp
3 // Purpose: Miscellaneous utility functions and classes
4 // Author: Julian Smart
5 // Modified by:
6 // Created: 29/01/98
7 // RCS-ID: $Id$
8 // Copyright: (c) 1998 Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 // ============================================================================
13 // declarations
14 // ============================================================================
15
16 // ----------------------------------------------------------------------------
17 // headers
18 // ----------------------------------------------------------------------------
19
20 // For compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
22
23 #ifdef __BORLANDC__
24 #pragma hdrstop
25 #endif
26
27 #ifndef WX_PRECOMP
28 #include "wx/app.h"
29 #include "wx/string.h"
30 #include "wx/utils.h"
31 #include "wx/intl.h"
32 #include "wx/log.h"
33
34 #if wxUSE_GUI
35 #include "wx/window.h"
36 #include "wx/frame.h"
37 #include "wx/menu.h"
38 #include "wx/msgdlg.h"
39 #include "wx/textdlg.h"
40 #include "wx/textctrl.h" // for wxTE_PASSWORD
41 #if wxUSE_ACCEL
42 #include "wx/menuitem.h"
43 #include "wx/accel.h"
44 #endif // wxUSE_ACCEL
45 #endif // wxUSE_GUI
46 #endif // WX_PRECOMP
47
48 #include "wx/apptrait.h"
49
50 #include "wx/process.h"
51 #include "wx/txtstrm.h"
52 #include "wx/uri.h"
53 #include "wx/mimetype.h"
54 #include "wx/config.h"
55
56 #if defined(__WXWINCE__) && wxUSE_DATETIME
57 #include "wx/datetime.h"
58 #endif
59
60 #include <ctype.h>
61 #include <stdio.h>
62 #include <stdlib.h>
63 #include <string.h>
64
65 #if !wxONLY_WATCOM_EARLIER_THAN(1,4)
66 #if !(defined(_MSC_VER) && (_MSC_VER > 800))
67 #include <errno.h>
68 #endif
69 #endif
70
71 #if wxUSE_GUI
72 #include "wx/colordlg.h"
73 #include "wx/fontdlg.h"
74 #include "wx/notebook.h"
75 #include "wx/statusbr.h"
76 #endif // wxUSE_GUI
77
78 #ifndef __WXWINCE__
79 #include <time.h>
80 #else
81 #include "wx/msw/wince/time.h"
82 #endif
83
84 #ifdef __WXMAC__
85 #include "wx/mac/private.h"
86 #ifndef __DARWIN__
87 #include "InternetConfig.h"
88 #endif
89 #endif
90
91 #if !defined(__MWERKS__) && !defined(__WXWINCE__)
92 #include <sys/types.h>
93 #include <sys/stat.h>
94 #endif
95
96 #if defined(__WXMSW__)
97 #include "wx/msw/private.h"
98 #include "wx/msw/registry.h"
99 #include <shellapi.h> // needed for SHELLEXECUTEINFO
100 #endif
101
102 #if wxUSE_BASE
103
104 // ----------------------------------------------------------------------------
105 // common data
106 // ----------------------------------------------------------------------------
107
108 // ============================================================================
109 // implementation
110 // ============================================================================
111
112 // Array used in DecToHex conversion routine.
113 static wxChar hexArray[] = wxT("0123456789ABCDEF");
114
115 // Convert 2-digit hex number to decimal
116 int wxHexToDec(const wxString& buf)
117 {
118 int firstDigit, secondDigit;
119
120 if (buf.GetChar(0) >= wxT('A'))
121 firstDigit = buf.GetChar(0) - wxT('A') + 10;
122 else
123 firstDigit = buf.GetChar(0) - wxT('0');
124
125 if (buf.GetChar(1) >= wxT('A'))
126 secondDigit = buf.GetChar(1) - wxT('A') + 10;
127 else
128 secondDigit = buf.GetChar(1) - wxT('0');
129
130 return (firstDigit & 0xF) * 16 + (secondDigit & 0xF );
131 }
132
133 // Convert decimal integer to 2-character hex string
134 void wxDecToHex(int dec, wxChar *buf)
135 {
136 int firstDigit = (int)(dec/16.0);
137 int secondDigit = (int)(dec - (firstDigit*16.0));
138 buf[0] = hexArray[firstDigit];
139 buf[1] = hexArray[secondDigit];
140 buf[2] = 0;
141 }
142
143 // Convert decimal integer to 2-character hex string
144 wxString wxDecToHex(int dec)
145 {
146 wxChar buf[3];
147 wxDecToHex(dec, buf);
148 return wxString(buf);
149 }
150
151 // ----------------------------------------------------------------------------
152 // misc functions
153 // ----------------------------------------------------------------------------
154
155 // Return the current date/time
156 wxString wxNow()
157 {
158 #ifdef __WXWINCE__
159 #if wxUSE_DATETIME
160 wxDateTime now = wxDateTime::Now();
161 return now.Format();
162 #else
163 return wxEmptyString;
164 #endif
165 #else
166 time_t now = time((time_t *) NULL);
167 char *date = ctime(&now);
168 date[24] = '\0';
169 return wxString::FromAscii(date);
170 #endif
171 }
172
173 void wxUsleep(unsigned long milliseconds)
174 {
175 wxMilliSleep(milliseconds);
176 }
177
178 const wxChar *wxGetInstallPrefix()
179 {
180 wxString prefix;
181
182 if ( wxGetEnv(wxT("WXPREFIX"), &prefix) )
183 return prefix.c_str();
184
185 #ifdef wxINSTALL_PREFIX
186 return wxT(wxINSTALL_PREFIX);
187 #else
188 return wxEmptyString;
189 #endif
190 }
191
192 wxString wxGetDataDir()
193 {
194 wxString dir = wxGetInstallPrefix();
195 dir << wxFILE_SEP_PATH << wxT("share") << wxFILE_SEP_PATH << wxT("wx");
196 return dir;
197 }
198
199 bool wxIsPlatformLittleEndian()
200 {
201 // Are we little or big endian? This method is from Harbison & Steele.
202 union
203 {
204 long l;
205 char c[sizeof(long)];
206 } u;
207 u.l = 1;
208
209 return u.c[0] == 1;
210 }
211
212
213 /*
214 * Class to make it easier to specify platform-dependent values
215 */
216
217 wxArrayInt* wxPlatform::sm_customPlatforms = NULL;
218
219 void wxPlatform::Copy(const wxPlatform& platform)
220 {
221 m_longValue = platform.m_longValue;
222 m_doubleValue = platform.m_doubleValue;
223 m_stringValue = platform.m_stringValue;
224 }
225
226 wxPlatform wxPlatform::If(int platform, long value)
227 {
228 if (Is(platform))
229 return wxPlatform(value);
230 else
231 return wxPlatform();
232 }
233
234 wxPlatform wxPlatform::IfNot(int platform, long value)
235 {
236 if (!Is(platform))
237 return wxPlatform(value);
238 else
239 return wxPlatform();
240 }
241
242 wxPlatform& wxPlatform::ElseIf(int platform, long value)
243 {
244 if (Is(platform))
245 m_longValue = value;
246 return *this;
247 }
248
249 wxPlatform& wxPlatform::ElseIfNot(int platform, long value)
250 {
251 if (!Is(platform))
252 m_longValue = value;
253 return *this;
254 }
255
256 wxPlatform wxPlatform::If(int platform, double value)
257 {
258 if (Is(platform))
259 return wxPlatform(value);
260 else
261 return wxPlatform();
262 }
263
264 wxPlatform wxPlatform::IfNot(int platform, double value)
265 {
266 if (!Is(platform))
267 return wxPlatform(value);
268 else
269 return wxPlatform();
270 }
271
272 wxPlatform& wxPlatform::ElseIf(int platform, double value)
273 {
274 if (Is(platform))
275 m_doubleValue = value;
276 return *this;
277 }
278
279 wxPlatform& wxPlatform::ElseIfNot(int platform, double value)
280 {
281 if (!Is(platform))
282 m_doubleValue = value;
283 return *this;
284 }
285
286 wxPlatform wxPlatform::If(int platform, const wxString& value)
287 {
288 if (Is(platform))
289 return wxPlatform(value);
290 else
291 return wxPlatform();
292 }
293
294 wxPlatform wxPlatform::IfNot(int platform, const wxString& value)
295 {
296 if (!Is(platform))
297 return wxPlatform(value);
298 else
299 return wxPlatform();
300 }
301
302 wxPlatform& wxPlatform::ElseIf(int platform, const wxString& value)
303 {
304 if (Is(platform))
305 m_stringValue = value;
306 return *this;
307 }
308
309 wxPlatform& wxPlatform::ElseIfNot(int platform, const wxString& value)
310 {
311 if (!Is(platform))
312 m_stringValue = value;
313 return *this;
314 }
315
316 wxPlatform& wxPlatform::Else(long value)
317 {
318 m_longValue = value;
319 return *this;
320 }
321
322 wxPlatform& wxPlatform::Else(double value)
323 {
324 m_doubleValue = value;
325 return *this;
326 }
327
328 wxPlatform& wxPlatform::Else(const wxString& value)
329 {
330 m_stringValue = value;
331 return *this;
332 }
333
334 void wxPlatform::AddPlatform(int platform)
335 {
336 if (!sm_customPlatforms)
337 sm_customPlatforms = new wxArrayInt;
338 sm_customPlatforms->Add(platform);
339 }
340
341 void wxPlatform::ClearPlatforms()
342 {
343 delete sm_customPlatforms;
344 sm_customPlatforms = NULL;
345 }
346
347 /// Function for testing current platform
348
349 bool wxPlatform::Is(int platform)
350 {
351 #ifdef __WXMSW__
352 if (platform == wxOS_WINDOWS)
353 return true;
354 #endif
355 #ifdef __WXWINCE__
356 if (platform == wxOS_WINDOWS_CE)
357 return true;
358 #endif
359
360 #if 0
361
362 // FIXME: wxWinPocketPC and wxWinSmartPhone are unknown symbols
363
364 #if defined(__WXWINCE__) && defined(__POCKETPC__)
365 if (platform == wxWinPocketPC)
366 return true;
367 #endif
368 #if defined(__WXWINCE__) && defined(__SMARTPHONE__)
369 if (platform == wxWinSmartPhone)
370 return true;
371 #endif
372
373 #endif
374
375 #ifdef __WXGTK__
376 if (platform == wxPORT_GTK)
377 return true;
378 #endif
379 #ifdef __WXMAC__
380 if (platform == wxPORT_MAC)
381 return true;
382 #endif
383 #ifdef __WXX11__
384 if (platform == wxPORT_X11)
385 return true;
386 #endif
387 #ifdef __UNIX__
388 if (platform == wxOS_UNIX)
389 return true;
390 #endif
391 #ifdef __WXMGL__
392 if (platform == wxPORT_MGL)
393 return true;
394 #endif
395 #ifdef __OS2__
396 if (platform == wxOS_OS2)
397 return true;
398 #endif
399 #ifdef __WXPM__
400 if (platform == wxPORT_PM)
401 return true;
402 #endif
403 #ifdef __WXCOCOA__
404 if (platform == wxPORT_MAC)
405 return true;
406 #endif
407
408 if (sm_customPlatforms && sm_customPlatforms->Index(platform) != wxNOT_FOUND)
409 return true;
410
411 return false;
412 }
413
414 // ----------------------------------------------------------------------------
415 // network and user id functions
416 // ----------------------------------------------------------------------------
417
418 // Get Full RFC822 style email address
419 bool wxGetEmailAddress(wxChar *address, int maxSize)
420 {
421 wxString email = wxGetEmailAddress();
422 if ( !email )
423 return false;
424
425 wxStrncpy(address, email, maxSize - 1);
426 address[maxSize - 1] = wxT('\0');
427
428 return true;
429 }
430
431 wxString wxGetEmailAddress()
432 {
433 wxString email;
434
435 wxString host = wxGetFullHostName();
436 if ( !host.empty() )
437 {
438 wxString user = wxGetUserId();
439 if ( !user.empty() )
440 {
441 email << user << wxT('@') << host;
442 }
443 }
444
445 return email;
446 }
447
448 wxString wxGetUserId()
449 {
450 static const int maxLoginLen = 256; // FIXME arbitrary number
451
452 wxString buf;
453 bool ok = wxGetUserId(wxStringBuffer(buf, maxLoginLen), maxLoginLen);
454
455 if ( !ok )
456 buf.Empty();
457
458 return buf;
459 }
460
461 wxString wxGetUserName()
462 {
463 static const int maxUserNameLen = 1024; // FIXME arbitrary number
464
465 wxString buf;
466 bool ok = wxGetUserName(wxStringBuffer(buf, maxUserNameLen), maxUserNameLen);
467
468 if ( !ok )
469 buf.Empty();
470
471 return buf;
472 }
473
474 wxString wxGetHostName()
475 {
476 static const size_t hostnameSize = 257;
477
478 wxString buf;
479 bool ok = wxGetHostName(wxStringBuffer(buf, hostnameSize), hostnameSize);
480
481 if ( !ok )
482 buf.Empty();
483
484 return buf;
485 }
486
487 wxString wxGetFullHostName()
488 {
489 static const size_t hostnameSize = 257;
490
491 wxString buf;
492 bool ok = wxGetFullHostName(wxStringBuffer(buf, hostnameSize), hostnameSize);
493
494 if ( !ok )
495 buf.Empty();
496
497 return buf;
498 }
499
500 wxString wxGetHomeDir()
501 {
502 wxString home;
503 wxGetHomeDir(&home);
504
505 return home;
506 }
507
508 #if 0
509
510 wxString wxGetCurrentDir()
511 {
512 wxString dir;
513 size_t len = 1024;
514 bool ok;
515 do
516 {
517 ok = getcwd(dir.GetWriteBuf(len + 1), len) != NULL;
518 dir.UngetWriteBuf();
519
520 if ( !ok )
521 {
522 if ( errno != ERANGE )
523 {
524 wxLogSysError(_T("Failed to get current directory"));
525
526 return wxEmptyString;
527 }
528 else
529 {
530 // buffer was too small, retry with a larger one
531 len *= 2;
532 }
533 }
534 //else: ok
535 } while ( !ok );
536
537 return dir;
538 }
539
540 #endif // 0
541
542 // ----------------------------------------------------------------------------
543 // wxExecute
544 // ----------------------------------------------------------------------------
545
546 // wxDoExecuteWithCapture() helper: reads an entire stream into one array
547 //
548 // returns true if ok, false if error
549 #if wxUSE_STREAMS
550 static bool ReadAll(wxInputStream *is, wxArrayString& output)
551 {
552 wxCHECK_MSG( is, false, _T("NULL stream in wxExecute()?") );
553
554 // the stream could be already at EOF or in wxSTREAM_BROKEN_PIPE state
555 is->Reset();
556
557 wxTextInputStream tis(*is);
558
559 for ( ;; )
560 {
561 wxString line = tis.ReadLine();
562
563 // check for EOF before other errors as it's not really an error
564 if ( is->Eof() )
565 {
566 // add the last, possibly incomplete, line
567 if ( !line.empty() )
568 output.Add(line);
569 break;
570 }
571
572 // any other error is fatal
573 if ( !*is )
574 return false;
575
576 output.Add(line);
577 }
578
579 return true;
580 }
581 #endif // wxUSE_STREAMS
582
583 // this is a private function because it hasn't a clean interface: the first
584 // array is passed by reference, the second by pointer - instead we have 2
585 // public versions of wxExecute() below
586 static long wxDoExecuteWithCapture(const wxString& command,
587 wxArrayString& output,
588 wxArrayString* error,
589 int flags)
590 {
591 // create a wxProcess which will capture the output
592 wxProcess *process = new wxProcess;
593 process->Redirect();
594
595 long rc = wxExecute(command, wxEXEC_SYNC | flags, process);
596
597 #if wxUSE_STREAMS
598 if ( rc != -1 )
599 {
600 if ( !ReadAll(process->GetInputStream(), output) )
601 rc = -1;
602
603 if ( error )
604 {
605 if ( !ReadAll(process->GetErrorStream(), *error) )
606 rc = -1;
607 }
608
609 }
610 #else
611 wxUnusedVar(output);
612 wxUnusedVar(error);
613 #endif // wxUSE_STREAMS/!wxUSE_STREAMS
614
615 delete process;
616
617 return rc;
618 }
619
620 long wxExecute(const wxString& command, wxArrayString& output, int flags)
621 {
622 return wxDoExecuteWithCapture(command, output, NULL, flags);
623 }
624
625 long wxExecute(const wxString& command,
626 wxArrayString& output,
627 wxArrayString& error,
628 int flags)
629 {
630 return wxDoExecuteWithCapture(command, output, &error, flags);
631 }
632
633 // ----------------------------------------------------------------------------
634 // Launch default browser
635 // ----------------------------------------------------------------------------
636
637 bool wxLaunchDefaultBrowser(const wxString& urlOrig, int flags)
638 {
639 wxUnusedVar(flags);
640
641 // set the scheme of url to http if it does not have one
642 // RR: This doesn't work if the url is just a local path
643 wxString url(urlOrig);
644 wxURI uri(url);
645 if ( !uri.HasScheme() )
646 url.Prepend(wxT("http://"));
647
648
649 #if defined(__WXMSW__)
650
651 #if wxUSE_IPC
652 if ( flags & wxBROWSER_NEW_WINDOW )
653 {
654 // ShellExecuteEx() opens the URL in an existing window by default so
655 // we can't use it if we need a new window
656 wxRegKey key(wxRegKey::HKCR, uri.GetScheme() + _T("\\shell\\open"));
657 if ( !key.Exists() )
658 {
659 // try default browser, it must be registered at least for http URLs
660 key.SetName(wxRegKey::HKCR, _T("http\\shell\\open"));
661 }
662
663 if ( key.Exists() )
664 {
665 wxRegKey keyDDE(key, wxT("DDEExec"));
666 if ( keyDDE.Exists() )
667 {
668 const wxString ddeTopic = wxRegKey(keyDDE, wxT("topic"));
669
670 // we only know the syntax of WWW_OpenURL DDE request for IE,
671 // optimistically assume that all other browsers are compatible
672 // with it
673 wxString ddeCmd;
674 bool ok = ddeTopic == wxT("WWW_OpenURL");
675 if ( ok )
676 {
677 ddeCmd = keyDDE.QueryDefaultValue();
678 ok = !ddeCmd.empty();
679 }
680
681 if ( ok )
682 {
683 // for WWW_OpenURL, the index of the window to open the URL
684 // in is -1 (meaning "current") by default, replace it with
685 // 0 which means "new" (see KB article 160957)
686 ok = ddeCmd.Replace(wxT("-1"), wxT("0"),
687 false /* only first occurence */) == 1;
688 }
689
690 if ( ok )
691 {
692 // and also replace the parameters: the topic should
693 // contain a placeholder for the URL
694 ok = ddeCmd.Replace(wxT("%1"), url, false) == 1;
695 }
696
697 if ( ok )
698 {
699 // try to send it the DDE request now but ignore the errors
700 wxLogNull noLog;
701
702 const wxString ddeServer = wxRegKey(keyDDE, wxT("application"));
703 if ( wxExecuteDDE(ddeServer, ddeTopic, ddeCmd) )
704 return true;
705
706 // this is not necessarily an error: maybe browser is
707 // simply not running, but no matter, in any case we're
708 // going to launch it using ShellExecuteEx() below now and
709 // we shouldn't try to open a new window if we open a new
710 // browser anyhow
711 }
712 }
713 }
714 }
715 #endif // wxUSE_IPC
716
717 WinStruct<SHELLEXECUTEINFO> sei;
718 sei.lpFile = url.c_str();
719 sei.lpVerb = _T("open");
720 sei.nShow = SW_SHOWNORMAL;
721
722 ::ShellExecuteEx(&sei);
723
724 const int nResult = (int) sei.hInstApp;
725
726 // Firefox returns file not found for some reason, so make an exception
727 // for it
728 if ( nResult > 32 || nResult == SE_ERR_FNF )
729 {
730 #ifdef __WXDEBUG__
731 // Log something if SE_ERR_FNF happens
732 if ( nResult == SE_ERR_FNF )
733 wxLogDebug(wxT("SE_ERR_FNF from ShellExecute -- maybe FireFox?"));
734 #endif // __WXDEBUG__
735 return true;
736 }
737 #elif defined(__WXMAC__)
738 OSStatus err;
739 ICInstance inst;
740 long int startSel;
741 long int endSel;
742
743 err = ICStart(&inst, 'STKA'); // put your app creator code here
744 if (err == noErr)
745 {
746 #if !TARGET_CARBON
747 err = ICFindConfigFile(inst, 0, NULL);
748 #endif
749 if (err == noErr)
750 {
751 ConstStr255Param hint = 0;
752 startSel = 0;
753 endSel = url.length();
754 err = ICLaunchURL(inst, hint, url.fn_str(), endSel, &startSel, &endSel);
755 if (err != noErr)
756 wxLogDebug(wxT("ICLaunchURL error %d"), (int) err);
757 }
758 ICStop(inst);
759 return true;
760 }
761 else
762 {
763 wxLogDebug(wxT("ICStart error %d"), (int) err);
764 return false;
765 }
766 #else
767 // (non-Mac, non-MSW)
768
769 #ifdef __UNIX__
770
771 wxString desktop = wxTheApp->GetTraits()->GetDesktopEnvironment();
772
773 // GNOME and KDE desktops have some applications which should be always installed
774 // together with their main parts, which give us the
775 if (desktop == wxT("GNOME"))
776 {
777 wxArrayString errors;
778 wxArrayString output;
779
780 // gconf will tell us the path of the application to use as browser
781 long res = wxExecute( wxT("gconftool-2 --get /desktop/gnome/applications/browser/exec"),
782 output, errors, wxEXEC_NODISABLE );
783 if (res >= 0 && errors.GetCount() == 0)
784 {
785 wxString cmd = output[0];
786 cmd << _T(' ') << url;
787 if (wxExecute(cmd))
788 return true;
789 }
790 }
791 else if (desktop == wxT("KDE"))
792 {
793 // kfmclient directly opens the given URL
794 if (wxExecute(wxT("kfmclient openURL ") + url))
795 return true;
796 }
797 #endif
798
799 bool ok = false;
800 wxString cmd;
801
802 #if wxUSE_MIMETYPE
803 wxFileType *ft = wxTheMimeTypesManager->GetFileTypeFromExtension(_T("html"));
804 if ( ft )
805 {
806 wxString mt;
807 ft->GetMimeType(&mt);
808
809 ok = ft->GetOpenCommand(&cmd, wxFileType::MessageParameters(url));
810 delete ft;
811 }
812 #endif // wxUSE_MIMETYPE
813
814 if ( !ok || cmd.empty() )
815 {
816 // fallback to checking for the BROWSER environment variable
817 cmd = wxGetenv(wxT("BROWSER"));
818 if ( !cmd.empty() )
819 cmd << _T(' ') << url;
820 }
821
822 ok = ( !cmd.empty() && wxExecute(cmd) );
823 if (ok)
824 return ok;
825
826 // no file type for HTML extension
827 wxLogError(_T("No default application configured for HTML files."));
828
829 #endif // !wxUSE_MIMETYPE && !__WXMSW__
830
831 wxLogSysError(_T("Failed to open URL \"%s\" in default browser."),
832 url.c_str());
833
834 return false;
835 }
836
837 // ----------------------------------------------------------------------------
838 // wxApp::Yield() wrappers for backwards compatibility
839 // ----------------------------------------------------------------------------
840
841 bool wxYield()
842 {
843 return wxTheApp && wxTheApp->Yield();
844 }
845
846 bool wxYieldIfNeeded()
847 {
848 return wxTheApp && wxTheApp->Yield(true);
849 }
850
851 // Id generation
852 static long wxCurrentId = 100;
853
854 long wxNewId()
855 {
856 // skip the part of IDs space that contains hard-coded values:
857 if (wxCurrentId == wxID_LOWEST)
858 wxCurrentId = wxID_HIGHEST + 1;
859
860 return wxCurrentId++;
861 }
862
863 long
864 wxGetCurrentId(void) { return wxCurrentId; }
865
866 void
867 wxRegisterId (long id)
868 {
869 if (id >= wxCurrentId)
870 wxCurrentId = id + 1;
871 }
872
873 #endif // wxUSE_BASE
874
875 // ============================================================================
876 // GUI-only functions from now on
877 // ============================================================================
878
879 #if wxUSE_GUI
880
881 // ----------------------------------------------------------------------------
882 // Menu accelerators related functions
883 // ----------------------------------------------------------------------------
884
885 wxChar *wxStripMenuCodes(const wxChar *in, wxChar *out)
886 {
887 #if wxUSE_MENUS
888 wxString s = wxMenuItem::GetLabelFromText(in);
889 #else
890 wxString str(in);
891 wxString s = wxStripMenuCodes(str);
892 #endif // wxUSE_MENUS
893 if ( out )
894 {
895 // go smash their buffer if it's not big enough - I love char * params
896 memcpy(out, s.c_str(), s.length() * sizeof(wxChar));
897 }
898 else
899 {
900 out = new wxChar[s.length() + 1];
901 wxStrcpy(out, s.c_str());
902 }
903
904 return out;
905 }
906
907 wxString wxStripMenuCodes(const wxString& in, int flags)
908 {
909 wxASSERT_MSG( flags, _T("this is useless to call without any flags") );
910
911 wxString out;
912
913 size_t len = in.length();
914 out.reserve(len);
915
916 for ( size_t n = 0; n < len; n++ )
917 {
918 wxChar ch = in[n];
919 if ( (flags & wxStrip_Mnemonics) && ch == _T('&') )
920 {
921 // skip it, it is used to introduce the accel char (or to quote
922 // itself in which case it should still be skipped): note that it
923 // can't be the last character of the string
924 if ( ++n == len )
925 {
926 wxLogDebug(_T("Invalid menu string '%s'"), in.c_str());
927 }
928 else
929 {
930 // use the next char instead
931 ch = in[n];
932 }
933 }
934 else if ( (flags & wxStrip_Accel) && ch == _T('\t') )
935 {
936 // everything after TAB is accel string, exit the loop
937 break;
938 }
939
940 out += ch;
941 }
942
943 return out;
944 }
945
946 // ----------------------------------------------------------------------------
947 // Window search functions
948 // ----------------------------------------------------------------------------
949
950 /*
951 * If parent is non-NULL, look through children for a label or title
952 * matching the specified string. If NULL, look through all top-level windows.
953 *
954 */
955
956 wxWindow *
957 wxFindWindowByLabel (const wxString& title, wxWindow * parent)
958 {
959 return wxWindow::FindWindowByLabel( title, parent );
960 }
961
962
963 /*
964 * If parent is non-NULL, look through children for a name
965 * matching the specified string. If NULL, look through all top-level windows.
966 *
967 */
968
969 wxWindow *
970 wxFindWindowByName (const wxString& name, wxWindow * parent)
971 {
972 return wxWindow::FindWindowByName( name, parent );
973 }
974
975 // Returns menu item id or wxNOT_FOUND if none.
976 int
977 wxFindMenuItemId (wxFrame * frame, const wxString& menuString, const wxString& itemString)
978 {
979 #if wxUSE_MENUS
980 wxMenuBar *menuBar = frame->GetMenuBar ();
981 if ( menuBar )
982 return menuBar->FindMenuItem (menuString, itemString);
983 #endif // wxUSE_MENUS
984
985 return wxNOT_FOUND;
986 }
987
988 // Try to find the deepest child that contains 'pt'.
989 // We go backwards, to try to allow for controls that are spacially
990 // within other controls, but are still siblings (e.g. buttons within
991 // static boxes). Static boxes are likely to be created _before_ controls
992 // that sit inside them.
993 wxWindow* wxFindWindowAtPoint(wxWindow* win, const wxPoint& pt)
994 {
995 if (!win->IsShown())
996 return NULL;
997
998 // Hack for wxNotebook case: at least in wxGTK, all pages
999 // claim to be shown, so we must only deal with the selected one.
1000 #if wxUSE_NOTEBOOK
1001 if (win->IsKindOf(CLASSINFO(wxNotebook)))
1002 {
1003 wxNotebook* nb = (wxNotebook*) win;
1004 int sel = nb->GetSelection();
1005 if (sel >= 0)
1006 {
1007 wxWindow* child = nb->GetPage(sel);
1008 wxWindow* foundWin = wxFindWindowAtPoint(child, pt);
1009 if (foundWin)
1010 return foundWin;
1011 }
1012 }
1013 #endif
1014
1015 wxWindowList::compatibility_iterator node = win->GetChildren().GetLast();
1016 while (node)
1017 {
1018 wxWindow* child = node->GetData();
1019 wxWindow* foundWin = wxFindWindowAtPoint(child, pt);
1020 if (foundWin)
1021 return foundWin;
1022 node = node->GetPrevious();
1023 }
1024
1025 wxPoint pos = win->GetPosition();
1026 wxSize sz = win->GetSize();
1027 if ( !win->IsTopLevel() && win->GetParent() )
1028 {
1029 pos = win->GetParent()->ClientToScreen(pos);
1030 }
1031
1032 wxRect rect(pos, sz);
1033 if (rect.Contains(pt))
1034 return win;
1035
1036 return NULL;
1037 }
1038
1039 wxWindow* wxGenericFindWindowAtPoint(const wxPoint& pt)
1040 {
1041 // Go backwards through the list since windows
1042 // on top are likely to have been appended most
1043 // recently.
1044 wxWindowList::compatibility_iterator node = wxTopLevelWindows.GetLast();
1045 while (node)
1046 {
1047 wxWindow* win = node->GetData();
1048 wxWindow* found = wxFindWindowAtPoint(win, pt);
1049 if (found)
1050 return found;
1051 node = node->GetPrevious();
1052 }
1053 return NULL;
1054 }
1055
1056 // ----------------------------------------------------------------------------
1057 // GUI helpers
1058 // ----------------------------------------------------------------------------
1059
1060 /*
1061 * N.B. these convenience functions must be separate from msgdlgg.cpp, textdlgg.cpp
1062 * since otherwise the generic code may be pulled in unnecessarily.
1063 */
1064
1065 #if wxUSE_MSGDLG
1066
1067 int wxMessageBox(const wxString& message, const wxString& caption, long style,
1068 wxWindow *parent, int WXUNUSED(x), int WXUNUSED(y) )
1069 {
1070 long decorated_style = style;
1071
1072 if ( ( style & ( wxICON_EXCLAMATION | wxICON_HAND | wxICON_INFORMATION | wxICON_QUESTION ) ) == 0 )
1073 {
1074 decorated_style |= ( style & wxYES ) ? wxICON_QUESTION : wxICON_INFORMATION ;
1075 }
1076
1077 wxMessageDialog dialog(parent, message, caption, decorated_style);
1078
1079 int ans = dialog.ShowModal();
1080 switch ( ans )
1081 {
1082 case wxID_OK:
1083 return wxOK;
1084 case wxID_YES:
1085 return wxYES;
1086 case wxID_NO:
1087 return wxNO;
1088 case wxID_CANCEL:
1089 return wxCANCEL;
1090 }
1091
1092 wxFAIL_MSG( _T("unexpected return code from wxMessageDialog") );
1093
1094 return wxCANCEL;
1095 }
1096
1097 #endif // wxUSE_MSGDLG
1098
1099 #if wxUSE_TEXTDLG
1100
1101 wxString wxGetTextFromUser(const wxString& message, const wxString& caption,
1102 const wxString& defaultValue, wxWindow *parent,
1103 wxCoord x, wxCoord y, bool centre )
1104 {
1105 wxString str;
1106 long style = wxTextEntryDialogStyle;
1107
1108 if (centre)
1109 style |= wxCENTRE;
1110 else
1111 style &= ~wxCENTRE;
1112
1113 wxTextEntryDialog dialog(parent, message, caption, defaultValue, style, wxPoint(x, y));
1114
1115 if (dialog.ShowModal() == wxID_OK)
1116 {
1117 str = dialog.GetValue();
1118 }
1119
1120 return str;
1121 }
1122
1123 wxString wxGetPasswordFromUser(const wxString& message,
1124 const wxString& caption,
1125 const wxString& defaultValue,
1126 wxWindow *parent,
1127 wxCoord x, wxCoord y, bool centre )
1128 {
1129 wxString str;
1130 long style = wxTextEntryDialogStyle;
1131
1132 if (centre)
1133 style |= wxCENTRE;
1134 else
1135 style &= ~wxCENTRE;
1136
1137 wxPasswordEntryDialog dialog(parent, message, caption, defaultValue,
1138 style, wxPoint(x, y));
1139 if ( dialog.ShowModal() == wxID_OK )
1140 {
1141 str = dialog.GetValue();
1142 }
1143
1144 return str;
1145 }
1146
1147 #endif // wxUSE_TEXTDLG
1148
1149 #if wxUSE_COLOURDLG
1150
1151 wxColour wxGetColourFromUser(wxWindow *parent, const wxColour& colInit, const wxString& caption)
1152 {
1153 wxColourData data;
1154 data.SetChooseFull(true);
1155 if ( colInit.Ok() )
1156 {
1157 data.SetColour((wxColour &)colInit); // const_cast
1158 }
1159
1160 wxColour colRet;
1161 wxColourDialog dialog(parent, &data);
1162 if (!caption.empty())
1163 dialog.SetTitle(caption);
1164 if ( dialog.ShowModal() == wxID_OK )
1165 {
1166 colRet = dialog.GetColourData().GetColour();
1167 }
1168 //else: leave it invalid
1169
1170 return colRet;
1171 }
1172
1173 #endif // wxUSE_COLOURDLG
1174
1175 #if wxUSE_FONTDLG
1176
1177 wxFont wxGetFontFromUser(wxWindow *parent, const wxFont& fontInit, const wxString& caption)
1178 {
1179 wxFontData data;
1180 if ( fontInit.Ok() )
1181 {
1182 data.SetInitialFont(fontInit);
1183 }
1184
1185 wxFont fontRet;
1186 wxFontDialog dialog(parent, data);
1187 if (!caption.empty())
1188 dialog.SetTitle(caption);
1189 if ( dialog.ShowModal() == wxID_OK )
1190 {
1191 fontRet = dialog.GetFontData().GetChosenFont();
1192 }
1193 //else: leave it invalid
1194
1195 return fontRet;
1196 }
1197
1198 #endif // wxUSE_FONTDLG
1199
1200 // ----------------------------------------------------------------------------
1201 // wxSafeYield and supporting functions
1202 // ----------------------------------------------------------------------------
1203
1204 void wxEnableTopLevelWindows(bool enable)
1205 {
1206 wxWindowList::compatibility_iterator node;
1207 for ( node = wxTopLevelWindows.GetFirst(); node; node = node->GetNext() )
1208 node->GetData()->Enable(enable);
1209 }
1210
1211 wxWindowDisabler::wxWindowDisabler(wxWindow *winToSkip)
1212 {
1213 // remember the top level windows which were already disabled, so that we
1214 // don't reenable them later
1215 m_winDisabled = NULL;
1216
1217 wxWindowList::compatibility_iterator node;
1218 for ( node = wxTopLevelWindows.GetFirst(); node; node = node->GetNext() )
1219 {
1220 wxWindow *winTop = node->GetData();
1221 if ( winTop == winToSkip )
1222 continue;
1223
1224 // we don't need to disable the hidden or already disabled windows
1225 if ( winTop->IsEnabled() && winTop->IsShown() )
1226 {
1227 winTop->Disable();
1228 }
1229 else
1230 {
1231 if ( !m_winDisabled )
1232 {
1233 m_winDisabled = new wxWindowList;
1234 }
1235
1236 m_winDisabled->Append(winTop);
1237 }
1238 }
1239 }
1240
1241 wxWindowDisabler::~wxWindowDisabler()
1242 {
1243 wxWindowList::compatibility_iterator node;
1244 for ( node = wxTopLevelWindows.GetFirst(); node; node = node->GetNext() )
1245 {
1246 wxWindow *winTop = node->GetData();
1247 if ( !m_winDisabled || !m_winDisabled->Find(winTop) )
1248 {
1249 winTop->Enable();
1250 }
1251 //else: had been already disabled, don't reenable
1252 }
1253
1254 delete m_winDisabled;
1255 }
1256
1257 // Yield to other apps/messages and disable user input to all windows except
1258 // the given one
1259 bool wxSafeYield(wxWindow *win, bool onlyIfNeeded)
1260 {
1261 wxWindowDisabler wd(win);
1262
1263 bool rc;
1264 if (onlyIfNeeded)
1265 rc = wxYieldIfNeeded();
1266 else
1267 rc = wxYield();
1268
1269 return rc;
1270 }
1271
1272 // Don't synthesize KeyUp events holding down a key and producing KeyDown
1273 // events with autorepeat. On by default and always on in wxMSW. wxGTK version
1274 // in utilsgtk.cpp.
1275 #ifndef __WXGTK__
1276 bool wxSetDetectableAutoRepeat( bool WXUNUSED(flag) )
1277 {
1278 return true; // detectable auto-repeat is the only mode MSW supports
1279 }
1280 #endif // !wxGTK
1281
1282 #endif // wxUSE_GUI