Read a Pcbnew s-expression formatted LINE_READER object and returns the appropriate BOARD_ITEM object. More...

#include <pcb_io_kicad_sexpr_parser.h>

Inheritance diagram for PCB_IO_KICAD_SEXPR_PARSER:

Classes
struct	GENERATOR_INFO
	Convert net code using the mapping table if available, otherwise returns unchanged net code if < 0 or if it's out of range. More...

struct	GROUP_INFO

Public Member Functions
	PCB_IO_KICAD_SEXPR_PARSER (LINE_READER aReader, BOARD aAppendToMe, std::function< bool(wxString, int, wxString, wxString)> aQueryUserCallback, PROGRESS_REPORTER *aProgressReporter=nullptr, unsigned aLineCount=0)

BOARD_ITEM *	Parse ()

FOOTPRINT *	parseFOOTPRINT (wxArrayString *aInitialComments=nullptr)

bool	IsTooRecent ()
	Return whether a version number, if any was parsed, was too recent.

wxString	GetRequiredVersion ()
	Return a string representing the version of KiCad required to open this file.

bool	IsValidBoardHeader ()
	Partially parse the input and check if it matches expected header.

Private Types
typedef std::unordered_map< std::string, PCB_LAYER_ID >	LAYER_ID_MAP

typedef std::unordered_map< std::string, LSET >	LSET_MAP

typedef std::unordered_map< wxString, KIID >	KIID_MAP
	The type of progress bar timeout.

using	TIMEOUT = std::chrono::milliseconds
	The clock used for the timestamp (guaranteed to be monotonic).

using	CLOCK = std::chrono::steady_clock
	The type of the time stamps.

using	TIME_PT = std::chrono::time_point< CLOCK >

Private Member Functions
int	getNetCode (int aNetCode)

void	pushValueIntoMap (int aIndex, int aValue)
	Add aValue value in netcode mapping (m_netCodes) at aIndex.

void	init ()
	Clear and re-establish m_layerMap with the default layer names.

void	checkpoint ()

void	createOldLayerMapping (std::unordered_map< std::string, std::string > &aMap)
	Create a mapping from the (short-lived) bug where layer names were translated.

void	skipCurrent ()
	Skip the current token level, i.e search for the RIGHT parenthesis which closes the current description.

void	parseHeader ()

void	parseGeneralSection ()

void	parsePAGE_INFO ()

void	parseTITLE_BLOCK ()

void	parseLayers ()

void	parseLayer (LAYER *aLayer)

void	parseBoardStackup ()

void	parseSetup ()

void	parseDefaults (BOARD_DESIGN_SETTINGS &aSettings)

void	parseDefaultTextDims (BOARD_DESIGN_SETTINGS &aSettings, int aLayer)

void	parseNETINFO_ITEM ()

void	parseNETCLASS ()

void	parseTEARDROP_PARAMETERS (TEARDROP_PARAMETERS *tdParams)

void	parseTextBoxContent (PCB_TEXTBOX *aTextBox)

PCB_SHAPE *	parsePCB_SHAPE (BOARD_ITEM *aParent)

PCB_TEXT *	parsePCB_TEXT (BOARD_ITEM *aParent)

void	parsePCB_TEXT_effects (PCB_TEXT *aText)

PCB_REFERENCE_IMAGE *	parsePCB_REFERENCE_IMAGE (BOARD_ITEM *aParent)

PCB_TEXTBOX *	parsePCB_TEXTBOX (BOARD_ITEM *aParent)

PCB_TABLECELL *	parsePCB_TABLECELL (BOARD_ITEM *aParent)

PCB_TABLE *	parsePCB_TABLE (BOARD_ITEM *aParent)

PCB_DIMENSION_BASE *	parseDIMENSION (BOARD_ITEM *aParent)

FOOTPRINT *	parseFOOTPRINT_unchecked (wxArrayString *aInitialComments=nullptr)

PAD *	parsePAD (FOOTPRINT *aParent=nullptr)

bool	parsePAD_option (PAD *aPad)

PCB_ARC *	parseARC ()

PCB_TRACK *	parsePCB_TRACK ()

PCB_VIA *	parsePCB_VIA ()

ZONE *	parseZONE (BOARD_ITEM_CONTAINER *aParent)

PCB_TARGET *	parsePCB_TARGET ()

BOARD *	parseBOARD ()

void	parseGROUP_members (GROUP_INFO &aGroupInfo)

void	parseGROUP (BOARD_ITEM *aParent)

void	parseGENERATOR (BOARD_ITEM *aParent)

BOARD *	parseBOARD_unchecked ()

template<class T , class M >
T	lookUpLayer (const M &aMap)
	Parse the current token for the layer definition of a BOARD_ITEM object.

PCB_LAYER_ID	parseBoardItemLayer ()
	Parse the layer definition of a BOARD_ITEM object.

LSET	parseBoardItemLayersAsMask ()
	Parse the layers definition of a BOARD_ITEM object.

VECTOR2I	parseXY ()
	Parse a coordinate pair (xy X Y) in board units (mm).

void	parseXY (int aX, int aY)

void	parseMargins (int &aLeft, int &aTop, int &aRight, int &aBottom)

std::pair< wxString, wxString >	parseBoardProperty ()

void	parseOutlinePoints (SHAPE_LINE_CHAIN &aPoly)
	Parses possible outline points and stores them into `aPoly`.

void	parseEDA_TEXT (EDA_TEXT *aText)
	Parse the common settings for any object derived from EDA_TEXT.

void	parseRenderCache (EDA_TEXT *text)
	Parse the render cache for any object derived from EDA_TEXT.

FP_3DMODEL *	parse3DModel ()

int	parseBoardUnits ()
	Parse the current token as an ASCII numeric string with possible leading whitespace into a double precision floating point number.

int	parseBoardUnits (const char *aExpected)

int	parseBoardUnits (PCB_KEYS_T::T aToken)

int	parseInt ()

int	parseInt (const char *aExpected)

