]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/valtext.cpp
Add some asserts to ensure cols and rows are >= 0 to avoid crashes
[wxWidgets.git] / src / common / valtext.cpp
index e527198cbc36a83279c0a52754a2569b181dcc6a..795df492d61539104a94a4daa09b7d7821140e0d 100644 (file)
@@ -1,18 +1,14 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        valtext.cpp
+// Name:        src/common/valtext.cpp
 // Purpose:     wxTextValidator
 // Author:      Julian Smart
-// Modified by:
+// Modified by: Francesco Montorsi
 // Created:     04/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-#ifdef __GNUG__
-#pragma implementation "valtext.h"
-#endif
-
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
   #pragma hdrstop
 #endif
 
-#if wxUSE_VALIDATORS
+#if wxUSE_VALIDATORS && (wxUSE_TEXTCTRL || wxUSE_COMBOBOX)
+
+#include "wx/valtext.h"
 
 #ifndef WX_PRECOMP
   #include <stdio.h>
   #include "wx/textctrl.h"
+  #include "wx/combobox.h"
   #include "wx/utils.h"
   #include "wx/msgdlg.h"
   #include "wx/intl.h"
 #endif
 
-#include "wx/valtext.h"
-
 #include <ctype.h>
 #include <string.h>
 #include <stdlib.h>
 
-#ifdef __SALFORDC__
-    #include <clib.h>
-#endif
+// ----------------------------------------------------------------------------
+// global helpers
+// ----------------------------------------------------------------------------
 
-IMPLEMENT_DYNAMIC_CLASS(wxTextValidator, wxValidator)
+static bool wxIsNumeric(const wxString& val)
+{
+    for ( wxString::const_iterator i = val.begin(); i != val.end(); ++i )
+    {
+        // Allow for "," (French) as well as "." -- in future we should
+        // use wxSystemSettings or other to do better localisation
+        if ((!wxIsdigit(*i)) &&
+            (*i != wxS('.')) && (*i != wxS(',')) && (*i != wxS('e')) &&
+            (*i != wxS('E')) && (*i != wxS('+')) && (*i != wxS('-')))
+            return false;
+    }
+    return true;
+}
 
+// ----------------------------------------------------------------------------
+// wxTextValidator
+// ----------------------------------------------------------------------------
+
+IMPLEMENT_DYNAMIC_CLASS(wxTextValidator, wxValidator)
 BEGIN_EVENT_TABLE(wxTextValidator, wxValidator)
     EVT_CHAR(wxTextValidator::OnChar)
 END_EVENT_TABLE()
 
-static bool wxIsNumeric(const wxString& val);
-
 wxTextValidator::wxTextValidator(long style, wxString *val)
 {
-    m_validatorStyle = style ;
-    m_stringValue = val ;
-/*
-    m_refData = new wxVTextRefData;
-
-    M_VTEXTDATA->m_validatorStyle = style ;
-    M_VTEXTDATA->m_stringValue = val ;
-*/
+    m_stringValue = val;
+    SetStyle(style);
 }
 
 wxTextValidator::wxTextValidator(const wxTextValidator& val)
@@ -66,271 +72,254 @@ wxTextValidator::wxTextValidator(const wxTextValidator& val)
     Copy(val);
 }
 
