274 lines
8.8 KiB
C++
274 lines
8.8 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2019-2020 Thomas Pointhuber <thomas.pointhuber@gmx.at>
|
|
*
|
|
* 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 2
|
|
* 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, you may find one here:
|
|
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
|
|
* or you may search the http://www.gnu.org website for the version 2 license,
|
|
* or you may write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
|
*/
|
|
|
|
#include "altium_parser.h"
|
|
#include "altium_parser_utils.h"
|
|
|
|
#include <compoundfilereader.h>
|
|
#include <ki_exception.h>
|
|
#include <math/util.h>
|
|
#include <sstream>
|
|
#include <utf.h>
|
|
#include <wx/log.h>
|
|
#include <wx/translation.h>
|
|
|
|
const CFB::COMPOUND_FILE_ENTRY* FindStream( const CFB::CompoundFileReader& aReader,
|
|
const char* aStreamName )
|
|
{
|
|
const CFB::COMPOUND_FILE_ENTRY* ret = nullptr;
|
|
aReader.EnumFiles( aReader.GetRootEntry(), -1,
|
|
[&]( const CFB::COMPOUND_FILE_ENTRY* aEntry, const CFB::utf16string& aU16dir,
|
|
int level ) -> void
|
|
{
|
|
if( aReader.IsStream( aEntry ) )
|
|
{
|
|
std::string name = UTF16ToUTF8( aEntry->name );
|
|
if( aU16dir.length() > 0 )
|
|
{
|
|
std::string dir = UTF16ToUTF8( aU16dir.c_str() );
|
|
if( strncmp( aStreamName, dir.c_str(), dir.length() ) == 0
|
|
&& aStreamName[dir.length()] == '\\'
|
|
&& strcmp( aStreamName + dir.length() + 1, name.c_str() ) == 0 )
|
|
{
|
|
ret = aEntry;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
if( strcmp( aStreamName, name.c_str() ) == 0 )
|
|
{
|
|
ret = aEntry;
|
|
}
|
|
}
|
|
}
|
|
} );
|
|
return ret;
|
|
}
|
|
|
|
|
|
ALTIUM_PARSER::ALTIUM_PARSER( const CFB::CompoundFileReader& aReader,
|
|
const CFB::COMPOUND_FILE_ENTRY* aEntry )
|
|
{
|
|
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
|
|
aReader.ReadFile( aEntry, 0, m_content.get(), m_size );
|
|
}
|
|
|
|
|
|
ALTIUM_PARSER::ALTIUM_PARSER( std::unique_ptr<char[]>& aContent, size_t aSize )
|
|
{
|
|
m_subrecord_end = nullptr;
|
|
m_size = aSize;
|
|
m_error = false;
|
|
m_content = std::move( aContent );
|
|
m_pos = m_content.get();
|
|
}
|
|
|
|
|
|
std::map<wxString, wxString> ALTIUM_PARSER::ReadProperties()
|
|
{
|
|
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 );
|
|
|
|
if( canonicalKey == wxT( "DESIGNATOR" )
|
|
|| canonicalKey == wxT( "NAME" )
|
|
|| canonicalKey == wxT( "TEXT" ) )
|
|
{
|
|
value = AltiumPropertyToKiCadString( value.Trim() );
|
|
}
|
|
|
|
kv.insert( { canonicalKey, value.Trim() } );
|
|
}
|
|
|
|
return kv;
|
|
}
|
|
|
|
|
|
int32_t ALTIUM_PARSER::ConvertToKicadUnit( const double aValue )
|
|
{
|
|
const double int_limit = ( std::numeric_limits<int>::max() - 1 ) / 2.54;
|
|
|
|
int32_t iu = KiROUND( Clamp<double>( -int_limit, aValue, int_limit ) * 2.54 );
|
|
|
|
// Altium stores metric units up to 0.001mm (1000nm) in accuracy. This code fixes rounding
|
|
// errors. Because imperial units > 0.01mil are always even, this workaround should never
|
|
// trigger for them.
|
|
switch( iu % 1000 )
|
|
{
|
|
case 1:
|
|
case -999:
|
|
return iu - 1;
|
|
case 999:
|
|
case -1:
|
|
return iu + 1;
|
|
default:
|
|
return iu;
|
|
}
|
|
}
|
|
|
|
|
|
int ALTIUM_PARSER::PropertiesReadInt( const std::map<wxString, wxString>& aProperties,
|
|
const wxString& aKey, int aDefault )
|
|
{
|
|
const std::map<wxString, wxString>::const_iterator& value = aProperties.find( aKey );
|
|
return value == aProperties.end() ? aDefault : wxAtoi( value->second );
|
|
}
|
|
|
|
|
|
double ALTIUM_PARSER::PropertiesReadDouble( const std::map<wxString, wxString>& aProperties,
|
|
const wxString& aKey, double aDefault )
|
|
{
|
|
const std::map<wxString, wxString>::const_iterator& value = aProperties.find( aKey );
|
|
if( value == aProperties.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;
|
|
}
|
|
|
|
|
|
bool ALTIUM_PARSER::PropertiesReadBool( const std::map<wxString, wxString>& aProperties,
|
|
const wxString& aKey, bool aDefault )
|
|
{
|
|
const std::map<wxString, wxString>::const_iterator& value = aProperties.find( aKey );
|
|
if( value == aProperties.end() )
|
|
return aDefault;
|
|
else
|
|
return value->second == "T" || value->second == "TRUE";
|
|
}
|
|
|
|
|
|
int32_t ALTIUM_PARSER::PropertiesReadKicadUnit( const std::map<wxString, wxString>& aProperties,
|
|
const wxString& aKey, const wxString& aDefault )
|
|
{
|
|
const wxString& value = PropertiesReadString( aProperties, 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 );
|
|
}
|
|
|
|
|
|
wxString ALTIUM_PARSER::PropertiesReadString( const std::map<wxString, wxString>& aProperties,
|
|
const wxString& aKey, const wxString& aDefault )
|
|
{
|
|
const auto& utf8Value = aProperties.find( wxString( "%UTF8%" ) + aKey );
|
|
|
|
if( utf8Value != aProperties.end() )
|
|
return utf8Value->second;
|
|
|
|
const auto& value = aProperties.find( aKey );
|
|
|
|
if( value != aProperties.end() )
|
|
return value->second;
|
|
|
|
return aDefault;
|
|
}
|