kicad/eeschema/highlight_connection.cpp

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 1992-2016 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, 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
 */

/**
 * @file highlight_connection.cpp
 * @brief This file contains basic functions related to the command to
 * highlight a connection (wires and labels) in a schematic
 * (that can be a simple or a complex hierarchy)
 */

#include <fctsys.h>
#include <sch_view.h>
#include <sch_draw_panel.h>
#include <sch_edit_frame.h>
#include <sch_component.h>
#include <erc.h>

#include <netlist_object.h>
#include <sch_component.h>
#include <sch_sheet.h>

// List of items having the highlight option modified, therefore need to be redrawn

// TODO(JE) Probably use netcode rather than connection name here eventually
bool SCH_EDIT_FRAME::HighlightConnectionAtPosition( wxPoint aPosition )
{
    std::vector<EDA_ITEM*> itemsToRedraw;
    m_SelectedNetName = "";
    bool buildNetlistOk = false;

    SetStatusText( "" );

    // find which connected item is selected
    EDA_ITEMS nodeList;
    wxPoint   gridPosition = GetGridPosition( aPosition );

    if( GetScreen()->GetNode( gridPosition, nodeList ) )
    {
        if( TestDuplicateSheetNames( false ) > 0 )
            wxMessageBox( _( "Error: duplicate sub-sheet names found in current sheet. Fix it" ) );
        else
        {
            if( auto item = dynamic_cast<SCH_ITEM*>( nodeList[0] ) )
            {
                if( item->Connection( *g_CurrentSheet ) )
                {
                    m_SelectedNetName = item->Connection( *g_CurrentSheet )->Name();
                    SetStatusText( _( "Highlighted net: " ) + m_SelectedNetName );
                }
            }
        }
    }

    SendCrossProbeNetName( m_SelectedNetName );
    SetStatusText( _( "Selected net: " ) + UnescapeString( m_SelectedNetName ) );
    SetCurrentSheetHighlightFlags( &itemsToRedraw );

    // Be sure hightlight change will be redrawn
    KIGFX::VIEW* view = GetGalCanvas()->GetView();

    for( auto item : itemsToRedraw )
        view->Update( (KIGFX::VIEW_ITEM*)item, KIGFX::VIEW_UPDATE_FLAGS::REPAINT );

    //view->MarkTargetDirty( KIGFX::TARGET_NONCACHED );
    GetGalCanvas()->Refresh();
    return buildNetlistOk;
}


bool SCH_EDIT_FRAME::SetCurrentSheetHighlightFlags( std::vector<EDA_ITEM*>* aItemsToRedrawList )
{
    SCH_SCREEN* screen = g_CurrentSheet->LastScreen();

    if( !screen )
        return true;

    for( SCH_ITEM* ptr = screen->GetDrawItems(); ptr; ptr = ptr->Next() )
    {
        auto conn = ptr->Connection( *g_CurrentSheet );
        bool redraw = ptr->GetState( BRIGHTENED );

        ptr->SetState( BRIGHTENED, ( conn && conn->Name() == m_SelectedNetName ) );

        redraw |= ptr->GetState( BRIGHTENED );

        if( ptr->Type() == SCH_COMPONENT_T )
        {
            SCH_COMPONENT* comp = static_cast<SCH_COMPONENT*>( ptr );

            redraw |= comp->HasBrightenedPins();

            comp->ClearBrightenedPins();
            std::vector<LIB_PIN*> pins;
            comp->GetPins( pins );

            for( LIB_PIN* pin : pins )
            {
                auto pin_conn = comp->GetConnectionForPin( pin, *g_CurrentSheet );

                if( pin_conn && pin_conn->Name( false ) == m_SelectedNetName )
                {
                    comp->BrightenPin( pin );
                    redraw = true;
                }
            }
        }
        else if( ptr->Type() == SCH_SHEET_T )
        {
            for( SCH_SHEET_PIN& pin : static_cast<SCH_SHEET*>( ptr )->GetPins() )
            {
                auto pin_conn = pin.Connection( *g_CurrentSheet );
                bool redrawPin = pin.GetState( BRIGHTENED );

                pin.SetState( BRIGHTENED, ( pin_conn && pin_conn->Name() == m_SelectedNetName ) );

                redrawPin |= pin.GetState( BRIGHTENED );

                if( redrawPin && aItemsToRedrawList )
                    aItemsToRedrawList->push_back( &pin );
            }
        }

        if( redraw && aItemsToRedrawList )
            aItemsToRedrawList->push_back( ptr );
    }

    if( m_SelectedNetName == "" )
        return true;

    if( TestDuplicateSheetNames( false ) > 0 )
        return false;

    return true;
}