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 1390 by gezelter, Wed Nov 25 20:02:06 2009 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 6 | Line 6
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
9 > * 1. Redistributions of source code must retain the above copyright
10   *    notice, this list of conditions and the following disclaimer.
11   *
12 < * 3. Redistributions in binary form must reproduce the above copyright
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.
# Line 37 | Line 28
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   */
41  
42   /**
# Line 51 | Line 51
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 < namespace oopse {
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 < /**
71 < * @class StringTokenizer.hpp "util/StringTokenizer.hpp"
72 < * @brief The string tokenizer class allows an application to break a string into tokens
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
76 < * created with the returnTokens flag having the value true or false.
77 < */
78 < class StringTokenizer {
79 <    public:
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 <         * Constructs a string tokenizer for the specified string. 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 str a string to be parsed.
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(const std::string & str,
92 <                        const std::string & delim = " ;\t\n\r");
82 >    /**
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 >    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 an iterator range [first, last). The characters in the delim argument
97 <         * are the delimiters for separating tokens. characters are skipped and only serve as
98 <         * separators between tokens.
99 <         * @param first begin iterator
100 <         * @param last end iterator
101 <         * @param delim the delimiters, default value is " ;\t\n\r".
102 <         * @note this is still a little bit java like implementation. Pure c++ one should use TokenIterator.
103 <         * Boost's tokenizer class is one of them
104 <         */
105 <        StringTokenizer(std::string::const_iterator& first, std::string::const_iterator& last,
106 <                        const std::string & delim = " ;\t\n\r");
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 <         * Constructs a string tokenizer for the specified string. The characters in the delim argument
110 <         * are the delimiters for separating tokens.
111 <         * If the returnTokens flag is true, then the delimiter characters are also returned as tokens.
112 <         * Each delimiter is returned as a string of length one. If the flag is false, the delimiter
113 <         * 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);
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 <         * Calculates the number of times that this tokenizer's nextToken method can be called
117 <         * before it generates an exception.
118 <         * @return the number of tokens remaining in the string using the current delimiter set.
119 <         */
111 <        int countTokens();
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 <         * Tests if there are more tokens available from this tokenizer's string.
123 <         * @return true if there are more tokens available from this tokenizer's string, false otherwise
124 <         */
125 <        bool hasMoreTokens();
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 from this string tokenizer.
130 <         * @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 <        //actually, nextToken Can be template function
127 <        //template <typename ReturnType>
128 <        //ReturnType nextToken();
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();
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 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();
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 <        /**
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();
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 <        /**
151 <         * Returns the next token from this string tokenizer as a double.
152 <         * @return the next token from this string tokenizer as a double.
153 <         */
154 <        double nextTokenAsDouble();
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();
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 <        /**
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 <        }
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 <        }
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 <    private:
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);
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);
192 >    /** convert a fortran number to a c/c++ number */
193 >    void convertFortranNumber(std::string& fortranNumber);
194          
195  
196 <        std::string tokenString_;
196 >    std::string tokenString_;
197  
198 <        std::string delim_;         /**< current delimiter set of this string tokenizer */
198 >    std::string delim_;         /**< current delimiter set of this string tokenizer */
199  
200 <        bool returnTokens_; /**< flag indicating whether to return the delimiters as tokens */
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 < };
202 >    std::string::const_iterator currentPos_;
203 >    std::string::const_iterator end_;
204 >  };
205  
206 < }                               //namespace oopse
206 > }                               //namespace OpenMD
207  
208   #endif                          //UTIL_STRINGTOKENIZER_HPP

Diff Legend

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