src/utils/Trim.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.
 */
 
#ifndef UTILS_TRIM_HPP
#define UTILS_TRIM_HPP

#include <string>
#include <cctype>

/**
 * @file Trim.hpp
 * Defines trim algorithms. Trim algorithms are used to remove trailing and leading spaces from a string. 
 */
namespace oopse {

  /**
   * Remove all leading spaces in-place. The supplied predicate is used to determine which 
   * characters are considered spaces
   * @param str An input sequence
   * @param IsSpace An unary predicate identifying spaces 
   */
  template<typename Predict>     
  void trimLeftIf(std::string& str, Predict isSpace) {
    std::string::iterator i = str.begin();

    for (; i != str.end(); ++i) {
      if (!isSpace(*i)) {
        break;
      }
    }
        
    str.erase(str.begin(), i);
  }

  /**
   * Remove all trailing spaces in-place. The supplied predicate is used to determine which 
   * characters are considered spaces
   * @param str An input sequence 
   */
  template<typename Predict>     
  void trimRightIf(std::string& str, Predict isSpace) {
    std::string::iterator i = str.end();

    for (; i != str.begin();) {
      if (!isSpace(*(--i))) {
        ++i;
        break;
      }
    }
        
    str.erase(i, str.end());
  }

  /**
   *Remove all leading and trailing spaces in-place. The supplied predicate is used to determine 
   * which characters are considered spaces
   * @param str An input sequence
   */
  template<typename Predict>     
  void trimIf(std::string& str, Predict isSpace) {
    trimLeftIf(str, isSpace);
    trimRightIf(str, isSpace);        
  }

  /**
   * Remove all leading spaces from the input. The supplied predicate is used to determine 
   * which characters are considered spaces
   * @return A trimmed copy of the input
   * @param input An input sequence 
   */
  template<typename Predict>
  std::string trimLeftCopyIf(const std::string& input, Predict isSpace) {
    std::string result(input);
    trimLeftIf(result, isSpace);
    return result;
  }

  /**
   * Remove all trailing spaces from the input. The supplied predicate is used to determine 
   * which characters are considered spaces
   * @return A trimmed copy of the input
   * @param input An input sequence
   */
  template<typename Predict>
  std::string trimRightCopyIf(const std::string& input, Predict isSpace) {
    std::string result(input);
    trimRightIf(result, isSpace);
    return result;
  }

  /**
   * Remove all leading and trailing spaces from the input. The supplied predicate is used to 
   * determine which characters are considered spaces
   * @return A trimmed copy of the input
   * @param input An input sequence
   */
  template<typename Predict>     
  std::string trimCopyIf(const std::string& input, Predict isSpace) {
    std::string result(input);
    trimIf(result, isSpace);
    return result;
  }

    
  /**
   * Remove all leading spaces in-place.
   * @param str An input sequence
   */
  void trimLeft(std::string& str);

  /**
   * Remove all trailing spaces in-place.
   * @param str An input sequence 
   */
  void trimRight(std::string& str);

  /**
   *Remove all leading and trailing spaces in-place
   * @param str An input sequence
   */
  void trim(std::string& str);

  /**
   * Remove all leading spaces from the input.
   * @return A trimmed copy of the input
   * @param input An input sequence 
   */
  std::string trimLeftCopy(const std::string& input);

  /**
   * Remove all trailing spaces from the input.
   * @return A trimmed copy of the input
   * @param input An input sequence
   */
  std::string trimRightCopy(const std::string& input);

