ALTIUM_PARSER Class Reference

#include <altium_parser.h>

Public Member Functions
	ALTIUM_PARSER (const ALTIUM_COMPOUND_FILE &aFile, const CFB::COMPOUND_FILE_ENTRY *aEntry)
	ALTIUM_PARSER (std::unique_ptr< char[]> &aContent, size_t aSize)
	~ALTIUM_PARSER ()=default
template<typename Type >
Type	Read ()
template<typename Type >
Type	Peek ()
wxString	ReadWxString ()
std::map< uint32_t, wxString >	ReadWideStringTable ()
std::vector< char >	ReadVector (size_t aSize)
int32_t	ReadKicadUnit ()
int32_t	ReadKicadUnitX ()
int32_t	ReadKicadUnitY ()
VECTOR2I	ReadVector2I ()
wxSize	ReadWxSize ()
size_t	ReadAndSetSubrecordLength ()
std::map< wxString, wxString >	ReadProperties ()
void	Skip (size_t aLength)
void	SkipSubrecord ()
size_t	GetRemainingBytes () const
size_t	GetRemainingSubrecordBytes () const
bool	HasParsingError ()

Static Public Member Functions
static int32_t	ConvertToKicadUnit (const double aValue)
static int	ReadInt (const std::map< wxString, wxString > &aProps, const wxString &aKey, int aDefault)
static double	ReadDouble (const std::map< wxString, wxString > &aProps, const wxString &aKey, double aDefault)
static bool	ReadBool (const std::map< wxString, wxString > &aProps, const wxString &aKey, bool aDefault)
static int32_t	ReadKicadUnit (const std::map< wxString, wxString > &aProps, const wxString &aKey, const wxString &aDefault)
static wxString	ReadString (const std::map< wxString, wxString > &aProps, const wxString &aKey, const wxString &aDefault)

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 74 of file altium_parser.h.

Constructor & Destructor Documentation

ALTIUM_PARSER() [1/2]

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

Definition at line 145 of file altium_parser.cpp.

{
 m_subrecord_end = nullptr;
 m_size = static_cast<size_t>( aEntry->size );
 m_error = false;
 m_content.reset( new char[m_size] );
 m_pos = m_content.get();
 
 // read file into buffer
 aFile.GetCompoundFileReader().ReadFile( aEntry, 0, m_content.get(), m_size );
}

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

ALTIUM_PARSER() [2/2]

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

Definition at line 159 of file altium_parser.cpp.

{
 m_subrecord_end = nullptr;
 m_size = aSize;
 m_error = false;
 m_content = std::move( aContent );
 m_pos = m_content.get();
}

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

~ALTIUM_PARSER()

ALTIUM_PARSER::~ALTIUM_PARSER ( )

default

Member Function Documentation

ConvertToKicadUnit()

int32_t ALTIUM_PARSER::ConvertToKicadUnit ( const double  aValue )

static

Definition at line 253 of file altium_parser.cpp.

{
 constexpr double int_limit = ( std::numeric_limits<int>::max() - 10 ) / 2.54;
 
 int32_t iu = KiROUND( Clamp<double>( -int_limit, aValue, int_limit ) * 2.54 );
 
 // Altium's internal precision is 0.1uinch. KiCad's is 1nm. Round to nearest 10nm to clean
 // up most rounding errors. This allows lossless conversion of increments of 0.05mils and
 // 0.01um.
 return KiROUND( (double) iu / 10.0 ) * 10;
}

References KiROUND().

Referenced by AREGION6::AREGION6(), BOOST_AUTO_TEST_CASE(), and ReadKicadUnit().

GetRemainingBytes()

size_t ALTIUM_PARSER::GetRemainingBytes ( ) const

inline

Definition at line 252 of file altium_parser.h.

 {
 return m_pos == nullptr ? 0 : m_size - ( m_pos - m_content.get() );
 }

References m_content, m_pos, and m_size.

