orcad_converter.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.
 *
 * Based on the dsn2kicad reference implementation and on OrCAD file format
 * documentation from the OpenOrCadParser project (MIT licensed).
 *
 * 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 ORCAD_CONVERTER_H_
#define ORCAD_CONVERTER_H_
 
#include <cstdint>
#include <map>
#include <memory>
#include <set>
#include <string>
#include <tuple>
#include <utility>
#include <vector>
 
#include <wx/string.h>
 
#include <math/box2.h>
#include <math/vector2d.h>
#include <gal/color4d.h>
#include <eda_shape.h>
 
#include <sch_io/orcad/orcad_records.h>
 
class LIB_SYMBOL;
class EDA_TEXT;
class PROGRESS_REPORTER;
class REPORTER;
class SCHEMATIC;
class SCH_SCREEN;
class SCH_SHEET;
class SCH_SHEET_PATH;
class SCH_SYMBOL;
class wxMemoryBuffer;
 

inline constexpr int ORCAD_IU_PER_DBU = 2540;
 
KIGFX::COLOR4D OrcadColor( int aColorIndex );
int            OrcadLineWidthIu( int aWidth );
LINE_STYLE     OrcadLineStyle( int aStyle );
FILL_T         OrcadFillType( int aFillStyle, int aHatchStyle );
int            OrcadPageOrder( wxString& aName );
 
inline VECTOR2I OrcadDbuToIu( int aX, int aY )
{
    return VECTOR2I( aX * ORCAD_IU_PER_DBU, aY * ORCAD_IU_PER_DBU );
}
 

struct ORCAD_ORIENT_ENTRY
{
    int    angle;    
    char   mirror;   
    int8_t txSel;    
    int8_t tySel;    
    int8_t a;
    int8_t b;
    int8_t c;
    int8_t d;
};

inline constexpr ORCAD_ORIENT_ENTRY ORCAD_ORIENT_TABLE[8] = {
    { 0,   0,   0, 0,    1,  0,  0,  1 },
    { 90,  0,   0, 1,    0,  1, -1,  0 },
    { 180, 0,   1, 2,   -1,  0,  0, -1 },
    { 270, 0,   2, 0,    0, -1,  1,  0 },
    { 0,   'y', 1, 0,   -1,  0,  0,  1 },
    { 90,  'x', 0, 0,    0,  1,  1,  0 },
    { 0,   'x', 0, 2,    1,  0,  0, -1 },
    { 270, 'x', 2, 1,    0, -1, -1,  0 }
};
 

inline int OrcadOrientOf( int aRotation, bool aMirror )
{
    return ( aRotation & 3 ) | ( aMirror ? 0x4 : 0 );
}
 
 
inline int OrcadOrientDim( int aSelector, int aWidth, int aHeight )
{
    return aSelector == 1 ? aWidth : aSelector == 2 ? aHeight : 0;
}
 

inline VECTOR2I OrcadOrientOffset( int aOrient, int aWidth, int aHeight )
{
    const ORCAD_ORIENT_ENTRY& e = ORCAD_ORIENT_TABLE[aOrient & 7];
    return VECTOR2I( OrcadOrientDim( e.txSel, aWidth, aHeight ),
                     OrcadOrientDim( e.tySel, aWidth, aHeight ) );
}
 

inline VECTOR2I OrcadTransformPoint( int aOrient, int aWidth, int aHeight, int aBaseX, int aBaseY,
                                     int aPx, int aPy )
{
    const ORCAD_ORIENT_ENTRY& e = ORCAD_ORIENT_TABLE[aOrient & 7];
    VECTOR2I                  t = OrcadOrientOffset( aOrient, aWidth, aHeight );
 
    return VECTOR2I( aBaseX + t.x + e.a * aPx + e.b * aPy,
                     aBaseY + t.y + e.c * aPx + e.d * aPy );
}
 

class ORCAD_CONVERTER
{
public:
    ORCAD_CONVERTER( ORCAD_DESIGN& aDesign, SCHEMATIC* aSchematic, REPORTER* aReporter,
                     PROGRESS_REPORTER* aProgressReporter = nullptr );

