/* * This program source code file is part of KiCad, a free EDA CAD application. * * Copyright (C) 2019 CERN * * 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 2 * 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, you may find one here: * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html * or you may search the http://www.gnu.org website for the version 2 license, * or you may write to the Free Software Foundation, Inc., * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include static double iu2hyp( double iu ) { return iu / 1e9 / 0.0254; } class HYPERLYNX_EXPORTER; class HYPERLYNX_PAD_STACK { public: friend class HYPERLYNX_EXPORTER; HYPERLYNX_PAD_STACK( BOARD* aBoard, const D_PAD* aPad ); HYPERLYNX_PAD_STACK( BOARD* aBoard, const VIA* aVia ); ~HYPERLYNX_PAD_STACK(){}; bool isThrough() const { return m_type == PAD_ATTRIB_HOLE_NOT_PLATED || m_type == PAD_ATTRIB_STANDARD; } bool operator==( const HYPERLYNX_PAD_STACK& other ) const { if( m_shape != other.m_shape ) return false; if( m_type != other.m_type ) return false; if( isThrough() && other.isThrough() && m_drill != other.m_drill ) return false; if( m_sx != other.m_sx ) return false; if( m_sy != other.m_sy ) return false; if( m_layers != other.m_layers ) return false; if( m_angle != other.m_angle ) return false; return true; } bool isSMD() const { return m_type == PAD_ATTRIB_SMD; } PCB_LAYER_ID getSMDLayer() const { for( auto l : LSET::AllCuMask().Seq() ) { if( m_layers[l] ) return l; } return F_Cu; } void SetId( int id ) { m_id = id; } int GetId() const { return m_id; } int IsSupportedByExporter() const { switch( m_shape ) { case PAD_SHAPE_CIRCLE: case PAD_SHAPE_OVAL: case PAD_SHAPE_ROUNDRECT: case PAD_SHAPE_RECT: return true; default: return false; } } bool isEmpty() const { LSET layerMask = LSET::AllCuMask() & m_board->GetEnabledLayers(); LSET outLayers = m_layers & layerMask; return outLayers.none(); } private: BOARD* m_board; int m_id; int m_drill; PAD_SHAPE_T m_shape; int m_sx, m_sy; double m_angle; LSET m_layers; PAD_ATTR_T m_type; }; class HYPERLYNX_EXPORTER : public BOARD_EXPORTER_BASE { public: HYPERLYNX_EXPORTER(){}; ~HYPERLYNX_EXPORTER(){}; virtual bool Run() override; private: HYPERLYNX_PAD_STACK* addPadStack( HYPERLYNX_PAD_STACK stack ) { for( auto p : m_padStacks ) { if( *p == stack ) return p; } stack.SetId( m_padStacks.size() ); m_padStacks.push_back( new HYPERLYNX_PAD_STACK( stack ) ); return m_padStacks.back(); } const std::string formatPadShape( HYPERLYNX_PAD_STACK& aStack ) { int shapeId = 0; char buf[1024]; switch( aStack.m_shape ) { case PAD_SHAPE_CIRCLE: case PAD_SHAPE_OVAL: shapeId = 0; break; case PAD_SHAPE_ROUNDRECT: shapeId = 2; break; case PAD_SHAPE_RECT: shapeId = 1; break; default: shapeId = 0; if( m_reporter ) { m_reporter->Report( _( "File contains pad shapes that are not supported by the Hyperlynx exporter\n" "(Supported shapes are oval, rectangle, circle.)\n" "They have been exported as oval pads." ), REPORTER::RPT_WARNING ); } break; } snprintf( buf, sizeof( buf ), "%d, %.9f, %.9f, %.1f, M", shapeId, iu2hyp( aStack.m_sx ), iu2hyp( aStack.m_sy ), aStack.m_angle ); return buf; } bool generateHeaders(); bool writeBoardInfo(); bool writeStackupInfo(); bool writeDevices(); bool writePadStacks(); bool writeNets(); bool writeNetObjects( const std::vector& aObjects ); void writeSinglePadStack( HYPERLYNX_PAD_STACK& aStack ); const std::vector collectNetObjects( int netcode ); std::vector m_padStacks; std::map m_padMap; std::shared_ptr m_out; int m_polyId; }; HYPERLYNX_PAD_STACK::HYPERLYNX_PAD_STACK( BOARD* aBoard, const D_PAD* aPad ) { m_board = aBoard; m_sx = aPad->GetSize().x; m_sy = aPad->GetSize().y; m_angle = 180.0 - ( aPad->GetOrientation() / 10.0 ); if( m_angle < 0.0 ) { m_angle += 360.0; } m_layers = aPad->GetLayerSet(); m_drill = aPad->GetDrillSize().x; m_shape = aPad->GetShape(); m_type = PAD_ATTRIB_STANDARD; } HYPERLYNX_PAD_STACK::HYPERLYNX_PAD_STACK( BOARD* aBoard, const VIA* aVia ) { m_board = aBoard; m_sx = m_sy = aVia->GetWidth(); m_angle = 0; m_layers = LSET::AllCuMask(); m_drill = aVia->GetDrillValue(); m_shape = PAD_SHAPE_CIRCLE; m_type = PAD_ATTRIB_STANDARD; } bool HYPERLYNX_EXPORTER::generateHeaders() { m_out->Print( 0, "{VERSION=2.14}\n" ); m_out->Print( 0, "{UNITS=ENGLISH LENGTH}\n\n" ); return true; } void HYPERLYNX_EXPORTER::writeSinglePadStack( HYPERLYNX_PAD_STACK& aStack ) { LSET layerMask = LSET::AllCuMask() & m_board->GetEnabledLayers(); LSET outLayers = aStack.m_layers & layerMask; if( outLayers.none() ) return; m_out->Print( 0, "{PADSTACK=%d, %.9f\n", aStack.m_id, iu2hyp( aStack.m_drill ) ); if( outLayers == layerMask ) { m_out->Print( 1, "(\"%s\", %s)\n", "MDEF", formatPadShape( aStack ).c_str() ); } else { for( auto l : outLayers.Seq() ) { m_out->Print( 1, "(\"%s\", %s)\n", (const char*) m_board->GetLayerName( l ).c_str(), formatPadShape( aStack ).c_str() ); } } m_out->Print( 0, "}\n\n" ); } bool HYPERLYNX_EXPORTER::writeBoardInfo() { SHAPE_POLY_SET outlines; wxString errText; wxPoint errLoc; m_out->Print( 0, "{BOARD \"%s\"\n", (const char*) m_board->GetFileName().c_str() ); if( !m_board->GetBoardPolygonOutlines( outlines, &errText, &errLoc ) ) { return false; } for( int o = 0; o < outlines.OutlineCount(); o++ ) { const auto& outl = outlines.COutline( o ); for( int i = 0; i < outl.SegmentCount(); i++ ) { const auto& s = outl.CSegment( i ); m_out->Print( 1, "(PERIMETER_SEGMENT X1=%.9f Y1=%.9f X2=%.9f Y2=%.9f)\n", iu2hyp( s.A.x ), iu2hyp( s.A.y ), iu2hyp( s.B.x ), iu2hyp( s.B.y ) ); } } m_out->Print( 0, "}\n\n" ); return true; } bool HYPERLYNX_EXPORTER::writeStackupInfo() { auto layers = m_board->GetDesignSettings().GetEnabledLayers().CuStack(); m_out->Print( 0, "{STACKUP\n" ); for( auto l : layers ) { const auto name = m_board->GetLayerName( l ); m_out->Print( 1, "(SIGNAL T=0.002284 P=0.000000 C=1.724e-8 L=\"%s\" M=COPPER)\n", (const char*) name.c_str() ); if( l != B_Cu ) { m_out->Print( 1, "(DIELECTRIC T=0.007087 C=3.660000 L=\"DE_%s\" M=FR4)\n", (const char*) name.c_str() ); } } m_out->Print( 0, "}\n\n" ); return true; } bool HYPERLYNX_EXPORTER::writeDevices() { m_out->Print( 0, "{DEVICES\n" ); for( auto mod : m_board->Modules() ) { wxString ref = mod->GetReference(); auto layerName = m_board->GetLayerName( mod->GetLayer() ); if( ref.IsEmpty() ) ref = "EMPTY"; m_out->Print( 1, "(? REF=\"%s\" L=\"%s\")\n", (const char*) ref.c_str(), (const char*) layerName.c_str() ); } m_out->Print( 0, "}\n\n" ); return true; } bool HYPERLYNX_EXPORTER::writePadStacks() { for( auto mod : m_board->Modules() ) { for( auto pad : mod->Pads() ) { auto ps = addPadStack( HYPERLYNX_PAD_STACK( m_board, pad ) ); m_padMap[pad] = ps; } } for( auto trk : m_board->Tracks() ) { if( VIA* via = dyn_cast( trk ) ) { auto ps = addPadStack( HYPERLYNX_PAD_STACK( m_board, via ) ); m_padMap[via] = ps; } } for( auto pstack : m_padStacks ) writeSinglePadStack( *pstack ); return true; } bool HYPERLYNX_EXPORTER::writeNetObjects( const std::vector& aObjects ) { for( auto item : aObjects ) { if( D_PAD* pad = dyn_cast( item ) ) { auto pstackIter = m_padMap.find( pad ); if( pstackIter != m_padMap.end() ) { wxString ref = pad->GetParent()->GetReference(); if( ref.IsEmpty() ) ref = "EMPTY"; auto padName = pad->GetName(); if( padName.IsEmpty() ) padName = "1"; m_out->Print( 1, "(PIN X=%.10f Y=%.10f R=\"%s.%s\" P=%d)\n", iu2hyp( pad->GetPosition().x ), iu2hyp( pad->GetPosition().y ), (const char*) ref.c_str(), (const char*) padName.c_str(), pstackIter->second->GetId() ); } } else if( VIA* via = dyn_cast( item ) ) { auto pstackIter = m_padMap.find( via ); if( pstackIter != m_padMap.end() ) { m_out->Print( 1, "(VIA X=%.10f Y=%.10f P=%d)\n", iu2hyp( via->GetPosition().x ), iu2hyp( via->GetPosition().y ), pstackIter->second->GetId() ); } } else if( TRACK* track = dyn_cast( item ) ) { const auto layerName = m_board->GetLayerName( track->GetLayer() ); m_out->Print( 1, "(SEG X1=%.10f Y1=%.10f X2=%.10f Y2=%.10f W=%.10f L=\"%s\")\n", iu2hyp( track->GetStart().x ), iu2hyp( track->GetStart().y ), iu2hyp( track->GetEnd().x ), iu2hyp( track->GetEnd().y ), iu2hyp( track->GetWidth() ), (const char*) layerName.c_str() ); } else if( ZONE_CONTAINER* zone = dyn_cast( item ) ) { const auto layerName = m_board->GetLayerName( zone->GetLayer() ); SHAPE_POLY_SET filledShape = zone->GetFilledPolysList(); filledShape.Simplify( SHAPE_POLY_SET::PM_FAST ); for( int i = 0; i < filledShape.OutlineCount(); i++ ) { const auto& outl = filledShape.COutline( i ); auto p0 = outl.CPoint( 0 ); m_out->Print( 1, "{POLYGON T=POUR L=\"%s\" ID=%d X=%.10f Y=%.10f\n", (const char*) layerName.c_str(), m_polyId, iu2hyp( p0.x ), iu2hyp( p0.y ) ); for( int v = 0; v < outl.PointCount(); v++ ) { m_out->Print( 2, "(LINE X=%.10f Y=%.10f)\n", iu2hyp( outl.CPoint( v ).x ), iu2hyp( outl.CPoint( v ).y ) ); } m_out->Print( 2, "(LINE X=%.10f Y=%.10f)\n", iu2hyp( p0.x ), iu2hyp( p0.y ) ); m_out->Print( 1, "}\n" ); for( int h = 0; h < filledShape.HoleCount( i ); h++ ) { const auto& holeShape = filledShape.CHole( i, h ); auto ph0 = holeShape.CPoint( 0 ); m_out->Print( 1, "{POLYVOID ID=%d X=%.10f Y=%.10f\n", m_polyId, iu2hyp( ph0.x ), iu2hyp( ph0.y ) ); for( int v = 0; v < holeShape.PointCount(); v++ ) { m_out->Print( 2, "(LINE X=%.10f Y=%.10f)\n", iu2hyp( holeShape.CPoint( v ).x ), iu2hyp( holeShape.CPoint( v ).y ) ); } m_out->Print( 2, "(LINE X=%.10f Y=%.10f)\n", iu2hyp( ph0.x ), iu2hyp( ph0.y ) ); m_out->Print( 1, "}\n" ); } m_polyId++; } } } return true; } const std::vector HYPERLYNX_EXPORTER::collectNetObjects( int netcode ) { std::vector rv; auto check = [&]( BOARD_CONNECTED_ITEM* item ) -> bool { if( ( item->GetLayerSet() & LSET::AllCuMask() ).none() ) return false; if( item->GetNetCode() == netcode || ( netcode < 0 && item->GetNetCode() <= 0 ) ) return true; return false; }; for( auto mod : m_board->Modules() ) { for( auto pad : mod->Pads() ) { if( check( pad ) ) rv.push_back( pad ); } } for( auto item : m_board->Tracks() ) if( check( item ) ) rv.push_back( item ); for( int i = 0; i < m_board->GetAreaCount(); i++ ) { auto zone = m_board->GetArea( i ); if( check( zone ) ) rv.push_back( zone ); } return rv; } bool HYPERLYNX_EXPORTER::writeNets() { m_polyId = 1; for( const auto netInfo : m_board->GetNetInfo() ) { int netcode = netInfo->GetNet(); bool isNullNet = netInfo->GetNet() <= 0 || netInfo->GetNetname().IsEmpty(); if( isNullNet ) continue; auto netObjects = collectNetObjects( netcode ); if( netObjects.size() ) { m_out->Print( 0, "{NET=\"%s\"\n", (const char*) netInfo->GetNetname().c_str() ); writeNetObjects( netObjects ); m_out->Print( 0, "}\n\n" ); } } auto nullNetObjects = collectNetObjects( -1 ); int idx = 0; for( auto item : nullNetObjects ) { m_out->Print( 0, "{NET=\"EmptyNet%d\"\n", idx ); writeNetObjects( { item } ); m_out->Print( 0, "}\n\n" ); idx++; } return true; } bool HYPERLYNX_EXPORTER::Run() { LOCALE_IO toggle; // toggles on, then off, the C locale. try { m_out.reset( new FILE_OUTPUTFORMATTER( m_outputFilePath.GetFullPath() ) ); generateHeaders(); writeBoardInfo(); writeStackupInfo(); writeDevices(); writePadStacks(); writeNets(); } catch( IO_ERROR& err ) { return false; } return true; } bool ExportBoardToHyperlynx( BOARD* aBoard, const wxFileName& aPath ) { HYPERLYNX_EXPORTER exporter; exporter.SetBoard( aBoard ); exporter.SetOutputFilename( aPath ); return exporter.Run(); }