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 !defined(__WATCOMC__)
  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/frame.h"
  76     #include "wx/statusbr.h"
  77 #endif // wxUSE_GUI
  78
  79 #ifndef __WXWINCE__
  80 #include <time.h>
  81 #else
  82 #include "wx/msw/wince/time.h"
  83 #endif
  84
  85 #if !defined(__MWERKS__) && !defined(__WXWINCE__)
  86     #include <sys/types.h>
  87     #include <sys/stat.h>
  88 #endif
  89
  90 #if defined(__WXMSW__)
  91     #include "wx/msw/private.h"
  92     #include "wx/msw/registry.h"
  93 #endif
  94
  95 #if wxUSE_BASE
  96
  97 // ----------------------------------------------------------------------------
  98 // common data
  99 // ----------------------------------------------------------------------------
 100
 101 // ============================================================================
 102 // implementation
 103 // ============================================================================
 104
 105 #if WXWIN_COMPATIBILITY_2_4
 106
 107 wxChar *
 108 copystring (const wxChar *s)
 109 {
 110     if (s == NULL) s = wxEmptyString;
 111     size_t len = wxStrlen (s) + 1;
 112
 113     wxChar *news = new wxChar[len];
 114     memcpy (news, s, len * sizeof(wxChar));    // Should be the fastest
 115
 116     return news;
 117 }
 118
 119 #endif // WXWIN_COMPATIBILITY_2_4
 120
 121 // ----------------------------------------------------------------------------
 122 // String <-> Number conversions (deprecated)
 123 // ----------------------------------------------------------------------------
 124
 125 #if WXWIN_COMPATIBILITY_2_4
 126
 127 WXDLLIMPEXP_DATA_BASE(const wxChar *) wxFloatToStringStr = wxT("%.2f");
 128 WXDLLIMPEXP_DATA_BASE(const wxChar *) wxDoubleToStringStr = wxT("%.2f");
 129
 130 void
 131 StringToFloat (const wxChar *s, float *number)
 132 {
 133     if (s && *s && number)
 134         *number = (float) wxStrtod (s, (wxChar **) NULL);
 135 }
 136
 137 void
 138 StringToDouble (const wxChar *s, double *number)
 139 {
 140     if (s && *s && number)
 141         *number = wxStrtod (s, (wxChar **) NULL);
 142 }
 143
 144 wxChar *
 145 FloatToString (float number, const wxChar *fmt)
 146 {
 147     static wxChar buf[256];
 148
 149     wxSprintf (buf, fmt, number);
 150     return buf;
 151 }
 152
 153 wxChar *
 154 DoubleToString (double number, const wxChar *fmt)
 155 {
 156     static wxChar buf[256];
 157
 158     wxSprintf (buf, fmt, number);
 159     return buf;
 160 }
 161
 162 void
 163 StringToInt (const wxChar *s, int *number)
 164 {
 165     if (s && *s && number)
 166         *number = (int) wxStrtol (s, (wxChar **) NULL, 10);
 167 }
 168
 169 void
 170 StringToLong (const wxChar *s, long *number)
 171 {
 172     if (s && *s && number)
 173         *number = wxStrtol (s, (wxChar **) NULL, 10);
 174 }
 175
 176 wxChar *
 177 IntToString (int number)
 178 {
 179     static wxChar buf[20];
 180
 181     wxSprintf (buf, wxT("%d"), number);
 182     return buf;
 183 }
 184
 185 wxChar *
 186 LongToString (long number)
 187 {
 188     static wxChar buf[20];
 189
 190     wxSprintf (buf, wxT("%ld"), number);
 191     return buf;
 192 }
 193
 194 #endif // WXWIN_COMPATIBILITY_2_4
 195
 196 // Array used in DecToHex conversion routine.
 197 static wxChar hexArray[] = wxT("0123456789ABCDEF");
 198
 199 // Convert 2-digit hex number to decimal
 200 int wxHexToDec(const wxString& buf)
 201 {
 202     int firstDigit, secondDigit;
 203
 204     if (buf.GetChar(0) >= wxT('A'))
 205         firstDigit = buf.GetChar(0) - wxT('A') + 10;
 206     else
 207        firstDigit = buf.GetChar(0) - wxT('0');
 208
 209     if (buf.GetChar(1) >= wxT('A'))
 210         secondDigit = buf.GetChar(1) - wxT('A') + 10;
 211     else
 212         secondDigit = buf.GetChar(1) - wxT('0');
 213
 214     return (firstDigit & 0xF) * 16 + (secondDigit & 0xF );
 215 }
 216
 217 // Convert decimal integer to 2-character hex string
 218 void wxDecToHex(int dec, wxChar *buf)
 219 {
 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];
 224     buf[2] = 0;
 225 }
 226
 227 // Convert decimal integer to 2-character hex string
 228 wxString wxDecToHex(int dec)
 229 {
 230     wxChar buf[3];
 231     wxDecToHex(dec, buf);
 232     return wxString(buf);
 233 }
 234
 235 // ----------------------------------------------------------------------------
 236 // misc functions
 237 // ----------------------------------------------------------------------------
 238
 239 // Return the current date/time
 240 wxString wxNow()
 241 {
 242 #ifdef __WXWINCE__
 243 #if wxUSE_DATETIME
 244     wxDateTime now = wxDateTime::Now();
 245     return now.Format();
 246 #else
 247     return wxEmptyString;
 248 #endif
 249 #else
 250     time_t now = time((time_t *) NULL);
 251     char *date = ctime(&now);
 252     date[24] = '\0';
 253     return wxString::FromAscii(date);
 254 #endif
 255 }
 256
 257 void wxUsleep(unsigned long milliseconds)
 258 {
 259     wxMilliSleep(milliseconds);
 260 }
 261
 262 const wxChar *wxGetInstallPrefix()
 263 {
 264     wxString prefix;
 265
 266     if ( wxGetEnv(wxT("WXPREFIX"), &prefix) )
 267         return prefix.c_str();
 268
 269 #ifdef wxINSTALL_PREFIX
 270     return wxT(wxINSTALL_PREFIX);
 271 #else
 272     return wxEmptyString;
 273 #endif
 274 }
 275
 276 wxString wxGetDataDir()
 277 {
 278     wxString dir = wxGetInstallPrefix();
 279     dir <<  wxFILE_SEP_PATH << wxT("share") << wxFILE_SEP_PATH << wxT("wx");
 280     return dir;
 281 }
 282
 283 int wxGetOsVersion(int *verMaj, int *verMin)
 284 {
 285     // we want this function to work even if there is no wxApp
 286     wxConsoleAppTraits traitsConsole;
 287     wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL;
 288     if ( ! traits )
 289         traits = &traitsConsole;
 290
 291     wxToolkitInfo& info = traits->GetToolkitInfo();
 292     if ( verMaj )
 293         *verMaj = info.versionMajor;
 294     if ( verMin )
 295         *verMin = info.versionMinor;
 296     return info.os;
 297 }
 298
 299 // ----------------------------------------------------------------------------
 300 // network and user id functions
 301 // ----------------------------------------------------------------------------
 302
 303 // Get Full RFC822 style email address
 304 bool wxGetEmailAddress(wxChar *address, int maxSize)
 305 {
 306     wxString email = wxGetEmailAddress();
 307     if ( !email )
 308         return false;
 309
 310     wxStrncpy(address, email, maxSize - 1);
 311     address[maxSize - 1] = wxT('\0');
 312
 313     return true;
 314 }
 315
 316 wxString wxGetEmailAddress()
 317 {
 318     wxString email;
 319
 320     wxString host = wxGetFullHostName();
 321     if ( !host.empty() )
 322     {
 323         wxString user = wxGetUserId();
 324         if ( !user.empty() )
 325         {
 326             email << user << wxT('@') << host;
 327         }
 328     }
 329
 330     return email;
 331 }
 332
 333 wxString wxGetUserId()
 334 {
 335     static const int maxLoginLen = 256; // FIXME arbitrary number
 336
 337     wxString buf;
 338     bool ok = wxGetUserId(wxStringBuffer(buf, maxLoginLen), maxLoginLen);
 339
 340     if ( !ok )
 341         buf.Empty();
 342
 343     return buf;
 344 }
 345
 346 wxString wxGetUserName()
 347 {
 348     static const int maxUserNameLen = 1024; // FIXME arbitrary number
 349
 350     wxString buf;
 351     bool ok = wxGetUserName(wxStringBuffer(buf, maxUserNameLen), maxUserNameLen);
 352
 353     if ( !ok )
 354         buf.Empty();
 355
 356     return buf;
 357 }
 358
 359 wxString wxGetHostName()
 360 {
 361     static const size_t hostnameSize = 257;
 362
 363     wxString buf;
 364     bool ok = wxGetHostName(wxStringBuffer(buf, hostnameSize), hostnameSize);
 365
 366     if ( !ok )
 367         buf.Empty();
 368
 369     return buf;
 370 }
 371
 372 wxString wxGetFullHostName()
 373 {
 374     static const size_t hostnameSize = 257;
 375
 376     wxString buf;
 377     bool ok = wxGetFullHostName(wxStringBuffer(buf, hostnameSize), hostnameSize);
 378
 379     if ( !ok )
 380         buf.Empty();
 381
 382     return buf;
 383 }
 384
 385 wxString wxGetHomeDir()
 386 {
 387     wxString home;
 388     wxGetHomeDir(&home);
 389
 390     return home;
 391 }
 392
 393 #if 0
 394
 395 wxString wxGetCurrentDir()
 396 {
 397     wxString dir;
 398     size_t len = 1024;
 399     bool ok;
 400     do
 401     {
 402         ok = getcwd(dir.GetWriteBuf(len + 1), len) != NULL;
 403         dir.UngetWriteBuf();
 404
 405         if ( !ok )
 406         {
 407             if ( errno != ERANGE )
 408             {
 409                 wxLogSysError(_T("Failed to get current directory"));
 410
 411                 return wxEmptyString;
 412             }
 413             else
 414             {
 415                 // buffer was too small, retry with a larger one
 416                 len *= 2;
 417             }
 418         }
 419         //else: ok
 420     } while ( !ok );
 421
 422     return dir;
 423 }
 424
 425 #endif // 0
 426
 427 // ----------------------------------------------------------------------------
 428 // wxExecute
 429 // ----------------------------------------------------------------------------
 430
 431 // wxDoExecuteWithCapture() helper: reads an entire stream into one array
 432 //
 433 // returns true if ok, false if error
 434 #if wxUSE_STREAMS
 435 static bool ReadAll(wxInputStream *is, wxArrayString& output)
 436 {
 437     wxCHECK_MSG( is, false, _T("NULL stream in wxExecute()?") );
 438
 439     // the stream could be already at EOF or in wxSTREAM_BROKEN_PIPE state
 440     is->Reset();
 441
 442     wxTextInputStream tis(*is);
 443
 444     bool cont = true;
 445     while ( cont )
 446     {
 447         wxString line = tis.ReadLine();
 448         if ( is->Eof() )
 449             break;
 450
 451         if ( !*is )
 452         {
 453             cont = false;
 454         }
 455         else
 456         {
 457             output.Add(line);
 458         }
 459     }
 460
 461     return cont;
 462 }
 463 #endif // wxUSE_STREAMS
 464
 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,
 471                                    int flags)
 472 {
 473     // create a wxProcess which will capture the output
 474     wxProcess *process = new wxProcess;
 475     process->Redirect();
 476
 477     long rc = wxExecute(command, wxEXEC_SYNC | flags, process);
 478
 479 #if wxUSE_STREAMS
 480     if ( rc != -1 )
 481     {
 482         if ( !ReadAll(process->GetInputStream(), output) )
 483             rc = -1;
 484
 485         if ( error )
 486         {
 487             if ( !ReadAll(process->GetErrorStream(), *error) )
 488                 rc = -1;
 489         }
 490
 491     }
 492 #else
 493     wxUnusedVar(output);
 494     wxUnusedVar(error);
 495 #endif // wxUSE_STREAMS/!wxUSE_STREAMS
 496
 497     delete process;
 498
 499     return rc;
 500 }
 501
 502 long wxExecute(const wxString& command, wxArrayString& output, int flags)
 503 {
 504     return wxDoExecuteWithCapture(command, output, NULL, flags);
 505 }
 506
 507 long wxExecute(const wxString& command,
 508                wxArrayString& output,
 509                wxArrayString& error,
 510                int flags)
 511 {
 512     return wxDoExecuteWithCapture(command, output, &error, flags);
 513 }
 514
 515 // ----------------------------------------------------------------------------
 516 // Launch default browser
 517 // ----------------------------------------------------------------------------
 518
 519 bool wxLaunchDefaultBrowser(const wxString& urlOrig, int flags)
 520 {
 521     wxUnusedVar(flags);
 522
 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://"));
 527
 528 #if defined(__WXMSW__)
 529
 530 #if wxUSE_IPC
 531     if ( flags & wxBROWSER_NEW_WINDOW )
 532     {
 533         // ShellExecuteEx() opens the URL in an existing window by default so
 534         // we can't use it if we need a new window
 535         wxRegKey key(wxRegKey::HKCR, url.BeforeFirst(':') + _T("\\shell\\open"));
 536         if ( key.Exists() )
 537         {
 538             wxRegKey keyDDE(key, wxT("DDEExec"));
 539             if ( keyDDE.Exists() )
 540             {
 541                 const wxString ddeTopic = wxRegKey(keyDDE, wxT("topic"));
 542
 543                 // we only know the syntax of WWW_OpenURL DDE request for IE,
 544                 // optimistically assume that all other browsers are compatible
 545                 // with it
 546                 wxString ddeCmd;
 547                 bool ok = ddeTopic == wxT("WWW_OpenURL");
 548                 if ( ok )
 549                 {
 550                     ddeCmd = keyDDE.QueryDefaultValue();
 551                     ok = !ddeCmd.empty();
 552                 }
 553
 554                 if ( ok )
 555                 {
 556                     // for WWW_OpenURL, the index of the window to open the URL
 557                     // in is -1 (meaning "current") by default, replace it with
 558                     // 0 which means "new" (see KB article 160957)
 559                     ok = ddeCmd.Replace(wxT("-1"), wxT("0"),
 560                                         false /* only first occurence */) == 1;
 561                 }
 562
 563                 if ( ok )
 564                 {
 565                     // and also replace the parameters: the topic should
 566                     // contain a placeholder for the URL
 567                     ok = ddeCmd.Replace(wxT("%1"), url, false) == 1;
 568                 }
 569
 570                 if ( ok )
 571                 {
 572                     // try to send it the DDE request now but ignore the errors
 573                     wxLogNull noLog;
 574
 575                     const wxString ddeServer = wxRegKey(keyDDE, wxT("application"));
 576                     if ( wxExecuteDDE(ddeServer, ddeTopic, ddeCmd) )
 577                         return true;
 578
 579                     // this is not necessarily an error: maybe browser is
 580                     // simply not running, but no matter, in any case we're
 581                     // going to launch it using ShellExecuteEx() below now and
 582                     // we shouldn't try to open a new window if we open a new
 583                     // browser anyhow
 584                 }
 585             }
 586         }
 587     }
 588 #endif // wxUSE_IPC
 589
 590     WinStruct<SHELLEXECUTEINFO> sei;
 591     sei.lpFile = url.c_str();
 592     sei.lpVerb = _T("open");
 593     sei.nShow = SW_SHOWNORMAL;
 594
 595     ::ShellExecuteEx(&sei);
 596
 597     const int nResult = (int) sei.hInstApp;
 598
 599     // Firefox returns file not found for some reason, so make an exception
 600     // for it
 601     if ( nResult > 32 || nResult == SE_ERR_FNF )
 602     {
 603 #ifdef __WXDEBUG__
 604         // Log something if SE_ERR_FNF happens
 605         if ( nResult == SE_ERR_FNF )
 606             wxLogDebug(wxT("SE_ERR_FNF from ShellExecute -- maybe FireFox?"));
 607 #endif // __WXDEBUG__
 608         return true;
 609     }
 610 #elif wxUSE_MIMETYPE
 611     // Non-windows way
 612     wxFileType *ft = wxTheMimeTypesManager->GetFileTypeFromExtension (_T("html"));
 613     if ( ft )
 614     {
 615         wxString mt;
 616         ft->GetMimeType(&mt);
 617
 618         wxString cmd;
 619         bool ok = ft->GetOpenCommand(&cmd, wxFileType::MessageParameters(url));
 620         delete ft;
 621
 622         if ( !ok || cmd.empty() )
 623         {
 624             // fallback to checking for the BROWSER environment variable
 625             cmd = wxGetenv(wxT("BROWSER"));
 626             if ( !cmd.empty() )
 627                 cmd << _T(' ') << url;
 628         }
 629
 630         if ( !cmd.empty() && wxExecute(cmd) )
 631             return true;
 632     }
 633     else // no file type for html extension
 634     {
 635         wxLogError(_T("No default application configured for HTML files."));
 636     }
 637 #endif // !wxUSE_MIMETYPE && !__WXMSW__
 638
 639     wxLogSysError(_T("Failed to open URL \"%s\" in default browser."),
 640                   url.c_str());
 641
 642     return false;
 643 }
 644
 645 // ----------------------------------------------------------------------------
 646 // wxApp::Yield() wrappers for backwards compatibility
 647 // ----------------------------------------------------------------------------
 648
 649 bool wxYield()
 650 {
 651     return wxTheApp && wxTheApp->Yield();
 652 }
 653
 654 bool wxYieldIfNeeded()
 655 {
 656     return wxTheApp && wxTheApp->Yield(true);
 657 }
 658
 659 #endif // wxUSE_BASE
 660
 661 // ============================================================================
 662 // GUI-only functions from now on
 663 // ============================================================================
 664
 665 #if wxUSE_GUI
 666
 667 // Id generation
 668 static long wxCurrentId = 100;
 669
 670 long wxNewId()
 671 {
 672     // skip the part of IDs space that contains hard-coded values:
 673     if (wxCurrentId == wxID_LOWEST)
 674         wxCurrentId = wxID_HIGHEST + 1;
 675
 676     return wxCurrentId++;
 677 }
 678
 679 long
 680 wxGetCurrentId(void) { return wxCurrentId; }
 681
 682 void
 683 wxRegisterId (long id)
 684 {
 685   if (id >= wxCurrentId)
 686     wxCurrentId = id + 1;
 687 }
 688
 689 #if wxUSE_MENUS
 690
 691 // ----------------------------------------------------------------------------
 692 // Menu accelerators related functions
 693 // ----------------------------------------------------------------------------
 694
 695 wxChar *wxStripMenuCodes(const wxChar *in, wxChar *out)
 696 {
 697     wxString s = wxMenuItem::GetLabelFromText(in);
 698     if ( out )
 699     {
 700         // go smash their buffer if it's not big enough - I love char * params
 701         memcpy(out, s.c_str(), s.length() * sizeof(wxChar));
 702     }
 703     else
 704     {
 705         // MYcopystring - for easier search...
 706         out = new wxChar[s.length() + 1];
 707         wxStrcpy(out, s.c_str());
 708     }
 709
 710     return out;
 711 }
 712
 713 wxString wxStripMenuCodes(const wxString& in)
 714 {
 715     wxString out;
 716
 717     size_t len = in.length();
 718     out.reserve(len);
 719
 720     for ( size_t n = 0; n < len; n++ )
 721     {
 722         wxChar ch = in[n];
 723         if ( ch == _T('&') )
 724         {
 725             // skip it, it is used to introduce the accel char (or to quote
 726             // itself in which case it should still be skipped): note that it
 727             // can't be the last character of the string
 728             if ( ++n == len )
 729             {
 730                 wxLogDebug(_T("Invalid menu string '%s'"), in.c_str());
 731             }
 732             else
 733             {
 734                 // use the next char instead
 735                 ch = in[n];
 736             }
 737         }
 738         else if ( ch == _T('\t') )
 739         {
 740             // everything after TAB is accel string, exit the loop
 741             break;
 742         }
 743
 744         out += ch;
 745     }
 746
 747     return out;
 748 }
 749
 750 #endif // wxUSE_MENUS
 751
 752 // ----------------------------------------------------------------------------
 753 // Window search functions
 754 // ----------------------------------------------------------------------------
 755
 756 /*
 757  * If parent is non-NULL, look through children for a label or title
 758  * matching the specified string. If NULL, look through all top-level windows.
 759  *
 760  */
 761
 762 wxWindow *
 763 wxFindWindowByLabel (const wxString& title, wxWindow * parent)
 764 {
 765     return wxWindow::FindWindowByLabel( title, parent );
 766 }
 767
 768
 769 /*
 770  * If parent is non-NULL, look through children for a name
 771  * matching the specified string. If NULL, look through all top-level windows.
 772  *
 773  */
 774
 775 wxWindow *
 776 wxFindWindowByName (const wxString& name, wxWindow * parent)
 777 {
 778     return wxWindow::FindWindowByName( name, parent );
 779 }
 780
 781 // Returns menu item id or wxNOT_FOUND if none.
 782 int
 783 wxFindMenuItemId (wxFrame * frame, const wxString& menuString, const wxString& itemString)
 784 {
 785 #if wxUSE_MENUS
 786   wxMenuBar *menuBar = frame->GetMenuBar ();
 787   if ( menuBar )
 788       return menuBar->FindMenuItem (menuString, itemString);
 789 #endif // wxUSE_MENUS
 790
 791   return wxNOT_FOUND;
 792 }
 793
 794 // Try to find the deepest child that contains 'pt'.
 795 // We go backwards, to try to allow for controls that are spacially
 796 // within other controls, but are still siblings (e.g. buttons within
 797 // static boxes). Static boxes are likely to be created _before_ controls
 798 // that sit inside them.
 799 wxWindow* wxFindWindowAtPoint(wxWindow* win, const wxPoint& pt)
 800 {
 801     if (!win->IsShown())
 802         return NULL;
 803
 804     // Hack for wxNotebook case: at least in wxGTK, all pages
 805     // claim to be shown, so we must only deal with the selected one.
 806 #if wxUSE_NOTEBOOK
 807     if (win->IsKindOf(CLASSINFO(wxNotebook)))
 808     {
 809       wxNotebook* nb = (wxNotebook*) win;
 810       int sel = nb->GetSelection();
 811       if (sel >= 0)
 812       {
 813         wxWindow* child = nb->GetPage(sel);
 814         wxWindow* foundWin = wxFindWindowAtPoint(child, pt);
 815         if (foundWin)
 816            return foundWin;
 817       }
 818     }
 819 #endif
 820
 821     wxWindowList::compatibility_iterator node = win->GetChildren().GetLast();
 822     while (node)
 823     {
 824         wxWindow* child = node->GetData();
 825         wxWindow* foundWin = wxFindWindowAtPoint(child, pt);
 826         if (foundWin)
 827           return foundWin;
 828         node = node->GetPrevious();
 829     }
 830
 831     wxPoint pos = win->GetPosition();
 832     wxSize sz = win->GetSize();
 833     if (win->GetParent())
 834     {
 835         pos = win->GetParent()->ClientToScreen(pos);
 836     }
 837
 838     wxRect rect(pos, sz);
 839     if (rect.Inside(pt))
 840         return win;
 841     else
 842         return NULL;
 843 }
 844
 845 wxWindow* wxGenericFindWindowAtPoint(const wxPoint& pt)
 846 {
 847     // Go backwards through the list since windows
 848     // on top are likely to have been appended most
 849     // recently.
 850     wxWindowList::compatibility_iterator node = wxTopLevelWindows.GetLast();
 851     while (node)
 852     {
 853         wxWindow* win = node->GetData();
 854         wxWindow* found = wxFindWindowAtPoint(win, pt);
 855         if (found)
 856             return found;
 857         node = node->GetPrevious();
 858     }
 859     return NULL;
 860 }
 861
 862 // ----------------------------------------------------------------------------
 863 // GUI helpers
 864 // ----------------------------------------------------------------------------
 865
 866 /*
 867  * N.B. these convenience functions must be separate from msgdlgg.cpp, textdlgg.cpp
 868  * since otherwise the generic code may be pulled in unnecessarily.
 869  */
 870
 871 #if wxUSE_MSGDLG
 872
 873 int wxMessageBox(const wxString& message, const wxString& caption, long style,
 874                  wxWindow *parent, int WXUNUSED(x), int WXUNUSED(y) )
 875 {
 876     long decorated_style = style;
 877
 878     if ( ( style & ( wxICON_EXCLAMATION | wxICON_HAND | wxICON_INFORMATION | wxICON_QUESTION ) ) == 0 )
 879     {
 880         decorated_style |= ( style & wxYES ) ? wxICON_QUESTION : wxICON_INFORMATION ;
 881     }
 882
 883     wxMessageDialog dialog(parent, message, caption, decorated_style);
 884
 885     int ans = dialog.ShowModal();
 886     switch ( ans )
 887     {
 888         case wxID_OK:
 889             return wxOK;
 890         case wxID_YES:
 891             return wxYES;
 892         case wxID_NO:
 893             return wxNO;
 894         case wxID_CANCEL:
 895             return wxCANCEL;
 896     }
 897
 898     wxFAIL_MSG( _T("unexpected return code from wxMessageDialog") );
 899
 900     return wxCANCEL;
 901 }
 902
 903 #endif // wxUSE_MSGDLG
 904
 905 #if wxUSE_TEXTDLG
 906
 907 wxString wxGetTextFromUser(const wxString& message, const wxString& caption,
 908                         const wxString& defaultValue, wxWindow *parent,
 909                         wxCoord x, wxCoord y, bool centre )
 910 {
 911     wxString str;
 912     long style = wxTextEntryDialogStyle;
 913
 914     if (centre)
 915         style |= wxCENTRE;
 916     else
 917         style &= ~wxCENTRE;
 918
 919     wxTextEntryDialog dialog(parent, message, caption, defaultValue, style, wxPoint(x, y));
 920
 921     if (dialog.ShowModal() == wxID_OK)
 922     {
 923         str = dialog.GetValue();
 924     }
 925
 926     return str;
 927 }
 928
 929 wxString wxGetPasswordFromUser(const wxString& message,
 930                                const wxString& caption,
 931                                const wxString& defaultValue,
 932                                wxWindow *parent,
 933                                wxCoord x, wxCoord y, bool centre )
 934 {
 935     wxString str;
 936     long style = wxTextEntryDialogStyle;
 937
 938     if (centre)
 939         style |= wxCENTRE;
 940     else
 941         style &= ~wxCENTRE;
 942
 943     wxPasswordEntryDialog dialog(parent, message, caption, defaultValue,
 944                              style, wxPoint(x, y));
 945     if ( dialog.ShowModal() == wxID_OK )
 946     {
 947         str = dialog.GetValue();
 948     }
 949
 950     return str;
 951 }
 952
 953 #endif // wxUSE_TEXTDLG
 954
 955 #if wxUSE_COLOURDLG
 956
 957 wxColour wxGetColourFromUser(wxWindow *parent, const wxColour& colInit)
 958 {
 959     wxColourData data;
 960     data.SetChooseFull(true);
 961     if ( colInit.Ok() )
 962     {
 963         data.SetColour((wxColour &)colInit); // const_cast
 964     }
 965
 966     wxColour colRet;
 967     wxColourDialog dialog(parent, &data);
 968     if ( dialog.ShowModal() == wxID_OK )
 969     {
 970         colRet = dialog.GetColourData().GetColour();
 971     }
 972     //else: leave it invalid
 973
 974     return colRet;
 975 }
 976
 977 #endif // wxUSE_COLOURDLG
 978
 979 #if wxUSE_FONTDLG
 980
 981 wxFont wxGetFontFromUser(wxWindow *parent, const wxFont& fontInit)
 982 {
 983     wxFontData data;
 984     if ( fontInit.Ok() )
 985     {
 986         data.SetInitialFont(fontInit);
 987     }
 988
 989     wxFont fontRet;
 990     wxFontDialog dialog(parent, data);
 991     if ( dialog.ShowModal() == wxID_OK )
 992     {
 993         fontRet = dialog.GetFontData().GetChosenFont();
 994     }
 995     //else: leave it invalid
 996
 997     return fontRet;
 998 }
 999
