Fix minor typo in wxDV_VERT_RULES documentation.

[wxWidgets.git] / src / common / tokenzr.cpp

diff --git a/src/common/tokenzr.cpp b/src/common/tokenzr.cpp
index 95eb0d586072f8c5a10cf4741cd7abb0271e0304..2822025bb7099b878aca5e2b0885ce876d0d96e5 100644 (file)
--- a/src/common/tokenzr.cpp
+++ b/src/common/tokenzr.cpp
@@ -1,17 +1,21 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        tokenzr.cpp
+// Name:        src/common/tokenzr.cpp

 // Purpose:     String tokenizer
 // Author:      Guilhem Lavaux
 // Purpose:     String tokenizer
 // Author:      Guilhem Lavaux

-// Modified by: Gregory Pietsch
+// Modified by: Vadim Zeitlin (almost full rewrite)

 // Created:     04/22/98
 // RCS-ID:      $Id$
 // Copyright:   (c) Guilhem Lavaux
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Created:     04/22/98
 // RCS-ID:      $Id$
 // Copyright:   (c) Guilhem Lavaux
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

-#ifdef __GNUG__
-    #pragma implementation "tokenzr.h"
-#endif
+// ============================================================================
+// declarations
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------

 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"


@@ -22,86 +26,271 @@
 
 #include "wx/tokenzr.h"
 
 
 #include "wx/tokenzr.h"
 

-wxStringTokenizer::wxStringTokenizer(const wxString& to_tokenize,
-                                     const wxString& delims,
-                                     bool ret_delims)
+#ifndef WX_PRECOMP
+    #include "wx/arrstr.h"
+    #include "wx/crt.h"
+#endif
+
+// Required for wxIs... functions
+#include <ctype.h>
+
+// ============================================================================
+// implementation
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// helpers
+// ----------------------------------------------------------------------------
+
+static wxString::const_iterator
+find_first_of(const wxChar *delims, size_t len,
+              const wxString::const_iterator& from,
+              const wxString::const_iterator& end)

 {
 {

-    m_string = to_tokenize;
-    m_delims = delims;
-    m_retdelims = ret_delims;
-    m_pos = 0;
+    wxASSERT_MSG( from <= end,  wxT("invalid index") );
+
+    for ( wxString::const_iterator i = from; i != end; ++i )
+    {
+        if ( wxTmemchr(delims, *i, len) )
+            return i;
+    }
+
+    return end;

 }
 
 }
 

-wxStringTokenizer::~wxStringTokenizer()
+static wxString::const_iterator
+find_first_not_of(const wxChar *delims, size_t len,
+                  const wxString::const_iterator& from,
+                  const wxString::const_iterator& end)
+{
+    wxASSERT_MSG( from <= end,  wxT("invalid index") );
+
+    for ( wxString::const_iterator i = from; i != end; ++i )
+    {
+        if ( !wxTmemchr(delims, *i, len) )
+            return i;
+    }
+
+    return end;
+}
+
+// ----------------------------------------------------------------------------
+// wxStringTokenizer construction
+// ----------------------------------------------------------------------------
+
+wxStringTokenizer::wxStringTokenizer(const wxString& str,
+                                     const wxString& delims,
+                                     wxStringTokenizerMode mode)

 {
 {

+    SetString(str, delims, mode);

 }
 
 }
 

