KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
ALTIUM_BINARY_PARSER Class Reference

#include <altium_binary_parser.h>

Public Member Functions

 ALTIUM_BINARY_PARSER (const ALTIUM_COMPOUND_FILE &aFile, const CFB::COMPOUND_FILE_ENTRY *aEntry)
 
 ALTIUM_BINARY_PARSER (std::unique_ptr< char[]> &aContent, size_t aSize)
 
 ~ALTIUM_BINARY_PARSER ()=default
 
template<typename Type >
Type Read ()
 
template<typename Type >
Type Peek ()
 
wxScopedCharBuffer ReadCharBuffer ()
 
wxString ReadWxString ()
 
std::map< uint32_t, wxString > ReadWideStringTable ()
 
std::vector< char > ReadVector (size_t aSize)
 
int ReadBytes (char *aOut, size_t aSize)
 
int32_t ReadKicadUnit ()
 
int32_t ReadKicadUnitX ()
 
int32_t ReadKicadUnitY ()
 
VECTOR2I ReadVector2IPos ()
 
VECTOR2I ReadVector2ISize ()
 
size_t ReadAndSetSubrecordLength ()
 
std::map< wxString, wxString > ReadProperties (std::function< std::map< wxString, wxString >(const std::string &)> handleBinaryData=[](const std::string &) { return std::map< wxString, wxString >();})
 
void Skip (size_t aLength)
 
void SkipSubrecord ()
 
size_t GetRemainingBytes () const
 
size_t GetRemainingSubrecordBytes () const
 
bool HasParsingError ()
 

Private Attributes

std::unique_ptr< char[]> m_content
 
size_t m_size
 
char * m_pos
 
char * m_subrecord_end
 
bool m_error
 

Detailed Description

Definition at line 111 of file altium_binary_parser.h.

Constructor & Destructor Documentation

◆ ALTIUM_BINARY_PARSER() [1/2]

ALTIUM_BINARY_PARSER::ALTIUM_BINARY_PARSER ( const ALTIUM_COMPOUND_FILE &  aFile,
const CFB::COMPOUND_FILE_ENTRY *  aEntry 
)

Definition at line 373 of file altium_binary_parser.cpp.

References ALTIUM_COMPOUND_FILE::GetCompoundFileReader(), m_content, m_error, m_pos, m_size, and m_subrecord_end.

◆ ALTIUM_BINARY_PARSER() [2/2]

ALTIUM_BINARY_PARSER::ALTIUM_BINARY_PARSER ( std::unique_ptr< char[]> &  aContent,
size_t  aSize 
)

Definition at line 387 of file altium_binary_parser.cpp.

References m_content, m_error, m_pos, m_size, and m_subrecord_end.

◆ ~ALTIUM_BINARY_PARSER()

ALTIUM_BINARY_PARSER::~ALTIUM_BINARY_PARSER ( )
default

Member Function Documentation

◆ GetRemainingBytes()

size_t ALTIUM_BINARY_PARSER::GetRemainingBytes ( ) const
inline

Definition at line 300 of file altium_binary_parser.h.

References m_content, m_pos, and m_size.

Referenced by BOOST_AUTO_TEST_CASE(), PCB_IO_ALTIUM_DESIGNER::FootprintEnumerate(), ALTIUM_PCB::Parse(), SCH_IO_ALTIUM::ParseAdditional(), ALTIUM_PCB::ParseArcs6Data(), ALTIUM_PCB::ParseBoard6Data(), ALTIUM_PCB::ParseBoardRegionsData(), ALTIUM_PCB::ParseClasses6Data(), ALTIUM_PCB::ParseComponents6Data(), ALTIUM_PCB::ParseComponentsBodies6Data(), ALTIUM_PCB::ParseDimensions6Data(), ALTIUM_PCB::ParseExtendedPrimitiveInformationData(), SCH_IO_ALTIUM::ParseFileHeader(), ALTIUM_PCB::ParseFills6Data(), ALTIUM_PCB::ParseFootprint(), SCH_IO_ALTIUM::ParseLibFile(), SCH_IO_ALTIUM::ParseLibHeader(), ALTIUM_PCB::ParseModelsData(), ALTIUM_PCB::ParseNets6Data(), ALTIUM_PCB::ParsePads6Data(), ALTIUM_PCB::ParsePolygons6Data(), ALTIUM_PCB::ParseRegions6Data(), ALTIUM_PCB::ParseRules6Data(), ALTIUM_PCB::ParseShapeBasedRegions6Data(), SCH_IO_ALTIUM::ParseStorage(), ALTIUM_PCB::ParseTexts6Data(), ALTIUM_PCB::ParseTracks6Data(), ALTIUM_PCB::ParseVias6Data(), ALTIUM_PCB::ParseWideStrings6Data(), Read(), ReadBytes(), ReadCharBuffer(), ReadProperties(), ReadVector(), ReadWideStringTable(), and Skip().