long	parseHex ()

bool	parseBool ()

bool	parseMaybeAbsentBool (bool aDefaultValue)
	Parses a boolean flag inside a list that existed before boolean normalization.

KIID	CurStrToKIID ()

void	resolveGroups (BOARD_ITEM *aParent)
	Called after parsing a footprint definition or board to build the group membership lists.

Private Attributes
BOARD *	m_board

LAYER_ID_MAP	m_layerIndices
	map layer name to it's index

LSET_MAP	m_layerMasks
	map layer names to their masks

std::set< wxString >	m_undefinedLayers
	set of layers not defined in layers section

std::vector< int >	m_netCodes
	net codes mapping for boards being loaded

bool	m_tooRecent
	true if version parses as later than supported

int	m_requiredVersion
	set to the KiCad format version this board requires

wxString	m_generatorVersion
	Set to the generator version this board requires.

bool	m_appendToExisting
	reading into an existing board; reset UUIDs

KIID_MAP	m_resetKIIDMap

bool	m_showLegacySegmentZoneWarning

bool	m_showLegacy5ZoneWarning

PROGRESS_REPORTER *	m_progressReporter
	optional; may be nullptr

TIME_PT	m_lastProgressTime
	for progress reporting

unsigned	m_lineCount
	for progress reporting

std::vector< GROUP_INFO >	m_groupInfos

std::vector< GENERATOR_INFO >	m_generatorInfos

std::function< bool(wxString aTitle, int aIcon, wxString aMsg, wxString aAction)>	m_queryUserCallback

Detailed Description

Read a Pcbnew s-expression formatted LINE_READER object and returns the appropriate BOARD_ITEM object.

Definition at line 75 of file pcb_io_kicad_sexpr_parser.h.

Member Typedef Documentation

◆ CLOCK

using PCB_IO_KICAD_SEXPR_PARSER::CLOCK = std::chrono::steady_clock

private

The type of the time stamps.

Definition at line 384 of file pcb_io_kicad_sexpr_parser.h.

◆ KIID_MAP

typedef std::unordered_map< wxString, KIID > PCB_IO_KICAD_SEXPR_PARSER::KIID_MAP

private

The type of progress bar timeout.

Definition at line 378 of file pcb_io_kicad_sexpr_parser.h.

◆ LAYER_ID_MAP

typedef std::unordered_map< std::string, PCB_LAYER_ID > PCB_IO_KICAD_SEXPR_PARSER::LAYER_ID_MAP

private

Definition at line 376 of file pcb_io_kicad_sexpr_parser.h.

◆ LSET_MAP

typedef std::unordered_map< std::string, LSET > PCB_IO_KICAD_SEXPR_PARSER::LSET_MAP

private

Definition at line 377 of file pcb_io_kicad_sexpr_parser.h.

◆ TIME_PT

using PCB_IO_KICAD_SEXPR_PARSER::TIME_PT = std::chrono::time_point<CLOCK>

private

Definition at line 387 of file pcb_io_kicad_sexpr_parser.h.

◆ TIMEOUT

using PCB_IO_KICAD_SEXPR_PARSER::TIMEOUT = std::chrono::milliseconds

private

The clock used for the timestamp (guaranteed to be monotonic).

Definition at line 381 of file pcb_io_kicad_sexpr_parser.h.

Constructor & Destructor Documentation

◆ PCB_IO_KICAD_SEXPR_PARSER()

PCB_IO_KICAD_SEXPR_PARSER::PCB_IO_KICAD_SEXPR_PARSER	(	LINE_READER *	aReader,
		BOARD *	aAppendToMe,
		std::function< bool(wxString, int, wxString, wxString)>	aQueryUserCallback,
		PROGRESS_REPORTER *	aProgressReporter = `nullptr`,
		unsigned	aLineCount = `0`
	)

inline

Definition at line 78 of file pcb_io_kicad_sexpr_parser.h.

References init().

Member Function Documentation

◆ checkpoint()

void PCB_IO_KICAD_SEXPR_PARSER::checkpoint ( )

private

Definition at line 135 of file pcb_io_kicad_sexpr_parser.cpp.

References _, delta, PROGRESS_REPORTER::KeepRefreshing(), m_lastProgressTime, m_lineCount, m_progressReporter, PROGRESS_REPORTER::SetCurrentProgress(), and THROW_IO_ERROR.

Referenced by parseBOARD_unchecked().

◆ createOldLayerMapping()

void PCB_IO_KICAD_SEXPR_PARSER::createOldLayerMapping ( std::unordered_map< std::string, std::string > & aMap )

private

Create a mapping from the (short-lived) bug where layer names were translated.

Todo:: Remove this once we support custom layer names.

Parameters

aMap	string mapping from translated to English layer names.

Definition at line 1802 of file pcb_io_kicad_sexpr_parser.cpp.

Referenced by parseLayers().

◆ CurStrToKIID()

KIID PCB_IO_KICAD_SEXPR_PARSER::CurStrToKIID ( )

private

Definition at line 6585 of file pcb_io_kicad_sexpr_parser.cpp.

References m_appendToExisting, and m_resetKIIDMap.

Referenced by parseARC(), parseDIMENSION(), parseFOOTPRINT_unchecked(), parseGENERATOR(), parseGROUP(), parsePAD(), parsePCB_REFERENCE_IMAGE(), parsePCB_SHAPE(), parsePCB_TARGET(), parsePCB_TEXT_effects(), parsePCB_TRACK(), parsePCB_VIA(), parseTextBoxContent(), and parseZONE().

◆ getNetCode()

int PCB_IO_KICAD_SEXPR_PARSER::getNetCode ( int aNetCode )

inlineprivate

Definition at line 150 of file pcb_io_kicad_sexpr_parser.h.

References m_netCodes.

Referenced by parseARC(), parsePAD(), parsePCB_SHAPE(), parsePCB_TRACK(), parsePCB_VIA(), and parseZONE().

◆ GetRequiredVersion()

