kicad-developers team mailing list archive
-
kicad-developers team
-
Mailing list archive
-
Message #16984
[PATCH] two eeschema cleanups
Just some patches as cleanup
1. Delete .cpp file that literally has no code in it, just #includes.....
2. Second patch cleans up netlist.cpp. classes sch_reference and
sch_reference_list are moved to to "sch_reference_list.h" file as
multiple other source files that had nothing to do with netlisting
were including netlist.h for the classes.
In fact, netlist.cpp never used sch_reference!
still compiles fine.
From a7dd2320896c62507e3ded31881005e9cd287c2e Mon Sep 17 00:00:00 2001
From: Mark Roszko <mark.roszko@xxxxxxxxx>
Date: Fri, 20 Feb 2015 23:18:14 -0500
Subject: [PATCH 1/2] eeschema: remove practically empty file
---
eeschema/CMakeLists.txt | 1 -
eeschema/eelibs_read_libraryfiles.cpp | 42 -----------------------------------
2 files changed, 43 deletions(-)
delete mode 100644 eeschema/eelibs_read_libraryfiles.cpp
diff --git a/eeschema/CMakeLists.txt b/eeschema/CMakeLists.txt
index c10810a..6e12361 100644
--- a/eeschema/CMakeLists.txt
+++ b/eeschema/CMakeLists.txt
@@ -88,7 +88,6 @@ set( EESCHEMA_SRCS
edit_component_in_schematic.cpp
edit_bitmap.cpp
edit_label.cpp
- eelibs_read_libraryfiles.cpp
eeredraw.cpp
eeschema.cpp
eeschema_config.cpp
diff --git a/eeschema/eelibs_read_libraryfiles.cpp b/eeschema/eelibs_read_libraryfiles.cpp
deleted file mode 100644
index 896bca0..0000000
--- a/eeschema/eelibs_read_libraryfiles.cpp
+++ /dev/null
@@ -1,42 +0,0 @@
-/*
- * This program source code file is part of KiCad, a free EDA CAD application.
- *
- * Copyright (C) 2007 SoftPLC Corporation, Dick Hollenbeck <dick@xxxxxxxxxxx>
- * Copyright (C) 2014 KiCad Developers, see CHANGELOG.TXT for contributors.
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, you may find one here:
- * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
- * or you may search the http://www.gnu.org website for the version 2 license,
- * or you may write to the Free Software Foundation, Inc.,
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
- */
-
-/**
- * @file eelibs_read_libraryfiles.cpp
- * @brief Functions to handle reading component library files.
- */
-
-#include <fctsys.h>
-#include <kiway.h>
-#include <confirm.h>
-#include <macros.h>
-#include <pgm_base.h>
-#include <wxEeschemaStruct.h>
-
-#include <general.h>
-#include <class_library.h>
-#include <wildcards_and_files_ext.h>
-
-#include <html_messagebox.h>
-
--
1.9.1
From c71d0e1c24b46d96c18d383f9473b6b4c28b1f20 Mon Sep 17 00:00:00 2001
From: Mark Roszko <mark.roszko@xxxxxxxxx>
Date: Fri, 20 Feb 2015 23:35:58 -0500
Subject: [PATCH 2/2] eeschema: split sch_reference_list class to its own file
as netlist.cpp didn't use it nor did includes of netlist.h use the netlist
functions.
---
eeschema/annotate.cpp | 2 +-
eeschema/backanno.cpp | 2 +-
eeschema/component_references_lister.cpp | 2 +-
eeschema/netform.cpp | 1 +
eeschema/netlist.h | 426 +----------------------------
eeschema/sch_reference_list.h | 453 +++++++++++++++++++++++++++++++
eeschema/sch_sheet_path.cpp | 2 +-
eeschema/schframe.cpp | 1 +
8 files changed, 461 insertions(+), 428 deletions(-)
create mode 100644 eeschema/sch_reference_list.h
diff --git a/eeschema/annotate.cpp b/eeschema/annotate.cpp
index f15e49a..fa7c9c5 100644
--- a/eeschema/annotate.cpp
+++ b/eeschema/annotate.cpp
@@ -33,7 +33,7 @@
#include <confirm.h>
#include <wxEeschemaStruct.h>
-#include <netlist.h>
+#include <sch_reference_list.h>
#include <class_library.h>
#include <sch_component.h>
#include <lib_pin.h>
diff --git a/eeschema/backanno.cpp b/eeschema/backanno.cpp
index 3d0601f..7dd45c0 100644
--- a/eeschema/backanno.cpp
+++ b/eeschema/backanno.cpp
@@ -40,7 +40,7 @@
#include <general.h>
#include <sch_sheet_path.h>
#include <sch_component.h>
-#include <netlist.h>
+#include <sch_reference_list.h>
#include <dsnlexer.h>
#include <ptree.h>
diff --git a/eeschema/component_references_lister.cpp b/eeschema/component_references_lister.cpp
index f83b45c..dd041d5 100644
--- a/eeschema/component_references_lister.cpp
+++ b/eeschema/component_references_lister.cpp
@@ -36,7 +36,7 @@
#include <fctsys.h>
#include <kicad_string.h>
#include <wxEeschemaStruct.h>
-#include <netlist.h>
+#include <sch_reference_list.h>
#include <sch_component.h>
diff --git a/eeschema/netform.cpp b/eeschema/netform.cpp
index 0caebf1..b2b42d2 100644
--- a/eeschema/netform.cpp
+++ b/eeschema/netform.cpp
@@ -36,6 +36,7 @@
#include <wxEeschemaStruct.h>
#include <netlist.h>
+#include <sch_reference_list.h>
#include <class_netlist_object.h>
#include <class_library.h>
#include <lib_pin.h>
diff --git a/eeschema/netlist.h b/eeschema/netlist.h
index 2f3d59b..b8d3608 100644
--- a/eeschema/netlist.h
+++ b/eeschema/netlist.h
@@ -3,7 +3,7 @@
*
* Copyright (C) 1992-2011 jean-pierre Charras <jean-pierre.charras@xxxxxxxxxxxxxxxxx>
* Copyright (C) 1992-2011 Wayne Stambaugh <stambaughw@xxxxxxxxxxx>
- * Copyright (C) 1992-2011 KiCad Developers, see change_log.txt for contributors.
+ * Copyright (C) 1992-2015 KiCad Developers, see changelog.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
@@ -31,15 +31,6 @@
#ifndef _NETLIST_H_
#define _NETLIST_H_
-
-#include <macros.h>
-
-#include <class_libentry.h>
-#include <sch_sheet_path.h>
-#include <sch_component.h>
-#include <sch_text.h>
-
-
/// netlist types
enum NETLIST_TYPE_ID {
NET_TYPE_UNINIT = 0,
@@ -64,422 +55,9 @@ enum netlistOptions {
};
-class SCH_COMPONENT;
-
-
#define NETLIST_HEAD_STRING "EESchema Netlist Version 1.1"
// Max pin number per component and footprint
#define MAXPIN 5000
-
-/**
- * Class SCH_REFERENCE
- * is used as a helper to define a component's reference designator in a schematic. This
- * helper is required in a complex hierarchy because a component can be used more than
- * once and its reference depends on the sheet path. This class is used to flatten the
- * schematic hierarchy for annotation, net list generation, and bill of material
- * generation.
- */
-class SCH_REFERENCE
-{
- /// Component reference prefix, without number (for IC1, this is IC) )
- UTF8 m_Ref; // it's private, use the accessors please
- SCH_COMPONENT* m_RootCmp; ///< The component associated the reference object.
- LIB_PART* m_Entry; ///< The source component from a library.
- wxPoint m_CmpPos; ///< The physical position of the component in schematic
- ///< used to annotate by X or Y position
- int m_Unit; ///< The unit number for components with multiple parts
- ///< per package.
- SCH_SHEET_PATH m_SheetPath; ///< The sheet path for this reference.
- bool m_IsNew; ///< True if not yet annotated.
- int m_SheetNum; ///< The sheet number for the reference.
- time_t m_TimeStamp; ///< The time stamp for the reference.
- EDA_TEXT* m_Value; ///< The component value of the refernce. It is the
- ///< same for all instances.
- int m_NumRef; ///< The numeric part of the reference designator.
- int m_Flag;
-
- friend class SCH_REFERENCE_LIST;
-
-
-public:
-
- SCH_REFERENCE() :
- m_SheetPath()
- {
- m_RootCmp = NULL;
- m_Entry = NULL;
- m_Unit = 0;
- m_TimeStamp = 0;
- m_IsNew = false;
- m_Value = NULL;
- m_NumRef = 0;
- m_Flag = 0;
- m_SheetNum = 0;
- }
-
- SCH_REFERENCE( SCH_COMPONENT* aComponent, LIB_PART* aLibComponent,
- SCH_SHEET_PATH& aSheetPath );
-
- SCH_COMPONENT* GetComp() const { return m_RootCmp; }
-
- LIB_PART* GetLibComponent() const { return m_Entry; }
-
- SCH_SHEET_PATH GetSheetPath() const { return m_SheetPath; }
-
- int GetUnit() const { return m_Unit; }
-
- void SetSheetNumber( int aSheetNumber ) { m_SheetNum = aSheetNumber; }
-
- /**
- * Function Annotate
- * updates the annotation of the component according the the current object state.
- */
- void Annotate();
-
- /**
- * Function Split
- * attempts to split the reference designator into a name (U) and number (1). If the
- * last character is '?' or not a digit, the reference is tagged as not annotated.
- * For components with multiple parts per package that are not already annotated, set
- * m_Unit to a max value (0x7FFFFFFF).
- */
- void Split();
-
- /* Some accessors which hide the strategy of how the reference is stored,
- thereby making it easy to change that strategy.
- */
-
- void SetRef( const wxString& aReference )
- {
- m_Ref = aReference;
- }
-
- wxString GetRef() const
- {
- return m_Ref;
- }
- void SetRefStr( const std::string& aReference )
- {
- m_Ref = aReference;
- }
- const char* GetRefStr() const
- {
- return m_Ref.c_str();
- }
-
- int CompareValue( const SCH_REFERENCE& item ) const
- {
- return Cmp_KEEPCASE( m_Value->GetText(), item.m_Value->GetText() );
- }
-
- int CompareRef( const SCH_REFERENCE& item ) const
- {
- return m_Ref.compare( item.m_Ref );
- }
-
- int CompareLibName( const SCH_REFERENCE& item ) const
- {
- return Cmp_KEEPCASE( m_RootCmp->GetPartName(), item.m_RootCmp->GetPartName() );
- }
-
- bool IsUnitsLocked()
- {
- return m_Entry->UnitsLocked();
- }
-};
-
-
-/**
- * Class SCH_REFERENCE_LIST
- * is used to create a flattened list of components because in a complex hierarchy, a component
- * can be used more than once and its reference designator is dependent on the sheet path for
- * the same component. This flattened list is used for netlist generation, BOM generation,
- * and schematic annotation.
- */
-class SCH_REFERENCE_LIST
-{
-private:
- std::vector <SCH_REFERENCE> componentFlatList;
-
-public:
- /** Constructor
- */
- SCH_REFERENCE_LIST()
- {
- }
-
- SCH_REFERENCE& operator[]( int aIndex )
- {
- return componentFlatList[ aIndex ];
- }
-
- /**
- * Function GetCount
- * @return the number of items in the list
- */
- unsigned GetCount()
- {
- return componentFlatList.size();
- }
-
- /**
- * Function GetItem
- * @return the aIdx item
- */
- SCH_REFERENCE& GetItem( int aIdx )
- {
- return componentFlatList[aIdx];
- }
-
- /**
- * Function AddItem
- * adds a SCH_REFERENCE object to the list of references.
- * @param aItem - a SCH_REFERENCE item to add
- */
- void AddItem( SCH_REFERENCE& aItem )
- {
- componentFlatList.push_back( aItem );
- }
-
- /**
- * Function RemoveItem
- * removes an item from the list of references.
- *
- * @param aIndex is the index of the item to be removed.
- */
- void RemoveItem( unsigned int aIndex );
-
- /**
- * Function RemoveSubComponentsFromList
- * Remove sub components from the list, when multiples parts per package are
- * found in this list.
- * Useful to create BOM, when a component must appear only once
- */
- void RemoveSubComponentsFromList();
-
- /* Sort functions:
- * Sort functions are used to sort components for annotation or BOM generation.
- * Because sorting depend on we want to do, there are many sort functions.
- * Note:
- * When creating BOM, components are fully annotated.
- * references are something like U3, U5 or R4, R8
- * When annotating, some or all components are not annotated,
- * i.e. ref is only U or R, with no number.
- */
-
- /**
- * Function SplitReferences
- * attempts to split all reference designators into a name (U) and number (1). If the
- * last character is '?' or not a digit, the reference is tagged as not annotated.
- * For components with multiple parts per package that are not already annotated, set
- * m_Unit to a max value (0x7FFFFFFF).
- * @see SCH_REFERENCE::Split()
- */
- void SplitReferences()
- {
- for( unsigned ii = 0; ii < GetCount(); ii++ )
- componentFlatList[ii].Split();
- }
-
- /**
- * function UpdateAnnotation
- * Updates the reference components for the schematic project (or the current sheet)
- * Note: this function does not calculate the reference numbers stored in m_NumRef
- * So, it must be called after calculation of new reference numbers
- * @see SCH_REFERENCE::Annotate()
- */
- void UpdateAnnotation()
- {
- /* update the reference numbers */
- for( unsigned ii = 0; ii < GetCount(); ii++ )
- {
- componentFlatList[ii].Annotate();
- }
- }
-
- /**
- * Function Annotate
- * set the reference designators in the list that have not been annotated.
- * @param aUseSheetNum Set to true to start annotation for each sheet at the sheet number
- * times \a aSheetIntervalId. Otherwise annotate incrementally.
- * @param aSheetIntervalId The per sheet reference designator multiplier.
- * <p>
- * If a the sheet number is 2 and \a aSheetIntervalId is 100, then the first reference
- * designator would be 201 and the last reference designator would be 299 when no overlap
- * occurs with sheet number 3. If there are 150 items in sheet number 2, then items are
- * referenced U201 to U351, and items in sheet 3 start from U352
- * </p>
- */
- void Annotate( bool aUseSheetNum, int aSheetIntervalId );
-
- /**
- * Function CheckAnnotation
- * check for annotations errors.
- * <p>
- * The following annotation error conditions are tested:
- * <ul>
- * <li>Components not annotated.</li>
- * <li>Components having the same reference designator (duplicates).</li>
- * <li>Components with multiple parts per package having different reference designators.</li>
- * <li>Components with multiple parts per package with invalid part count.</li>
- * </ul>
- * </p>
- * @param aMessageList A wxArrayString to store error messages.
- * @return The number of errors found.
- */
- int CheckAnnotation( wxArrayString* aMessageList );
-
- /**
- * Function sortByXCoordinate
- * sorts the list of references by X position.
- * <p>
- * Components are sorted as follows:
- * <ul>
- * <li>Numeric value of reference designator.</li>
- * <li>Sheet number.</li>
- * <li>X coordinate position.</li>
- * <li>Y coordinate position.</li>
- * <li>Time stamp.</li>
- * </ul>
- * </p>
- */
- void SortByXCoordinate()
- {
- sort( componentFlatList.begin(), componentFlatList.end(), sortByXPosition );
- }
-
- /**
- * Function sortByYCoordinate
- * sorts the list of references by Y position.
- * <p>
- * Components are sorted as follows:
- * <ul>
- * <li>Numeric value of reference designator.</li>
- * <li>Sheet number.</li>
- * <li>Y coordinate position.</li>
- * <li>X coordinate position.</li>
- * <li>Time stamp.</li>
- * </ul>
- * </p>
- */
- void SortByYCoordinate()
- {
- sort( componentFlatList.begin(), componentFlatList.end(), sortByYPosition );
- }
-
- /**
- * Function SortComponentsByTimeStamp
- * sort the flat list by Time Stamp.
- * Useful to detect duplicate Time Stamps
- */
- void SortByTimeStamp()
- {
- sort( componentFlatList.begin(), componentFlatList.end(), sortByTimeStamp );
- }
-
- /**
- * Function SortByRefAndValue
- * sorts the list of references by value.
- * <p>
- * Components are sorted in the following order:
- * <ul>
- * <li>Numeric value of reference designator.</li>
- * <li>Value of component.</li>
- * <li>Unit number when component has multiple parts.</li>
- * <li>Sheet number.</li>
- * <li>X coordinate position.</li>
- * <li>Y coordinate position.</li>
- * </ul>
- * </p>
- */
- void SortByRefAndValue()
- {
- sort( componentFlatList.begin(), componentFlatList.end(), sortByRefAndValue );
- }
-
- /**
- * Function SortByReferenceOnly
- * sorts the list of references by reference.
- * <p>
- * Components are sorted in the following order:
- * <ul>
- * <li>Numeric value of reference designator.</li>
- * <li>Unit number when component has multiple parts.</li>
- * </ul>
- * </p>
- */
- void SortByReferenceOnly()
- {
- sort( componentFlatList.begin(), componentFlatList.end(), sortByReferenceOnly );
- }
-
- /**
- * Function GetUnit
- * searches the sorted list of components for a another component with the same
- * reference and a given part unit. Use this method to manage components with
- * multiple parts per package.
- * @param aIndex = index in aComponentsList for of given SCH_REFERENCE item to test.
- * @param aUnit = the given unit number to search
- * @return index in aComponentsList if found or -1 if not found
- */
- int FindUnit( size_t aIndex, int aUnit );
-
- /**
- * Function ResetHiddenReferences
- * clears the annotation for all references that have an invisible reference designator.
- * Invisible reference designators always have # as the first letter.
- */
- void ResetHiddenReferences();
-
- /**
- * Function GetRefsInUse
- * adds all the reference designator numbers greater than \a aMinRefId to \a aIdList
- * skipping the reference at \a aIndex.
- * @param aIndex = the current component index to use for reference prefix filtering.
- * @param aIdList = the buffer to fill
- * @param aMinRefId = the min id value to store. all values < aMinRefId are ignored
- */
- void GetRefsInUse( int aIndex, std::vector< int >& aIdList, int aMinRefId );
-
- /**
- * Function GetLastReference
- * returns the last used (greatest) reference number in the reference list
- * for the prefix reference given by \a aIndex. The component list must be
- * sorted.
- *
- * @param aIndex The index of the reference item used for the search pattern.
- * @param aMinValue The minimum value for the current search.
- */
- int GetLastReference( int aIndex, int aMinValue );
-
-private:
- /* sort functions used to sort componentFlatList
- */
-
- static bool sortByRefAndValue( const SCH_REFERENCE& item1, const SCH_REFERENCE& item2 );
-
- static bool sortByXPosition( const SCH_REFERENCE& item1, const SCH_REFERENCE& item2 );
-
- static bool sortByYPosition( const SCH_REFERENCE& item1, const SCH_REFERENCE& item2 );
-
- static bool sortByTimeStamp( const SCH_REFERENCE& item1, const SCH_REFERENCE& item2 );
-
- static bool sortByReferenceOnly( const SCH_REFERENCE& item1, const SCH_REFERENCE& item2 );
-
- /**
- * Function CreateFirstFreeRefId
- * searches for the first free reference number in \a aListId of reference numbers in use.
- * This function just searches for a hole in a list of incremented numbers, this list must
- * be sorted by increasing values and each value can be stored only once. The new value
- * is added to the list.
- * @see BuildRefIdInUseList to prepare this list
- * @param aIdList The buffer that contains the reference numbers in use.
- * @param aFirstValue The first expected free value
- * @return The first free (not yet used) value.
- */
- int CreateFirstFreeRefId( std::vector<int>& aIdList, int aFirstValue );
-};
-
-#endif // _NETLIST_H_
+#endif
diff --git a/eeschema/sch_reference_list.h b/eeschema/sch_reference_list.h
new file mode 100644
index 0000000..7133d4b
--- /dev/null
+++ b/eeschema/sch_reference_list.h
@@ -0,0 +1,453 @@
+/*
+ * This program source code file is part of KiCad, a free EDA CAD application.
+ *
+ * Copyright (C) 1992-2011 jean-pierre Charras <jean-pierre.charras@xxxxxxxxxxxxxxxxx>
+ * Copyright (C) 1992-2011 Wayne Stambaugh <stambaughw@xxxxxxxxxxx>
+ * Copyright (C) 1992-2015 KiCad Developers, see authors.txt for contributors.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, you may find one here:
+ * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
+ * or you may search the http://www.gnu.org website for the version 2 license,
+ * or you may write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
+ */
+
+
+/**
+ * @file eeschema/sch_reference_list.h
+ */
+
+#ifndef _SCH_REFERENCE_LIST_H_
+#define _SCH_REFERENCE_LIST_H_
+
+
+#include <macros.h>
+
+#include <class_libentry.h>
+#include <sch_sheet_path.h>
+#include <sch_component.h>
+#include <sch_text.h>
+
+
+/**
+ * Class SCH_REFERENCE
+ * is used as a helper to define a component's reference designator in a schematic. This
+ * helper is required in a complex hierarchy because a component can be used more than
+ * once and its reference depends on the sheet path. This class is used to flatten the
+ * schematic hierarchy for annotation, net list generation, and bill of material
+ * generation.
+ */
+class SCH_REFERENCE
+{
+ /// Component reference prefix, without number (for IC1, this is IC) )
+ UTF8 m_Ref; // it's private, use the accessors please
+ SCH_COMPONENT* m_RootCmp; ///< The component associated the reference object.
+ LIB_PART* m_Entry; ///< The source component from a library.
+ wxPoint m_CmpPos; ///< The physical position of the component in schematic
+ ///< used to annotate by X or Y position
+ int m_Unit; ///< The unit number for components with multiple parts
+ ///< per package.
+ SCH_SHEET_PATH m_SheetPath; ///< The sheet path for this reference.
+ bool m_IsNew; ///< True if not yet annotated.
+ int m_SheetNum; ///< The sheet number for the reference.
+ time_t m_TimeStamp; ///< The time stamp for the reference.
+ EDA_TEXT* m_Value; ///< The component value of the refernce. It is the
+ ///< same for all instances.
+ int m_NumRef; ///< The numeric part of the reference designator.
+ int m_Flag;
+
+ friend class SCH_REFERENCE_LIST;
+
+
+public:
+
+ SCH_REFERENCE() :
+ m_SheetPath()
+ {
+ m_RootCmp = NULL;
+ m_Entry = NULL;
+ m_Unit = 0;
+ m_TimeStamp = 0;
+ m_IsNew = false;
+ m_Value = NULL;
+ m_NumRef = 0;
+ m_Flag = 0;
+ m_SheetNum = 0;
+ }
+
+ SCH_REFERENCE( SCH_COMPONENT* aComponent, LIB_PART* aLibComponent,
+ SCH_SHEET_PATH& aSheetPath );
+
+ SCH_COMPONENT* GetComp() const { return m_RootCmp; }
+
+ LIB_PART* GetLibComponent() const { return m_Entry; }
+
+ SCH_SHEET_PATH GetSheetPath() const { return m_SheetPath; }
+
+ int GetUnit() const { return m_Unit; }
+
+ void SetSheetNumber( int aSheetNumber ) { m_SheetNum = aSheetNumber; }
+
+ /**
+ * Function Annotate
+ * updates the annotation of the component according the the current object state.
+ */
+ void Annotate();
+
+ /**
+ * Function Split
+ * attempts to split the reference designator into a name (U) and number (1). If the
+ * last character is '?' or not a digit, the reference is tagged as not annotated.
+ * For components with multiple parts per package that are not already annotated, set
+ * m_Unit to a max value (0x7FFFFFFF).
+ */
+ void Split();
+
+ /* Some accessors which hide the strategy of how the reference is stored,
+ thereby making it easy to change that strategy.
+ */
+
+ void SetRef( const wxString& aReference )
+ {
+ m_Ref = aReference;
+ }
+
+ wxString GetRef() const
+ {
+ return m_Ref;
+ }
+ void SetRefStr( const std::string& aReference )
+ {
+ m_Ref = aReference;
+ }
+ const char* GetRefStr() const
+ {
+ return m_Ref.c_str();
+ }
+
+ int CompareValue( const SCH_REFERENCE& item ) const
+ {
+ return Cmp_KEEPCASE( m_Value->GetText(), item.m_Value->GetText() );
+ }
+
+ int CompareRef( const SCH_REFERENCE& item ) const
+ {
+ return m_Ref.compare( item.m_Ref );
+ }
+
+ int CompareLibName( const SCH_REFERENCE& item ) const
+ {
+ return Cmp_KEEPCASE( m_RootCmp->GetPartName(), item.m_RootCmp->GetPartName() );
+ }
+
+ bool IsUnitsLocked()
+ {
+ return m_Entry->UnitsLocked();
+ }
+};
+
+
+/**
+ * Class SCH_REFERENCE_LIST
+ * is used to create a flattened list of components because in a complex hierarchy, a component
+ * can be used more than once and its reference designator is dependent on the sheet path for
+ * the same component. This flattened list is used for netlist generation, BOM generation,
+ * and schematic annotation.
+ */
+class SCH_REFERENCE_LIST
+{
+private:
+ std::vector <SCH_REFERENCE> componentFlatList;
+
+public:
+ /** Constructor
+ */
+ SCH_REFERENCE_LIST()
+ {
+ }
+
+ SCH_REFERENCE& operator[]( int aIndex )
+ {
+ return componentFlatList[ aIndex ];
+ }
+
+ /**
+ * Function GetCount
+ * @return the number of items in the list
+ */
+ unsigned GetCount()
+ {
+ return componentFlatList.size();
+ }
+
+ /**
+ * Function GetItem
+ * @return the aIdx item
+ */
+ SCH_REFERENCE& GetItem( int aIdx )
+ {
+ return componentFlatList[aIdx];
+ }
+
+ /**
+ * Function AddItem
+ * adds a SCH_REFERENCE object to the list of references.
+ * @param aItem - a SCH_REFERENCE item to add
+ */
+ void AddItem( SCH_REFERENCE& aItem )
+ {
+ componentFlatList.push_back( aItem );
+ }
+
+ /**
+ * Function RemoveItem
+ * removes an item from the list of references.
+ *
+ * @param aIndex is the index of the item to be removed.
+ */
+ void RemoveItem( unsigned int aIndex );
+
+ /**
+ * Function RemoveSubComponentsFromList
+ * Remove sub components from the list, when multiples parts per package are
+ * found in this list.
+ * Useful to create BOM, when a component must appear only once
+ */
+ void RemoveSubComponentsFromList();
+
+ /* Sort functions:
+ * Sort functions are used to sort components for annotation or BOM generation.
+ * Because sorting depend on we want to do, there are many sort functions.
+ * Note:
+ * When creating BOM, components are fully annotated.
+ * references are something like U3, U5 or R4, R8
+ * When annotating, some or all components are not annotated,
+ * i.e. ref is only U or R, with no number.
+ */
+
+ /**
+ * Function SplitReferences
+ * attempts to split all reference designators into a name (U) and number (1). If the
+ * last character is '?' or not a digit, the reference is tagged as not annotated.
+ * For components with multiple parts per package that are not already annotated, set
+ * m_Unit to a max value (0x7FFFFFFF).
+ * @see SCH_REFERENCE::Split()
+ */
+ void SplitReferences()
+ {
+ for( unsigned ii = 0; ii < GetCount(); ii++ )
+ componentFlatList[ii].Split();
+ }
+
+ /**
+ * function UpdateAnnotation
+ * Updates the reference components for the schematic project (or the current sheet)
+ * Note: this function does not calculate the reference numbers stored in m_NumRef
+ * So, it must be called after calculation of new reference numbers
+ * @see SCH_REFERENCE::Annotate()
+ */
+ void UpdateAnnotation()
+ {
+ /* update the reference numbers */
+ for( unsigned ii = 0; ii < GetCount(); ii++ )
+ {
+ componentFlatList[ii].Annotate();
+ }
+ }
+
+ /**
+ * Function Annotate
+ * set the reference designators in the list that have not been annotated.
+ * @param aUseSheetNum Set to true to start annotation for each sheet at the sheet number
+ * times \a aSheetIntervalId. Otherwise annotate incrementally.
+ * @param aSheetIntervalId The per sheet reference designator multiplier.
+ * <p>
+ * If a the sheet number is 2 and \a aSheetIntervalId is 100, then the first reference
+ * designator would be 201 and the last reference designator would be 299 when no overlap
+ * occurs with sheet number 3. If there are 150 items in sheet number 2, then items are
+ * referenced U201 to U351, and items in sheet 3 start from U352
+ * </p>
+ */
+ void Annotate( bool aUseSheetNum, int aSheetIntervalId );
+
+ /**
+ * Function CheckAnnotation
+ * check for annotations errors.
+ * <p>
+ * The following annotation error conditions are tested:
+ * <ul>
+ * <li>Components not annotated.</li>
+ * <li>Components having the same reference designator (duplicates).</li>
+ * <li>Components with multiple parts per package having different reference designators.</li>
+ * <li>Components with multiple parts per package with invalid part count.</li>
+ * </ul>
+ * </p>
+ * @param aMessageList A wxArrayString to store error messages.
+ * @return The number of errors found.
+ */
+ int CheckAnnotation( wxArrayString* aMessageList );
+
+ /**
+ * Function sortByXCoordinate
+ * sorts the list of references by X position.
+ * <p>
+ * Components are sorted as follows:
+ * <ul>
+ * <li>Numeric value of reference designator.</li>
+ * <li>Sheet number.</li>
+ * <li>X coordinate position.</li>
+ * <li>Y coordinate position.</li>
+ * <li>Time stamp.</li>
+ * </ul>
+ * </p>
+ */
+ void SortByXCoordinate()
+ {
+ sort( componentFlatList.begin(), componentFlatList.end(), sortByXPosition );
+ }
+
+ /**
+ * Function sortByYCoordinate
+ * sorts the list of references by Y position.
+ * <p>
+ * Components are sorted as follows:
+ * <ul>
+ * <li>Numeric value of reference designator.</li>
+ * <li>Sheet number.</li>
+ * <li>Y coordinate position.</li>
+ * <li>X coordinate position.</li>
+ * <li>Time stamp.</li>
+ * </ul>
+ * </p>
+ */
+ void SortByYCoordinate()
+ {
+ sort( componentFlatList.begin(), componentFlatList.end(), sortByYPosition );
+ }
+
+ /**
+ * Function SortComponentsByTimeStamp
+ * sort the flat list by Time Stamp.
+ * Useful to detect duplicate Time Stamps
+ */
+ void SortByTimeStamp()
+ {
+ sort( componentFlatList.begin(), componentFlatList.end(), sortByTimeStamp );
+ }
+
+ /**
+ * Function SortByRefAndValue
+ * sorts the list of references by value.
+ * <p>
+ * Components are sorted in the following order:
+ * <ul>
+ * <li>Numeric value of reference designator.</li>
+ * <li>Value of component.</li>
+ * <li>Unit number when component has multiple parts.</li>
+ * <li>Sheet number.</li>
+ * <li>X coordinate position.</li>
+ * <li>Y coordinate position.</li>
+ * </ul>
+ * </p>
+ */
+ void SortByRefAndValue()
+ {
+ sort( componentFlatList.begin(), componentFlatList.end(), sortByRefAndValue );
+ }
+
+ /**
+ * Function SortByReferenceOnly
+ * sorts the list of references by reference.
+ * <p>
+ * Components are sorted in the following order:
+ * <ul>
+ * <li>Numeric value of reference designator.</li>
+ * <li>Unit number when component has multiple parts.</li>
+ * </ul>
+ * </p>
+ */
+ void SortByReferenceOnly()
+ {
+ sort( componentFlatList.begin(), componentFlatList.end(), sortByReferenceOnly );
+ }
+
+ /**
+ * Function GetUnit
+ * searches the sorted list of components for a another component with the same
+ * reference and a given part unit. Use this method to manage components with
+ * multiple parts per package.
+ * @param aIndex = index in aComponentsList for of given SCH_REFERENCE item to test.
+ * @param aUnit = the given unit number to search
+ * @return index in aComponentsList if found or -1 if not found
+ */
+ int FindUnit( size_t aIndex, int aUnit );
+
+ /**
+ * Function ResetHiddenReferences
+ * clears the annotation for all references that have an invisible reference designator.
+ * Invisible reference designators always have # as the first letter.
+ */
+ void ResetHiddenReferences();
+
+ /**
+ * Function GetRefsInUse
+ * adds all the reference designator numbers greater than \a aMinRefId to \a aIdList
+ * skipping the reference at \a aIndex.
+ * @param aIndex = the current component index to use for reference prefix filtering.
+ * @param aIdList = the buffer to fill
+ * @param aMinRefId = the min id value to store. all values < aMinRefId are ignored
+ */
+ void GetRefsInUse( int aIndex, std::vector< int >& aIdList, int aMinRefId );
+
+ /**
+ * Function GetLastReference
+ * returns the last used (greatest) reference number in the reference list
+ * for the prefix reference given by \a aIndex. The component list must be
+ * sorted.
+ *
+ * @param aIndex The index of the reference item used for the search pattern.
+ * @param aMinValue The minimum value for the current search.
+ */
+ int GetLastReference( int aIndex, int aMinValue );
+
+private:
+ /* sort functions used to sort componentFlatList
+ */
+
+ static bool sortByRefAndValue( const SCH_REFERENCE& item1, const SCH_REFERENCE& item2 );
+
+ static bool sortByXPosition( const SCH_REFERENCE& item1, const SCH_REFERENCE& item2 );
+
+ static bool sortByYPosition( const SCH_REFERENCE& item1, const SCH_REFERENCE& item2 );
+
+ static bool sortByTimeStamp( const SCH_REFERENCE& item1, const SCH_REFERENCE& item2 );
+
+ static bool sortByReferenceOnly( const SCH_REFERENCE& item1, const SCH_REFERENCE& item2 );
+
+ /**
+ * Function CreateFirstFreeRefId
+ * searches for the first free reference number in \a aListId of reference numbers in use.
+ * This function just searches for a hole in a list of incremented numbers, this list must
+ * be sorted by increasing values and each value can be stored only once. The new value
+ * is added to the list.
+ * @see BuildRefIdInUseList to prepare this list
+ * @param aIdList The buffer that contains the reference numbers in use.
+ * @param aFirstValue The first expected free value
+ * @return The first free (not yet used) value.
+ */
+ int CreateFirstFreeRefId( std::vector<int>& aIdList, int aFirstValue );
+};
+
+
+#endif // _SCH_REFERENCE_LIST_H_
diff --git a/eeschema/sch_sheet_path.cpp b/eeschema/sch_sheet_path.cpp
index 4db1666..28900e4 100644
--- a/eeschema/sch_sheet_path.cpp
+++ b/eeschema/sch_sheet_path.cpp
@@ -35,7 +35,7 @@
#include <class_sch_screen.h>
#include <sch_item_struct.h>
-#include <netlist.h>
+#include <sch_reference_list.h>
#include <class_library.h>
#include <sch_sheet.h>
#include <sch_sheet_path.h>
diff --git a/eeschema/schframe.cpp b/eeschema/schframe.cpp
index 65c9e49..1581292 100644
--- a/eeschema/schframe.cpp
+++ b/eeschema/schframe.cpp
@@ -52,6 +52,7 @@
#include <hotkeys.h>
#include <eeschema_config.h>
#include <sch_sheet.h>
+#include <sch_sheet_path.h>
#include <invoke_sch_dialog.h>
#include <dialogs/dialog_schematic_find.h>
--
1.9.1
Follow ups
