ADDED: alternate pin functions in context menu.

Fixes https://gitlab.com/kicad/code/kicad/-/issues/12852

eeschema/dialogs/dialog_pin_properties_base.cpp

@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////
-// C++ code generated with wxFormBuilder (version 3.10.1-0-g8feb16b3)
+// C++ code generated with wxFormBuilder (version 3.10.1-0-g8feb16b)
 // http://www.wxformbuilder.org/
 //
 // PLEASE DO *NOT* EDIT THIS FILE!
@@ -185,7 +185,7 @@ DIALOG_PIN_PROPERTIES_BASE::DIALOG_PIN_PROPERTIES_BASE( wxWindow* parent, wxWind
 	wxBoxSizer* bLowerSizer;
 	bLowerSizer = new wxBoxSizer( wxVERTICAL );
 
-	m_alternatesTurndown = new wxCollapsiblePane( this, wxID_ANY, _("Alternate pin definitions"), wxDefaultPosition, wxDefaultSize, wxCP_DEFAULT_STYLE|wxCP_NO_TLW_RESIZE );
+	m_alternatesTurndown = new wxCollapsiblePane( this, wxID_ANY, _("Alternate pin function definitions"), wxDefaultPosition, wxDefaultSize, wxCP_DEFAULT_STYLE|wxCP_NO_TLW_RESIZE );
 	m_alternatesTurndown->Collapse( true );
 
 	wxBoxSizer* bAlternatesSizer;
@@ -313,4 +313,3 @@ DIALOG_PIN_PROPERTIES_BASE::~DIALOG_PIN_PROPERTIES_BASE()
 	m_deleteAlternate->Disconnect( wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler( DIALOG_PIN_PROPERTIES_BASE::OnDeleteAlternate ), NULL, this );
 
 }
-

eeschema/dialogs/dialog_pin_properties_base.fbp

@@ -2191,7 +2191,7 @@
                                 <property name="gripper">0</property>
                                 <property name="hidden">0</property>
                                 <property name="id">wxID_ANY</property>
-                                <property name="label">Alternate pin definitions</property>
+                                <property name="label">Alternate pin function definitions</property>
                                 <property name="max_size"></property>
                                 <property name="maximize_button">0</property>
                                 <property name="maximum_size"></property>

eeschema/dialogs/dialog_pin_properties_base.h

@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////
-// C++ code generated with wxFormBuilder (version 3.10.1-0-g8feb16b3)
+// C++ code generated with wxFormBuilder (version 3.10.1-0-g8feb16b)
 // http://www.wxformbuilder.org/
 //
 // PLEASE DO *NOT* EDIT THIS FILE!

eeschema/eeschema_id.h

@@ -35,6 +35,8 @@
  */
 #define MAX_UNIT_COUNT_PER_PACKAGE 676
 
