kicad-source/common/pin_type.h

/*
 * 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 PIN_TYPE_H_
#define PIN_TYPE_H_

#include <wx/arrstr.h>
#include <vector>

enum class BITMAPS : unsigned int;

/**
 * The symbol library pin object electrical types used in ERC tests.
 */
enum class ELECTRICAL_PINTYPE
{
    PT_INPUT,         ///< usual pin input: must be connected
    PT_OUTPUT,        ///< usual output
    PT_BIDI,          ///< input or output (like port for a microprocessor)
    PT_TRISTATE,      ///< tri state bus pin

    /// pin for passive symbols: must be connected, and can be connected to any pin.
    PT_PASSIVE,
    PT_NIC,           ///< not internally connected (may be connected to anything)
    PT_UNSPECIFIED,   ///< unknown electrical properties: creates always a warning when connected
    PT_POWER_IN,      ///< power input (GND, VCC for ICs). Must be connected to a power output.
    PT_POWER_OUT,     ///< output of a regulator: intended to be connected to power input pins
    PT_OPENCOLLECTOR, ///< pin type open collector
    PT_OPENEMITTER,   ///< pin type open emitter
    PT_NC,            ///< not connected (must be left open)

    PT_LAST_OPTION = PT_NC, ///< sentinel value, set to last usable enum option
    PT_INHERIT
};

#define ELECTRICAL_PINTYPES_TOTAL ( static_cast<int>( ELECTRICAL_PINTYPE::PT_LAST_OPTION ) + 1 )

inline wxString GetCanonicalElectricalTypeName( ELECTRICAL_PINTYPE aType )
{
    // These strings are the canonical name of the electrictal type
    // Not translated, no space in name, only ASCII chars.
    // to use when the string name must be known and well defined
    // must have same order than enum ELECTRICAL_PINTYPE (see sch_pin.h)
    static const wxChar* msgPinElectricType[] =
    {
        wxT( "input" ),
        wxT( "output" ),
        wxT( "bidirectional" ),
        wxT( "tri_state" ),
        wxT( "passive" ),
        wxT( "free" ),
        wxT( "unspecified" ),
        wxT( "power_in" ),
        wxT( "power_out" ),
        wxT( "open_collector" ),
        wxT( "open_emitter" ),
        wxT( "no_connect" )
    };

    return msgPinElectricType[static_cast<int>( aType )];
}

enum class GRAPHIC_PINSHAPE
{
    LINE,
    INVERTED,
    CLOCK,
    INVERTED_CLOCK,
    INPUT_LOW,
    CLOCK_LOW,
    OUTPUT_LOW,
    FALLING_EDGE_CLOCK,
    NONLOGIC,

    LAST_OPTION = NONLOGIC, ///< this is the sentinel value, must be set to last enum value
    INHERIT
};

#define GRAPHIC_PINSHAPES_TOTAL ( static_cast<int>( GRAPHIC_PINSHAPE::LAST_OPTION ) + 1 )

/**
 *  The symbol library pin object orientations.
 */
enum class PIN_ORIENTATION
{
    /**
     * The pin extends rightwards from the connection point.
     * Probably on the left side of the symbol.
     * x---|
     */
    PIN_RIGHT,

    /**
     * The pin extends leftwards from the connection point:
     * Probably on the right side of the symbol.
     * |---x
     */
    PIN_LEFT,

    /**
     * The pin extends upwards from the connection point:
     * Probably on the bottom side of the symbol.
     *  ___
     *   |
     *   x
     */
    PIN_UP,

    /**
     * The pin extends downwards from the connection:
     * Probably on the top side of the symbol.
     *   x
     *  _|_
     */
    PIN_DOWN,
    INHERIT
};


// UI

wxString PinShapeGetText( GRAPHIC_PINSHAPE shape );
BITMAPS PinShapeGetBitmap( GRAPHIC_PINSHAPE shape );

wxString ElectricalPinTypeGetText( ELECTRICAL_PINTYPE );
BITMAPS ElectricalPinTypeGetBitmap( ELECTRICAL_PINTYPE );

wxString PinOrientationName( PIN_ORIENTATION aOrientation );
BITMAPS PinOrientationGetBitmap( PIN_ORIENTATION aOrientation );
PIN_ORIENTATION PinOrientationCode( size_t index );
int PinOrientationIndex( PIN_ORIENTATION code );

const wxArrayString& PinTypeNames();
const std::vector<BITMAPS>& PinTypeIcons();

const wxArrayString& PinShapeNames();
const std::vector<BITMAPS>& PinShapeIcons();

const wxArrayString& PinOrientationNames();
const std::vector<BITMAPS>& PinOrientationIcons();

#endif