From 3f7a10f82567a0be04a424e0ddc360a73670c9d7 Mon Sep 17 00:00:00 2001 From: Oleg Morozenkov Date: Mon, 27 Jul 2015 20:59:09 +0300 Subject: Documentation --- include/tgbot/tools/StringTools.h | 91 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 91 insertions(+) create mode 100644 include/tgbot/tools/StringTools.h (limited to 'include/tgbot/tools') diff --git a/include/tgbot/tools/StringTools.h b/include/tgbot/tools/StringTools.h new file mode 100644 index 0000000..0a01b0d --- /dev/null +++ b/include/tgbot/tools/StringTools.h @@ -0,0 +1,91 @@ +/* + * Copyright (c) 2015 Oleg Morozenkov + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ + +#ifndef TGBOT_CPP_STRINGTOOLS_H +#define TGBOT_CPP_STRINGTOOLS_H + +#include +#include +#include + +/** + * @ingroup tools + */ +namespace StringTools { + +/** + * Checks if first string is starting with second string and vice-versa + * @param str1 First string + * @param str2 Second string + */ +bool startsWith(const std::string& str1, const std::string& str2); + +/** + * Checks if first string is ending with second string and vice-versa + * @param str1 First string + * @param str2 Second string + */ +bool endsWith(const std::string& str1, const std::string& str2); + +/** + * Splits string to smaller substrings which have between them a delimiter. Resulting substrings won't have delimiter. + * @param str Source string + * @param delimiter Delimiter + * @param dest Array to which substrings will be saved. + */ +void split(const std::string& str, char delimiter, std::vector& dest); + +/** + * Generates pseudo random string. It's recommended to call srand before this method. + * @param length Length of resulting string. + */ +std::string generateRandomString(size_t length); + +/** + * Performs url encode. + * @param value Source url string + * @return Encoded url string + */ +std::string urlEncode(const std::string& value); + +/** + * Performs url decode. + * @param value Encoded url string + * @return Decoded url string + */ +std::string urlDecode(const std::string& value); + +/** + * Splits string to smaller substrings which have between them a delimiter. Resulting substrings won't have delimiter. + * @param str Source string + * @param delimiter Delimiter + * @return Array of substrings + */ +inline std::vector split(const std::string& str, char delimiter) { + std::vector result; + split(str, delimiter, result); + return result; +} + +} + +#endif //TGBOT_CPP_STRINGTOOLS_H -- cgit v1.2.3