From 76535d8572376de6ea46073f48902836eedca3ce Mon Sep 17 00:00:00 2001
From: Jeff Young <jeff@rokeby.ie>
Date: Thu, 3 Mar 2022 12:20:30 +0000
Subject: [PATCH] Make LIB_ITEM::COMPARE_FLAGS really a flags field, and add
 ERC.

Before they were 1/2 treated as flags and 1/2 treated as a mode enum.

The ERC flag relaxes constraints on data that is settable in the
schematic editor.

Fixes https://gitlab.com/kicad/code/kicad/issues/11018
---
 eeschema/erc.cpp         |  3 ++-
 eeschema/lib_field.cpp   |  2 +-
 eeschema/lib_field.h     |  3 +--
 eeschema/lib_item.cpp    |  2 +-
 eeschema/lib_item.h      | 19 +++++++++++++------
 eeschema/lib_pin.cpp     |  2 +-
 eeschema/lib_pin.h       |  3 +--
 eeschema/lib_shape.cpp   |  2 +-
 eeschema/lib_shape.h     |  3 +--
 eeschema/lib_symbol.cpp  | 21 ++++++++++++---------
 eeschema/lib_symbol.h    |  3 +--
 eeschema/lib_text.cpp    |  2 +-
 eeschema/lib_text.h      |  3 +--
 eeschema/lib_textbox.cpp |  2 +-
 eeschema/lib_textbox.h   |  3 +--
 15 files changed, 39 insertions(+), 34 deletions(-)

diff --git a/eeschema/erc.cpp b/eeschema/erc.cpp
index 887a024faf..33da22df0c 100644
--- a/eeschema/erc.cpp
+++ b/eeschema/erc.cpp
@@ -756,8 +756,9 @@ int ERC_TESTER::TestLibSymbolIssues()
             }
 
             std::unique_ptr<LIB_SYMBOL> flattenedSymbol = libSymbol->Flatten();
+            constexpr int flags = LIB_ITEM::COMPARE_FLAGS::EQUALITY | LIB_ITEM::COMPARE_FLAGS::ERC;
 
-            if( *flattenedSymbol != *libSymbolInSchematic )
+            if( flattenedSymbol->Compare( *libSymbolInSchematic, flags ) != 0 )
             {
                 std::shared_ptr<ERC_ITEM> ercItem = ERC_ITEM::Create( ERCE_LIB_SYMBOL_ISSUES );
                 ercItem->SetItems( symbol );
diff --git a/eeschema/lib_field.cpp b/eeschema/lib_field.cpp
index d2f9a25d9c..dc2418f67f 100644
--- a/eeschema/lib_field.cpp
+++ b/eeschema/lib_field.cpp
@@ -190,7 +190,7 @@ void LIB_FIELD::Copy( LIB_FIELD* aTarget ) const
 }
 
 
