allegro_block_tests.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 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, you may find one here:
 * http://www.gnu.org/licenses/gpl-3.0.html
 * or you may search the http://www.gnu.org website for the version 3 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 <functional>
#include <iomanip>
#include <vector>
 
#include <convert/allegro_db.h>
 
 
namespace KI_TEST
{
class BOARD_EXPECTATION_TEST;

struct HEADER_TEST_INFO
{
    std::string m_HeaderDataSource;
    bool m_Skip;
 
    friend std::ostream& operator<<( std::ostream& os, const HEADER_TEST_INFO& aTestInfo )
    {
        wxString descr = wxString::Format( "Header: %s", aTestInfo.m_HeaderDataSource );
        os << descr.ToStdString();
        return os;
    }
};

struct BLK_TEST_INFO
{
    uint8_t m_BlockType;
    size_t m_BlockOffset;
    bool m_Skip;
    std::string m_DataSource;
    std::function<void( const ALLEGRO::BLOCK_BASE& )> m_ValidateFunc;
 
    friend std::ostream& operator<<( std::ostream& os, const BLK_TEST_INFO& aTestInfo )
    {
        wxString msg = wxString::Format( "Block type %#02x at offset %#010zx", aTestInfo.m_BlockType,
                                         aTestInfo.m_BlockOffset );
        os << msg.ToStdString();
        return os;
    }
};
 
 
struct BOARD_TEST_DEF
{
    std::string m_BrdName;
    std::string m_FilePath;
    ALLEGRO::FMT_VER m_FormatVersion;
    // If there is a header test for this board, it will be stored here, else nullptr
    std::unique_ptr<HEADER_TEST_INFO> m_HeaderTest;
    // List of block tests for this board
    std::vector<BLK_TEST_INFO> m_BlockTests;
    // A KiCad board expectation test to run against the parsed board, or nullptr
    std::unique_ptr<BOARD_EXPECTATION_TEST> m_BrdExpectations;
};
 

extern void RunAdditionalBlockTest( const std::string& aBoardName, size_t aBlockOffset,
                                    const ALLEGRO::BLOCK_BASE& aBlock );

extern void RunAdditionalObjectTest( const std::string& aBoardName, size_t aBlockOffset,
                                     const ALLEGRO::DB_OBJ& aDbObj );
 
 
} // namespace KI_TEST