#include <cmath>
#include <map>
#include <set>
#include <unordered_map>
#include <ki_exception.h>
#include <math/util.h>
#include <wx/log.h>
#include <wx/translation.h>
#include "altium_parser_pcb.h"
#include "io/altium/altium_binary_parser.h"
#include "io/altium/altium_props_utils.h"

Functions
ALTIUM_LAYER	altium_versioned_layer (ALTIUM_LAYER aV6Layer, ALTIUM_LAYER aV7Layer)

bool	altiumScopeExprMatchesPolygon (const wxString &aExpr)
	Return true if an Altium rule scope expression targets polygon pour primitives (matches InPolygon, InPoly, IsPolygon, or IsPoly).

const ARULE6 *	selectAltiumPolygonRule (const std::vector< ARULE6 > &aRulesByPriorityAsc)
	Select the highest Altium-priority rule whose scope references polygons.

bool	altiumViaSideIsTented (bool aTentFlag, bool aManual, bool aFromHole, uint32_t aHoleSize, int32_t aMaskExpansion, int aLandDiameter)
	Decide whether one side of an Altium via should be tented when imported into KiCad.

ALTIUM_LAYER	altium_layer_from_name (const wxString &aName)

ALTIUM_MECHKIND	altium_mechkind_from_name (const wxString &aName)

void	altium_parse_polygons (std::map< wxString, wxString > &aProps, std::vector< ALTIUM_VERTICE > &aVertices)

static ALTIUM_MODE	ReadAltiumModeFromProperties (const std::map< wxString, wxString > &aProps, wxString aKey)

static ALTIUM_RECORD	ReadAltiumRecordFromProperties (const std::map< wxString, wxString > &aProps, wxString aKey)

static AEXTENDED_PRIMITIVE_INFORMATION_TYPE	ReadAltiumExtendedPrimitiveInformationTypeFromProperties (const std::map< wxString, wxString > &aProps, wxString aKey)

static void	ExpectSubrecordLengthAtLeast (const std::string &aStreamType, const std::string &aSubrecordName, size_t aExpectedLength, size_t aActualLength)
	Throw an IO_ERROR if the actual length is less than the expected length.

static wxString	MakeAltiumDielectricKey (const wxString &aMaterial, int32_t aHeight, double aConst)

static std::map< wxString, double >	ReadAltiumDielectricLossTangents (const std::map< wxString, wxString > &aProps)

static std::vector< ABOARD6_LAYER_STACKUP >	ReadAltiumStackupFromProperties (const std::map< wxString, wxString > &aProps)

Variables
static const wxChar *	traceAltiumImport = wxT( "KICAD_ALTIUM_IMPORT" )
	Flag to enable Altium importer logging.

Function Documentation

◆ altium_layer_from_name()

ALTIUM_LAYER altium_layer_from_name ( const wxString & aName )

Definition at line 106 of file altium_parser_pcb.cpp.

References _, BACKGROUND, BOTTOM_LAYER, BOTTOM_OVERLAY, BOTTOM_PASTE, BOTTOM_SOLDER, CONNECTIONS, DRC_ERROR_MARKERS, DRILL_DRAWING, DRILL_GUIDE, INTERNAL_PLANE_1, INTERNAL_PLANE_10, INTERNAL_PLANE_11, INTERNAL_PLANE_12, INTERNAL_PLANE_13, INTERNAL_PLANE_14, INTERNAL_PLANE_15, INTERNAL_PLANE_16, INTERNAL_PLANE_2, INTERNAL_PLANE_3, INTERNAL_PLANE_4, INTERNAL_PLANE_5, INTERNAL_PLANE_6, INTERNAL_PLANE_7, INTERNAL_PLANE_8, INTERNAL_PLANE_9, KEEP_OUT_LAYER, MECHANICAL_1, MECHANICAL_10, MECHANICAL_11, MECHANICAL_12, MECHANICAL_13, MECHANICAL_14, MECHANICAL_15, MECHANICAL_16, MECHANICAL_2, MECHANICAL_3, MECHANICAL_4, MECHANICAL_5, MECHANICAL_6, MECHANICAL_7, MECHANICAL_8, MECHANICAL_9, MID_LAYER_1, MID_LAYER_10, MID_LAYER_11, MID_LAYER_12, MID_LAYER_13, MID_LAYER_14, MID_LAYER_15, MID_LAYER_16, MID_LAYER_17, MID_LAYER_18, MID_LAYER_19, MID_LAYER_2, MID_LAYER_20, MID_LAYER_21, MID_LAYER_22, MID_LAYER_23, MID_LAYER_24, MID_LAYER_25, MID_LAYER_26, MID_LAYER_27, MID_LAYER_28, MID_LAYER_29, MID_LAYER_3, MID_LAYER_30, MID_LAYER_4, MID_LAYER_5, MID_LAYER_6, MID_LAYER_7, MID_LAYER_8, MID_LAYER_9, MULTI_LAYER, PAD_HOLES, SELECTIONS, TOP_LAYER, TOP_OVERLAY, TOP_PASTE, TOP_SOLDER, UNKNOWN, V7_MECHANICAL_BASE, VIA_HOLES, VISIBLE_GRID_1, and VISIBLE_GRID_2.