-int LIB_FIELD::compare( const LIB_ITEM& aOther, LIB_ITEM::COMPARE_FLAGS aCompareFlags ) const
+int LIB_FIELD::compare( const LIB_ITEM& aOther, int aCompareFlags ) const
 {
     wxASSERT( aOther.Type() == LIB_FIELD_T );
 
diff --git a/eeschema/lib_field.h b/eeschema/lib_field.h
index 1ecf62fbd2..f7e44f9f40 100644
--- a/eeschema/lib_field.h
+++ b/eeschema/lib_field.h
@@ -187,8 +187,7 @@ private:
      *      - Field width.
      *      - Field height.
      */
-    int compare( const LIB_ITEM& aOther,
-            LIB_ITEM::COMPARE_FLAGS aCompareFlags = LIB_ITEM::COMPARE_FLAGS::NORMAL ) const override;
+    int compare( const LIB_ITEM& aOther, int aCompareFlags = 0 ) const override;
 
     /**
      * Print the field.
diff --git a/eeschema/lib_item.cpp b/eeschema/lib_item.cpp
index 86d003f9ac..f3da31f64a 100644
--- a/eeschema/lib_item.cpp
+++ b/eeschema/lib_item.cpp
@@ -71,7 +71,7 @@ void LIB_ITEM::GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_IT
 }
 
 
-int LIB_ITEM::compare( const LIB_ITEM& aOther, LIB_ITEM::COMPARE_FLAGS aCompareFlags ) const
+int LIB_ITEM::compare( const LIB_ITEM& aOther, int aCompareFlags ) const
 {
     if( Type() != aOther.Type() )
         return Type() - aOther.Type();
diff --git a/eeschema/lib_item.h b/eeschema/lib_item.h
index ba89af67b9..c89aec3323 100644
--- a/eeschema/lib_item.h
+++ b/eeschema/lib_item.h
@@ -73,11 +73,19 @@ public:
     /**
      * The list of flags used by the #compare function.
      *
-     * - NORMAL This compares everything between two #LIB_ITEM objects.
-     * - UNIT This compare flag ignores unit and convert and pin number information when
-     *        comparing #LIB_ITEM objects for unit comparison.
+     * - UNIT This flag relaxes unit, conversion and pin number constraints.  It is used for
+     *        #LIB_ITEM object unit comparisons.
+     * - EQUALITY This flag relaxes ordering contstraints so that fields, etc. don't have to
+     *            appear in the same order to be considered equal.
+     * - ERC This flag relaxes constraints on data that is settable in the schematic editor.  It
+     *       compares only symbol-editor-only data.
      */
-    enum COMPARE_FLAGS : int { NORMAL = 0x00, UNIT = 0x01, EQUALITY = 0x02 };
+    enum COMPARE_FLAGS : int
+    {
+        UNIT     = 0x01,
+        EQUALITY = 0x02,
+        ERC      = 0x04
+    };
 
     /**
      * Provide a user-consumable name of the object type.  Perform localization when
@@ -294,8 +302,7 @@ protected:
      *         zero if the object is equal to \a aOther object, or greater than 0 if the
      *         object is greater than \a aOther object.
      */
-    virtual int compare( const LIB_ITEM& aOther,
-            LIB_ITEM::COMPARE_FLAGS aCompareFlags = LIB_ITEM::COMPARE_FLAGS::NORMAL ) const;
+    virtual int compare( const LIB_ITEM& aOther, int aCompareFlags = 0 ) const;
 
     /**
      * Print the item to \a aDC.
diff --git a/eeschema/lib_pin.cpp b/eeschema/lib_pin.cpp
index 4351f5cf19..b3f9436f3c 100644
--- a/eeschema/lib_pin.cpp
+++ b/eeschema/lib_pin.cpp
@@ -884,7 +884,7 @@ EDA_ITEM* LIB_PIN::Clone() const
 }
 
 
-int LIB_PIN::compare( const LIB_ITEM& aOther, LIB_ITEM::COMPARE_FLAGS aCompareFlags ) const
+int LIB_PIN::compare( const LIB_ITEM& aOther, int aCompareFlags ) const
 {
     wxASSERT( aOther.Type() == LIB_PIN_T );
 
diff --git a/eeschema/lib_pin.h b/eeschema/lib_pin.h
index 13416fd271..5639363107 100644
--- a/eeschema/lib_pin.h
+++ b/eeschema/lib_pin.h
@@ -275,8 +275,7 @@ private:
      *      - Pin horizontal (X) position.
      *      - Pin vertical (Y) position.
      */
-    int compare( const LIB_ITEM& aOther,
-            LIB_ITEM::COMPARE_FLAGS aCompareFlags = LIB_ITEM::COMPARE_FLAGS::NORMAL ) const override;
+    int compare( const LIB_ITEM& aOther, int aCompareFlags = 0 ) const override;
 
 protected:
     VECTOR2I                m_position;      // Position of the pin.
diff --git a/eeschema/lib_shape.cpp b/eeschema/lib_shape.cpp
index a3ba282fc6..60a1078b63 100644
--- a/eeschema/lib_shape.cpp
+++ b/eeschema/lib_shape.cpp
@@ -66,7 +66,7 @@ EDA_ITEM* LIB_SHAPE::Clone() const
 }
 
 
