]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/utilscmn.cpp
removed obsolete docs
[wxWidgets.git] / src / common / utilscmn.cpp
index fbcad04649eec361577d3ff0657006db3a78f199..a5e42a0eb1048b756a77ccd791b3b80cd32f924d 100644 (file)
     #include "wx/log.h"
 
     #if wxUSE_GUI
+        #include "wx/app.h"
         #include "wx/window.h"
-        #include "wx/menu.h"
         #include "wx/frame.h"
+        #include "wx/menu.h"
         #include "wx/msgdlg.h"
         #include "wx/textdlg.h"
+        #include "wx/textctrl.h"    // for wxTE_PASSWORD
         #if wxUSE_ACCEL
             #include "wx/menuitem.h"
             #include "wx/accel.h"
     #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>
 
 #if wxUSE_GUI
     #include "wx/colordlg.h"
+    #include "wx/notebook.h"
+    #include "wx/frame.h"
+    #include "wx/statusbr.h"
+    #include "wx/toolbar.h"
 #endif // wxUSE_GUI
 
 #include <time.h>
@@ -75,7 +86,7 @@
 #endif
 
 #ifdef __WXMSW__
-    #include "windows.h"
+    #include "wx/msw/private.h"
 #endif
 
 // ----------------------------------------------------------------------------
 // string functions
 // ----------------------------------------------------------------------------
 
-#ifdef __WXMAC__
+#if defined(__WXMAC__) && !defined(__DARWIN__)
 int strcasecmp(const char *str_1, const char *str_2)
 {
   register char c1, c2;
@@ -124,7 +135,7 @@ int strncasecmp(const char *str_1, const char *str_2, size_t maxchar)
   return 0 ;
 
 }
-#endif // wxMAC
+#endif // __WXMAC__ && !__DARWIN__
 
 #if defined( __VMS__ ) && ( __VMS_VER < 70000000 )
 // we have no strI functions under VMS, therefore I have implemented
@@ -171,7 +182,7 @@ int strncasecmp(const char *str_1, const char *str_2, size_t maxchar)
 }
 #endif // __VMS__
 
-#ifdef __WINDOWS__
+#if defined(__WINDOWS__) && !defined(__WXMICROWIN__)
 
 #ifndef __GNUWIN32__
 #ifndef __MWERKS__
@@ -206,6 +217,11 @@ extern "C"
 #define strncasecmp strnicmp
 #endif
 
+#ifdef __WATCOMC__
+#define strcasecmp stricmp
+#define strncasecmp strnicmp
+#endif
+
 wxChar *
 copystring (const wxChar *s)
 {
@@ -238,14 +254,14 @@ wxRegisterId (long id)
 }
 
 void
-StringToFloat (wxChar *s, float *number)
+StringToFloat (const wxChar *s, float *number)
 {
   if (s && *s && number)
     *number = (float) wxStrtod (s, (wxChar **) NULL);
 }
 
 void
-StringToDouble (wxChar *s, double *number)
+StringToDouble (const wxChar *s, double *number)
 {
   if (s && *s && number)
     *number = wxStrtod (s, (wxChar **) NULL);
@@ -256,7 +272,6 @@ FloatToString (float number, const wxChar *fmt)
 {
   static wxChar buf[256];
 
-//  sprintf (buf, "%.2f", number);
   wxSprintf (buf, fmt, number);
   return buf;
 }
@@ -271,14 +286,14 @@ DoubleToString (double number, const wxChar *fmt)
 }
 
 void
-StringToInt (wxChar *s, int *number)
+StringToInt (const wxChar *s, int *number)
 {
   if (s && *s && number)
     *number = (int) wxStrtol (s, (wxChar **) NULL, 10);
 }
 
 void
-StringToLong (wxChar *s, long *number)
+StringToLong (const wxChar *s, long *number)
 {
   if (s && *s && number)
     *number = wxStrtol (s, (wxChar **) NULL, 10);
@@ -320,7 +335,7 @@ int wxHexToDec(const wxString& buf)
   else
     secondDigit = buf.GetChar(1) - wxT('0');
 
-  return firstDigit * 16 + secondDigit;
+  return (firstDigit & 0xF) * 16 + (secondDigit & 0xF );
 }
 
 // Convert decimal integer to 2-character hex string
@@ -343,7 +358,7 @@ wxString wxDecToHex(int dec)
 
 // Match a string INDEPENDENT OF CASE
 bool
