src/utils/StringUtils.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 StringUtils.hpp
 * @author Dan Gezelter
 * @date 10/18/2004
 * @version 1.0
 */

#ifndef UTILS_STRINGUTILS_HPP
#define UTILS_STRINGUTILS_HPP
#include <string>
#include <string.h>
#include <iostream>
#include <fstream>
#include <sstream>

namespace OpenMD {
 
  /**
   * Converts a string to UPPER CASE
   * @param S
   */
  std::string UpperCase(const std::string& S);

  /**
   * Converts a string to lower case
   * @param S
   */
  std::string LowerCase(const std::string& S);

  /**
   * Removes left and right spaces from a string
   *
   * @param str  String to trim
   *
   * @return  char* to the trimed string
   */
  char* trimSpaces(char *str);

  /**
   * Finds the location of the string "begin <startText>" in an input stream.
   * @param theStream
   * @param startText
   *
   * @return the line number of the block within the theStream
   */
  int findBegin(std::istream &theStream, const char* startText );

  /**
   * Counts the number of tokens on line which are delimited by the characters 
   * listed in delimiters
   * @param line
   * @param delimiters
   */
  int countTokens(char *line, char *delimiters);

  /**
   * discovers whether or not the line contains the "end" token
   *
   * @param line  The line to test
   * 
   * @return int  (==1 if the line has "end", ==0 if not).
   */
  int isEndLine(char *line);

  bool CaseInsensitiveEquals(char ch1, char ch2);

  size_t CaseInsensitiveFind(const std::string& str1, const std::string& str2);


  /**
   * Convert a variable to a string
   * @param T data type
   * @param v data to be converted
   * @return a string
   */
  template<typename T>
  std::string toString(const T& v) {
    std::ostringstream oss;        
    if (!oss << v) {
      std::cerr << "toString Error" << std::endl;
    }
    return oss.str();
  }
  
  template<typename T>
  T lexi_cast(const std::string& str) {
    T result;
    std::istringstream iss(str);        
    if (!(iss >> result)) {
      std::cerr << "lexi_cast Error" << std::endl;
    }
    return result;
  }


  template<typename T>
  bool isType(const std::string& str) {
    T result;
    std::istringstream iss(str);        
    bool ret = true;
    if (!(iss >> result)) {
        ret = false;
    }
    return ret;
  }

  bool isInteger(const std::string& str);
  
  std::string OpenMD_itoa(int value, unsigned int base = 10);
  
  /**@todo need implementation */
  std::string getPrefix(const std::string& str);
  
  /**@todo need implementation */
  std::string getSuffix(const std::string& str);
  

template<class ContainerType>
std::string containerToString(const ContainerType& cont) {
    std::ostringstream oss;
    oss << "(";
    typename ContainerType::const_iterator i = cont.begin();
    if (i != cont.end()) {
        oss << *i;
        ++i;
    }
    for (; i != cont.end();++i) {
        oss << ", ";
        oss << *i;
    }
    oss << ")";
    return oss.str();
}  

  unsigned long long memparse (char *ptr,  char **retptr); 
}  
#endif
Revision:	1665
Committed:	Tue Nov 22 20:38:56 2011 UTC (13 years, 5 months ago) by gezelter
File size:	5184 byte(s)
Log Message:	updated copyright notices
#	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 StringUtils.hpp
45	* @author Dan Gezelter
46	* @date 10/18/2004
47	* @version 1.0
48	*/
49
50	#ifndef UTILS_STRINGUTILS_HPP
51	#define UTILS_STRINGUTILS_HPP
52	#include <string>
53	#include <string.h>
54	#include <iostream>
55	#include <fstream>
56	#include <sstream>
57
58	namespace OpenMD {
59
60	/**
61	* Converts a string to UPPER CASE
62	* @param S
63	*/
64	std::string UpperCase(const std::string& S);
65
66	/**
67	* Converts a string to lower case
68	* @param S
69	*/
70	std::string LowerCase(const std::string& S);
71
72	/**
73	* Removes left and right spaces from a string
74	*
75	* @param str String to trim
76	*
77	* @return char* to the trimed string
78	*/
79	char* trimSpaces(char *str);
80
81	/**
82	* Finds the location of the string "begin <startText>" in an input stream.
83	* @param theStream
84	* @param startText
85	*
86	* @return the line number of the block within the theStream
87	*/
88	int findBegin(std::istream &theStream, const char* startText );
89
90	/**
91	* Counts the number of tokens on line which are delimited by the characters
92	* listed in delimiters
93	* @param line
94	* @param delimiters
95	*/
96	int countTokens(char line, char delimiters);
97
98	/**
99	* discovers whether or not the line contains the "end" token
100	*
101	* @param line The line to test
102	*
103	* @return int (==1 if the line has "end", ==0 if not).
104	*/
105	int isEndLine(char *line);
106
107	bool CaseInsensitiveEquals(char ch1, char ch2);
108
109	size_t CaseInsensitiveFind(const std::string& str1, const std::string& str2);
110
111
112	/**
113	* Convert a variable to a string
114	* @param T data type
115	* @param v data to be converted
116	* @return a string
117	*/
118	template<typename T>
119	std::string toString(const T& v) {
120	std::ostringstream oss;
121	if (!oss << v) {
122	std::cerr << "toString Error" << std::endl;
123	}
124	return oss.str();
125	}
126
127	template<typename T>
128	T lexi_cast(const std::string& str) {
129	T result;
130	std::istringstream iss(str);
131	if (!(iss >> result)) {
132	std::cerr << "lexi_cast Error" << std::endl;
133	}
134	return result;
135	}
136
137
138	template<typename T>
139	bool isType(const std::string& str) {
140	T result;
141	std::istringstream iss(str);
142	bool ret = true;
143	if (!(iss >> result)) {
144	ret = false;
145	}
146	return ret;
147	}
148
149	bool isInteger(const std::string& str);
150
151	std::string OpenMD_itoa(int value, unsigned int base = 10);
152
153	/*@todo need implementation /
154	std::string getPrefix(const std::string& str);
155
156	/*@todo need implementation /
157	std::string getSuffix(const std::string& str);
158
159
160	template<class ContainerType>
161	std::string containerToString(const ContainerType& cont) {
162	std::ostringstream oss;
163	oss << "(";
164	typename ContainerType::const_iterator i = cont.begin();
165	if (i != cont.end()) {
166	oss << *i;
167	++i;
168	}
169	for (; i != cont.end();++i) {
170	oss << ", ";
171	oss << *i;
172	}
173	oss << ")";
174	return oss.str();
175	}
176
177	unsigned long long memparse (char ptr, char *retptr);
178	}
179	#endif