Small usability improvements

[wxWidgets.git] / include / wx / tokenzr.h

diff --git a/include/wx/tokenzr.h b/include/wx/tokenzr.h
index 34fd0630321faef07dd5392d0562fb5810efcfad..fca43655d915a86cd4b4ca96c2cba1a6ddb27003 100644 (file)
--- a/include/wx/tokenzr.h
+++ b/include/wx/tokenzr.h
@@ -2,7 +2,7 @@
 // Name:        wx/tokenzr.h
 // Purpose:     String tokenizer - a C++ replacement for strtok(3)
 // Author:      Guilhem Lavaux
 // Name:        wx/tokenzr.h
 // Purpose:     String tokenizer - a C++ replacement for strtok(3)
 // Author:      Guilhem Lavaux

-// Modified by: Vadim Zeitlin
+// Modified by: (or rather rewritten by) Vadim Zeitlin

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


@@ -12,12 +12,9 @@
 #ifndef _WX_TOKENZRH
 #define _WX_TOKENZRH
 
 #ifndef _WX_TOKENZRH
 #define _WX_TOKENZRH
 

-#ifdef __GNUG__
-    #pragma interface "tokenzr.h"
-#endif
-

 #include "wx/object.h"
 #include "wx/string.h"
 #include "wx/object.h"
 #include "wx/string.h"

+#include "wx/arrstr.h"

 
 // ----------------------------------------------------------------------------
 // constants
 
 // ----------------------------------------------------------------------------
 // constants


@@ -41,7 +38,7 @@ enum wxStringTokenizerMode
 // wxStringTokenizer: replaces infamous strtok() and has some other features
 // ----------------------------------------------------------------------------
 
 // wxStringTokenizer: replaces infamous strtok() and has some other features
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxStringTokenizer : public wxObject
+class WXDLLIMPEXP_BASE wxStringTokenizer : public wxObject

 {
 public:
     // ctors and initializers
 {
 public:
     // ctors and initializers


@@ -61,27 +58,34 @@ public:
     void Reinit(const wxString& str);
 
     // tokens access
     void Reinit(const wxString& str);
 
     // tokens access

-        // count them
+        // return the number of remaining tokens

     size_t CountTokens() const;
         // did we reach the end of the string?
     bool HasMoreTokens() const;
         // get the next token, will return empty string if !HasMoreTokens()
     wxString GetNextToken();
     size_t CountTokens() const;
         // did we reach the end of the string?
     bool HasMoreTokens() const;
         // get the next token, will return empty string if !HasMoreTokens()
     wxString GetNextToken();

+        // get the delimiter which terminated the token last retrieved by
+        // GetNextToken() or NUL if there had been no tokens yet or the last
+        // one wasn't terminated (but ran to the end of the string)
+    wxChar GetLastDelimiter() const { return m_lastDelim; }

 
     // get current tokenizer state
         // returns the part of the string which remains to tokenize (*not* the
         // initial string)
 
     // get current tokenizer state
         // returns the part of the string which remains to tokenize (*not* the
         // initial string)

-    wxString GetString() const { return m_string; }
+    wxString GetString() const { return wxString(m_pos, m_string.end()); }

 
         // returns the current position (i.e. one index after the last
         // returned token or 0 if GetNextToken() has never been called) in the
         // original string
 
         // returns the current position (i.e. one index after the last
         // returned token or 0 if GetNextToken() has never been called) in the
         // original string

-    size_t GetPosition() const { return m_pos; }
+    size_t GetPosition() const { return m_pos - m_string.begin(); }

 
     // misc
         // get the current mode - can be different from the one passed to the
         // ctor if it was wxTOKEN_DEFAULT
     wxStringTokenizerMode GetMode() const { return m_mode; }
 
     // misc
         // get the current mode - can be different from the one passed to the
         // ctor if it was wxTOKEN_DEFAULT
     wxStringTokenizerMode GetMode() const { return m_mode; }

+        // do we return empty tokens?
+    bool AllowEmpty() const { return m_mode != wxTOKEN_STRTOK; }
+

 
     // backwards compatibility section from now on
     // -------------------------------------------
 
     // backwards compatibility section from now on
     // -------------------------------------------


@@ -107,14 +111,39 @@ public:
 protected:
     bool IsOk() const { return m_mode != wxTOKEN_INVALID; }
 
 protected:
     bool IsOk() const { return m_mode != wxTOKEN_INVALID; }
 

-    wxString m_string,              // the (rest of) string to tokenize
-             m_delims;              // all delimiters
+    bool DoHasMoreTokens() const;
+
+    enum MoreTokensState
+    {
+        MoreTokens_Unknown,
+        MoreTokens_Yes,
+        MoreTokens_No
+    };
+
+    MoreTokensState m_hasMoreTokens;

 
 

-    size_t   m_pos;                 // the position in the original string
+    wxString m_string;              // the string we tokenize
+    wxString::const_iterator m_stringEnd;
+    // FIXME-UTF8: use wxWcharBuffer
+    wxWxCharBuffer m_delims;        // all possible delimiters
+    size_t m_delimsLen;
+
+    wxString::const_iterator m_pos; // the current position in m_string

 
     wxStringTokenizerMode m_mode;   // see wxTOKEN_XXX values
 
 
     wxStringTokenizerMode m_mode;   // see wxTOKEN_XXX values
 

-    bool     m_hasMore;             // do we have more (possible empty) tokens?
+    wxChar   m_lastDelim;           // delimiter after last token or '\0'

 };
 
 };
 

+// ----------------------------------------------------------------------------
+// convenience function which returns all tokens at once
+// ----------------------------------------------------------------------------
+
+// the function takes the same parameters as wxStringTokenizer ctor and returns
+// the array containing all tokens
+wxArrayString WXDLLIMPEXP_BASE
+wxStringTokenize(const wxString& str,
+                 const wxString& delims = wxDEFAULT_DELIMITERS,
+                 wxStringTokenizerMode mode = wxTOKEN_DEFAULT);
+

 #endif // _WX_TOKENZRH
 #endif // _WX_TOKENZRH