variant_symbol_utils.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * 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, 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 VARIANT_SYMBOL_UTILS_H
#define VARIANT_SYMBOL_UTILS_H
 
#include <functional>
#include <vector>
#include <wx/string.h>
 
class LIB_ID;
class LIB_SYMBOL;
class SCH_PIN;
 
namespace SCH_CONNECTIVITY
{
struct LIBRARY_SYMBOL_FACT;
}
 

enum class VARIANT_COMPAT_ERROR
{
    NONE,
    MISSING_PIN_NUMBER,    
    EXTRA_PIN_NUMBER,      
    PIN_POSITION_MISMATCH, 
    PIN_TYPE_MISMATCH,     
    INSUFFICIENT_UNITS,    
    MISSING_BODY_STYLE,    
};
 

bool VariantSymbolPinsMatch( const SCH_PIN& aBase, const SCH_PIN& aCandidate );
 
 
struct VARIANT_COMPAT_RESULT
{
    VARIANT_COMPAT_ERROR error = VARIANT_COMPAT_ERROR::NONE;
    wxString             detail;     
    wxString             pinNumber;  
    int                  unit = 0;      
    int                  bodyStyle = 0; 
};
 

using SYMBOL_COMPAT_FUNC = std::function<std::vector<VARIANT_COMPAT_RESULT>( const LIB_ID& )>;
 

std::vector<VARIANT_COMPAT_RESULT> ValidateVariantSymbolCompatibility( const LIB_SYMBOL& aBase,
                                                                        const LIB_SYMBOL& aCandidate );
 
// Compare an owned embedded symbol snapshot against a freshly loaded alternate.
std::vector<VARIANT_COMPAT_RESULT> ValidateVariantSymbolCompatibility(
        const SCH_CONNECTIVITY::LIBRARY_SYMBOL_FACT& aBase, const LIB_SYMBOL& aCandidate );
 
#endif // VARIANT_SYMBOL_UTILS_H