Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/script_trigger/src/util/String.h @ 2187

Last change on this file since 2187 was 1062, checked in by rgrieder, 17 years ago
  • changed header file inclusion order
File size: 5.8 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Fabian 'x3n' Landau
24 *   Co-authors:
25 *      Benjamin Grauer
26 *
27 */
28
29#ifndef _Util_String_H__
30#define _Util_String_H__
31
32#include "UtilPrereqs.h"
33
34#include <string>
35#include <sstream>
36
37_UtilExport void         strip(std::string* str);
38_UtilExport std::string  getStripped(const std::string& str);
39
40_UtilExport std::string  removeTrailingWhitespaces(const std::string& str);
41
42_UtilExport unsigned int getNextQuote(const std::string& str, unsigned int start);
43_UtilExport bool         isBetweenQuotes(const std::string& str, unsigned int pos);
44
45_UtilExport bool         hasStringBetweenQuotes(const std::string& str);
46_UtilExport std::string  getStringBetweenQuotes(const std::string& str);
47
48_UtilExport std::string  stripEnclosingQuotes(const std::string& str);
49
50_UtilExport bool         isEmpty(const std::string& str);
51_UtilExport bool         isComment(const std::string& str);
52_UtilExport bool         isNumeric(const std::string& str);
53
54_UtilExport std::string  addSlashes(const std::string& str);
55_UtilExport std::string  removeSlashes(const std::string& str);
56
57_UtilExport void         lowercase(std::string* str);
58_UtilExport std::string  getLowercase(const std::string& str);
59
60_UtilExport void         uppercase(std::string* str);
61_UtilExport std::string  getUppercase(const std::string& str);
62
63_UtilExport int          nocaseCmp(const std::string& s1, const std::string& s2);
64_UtilExport int          nocaseCmp(const std::string& s1, const std::string& s2, unsigned int len);
65
66_UtilExport bool         hasComment(const std::string& str);
67_UtilExport std::string  getComment(const std::string& str);
68_UtilExport unsigned int getCommentPosition(const std::string& str);
69_UtilExport unsigned int getNextCommentPosition(const std::string& str, unsigned int start = 0);
70
71//! The Convert class has some static member functions to convert strings to values and values to strings.
72class _UtilExport Convert
73{
74    public:
75        /**
76            @brief Converts a value of any type to a string.
77            @param output The string to write the result in
78            @param input The variable to convert
79            @return True if the conversion succeded
80
81            @example
82            float f = 3.14;
83            std::string output;
84            bool success = Convert::ToString(&output, f);
85        */
86        template <typename T>
87        static bool ToString(std::string* output, T input)
88        {
89            std::ostringstream oss;
90            if (oss << input)
91            {
92                (*output) = oss.str();
93                return true;
94            }
95
96            return false;
97        }
98
99        /**
100            @brief Converts a value of any type to a string and assigns a defaultvalue if the conversion fails.
101            @param output The string to write the result in
102            @param input The variable to convert
103            @param fallbackString The assigned string if the conversion fails.
104            @return True if the conversion succeeded
105
106            @example
107            float f = 3.14;
108            std::string output;
109            bool success = Convert::ToString(&output, f, "0.000000");
110        */
111        template <typename T>
112        static bool ToString(std::string* output, T input, const std::string& fallbackString)
113        {
114            if (Convert::ToString(output, input))
115                return true;
116
117            (*output) = fallbackString;
118            return false;
119        }
120
121        /**
122            @brief Converts a string to a value of any type.
123            @param output The variable to assign the result to
124            @param input The string to convert
125            @return True if the conversion succeeded
126
127            @example
128            std::string input = "3.14";
129            float f;
130            bool success = string2Number(&f, input);
131        */
132        template <typename T>
133        static bool FromString(T* output, const std::string& input)
134        {
135            std::istringstream iss(input);
136            if (iss >> (*output))
137                return true;
138
139            return false;
140        }
141
142        /**
143            @brief Converts a string to a value of any type.
144            @param output The variable to assign the result to
145            @param input The string to convert
146            @param fallbackValue The assigned value if the conversion fails
147            @return True if the conversion succeeded
148
149            @example
150            std::string input = "3.14";
151            float f;
152            bool success = string2Number(&f, input, 0.000000);
153        */
154        template <typename T>
155        static bool FromString(T* output, const std::string& input, T fallbackValue)
156        {
157            if (Convert::FromString(output, input))
158                return true;
159
160            (*output) = fallbackValue;
161            return false;
162        }
163};
164
165#endif /* _Util_String_H__ */
Note: See TracBrowser for help on using the repository browser.