sch_merge_applier.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_MERGE_APPLIER_H
#define SCH_MERGE_APPLIER_H
 
#include <diff_merge/kicad_merge_engine.h>
#include <diff_merge/merge_validators.h>
 
#include <map>
#include <memory>
#include <vector>
 
 
class SCHEMATIC;
class SCH_ITEM;
class SCH_SHEET_PATH;
 
 
namespace KICAD_DIFF
{

class SCH_MERGE_APPLIER
{
public:
    SCH_MERGE_APPLIER( SCHEMATIC* aAncestor, const SCHEMATIC* aOurs,
                       const SCHEMATIC* aTheirs, MERGE_PLAN aPlan );

    bool Apply();
 
    struct REPORT
    {
        std::size_t itemsTakenOurs    = 0;
        std::size_t itemsTakenTheirs  = 0;
        std::size_t itemsMergedProps  = 0;
        std::size_t itemsDeleted      = 0;
        std::size_t itemsKept         = 0;
        std::size_t propertiesApplied = 0;
        std::size_t propertiesFailed  = 0;

        std::size_t sheetActionsSkipped = 0;
 
        bool requiresConnectivityRebuild = false;

        bool projectFileTouched = false;
        bool ercSeveritiesTouched = false;
        bool drawingSheetFileTouched = false;

        VALIDATION_REPORT validation;

        bool connectivityRebuildPerformed = false;
    };
 
    const REPORT& GetReport() const { return m_report; }
 
private:
    struct PathedItem
    {
        SCH_ITEM*       item;
        SCH_SHEET_PATH* sheetPath;
    };

    std::map<KIID_PATH, PathedItem>
    indexSchematic( const SCHEMATIC* aSchematic,
                    std::vector<std::unique_ptr<SCH_SHEET_PATH>>& aStorage ) const;
 
    std::size_t applyPropertyResolutions( SCH_ITEM*                               aTarget,
                                          const std::vector<PROPERTY_RESOLUTION>& aProps,
                                          const SCH_ITEM*                         aOurs,
                                          const SCH_ITEM*                         aTheirs,
                                          const SCH_ITEM*                         aAncestor );
 
private:
    SCHEMATIC*       m_ancestor;
    const SCHEMATIC* m_ours;
    const SCHEMATIC* m_theirs;
    MERGE_PLAN       m_plan;
    REPORT           m_report;
};
 
} // namespace KICAD_DIFF
 
#endif // SCH_MERGE_APPLIER_H