pads_sch_symbol_builder.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2025 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 <https://www.gnu.org/licenses/>.
 */
 
#ifndef PADS_SCH_SYMBOL_BUILDER_H_
#define PADS_SCH_SYMBOL_BUILDER_H_
 
#include <sch_io/pads/pads_sch_parser.h>
#include <lib_id.h>
#include <map>
#include <memory>
#include <optional>
#include <string>
 
class LIB_SYMBOL;
class SCH_SHAPE;
class SCH_PIN;
class SCH_SHEET;
class SCH_TEXT;
class SCHEMATIC;
 
namespace PADS_SCH
{

class PADS_SCH_SYMBOL_BUILDER
{
public:
    PADS_SCH_SYMBOL_BUILDER( const PARAMETERS& aParams );
    ~PADS_SCH_SYMBOL_BUILDER();

    LIB_SYMBOL* BuildSymbol( const SYMBOL_DEF& aSymbolDef );

    LIB_SYMBOL* GetOrCreateSymbol( const SYMBOL_DEF& aSymbolDef );
 
    bool HasSymbol( const std::string& aName ) const;
 
    LIB_SYMBOL* GetSymbol( const std::string& aName ) const;
 
    static bool IsPowerSymbol( const std::string& aName );

    static std::optional<LIB_ID> GetKiCadPowerSymbolId( const std::string& aPadsName );

    LIB_SYMBOL* BuildKiCadPowerSymbol( const std::string& aKiCadName );

    static std::string GetPowerStyleFromVariant( const std::string& aDecalName,
                                                 const std::string& aPinType );

    static int NextFreePowerOrdinal( SCH_SHEET* aSheet );

    LIB_SYMBOL* BuildMultiUnitSymbol( const PARTTYPE_DEF& aPartType,
                                       const std::vector<SYMBOL_DEF>& aSymbolDefs );

    LIB_SYMBOL* GetOrCreateMultiUnitSymbol( const PARTTYPE_DEF& aPartType,
                                             const std::vector<SYMBOL_DEF>& aSymbolDefs );

    LIB_SYMBOL* GetOrCreatePartTypeSymbol( const PARTTYPE_DEF& aPartType,
                                            const SYMBOL_DEF& aSymbolDef );

    LIB_SYMBOL* GetOrCreateConnectorPinSymbol( const PARTTYPE_DEF& aPartType,
                                                const SYMBOL_DEF&   aSymbolDef,
                                                const std::string&  aPinNumber );

    LIB_SYMBOL* BuildMultiUnitConnectorSymbol( const PARTTYPE_DEF&            aPartType,
                                                const SYMBOL_DEF&              aSymbolDef,
                                                const std::vector<std::string>& aPinNumbers );

    LIB_SYMBOL* GetOrCreateMultiUnitConnectorSymbol(
            const PARTTYPE_DEF&             aPartType,
            const SYMBOL_DEF&               aSymbolDef,
            const std::vector<std::string>& aPinNumbers,
            const std::string&              aCacheKey );

    void AddHiddenPowerPins( LIB_SYMBOL* aSymbol,
                             const std::vector<PARTTYPE_DEF::SIGPIN>& aSigpins );
 
private:
    int toKiCadUnits( double aPadsValue ) const;

    SCH_SHAPE* createShape( const SYMBOL_GRAPHIC& aGraphic );
 
    std::vector<SCH_SHAPE*> createShapes( const SYMBOL_GRAPHIC& aGraphic );

    static std::vector<SYMBOL_PIN> applyGateOverrides( const std::vector<SYMBOL_PIN>& aDecalPins,
                                                       const GATE_DEF&               aGate );

    static bool isDiodeAKPinSet( const std::vector<SYMBOL_PIN>& aPins );
 
    SCH_PIN* createPin( const SYMBOL_PIN& aPin, LIB_SYMBOL* aParent, bool aMapDiodeAK = false );

    SCH_TEXT* createSymbolText( const SYMBOL_TEXT& aText, int aUnit = 0 );
 
    int mapPinType( PIN_TYPE aPadsType );
 
    const PARAMETERS& m_params;
    std::map<std::string, std::unique_ptr<LIB_SYMBOL>> m_symbolCache;
};
 
} // namespace PADS_SCH
 
#endif // PADS_SCH_SYMBOL_BUILDER_H_