]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/utilscmn.cpp
Added chapter on collection and container classes to contents
[wxWidgets.git] / src / common / utilscmn.cpp
index 9f91d813c8cf641f0d57270ded89ac42646c72eb..49c15f328409766841d5ed091a39a822082f497b 100644 (file)
@@ -9,77 +9,97 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
+// ============================================================================
+// declarations
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
+
 #ifdef __GNUG__
-#pragma implementation "utils.h"
+    #pragma implementation "utils.h"
 #endif
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__
-#pragma hdrstop
+    #pragma hdrstop
 #endif
 
 #ifndef WX_PRECOMP
-#include "wx/defs.h"
-#include "wx/utils.h"
-#include "wx/window.h"
-#include "wx/menu.h"
-#include "wx/frame.h"
-#include "wx/msgdlg.h"
-#include "wx/textdlg.h"
-#endif
-
-#include "wx/ioswrap.h"
-
-#if wxUSE_IOSTREAMH
-    #include <fstream.h>
-#else
-    #include <fstream>
+    #include "wx/defs.h"
+    #include "wx/string.h"
+    #include "wx/utils.h"
+    #include "wx/intl.h"
+    #include "wx/log.h"
+
+    #if wxUSE_GUI
+        #include "wx/window.h"
+        #include "wx/menu.h"
+        #include "wx/frame.h"
+        #include "wx/msgdlg.h"
+        #include "wx/textdlg.h"
+        #if wxUSE_ACCEL
+            #include "wx/menuitem.h"
+            #include "wx/accel.h"
+        #endif // wxUSE_ACCEL
+    #endif // wxUSE_GUI
+#endif // WX_PRECOMP
+
+#ifndef __WIN16__
+#include "wx/process.h"
+#include "wx/txtstrm.h"
 #endif
 
 #include <ctype.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
+
 #if !defined(__WATCOMC__)
     #if !(defined(_MSC_VER) && (_MSC_VER > 800))
         #include <errno.h>
     #endif
 #endif
+
+#if wxUSE_GUI
+    #include "wx/colordlg.h"
+#endif // wxUSE_GUI
+
 #include <time.h>
+
 #ifndef __MWERKS__
-#include <sys/types.h>
-#include <sys/stat.h>
+    #include <sys/types.h>
+    #include <sys/stat.h>
 #endif
 
 #ifdef __SALFORDC__
-#include <clib.h>
-#endif
-
-// Pattern matching code.
-// Yes, this path is deliberate (for Borland compilation)
-#ifdef wx_mac /* MATTHEW: [5] Mac doesn't like paths with "/" */
-#include "glob.inc"
-#else
-#include "../common/glob.inc"
+    #include <clib.h>
 #endif
 
 #ifdef __WXMSW__
-#include "windows.h"
+    #include "wx/msw/private.h"
 #endif
 
-#define _MAXPATHLEN 500
+// ----------------------------------------------------------------------------
+// function protoypes
+// ----------------------------------------------------------------------------
+
+#if wxUSE_GUI
+    static wxWindow *wxFindWindowByLabel1(const wxString& title, wxWindow *parent);
+    static wxWindow *wxFindWindowByName1 (const wxString& title, wxWindow *parent);
+#endif // wxUSE_GUI
 
-extern wxChar *wxBuffer;
+// ============================================================================
+// implementation
+// ============================================================================
 
 // ----------------------------------------------------------------------------
-// private functions
+// string functions
 // ----------------------------------------------------------------------------
 
-static wxWindow *wxFindWindowByLabel1(const wxString& title, wxWindow * parent);
-static wxWindow *wxFindWindowByName1 (const wxString& title, wxWindow * parent);
-
 #ifdef __WXMAC__
 int strcasecmp(const char *str_1, const char *str_2)
 {
@@ -109,8 +129,9 @@ int strncasecmp(const char *str_1, const char *str_2, size_t maxchar)
   return 0 ;
 
 }
-#endif
-#ifdef __VMS__
+#endif // wxMAC
+
+#if defined( __VMS__ ) && ( __VMS_VER < 70000000 )
 // we have no strI functions under VMS, therefore I have implemented
 // an inefficient but portable version: convert copies of strings to lowercase
 // and then use the normal comparison
