cdb240f3d4
[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 01cf05bc75
67 lines
3.4 KiB
C++
67 lines
3.4 KiB
C++
// SPDX-FileCopyrightText: 2014 Citra Emulator Project
|
|
// SPDX-License-Identifier: GPL-2.0-or-later
|
|
|
|
#pragma once
|
|
|
|
#include <algorithm>
|
|
#include <string_view>
|
|
|
|
#include <fmt/format.h>
|
|
|
|
#include "common/logging/formatter.h"
|
|
#include "common/logging/types.h"
|
|
|
|
namespace Common::Log {
|
|
|
|
// trims up to and including the last of ../, ..\, src/, src\ in a string
|
|
constexpr const char* TrimSourcePath(std::string_view source) {
|
|
const auto rfind = [source](const std::string_view match) {
|
|
return source.rfind(match) == source.npos ? 0 : (source.rfind(match) + match.size());
|
|
};
|
|
auto idx = std::max({rfind("src/"), rfind("src\\"), rfind("../"), rfind("..\\")});
|
|
return source.data() + idx;
|
|
}
|
|
|
|
/// Logs a message to the global logger, using fmt
|
|
void FmtLogMessageImpl(Class log_class, Level log_level, const char* filename,
|
|
unsigned int line_num, const char* function, const char* format,
|
|
const fmt::format_args& args);
|
|
|
|
template <typename... Args>
|
|
void FmtLogMessage(Class log_class, Level log_level, const char* filename, unsigned int line_num,
|
|
const char* function, const char* format, const Args&... args) {
|
|
FmtLogMessageImpl(log_class, log_level, filename, line_num, function, format,
|
|
fmt::make_format_args(args...));
|
|
}
|
|
|
|
} // namespace Common::Log
|
|
|
|
#ifdef _DEBUG
|
|
#define LOG_TRACE(log_class, ...) \
|
|
Common::Log::FmtLogMessage(Common::Log::Class::log_class, Common::Log::Level::Trace, \
|
|
Common::Log::TrimSourcePath(__FILE__), __LINE__, __func__, \
|
|
__VA_ARGS__)
|
|
#else
|
|
#define LOG_TRACE(log_class, fmt, ...) (void(0))
|
|
#endif
|
|
|
|
#define LOG_DEBUG(log_class, ...) \
|
|
Common::Log::FmtLogMessage(Common::Log::Class::log_class, Common::Log::Level::Debug, \
|
|
Common::Log::TrimSourcePath(__FILE__), __LINE__, __func__, \
|
|
__VA_ARGS__)
|
|
#define LOG_INFO(log_class, ...) \
|
|
Common::Log::FmtLogMessage(Common::Log::Class::log_class, Common::Log::Level::Info, \
|
|
Common::Log::TrimSourcePath(__FILE__), __LINE__, __func__, \
|
|
__VA_ARGS__)
|
|
#define LOG_WARNING(log_class, ...) \
|
|
Common::Log::FmtLogMessage(Common::Log::Class::log_class, Common::Log::Level::Warning, \
|
|
Common::Log::TrimSourcePath(__FILE__), __LINE__, __func__, \
|
|
__VA_ARGS__)
|
|
#define LOG_ERROR(log_class, ...) \
|
|
Common::Log::FmtLogMessage(Common::Log::Class::log_class, Common::Log::Level::Error, \
|
|
Common::Log::TrimSourcePath(__FILE__), __LINE__, __func__, \
|
|
__VA_ARGS__)
|
|
#define LOG_CRITICAL(log_class, ...) \
|
|
Common::Log::FmtLogMessage(Common::Log::Class::log_class, Common::Log::Level::Critical, \
|
|
Common::Log::TrimSourcePath(__FILE__), __LINE__, __func__, \
|
|
__VA_ARGS__)
|