diptrace_binary_reader.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
 */
 
#ifndef DIPTRACE_BINARY_READER_H
#define DIPTRACE_BINARY_READER_H
 
#include <cstddef>
#include <cstdint>
#include <vector>
 
#include <wx/string.h>
 
 
namespace DIPTRACE
{
 
enum class STRING_ENCODING
{
    BY_VERSION,
    LEGACY_ASCII,
    UTF16_BE
};

constexpr int INT3_BIAS = 1000000;

constexpr int INT4_BIAS = 1000000000;

constexpr double DIPTRACE_COORD_TO_MM = 1.0 / 30000.0;

constexpr double DIPTRACE_ANGLE_TO_DEG = 0.00001;

constexpr int LEGACY_STRING_VERSION = 37;

constexpr int MAX_STRING_CHARS = 10000;
 

class BINARY_READER
{
public:
    BINARY_READER( const wxString& aFileName );
 
    ~BINARY_READER();
 
    // -- Position management -------------------------------------------------

    size_t GetOffset() const { return m_offset; }

    void SetOffset( size_t aOffset );

    void Skip( size_t aBytes );

    size_t GetFileSize() const { return m_data.size(); }

    bool IsEOF() const { return m_offset >= m_data.size(); }

    const uint8_t* GetData() const { return m_data.data(); }
 
    // -- Version management --------------------------------------------------

    void SetVersion( int aVersion ) { m_version = aVersion; }

    int GetVersion() const { return m_version; }

    void SetStringEncoding( STRING_ENCODING aEncoding ) { m_stringEncoding = aEncoding; }

    void DetectStringEncoding( size_t aProbeOffset );
 
    // -- Primitive readers ---------------------------------------------------

    uint8_t ReadByte();

    int ReadInt3();

    int ReadInt4();

    wxString ReadString();

    void ReadColor( uint8_t& r, uint8_t& g, uint8_t& b );

    void ReadBytes( uint8_t* aDst, size_t aCount );
 
    // -- Peek methods (do not advance position) ------------------------------

    int PeekInt3() const;

    int PeekInt4() const;

    uint8_t PeekByte() const;
 
    // -- Coordinate conversion helpers ---------------------------------------

    static int DipTraceToKiCadNm( int aDipTraceCoord );

    static double DipTraceToMM( int aDipTraceCoord );
 
    // -- Search helpers ------------------------------------------------------

    size_t FindPattern( const uint8_t* aPattern, size_t aPatternLen,
                        size_t aStart, size_t aEnd ) const;

    size_t FindString( const wxString& aStr, size_t aStart, size_t aEnd ) const;
 
    // -- Try-read methods (return false instead of throwing) ------------------

    bool TryReadString( wxString& aResult );
 
private:
    wxString ReadStringUTF16();

    wxString ReadStringASCII();

    bool TryReadStringUTF16( wxString& aResult );

    bool TryReadStringASCII( wxString& aResult );

    static bool IsPrintableString( const wxString& aStr );

    void ThrowEOFError( size_t aBytesNeeded ) const;
 
    std::vector<uint8_t> m_data;      
    size_t               m_offset;    
    int                  m_version;   
    STRING_ENCODING      m_stringEncoding; 
};
 
} // namespace DIPTRACE
 
#endif // DIPTRACE_BINARY_READER_H