pcb_marker.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2018 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
 * 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 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, see <https://www.gnu.org/licenses/>.
 */
 
#include "connectivity/connectivity_data.h"
#include <google/protobuf/any.pb.h>
#include <api/api_enums.h>
#include <api/api_utils.h>
#include <api/board/board_rules.pb.h>
#include <bitmaps.h>
#include <base_units.h>
#include <eda_draw_frame.h>
#include <board.h>
#include <board_design_settings.h>
#include <pcb_marker.h>
#include <layer_ids.h>
#include <settings/color_settings.h>
#include <settings/settings_manager.h>
#include <geometry/shape_null.h>
#include <widgets/ui_common.h>
#include <widgets/wx_data_view_hyperlink_renderer.h>
#include <pgm_base.h>
#include <drc/drc_item.h>
#include <drc/drc_rule.h>
#include <trigo.h>
#include <properties/property.h>
#include <properties/property_mgr.h>
 

#define SCALING_FACTOR  pcbIUScale.mmToIU( 0.1625 )
 
 
 
PCB_MARKER::PCB_MARKER( std::shared_ptr<DRC_ITEM> aItem, const VECTOR2I& aPosition, int aLayer ) :
        BOARD_ITEM( nullptr, PCB_MARKER_T, F_Cu ),  // parent set during BOARD::Add()
        MARKER_BASE( SCALING_FACTOR, std::move( aItem ) ),
        m_pathLength( 0 )
{
    if( m_rcItem )
    {
        m_rcItem->SetParent( this );
 
        if( aLayer == LAYER_DRAWINGSHEET )
        {
            SetMarkerType( MARKER_BASE::MARKER_DRAWING_SHEET );
        }
        else
        {
            switch( m_rcItem->GetErrorCode() )
            {
            case DRCE_UNCONNECTED_ITEMS:
                SetMarkerType( MARKER_BASE::MARKER_RATSNEST );
                break;
 
            case DRCE_MISSING_FOOTPRINT:
            case DRCE_DUPLICATE_FOOTPRINT:
            case DRCE_EXTRA_FOOTPRINT:
            case DRCE_NET_CONFLICT:
            case DRCE_SCHEMATIC_PARITY:
            case DRCE_SCHEMATIC_FIELDS_PARITY:
            case DRCE_FOOTPRINT_FILTERS:
                SetMarkerType( MARKER_BASE::MARKER_PARITY );
                break;
 
            default:
                SetMarkerType( MARKER_BASE::MARKER_DRC );
                break;
            }
 
            SetLayer( ToLAYER_ID( aLayer ) );
        }
    }
 
    m_Pos = aPosition;
}
 
 
PCB_MARKER::~PCB_MARKER()
{
    if( m_rcItem )
        m_rcItem->SetParent( nullptr );
}
 
 
static void ToProto( kiapi::board::DrcMarker& aMsg, const PCB_MARKER& aMarker )
{
    std::shared_ptr<DRC_ITEM> drc = std::static_pointer_cast<DRC_ITEM>( aMarker.GetRCItem() );
 
    aMsg.set_error_type(
            ToProtoEnum<PCB_DRC_CODE, kiapi::board::DrcErrorType>( static_cast<PCB_DRC_CODE>( drc->GetErrorCode() ) ) );
 
    kiapi::common::PackVector2( *aMsg.mutable_position(), aMarker.GetPos() );
 
    for( const KIID& id : drc->GetIDs() )
    {
        if( id != niluuid )
            aMsg.add_items()->set_value( id.AsStdString() );
    }
 
    // Only store the layer for error types where it affects identity.
    bool storeLayer = false;
 
    switch( drc->GetErrorCode() )
    {
    case DRCE_COPPER_SLIVER:
    case DRCE_GENERIC_WARNING:
    case DRCE_GENERIC_ERROR:
    case DRCE_UNCONNECTED_ITEMS:
    case DRCE_STARVED_THERMAL:
        storeLayer = true;
        break;
 
    case DRCE_UNRESOLVED_VARIABLE:
        if( aMarker.GetMarkerType() == MARKER_BASE::MARKER_DRAWING_SHEET )
            storeLayer = true;
 
        break;
 
    default:
        break;
    }
 
    if( storeLayer )
    {
        PCB_LAYER_ID layer = aMarker.GetLayer();
 
        if( layer == UNDEFINED_LAYER )
            layer = F_Cu;
 
        aMsg.set_layer( ToProtoEnum<PCB_LAYER_ID, kiapi::board::types::BoardLayer>( layer ) );
    }
}
 
 
PCB_MARKER* PCB_MARKER::FromProto( const kiapi::board::DrcMarker& aMsg )
{
    PCB_DRC_CODE code = FromProtoEnum<PCB_DRC_CODE, kiapi::board::DrcErrorType>( aMsg.error_type() );
 
    std::shared_ptr<DRC_ITEM> drcItem = DRC_ITEM::Create( code );
 
    if( !drcItem )
        return nullptr;
 
    VECTOR2I pos = kiapi::common::UnpackVector2( aMsg.position() );
    PCB_LAYER_ID layer = FromProtoEnum<PCB_LAYER_ID, kiapi::board::types::BoardLayer>( aMsg.layer() );
 
    PCB_MARKER* marker = new PCB_MARKER( drcItem, pos, layer );
 
    KIID mainId = aMsg.items_size() > 0 ? KIID( aMsg.items( 0 ).value() ) : niluuid;
    KIID auxId  = aMsg.items_size() > 1 ? KIID( aMsg.items( 1 ).value() ) : niluuid;
    KIID aux2Id = aMsg.items_size() > 2 ? KIID( aMsg.items( 2 ).value() ) : niluuid;
    KIID aux3Id = aMsg.items_size() > 3 ? KIID( aMsg.items( 3 ).value() ) : niluuid;
 
    marker->GetRCItem()->SetItems( mainId, auxId, aux2Id, aux3Id );
 
    return marker;
}
 
 
void PCB_MARKER::Serialize( google::protobuf::Any& aContainer ) const
{
    kiapi::board::DrcMarker msg;
    ToProto( msg, *this );
    aContainer.PackFrom( msg );
}
 
 
bool PCB_MARKER::Deserialize( const google::protobuf::Any& aContainer )
{
    kiapi::board::DrcMarker msg;
 
    if( !aContainer.UnpackTo( &msg ) )
        return false;
 
    std::unique_ptr<PCB_MARKER> tmp( PCB_MARKER::FromProto( msg ) );
 
    if( !tmp )
        return false;
 
    swapData( tmp.get() );
    return true;
}
 
 
PCB_MARKER* PCB_MARKER::FromLegacyString( const wxString& aData )
{
    auto getMarkerLayer =
            []( const wxString& layerName ) -> int
            {
                for( int layer = 0; layer < PCB_LAYER_ID_COUNT; ++layer )
                {
                    if( LayerName( ToLAYER_ID( layer ) ) == layerName )
                        return layer;
                }
 
                return F_Cu;
            };
 
    wxArrayString props = wxSplit( aData, '|' );
 
    // Every legacy marker has a settings key, position and at least two item fields.
    // Reject truncated settings rather than indexing past wxArrayString below.
    if( props.size() < 5 )
        return nullptr;
 
    int           markerLayer = F_Cu;
    VECTOR2I      markerPos( (int) strtol( props[1].c_str(), nullptr, 10 ),
                             (int) strtol( props[2].c_str(), nullptr, 10 ) );
 
    std::shared_ptr<DRC_ITEM> drcItem = DRC_ITEM::Create( props[0] );
 
    if( !drcItem )
        return nullptr;
 
    if( drcItem->GetErrorCode() == DRCE_COPPER_SLIVER
            || drcItem->GetErrorCode() == DRCE_GENERIC_WARNING
            || drcItem->GetErrorCode() == DRCE_GENERIC_ERROR )
    {
        drcItem->SetItems( KIID( props[3] ) );
        markerLayer = getMarkerLayer( props[4] );
    }
    else if( drcItem->GetErrorCode() == DRCE_UNCONNECTED_ITEMS )
    {
        // Pre-9.0.4 versions didn't have KIIDs as last two properties to allow sorting stability
        if( props.size() == 5 )
            drcItem->SetItems( KIID( props[3] ), KIID( props[4] ) );
        else if( props.size() >= 7 )
            drcItem->SetItems( KIID( props[5] ), KIID( props[6] ) );
        else
            return nullptr;
    }
    else if( drcItem->GetErrorCode() == DRCE_STARVED_THERMAL )
    {
        drcItem->SetItems( KIID( props[3] ), KIID( props[4] ) );
 
        // Pre-7.0 versions didn't differentiate between layers
        if( props.size() == 6 )
            markerLayer = getMarkerLayer( props[5] );
    }
    else if( drcItem->GetErrorCode() == DRCE_UNRESOLVED_VARIABLE
                && props[3].IsEmpty()
                && props[4].IsEmpty() )
    {
        // Note: caller must load our item pointer with the drawing sheet proxy item
        markerLayer = LAYER_DRAWINGSHEET;
    }
    else
    {
        drcItem->SetItems( KIID( props[3] ), KIID( props[4] ) );
    }
 
    return new PCB_MARKER( drcItem, markerPos, markerLayer );
}
 
 
EDA_ITEM* PCB_MARKER::Clone() const
{
    PCB_MARKER* res = new PCB_MARKER( *this );
 
    // An RC_ITEM is shared between its marker and various tree views.  It cannot be shared between
    // two markers.
    if( m_rcItem )
    {
        res->m_rcItem = std::make_shared<DRC_ITEM>( *std::static_pointer_cast<DRC_ITEM>( m_rcItem ) );
        res->m_rcItem->SetParent( res );
    }
 
    return res;
}
 
 
void PCB_MARKER::swapData( BOARD_ITEM* aImage )
{
    wxASSERT( aImage->Type() == PCB_MARKER_T );
    PCB_MARKER* image = static_cast<PCB_MARKER*>( aImage );
 
    std::swap( *this, *image );
 
    if( m_rcItem )
        m_rcItem->SetParent( this );
 
    if( image->m_rcItem )
        image->m_rcItem->SetParent( image );
}
 
 
void PCB_MARKER::GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList )
{
    aList.emplace_back( _( "Type" ), _( "Marker" ) );
    aList.emplace_back( _( "Violation" ), HYPERLINK_DV_RENDERER::StripMarkup( m_rcItem->GetErrorMessage( true ) ) );
 
    switch( GetSeverity() )
    {
    case RPT_SEVERITY_IGNORE:  aList.emplace_back( _( "Severity" ), _( "Ignore" ) );  break;
    case RPT_SEVERITY_WARNING: aList.emplace_back( _( "Severity" ), _( "Warning" ) ); break;
    case RPT_SEVERITY_ERROR:   aList.emplace_back( _( "Severity" ), _( "Error" ) );   break;
    default:                                                                          break;
    }
 
    if( GetMarkerType() == MARKER_DRAWING_SHEET )
    {
        aList.emplace_back( _( "Drawing Sheet" ), wxEmptyString );
    }
    else
    {
        wxString  mainText;
        wxString  auxText;
        EDA_ITEM* mainItem = aFrame->ResolveItem( m_rcItem->GetMainItemID() );
        EDA_ITEM* auxItem = aFrame->ResolveItem( m_rcItem->GetAuxItemID() );
 
        if( mainItem )
            mainText = mainItem->GetItemDescription( aFrame, true );
 
        if( auxItem )
            auxText = auxItem->GetItemDescription( aFrame, true );
 
        aList.emplace_back( mainText, auxText );
    }
 
    if( IsExcluded() )
        aList.emplace_back( _( "Excluded" ), m_comment );
}
 
 
void PCB_MARKER::Rotate( const VECTOR2I& aRotCentre, const EDA_ANGLE& aAngle )
{
    // Marker geometry isn't user-editable
}
 
 
void PCB_MARKER::Flip( const VECTOR2I& aCentre, FLIP_DIRECTION aFlipDirection )
{
    // Marker geometry isn't user-editable
}
 
 
std::shared_ptr<SHAPE> PCB_MARKER::GetEffectiveShape( PCB_LAYER_ID aLayer, FLASHING, DRC_CONSTRAINT_T ) const
{
    // Markers do not participate in the board geometry space, and therefore have no effective shape.
    return std::make_shared<SHAPE_NULL>();
}
 
 
double PCB_MARKER::GetCoverageArea( int aTextMargin ) const
{
    SHAPE_LINE_CHAIN markerShape;
    ShapeToPolygon( markerShape );
    return markerShape.Area();
}
 
 
void PCB_MARKER::TransformShapeToPolygon( SHAPE_POLY_SET& aBuffer, PCB_LAYER_ID aLayer, int aClearance,
                                          int aError, ERROR_LOC aErrorLoc, bool ignoreLineWidth ) const
{
    // Markers do not participate in the board geometry space, and therefore have no shape.
};
 
 
wxString PCB_MARKER::GetItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const
{
    return wxString::Format( _( "Marker (%s)" ), aFull ? m_rcItem->GetErrorMessage( true )
                                                       : m_rcItem->GetErrorText( true ) );
}
 
 
BITMAPS PCB_MARKER::GetMenuImage() const
{
    return BITMAPS::drc;
}
 
 
SEVERITY PCB_MARKER::GetSeverity() const
{
    if( IsExcluded() )
        return RPT_SEVERITY_EXCLUSION;
 
    DRC_ITEM* item = static_cast<DRC_ITEM*>( m_rcItem.get() );
 
    if( item->GetErrorCode() == DRCE_GENERIC_WARNING )
        return RPT_SEVERITY_WARNING;
    else if( item->GetErrorCode() == DRCE_GENERIC_ERROR )
        return RPT_SEVERITY_ERROR;
 
    DRC_RULE* rule = item->GetViolatingRule();
 
    if( rule && rule->m_Severity != RPT_SEVERITY_UNDEFINED )
        return rule->m_Severity;
 
    return GetBoard()->GetDesignSettings().GetSeverity( item->GetErrorCode() );
}
 
 
std::vector<int> PCB_MARKER::ViewGetLayers() const
{
    if( GetMarkerType() == MARKER_RATSNEST )
        return {};
 
    std::vector<int> layers{ 0, LAYER_MARKER_SHADOWS, LAYER_DRC_HIGHLIGHTED };
 
    switch( GetSeverity() )
    {
    default:
    case SEVERITY::RPT_SEVERITY_ERROR:     layers[0] = LAYER_DRC_ERROR;     break;
    case SEVERITY::RPT_SEVERITY_WARNING:   layers[0] = LAYER_DRC_WARNING;   break;
    case SEVERITY::RPT_SEVERITY_EXCLUSION: layers[0] = LAYER_DRC_EXCLUSION; break;
    }
 
    return layers;
}
 
 
GAL_LAYER_ID PCB_MARKER::GetColorLayer() const
{
    switch( GetSeverity() )
    {
    default:
    case SEVERITY::RPT_SEVERITY_ERROR:     return LAYER_DRC_ERROR;
    case SEVERITY::RPT_SEVERITY_WARNING:   return LAYER_DRC_WARNING;
    case SEVERITY::RPT_SEVERITY_EXCLUSION: return LAYER_DRC_EXCLUSION;
    }
}
 
 
KIGFX::COLOR4D PCB_MARKER::getColor() const
{
    return ::GetColorSettings( DEFAULT_THEME )->GetColor( GetColorLayer() );
}
 
 
void PCB_MARKER::SetZoom( double aZoomFactor ) const
{
    SetMarkerScale( SCALING_FACTOR * aZoomFactor );
}
 
 
std::vector<PCB_SHAPE> PCB_MARKER::GetErrorLegendShapes() const
{
    STROKE_PARAMS          hairline( 1.0 );     // Segments of width 1.0 will get drawn as lines by PCB_PAINTER
    std::vector<PCB_SHAPE> pathShapes;
 
    if( m_pathStart == m_pathEnd )
    {
        // Add a collision 'X'
        const int len = KiROUND( 2.5 * MarkerScale() );
 
        PCB_SHAPE s( nullptr, SHAPE_T::SEGMENT );
        s.SetStroke( hairline );
 
        s.SetStart( m_pathStart + VECTOR2I( -len, -len ) );
        s.SetEnd( m_pathStart + VECTOR2I( len, len ) );
        pathShapes.push_back( s );
 
        s.SetStart( m_pathStart + VECTOR2I( -len, len ) );
        s.SetEnd( m_pathStart + VECTOR2I( len, -len ) );
        pathShapes.push_back( s );
    }
    else
    {
        // Add the path
        for( PCB_SHAPE shape : m_pathShapes )
        {
            shape.SetStroke( hairline );
            pathShapes.push_back( std::move( shape ) );
        }
 
        // Draw perpendicular begin/end stops
        if( pathShapes.size() > 0 )
        {
            VECTOR2I V1 = pathShapes[0].GetStart() - pathShapes[0].GetEnd();
            VECTOR2I V2 = pathShapes.back().GetStart() - pathShapes.back().GetEnd();
            V1 = V1.Perpendicular().Resize( 2.5 * MarkerScale() );
            V2 = V2.Perpendicular().Resize( 2.5 * MarkerScale() );
 
            PCB_SHAPE s( nullptr, SHAPE_T::SEGMENT );
            s.SetStroke( hairline );
 
            s.SetStart( m_pathStart + V1 );
            s.SetEnd( m_pathStart - V1 );
            pathShapes.push_back( s );
 
            s.SetStart( m_pathEnd + V2 );
            s.SetEnd( m_pathEnd - V2 );
            pathShapes.push_back( s );
        }
    }
 
    // Add shaded areas
    for( PCB_SHAPE shape : m_pathShapes )
    {
        shape.SetWidth( 10 * MarkerScale() );
        pathShapes.push_back( std::move( shape ) );
    }
 
    return pathShapes;
}
 
 
const BOX2I PCB_MARKER::GetBoundingBox() const
{
    BOX2I box = GetBoundingBoxMarker();
 
    for( const PCB_SHAPE& s : m_pathShapes )
        box.Merge( s.GetBoundingBox() );
 
    return box;
}
 
 
const BOX2I PCB_MARKER::ViewBBox() const
{
    return GetBoundingBox();
}
 
 
static struct PCB_MARKER_DESC
{
    PCB_MARKER_DESC()
    {
        PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
        REGISTER_TYPE( PCB_MARKER );
        propMgr.AddTypeCast( new TYPE_CAST<PCB_MARKER, BOARD_ITEM> );
        propMgr.AddTypeCast( new TYPE_CAST<PCB_MARKER, MARKER_BASE> );
        propMgr.InheritsAfter( TYPE_HASH( PCB_MARKER ), TYPE_HASH( BOARD_ITEM ) );
        propMgr.InheritsAfter( TYPE_HASH( PCB_MARKER ), TYPE_HASH( MARKER_BASE ) );
 
        // Markers cannot be locked and have no user-accessible layer control
        propMgr.Mask( TYPE_HASH( PCB_MARKER ), TYPE_HASH( BOARD_ITEM ), _HKI( "Layer" ) );
        propMgr.Mask( TYPE_HASH( PCB_MARKER ), TYPE_HASH( BOARD_ITEM ), _HKI( "Locked" ) );
    }
} _PCB_MARKER_DESC;