ViewVC Help

View File | Revision Log | Show Annotations | View Changeset | Root Listing

root/OpenMD/trunk/src/utils/StringTokenizer.hpp

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

Comparing trunk/src/utils/StringTokenizer.hpp (property svn:keywords):
Revision 246 by gezelter, Wed Jan 12 22:41:40 2005 UTC vs.
Revision 1782 by gezelter, Wed Aug 22 02:28:28 2012 UTC

#	Line 0 | Line 1
1	+	Author Id Revision Date

Diff Legend

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