ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/group/trunk/OOPSE-4/src/utils/StringTokenizer.hpp
(Generate patch)

Comparing trunk/OOPSE-4/src/utils/StringTokenizer.hpp (file contents):
Revision 1594 by tim, Mon Oct 18 23:13:23 2004 UTC vs.
Revision 2204 by gezelter, Fri Apr 15 22:04:00 2005 UTC

# Line 1 | Line 1
1   /*
2 < * Copyright (C) 2000-2004  Object Oriented Parallel Simulation Engine (OOPSE) project
3 < *
4 < * Contact: oopse@oopse.org
5 < *
6 < * This program is free software; you can redistribute it and/or
7 < * modify it under the terms of the GNU Lesser General Public License
8 < * as published by the Free Software Foundation; either version 2.1
9 < * of the License, or (at your option) any later version.
10 < * All we ask is that proper credit is given for our work, which includes
11 < * - but is not limited to - adding the above copyright notice to the beginning
12 < * of your source code files, and to any copyright notice that you may distribute
13 < * with programs based on this work.
14 < *
15 < * This program is distributed in the hope that it will be useful,
16 < * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 < * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 < * GNU Lesser General Public License for more details.
19 < *
20 < * You should have received a copy of the GNU Lesser General Public License
21 < * along with this program; if not, write to the Free Software
22 < * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
2 > * Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
3   *
4 + * The University of Notre Dame grants you ("Licensee") a
5 + * non-exclusive, royalty free, license to use, modify and
6 + * redistribute this software in source and binary code form, provided
7 + * that the following conditions are met:
8 + *
9 + * 1. Acknowledgement of the program authors must be made in any
10 + *    publication of scientific results based in part on use of the
11 + *    program.  An acceptable form of acknowledgement is citation of
12 + *    the article in which the program was described (Matthew
13 + *    A. Meineke, Charles F. Vardeman II, Teng Lin, Christopher
14 + *    J. Fennell and J. Daniel Gezelter, "OOPSE: An Object-Oriented
15 + *    Parallel Simulation Engine for Molecular Dynamics,"
16 + *    J. Comput. Chem. 26, pp. 252-271 (2005))
17 + *
18 + * 2. Redistributions of source code must retain the above copyright
19 + *    notice, this list of conditions and the following disclaimer.
20 + *
21 + * 3. Redistributions in binary form must reproduce the above copyright
22 + *    notice, this list of conditions and the following disclaimer in the
23 + *    documentation and/or other materials provided with the
24 + *    distribution.
25 + *
26 + * This software is provided "AS IS," without a warranty of any
27 + * kind. All express or implied conditions, representations and
28 + * warranties, including any implied warranty of merchantability,
29 + * fitness for a particular purpose or non-infringement, are hereby
30 + * excluded.  The University of Notre Dame and its licensors shall not
31 + * be liable for any damages suffered by licensee as a result of
32 + * using, modifying or distributing the software or its
33 + * derivatives. In no event will the University of Notre Dame or its
34 + * licensors be liable for any lost revenue, profit or data, or for
35 + * direct, indirect, special, consequential, incidental or punitive
36 + * damages, however caused and regardless of the theory of liability,
37 + * arising out of the use of or inability to use software, even if the
38 + * University of Notre Dame has been advised of the possibility of
39 + * such damages.
40   */
25 –
26 – /**
27 –  * @file StringTokenizer.hpp
28 –  * @author tlin
29 –  * @date 09/20/2004
30 –  * @time 11:30am
31 –  * @version 1.0
32 –  */
41  
42 + /**
43 + * @file StringTokenizer.hpp
44 + * @author tlin
45 + * @date 09/20/2004
46 + * @time 11:30am
47 + * @version 1.0
48 + */
49 +
50   #ifndef UTIL_STRINGTOKENIZER_HPP
51   #define UTIL_STRINGTOKENIZER_HPP
52  
53 < #include <vector>
53 > #include <string>
54  
55 < #include "util/NoSuchElementException.hpp"
55 > namespace oopse {
56  
57 < namespace oopse{
57 >  /**
58 >   * @class StringTokenizer.hpp "util/StringTokenizer.hpp"
59 >   * @brief The string tokenizer class allows an application to break a string into tokens
60 >   * The set of delimiters (the characters that separate tokens) may be specified either
61 >   * at creation time or on a per-token basis.
62 >   * An instance of StringTokenizer behaves in one of two ways, depending on whether it was
63 >   * created with the returnTokens flag having the value true or false.
64 >   */
65 >  class StringTokenizer {
66 >  public:
67  
68      /**
69 <     * @class StringTokenizer.hpp "util/StringTokenizer.hpp"
70 <     *
71 <     * @brief The string tokenizer class allows an application to break a string into tokens
72 <     *
73 <     * The set of delimiters (the characters that separate tokens) may be specified either
74 <     * at creation time or on a per-token basis.
75 <     * An instance of StringTokenizer behaves in one of two ways, depending on whether it was
51 <     * created with the returnTokens flag having the value true or false.
69 >     * Constructs a string tokenizer for the specified string. The characters in the delim argument
70 >     * are the delimiters for separating tokens. characters are skipped and only serve as
71 >     * separators between tokens.
72 >     * @param str a string to be parsed.
73 >     * @param delim the delimiters, default value is " ;\t\n\r".
74 >     * @note this is still a little bit java like implementation. Pure c++ one should use TokenIterator.
75 >     * Boost's tokenizer class is one of them
76       */
77 <    class StringTokenizer{
78 <    
55 <        public:
56 <            
57 <            /**
58 <             * Constructs a string tokenizer for the specified string. The characters in the delim argument
59 <             * are the delimiters for separating tokens. characters are skipped and only serve as
60 <             * separators between tokens.
61 <             * @param str a string to be parsed.
62 <             * @param delim the delimiters, default value is "\t\n\r".
63 <             */
64 <            StringTokenizer(const std::string& str, const std::string& delim = "\t\n\r");
77 >    StringTokenizer(const std::string & str,
78 >                    const std::string & delim = " ;\t\n\r");
79  
80 <            /**
81 <             * Constructs a string tokenizer for the specified string. The characters in the delim argument
82 <             * are the delimiters for separating tokens.
83 <             * If the returnTokens flag is true, then the delimiter characters are also returned as tokens.
84 <             * Each delimiter is returned as a string of length one. If the flag is false, the delimiter
85 <             * characters are skipped and only serve as separators between tokens.
86 <             * @param str a string to be parsed.
87 <             * @param delim the delimiters.
88 <             * @param returnTokens flag indicating whether to return the delimiters as tokens.
89 <             */
90 <            StringTokenizer(const std::string& str, const std::string& delim, bool returnTokens);
80 >    /**
81 >     * Constructs a string tokenizer for an iterator range [first, last). The characters in the delim argument
82 >     * are the delimiters for separating tokens. characters are skipped and only serve as
83 >     * separators between tokens.
84 >     * @param first begin iterator
85 >     * @param last end iterator
86 >     * @param delim the delimiters, default value is " ;\t\n\r".
87 >     * @note this is still a little bit java like implementation. Pure c++ one should use TokenIterator.
88 >     * Boost's tokenizer class is one of them
89 >     */
90 >    StringTokenizer(std::string::const_iterator& first, std::string::const_iterator& last,
91 >                    const std::string & delim = " ;\t\n\r");
92  
93 <            /**
94 <             * Calculates the number of times that this tokenizer's nextToken method can be called
95 <             * before it generates an exception.
96 <             *
97 <             * @return the number of tokens remaining in the string using the current delimiter set.
98 <             */
99 <            int countTokens();
93 >    /**
94 >     * Constructs a string tokenizer for the specified string. The characters in the delim argument
95 >     * are the delimiters for separating tokens.
96 >     * If the returnTokens flag is true, then the delimiter characters are also returned as tokens.
97 >     * Each delimiter is returned as a string of length one. If the flag is false, the delimiter
98 >     * characters are skipped and only serve as separators between tokens.
99 >     * @param str a string to be parsed.
100 >     * @param delim the delimiters.
101 >     * @param returnTokens flag indicating whether to return the delimiters as tokens.
102 >     */
103 >    StringTokenizer(const std::string&str, const std::string&delim,
104 >                    bool returnTokens);
105  
106 <            /**
107 <             * Tests if there are more tokens available from this tokenizer's string.
108 <             *
109 <             * @return true if there are more tokens available from this tokenizer's string, false otherwise
110 <             */
111 <            bool hasMoreTokens();
106 >    /**
107 >     * Calculates the number of times that this tokenizer's nextToken method can be called
108 >     * before it generates an exception.
109 >     * @return the number of tokens remaining in the string using the current delimiter set.
110 >     */
111 >    int countTokens();
112  
113 <            /**
114 <             * Returns the next token from this string tokenizer.
115 <             *
116 <             * @return the next token from this string tokenizer.
117 <             *
98 <             * @exception NoSuchElementException if there are no more tokens in this tokenizer's string
99 <             */
100 <            std::string nextToken();
113 >    /**
114 >     * Tests if there are more tokens available from this tokenizer's string.
115 >     * @return true if there are more tokens available from this tokenizer's string, false otherwise
116 >     */
117 >    bool hasMoreTokens();
118  
119 <            /**
120 <             * Returns the next token in this string tokenizer's string. The new delimiter set remains the
121 <             * default after this call.
122 <             *
123 <             * @param newDelim the new delimiters.
124 <             *
108 <             * @return the next token, after switching to the new delimiter set.
109 <             *
110 <             * @exception NoSuchElementException if there are no more tokens in this tokenizer's string.
111 <             *
112 <             */
113 <            std::string nextToken(const std::string& newDelim);
119 >    /**
120 >     * Returns the next token from this string tokenizer.
121 >     * @return the next token from this string tokenizer.
122 >     * @exception NoSuchElementException if there are no more tokens in this tokenizer's string
123 >     */
124 >    std::string nextToken();
125  
126 <            /**
127 <             * Returns the current delimiter set of this string tokenizer
128 <             *
129 <             * @return the current delimiter set
130 <             */
131 <            std::string getDelimiter();
126 >    //actually, nextToken Can be template function
127 >    //template <typename ReturnType>
128 >    //ReturnType nextToken();
129 >        
130 >    /**
131 >     * Returns the next token from this string tokenizer as a bool.
132 >     * @return the next token from this string tokenizer  as a bool.
133 >     */
134 >    bool nextTokenAsBool();
135  
136 <        private:
137 <            
138 <            /**
139 <             * Test if character is in current delimiter set.
140 <             *
127 <             * @param c character to be tested
128 <             *
129 <             * @return true if character is in current delimiter set, flase otherwise.
130 <             */
131 <            bool isDelimiter(char c);
132 <            
133 <            std::string delim_;  /**< current delimiter set of this string tokenizer */
136 >    /**
137 >     * Returns the next token from this string tokenizer as an integer.
138 >     * @return the next token from this string tokenizer  as an integer.
139 >     */
140 >    int nextTokenAsInt();
141  
142 <            bool returnTokens_; /**< flag indicating whether to return the delimiters as tokens */
143 <    };
142 >    /**
143 >     * Returns the next token from this string tokenizer as a float.
144 >     * @return the next token from this string tokenizer as a float.
145 >     */
146 >    float nextTokenAsFloat();
147  
148 +    /**
149 +     * Returns the next token from this string tokenizer as a double.
150 +     * @return the next token from this string tokenizer as a double.
151 +     */
152 +    double nextTokenAsDouble();
153  
154 < } //namespace oopse
155 < #endif //UTIL_STRINGTOKENIZER_HPP
154 >    /**
155 >     * Returns the next token without advancing the position of the StringTokenizer.
156 >     * @return the next token
157 >     */
158 >    std::string  peekNextToken();
159 >
160 >    /**
161 >     * Returns the current delimiter set of this string tokenizer
162 >     * @return the current delimiter set
163 >     */
164 >    const std::string& getDelimiters() {
165 >      return delim_;
166 >    }
167 >
168 >    /**
169 >     * Returns the original string before tokenizing.
170 >     * @return the original string before tokenizing
171 >     */
172 >    const std::string& getOriginal() {
173 >      return tokenString_;
174 >    }
175 >
176 >  private:
177 >
178 >    /**
179 >     * Test if character is in current delimiter set.
180 >     * @param c character to be tested
181 >     * @return true if character is in current delimiter set, flase otherwise.
182 >     */
183 >    bool isDelimiter(const char c);
184 >
185 >    /** convert a fortran number to a c/c++ number */
186 >    void convertFortranNumber(std::string& fortranNumber);
187 >        
188 >
189 >    std::string tokenString_;
190 >
191 >    std::string delim_;         /**< current delimiter set of this string tokenizer */
192 >
193 >    bool returnTokens_; /**< flag indicating whether to return the delimiters as tokens */
194 >
195 >    std::string::const_iterator currentPos_;
196 >    std::string::const_iterator end_;
197 >  };
198 >
199 > }                               //namespace oopse
200 >
201 > #endif                          //UTIL_STRINGTOKENIZER_HPP

Diff Legend

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