pin_map.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, see <http://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include <kicommon.h>
#include <lib_id.h>
 
#include <nlohmann/json_fwd.hpp>
 
#include <unordered_map>
#include <vector>
#include <wx/string.h>
#include <wx/arrstr.h> // gives std::vector<wxString> dllimport attribution on MSVC
 

struct KICOMMON_API PIN_MAP_ENTRY
{
    wxString m_PinNumber;
    wxString m_PadNumber;
 
    bool operator==( const PIN_MAP_ENTRY& aOther ) const
    {
        return m_PinNumber == aOther.m_PinNumber && m_PadNumber == aOther.m_PadNumber;
    }
};
 

class KICOMMON_API PIN_MAP
{
public:
    PIN_MAP() = default;
    explicit PIN_MAP( const wxString& aName );
 
    const wxString& GetName() const { return m_name; }
    void            SetName( const wxString& aName ) { m_name = aName; }

    void SetEntry( const wxString& aPinNumber, const wxString& aPadNumber );

    void ClearEntry( const wxString& aPinNumber );
 
    bool HasEntry( const wxString& aPinNumber ) const;

    const wxString& GetPadNumber( const wxString& aPinNumber ) const;
 
    const std::vector<PIN_MAP_ENTRY>& GetEntries() const { return m_entries; }
 
    bool IsEmpty() const { return m_entries.empty(); }

    bool IsIdentity( const std::vector<wxString>& aPinNumbers ) const;
 
    bool operator==( const PIN_MAP& aOther ) const;
 
private:
    std::vector<PIN_MAP_ENTRY>::iterator       findEntry( const wxString& aPinNumber );
    std::vector<PIN_MAP_ENTRY>::const_iterator findEntry( const wxString& aPinNumber ) const;
 
    wxString                   m_name;
    std::vector<PIN_MAP_ENTRY> m_entries;
};
 

class KICOMMON_API PIN_MAP_SET
{
public:
    void AddOrReplace( PIN_MAP aMap );

    void Remove( const wxString& aName );
 
    const PIN_MAP* FindByName( const wxString& aName ) const;
    PIN_MAP*       FindByName( const wxString& aName );
 
    const std::vector<PIN_MAP>& GetAll() const { return m_maps; }
    bool                        IsEmpty() const { return m_maps.empty(); }
 
    bool operator==( const PIN_MAP_SET& aOther ) const { return m_maps == aOther.m_maps; }
    bool operator!=( const PIN_MAP_SET& aOther ) const { return !( *this == aOther ); }
 
private:
    std::vector<PIN_MAP> m_maps;   // ordered for stable file output
};
 

struct KICOMMON_API ASSOCIATED_FOOTPRINT
{
    LIB_ID   m_FootprintLibId;
    wxString m_MapName;
 
    bool operator==( const ASSOCIATED_FOOTPRINT& aOther ) const
    {
        return m_FootprintLibId == aOther.m_FootprintLibId && m_MapName == aOther.m_MapName;
    }
};
 

enum class PIN_MAP_OVERRIDE_MODE
{
    USE_LIBRARY_DEFAULT,
    USE_NAMED_MAP,
    FORCE_IDENTITY,
    DELEGATE_TO_UNIT_1
};
 

struct KICOMMON_API PIN_MAP_INSTANCE_OVERRIDE
{
    PIN_MAP_OVERRIDE_MODE      m_Mode = PIN_MAP_OVERRIDE_MODE::USE_LIBRARY_DEFAULT;
    wxString                   m_ActiveMapName;
    std::vector<PIN_MAP_ENTRY> m_Edits;

    bool IsDefault() const
    {
        return m_Mode == PIN_MAP_OVERRIDE_MODE::USE_LIBRARY_DEFAULT && m_Edits.empty();
    }

    bool IsDelegate() const { return m_Mode == PIN_MAP_OVERRIDE_MODE::DELEGATE_TO_UNIT_1; }
 
    bool operator==( const PIN_MAP_INSTANCE_OVERRIDE& aOther ) const
    {
        return m_Mode == aOther.m_Mode && m_ActiveMapName == aOther.m_ActiveMapName
               && m_Edits == aOther.m_Edits;
    }
 
    bool operator!=( const PIN_MAP_INSTANCE_OVERRIDE& aOther ) const { return !( *this == aOther ); }
};
 

KICOMMON_API PIN_MAP MakeLegacyPinMap(
        const wxString& aName,
        const std::unordered_map<wxString, std::vector<wxString>>& aAssignments );
 

KICOMMON_API std::unordered_map<wxString, std::vector<wxString>>
ParseLegacyPinAssignments( const nlohmann::json& aArray );

KICOMMON_API PIN_MAP_SET ParsePinMapSet( const nlohmann::json& aParent );

KICOMMON_API std::vector<ASSOCIATED_FOOTPRINT>
ParseAssociatedFootprints( const nlohmann::json& aParent );