chore: make yuzu REUSE compliant
[REUSE] is a specification that aims at making file copyright
information consistent, so that it can be both human and machine
readable. It basically requires that all files have a header containing
copyright and licensing information. When this isn't possible, like
when dealing with binary assets, generated files or embedded third-party
dependencies, it is permitted to insert copyright information in the
`.reuse/dep5` file.
Oh, and it also requires that all the licenses used in the project are
present in the `LICENSES` folder, that's why the diff is so huge.
This can be done automatically with `reuse download --all`.
The `reuse` tool also contains a handy subcommand that analyzes the
project and tells whether or not the project is (still) compliant,
`reuse lint`.
Following REUSE has a few advantages over the current approach:
- Copyright information is easy to access for users / downstream
- Files like `dist/license.md` do not need to exist anymore, as
`.reuse/dep5` is used instead
- `reuse lint` makes it easy to ensure that copyright information of
files like binary assets / images is always accurate and up to date
To add copyright information of files that didn't have it I looked up
who committed what and when, for each file. As yuzu contributors do not
have to sign a CLA or similar I couldn't assume that copyright ownership
was of the "yuzu Emulator Project", so I used the name and/or email of
the commit author instead.
[REUSE]: https://reuse.software
Follow-up to 01cf05bc75b1e47beb08937439f3ed9339e7b254
2022-05-14 20:06:02 -04:00
|
|
|
// SPDX-FileCopyrightText: 2014 Citra Emulator Project
|
|
|
|
// SPDX-License-Identifier: GPL-2.0-or-later
|
2014-09-12 20:06:13 -04:00
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
2021-05-25 19:32:56 -04:00
|
|
|
#include <filesystem>
|
2016-03-02 07:49:30 -05:00
|
|
|
#include <memory>
|
2022-03-15 01:05:55 -04:00
|
|
|
#include <optional>
|
2015-06-20 15:34:41 -04:00
|
|
|
#include <string>
|
2017-05-27 21:14:00 -04:00
|
|
|
|
2021-06-28 15:58:16 -04:00
|
|
|
#include "common/settings.h"
|
|
|
|
|
2017-05-27 21:14:00 -04:00
|
|
|
class INIReader;
|
2014-09-12 20:06:13 -04:00
|
|
|
|
|
|
|
class Config {
|
2021-05-25 19:32:56 -04:00
|
|
|
std::filesystem::path sdl2_config_loc;
|
2022-03-15 01:05:55 -04:00
|
|
|
std::unique_ptr<INIReader> sdl2_config;
|
2014-09-12 20:06:13 -04:00
|
|
|
|
2016-09-17 20:38:01 -04:00
|
|
|
bool LoadINI(const std::string& default_contents = "", bool retry = true);
|
2014-11-15 14:56:18 -05:00
|
|
|
void ReadValues();
|
2016-09-17 20:38:01 -04:00
|
|
|
|
2014-09-12 20:06:13 -04:00
|
|
|
public:
|
2022-03-15 01:05:55 -04:00
|
|
|
explicit Config(std::optional<std::filesystem::path> config_path);
|
2017-05-27 21:14:00 -04:00
|
|
|
~Config();
|
2014-09-12 20:06:13 -04:00
|
|
|
|
|
|
|
void Reload();
|
2021-06-28 15:58:16 -04:00
|
|
|
|
|
|
|
private:
|
2021-06-30 20:16:01 -04:00
|
|
|
/**
|
2022-06-30 12:32:03 -04:00
|
|
|
* Applies a value read from the sdl2_config to a Setting.
|
2021-06-30 20:16:01 -04:00
|
|
|
*
|
|
|
|
* @param group The name of the INI group
|
|
|
|
* @param setting The yuzu setting to modify
|
|
|
|
*/
|
2022-07-15 13:37:48 -04:00
|
|
|
template <typename Type, bool ranged>
|
|
|
|
void ReadSetting(const std::string& group, Settings::Setting<Type, ranged>& setting);
|
2023-06-05 21:05:22 -04:00
|
|
|
void ReadCategory(Settings::Category category);
|
2014-09-12 20:06:13 -04:00
|
|
|
};
|