@@ -131,7 +152,7 @@ int strcasecmp(const char *str_1, const char *str_2)
   myLowerString(temp1);
   myLowerString(temp2);
 
-  int result = strcmp(temp1,temp2);
+  int result = wxStrcmp(temp1,temp2);
   delete[] temp1;
   delete[] temp2;
 
@@ -153,7 +174,7 @@ int strncasecmp(const char *str_1, const char *str_2, size_t maxchar)
 
   return(result);
 }
-#endif
+#endif // __VMS__
 
 #ifdef __WINDOWS__
 
@@ -168,6 +189,12 @@ int strncasecmp(const char *str_1, const char *str_2, size_t maxchar)
 #endif
 
 #else
+
+#ifdef __EMX__
+#define strcasecmp stricmp
+#define strncasecmp strnicmp
+#endif
+
 // This declaration is missing in SunOS!
 // (Yes, I know it is NOT ANSI-C but its in BSD libc)
 #if defined(__xlC) || defined(__AIX__) || defined(__GNUG__)
@@ -179,11 +206,15 @@ extern "C"
 #endif
 #endif  /* __WXMSW__ */
 
+#ifdef __WXPM__
+#define strcasecmp stricmp
+#define strncasecmp strnicmp
+#endif
 
 wxChar *
 copystring (const wxChar *s)
 {
-  if (s == NULL) s = _T("");
+  if (s == NULL) s = wxT("");
   size_t len = wxStrlen (s) + 1;
 
   wxChar *news = new wxChar[len];
@@ -263,7 +294,7 @@ IntToString (int number)
 {
   static wxChar buf[20];
 
-  wxSprintf (buf, _T("%d"), number);
+  wxSprintf (buf, wxT("%d"), number);
   return buf;
 }
 
@@ -272,27 +303,27 @@ LongToString (long number)
 {
   static wxChar buf[20];
 
-  wxSprintf (buf, _T("%ld"), number);
+  wxSprintf (buf, wxT("%ld"), number);
   return buf;
 }
 
 // Array used in DecToHex conversion routine.
-static wxChar hexArray[] = _T("0123456789ABCDEF");
+static wxChar hexArray[] = wxT("0123456789ABCDEF");
 
 // Convert 2-digit hex number to decimal
 int wxHexToDec(const wxString& buf)
 {
   int firstDigit, secondDigit;
 
-  if (buf.GetChar(0) >= _T('A'))
-    firstDigit = buf.GetChar(0) - _T('A') + 10;
+  if (buf.GetChar(0) >= wxT('A'))
+    firstDigit = buf.GetChar(0) - wxT('A') + 10;
   else
-    firstDigit = buf.GetChar(0) - _T('0');
+    firstDigit = buf.GetChar(0) - wxT('0');
 
-  if (buf.GetChar(1) >= _T('A'))
-    secondDigit = buf.GetChar(1) - _T('A') + 10;
+  if (buf.GetChar(1) >= wxT('A'))
+    secondDigit = buf.GetChar(1) - wxT('A') + 10;
   else
-    secondDigit = buf.GetChar(1) - _T('0');
+    secondDigit = buf.GetChar(1) - wxT('0');
 
   return firstDigit * 16 + secondDigit;
 }
@@ -355,19 +386,9 @@ StringMatch (char *str1, char *str2, bool subString, bool exact)
   return FALSE;
 }
 
-// Don't synthesize KeyUp events holding down a key and producing
-// KeyDown events with autorepeat. On by default and always on
-// on in wxMSW. wxGTK version in utilsgtk.cpp.
-#ifndef __WXGTK__
-bool wxSetDetectableAutoRepeat( bool WXUNUSED(flag) )
-{
-   return TRUE;          // detectable auto-repeat is the only mode MSW supports
-}
-#endif
-
 // Return the current date/time
 // [volatile]
-wxString wxNow( void )
+wxString wxNow()
 {
   time_t now = time((time_t *) NULL);
   char *date = ctime(&now);
@@ -375,9 +396,11 @@ wxString wxNow( void )
   return wxString(date);
 }
 