-int LIB_SHAPE::compare( const LIB_ITEM& aOther, LIB_ITEM::COMPARE_FLAGS aCompareFlags ) const
+int LIB_SHAPE::compare( const LIB_ITEM& aOther, int aCompareFlags ) const
 {
     int retv = LIB_ITEM::compare( aOther, aCompareFlags );
 
diff --git a/eeschema/lib_shape.h b/eeschema/lib_shape.h
index 8cbef7549b..d711cf15dd 100644
--- a/eeschema/lib_shape.h
+++ b/eeschema/lib_shape.h
@@ -103,8 +103,7 @@ private:
      *      - Circle vertical (Y) position.
      *      - Circle radius.
      */
-    int compare( const LIB_ITEM& aOther,
-            LIB_ITEM::COMPARE_FLAGS aCompareFlags = LIB_ITEM::COMPARE_FLAGS::NORMAL ) const override;
+    int compare( const LIB_ITEM& aOther, int aCompareFlags = 0 ) const override;
 
     void print( const RENDER_SETTINGS* aSettings, const VECTOR2I& aOffset, void* aData,
                 const TRANSFORM& aTransform ) override;
diff --git a/eeschema/lib_symbol.cpp b/eeschema/lib_symbol.cpp
index 2d35b05f0b..0906c7be82 100644
--- a/eeschema/lib_symbol.cpp
+++ b/eeschema/lib_symbol.cpp
@@ -209,7 +209,7 @@ const LIB_SYMBOL& LIB_SYMBOL::operator=( const LIB_SYMBOL& aSymbol )
 }
 
 
-int LIB_SYMBOL::Compare( const LIB_SYMBOL& aRhs, LIB_ITEM::COMPARE_FLAGS aCompareFlags ) const
+int LIB_SYMBOL::Compare( const LIB_SYMBOL& aRhs, int aCompareFlags ) const
 {
     if( m_me == aRhs.m_me )
         return 0;
@@ -322,17 +322,20 @@ int LIB_SYMBOL::Compare( const LIB_SYMBOL& aRhs, LIB_ITEM::COMPARE_FLAGS aCompar
     if( m_unitsLocked != aRhs.m_unitsLocked )
         return ( m_unitsLocked ) ? 1 : -1;
 
-    if( m_showPinNames != aRhs.m_showPinNames )
-        return ( m_showPinNames ) ? 1 : -1;
+    if( ( aCompareFlags & LIB_ITEM::COMPARE_FLAGS::ERC ) == 0 )
+    {
+        if( m_showPinNames != aRhs.m_showPinNames )
+            return ( m_showPinNames ) ? 1 : -1;
 
-    if( m_showPinNumbers != aRhs.m_showPinNumbers )
-        return ( m_showPinNumbers ) ? 1 : -1;
+        if( m_showPinNumbers != aRhs.m_showPinNumbers )
+            return ( m_showPinNumbers ) ? 1 : -1;
 
-    if( m_includeInBom != aRhs.m_includeInBom )
-        return ( m_includeInBom ) ? 1 : -1;
+        if( m_includeInBom != aRhs.m_includeInBom )
+            return ( m_includeInBom ) ? 1 : -1;
 
-    if( m_includeOnBoard != aRhs.m_includeOnBoard )
-        return ( m_includeOnBoard ) ? 1 : -1;
+        if( m_includeOnBoard != aRhs.m_includeOnBoard )
+            return ( m_includeOnBoard ) ? 1 : -1;
+    }
 
     return 0;
 }
diff --git a/eeschema/lib_symbol.h b/eeschema/lib_symbol.h
index 8d6076fc90..21ca5c2965 100644
--- a/eeschema/lib_symbol.h
+++ b/eeschema/lib_symbol.h
@@ -618,8 +618,7 @@ public:
      *         1 if this symbol is greater than \a aRhs
      *         0 if this symbol is the same as \a aRhs
      */
-    int Compare( const LIB_SYMBOL& aRhs,
-                 LIB_ITEM::COMPARE_FLAGS aCompareFlags = LIB_ITEM::COMPARE_FLAGS::NORMAL ) const;
+    int Compare( const LIB_SYMBOL& aRhs, int aCompareFlags = 0 ) const;
 
     bool operator==( const LIB_SYMBOL* aSymbol ) const { return this == aSymbol; }
     bool operator==( const LIB_SYMBOL& aSymbol ) const
diff --git a/eeschema/lib_text.cpp b/eeschema/lib_text.cpp
index 83d92a1aa8..d1a31d557a 100644
--- a/eeschema/lib_text.cpp
+++ b/eeschema/lib_text.cpp
@@ -84,7 +84,7 @@ EDA_ITEM* LIB_TEXT::Clone() const
 }
 
 
