pcb_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 PCB_MERGE_APPLIER_H
#define PCB_MERGE_APPLIER_H
 
#include <diff_merge/kicad_merge_engine.h>
#include <diff_merge/merge_validators.h>
 
#include <wx/string.h>
 
#include <memory>
 
 
class BOARD;
class BOARD_ITEM;
 
 
namespace KICAD_DIFF
{

class PCB_MERGE_APPLIER
{
public:
    PCB_MERGE_APPLIER( const BOARD* aAncestor, const BOARD* aOurs, const BOARD* aTheirs,
                       MERGE_PLAN aPlan );

    std::unique_ptr<BOARD> 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;
 
        bool requiresZoneRefill          = false;
        bool requiresConnectivityRebuild = false;

        bool projectFileTouched = false;
        bool drcSeveritiesTouched = false;
        bool netClassesTouched = false;

        wxString drawingSheetFile;
        bool     drawingSheetFileSet = false;

        wxString customDrcRules;
        bool     customDrcRulesSet = false;

        wxString fpLibTable;
        bool     fpLibTableSet = false;

        wxString symLibTable;
        bool     symLibTableSet = false;

        VALIDATION_REPORT validation;

        bool connectivityRebuildPerformed = false;
    };
 
    const REPORT& GetReport() const { return m_report; }
 
private:
    const BOARD_ITEM* findItem( const BOARD* aBoard, const KIID& aId ) const;

    BOARD_ITEM* cloneInto( BOARD* aTarget, const BOARD_ITEM* aSource ) const;

    std::size_t applyPropertyResolutions( BOARD_ITEM*                             aTarget,
                                          const std::vector<PROPERTY_RESOLUTION>& aProps,
                                          const BOARD_ITEM*                       aOurs,
                                          const BOARD_ITEM*                       aTheirs,
                                          const BOARD_ITEM*                       aAncestor );
 
private:
    const BOARD* m_ancestor;
    const BOARD* m_ours;
    const BOARD* m_theirs;
    MERGE_PLAN   m_plan;
    REPORT       m_report;
};
 
} // namespace KICAD_DIFF
 
#endif // PCB_MERGE_APPLIER_H