kicad/qa/drc_proto/drc_test_provider_lvs.cpp

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2004-2020 KiCad Developers.
 *
 * 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 <class_board.h>
#include <class_track.h>
#include <common.h>

#include <drc_proto/drc_engine.h>
#include <drc_proto/drc_item.h>
#include <drc_proto/drc_rule.h>
#include <drc_proto/drc_test_provider.h>

#include <kiway.h>
#include <netlist_reader/pcb_netlist.h>

/*
    Layout-versus-schematic (LVS) test.

    Errors generated:
    - DRCE_MISSING_FOOTPRINT
    - DRCE_DUPLICATE_FOOTPRINT
    - DRCE_EXTRA_FOOTPRINT

    TODO:
    - cross-check PCB netlist against SCH netlist
    - cross-check PCB fields against SCH fields
*/

namespace test
{

class DRC_TEST_PROVIDER_LVS : public DRC_TEST_PROVIDER
{
public:
    DRC_TEST_PROVIDER_LVS()
    {
        m_isRuleDriven = false;
    }

    virtual ~DRC_TEST_PROVIDER_LVS()
    {
    }

    virtual bool Run() override;

    virtual const wxString GetName() const override
    {
        return "LVS";
    };

    virtual const wxString GetDescription() const override
    {
        return "Performs layout-vs-schematics integity check";
    }

    virtual std::set<test::DRC_CONSTRAINT_TYPE_T> GetMatchingConstraintIds() const override;

private:

    bool fetchNetlistFromSchematic( NETLIST& aNetlist );
    void testFootprints( NETLIST& aNetlist );
};

}; // namespace test


void test::DRC_TEST_PROVIDER_LVS::testFootprints( NETLIST& aNetlist )
{
    wxString msg;
    BOARD*   board = m_drcEngine->GetBoard();

    auto comp = []( const MODULE* x, const MODULE* y ) {
        return x->GetReference().CmpNoCase( y->GetReference() ) < 0;
    };

    auto mods = std::set<MODULE*, decltype( comp )>( comp );

    for( MODULE* mod : board->Modules() )
    {
        auto ins = mods.insert( mod );

        if( !ins.second )
        {
            std::shared_ptr<DRC_ITEM> drcItem = DRC_ITEM::Create( DRCE_DUPLICATE_FOOTPRINT );
            drcItem->SetItems( mod, *ins.first );

            ReportWithMarker( drcItem, mod->GetPosition() );

            if( isErrorLimitExceeded( DRCE_DUPLICATE_FOOTPRINT ) )
                break;
        }
    }

    // Search for component footprints in the netlist but not on the board.
    for( unsigned ii = 0; ii < aNetlist.GetCount(); ii++ )
    {
        COMPONENT* component = aNetlist.GetComponent( ii );
        MODULE*    module    = board->FindModuleByReference( component->GetReference() );

        if( module == nullptr )
        {
            msg.Printf( _( "Missing footprint %s (%s)" ), component->GetReference(),
                    component->GetValue() );

            std::shared_ptr<DRC_ITEM> drcItem = DRC_ITEM::Create( DRCE_MISSING_FOOTPRINT );

            drcItem->SetErrorMessage( msg );
            Report( drcItem );

            if( isErrorLimitExceeded( DRCE_MISSING_FOOTPRINT ) )
                break;
        }
    }


    for( auto module : mods )
    {
        COMPONENT* component = aNetlist.GetComponentByReference( module->GetReference() );

        if( component == NULL )
        {
            std::shared_ptr<DRC_ITEM> drcItem = DRC_ITEM::Create( DRCE_EXTRA_FOOTPRINT );

            drcItem->SetItems( module );
            ReportWithMarker( drcItem, module->GetPosition() );

            if( isErrorLimitExceeded( DRCE_EXTRA_FOOTPRINT ) )
                break;
        }
    }
}


bool test::DRC_TEST_PROVIDER_LVS::fetchNetlistFromSchematic( NETLIST& aNetlist )
{
    // fixme: make it work without dependency on EDIT_FRAME/kiway
#if 0
    std::string payload;

    Kiway().ExpressMail( FRAME_SCH, MAIL_SCH_GET_NETLIST, payload, nullptr );

    try
    {
        auto lineReader = new STRING_LINE_READER( payload, _( "Eeschema netlist" ) );
        KICAD_NETLIST_READER netlistReader( lineReader, &aNetlist );
        netlistReader.LoadNetlist();
    }
    catch( const IO_ERROR& )
    {
        assert( false ); // should never happen
        return false;
    }

#endif

    return false;
}

bool test::DRC_TEST_PROVIDER_LVS::Run()
{
    ReportStage( _( "Layout-vs-Schematic checks..." ), 0, 2 );

#if 0
       
    if ( !Kiface().IsSingle() )
    {
        NETLIST netlist; // fixme: fetch from schematic without referring directly to the FRAME

        if( ! fetchNetlistFromSchematic( netlist ) )
        {
            ReportAux( _( "Unable to fetch the schematic netlist. Skipping LVS checks. ") );
            return true;
        }
    
        testFootprints( netlist );
    }
#endif

    reportRuleStatistics();

    return true;
}


std::set<test::DRC_CONSTRAINT_TYPE_T> test::DRC_TEST_PROVIDER_LVS::GetMatchingConstraintIds() const
{
    return {};
}


namespace detail
{
static test::DRC_REGISTER_TEST_PROVIDER<test::DRC_TEST_PROVIDER_LVS> dummy;
}