1000 #endif // wxUSE_FONTDLG
1001
1002 // ----------------------------------------------------------------------------
1003 // wxSafeYield and supporting functions
1004 // ----------------------------------------------------------------------------
1005
1006 void wxEnableTopLevelWindows(bool enable)
1007 {
1008     wxWindowList::compatibility_iterator node;
1009     for ( node = wxTopLevelWindows.GetFirst(); node; node = node->GetNext() )
1010         node->GetData()->Enable(enable);
1011 }
1012
1013 wxWindowDisabler::wxWindowDisabler(wxWindow *winToSkip)
1014 {
1015     // remember the top level windows which were already disabled, so that we
1016     // don't reenable them later
1017     m_winDisabled = NULL;
1018
1019     wxWindowList::compatibility_iterator node;
1020     for ( node = wxTopLevelWindows.GetFirst(); node; node = node->GetNext() )
1021     {
1022         wxWindow *winTop = node->GetData();
1023         if ( winTop == winToSkip )
1024             continue;
1025
1026         // we don't need to disable the hidden or already disabled windows
1027         if ( winTop->IsEnabled() && winTop->IsShown() )
1028         {
1029             winTop->Disable();
1030         }
1031         else
1032         {
1033             if ( !m_winDisabled )
1034             {
1035                 m_winDisabled = new wxWindowList;
1036             }
1037
1038             m_winDisabled->Append(winTop);
1039         }
1040     }
1041 }
1042
1043 wxWindowDisabler::~wxWindowDisabler()
1044 {
1045     wxWindowList::compatibility_iterator node;
1046     for ( node = wxTopLevelWindows.GetFirst(); node; node = node->GetNext() )
1047     {
1048         wxWindow *winTop = node->GetData();
1049         if ( !m_winDisabled || !m_winDisabled->Find(winTop) )
1050         {
1051             winTop->Enable();
1052         }
1053         //else: had been already disabled, don't reenable
1054     }
1055
1056     delete m_winDisabled;
1057 }
1058
1059 // Yield to other apps/messages and disable user input to all windows except
1060 // the given one
1061 bool wxSafeYield(wxWindow *win, bool onlyIfNeeded)
1062 {
1063     wxWindowDisabler wd(win);
1064
1065     bool rc;
1066     if (onlyIfNeeded)
1067         rc = wxYieldIfNeeded();
1068     else
1069         rc = wxYield();
1070
1071     return rc;
1072 }
1073
1074 // Don't synthesize KeyUp events holding down a key and producing KeyDown
1075 // events with autorepeat. On by default and always on in wxMSW. wxGTK version
1076 // in utilsgtk.cpp.
1077 #ifndef __WXGTK__
1078 bool wxSetDetectableAutoRepeat( bool WXUNUSED(flag) )
1079 {
1080     return true;    // detectable auto-repeat is the only mode MSW supports
1081 }
1082 #endif // !wxGTK
1083
1084 #endif // wxUSE_GUI