sch_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 SCH_DIFFER_H
#define SCH_DIFFER_H
 
#include <diff_merge/kicad_differ.h>
 
#include <wx/string.h>
 
 
class SCHEMATIC;
class SCH_ITEM;
class SCH_SHEET_PATH;
 
 
namespace KICAD_DIFF
{

class SCH_DIFFER : public KICAD_DIFFER
{
public:
    SCH_DIFFER( const SCHEMATIC* aBefore, const SCHEMATIC* aAfter,
                const wxString& aPath = wxEmptyString );
    ~SCH_DIFFER() override;

    void SetScope( const KIID_PATH& aBeforeScope, const KIID_PATH& aAfterScope );
 
    DOCUMENT_DIFF Diff() override;
 
    const SCHEMATIC* Before() const { return m_before; }
    const SCHEMATIC* After()  const { return m_after; }
 
private:
    struct WalkedItem
    {
        KIID_PATH       id;
        const SCH_ITEM* item;
        SCH_SHEET_PATH* sheetPath;  // raw pointer into m_pathStorage
    };

    void walk( const SCHEMATIC* aSchematic, std::vector<WalkedItem>& aOut,
               std::vector<std::unique_ptr<SCH_SHEET_PATH>>& aStorage, const KIID_PATH& aScope = {} ) const;

    std::vector<PROPERTY_DELTA> diffProperties( const SCH_ITEM* aBefore,
                                                const SCH_ITEM* aAfter,
                                                const SCH_SHEET_PATH* aBeforePath,
                                                const SCH_SHEET_PATH* aAfterPath ) const;

    static wxString itemTypeName( const SCH_ITEM* aItem );

    static std::optional<wxString> itemRefdes( const SCH_ITEM* aItem,
                                               const SCH_SHEET_PATH* aPath );
 
    static void sortChanges( std::vector<ITEM_CHANGE>& aChanges );
 
private:
    const SCHEMATIC* m_before;
    const SCHEMATIC* m_after;
    wxString         m_path;
    KIID_PATH        m_scopeBefore;
    KIID_PATH        m_scopeAfter;
};
 
} // namespace KICAD_DIFF
 
#endif // SCH_DIFFER_H