altium_binary_parser.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2019-2020 Thomas Pointhuber <[email protected]>
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * 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, see <https://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include "altium_props_utils.h"
 
#include <charconv>
#include <map>
#include <memory>
#include <numeric>
#include <string>
#include <stdexcept>
#include <vector>
 
#include <wx/mstream.h>
#include <wx/zstream.h>
#include <math/vector2d.h>
#include <math/vector3.h>
 
namespace CFB
{
    class CompoundFileReader;
    struct COMPOUND_FILE_ENTRY;
} // namespace CFB

std::string FormatPath( const std::vector<std::string>& aVectorPath );
 
 
class ALTIUM_SYMBOL_DATA
{
public:
    const CFB::COMPOUND_FILE_ENTRY* m_symbol;
    const CFB::COMPOUND_FILE_ENTRY* m_pinsFrac;
    const CFB::COMPOUND_FILE_ENTRY* m_pinsWideText;
    const CFB::COMPOUND_FILE_ENTRY* m_pinsTextData;
    const CFB::COMPOUND_FILE_ENTRY* m_pinsSymbolLineWidth;
};
 
 
class ALTIUM_COMPOUND_FILE
{
    friend class ALTIUM_PCB_COMPOUND_FILE;
 
public:
    ALTIUM_COMPOUND_FILE();

    ALTIUM_COMPOUND_FILE( const wxString& aFilePath );

    ALTIUM_COMPOUND_FILE( const void* aBuffer, size_t aLen );
 
    ALTIUM_COMPOUND_FILE( const ALTIUM_COMPOUND_FILE& temp_obj ) = delete;
    ALTIUM_COMPOUND_FILE& operator=( const ALTIUM_COMPOUND_FILE& temp_obj ) = delete;
    ~ALTIUM_COMPOUND_FILE() = default;

    void InitFromBuffer( const void* aBuffer, size_t aLen );
 
    const CFB::CompoundFileReader& GetCompoundFileReader() const { return *m_reader; }
 
    bool DecodeIntLibStream( const CFB::COMPOUND_FILE_ENTRY& cfe, ALTIUM_COMPOUND_FILE* aOutput );
 
    const CFB::COMPOUND_FILE_ENTRY* FindStream( const std::vector<std::string>& aStreamPath ) const;
 
    const CFB::COMPOUND_FILE_ENTRY* FindStream( const CFB::COMPOUND_FILE_ENTRY* aStart,
                                                const std::vector<std::string>& aStreamPath ) const;
 
    const CFB::COMPOUND_FILE_ENTRY* FindStreamSingleLevel( const CFB::COMPOUND_FILE_ENTRY* aEntry,
                                                           const std::string               aName,
                                                           const bool aIsStream ) const;
 
    std::map<wxString, const CFB::COMPOUND_FILE_ENTRY*> EnumDir( const std::wstring& aDir ) const;
 
    std::map<wxString, ALTIUM_SYMBOL_DATA> GetLibSymbols( const CFB::COMPOUND_FILE_ENTRY* aStart ) const;
 
private:
 
    std::unique_ptr<CFB::CompoundFileReader> m_reader;
    std::vector<char>                        m_buffer;
};
 
 
class ALTIUM_BINARY_PARSER
{
public:
    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()
    {
        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;
        }
    }
 
    template <typename Type>
    Type Peek()
    {
        char* const oldPos = m_pos;
        const bool  oldError = m_error;
        Type        result = Read<Type>();
        m_pos = oldPos;
        m_error = oldError;
        return result;
    }
 
    wxScopedCharBuffer ReadCharBuffer()
    {
        uint8_t len = Read<uint8_t>();
 
        if( GetRemainingBytes() >= len )
        {
            char* buf = static_cast<char*>( malloc( len ) );
            memcpy( buf, m_pos, len );
            m_pos += len;
 
            return wxScopedCharBuffer::CreateOwned( buf, len );
        }
        else
        {
            m_error = true;
            return wxScopedCharBuffer();
        }
    }
 
    wxString ReadWxString()
    {
        // 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
        return wxString( ReadCharBuffer(), wxConvISO8859_1 );
    }
 
    std::map<uint32_t, wxString> ReadWideStringTable()
    {
        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;
    }
 
    std::vector<char> ReadVector( size_t aSize )
    {
        if( aSize > GetRemainingBytes() )
        {
            m_error = true;
            return {};
        }
        else
        {
            std::vector<char> data( m_pos, m_pos + aSize );
            m_pos += aSize;
            return data;
        }
    }
 
    int ReadBytes( char* aOut, size_t aSize )
    {
        if( aSize > GetRemainingBytes() )
        {
            m_error = true;
            return 0;
        }
        else
        {
            memcpy( aOut, m_pos, aSize );
            m_pos += aSize;
            return aSize;
        }
    }
 
    int32_t ReadKicadUnit()
    {
        return ALTIUM_PROPS_UTILS::ConvertToKicadUnit( Read<int32_t>() );
    }
 
    int32_t ReadKicadUnitX()
    {
        return ReadKicadUnit();
    }
 
    int32_t ReadKicadUnitY()
    {
        return -ReadKicadUnit();
    }
 
    VECTOR2I ReadVector2IPos()
    {
        int32_t x = ReadKicadUnitX();
        int32_t y = ReadKicadUnitY();
        return { x, y };
    }
 
    VECTOR2I ReadVector2ISize()
    {
        int32_t x = ReadKicadUnit();
        int32_t y = ReadKicadUnit();
        return { x, y };
    }
 
    size_t ReadAndSetSubrecordLength()
    {
        uint32_t length = Read<uint32_t>();
        m_subrecord_end = m_pos + length;
        return length;
    }
 
    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 )
    {
        if( GetRemainingBytes() < aLength )
        {
            m_error = true;
            return;
        }
 
        m_pos += aLength;
    }
 
    void SkipSubrecord()
    {
        if( m_subrecord_end == nullptr || m_subrecord_end < m_pos )
        {
            m_error = true;
            return;
        }
 
        m_pos = m_subrecord_end;
    };
 
    size_t GetRemainingBytes() const
    {
        if( m_pos == nullptr || m_content.get() + m_size < m_pos )
            return 0;
 
        return m_size - ( m_pos - m_content.get() );
    }
 
    size_t GetRemainingSubrecordBytes() const
    {
        if( m_pos == nullptr || m_subrecord_end == nullptr || m_subrecord_end < m_pos )
            return 0;
 
        return m_subrecord_end - m_pos;
    };
 
    bool HasParsingError() { return m_error; }
 
