src/utils/StringTokenizer.hpp

/*
 * Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
 *
 * The University of Notre Dame grants you ("Licensee") a
 * non-exclusive, royalty free, license to use, modify and
 * redistribute this software in source and binary code form, provided
 * that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 * This software is provided "AS IS," without a warranty of any
 * kind. All express or implied conditions, representations and
 * warranties, including any implied warranty of merchantability,
 * fitness for a particular purpose or non-infringement, are hereby
 * excluded.  The University of Notre Dame and its licensors shall not
 * be liable for any damages suffered by licensee as a result of
 * using, modifying or distributing the software or its
 * derivatives. In no event will the University of Notre Dame or its
 * licensors be liable for any lost revenue, profit or data, or for
 * direct, indirect, special, consequential, incidental or punitive
 * damages, however caused and regardless of the theory of liability,
 * arising out of the use of or inability to use software, even if the
 * University of Notre Dame has been advised of the possibility of
 * such damages.
 *
 * SUPPORT OPEN SCIENCE!  If you use OpenMD or its source code in your
 * research, please cite the appropriate papers when you publish your
 * work.  Good starting points are:
 *                                                                      
 * [1]  Meineke, et al., J. Comp. Chem. 26, 252-271 (2005).             
 * [2]  Fennell & Gezelter, J. Chem. Phys. 124, 234104 (2006).          
 * [3]  Sun, Lin & Gezelter, J. Chem. Phys. 128, 24107 (2008).          
 * [4]  Kuang & Gezelter,  J. Chem. Phys. 133, 164101 (2010).
 * [5]  Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
 */
 
/**
 * @file StringTokenizer.hpp
 * @author tlin
 * @date 09/20/2004
 * @time 11:30am
 * @version 1.0
 */

#ifndef UTIL_STRINGTOKENIZER_HPP
#define UTIL_STRINGTOKENIZER_HPP

#include <string>
#include <stdlib.h>
#include <vector>
#include "config.h"
namespace OpenMD {

  /**
   * @class StringTokenizer.hpp "util/StringTokenizer.hpp"
   * @brief The string tokenizer class allows an application to break a string into tokens
   * The set of delimiters (the characters that separate tokens) may be specified either 
   * at creation time or on a per-token basis. 
   * An instance of StringTokenizer behaves in one of two ways, depending on whether it was 
   * created with the returnTokens flag having the value true or false.
   */
  class StringTokenizer {
  public:

    /**
     * Constructs a string tokenizer for the specified string. The characters in the delim argument
     * are the delimiters for separating tokens. characters are skipped and only serve as 
     * separators between tokens.
     * @param str a string to be parsed.
     * @param delim the delimiters, default value is " ;\t\n\r".
     * @note this is still a little bit java like implementation. Pure c++ one should use TokenIterator.
     * Boost's tokenizer class is one of them 
     */
    StringTokenizer(const std::string & str,
                    const std::string & delim = " ;\t\n\r");

    /**
     * Constructs a string tokenizer for an iterator range [first, last). The characters in the delim argument
     * are the delimiters for separating tokens. characters are skipped and only serve as 
     * separators between tokens.
     * @param first begin iterator
     * @param last end iterator
     * @param delim the delimiters, default value is " ;\t\n\r".
     * @note this is still a little bit java like implementation. Pure c++ one should use TokenIterator.
     * Boost's tokenizer class is one of them 
     */
    StringTokenizer(std::string::const_iterator& first, std::string::const_iterator& last,
                    const std::string & delim = " ;\t\n\r");

    /**
     * Constructs a string tokenizer for the specified string. The characters in the delim argument
     * are the delimiters for separating tokens. 
     * If the returnTokens flag is true, then the delimiter characters are also returned as tokens. 
     * Each delimiter is returned as a string of length one. If the flag is false, the delimiter 
     * characters are skipped and only serve as separators between tokens.
     * @param str a string to be parsed. 
     * @param delim the delimiters. 
     * @param returnTokens flag indicating whether to return the delimiters as tokens.
     */
    StringTokenizer(const std::string&str, const std::string&delim,
                    bool returnTokens);