wxString PCB_IO_KICAD_SEXPR_PARSER::GetRequiredVersion ( )

Return a string representing the version of KiCad required to open this file.

Not particularly meaningful if IsTooRecent() returns false.

Definition at line 267 of file pcb_io_kicad_sexpr_parser.cpp.

References _, m_requiredVersion, and THROW_PARSE_ERROR.

Referenced by PCB_IO_KICAD_SEXPR::DoLoad(), CLIPBOARD_IO::LoadBoard(), PCB_IO_KICAD_SEXPR::Parse(), parseBOARD(), and parseFOOTPRINT().

◆ init()

void PCB_IO_KICAD_SEXPR_PARSER::init ( )

private

Clear and re-establish m_layerMap with the default layer names.

m_layerMap will have some of its entries overwritten whenever a (new) board is encountered.

Definition at line 89 of file pcb_io_kicad_sexpr_parser.cpp.

References LSET::AllCuMask(), B_Adhes, B_CrtYd, B_Cu, B_Fab, B_Mask, B_Paste, B_SilkS, F_Adhes, F_CrtYd, F_Cu, F_Fab, F_Mask, F_Paste, F_SilkS, In15_Cu, LSET::InternalCuMask(), m_layerIndices, m_layerMasks, m_requiredVersion, m_resetKIIDMap, m_showLegacy5ZoneWarning, m_showLegacySegmentZoneWarning, m_tooRecent, LSET::Name(), PCB_LAYER_ID_COUNT, StrPrintf(), and TO_UTF8.

Referenced by PCB_IO_KICAD_SEXPR_PARSER().

◆ IsTooRecent()

bool PCB_IO_KICAD_SEXPR_PARSER::IsTooRecent ( )

inline

Return whether a version number, if any was parsed, was too recent.

Definition at line 107 of file pcb_io_kicad_sexpr_parser.h.

References m_tooRecent.

Referenced by PCB_IO_KICAD_SEXPR::DoLoad(), CLIPBOARD_IO::LoadBoard(), and PCB_IO_KICAD_SEXPR::Parse().

◆ IsValidBoardHeader()

bool PCB_IO_KICAD_SEXPR_PARSER::IsValidBoardHeader ( )

Partially parse the input and check if it matches expected header.

Returns: true if expected header matches

Definition at line 801 of file pcb_io_kicad_sexpr_parser.cpp.

References m_groupInfos.

Referenced by PCB_IO_KICAD_SEXPR::CanReadBoard().

◆ lookUpLayer()

template<class T , class M >

T PCB_IO_KICAD_SEXPR_PARSER::lookUpLayer ( const M & aMap )

private

Parse the current token for the layer definition of a BOARD_ITEM object.

Parameters

aMap	is the LAYER_{NUM\|MSK}_MAP to use for the lookup.

Returns: The result of the parsed BOARD_ITEM layer or set designator.

Exceptions

IO_ERROR	if the layer is not valid.
PARSE_ERROR	if the layer syntax is incorrect.

Definition at line 1982 of file pcb_io_kicad_sexpr_parser.cpp.

References m_undefinedLayers, and Rescue.

◆ Parse()

BOARD_ITEM * PCB_IO_KICAD_SEXPR_PARSER::Parse ( )

Definition at line 821 of file pcb_io_kicad_sexpr_parser.cpp.

References _, m_board, m_groupInfos, parseBOARD(), parseFOOTPRINT(), resolveGroups(), BOARD_ITEM::SetLocked(), and THROW_PARSE_ERROR.

Referenced by BOOST_FIXTURE_TEST_CASE(), PCB_IO_KICAD_SEXPR::DoLoad(), FP_CACHE::Load(), CLIPBOARD_IO::LoadBoard(), KIGIT_PCB_MERGE::Merge(), PCB_IO_KICAD_SEXPR::Parse(), parse(), readBoard(), and KI_TEST::ReadBoardItemFromStream().

◆ parse3DModel()

FP_3DMODEL * PCB_IO_KICAD_SEXPR_PARSER::parse3DModel ( )

private

Definition at line 692 of file pcb_io_kicad_sexpr_parser.cpp.

References FP_3DMODEL::m_Filename, FP_3DMODEL::m_Offset, FP_3DMODEL::m_Opacity, FP_3DMODEL::m_Rotation, FP_3DMODEL::m_Scale, FP_3DMODEL::m_Show, parseDouble(), parseMaybeAbsentBool(), VECTOR3< T >::x, VECTOR3< T >::y, and VECTOR3< T >::z.

Referenced by parseFOOTPRINT_unchecked().

◆ parseARC()

PCB_ARC * PCB_IO_KICAD_SEXPR_PARSER::parseARC ( )

private

Definition at line 5526 of file pcb_io_kicad_sexpr_parser.cpp.

