KiCad PCB EDA Suite
board_file_utils.cpp
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 
25 
26 // For PCB parsing
29 #include <richio.h>
30 
31 #include <board.h>
32 
34 
35 namespace KI_TEST
36 {
37 
38 #ifndef QA_PCBNEW_DATA_LOCATION
39  #define QA_PCBNEW_DATA_LOCATION "???"
40 #endif
41 
42 std::string GetPcbnewTestDataDir()
43 {
44  const char* env = std::getenv( "KICAD_TEST_PCBNEW_DATA_DIR" );
45  std::string fn;
46 
47  if( !env )
48  {
49  // Use the compiled-in location of the data dir (i.e. where the files were at build time)
51  }
52  else
53  {
54  // Use whatever was given in the env var
55  fn = env;
56  }
57 
58  // Ensure the string ends in / to force a directory interpretation
59  fn += "/";
60 
61  return fn;
62 }
63 
64 
65 void DumpBoardToFile( BOARD& board, const std::string& aFilename )
66 {
67  PCB_IO io;
68  io.Save( aFilename, &board );
69 }
70 
71 
72 std::unique_ptr<BOARD_ITEM> ReadBoardItemFromFile( const std::string& aFilename )
73 {
74  FILE_LINE_READER reader( aFilename );
75 
76  PCB_PARSER parser;
77  parser.SetLineReader( &reader );
78 
79  return std::unique_ptr<BOARD_ITEM>( parser.Parse() );
80 }
81 
82 
83 std::unique_ptr<BOARD_ITEM> ReadBoardItemFromStream( std::istream& aStream )
84 {
85  // Take input from stdin
87  reader.SetStream( aStream );
88 
89  PCB_PARSER parser;
90 
91  parser.SetLineReader( &reader );
92 
93  std::unique_ptr<BOARD_ITEM> board;
94 
95  try
96  {
97  board.reset( parser.Parse() );
98  }
99  catch( const IO_ERROR& )
100  {
101  }
102 
103  return board;
104 }
105 
106 
107 std::unique_ptr<BOARD> ReadBoardFromFileOrStream( const std::string& aFilename,
108  std::istream& aFallback )
109 {
110  std::istream* in_stream = nullptr;
111  std::ifstream file_stream;
112 
113  if( aFilename.empty() )
114  {
115  // no file, read stdin
116  in_stream = &aFallback;
117  }
118  else
119  {
120  file_stream.open( aFilename );
121  in_stream = &file_stream;
122  }
123 
124  return ReadItemFromStream<BOARD>( *in_stream );
125 }
126 
127 
128 
129 } // namespace KI_TEST
A PLUGIN derivation for saving and loading Pcbnew s-expression formatted files.
Read a Pcbnew s-expression formatted LINE_READER object and returns the appropriate BOARD_ITEM object...
Definition: pcb_parser.h:71
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.
std::unique_ptr< BOARD_ITEM > ReadBoardItemFromFile(const std::string &aFilename)
A LINE_READER that reads from an open file.
Definition: richio.h:172
void SetStream(std::istream &aStream)
Set the stream for this line reader.
LINE_READER that wraps a given std::istream instance.
void DumpBoardToFile(BOARD &board, const std::string &aFilename)
Utility function to simply write a Board out to a file.
BOARD_ITEM * Parse()
Definition: pcb_parser.cpp:626
LINE_READER * SetLineReader(LINE_READER *aReader)
Set aLineReader into the parser, and returns the previous one, if any.
Definition: pcb_parser.h:94
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:190
virtual void Save(const wxString &aFileName, BOARD *aBoard, const PROPERTIES *aProperties=nullptr) override
Write aBoard to a storage file in a format that this PLUGIN implementation knows about or it can be u...
Pcbnew s-expression file format parser definition.
General utilities for PCB file IO for QA programs.
std::unique_ptr< BOARD > ReadBoardFromFileOrStream(const std::string &aFilename, std::istream &aFallback)
Read a board from a file, or another stream, as appropriate.
#define QA_PCBNEW_DATA_LOCATION
std::string GetPcbnewTestDataDir()
Utility which returns a path to the data directory where the test board files are stored.
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:75