    /**
     * Calculates the number of times that this tokenizer's nextToken method can be called 
     * before it generates an exception.
     * @return the number of tokens remaining in the string using the current delimiter set.
     */
    int countTokens();

    /**
     * Tests if there are more tokens available from this tokenizer's string.
     * @return true if there are more tokens available from this tokenizer's string, false otherwise
     */
    bool hasMoreTokens();

    /**
     * Returns the next token from this string tokenizer.
     * @return the next token from this string tokenizer.
     * @exception NoSuchElementException if there are no more tokens in this tokenizer's string
     */
    std::string nextToken();

    //actually, nextToken Can be template function
    //template <typename ReturnType>
    //ReturnType nextToken();
        
    /**
     * Returns the next token from this string tokenizer as a bool.
     * @return the next token from this string tokenizer  as a bool.
     */
    bool nextTokenAsBool();

    /**
     * Returns the next token from this string tokenizer as an integer.
     * @return the next token from this string tokenizer  as an integer.
     */
    int nextTokenAsInt();

    /**
     * Returns the next token from this string tokenizer as a float.
     * @return the next token from this string tokenizer as a float.
     */
    float nextTokenAsFloat();

    /**
     * Returns the next token from this string tokenizer as a RealType.
     * @return the next token from this string tokenizer as a RealType.
     */
    RealType nextTokenAsDouble();

    /**
     * Returns the next token without advancing the position of the StringTokenizer.
     * @return the next token
     */
    std::string  peekNextToken();

    /**
     * Returns the current delimiter set of this string tokenizer
     * @return the current delimiter set
     */
    const std::string& getDelimiters() {
      return delim_;
    }

    /** 
     * Returns the original string before tokenizing.
     * @return the original string before tokenizing 
     */
    const std::string& getOriginal() {
      return tokenString_;
    }

    /** 
     * Returns all of the tokens
     * @return all of the tokens
     */
    std::vector<std::string> getAllTokens();
  private:

    /**
     * Test if character is in current delimiter set.
     * @param c character to be tested
     * @return true if character is in current delimiter set, flase otherwise.
     */
    bool isDelimiter(const char c);

    /** convert a fortran number to a c/c++ number */
    void convertFortranNumber(std::string& fortranNumber);
         

    std::string tokenString_;

    std::string delim_;         /**< current delimiter set of this string tokenizer */

    bool returnTokens_; /**< flag indicating whether to return the delimiters as tokens */

    std::string::const_iterator currentPos_;
    std::string::const_iterator end_;
  };

}                               //namespace OpenMD

#endif                          //UTIL_STRINGTOKENIZER_HPP
Revision:	1782
Committed:	Wed Aug 22 02:28:28 2012 UTC (13 years, 2 months ago) by gezelter
File size:	8002 byte(s)
Log Message:	MERGE OpenMD development branch 1465:1781 into trunk
#	Content
1	/*
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] Kuang & Gezelter, J. Chem. Phys. 133, 164101 (2010).
40	* [5] Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
41	*/
42
43	/**
44	* @file StringTokenizer.hpp
45	* @author tlin
46	* @date 09/20/2004
47	* @time 11:30am
48	* @version 1.0
49	*/
50
51	#ifndef UTIL_STRINGTOKENIZER_HPP
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	/**
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	* 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 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 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	* @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	* @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	* @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	//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();
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();
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();
150
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();
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	}
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	}
178
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);
192
193	/** convert a fortran number to a c/c++ number */
194	void convertFortranNumber(std::string& fortranNumber);
195
196
197	std::string tokenString_;
198
199	std::string delim_; /*< current delimiter set of this string tokenizer /
200
201	bool returnTokens_; /*< flag indicating whether to return the delimiters as tokens /
202
203	std::string::const_iterator currentPos_;
204	std::string::const_iterator end_;
205	};
206
207	} //namespace OpenMD
208
209	#endif //UTIL_STRINGTOKENIZER_HPP