-StringMatch (char *str1, char *str2, bool subString, bool exact)
+StringMatch (const char *str1, const char *str2, bool subString, bool exact)
 {
   if (str1 == NULL || str2 == NULL)
     return FALSE;
@@ -393,138 +408,66 @@ wxString wxNow()
 
 #if wxUSE_GUI
 
+#if wxUSE_MENUS
+
 // ----------------------------------------------------------------------------
 // Menu accelerators related functions
 // ----------------------------------------------------------------------------
 
-wxChar *wxStripMenuCodes (wxChar *in, wxChar *out)
+wxChar *wxStripMenuCodes(const wxChar *in, wxChar *out)
 {
-  if (!in)
-    return (wxChar *) NULL;
-
-  if (!out)
-    out = copystring(in);
-
-  wxChar *tmpOut = out;
-
-  while (*in)
+    wxString s = wxMenuItem::GetLabelFromText(in);
+    if ( out )
     {
-      if (*in == wxT('&'))
-        {
-          // Check && -> &, &x -> x
-          if (*++in == wxT('&'))
-            *out++ = *in++;
-        }
-      else if (*in == wxT('\t'))
-        {
-          // Remove all stuff after \t in X mode, and let the stuff as is
-          // in Windows mode.
-          // Accelerators are handled in wx_item.cc for Motif, and are not
-          // YET supported in XView
-          break;
-        }
-      else
-        *out++ = *in++;
-    }                                // while
-
-  *out = wxT('\0');
+        // go smash their buffer if it's not big enough - I love char * params
+        memcpy(out, s.c_str(), s.length() * sizeof(wxChar));
+    }
+    else
+    {
+        out = copystring(s);
+    }
 
-  return tmpOut;
+    return out;
 }
 
-wxString wxStripMenuCodes(const wxString& str)
+wxString wxStripMenuCodes(const wxString& in)
 {
-    wxChar *buf = new wxChar[str.Length() + 1];
-    wxStripMenuCodes(WXSTRINGCAST str, buf);
-    wxString str1(buf);
-    delete[] buf;
-    return str1;
-}
+    wxString out;
 
-#if wxUSE_ACCEL
+    size_t len = in.length();
+    out.reserve(len);
 
