pcb_differ.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 PCB_DIFFER_H
#define PCB_DIFFER_H
 
#include <diff_merge/kicad_differ.h>
#include <diff_merge/identity_reconciler.h>
 
#include <wx/string.h>
 
 
class BOARD;
class BOARD_ITEM;
class EDA_ITEM;
class FOOTPRINT;
 
 
namespace KICAD_DIFF
{

KIID PcbDiffItemId( const EDA_ITEM& aItem );

BOARD_ITEM* FindPcbDiffItem( const BOARD* aBoard, const KIID& aId );

class PCB_DIFFER : public KICAD_DIFFER
{
public:
    PCB_DIFFER( const BOARD* aBefore, const BOARD* aAfter, const wxString& aPath = wxEmptyString );
    ~PCB_DIFFER() override;
 
    DOCUMENT_DIFF Diff() override;

    const BOARD* Before() const { return m_before; }
    const BOARD* After() const { return m_after; }
 
private:
    std::vector<PROPERTY_DELTA> diffProperties( const BOARD_ITEM* aBefore, const BOARD_ITEM* aAfter ) const;

    ITEM_DESCRIPTOR makeDescriptor( const BOARD_ITEM* aItem ) const;

    std::vector<ITEM_CHANGE> diffFootprintChildren( const FOOTPRINT* aBefore, const FOOTPRINT* aAfter ) const;

    static void sortChanges( std::vector<ITEM_CHANGE>& aChanges );

    static wxString itemTypeName( const BOARD_ITEM* aItem );

    static std::optional<wxString> itemRefdes( const BOARD_ITEM* aItem );
 
private:
    const BOARD* m_before;
    const BOARD* m_after;
    wxString     m_path;
};
 
} // namespace KICAD_DIFF
 
#endif // PCB_DIFFER_H