kicad/pcbnew/drc/drc_rule.cpp

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2020 KiCad Developers, see change_log.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 <fctsys.h>
#include <class_board.h>
#include <class_board_item.h>
#include <reporter.h>
#include <drc/drc_rule.h>
#include <drc/drc_engine.h>
#include <pcb_expr_evaluator.h>


const DRC_CONSTRAINT* GetConstraint( const BOARD_ITEM* aItem, const BOARD_ITEM* bItem,
                                     int aConstraint, PCB_LAYER_ID aLayer, wxString* aRuleName,
                                     REPORTER* aReporter )
{
    BOARD* board = aItem->GetBoard();

    if( !board )
        return nullptr;

    for( DRC_RULE* rule : board->GetDesignSettings().m_DRCRules )
    {
        if( aReporter )
        {
            aReporter->Report( wxString::Format( _( "Checking rule \"%s\"." ),
                                                 rule->m_Name ) );
        }

        if( !rule->m_LayerCondition.test( aLayer ) )
        {
            if( aReporter )
            {
                aReporter->Report( wxString::Format( _( "Rule layer \"%s\" not matched." ),
                                                     rule->m_LayerSource ) );
                aReporter->Report( "Rule not applied." );
            }

            continue;
        }

        const DRC_CONSTRAINT* constraint = nullptr;

        for( const DRC_CONSTRAINT& candidate : rule->m_Constraints )
        {
            if( candidate.m_Type == aConstraint )
            {
                constraint = &candidate;
                break;
            }
        }

        if( aReporter && !constraint )
        {
            aReporter->Report( _( "Rule contains no applicable constraints." ) );
            aReporter->Report( _( "Rule not applied." ) );
        }
        else
        {
            if( !rule->m_Condition )
            {
                if( aReporter )
                    aReporter->Report( _( "No condition found; rule not applied." ) );

                return nullptr;
            }

            if( aReporter )
            {
                aReporter->Report( wxString::Format( _( "Checking rule condition \"%s\"." ),
                                                     rule->m_Condition->GetExpression() ) );
            }

            if( rule->m_Condition->EvaluateFor( aItem, bItem, aLayer ) )
            {
                if( aReporter )
                    aReporter->Report( "Rule applied." );

                if( aRuleName )
                    *aRuleName = rule->m_Name;

                return constraint;
            }

            if( bItem && rule->m_Condition->EvaluateFor( bItem, aItem, aLayer ) )
            {
                if( aReporter )
                    aReporter->Report( "Rule applied." );

                if( aRuleName )
                    *aRuleName = rule->m_Name;

                return constraint;
            }

            if( aReporter )
                aReporter->Report( "Condition not satisfied; rule not applied." );
        }

        if( aReporter )
            aReporter->Report( "" );
    }

    return nullptr;
}


wxString DRC_CONSTRAINT::GetName() const
{
    if( m_parentRule )
        return wxString::Format( _( "rule %s" ), m_parentRule->m_Name );
    else
        return m_name;
}


DRC_RULE::DRC_RULE() :
        m_Unary( false ),
        m_LayerCondition( LSET::AllLayersMask() ),
        m_Condition( nullptr ),
        m_Priority( 0 ),
        m_Severity( SEVERITY::RPT_SEVERITY_ERROR )
{
}


DRC_RULE::~DRC_RULE()
{
    delete m_Condition;
}


void DRC_RULE::AddConstraint( DRC_CONSTRAINT& aConstraint )
{
    aConstraint.SetParentRule( this );
    m_Constraints.push_back( aConstraint );
}


DRC_RULE_CONDITION::DRC_RULE_CONDITION( const wxString& aExpression ) :
    m_expression( aExpression ),
    m_ucode ( nullptr )
{
}


DRC_RULE_CONDITION::~DRC_RULE_CONDITION()
{
}


bool DRC_RULE_CONDITION::EvaluateFor( const BOARD_ITEM* aItemA, const BOARD_ITEM* aItemB,
                                      PCB_LAYER_ID aLayer, REPORTER* aReporter )
{
#define REPORT( s ) { if( aReporter ) { aReporter->Report( s ); } }

    if( GetExpression().IsEmpty() )
    {
        REPORT( _( "Unconditional constraint." ) );

        return true;
    }

    REPORT( _( "Checking rule condition \"" + GetExpression() + "\"." ) );

    if( !m_ucode )
    {
        REPORT( _( "ERROR in expression." ) );

        return false;
    }

    BOARD_ITEM* a = const_cast<BOARD_ITEM*>( aItemA );
    BOARD_ITEM* b = aItemB ? const_cast<BOARD_ITEM*>( aItemB ) : DELETED_BOARD_ITEM::GetInstance();

    PCB_EXPR_CONTEXT ctx( aLayer );
    ctx.SetItems( a, b );
    ctx.SetErrorCallback( [&]( const wxString& aMessage, int aOffset )
                          {
                              REPORT( _( "ERROR: " ) + aMessage );
                          } );

    return m_ucode->Run( &ctx )->AsDouble() != 0.0;
}


bool DRC_RULE_CONDITION::Compile( REPORTER* aReporter, int aSourceLine, int aSourceOffset )
{
    auto errorHandler = [&]( const wxString& aMessage, int aOffset )
    {
        wxString rest;
        wxString first = aMessage.BeforeFirst( '|', &rest );
        wxString msg = wxString::Format( _( "ERROR: <a href='%d:%d'>%s</a>%s" ),
                                         aSourceLine,
                                         aSourceOffset + aOffset,
                                         first,
                                         rest );

        aReporter->Report( msg, RPT_SEVERITY_ERROR );
    };

    PCB_EXPR_COMPILER compiler;
    compiler.SetErrorCallback( errorHandler );

    m_ucode = std::make_unique<PCB_EXPR_UCODE>();

    PCB_EXPR_CONTEXT preflightContext( F_Cu );

    bool ok = compiler.Compile( GetExpression().ToUTF8().data(), m_ucode.get(), &preflightContext );
    return ok;
}