Referenced by BOOST_AUTO_TEST_CASE(), ALTIUM_DESIGNER_PLUGIN::FootprintEnumerate(), ALTIUM_PCB::Parse(), SCH_ALTIUM_PLUGIN::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_ALTIUM_PLUGIN::ParseFileHeader(), ALTIUM_PCB::ParseFills6Data(), ALTIUM_PCB::ParseFootprint(), ALTIUM_PCB::ParseModelsData(), ALTIUM_PCB::ParseNets6Data(), ALTIUM_PCB::ParsePads6Data(), ALTIUM_PCB::ParsePolygons6Data(), ALTIUM_PCB::ParseRegions6Data(), ALTIUM_PCB::ParseRules6Data(), ALTIUM_PCB::ParseShapeBasedRegions6Data(), SCH_ALTIUM_PLUGIN::ParseStorage(), ALTIUM_PCB::ParseTexts6Data(), ALTIUM_PCB::ParseTracks6Data(), ALTIUM_PCB::ParseVias6Data(), ALTIUM_PCB::ParseWideStrings6Data(), Read(), ReadProperties(), ReadVector(), ReadWideStringTable(), ReadWxString(), and Skip().

GetRemainingSubrecordBytes()

size_t ALTIUM_PARSER::GetRemainingSubrecordBytes ( ) const

inline

Definition at line 257 of file altium_parser.h.

 {
 return m_pos == nullptr || m_subrecord_end == nullptr || m_subrecord_end <= m_pos ?
 0 :
 m_subrecord_end - m_pos;
 };

References m_pos, and m_subrecord_end.

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

HasParsingError()

bool ALTIUM_PARSER::HasParsingError ( )

inline

Definition at line 264 of file altium_parser.h.

 {
 return m_error;
 }

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(), ALTIUM_DESIGNER_PLUGIN::FootprintEnumerate(), ALTIUM_PCB::Parse(), SCH_ALTIUM_PLUGIN::ParseAdditional(), SCH_ALTIUM_PLUGIN::ParseFileHeader(), ALTIUM_PCB::ParseFootprint(), and SCH_ALTIUM_PLUGIN::ParseStorage().

Peek()

template<typename Type >

Type ALTIUM_PARSER::Peek ( )

inline

Definition at line 100 of file altium_parser.h.

 {
 char* const oldPos = m_pos;
 const bool oldError = m_error;
 Type result = Read<Type>();
 m_pos = oldPos;
 m_error = oldError;
 return result;
 }

References m_error, and m_pos.

Referenced by ALTIUM_PCB::ParseFootprint().

Read()

template<typename Type >

Type ALTIUM_PARSER::Read ( )

inline

Definition at line 82 of file altium_parser.h.

 {
 const size_t remainingBytes = GetRemainingBytes();
 if( remainingBytes >= sizeof( Type ) )
 {
 Type val = *(Type*) ( m_pos );
 m_pos += sizeof( Type );
 return val;
 }
 else
 {
 m_pos += remainingBytes; // Ensure remaining bytes are zero
 m_error = true;
 return 0;
 }
 }

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(), ALTIUM_DESIGNER_PLUGIN::FootprintEnumerate(), and ALTIUM_PCB::Parse().

ReadAndSetSubrecordLength()

size_t ALTIUM_PARSER::ReadAndSetSubrecordLength ( )

inline

Definition at line 202 of file altium_parser.h.

 {
 uint32_t length = Read<uint32_t>();
 m_subrecord_end = m_pos + length;
 return length;
 }

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(), ALTIUM_DESIGNER_PLUGIN::FootprintEnumerate(), ALTIUM_PCB::ParseFileHeader(), and ALTIUM_PCB::ParseFootprint().

ReadBool()

bool ALTIUM_PARSER::ReadBool ( const std::map< wxString, wxString > &  aProps, const wxString &  aKey, bool  aDefault  )

static

Definition at line 292 of file altium_parser.cpp.

{
 const std::map<wxString, wxString>::const_iterator& value = aProps.find( aKey );
 
 if( value == aProps.end() )
 return aDefault;
 else
 return value->second == "T" || value->second == "TRUE";
}