private:
    std::unique_ptr<char[]> m_content;
    size_t                  m_size;
 
    char*                   m_pos;           // current read pointer
    char*                   m_subrecord_end; // pointer which points to next subrecord start
    bool                    m_error;
};
 
 
class ALTIUM_BINARY_READER
{
public:
    ALTIUM_BINARY_READER( const std::string& binaryData ) :
            m_data( binaryData ),
            m_position( 0 )
    {}
 
    int32_t ReadInt32()
    {
        if( m_position + sizeof( int32_t ) > m_data.size() )
            throw std::out_of_range( "ALTIUM_BINARY_READER: out of range" );
 
        int32_t value = *reinterpret_cast<const int32_t*>( &m_data[m_position] );
        m_position += sizeof( int32_t );
        return value;
    }
 
    int16_t ReadInt16()
    {
        if( m_position + sizeof( int16_t ) > m_data.size() )
            throw std::out_of_range( "ALTIUM_BINARY_READER: out of range" );
 
        int16_t value = *reinterpret_cast<const int16_t*>( &m_data[m_position] );
        m_position += sizeof( int16_t );
        return value;
    }
 
    uint8_t ReadByte()
    {
        if( m_position + sizeof( uint8_t ) > m_data.size() )
            throw std::out_of_range( "ALTIUM_BINARY_READER: out of range" );
 
        uint8_t value = *reinterpret_cast<const uint8_t*>( &m_data[m_position] );
        m_position += sizeof( uint8_t );
        return value;
    }
 
    std::string ReadShortPascalString()
    {
        uint8_t length = ReadByte();
 
        if( m_position + length > m_data.size() )
            throw std::out_of_range( "ALTIUM_BINARY_READER: out of range" );
 
        std::string pascalString( &m_data[m_position], &m_data[m_position + length] );
        m_position += length;
        return pascalString;
    }
 
    std::string ReadFullPascalString()
    {
        uint32_t length = ReadInt32();
 
        if( m_position + length > m_data.size() )
            throw std::out_of_range( "ALTIUM_BINARY_READER: out of range" );
 
        std::string pascalString( &m_data[m_position], &m_data[m_position + length] );
        m_position += length;
        return pascalString;
    }
 
private:
    const std::string& m_data;
    size_t             m_position;
};
 
class ALTIUM_COMPRESSED_READER : public ALTIUM_BINARY_READER
{
public:
    ALTIUM_COMPRESSED_READER( const std::string& aData ) :
            ALTIUM_BINARY_READER( aData )
    {}
 
    std::pair<int, std::string*> ReadCompressedString()
    {
        std::string* result;
        int id = -1;
 
        uint8_t byte = ReadByte();
 
        if( byte != 0xD0 )
            throw std::runtime_error( "ALTIUM_COMPRESSED_READER: invalid compressed string" );
 
        std::string str = ReadShortPascalString();
        std::from_chars( str.data(), str.data() + str.size(), id );
 
        std::string data = ReadFullPascalString();
        result = decompressData( data );
 
        return std::make_pair( id, result );
    }
 
private:
    std::string decompressedData;
 
    std::string* decompressData( std::string& aData )
    {
        // Create a memory input stream with the buffer
        wxMemoryInputStream memStream( (void*) aData.data(), aData.length() );
 
        // Create a zlib input stream with the memory input stream
        wxZlibInputStream zStream( memStream );
 
        // Read decompressed data from the zlib input stream
        while( !zStream.Eof() )
        {
            char buffer[1024];
            zStream.Read( buffer, sizeof( buffer ) );
            size_t bytesRead = zStream.LastRead();
            decompressedData.append( buffer, bytesRead );
        }
 
        return &decompressedData;
    }
};