  /**
   *Remove all leading and trailing spaces from the input.
   * @return A trimmed copy of the input
   * @param input An input sequence
   */
  std::string trimCopy(const std::string& input);

}//end namespace oopse
#endif //UTILS_TRIM_HPP    
Revision:	507
Committed:	Fri Apr 15 22:04:00 2005 UTC (20 years ago) by gezelter
File size:	5878 byte(s)
Log Message:	xemacs has been drafted to perform our indentation services
#	User	Rev	Content
1	gezelter	507	/*
2	gezelter	246	* 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			#ifndef UTILS_TRIM_HPP
43			#define UTILS_TRIM_HPP
44
45			#include <string>
46			#include <cctype>
47
48			/**
49			* @file Trim.hpp
50			* Defines trim algorithms. Trim algorithms are used to remove trailing and leading spaces from a string.
51			*/
52			namespace oopse {
53
54	gezelter	507	/**
55			* Remove all leading spaces in-place. The supplied predicate is used to determine which
56			* characters are considered spaces
57			* @param str An input sequence
58			* @param IsSpace An unary predicate identifying spaces
59			*/
60			template<typename Predict>
61			void trimLeftIf(std::string& str, Predict isSpace) {
62			std::string::iterator i = str.begin();
63	gezelter	246
64	gezelter	507	for (; i != str.end(); ++i) {
65			if (!isSpace(*i)) {
66			break;
67			}
68			}
69	gezelter	246
70	gezelter	507	str.erase(str.begin(), i);
71			}
72	gezelter	246
73	gezelter	507	/**
74			* Remove all trailing spaces in-place. The supplied predicate is used to determine which
75			* characters are considered spaces
76			* @param str An input sequence
77			*/
78			template<typename Predict>
79			void trimRightIf(std::string& str, Predict isSpace) {
80			std::string::iterator i = str.end();
81	gezelter	246
82	gezelter	507	for (; i != str.begin();) {
83			if (!isSpace(*(--i))) {
84			++i;
85			break;
86			}
87			}
88	gezelter	246
89	gezelter	507	str.erase(i, str.end());
90			}
91	gezelter	246
92	gezelter	507	/**
93			*Remove all leading and trailing spaces in-place. The supplied predicate is used to determine
94			* which characters are considered spaces
95			* @param str An input sequence
96			*/
97			template<typename Predict>
98			void trimIf(std::string& str, Predict isSpace) {
99			trimLeftIf(str, isSpace);
100			trimRightIf(str, isSpace);
101			}
102	gezelter	246
103	gezelter	507	/**
104			* Remove all leading spaces from the input. The supplied predicate is used to determine
105			* which characters are considered spaces
106			* @return A trimmed copy of the input
107			* @param input An input sequence
108			*/
109			template<typename Predict>
110			std::string trimLeftCopyIf(const std::string& input, Predict isSpace) {
111			std::string result(input);
112			trimLeftIf(result, isSpace);
113			return result;
114			}
115	gezelter	246
116	gezelter	507	/**
117			* Remove all trailing spaces from the input. The supplied predicate is used to determine
118			* which characters are considered spaces
119			* @return A trimmed copy of the input
120			* @param input An input sequence
121			*/
122			template<typename Predict>
123			std::string trimRightCopyIf(const std::string& input, Predict isSpace) {
124			std::string result(input);
125			trimRightIf(result, isSpace);
126			return result;
127			}
128	gezelter	246
129	gezelter	507	/**
130			* Remove all leading and trailing spaces from the input. The supplied predicate is used to
131			* determine which characters are considered spaces
132			* @return A trimmed copy of the input
133			* @param input An input sequence
134			*/
135			template<typename Predict>
136			std::string trimCopyIf(const std::string& input, Predict isSpace) {
137			std::string result(input);
138			trimIf(result, isSpace);
139			return result;
140			}
141	gezelter	246
142
143	gezelter	507	/**
144			* Remove all leading spaces in-place.
145			* @param str An input sequence
146			*/
147			void trimLeft(std::string& str);
148	gezelter	246
149	gezelter	507	/**
150			* Remove all trailing spaces in-place.
151			* @param str An input sequence
152			*/
153			void trimRight(std::string& str);
154	gezelter	246
155	gezelter	507	/**
156			*Remove all leading and trailing spaces in-place
157			* @param str An input sequence
158			*/
159			void trim(std::string& str);
160	gezelter	246
161	gezelter	507	/**
162			* Remove all leading spaces from the input.
163			* @return A trimmed copy of the input
164			* @param input An input sequence
165			*/
166			std::string trimLeftCopy(const std::string& input);
167	gezelter	246
168	gezelter	507	/**
169			* Remove all trailing spaces from the input.
170			* @return A trimmed copy of the input
171			* @param input An input sequence
172			*/
173			std::string trimRightCopy(const std::string& input);
174	gezelter	246
175	gezelter	507	/**
176			*Remove all leading and trailing spaces from the input.
177			* @return A trimmed copy of the input
178			* @param input An input sequence
179			*/
180			std::string trimCopy(const std::string& input);
181	gezelter	246
182			}//end namespace oopse
183			#endif //UTILS_TRIM_HPP