more new search stuff, beautification

common/base_struct.cpp

@@ -231,7 +231,7 @@ std::ostream& EDA_BaseStruct::NestedSpace( int nestLevel, std::ostream& os )
 
 // see base_struct.h
 SEARCH_RESULT EDA_BaseStruct::IterateForward( EDA_BaseStruct* listStart, 
-    INSPECTOR* inspector, void* testData, const KICAD_T scanTypes[] )
+    INSPECTOR* inspector, const void* testData, const KICAD_T scanTypes[] )
 {
     EDA_BaseStruct* p = listStart;
     for( ; p; p = p->Pnext )
@@ -245,7 +245,7 @@ SEARCH_RESULT EDA_BaseStruct::IterateForward( EDA_BaseStruct* listStart,
 
 
 // see base_struct.h
-SEARCH_RESULT EDA_BaseStruct::Traverse( INSPECTOR* inspector, void* testData, 
+SEARCH_RESULT EDA_BaseStruct::Traverse( INSPECTOR* inspector, const void* testData, 
         const KICAD_T scanTypes[] )
 {
     KICAD_T     stype;

include/base_struct.h

@@ -88,7 +88,7 @@ class EDA_BaseStruct;
  * Class INSPECTOR
  * is an abstract class that is used to inspect and possibly collect the 
  * (search) results of Iterating over a list or tree of KICAD_T objects.
- * Extend from this class and implment the Inspect function and provide for
+ * Extend from this class and implement the Inspect function and provide for
  * a way for the extension to collect the results of the search/scan data and
  * provide them to the caller.
  */
@@ -99,15 +99,18 @@ public:
 
     /**
      * Function Inspect
-     * is the function type that can be passed to the Iterate function,
+     * is the examining function within the INSPECTOR which is passed to the 
-     * used primarily for searching, but not exclusively.
+     * Iterate function.  It is used primarily for searching, but not limited to
+     * that.  It can also collect or modify the scanned objects.
+     *
+     * @param testItem An EDA_BaseStruct to examine.
      * @param testData is arbitrary data needed by the inspector to determine
      *   if the EDA_BaseStruct under test meets its match criteria.
      * @return SEARCH_RESULT - SEARCH_QUIT if the Iterator is to stop the scan,
      *   else SCAN_CONTINUE;
      */ 
     SEARCH_RESULT virtual Inspect( EDA_BaseStruct* testItem, 
-        void* testData ) = 0;
+        const void* testData ) = 0;
     
     // derived classes add more functions for collecting and subsequent 
     // retrieval here.
@@ -199,27 +202,27 @@ public:
     /**
      * Function IterateForward
      * walks through the object tree calling the testFunc on each object 
-     * type requested in structTypes.
+     * type requested in scanTypes.
      *
      * @param listStart The first in a list of EDA_BaseStructs to iterate over. 
-     * @param inspector Is an INSPECTOR to call on each object that is of one of 
+     * @param inspector Is an INSPECTOR to call on each object that is one of 
-     *  the requested itemTypes.
+     *  the requested scanTypes.
      * @param testData Is an aid to testFunc, and should be sufficient to 
      *  allow it to fully determine if an item meets the match criteria, but it
      *  may also be used to collect output.
-     * @param scanTypes Is a char array of KICAD_T that is EOT 
+     * @param scanTypes A KICAD_T array that is EOT 
      *  terminated, and provides both the order and interest level of of
      *  the types of objects to be iterated over.
-     * @return SEARCH_RESULT - SEARCH_QUIT if the Iterator is to stop the scan,
+     * @return SEARCH_RESULT - SEARCH_QUIT if the called INSPECTOR returned 
-     *   else SCAN_CONTINUE;
+     *  SEARCH_QUIT, else SCAN_CONTINUE;
      */
     static SEARCH_RESULT IterateForward( EDA_BaseStruct* listStart, 
-        INSPECTOR* inspector, void* testData, const KICAD_T scanTypes[] );
+        INSPECTOR* inspector, const void* testData, const KICAD_T scanTypes[] );
 
     
     /**
      * Function Traverse
-     * should be re-implemented for each derrived class in order to handle
+     * should be re-implemented for each derived class in order to handle
      * all the types given by its member data.  Implementations should call
      * inspector->Inspect() on types in scanTypes[], and may use IterateForward()
      * to do so on lists of such data.
@@ -230,7 +233,7 @@ public:
      * @return SEARCH_RESULT - SEARCH_QUIT if the Iterator is to stop the scan,
      *   else SCAN_CONTINUE;
      */
-    virtual SEARCH_RESULT Traverse( INSPECTOR* inspector, void* testData, 
+    virtual SEARCH_RESULT Traverse( INSPECTOR* inspector, const void* testData, 
         const KICAD_T scanTypes[] );
 
     

pcbnew/class_board.cpp

@@ -300,7 +300,7 @@ public:
     {
     }
 
-    SEARCH_RESULT Inspect( EDA_BaseStruct* testItem, void* testData )
+    SEARCH_RESULT Inspect( EDA_BaseStruct* testItem, const void* testData )
     {
         const wxPoint*  refPos = (const wxPoint*) testData;
 
@@ -336,9 +336,9 @@ EDA_BaseStruct* BOARD::FindModuleOrPad( const wxPoint& refPos )
 {
     ModuleOrPad inspector;
 
-    static const KICAD_T scanTypes[] = { TYPEMODULE, TYPEPAD, EOT };
+    static const KICAD_T scanTypes[] = { TYPEPAD, TYPEMODULE, EOT };
     
-    if( SEARCH_QUIT == IterateForward( m_Modules, &inspector, (void*) &refPos, scanTypes ) )
+    if( SEARCH_QUIT == IterateForward( m_Modules, &inspector, &refPos, scanTypes ) )
         return inspector.found;
 
     return NULL;

pcbnew/class_module.cpp

@@ -1188,7 +1188,7 @@ void MODULE::Show( int nestLevel, std::ostream& os )
 
 
 // see class_module.h     
-SEARCH_RESULT MODULE::Traverse( INSPECTOR* inspector, void* testData, 
+SEARCH_RESULT MODULE::Traverse( INSPECTOR* inspector, const void* testData, 
     const KICAD_T scanTypes[] )
 {
     KICAD_T     stype;

pcbnew/class_module.h

@@ -157,7 +157,7 @@ public:
      * @return SEARCH_RESULT - SEARCH_QUIT if the Iterator is to stop the scan,
      *   else SCAN_CONTINUE;
      */
-    virtual SEARCH_RESULT Traverse( INSPECTOR* inspector, void* testData, 
+    virtual SEARCH_RESULT Traverse( INSPECTOR* inspector, const void* testData, 
         const KICAD_T scanTypes[] );
     
 #endif

pcbnew/classpcb.cpp

@@ -21,14 +21,14 @@
 /**************************************************************/
 void EDA_BaseStruct::Place( WinEDA_DrawFrame* frame, wxDC* DC )
 /**************************************************************/
+
 /* fonction virtuelle de placement: non utilisee en pcbnew (utilisee eeschema)
----- A mieux utiliser (TODO...)
+ *  ---- A mieux utiliser (TODO...)
  */
 {
 }
 
 
-
 /**********************/
 /* Classe EDGE_ZONE */
 /**********************/
@@ -39,11 +39,13 @@ EDGE_ZONE::EDGE_ZONE(EDA_BaseStruct * parent):
 {
 }
 
+
 /* Effacement memoire de la structure */
 EDGE_ZONE:: ~EDGE_ZONE( void )
 {
 }
 
+
 /**********************/
 /* Classe DRAWSEGMENT */
 /**********************/
@@ -55,11 +57,13 @@ DRAWSEGMENT::DRAWSEGMENT(EDA_BaseStruct * StructFather, DrawStructureType idtype
     m_Flags = m_Shape = m_Type = m_Angle = 0;
 }
 
+
 /* Effacement memoire de la structure */
 DRAWSEGMENT:: ~DRAWSEGMENT( void )
 {
 }
 
+
 void DRAWSEGMENT::UnLink( void )
 {
     /* Modification du chainage arriere */
@@ -69,7 +73,6 @@ void DRAWSEGMENT::UnLink( void )
         {
             Pback->Pnext = Pnext;
         }
-
         else /* Le chainage arriere pointe sur la structure "Pere" */
         {
             ( (BOARD*) Pback )->m_Drawings = Pnext;
@@ -77,7 +80,8 @@ void DRAWSEGMENT::UnLink( void )
     }
 
     /* Modification du chainage avant */
-	if( Pnext) Pnext->Pback = Pback;
+    if( Pnext )
+        Pnext->Pback = Pback;
 
     Pnext = Pback = NULL;
 }
@@ -102,7 +106,8 @@ void DRAWSEGMENT::Copy(DRAWSEGMENT * source)
 bool DRAWSEGMENT::WriteDrawSegmentDescr( FILE* File )
 /********************************************************/
 {
-	if( GetState(DELETED) ) return FALSE;
+    if( GetState( DELETED ) )
+        return FALSE;
 
     fprintf( File, "$DRAWSEGMENT\n" );
     fprintf( File, "Po %d %d %d %d %d %d\n",
@@ -116,9 +121,11 @@ bool DRAWSEGMENT::WriteDrawSegmentDescr(FILE * File)
     return TRUE;
 }
 
+
 /******************************************************************/
 bool DRAWSEGMENT::ReadDrawSegmentDescr( FILE* File, int* LineNum )
 /******************************************************************/
+
 /* Lecture de la description de 1 segment type Drawing PCB
  */
 {
@@ -127,13 +134,15 @@ char Line[2048];
 
     while( GetLine( File, Line, LineNum ) != NULL )
     {
-		if(strnicmp(Line,"$End",4 ) == 0 ) return TRUE;  /* fin de liste */
+        if( strnicmp( Line, "$End", 4 ) == 0 )
+            return TRUE;                                /* fin de liste */
         if( Line[0] == 'P' )
         {
             sscanf( Line + 2, " %d %d %d %d %d %d",
                     &m_Shape, &m_Start.x, &m_Start.y,
                     &m_End.x, &m_End.y, &m_Width );
-			if ( m_Width < 0 ) m_Width = 0;
+            if( m_Width < 0 )
+                m_Width = 0;
         }
 
         if( Line[0] == 'D' )
@@ -150,13 +159,12 @@ char Line[2048];
 
             SetState( status, ON );
         }
-
     }
+
     return FALSE;
 }
 
 
-
 /*******************/
 /* Classe MARQUEUR */
 /*******************/
@@ -169,6 +177,7 @@ MARQUEUR::MARQUEUR(EDA_BaseStruct * StructFather):
     m_Color  = RED;
 }
 
+
 /* Effacement memoire de la structure */
 MARQUEUR:: ~MARQUEUR( void )
 {
@@ -176,7 +185,7 @@ MARQUEUR:: ~MARQUEUR(void)
 
 
 /* supprime du chainage la structure Struct
-  les structures arrieres et avant sont chainees directement
+ *  les structures arrieres et avant sont chainees directement
  */
 void MARQUEUR::UnLink( void )
 {
@@ -187,7 +196,6 @@ void MARQUEUR::UnLink( void )
         {
             Pback->Pnext = Pnext;
         }
-
         else /* Le chainage arriere pointe sur la structure "Pere" */
         {
             ( (BOARD*) Pback )->m_Drawings = Pnext;
@@ -195,13 +203,13 @@ void MARQUEUR::UnLink( void )
     }
 
     /* Modification du chainage avant */
-	if( Pnext) Pnext->Pback = Pback;
+    if( Pnext )
+        Pnext->Pback = Pback;
 
     Pnext = Pback = NULL;
 }
 
 
-
 /**************************************************/
 /* Class SCREEN: classe de gestion d'un affichage */
 /***************************************************/
@@ -209,12 +217,14 @@ void MARQUEUR::UnLink( void )
 PCB_SCREEN::PCB_SCREEN( int idscreen ) : BASE_SCREEN( TYPESCREEN )
 {
     int zoom_list[] = { 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 0 };
+
     m_Type = idscreen;
     SetGridList( g_GridList );
     SetZoomList( zoom_list );
     Init();
 }
 
+
 /***************************/
 PCB_SCREEN::~PCB_SCREEN( void )
 /***************************/
@@ -238,8 +248,9 @@ void PCB_SCREEN::Init(void)
 /*************************/
 /* class DISPLAY_OPTIONS */
 /*************************/
+
 /*
-Options diverses d'affichage à l'écran:
+ *  Options diverses d'affichage <EFBFBD>l'<EFBFBD>ran:
  */
 
 DISPLAY_OPTIONS::DISPLAY_OPTIONS( void )
@@ -268,6 +279,7 @@ DISPLAY_OPTIONS::DISPLAY_OPTIONS(void)
 /*****************************************************/
 EDA_BoardDesignSettings::EDA_BoardDesignSettings( void )
 /*****************************************************/
+
 // Default values for designing boards
 {
     int ii;
@@ -286,7 +298,8 @@ int default_layer_color[32]= {
         LIGHTGRAY,
         LIGHTGRAY,
         LIGHTGRAY,
-	LIGHTGRAY };
+        LIGHTGRAY
+    };
 
     m_CopperLayerCount = 2;             // Default design is a double sided board
     m_ViaDrill = 250;                   // via drill (for the entire board)
@@ -298,6 +311,7 @@ int default_layer_color[32]= {
         m_TrackWidhtHistory[ii] = 0;    // Last HIST0RY_NUMBER used track widths
         m_ViaSizeHistory[ii]    = 0;    // Last HIST0RY_NUMBER used via sizes
     }
+
     m_DrawSegmentWidth = 100;               // current graphic line width (not EDGE layer)
     m_EdgeSegmentWidth = 100;               // current graphic line width (EDGE layer only)
     m_PcbTextWidth   = 100;                 // current Pcb (not module) Text width
@@ -308,7 +322,9 @@ int default_layer_color[32]= {
     /* Color options for screen display of the Printed Board: */
     m_PcbGridColor = DARKGRAY;              // Grid color
     for( ii = 0; ii < 32; ii++ )
-		m_LayerColor[ii] = default_layer_color[ii];		// Layer colors (tracks and graphic items)
+        m_LayerColor[ii] = default_layer_color[ii];
+
+    // Layer colors (tracks and graphic items)
     m_ViaColor[VIA_BORGNE]   = CYAN;
     m_ViaColor[VIA_ENTERREE] = BROWN;
     m_ViaColor[VIA_NORMALE]  = WHITE;
@@ -320,4 +336,3 @@ int default_layer_color[32]= {
     m_PadCMPColor   = RED;              // Pad color for the COPPER side of the pad
     m_RatsnestColor = WHITE;            // Ratsnest color
 }
-