Referenced by ACOMPONENT6::ACOMPONENT6(), ADIMENSION6::ADIMENSION6(), APOLYGON6::APOLYGON6(), and AREGION6::AREGION6().

◆ altium_mechkind_from_name()

ALTIUM_MECHKIND altium_mechkind_from_name ( const wxString & aName )

Definition at line 224 of file altium_parser_pcb.cpp.

References _, ASSEMBLY_BOT, ASSEMBLY_NOTES, ASSEMBLY_TOP, BOARD, BOARD_SHAPE, BODY_3D_BOT, BODY_3D_TOP, COATING_BOT, COATING_TOP, COMPONENT_CENTER_BOT, COMPONENT_CENTER_TOP, COMPONENT_OUTLINE_BOT, COMPONENT_OUTLINE_TOP, COURTYARD_BOT, COURTYARD_TOP, DESIGNATOR_BOT, DESIGNATOR_TOP, DIMENSIONS, DIMENSIONS_BOT, DIMENSIONS_TOP, FAB_NOTES, GLUE_POINTS_BOT, GLUE_POINTS_TOP, GOLD_PLATING_BOT, GOLD_PLATING_TOP, ROUTE_TOOL_PATH, SHEET, UNKNOWN, V_CUT, VALUE_BOT, and VALUE_TOP.

Referenced by ABOARD6_LAYER_STACKUP::ABOARD6_LAYER_STACKUP().

◆ altium_parse_polygons()

void altium_parse_polygons	(	std::map< wxString, wxString > &	aProps,
		std::vector< ALTIUM_VERTICE > &	aVertices )

Definition at line 287 of file altium_parser_pcb.cpp.

References radius, ALTIUM_PROPS_UTILS::ReadDouble(), ALTIUM_PROPS_UTILS::ReadInt(), and ALTIUM_PROPS_UTILS::ReadKicadUnit().

Referenced by ABOARD6::ABOARD6(), and APOLYGON6::APOLYGON6().

◆ altium_versioned_layer()

ALTIUM_LAYER altium_versioned_layer	(	ALTIUM_LAYER	aV6Layer,
		ALTIUM_LAYER	aV7Layer )

Definition at line 54 of file altium_parser_pcb.cpp.

References V7_MECHANICAL_17, and V7_MECHANICAL_LAST.

Referenced by AARC6::AARC6(), ADIMENSION6::ADIMENSION6(), AFILL6::AFILL6(), APAD6::APAD6(), APOLYGON6::APOLYGON6(), AREGION6::AREGION6(), ATEXT6::ATEXT6(), and ATRACK6::ATRACK6().

◆ altiumScopeExprMatchesPolygon()

bool altiumScopeExprMatchesPolygon ( const wxString & aExpr )

Return true if an Altium rule scope expression targets polygon pour primitives (matches InPolygon, InPoly, IsPolygon, or IsPoly).

Definition at line 63 of file altium_parser_pcb.cpp.

Referenced by BOOST_AUTO_TEST_CASE(), and selectAltiumPolygonRule().

◆ altiumViaSideIsTented()

bool altiumViaSideIsTented	(	bool	aTentFlag,
		bool	aManual,
		bool	aFromHole,
		uint32_t	aHoleSize,
		int32_t	aMaskExpansion,
		int	aLandDiameter )

Decide whether one side of an Altium via should be tented when imported into KiCad.

Returns the explicit Altium tent flag, except when the via uses a manual solder mask expansion measured from the hole edge. KiCad vias cannot represent a hole-referenced opening, so when the resulting opening (hole + 2 * expansion) does not clear the via land the pad copper is covered and the side is treated as tented.

Parameters

aTentFlag	explicit Altium tent flag for this side
aManual	true if the via carries a manual solder mask expansion
aFromHole	true if the manual expansion is measured from the hole edge
aHoleSize	via hole diameter (KiCad nm)
aMaskExpansion	solder mask expansion for this side (KiCad nm, may be negative)
aLandDiameter	via land (copper) diameter for this side (KiCad nm)

Definition at line 86 of file altium_parser_pcb.cpp.

Referenced by BOOST_AUTO_TEST_CASE(), and ALTIUM_PCB::ParseVias6Data().

◆ ExpectSubrecordLengthAtLeast()

static void ExpectSubrecordLengthAtLeast	(	const std::string &	aStreamType,
		const std::string &	aSubrecordName,
		size_t	aExpectedLength,
		size_t	aActualLength )

static

Throw an IO_ERROR if the actual length is less than the expected length.

