dialog_kicad_merge_3way.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
 * or you may search the http://www.gnu.org website for the version 3 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */
 
#ifndef DIALOG_KICAD_MERGE_3WAY_H
#define DIALOG_KICAD_MERGE_3WAY_H
 
#include "dialog_kicad_merge_3way_base.h"
 
#include <diff_merge/diff_scene.h>
#include <diff_merge/kicad_merge_engine.h>
 
#include <functional>
#include <map>
#include <optional>
 
 
class WIDGET_DIFF_CANVAS;
 

class DIALOG_KICAD_MERGE_3WAY : public DIALOG_KICAD_MERGE_3WAY_BASE
{
public:
    enum class SIDE
    {
        OURS,
        THEIRS,
        ANCESTOR
    };

    struct CONFLICT_CONTEXT
    {
        KICAD_DIFF::DOCUMENT_GEOMETRY ancestorGeometry;
        KICAD_DIFF::DOCUMENT_GEOMETRY oursGeometry;
        KICAD_DIFF::DOCUMENT_GEOMETRY theirsGeometry;

        std::map<KIID_PATH, BOX2I>    ancestorBBoxes;
        std::map<KIID_PATH, BOX2I>    oursBBoxes;
        std::map<KIID_PATH, BOX2I>    theirsBBoxes;

        std::function<void( WIDGET_DIFF_CANVAS&, SIDE, const std::optional<KIID_PATH>& )> drawSide;

        wxString formatNotice;

        std::function<wxString( const KIID_PATH& )> describeItem;
    };
 
    DIALOG_KICAD_MERGE_3WAY( wxWindow* aParent, const KICAD_DIFF::MERGE_PLAN& aPlan,
                             CONFLICT_CONTEXT aContext = {} );
 
    ~DIALOG_KICAD_MERGE_3WAY() override = default;

    const KICAD_DIFF::MERGE_PLAN& GetResolvedPlan() const { return m_plan; }
 
protected:
    void OnClose( wxCloseEvent& aEvent ) override;
    void OnConflictSelected( wxCommandEvent& aEvent ) override;
    void OnResolutionChanged( wxCommandEvent& aEvent ) override;
    void OnApply( wxCommandEvent& aEvent ) override;
    void OnCancel( wxCommandEvent& aEvent ) override;
 
private:
    void buildList();

    void showConflict( int aIndex );

    void rebuildCanvas();

    SIDE activeSide() const;

    wxString describe( const KIID_PATH& aId, const wxString& aFallback ) const;
 
    KICAD_DIFF::MERGE_PLAN          m_plan;
    CONFLICT_CONTEXT                m_context;

    std::vector<bool>               m_hasMergedEdit;

    std::vector<std::size_t>        m_conflictActionIndex;

    int                             m_currentConflict = -1;

    WIDGET_DIFF_CANVAS*             m_canvas = nullptr;
};
 
#endif // DIALOG_KICAD_MERGE_3WAY_H