References _, CurStrToKIID(), getNetCode(), m_board, parseBoardItemLayer(), parseBoardUnits(), parseHex(), parseInt(), parseMaybeAbsentBool(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by parseBOARD_unchecked().

◆ parseBOARD()

BOARD * PCB_IO_KICAD_SEXPR_PARSER::parseBOARD ( )

private

Definition at line 871 of file pcb_io_kicad_sexpr_parser.cpp.

References GetRequiredVersion(), m_tooRecent, and parseBOARD_unchecked().

Referenced by Parse().

◆ parseBOARD_unchecked()

BOARD * PCB_IO_KICAD_SEXPR_PARSER::parseBOARD_unchecked ( )

private

Definition at line 887 of file pcb_io_kicad_sexpr_parser.cpp.

References _, BOARD::Add(), B_Cu, BOARD_FILE_HOST_VERSION, checkpoint(), Cmts_User, BOARD::Drawings(), F_Cu, BOARD::FinalizeBulkAdd(), BOARD::Footprints(), BOARD::GetEnabledLayers(), BOARD::GetLayerName(), ZONE::GetLayerSet(), m_board, m_generatorVersion, BOARD::m_LegacyNetclassesLoaded, m_queryUserCallback, m_requiredVersion, m_undefinedLayers, parseARC(), parseBoardProperty(), parseDIMENSION(), parseFOOTPRINT(), parseGeneralSection(), parseGENERATOR(), parseGROUP(), parseHeader(), parseLayers(), parseNETCLASS(), parseNETINFO_ITEM(), parsePAGE_INFO(), parsePCB_REFERENCE_IMAGE(), parsePCB_SHAPE(), parsePCB_TABLE(), parsePCB_TARGET(), parsePCB_TEXT(), parsePCB_TEXTBOX(), parsePCB_TRACK(), parsePCB_VIA(), parseSetup(), parseTITLE_BLOCK(), parseZONE(), PCB_VIA_T, Pgm(), Rescue, BOARD::SetGenerator(), ZONE::SetLayerSet(), BOARD::SetProperties(), SEXPR_BOARD_FILE_VERSION, THROW_IO_ERROR, THROW_PARSE_ERROR, BOARD::Tracks(), via, and BOARD::Zones().

Referenced by parseBOARD().

◆ parseBoardItemLayer()

PCB_LAYER_ID PCB_IO_KICAD_SEXPR_PARSER::parseBoardItemLayer ( )

private

Parse the layer definition of a BOARD_ITEM object.

Returns: The index the parsed BOARD_ITEM layer.

Exceptions

IO_ERROR	if the layer is not valid.
PARSE_ERROR	if the layer syntax is incorrect.

Definition at line 2001 of file pcb_io_kicad_sexpr_parser.cpp.

References m_layerIndices, and UNDEFINED_LAYER.

Referenced by parseARC(), parseDIMENSION(), parseFOOTPRINT_unchecked(), parseGENERATOR(), parsePCB_REFERENCE_IMAGE(), parsePCB_SHAPE(), parsePCB_TABLE(), parsePCB_TARGET(), parsePCB_TEXT_effects(), parsePCB_TRACK(), parseTextBoxContent(), and parseZONE().

◆ parseBoardItemLayersAsMask()

LSET PCB_IO_KICAD_SEXPR_PARSER::parseBoardItemLayersAsMask ( )

private

Parse the layers definition of a BOARD_ITEM object.

Returns: The mask of layers the parsed BOARD_ITEM is on.

Exceptions

IO_ERROR	if any of the layers is not valid.
PARSE_ERROR	if the layers syntax is incorrect.

Definition at line 2016 of file pcb_io_kicad_sexpr_parser.cpp.

References m_layerMasks.

Referenced by parsePAD(), and parseZONE().

◆ parseBoardProperty()

std::pair< wxString, wxString > PCB_IO_KICAD_SEXPR_PARSER::parseBoardProperty ( )

private

Definition at line 417 of file pcb_io_kicad_sexpr_parser.cpp.

Referenced by parseBOARD_unchecked().

◆ parseBoardStackup()

void PCB_IO_KICAD_SEXPR_PARSER::parseBoardStackup ( )

private

Definition at line 1581 of file pcb_io_kicad_sexpr_parser.cpp.

Referenced by parseSetup().

◆ parseBoardUnits() [1/3]

int PCB_IO_KICAD_SEXPR_PARSER::parseBoardUnits ( )

private

Parse the current token as an ASCII numeric string with possible leading whitespace into a double precision floating point number.

Returns: The result of the parsed token.

Exceptions

IO_ERROR if an error occurs attempting to convert the current token.

Definition at line 190 of file pcb_io_kicad_sexpr_parser.cpp.

References INT_LIMIT, EDA_IU_SCALE::IU_PER_MM, KiROUND(), parseDouble(), and pcbIUScale.

Referenced by parseARC(), parseBoardStackup(), parseBoardUnits(), parseDefaults(), parseDefaultTextDims(), parseDIMENSION(), parseEDA_TEXT(), parseFOOTPRINT_unchecked(), parseGeneralSection(), parseGENERATOR(), parseMargins(), parseNETCLASS(), parseOutlinePoints(), parsePAD(), parsePCB_REFERENCE_IMAGE(), parsePCB_SHAPE(), parsePCB_TABLE(), parsePCB_TARGET(), parsePCB_TEXT_effects(), parsePCB_TRACK(), parsePCB_VIA(), parseSetup(), parseTEARDROP_PARAMETERS(), parseTextBoxContent(), parseXY(), and parseZONE().

◆ parseBoardUnits() [2/3]

int PCB_IO_KICAD_SEXPR_PARSER::parseBoardUnits ( const char * aExpected )

private

Definition at line 207 of file pcb_io_kicad_sexpr_parser.cpp.

References INT_LIMIT, EDA_IU_SCALE::IU_PER_MM, KiROUND(), parseDouble(), and pcbIUScale.

◆ parseBoardUnits() [3/3]

int PCB_IO_KICAD_SEXPR_PARSER::parseBoardUnits ( PCB_KEYS_T::T aToken )

inlineprivate

Definition at line 329 of file pcb_io_kicad_sexpr_parser.h.

References parseBoardUnits().

◆ parseBool()

bool PCB_IO_KICAD_SEXPR_PARSER::parseBool ( )

private

Definition at line 218 of file pcb_io_kicad_sexpr_parser.cpp.

Referenced by parseGROUP(), parsePCB_REFERENCE_IMAGE(), parsePCB_TABLE(), parsePCB_TEXT_effects(), parseSetup(), parseTextBoxContent(), and parseZONE().

◆ parseDefaults()

void PCB_IO_KICAD_SEXPR_PARSER::parseDefaults ( BOARD_DESIGN_SETTINGS & aSettings )

private

Definition at line 2397 of file pcb_io_kicad_sexpr_parser.cpp.

References LAYER_CLASS_COPPER, LAYER_CLASS_COURTYARD, LAYER_CLASS_EDGES, LAYER_CLASS_FAB, LAYER_CLASS_OTHERS, LAYER_CLASS_SILK, m_board, BOARD_DESIGN_SETTINGS::m_CopperEdgeClearance, BOARD_DESIGN_SETTINGS::m_DimensionPrecision, BOARD_DESIGN_SETTINGS::m_DimensionUnitsMode, BOARD::m_LegacyCopperEdgeClearanceLoaded, BOARD_DESIGN_SETTINGS::m_LineThickness, parseBoardUnits(), parseDefaultTextDims(), and parseInt().

Referenced by parseSetup().

◆ parseDefaultTextDims()

void PCB_IO_KICAD_SEXPR_PARSER::parseDefaultTextDims	(	BOARD_DESIGN_SETTINGS &	aSettings,
		int	aLayer
	)

private

Definition at line 2481 of file pcb_io_kicad_sexpr_parser.cpp.

References BOARD_DESIGN_SETTINGS::m_TextItalic, BOARD_DESIGN_SETTINGS::m_TextSize, BOARD_DESIGN_SETTINGS::m_TextThickness, BOARD_DESIGN_SETTINGS::m_TextUpright, parseBoardUnits(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by parseDefaults().

◆ parseDIMENSION()

PCB_DIMENSION_BASE * PCB_IO_KICAD_SEXPR_PARSER::parseDIMENSION ( BOARD_ITEM * aParent )

private

◆ parseEDA_TEXT()

void PCB_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT ( EDA_TEXT * aText )

private

Parse the common settings for any object derived from EDA_TEXT.

Parameters

aText A pointer to the EDA_TEXT object to save the parsed settings into.

Exceptions

PARSE_ERROR if the text syntax is not valid.

Definition at line 495 of file pcb_io_kicad_sexpr_parser.cpp.

References ConvertToNewOverbarNotation(), KIFONT::FONT::GetFont(), EDA_TEXT::GetText(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_H_ALIGN_LEFT, GR_TEXT_H_ALIGN_RIGHT, GR_TEXT_V_ALIGN_BOTTOM, GR_TEXT_V_ALIGN_CENTER, GR_TEXT_V_ALIGN_TOP, EDA_TEXT::IsBold(), EDA_TEXT::IsItalic(), EDA_IU_SCALE::IU_PER_MM, m_requiredVersion, parseBoardUnits(), parseDouble(), parseMaybeAbsentBool(), pcbIUScale, EDA_TEXT::SetBoldFlag(), EDA_TEXT::SetFont(), EDA_TEXT::SetHorizJustify(), EDA_TEXT::SetItalic(), EDA_TEXT::SetLineSpacing(), EDA_TEXT::SetMirrored(), EDA_TEXT::SetText(), EDA_TEXT::SetTextSize(), EDA_TEXT::SetTextThickness(), EDA_TEXT::SetVertJustify(), EDA_TEXT::SetVisible(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by parsePCB_TEXT_effects(), and parseTextBoxContent().

◆ parseFOOTPRINT()

FOOTPRINT * PCB_IO_KICAD_SEXPR_PARSER::parseFOOTPRINT ( wxArrayString * aInitialComments = nullptr )

Parameters

aInitialComments may be a pointer to a heap allocated initial comment block or NULL. If not NULL, then caller has given ownership of a wxArrayString to this function and care must be taken to delete it even on exception.

Definition at line 4145 of file pcb_io_kicad_sexpr_parser.cpp.

References GetRequiredVersion(), m_tooRecent, and parseFOOTPRINT_unchecked().

Referenced by Parse(), and parseBOARD_unchecked().

◆ parseFOOTPRINT_unchecked()

FOOTPRINT * PCB_IO_KICAD_SEXPR_PARSER::parseFOOTPRINT_unchecked ( wxArrayString * aInitialComments = nullptr )

private

Definition at line 4161 of file pcb_io_kicad_sexpr_parser.cpp.

References _, B_Cu, B_Fab, CurStrToKIID(), DEGREES_T, DESCRIPTION_FIELD, Edge_Cuts, F_Cu, F_Fab, FP_ALLOW_MISSING_COURTYARD, FP_ALLOW_SOLDERMASK_BRIDGES, FP_BOARD_ONLY, FP_DNP, FP_EXCLUDE_FROM_BOM, FP_EXCLUDE_FROM_POS_FILES, FP_SMD, FP_THROUGH_HOLE, BOARD::GetDesignSettings(), image, LEGACY_NET_TIES, m_board, m_generatorVersion, m_layerIndices, m_requiredVersion, m_tooRecent, Margin, name, pad, LIB_ID::Parse(), parse3DModel(), parseBoardItemLayer(), parseBoardUnits(), parseDIMENSION(), parseDouble(), parseGROUP(), parseHex(), parseInt(), parseMaybeAbsentBool(), parsePAD(), parsePCB_REFERENCE_IMAGE(), parsePCB_SHAPE(), parsePCB_TABLE(), parsePCB_TEXT(), parsePCB_TEXT_effects(), parsePCB_TEXTBOX(), parseZONE(), REFERENCE_FIELD, BOARD_ITEM::SetLayer(), EDA_TEXT::SetText(), EDA_TEXT::SetVisible(), SEXPR_BOARD_FILE_VERSION, PCB_TEXT::StyleFromSettings(), text, THROW_IO_ERROR, VALUE_FIELD, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by parseFOOTPRINT().

◆ parseGeneralSection()

void PCB_IO_KICAD_SEXPR_PARSER::parseGeneralSection ( )

private

Definition at line 1323 of file pcb_io_kicad_sexpr_parser.cpp.

References BOARD::GetDesignSettings(), m_board, parseBoardUnits(), parseMaybeAbsentBool(), BOARD_DESIGN_SETTINGS::SetBoardThickness(), and BOARD::SetLegacyTeardrops().

Referenced by parseBOARD_unchecked().

◆ parseGENERATOR()

void PCB_IO_KICAD_SEXPR_PARSER::parseGENERATOR ( BOARD_ITEM * aParent )

private

◆ parseGROUP()

void PCB_IO_KICAD_SEXPR_PARSER::parseGROUP ( BOARD_ITEM * aParent )

private

Definition at line 5330 of file pcb_io_kicad_sexpr_parser.cpp.

References CurStrToKIID(), PCB_IO_KICAD_SEXPR_PARSER::GROUP_INFO::locked, m_groupInfos, PCB_IO_KICAD_SEXPR_PARSER::GROUP_INFO::name, PCB_IO_KICAD_SEXPR_PARSER::GROUP_INFO::parent, parseBool(), parseGROUP_members(), and PCB_IO_KICAD_SEXPR_PARSER::GROUP_INFO::uuid.

Referenced by parseBOARD_unchecked(), and parseFOOTPRINT_unchecked().

◆ parseGROUP_members()

void PCB_IO_KICAD_SEXPR_PARSER::parseGROUP_members ( GROUP_INFO & aGroupInfo )

private

Definition at line 5315 of file pcb_io_kicad_sexpr_parser.cpp.

References PCB_IO_KICAD_SEXPR_PARSER::GROUP_INFO::memberUuids.

Referenced by parseGENERATOR(), and parseGROUP().

◆ parseHeader()

void PCB_IO_KICAD_SEXPR_PARSER::parseHeader ( )

private

Definition at line 1297 of file pcb_io_kicad_sexpr_parser.cpp.

References m_board, m_requiredVersion, m_tooRecent, parseInt(), BOARD::SetFileFormatVersionAtLoad(), and SEXPR_BOARD_FILE_VERSION.

Referenced by parseBOARD_unchecked().

◆ parseHex()

long PCB_IO_KICAD_SEXPR_PARSER::parseHex ( )

inlineprivate

Definition at line 345 of file pcb_io_kicad_sexpr_parser.h.

Referenced by parseARC(), parseFOOTPRINT_unchecked(), parsePCB_SHAPE(), parsePCB_TRACK(), parsePCB_VIA(), and parseSetup().

◆ parseInt() [1/2]

int PCB_IO_KICAD_SEXPR_PARSER::parseInt ( )

inlineprivate

Definition at line 334 of file pcb_io_kicad_sexpr_parser.h.

Referenced by parseARC(), parseDefaults(), parseDIMENSION(), parseFOOTPRINT_unchecked(), parseHeader(), parseInt(), parseLayer(), parseNETINFO_ITEM(), parsePAD(), parsePCB_SHAPE(), parsePCB_TABLE(), parsePCB_TRACK(), parsePCB_VIA(), parseTEARDROP_PARAMETERS(), parseTextBoxContent(), parseTITLE_BLOCK(), and parseZONE().

◆ parseInt() [2/2]

int PCB_IO_KICAD_SEXPR_PARSER::parseInt ( const char * aExpected )

inlineprivate

Definition at line 339 of file pcb_io_kicad_sexpr_parser.h.

References parseInt().

◆ parseLayer()

void PCB_IO_KICAD_SEXPR_PARSER::parseLayer ( LAYER * aLayer )

private

Definition at line 1524 of file pcb_io_kicad_sexpr_parser.cpp.

References LAYER::clear(), From_UTF8(), LAYER::m_name, LAYER::m_number, LAYER::m_type, LAYER::m_userName, LAYER::m_visible, name, LSET::Name(), parseInt(), and LAYER::ParseType().

Referenced by parseLayers().

◆ parseLayers()

void PCB_IO_KICAD_SEXPR_PARSER::parseLayers ( )

private

Definition at line 1852 of file pcb_io_kicad_sexpr_parser.cpp.

References _, B_Cu, createOldLayerMapping(), LT_UNDEFINED, m_board, m_layerIndices, m_layerMasks, BOARD::m_LegacyVisibleLayers, LAYER::m_name, LAYER::m_number, LAYER::m_type, LAYER::m_visible, name, parseLayer(), BOARD::SetCopperLayerCount(), BOARD::SetEnabledLayers(), BOARD::SetLayerDescr(), THROW_IO_ERROR, and THROW_PARSE_ERROR.

Referenced by parseBOARD_unchecked().

◆ parseMargins()

void PCB_IO_KICAD_SEXPR_PARSER::parseMargins	(	int &	aLeft,
		int &	aTop,
		int &	aRight,
		int &	aBottom
	)

private

Definition at line 408 of file pcb_io_kicad_sexpr_parser.cpp.

References parseBoardUnits().

Referenced by parseTextBoxContent().

◆ parseMaybeAbsentBool()

bool PCB_IO_KICAD_SEXPR_PARSER::parseMaybeAbsentBool ( bool aDefaultValue )

private

Parses a boolean flag inside a list that existed before boolean normalization.

For example, this will handle both (legacy_teardrops) and (legacy_teardrops yes). Call this after parsing the T_legacy_teardrops, and aDefaultValue will be returned for the first case, or true will be returned for the second case.

Parameters

aDefaultValue will be returned if the end of the list is encountered as the next token

Returns: the parsed boolean

Definition at line 236 of file pcb_io_kicad_sexpr_parser.cpp.

References DSN_RIGHT.

Referenced by parse3DModel(), parseARC(), parseDIMENSION(), parseEDA_TEXT(), parseFOOTPRINT_unchecked(), parseGeneralSection(), parsePAD(), parsePCB_SHAPE(), parsePCB_TEXT_effects(), parsePCB_TRACK(), parsePCB_VIA(), parseTEARDROP_PARAMETERS(), and parseTextBoxContent().

◆ parseNETCLASS()

void PCB_IO_KICAD_SEXPR_PARSER::parseNETCLASS ( )

private

Definition at line 2549 of file pcb_io_kicad_sexpr_parser.cpp.

References _, ConvertToNewOverbarNotation(), CTX_NETCLASS, BOARD::GetDesignSettings(), m_board, BOARD_DESIGN_SETTINGS::m_NetSettings, m_requiredVersion, parseBoardUnits(), and THROW_IO_ERROR.

Referenced by parseBOARD_unchecked().

◆ parseNETINFO_ITEM()

void PCB_IO_KICAD_SEXPR_PARSER::parseNETINFO_ITEM ( )

private

Definition at line 2518 of file pcb_io_kicad_sexpr_parser.cpp.

References BOARD::Add(), ConvertToNewOverbarNotation(), BOARD::FindNet(), NETINFO_ITEM::GetNetCode(), m_board, m_requiredVersion, name, parseInt(), pushValueIntoMap(), and NETINFO_LIST::UNCONNECTED.

Referenced by parseBOARD_unchecked().

◆ parseOutlinePoints()

void PCB_IO_KICAD_SEXPR_PARSER::parseOutlinePoints ( SHAPE_LINE_CHAIN & aPoly )

private

Parses possible outline points and stores them into aPoly.

This accepts points for DRAWSEGMENT polygons, EDGEMODULE polygons and ZONE_CONTAINER polygons. Points and arcs are added to the most recent outline

Parameters

aPoly polygon container to add points and arcs

Definition at line 311 of file pcb_io_kicad_sexpr_parser.cpp.

References SHAPE_LINE_CHAIN::Append(), parseBoardUnits(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by parseGENERATOR(), parsePCB_SHAPE(), parseRenderCache(), parseTextBoxContent(), and parseZONE().

◆ parsePAD()

PAD * PCB_IO_KICAD_SEXPR_PARSER::parsePAD ( FOOTPRINT * aParent = nullptr )

private

◆ parsePAD_option()

bool PCB_IO_KICAD_SEXPR_PARSER::parsePAD_option ( PAD * aPad )

private

Definition at line 5243 of file pcb_io_kicad_sexpr_parser.cpp.

References CUST_PAD_SHAPE_IN_ZONE_CONVEXHULL, CUST_PAD_SHAPE_IN_ZONE_OUTLINE, PAD::SetAnchorPadShape(), and PAD::SetCustomShapeInZoneOpt().

Referenced by parsePAD().

◆ parsePAGE_INFO()

void PCB_IO_KICAD_SEXPR_PARSER::parsePAGE_INFO ( )

private

Definition at line 1360 of file pcb_io_kicad_sexpr_parser.cpp.

References _, PAGE_INFO::Custom, m_board, m_requiredVersion, MAX_PAGE_SIZE_PCBNEW_MM, MIN_PAGE_SIZE_MM, parseDouble(), PAGE_INFO::SetHeightMM(), BOARD::SetPageSettings(), PAGE_INFO::SetPortrait(), PAGE_INFO::SetType(), PAGE_INFO::SetWidthMM(), and THROW_PARSE_ERROR.

Referenced by parseBOARD_unchecked().

◆ parsePCB_REFERENCE_IMAGE()

PCB_REFERENCE_IMAGE * PCB_IO_KICAD_SEXPR_PARSER::parsePCB_REFERENCE_IMAGE ( BOARD_ITEM * aParent )

private

Definition at line 3066 of file pcb_io_kicad_sexpr_parser.cpp.

References _, CurStrToKIID(), locked, parseBoardItemLayer(), parseBoardUnits(), parseBool(), parseDouble(), THROW_IO_ERROR, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by parseBOARD_unchecked(), and parseFOOTPRINT_unchecked().

◆ parsePCB_SHAPE()

PCB_SHAPE * PCB_IO_KICAD_SEXPR_PARSER::parsePCB_SHAPE ( BOARD_ITEM * aParent )

private

◆ parsePCB_TABLE()

PCB_TABLE * PCB_IO_KICAD_SEXPR_PARSER::parsePCB_TABLE ( BOARD_ITEM * aParent )

private

Definition at line 3552 of file pcb_io_kicad_sexpr_parser.cpp.

References EDA_IU_SCALE::IU_PER_MM, parseBoardItemLayer(), parseBoardUnits(), parseBool(), parseInt(), parsePCB_TABLECELL(), STROKE_PARAMS_PARSER::ParseStroke(), and pcbIUScale.

Referenced by parseBOARD_unchecked(), and parseFOOTPRINT_unchecked().

◆ parsePCB_TABLECELL()

PCB_TABLECELL * PCB_IO_KICAD_SEXPR_PARSER::parsePCB_TABLECELL ( BOARD_ITEM * aParent )

private

Definition at line 3374 of file pcb_io_kicad_sexpr_parser.cpp.

References parseTextBoxContent().

Referenced by parsePCB_TABLE().

◆ parsePCB_TARGET()

PCB_TARGET * PCB_IO_KICAD_SEXPR_PARSER::parsePCB_TARGET ( )

private

Definition at line 6522 of file pcb_io_kicad_sexpr_parser.cpp.

References CurStrToKIID(), parseBoardItemLayer(), parseBoardUnits(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by parseBOARD_unchecked().

◆ parsePCB_TEXT()

PCB_TEXT * PCB_IO_KICAD_SEXPR_PARSER::parsePCB_TEXT ( BOARD_ITEM * aParent )

private

Definition at line 3161 of file pcb_io_kicad_sexpr_parser.cpp.

References _, DSN_NUMBER, parsePCB_TEXT_effects(), REFERENCE_FIELD, text, THROW_IO_ERROR, and VALUE_FIELD.

Referenced by parseBOARD_unchecked(), parseDIMENSION(), and parseFOOTPRINT_unchecked().

◆ parsePCB_TEXT_effects()

void PCB_IO_KICAD_SEXPR_PARSER::parsePCB_TEXT_effects ( PCB_TEXT * aText )

private

◆ parsePCB_TEXTBOX()

PCB_TEXTBOX * PCB_IO_KICAD_SEXPR_PARSER::parsePCB_TEXTBOX ( BOARD_ITEM * aParent )

private

Definition at line 3361 of file pcb_io_kicad_sexpr_parser.cpp.

References parseTextBoxContent().

Referenced by parseBOARD_unchecked(), and parseFOOTPRINT_unchecked().

◆ parsePCB_TRACK()

PCB_TRACK * PCB_IO_KICAD_SEXPR_PARSER::parsePCB_TRACK ( )

private

Definition at line 5618 of file pcb_io_kicad_sexpr_parser.cpp.

References _, CurStrToKIID(), getNetCode(), m_board, parseBoardItemLayer(), parseBoardUnits(), parseHex(), parseInt(), parseMaybeAbsentBool(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by parseBOARD_unchecked().

◆ parsePCB_VIA()

PCB_VIA * PCB_IO_KICAD_SEXPR_PARSER::parsePCB_VIA ( )

private

Definition at line 5703 of file pcb_io_kicad_sexpr_parser.cpp.

References _, LSET::AllCuMask(), B_Cu, CurStrToKIID(), getNetCode(), m_board, m_layerIndices, parseBoardUnits(), parseHex(), parseInt(), parseMaybeAbsentBool(), parseTEARDROP_PARAMETERS(), LSET::Seq(), via, VECTOR2< T >::x, VECTOR2< T >::y, ZLO_FORCE_FLASHED, and ZLO_FORCE_NO_ZONE_CONNECTION.

Referenced by parseBOARD_unchecked().

◆ parseRenderCache()

void PCB_IO_KICAD_SEXPR_PARSER::parseRenderCache ( EDA_TEXT * text )

private

Parse the render cache for any object derived from EDA_TEXT.

Parameters

aText A pointer to the EDA_TEXT object to save the parsed settings into.

Exceptions

PARSE_ERROR if the text syntax is not valid.

Definition at line 642 of file pcb_io_kicad_sexpr_parser.cpp.

References SHAPE_POLY_SET::AddHole(), SHAPE_POLY_SET::AddOutline(), DEGREES_T, From_UTF8(), SHAPE_POLY_SET::OutlineCount(), parseDouble(), parseOutlinePoints(), SHAPE_LINE_CHAIN::SetClosed(), and text.

Referenced by parsePCB_TEXT_effects(), and parseTextBoxContent().

◆ parseSetup()

void PCB_IO_KICAD_SEXPR_PARSER::parseSetup ( )

private

Definition at line 2033 of file pcb_io_kicad_sexpr_parser.cpp.

Referenced by parseBOARD_unchecked().

◆ parseTEARDROP_PARAMETERS()

void PCB_IO_KICAD_SEXPR_PARSER::parseTEARDROP_PARAMETERS ( TEARDROP_PARAMETERS * tdParams )

private

Definition at line 432 of file pcb_io_kicad_sexpr_parser.cpp.

References TEARDROP_PARAMETERS::m_AllowUseTwoTracks, TEARDROP_PARAMETERS::m_BestLengthRatio, TEARDROP_PARAMETERS::m_BestWidthRatio, TEARDROP_PARAMETERS::m_CurveSegCount, TEARDROP_PARAMETERS::m_Enabled, TEARDROP_PARAMETERS::m_TdMaxLen, TEARDROP_PARAMETERS::m_TdMaxWidth, TEARDROP_PARAMETERS::m_TdOnPadsInZones, TEARDROP_PARAMETERS::m_WidthtoSizeFilterRatio, parseBoardUnits(), parseDouble(), parseInt(), and parseMaybeAbsentBool().

Referenced by parsePAD(), and parsePCB_VIA().

◆ parseTextBoxContent()

void PCB_IO_KICAD_SEXPR_PARSER::parseTextBoxContent ( PCB_TEXTBOX * aTextBox )

private

Definition at line 3387 of file pcb_io_kicad_sexpr_parser.cpp.

References CurStrToKIID(), DEGREES_T, DSN_NUMBER, PCB_TEXTBOX::GetLegacyTextMargin(), BOARD_ITEM::GetParent(), EDA_SHAPE::GetPolyShape(), STROKE_PARAMS::GetWidth(), EDA_IU_SCALE::IU_PER_MM, left, m_requiredVersion, EDA_ITEM::m_Uuid, PCB_TEXTBOX::Move(), SHAPE_POLY_SET::NewOutline(), SHAPE_POLY_SET::Outline(), parseBoardItemLayer(), parseBoardUnits(), parseBool(), parseDouble(), parseEDA_TEXT(), parseInt(), parseMargins(), parseMaybeAbsentBool(), parseOutlinePoints(), parseRenderCache(), STROKE_PARAMS_PARSER::ParseStroke(), pcbIUScale, SHAPE_POLY_SET::RemoveAllContours(), right, PCB_TEXTBOX::Rotate(), PCB_TEXTBOX::SetBorderEnabled(), EDA_SHAPE::SetEnd(), PCB_SHAPE::SetLayer(), BOARD_ITEM::SetLocked(), PCB_TEXTBOX::SetMarginBottom(), PCB_TEXTBOX::SetMarginLeft(), PCB_TEXTBOX::SetMarginRight(), PCB_TEXTBOX::SetMarginTop(), EDA_SHAPE::SetShape(), EDA_SHAPE::SetStart(), PCB_SHAPE::SetStroke(), and EDA_TEXT::SetText().

Referenced by parsePCB_TABLECELL(), and parsePCB_TEXTBOX().

◆ parseTITLE_BLOCK()

void PCB_IO_KICAD_SEXPR_PARSER::parseTITLE_BLOCK ( )

private

Definition at line 1416 of file pcb_io_kicad_sexpr_parser.cpp.

References m_board, parseInt(), TITLE_BLOCK::SetComment(), TITLE_BLOCK::SetCompany(), TITLE_BLOCK::SetDate(), TITLE_BLOCK::SetRevision(), TITLE_BLOCK::SetTitle(), BOARD::SetTitleBlock(), and THROW_PARSE_ERROR.

Referenced by parseBOARD_unchecked().

◆ parseXY() [1/2]

VECTOR2I PCB_IO_KICAD_SEXPR_PARSER::parseXY ( )

private

Parse a coordinate pair (xy X Y) in board units (mm).

The parser checks if the previous token was T_LEFT and parses the remainder of the token syntax. This is used when parsing a list of coordinate points. This way the parser can be used in either case.