Schematic hierarchy path object improvements.

* Use Boost pointer container for sheet hierarchy object.
* Add test for modification in sheet hierarchy list object.
* Add method to clear modification flag in sheet hierarchy list object.
* Improve Doxygen comments for sheet hierarchy list object.
* Remove redundant definitions in prototypes header file.

eeschema/protos.h

@@ -2,29 +2,19 @@
 #ifndef __PROTOS_H__
 #define __PROTOS_H__
 
-#include "block_commande.h"
 #include "colors.h"
-#include "sch_sheet_path.h"
 
-#include <wx/wx.h>
 
-
-class EDA_ITEM;
 class EDA_DRAW_PANEL;
 class EDA_DRAW_FRAME;
 class SCH_EDIT_FRAME;
 class LIB_EDIT_FRAME;
 class CMP_LIBRARY;
-class LIB_COMPONENT;
-class LIB_DRAW_ITEM;
 class SCH_COMPONENT;
 class SCH_SCREEN;
 class SCH_ITEM;
-class SCH_SHEET_PIN;
 class PLOTTER;
 class SCH_SHEET;
-class LIB_PIN;
-class LABEL_OBJECT;
 class NETLIST_OBJECT;
 
 
@@ -52,17 +42,18 @@ void IncrementLabelMember( wxString& name );
 /****************/
 void InstallCmpeditFrame( SCH_EDIT_FRAME* parent, wxPoint& pos, SCH_COMPONENT* m_Cmp );
 
-void           SnapLibItemPoint( int            OrigX,
-                                 int            OrigY,
-                                 int*           ClosestX,
-                                 int*           ClosestY,
-                                 SCH_COMPONENT* DrawLibItem );
-bool           LibItemInBox( int x1, int y1, int x2, int y2, SCH_COMPONENT* DrawLibItem );
+void SnapLibItemPoint( int            OrigX,
+                       int            OrigY,
+                       int*           ClosestX,
+                       int*           ClosestY,
+                       SCH_COMPONENT* DrawLibItem );
+
+bool LibItemInBox( int x1, int y1, int x2, int y2, SCH_COMPONENT* DrawLibItem );
 
 /************/
 /* BLOCK.CPP */
 /************/
-void      DeleteStruct( EDA_DRAW_PANEL* panel, wxDC* DC, SCH_ITEM* DrawStruct );
+void DeleteStruct( EDA_DRAW_PANEL* panel, wxDC* DC, SCH_ITEM* DrawStruct );
 
 
 // operations_on_item_lists.cpp
@@ -82,7 +73,7 @@ SCH_ITEM* DuplicateStruct( SCH_ITEM* DrawStruct, bool aClone = false );
 /* LOCATE.CPP */
 /*************/
 
-SCH_COMPONENT*  LocateSmallestComponent( SCH_SCREEN* Screen );
+SCH_COMPONENT* LocateSmallestComponent( SCH_SCREEN* Screen );
 
 /* function PickStruct:
  *   Search at location pos
@@ -127,14 +118,14 @@ void RedrawActiveWindow( EDA_DRAW_PANEL* panel, wxDC* DC );
 /**************/
 /* EELAYER.CPP */
 /**************/
-void       SeedLayers();
+void SeedLayers();
 EDA_Colors ReturnLayerColor( int Layer );
 
 
 /**************/
 /* NETLIST.CPP */
 /**************/
-int  IsBusLabel( const wxString& LabelDrawList );
+int IsBusLabel( const wxString& LabelDrawList );
 
 /************/
 /* PLOT.CPP */
@@ -181,10 +172,10 @@ void InstallPineditFrame( LIB_EDIT_FRAME* parent, wxDC* DC, const wxPoint& pos )
  *   1 if selected component
  *   0 if canceled order
  */
-int            DisplayComponentsNamesInLib( EDA_DRAW_FRAME* frame,
-                                            CMP_LIBRARY*    Library,
-                                            wxString&       Buffer,
-                                            wxString&       OldName );
+int DisplayComponentsNamesInLib( EDA_DRAW_FRAME* frame,
+                                 CMP_LIBRARY*    Library,
+                                 wxString&       Buffer,
+                                 wxString&       OldName );
 
 /**
  * Function SelectLibraryFromList
@@ -203,9 +194,7 @@ CMP_LIBRARY* SelectLibraryFromList( EDA_DRAW_FRAME* frame );
  *   0 if canceled order
  * Place the name of the selected component list in BufName
  */
-int            GetNameOfPartToLoad( EDA_DRAW_FRAME* frame,
-                                    CMP_LIBRARY*    Lib,
-                                    wxString&       BufName );
+int GetNameOfPartToLoad( EDA_DRAW_FRAME* frame, CMP_LIBRARY* Lib, wxString& BufName );
 
 /**************/
 /* LIBARCH.CPP */
@@ -227,7 +216,7 @@ void RemoteCommand( const char* cmdline );
 
 
 /* Prototypes in netlist_control.cpp */
