netlist_exporter_allegro.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 The 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, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef NETLIST_EXPORTER_ALLEGRO_H
#define NETLIST_EXPORTER_ALLEGRO_H
 
#include "netlist_exporter_base.h"
#include <list>
#include <sch_pin.h>
#include <symbol.h>

class NETLIST_EXPORTER_ALLEGRO : public NETLIST_EXPORTER_BASE
{
public:
    NETLIST_EXPORTER_ALLEGRO( SCHEMATIC* aSchematic, KIWAY* aKiway ) :
            NETLIST_EXPORTER_BASE( aSchematic, aKiway ),
            m_f( nullptr )
    {
    }

    bool writeNetlist( const wxString& aOutFileName, unsigned aNetlistOptions, REPORTER& aReporter ) override;

    static bool CompareSymbolSheetpath( const std::pair<SCH_SYMBOL*, SCH_SHEET_PATH>& aItem1,
                                        const std::pair<SCH_SYMBOL*, SCH_SHEET_PATH>& aItem2 );

    static bool CompareSymbolRef( const wxString& aRefText1, const wxString& aRefText2 );

    static bool CompareLibPin( const SCH_PIN* aPin1, const SCH_PIN* aPin2 );

    static wxString formatRoom( const SCH_SHEET_PATH& aSheetPath );
 
private:
    void extractComponentsInfo();

    bool toAllegroPackages();

    void toAllegroNets();

    void toAllegroPackageProperties();

    wxString formatDevice( wxString aString );

    wxString formatText( wxString aString );

    wxString formatPin( const SCH_PIN& aPin );

    wxString formatFunction( wxString aName, std::vector<SCH_PIN*> aPinList );

    wxString getGroupField( int aGroupIndex, const wxArrayString& aFieldArray, bool aSanitize = true );

    static wxString removeTailDigits( wxString aString );

    static unsigned int extractTailNumber( wxString aString );
 
    struct NET_NODE
    {
        NET_NODE( SCH_PIN* aPin, const SCH_SHEET_PATH& aSheet ) :
                m_Pin( aPin ),
                m_Sheet( aSheet )
        {}
 
        bool operator<( const NET_NODE& aNetNode ) const
        {
            wxString refText1 = m_Pin->GetParentSymbol()->GetRef( &m_Sheet );
            wxString refText2 = aNetNode.m_Pin->GetParentSymbol()->GetRef( &aNetNode.m_Sheet );
 
            if( refText1 == refText2 )
            {
                unsigned long val1, val2;
 
                //From wxWidgets 3.1.6, the function ToULong can be replaced with ToUInt
                bool convertingResult = m_Pin->GetShownNumber().ToULong( &val1 );
                convertingResult &= aNetNode.m_Pin->GetShownNumber().ToULong( &val2 );
 
                if( convertingResult )
                {
                    return val1 < val2;
                }
                else
                {
                    return m_Pin->GetShownNumber() < aNetNode.m_Pin->GetShownNumber();
                }
            }
 
            return CompareSymbolRef( refText1, refText2 );
        }
 
        SCH_PIN*       m_Pin;
        SCH_SHEET_PATH m_Sheet;
    };
 
    FILE* m_f            ;    
    wxString m_exportPath;    
    std::multimap<wxString, wxString> m_packageProperties;

    std::multimap<int, std::pair<SCH_SYMBOL*, SCH_SHEET_PATH> > m_componentGroups;

    std::list<std::pair<SCH_SYMBOL*, SCH_SHEET_PATH>> m_orderedSymbolsSheetpath;
    std::multimap<wxString, NET_NODE> m_netNameNodes;    
};
 
#endif