+void wxTextValidator::SetStyle(long style)
+{
+    m_validatorStyle = style;
+
+#if wxDEBUG_LEVEL
+    int check;
+    check = (int)HasFlag(wxFILTER_ALPHA) + (int)HasFlag(wxFILTER_ALPHANUMERIC) +
+            (int)HasFlag(wxFILTER_DIGITS) + (int)HasFlag(wxFILTER_NUMERIC);
+    wxASSERT_MSG(check <= 1,
+        "It makes sense to use only one of the wxFILTER_ALPHA/wxFILTER_ALPHANUMERIC/"
+        "wxFILTER_SIMPLE_NUMBER/wxFILTER_NUMERIC styles");
+
+    wxASSERT_MSG(((int)HasFlag(wxFILTER_INCLUDE_LIST) + (int)HasFlag(wxFILTER_INCLUDE_CHAR_LIST) <= 1) &&
+                 ((int)HasFlag(wxFILTER_EXCLUDE_LIST) + (int)HasFlag(wxFILTER_EXCLUDE_CHAR_LIST) <= 1),
+        "Using both wxFILTER_[IN|EX]CLUDE_LIST _and_ wxFILTER_[IN|EX]CLUDE_CHAR_LIST "
+        "doesn't work since wxTextValidator internally uses the same array for both");
+
+    check = (int)HasFlag(wxFILTER_INCLUDE_LIST) + (int)HasFlag(wxFILTER_INCLUDE_CHAR_LIST) +
+            (int)HasFlag(wxFILTER_EXCLUDE_LIST) + (int)HasFlag(wxFILTER_EXCLUDE_CHAR_LIST);
+    wxASSERT_MSG(check <= 1,
+        "Using both an include/exclude list may lead to unexpected results");
+#endif // wxDEBUG_LEVEL
+}
+
 bool wxTextValidator::Copy(const wxTextValidator& val)
 {
     wxValidator::Copy(val);
 
-    m_validatorStyle = val.m_validatorStyle ;
-    m_stringValue = val.m_stringValue ;
+    m_validatorStyle = val.m_validatorStyle;
+    m_stringValue = val.m_stringValue;
 
-    wxStringList::Node *node = val.m_includeList.GetFirst() ;
-    while ( node )
-    {
-        wxChar *s = node->GetData();
-        m_includeList.Add(s);
-        node = node->GetNext();
-    }
-    node = val.m_excludeList.GetFirst() ;
-    while ( node )
-    {
-        wxChar *s = node->GetData();
-        m_excludeList.Add(s);
-        node = node->GetNext();
-    }
-    return TRUE;
-}
+    m_includes    = val.m_includes;
+    m_excludes    = val.m_excludes;
 
-wxTextValidator::~wxTextValidator()
-{
+    return true;
 }
 
-static bool wxIsAlpha(const wxString& val)
+wxTextEntry *wxTextValidator::GetTextEntry()
 {
-    int i;
-    for ( i = 0; i < (int)val.Length(); i++)
+#if wxUSE_TEXTCTRL
+    if (m_validatorWindow->IsKindOf(CLASSINFO(wxTextCtrl)))
     {
-        if (!wxIsalpha(val[i]))
-            return FALSE;
+        return (wxTextCtrl*)m_validatorWindow;
     }
-    return TRUE;
-}
+#endif
 
