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