Add documentation on placing tiles.
[Tsunagari.git] / src / string.h
blob783acb9d24b8b1bcdb63d7a944880a09cf15dc3a
1 /*********************************
2 ** Tsunagari Tile Engine **
3 ** string.h **
4 ** Copyright 2011-2012 OmegaSDG **
5 *********************************/
7 // **********
8 // Permission is hereby granted, free of charge, to any person obtaining a copy
9 // of this software and associated documentation files (the "Software"), to
10 // deal in the Software without restriction, including without limitation the
11 // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
12 // sell copies of the Software, and to permit persons to whom the Software is
13 // furnished to do so, subject to the following conditions:
15 // The above copyright notice and this permission notice shall be included in
16 // all copies or substantial portions of the Software.
18 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
24 // IN THE SOFTWARE.
25 // **********
27 #ifndef STRING_H
28 #define STRING_H
30 #include <string>
31 #include <vector>
33 //! Returns true if the string contains only digits, whitespace, and minus.
34 bool isInteger(const std::string& s);
36 //! Returns true if the string contains only digits, whitespace, minus, and
37 //! period.
38 bool isDecimal(const std::string& s);
40 bool isRanges(const std::string& s);
43 //! Return a bool from a "true"/"false" string.
44 bool parseBool(const std::string& s);
46 //! Split a string by a delimiter.
47 std::vector<std::string> splitStr(const std::string& str,
48 const std::string& delimiter);
50 /**
51 * Parse ranges of integers separated by commas.
52 * Can take things such as "5-7,2,12-18".
54 std::vector<int> parseRanges(const std::string& format);
56 //! Convert an integer to a representative string.
57 std::string itostr(int in);
59 #endif