-int LIB_TEXT::compare( const LIB_ITEM& aOther, LIB_ITEM::COMPARE_FLAGS aCompareFlags ) const
+int LIB_TEXT::compare( const LIB_ITEM& aOther, int aCompareFlags ) const
 {
     wxASSERT( aOther.Type() == LIB_TEXT_T );
 
diff --git a/eeschema/lib_text.h b/eeschema/lib_text.h
index 98b4abf539..726cca4570 100644
--- a/eeschema/lib_text.h
+++ b/eeschema/lib_text.h
@@ -119,8 +119,7 @@ private:
      *      - Text width.
      *      - Text height.
      */
-    int compare( const LIB_ITEM& aOther,
-            LIB_ITEM::COMPARE_FLAGS aCompareFlags = LIB_ITEM::COMPARE_FLAGS::NORMAL ) const override;
+    int compare( const LIB_ITEM& aOther, int aCompareFlags = 0 ) const override;
 
     void print( const RENDER_SETTINGS* aSettings, const VECTOR2I& aOffset, void* aData,
                 const TRANSFORM& aTransform ) override;
diff --git a/eeschema/lib_textbox.cpp b/eeschema/lib_textbox.cpp
index 7d7cb7e2b2..04597b39a9 100644
--- a/eeschema/lib_textbox.cpp
+++ b/eeschema/lib_textbox.cpp
@@ -138,7 +138,7 @@ VECTOR2I LIB_TEXTBOX::GetDrawPos() const
 }
 
 
-int LIB_TEXTBOX::compare( const LIB_ITEM& aOther, LIB_ITEM::COMPARE_FLAGS aCompareFlags ) const
+int LIB_TEXTBOX::compare( const LIB_ITEM& aOther, int aCompareFlags ) const
 {
     wxASSERT( aOther.Type() == LIB_TEXTBOX_T );
 
diff --git a/eeschema/lib_textbox.h b/eeschema/lib_textbox.h
index 92fd23ad88..d6ca1734e6 100644
--- a/eeschema/lib_textbox.h
+++ b/eeschema/lib_textbox.h
@@ -96,8 +96,7 @@ public:
     void ViewGetLayers( int aLayers[], int& aCount ) const override;
 
 private:
-    int compare( const LIB_ITEM& aOther,
-            LIB_ITEM::COMPARE_FLAGS aCompareFlags = LIB_ITEM::COMPARE_FLAGS::NORMAL ) const override;
+    int compare( const LIB_ITEM& aOther, int aCompareFlags = 0 ) const override;
 
     void print( const RENDER_SETTINGS* aSettings, const VECTOR2I& aOffset, void* aData,
                 const TRANSFORM& aTransform ) override;