sch_io_ltspice_parser.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2022 Chetan Subhash Shinde<[email protected]>
 * Copyright (C) 2023 CERN
 * 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 <https://www.gnu.org/licenses/>.
 */

 
#ifndef LTSPICE_SCH_PARSER_H
#define LTSPICE_SCH_PARSER_H
 
#include <core/typeinfo.h>
#include <layer_ids.h>
#include <sch_io/ltspice/ltspice_schematic.h>
#include <stroke_params.h>
 
 
class EDA_TEXT;
class SCH_PIN;
class SCH_LABEL_BASE;
class SCH_SYMBOL;
class SCH_TEXT;
class SCH_SHAPE;

class SCH_IO_LTSPICE_PARSER
{
public:
    // Field for storing LTspice symbol's InstName in SCH_SHEET.
    static constexpr const wxChar* LT_INSTNAME_FIELD = wxS( "LT_InstName" );
 
    explicit SCH_IO_LTSPICE_PARSER( LTSPICE_SCHEMATIC* aLTSchematic ) :
            m_lt_schematic( aLTSchematic ),
            m_powerSymbolIndex( 0 )
    { }
 
    ~SCH_IO_LTSPICE_PARSER() {}

    int      ToKicadCoords( int aCoordinate );
    VECTOR2I ToKicadCoords( const VECTOR2I& aPos );
    VECTOR2I ToKicadFontSize( int aLTFontSize );

    int      ToLtSpiceCoords( int aCoordinate );
    VECTOR2I ToLtSpiceCoords( const VECTOR2I& aPos );

    void CreateItems( LTSPICE_SCHEMATIC::LT_ASC& aAscfile, SCH_SCREEN* aScreen,
                      const std::vector<wxString>& aUniqueAscNames, std::map<wxString, SCH_SCREEN*>& aMapOfScreens,
                      VECTOR2I aOriginOffset );
 
 

    void CreateSymLine( LIB_SYMBOL* aSymbol, const LTSPICE_SCHEMATIC::LT_SYMBOL& aLTSymbol, int aIndex,
                      SCH_SHAPE* aShape );

    void CreateKicadSymbolsAndSubsheets( LTSPICE_SCHEMATIC::LT_ASC& aAscfile, SCH_SCREEN* aScreen,
                                         const std::vector<wxString>&     aUniqueAscNames,
                                         std::map<wxString, SCH_SCREEN*>& aMapOfScreens );

    void CreateSymbol( LTSPICE_SCHEMATIC::LT_SYMBOL& aLtSymbol, LIB_SYMBOL* aLibSymbol );

    void RotateMirrorItem( const LTSPICE_SCHEMATIC::LT_SYMBOL& aLTSymbol, SCH_ITEM* aItem );

    VECTOR2I RotateMirror( const LTSPICE_SCHEMATIC::LT_SYMBOL& aLTSymbol, const VECTOR2I& aPoint );

    void AssignSymOrientation( const LTSPICE_SCHEMATIC::LT_SYMBOL& aLTSymbol, SCH_SYMBOL* aSchSymbol );

    void CreateKicadSCH_ITEMs( LTSPICE_SCHEMATIC::LT_ASC& aAscfile, SCH_SCREEN* aScreen );

    void AddAscBusEntry( LTSPICE_SCHEMATIC::LT_ASC& aAscfile, int aIndex, SCH_SCREEN* aScreen );

    void AddAscIopin( LTSPICE_SCHEMATIC::LT_ASC& aAscfile, int aIndex, SCH_SCREEN* aScreen );

    void AddAscLine( const LTSPICE_SCHEMATIC::LT_ASC& aAscfile, int aIndex, SCH_SCREEN* aScreen );

    void AddAscCircle( const LTSPICE_SCHEMATIC::LT_ASC& aAscfile, int aIndex, SCH_SCREEN* aScreen );

    void AddAscArc( const LTSPICE_SCHEMATIC::LT_ASC& aAscfile, int aIndex, SCH_SCREEN* aScreen );

    void AddAscRect( const LTSPICE_SCHEMATIC::LT_ASC& aAscfile, int aIndex, SCH_SCREEN* aScreen );
 
    SCH_SHEET* AddAscSymAsSubsheet( LTSPICE_SCHEMATIC::LT_ASC& aAscfile, const LTSPICE_SCHEMATIC::LT_SYMBOL& aLTSymbol,
                               SCH_SCREEN* aScreen );

    SCH_TEXT* CreateSCH_TEXT( const VECTOR2I& aOffset, const wxString& aText, int aFontSize,
                           LTSPICE_SCHEMATIC::JUSTIFICATION aJustification );

    void AddAscWire( const LTSPICE_SCHEMATIC::LT_ASC& aAscfile, int aIndex, SCH_SCREEN* aScreen,
                     SCH_LAYER_ID aLayer );

    SCH_SYMBOL* CreatePowerSymbol( const VECTOR2I& aOffset, const wxString& aValue, int aFontSize,
                                   SCH_SCREEN* aScreen,
                                   std::vector<LTSPICE_SCHEMATIC::WIRE>& aWires );

    SCH_LABEL_BASE* CreateSCH_LABEL( KICAD_T aType, const VECTOR2I& aOffset, const wxString& aValue, int aFontSize,
                                     SCH_SCREEN* aScreen );

    void AddSymFields( const LTSPICE_SCHEMATIC::LT_SYMBOL& aLTSymbol, SCH_SYMBOL* aSymbol );

    void CreateSymRect( const LTSPICE_SCHEMATIC::LT_SYMBOL& aLTSymbol, int aIndex, SCH_SHAPE* aRectangle );

    void CreateSymPin( const LTSPICE_SCHEMATIC::LT_SYMBOL& aLTSymbol, int aIndex, SCH_PIN* aPin );

    void CreateSymArc( const LTSPICE_SCHEMATIC::LT_SYMBOL& aLTSymbol, int aIndex, SCH_SHAPE* aArc );

    void CreateSymCircle( const LTSPICE_SCHEMATIC::LT_SYMBOL& aLTSymbol, int aIndex, SCH_SHAPE* aCircle );

    void CreateSymText( const LTSPICE_SCHEMATIC::LT_SYMBOL& aLTSymbol, int aIndex, SCH_TEXT* aText );
 
private:
    int getLineWidth( const LTSPICE_SCHEMATIC::LINEWIDTH& aLineWidth );
 
    LINE_STYLE getLineStyle( const LTSPICE_SCHEMATIC::LINESTYLE& aLineStyle );
 
    STROKE_PARAMS getStroke( const LTSPICE_SCHEMATIC::LINEWIDTH& aLineWidth,
                             const LTSPICE_SCHEMATIC::LINESTYLE& aLineStyle );
 
    void setTextJustification( EDA_TEXT* aText, LTSPICE_SCHEMATIC::JUSTIFICATION aJustification );
 
private:
    LTSPICE_SCHEMATIC* m_lt_schematic;
    VECTOR2I           m_originOffset;
    int                m_powerSymbolIndex;
};
#endif // LTSPICE_SCH_PARSER_H