src/common/utilscmn.cpp

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