pcm_data.h File Reference

#include "core/wx_stl_compat.h"
#include <map>
#include <json_common.h>
#include <core/json_serializers.h>
#include <optional>
#include <string>
#include <tuple>
#include <vector>
#include <wx/string.h>

Go to the source code of this file.

Classes
struct	PCM_CONTACT
struct	PACKAGE_VERSION
	< Package version metadata Package metadata More...
struct	PCM_PACKAGE
	Repository reference to a resource. More...
struct	PCM_RESOURCE_REFERENCE
	Repository metadata. More...
struct	PCM_REPOSITORY
	Package installation entry. More...
struct	PCM_INSTALLATION_ENTRY

Typedefs
using	STRING_MAP = std::map< std::string, wxString >

Enumerations
enum	PCM_PACKAGE_TYPE {   PT_INVALID , PT_PLUGIN , PT_FAB , PT_LIBRARY ,   PT_COLORTHEME }
	< Supported package types More...
enum	PCM_PLUGIN_CATEGORY { PC_INVALID , PC_GENERAL , PC_FAB }
enum	PCM_PACKAGE_VERSION_STATUS {   PVS_INVALID , PVS_STABLE , PVS_TESTING , PVS_DEVELOPMENT ,   PVS_DEPRECATED }

Functions
	NLOHMANN_JSON_SERIALIZE_ENUM (PCM_PACKAGE_TYPE, { { PT_INVALID, "invalid" }, { PT_PLUGIN, "plugin" }, { PT_FAB, "fab" }, { PT_LIBRARY, "library" }, { PT_COLORTHEME, "colortheme" }, }) NLOHMANN_JSON_SERIALIZE_ENUM(PCM_PLUGIN_CATEGORY
void	from_json (const json &j, PACKAGE_VERSION &v)
void	to_json (json &j, const PCM_PACKAGE &p)
void	from_json (const json &j, PCM_PACKAGE &p)
void	to_json (json &j, const PCM_RESOURCE_REFERENCE &r)
void	from_json (const json &j, PCM_RESOURCE_REFERENCE &r)
void	to_json (json &j, const PCM_REPOSITORY &r)
void	from_json (const json &j, PCM_REPOSITORY &r)
void	to_json (json &j, const PCM_INSTALLATION_ENTRY &e)
void	from_json (const json &j, PCM_INSTALLATION_ENTRY &e)

Typedef Documentation

STRING_MAP

using STRING_MAP = std::map<std::string, wxString>

Definition at line 36 of file pcm_data.h.

Enumeration Type Documentation

PCM_PACKAGE_TYPE

enum PCM_PACKAGE_TYPE

< Supported package types

Enumerator
PT_INVALID
PT_PLUGIN
PT_FAB
PT_LIBRARY
PT_COLORTHEME

Definition at line 41 of file pcm_data.h.

PCM_PACKAGE_VERSION_STATUS

enum PCM_PACKAGE_VERSION_STATUS

Enumerator
PVS_INVALID
PVS_STABLE
PVS_TESTING
PVS_DEVELOPMENT
PVS_DEPRECATED

Definition at line 60 of file pcm_data.h.

PCM_PLUGIN_CATEGORY

enum PCM_PLUGIN_CATEGORY

Enumerator
PC_INVALID
PC_GENERAL
PC_FAB

Definition at line 51 of file pcm_data.h.

Function Documentation

from_json() [1/5]

void from_json	(	const json &	j,
		PACKAGE_VERSION &	v
	)

Definition at line 68 of file pcm_data.cpp.

References PACKAGE_VERSION::download_sha256, PACKAGE_VERSION::download_size, PACKAGE_VERSION::download_url, PACKAGE_VERSION::install_size, PACKAGE_VERSION::keep_on_update, PACKAGE_VERSION::kicad_version, PACKAGE_VERSION::kicad_version_max, PACKAGE_VERSION::platforms, PACKAGE_VERSION::status, to_optional(), PACKAGE_VERSION::version, and PACKAGE_VERSION::version_epoch.

from_json() [2/5]

void from_json	(	const json &	j,
		PCM_INSTALLATION_ENTRY &	e
	)

Definition at line 193 of file pcm_data.cpp.

References PCM_INSTALLATION_ENTRY::current_version, PCM_INSTALLATION_ENTRY::install_timestamp, PCM_INSTALLATION_ENTRY::package, PCM_INSTALLATION_ENTRY::pinned, PCM_INSTALLATION_ENTRY::repository_id, and PCM_INSTALLATION_ENTRY::repository_name.

from_json() [3/5]

void from_json	(	const json &	j,
		PCM_PACKAGE &	p
	)

Definition at line 112 of file pcm_data.cpp.

References PCM_PACKAGE::author, PCM_PACKAGE::category, PCM_PACKAGE::description, PCM_PACKAGE::description_full, PCM_PACKAGE::identifier, PCM_PACKAGE::keep_on_update, PCM_PACKAGE::license, PCM_PACKAGE::maintainer, PCM_PACKAGE::name, PC_FAB, PT_FAB, PT_PLUGIN, PCM_PACKAGE::resources, PCM_PACKAGE::tags, to_optional(), PCM_PACKAGE::type, and PCM_PACKAGE::versions.

from_json() [4/5]

void from_json	(	const json &	j,
		PCM_REPOSITORY &	r
	)

Definition at line 171 of file pcm_data.cpp.

References PCM_REPOSITORY::maintainer, PCM_REPOSITORY::manifests, PCM_REPOSITORY::name, PCM_REPOSITORY::packages, PCM_REPOSITORY::resources, and to_optional().

from_json() [5/5]

void from_json	(	const json &	j,
		PCM_RESOURCE_REFERENCE &	r
	)

Definition at line 147 of file pcm_data.cpp.

References PCM_RESOURCE_REFERENCE::sha256, to_optional(), PCM_RESOURCE_REFERENCE::update_timestamp, and PCM_RESOURCE_REFERENCE::url.

NLOHMANN_JSON_SERIALIZE_ENUM()

NLOHMANN_JSON_SERIALIZE_ENUM	(	PCM_PACKAGE_TYPE	,
		{ { PT_INVALID, "invalid" }, { PT_PLUGIN, "plugin" }, { PT_FAB, "fab" }, { PT_LIBRARY, "library" }, { PT_COLORTHEME, "colortheme" }, }
	)

References PT_COLORTHEME, PT_FAB, PT_INVALID, PT_LIBRARY, and PT_PLUGIN.

to_json() [1/4]

void to_json	(	json &	j,
		const PCM_INSTALLATION_ENTRY &	e
	)

Definition at line 182 of file pcm_data.cpp.

References PCM_INSTALLATION_ENTRY::current_version, PCM_INSTALLATION_ENTRY::install_timestamp, PCM_INSTALLATION_ENTRY::package, PCM_INSTALLATION_ENTRY::pinned, PCM_INSTALLATION_ENTRY::repository_id, and PCM_INSTALLATION_ENTRY::repository_name.

to_json() [2/4]

void to_json	(	json &	j,
		const PCM_PACKAGE &	p
	)

Definition at line 89 of file pcm_data.cpp.

References PCM_PACKAGE::author, PCM_PACKAGE::description, PCM_PACKAGE::description_full, PCM_PACKAGE::identifier, PCM_PACKAGE::keep_on_update, PCM_PACKAGE::license, PCM_PACKAGE::maintainer, PCM_PACKAGE::name, PCM_PACKAGE::resources, PCM_PACKAGE::tags, PCM_PACKAGE::type, and PCM_PACKAGE::versions.

to_json() [3/4]

void to_json	(	json &	j,
		const PCM_REPOSITORY &	r
	)

Definition at line 156 of file pcm_data.cpp.

References PCM_REPOSITORY::maintainer, PCM_REPOSITORY::manifests, PCM_REPOSITORY::name, PCM_REPOSITORY::packages, and PCM_REPOSITORY::resources.

to_json() [4/4]

void to_json	(	json &	j,
		const PCM_RESOURCE_REFERENCE &	r
	)

Definition at line 138 of file pcm_data.cpp.

References PCM_RESOURCE_REFERENCE::sha256, PCM_RESOURCE_REFERENCE::update_timestamp, and PCM_RESOURCE_REFERENCE::url.