pads_sch_schematic_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_SCHEMATIC_BUILDER_H_
#define PADS_SCH_SCHEMATIC_BUILDER_H_
 
#include <sch_io/pads/pads_sch_parser.h>
#include <sch_label.h>
#include <map>
#include <set>
#include <vector>
#include <memory>
#include <wx/string.h>
 
class SCH_SCREEN;
class SCH_SHEET;
class SCH_SHEET_PATH;
class SCH_SHEET_PIN;
class SCH_HIERLABEL;
class SCH_GLOBALLABEL;
class SCH_LINE;
class SCH_JUNCTION;
class SCH_LABEL;
class SCH_BUS_WIRE_ENTRY;
class SCH_SYMBOL;
class SCHEMATIC;
 
namespace PADS_SCH
{

class PADS_SCH_SCHEMATIC_BUILDER
{
public:
    PADS_SCH_SCHEMATIC_BUILDER( const PARAMETERS& aParams, SCHEMATIC* aSchematic );
    ~PADS_SCH_SCHEMATIC_BUILDER();
 
    int CreateWires( const std::vector<SCH_SIGNAL>& aSignals, SCH_SCREEN* aScreen );
 
    SCH_LINE* CreateWire( const WIRE_SEGMENT& aWire );
 
    int CreateJunctions( const std::vector<SCH_SIGNAL>& aSignals, SCH_SCREEN* aScreen );

    int CreateNetLabels( const std::vector<SCH_SIGNAL>& aSignals, SCH_SCREEN* aScreen,
                         const std::set<std::string>& aSignalOpcIds,
                         const std::set<std::string>& aSkipSignals = {},
                         const std::map<std::string, NETNAME_LABEL>& aNetNameLabels = {} );

    static SPIN_STYLE SpinFromNetNameLabel( const NETNAME_LABEL& aLabel );

    SCH_GLOBALLABEL* CreateNetLabel( const SCH_SIGNAL& aSignal, const VECTOR2I& aPosition,
                                     SPIN_STYLE aOrientation = SPIN_STYLE::RIGHT );
 
    int CreateBusWires( const std::vector<SCH_SIGNAL>& aSignals, SCH_SCREEN* aScreen );
 
    SCH_LINE* CreateBusWire( const WIRE_SEGMENT& aWire );
 
    static bool IsBusSignal( const std::string& aName );

    void ApplyPartAttributes( SCH_SYMBOL* aSymbol, const PART_PLACEMENT& aPlacement );
 
    void ApplyFieldSettings( SCH_SYMBOL* aSymbol, const PART_PLACEMENT& aPlacement );

    int CreateCustomFields( SCH_SYMBOL* aSymbol, const PART_PLACEMENT& aPlacement );

    void CreateTitleBlock( SCH_SCREEN* aScreen );

    SCH_SHEET* CreateHierarchicalSheet( int aSheetNumber, int aTotalSheets,
                                        SCH_SHEET* aParentSheet,
                                        const wxString& aBaseFilename );
 
    VECTOR2I GetDefaultSheetSize() const;

    VECTOR2I CalculateSheetPosition( int aSheetIndex, int aTotalSheets ) const;

    SCH_SHEET_PIN* CreateSheetPin( SCH_SHEET* aSheet, const std::string& aSignalName,
                                   int aPinIndex );

    SCH_HIERLABEL* CreateHierLabel( const std::string& aSignalName, const VECTOR2I& aPosition,
                                    SCH_SCREEN* aScreen );

    static bool IsGlobalSignal( const std::string& aSignalName,
                                const std::set<int>& aSheetNumbers );

    static SPIN_STYLE computeLabelOrientation( const VECTOR2I& aLabelPos,
                                               const VECTOR2I& aAdjacentPos );
 
private:
    int toKiCadUnits( double aPadsValue ) const;

    int toKiCadY( double aPadsY ) const;

    std::vector<VECTOR2I> findJunctionPoints( const std::vector<SCH_SIGNAL>& aSignals );
 
    VECTOR2I chooseLabelPosition( const SCH_SIGNAL& aSignal );

    wxString convertNetName( const std::string& aName ) const;
 
    const PARAMETERS& m_params;
    SCHEMATIC*        m_schematic;
    int               m_pageHeightIU;
};
 
} // namespace PADS_SCH
 
#endif // PADS_SCH_SCHEMATIC_BUILDER_H_