Eeschema: better backannotation from cvpcb

eeschema/backanno.cpp

@@ -14,40 +14,74 @@
 
 #include "dialog_backanno.cpp"
 
-/**************************************************************/
+/*******************************************************************************************/
-SCH_COMPONENT* WinEDA_SchematicFrame::FindComponentByRef(
+bool WinEDA_SchematicFrame::FillFootprintFieldForAllInstancesofComponent(
-    const wxString& reference )
+    const wxString& aReference,
-/**************************************************************/
+    const wxString&
+    aFootPrint,
+    bool            aSetVisible )
+/********************************************************************************************/
+
+/** function FillFootprintFieldForAllInstancesofComponent
+ * Search for component "aReference", and place a Footprint in Footprint field
+ * @param aReference = reference of the component to initialise
+ * @param aFootPrint = new value for the filed Fottprint component
+ * @param aSetVisible = true to have the field visible, false to set the invisible flag
+ * @return true if the given component is found
+ * Note:
+ * the component is searched in the whole schematic, and because some components
+ * have more than one instance (multiple parts per package components)
+ * the search is not stopped when a reference is found (all instances must be found).
+ */
 {
     DrawSheetPath* sheet;
     SCH_ITEM*      DrawList = NULL;
     EDA_SheetList  SheetList( NULL );
+    SCH_COMPONENT* Cmp;
+    bool           found = false;
 
     for( sheet = SheetList.GetFirst(); sheet != NULL; sheet = SheetList.GetNext() )
     {
         DrawList = (SCH_ITEM*) sheet->LastDrawList();
         for( ; (DrawList != NULL); DrawList = DrawList->Next() )
         {
-            if( DrawList->Type() == TYPE_SCH_COMPONENT )
+            if( DrawList->Type() != TYPE_SCH_COMPONENT )
+                continue;
+
+            Cmp = (SCH_COMPONENT*) DrawList;
+            if( aReference.CmpNoCase( Cmp->GetRef( sheet ) ) == 0 )
+            {    // Found: Init Footprint Field
+                 /* Give a reasonnable value to the fied position and orientation, if
+                  * the text is empty at position 0, because it is probably not yet initialised
+                  */
+                if( Cmp->m_Field[FOOTPRINT].m_Text.IsEmpty()
+                   && ( Cmp->m_Field[FOOTPRINT].m_Pos == wxPoint( 0, 0 ) ) )
                 {
-                SCH_COMPONENT* pSch;
+                    Cmp->m_Field[FOOTPRINT].m_Orient = Cmp->m_Field[VALUE].m_Orient;
-
+                    Cmp->m_Field[FOOTPRINT].m_Pos    = Cmp->m_Field[VALUE].m_Pos;
-                pSch = (SCH_COMPONENT*) DrawList;
+                    Cmp->m_Field[FOOTPRINT].m_Pos.y -= 100;
-                if( reference.CmpNoCase( pSch->GetRef( sheet ) ) == 0 )
+                }
-                    return pSch;
+                Cmp->m_Field[FOOTPRINT].m_Text = aFootPrint;
+                if( aSetVisible )
+                    Cmp->m_Field[FOOTPRINT].m_Attributs &= ~TEXT_NO_VISIBLE;
+                else
+                    Cmp->m_Field[FOOTPRINT].m_Attributs |= TEXT_NO_VISIBLE;
+                found = true;
             }
         }
     }
 
-    return NULL;
+    return found;
 }
 
 
-/**************************************************************/
+/***************************************************************************/
-bool WinEDA_SchematicFrame::ProcessStuffFile( FILE* StuffFile )
+bool WinEDA_SchematicFrame::ProcessStuffFile( FILE* aStuffFile, bool
-/**************************************************************/
+                                              aSetFielsAttributeToVisible  )
+/***************************************************************************/
 