-void     FreeNetObjectsList( std::vector <NETLIST_OBJECT*>& aNetObjectslist );
+void FreeNetObjectsList( std::vector <NETLIST_OBJECT*>& aNetObjectslist );
 
 /**
  * Function ReturnUserNetlistTypeName

eeschema/sch_sheet.h

@@ -530,4 +530,7 @@ private:
     virtual EDA_ITEM* doClone() const;
 };
 
+
+typedef boost::ptr_vector< SCH_SHEET > SCH_SHEETS;
+
 #endif /* CLASS_DRAWSHEET_H */

eeschema/sch_sheet_path.cpp

@@ -3,7 +3,7 @@
 // Purpose:     member functions for SCH_SHEET_PATH
 //              header = sch_sheet_path.h
 // Author:      jean-pierre Charras
-// Modified by:
+// Modified by: Wayne Stambaugh
 // License:     License GNU
 /////////////////////////////////////////////////////////////////////////////
 
@@ -25,44 +25,43 @@
 #include "dialogs/dialog_schematic_find.h"
 
 
-/**********************************************/
-/* class to handle a series of sheets *********/
-/* a 'path' so to speak.. *********************/
-/**********************************************/
 SCH_SHEET_PATH::SCH_SHEET_PATH()
 {
-    for( int i = 0; i<DSLSZ; i++ )
-        m_sheets[i] = NULL;
+}
+
 
-    m_numSheets = 0;
+SCH_SHEET_PATH::~SCH_SHEET_PATH()
+{
+    // The sheets are not owned by the sheet path object so don't allow them to be destroyed.
+    Clear();
+}
+
+
+void SCH_SHEET_PATH::Clear()
+{
+    while( !m_sheets.empty() )
+        m_sheets.pop_back().release();
 }
 
 
