KiCad PCB EDA Suite
Loading...
Searching...
No Matches
board_file_utils.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <https://www.gnu.org/licenses/>.
18 */
19
20#pragma once
21
22#include <filesystem>
23#include <iostream>
24#include <memory>
25#include <string>
26
27#include <wx/string.h>
28
29class BOARD;
30class BOARD_ITEM;
31class FOOTPRINT;
32
37namespace KI_TEST
38{
42std::string GetPcbnewTestDataDir();
43
56void DumpBoardToFile( BOARD& aBoard, const std::filesystem::path& aFilename );
57
61void DumpFootprintToFile( const FOOTPRINT& aFootprint, const std::filesystem::path& aLibraryPath );
62
72std::unique_ptr<BOARD_ITEM> ReadBoardItemFromStream( std::istream& aStream );
73
80template <typename ITEM> std::unique_ptr<ITEM> ReadItemFromStream( std::istream& aStream )
81{
82 auto bi_ptr = ReadBoardItemFromStream( aStream );
83 std::unique_ptr<ITEM> downcast_ptr;
84
85 // if it's the right type, downcast and "steal" (and we'll return ownership)
86 ITEM* const tmp = dynamic_cast<ITEM*>( bi_ptr.get() );
87 if( tmp != nullptr )
88 {
89 bi_ptr.release();
90 downcast_ptr.reset( tmp );
91 }
92
93 return downcast_ptr;
94}
95
103std::unique_ptr<BOARD> ReadBoardFromFileOrStream( const std::string& aFilename,
104 std::istream& aFallback = std::cin );
105
106std::unique_ptr<BOARD> ReadBoardFromFile( const std::filesystem::path& aFilename );
107
114std::unique_ptr<BOARD> RequireBoardFromPcbnewQAData( const std::filesystem::path& aFilename );
115
128std::unique_ptr<FOOTPRINT> ReadFootprintFromFile( const std::filesystem::path& aFilename,
129 const wxString& aFootprintName );
130
131} // namespace KI_TEST
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition board_item.h:99
Information pertinent to a Pcbnew printed circuit board.
Definition board.h:411
Test utilities for timestamps.
std::unique_ptr< BOARD > ReadBoardFromFile(const std::filesystem::path &aFilename)
std::string GetPcbnewTestDataDir()
Utility which returns a path to the data directory where the test board files are stored.
void DumpFootprintToFile(const FOOTPRINT &aFootprint, const std::filesystem::path &aLibraryPath)
Same as DumpBoardToFile, but for footprints.
std::unique_ptr< BOARD > RequireBoardFromPcbnewQAData(const std::filesystem::path &aFilename)
Require a board from the path relative to the pcbnew QA data directory.
std::unique_ptr< ITEM > ReadItemFromStream(std::istream &aStream)
Read a specific kind of BOARD_ITEM from a stream.
std::unique_ptr< BOARD > ReadBoardFromFileOrStream(const std::string &aFilename, std::istream &aFallback)
Read a board from a file, or another stream, as appropriate.
std::unique_ptr< FOOTPRINT > ReadFootprintFromFile(const std::filesystem::path &aFilename, const wxString &aFootprintName)
Read a footprint object aFootprintName from aFileName.
void DumpBoardToFile(BOARD &board, const std::filesystem::path &aFilename)
Utility function to simply write a Board out to a file.
std::unique_ptr< BOARD_ITEM > ReadBoardItemFromStream(std::istream &aStream)
Utility function to read a BOARD_ITEM (probably a FOOTPRINT or a BOARD) from a file.