+#define MAX_ALT_PIN_FUNCTION_ITEMS 1024
+
 /**
  * While it would seem that an unfold-from-bus menu with over 100 items would be
  * hard to deal with, we've already had one user who wants 256.
@@ -78,11 +80,14 @@ enum id_eeschema_frm
     ID_POPUP_SCH_UNFOLD_BUS_END = ID_POPUP_SCH_UNFOLD_BUS + MAX_BUS_UNFOLD_MENU_ITEMS,
 
     // Unit select context menus command IDs.
-    ID_POPUP_SCH_SELECT_UNIT_CMP,
+    ID_POPUP_SCH_SELECT_UNIT,
     ID_POPUP_SCH_SELECT_UNIT1,
     // ... leave room for MAX_UNIT_COUNT_PER_PACKAGE IDs ,
     // to select one unit among MAX_UNIT_COUNT_PER_PACKAGE in popup menu
-    ID_POPUP_SCH_SELECT_UNIT_SYM_MAX = ID_POPUP_SCH_SELECT_UNIT1 + MAX_UNIT_COUNT_PER_PACKAGE
+    ID_POPUP_SCH_SELECT_UNIT_END = ID_POPUP_SCH_SELECT_UNIT1 + MAX_UNIT_COUNT_PER_PACKAGE,
+
+    ID_POPUP_SCH_ALT_PIN_FUNCTION,
+    ID_POPUP_SCH_ALT_PIN_FUNCTION_END = ID_POPUP_SCH_ALT_PIN_FUNCTION + MAX_ALT_PIN_FUNCTION_ITEMS
 };
 
 

eeschema/picksymbol.cpp

@@ -308,3 +308,20 @@ void SCH_EDIT_FRAME::ConvertPart( SCH_SYMBOL* aSymbol )
 
     commit.Push( _( "Convert Symbol" ) );
 }
+
+
+void SCH_EDIT_FRAME::SetAltPinFunction( SCH_PIN* aPin, const wxString& aFunction )
+{
+    if( !aPin )
+        return;
+
+    SCH_COMMIT commit( m_toolManager );
+    commit.Modify( aPin, GetScreen() );
+
+    if( aFunction == aPin->GetName() )
+        aPin->SetAlt( wxEmptyString );
+    else
+        aPin->SetAlt( aFunction );
+
+    commit.Push( _( "Set Alternate Pin Function" ) );
+}

eeschema/sch_edit_frame.h

@@ -646,6 +646,8 @@ public:
 
     void SelectUnit( SCH_SYMBOL* aSymbol, int aUnit );
 
+    void SetAltPinFunction( SCH_PIN* aPin, const wxString& aFunction );
+
     /* Undo - redo */
 
     /**

eeschema/sch_symbol.cpp

@@ -175,7 +175,7 @@ SCH_SYMBOL::SCH_SYMBOL( const SCH_SYMBOL& aSymbol ) :
     m_DNP         = aSymbol.m_DNP;
 
     if( aSymbol.m_part )
-        SetLibSymbol( new LIB_SYMBOL( *aSymbol.m_part.get() ) );
+        SetLibSymbol( new LIB_SYMBOL( *aSymbol.m_part ) );
 
     const_cast<KIID&>( m_Uuid ) = aSymbol.m_Uuid;
 
@@ -188,6 +188,11 @@ SCH_SYMBOL::SCH_SYMBOL( const SCH_SYMBOL& aSymbol ) :
     for( SCH_FIELD& field : m_fields )
         field.SetParent( this );
 
+    m_pins.clear();
+
+    for( const std::unique_ptr<SCH_PIN>& pin : aSymbol.m_pins )
+        m_pins.emplace_back( std::make_unique<SCH_PIN>( this, pin->GetNumber(), pin->GetAlt() ) );
+
     m_fieldsAutoplaced = aSymbol.m_fieldsAutoplaced;
     m_schLibSymbolName = aSymbol.m_schLibSymbolName;
 }

eeschema/tools/ee_selection_tool.cpp

@@ -110,6 +110,20 @@ SELECTION_CONDITION EE_CONDITIONS::SingleMultiUnitSymbol = []( const SELECTION&
 };
 
 
+SELECTION_CONDITION EE_CONDITIONS::SingleMultiFunctionPin = []( const SELECTION& aSel )
+{
+    if( aSel.GetSize() == 1 )
+    {
+        SCH_PIN* pin = dynamic_cast<SCH_PIN*>( aSel.Front() );
+
+        if( pin && pin->GetLibPin() )
+            return !pin->GetLibPin()->GetAlternates().empty();
+    }
+
+    return false;
+};
+
+
 SELECTION_CONDITION EE_CONDITIONS::SingleNonExcludedMarker = []( const SELECTION& aSel )
 {
     if( aSel.CountType( SCH_MARKER_T ) != 1 )
@@ -573,15 +587,24 @@ int EE_SELECTION_TOOL::Main( const TOOL_EVENT& aEvent )
             m_disambiguateTimer.Stop();
 
             // context sub-menu selection?  Handle unit selection or bus unfolding
-            if( *evt->GetCommandId() >= ID_POPUP_SCH_SELECT_UNIT_CMP
+            if( *evt->GetCommandId() >= ID_POPUP_SCH_SELECT_UNIT
-                && *evt->GetCommandId() <= ID_POPUP_SCH_SELECT_UNIT_SYM_MAX )
+                && *evt->GetCommandId() <= ID_POPUP_SCH_SELECT_UNIT_END )
             {
                 SCH_SYMBOL* symbol = dynamic_cast<SCH_SYMBOL*>( m_selection.Front() );
-                int unit = *evt->GetCommandId() - ID_POPUP_SCH_SELECT_UNIT_CMP;
+                int unit = *evt->GetCommandId() - ID_POPUP_SCH_SELECT_UNIT;
 
                 if( symbol )
                     static_cast<SCH_EDIT_FRAME*>( m_frame )->SelectUnit( symbol, unit );
             }
+            else if( *evt->GetCommandId() >= ID_POPUP_SCH_ALT_PIN_FUNCTION
+                     && *evt->GetCommandId() <= ID_POPUP_SCH_ALT_PIN_FUNCTION_END )
+            {
+                SCH_PIN* pin = dynamic_cast<SCH_PIN*>( m_selection.Front() );
+                wxString alt = *evt->Parameter<wxString*>();
+
+                if( pin )
+                    static_cast<SCH_EDIT_FRAME*>( m_frame )->SetAltPinFunction( pin, alt );
+            }
             else if( *evt->GetCommandId() >= ID_POPUP_SCH_UNFOLD_BUS
                      && *evt->GetCommandId() <= ID_POPUP_SCH_UNFOLD_BUS_END )
             {

eeschema/tools/ee_selection_tool.h

@@ -50,6 +50,7 @@ public:
     static SELECTION_CONDITION SingleSymbolOrPower;
     static SELECTION_CONDITION SingleDeMorganSymbol;
     static SELECTION_CONDITION SingleMultiUnitSymbol;
+    static SELECTION_CONDITION SingleMultiFunctionPin;
     static SELECTION_CONDITION SingleNonExcludedMarker;
     static SELECTION_CONDITION MultipleSymbolsOrPower;
 };

eeschema/tools/sch_drawing_tools.cpp

@@ -419,10 +419,10 @@ int SCH_DRAWING_TOOLS::PlaceSymbol( const TOOL_EVENT& aEvent )
         }
         else if( evt->Category() == TC_COMMAND && evt->Action() == TA_CHOICE_MENU_CHOICE )
         {
-            if( *evt->GetCommandId() >= ID_POPUP_SCH_SELECT_UNIT_CMP
+            if( *evt->GetCommandId() >= ID_POPUP_SCH_SELECT_UNIT
-                && *evt->GetCommandId() <= ID_POPUP_SCH_SELECT_UNIT_SYM_MAX )
+                && *evt->GetCommandId() <= ID_POPUP_SCH_SELECT_UNIT_END )
             {
-                int unit = *evt->GetCommandId() - ID_POPUP_SCH_SELECT_UNIT_CMP;
+                int unit = *evt->GetCommandId() - ID_POPUP_SCH_SELECT_UNIT;
 
                 if( symbol )
                 {

eeschema/tools/sch_edit_tool.cpp

@@ -94,8 +94,8 @@ private:
 
         if( !symbol )
         {
-            Append( ID_POPUP_SCH_SELECT_UNIT_CMP, _( "no symbol selected" ), wxEmptyString );
+            Append( ID_POPUP_SCH_SELECT_UNIT, _( "no symbol selected" ), wxEmptyString );
-            Enable( ID_POPUP_SCH_SELECT_UNIT_CMP, false );
+            Enable( ID_POPUP_SCH_SELECT_UNIT, false );
             return;
         }
 
@@ -103,8 +103,8 @@ private:
 
         if( !symbol->GetLibSymbolRef() || symbol->GetLibSymbolRef()->GetUnitCount() < 2 )
         {
-            Append( ID_POPUP_SCH_SELECT_UNIT_CMP, _( "symbol is not multi-unit" ), wxEmptyString );
+            Append( ID_POPUP_SCH_SELECT_UNIT, _( "symbol is not multi-unit" ), wxEmptyString );
-            Enable( ID_POPUP_SCH_SELECT_UNIT_CMP, false );
+            Enable( ID_POPUP_SCH_SELECT_UNIT, false );
             return;
         }
 
@@ -113,14 +113,78 @@ private:
             wxString num_unit;
             num_unit.Printf( _( "Unit %s" ), LIB_SYMBOL::SubReference( ii + 1, false ) );
 
-            wxMenuItem * item = Append( ID_POPUP_SCH_SELECT_UNIT1 + ii, num_unit, wxEmptyString,
+            wxMenuItem* item = Append( ID_POPUP_SCH_SELECT_UNIT1 + ii, num_unit, wxEmptyString,
-                                        wxITEM_CHECK );
+                                       wxITEM_CHECK );
-            if( unit == ii + 1 )
-                item->Check(true);
 
-            // The ID max for these submenus is ID_POPUP_SCH_SELECT_UNIT_SYM_MAX
+            if( unit == ii + 1 )
+                item->Check( true );
+
+            // The ID max for these submenus is ID_POPUP_SCH_SELECT_UNIT_END
             // See eeschema_id to modify this value.
-            if( ii >= (ID_POPUP_SCH_SELECT_UNIT_SYM_MAX - ID_POPUP_SCH_SELECT_UNIT1) )
+            if( ii >= ( ID_POPUP_SCH_SELECT_UNIT_END - ID_POPUP_SCH_SELECT_UNIT1) )
+                break;      // We have used all IDs for these submenus
+        }
+    }
+};
+
+
+class ALT_PIN_FUNCTION_MENU : public ACTION_MENU
+{
+public:
+    ALT_PIN_FUNCTION_MENU() :
+        ACTION_MENU( true )
+    {
+        SetIcon( BITMAPS::component_select_unit );
+        SetTitle( _( "Alternate Pin Functions" ) );
+    }
+
+protected:
+    ACTION_MENU* create() const override
+    {
+        return new ALT_PIN_FUNCTION_MENU();
+    }
+
+private:
+    void update() override
+    {
+        EE_SELECTION_TOOL* selTool = getToolManager()->GetTool<EE_SELECTION_TOOL>();
+        EE_SELECTION&      selection = selTool->GetSelection();
+        SCH_PIN*           pin = dynamic_cast<SCH_PIN*>( selection.Front() );
+
+        Clear();
+
+        if( !pin )
+        {
+            Append( ID_POPUP_SCH_SELECT_UNIT, _( "no pin selected" ), wxEmptyString );
+            Enable( ID_POPUP_SCH_SELECT_UNIT, false );
+            return;
+        }
+
+        if( !pin->GetLibPin() || pin->GetLibPin()->GetAlternates().empty() )
+        {
+            Append( ID_POPUP_SCH_SELECT_UNIT, _( "no alternate pin functions defined" ), wxEmptyString );
+            Enable( ID_POPUP_SCH_SELECT_UNIT, false );
+            return;
+        }
+
+        wxMenuItem* item = Append( ID_POPUP_SCH_ALT_PIN_FUNCTION, pin->GetName(), wxEmptyString,
+                                   wxITEM_CHECK );
+
+        if( pin->GetAlt().IsEmpty() )
+            item->Check( true );
+
+        int ii = 1;
+
+        for( const auto& [ name, definition ] : pin->GetLibPin()->GetAlternates() )
+        {
+            item = Append( ID_POPUP_SCH_ALT_PIN_FUNCTION + ii, name, wxEmptyString, wxITEM_CHECK );
+
+            if( name == pin->GetAlt() )
+                item->Check( true );
+
+            // The ID max for these submenus is ID_POPUP_SCH_ALT_PIN_FUNCTION_END
+            // See eeschema_id to modify this value.
+            if( ++ii >= ( ID_POPUP_SCH_ALT_PIN_FUNCTION_END - ID_POPUP_SCH_SELECT_UNIT ) )
                 break;      // We have used all IDs for these submenus
         }
     }
@@ -606,6 +670,11 @@ bool SCH_EDIT_TOOL::Init()
     m_selectionTool->GetToolMenu().RegisterSubMenu( symUnitMenu3 );
     selToolMenu.AddMenu( symUnitMenu3.get(), E_C::SingleMultiUnitSymbol, 1 );
 
+    std::shared_ptr<ALT_PIN_FUNCTION_MENU> altPinMenu = std::make_shared<ALT_PIN_FUNCTION_MENU>();
+    altPinMenu->SetTool( m_selectionTool );
+    m_selectionTool->GetToolMenu().RegisterSubMenu( altPinMenu );
+    selToolMenu.AddMenu( altPinMenu.get(), E_C::SingleMultiFunctionPin, 1 );
+
     selToolMenu.AddItem( EE_ACTIONS::editWithLibEdit,  E_C::SingleSymbolOrPower && E_C::Idle, 200 );
     selToolMenu.AddItem( EE_ACTIONS::changeSymbol,     E_C::SingleSymbolOrPower, 200 );
     selToolMenu.AddItem( EE_ACTIONS::updateSymbol,     E_C::SingleSymbolOrPower, 200 );

eeschema/tools/sch_move_tool.cpp

@@ -825,11 +825,11 @@ bool SCH_MOVE_TOOL::doMoveSelection( const TOOL_EVENT& aEvent, SCH_COMMIT* aComm
         }
         else if( evt->Action() == TA_CHOICE_MENU_CHOICE )
         {
-            if( *evt->GetCommandId() >= ID_POPUP_SCH_SELECT_UNIT_CMP
+            if( *evt->GetCommandId() >= ID_POPUP_SCH_SELECT_UNIT
-                && *evt->GetCommandId() <= ID_POPUP_SCH_SELECT_UNIT_SYM_MAX )
+                && *evt->GetCommandId() <= ID_POPUP_SCH_SELECT_UNIT_END )
             {
                 SCH_SYMBOL* symbol = dynamic_cast<SCH_SYMBOL*>( selection.Front() );
-                int unit = *evt->GetCommandId() - ID_POPUP_SCH_SELECT_UNIT_CMP;
+                int unit = *evt->GetCommandId() - ID_POPUP_SCH_SELECT_UNIT;
 
                 if( symbol )
                 {