Referenced by ACOMPONENT6::ACOMPONENT6(), ACOMPONENTBODY6::ACOMPONENTBODY6(), ADIMENSION6::ADIMENSION6(), AMODEL::AMODEL(), APOLYGON6::APOLYGON6(), AREGION6::AREGION6(), ASCH_ELLIPSE::ASCH_ELLIPSE(), ASCH_FILE_NAME::ASCH_FILE_NAME(), ASCH_HARNESS_ENTRY::ASCH_HARNESS_ENTRY(), ASCH_HARNESS_TYPE::ASCH_HARNESS_TYPE(), ASCH_IMAGE::ASCH_IMAGE(), ASCH_IMPLEMENTATION::ASCH_IMPLEMENTATION(), ASCH_LABEL::ASCH_LABEL(), ASCH_NO_ERC::ASCH_NO_ERC(), ASCH_PARAMETER::ASCH_PARAMETER(), ASCH_POLYGON::ASCH_POLYGON(), ASCH_POWER_PORT::ASCH_POWER_PORT(), ASCH_RECTANGLE::ASCH_RECTANGLE(), ASCH_ROUND_RECTANGLE::ASCH_ROUND_RECTANGLE(), ASCH_SHEET_FONT::ASCH_SHEET_FONT(), ASCH_SHEET_NAME::ASCH_SHEET_NAME(), ASCH_SHEET_SYMBOL::ASCH_SHEET_SYMBOL(), ASCH_SYMBOL::ASCH_SYMBOL(), and ASCH_TEXT_FRAME::ASCH_TEXT_FRAME().

ReadDouble()

double ALTIUM_PARSER::ReadDouble ( const std::map< wxString, wxString > &  aProps, const wxString &  aKey, double  aDefault  )

static

Definition at line 274 of file altium_parser.cpp.

{
 const std::map<wxString, wxString>::const_iterator& value = aProps.find( aKey );
 
 if( value == aProps.end() )
 return aDefault;
 
 // Locale independent str -> double conversation
 std::istringstream istr( (const char*) value->second.mb_str() );
 istr.imbue( std::locale::classic() );
 
 double doubleValue;
 istr >> doubleValue;
 return doubleValue;
}

Referenced by ABOARD6::ABOARD6(), ACOMPONENT6::ACOMPONENT6(), ACOMPONENTBODY6::ACOMPONENTBODY6(), ADIMENSION6::ADIMENSION6(), altium_parse_polygons(), AMODEL::AMODEL(), and ASCH_ARC::ASCH_ARC().

ReadInt()

int ALTIUM_PARSER::ReadInt ( const std::map< wxString, wxString > &  aProps, const wxString &  aKey, int  aDefault  )

static

Definition at line 266 of file altium_parser.cpp.

{
 const std::map<wxString, wxString>::const_iterator& value = aProps.find( aKey );
 return value == aProps.end() ? aDefault : wxAtoi( value->second );
}

Referenced by ABOARD6::ABOARD6(), ACLASS6::ACLASS6(), ACOMPONENT6::ACOMPONENT6(), ADIMENSION6::ADIMENSION6(), AEXTENDED_PRIMITIVE_INFORMATION::AEXTENDED_PRIMITIVE_INFORMATION(), altium_parse_polygons(), APOLYGON6::APOLYGON6(), AREGION6::AREGION6(), ARULE6::ARULE6(), ASCH_ARC::ASCH_ARC(), ASCH_BEZIER::ASCH_BEZIER(), ASCH_BUS::ASCH_BUS(), ASCH_ELLIPSE::ASCH_ELLIPSE(), ASCH_HARNESS_CONNECTOR::ASCH_HARNESS_CONNECTOR(), ASCH_HARNESS_ENTRY::ASCH_HARNESS_ENTRY(), ASCH_HARNESS_TYPE::ASCH_HARNESS_TYPE(), ASCH_IMAGE::ASCH_IMAGE(), ASCH_IMPLEMENTATION::ASCH_IMPLEMENTATION(), ASCH_LABEL::ASCH_LABEL(), ASCH_LINE::ASCH_LINE(), ASCH_NO_ERC::ASCH_NO_ERC(), ASCH_PIN::ASCH_PIN(), ASCH_POLYGON::ASCH_POLYGON(), ASCH_POLYLINE::ASCH_POLYLINE(), ASCH_PORT::ASCH_PORT(), ASCH_RECTANGLE::ASCH_RECTANGLE(), ASCH_ROUND_RECTANGLE::ASCH_ROUND_RECTANGLE(), ASCH_SHEET::ASCH_SHEET(), ASCH_SHEET_FONT::ASCH_SHEET_FONT(), ASCH_SHEET_SYMBOL::ASCH_SHEET_SYMBOL(), ASCH_SIGNAL_HARNESS::ASCH_SIGNAL_HARNESS(), ASCH_SYMBOL::ASCH_SYMBOL(), ASCH_TEXT_FRAME::ASCH_TEXT_FRAME(), ASCH_WIRE::ASCH_WIRE(), SCH_ALTIUM_PLUGIN::ParseAdditional(), SCH_ALTIUM_PLUGIN::ParseFileHeader(), SCH_ALTIUM_PLUGIN::ParseStorage(), ReadEnum(), ReadKiCadUnitFrac(), ReadKiCadUnitFrac1(), ReadOwnerIndex(), ReadOwnerPartId(), and ReadRecord().