◆ GetRemainingSubrecordBytes()

size_t ALTIUM_BINARY_PARSER::GetRemainingSubrecordBytes ( ) const
inline

Definition at line 305 of file altium_binary_parser.h.

References m_pos, and m_subrecord_end.

Referenced by AARC6::AARC6(), AFILL6::AFILL6(), APAD6::APAD6(), and ATRACK6::ATRACK6().

◆ HasParsingError()

bool ALTIUM_BINARY_PARSER::HasParsingError ( )
inline

Definition at line 312 of file altium_binary_parser.h.

References m_error.

Referenced by AARC6::AARC6(), ABOARD6::ABOARD6(), ACLASS6::ACLASS6(), ACOMPONENT6::ACOMPONENT6(), ACOMPONENTBODY6::ACOMPONENTBODY6(), ADIMENSION6::ADIMENSION6(), AFILL6::AFILL6(), AMODEL::AMODEL(), ANET6::ANET6(), APAD6::APAD6(), APOLYGON6::APOLYGON6(), AREGION6::AREGION6(), ARULE6::ARULE6(), ASCH_ADDITIONAL_FILE::ASCH_ADDITIONAL_FILE(), ASCH_STORAGE_FILE::ASCH_STORAGE_FILE(), ATEXT6::ATEXT6(), ATRACK6::ATRACK6(), AVIA6::AVIA6(), BOOST_AUTO_TEST_CASE(), PCB_IO_ALTIUM_DESIGNER::FootprintEnumerate(), ALTIUM_PCB::Parse(), SCH_IO_ALTIUM::ParseAdditional(), SCH_IO_ALTIUM::ParseFileHeader(), ALTIUM_PCB::ParseFootprint(), SCH_IO_ALTIUM::ParseLibFile(), and SCH_IO_ALTIUM::ParseStorage().

◆ Peek()

template<typename Type >
Type ALTIUM_BINARY_PARSER::Peek ( )
inline

Definition at line 137 of file altium_binary_parser.h.

References m_error, and m_pos.

Referenced by ALTIUM_PCB::ParseFootprint().

◆ Read()

template<typename Type >
Type ALTIUM_BINARY_PARSER::Read ( )
inline

Definition at line 119 of file altium_binary_parser.h.

References GetRemainingBytes(), m_error, and m_pos.

Referenced by AARC6::AARC6(), ACOMPONENTBODY6::ACOMPONENTBODY6(), AFILL6::AFILL6(), APAD6::APAD6(), AREGION6::AREGION6(), ASCH_ADDITIONAL_FILE::ASCH_ADDITIONAL_FILE(), ASCH_STORAGE_FILE::ASCH_STORAGE_FILE(), ATEXT6::ATEXT6(), ATRACK6::ATRACK6(), AVIA6::AVIA6(), PCB_IO_ALTIUM_DESIGNER::FootprintEnumerate(), and ALTIUM_PCB::Parse().

◆ ReadAndSetSubrecordLength()

size_t ALTIUM_BINARY_PARSER::ReadAndSetSubrecordLength ( )
inline

Definition at line 262 of file altium_binary_parser.h.

References m_pos, and m_subrecord_end.

Referenced by AARC6::AARC6(), ACOMPONENTBODY6::ACOMPONENTBODY6(), AFILL6::AFILL6(), APAD6::APAD6(), AREGION6::AREGION6(), ATEXT6::ATEXT6(), ATRACK6::ATRACK6(), AVIA6::AVIA6(), PCB_IO_ALTIUM_DESIGNER::FootprintEnumerate(), ALTIUM_PCB::ParseFileHeader(), and ALTIUM_PCB::ParseFootprint().