    ~ORCAD_CONVERTER();

    SCH_SHEET* Convert( SCH_SHEET* aRootSheet );

    std::vector<LIB_SYMBOL*> BuildSymbolLibrary();

    static constexpr const char* LIB_NICK = "orcad_import";
 
private:
    // -- shared bookkeeping types ---------------------------------------------------

    struct UNIT_INFO
    {
        std::string              letter;      
        const ORCAD_SYMBOL_DEF*  symbol = nullptr;
        std::vector<std::string> pinNumbers;  
    };

    struct LIB_ENTRY
    {
        std::string                 name;      
        std::vector<UNIT_INFO>      units;     
        bool                        isPower = false;
        std::string                 powerNet;  
        std::string                 refPrefix = "U";
        std::string                 footprint;
        std::unique_ptr<LIB_SYMBOL> kicadSymbol;  
    };

    struct OFFPAGE_NET
    {
        int         index = 0;
        std::string net;
        int         x = 0;  
        int         y = 0;
    };

    using PKG_KEY = std::tuple<std::string, std::string, int>;
 
    // -- constants (calibrated; do not change) ----------------------------------------

    static constexpr int PIN_LEN_DBU = 10;

    static constexpr int MARGIN_L_DBU = 60;
    static constexpr int MARGIN_T_DBU = 60;
    static constexpr int MARGIN_R_DBU = 60;
    static constexpr int MARGIN_B_DBU = 100;
 
    // -- reporting [orcad_converter_sheet.cpp] ------------------------------------------

    void warn( const wxString& aMsg );

    void note( const wxString& aMsg );
 
    // ================================================================================
    // implemented in orcad_converter_symbols.cpp
    // ================================================================================

    void prepareSymbols();

    ORCAD_SYMBOL_DEF synthesizeSymbol( const std::string& aPkgName,
                                       const std::vector<const ORCAD_PLACED_INSTANCE*>& aInstances ) const;

    std::string unitLetter( const ORCAD_PLACED_INSTANCE& aInst ) const;

    std::pair<const ORCAD_SYMBOL_DEF*, int> pickVariant( const ORCAD_PLACED_INSTANCE& aInst ) const;

    std::pair<std::string, int> libForInstance( const ORCAD_PLACED_INSTANCE& aInst );

    std::string powerLibFor( const std::string& aSymbolName, const std::string& aNetName );

    LIB_SYMBOL* kicadSymbolFor( const std::string& aLibName );

    void addSymbolPrimitive( LIB_SYMBOL* aSymbol, const ORCAD_PRIMITIVE& aPrim, int aUnit, int aColor, int aOffsetX = 0,
                             int aOffsetY = 0 );

    void addSymbolArc( LIB_SYMBOL* aSymbol, const ORCAD_PRIMITIVE& aPrim, int aUnit, int aColor, int aOffsetX = 0,
                       int aOffsetY = 0 );

    void addSymbolPin( LIB_SYMBOL* aSymbol, const ORCAD_SYMBOL_PIN& aPin, const wxString& aNumber,
                       int aUnit, bool aPower, const std::string& aNameOverride );

    void placeInstance( ORCAD_RAW_PAGE& aPage, const ORCAD_PLACED_INSTANCE& aInst,
                        SCH_SCREEN* aScreen, const SCH_SHEET_PATH& aSheetPath );

    wxString resolveReference( const ORCAD_PLACED_INSTANCE& aInst ) const;

    void placePowerSymbol( ORCAD_RAW_PAGE& aPage, const ORCAD_GRAPHIC_INST& aInst,
                           const std::string& aNet, SCH_SCREEN* aScreen,
                           const SCH_SHEET_PATH& aSheetPath );

    void placeSymbolFields( SCH_SYMBOL* aSymbol, const ORCAD_PLACED_INSTANCE& aInst,
                            const ORCAD_SYMBOL_DEF& aDef, int aOrient, const std::string& aValue,
                            const std::string& aFootprint );

    static int toKicadOrientation( int aOrient );

    void computeFontBaseline();

    int fontHeightDbu( int aFontIdx ) const;

    int textSizeIU( int aFontIdx ) const;
 