-/**
- * Function BuildSheetPathInfoFromSheetPathValue
- * Fill this with data to access to the hierarchical sheet known by its path
- * aPath
- * @param aPath = path of the sheet to reach (in non human readable format)
- * @return true if success else false
- */
 bool SCH_SHEET_PATH::BuildSheetPathInfoFromSheetPathValue( const wxString& aPath, bool aFound )
 {
     if( aFound )
         return true;
 
-    if(  GetSheetsCount() == 0 )
+    if( GetSheetCount() == 0 )
         Push( g_RootSheet );
 
     if( aPath == Path() )
         return true;
 
-    SCH_ITEM* schitem = LastDrawList();
+    SCH_ITEM* item = LastDrawList();
 
-    while( schitem && GetSheetsCount() < NB_MAX_SHEET )
+    while( item && GetSheetCount() < NB_MAX_SHEET )
     {
-        if( schitem->Type() == SCH_SHEET_T )
+        if( item->Type() == SCH_SHEET_T )
         {
-            SCH_SHEET* sheet = (SCH_SHEET*) schitem;
+            SCH_SHEET* sheet = (SCH_SHEET*) item;
             Push( sheet );
 
             if( aPath == Path() )
@@ -73,34 +72,29 @@ bool SCH_SHEET_PATH::BuildSheetPathInfoFromSheetPathValue( const wxString& aPath
 
             Pop();
         }
-        schitem = schitem->Next();
+
+        item = item->Next();
     }
 
     return false;
 }
 
 
-/**
- * Function Cmp
- * Compare if this is the same sheet path as aSheetPathToTest
- * @param aSheetPathToTest = sheet path to compare
- * @return -1 if different, 0 if same
- */
 int SCH_SHEET_PATH::Cmp( const SCH_SHEET_PATH& aSheetPathToTest ) const
 {
-    if( m_numSheets > aSheetPathToTest.m_numSheets )
+    if( m_sheets.size() > aSheetPathToTest.GetSheetCount() )
         return 1;
 
-    if( m_numSheets < aSheetPathToTest.m_numSheets )
+    if( m_sheets.size() < aSheetPathToTest.GetSheetCount() )
         return -1;
 
-    //otherwise, same number of sheets.
-    for( unsigned i = 0; i<m_numSheets; i++ )
+    // Same number of sheets, use time stamps.
+    for( unsigned i = 0; i < GetSheetCount(); i++ )
     {
-        if( m_sheets[i]->m_TimeStamp > aSheetPathToTest.m_sheets[i]->m_TimeStamp )
+        if( m_sheets[i].m_TimeStamp > aSheetPathToTest.m_sheets[i].m_TimeStamp )
             return 1;
 
-        if( m_sheets[i]->m_TimeStamp < aSheetPathToTest.m_sheets[i]->m_TimeStamp )
+        if( m_sheets[i].m_TimeStamp < aSheetPathToTest.m_sheets[i].m_TimeStamp )
             return -1;
     }
 
@@ -108,24 +102,15 @@ int SCH_SHEET_PATH::Cmp( const SCH_SHEET_PATH& aSheetPathToTest ) const
 }
 
 
-/**
- * Function Last
- * returns a pointer to the last sheet of the list
- * One can see the others sheet as the "path" to reach this last sheet
- */
 SCH_SHEET* SCH_SHEET_PATH::Last()
 {
-    if( m_numSheets )
-        return m_sheets[m_numSheets - 1];
+    if( !m_sheets.empty() )
+        return &m_sheets[ m_sheets.size() - 1 ];
 
     return NULL;
 }
 
 
-/**
- * Function LastScreen
- * @return the SCH_SCREEN relative to the last sheet in list
- */
 SCH_SCREEN* SCH_SHEET_PATH::LastScreen()
 {
     SCH_SHEET* lastSheet = Last();
@@ -137,17 +122,12 @@ SCH_SCREEN* SCH_SHEET_PATH::LastScreen()
 }
 
 
-/**
- * Function LastScreen
- * @return a pointer to the first schematic item handled by the
- * SCH_SCREEN relative to the last sheet in list
- */
 SCH_ITEM* SCH_SHEET_PATH::LastDrawList()
 {
-    SCH_SHEET* lastSheet = Last();
+    SCH_SCREEN* screen = LastScreen();
 
-    if( lastSheet && lastSheet->GetScreen() )
-        return lastSheet->GetScreen()->GetDrawItems();
+    if( screen )
+        return screen->GetDrawItems();
 
     return NULL;
 }
@@ -157,66 +137,37 @@ SCH_ITEM* SCH_SHEET_PATH::FirstDrawList()
 {
     SCH_ITEM* item = NULL;
 
-    if( m_numSheets && m_sheets[0]->GetScreen() )
-        item = m_sheets[0]->GetScreen()->GetDrawItems();
-
-    /* @fixme - These lists really should be one of the boost pointer containers.  This
-     *          is a brain dead hack to allow reverse iteration of EDA_ITEM linked
-     *          list.
-     */
-    SCH_ITEM* lastItem = NULL;
-
-    while( item != NULL )
-    {
-        lastItem = item;
-        item = item->Next();
-    }
+    if( !m_sheets.empty() && m_sheets[0].GetScreen() )
+        item = m_sheets[0].GetScreen()->GetDrawItems();
 
-    return lastItem;
+    return item;
 }
 
 
 void SCH_SHEET_PATH::Push( SCH_SHEET* aSheet )
 {
-    if( m_numSheets > DSLSZ )
+    if( m_sheets.size() >= MAX_SHEET_PATH_DEPTH )
     {
-        wxString msg;
-        msg.Printf( _( "Schematic sheets can only be nested %d levels deep." ), DSLSZ );
-        wxMessageBox( msg );
+        wxLogWarning( _( "Schematic sheets can only be nested %d levels deep.  Not adding sheet %s" ),
+                      MAX_SHEET_PATH_DEPTH, GetChars( aSheet->m_SheetName ) );
+        return;
     }
 
-    if( m_numSheets < DSLSZ )
-    {
-        m_sheets[m_numSheets] = aSheet;
-        m_numSheets++;
-    }
+    m_sheets.push_back( aSheet );
 }
 
 
-/**
- * Function Pop
- * retrieves (pop) the last entered sheet and remove it from list
- * @return a SCH_SHEET* pointer to the removed sheet in list
- */
 SCH_SHEET* SCH_SHEET_PATH::Pop()
 {
-    if( m_numSheets > 0 )
-    {
-        m_numSheets--;
-        return m_sheets[m_numSheets];
-    }
+    if( m_sheets.empty() )
+        return NULL;
 
-    return NULL;
+    // The sheet must be released from the end of the container otherwise it will be destroyed.
+    return m_sheets.pop_back().release();
 }
 
 
-/**
- * Function Path
- * the path uses the time stamps which do not changes even when editing sheet
- * parameters
- * a path is something like / (root) or /34005677 or /34005677/00AE4523
- */
-wxString SCH_SHEET_PATH::Path()
+wxString SCH_SHEET_PATH::Path() const
 {
     wxString s, t;
 
@@ -225,9 +176,9 @@ wxString SCH_SHEET_PATH::Path()
     // start at 1 to avoid the root sheet,
     // which does not need to be added to the path
     // it's timestamp changes anyway.
-    for( unsigned i = 1; i < m_numSheets; i++ )
+    for( unsigned i = 1; i < m_sheets.size(); i++ )
     {
-        t.Printf( _( "%8.8lX/" ), m_sheets[i]->m_TimeStamp );
+        t.Printf( _( "%8.8lX/" ), m_sheets[i].m_TimeStamp );
         s = s + t;
     }
 
@@ -235,13 +186,6 @@ wxString SCH_SHEET_PATH::Path()
 }
 
 
-/**
- * Function PathHumanReadable
- * Return the sheet path in a readable form, i.e.
- * as a path made from sheet names.
- * (the "normal" path uses the time stamps which do not changes even when
- * editing sheet parameters)
- */
 wxString SCH_SHEET_PATH::PathHumanReadable() const
 {
     wxString s, t;
@@ -249,9 +193,9 @@ wxString SCH_SHEET_PATH::PathHumanReadable() const
     s = wxT( "/" );
 
     // start at 1 to avoid the root sheet, as above.
-    for( unsigned i = 1; i< m_numSheets; i++ )
+    for( unsigned i = 1; i< m_sheets.size(); i++ )
     {
-        s = s + m_sheets[i]->m_SheetName + wxT( "/" );
+        s = s + m_sheets[i].m_SheetName + wxT( "/" );
     }
 
     return s;
@@ -313,12 +257,12 @@ void SCH_SHEET_PATH::AnnotatePowerSymbols( int* aReference )
 }
 
 
-void SCH_SHEET_PATH::GetComponents( SCH_REFERENCE_LIST& aReferences,
-                                    bool                aIncludePowerSymbols )
+void SCH_SHEET_PATH::GetComponents( SCH_REFERENCE_LIST& aReferences, bool aIncludePowerSymbols )
 {
     // Search to sheet path number:
     int sheetnumber = 1;    // 1 = root
     SCH_SHEET_LIST sheetList;
+
     for( SCH_SHEET_PATH* path = sheetList.GetFirst(); path != NULL;
          path = sheetList.GetNext(), sheetnumber++ )
         if( Cmp(*path) == 0 )
@@ -416,7 +360,7 @@ SCH_ITEM* SCH_SHEET_PATH::FindPreviousItem( KICAD_T aType, SCH_ITEM* aLastItem,
 
 SCH_ITEM* SCH_SHEET_PATH::MatchNextItem( wxFindReplaceData& aSearchData,
                                          SCH_ITEM*          aLastItem,
-                                         wxPoint * aFindLocation )
+                                         wxPoint*           aFindLocation )
 {
     bool hasWrapped = false;
     bool firstItemFound = false;
@@ -448,34 +392,14 @@ SCH_ITEM* SCH_SHEET_PATH::MatchNextItem( wxFindReplaceData& aSearchData,
 }
 
 
-bool SCH_SHEET_PATH::operator=( const SCH_SHEET_PATH& d1 )
-{
-    m_numSheets = d1.m_numSheets;
-
-    unsigned i;
-
-    for( i = 0; i < m_numSheets; i++ )
-    {
-        m_sheets[i] = d1.m_sheets[i];
-    }
-
-    for( ; i < DSLSZ; i++ )
-    {
-        m_sheets[i] = 0;
-    }
-
-    return true;
-}
-
-
 bool SCH_SHEET_PATH::operator==( const SCH_SHEET_PATH& d1 ) const
 {
-    if( m_numSheets != d1.m_numSheets )
+    if( m_sheets.size() != d1.m_sheets.size() )
         return false;
 
-    for( unsigned i = 0; i < m_numSheets; i++ )
+    for( unsigned i = 0; i < m_sheets.size(); i++ )
     {
-        if( m_sheets[i] != d1.m_sheets[i] )
+        if( &m_sheets[i] != &d1.m_sheets[i] )
             return false;
     }
 
@@ -483,38 +407,11 @@ bool SCH_SHEET_PATH::operator==( const SCH_SHEET_PATH& d1 ) const
 }
 
 
-bool SCH_SHEET_PATH::operator!=( const SCH_SHEET_PATH& d1 ) const
-{
-    if( m_numSheets != d1.m_numSheets )
-        return true;
-
-    for( unsigned i = 0; i < m_numSheets; i++ )
-    {
-        if( m_sheets[i] != d1.m_sheets[i] )
-        {
-            /*
-            printf( "micompare this:'%s' d1:'%s'\n",
-                CONV_TO_UTF8( PathHumanReadable() ),
-                CONV_TO_UTF8( d1.PathHumanReadable() ) );
-            */
-
-            return true;
-        }
-    }
-
-    return false;
-}
-
-
 /*********************************************************************/
 /* Class SCH_SHEET_LIST to handle the list of Sheets in a hierarchy */
 /*********************************************************************/
 
 
-/* The constructor: build the list of sheets from aSheet.
- * If aSheet == NULL (default) build the whole list of sheets in hierarchy
- * So usually call it with no param.
- */
 SCH_SHEET_LIST::SCH_SHEET_LIST( SCH_SHEET* aSheet )
 {
     m_index = 0;
@@ -528,10 +425,6 @@ SCH_SHEET_LIST::SCH_SHEET_LIST( SCH_SHEET* aSheet )
 }
 
 
-/**
- * Function GetFirst
- *  @return the first item (sheet) in m_List and prepare calls to GetNext()
- */
 SCH_SHEET_PATH* SCH_SHEET_LIST::GetFirst()
 {
     m_index = 0;
@@ -543,11 +436,6 @@ SCH_SHEET_PATH* SCH_SHEET_LIST::GetFirst()
 }
 
 
-/**
- * Function GetNext
- *  @return the next item (sheet) in m_List or NULL if no more item in sheet
- * list
- */
 SCH_SHEET_PATH* SCH_SHEET_LIST::GetNext()
 {
     if( m_index < GetCount() )
@@ -579,12 +467,6 @@ SCH_SHEET_PATH* SCH_SHEET_LIST::GetPrevious()
 }
 
 
-/**
- * Function GetSheet
- *  @return the item (sheet) in aIndex position in m_List or NULL if less than
- * index items
- * @param aIndex = index in sheet list to get the sheet
- */
 SCH_SHEET_PATH* SCH_SHEET_LIST::GetSheet( int aIndex )
 {
     if( aIndex < GetCount() )
@@ -594,6 +476,28 @@ SCH_SHEET_PATH* SCH_SHEET_LIST::GetSheet( int aIndex )
 }
 
 
+bool SCH_SHEET_LIST::IsModified()
+{
+    for( SCH_SHEET_PATH* sheet = GetFirst(); sheet != NULL; sheet = GetNext() )
+    {
+        if( sheet->LastScreen() && sheet->LastScreen()->IsModify() )
+            return true;
+    }
+
+    return false;
+}
+
+
+void SCH_SHEET_LIST::ClearModifyStatus()
+{
+    for( SCH_SHEET_PATH* sheet = GetFirst(); sheet != NULL; sheet = GetNext() )
+    {
+        if( sheet->LastScreen() )
+            sheet->LastScreen()->ClrModify();
+    }
+}
+
+
 void SCH_SHEET_LIST::BuildSheetList( SCH_SHEET* aSheet )
 {
     if( m_List == NULL )
@@ -745,7 +649,7 @@ SCH_ITEM* SCH_SHEET_LIST::FindPreviousItem( KICAD_T aType, SCH_SHEET_PATH** aShe
 SCH_ITEM* SCH_SHEET_LIST::MatchNextItem( wxFindReplaceData& aSearchData,
                                          SCH_SHEET_PATH**   aSheetFoundIn,
                                          SCH_ITEM*          aLastItem,
-                                         wxPoint * aFindLocation )
+                                         wxPoint*           aFindLocation )
 {
     bool hasWrapped = false;
     bool firstItemFound = false;

eeschema/sch_sheet_path.h

@@ -5,7 +5,7 @@
 #ifndef CLASS_DRAWSHEET_PATH_H
 #define CLASS_DRAWSHEET_PATH_H
 
-#include "base_struct.h"
+#include "sch_sheet.h"
 
 /** Info about complex hierarchies handling:
  * A hierarchical schematic uses sheets (hierarchical sheets) included in a
@@ -53,74 +53,61 @@
 class wxFindReplaceData;
 class SCH_SCREEN;
 class SCH_MARKER;
-class SCH_SHEET;
 class SCH_ITEM;
 class SCH_REFERENCE_LIST;
 
 
 /**
  * Class SCH_SHEET_PATH
- * handles access to a sheet by way of a path.
+ * handles access to a hierarchical sheet by way of a path.
  * <p>
- * The member m_sheets stores the list of sheets from the first (usually
- * g_RootSheet) to a given sheet in last position.
- * The _last_ sheet is usually the sheet we want to select or reach (which is
- * what the function Last() returns).
- * Others sheets constitute the "path" from the first to the last sheet.
+ * The sheets are stored from the first (usually the root sheet) to the last sheet in
+ * the hierarchy.  The _last_ sheet is usually the sheet used to select or reach the
+ * data for the sheet (which is what the function Last() returns).  The other sheets
+ * constitute the "path" to the last sheet.
  */
 class SCH_SHEET_PATH
 {
-private:
-    unsigned        m_numSheets;
+    SCH_SHEETS m_sheets;  ///< The list of sheets used to create this sheet path.
 
 public:
-#define DSLSZ 32          // Max number of levels for a sheet path
-    SCH_SHEET*      m_sheets[DSLSZ];
-
+#define MAX_SHEET_PATH_DEPTH 32          // Max number of levels for a sheet path
 
-public:
     SCH_SHEET_PATH();
-    // ~SCH_SHEET_PATH() { };
 
-    void Clear()
-    {
-        m_numSheets = 0;
-    }
+    ~SCH_SHEET_PATH();
 
+    void Clear();
 
-    unsigned GetSheetsCount()
-    {
-        return m_numSheets;
-    }
-
+    unsigned GetSheetCount() const { return m_sheets.size(); }
 
     /**
      * Function Cmp
-     * Compare if this is the same sheet path as aSheetPathToTest
-     * @param aSheetPathToTest = sheet path to compare
-     * @return -1 if different, 0 if same
+     * compares if the sheet path is the same as the sheet path of \a aSheetPathToTest
+     * @param aSheetPathToTest Sheet path to compare.
+     * @return -1 is less than, 0 if same as, or 1 if greater than.
      */
-    int              Cmp( const SCH_SHEET_PATH& aSheetPathToTest ) const;
+    int Cmp( const SCH_SHEET_PATH& aSheetPathToTest ) const;
 
     /**
      * Function Last
-     * returns a pointer to the last sheet of the list
-     * One can see the others sheet as the "path" to reach this last sheet
+     * returns a pointer to the last sheet of the list.
+     * One can see the others sheet as the "path" to reach this last sheet.
      */
-    SCH_SHEET*      Last();
+    SCH_SHEET* Last();
 
     /**
      * Function LastScreen
-     * @return the SCH_SCREEN relative to the last sheet in list
+     * @return The SCH_SCREEN relative to the last sheet in the hierarchy.
      */
-    SCH_SCREEN*      LastScreen();
+    SCH_SCREEN* LastScreen();
 
     /**
-     * Function LastScreen
-     * @return a pointer to the first schematic item handled by the
-     * SCH_SCREEN relative to the last sheet in list
+     * Function LastDrawItem
+     * @return The first item in the draw list of the screen associated with the last
+     * sheet in the hierarchy.
      */
-    SCH_ITEM*        LastDrawList();
+    SCH_ITEM* LastDrawList();
 
     /**
      * Get the last schematic item relative to the first sheet in the list.
@@ -128,63 +115,60 @@ public:
      * @return Last schematic item relative to the first sheet in the list if list
      *         is not empty.  Otherwise NULL.
      */
-    SCH_ITEM*        FirstDrawList();
+    SCH_ITEM* FirstDrawList();
 
     /**
      * Function Push
-     * store (push) aSheet in list
-     * @param aSheet = pointer to the SCH_SHEET to store in list
-     * Push is used when entered a sheet to select or analyze it
-     * This is like cd &ltdirectory&gt in directories navigation
+     * adds \a aSheet to the end of the hierarchy.
+     * @param aSheet The SCH_SHEET to store in the hierarchy.
+     * Push is used to enter a sheet to select or analyze it.  This is like using
+     * cd &ltdirectory&gt to navigate a directory.
      */
-    void             Push( SCH_SHEET* aSheet );
+    void Push( SCH_SHEET* aSheet );
 
     /**
      * Function Pop
-     * retrieves (pop) the last entered sheet and remove it from list
-     * @return a SCH_SHEET* pointer to the removed sheet in list
-     * Pop is used when leaving a sheet after a selection or analyze
-     * This is like cd .. in directories navigation
+     * removes and returns the last sheet in the hierarchy.
+     * @return The last in the hierarchy or NULL if there are no sheets in the hierarchy.
+     * <p>
+     * Pop is used when leaving a sheet after a has been selected or analyzed.  This is
+     * like using cd .. to navigate a directory.
      */
-    SCH_SHEET*      Pop();
+    SCH_SHEET* Pop();
 
     /**
      * Function Path
-     * the path uses the time stamps which do not changes even when editing
-     * sheet parameters
-     * a path is something like / (root) or /34005677 or /34005677/00AE4523
+     * returns the path using the time stamps which do not changes even when editing
+     * sheet parameters.
+     * Sample paths include / (root) or /34005677 or /34005677/00AE4523
      */
-    wxString         Path();
+    wxString Path() const;
 
     /**
      * Function PathHumanReadable
-     * returns the sheet path in a human readable form, i.e. as a path made
-     * from sheet names.  The the "normal" path instead uses the time
-     * stamps in the path.  (Time stamps do not change even when editing
-     * sheet parameters).
+     * returns the sheet path in a human readable form, i.e. as a path made from sheet
+     * names.  This is the "normal" path instead of the path that uses the time stamps
+     * in the path.  Time stamps do not change even when the sheet name is changed.
      */
-    wxString         PathHumanReadable()  const;
+    wxString PathHumanReadable() const;
 
     /**
      * Function BuildSheetPathInfoFromSheetPathValue
-     * Fill this with data to access to the hierarchical sheet known by its path \a aPath
+     * creates the hierarchy to access the sheet known by \a aPath.
      * @param aPath = path of the sheet to reach (in non human readable format)
      * @param aFound - Please document me.
      * @return true if success else false
      */
-    bool BuildSheetPathInfoFromSheetPathValue( const wxString& aPath,
-                                               bool            aFound = false );
+    bool BuildSheetPathInfoFromSheetPathValue( const wxString& aPath, bool aFound = false );
 
     /**
      * Function UpdateAllScreenReferences
-     * updates the reference and the m_Multi parameter (part selection) for all
-     * components on a screen depending on the actual sheet path.
-     * Mandatory in complex hierarchies because sheets use the same screen
-     * (basic schematic)
-     * but with different references and part selections according to the
-     * displayed sheet
+     * updates the reference and the part selection parameter for all components with
+     * multiple parts on a screen depending on the actual sheet path.  This is required
+     * in complex hierarchies because sheets use the same screen with different references
+     * and part selections according to the displayed sheet.
      */
-    void             UpdateAllScreenReferences();
+    void UpdateAllScreenReferences();
 
     /**
      * Function AnnotatePowerSymbols
@@ -206,56 +190,61 @@ public:
                         bool                aIncludePowerSymbols = true  );
 
     /**
-     * Find the next schematic item in this sheet ojbect.
+     * Function FindNextItem
+     * searches for the next schematic item of \a aType in the hierarchy.
      *
-     * @param aType - The type of schematic item object to search for.
-     * @param aLastItem - Start search from aLastItem.  If no aLastItem, search from
-     *                    the beginning of the list.
-     * @param aWrap - Wrap around the end of the list to find the next item if aLastItem
+     * @param aType The type of schematic item object to search for.
+     * @param aLastItem Start search from aLastItem.  If no aLastItem, search from
+     *                  the beginning of the list.
+     * @param aWrap Wrap around the end of the list to find the next item if aLastItem
      *                is defined.
-     * @return - The next schematic item if found.  Otherwise, NULL is returned.
+     * @return The next schematic item if found.  Otherwise, NULL is returned.
      */
     SCH_ITEM* FindNextItem( KICAD_T aType, SCH_ITEM* aLastItem = NULL, bool aWrap = false );
 
     /**
-     * Find the previous schematic item in this sheet path object.
+     * Fucntion FindPreviousItem
+     * searched for the previous schematic item of \a aType in the hierarchy.
      *
-     * @param aType - The type of schematic item object to search for.
-     * @param aLastItem - Start search from aLastItem.  If no aLastItem, search from
-     *                    the end of the list.
-     * @param aWrap - Wrap around the beginning of the list to find the next item if aLastItem
-     *                is defined.
-     * @return - The previous schematic item if found.  Otherwise, NULL is returned.
+     * @param aType The type of schematic item object to search for.
+     * @param aLastItem Start search from aLastItem.  If no aLastItem, search from
+     *                  the end of the list.
+     * @param aWrap Wrap around the beginning of the list to find the next item if aLastItem
+     *              is defined.
+     * @return The previous schematic item if found.  Otherwise, NULL is returned.
      */
     SCH_ITEM* FindPreviousItem( KICAD_T aType, SCH_ITEM* aLastItem = NULL, bool aWrap = false );
 
     /**
-     * Search this sheet path for the next item that matches the search criteria.
+     * Funnction MatchNextItem
+     * searches the hierarchy for the next item that matches the search criteria
+     * \a aSeaechDate.
      *
-     * @param aSearchData - Criteria to search item against.
-     * @param aLastItem - Find next item after aLastItem if not NULL.
-     * @param aFindLocation - a wxPoint where to put the location of matched item. can be NULL.
-     * @return If found, Returns the next schematic item.  Otherwise, returns NULL.
+     * @param aSearchData Criteria to search item against.
+     * @param aLastItem Find next item after aLastItem if not NULL.
+     * @param aFindLocation The location where to put the location of matched item.  Can be NULL.
+     * @return The next schematic item if found.  Otherwise, returns NULL.
      */
     SCH_ITEM* MatchNextItem( wxFindReplaceData& aSearchData, SCH_ITEM* aLastItem,
-                             wxPoint * aFindLocation  );
-
-    bool operator=( const SCH_SHEET_PATH& d1 );
+                             wxPoint* aFindLocation );
 
     bool operator==( const SCH_SHEET_PATH& d1 ) const;
 
-    bool operator!=( const SCH_SHEET_PATH& d1 ) const;
+    bool operator!=( const SCH_SHEET_PATH& d1 ) const { return !( *this == d1 ); }
 };
 
 
 /**
  * Class SCH_SHEET_LIST
- * handles the list of Sheets in a hierarchy.
- * Sheets are not unique, there can be many sheets with the same
- * filename and the same SCH_SCREEN reference.
- * The schematic (SCH_SCREEN) is shared between these sheets,
- * and component references are specific to a sheet path.
- * When a sheet is entered, component references and sheet number are updated.
+ * handles a list of hierarchies.
+ * <p>
+ * Sheets may not be unique.  There can be many sheets that share the same file name and
+ * SCH_SCREEN reference.  When a file is shared between sheets the component references
+ * are specific to where the sheet is in the hierarchy.   When a sheet is entered, the
+ * component references and sheet number in the screen are updated to reflect the sheet
+ * path.  If the hierarchy is created with the root sheet, the hierarchy represents the
+ * entire schematic.
+ * </p>
  */
 class SCH_SHEET_LIST
 {
@@ -293,35 +282,34 @@ public:
 
     /**
      * Function GetCount
-     * @return the number of sheets in list:
+     * @return The number of sheets in the hierarchy.
      * usually the number of sheets found in the whole hierarchy
      */
     int GetCount() { return m_count; }
 
     /**
      * Function GetFirst
-     * @return the first item (sheet) in m_List and prepare calls to GetNext()
+     * @return The first hierarchical path and prepare for calls to GetNext().
      */
     SCH_SHEET_PATH* GetFirst();
 
     /**
      * Function GetNext
-     * @return the next item (sheet) in m_List or NULL if no more item in
-     * sheet list
+     * @return The next hierarchical path or NULL if the end of the list.
      */
     SCH_SHEET_PATH* GetNext();
 
     /**
      * Function GetLast
-     * returns the last sheet in the sheet list.
+     * returns the last sheet in the hierarchy.
      *
-     * @return Last sheet in the list or NULL if sheet list is empty.
+     * @return Last sheet in the hierarchy or NULL if the hierarchy is empty.
      */
     SCH_SHEET_PATH* GetLast();
 
     /**
      * Function GetPrevious
-     * returns the previous sheet in the sheet list.
+     * returns the previous sheet in the hierarchy.
      *
      * @return The previous sheet in the sheet list or NULL if already at the
      *         beginning of the list.
@@ -330,15 +318,23 @@ public:
 
     /**
      * Function GetSheet
-     * @return the item (sheet) in aIndex position in m_List or NULL if less
-     * than index items
-     * @param aIndex = index in sheet list to get the sheet
+     * @return The hierarchy at \a aIndex position or NULL if \a aIndex is out of range.
+     * @param aIndex Index in the list of hierarchies.
      */
     SCH_SHEET_PATH* GetSheet( int aIndex );
 
+    /**
+     * Function IsModified
+     * checks the entire hierachy for any modifications.
+     * @returns True if the hierarchy is modified otherwise false.
+     */
+    bool IsModified();
+
+    void ClearModifyStatus();
+
     /**
      * Function AnnotatePowerSymbols
-     * clear and annotates the entire hierarchy of the sheet path list.
+     * clear and annotate the entire hierarchy of the sheet path list.
      */
     void AnnotatePowerSymbols();
 
@@ -356,11 +352,11 @@ public:
      * Function FindNextItem
      * searches the entire schematic for the next schematic object.
      *
-     * @param aType - The type of schematic item to find.
-     * @param aSheetFound - The sheet the item was found in.  NULL if the next item
-     *                      is not found.
-     * @param aLastItem - Find next item after aLastItem if not NULL.
-     * @param aWrap - Wrap past around the end of the list of sheets.
+     * @param aType The type of schematic item to find.
+     * @param aSheetFound The sheet the item was found in.  NULL if the next item
+     *                    is not found.
+     * @param aLastItem Find next item after aLastItem if not NULL.
+     * @param aWrap Wrap past around the end of the list of sheets.
      * @return If found, Returns the next schematic item.  Otherwise, returns NULL.
      */
     SCH_ITEM* FindNextItem( KICAD_T aType, SCH_SHEET_PATH** aSheetFound = NULL,
@@ -370,11 +366,11 @@ public:
      * Function FindPreviousItem
      * searches the entire schematic for the previous schematic item.
      *
-     * @param aType - The type of schematic item to find.
-     * @param aSheetFound - The sheet the item was found in.  NULL if the previous item
-     *                      is not found.
-     * @param aLastItem - Find the previous item before aLastItem if not NULL.
-     * @param aWrap - Wrap past around the beginning of the list of sheets.
+     * @param aType The type of schematic item to find.
+     * @param aSheetFound The sheet the item was found in.  NULL if the previous item
+     *                    is not found.
+     * @param aLastItem Find the previous item before aLastItem if not NULL.
+     * @param aWrap Wrap past around the beginning of the list of sheets.
      * @return If found, the previous schematic item.  Otherwise, NULL.
      */
     SCH_ITEM* FindPreviousItem( KICAD_T aType, SCH_SHEET_PATH** aSheetFound = NULL,
@@ -384,27 +380,27 @@ public:
      * Function MatchNextItem
      * searches the entire schematic for the next item that matches the search criteria.
      *
-     * @param aSearchData - Criteria to search item against.
-     * @param aSheetFound - The sheet the item was found in.  NULL if the next item
-     *                      is not found.
-     * @param aLastItem - Find next item after aLastItem if not NULL.
-     * @param aFindLocation - a wxPoint where to put the location of matched item. can be NULL.
+     * @param aSearchData Criteria to search item against.
+     * @param aSheetFound The sheet the item was found in.  NULL if the next item
+     *                    is not found.
+     * @param aLastItem Find next item after aLastItem if not NULL.
+     * @param aFindLocation a wxPoint where to put the location of matched item. can be NULL.
      * @return If found, Returns the next schematic item.  Otherwise, returns NULL.
      */
     SCH_ITEM* MatchNextItem( wxFindReplaceData& aSearchData,
                              SCH_SHEET_PATH**   aSheetFound,
                              SCH_ITEM*          aLastItem,
-                             wxPoint * aFindLocation );
+                             wxPoint*           aFindLocation );
 
 private:
 
     /**
      * Function BuildSheetList
-     * builds the list of sheets and their sheet path from \a aSheet.
-     * If aSheet = g_RootSheet, the full sheet path and sheet list is built
+     * builds the list of sheets and their sheet path from \a aSheet.  If \a aSheet is
+     * the root sheet, the full sheet path and sheet list is built.
      *
-     * @param aSheet is the starting sheet from which the list is built,
-     *   or NULL indicating that g_RootSheet should be used.
+     * @param aSheet The starting sheet from which the list is built, or NULL indicating
+     *               that the root sheet should be used.
      */
     void           BuildSheetList( SCH_SHEET* aSheet );
 };

eeschema/schframe.cpp

@@ -346,23 +346,12 @@ void SCH_EDIT_FRAME::CreateScreens()
 
 void SCH_EDIT_FRAME::OnCloseWindow( wxCloseEvent& Event )
 {
-    SCH_SHEET_PATH* sheet;
-
-    if( m_LibeditFrame ) // Can close component editor ?
-    {
-        if( !m_LibeditFrame->Close() )
-            return;
-    }
+    if( m_LibeditFrame && !m_LibeditFrame->Close() )   // Can close component editor?
+        return;
 
     SCH_SHEET_LIST SheetList;
 
-    for( sheet = SheetList.GetFirst(); sheet != NULL; sheet = SheetList.GetNext() )
-    {
-        if( sheet->LastScreen() && sheet->LastScreen()->IsModify() )
-            break;
-    }
-
-    if( sheet )
+    if( SheetList.IsModified() )
     {
         wxMessageDialog dialog( this,
                                 _( "Schematic modified, Save before exit ?" ),
@@ -385,15 +374,7 @@ void SCH_EDIT_FRAME::OnCloseWindow( wxCloseEvent& Event )
         }
     }
 
-    for( sheet = SheetList.GetFirst();
-        sheet != NULL;
-        sheet = SheetList.GetNext() )
-    {
-        if( sheet->LastScreen() )
-        {
-            sheet->LastScreen()->ClrModify();
-        }
-    }
+    SheetList.ClearModifyStatus();
 
     if( !g_RootSheet->GetScreen()->GetFileName().IsEmpty()
        && (g_RootSheet->GetScreen()->GetDrawItems() != NULL) )