dialog_kicad_diff.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 DIALOG_KICAD_DIFF_H
#define DIALOG_KICAD_DIFF_H
 
#include "dialog_kicad_diff_base.h"
 
#include <diff_merge/diff_scene.h>
#include <diff_merge/kicad_diff_types.h>
 
#include <functional>
#include <map>
#include <set>
 
 
class WIDGET_DIFF_CANVAS;
class wxChoice;
 

class DIALOG_KICAD_DIFF : public DIALOG_KICAD_DIFF_BASE
{
public:
    using SHEET_SWITCHER = std::function<void( WIDGET_DIFF_CANVAS&, const KIID_PATH& )>;
 
    DIALOG_KICAD_DIFF( wxWindow* aParent, const wxString& aReferencePath, const wxString& aComparisonPath,
                       const KICAD_DIFF::DOCUMENT_DIFF& aDiff, KICAD_DIFF::DOCUMENT_GEOMETRY aReferenceGeometry = {},
                       KICAD_DIFF::DOCUMENT_GEOMETRY aComparisonGeometry = {}, SHEET_SWITCHER aSheetSwitcher = {},
                       KIID_PATH aInitialSheet = {} );
 
    ~DIALOG_KICAD_DIFF() override = default;
 
    void                SwitchCanvasToSheet( const KIID_PATH& aSheetPath );
    const KIID_PATH&    CurrentCanvasSheet() const { return m_currentCanvasSheet; }
    WIDGET_DIFF_CANVAS* DiffCanvas() const { return m_canvas; }

    void Reload( const wxString& aReferencePath, const wxString& aComparisonPath, KICAD_DIFF::DOCUMENT_DIFF aDiff,
                 KICAD_DIFF::DOCUMENT_GEOMETRY aReferenceGeometry, KICAD_DIFF::DOCUMENT_GEOMETRY aComparisonGeometry,
                 SHEET_SWITCHER aSheetSwitcher, KIID_PATH aInitialSheet );
 
    using REVISION_HANDLER = std::function<void( int aIndex )>;

    void SetRevisionChooser( const std::vector<wxString>& aLabels, int aSelected, REVISION_HANDLER aOnChange );
 
    using CHANGE_SELECTED_FN = std::function<void( const KIID_PATH& )>;
 
    void SetChangeSelectedHandler( CHANGE_SELECTED_FN aFn ) { m_changeSelectedFn = std::move( aFn ); }
 
protected:
    void OnClose( wxCloseEvent& aEvent ) override;
    void OnTreeSelectionChanged( wxTreeEvent& aEvent ) override;
    void OnTreeItemMenu( wxTreeEvent& aEvent );
    void OnOK( wxCommandEvent& aEvent ) override;
 
private:
    void buildTree();

    void showChange( const KICAD_DIFF::ITEM_CHANGE* aChange );

    bool selectChangeById( const KIID_PATH& aChangeId );

    void applyHiddenToTree();

    std::vector<KIID_PATH> changeRowIds( const KICAD_DIFF::ITEM_CHANGE& aChange ) const;
 
    KICAD_DIFF::DOCUMENT_DIFF                                m_diff;

    std::set<KIID_PATH> m_hiddenChanges;
 
    REVISION_HANDLER m_revisionHandler;
    wxChoice*        m_revisionChoice = nullptr;

    std::map<wxUIntPtr, const KICAD_DIFF::ITEM_CHANGE*>      m_changeByTreeId;

    wxString                                                 m_searchFilter;

    WIDGET_DIFF_CANVAS*                                      m_canvas = nullptr;

    bool m_suppressCenter = false;
 
    SHEET_SWITCHER m_sheetSwitcher;
    KIID_PATH      m_currentCanvasSheet;
 
    CHANGE_SELECTED_FN m_changeSelectedFn;
};
 
#endif // DIALOG_KICAD_DIFF_H