drc_test_provider_track_segment_length.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2004-2023 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 <core/thread_pool.h>
#include <pcb_track.h>
#include <drc/drc_engine.h>
#include <drc/drc_item.h>
#include <drc/drc_rule.h>
#include <drc/drc_test_provider.h>
 
 
/*
    Track segment length test. As the name says, checks segment length of the tracks (including segments and arcs)
    Errors generated:
    - DRCE_TRACK_SEGMENT_LENGTH
*/
 
class DRC_TEST_PROVIDER_TRACK_SEGMENT_LENGTH : public DRC_TEST_PROVIDER
{
public:
    DRC_TEST_PROVIDER_TRACK_SEGMENT_LENGTH()
    {}
 
    virtual ~DRC_TEST_PROVIDER_TRACK_SEGMENT_LENGTH()
    {}
 
    virtual bool Run() override;
 
    virtual const wxString GetName() const override
    {
        return wxT( "segment_length" );
    };
 
    virtual const wxString GetDescription() const override
    {
        return wxT( "Tests track segment lengths" );
    }
};
 
 
bool DRC_TEST_PROVIDER_TRACK_SEGMENT_LENGTH::Run()
{
    if( m_drcEngine->IsErrorLimitExceeded( DRCE_TRACK_SEGMENT_LENGTH ) )
    {
        reportAux( wxT( "Track segment length violations ignored. Tests not run." ) );
        return true;        // continue with other tests
    }
 
    if( !m_drcEngine->HasRulesForConstraintType( TRACK_SEGMENT_LENGTH_CONSTRAINT ) )
    {
        reportAux( wxT( "No track segment length constraints found. Tests not run." ) );
        return true;        // continue with other tests
    }
 
    if( !reportPhase( _( "Checking track segment lengths..." ) ) )
        return false;       // DRC cancelled
 
    auto checkTrackSegmentLength =
            [&]( BOARD_ITEM* item ) -> bool
            {
                if( m_drcEngine->IsErrorLimitExceeded( DRCE_TRACK_SEGMENT_LENGTH ) )
                    return false;
 
                int      actual;
                VECTOR2I p0;
 
                if( item->Type() == PCB_ARC_T )
                {
                    PCB_ARC* arc = static_cast<PCB_ARC*>( item );
 
                    actual = arc->GetLength();
                    p0 = arc->GetStart();
                }
                else if( item->Type() == PCB_TRACE_T )
                {
                    PCB_TRACK* track = static_cast<PCB_TRACK*>( item );
 
                    actual = track->GetLength();
                    p0 = ( track->GetStart() + track->GetEnd() ) / 2;
                }
                else
                {
                    return true;
                }
 
                auto constraint = m_drcEngine->EvalRules( TRACK_SEGMENT_LENGTH_CONSTRAINT, item, nullptr,
                                                          item->GetLayer() );
                bool fail_min = false;
                bool fail_max = false;
                int  constraintLength = 0;
 
                if( constraint.GetSeverity() != RPT_SEVERITY_IGNORE )
                {
                    if( constraint.Value().HasMin() && actual < constraint.Value().Min() )
                    {
                        fail_min        = true;
                        constraintLength = constraint.Value().Min();
                    }
 
                    if( constraint.Value().HasMax() && actual > constraint.Value().Max() )
                    {
                        fail_max        = true;
                        constraintLength = constraint.Value().Max();
                    }
                }
 
                if( fail_min || fail_max )
                {
                    std::shared_ptr<DRC_ITEM> drcItem = DRC_ITEM::Create( DRCE_TRACK_SEGMENT_LENGTH );
                    wxString constraintName = constraint.GetName();
                    wxString msg;
 
                    if( fail_min )
                    {
                        if( constraint.GetParentRule() && constraint.GetParentRule()->m_Implicit )
                            constraintName = _( "board setup constraints" );
 
                        msg = formatMsg( _( "(%s min length %s; actual %s)" ),
                                         constraintName,
                                         constraintLength,
                                         actual );
                    }
                    else
                    {
                        msg = formatMsg( _( "(%s max length %s; actual %s)" ),
                                         constraintName,
                                         constraintLength,
                                         actual );
                    }
 
                    drcItem->SetErrorMessage( drcItem->GetErrorText() + wxS( " " ) + msg );
                    drcItem->SetItems( item );
                    drcItem->SetViolatingRule( constraint.GetParentRule() );
 
                    reportViolation( drcItem, p0, item->GetLayer() );
                }
 
                return true;
            };
 
    const int progressDelta = 250;
    int       ii = 0;
 
    thread_pool&                   tp = GetKiCadThreadPool();
    std::vector<std::future<bool>> returns;
 
    returns.reserve( m_drcEngine->GetBoard()->Tracks().size() );
 
    for( PCB_TRACK* item : m_drcEngine->GetBoard()->Tracks() )
    {
        returns.emplace_back( tp.submit( checkTrackSegmentLength, item ) );
    }
 
    for( std::future<bool>& ret : returns )
    {
        std::future_status status = ret.wait_for( std::chrono::milliseconds( 250 ) );
 
        while( status != std::future_status::ready )
        {
            reportProgress( ii++, m_drcEngine->GetBoard()->Tracks().size(), progressDelta );
            status = ret.wait_for( std::chrono::milliseconds( 250 ) );
        }
    }
 
    reportRuleStatistics();
 
    return !m_drcEngine->IsCancelled();
}
 
 
namespace detail
{
static DRC_REGISTER_TEST_PROVIDER<DRC_TEST_PROVIDER_TRACK_SEGMENT_LENGTH> dummy;
}