ReadKicadUnit() [1/2]

int32_t ALTIUM_PARSER::ReadKicadUnit ( )

inline

Definition at line 173 of file altium_parser.h.

 {
 return ConvertToKicadUnit( Read<int32_t>() );
 }

References ConvertToKicadUnit().

Referenced by AARC6::AARC6(), ABOARD6::ABOARD6(), ACOMPONENT6::ACOMPONENT6(), ACOMPONENTBODY6::ACOMPONENTBODY6(), ADIMENSION6::ADIMENSION6(), AEXTENDED_PRIMITIVE_INFORMATION::AEXTENDED_PRIMITIVE_INFORMATION(), altium_parse_polygons(), APAD6::APAD6(), APOLYGON6::APOLYGON6(), AREGION6::AREGION6(), ARULE6::ARULE6(), ATEXT6::ATEXT6(), ATRACK6::ATRACK6(), AVIA6::AVIA6(), BOOST_AUTO_TEST_CASE(), ReadKicadUnitX(), ReadKicadUnitY(), and ReadWxSize().

ReadKicadUnit() [2/2]

int32_t ALTIUM_PARSER::ReadKicadUnit ( const std::map< wxString, wxString > &  aProps, const wxString &  aKey, const wxString &  aDefault  )

static

Definition at line 304 of file altium_parser.cpp.

{
 const wxString& value = ReadString( aProps, aKey, aDefault );
 
 wxString prefix;
 
 if( !value.EndsWith( "mil", &prefix ) )
 {
 wxLogError( _( "Unit '%s' does not end with 'mil'." ), value );
 return 0;
 }
 
 double mils;
 
 if( !prefix.ToCDouble( &mils ) )
 {
 wxLogError( _( "Cannot convert '%s' to double." ), prefix );
 return 0;
 }
 
 return ConvertToKicadUnit( mils * 10000 );
}

References _, ConvertToKicadUnit(), and ReadString().

ReadKicadUnitX()

int32_t ALTIUM_PARSER::ReadKicadUnitX ( )

inline

Definition at line 178 of file altium_parser.h.

 {
 return ReadKicadUnit();
 }

References ReadKicadUnit().

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

ReadKicadUnitY()

int32_t ALTIUM_PARSER::ReadKicadUnitY ( )

inline

Definition at line 183 of file altium_parser.h.

 {
 return -ReadKicadUnit();
 }

References ReadKicadUnit().

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

ReadProperties()

std::map< wxString, wxString > ALTIUM_PARSER::ReadProperties

(

)

Definition at line 169 of file altium_parser.cpp.

{
 std::map<wxString, wxString> kv;
 
 uint32_t length = Read<uint32_t>();
 
 if( length > GetRemainingBytes() )
 {
 m_error = true;
 return kv;
 }
 
 if( length == 0 )
 {
 return kv;
 }
 
 // There is one case by kliment where Board6 ends with "|NEARDISTANCE=1000mi".
 // Both the 'l' and the null-byte are missing, which looks like Altium swallowed two bytes.
 bool hasNullByte = m_pos[length - 1] == '\0';
 
 if( !hasNullByte )
 {
 wxLogError( _( "Missing null byte at end of property list. Imported data might be "
  "malformed or missing." ) );
 }
 
 // we use std::string because std::string can handle NULL-bytes
 // wxString would end the string at the first NULL-byte
 std::string str = std::string( m_pos, length - ( hasNullByte ? 1 : 0 ) );
 m_pos += length;
 
 std::size_t token_end = 0;
 
 while( token_end < str.size() && token_end != std::string::npos )
 {
 std::size_t token_start = str.find( '|', token_end );
 std::size_t token_equal = str.find( '=', token_start );
 token_end = str.find( '|', token_start + 1 );
 
 if( token_equal >= token_end )
 {
 continue; // this looks like an error: skip the entry. Also matches on std::string::npos
 }
 
 if( token_end == std::string::npos )
 {
 token_end = str.size() + 1; // this is the correct offset
 }
 
 std::string keyS = str.substr( token_start + 1, token_equal - token_start - 1 );
 std::string valueS = str.substr( token_equal + 1, token_end - token_equal - 1 );
 
 // convert the strings to wxStrings, since we use them everywhere
 // value can have non-ASCII characters, so we convert them from LATIN1/ISO8859-1
 wxString key( keyS.c_str(), wxConvISO8859_1 );
 // Altium stores keys either in Upper, or in CamelCase. Lets unify it.
 wxString canonicalKey = key.Trim( false ).Trim( true ).MakeUpper();
 // If the key starts with '%UTF8%' we have to parse the value using UTF8
 wxString value;
 
 if( canonicalKey.StartsWith( "%UTF8%" ) )
 value = wxString( valueS.c_str(), wxConvUTF8 );
 else
 value = wxString( valueS.c_str(), wxConvISO8859_1 );
 
 // Breathless hack because I haven't a clue what the story is here (but this character
 // appears in a lot of radial dimensions and is rendered by Altium as a space).
 value.Replace( wxT( "ÿ" ), wxT( " " ) );
 
 if( canonicalKey == wxT( "DESIGNATOR" )
 || canonicalKey == wxT( "NAME" )
 || canonicalKey == wxT( "TEXT" ) )
 {
 value = AltiumPropertyToKiCadString( value.Trim() );
 }
 
 kv.insert( { canonicalKey, value.Trim() } );
 }
 
 return kv;
}

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(), ALTIUM_DESIGNER_PLUGIN::FootprintEnumerate(), SCH_ALTIUM_PLUGIN::ParseAdditional(), SCH_ALTIUM_PLUGIN::ParseFileHeader(), ALTIUM_PCB::ParseFootprint(), and SCH_ALTIUM_PLUGIN::ParseStorage().