◆ ReadBytes()

int ALTIUM_BINARY_PARSER::ReadBytes ( char *  aOut,
size_t  aSize 
)
inline

Definition at line 218 of file altium_binary_parser.h.

References GetRemainingBytes(), m_error, and m_pos.

Referenced by ATEXT6::ATEXT6().

◆ ReadCharBuffer()

wxScopedCharBuffer ALTIUM_BINARY_PARSER::ReadCharBuffer ( )
inline

Definition at line 147 of file altium_binary_parser.h.

References GetRemainingBytes(), m_error, and m_pos.

Referenced by PCB_IO_ALTIUM_DESIGNER::FootprintEnumerate(), and ReadWxString().

◆ ReadKicadUnit()

int32_t ALTIUM_BINARY_PARSER::ReadKicadUnit ( )
inline

Definition at line 233 of file altium_binary_parser.h.

References ALTIUM_PROPS_UTILS::ConvertToKicadUnit().

Referenced by AARC6::AARC6(), APAD6::APAD6(), AREGION6::AREGION6(), ATEXT6::ATEXT6(), ATRACK6::ATRACK6(), AVIA6::AVIA6(), ReadKicadUnitX(), ReadKicadUnitY(), and ReadVector2ISize().

◆ ReadKicadUnitX()

int32_t ALTIUM_BINARY_PARSER::ReadKicadUnitX ( )
inline

Definition at line 238 of file altium_binary_parser.h.

References ReadKicadUnit().

Referenced by APAD6::APAD6(), and ReadVector2IPos().

◆ ReadKicadUnitY()

int32_t ALTIUM_BINARY_PARSER::ReadKicadUnitY ( )
inline

Definition at line 243 of file altium_binary_parser.h.

References ReadKicadUnit().

Referenced by APAD6::APAD6(), and ReadVector2IPos().

◆ ReadProperties()

std::map< wxString, wxString > ALTIUM_BINARY_PARSER::ReadProperties ( std::function< std::map< wxString, wxString >(const std::string &)>  handleBinaryData = []( const std::string& ) { return std::map<wxString, wxString>(); })

Definition at line 397 of file altium_binary_parser.cpp.

References _, AltiumPropertyToKiCadString(), GetRemainingBytes(), kv, m_error, and m_pos.

Referenced by ABOARD6::ABOARD6(), ACLASS6::ACLASS6(), ACOMPONENT6::ACOMPONENT6(), ACOMPONENTBODY6::ACOMPONENTBODY6(), ADIMENSION6::ADIMENSION6(), AEXTENDED_PRIMITIVE_INFORMATION::AEXTENDED_PRIMITIVE_INFORMATION(), AMODEL::AMODEL(), ANET6::ANET6(), APOLYGON6::APOLYGON6(), AREGION6::AREGION6(), ARULE6::ARULE6(), BOOST_AUTO_TEST_CASE(), PCB_IO_ALTIUM_DESIGNER::FootprintEnumerate(), SCH_IO_ALTIUM::ParseAdditional(), SCH_IO_ALTIUM::ParseFileHeader(), ALTIUM_PCB::ParseFootprint(), SCH_IO_ALTIUM::ParseLibFile(), SCH_IO_ALTIUM::ParseLibHeader(), and SCH_IO_ALTIUM::ParseStorage().

◆ ReadVector()

std::vector< char > ALTIUM_BINARY_PARSER::ReadVector ( size_t  aSize)
inline

Definition at line 203 of file altium_binary_parser.h.

References GetRemainingBytes(), m_error, and m_pos.

Referenced by ASCH_ADDITIONAL_FILE::ASCH_ADDITIONAL_FILE(), and ASCH_STORAGE_FILE::ASCH_STORAGE_FILE().

◆ ReadVector2IPos()

VECTOR2I ALTIUM_BINARY_PARSER::ReadVector2IPos ( )
inline

Definition at line 248 of file altium_binary_parser.h.

References ReadKicadUnitX(), and ReadKicadUnitY().

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

◆ ReadVector2ISize()

