drc_report.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The 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 3 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, see <https://www.gnu.org/licenses/>.
 */
 
#include "drc_report.h"
#include "eda_item.h"
 
#include <fstream>
 
#include <wx/string.h>
 
#include <board.h>
#include <board_design_settings.h>
#include <build_version.h>
#include <drc/drc_item.h>
#include <locale_io.h>
#include <widgets/wx_data_view_hyperlink_renderer.h>
#include <macros.h>
#include <json_common.h>
#include <rc_json_schema.h>
#include <string_utils.h>
#include <widgets/report_severity.h>
 
 
DRC_REPORT::DRC_REPORT( BOARD* aBoard, EDA_UNITS aReportUnits,
                        std::shared_ptr<RC_ITEMS_PROVIDER> aMarkersProvider,
                        std::shared_ptr<RC_ITEMS_PROVIDER> aRatsnestProvider,
                        std::shared_ptr<RC_ITEMS_PROVIDER> aFpWarningsProvider) :
        m_board( aBoard ),
        m_reportUnits( aReportUnits ),
        m_markersProvider( std::move( aMarkersProvider ) ),
        m_ratsnestProvider( std::move( aRatsnestProvider ) ),
        m_fpWarningsProvider( std::move( aFpWarningsProvider ) ),
        m_reportedSeverities( 0 )
{
    if( m_markersProvider )
        m_reportedSeverities = m_markersProvider->GetSeverities();
}
 
 
bool DRC_REPORT::WriteTextReport( const wxString& aFullFileName )
{
    // We need the global LOCALE_IO here in order to
    // write the report in the c-locale.
    LOCALE_IO locale;
    FILE*     fp = wxFopen( aFullFileName, wxT( "w" ) );
 
    if( fp == nullptr )
        return false;
 
    UNITS_PROVIDER         unitsProvider( pcbIUScale, m_reportUnits );
    BOARD_DESIGN_SETTINGS& bds = m_board->GetDesignSettings();
    BOARD_RC_ITEM_RESOLVER itemResolver( *m_board );
    int                    count = 0;
 
    wxFileName fn( m_board->GetFileName() );
    fprintf( fp, "** Drc report for %s **\n", TO_UTF8( fn.GetFullName() ) );
 
    fprintf( fp, "** Created on %s **\n", TO_UTF8( GetISO8601CurrentDateTime() ) );
 
    fprintf( fp, "** Report includes: %s **\n", TO_UTF8( formatSeverities( m_reportedSeverities ) ) );
 
    count = m_markersProvider->GetCount();
 
    fprintf( fp, "\n** Found %d DRC violations **\n", count );
 
    for( int i = 0; i < count; ++i )
    {
        const std::shared_ptr<RC_ITEM>& item = m_markersProvider->GetItem( i );
        SEVERITY                        severity = item->GetParent()->GetSeverity();
 
        if( severity == RPT_SEVERITY_EXCLUSION )
            severity = bds.GetSeverity( item->GetErrorCode() );
 
        fprintf( fp, "%s", TO_UTF8( item->ShowReport( &unitsProvider, severity, itemResolver ) ) );
    }
 
    count = m_ratsnestProvider->GetCount();
 
    fprintf( fp, "\n** Found %d unconnected pads **\n", count );
 
    for( int i = 0; i < count; ++i )
    {
        const std::shared_ptr<RC_ITEM>& item = m_ratsnestProvider->GetItem( i );
        SEVERITY                        severity = bds.GetSeverity( item->GetErrorCode() );
 
        fprintf( fp, "%s", TO_UTF8( item->ShowReport( &unitsProvider, severity, itemResolver ) ) );
    }
 
    count = m_fpWarningsProvider->GetCount();
 
    fprintf( fp, "\n** Found %d Footprint errors **\n", count );
 
    for( int i = 0; i < count; ++i )
    {
        const std::shared_ptr<RC_ITEM>& item = m_fpWarningsProvider->GetItem( i );
        SEVERITY                        severity = bds.GetSeverity( item->GetErrorCode() );
 
        fprintf( fp, "%s", TO_UTF8( item->ShowReport( &unitsProvider, severity, itemResolver ) ) );
    }
 
    fprintf( fp, "\n** Ignored checks **\n" );
 
    bool hasIgnored = false;
 
    for( const std::reference_wrapper<RC_ITEM>& item : DRC_ITEM::GetItemsWithSeverities() )
    {
        int code = item.get().GetErrorCode();
 
        if( code > 0 && bds.Ignore( code ) )
        {
            fprintf( fp, "    - %s\n", TO_UTF8( HYPERLINK_DV_RENDERER::StripMarkup( item.get().GetErrorMessage( false ) ) ) );
            hasIgnored = true;
        }
    }
 
    if( !hasIgnored )
        fprintf( fp, "    - %s\n", TO_UTF8( _( "None" ) ) );
 
    fprintf( fp, "\n** End of Report **\n" );
 
    fclose( fp );
 
    return true;
}
 
 
bool DRC_REPORT::WriteJsonReport( const wxString& aFullFileName )
{
    std::ofstream jsonFileStream( aFullFileName.fn_str() );
 
    UNITS_PROVIDER         unitsProvider( pcbIUScale, m_reportUnits );
    BOARD_DESIGN_SETTINGS& bds = m_board->GetDesignSettings();
    BOARD_RC_ITEM_RESOLVER itemResolver( *m_board );
 
    RC_JSON::DRC_REPORT reportHead;
 
    wxFileName fn( m_board->GetFileName() );
    reportHead.$schema = "https://schemas.kicad.org/drc.v1.json";
    reportHead.source = fn.GetFullName();
    reportHead.date = GetISO8601CurrentDateTime();
    reportHead.kicad_version = GetMajorMinorPatchVersion();
    reportHead.coordinate_units = EDA_UNIT_UTILS::GetLabel( m_reportUnits );
 
    // Document which severities are included in this report
    if( m_reportedSeverities & RPT_SEVERITY_ERROR )
        reportHead.included_severities.push_back( wxS( "error" ) );
 
    if( m_reportedSeverities & RPT_SEVERITY_WARNING )
        reportHead.included_severities.push_back( wxS( "warning" ) );
 
    if( m_reportedSeverities & RPT_SEVERITY_EXCLUSION )
        reportHead.included_severities.push_back( wxS( "exclusion" ) );
 
    for( int i = 0; i < m_markersProvider->GetCount(); ++i )
    {
        const std::shared_ptr<RC_ITEM>& item = m_markersProvider->GetItem( i );
        SEVERITY                        severity = item->GetParent()->GetSeverity();
 
        if( severity == RPT_SEVERITY_EXCLUSION )
            severity = bds.GetSeverity( item->GetErrorCode() );
 
        RC_JSON::VIOLATION violation;
        item->GetJsonViolation( violation, &unitsProvider, severity, itemResolver );
 
        reportHead.violations.push_back( violation );
    }
 
    for( int i = 0; i < m_ratsnestProvider->GetCount(); ++i )
    {
        const std::shared_ptr<RC_ITEM>& item = m_ratsnestProvider->GetItem( i );
        SEVERITY                        severity = bds.GetSeverity( item->GetErrorCode() );
 
        RC_JSON::VIOLATION violation;
        item->GetJsonViolation( violation, &unitsProvider, severity, itemResolver );
 
        reportHead.unconnected_items.push_back( violation );
    }
 
 
    for( int i = 0; i < m_fpWarningsProvider->GetCount(); ++i )
    {
        const std::shared_ptr<RC_ITEM>& item = m_fpWarningsProvider->GetItem( i );
        SEVERITY                        severity = bds.GetSeverity( item->GetErrorCode() );
 
        RC_JSON::VIOLATION violation;
        item->GetJsonViolation( violation, &unitsProvider, severity, itemResolver );
 
        reportHead.schematic_parity.push_back( violation );
    }
 
    for( const std::reference_wrapper<RC_ITEM>& item : DRC_ITEM::GetItemsWithSeverities() )
    {
        int code = item.get().GetErrorCode();
 
        if( code > 0 && bds.Ignore( code ) )
        {
            RC_JSON::IGNORED_CHECK ignoredCheck;
            ignoredCheck.key = item.get().GetSettingsKey();
            ignoredCheck.description = HYPERLINK_DV_RENDERER::StripMarkup( item.get().GetErrorMessage( false ) );
            reportHead.ignored_checks.push_back( ignoredCheck );
        }
    }
 
    nlohmann::json saveJson = nlohmann::json( reportHead );
    jsonFileStream << std::setw( 4 ) << saveJson << std::endl;
    jsonFileStream.flush();
    jsonFileStream.close();
 
    return true;
}