-int wxStringTokenizer::CountTokens() const
+void wxStringTokenizer::SetString(const wxString& str,
+                                  const wxString& delims,
+                                  wxStringTokenizerMode mode)

 {
 {

-    size_t pos = 0;
-    int count = 0;
-    bool at_delim;
-
-    while (pos < m_string.length()) {
-        // while we're still counting ...
-        at_delim = (m_delims.find(m_string.at(pos)) < m_delims.length());
-        // are we at a delimiter? if so, move to the next nondelimiter;
-        // if not, move to the next delimiter.  If the find_first_of
-        // and find_first_not_of methods fail, pos will be assigned
-        // npos (0xFFFFFFFF) which will terminate the loop on the next
-        // go-round unless we have a really long string, which is unlikely
-        pos = at_delim ? m_string.find_first_not_of(m_delims, pos)
-                       : m_string.find_first_of(m_delims, pos);
-        if (m_retdelims)
+    if ( mode == wxTOKEN_DEFAULT )
+    {
+        // by default, we behave like strtok() if the delimiters are only
+        // whitespace characters and as wxTOKEN_RET_EMPTY otherwise (for
+        // whitespace delimiters, strtok() behaviour is better because we want
+        // to count consecutive spaces as one delimiter)
+        wxString::const_iterator p;
+        for ( p = delims.begin(); p != delims.end(); ++p )

         {
         {

-            // if we're retaining delimiters, increment count
-            count++;
+            if ( !wxIsspace(*p) )
+                break;
+        }
+
+        if ( p != delims.end() )
+        {
+            // not whitespace char in delims
+            mode = wxTOKEN_RET_EMPTY;

         }
         else
         {
         }
         else
         {

-            // if we're not retaining delimiters and at a token, inc count
-            count += (!at_delim);
+            // only whitespaces
+            mode = wxTOKEN_STRTOK;

         }
     }
         }
     }

-    return count;
+
+#if wxUSE_UNICODE // FIXME-UTF8: only wc_str()
+    m_delims = delims.wc_str();
+#else
+    m_delims = delims.mb_str();
+#endif
+    m_delimsLen = delims.length();
+
+    m_mode = mode;
+
+    Reinit(str);
+}
+
+void wxStringTokenizer::Reinit(const wxString& str)
+{
+    wxASSERT_MSG( IsOk(), wxT("you should call SetString() first") );
+
+    m_string = str;
+    m_stringEnd = m_string.end();
+    m_pos = m_string.begin();
+    m_lastDelim = wxT('\0');
+    m_hasMoreTokens = MoreTokens_Unknown;
+}
+
+// ----------------------------------------------------------------------------
+// access to the tokens
+// ----------------------------------------------------------------------------
+
+// do we have more of them?
+bool wxStringTokenizer::HasMoreTokens() const
+{
+    // GetNextToken() calls HasMoreTokens() and so HasMoreTokens() is called
+    // twice in every interation in the following common usage patten:
+    //     while ( HasMoreTokens() )
+    //        GetNextToken();
+    // We optimize this case by caching HasMoreTokens() return value here:
+    if ( m_hasMoreTokens == MoreTokens_Unknown )
+    {
+        bool r = DoHasMoreTokens();
+        wxConstCast(this, wxStringTokenizer)->m_hasMoreTokens =
+            r ? MoreTokens_Yes : MoreTokens_No;
+        return r;
+    }
+    else
+        return m_hasMoreTokens == MoreTokens_Yes;
+}
+
+bool wxStringTokenizer::DoHasMoreTokens() const
+{
+    wxCHECK_MSG( IsOk(), false, wxT("you should call SetString() first") );
+
+    if ( find_first_not_of(m_delims, m_delimsLen, m_pos, m_stringEnd)
+         != m_stringEnd )
+    {
+        // there are non delimiter characters left, so we do have more tokens
+        return true;
+    }
+
+    switch ( m_mode )
+    {
+        case wxTOKEN_RET_EMPTY:
+        case wxTOKEN_RET_DELIMS:
+            // special hack for wxTOKEN_RET_EMPTY: we should return the initial
+            // empty token even if there are only delimiters after it
+            return !m_string.empty() && m_pos == m_string.begin();
+
+        case wxTOKEN_RET_EMPTY_ALL:
+            // special hack for wxTOKEN_RET_EMPTY_ALL: we can know if we had
+            // already returned the trailing empty token after the last
+            // delimiter by examining m_lastDelim: it is set to NUL if we run
+            // up to the end of the string in GetNextToken(), but if it is not
+            // NUL yet we still have this last token to return even if m_pos is
+            // already at m_string.length()
+            return m_pos < m_stringEnd || m_lastDelim != wxT('\0');
+
+        case wxTOKEN_INVALID:
+        case wxTOKEN_DEFAULT:
+            wxFAIL_MSG( wxT("unexpected tokenizer mode") );
+            // fall through
+
+        case wxTOKEN_STRTOK:
+            // never return empty delimiters
+            break;
+    }
+
+    return false;

 }
 
 }
 