-static bool wxIsAlphaNumeric(const wxString& val)
-{
-    int i;
-    for ( i = 0; i < (int)val.Length(); i++)
+#if wxUSE_COMBOBOX
+    if (m_validatorWindow->IsKindOf(CLASSINFO(wxComboBox)))
     {
-        if (!wxIsalnum(val[i]))
-            return FALSE;
+        return (wxComboBox*)m_validatorWindow;
     }
-    return TRUE;
+#endif
+
+    wxFAIL_MSG(
+        wxT("wxTextValidator can only be used with wxTextCtrl or wxComboBox")
+    );
+
+    return NULL;
 }
 
 // Called when the value in the window must be validated.
 // This function can pop up an error message.
 bool wxTextValidator::Validate(wxWindow *parent)
 {
-    if( !CheckValidator() )
-        return FALSE;
-
-    wxTextCtrl *control = (wxTextCtrl *) m_validatorWindow ;
-
     // If window is disabled, simply return
-    if ( !control->IsEnabled() )
-        return TRUE;
+    if ( !m_validatorWindow->IsEnabled() )
+        return true;
 
-    wxString val(control->GetValue());
+    wxTextEntry * const text = GetTextEntry();
+    if ( !text )
+        return false;
 
-    bool ok = TRUE;
+    wxString val(text->GetValue());
 
-    // NB: this format string should contian exactly one '%s'
     wxString errormsg;
-
-    bool includeList = (m_validatorStyle & wxFILTER_INCLUDE_LIST) != 0;
-    if ( includeList || (m_validatorStyle & wxFILTER_EXCLUDE_LIST) )
+    if ( HasFlag(wxFILTER_EMPTY) && val.empty() )
     {
-        // if includeList, it's only ok to have the members of the list,
-        // otherwise it's only ok to have non-members
-        ok = includeList == m_includeList.Member(val);
-        if ( !ok )
-        {
-            errormsg = _("'%s' is invalid");
-        }
+        errormsg = _("Required information entry is empty.");
     }
-    else if ( (m_validatorStyle & wxFILTER_ASCII) && !val.IsAscii() )
+    else if ( !(errormsg = IsValid(val)).empty() )
     {
-        ok = FALSE;
-
-        errormsg = _("'%s' should only contain ASCII characters.");
+        // NB: this format string should always contain exactly one '%s'
+        wxString buf;
+        buf.Printf(errormsg, val.c_str());
+        errormsg = buf;
     }
-    else if ( (m_validatorStyle & wxFILTER_ALPHA) && !wxIsAlpha(val) )
-    {
-        ok = FALSE;
 
-        errormsg = _("'%s' should only contain alphabetic characters.");
-    }
-    else if ( (m_validatorStyle & wxFILTER_ALPHANUMERIC) && !wxIsAlphaNumeric(val))
+    if ( !errormsg.empty() )
     {
-        ok = FALSE;
+        m_validatorWindow->SetFocus();
+        wxMessageBox(errormsg, _("Validation conflict"),
+                     wxOK | wxICON_EXCLAMATION, parent);
 
-        errormsg = _("'%s' should only contain alphabetic or numeric characters.");
+        return false;
     }
-    else if ( (m_validatorStyle & wxFILTER_NUMERIC) && !wxIsNumeric(val))
-    {
-        ok = FALSE;
 
-        errormsg = _("'%s' should be numeric.");
-    }
-    else if ( (m_validatorStyle & wxFILTER_INCLUDE_CHAR_LIST) && !IsInCharIncludeList(val))
-    {
-        //it's only ok to have the members of the list
-        errormsg = _("'%s' is invalid");
-        ok = FALSE;
-    }
-    else if ( (m_validatorStyle & wxFILTER_EXCLUDE_CHAR_LIST) && !IsNotInCharExcludeList(val))
-    {
-        // it's only ok to have non-members of the list
-        errormsg = _("'%s' is invalid");
-        ok = FALSE;
-    }
+    return true;
+}
 
-    if ( !ok )
+// Called to transfer data to the window
+bool wxTextValidator::TransferToWindow()
+{
+    if ( m_stringValue )
     {
-        wxASSERT_MSG( !errormsg.empty(), _T("you forgot to set errormsg") );
+        wxTextEntry * const text = GetTextEntry();
+        if ( !text )
+            return false;
 
-        m_validatorWindow->SetFocus();
+        text->SetValue(*m_stringValue);
+    }
 
-        wxString buf;
-        buf.Printf(errormsg, val.c_str());
+    return true;
+}
 
-        wxMessageBox(buf, _("Validation conflict"),
-                     wxOK | wxICON_EXCLAMATION, parent);
+// Called to transfer data to the window
+bool wxTextValidator::TransferFromWindow()
+{
+    if ( m_stringValue )
+    {
+        wxTextEntry * const text = GetTextEntry();
+        if ( !text )
+            return false;
+
+        *m_stringValue = text->GetValue();
     }
 
-    return ok;
+    return true;
 }
 
