board_file_utils.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, see <https://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include <filesystem>
#include <iostream>
#include <memory>
#include <string>
 
class BOARD;
class BOARD_ITEM;
class FOOTPRINT;

namespace KI_TEST
{
std::string GetPcbnewTestDataDir();

void DumpBoardToFile( BOARD& aBoard, const std::filesystem::path& aFilename );

void DumpFootprintToFile( const FOOTPRINT& aFootprint, const std::filesystem::path& aLibraryPath );

std::unique_ptr<BOARD_ITEM> ReadBoardItemFromStream( std::istream& aStream );

template <typename ITEM> std::unique_ptr<ITEM> ReadItemFromStream( std::istream& aStream )
{
    auto                  bi_ptr = ReadBoardItemFromStream( aStream );
    std::unique_ptr<ITEM> downcast_ptr;
 
    // if it's the right type, downcast and "steal" (and we'll return ownership)
    ITEM* const tmp = dynamic_cast<ITEM*>( bi_ptr.get() );
    if( tmp != nullptr )
    {
        bi_ptr.release();
        downcast_ptr.reset( tmp );
    }
 
    return downcast_ptr;
}

std::unique_ptr<BOARD> ReadBoardFromFileOrStream( const std::string& aFilename,
                                                  std::istream& aFallback = std::cin );
 
std::unique_ptr<BOARD> ReadBoardFromFile( const std::filesystem::path& aFilename );

std::unique_ptr<BOARD> RequireBoardFromPcbnewQAData( const std::filesystem::path& aFilename );
 
std::unique_ptr<FOOTPRINT> ReadFootprintFromFileOrStream( const std::string& aFilename,
                                                          std::istream& aFallback = std::cin );
 
std::unique_ptr<FOOTPRINT> ReadFootprintFromFile( const std::filesystem::path& aFilename );
 
} // namespace KI_TEST