sch_io_eagle.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2017 CERN
 * Copyright (C) 2021-2024 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @author Alejandro García Montoro <[email protected]>
 * @author Maciej Suminski <[email protected]>
 * @author Russell Oliver <[email protected]>
 *
 * 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/>.
 */
 
#ifndef SCH_IO_EAGLE_H_
#define SCH_IO_EAGLE_H_
 
#include <sch_line.h>
#include <sch_io/sch_io.h>
#include <sch_io/sch_io_mgr.h>
#include <io/eagle/eagle_parser.h>
#include <geometry/seg.h>
 
 
class EDA_TEXT;
class KIWAY;
class LINE_READER;
class SCH_SCREEN;
class SCH_SHEET;
class SCH_BITMAP;
class SCH_JUNCTION;
class SCH_NO_CONNECT;
class SCH_SHAPE;
class SCH_LINE;
class SCH_BUS_ENTRY_BASE;
class SCH_TEXT;
class SCH_GLOBALLABEL;
class SCH_SYMBOL;
class SCH_FIELD;
class STRING_UTF8_MAP;
class LIB_SYMBOL;
class SYMBOL_LIB;
class SCH_PIN;
class wxXmlNode;
 
 
struct EAGLE_LIBRARY
{
 wxString name;
 std::map<wxString, std::unique_ptr<LIB_SYMBOL>> KiCadSymbols;
 
 std::unordered_map<wxString, int> GateToUnitMap;
 std::unordered_map<wxString, wxString> package;
};
 
 
class SCH_IO_EAGLE : public SCH_IO
{
public:
 const double ARC_ACCURACY = SCH_IU_PER_MM * 0.01; // 0.01mm
 
 SCH_IO_EAGLE();
 ~SCH_IO_EAGLE();
 
 const IO_BASE::IO_FILE_DESC GetSchematicFileDesc() const override
 {
 return IO_BASE::IO_FILE_DESC( _HKI( "Eagle XML schematic files" ), { "sch" } );
 }
 
 const IO_BASE::IO_FILE_DESC GetLibraryDesc() const override
 {
 return IO_BASE::IO_FILE_DESC( _HKI( "Eagle XML library files" ), { "lbr" } );
 }
 
 bool CanReadSchematicFile( const wxString& aFileName ) const override;
 bool CanReadLibrary( const wxString& aFileName ) const override;
 
 int GetModifyHash() const override;
 
 SCH_SHEET* LoadSchematicFile( const wxString& aFileName, SCHEMATIC* aSchematic,
 SCH_SHEET* aAppendToMe = nullptr,
 const STRING_UTF8_MAP* aProperties = nullptr ) override;
 
 void EnumerateSymbolLib( wxArrayString& aSymbolNameList, const wxString& aLibraryPath,
 const STRING_UTF8_MAP* aProperties ) override;
 
 void EnumerateSymbolLib( std::vector<LIB_SYMBOL*>& aSymbolList, const wxString& aLibraryPath,
 const STRING_UTF8_MAP* aProperties ) override;
 
 LIB_SYMBOL* LoadSymbol( const wxString& aLibraryPath, const wxString& aAliasName,
 const STRING_UTF8_MAP* aProperties ) override;
 
 bool IsLibraryWritable( const wxString& aLibraryPath ) override { return false; }
 
private:
 bool checkHeader( const wxString& aFileName ) const;
 wxXmlDocument loadXmlDocument( const wxString& aFileName );
 long long getLibraryTimestamp( const wxString& aLibraryPath ) const;
 void ensureLoadedLibrary( const wxString& aLibraryPath );
 
 void loadDrawing( const std::unique_ptr<EDRAWING>& aDrawing );
 void loadLayerDefs( const std::vector<std::unique_ptr<ELAYER>>& aLayers );
 void loadSchematic( const ESCHEMATIC& aSchematic );
 void loadSheet( const std::unique_ptr<ESHEET>& aSheet );
 void loadInstance( const std::unique_ptr<EINSTANCE>& aInstance,
 const std::map<wxString, std::unique_ptr<EPART>>& aParts );
 
 SCH_SHEET* loadModuleInstance( const std::unique_ptr<EMODULEINST>& aModuleInstance );
 
 EAGLE_LIBRARY* loadLibrary( const ELIBRARY* aLibrary, EAGLE_LIBRARY* aEagleLib );
 void countNets( const ESCHEMATIC& aSchematic );
 
 void moveLabels( SCH_LINE* aWire, const VECTOR2I& aNewEndPoint );
 
 void addBusEntries();
 
 SCH_LAYER_ID kiCadLayer( int aEagleLayer );
 
 std::pair<VECTOR2I, const SEG*> findNearestLinePoint( const VECTOR2I& aPoint,
 const std::vector<SEG>& aLines ) const;
 
 void loadSegments( const std::vector<std::unique_ptr<ESEGMENT>>& aSegments,
 const wxString& aNetName,
 const wxString& aNetClass );
 SCH_SHAPE* loadPolyLine( const std::unique_ptr<EPOLYGON>& aPolygon );
 SCH_ITEM* loadWire( const std::unique_ptr<EWIRE>& aWire, SEG& endpoints );
 SCH_SHAPE* loadCircle( const std::unique_ptr<ECIRCLE>& aCircle );
 SCH_SHAPE* loadRectangle( const std::unique_ptr<ERECT>& aRect );
 SCH_TEXT* loadLabel( const std::unique_ptr<ELABEL>& aLabel, const wxString& aNetName );
 SCH_JUNCTION* loadJunction( const std::unique_ptr<EJUNCTION>& aJunction );
 SCH_TEXT* loadPlainText( const std::unique_ptr<ETEXT>& aSchText );
 void loadFrame( const std::unique_ptr<EFRAME>& aFrame,
 std::vector<SCH_ITEM*>& aItems );
 