-// Called to transfer data to the window
-bool wxTextValidator::TransferToWindow(void)
+// IRIX mipsPro refuses to compile wxStringCheck<func>() if func is inline so
+// let's work around this by using this non-template function instead of
+// wxStringCheck(). And while this might be fractionally less efficient because
+// the function call won't be inlined like this, we don't care enough about
+// this to add extra #ifs for non-IRIX case.
+namespace
 {
-    if( !CheckValidator() )
-        return FALSE;
 
-    wxTextCtrl *control = (wxTextCtrl *) m_validatorWindow ;
-    control->SetValue(* m_stringValue) ;
+bool CheckString(bool (*func)(const wxUniChar&), const wxString& str)
+{
+    for ( wxString::const_iterator i = str.begin(); i != str.end(); ++i )
+    {
+        if ( !func(*i) )
+            return false;
+    }
 
-    return TRUE;
+    return true;
 }
 
-// Called to transfer data to the window
-bool wxTextValidator::TransferFromWindow(void)
+} // anonymous namespace
+
+wxString wxTextValidator::IsValid(const wxString& val) const
 {
-    if( !CheckValidator() )
-        return FALSE;
+    // wxFILTER_EMPTY is checked for in wxTextValidator::Validate
+
+    if ( HasFlag(wxFILTER_ASCII) && !val.IsAscii() )
+        return _("'%s' should only contain ASCII characters.");
+    if ( HasFlag(wxFILTER_ALPHA) && !CheckString(wxIsalpha, val) )
+        return _("'%s' should only contain alphabetic characters.");
+    if ( HasFlag(wxFILTER_ALPHANUMERIC) && !CheckString(wxIsalnum, val) )
+        return _("'%s' should only contain alphabetic or numeric characters.");
+    if ( HasFlag(wxFILTER_DIGITS) && !CheckString(wxIsdigit, val) )
+        return _("'%s' should only contain digits.");
+    if ( HasFlag(wxFILTER_NUMERIC) && !wxIsNumeric(val) )
+        return _("'%s' should be numeric.");
+    if ( HasFlag(wxFILTER_INCLUDE_LIST) && m_includes.Index(val) == wxNOT_FOUND )
+        return _("'%s' is invalid");
+    if ( HasFlag(wxFILTER_INCLUDE_CHAR_LIST) && !ContainsOnlyIncludedCharacters(val) )
+        return _("'%s' is invalid");
+    if ( HasFlag(wxFILTER_EXCLUDE_LIST) && m_excludes.Index(val) != wxNOT_FOUND )
+        return _("'%s' is invalid");
+    if ( HasFlag(wxFILTER_EXCLUDE_CHAR_LIST) && ContainsExcludedCharacters(val) )
+        return _("'%s' is invalid");
+
+    return wxEmptyString;
+}
 
-    wxTextCtrl *control = (wxTextCtrl *) m_validatorWindow ;
-    * m_stringValue = control->GetValue() ;
+bool wxTextValidator::ContainsOnlyIncludedCharacters(const wxString& val) const
+{
+    for ( wxString::const_iterator i = val.begin(); i != val.end(); ++i )
+        if (m_includes.Index((wxString) *i) == wxNOT_FOUND)
+            // one character of 'val' is NOT present in m_includes...
+            return false;
 
-    return TRUE;
+    // all characters of 'val' are present in m_includes
+    return true;
 }
 
-void wxTextValidator::SetIncludeList(const wxStringList& list)
+bool wxTextValidator::ContainsExcludedCharacters(const wxString& val) const
 {
-/*
-    if ( !M_VTEXTDATA )
-        return;
-*/
+    for ( wxString::const_iterator i = val.begin(); i != val.end(); ++i )
+        if (m_excludes.Index((wxString) *i) != wxNOT_FOUND)
+            // one character of 'val' is present in m_excludes...
+            return true;
 
-    m_includeList.Clear();
-    // TODO: replace with =
-    wxStringList::Node     *node = list.GetFirst();
-    while ( node )
-    {
-        wxChar *s = node->GetData();
-        m_includeList.Add(s);
-        node = node->GetNext();
-    }
+    // all characters of 'val' are NOT present in m_excludes
+    return false;
 }
 
