df72480395
Now that clang-format makes [[nodiscard]] attributes format sensibly, we can apply them to several functions within the common library to allow the compiler to complain about any misuses of the functions.
80 lines
2.8 KiB
C++
80 lines
2.8 KiB
C++
// Copyright 2013 Dolphin Emulator Project / 2014 Citra Emulator Project
|
|
// Licensed under GPLv2 or any later version
|
|
// Refer to the license.txt file included.
|
|
|
|
#pragma once
|
|
|
|
#include <cstddef>
|
|
#include <string>
|
|
#include <vector>
|
|
#include "common/common_types.h"
|
|
|
|
namespace Common {
|
|
|
|
/// Make a string lowercase
|
|
[[nodiscard]] std::string ToLower(std::string str);
|
|
|
|
/// Make a string uppercase
|
|
[[nodiscard]] std::string ToUpper(std::string str);
|
|
|
|
[[nodiscard]] std::string StringFromBuffer(const std::vector<u8>& data);
|
|
|
|
[[nodiscard]] std::string StripSpaces(const std::string& s);
|
|
[[nodiscard]] std::string StripQuotes(const std::string& s);
|
|
|
|
[[nodiscard]] std::string StringFromBool(bool value);
|
|
|
|
[[nodiscard]] std::string TabsToSpaces(int tab_size, std::string in);
|
|
|
|
void SplitString(const std::string& str, char delim, std::vector<std::string>& output);
|
|
|
|
// "C:/Windows/winhelp.exe" to "C:/Windows/", "winhelp", ".exe"
|
|
bool SplitPath(const std::string& full_path, std::string* _pPath, std::string* _pFilename,
|
|
std::string* _pExtension);
|
|
|
|
void BuildCompleteFilename(std::string& _CompleteFilename, const std::string& _Path,
|
|
const std::string& _Filename);
|
|
[[nodiscard]] std::string ReplaceAll(std::string result, const std::string& src,
|
|
const std::string& dest);
|
|
|
|
[[nodiscard]] std::string UTF16ToUTF8(const std::u16string& input);
|
|
[[nodiscard]] std::u16string UTF8ToUTF16(const std::string& input);
|
|
|
|
#ifdef _WIN32
|
|
[[nodiscard]] std::string UTF16ToUTF8(const std::wstring& input);
|
|
[[nodiscard]] std::wstring UTF8ToUTF16W(const std::string& str);
|
|
|
|
#endif
|
|
|
|
/**
|
|
* Compares the string defined by the range [`begin`, `end`) to the null-terminated C-string
|
|
* `other` for equality.
|
|
*/
|
|
template <typename InIt>
|
|
[[nodiscard]] bool ComparePartialString(InIt begin, InIt end, const char* other) {
|
|
for (; begin != end && *other != '\0'; ++begin, ++other) {
|
|
if (*begin != *other) {
|
|
return false;
|
|
}
|
|
}
|
|
// Only return true if both strings finished at the same point
|
|
return (begin == end) == (*other == '\0');
|
|
}
|
|
|
|
/**
|
|
* Creates a std::string from a fixed-size NUL-terminated char buffer. If the buffer isn't
|
|
* NUL-terminated then the string ends at max_len characters.
|
|
*/
|
|
[[nodiscard]] std::string StringFromFixedZeroTerminatedBuffer(const char* buffer,
|
|
std::size_t max_len);
|
|
|
|
/**
|
|
* Creates a UTF-16 std::u16string from a fixed-size NUL-terminated char buffer. If the buffer isn't
|
|
* null-terminated, then the string ends at the greatest multiple of two less then or equal to
|
|
* max_len_bytes.
|
|
*/
|
|
[[nodiscard]] std::u16string UTF16StringFromFixedZeroTerminatedBuffer(std::u16string_view buffer,
|
|
std::size_t max_len);
|
|
|
|
} // namespace Common
|