KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
KICAD_DIFF::MERGE_PLAN Struct Reference

Result of planning a 3-way merge. More...

#include <kicad_merge_engine.h>

Public Member Functions

bool Resolved () const
 
std::size_t ConflictCount () const
 
nlohmann::json ToJson () const
 

Static Public Member Functions

static MERGE_PLAN FromJson (const nlohmann::json &aJson)
 

Public Attributes

std::vector< ITEM_RESOLUTION > actions
 
std::vector< KIID_PATH > unresolved
 
bool requiresZoneRefill = false
 
bool requiresConnectivityRebuild = false
 

Detailed Description

Result of planning a 3-way merge.

Plan generation is pure: feeds three DOCUMENT_DIFFs (ancestor-vs-ours, ancestor-vs-theirs, ours-vs-theirs) and produces actions + unresolved. The applier consumes this; validators run after applying.

Definition at line 121 of file kicad_merge_engine.h.

Member Function Documentation

◆ ConflictCount()

std::size_t KICAD_DIFF::MERGE_PLAN::ConflictCount ( ) const
inline

Definition at line 129 of file kicad_merge_engine.h.

References unresolved.

Referenced by BOOST_AUTO_TEST_CASE(), PCBNEW_JOBS_HANDLER::runPcbMerge(), and EESCHEMA_JOBS_HANDLER::runSchMerge().

◆ FromJson()

MERGE_PLAN KICAD_DIFF::MERGE_PLAN::FromJson ( const nlohmann::json & aJson)
static

Definition at line 285 of file kicad_merge_engine.cpp.

References actions, KICAD_DIFF::ITEM_RESOLUTION::FromJson(), requiresConnectivityRebuild, requiresZoneRefill, and unresolved.

Referenced by BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().

◆ Resolved()

bool KICAD_DIFF::MERGE_PLAN::Resolved ( ) const
inline

Definition at line 128 of file kicad_merge_engine.h.

References unresolved.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), KIGIT_PCB_MERGE::Merge(), PCBNEW_JOBS_HANDLER::runFpLibMerge(), PCBNEW_JOBS_HANDLER::runPcbMerge(), EESCHEMA_JOBS_HANDLER::runSchMerge(), and EESCHEMA_JOBS_HANDLER::runSymLibMerge().

◆ ToJson()

nlohmann::json KICAD_DIFF::MERGE_PLAN::ToJson ( ) const

Definition at line 262 of file kicad_merge_engine.cpp.

References actions, requiresConnectivityRebuild, requiresZoneRefill, and unresolved.

Referenced by BOOST_AUTO_TEST_CASE().

Member Data Documentation

◆ actions

std::vector<ITEM_RESOLUTION> KICAD_DIFF::MERGE_PLAN::actions

Definition at line 123 of file kicad_merge_engine.h.

Referenced by KICAD_DIFF::ApplyAutoResolutions(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), KICAD_DIFF::BuildConflictList(), KICAD_DIFF::CollectUnresolvedConflicts(), FromJson(), KICAD_DIFF::KICAD_MERGE_ENGINE::Plan(), and ToJson().

◆ requiresConnectivityRebuild

bool KICAD_DIFF::MERGE_PLAN::requiresConnectivityRebuild = false

Definition at line 126 of file kicad_merge_engine.h.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), FromJson(), KICAD_DIFF::KICAD_MERGE_ENGINE::Plan(), and ToJson().

◆ requiresZoneRefill

bool KICAD_DIFF::MERGE_PLAN::requiresZoneRefill = false

Definition at line 125 of file kicad_merge_engine.h.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), FromJson(), KICAD_DIFF::KICAD_MERGE_ENGINE::Plan(), and ToJson().

◆ unresolved

std::vector<KIID_PATH> KICAD_DIFF::MERGE_PLAN::unresolved

Definition at line 124 of file kicad_merge_engine.h.

Referenced by KICAD_DIFF::ApplyAutoResolutions(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), KICAD_DIFF::BuildConflictList(), ConflictCount(), FromJson(), KICAD_DIFF::KICAD_MERGE_ENGINE::Plan(), Resolved(), PCBNEW_JOBS_HANDLER::runFpLibMerge(), EESCHEMA_JOBS_HANDLER::runSymLibMerge(), and ToJson().

The documentation for this struct was generated from the following files: