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. Acknowledgement of the program authors must be made in any
 *    publication of scientific results based in part on use of the
 *    program.  An acceptable form of acknowledgement is citation of
 *    the article in which the program was described (Matthew
 *    A. Meineke, Charles F. Vardeman II, Teng Lin, Christopher
 *    J. Fennell and J. Daniel Gezelter, "OOPSE: An Object-Oriented
 *    Parallel Simulation Engine for Molecular Dynamics,"
 *    J. Comput. Chem. 26, pp. 252-271 (2005))
 *
 * 2. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 3. 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.
 */
 
/**
 * @file StringUtils.hpp
 * @author Dan Gezelter
 * @date 10/18/2004
 * @version 1.0
 */

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

namespace oopse {
 
  /**
   * 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, 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 OOPSE_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();
}  

  
}  
#endif
Revision:	2982
Committed:	Wed Aug 30 18:42:29 2006 UTC (17 years, 10 months ago) by tim
File size:	4992 byte(s)
Log Message:	Massive changes preparing for release of OOPSE-4: The main difference is that the new MD file format (.md, .dump, .eor) now contains meta-data information along with the configuration information.
#	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. 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
19	* notice, this list of conditions and the following disclaimer.
20	*
21	* 3. Redistributions in binary form must reproduce the above copyright
22	* notice, this list of conditions and the following disclaimer in the
23	* documentation and/or other materials provided with the
24	* distribution.
25	*
26	* This software is provided "AS IS," without a warranty of any
27	* kind. All express or implied conditions, representations and
28	* warranties, including any implied warranty of merchantability,
29	* fitness for a particular purpose or non-infringement, are hereby
30	* excluded. The University of Notre Dame and its licensors shall not
31	* be liable for any damages suffered by licensee as a result of
32	* using, modifying or distributing the software or its
33	* derivatives. In no event will the University of Notre Dame or its
34	* licensors be liable for any lost revenue, profit or data, or for
35	* direct, indirect, special, consequential, incidental or punitive
36	* damages, however caused and regardless of the theory of liability,
37	* arising out of the use of or inability to use software, even if the
38	* University of Notre Dame has been advised of the possibility of
39	* such damages.
40	*/
41
42	/**
43	* @file StringUtils.hpp
44	* @author Dan Gezelter
45	* @date 10/18/2004
46	* @version 1.0
47	*/
48
49	#ifndef UTILS_STRINGUTILS_HPP
50	#define UTILS_STRINGUTILS_HPP
51	#include <string>
52	#include <iostream>
53	#include <fstream>
54	#include <sstream>
55
56	namespace oopse {
57
58	/**
59	* Converts a string to UPPER CASE
60	* @param S
61	*/
62	std::string UpperCase(const std::string& S);
63
64	/**
65	* Converts a string to lower case
66	* @param S
67	*/
68	std::string LowerCase(const std::string& S);
69
70	/**
71	* Removes left and right spaces from a string
72	*
73	* @param str String to trim
74	*
75	* @return char* to the trimed string
76	*/
77	char* trimSpaces(char *str);
78
79	/**
80	* Finds the location of the string "begin <startText>" in an input stream.
81	* @param theStream
82	* @param startText
83	*
84	* @return the line number of the block within the theStream
85	*/
86	int findBegin(std::istream &theStream, char* startText );
87
88	/**
89	* Counts the number of tokens on line which are delimited by the characters
90	* listed in delimiters
91	* @param line
92	* @param delimiters
93	*/
94	int countTokens(char line, char delimiters);
95
96	/**
97	* discovers whether or not the line contains the "end" token
98	*
99	* @param line The line to test
100	*
101	* @return int (==1 if the line has "end", ==0 if not).
102	*/
103	int isEndLine(char *line);
104
105	bool CaseInsensitiveEquals(char ch1, char ch2);
106
107	size_t CaseInsensitiveFind(const std::string& str1, const std::string& str2);
108
109
110	/**
111	* Convert a variable to a string
112	* @param T data type
113	* @param v data to be converted
114	* @return a string
115	*/
116	template<typename T>
117	std::string toString(const T& v) {
118	std::ostringstream oss;
119	if (!oss << v) {
120	std::cerr << "toString Error" << std::endl;
121	}
122	return oss.str();
123	}
124
125	template<typename T>
126	T lexi_cast(const std::string& str) {
127	T result;
128	std::istringstream iss(str);
129	if (!(iss >> result)) {
130	std::cerr << "lexi_cast Error" << std::endl;
131	}
132	return result;
133	}
134
135
136	template<typename T>
137	bool isType(const std::string& str) {
138	T result;
139	std::istringstream iss(str);
140	bool ret = true;
141	if (!(iss >> result)) {
142	ret = false;
143	}
144	return ret;
145	}
146
147	bool isInteger(const std::string& str);
148
149	std::string OOPSE_itoa(int value, unsigned int base = 10);
150
151	/*@todo need implementation /
152	std::string getPrefix(const std::string& str);
153
154	/*@todo need implementation /
155	std::string getSuffix(const std::string& str);
156
157
158	template<class ContainerType>
159	std::string containerToString(const ContainerType& cont) {
160	std::ostringstream oss;
161	oss << "(";
162	typename ContainerType::const_iterator i = cont.begin();
163	if (i != cont.end()) {
164	oss << *i;
165	++i;
166	}
167	for (; i != cont.end();++i) {
168	oss << ", ";
169	oss << *i;
170	}
171	oss << ")";
172	return oss.str();
173	}
174
175
176	}
177	#endif