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);


  /**
   * 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;
        T result;
        
        oss << v;
        return oss.str();
    }

    /**@todo need implementation */
    std::string getPrefix(const std::string& str);

    /**@todo need implementation */
    std::string getSuffix(const std::string& str);
    
}

#endif
Revision:	1930
Committed:	Wed Jan 12 22:41:40 2005 UTC (19 years, 6 months ago) by gezelter
File size:	3903 byte(s)
Log Message:	merging new_design branch into OOPSE-2.0
#	User	Rev	Content
1	gezelter	1930	/*
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	gezelter	1590	/**
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	gezelter	1490	#include <string>
52	gezelter	1590	#include <iostream>
53			#include <fstream>
54	gezelter	1930	#include <sstream>
55	gezelter	1490
56	gezelter	1590	namespace oopse {
57
58
59			/**
60			* Converts a string to UPPER CASE
61			* @param S
62			*/
63	gezelter	1930	std::string UpperCase(const std::string& S);
64	gezelter	1590
65			/**
66			* Converts a string to lower case
67			* @param S
68			*/
69	gezelter	1930	std::string LowerCase(const std::string& S);
70	gezelter	1590
71			/**
72	chrisfen	1598	* Removes left and right spaces from a string
73			*
74			* @param str String to trim
75			*
76			* @return char* to the trimed string
77			*/
78			char* trimSpaces(char *str);
79
80			/**
81	gezelter	1590	* Finds the location of the string "begin <startText>" in an input stream.
82			* @param theStream
83			* @param startText
84			*
85			* @return the line number of the block within the theStream
86			*/
87	gezelter	1930	int findBegin(std::istream &theStream, char* startText );
88	gezelter	1590
89			/**
90			* Counts the number of tokens on line which are delimited by the characters
91			* listed in delimiters
92			* @param line
93			* @param delimiters
94			*/
95			int countTokens(char line, char delimiters);
96
97			/**
98			* discovers whether or not the line contains the "end" token
99			*
100			* @param line The line to test
101			*
102			* @return int (==1 if the line has "end", ==0 if not).
103			*/
104			int isEndLine(char *line);
105	gezelter	1930
106
107			/**
108			* Convert a variable to a string
109			* @param T data type
110			* @param v data to be converted
111			* @return a string
112			*/
113			template<typename T>
114			std::string toString(const T& v) {
115			std::ostringstream oss;
116			T result;
117
118			oss << v;
119			return oss.str();
120			}
121
122			/*@todo need implementation /
123			std::string getPrefix(const std::string& str);
124
125			/*@todo need implementation /
126			std::string getSuffix(const std::string& str);
127
128	gezelter	1590	}
129
130	gezelter	1490	#endif