-bool wxStringTokenizer::HasMoreTokens()
+// count the number of (remaining) tokens in the string
+size_t wxStringTokenizer::CountTokens() const

 {
 {

-    return (m_retdelims
-            ? !m_string.IsEmpty()
-            : m_string.find_first_not_of(m_delims) < m_string.length());
+    wxCHECK_MSG( IsOk(), 0, wxT("you should call SetString() first") );
+
+    // VZ: this function is IMHO not very useful, so it's probably not very
+    //     important if its implementation here is not as efficient as it
+    //     could be -- but OTOH like this we're sure to get the correct answer
+    //     in all modes
+    wxStringTokenizer tkz(wxString(m_pos, m_stringEnd), m_delims, m_mode);
+
+    size_t count = 0;
+    while ( tkz.HasMoreTokens() )
+    {
+        count++;
+
+        (void)tkz.GetNextToken();
+    }
+
+    return count;

 }
 
 }
 

-wxString wxStringTokenizer::NextToken()
+// ----------------------------------------------------------------------------
+// token extraction
+// ----------------------------------------------------------------------------
+
+wxString wxStringTokenizer::GetNextToken()

 {
 {

-    size_t pos;
-    wxString r_string;
-
-    if ( m_string.IsEmpty() )
-        return m_string;
-        pos = m_string.find_first_not_of(m_delims);
-    if ( m_retdelims ) {
-        // we're retaining delimiters (unusual behavior, IMHO)
-        if (pos == 0)
-            // first char is a non-delimiter
-            pos = m_string.find_first_of(m_delims);
-    } else {
-        // we're not retaining delimiters
-        m_string.erase(0, pos);
-        m_pos += pos;
-        if (m_string.IsEmpty())
-            return m_string;
-        pos = m_string.find_first_of(m_delims);
+    wxString token;
+    do
+    {
+        if ( !HasMoreTokens() )
+        {
+            break;
+        }
+
+        m_hasMoreTokens = MoreTokens_Unknown;
+
+        // find the end of this token
+        wxString::const_iterator pos =
+            find_first_of(m_delims, m_delimsLen, m_pos, m_stringEnd);
+
+        // and the start of the next one
+        if ( pos == m_stringEnd )
+        {
+            // no more delimiters, the token is everything till the end of
+            // string
+            token.assign(m_pos, m_stringEnd);
+
+            // skip the token
+            m_pos = m_stringEnd;
+
+            // it wasn't terminated
+            m_lastDelim = wxT('\0');
+        }
+        else // we found a delimiter at pos
+        {
+            // in wxTOKEN_RET_DELIMS mode we return the delimiter character
+            // with token, otherwise leave it out
+            wxString::const_iterator tokenEnd(pos);
+            if ( m_mode == wxTOKEN_RET_DELIMS )
+                ++tokenEnd;
+
+            token.assign(m_pos, tokenEnd);
+
+            // skip the token and the trailing delimiter
+            m_pos = pos + 1;
+
+            m_lastDelim = (pos == m_stringEnd) ? wxT('\0') : (wxChar)*pos;
+        }

     }
     }

-    if (pos <= m_string.length()) {
-        r_string = m_string.substr(0, pos);
-        m_string.erase(0, pos);
-        m_pos += pos;
-    } else {
-        r_string = m_string;
-        m_pos += m_string.length();
-        m_string.Empty();
+    while ( !AllowEmpty() && token.empty() );
+
+    return token;
+}
+
+// ----------------------------------------------------------------------------
+// public functions
+// ----------------------------------------------------------------------------
+
+wxArrayString wxStringTokenize(const wxString& str,
+                               const wxString& delims,
+                               wxStringTokenizerMode mode)
+{
+    wxArrayString tokens;
+    wxStringTokenizer tk(str, delims, mode);
+    while ( tk.HasMoreTokens() )
+    {
+        tokens.Add(tk.GetNextToken());

     }
     }

-    return r_string;
+
+    return tokens;

 }
 }