-// 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();
+    for ( size_t n = 0; n < len; n++ )
+    {
+        wxChar ch = in[n];
+        if ( ch == _T('&') )
+        {
+            // skip it, it is used to introduce the accel char (or to quote
+            // itself in which case it should still be skipped): note that it
+            // can't be the last character of the string
+            if ( ++n == len )
+            {
+                wxLogDebug(_T("Invalid menu string '%s'"), in.c_str());
             }
-            else {
-                current += wxTolower(label[n]);
+            else
+            {
+                // use the next char instead
+                ch = in[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 {
-#if 0 // this is not supported by GTK+, apparently
-                    // several special cases
-                    current.MakeUpper();
-                    if ( current == wxT("DEL") ) {
-                        keyCode = VK_DELETE;
-                    }
-                    else if ( current == wxT("PGUP") ) {
-                        keyCode = VK_PRIOR;
-                    }
-                    else if ( current == wxT("PGDN") ) {
-                        keyCode = VK_NEXT;
-                    }
-                    else
-#endif // 0
-                    {
-                        wxLogDebug(wxT("Unrecognized accel key '%s', accel "
-                                       "string ignored."), current.c_str());
-                    }
-                }
-            }
+        else if ( ch == _T('\t') )
+        {
+            // everything after TAB is accel string, exit the loop
+            break;
         }
 
-        if ( keyCode ) {
-            // we do have something
-            return new wxAcceleratorEntry(accelFlags, keyCode);
-        }
+        out += ch;
     }
 
-    return (wxAcceleratorEntry *)NULL;
+    return out;
 }
 
-#endif // wxUSE_ACCEL
+#endif // wxUSE_MENUS
 
 // ----------------------------------------------------------------------------
 // Window search functions
@@ -647,10 +590,105 @@ wxFindWindowByName1 (const wxString& title, wxWindow * parent)
 int
 wxFindMenuItemId (wxFrame * frame, const wxString& menuString, const wxString& itemString)
 {
+#if wxUSE_MENUS
   wxMenuBar *menuBar = frame->GetMenuBar ();
-  if (!menuBar)
-    return -1;
-  return menuBar->FindMenuItem (menuString, itemString);
+  if ( menuBar )
+      return menuBar->FindMenuItem (menuString, itemString);
+#endif // wxUSE_MENUS
+
+  return -1;
+}
+
+// Try to find the deepest child that contains 'pt'.
+// We go backwards, to try to allow for controls that are spacially
+// within other controls, but are still siblings (e.g. buttons within
+// static boxes). Static boxes are likely to be created _before_ controls
+// that sit inside them.
+wxWindow* wxFindWindowAtPoint(wxWindow* win, const wxPoint& pt)
+{
+    if (!win->IsShown())
+        return NULL;
+
+    // Hack for wxNotebook case: at least in wxGTK, all pages
+    // claim to be shown, so we must only deal with the selected one.
+#if wxUSE_NOTEBOOK
+    if (win->IsKindOf(CLASSINFO(wxNotebook)))
+    {
+      wxNotebook* nb = (wxNotebook*) win;
+      int sel = nb->GetSelection();
+      if (sel >= 0)
+      {
+        wxWindow* child = nb->GetPage(sel);
+        wxWindow* foundWin = wxFindWindowAtPoint(child, pt);
+        if (foundWin)
+           return foundWin;
+      }
+    }
+#endif
+
+    /* Doesn't work
+    // Frame case
+    else if (win->IsKindOf(CLASSINFO(wxFrame)))
+    {
+      // Pseudo-children that may not be mentioned in the child list
+      wxWindowList extraChildren;
+      wxFrame* frame = (wxFrame*) win;
+      if (frame->GetStatusBar())
+        extraChildren.Append(frame->GetStatusBar());
+      if (frame->GetToolBar())
+        extraChildren.Append(frame->GetToolBar());
+
+      wxNode* node = extraChildren.First();
+      while (node)
+      {
+          wxWindow* child = (wxWindow*) node->Data();
+          wxWindow* foundWin = wxFindWindowAtPoint(child, pt);
+          if (foundWin)
+            return foundWin;
+          node = node->Next();
+      }
+    }
+    */
+
+    wxNode* node = win->GetChildren().Last();
+    while (node)
+    {
+        wxWindow* child = (wxWindow*) node->Data();
+        wxWindow* foundWin = wxFindWindowAtPoint(child, pt);
+        if (foundWin)
+          return foundWin;
+        node = node->Previous();
+    }
+
+    wxPoint pos = win->GetPosition();
+    wxSize sz = win->GetSize();
+    if (win->GetParent())
+    {
+        pos = win->GetParent()->ClientToScreen(pos);
+    }
+
+    wxRect rect(pos, sz);
+    if (rect.Inside(pt))
+        return win;
+    else
+        return NULL;
+}
+
+wxWindow* wxGenericFindWindowAtPoint(const wxPoint& pt)
+{
+    // Go backwards through the list since windows
+    // on top are likely to have been appended most
+    // recently.
+    wxNode* node = wxTopLevelWindows.Last();
+    while (node)
+    {
+        wxWindow* win = (wxWindow*) node->Data();
+        wxWindow* found = wxFindWindowAtPoint(win, pt);
+        if (found)
+            return found;
+        node = node->Previous();
+    }
+    return NULL;
 }
 
 #endif // wxUSE_GUI
@@ -709,7 +747,7 @@ whereami(name)
 
         t = imagedir;
         if (!absolute_pathname(name)) {
-#if defined(DOS) || defined(__WIN32__)
+#if defined(__DOS__) || defined(__WIN32__)
             int   drive;
             char *newrbuf;
 
@@ -859,6 +897,8 @@ whereami(name)
  * since otherwise the generic code may be pulled in unnecessarily.
  */
 
+#if wxUSE_MSGDLG
+
 int wxMessageBox(const wxString& message, const wxString& caption, long style,
                  wxWindow *parent, int WXUNUSED(x), int WXUNUSED(y) )
 {
@@ -873,13 +913,19 @@ int wxMessageBox(const wxString& message, const wxString& caption, long style,
             return wxYES;
         case wxID_NO:
             return wxNO;
-        default:
         case wxID_CANCEL:
             return wxCANCEL;
     }
+
+    wxFAIL_MSG( _T("unexpected return code from wxMessageDialog") );
+
+    return wxCANCEL;
 }
 
+#endif // wxUSE_MSGDLG
+
 #if wxUSE_TEXTDLG
+
 wxString wxGetTextFromUser(const wxString& message, const wxString& caption,
                         const wxString& defaultValue, wxWindow *parent,
                         int x, int y, bool WXUNUSED(centre) )
@@ -912,6 +958,8 @@ wxString wxGetPasswordFromUser(const wxString& message,
 
 #endif // wxUSE_TEXTDLG
 
+#if wxUSE_COLOURDLG
+
 wxColour wxGetColourFromUser(wxWindow *parent, const wxColour& colInit)
 {
       wxColourData data;
@@ -932,6 +980,8 @@ wxColour wxGetColourFromUser(wxWindow *parent, const wxColour& colInit)
       return colRet;
 }
 
+#endif // wxUSE_COLOURDLG
+
 // ----------------------------------------------------------------------------
 // missing C RTL functions (FIXME shouldn't be here at all)
 // ----------------------------------------------------------------------------
@@ -949,7 +999,7 @@ int isascii( int c )
 #endif // __MWERKS__
 
 // ----------------------------------------------------------------------------
-// misc functions
+// wxSafeYield and supporting functions
 // ----------------------------------------------------------------------------
 
 void wxEnableTopLevelWindows(bool enable)
@@ -959,55 +1009,66 @@ void wxEnableTopLevelWindows(bool enable)
         node->GetData()->Enable(enable);
 }
 
-static void wxFindDisabledWindows(wxWindowList& winDisabled, wxWindow *win)
+wxWindowDisabler::wxWindowDisabler(wxWindow *winToSkip)
 {
+    // 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 = win->GetChildren().GetFirst(); node; node = node->GetNext() )
+    for ( node = wxTopLevelWindows.GetFirst(); node; node = node->GetNext() )
     {
-        wxWindow *child = node->GetData();
-        if ( child->IsEnabled() )
+        wxWindow *winTop = node->GetData();
+        if ( winTop == winToSkip )
+            continue;
+
+        if ( winTop->IsEnabled() )
         {
-            winDisabled.Append(child);
+            winTop->Disable();
         }
+        else
+        {
+            if ( !m_winDisabled )
+            {
+                m_winDisabled = new wxWindowList;
+            }
 
-        wxFindDisabledWindows(winDisabled, child);
+            m_winDisabled->Append(winTop);
+        }
     }
 }
 
-// Yield to other apps/messages and disable user input to all windows except
-// the given one
-bool wxSafeYield(wxWindow *win)
+wxWindowDisabler::~wxWindowDisabler()
 {
-    // remember all windows we're going to (temporarily) disable
-    wxWindowList winDisabled;
-
     wxWindowList::Node *node;
     for ( node = wxTopLevelWindows.GetFirst(); node; node = node->GetNext() )
     {
         wxWindow *winTop = node->GetData();
-        wxFindDisabledWindows(winDisabled, winTop);
-
-        winTop->Disable();
+        if ( !m_winDisabled || !m_winDisabled->Find(winTop) )
+        {
+            winTop->Enable();
+        }
+        //else: had been already disabled, don't reenable
     }
 
-    if ( win )
-    {
-        // always enable ourselves
-        win->Enable();
-    }
+    delete m_winDisabled;
+}
 
-    bool rc = wxYield();
+// Yield to other apps/messages and disable user input to all windows except
+// the given one
+bool wxSafeYield(wxWindow *win)
+{
+    wxWindowDisabler wd(win);
 
-    // don't call wxEnableTopLevelWindows(TRUE) because this will reenable even
-    // the window which had been disabled before, do it manually instead
-    for ( node = winDisabled.GetFirst(); node; node = node->GetNext() )
-    {
-        node->GetData()->Enable();
-    }
+    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.
@@ -1020,6 +1081,33 @@ bool wxSetDetectableAutoRepeat( bool WXUNUSED(flag) )
 
 #endif // wxUSE_GUI
 
+const wxChar *wxGetInstallPrefix()
+{
+    wxString prefix;
+    
+    if ( wxGetEnv(wxT("WX_PREFIX"), &prefix) )
+        return prefix.c_str();
+    
+#ifdef wxINSTALL_PREFIX
+    return wxT(wxINSTALL_PREFIX);
+#else 
+    return wxT("");
+#endif
+}
+
+wxString wxGetDataDir()
+{
+    wxString format = wxGetInstallPrefix();
+    format <<  wxFILE_SEP_PATH
+           << wxT("share") << wxFILE_SEP_PATH
+           << wxT("wx") << wxFILE_SEP_PATH
+           << wxT("%i.%i");
+    wxString dir;
+    dir.Printf(format.c_str(), wxMAJOR_VERSION, wxMINOR_VERSION);
+    return dir;
+}
+
+
 // ----------------------------------------------------------------------------
 // network and user id functions
 // ----------------------------------------------------------------------------
@@ -1041,14 +1129,13 @@ wxString wxGetEmailAddress()
 {
     wxString email;
 
-    wxString host = wxGetHostName();
+    wxString host = wxGetFullHostName();
     if ( !!host )
     {
         wxString user = wxGetUserId();
         if ( !!user )
         {
-            wxString email(user);
-            email << wxT('@') << host;
+            email << user << wxT('@') << host;
         }
     }
 
@@ -1154,3 +1241,117 @@ wxString wxGetCurrentDir()
 }
 
 #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);
+}
+
+// ----------------------------------------------------------------------------
+// wxApp::Yield() wrappers for backwards compatibility
+// ----------------------------------------------------------------------------
+
+bool wxYield()
+{
+#if wxUSE_GUI
+    return wxTheApp && wxTheApp->Yield();
+#else
+    return FALSE;
+#endif
+}
+
+bool wxYieldIfNeeded()
+{
+#if wxUSE_GUI
+    return wxTheApp && wxTheApp->Yield(TRUE);
+#else
+    return FALSE;
+#endif
+}
+