ReadString()

wxString ALTIUM_PARSER::ReadString ( const std::map< wxString, wxString > &  aProps, const wxString &  aKey, const wxString &  aDefault  )

static

Definition at line 329 of file altium_parser.cpp.

{
 const auto& utf8Value = aProps.find( wxString( "%UTF8%" ) + aKey );
 
 if( utf8Value != aProps.end() )
 return utf8Value->second;
 
 const auto& value = aProps.find( aKey );
 
 if( value != aProps.end() )
 return value->second;
 
 return aDefault;
}

Referenced by ABOARD6::ABOARD6(), ACLASS6::ACLASS6(), ACOMPONENT6::ACOMPONENT6(), ACOMPONENTBODY6::ACOMPONENTBODY6(), ADIMENSION6::ADIMENSION6(), AMODEL::AMODEL(), ANET6::ANET6(), APOLYGON6::APOLYGON6(), ARULE6::ARULE6(), ASCH_DESIGNATOR::ASCH_DESIGNATOR(), ASCH_FILE_NAME::ASCH_FILE_NAME(), ASCH_HARNESS_ENTRY::ASCH_HARNESS_ENTRY(), ASCH_HARNESS_TYPE::ASCH_HARNESS_TYPE(), ASCH_IMAGE::ASCH_IMAGE(), ASCH_IMPLEMENTATION::ASCH_IMPLEMENTATION(), ASCH_LABEL::ASCH_LABEL(), ASCH_NET_LABEL::ASCH_NET_LABEL(), ASCH_NOTE::ASCH_NOTE(), ASCH_PARAMETER::ASCH_PARAMETER(), ASCH_PIN::ASCH_PIN(), ASCH_PORT::ASCH_PORT(), ASCH_POWER_PORT::ASCH_POWER_PORT(), ASCH_SHEET_ENTRY::ASCH_SHEET_ENTRY(), ASCH_SHEET_FONT::ASCH_SHEET_FONT(), ASCH_SHEET_NAME::ASCH_SHEET_NAME(), ASCH_SYMBOL::ASCH_SYMBOL(), ASCH_TEXT_FRAME::ASCH_TEXT_FRAME(), ALTIUM_PCB::ParseFootprint(), SCH_ALTIUM_PLUGIN::ParseStorage(), ReadAltiumExtendedPrimitiveInformationTypeFromProperties(), ReadAltiumModeFromProperties(), ReadAltiumRecordFromProperties(), and ReadKicadUnit().

ReadVector()

std::vector< char > ALTIUM_PARSER::ReadVector ( size_t  aSize )

inline

Definition at line 158 of file altium_parser.h.

 {
 if( aSize > GetRemainingBytes() )
 {
 m_error = true;
 return {};
 }
 else
 {
 std::vector<char> data( m_pos, m_pos + aSize );
 m_pos += aSize;
 return data;
 }
 }