-/* Read a "stuff" file created by cvpcb.
+/** Function ProcessStuffFile
+ * Read a "stuff" file created by cvpcb.
  * That file has lines like:
  * comp = "C1" module = "CP6"
  * comp = "C2" module = "C1"
@@ -55,13 +89,15 @@ bool WinEDA_SchematicFrame::ProcessStuffFile( FILE* StuffFile )
  * "comp =" gives the component reference
  * "module =" gives the footprint name
  *
+ * @param aStuffFile = file (*.stf) to Read.
+ * @param aSetFielsAttributeToVisible = true to set the footprint field flag to visible
+ * @return true if ok.
  */
 {
     int   LineNum = 0;
     char* cp, Ref[256], FootPrint[256], Line[1024];
-    SCH_COMPONENT* Cmp;
 
-    while( GetLine( StuffFile, Line, &LineNum, sizeof(Line) ) )
+    while( GetLine( aStuffFile, Line, &LineNum, sizeof(Line) ) )
     {
         if( sscanf( Line, "comp = \"%s module = \"%s", Ref, FootPrint ) == 2 )
         {
@@ -74,21 +110,10 @@ bool WinEDA_SchematicFrame::ProcessStuffFile( FILE* StuffFile )
                     *cp = 0;
 
             wxString reference = CONV_FROM_UTF8( Ref );
-
+            wxString Footprint = CONV_FROM_UTF8( FootPrint );
-            Cmp = WinEDA_SchematicFrame::FindComponentByRef( reference );
+            FillFootprintFieldForAllInstancesofComponent( reference,
-            if( Cmp == NULL )
+                                                          Footprint,
-                continue;
+                                                          aSetFielsAttributeToVisible );
-
-            /* Give a reasonnable value to the fied position, if
-             * the text is empty at position 0, because it is probably not yet initialised
-             */
-            if( Cmp->m_Field[FOOTPRINT].m_Text.IsEmpty() &&
-               ( Cmp->m_Field[FOOTPRINT].m_Pos == wxPoint( 0, 0 ) ) )
-            {
-                Cmp->m_Field[FOOTPRINT].m_Pos    = Cmp->m_Field[VALUE].m_Pos;
-                Cmp->m_Field[FOOTPRINT].m_Pos.y -= 100;
-            }
-            Cmp->m_Field[FOOTPRINT].m_Text = CONV_FROM_UTF8( FootPrint );
         }
     }
 
@@ -106,6 +131,7 @@ bool WinEDA_SchematicFrame::ReadInputStuffFile()
     wxString Line, filename;
     FILE*    StuffFile;
     wxString msg;
+    bool     SetFieldToVisible = true;
 
     filename = EDA_FileSelector( _( "Load Stuff File" ),
                                  wxEmptyString,             /* Chemin par defaut */
@@ -127,6 +153,18 @@ bool WinEDA_SchematicFrame::ReadInputStuffFile()
     if( filename.IsEmpty() )
         return FALSE;
 
+    int diag = wxMessageBox(
+        _( "Set the Footprint Field to Visible ?" ),
+        _ ("Field Display Option"),
+        wxYES_NO | wxICON_QUESTION | wxCANCEL, this );
+
+    if( diag == wxCANCEL )
+        return false;
+    if( diag == wxYES )
+        SetFieldToVisible = true;
+    else
+        SetFieldToVisible = false;
+
     StuffFile = wxFopen( filename, wxT( "rt" ) );
     if( StuffFile == NULL )
     {
@@ -135,7 +173,7 @@ bool WinEDA_SchematicFrame::ReadInputStuffFile()
         return FALSE;
     }
 
-    ProcessStuffFile( StuffFile );
+    ProcessStuffFile( StuffFile, SetFieldToVisible );
 
     return TRUE;
 }

include/wxEeschemaStruct.h

@@ -89,8 +89,20 @@ public:
         bool
         IncludePin );
 
-    SCH_COMPONENT*          FindComponentByRef( const wxString& reference );
+    /** function FillFootprintFieldForAllInstancesofComponent
-
+     * Search for component "aReference", and place a Footprint in Footprint field
+     * @param aReference = reference of the component to initialise
+     * @param aFootPrint = new value for the filed Fottprint component
+     * @param aSetVisible = true to have the field visible, false to set the invisible flag
+     * @return true if the given component is found
+     * Note:
+     * the component is searched in the whole schematic, and because some components
+     * have more than one instance (multiple parts per package components)
+     * the search is not stopped when a reference is found (all instances must be found).
+     */
+    bool FillFootprintFieldForAllInstancesofComponent( const wxString& aReference,
+                                                       const wxString& aFootPrint,
+                                                    bool            aSetVisible );
     SCH_ITEM*               FindComponentAndItem( const wxString& component_reference,
                                                   bool                          Find_in_hierarchy,
                                                   int                           SearchType,
@@ -136,10 +148,11 @@ public:
     /**
      * Function ProcessStuffFile
      * gets footprint info from each line in the Stuff File by Ref Desg
-     * @param filename The file to read from.
+     * @param aFilename The file to read from.
+     * @param aSetFielsAttributeToVisible = true to set the footprint field flag to visible
      * @return bool - true if success, else true.
      */
-    bool  		            ProcessStuffFile( FILE* filename );
+    bool  		            ProcessStuffFile( FILE* aFilename, bool aSetFielsAttributeToVisible );
 
     bool                    SaveEEFile( SCH_SCREEN* screen, int FileSave );
     SCH_SCREEN*             CreateNewScreen( SCH_SCREEN* OldScreen, int TimeStamp );