Parameters

aStreamType	the current stream type (e.g. 'Pads6')
aSubrecordName	the current subrecord name (e.g. 'subrecord5')
aExpectedLength	the expected length needed to parse the stream
aActualLength	the actual length of the subrecord encountered

Definition at line 380 of file altium_parser_pcb.cpp.

References THROW_IO_ERROR.

Referenced by APAD6::APAD6().

◆ MakeAltiumDielectricKey()

static wxString MakeAltiumDielectricKey	(	const wxString &	aMaterial,
		int32_t	aHeight,
		double	aConst )

static

Definition at line 446 of file altium_parser_pcb.cpp.

Referenced by ReadAltiumDielectricLossTangents(), and ReadAltiumStackupFromProperties().

◆ ReadAltiumDielectricLossTangents()

static std::map< wxString, double > ReadAltiumDielectricLossTangents ( const std::map< wxString, wxString > & aProps )

static

Definition at line 459 of file altium_parser_pcb.cpp.

References std::abs(), MakeAltiumDielectricKey(), ALTIUM_PROPS_UTILS::ReadDouble(), ALTIUM_PROPS_UTILS::ReadKicadUnit(), and ALTIUM_PROPS_UTILS::ReadString().

Referenced by ReadAltiumStackupFromProperties().

◆ ReadAltiumExtendedPrimitiveInformationTypeFromProperties()

static AEXTENDED_PRIMITIVE_INFORMATION_TYPE ReadAltiumExtendedPrimitiveInformationTypeFromProperties	(	const std::map< wxString, wxString > &	aProps,
		wxString	aKey )

static

Definition at line 359 of file altium_parser_pcb.cpp.

References _, MASK, ALTIUM_PROPS_UTILS::ReadString(), and UNKNOWN.

Referenced by AEXTENDED_PRIMITIVE_INFORMATION::AEXTENDED_PRIMITIVE_INFORMATION().

◆ ReadAltiumModeFromProperties()

static ALTIUM_MODE ReadAltiumModeFromProperties	(	const std::map< wxString, wxString > &	aProps,
		wxString	aKey )

static

Definition at line 314 of file altium_parser_pcb.cpp.

References _, MANUAL, NONE, ALTIUM_PROPS_UTILS::ReadString(), RULE, and UNKNOWN.

Referenced by AEXTENDED_PRIMITIVE_INFORMATION::AEXTENDED_PRIMITIVE_INFORMATION().

◆ ReadAltiumRecordFromProperties()

static ALTIUM_RECORD ReadAltiumRecordFromProperties	(	const std::map< wxString, wxString > &	aProps,
		wxString	aKey )

static

Definition at line 331 of file altium_parser_pcb.cpp.

References _, ARC, FILL, MODEL, PAD, ALTIUM_PROPS_UTILS::ReadString(), REGION, TEXT, TRACK, UNKNOWN, and VIA.

Referenced by AEXTENDED_PRIMITIVE_INFORMATION::AEXTENDED_PRIMITIVE_INFORMATION().

◆ ReadAltiumStackupFromProperties()

static std::vector< ABOARD6_LAYER_STACKUP > ReadAltiumStackupFromProperties ( const std::map< wxString, wxString > & aProps )

static

Definition at line 505 of file altium_parser_pcb.cpp.

References MakeAltiumDielectricKey(), and ReadAltiumDielectricLossTangents().

Referenced by ABOARD6::ABOARD6(), and ALIBRARY::ALIBRARY().

◆ selectAltiumPolygonRule()

const ARULE6 * selectAltiumPolygonRule ( const std::vector< ARULE6 > & aRulesByPriorityAsc )

Select the highest Altium-priority rule whose scope references polygons.

Altium priority 1 is the most specific; larger numeric values are more general. aRulesByPriorityAsc must be sorted by ARULE6::priority in ascending numeric order so the first polygon-scoped match is also the highest Altium priority.

Returns nullptr if no rule references polygons.

Definition at line 71 of file altium_parser_pcb.cpp.

References altiumScopeExprMatchesPolygon().

Referenced by BOOST_AUTO_TEST_CASE(), and ALTIUM_PCB::GetRuleForPolygon().

Functions

Variables

Function Documentation

◆ altium_layer_from_name()

◆ altium_mechkind_from_name()

◆ altium_parse_polygons()

◆ altium_versioned_layer()

◆ altiumScopeExprMatchesPolygon()

◆ altiumViaSideIsTented()

◆ ExpectSubrecordLengthAtLeast()

◆ MakeAltiumDielectricKey()

◆ ReadAltiumDielectricLossTangents()

◆ ReadAltiumExtendedPrimitiveInformationTypeFromProperties()

◆ ReadAltiumModeFromProperties()

◆ ReadAltiumRecordFromProperties()

◆ ReadAltiumStackupFromProperties()

◆ selectAltiumPolygonRule()