haskal
/
kicad
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
kicad/qa/pcbnew_utils/board_file_utils.cpp

100 lines
2.5 KiB
C++
Raw Normal View History

DRC: Break out courtyard overlap function Introduce the concept of a DRC_PROVIDER which allows to separate the various DRC functions to their own areas. This allows, amongst other things, a slimmer core DRC class, and allows DRC functions to be separately testable. The courtyard DRCs (overlap, missing and malformed) are the first victims, so instrumentation can be added to this function. Add some unit tests on this DRC function, as well a few re-usable PCB-based utility functions in a library (qa_pcbnew_utils) that could be shared between unit tests and other utilities.
2019-01-11 22:03:45 +00:00
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2019 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, you may find one here:
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
* or you may search the http://www.gnu.org website for the version 2 license,
* or you may write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#include <pcbnew_utils/board_file_utils.h>
// For PCB parsing
Cleanup: Move KiCad files into plugins folder
2020-10-05 18:38:40 +00:00
#include <plugins/kicad/kicad_plugin.h>
#include <plugins/kicad/pcb_parser.h>
DRC: Break out courtyard overlap function Introduce the concept of a DRC_PROVIDER which allows to separate the various DRC functions to their own areas. This allows, amongst other things, a slimmer core DRC class, and allows DRC functions to be separately testable. The courtyard DRCs (overlap, missing and malformed) are the first victims, so instrumentation can be added to this function. Add some unit tests on this DRC function, as well a few re-usable PCB-based utility functions in a library (qa_pcbnew_utils) that could be shared between unit tests and other utilities.
2019-01-11 22:03:45 +00:00
#include <richio.h>
#include <class_board.h>
QA: Tidy qa_utils headers Move into own include directory for clarity. Also allows qa_utils to use its own private headers in qa/qa_utils without exposing them through the target_include_directories directive.
2019-01-28 10:36:54 +00:00
#include <qa_utils/stdstream_line_reader.h>
QA: Centralise BOARD reading functions in pcbnew_utils Several pcbnew_tools utilities read a file from the command line. Instead of replicating this code, centralise the code in qa_pcbnew_utils, which allows simpler reuse. THe utilities are: * polygon_triangulation * polygon_generator * drc_tool pcb_parser keeps its own function, as that is the focus of the tool, and its likely to have its own instrumention. This also adds the ability to read from stdin for the above tools, which means fuzz testers could theoretically work with them, and it also can make life easier if you can pipe a board to the executable directly.
2019-01-24 14:56:55 +00:00
DRC: Break out courtyard overlap function Introduce the concept of a DRC_PROVIDER which allows to separate the various DRC functions to their own areas. This allows, amongst other things, a slimmer core DRC class, and allows DRC functions to be separately testable. The courtyard DRCs (overlap, missing and malformed) are the first victims, so instrumentation can be added to this function. Add some unit tests on this DRC function, as well a few re-usable PCB-based utility functions in a library (qa_pcbnew_utils) that could be shared between unit tests and other utilities.
2019-01-11 22:03:45 +00:00
namespace KI_TEST
{
void DumpBoardToFile( BOARD& board, const std::string& aFilename )
{
PCB_IO io;
io.Save( aFilename, &board );
}
std::unique_ptr<BOARD_ITEM> ReadBoardItemFromFile( const std::string& aFilename )
{
FILE_LINE_READER reader( aFilename );
PCB_PARSER parser;
parser.SetLineReader( &reader );
return std::unique_ptr<BOARD_ITEM>( parser.Parse() );
}
QA: Centralise BOARD reading functions in pcbnew_utils Several pcbnew_tools utilities read a file from the command line. Instead of replicating this code, centralise the code in qa_pcbnew_utils, which allows simpler reuse. THe utilities are: * polygon_triangulation * polygon_generator * drc_tool pcb_parser keeps its own function, as that is the focus of the tool, and its likely to have its own instrumention. This also adds the ability to read from stdin for the above tools, which means fuzz testers could theoretically work with them, and it also can make life easier if you can pipe a board to the executable directly.
2019-01-24 14:56:55 +00:00
std::unique_ptr<BOARD_ITEM> ReadBoardItemFromStream( std::istream& aStream )
{
// Take input from stdin
STDISTREAM_LINE_READER reader;
reader.SetStream( aStream );
PCB_PARSER parser;
parser.SetLineReader( &reader );
std::unique_ptr<BOARD_ITEM> board;
try
{
board.reset( parser.Parse() );
}
Remove all debugging output that cannot be disabled. The use of printf, wxLogDebug, and std::err/std::out causes excessive debugging output which makes finding specific debugging messages more difficult than it needs to be. There is still some debugging output in test code that really needs to be moved into a unit test. Add debugging output section to the coding policy regarding debugging output.
2020-08-18 14:17:16 +00:00
catch( const IO_ERROR& )
QA: Centralise BOARD reading functions in pcbnew_utils Several pcbnew_tools utilities read a file from the command line. Instead of replicating this code, centralise the code in qa_pcbnew_utils, which allows simpler reuse. THe utilities are: * polygon_triangulation * polygon_generator * drc_tool pcb_parser keeps its own function, as that is the focus of the tool, and its likely to have its own instrumention. This also adds the ability to read from stdin for the above tools, which means fuzz testers could theoretically work with them, and it also can make life easier if you can pipe a board to the executable directly.
2019-01-24 14:56:55 +00:00
{
}
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 );
in_stream = &file_stream;
}
return ReadItemFromStream<BOARD>( *in_stream );
}
Remove all debugging output that cannot be disabled. The use of printf, wxLogDebug, and std::err/std::out causes excessive debugging output which makes finding specific debugging messages more difficult than it needs to be. There is still some debugging output in test code that really needs to be moved into a unit test. Add debugging output section to the coding policy regarding debugging output.
2020-08-18 14:17:16 +00:00
} // namespace KI_TEST