    void applyFont( EDA_TEXT* aText, int aFontIdx ) const;

    static std::string SymbolId( const std::string& aName );
 
    // ================================================================================
    // implemented in orcad_converter_sheet.cpp
    // ================================================================================

    void convertPage( ORCAD_RAW_PAGE& aPage, SCH_SCREEN* aScreen,
                      const SCH_SHEET_PATH& aSheetPath );

    static wxString MakePageFileName( int aPageIndex, const std::string& aPageName );

    void applyPageSettings( ORCAD_RAW_PAGE& aPage, SCH_SCREEN* aScreen );

    static BOX2I pageExtentDbu( const ORCAD_RAW_PAGE& aPage );

    static void offsetPage( ORCAD_RAW_PAGE& aPage, int aDx, int aDy );

    void applyTitleBlock( const ORCAD_RAW_PAGE& aPage, SCH_SCREEN* aScreen );

    void buildNetLookup( const ORCAD_RAW_PAGE& aPage );

    std::string netAt( const ORCAD_RAW_PAGE& aPage, int aX, int aY ) const;

    std::string powerNet( const ORCAD_RAW_PAGE& aPage, const ORCAD_GRAPHIC_INST& aInst ) const;

    VECTOR2I graphicPinPos( const ORCAD_GRAPHIC_INST& aInst ) const;

    std::vector<OFFPAGE_NET> offpageNets( const ORCAD_RAW_PAGE& aPage ) const;

    std::vector<VECTOR2I> computeJunctions( const ORCAD_RAW_PAGE& aPage ) const;

    void placeJunctions( const ORCAD_RAW_PAGE& aPage, SCH_SCREEN* aScreen );

    void placeWires( const ORCAD_RAW_PAGE& aPage, SCH_SCREEN* aScreen );

    void placeBusEntries( const ORCAD_RAW_PAGE& aPage, SCH_SCREEN* aScreen );

    void placeNoConnects( const ORCAD_RAW_PAGE& aPage, SCH_SCREEN* aScreen );

    void placeOffpageConnectors( const ORCAD_RAW_PAGE& aPage, SCH_SCREEN* aScreen );

    void placePorts( const ORCAD_RAW_PAGE& aPage, SCH_SCREEN* aScreen, bool aHierarchical );

    void placeGraphics( const ORCAD_RAW_PAGE& aPage, SCH_SCREEN* aScreen );

    void placeBitmap( const ORCAD_PRIMITIVE& aPrim, SCH_SCREEN* aScreen, int aOrient = 0 );
 
    void placeDefinitionImages( const ORCAD_SYMBOL_DEF& aDefinition, int aBaseX, int aBaseY, int aOrient,
                                SCH_SCREEN* aScreen );
 
    void placeDefinitionVectors( const ORCAD_SYMBOL_DEF& aDefinition, int aBaseX, int aBaseY, int aOrient,
                                 SCH_SCREEN* aScreen );

    static bool MakeBmpFromDib( const std::vector<uint8_t>& aDib, wxMemoryBuffer& aOut );

    static VECTOR2I snapToWire( int aX, int aY, const ORCAD_WIRE& aWire );

    static bool onSegment( int aX, int aY, const ORCAD_WIRE& aWire );

    static wxString SanitizeFileName( const std::string& aName );
 
private:
    ORCAD_DESIGN&      m_design;
    SCHEMATIC*         m_schematic;
    REPORTER*          m_reporter;
    PROGRESS_REPORTER* m_progressReporter;
    SCH_SHEET*         m_rootSheet;
 
    std::map<std::string, LIB_ENTRY>               m_libSymbols;  
    std::map<PKG_KEY, std::pair<std::string, int>> m_pkgToLib;
    int                                            m_powerCount;      
    int                                            m_fontBaselineDbu; 

    const std::map<uint32_t, std::string>*         m_currentOccRefs = nullptr;

    std::set<wxString>                             m_usedSheetNames;

    std::map<std::pair<int, int>, std::vector<const ORCAD_WIRE*>> m_wireEndpoints;
};
 
#endif // ORCAD_CONVERTER_H_