References GetRemainingBytes(), m_error, and m_pos.

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

ReadVector2I()

VECTOR2I ALTIUM_PARSER::ReadVector2I ( )

inline

Definition at line 188 of file altium_parser.h.

 {
 int32_t x = ReadKicadUnitX();
 int32_t y = ReadKicadUnitY();
 return { x, y };
 }

References ReadKicadUnitX(), and ReadKicadUnitY().

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

ReadWideStringTable()

std::map< uint32_t, wxString > ALTIUM_PARSER::ReadWideStringTable ( )

inline

Definition at line 128 of file altium_parser.h.

 {
 std::map<uint32_t, wxString> table;
 size_t remaining = GetRemainingBytes();
 
 while( remaining >= 8 )
 {
 uint32_t index = Read<uint32_t>();
 uint32_t length = Read<uint32_t>();
 wxString str;
 remaining -= 8;
 
 if( length <= 2 )
 length = 0; // for empty strings, not even the null bytes are present
 else
 {
 if( length > remaining )
 break;
 
 str = wxString( m_pos, wxMBConvUTF16LE(), length - 2 );
 }
 
 table.emplace( index, str );
 m_pos += length;
 remaining -= length;
 }
 
 return table;
 }

References GetRemainingBytes(), and m_pos.

Referenced by ALTIUM_PCB::ParseWideStrings6Data().

ReadWxSize()

wxSize ALTIUM_PARSER::ReadWxSize ( )

inline

Definition at line 195 of file altium_parser.h.

 {
 int32_t x = ReadKicadUnit();
 int32_t y = ReadKicadUnit();
 return { x, y };
 }

References ReadKicadUnit().

Referenced by APAD6::APAD6().

ReadWxString()

wxString ALTIUM_PARSER::ReadWxString ( )

inline

Definition at line 110 of file altium_parser.h.

 {
 uint8_t len = Read<uint8_t>();
 if( GetRemainingBytes() >= len )
 {
 // TODO: Identify where the actual code page is stored. For now, this default code page
 // has limited impact, because recent Altium files come with a UTF16 string table
 wxString val = wxString( m_pos, wxConvISO8859_1, len );
 m_pos += len;
 return val;
 }
 else
 {
 m_error = true;
 return wxString( "" );
 }
 }

References GetRemainingBytes(), m_error, and m_pos.

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

Skip()

void ALTIUM_PARSER::Skip ( size_t  aLength )

inline

Definition at line 228 of file altium_parser.h.

 {
 if( GetRemainingBytes() >= aLength )
 {
 m_pos += aLength;
 }
 else
 {
 m_error = true;
 }
 }

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_PARSER::SkipSubrecord ( )

inline

Definition at line 240 of file altium_parser.h.

 {
 if( m_subrecord_end == nullptr || m_subrecord_end < m_pos )
 {
 m_error = true;
 }
 else
 {
 m_pos = m_subrecord_end;
 }
 };

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(), ALTIUM_DESIGNER_PLUGIN::FootprintEnumerate(), and ALTIUM_PCB::ParseFootprint().

Member Data Documentation

m_content

std::unique_ptr<char[]> ALTIUM_PARSER::m_content

private

Definition at line 270 of file altium_parser.h.

Referenced by ALTIUM_PARSER(), and GetRemainingBytes().

m_error

bool ALTIUM_PARSER::m_error

private

Definition at line 275 of file altium_parser.h.

Referenced by ALTIUM_PARSER(), HasParsingError(), Peek(), Read(), ReadProperties(), ReadVector(), ReadWxString(), Skip(), and SkipSubrecord().

m_pos

char* ALTIUM_PARSER::m_pos

private

Definition at line 273 of file altium_parser.h.

Referenced by ALTIUM_PARSER(), GetRemainingBytes(), GetRemainingSubrecordBytes(), Peek(), Read(), ReadAndSetSubrecordLength(), ReadProperties(), ReadVector(), ReadWideStringTable(), ReadWxString(), Skip(), and SkipSubrecord().

m_size

size_t ALTIUM_PARSER::m_size

private

Definition at line 271 of file altium_parser.h.

Referenced by ALTIUM_PARSER(), and GetRemainingBytes().

m_subrecord_end

char* ALTIUM_PARSER::m_subrecord_end

private

Definition at line 274 of file altium_parser.h.

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

---

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

• altium_parser.h
• altium_parser.cpp