KiCad PCB EDA Suite
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 (C) 2019 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, you may find one here:
18 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19 * or you may search the http://www.gnu.org website for the version 2 license,
20 * or you may write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22 */
23
24
25#ifndef QA_PCBNEW_UTILS_BOARD_FILE_UTILS__H
26#define QA_PCBNEW_UTILS_BOARD_FILE_UTILS__H
27
28#include <iostream>
29#include <memory>
30#include <string>
31
32class BOARD;
33class BOARD_ITEM;
34
39namespace KI_TEST
40{
44std::string GetPcbnewTestDataDir();
45
58void DumpBoardToFile( BOARD& aBoard, const std::string& aFilename );
59
69std::unique_ptr<BOARD_ITEM> ReadBoardItemFromStream( std::istream& aStream );
70
77template <typename ITEM> std::unique_ptr<ITEM> ReadItemFromStream( std::istream& aStream )
78{
79 auto bi_ptr = ReadBoardItemFromStream( aStream );
80 std::unique_ptr<ITEM> downcast_ptr;
81
82 // if it's the right type, downcast and "steal" (and we'll return ownership)
83 ITEM* const tmp = dynamic_cast<ITEM*>( bi_ptr.get() );
84 if( tmp != nullptr )
85 {
86 bi_ptr.release();
87 downcast_ptr.reset( tmp );
88 }
89
90 return downcast_ptr;
91}
92
100std::unique_ptr<BOARD> ReadBoardFromFileOrStream( const std::string& aFilename,
101 std::istream& aFallback = std::cin );
102
103} // namespace KI_TEST
104
105#endif // QA_PCBNEW_UTILS_BOARD_FILE_UTILS__H
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:53
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:240
std::string GetPcbnewTestDataDir()
Utility which returns a path to the data directory where the test board files are stored.
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.
void DumpBoardToFile(BOARD &board, const std::string &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.