allegro_parser.h

Go to the documentation of this file.

/*
* This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright Quilter
 * 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 3
 * 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 <memory>
 
#include <convert/allegro_db.h>
#include <convert/allegro_stream.h>
#include <convert/allegro_pcb_structs.h>
 
#include <progress_reporter.h>
 
namespace ALLEGRO
{
 

class HEADER_PARSER
{
public:
    HEADER_PARSER( FILE_STREAM& aStream ) :
            m_stream( aStream ),
            m_fmtVer( FMT_VER::V_UNKNOWN )
    {
    }
 
    std::unique_ptr<FILE_HEADER> ParseHeader();

    FMT_VER GetFormatVersion() const { return m_fmtVer; }

    static FMT_VER FormatFromMagic( uint32_t aMagic );
 
private:
    FILE_STREAM& m_stream;
    FMT_VER      m_fmtVer;
};
 

class BLOCK_PARSER
{
public:
    BLOCK_PARSER( FILE_STREAM& aStream, FMT_VER aVer, size_t aX27End = 0 ) :
            m_stream( aStream ),
            m_ver( aVer ),
            m_x27_end( aX27End )
    {
    }

    std::unique_ptr<BLOCK_BASE> ParseBlock( bool& aEndOfObjectsMarker );
 
private:
    FILE_STREAM&  m_stream;
    const FMT_VER m_ver;

    const size_t m_x27_end;
};
 

class PARSER
{
public:
    PARSER( FILE_STREAM& aStream, PROGRESS_REPORTER* aProgressReporter ) :
        m_stream( aStream ),
        m_progressReporter( aProgressReporter )
    {
    }

    void EndAtUnknownBlock( bool aEndAtUnknownBlock )
    {
        m_endAtUnknownBlock = aEndAtUnknownBlock;
    }
 
    std::unique_ptr<BRD_DB> Parse();
 
private:
    void readObjects( BRD_DB& aDb );
 
    FILE_STREAM& m_stream;
 
    bool               m_endAtUnknownBlock = false;
    PROGRESS_REPORTER* m_progressReporter = nullptr;
};
 
} // namespace ALLEGRO