VECTOR2I ALTIUM_BINARY_PARSER::ReadVector2ISize ( )
inline

Definition at line 255 of file altium_binary_parser.h.

References ReadKicadUnit().

Referenced by APAD6::APAD6().

◆ ReadWideStringTable()

std::map< uint32_t, wxString > ALTIUM_BINARY_PARSER::ReadWideStringTable ( )
inline

Definition at line 173 of file altium_binary_parser.h.

References GetRemainingBytes(), and m_pos.

Referenced by ALTIUM_PCB::ParseWideStrings6Data().

◆ ReadWxString()

wxString ALTIUM_BINARY_PARSER::ReadWxString ( )
inline

Definition at line 166 of file altium_binary_parser.h.

References ReadCharBuffer().

Referenced by APAD6::APAD6(), ASCH_ADDITIONAL_FILE::ASCH_ADDITIONAL_FILE(), ASCH_STORAGE_FILE::ASCH_STORAGE_FILE(), ATEXT6::ATEXT6(), and ALTIUM_PCB::ParseFileHeader().

◆ Skip()

void ALTIUM_BINARY_PARSER::Skip ( size_t  aLength)
inline

Definition at line 276 of file altium_binary_parser.h.

References GetRemainingBytes(), m_error, and m_pos.

Referenced by AARC6::AARC6(), ACOMPONENTBODY6::ACOMPONENTBODY6(), ADIMENSION6::ADIMENSION6(), AFILL6::AFILL6(), APAD6::APAD6(), AREGION6::AREGION6(), ARULE6::ARULE6(), ASCH_ADDITIONAL_FILE::ASCH_ADDITIONAL_FILE(), ASCH_STORAGE_FILE::ASCH_STORAGE_FILE(), ATEXT6::ATEXT6(), ATRACK6::ATRACK6(), and AVIA6::AVIA6().

◆ SkipSubrecord()

void ALTIUM_BINARY_PARSER::SkipSubrecord ( )
inline

Definition at line 288 of file altium_binary_parser.h.

References m_error, m_pos, and m_subrecord_end.

Referenced by AARC6::AARC6(), ACOMPONENTBODY6::ACOMPONENTBODY6(), AFILL6::AFILL6(), APAD6::APAD6(), AREGION6::AREGION6(), ATEXT6::ATEXT6(), ATRACK6::ATRACK6(), AVIA6::AVIA6(), PCB_IO_ALTIUM_DESIGNER::FootprintEnumerate(), and ALTIUM_PCB::ParseFootprint().

Member Data Documentation

◆ m_content

std::unique_ptr<char[]> ALTIUM_BINARY_PARSER::m_content
private

Definition at line 318 of file altium_binary_parser.h.

Referenced by ALTIUM_BINARY_PARSER(), and GetRemainingBytes().

◆ m_error

bool ALTIUM_BINARY_PARSER::m_error
private

Definition at line 323 of file altium_binary_parser.h.

Referenced by ALTIUM_BINARY_PARSER(), HasParsingError(), Peek(), Read(), ReadBytes(), ReadCharBuffer(), ReadProperties(), ReadVector(), Skip(), and SkipSubrecord().

◆ m_pos

char* ALTIUM_BINARY_PARSER::m_pos
private

Definition at line 321 of file altium_binary_parser.h.

Referenced by ALTIUM_BINARY_PARSER(), GetRemainingBytes(), GetRemainingSubrecordBytes(), Peek(), Read(), ReadAndSetSubrecordLength(), ReadBytes(), ReadCharBuffer(), ReadProperties(), ReadVector(), ReadWideStringTable(), Skip(), and SkipSubrecord().

◆ m_size

size_t ALTIUM_BINARY_PARSER::m_size
private

Definition at line 319 of file altium_binary_parser.h.

Referenced by ALTIUM_BINARY_PARSER(), and GetRemainingBytes().

◆ m_subrecord_end

char* ALTIUM_BINARY_PARSER::m_subrecord_end
private

Definition at line 322 of file altium_binary_parser.h.

Referenced by ALTIUM_BINARY_PARSER(), GetRemainingSubrecordBytes(), ReadAndSetSubrecordLength(), and SkipSubrecord().

The documentation for this class was generated from the following files: