mirror of
https://gitlab.com/kicad/code/kicad.git
synced 2025-09-15 02:33:15 +02:00
8297ab24e4
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.
67 lines
2.2 KiB
C++
67 lines
2.2 KiB
C++
/*
|
|
* 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
|
|
*/
|
|
|
|
|
|
#ifndef QA_PCBNEW_UTILS_BOARD_FILE_UTILS__H
|
|
#define QA_PCBNEW_UTILS_BOARD_FILE_UTILS__H
|
|
|
|
#include <memory>
|
|
#include <string>
|
|
|
|
class BOARD;
|
|
class BOARD_ITEM;
|
|
|
|
/**
|
|
* @file board_file_utils.h
|
|
* General utilities for PCB file IO for QA programs
|
|
*/
|
|
namespace KI_TEST
|
|
{
|
|
/**
|
|
* Utility function to simply write a Board out to a file.
|
|
*
|
|
* Helps debug tests and utility programs by making it easy to quickly
|
|
* write to disk without directly using the PCB_IO API.
|
|
*
|
|
* Note: The aBoard param is non-const because PCB_IO::Save demands it
|
|
* and I am not confident a const_cast will be a true assurance.
|
|
*
|
|
* @param aBoard the board to write out
|
|
* @param aFilename the filename to write to
|
|
*/
|
|
void DumpBoardToFile( BOARD& aBoard, const std::string& aFilename );
|
|
|
|
/**
|
|
* Utility function to read a #BOARD_ITEM (probably a #MODULE or a #BOARD)
|
|
* from a file.
|
|
*
|
|
* Helps when writing tests or utilities that can be fed an external file.
|
|
*
|
|
* @param aFilename the file to read in
|
|
* @returns a new #BOARD_ITEM, which is nullptr if the read or parse failed.
|
|
*/
|
|
std::unique_ptr<BOARD_ITEM> ReadBoardItemFromFile( const std::string& aFilename );
|
|
|
|
} // namespace KI_TEST
|
|
|
|
#endif // QA_PCBNEW_UTILS_BOARD_FILE_UTILS__H
|