api_utils.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2024 Jon Evans <[email protected]>
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef KICAD_API_UTILS_H
#define KICAD_API_UTILS_H
 
#include <optional>
#include <google/protobuf/any.pb.h>
#include <google/protobuf/repeated_field.h>
 
#include <base_units.h>
#include <core/typeinfo.h>
#include <lib_id.h>
#include <api/common/envelope.pb.h>
#include <api/common/types/base_types.pb.h>
#include <layer_ids.h>
#include <geometry/shape_line_chain.h>
#include <math/vector2d.h>
#include <math/vector3.h>
#include <gal/color4d.h>
 
class LINE_ENDING;
class SHAPE_LINE_CHAIN;
class STROKE_PARAMS;
class TEXT_ATTRIBUTES;
class KIID_PATH;
class EDA_ITEM;
class PROJECT;

extern const KICOMMON_API wxChar* const traceApi;
 
namespace kiapi::common
{
 
KICOMMON_API ApiResponseStatus MakeResponseStatus( ApiStatusCode aCode, const std::string& aMessage = "" );
 
KICOMMON_API std::optional<KICAD_T> TypeNameFromAny( const google::protobuf::Any& aMessage );
 
KICOMMON_API LIB_ID UnpackLibId( const types::LibraryIdentifier& aId );
 
KICOMMON_API void PackLibId( types::LibraryIdentifier* aOutput, const LIB_ID& aId );
 
KICOMMON_API void PackVector2( types::Vector2& aOutput, const VECTOR2I& aInput,
                               const EDA_IU_SCALE& aScale = pcbIUScale );
 
KICOMMON_API VECTOR2I UnpackVector2( const types::Vector2& aInput, const EDA_IU_SCALE& aScale = pcbIUScale );
 
KICOMMON_API void PackVector3D( types::Vector3D& aOutput, const VECTOR3D& aInput );
 
KICOMMON_API VECTOR3D UnpackVector3D( const types::Vector3D& aInput );
 
KICOMMON_API void PackBox2( types::Box2& aOutput, const BOX2I& aInput, const EDA_IU_SCALE& aScale = pcbIUScale );
 
KICOMMON_API BOX2I UnpackBox2( const types::Box2& aInput, const EDA_IU_SCALE& aScale = pcbIUScale );
 
KICOMMON_API void PackPolyLine( types::PolyLine& aOutput, const SHAPE_LINE_CHAIN& aSlc,
                                const EDA_IU_SCALE& aScale = pcbIUScale );
 
KICOMMON_API SHAPE_LINE_CHAIN UnpackPolyLine( const types::PolyLine& aInput, const EDA_IU_SCALE& aScale = pcbIUScale );
 
KICOMMON_API void PackPolySet( types::PolySet& aOutput, const SHAPE_POLY_SET& aInput,
                               const EDA_IU_SCALE& aScale = pcbIUScale );
 
KICOMMON_API SHAPE_POLY_SET UnpackPolySet( const types::PolySet& aInput, const EDA_IU_SCALE& aScale = pcbIUScale );
 
KICOMMON_API void PackColor( types::Color& aOutput, const KIGFX::COLOR4D& aInput );
 
KICOMMON_API KIGFX::COLOR4D UnpackColor( const types::Color& aInput );
 
KICOMMON_API void PackDistance( types::Distance& aOutput, int aInput, const EDA_IU_SCALE& aScale = pcbIUScale );
 
KICOMMON_API int UnpackDistance( const types::Distance& aInput, const EDA_IU_SCALE& aScale = pcbIUScale );
 
KICOMMON_API void PackSheetPath( types::SheetPath& aOutput, const KIID_PATH& aInput );
 
KICOMMON_API KIID_PATH UnpackSheetPath( const types::SheetPath& aInput );
 
KICOMMON_API void PackStroke( kiapi::common::types::StrokeAttributes& aOutput, const STROKE_PARAMS& aInput,
                              const EDA_IU_SCALE& aScale = pcbIUScale );
 
KICOMMON_API void UnpackStroke( STROKE_PARAMS& aOutput, const kiapi::common::types::StrokeAttributes& aInput,
                                const EDA_IU_SCALE& aScale = pcbIUScale );
 
KICOMMON_API void PackLineEnding( kiapi::common::types::LineEnding& aOutput, const LINE_ENDING& aInput,
                                  const EDA_IU_SCALE& aScale = pcbIUScale );
 
KICOMMON_API LINE_ENDING UnpackLineEnding( const kiapi::common::types::LineEnding& aInput,
                                           const EDA_IU_SCALE& aScale = pcbIUScale );
 
KICOMMON_API void PackCustomProperties( google::protobuf::RepeatedPtrField<types::CustomProperty>* aOutput,
                                        const EDA_ITEM& aItem );
 
KICOMMON_API void UnpackCustomProperties( const google::protobuf::RepeatedPtrField<types::CustomProperty>& aInput,
                                          EDA_ITEM& aItem );
 
KICOMMON_API void PackProject( types::ProjectSpecifier& aOutput, const PROJECT& aInput );
 
extern const KICOMMON_API std::string KiwayClientName;
extern const KICOMMON_API std::string StandaloneCrossProbeClientName;
 
KICOMMON_API bool PackKiwayApiMessage( const google::protobuf::Message& aMessage, std::string& aBytes );
 
// Not KICOMMON_API: depends on font stuff in GAL for now
void PackTextAttributes( kiapi::common::types::TextAttributes& aOutput, const TEXT_ATTRIBUTES& aInput,
                         const EDA_IU_SCALE& aScale = pcbIUScale );
 
// Not KICOMMON_API: depends on font stuff in GAL for now
void UnpackTextAttributes( TEXT_ATTRIBUTES& aOutput, const kiapi::common::types::TextAttributes& aInput,
                           const EDA_IU_SCALE& aScale = pcbIUScale );
 
} // namespace kiapi::common
 
#endif //KICAD_API_UTILS_H