ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/OpenMD/branches/development/src/utils/StringTokenizer.hpp
(Generate patch)

Comparing trunk/src/utils/StringTokenizer.hpp (file contents):
Revision 261 by tim, Fri Jan 14 16:49:46 2005 UTC vs.
Revision 770 by tim, Fri Dec 2 15:38:03 2005 UTC

# Line 1 | Line 1
1 < /*
1 > /*
2   * Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
3   *
4   * The University of Notre Dame grants you ("Licensee") a
# Line 51 | Line 51
51   #define UTIL_STRINGTOKENIZER_HPP
52  
53   #include <string>
54 + #include <vector>
55  
56   namespace oopse {
57  
58 < /**
59 < * @class StringTokenizer.hpp "util/StringTokenizer.hpp"
60 < * @brief The string tokenizer class allows an application to break a string into tokens
61 < * The set of delimiters (the characters that separate tokens) may be specified either
62 < * at creation time or on a per-token basis.
63 < * An instance of StringTokenizer behaves in one of two ways, depending on whether it was
64 < * created with the returnTokens flag having the value true or false.
65 < */
66 < class StringTokenizer {
67 <    public:
58 >  /**
59 >   * @class StringTokenizer.hpp "util/StringTokenizer.hpp"
60 >   * @brief The string tokenizer class allows an application to break a string into tokens
61 >   * The set of delimiters (the characters that separate tokens) may be specified either
62 >   * at creation time or on a per-token basis.
63 >   * An instance of StringTokenizer behaves in one of two ways, depending on whether it was
64 >   * created with the returnTokens flag having the value true or false.
65 >   */
66 >  class StringTokenizer {
67 >  public:
68  
69 <        /**
70 <         * Constructs a string tokenizer for the specified string. The characters in the delim argument
71 <         * are the delimiters for separating tokens. characters are skipped and only serve as
72 <         * separators between tokens.
73 <         * @param str a string to be parsed.
74 <         * @param delim the delimiters, default value is " ;\t\n\r".
75 <         * @note this is still a little bit java like implementation. Pure c++ one should use TokenIterator.
76 <         * Boost's tokenizer class is one of them
77 <         */
78 <        StringTokenizer(const std::string & str,
79 <                        const std::string & delim = " ;\t\n\r");
69 >    /**
70 >     * Constructs a string tokenizer for the specified string. The characters in the delim argument
71 >     * are the delimiters for separating tokens. characters are skipped and only serve as
72 >     * separators between tokens.
73 >     * @param str a string to be parsed.
74 >     * @param delim the delimiters, default value is " ;\t\n\r".
75 >     * @note this is still a little bit java like implementation. Pure c++ one should use TokenIterator.
76 >     * Boost's tokenizer class is one of them
77 >     */
78 >    StringTokenizer(const std::string & str,
79 >                    const std::string & delim = " ;\t\n\r");
80  
81 <        /**
82 <         * Constructs a string tokenizer for an iterator range [first, last). The characters in the delim argument
83 <         * are the delimiters for separating tokens. characters are skipped and only serve as
84 <         * separators between tokens.
85 <         * @param first begin iterator
86 <         * @param last end iterator
87 <         * @param delim the delimiters, default value is " ;\t\n\r".
88 <         * @note this is still a little bit java like implementation. Pure c++ one should use TokenIterator.
89 <         * Boost's tokenizer class is one of them
90 <         */
91 <        StringTokenizer(std::string::const_iterator& first, std::string::const_iterator& last,
92 <                        const std::string & delim = " ;\t\n\r");
81 >    /**
82 >     * Constructs a string tokenizer for an iterator range [first, last). The characters in the delim argument
83 >     * are the delimiters for separating tokens. characters are skipped and only serve as
84 >     * separators between tokens.
85 >     * @param first begin iterator
86 >     * @param last end iterator
87 >     * @param delim the delimiters, default value is " ;\t\n\r".
88 >     * @note this is still a little bit java like implementation. Pure c++ one should use TokenIterator.
89 >     * Boost's tokenizer class is one of them
90 >     */
91 >    StringTokenizer(std::string::const_iterator& first, std::string::const_iterator& last,
92 >                    const std::string & delim = " ;\t\n\r");
93  
94 <        /**
95 <         * Constructs a string tokenizer for the specified string. The characters in the delim argument
96 <         * are the delimiters for separating tokens.
97 <         * If the returnTokens flag is true, then the delimiter characters are also returned as tokens.
98 <         * Each delimiter is returned as a string of length one. If the flag is false, the delimiter
99 <         * characters are skipped and only serve as separators between tokens.
100 <         * @param str a string to be parsed.
101 <         * @param delim the delimiters.
102 <         * @param returnTokens flag indicating whether to return the delimiters as tokens.
103 <         */
104 <        StringTokenizer(const std::string&str, const std::string&delim,
105 <                        bool returnTokens);
94 >    /**
95 >     * Constructs a string tokenizer for the specified string. The characters in the delim argument
96 >     * are the delimiters for separating tokens.
97 >     * If the returnTokens flag is true, then the delimiter characters are also returned as tokens.
98 >     * Each delimiter is returned as a string of length one. If the flag is false, the delimiter
99 >     * characters are skipped and only serve as separators between tokens.
100 >     * @param str a string to be parsed.
101 >     * @param delim the delimiters.
102 >     * @param returnTokens flag indicating whether to return the delimiters as tokens.
103 >     */
104 >    StringTokenizer(const std::string&str, const std::string&delim,
105 >                    bool returnTokens);
106  
107 <        /**
108 <         * Calculates the number of times that this tokenizer's nextToken method can be called
109 <         * before it generates an exception.
110 <         * @return the number of tokens remaining in the string using the current delimiter set.
111 <         */
112 <        int countTokens();
107 >    /**
108 >     * Calculates the number of times that this tokenizer's nextToken method can be called
109 >     * before it generates an exception.
110 >     * @return the number of tokens remaining in the string using the current delimiter set.
111 >     */
112 >    int countTokens();
113  
114 <        /**
115 <         * Tests if there are more tokens available from this tokenizer's string.
116 <         * @return true if there are more tokens available from this tokenizer's string, false otherwise
117 <         */
118 <        bool hasMoreTokens();
114 >    /**
115 >     * Tests if there are more tokens available from this tokenizer's string.
116 >     * @return true if there are more tokens available from this tokenizer's string, false otherwise
117 >     */
118 >    bool hasMoreTokens();
119  
120 <        /**
121 <         * Returns the next token from this string tokenizer.
122 <         * @return the next token from this string tokenizer.
123 <         * @exception NoSuchElementException if there are no more tokens in this tokenizer's string
124 <         */
125 <        std::string nextToken();
120 >    /**
121 >     * Returns the next token from this string tokenizer.
122 >     * @return the next token from this string tokenizer.
123 >     * @exception NoSuchElementException if there are no more tokens in this tokenizer's string
124 >     */
125 >    std::string nextToken();
126  
127 <        //actually, nextToken Can be template function
128 <        //template <typename ReturnType>
129 <        //ReturnType nextToken();
127 >    //actually, nextToken Can be template function
128 >    //template <typename ReturnType>
129 >    //ReturnType nextToken();
130          
131 <        /**
132 <         * Returns the next token from this string tokenizer as a bool.
133 <         * @return the next token from this string tokenizer  as a bool.
134 <         */
135 <        bool nextTokenAsBool();
131 >    /**
132 >     * Returns the next token from this string tokenizer as a bool.
133 >     * @return the next token from this string tokenizer  as a bool.
134 >     */
135 >    bool nextTokenAsBool();
136  
137 <        /**
138 <         * Returns the next token from this string tokenizer as an integer.
139 <         * @return the next token from this string tokenizer  as an integer.
140 <         */
141 <        int nextTokenAsInt();
137 >    /**
138 >     * Returns the next token from this string tokenizer as an integer.
139 >     * @return the next token from this string tokenizer  as an integer.
140 >     */
141 >    int nextTokenAsInt();
142  
143 <        /**
144 <         * Returns the next token from this string tokenizer as a float.
145 <         * @return the next token from this string tokenizer as a float.
146 <         */
147 <        float nextTokenAsFloat();
143 >    /**
144 >     * Returns the next token from this string tokenizer as a float.
145 >     * @return the next token from this string tokenizer as a float.
146 >     */
147 >    float nextTokenAsFloat();
148  
149 <        /**
150 <         * Returns the next token from this string tokenizer as a double.
151 <         * @return the next token from this string tokenizer as a double.
152 <         */
153 <        double nextTokenAsDouble();
149 >    /**
150 >     * Returns the next token from this string tokenizer as a double.
151 >     * @return the next token from this string tokenizer as a double.
152 >     */
153 >    double nextTokenAsDouble();
154  
155 <        /**
156 <         * Returns the next token without advancing the position of the StringTokenizer.
157 <         * @return the next token
158 <         */
159 <        std::string  peekNextToken();
155 >    /**
156 >     * Returns the next token without advancing the position of the StringTokenizer.
157 >     * @return the next token
158 >     */
159 >    std::string  peekNextToken();
160  
161 <        /**
162 <         * Returns the current delimiter set of this string tokenizer
163 <         * @return the current delimiter set
164 <         */
165 <        const std::string& getDelimiters() {
166 <            return delim_;
167 <        }
161 >    /**
162 >     * Returns the current delimiter set of this string tokenizer
163 >     * @return the current delimiter set
164 >     */
165 >    const std::string& getDelimiters() {
166 >      return delim_;
167 >    }
168  
169 <        /**
170 <         * Returns the original string before tokenizing.
171 <         * @return the original string before tokenizing
172 <         */
173 <        const std::string& getOriginal() {
174 <            return tokenString_;
175 <        }
169 >    /**
170 >     * Returns the original string before tokenizing.
171 >     * @return the original string before tokenizing
172 >     */
173 >    const std::string& getOriginal() {
174 >      return tokenString_;
175 >    }
176  
177 <    private:
177 >    /**
178 >     * Returns all of the tokens
179 >     * @return all of the tokens
180 >     */
181 >    std::vector<std::string> getAllTokens();
182 >  private:
183  
184 <        /**
185 <         * Test if character is in current delimiter set.
186 <         * @param c character to be tested
187 <         * @return true if character is in current delimiter set, flase otherwise.
188 <         */
189 <        bool isDelimiter(const char c);
184 >    /**
185 >     * Test if character is in current delimiter set.
186 >     * @param c character to be tested
187 >     * @return true if character is in current delimiter set, flase otherwise.
188 >     */
189 >    bool isDelimiter(const char c);
190  
191 <        /** convert a fortran number to a c/c++ number */
192 <        void convertFortranNumber(std::string& fortranNumber);
191 >    /** convert a fortran number to a c/c++ number */
192 >    void convertFortranNumber(std::string& fortranNumber);
193          
194  
195 <        std::string tokenString_;
195 >    std::string tokenString_;
196  
197 <        std::string delim_;         /**< current delimiter set of this string tokenizer */
197 >    std::string delim_;         /**< current delimiter set of this string tokenizer */
198  
199 <        bool returnTokens_; /**< flag indicating whether to return the delimiters as tokens */
199 >    bool returnTokens_; /**< flag indicating whether to return the delimiters as tokens */
200  
201 <        std::string::const_iterator currentPos_;
202 <        std::string::const_iterator end_;
203 < };
201 >    std::string::const_iterator currentPos_;
202 >    std::string::const_iterator end_;
203 >  };
204  
205   }                               //namespace oopse
206  

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines