backannotate.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2019 Alexander Shuklin <[email protected]>
 * 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 2
 * 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, see <https://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include <deque>
#include <map>
#include <set>
#include <memory>
#include <vector>
#include <sch_reference_list.h>
#include <template_fieldnames.h>
#include <wx/string.h>
 
// Forward declarations
class REPORTER;
class SCH_SHEET_LIST;
class SCH_EDIT_FRAME;
class SCH_COMMIT;
 
struct BACKANNOTATE_UNIT_SWAP_CANDIDATE
{
    wxString                     m_ref;
    int                          m_currentUnit = 0;
    std::map<wxString, wxString> m_schNetsByPin;
    std::vector<wxString>        m_unitPinNumbers;
};
 
struct BACKANNOTATE_UNIT_SWAP_STEP
{
    size_t m_firstIndex = 0;
    size_t m_secondIndex = 0;
    int    m_firstUnit = 0;
    int    m_secondUnit = 0;
};
 
struct BACKANNOTATE_UNIT_SWAP_PLAN
{
    bool                                     m_mappingOk = false;
    bool                                     m_identity = true;
    std::vector<BACKANNOTATE_UNIT_SWAP_STEP> m_steps;
    std::set<size_t>                         m_swappedCandidateIndices;
};

bool CollectBackannotatePcbNets( const SCH_SYMBOL& aSymbol, const SCH_SHEET_PATH& aSheetPath,
                                 const wxString& aVariantName, const std::map<wxString, wxString>& aPcbNetsByPad,
                                 std::map<wxString, wxString>& aPcbNetsByLogicalPin );

BACKANNOTATE_UNIT_SWAP_PLAN PlanBackannotateUnitSwaps(
        const std::vector<BACKANNOTATE_UNIT_SWAP_CANDIDATE>& aCandidates,
        const std::map<wxString, wxString>& aPcbPinMap );

class BACK_ANNOTATE
{
public:
    struct PCB_FP_DATA
    {
        PCB_FP_DATA( const wxString& aRef, const wxString& aFootprint, const wxString& aValue, bool aDNP,
                     bool aExcludeFromBOM, bool aExcludeFromSim, bool aExcludeFromPosFiles,
                     const std::map<wxString, wxString>& aPinMap,
                     const std::map<wxString, wxString>& aFieldsMap ) :
                m_ref( aRef ),
                m_footprint( aFootprint ),
                m_value( aValue ),
                m_DNP( aDNP ),
                m_excludeFromBOM( aExcludeFromBOM ),
                m_excludeFromSim( aExcludeFromSim ),
                m_excludeFromPosFiles( aExcludeFromPosFiles ),
                m_pinMap( aPinMap ),
                m_fieldsMap( aFieldsMap )
        {}
 
        wxString                     m_ref;
        wxString                     m_footprint;
        wxString                     m_value;
        bool                         m_DNP;
        bool                         m_excludeFromBOM;
        bool                         m_excludeFromSim;
        bool                         m_excludeFromPosFiles;
        std::map<wxString, wxString> m_pinMap;
        std::map<wxString, wxString> m_fieldsMap;
    };

    using PCB_FOOTPRINTS_MAP = std::map<wxString, std::shared_ptr<PCB_FP_DATA>>;
 
    using CHANGELIST_ITEM = std::pair<SCH_REFERENCE, std::shared_ptr<PCB_FP_DATA>>;
 
    BACK_ANNOTATE( SCH_EDIT_FRAME* aFrame, REPORTER& aReporter, bool aRelinkFootprints,
                   bool aProcessFootprints, bool aProcessValues, bool aProcessReferences,
                   bool aProcessNetNames, bool aProcessAttributes, bool aProcessOtherFields,
                   bool aPreferUnitSwaps, bool aPreferPinSwaps, bool aDryRun );
 
    ~BACK_ANNOTATE() = default;

    bool FetchNetlistFromPCB( std::string& aNetlist );
 
    void PushNewLinksToPCB();

    bool BackAnnotateSymbols( const std::string& aNetlist );
 
private:
    void getPcbModulesFromString( const std::string& aPayload );

    void getChangeList();

    void checkForUnusedSymbols();

    void applyChangelist();

    std::set<wxString> applyPinSwaps( SCH_SYMBOL* aSymbol, const SCH_REFERENCE& aReference, const PCB_FP_DATA& aFpData,
                                      SCH_COMMIT* aCommit );
 
    void processNetNameChange( SCH_COMMIT* aCommit, const wxString& aRef, SCH_PIN* aPin,
                               const SCH_SHEET_PATH& aSheet, const wxString& aOldName, const wxString& aNewName );
 
private:
    REPORTER&                    m_reporter;
 
    bool                         m_matchByReference;
    bool                         m_processFootprints;
    bool                         m_processValues;
    bool                         m_processReferences;
    bool                         m_processNetNames;
    bool                         m_processAttributes;
    bool                         m_processOtherFields;
    bool                         m_preferUnitSwaps;
    bool                         m_preferPinSwaps;
    bool                         m_dryRun;
 
    PCB_FOOTPRINTS_MAP           m_pcbFootprints;
    SCH_REFERENCE_LIST           m_refs;
    SCH_MULTI_UNIT_REFERENCE_MAP m_multiUnitsRefs;
    std::deque<CHANGELIST_ITEM>  m_changelist;
    SCH_EDIT_FRAME*              m_frame;
 
    int                          m_changesCount;    // Number of user-level changes
};