summaryrefslogtreecommitdiffstats
path: root/src/common/fs/fs_util.h
blob: dbb4f5a9a1de5d4dabee612d710f614c02b78afd (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
// SPDX-FileCopyrightText: Copyright 2021 yuzu Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later

#pragma once

#include <concepts>
#include <filesystem>
#include <span>
#include <string>

#include "common/common_types.h"

namespace Common::FS {

template <typename T>
concept IsChar = std::same_as<T, char>;

/**
 * Converts a UTF-8 encoded std::string or std::string_view to a std::u8string.
 *
 * @param utf8_string UTF-8 encoded string
 *
 * @returns UTF-8 encoded std::u8string.
 */
[[nodiscard]] std::u8string ToU8String(std::string_view utf8_string);

/**
 * Converts a buffer of bytes to a UTF8-encoded std::u8string.
 * This converts from the start of the buffer until the first encountered null-terminator.
 * If no null-terminator is found, this converts the entire buffer instead.
 *
 * @param buffer Buffer of bytes
 *
 * @returns UTF-8 encoded std::u8string.
 */
[[nodiscard]] std::u8string BufferToU8String(std::span<const u8> buffer);

/**
 * Same as BufferToU8String, but returns a string view of the buffer.
 *
 * @param buffer Buffer of bytes
 *
 * @returns UTF-8 encoded std::u8string_view.
 */
[[nodiscard]] std::u8string_view BufferToU8StringView(std::span<const u8> buffer);

/**
 * Converts a std::u8string or std::u8string_view to a UTF-8 encoded std::string.
 *
 * @param u8_string UTF-8 encoded u8string
 *
 * @returns UTF-8 encoded std::string.
 */
[[nodiscard]] std::string ToUTF8String(std::u8string_view u8_string);

/**
 * Converts a buffer of bytes to a UTF8-encoded std::string.
 * This converts from the start of the buffer until the first encountered null-terminator.
 * If no null-terminator is found, this converts the entire buffer instead.
 *
 * @param buffer Buffer of bytes
 *
 * @returns UTF-8 encoded std::string.
 */
[[nodiscard]] std::string BufferToUTF8String(std::span<const u8> buffer);

/**
 * Same as BufferToUTF8String, but returns a string view of the buffer.
 *
 * @param buffer Buffer of bytes
 *
 * @returns UTF-8 encoded std::string_view.
 */
[[nodiscard]] std::string_view BufferToUTF8StringView(std::span<const u8> buffer);

/**
 * Converts a filesystem path to a UTF-8 encoded std::string.
 *
 * @param path Filesystem path
 *
 * @returns UTF-8 encoded std::string.
 */
[[nodiscard]] std::string PathToUTF8String(const std::filesystem::path& path);

/**
 * Fix filename (remove invalid characters)
 *
 * @param u8_string dirty encoded filename string
 *
 * @returns utf8_string santized filename string
 *
 */
[[nodiscard]] std::u8string U8FilenameSantizer(const std::u8string_view u8filename);

/**
 * Fix filename (remove invalid characters)
 *
 * @param utf8_string dirty encoded filename string
 *
 * @returns utf8_string santized filename string
 *
 */
[[nodiscard]] std::string UTF8FilenameSantizer(const std::string_view filename);

} // namespace Common::FS