auto_resolution.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 KICAD_DIFF_AUTO_RESOLUTION_H
#define KICAD_DIFF_AUTO_RESOLUTION_H
 
#include <kicommon.h>
 
#include <diff_merge/kicad_merge_engine.h>
 
#include <wx/string.h>
 
#include <map>
#include <string>
#include <vector>
 
 
namespace KICAD_DIFF
{

enum class AUTO_RESOLUTION_STATUS
{
    OK,             
    INVALID_JSON,   
    NOT_OBJECT,     
    BAD_VALUE,      
    UNKNOWN_KIND,   
    ENGINE_INTERNAL_KIND   
};
 

struct KICOMMON_API AUTO_RESOLUTION_PARSE_RESULT
{
    AUTO_RESOLUTION_STATUS                  status = AUTO_RESOLUTION_STATUS::OK;
    std::map<wxString, ITEM_RES>            resolutions;
    wxString                                errorContext;
};
 

KICOMMON_API AUTO_RESOLUTION_PARSE_RESULT
ParseAutoResolutionJson( const std::string& aJsonContent );
 

enum class APPLY_AUTO_RESOLUTIONS_STATUS
{
    COMPLETE,
    PARTIAL,
    NO_CONFLICTS,
};
 
 
struct KICOMMON_API APPLY_AUTO_RESOLUTIONS_RESULT
{
    APPLY_AUTO_RESOLUTIONS_STATUS   status      = APPLY_AUTO_RESOLUTIONS_STATUS::NO_CONFLICTS;
    std::size_t                     appliedCount = 0;
    KIID_PATH                       firstMissingId;
};
 

KICOMMON_API APPLY_AUTO_RESOLUTIONS_RESULT
ApplyAutoResolutions( MERGE_PLAN&                          aPlan,
                      const std::vector<std::size_t>&      aConflictActionIndices,
                      const std::map<wxString, ITEM_RES>&  aResolutions );
 

struct KICOMMON_API CONFLICT_LIST_ENTRY
{
    std::size_t actionIndex;
    wxString    label;
    KIID_PATH   id;
};
 
 
KICOMMON_API std::vector<CONFLICT_LIST_ENTRY> BuildConflictList( const MERGE_PLAN& aPlan );
 

KICOMMON_API std::vector<KIID_PATH>
CollectUnresolvedConflicts( const MERGE_PLAN&                aPlan,
                            const std::vector<std::size_t>&  aConflictActionIndices );
 

KICOMMON_API std::optional<BOX2I>
ResolveConflictBBox( const KIID_PATH&                  aId,
                     const std::map<KIID_PATH, BOX2I>& aPrimary,
                     const std::map<KIID_PATH, BOX2I>& aOurs,
                     const std::map<KIID_PATH, BOX2I>& aTheirs,
                     const std::map<KIID_PATH, BOX2I>& aAncestor );
 

KICOMMON_API wxString
BuildConflictDetailText( const ITEM_RESOLUTION& aResolution );
 
} // namespace KICAD_DIFF
 
#endif // KICAD_DIFF_AUTO_RESOLUTION_H