feat(xdg): return base or user directories (#6702)

This commit is contained in:
pajlada
2026-01-03 13:08:01 +01:00
committed by GitHub
parent 135d6ef9ae
commit 0f58bc3410
3 changed files with 158 additions and 27 deletions
+35 -26
View File
@@ -8,29 +8,8 @@ namespace chatterino {
#if defined(Q_OS_UNIX) and !defined(Q_OS_DARWIN)
QStringList getXDGDirectories(XDGDirectoryType directory)
QStringList getXDGBaseDirectories(XDGDirectoryType directory)
{
// User XDG directory environment variables with defaults
// Defaults fetched from https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html#variables 2023-08-05
static std::unordered_map<XDGDirectoryType,
std::pair<const char *, QString>>
userDirectories = {
{
XDGDirectoryType::Config,
{
"XDG_CONFIG_HOME",
combinePath(QDir::homePath(), ".config/"),
},
},
{
XDGDirectoryType::Data,
{
"XDG_DATA_HOME",
combinePath(QDir::homePath(), ".local/share/"),
},
},
};
// Base (or system) XDG directory environment variables with defaults
// Defaults fetched from https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html#variables 2023-08-05
static std::unordered_map<XDGDirectoryType,
@@ -54,10 +33,6 @@ QStringList getXDGDirectories(XDGDirectoryType directory)
QStringList paths;
const auto &[userEnvVar, userDefaultValue] = userDirectories.at(directory);
auto userEnvPath = qEnvironmentVariable(userEnvVar, userDefaultValue);
paths.push_back(userEnvPath);
const auto &[baseEnvVar, baseDefaultValue] = baseDirectories.at(directory);
auto baseEnvPaths =
qEnvironmentVariable(baseEnvVar).split(':', Qt::SkipEmptyParts);
@@ -73,6 +48,40 @@ QStringList getXDGDirectories(XDGDirectoryType directory)
return paths;
}
QStringList getXDGUserDirectories(XDGDirectoryType directory)
{
// User XDG directory environment variables with defaults
// Defaults fetched from https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html#variables 2023-08-05
static std::unordered_map<XDGDirectoryType,
std::pair<const char *, QString>>
userDirectories = {
{
XDGDirectoryType::Config,
{
"XDG_CONFIG_HOME",
combinePath(QDir::homePath(), ".config/"),
},
},
{
XDGDirectoryType::Data,
{
"XDG_DATA_HOME",
combinePath(QDir::homePath(), ".local/share/"),
},
},
};
const auto &[userEnvVar, userDefaultValue] = userDirectories.at(directory);
return {
qEnvironmentVariable(userEnvVar, userDefaultValue),
};
}
QStringList getXDGDirectories(XDGDirectoryType directory)
{
return getXDGUserDirectories(directory) + getXDGBaseDirectories(directory);
}
#endif
} // namespace chatterino
+11 -1
View File
@@ -2,15 +2,25 @@
#include <QStringList>
#include <cstdint>
namespace chatterino {
#if defined(Q_OS_UNIX) and !defined(Q_OS_DARWIN)
enum class XDGDirectoryType {
enum class XDGDirectoryType : std::uint8_t {
/// The values from XDG_CONFIG_HOME and XDG_CONFIG_DIRS.
Config,
/// The values from XDG_DATA_HOME and XDG_DATA_DIRS
Data,
};
/// Return the directories from the base environment variables only (e.g. XDG_CONFIG_DIRS)
QStringList getXDGBaseDirectories(XDGDirectoryType directory);
/// Return the directories from the user environment variables only (e.g. XDG_CONFIG_HOME)
QStringList getXDGUserDirectories(XDGDirectoryType directory);
/// getXDGDirectories returns a list of directories given a directory type
///
/// This will attempt to read the relevant environment variable (e.g. XDG_CONFIG_HOME and XDG_CONFIG_DIRS) and merge them, with sane defaults