-void wxTextValidator::SetExcludeList(const wxStringList& list)
+void wxTextValidator::SetCharIncludes(const wxString& chars)
 {
-/*
-    if ( !M_VTEXTDATA )
-        return;
-*/
+    wxArrayString arr;
 
-    m_excludeList.Clear();
-    // TODO: replace with =
-    wxStringList::Node  *node = list.GetFirst() ;
-    while ( node )
-    {
-        wxChar *s = node->GetData();
-        m_excludeList.Add(s);
-        node = node->GetNext();
-    }
+    for ( wxString::const_iterator i = chars.begin(); i != chars.end(); ++i )
+        arr.Add(*i);
+
+    SetIncludes(arr);
 }
 
-void wxTextValidator::OnChar(wxKeyEvent& event)
+void wxTextValidator::SetCharExcludes(const wxString& chars)
 {
-/*
-    if ( !M_VTEXTDATA )
-        return;
-*/
+    wxArrayString arr;
 
-    if ( m_validatorWindow )
-    {
-        int keyCode = event.GetKeyCode();
-
-        // we don't filter special keys and Delete
-        if (
-             !(keyCode < WXK_SPACE || keyCode == WXK_DELETE || keyCode > WXK_START) &&
-             (
-              ((m_validatorStyle & wxFILTER_INCLUDE_CHAR_LIST) && !IsInCharIncludeList(wxString((char) keyCode, 1))) ||
-              ((m_validatorStyle & wxFILTER_EXCLUDE_CHAR_LIST) && !IsNotInCharExcludeList(wxString((char) keyCode, 1))) ||
-              ((m_validatorStyle & wxFILTER_ASCII) && !isascii(keyCode)) ||
-              ((m_validatorStyle & wxFILTER_ALPHA) && !wxIsalpha(keyCode)) ||
-              ((m_validatorStyle & wxFILTER_ALPHANUMERIC) && !wxIsalnum(keyCode)) ||
-              ((m_validatorStyle & wxFILTER_NUMERIC) && !wxIsdigit(keyCode)
-                                && keyCode != '.' && keyCode != ',' && keyCode != '-')
-             )
-           )
-        {
-            if ( !wxValidator::IsSilent() )
-                wxBell();
-
-            // eat message
-            return;
-        }
-    }
+    for ( wxString::const_iterator i = chars.begin(); i != chars.end(); ++i )
+        arr.Add(*i);
 
-    event.Skip();
+    SetExcludes(arr);
 }
 
-static bool wxIsNumeric(const wxString& val)
+void wxTextValidator::OnChar(wxKeyEvent& event)
 {
-    int i;
-    for ( i = 0; i < (int)val.Length(); i++)
+    if (!m_validatorWindow)
     {
-        // Allow for "," (French) as well as "." -- in future we should
-        // use wxSystemSettings or other to do better localisation
-        if ((!isdigit(val[i])) && (val[i] != '.') && (val[i] != ','))
-          if(!((i == 0) && (val[i] == '-')))
-            return FALSE;
+        event.Skip();
+        return;
     }
-    return TRUE;
-}
 
-bool wxTextValidator::IsInCharIncludeList(const wxString& val)
-{
-    size_t i;
-    for ( i = 0; i < val.Length(); i++)
+    int keyCode = event.GetKeyCode();
+
+    // we don't filter special keys and delete
+    if (keyCode < WXK_SPACE || keyCode == WXK_DELETE || keyCode >= WXK_START)
     {
-        if (!m_includeList.Member((wxString) val[i]))
-            return FALSE;
+        event.Skip();
+        return;
     }
-    return TRUE;
-}
 
-bool wxTextValidator::IsNotInCharExcludeList(const wxString& val)
-{
-    size_t i;
-    for ( i = 0; i < val.Length(); i++)
+    wxString str((wxUniChar)keyCode, 1);
+    if (!IsValid(str).empty())
     {
-       if (m_excludeList.Member((wxString) val[i]))
-       return FALSE;
+        if ( !wxValidator::IsSilent() )
+            wxBell();
+
+        // eat message
+        return;
     }
-    return TRUE;
+    else
+        event.Skip();
 }
 
+
 #endif
-  // wxUSE_VALIDATORS
+  // wxUSE_VALIDATORS && (wxUSE_TEXTCTRL || wxUSE_COMBOBOX)