 bool loadSymbol( const std::unique_ptr<ESYMBOL>& aEsymbol,
 std::unique_ptr<LIB_SYMBOL>& aSymbol,
 const std::unique_ptr<EDEVICE>& aDevice, int aGateNumber,
 const wxString& aGateName );
 SCH_SHAPE* loadSymbolCircle( std::unique_ptr<LIB_SYMBOL>& aSymbol,
 const std::unique_ptr<ECIRCLE>& aCircle,
 int aGateNumber );
 SCH_SHAPE* loadSymbolRectangle( std::unique_ptr<LIB_SYMBOL>& aSymbol,
 const std::unique_ptr<ERECT>& aRectangle,
 int aGateNumber );
 SCH_SHAPE* loadSymbolPolyLine( std::unique_ptr<LIB_SYMBOL>& aSymbol,
 const std::unique_ptr<EPOLYGON>& aPolygon, int aGateNumber );
 SCH_ITEM* loadSymbolWire( std::unique_ptr<LIB_SYMBOL>& aSymbol,
 const std::unique_ptr<EWIRE>& aWire,
 int aGateNumber );
 SCH_PIN* loadPin( std::unique_ptr<LIB_SYMBOL>& aSymbol, const std::unique_ptr<EPIN>& aPin,
 int aGateNumber );
 SCH_TEXT* loadSymbolText( std::unique_ptr<LIB_SYMBOL>& aSymbol,
 const std::unique_ptr<ETEXT>& aText,
 int aGateNumber );
 void loadTextAttributes( EDA_TEXT* aText,
 const std::unique_ptr<ETEXT>& aAttributes ) const;
 void loadFieldAttributes( SCH_FIELD* aField, const SCH_TEXT* aText ) const;
 
 void adjustNetLabels();
 
 wxString translateEagleBusName( const wxString& aEagleName ) const;
 
 wxString getLibName();
 wxFileName getLibFileName();
 
 bool checkConnections( const SCH_SYMBOL* aSymbol, const SCH_PIN* aPin ) const;
 
 void addImplicitConnections( SCH_SYMBOL* aSymbol, SCH_SCREEN* aScreen, bool aUpdateSet );
 
 bool netHasPowerDriver( SCH_LINE* aLine, const wxString& aNetName ) const;
 
 void getEagleSymbolFieldAttributes( const std::unique_ptr<EINSTANCE>& aInstance,
 const wxString& aEagleFieldName,
 SCH_FIELD* aField );
 const ESYMBOL* getEagleSymbol( const std::unique_ptr<EINSTANCE>& aInstance );
 
 SCH_SHEET* getCurrentSheet();
 SCH_SCREEN* getCurrentScreen();
 
 // Describe missing units containing pins creating implicit connections
 // (named power pins in Eagle).
 struct EAGLE_MISSING_CMP
 {
 EAGLE_MISSING_CMP( const SCH_SYMBOL* aSymbol = nullptr )
 : cmp( aSymbol )
 {
 }
 
 const SCH_SYMBOL* cmp;
 
 /* Map of the symbol units: for each unit there is a flag saying
 * whether the unit needs to be instantiated with appropriate net labels to
 * emulate implicit connections as is done in Eagle.
 */
 std::map<int, bool> units;
 };
 
 std::map<wxString, EAGLE_MISSING_CMP> m_missingCmps;
 
 SCH_SHEET* m_rootSheet; 
 SCH_SHEET_PATH m_sheetPath; 
 wxString m_version; 
 wxFileName m_filename;
 wxString m_libName; 
 SCHEMATIC* m_schematic; 
 EMODULE* m_module; 
 
 std::map<wxString, const EPART*> m_partlist;
 std::map<wxString, long long> m_timestamps;
 std::map<wxString, EAGLE_LIBRARY> m_eagleLibs;
 std::map<wxString, std::unique_ptr<EMODULE>> m_eagleModules;
 
 std::unordered_map<wxString, bool> m_userValue; 
 
 IO_RELEASER<SCH_IO> m_pi; 
 std::unique_ptr<STRING_UTF8_MAP> m_properties; 
 
 int m_sheetIndex;
 
 std::map<wxString, int> m_netCounts;
 std::map<int, SCH_LAYER_ID> m_layerMap;
 std::map<wxString, wxString> m_powerPorts; 
 
 std::vector<VECTOR2I> m_wireIntersections;
 
 struct SEG_DESC
 {
 const SEG* LabelAttached( const SCH_TEXT* aLabel ) const;
 
 std::vector<SCH_TEXT*> labels;
 std::vector<SEG> segs;
 };
 
 std::vector<SEG_DESC> m_segments;
 
 std::map<wxString, ENET> m_nets;
 
 std::map<VECTOR2I, std::set<const EDA_ITEM*>> m_connPoints;
 
 std::unique_ptr<EAGLE_DOC> m_eagleDoc;
};
 
#endif // SCH_IO_EAGLE_H_