api_utils.cpp File Reference

#include <magic_enum.hpp>
#include <api/api_utils.h>
#include <api/api_enums.h>
#include <api/schematic/schematic_types.pb.h>
#include <line_ending.h>
#include <geometry/shape_poly_set.h>
#include <eda_item.h>
#include <kiid.h>
#include <project.h>
#include <stroke_params.h>
#include <wx/log.h>

Go to the source code of this file.

Namespaces
namespace	kiapi
namespace	kiapi::common

Functions
KICOMMON_API ApiResponseStatus	kiapi::common::MakeResponseStatus (ApiStatusCode aCode, const std::string &aMessage)
KICOMMON_API std::optional< KICAD_T >	kiapi::common::TypeNameFromAny (const google::protobuf::Any &aMessage)
KICOMMON_API LIB_ID	kiapi::common::UnpackLibId (const types::LibraryIdentifier &aId)
KICOMMON_API void	kiapi::common::PackLibId (types::LibraryIdentifier *aOutput, const LIB_ID &aId)
KICOMMON_API void	kiapi::common::PackVector2 (types::Vector2 &aOutput, const VECTOR2I &aInput, const EDA_IU_SCALE &aScale)
KICOMMON_API VECTOR2I	kiapi::common::UnpackVector2 (const types::Vector2 &aInput, const EDA_IU_SCALE &aScale)
KICOMMON_API void	kiapi::common::PackVector3D (types::Vector3D &aOutput, const VECTOR3D &aInput)
KICOMMON_API VECTOR3D	kiapi::common::UnpackVector3D (const types::Vector3D &aInput)
KICOMMON_API void	kiapi::common::PackBox2 (types::Box2 &aOutput, const BOX2I &aInput, const EDA_IU_SCALE &aScale)
KICOMMON_API BOX2I	kiapi::common::UnpackBox2 (const types::Box2 &aInput, const EDA_IU_SCALE &aScale)
KICOMMON_API void	kiapi::common::PackDistance (types::Distance &aOutput, int aInput, const EDA_IU_SCALE &aScale)
KICOMMON_API int	kiapi::common::UnpackDistance (const types::Distance &aInput, const EDA_IU_SCALE &aScale)
KICOMMON_API void	kiapi::common::PackPolyLine (types::PolyLine &aOutput, const SHAPE_LINE_CHAIN &aSlc, const EDA_IU_SCALE &aScale)
KICOMMON_API SHAPE_LINE_CHAIN	kiapi::common::UnpackPolyLine (const types::PolyLine &aInput, const EDA_IU_SCALE &aScale)
KICOMMON_API void	kiapi::common::PackPolySet (types::PolySet &aOutput, const SHAPE_POLY_SET &aInput, const EDA_IU_SCALE &aScale)
KICOMMON_API SHAPE_POLY_SET	kiapi::common::UnpackPolySet (const types::PolySet &aInput, const EDA_IU_SCALE &aScale)
KICOMMON_API void	kiapi::common::PackColor (types::Color &aOutput, const KIGFX::COLOR4D &aInput)
KICOMMON_API KIGFX::COLOR4D	kiapi::common::UnpackColor (const types::Color &aInput)
KICOMMON_API void	kiapi::common::PackSheetPath (types::SheetPath &aOutput, const KIID_PATH &aInput)
KICOMMON_API KIID_PATH	kiapi::common::UnpackSheetPath (const types::SheetPath &aInput)
KICOMMON_API void	kiapi::common::PackStroke (types::StrokeAttributes &aOutput, const STROKE_PARAMS &aInput, const EDA_IU_SCALE &aScale)
KICOMMON_API void	kiapi::common::UnpackStroke (STROKE_PARAMS &aOutput, const types::StrokeAttributes &aInput, const EDA_IU_SCALE &aScale)
KICOMMON_API void	kiapi::common::PackLineEnding (types::LineEnding &aOutput, const LINE_ENDING &aInput, const EDA_IU_SCALE &aScale)
KICOMMON_API LINE_ENDING	kiapi::common::UnpackLineEnding (const types::LineEnding &aInput, const EDA_IU_SCALE &aScale)
KICOMMON_API void	kiapi::common::PackProject (types::ProjectSpecifier &aOutput, const PROJECT &aInput)
KICOMMON_API bool	kiapi::common::PackKiwayApiMessage (const google::protobuf::Message &aMessage, std::string &aBytes)
KICOMMON_API void	kiapi::common::PackCustomProperties (google::protobuf::RepeatedPtrField< types::CustomProperty > *aOutput, const EDA_ITEM &aItem)
KICOMMON_API void	kiapi::common::UnpackCustomProperties (const google::protobuf::RepeatedPtrField< types::CustomProperty > &aInput, EDA_ITEM &aItem)

Variables
const wxChar *const	traceApi = wxT( "KICAD_API" )
	Flag to enable debug output related to the IPC API and its plugin system.
const KICOMMON_API std::string	kiapi::common::KiwayClientName = "org.kicad.internal.kiway"
const KICOMMON_API std::string	kiapi::common::StandaloneCrossProbeClientName = "org.kicad.internal.crossprobe"