Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/archive/tutorialHS08/src/util/String.h

Last change on this file was 1791, checked in by landauf, 16 years ago

added comments to all my classes in util

  • Property svn:eol-style set to native
File size: 2.9 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    @file String.h
31    @brief Declaration of several string manipulation functions, used in many parts of the game.
32*/
33
34#ifndef _Util_String_H__
35#define _Util_String_H__
36
37#include "UtilPrereqs.h"
38
39#include <string>
40#include <sstream>
41
42extern _UtilExport std::string blankString;
43
44_UtilExport void         strip(std::string* str);
45_UtilExport std::string  getStripped(const std::string& str);
46
47_UtilExport std::string  removeTrailingWhitespaces(const std::string& str);
48
49_UtilExport unsigned int getNextQuote(const std::string& str, unsigned int start);
50_UtilExport bool         isBetweenQuotes(const std::string& str, unsigned int pos);
51
52_UtilExport bool         hasStringBetweenQuotes(const std::string& str);
53_UtilExport std::string  getStringBetweenQuotes(const std::string& str);
54
55_UtilExport std::string  stripEnclosingQuotes(const std::string& str);
56_UtilExport std::string  stripEnclosingBraces(const std::string& str);
57
58_UtilExport bool         isEmpty(const std::string& str);
59_UtilExport bool         isComment(const std::string& str);
60_UtilExport bool         isNumeric(const std::string& str);
61
62_UtilExport std::string  addSlashes(const std::string& str);
63_UtilExport std::string  removeSlashes(const std::string& str);
64
65_UtilExport void         lowercase(std::string* str);
66_UtilExport std::string  getLowercase(const std::string& str);
67
68_UtilExport void         uppercase(std::string* str);
69_UtilExport std::string  getUppercase(const std::string& str);
70
71_UtilExport int          nocaseCmp(const std::string& s1, const std::string& s2);
72_UtilExport int          nocaseCmp(const std::string& s1, const std::string& s2, unsigned int len);
73
74_UtilExport bool         hasComment(const std::string& str);
75_UtilExport std::string  getComment(const std::string& str);
76_UtilExport unsigned int getCommentPosition(const std::string& str);
77_UtilExport unsigned int getNextCommentPosition(const std::string& str, unsigned int start = 0);
78
79#endif /* _Util_String_H__ */
Note: See TracBrowser for help on using the repository browser.