board_file_utils.cpp

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/>.
 */
 
#include <boost/test/tools/context.hpp>
#include <memory>
 
#include <boost/test/unit_test.hpp>
 
#include <pcbnew_utils/board_file_utils.h>
 
// For PCB parsing
#include <pcb_io/kicad_sexpr/pcb_io_kicad_sexpr.h>
#include <pcb_io/kicad_sexpr/pcb_io_kicad_sexpr_parser.h>
#include <richio.h>
#include <board.h>
#include <footprint.h>
 
#include <qa_utils/stdstream_line_reader.h>
 
namespace KI_TEST
{
 
#ifndef QA_PCBNEW_DATA_LOCATION
    #define QA_PCBNEW_DATA_LOCATION "???"
#endif
 
std::string GetPcbnewTestDataDir()
{
    const char* env = std::getenv( "KICAD_TEST_PCBNEW_DATA_DIR" );
    std::string fn;
 
    if( !env )
    {
        // Use the compiled-in location of the data dir (i.e. where the files were at build time)
        fn = QA_PCBNEW_DATA_LOCATION;
    }
    else
    {
        // Use whatever was given in the env var
        fn = env;
    }
 
    // Ensure the string ends in / to force a directory interpretation
    fn += "/";
 
    return fn;
}
 
 
void DumpBoardToFile( BOARD& board, const std::filesystem::path& aFilename )
{
    PCB_IO_KICAD_SEXPR io;
    io.SaveBoard( aFilename.string(), board );
}
 
 
std::unique_ptr<BOARD_ITEM> ReadBoardItemFromStream( std::istream& aStream )
{
    // Take input from stdin
    STDISTREAM_LINE_READER reader;
    reader.SetStream( aStream );
 
    PCB_IO_KICAD_SEXPR_PARSER                  parser( &reader, nullptr, nullptr );
    std::unique_ptr<BOARD_ITEM> board;
 
    try
    {
        board.reset( parser.Parse() );
    }
    catch( const IO_ERROR& e )
    {
        throw e;
    }
 
    return board;
}
 
 
std::unique_ptr<BOARD> ReadBoardFromFileOrStream( const std::string& aFilename,
                                                  std::istream&      aFallback )
{
    std::istream* in_stream = nullptr;
    std::ifstream file_stream;
 
    if( aFilename.empty() )
    {
        // no file, read stdin
        in_stream = &aFallback;
    }
    else
    {
        file_stream.open( aFilename );
 
        if( !file_stream.is_open() )
        {
            return nullptr;
        }
 
        in_stream = &file_stream;
    }
 
    return ReadItemFromStream<BOARD>( *in_stream );
}
 
 
std::unique_ptr<BOARD> ReadBoardFromFile( const std::filesystem::path& aFilename )
{
    return ReadBoardFromFileOrStream( aFilename.string() );
}
 
 
std::unique_ptr<BOARD> RequireBoardFromPcbnewQAData( const std::filesystem::path& aFilename )
{
    std::unique_ptr<BOARD> board;
 
    // Make it really clear in the test context which board is being loaded
    BOOST_TEST_CONTEXT( "Loading board " << aFilename )
    {
        board = ReadBoardFromFile( KI_TEST::GetPcbnewTestDataDir() + aFilename.string() );
 
        BOOST_REQUIRE( board );
    }
 
    return board;
}
 
 
std::unique_ptr<FOOTPRINT> ReadFootprintFromFileOrStream( const std::string& aFilename,
                                                          std::istream& aFallback )
{
    std::istream* in_stream = nullptr;
    std::ifstream file_stream;
 
    if( aFilename.empty() )
    {
        // no file, read stdin
        in_stream = &aFallback;
    }
    else
    {
        file_stream.open( aFilename );
 
        if( !file_stream.is_open() )
        {
            return nullptr;
        }
 
        in_stream = &file_stream;
    }
 
    return ReadItemFromStream<FOOTPRINT>( *in_stream );
}
 
 
std::unique_ptr<FOOTPRINT> ReadFootprintFromFile( const std::filesystem::path& aFilename )
{
    return ReadFootprintFromFileOrStream( aFilename.string() );
}
 
 
void DumpFootprintToFile( const FOOTPRINT& aFootprint, const std::filesystem::path& aLibraryPath )
{
    PCB_IO_KICAD_SEXPR io;
    io.FootprintSave( aLibraryPath.string(), &aFootprint, nullptr );
}
 
 
} // namespace KI_TEST