sch_diff_utils.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * 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 3
 * 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/gpl-3.0.html
 */
 
#ifndef SCH_DIFF_UTILS_H
#define SCH_DIFF_UTILS_H
 
#include <schematic.h>
#include <sch_item.h>
#include <sch_screen.h>
#include <sch_sheet_path.h>
 
 
namespace KICAD_DIFF
{

class SHEET_SCOPE
{
public:
    SHEET_SCOPE( const SCHEMATIC* aSch, const SCH_SHEET_PATH* aPath ) :
            m_sch( aSch ),
            m_saved( aSch ? aSch->CurrentSheet() : SCH_SHEET_PATH{} )
    {
        if( m_sch && aPath )
            m_sch->CurrentSheet() = *aPath;
    }
 
    ~SHEET_SCOPE()
    {
        if( m_sch )
            m_sch->CurrentSheet() = m_saved;
    }
 
    SHEET_SCOPE( const SHEET_SCOPE& )            = delete;
    SHEET_SCOPE& operator=( const SHEET_SCOPE& ) = delete;
 
private:
    const SCHEMATIC* m_sch;
    SCH_SHEET_PATH   m_saved;
};
 

template <typename SHEET_VISITOR, typename ITEM_VISITOR>
void WalkSchematic( const SCHEMATIC* aSchematic, SHEET_VISITOR&& aSheetVisitor, ITEM_VISITOR&& aItemVisitor,
                    const KIID_PATH& aScope = {} )
{
    if( !aSchematic )
        return;
 
    SCH_SHEET_LIST sheets = aSchematic->BuildSheetListSortedByPageNumbers();
 
    for( const SCH_SHEET_PATH& path : sheets )
    {
        const KIID_PATH sheetPath = path.Path();
 
        if( !aScope.empty() && sheetPath != aScope )
            continue;
 
        aSheetVisitor( path );
 
        SCH_SCREEN* screen = path.LastScreen();
 
        if( !screen )
            continue;
 
        for( SCH_ITEM* item : screen->Items() )
        {
            if( !item )
                continue;
 
            // Scoped mode emits just the item KIID so items align across
            // schematics with different hierarchies.
            KIID_PATH kiidPath;
 
            if( aScope.empty() )
                kiidPath = sheetPath;
 
            kiidPath.push_back( item->m_Uuid );
 
            aItemVisitor( item, path, kiidPath );
        }
    }
}
 
} // namespace KICAD_DIFF
 
#endif // SCH_DIFF_UTILS_H