jcgruenhage/yuzu
1
0
Fork 0
mirror of https://github.com/yuzu-emu/yuzu.git synced 2024-09-22 15:34:57 +00:00
Code Issues Projects Releases Packages Wiki Activity
yuzu/src/web_service/telemetry_json.h

45 lines
1.6 KiB
C++
Raw Normal View History

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-15 00:06:02 +00:00
// SPDX-FileCopyrightText: 2017 Citra Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
Port web_service from Citra
2018-09-16 18:05:51 +00:00
#pragma once
telemetry_json: Remove unnecessary includes Removes unused includes. Also rectifies a missing <chrono> include.
2018-10-11 00:57:29 +00:00
#include <chrono>
Port web_service from Citra
2018-09-16 18:05:51 +00:00
#include <string>
#include "common/telemetry.h"
namespace WebService {
/**
* Implementation of VisitorInterface that serialized telemetry into JSON, and submits it to the
* yuzu web service
*/
common/telemetry: Migrate namespace into the Common namespace Migrates the Telemetry namespace into the Common namespace to make the code consistent with the rest of our common code.
2020-08-18 18:21:50 +00:00
class TelemetryJson : public Common::Telemetry::VisitorInterface {
Port web_service from Citra
2018-09-16 18:05:51 +00:00
public:
telemetry_json: Take std::string parameters by value Taking them by const reference isn't advisable here, because it means the std::move calls were doing nothing and we were always copying the std::string instances.
2018-10-11 00:59:25 +00:00
TelemetryJson(std::string host, std::string username, std::string token);
telemetry_json: Add missing override specifier to the destructor of TelemetryJson
2018-10-11 01:00:39 +00:00
~TelemetryJson() override;
Port web_service from Citra
2018-09-16 18:05:51 +00:00
common/telemetry: Migrate namespace into the Common namespace Migrates the Telemetry namespace into the Common namespace to make the code consistent with the rest of our common code.
2020-08-18 18:21:50 +00:00
void Visit(const Common::Telemetry::Field<bool>& field) override;
void Visit(const Common::Telemetry::Field<double>& field) override;
void Visit(const Common::Telemetry::Field<float>& field) override;
void Visit(const Common::Telemetry::Field<u8>& field) override;
void Visit(const Common::Telemetry::Field<u16>& field) override;
void Visit(const Common::Telemetry::Field<u32>& field) override;
void Visit(const Common::Telemetry::Field<u64>& field) override;
void Visit(const Common::Telemetry::Field<s8>& field) override;
void Visit(const Common::Telemetry::Field<s16>& field) override;
void Visit(const Common::Telemetry::Field<s32>& field) override;
void Visit(const Common::Telemetry::Field<s64>& field) override;
void Visit(const Common::Telemetry::Field<std::string>& field) override;
void Visit(const Common::Telemetry::Field<const char*>& field) override;
void Visit(const Common::Telemetry::Field<std::chrono::microseconds>& field) override;
Port web_service from Citra
2018-09-16 18:05:51 +00:00
void Complete() override;
compatdb: Use a seperate endpoint for testcase submission
2018-10-26 14:21:45 +00:00
bool SubmitTestcase() override;
Port web_service from Citra
2018-09-16 18:05:51 +00:00
private:
telemetry_json: Use the PImpl idiom to avoid unnecessary dependency exposure Users of the web_service library shouldn't need to care about an external library like json.h. However, given it's exposed in our interface, this requires that other libraries publicly link in the JSON library. We can do better. By using the PImpl idiom, we can hide this dependency in the cpp file and remove the need to link that library in altogether.
2018-10-11 01:04:19 +00:00
struct Impl;
std::unique_ptr<Impl> impl;
Port web_service from Citra
2018-09-16 18:05:51 +00:00
};
} // namespace WebService
Reference in a new issue Copy permalink