-/*
- * Strip out any menu codes
- */
+#if wxUSE_GUI
+
+// ----------------------------------------------------------------------------
+// Menu accelerators related functions
+// ----------------------------------------------------------------------------
 
 wxChar *wxStripMenuCodes (wxChar *in, wxChar *out)
 {
@@ -391,13 +414,13 @@ wxChar *wxStripMenuCodes (wxChar *in, wxChar *out)
 
   while (*in)
     {
-      if (*in == _T('&'))
+      if (*in == wxT('&'))
         {
           // Check && -> &, &x -> x
-          if (*++in == _T('&'))
+          if (*++in == wxT('&'))
             *out++ = *in++;
         }
-      else if (*in == _T('\t'))
+      else if (*in == wxT('\t'))
         {
           // Remove all stuff after \t in X mode, and let the stuff as is
           // in Windows mode.
@@ -409,7 +432,7 @@ wxChar *wxStripMenuCodes (wxChar *in, wxChar *out)
         *out++ = *in++;
     }                                // while
 
-  *out = _T('\0');
+  *out = wxT('\0');
 
   return tmpOut;
 }
@@ -423,10 +446,103 @@ wxString wxStripMenuCodes(const wxString& str)
     return str1;
 }
 
-/*
- * Window search functions
- *
- */
+#if wxUSE_ACCEL
+
+// return wxAcceleratorEntry for the given menu string or NULL if none
+// specified
+wxAcceleratorEntry *wxGetAccelFromString(const wxString& label)
+{
+    // check for accelerators: they are given after '\t'
+    int posTab = label.Find(wxT('\t'));
+    if ( posTab != wxNOT_FOUND ) {
+        // parse the accelerator string
+        int keyCode = 0;
+        int accelFlags = wxACCEL_NORMAL;
+        wxString current;
+        for ( size_t n = (size_t)posTab + 1; n < label.Len(); n++ ) {
+            if ( (label[n] == '+') || (label[n] == '-') ) {
+                if ( current == _("ctrl") )
+                    accelFlags |= wxACCEL_CTRL;
+                else if ( current == _("alt") )
+                    accelFlags |= wxACCEL_ALT;
+                else if ( current == _("shift") )
+                    accelFlags |= wxACCEL_SHIFT;
+                else {
+                    wxLogDebug(wxT("Unknown accel modifier: '%s'"),
+                               current.c_str());
+                }
+
+                current.Empty();
+            }
+            else {
+                current += wxTolower(label[n]);
+            }
+        }
+
+        if ( current.IsEmpty() ) {
+            wxLogDebug(wxT("No accel key found, accel string ignored."));
+        }
+        else {
+            if ( current.Len() == 1 ) {
+                // it's a letter
+                keyCode = wxToupper(current[0U]);
+            }
+            else {
+                // is it a function key?
+                if ( current[0U] == 'f' && isdigit(current[1U]) &&
+                     (current.Len() == 2 ||
+                     (current.Len() == 3 && isdigit(current[2U]))) ) {
+                    int n;
+                    wxSscanf(current.c_str() + 1, wxT("%d"), &n);
+
+                    keyCode = WXK_F1 + n - 1;
+                }
+                else {
+                    // several special cases
+                    current.MakeUpper();
+                    if ( current == wxT("DEL") ) {
+                        keyCode = WXK_DELETE;
+                    }
+                    else if ( current == wxT("DELETE") ) {
+                        keyCode = WXK_DELETE;
+                    }
+                    else if ( current == wxT("INS") ) {
+                        keyCode = WXK_INSERT;
+                    }
+                    else if ( current == wxT("INSERT") ) {
+                        keyCode = WXK_INSERT;
+                    }
+#if 0
+                    else if ( current == wxT("PGUP") ) {
+                        keyCode = VK_PRIOR;
+                    }
+                    else if ( current == wxT("PGDN") ) {
+                        keyCode = VK_NEXT;
+                    }
+#endif
+                    else
+                    {
+                        wxLogDebug(wxT("Unrecognized accel key '%s', accel string ignored."),
+                                   current.c_str());
+                    }
+                }
+            }
+        }
+
+        if ( keyCode ) {
+            // we do have something
+            return new wxAcceleratorEntry(accelFlags, keyCode);
+        }
+    }
+
+    return (wxAcceleratorEntry *)NULL;
+}
+
+#endif // wxUSE_ACCEL
+
+// ----------------------------------------------------------------------------
+// Window search functions
+// ----------------------------------------------------------------------------
 
 /*
  * If parent is non-NULL, look through children for a label or title
@@ -551,6 +667,8 @@ wxFindMenuItemId (wxFrame * frame, const wxString& menuString, const wxString& i
   return menuBar->FindMenuItem (menuString, itemString);
 }
 
+#endif // wxUSE_GUI
+
 /*
 On Fri, 21 Jul 1995, Paul Craven wrote:
 
@@ -743,24 +861,12 @@ whereami(name)
 }
 
 #endif
-void wxEnableTopLevelWindows(bool enable)
-{
-   wxWindowList::Node *node;
-   for ( node = wxTopLevelWindows.GetFirst(); node; node = node->GetNext() )
-      node->GetData()->Enable(enable);
-}
 
-// Yield to other apps/messages and disable user input
-bool wxSafeYield(wxWindow *win)
-{
-   wxEnableTopLevelWindows(FALSE);
-   // always enable ourselves
-   if ( win )
-      win->Enable(TRUE);
-   bool rc = wxYield();
-   wxEnableTopLevelWindows(TRUE);
-   return rc;
-}
+#if wxUSE_GUI
+
+// ----------------------------------------------------------------------------
+// GUI helpers
+// ----------------------------------------------------------------------------
 
 /*
  * N.B. these convenience functions must be separate from msgdlgg.cpp, textdlgg.cpp
@@ -777,32 +883,76 @@ int wxMessageBox(const wxString& message, const wxString& caption, long style,
     {
         case wxID_OK:
             return wxOK;
-            break;
         case wxID_YES:
             return wxYES;
-            break;
         case wxID_NO:
             return wxNO;
-            break;
-        default:
         case wxID_CANCEL:
             return wxCANCEL;
-            break;
     }
-    return ans;
+
+    wxFAIL_MSG( _T("unexpected return code from wxMessageDialog") );
+
+    return wxCANCEL;
 }
 
+#if wxUSE_TEXTDLG
 wxString wxGetTextFromUser(const wxString& message, const wxString& caption,
                         const wxString& defaultValue, wxWindow *parent,
                         int x, int y, bool WXUNUSED(centre) )
 {
+    wxString str;
     wxTextEntryDialog dialog(parent, message, caption, defaultValue, wxOK|wxCANCEL, wxPoint(x, y));
     if (dialog.ShowModal() == wxID_OK)
-        return dialog.GetValue();
-    else
-        return wxString("");
+    {
+        str = dialog.GetValue();
+    }
+
+    return str;
 }
 
+wxString wxGetPasswordFromUser(const wxString& message,
+                               const wxString& caption,
+                               const wxString& defaultValue,
+                               wxWindow *parent)
+{
+    wxString str;
+    wxTextEntryDialog dialog(parent, message, caption, defaultValue,
+                             wxOK | wxCANCEL | wxTE_PASSWORD);
+    if ( dialog.ShowModal() == wxID_OK )
+    {
+        str = dialog.GetValue();
+    }
+
+    return str;
+}
+
+#endif // wxUSE_TEXTDLG
+
+wxColour wxGetColourFromUser(wxWindow *parent, const wxColour& colInit)
+{
+      wxColourData data;
+      data.SetChooseFull(TRUE);
+      if ( colInit.Ok() )
+      {
+          data.SetColour((wxColour &)colInit); // const_cast
+      }
+
+      wxColour colRet;
+      wxColourDialog dialog(parent, &data);
+      if ( dialog.ShowModal() == wxID_OK )
+      {
+          colRet = dialog.GetColourData().GetColour();
+      }
+      //else: leave it invalid
+
+      return colRet;
+}
+
+// ----------------------------------------------------------------------------
+// missing C RTL functions (FIXME shouldn't be here at all)
+// ----------------------------------------------------------------------------
+
 #ifdef __MWERKS__
 char *strdup(const char *s)
 {
@@ -813,7 +963,124 @@ int isascii( int c )
 {
         return ( c >= 0 && c < 128 ) ;
 }
+#endif // __MWERKS__
+
+// ----------------------------------------------------------------------------
+// wxSafeYield and supporting functions
+// ----------------------------------------------------------------------------
+
+void wxEnableTopLevelWindows(bool enable)
+{
+    wxWindowList::Node *node;
+    for ( node = wxTopLevelWindows.GetFirst(); node; node = node->GetNext() )
+        node->GetData()->Enable(enable);
+}
+
+wxWindowDisabler::wxWindowDisabler(wxWindow *winToSkip)
+{
+#ifdef __WXMSW__
+#ifdef __WIN32__
+    // and the top level window too
+    HWND hwndFG = ::GetForegroundWindow();
+    m_winTop = hwndFG ? wxFindWinFromHandle((WXHWND)hwndFG) : (wxWindow *)NULL;
+#else
+    HWND hwndFG = ::GetTopWindow(0);
+    m_winTop = hwndFG ? wxFindWinFromHandle((WXHWND)hwndFG) : (wxWindow *)NULL;
 #endif
+#endif // MSW
+
+    // remember the top level windows which were already disabled, so that we
+    // don't reenable them later
+    m_winDisabled = NULL;
+
+    wxWindowList::Node *node;
+    for ( node = wxTopLevelWindows.GetFirst(); node; node = node->GetNext() )
+    {
+        wxWindow *winTop = node->GetData();
+        if ( winTop == winToSkip )
+            continue;
+
+        if ( winTop->IsEnabled() )
+        {
+            winTop->Disable();
+        }
+        else
+        {
+            if ( !m_winDisabled )
+            {
+                m_winDisabled = new wxWindowList;
+            }
+
+            m_winDisabled->Append(winTop);
+        }
+    }
+}
+
+wxWindowDisabler::~wxWindowDisabler()
+{
+    wxWindowList::Node *node;
+    for ( node = wxTopLevelWindows.GetFirst(); node; node = node->GetNext() )
+    {
+        wxWindow *winTop = node->GetData();
+        if ( !m_winDisabled || !m_winDisabled->Find(winTop) )
+        {
+            winTop->Enable();
+        }
+        //else: had been already disabled, don't reenable
+    }
+
+    delete m_winDisabled;
+
+#ifdef __WXMSW__
+#ifdef __WIN32__
+    if ( m_winTop )
+    {
+        if ( !::SetForegroundWindow(GetHwndOf(m_winTop)) )
+        {
+            wxLogLastError(wxT("SetForegroundWindow"));
+        }
+    }
+#else
+    if ( m_winTop )
+    {
+        // 16-bit SetForegroundWindow() replacement
+        RECT reWin;
+        GetWindowRect((HWND) m_winTop, &reWin);
+        SetWindowPos ((HWND) m_winTop, HWND_TOP,
+                             reWin.left, reWin.top, 
+                             reWin.right - reWin.left, reWin.bottom, 
+                             SWP_SHOWWINDOW);
+    }
+#endif
+#endif // MSW
+}
+
+// Yield to other apps/messages and disable user input to all windows except
+// the given one
+bool wxSafeYield(wxWindow *win)
+{
+    wxWindowDisabler wd(win);
+
+    bool rc = wxYield();
+
+    return rc;
+}
+
+// ----------------------------------------------------------------------------
+// misc functions
+// ----------------------------------------------------------------------------
+
+// Don't synthesize KeyUp events holding down a key and producing KeyDown
+// events with autorepeat. On by default and always on in wxMSW. wxGTK version
+// in utilsgtk.cpp.
+#ifndef __WXGTK__
+bool wxSetDetectableAutoRepeat( bool WXUNUSED(flag) )
+{
+    return TRUE;    // detectable auto-repeat is the only mode MSW supports
+}
+#endif // !wxGTK
+
+#endif // wxUSE_GUI
 
 // ----------------------------------------------------------------------------
 // network and user id functions
@@ -827,7 +1094,7 @@ bool wxGetEmailAddress(wxChar *address, int maxSize)
         return FALSE;
 
     wxStrncpy(address, email, maxSize - 1);
-    address[maxSize - 1] = _T('\0');
+    address[maxSize - 1] = wxT('\0');
 
     return TRUE;
 }
@@ -836,14 +1103,13 @@ wxString wxGetEmailAddress()
 {
     wxString email;
 
-    wxString host = wxGetHostName();
+    wxString host = wxGetFullHostName();
     if ( !!host )
     {
         wxString user = wxGetUserId();
         if ( !!user )
         {
-            wxString email(user);
-            email << _T('@') << host;
+            email << user << wxT('@') << host;
         }
     }
 
@@ -893,3 +1159,150 @@ wxString wxGetHostName()
     return buf;
 }
 
+wxString wxGetFullHostName()
+{
+    static const size_t hostnameSize = 257;
+
+    wxString buf;
+    bool ok = wxGetFullHostName(buf.GetWriteBuf(hostnameSize), hostnameSize);
+
+    buf.UngetWriteBuf();
+
+    if ( !ok )
+        buf.Empty();
+
+    return buf;
+}
+
+wxString wxGetHomeDir()
+{
+    wxString home;
+    wxGetHomeDir(&home);
+
+    return home;
+}
+
+#if 0
+
+wxString wxGetCurrentDir()
+{
+    wxString dir;
+    size_t len = 1024;
+    bool ok;
+    do
+    {
+        ok = getcwd(dir.GetWriteBuf(len + 1), len) != NULL;
+        dir.UngetWriteBuf();
+
+        if ( !ok )
+        {
+            if ( errno != ERANGE )
+            {
+                wxLogSysError(_T("Failed to get current directory"));
+
+                return wxEmptyString;
+            }
+            else
+            {
+                // buffer was too small, retry with a larger one
+                len *= 2;
+            }
+        }
+        //else: ok
+    } while ( !ok );
+
+    return dir;
+}
+
+#endif // 0
+
+// ----------------------------------------------------------------------------
+// wxExecute
+// ----------------------------------------------------------------------------
+
+// this is a private function because it hasn't a clean interface: the first
+// array is passed by reference, the second by pointer - instead we have 2
+// public versions of wxExecute() below
+static long wxDoExecuteWithCapture(const wxString& command,
+                                   wxArrayString& output,
+                                   wxArrayString* error)
+{
+#ifdef __WIN16__
+    wxFAIL_MSG("Sorry, this version of wxExecute not implemented on WIN16.");
+
+    return 0;
+#else // !Win16
+    // create a wxProcess which will capture the output
+    wxProcess *process = new wxProcess;
+    process->Redirect();
+
+    long rc = wxExecute(command, TRUE /* sync */, process);
+
+#if wxUSE_STREAMS
+    if ( rc != -1 )
+    {
+        wxInputStream* is = process->GetInputStream();
+        wxCHECK_MSG( is, -1, _T("if wxExecute() succeded, stream can't be NULL") );
+        wxTextInputStream tis(*is);
+
+        wxTextInputStream *tes = NULL;
+        wxInputStream *es = NULL;
+        if ( error )
+        {
+            es = process->GetErrorStream();
+
+            wxCHECK_MSG( es, -1, _T("stderr can't be NULL") );
+
+            tes = new wxTextInputStream(*es);
+        }
+
+        bool cont;
+        do
+        {
+            cont = FALSE;
+
+            if ( !is->Eof() && is->IsOk() )
+            {
+                wxString line = tis.ReadLine();
+                if ( is->LastError() )
+                    break;
+
+                cont = TRUE;
+
+                output.Add(line);
+            }
+
+            if ( error && !es->Eof() && es->IsOk() )
+            {
+                wxString line = tes->ReadLine();
+                if ( es->LastError() )
+                    break;
+
+                cont = TRUE;
+
+                error->Add(line);
+            }
+        }
+        while ( cont );
+
+        delete tes;
+    }
+#endif // wxUSE_STREAMS
+
+    delete process;
+
+    return rc;
+#endif // IO redirection supoprted
+}
+
+long wxExecute(const wxString& command, wxArrayString& output)
+{
+    return wxDoExecuteWithCapture(command, output, NULL);
+}
+
+long wxExecute(const wxString& command,
+               wxArrayString& output,
+               wxArrayString& error)
+{
+    return wxDoExecuteWithCapture(command, output, &error);
+}