Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/ScriptableController/src/libraries/util/StringUtils.h @ 10012

Last change on this file since 10012 was 9550, checked in by landauf, 12 years ago

merged testing branch back to trunk. unbelievable it took me 13 months to finish this chore…

  • Property svn:eol-style set to native
File size: 3.3 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 *      ...
26 *
27 */
28
29/**
30    @defgroup String String functions
31    @ingroup Util
32*/
33
34/**
35    @file
36    @ingroup String
37    @brief Declaration of several string manipulation functions, used in many parts of the game.
38*/
39
40#ifndef _StringUtils_H__
41#define _StringUtils_H__
42
43#include "UtilPrereqs.h"
44#include <string>
45#include <vector>
46
47namespace orxonox
48{
49    extern _UtilExport std::string BLANKSTRING;
50
51    _UtilExport std::string  getUniqueNumberString();
52
53    _UtilExport void         strip(std::string* str);
54    _UtilExport std::string  getStripped(const std::string& str);
55
56    _UtilExport std::string  removeTrailingWhitespaces(const std::string& str);
57
58    _UtilExport void         vectorize(const std::string& str, char delimiter, std::vector<std::string>* output);
59
60    _UtilExport size_t       getNextQuote(const std::string& str, size_t start = 0);
61    _UtilExport bool         isBetweenQuotes(const std::string& str, size_t pos);
62
63    _UtilExport bool         hasStringBetweenQuotes(const std::string& str);
64    _UtilExport std::string  getStringBetweenQuotes(const std::string& str);
65
66    _UtilExport std::string  stripEnclosingQuotes(const std::string& str);
67    _UtilExport std::string  stripEnclosingBraces(const std::string& str);
68
69    _UtilExport bool         isEmpty(const std::string& str);
70    _UtilExport bool         isComment(const std::string& str);
71
72    _UtilExport std::string  addSlashes(const std::string& str);
73    _UtilExport std::string  removeSlashes(const std::string& str);
74
75    _UtilExport void         lowercase(std::string* str);
76    _UtilExport std::string  getLowercase(const std::string& str);
77
78    _UtilExport void         uppercase(std::string* str);
79    _UtilExport std::string  getUppercase(const std::string& str);
80
81    _UtilExport int          nocaseCmp(const std::string& s1, const std::string& s2);
82    _UtilExport int          nocaseCmp(const std::string& s1, const std::string& s2, size_t len);
83
84    _UtilExport bool         hasComment(const std::string& str);
85    _UtilExport std::string  getComment(const std::string& str);
86    _UtilExport size_t       getNextCommentPosition(const std::string& str, size_t start = 0);
87
88    _UtilExport size_t       replaceCharacters(std::string& str, char target, char replacement);
89
90    _UtilExport unsigned int getLevenshteinDistance(const std::string& str1, const std::string& str2);
91
92    _UtilExport std::string  getTimestamp(void);
93}
94
95#endif /* _StringUtils_H__ */
Note: See TracBrowser for help on using the repository browser.