/** * Copyright (C) 2018-present MongoDB, Inc. * * This program is free software: you can redistribute it and/or modify * it under the terms of the Server Side Public License, version 1, * as published by MongoDB, Inc. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * Server Side Public License for more details. * * You should have received a copy of the Server Side Public License * along with this program. If not, see * . * * As a special exception, the copyright holders give permission to link the * code of portions of this program with the OpenSSL library under certain * conditions as described in each individual source file and distribute * linked combinations including the program with the OpenSSL library. You * must comply with the Server Side Public License in all respects for * all of the code used other than as permitted herein. If you modify file(s) * with this exception, you may extend this exception to your version of the * file(s), but you are not obligated to do so. If you do not wish to do so, * delete this exception statement from your version. If you delete this * exception statement from all source files in the program, then also delete * it in the license file. */ #pragma once /** * String utilities. * * TODO: De-inline. */ #include #include #include #include #include #include #include "mongo/base/string_data.h" #include "mongo/bson/util/builder.h" namespace mongo::str { /** the idea here is to make one liners easy. e.g.: return str::stream() << 1 << ' ' << 2; since the following doesn't work: (std::stringstream() << 1).str(); TODO: To avoid implicit conversions in relational operation expressions, this stream class should provide a full symmetric set of relational operators vs itself, vs std::string, vs mongo::StringData, and vs const char*, but that's a lot of functions. */ class stream { public: mongo::StringBuilder ss; template stream& operator<<(const T& v) { ss << v; return *this; } operator std::string() const { return ss.str(); } operator mongo::StringData() const { return ss.stringData(); } /** * Fail to compile if passed an unevaluated function, rather than allow it to decay and invoke * the bool overload. This catches both passing std::hex (which isn't supported by this type) * and forgetting to add () when doing `stream << someFuntion`. */ template stream& operator<<(R (*val)(Args...)) = delete; }; inline bool startsWith(const char* str, const char* prefix) { const char* s = str; const char* p = prefix; while (*p) { if (*p != *s) return false; p++; s++; } return true; } inline bool startsWith(const std::string& s, const std::string& p) { return startsWith(s.c_str(), p.c_str()); } // while these are trivial today use in case we do different wide char things later inline bool startsWith(const char* p, char ch) { return *p == ch; } inline bool startsWith(const std::string& s, char ch) { return startsWith(s.c_str(), ch); } inline bool endsWith(const std::string& s, const std::string& p) { int l = p.size(); int x = s.size(); if (x < l) return false; return strncmp(s.c_str() + x - l, p.c_str(), l) == 0; } inline bool endsWith(const char* s, char p) { size_t len = strlen(s); return len && s[len - 1] == p; } inline bool endsWith(const char* p, const char* suffix) { size_t a = strlen(p); size_t b = strlen(suffix); if (b > a) return false; return strcmp(p + a - b, suffix) == 0; } /** find char x, and return rest of the string thereafter, or an empty string if not found */ inline const char* after(const char* s, char x) { const char* p = strchr(s, x); return (p != nullptr) ? p + 1 : ""; } inline mongo::StringData after(mongo::StringData s, char x) { auto pos = s.find(x); return s.substr(pos == std::string::npos ? s.size() : pos + 1); } /** find string x, and return rest of the string thereafter, or an empty string if not found */ inline const char* after(const char* s, const char* x) { const char* p = strstr(s, x); return (p != nullptr) ? p + strlen(x) : ""; } inline mongo::StringData after(mongo::StringData s, mongo::StringData x) { auto pos = s.find(x); return s.substr(pos == std::string::npos ? s.size() : pos + x.size()); } /** @return true if s contains x */ inline bool contains(mongo::StringData s, mongo::StringData x) { return s.find(x) != std::string::npos; } /** @return true if s contains x */ inline bool contains(mongo::StringData s, char x) { return s.find(x) != std::string::npos; } /** @return everything before the character x, else entire string */ inline mongo::StringData before(const char* s, char x) { const char* p = s; // loop instead of strchr, so if we fail to find we don't have to iterate again. for (; *p && *p != x; ++p) { } return mongo::StringData(s, p - s); } /** @return everything before the character x, else entire string */ inline mongo::StringData before(mongo::StringData s, char x) { auto pos = s.find(x); return pos == std::string::npos ? s : s.substr(0, pos); } /** @return everything before the string x, else entire string */ inline mongo::StringData before(mongo::StringData s, mongo::StringData x) { auto pos = s.find(x); return pos != std::string::npos ? s.substr(0, pos) : s; } /** check if if strings share a common starting prefix @return offset of divergence (or length if equal). 0=nothing in common. */ inline int shareCommonPrefix(const char* p, const char* q) { int ofs = 0; while (1) { if (*p == 0 || *q == 0) break; if (*p != *q) break; p++; q++; ofs++; } return ofs; } inline int shareCommonPrefix(const std::string& a, const std::string& b) { return shareCommonPrefix(a.c_str(), b.c_str()); } /** std::string to unsigned. zero if not a number. can end with non-num chars */ inline unsigned toUnsigned(const std::string& a) { unsigned x = 0; const char* p = a.c_str(); while (1) { if (!isdigit(*p)) break; x = x * 10 + (*p - '0'); p++; } return x; } /** split a string on a specific char. We don't split N times, just once on the first occurrence. If char not present, 'before' contains entire input string and 'after' is empty. @return true if char found */ inline bool splitOn(mongo::StringData s, char c, mongo::StringData& before, mongo::StringData& after) { auto pos = s.find(c); if (pos == std::string::npos) { before = s; after = mongo::StringData(); return false; } before = s.substr(0, pos); after = s.substr(pos + 1); return true; } /** split scanning reverse direction. Splits ONCE ONLY. */ inline bool rSplitOn(mongo::StringData s, char c, mongo::StringData& before, mongo::StringData& after) { auto pos = s.rfind(c); if (pos == std::string::npos) { before = s; after = mongo::StringData(); return false; } before = s.substr(0, pos); after = s.substr(pos + 1); return true; } /** @return number of occurrences of c in s */ inline unsigned count(const std::string& s, char c) { unsigned n = 0; for (unsigned i = 0; i < s.size(); i++) if (s[i] == c) n++; return n; } /** trim leading spaces. spaces only, not tabs etc. */ inline mongo::StringData ltrim(mongo::StringData s) { auto i = s.rawData(); auto end = s.rawData() + s.size(); for (; i != end && *i == ' '; ++i) { } return s.substr(i - s.rawData()); } /** * UTF-8 multi-byte code points consist of one leading byte of the form 11xxxxxx, and potentially * many continuation bytes of the form 10xxxxxx. This method checks whether 'charByte' is a * continuation byte. */ inline bool isUTF8ContinuationByte(char charByte) { return (charByte & 0xc0) == 0x80; } /** * Assuming 'str' stores a UTF-8 string, returns the number of UTF codepoints. The return value is * undefined if the input is not a well formed UTF-8 string. */ inline size_t lengthInUTF8CodePoints(mongo::StringData str) { size_t strLen = 0; for (char byte : str) { strLen += !isUTF8ContinuationByte(byte); } return strLen; } inline int caseInsensitiveCompare(const char* s1, const char* s2) { #if defined(_WIN32) return _stricmp(s1, s2); #else return strcasecmp(s1, s2); #endif } void splitStringDelim(const std::string& str, std::vector* res, char delim); void joinStringDelim(const std::vector& strs, std::string* res, char delim); inline std::string toLower(StringData input) { std::string::size_type sz = input.size(); std::unique_ptr line(new char[sz + 1]); char* copy = line.get(); for (std::string::size_type i = 0; i < sz; i++) { char c = input[i]; copy[i] = (char)tolower((int)c); } copy[sz] = 0; return copy; } /** Functor for combining lexical and numeric comparisons. */ class LexNumCmp { public: /** @param lexOnly - compare all characters lexically, including digits. */ LexNumCmp(bool lexOnly); /** * Non numeric characters are compared lexicographically; numeric substrings * are compared numerically; dots separate ordered comparable subunits. * For convenience, character 255 is greater than anything else. * @param lexOnly - compare all characters lexically, including digits. */ static int cmp(StringData s1, StringData s2, bool lexOnly); int cmp(StringData s1, StringData s2) const; bool operator()(StringData s1, StringData s2) const; private: bool _lexOnly; }; // TODO: Sane-ify core std::string functionality // For now, this needs to be near the LexNumCmp or else int versionCmp(StringData rhs, StringData lhs); /** * A method to escape whitespace and control characters in strings. For example, the string "\t" * goes to "\\t". If `escape_slash` is true, then "/" goes to "\\/". */ std::string escape(StringData s, bool escape_slash = false); /** * Converts 'integer' from a base-10 string to a size_t value or returns boost::none if 'integer' * is not a valid base-10 string. A valid string is not allowed to have anything but decimal * numerals, not even a +/- prefix or leading/trailing whitespace. */ boost::optional parseUnsignedBase10Integer(StringData integer); /** * Converts a double to a string with specified precision. If unspecified, default to 17, which is * the maximum decimal precision possible from a standard double. */ std::string convertDoubleToString(double d, int prec = 17); } // namespace mongo::str