KiCad PCB EDA Suite
netlist_exporter_orcadpcb2.cpp
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 1992-2018 jp.charras at wanadoo.fr
5 * Copyright (C) 2013 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
6 * Copyright (C) 1992-2022 KiCad Developers, see AUTHORS.txt for contributors.
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version 2
11 * of the License, or (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, you may find one here:
20 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21 * or you may search the http://www.gnu.org website for the version 2 license,
22 * or you may write to the Free Software Foundation, Inc.,
23 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24 */
25
26#include <confirm.h>
27#include <refdes_utils.h>
28
29#include <sch_edit_frame.h>
30#include <sch_reference_list.h>
31#include <string_utils.h>
32#include <symbol_library.h>
33#include <symbol_lib_table.h>
34
35#include <netlist.h>
37
38
39bool NETLIST_EXPORTER_ORCADPCB2::WriteNetlist( const wxString& aOutFileName,
40 unsigned /* aNetlistOptions */,
41 REPORTER& aReporter )
42{
43 FILE* f = nullptr;
44 wxString field;
45 wxString footprint;
46 int ret = 0; // zero now, OR in the sign bit on error
47 wxString netName;
48
49
50 if( ( f = wxFopen( aOutFileName, wxT( "wt" ) ) ) == nullptr )
51 {
52 wxString msg = wxString::Format( _( "Failed to create file '%s'." ), aOutFileName );
53 aReporter.Report( msg, RPT_SEVERITY_ERROR );
54 return false;
55 }
56
57 std::vector< SCH_REFERENCE > cmpList;
58
59 ret |= fprintf( f, "( { %s created %s }\n",
61
62 // Create netlist footprints section
64
66
67 for( unsigned i = 0; i < sheetList.size(); i++ )
68 {
69 SCH_SHEET_PATH sheet = sheetList[i];
70
71 // Process symbol attributes
72 for( EDA_ITEM* item : sheet.LastScreen()->Items().OfType( SCH_SYMBOL_T ) )
73 {
74 SCH_SYMBOL* symbol = findNextSymbol( item, &sheet );
75
76 if( !symbol )
77 continue;
78
79 if( !symbol->GetIncludeOnBoard() )
80 continue;
81
82 CreatePinList( symbol, &sheet, true );
83
84 if( symbol->GetLibSymbolRef()
85 && symbol->GetLibSymbolRef()->GetFPFilters().GetCount() != 0 )
86 {
87 cmpList.push_back( SCH_REFERENCE( symbol, symbol->GetLibSymbolRef().get(),
88 sheet ) );
89 }
90
91 footprint = symbol->GetFootprintFieldText( true );
92 footprint.Replace( wxT( " " ), wxT( "_" ) );
93
94 if( footprint.IsEmpty() )
95 footprint = wxT( "$noname" );
96
97 ret |= fprintf( f, " ( %s %s",
98 TO_UTF8( sheet.PathAsString() + symbol->m_Uuid.AsString() ),
99 TO_UTF8( footprint ) );
100
101 field = symbol->GetRef( &sheet );
102
103 ret |= fprintf( f, " %s", TO_UTF8( field ) );
104
105 field = symbol->GetValueFieldText( true );
106 field.Replace( wxT( " " ), wxT( "_" ) );
107
108 ret |= fprintf( f, " %s", TO_UTF8( field ) );
109
110 ret |= fprintf( f, "\n" );
111
112 // Write pin list:
113 for( const PIN_INFO& pin : m_sortedSymbolPinList )
114 {
115 if( pin.num.IsEmpty() ) // Erased pin in list
116 continue;
117
118 netName = pin.netName;
119 netName.Replace( wxT( " " ), wxT( "_" ) );
120
121 ret |= fprintf( f, " ( %4.4s %s )\n", TO_UTF8( pin.num ), TO_UTF8( netName ) );
122 }
123
124 ret |= fprintf( f, " )\n" );
125 }
126 }
127
128 ret |= fprintf( f, ")\n*\n" );
129
130 fclose( f );
131
132 return ret >= 0;
133}
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:85
const KIID m_Uuid
Definition: eda_item.h:492
EE_TYPE OfType(KICAD_T aType) const
Definition: sch_rtree.h:238
wxString AsString() const
Definition: kiid.cpp:257
void CreatePinList(SCH_SYMBOL *aSymbol, SCH_SHEET_PATH *aSheetPath, bool aKeepUnconnectedPins)
Find a symbol from the DrawList and builds its pin list in m_sortedSymbolPinList.
UNIQUE_STRINGS m_referencesAlreadyFound
Used for "multiple symbols per package" symbols to avoid processing a lib symbol more than once.
SCH_SYMBOL * findNextSymbol(EDA_ITEM *aItem, SCH_SHEET_PATH *aSheetPath)
Check if the given symbol should be processed for netlisting.
SCHEMATIC_IFACE * m_schematic
The schematic we're generating a netlist for.
std::vector< PIN_INFO > m_sortedSymbolPinList
Used to temporarily store and filter the list of pins of a schematic symbol when generating schematic...
bool WriteNetlist(const wxString &aOutFileName, unsigned aNetlistOptions, REPORTER &aReporter) override
Write to specified output file.
A pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:71
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)=0
Report a string with a given severity.
virtual SCH_SHEET_LIST GetSheets() const =0
A helper to define a symbol's reference designator in a schematic.
EE_RTREE & Items()
Gets the full RTree, usually for iterating.
Definition: sch_screen.h:109
A container for handling SCH_SHEET_PATH objects in a flattened hierarchy.
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
SCH_SCREEN * LastScreen()
wxString PathAsString() const
Return the path of time stamps which do not changes even when editing sheet parameters.
Schematic symbol object.
Definition: sch_symbol.h:81
const wxString GetRef(const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false) const
Return the reference for the given sheet path.
Definition: sch_symbol.cpp:652
bool GetIncludeOnBoard() const
Definition: sch_symbol.h:750
const wxString GetFootprintFieldText(bool aResolve) const
Definition: sch_symbol.cpp:828
const wxString GetValueFieldText(bool aResolve) const
Definition: sch_symbol.cpp:813
std::unique_ptr< LIB_SYMBOL > & GetLibSymbolRef()
Definition: sch_symbol.h:192
void Clear()
Erase the record.
This file is part of the common library.
#define _(s)
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:96
#define NETLIST_HEAD_STRING
Definition: netlist.h:52
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
Collection of utility functions for component reference designators (refdes)
@ RPT_SEVERITY_ERROR
wxString DateAndTime()
Definition for symbol library class.
@ SCH_SYMBOL_T
Definition: typeinfo.h:156