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 101 by tim, Mon Oct 18 23:13:23 2004 UTC vs.
Revision 2073 by gezelter, Sat Mar 7 23:52:07 2015 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, 234107 (2008).
39	+	* [4]  Kuang & Gezelter,  J. Chem. Phys. 133, 164101 (2010).
40	+	* [5]  Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
41		*/
25	–
26	–	/**
27	–	* @file StringTokenizer.hpp
28	–	* @author tlin
29	–	* @date 09/20/2004
30	–	* @time 11:30am
31	–	* @version 1.0
32	–	*/
42
43	+	/**
44	+	* @file StringTokenizer.hpp
45	+	* @author tlin
46	+	* @date 09/20/2004
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
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	<
94	<	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,
93	>	std::string::const_iterator& last,
94	>	const std::string & delim = " ;\t\n\r");
95
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, bool returnTokens);
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	<	* Calculates the number of times that this tokenizer's nextToken method can be called
111	<	* before it generates an exception.
112	<	*
113	<	* @return the number of tokens remaining in the string using the current delimiter set.
114	<	*/
84	<	int countTokens();
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	<	* Tests if there are more tokens available from this tokenizer's string.
118	<	*
119	<	* @return true if there are more tokens available from this tokenizer's string, false otherwise
120	<	*/
91	<	bool hasMoreTokens();
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	<	* Returns the next token from this string tokenizer.
124	<	*
125	<	* @return the next token from this string tokenizer.
126	<	*
127	<	* @exception NoSuchElementException if there are no more tokens in this tokenizer's string
99	<	*/
100	<	std::string nextToken();
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 in this string tokenizer's string. The new delimiter set remains the
131	<	* default after this call.
132	<	*
133	<	* @param newDelim the new delimiters.
107	<	*
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);
129	>	/**
130	>	* Skips the next token from this string tokenizer.
131	>	* @exception NoSuchElementException if there are no more tokens in this tokenizer's string
132	>	*/
133	>	void skipToken();
134
135	<	/**
136	<	* Returns the current delimiter set of this string tokenizer
137	<	*
138	<	* @return the current delimiter set
139	<	*/
140	<	std::string getDelimiter();
135	>	//actually, nextToken Can be template function
136	>	//template <typename ReturnType>
137	>	//ReturnType nextToken();
138	>
139	>	/**
140	>	* Returns the next token from this string tokenizer as a bool.
141	>	* @return the next token from this string tokenizer  as a bool.
142	>	*/
143	>	bool nextTokenAsBool();
144
145	<	private:
146	<
147	<	/**
148	<	* Test if character is in current delimiter set.
149	<	*
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 */
145	>	/**
146	>	* Returns the next token from this string tokenizer as an integer.
147	>	* @return the next token from this string tokenizer  as an integer.
148	>	*/
149	>	int nextTokenAsInt();
150
151	<	bool returnTokens_; /**< flag indicating whether to return the delimiters as tokens */
152	<	};
151	>	/**
152	>	* Returns the next token from this string tokenizer as a float.
153	>	* @return the next token from this string tokenizer as a float.
154	>	*/
155	>	float nextTokenAsFloat();
156
157	+	/**
158	+	* Returns the next token from this string tokenizer as a RealType.
159	+	* @return the next token from this string tokenizer as a RealType.
160	+	*/
161	+	RealType nextTokenAsDouble();
162
163	<	} //namespace oopse
164	<	#endif //UTIL_STRINGTOKENIZER_HPP
163	>	/**
164	>	* Returns the next token without advancing the position of the StringTokenizer.
165	>	* @return the next token
166	>	*/
167	>	std::string  peekNextToken();
168	>
169	>	/**
170	>	* Returns the current delimiter set of this string tokenizer
171	>	* @return the current delimiter set
172	>	*/
173	>	const std::string& getDelimiters() {
174	>	return delim_;
175	>	}
176	>
177	>	/**
178	>	* Returns the original string before tokenizing.
179	>	* @return the original string before tokenizing
180	>	*/
181	>	const std::string& getOriginal() {
182	>	return tokenString_;
183	>	}
184	>
185	>	/**
186	>	* Returns all of the tokens
187	>	* @return all of the tokens
188	>	*/
189	>	std::vector<std::string> getAllTokens();
190	>	/**
191	>	* Returns the remaining unparsed string
192	>	* @return the remaining unparsed string
193	>	*/
194	>	std::string getRemainingString();
195	>	private:
196	>
197	>	/**
198	>	* Test if character is in current delimiter set.
199	>	* @param c character to be tested
200	>	* @return true if character is in current delimiter set, flase otherwise.
201	>	*/
202	>	bool isDelimiter(const char c);
203	>
204	>	/** convert a fortran number to a c/c++ number */
205	>	void convertFortranNumber(std::string& fortranNumber);
206	>
207	>
208	>	std::string tokenString_;
209	>
210	>	std::string delim_;         /**< current delimiter set of this string tokenizer */
211	>
212	>	bool returnTokens_; /**< flag indicating whether to return the delimiters as tokens */
213	>
214	>	std::string::const_iterator currentPos_;
215	>	std::string::const_iterator end_;
216	>	};
217	>
218	>	}                               //namespace OpenMD
219	>
220	>	#endif                          //UTIL_STRINGTOKENIZER_HPP

Comparing trunk/src/utils/StringTokenizer.hpp (property svn:keywords):
Revision 101 by tim, Mon Oct 18 23:13:23 2004 UTC vs.
Revision 2073 by gezelter, Sat Mar 7 23:52:07 2015 UTC

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

Diff Legend

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