pads_sdb.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * 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, 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
 */
 
#pragma once
 
#include <cstdint>
#include <vector>
 
#include <wx/string.h>
 
#include <io/pads/pads_binary_utils.h>
 
namespace PADS_IO
{


struct SDB_SECTION
{
    int      index = 0;
    uint32_t count = 0;
    uint32_t totalBytes = 0;
    uint32_t stride = 0;
 
    uint32_t physicalOffset = 0;
    uint32_t physicalBytes = 0;
    uint32_t physicalCount = 0;
    uint32_t physicalLiveCount = 0;
 
    bool     IsEmpty() const { return totalBytes == 0; }
};

class SDB_COORDS
{
public:
    int32_t OriginX() const { return m_originX; }
    int32_t OriginY() const { return m_originY; }
    bool    Found() const { return m_found; }
 
    int32_t DesignX( int32_t aRaw ) const { return aRaw - m_originX; }
    int32_t DesignY( int32_t aRaw ) const { return aRaw - m_originY; }

    uint32_t HeaderBase() const { return m_headerBase; }
 
private:
    friend class PADS_SDB;
 
    int32_t  m_originX = 0;
    int32_t  m_originY = 0;
    bool     m_found = false;
    uint32_t m_headerBase = 0;
};

class PADS_SDB
{
public:
    PADS_SDB() = default;
 
    PADS_SDB( const PADS_SDB& ) = delete;
    PADS_SDB& operator=( const PADS_SDB& ) = delete;

    void Load( std::vector<uint8_t> aBytes );

    static bool HasMagic( const std::vector<uint8_t>& aBytes );
 
    static bool IsSupportedVersion( uint16_t aVersion );
 
    uint16_t                    Version() const { return m_version; }
    bool                        IsOldFormat() const { return m_version <= 0x2022; }
    const std::vector<uint8_t>& Bytes() const { return m_data; }
    const BINARY_CURSOR&        Cursor() const { return m_cursor; }
    const SDB_COORDS&           Coords() const { return m_coords; }
 
    size_t             SectionCount() const { return m_sections.size(); }
    const SDB_SECTION* Section( int aIndex ) const;

    SDB_RECORD RecordAt( uint32_t aBase ) const { return SDB_RECORD( m_cursor, aBase ); }
 
private:
    void parseHeader();
    void parseDirectory();
    void parsePhysicalFraming();
    void verifyFooter() const;
    void readBoardSetup();
    int  directoryEntryCount() const;
 
    static constexpr uint8_t MAGIC0 = 0x00;
    static constexpr uint8_t MAGIC1 = 0xFF;
    static constexpr int     HEADER_SIZE = 10;
    static constexpr int     FOOTER_SIZE = 42;
    static constexpr int     DIR_ENTRY_SIZE = 16;

    static constexpr int     VIEW_STATE_RECORD_BYTES = 48;
 
    std::vector<uint8_t> m_data;
 
    // Declared after m_data so the bound reference targets a live buffer.
    BINARY_CURSOR m_cursor{ m_data };
 
    uint16_t                 m_version = 0;
    std::vector<SDB_SECTION> m_sections;
    SDB_COORDS               m_coords;
};
 
} // namespace PADS_IO