netlist_exporter_xml.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 1992-2013 jp.charras at wanadoo.fr
 * Copyright (C) 2013 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
 * Copyright (C) 1992-2021 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 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
 */
 
#ifndef NETLIST_EXPORT_XML_H
#define NETLIST_EXPORT_XML_H
 
#include <netlist_exporter_base.h>
 
#include <project.h>
 
#include <sch_edit_frame.h>
 
class CONNECTION_GRAPH;
class SYMBOL_LIB_TABLE;
class XNODE;
 
#define GENERIC_INTERMEDIATE_NETLIST_EXT wxT( "xml" )
 
enum GNL_T
{
    GNL_LIBRARIES   = 1 << 0,
    GNL_SYMBOLS     = 1 << 1,
    GNL_PARTS       = 1 << 2,
    GNL_HEADER      = 1 << 3,
    GNL_NETS        = 1 << 4,
    GNL_OPT_KICAD   = 1 << 5,
    GNL_OPT_BOM     = 1 << 6,
};
 
 
class NETLIST_EXPORTER_XML : public NETLIST_EXPORTER_BASE
{
public:
    NETLIST_EXPORTER_XML( SCHEMATIC* aSchematic ) :
            NETLIST_EXPORTER_BASE( aSchematic ),
            m_resolveTextVars( true )
    {}
 
    bool WriteNetlist( const wxString& aOutFileName, unsigned aNetlistOptions,
                       REPORTER& aReporter ) override;
 
#define GNL_ALL     ( GNL_LIBRARIES | GNL_SYMBOLS | GNL_PARTS | GNL_HEADER | GNL_NETS )
 
protected:
    XNODE* node( const wxString& aName, const wxString& aTextualContent = wxEmptyString );
 
    XNODE* makeRoot( unsigned aCtl = GNL_ALL );
 
    XNODE* makeSymbols( unsigned aCtl );
 
    XNODE* makeDesignHeader();
 
    XNODE* makeLibParts();
 
    XNODE* makeListOfNets( unsigned aCtl );
 
    XNODE* makeLibraries();
 
    void addSymbolFields( XNODE* aNode, SCH_SYMBOL* aSymbol, const SCH_SHEET_PATH& aSheet,
                          const SCH_SHEET_LIST& aSheetList);
 
    std::vector<wxString>
    getComponentClassNamesForAllSymbolUnits( SCH_SYMBOL*           aSymbol,
                                             const SCH_SHEET_PATH& aSymbolSheet,
                                             const SCH_SHEET_LIST& aSheetList );
 
    bool                m_resolveTextVars;   // Export textVar references resolved
 
private:
    std::set<wxString>  m_libraries;         // Set of library nicknames.
};
 
#endif