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

Comparing trunk/src/utils/StringTokenizer.hpp (file contents):
Revision 101 by tim, Mon Oct 18 23:13:23 2004 UTC vs.
Revision 1390 by gezelter, Wed Nov 25 20:02:06 2009 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. Redistributions of source code must retain the above copyright
10 + *    notice, this list of conditions and the following disclaimer.
11 + *
12 + * 2. Redistributions in binary form must reproduce the above copyright
13 + *    notice, this list of conditions and the following disclaimer in the
14 + *    documentation and/or other materials provided with the
15 + *    distribution.
16 + *
17 + * This software is provided "AS IS," without a warranty of any
18 + * kind. All express or implied conditions, representations and
19 + * warranties, including any implied warranty of merchantability,
20 + * fitness for a particular purpose or non-infringement, are hereby
21 + * excluded.  The University of Notre Dame and its licensors shall not
22 + * be liable for any damages suffered by licensee as a result of
23 + * using, modifying or distributing the software or its
24 + * derivatives. In no event will the University of Notre Dame or its
25 + * licensors be liable for any lost revenue, profit or data, or for
26 + * direct, indirect, special, consequential, incidental or punitive
27 + * damages, however caused and regardless of the theory of liability,
28 + * arising out of the use of or inability to use software, even if the
29 + * University of Notre Dame has been advised of the possibility of
30 + * such damages.
31 + *
32 + * SUPPORT OPEN SCIENCE!  If you use OpenMD or its source code in your
33 + * research, please cite the appropriate papers when you publish your
34 + * work.  Good starting points are:
35 + *                                                                      
36 + * [1]  Meineke, et al., J. Comp. Chem. 26, 252-271 (2005).            
37 + * [2]  Fennell & Gezelter, J. Chem. Phys. 124, 234104 (2006).          
38 + * [3]  Sun, Lin & Gezelter, J. Chem. Phys. 128, 24107 (2008).          
39 + * [4]  Vardeman & Gezelter, in progress (2009).                        
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 <string>
54 + #include <stdlib.h>
55   #include <vector>
56 + #include "config.h"
57 + namespace OpenMD {
58  
59 < #include "util/NoSuchElementException.hpp"
59 >  /**
60 >   * @class StringTokenizer.hpp "util/StringTokenizer.hpp"
61 >   * @brief The string tokenizer class allows an application to break a string into tokens
62 >   * The set of delimiters (the characters that separate tokens) may be specified either
63 >   * at creation time or on a per-token basis.
64 >   * An instance of StringTokenizer behaves in one of two ways, depending on whether it was
65 >   * created with the returnTokens flag having the value true or false.
66 >   */
67 >  class StringTokenizer {
68 >  public:
69  
70 < namespace oopse{
70 >    /**
71 >     * Constructs a string tokenizer for the specified string. The characters in the delim argument
72 >     * are the delimiters for separating tokens. characters are skipped and only serve as
73 >     * separators between tokens.
74 >     * @param str a string to be parsed.
75 >     * @param delim the delimiters, default value is " ;\t\n\r".
76 >     * @note this is still a little bit java like implementation. Pure c++ one should use TokenIterator.
77 >     * Boost's tokenizer class is one of them
78 >     */
79 >    StringTokenizer(const std::string & str,
80 >                    const std::string & delim = " ;\t\n\r");
81  
82      /**
83 <     * @class StringTokenizer.hpp "util/StringTokenizer.hpp"
84 <     *
85 <     * @brief The string tokenizer class allows an application to break a string into tokens
86 <     *
87 <     * The set of delimiters (the characters that separate tokens) may be specified either
88 <     * at creation time or on a per-token basis.
89 <     * An instance of StringTokenizer behaves in one of two ways, depending on whether it was
90 <     * created with the returnTokens flag having the value true or false.
83 >     * Constructs a string tokenizer for an iterator range [first, last). The characters in the delim argument
84 >     * are the delimiters for separating tokens. characters are skipped and only serve as
85 >     * separators between tokens.
86 >     * @param first begin iterator
87 >     * @param last end iterator
88 >     * @param delim the delimiters, default value is " ;\t\n\r".
89 >     * @note this is still a little bit java like implementation. Pure c++ one should use TokenIterator.
90 >     * Boost's tokenizer class is one of them
91       */
92 <    class StringTokenizer{
93 <    
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");
92 >    StringTokenizer(std::string::const_iterator& first, std::string::const_iterator& last,
93 >                    const std::string & delim = " ;\t\n\r");
94  
95 <            /**
96 <             * Constructs a string tokenizer for the specified string. The characters in the delim argument
97 <             * are the delimiters for separating tokens.
98 <             * If the returnTokens flag is true, then the delimiter characters are also returned as tokens.
99 <             * Each delimiter is returned as a string of length one. If the flag is false, the delimiter
100 <             * characters are skipped and only serve as separators between tokens.
101 <             * @param str a string to be parsed.
102 <             * @param delim the delimiters.
103 <             * @param returnTokens flag indicating whether to return the delimiters as tokens.
104 <             */
105 <            StringTokenizer(const std::string& str, const std::string& delim, bool returnTokens);
95 >    /**
96 >     * Constructs a string tokenizer for the specified string. The characters in the delim argument
97 >     * are the delimiters for separating tokens.
98 >     * If the returnTokens flag is true, then the delimiter characters are also returned as tokens.
99 >     * Each delimiter is returned as a string of length one. If the flag is false, the delimiter
100 >     * characters are skipped and only serve as separators between tokens.
101 >     * @param str a string to be parsed.
102 >     * @param delim the delimiters.
103 >     * @param returnTokens flag indicating whether to return the delimiters as tokens.
104 >     */
105 >    StringTokenizer(const std::string&str, const std::string&delim,
106 >                    bool returnTokens);
107  
108 <            /**
109 <             * Calculates the number of times that this tokenizer's nextToken method can be called
110 <             * before it generates an exception.
111 <             *
112 <             * @return the number of tokens remaining in the string using the current delimiter set.
113 <             */
84 <            int countTokens();
108 >    /**
109 >     * Calculates the number of times that this tokenizer's nextToken method can be called
110 >     * before it generates an exception.
111 >     * @return the number of tokens remaining in the string using the current delimiter set.
112 >     */
113 >    int countTokens();
114  
115 <            /**
116 <             * Tests if there are more tokens available from this tokenizer's string.
117 <             *
118 <             * @return true if there are more tokens available from this tokenizer's string, false otherwise
119 <             */
91 <            bool hasMoreTokens();
115 >    /**
116 >     * Tests if there are more tokens available from this tokenizer's string.
117 >     * @return true if there are more tokens available from this tokenizer's string, false otherwise
118 >     */
119 >    bool hasMoreTokens();
120  
121 <            /**
122 <             * Returns the next token from this string tokenizer.
123 <             *
124 <             * @return the next token from this string tokenizer.
125 <             *
126 <             * @exception NoSuchElementException if there are no more tokens in this tokenizer's string
99 <             */
100 <            std::string nextToken();
121 >    /**
122 >     * Returns the next token from this string tokenizer.
123 >     * @return the next token from this string tokenizer.
124 >     * @exception NoSuchElementException if there are no more tokens in this tokenizer's string
125 >     */
126 >    std::string nextToken();
127  
128 <            /**
129 <             * Returns the next token in this string tokenizer's string. The new delimiter set remains the
130 <             * default after this call.
131 <             *
132 <             * @param newDelim the new delimiters.
133 <             *
134 <             * @return the next token, after switching to the new delimiter set.
135 <             *
136 <             * @exception NoSuchElementException if there are no more tokens in this tokenizer's string.
111 <             *
112 <             */
113 <            std::string nextToken(const std::string& newDelim);
128 >    //actually, nextToken Can be template function
129 >    //template <typename ReturnType>
130 >    //ReturnType nextToken();
131 >        
132 >    /**
133 >     * Returns the next token from this string tokenizer as a bool.
134 >     * @return the next token from this string tokenizer  as a bool.
135 >     */
136 >    bool nextTokenAsBool();
137  
138 <            /**
139 <             * Returns the current delimiter set of this string tokenizer
140 <             *
141 <             * @return the current delimiter set
142 <             */
120 <            std::string getDelimiter();
138 >    /**
139 >     * Returns the next token from this string tokenizer as an integer.
140 >     * @return the next token from this string tokenizer  as an integer.
141 >     */
142 >    int nextTokenAsInt();
143  
144 <        private:
145 <            
146 <            /**
147 <             * Test if character is in current delimiter set.
148 <             *
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 */
144 >    /**
145 >     * Returns the next token from this string tokenizer as a float.
146 >     * @return the next token from this string tokenizer as a float.
147 >     */
148 >    float nextTokenAsFloat();
149  
150 <            bool returnTokens_; /**< flag indicating whether to return the delimiters as tokens */
151 <    };
150 >    /**
151 >     * Returns the next token from this string tokenizer as a RealType.
152 >     * @return the next token from this string tokenizer as a RealType.
153 >     */
154 >    RealType nextTokenAsDouble();
155  
156 +    /**
157 +     * Returns the next token without advancing the position of the StringTokenizer.
158 +     * @return the next token
159 +     */
160 +    std::string  peekNextToken();
161  
162 < } //namespace oopse
163 < #endif //UTIL_STRINGTOKENIZER_HPP
162 >    /**
163 >     * Returns the current delimiter set of this string tokenizer
164 >     * @return the current delimiter set
165 >     */
166 >    const std::string& getDelimiters() {
167 >      return delim_;
168 >    }
169 >
170 >    /**
171 >     * Returns the original string before tokenizing.
172 >     * @return the original string before tokenizing
173 >     */
174 >    const std::string& getOriginal() {
175 >      return tokenString_;
176 >    }
177 >
178 >    /**
179 >     * Returns all of the tokens
180 >     * @return all of the tokens
181 >     */
182 >    std::vector<std::string> getAllTokens();
183 >  private:
184 >
185 >    /**
186 >     * Test if character is in current delimiter set.
187 >     * @param c character to be tested
188 >     * @return true if character is in current delimiter set, flase otherwise.
189 >     */
190 >    bool isDelimiter(const char c);
191 >
192 >    /** convert a fortran number to a c/c++ number */
193 >    void convertFortranNumber(std::string& fortranNumber);
194 >        
195 >
196 >    std::string tokenString_;
197 >
198 >    std::string delim_;         /**< current delimiter set of this string tokenizer */
199 >
200 >    bool returnTokens_; /**< flag indicating whether to return the delimiters as tokens */
201 >
202 >    std::string::const_iterator currentPos_;
203 >    std::string::const_iterator end_;
204 >  };
205 >
206 > }                               //namespace OpenMD
207 >
208 > #endif                          //UTIL_STRINGTOKENIZER_HPP

Diff Legend

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