2011-10-31 20:49:48 +00:00
|
|
|
/*
|
|
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
|
|
*
|
|
|
|
* Copyright (C) 2004 Jean-Pierre Charras, jaen-pierre.charras@gipsa-lab.inpg.com
|
|
|
|
* Copyright (C) 2008-2011 Wayne Stambaugh <stambaughw@verizon.net>
|
|
|
|
* Copyright (C) 2004-2011 KiCad Developers, see change_log.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 class_libentry.h
|
|
|
|
*/
|
2008-12-31 09:27:19 +00:00
|
|
|
|
|
|
|
#ifndef CLASS_LIBENTRY_H
|
|
|
|
#define CLASS_LIBENTRY_H
|
|
|
|
|
2012-01-23 04:33:36 +00:00
|
|
|
#include <general.h>
|
|
|
|
#include <lib_draw_item.h>
|
|
|
|
#include <lib_field.h>
|
2008-12-31 09:27:19 +00:00
|
|
|
|
2010-10-04 18:54:14 +00:00
|
|
|
#include <map>
|
2009-08-27 11:41:56 +00:00
|
|
|
|
|
|
|
|
2011-10-31 20:49:48 +00:00
|
|
|
class LINE_READER;
|
2011-11-01 15:06:26 +00:00
|
|
|
class OUTPUTFORMATTER;
|
2009-09-18 14:56:05 +00:00
|
|
|
class CMP_LIBRARY;
|
2010-10-04 18:54:14 +00:00
|
|
|
class LIB_ALIAS;
|
2010-10-25 15:43:42 +00:00
|
|
|
class LIB_COMPONENT;
|
2010-10-22 12:11:52 +00:00
|
|
|
class LIB_FIELD;
|
2009-09-18 14:56:05 +00:00
|
|
|
|
2010-10-20 20:24:26 +00:00
|
|
|
|
2014-01-29 18:02:02 +00:00
|
|
|
/// Compiler controlled string compare function, either case independent or not:
|
|
|
|
inline int Cmp_KEEPCASE( const wxString& aString1, const wxString& aString2 )
|
|
|
|
{
|
|
|
|
#ifdef KICAD_KEEPCASE
|
|
|
|
// case specificity:
|
|
|
|
return aString1.Cmp( aString2 );
|
|
|
|
#else
|
|
|
|
// case independence:
|
|
|
|
return aString1.CmpNoCase( aString2 );
|
|
|
|
#endif
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2010-10-04 18:54:14 +00:00
|
|
|
/**
|
|
|
|
* LIB_ALIAS map sorting.
|
|
|
|
*/
|
|
|
|
struct AliasMapSort
|
|
|
|
{
|
|
|
|
bool operator() ( const wxString& aItem1, const wxString& aItem2 ) const
|
2014-01-29 18:02:02 +00:00
|
|
|
{
|
|
|
|
return Cmp_KEEPCASE( aItem1, aItem2 ) < 0;
|
|
|
|
}
|
2010-10-04 18:54:14 +00:00
|
|
|
};
|
|
|
|
|
2014-01-29 18:02:02 +00:00
|
|
|
|
2010-10-04 18:54:14 +00:00
|
|
|
/**
|
|
|
|
* Alias map used by component library object.
|
|
|
|
*/
|
|
|
|
typedef std::map< wxString, LIB_ALIAS*, AliasMapSort > LIB_ALIAS_MAP;
|
|
|
|
|
2011-04-27 19:44:32 +00:00
|
|
|
typedef std::vector< LIB_ALIAS* > LIB_ALIASES;
|
2009-09-18 14:56:05 +00:00
|
|
|
|
2010-02-17 13:22:25 +00:00
|
|
|
/* values for member .m_options */
|
2009-09-02 18:12:45 +00:00
|
|
|
enum LibrEntryOptions
|
|
|
|
{
|
2008-12-31 09:27:19 +00:00
|
|
|
ENTRY_NORMAL, // Libentry is a standard component (real or alias)
|
|
|
|
ENTRY_POWER // Libentry is a power symbol
|
|
|
|
};
|
|
|
|
|
|
|
|
|
2009-08-19 19:34:03 +00:00
|
|
|
/**
|
2010-10-25 15:43:42 +00:00
|
|
|
* Component library alias object definition.
|
2009-08-19 19:34:03 +00:00
|
|
|
*
|
2011-10-31 20:49:48 +00:00
|
|
|
* Component aliases are not really components. An alias uses the component definition
|
|
|
|
* (graphic, pins...) but has its own name, keywords and documentation. Therefore, when
|
|
|
|
* the component is modified, alias of this component are modified. This is a simple
|
|
|
|
* method to create components that have the same physical layout with different names
|
|
|
|
* such as 74LS00, 74HC00 ... and many op amps.
|
2009-08-19 19:34:03 +00:00
|
|
|
*/
|
2010-12-08 20:12:46 +00:00
|
|
|
class LIB_ALIAS : public EDA_ITEM
|
2008-12-31 09:27:19 +00:00
|
|
|
{
|
2010-10-25 15:43:42 +00:00
|
|
|
/**
|
|
|
|
* The actual component of the alias.
|
|
|
|
*
|
|
|
|
* @note - Do not delete the root component. The root component is actually shared by
|
|
|
|
* all of the aliases associated with it. The component pointer will be delete
|
|
|
|
* in the destructor of the last alias that shares this component is deleted.
|
2011-09-30 18:15:37 +00:00
|
|
|
* Deleting the root component will likely cause Eeschema to crash.
|
2010-10-25 15:43:42 +00:00
|
|
|
*/
|
|
|
|
LIB_COMPONENT* root;
|
2009-12-15 21:11:05 +00:00
|
|
|
|
2010-10-25 15:43:42 +00:00
|
|
|
friend class LIB_COMPONENT;
|
2009-12-15 21:11:05 +00:00
|
|
|
|
2010-10-25 15:43:42 +00:00
|
|
|
protected:
|
|
|
|
wxString name;
|
2010-07-31 23:57:36 +00:00
|
|
|
wxString description; ///< documentation for info
|
|
|
|
wxString keyWords; ///< keyword list (used for search for components by keyword)
|
|
|
|
wxString docFileName; ///< Associate doc file name
|
2008-12-31 09:27:19 +00:00
|
|
|
|
|
|
|
public:
|
2010-10-25 15:43:42 +00:00
|
|
|
LIB_ALIAS( const wxString& aName, LIB_COMPONENT* aRootComponent );
|
|
|
|
LIB_ALIAS( const LIB_ALIAS& aAlias, LIB_COMPONENT* aRootComponent = NULL );
|
2009-09-25 18:49:04 +00:00
|
|
|
|
2010-10-25 15:43:42 +00:00
|
|
|
virtual ~LIB_ALIAS();
|
2009-09-18 14:56:05 +00:00
|
|
|
|
2008-12-31 09:27:19 +00:00
|
|
|
virtual wxString GetClass() const
|
|
|
|
{
|
2010-10-25 15:43:42 +00:00
|
|
|
return wxT( "LIB_ALIAS" );
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the alias root component.
|
|
|
|
*/
|
|
|
|
LIB_COMPONENT* GetComponent() const
|
|
|
|
{
|
|
|
|
return root;
|
2008-12-31 09:27:19 +00:00
|
|
|
}
|
|
|
|
|
2010-10-12 10:28:30 +00:00
|
|
|
virtual wxString GetLibraryName();
|
2008-12-31 09:27:19 +00:00
|
|
|
|
2010-10-25 15:43:42 +00:00
|
|
|
bool IsRoot() const;
|
|
|
|
|
|
|
|
CMP_LIBRARY* GetLibrary();
|
2010-02-17 13:22:25 +00:00
|
|
|
|
2009-12-15 21:11:05 +00:00
|
|
|
virtual const wxString& GetName() const { return name; }
|
|
|
|
|
|
|
|
virtual void SetName( const wxString& aName ) { name = aName; }
|
|
|
|
|
|
|
|
void SetDescription( const wxString& aDescription )
|
|
|
|
{
|
|
|
|
description = aDescription;
|
|
|
|
}
|
2009-10-21 20:02:25 +00:00
|
|
|
|
2010-08-04 19:14:51 +00:00
|
|
|
wxString GetDescription() const { return description; }
|
2009-12-15 21:11:05 +00:00
|
|
|
|
|
|
|
void SetKeyWords( const wxString& aKeyWords )
|
|
|
|
{
|
|
|
|
keyWords = aKeyWords;
|
|
|
|
}
|
|
|
|
|
2010-08-04 19:14:51 +00:00
|
|
|
wxString GetKeyWords() const { return keyWords; }
|
2009-12-15 21:11:05 +00:00
|
|
|
|
|
|
|
void SetDocFileName( const wxString& aDocFileName )
|
|
|
|
{
|
|
|
|
docFileName = aDocFileName;
|
|
|
|
}
|
|
|
|
|
2010-08-04 19:14:51 +00:00
|
|
|
wxString GetDocFileName() const { return docFileName; }
|
2009-09-14 13:24:17 +00:00
|
|
|
|
2008-12-31 09:27:19 +00:00
|
|
|
/**
|
2011-11-11 20:10:24 +00:00
|
|
|
* Function SaveDocs
|
|
|
|
* rrite the entry document information to \a aFormatter in "*.dcm" format.
|
2009-08-19 19:34:03 +00:00
|
|
|
*
|
2011-11-11 20:10:24 +00:00
|
|
|
* @param aFormatter The #OUTPUTFORMATTER to write the alias documents to.
|
2009-10-30 19:26:25 +00:00
|
|
|
* @return True if success writing else false.
|
2008-12-31 09:27:19 +00:00
|
|
|
*/
|
2011-11-11 20:10:24 +00:00
|
|
|
bool SaveDoc( OUTPUTFORMATTER& aFormatter );
|
2009-08-27 11:41:56 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Case insensitive comparison of the component entry name.
|
|
|
|
*/
|
2009-12-15 21:11:05 +00:00
|
|
|
bool operator==( const wxChar* aName ) const;
|
|
|
|
bool operator!=( const wxChar* aName ) const
|
2009-08-27 11:41:56 +00:00
|
|
|
{
|
2009-12-15 21:11:05 +00:00
|
|
|
return !( *this == aName );
|
2009-08-27 11:41:56 +00:00
|
|
|
}
|
|
|
|
|
2010-10-25 15:43:42 +00:00
|
|
|
bool operator==( const LIB_ALIAS* aAlias ) const { return this == aAlias; }
|
2011-12-14 17:25:42 +00:00
|
|
|
|
|
|
|
#if defined(DEBUG)
|
|
|
|
void Show( int nestLevel, std::ostream& os ) const { ShowDummy( os ); } // override
|
|
|
|
#endif
|
2010-10-04 18:54:14 +00:00
|
|
|
};
|
2010-06-17 16:30:10 +00:00
|
|
|
|
2010-10-25 15:43:42 +00:00
|
|
|
extern bool operator<( const LIB_ALIAS& aItem1, const LIB_ALIAS& aItem2 );
|
2009-08-27 11:41:56 +00:00
|
|
|
|
2010-10-25 15:43:42 +00:00
|
|
|
extern int LibraryEntryCompare( const LIB_ALIAS* aItem1, const LIB_ALIAS* aItem2 );
|
2009-08-27 11:41:56 +00:00
|
|
|
|
|
|
|
|
2009-08-19 19:34:03 +00:00
|
|
|
/**
|
2011-10-31 20:49:48 +00:00
|
|
|
* Class LIB_COMPONENT
|
|
|
|
* defines a library component object.
|
2009-08-19 19:34:03 +00:00
|
|
|
*
|
2010-06-24 18:31:43 +00:00
|
|
|
* A library component object is typically saved and loaded in a component library file (.lib).
|
2010-02-14 18:14:33 +00:00
|
|
|
* Library components are different from schematic components.
|
2009-08-19 19:34:03 +00:00
|
|
|
*/
|
2010-12-08 20:12:46 +00:00
|
|
|
class LIB_COMPONENT : public EDA_ITEM
|
2008-12-31 09:27:19 +00:00
|
|
|
{
|
2013-05-19 19:35:49 +00:00
|
|
|
friend class CMP_LIBRARY;
|
|
|
|
friend class LIB_ALIAS;
|
|
|
|
|
2010-10-25 15:43:42 +00:00
|
|
|
wxString m_name;
|
2010-09-09 17:37:25 +00:00
|
|
|
int m_pinNameOffset; ///< The offset in mils to draw the pin name. Set to 0
|
|
|
|
///< to draw the pin name above the pin.
|
|
|
|
bool m_unitsLocked; ///< True if component has multiple parts and changing
|
|
|
|
///< one part does not automatically change another part.
|
|
|
|
bool m_showPinNames; ///< Determines if component pin names are visible.
|
|
|
|
bool m_showPinNumbers; ///< Determines if component pin numbers are visible.
|
|
|
|
long m_dateModified; ///< Date the component was last modified.
|
|
|
|
LibrEntryOptions m_options; ///< Special component features such as POWER or NORMAL.)
|
2010-10-25 15:43:42 +00:00
|
|
|
int m_unitCount; ///< Number of units (parts) per package.
|
2011-04-27 19:44:32 +00:00
|
|
|
LIB_ITEMS drawings; ///< How to draw this part.
|
2010-09-09 17:37:25 +00:00
|
|
|
wxArrayString m_FootprintList; /**< List of suitable footprint names for the
|
2010-10-04 18:54:14 +00:00
|
|
|
component (wild card names accepted). */
|
2011-04-27 19:44:32 +00:00
|
|
|
LIB_ALIASES m_aliases; ///< List of alias object pointers associated with the
|
2010-10-04 18:54:14 +00:00
|
|
|
///< component.
|
2010-10-25 15:43:42 +00:00
|
|
|
CMP_LIBRARY* m_library; ///< Library the component belongs to if any.
|
2013-07-19 18:27:22 +00:00
|
|
|
|
|
|
|
static int m_subpartIdSeparator; ///< the separator char between
|
2013-05-19 19:35:49 +00:00
|
|
|
///< the subpart id and the reference
|
|
|
|
///< like U1A ( m_subpartIdSeparator = 0 ) or U1.A or U1-A
|
2013-07-19 18:27:22 +00:00
|
|
|
static int m_subpartFirstId; ///< the ascii char value to calculate the subpart symbol id
|
2013-05-19 19:35:49 +00:00
|
|
|
///< from the part number: only 'A', 'a' or '1' can be used,
|
|
|
|
///< other values have no sense.
|
2013-07-19 18:27:22 +00:00
|
|
|
private:
|
2010-09-09 17:37:25 +00:00
|
|
|
void deleteAllFields();
|
|
|
|
|
|
|
|
public:
|
2010-02-17 13:22:25 +00:00
|
|
|
LIB_COMPONENT( const wxString& aName, CMP_LIBRARY* aLibrary = NULL );
|
|
|
|
LIB_COMPONENT( LIB_COMPONENT& aComponent, CMP_LIBRARY* aLibrary = NULL );
|
|
|
|
|
2010-10-04 18:54:14 +00:00
|
|
|
virtual ~LIB_COMPONENT();
|
2010-02-17 13:22:25 +00:00
|
|
|
|
2008-12-31 09:27:19 +00:00
|
|
|
virtual wxString GetClass() const
|
|
|
|
{
|
2009-09-18 14:56:05 +00:00
|
|
|
return wxT( "LIB_COMPONENT" );
|
2008-12-31 09:27:19 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2010-10-22 12:11:52 +00:00
|
|
|
virtual void SetName( const wxString& aName );
|
2009-10-21 20:02:25 +00:00
|
|
|
|
2010-10-25 15:43:42 +00:00
|
|
|
wxString GetName() { return m_name; }
|
|
|
|
|
|
|
|
wxString GetLibraryName();
|
|
|
|
|
|
|
|
CMP_LIBRARY* GetLibrary() { return m_library; }
|
2010-10-12 10:28:30 +00:00
|
|
|
|
2010-10-04 18:54:14 +00:00
|
|
|
wxArrayString GetAliasNames( bool aIncludeRoot = true ) const;
|
2010-09-09 17:37:25 +00:00
|
|
|
|
2010-10-04 18:54:14 +00:00
|
|
|
size_t GetAliasCount() const { return m_aliases.size(); }
|
2010-02-17 13:22:25 +00:00
|
|
|
|
2010-10-04 18:54:14 +00:00
|
|
|
LIB_ALIAS* GetAlias( size_t aIndex );
|
2009-09-25 18:49:04 +00:00
|
|
|
|
2010-10-04 18:54:14 +00:00
|
|
|
LIB_ALIAS* GetAlias( const wxString& aName );
|
2010-02-17 13:22:25 +00:00
|
|
|
|
2010-12-02 21:41:56 +00:00
|
|
|
/**
|
|
|
|
* Function AddAlias
|
|
|
|
*
|
|
|
|
* Add an alias \a aName to the component.
|
|
|
|
*
|
|
|
|
* Duplicate alias names are not added to the alias list. Debug builds will raise an
|
2011-10-31 20:49:48 +00:00
|
|
|
* assertion. Release builds will fail silently.
|
2010-12-02 21:41:56 +00:00
|
|
|
*
|
|
|
|
* @param aName - Name of alias to add.
|
|
|
|
*/
|
|
|
|
void AddAlias( const wxString& aName );
|
|
|
|
|
2010-10-04 18:54:14 +00:00
|
|
|
/**
|
|
|
|
* Test if alias \a aName is in component alias list.
|
|
|
|
*
|
|
|
|
* Alias name comparisons are case insensitive.
|
|
|
|
*
|
|
|
|
* @param aName - Name of alias.
|
|
|
|
* @return True if alias name in alias list.
|
2010-02-17 13:22:25 +00:00
|
|
|
*/
|
2010-10-04 18:54:14 +00:00
|
|
|
bool HasAlias( const wxString& aName ) const;
|
2010-02-17 13:22:25 +00:00
|
|
|
|
2010-10-04 18:54:14 +00:00
|
|
|
void SetAliases( const wxArrayString& aAliasList );
|
2010-02-17 13:22:25 +00:00
|
|
|
|
2010-10-04 18:54:14 +00:00
|
|
|
void RemoveAlias( const wxString& aName );
|
2010-02-17 13:22:25 +00:00
|
|
|
|
2010-10-04 18:54:14 +00:00
|
|
|
LIB_ALIAS* RemoveAlias( LIB_ALIAS* aAlias );
|
2010-02-17 13:22:25 +00:00
|
|
|
|
2010-12-02 21:41:56 +00:00
|
|
|
void RemoveAllAliases();
|
|
|
|
|
2010-10-04 18:54:14 +00:00
|
|
|
wxArrayString& GetFootPrints() { return m_FootprintList; }
|
2009-04-05 20:49:15 +00:00
|
|
|
|
2011-02-27 19:54:01 +00:00
|
|
|
/**
|
|
|
|
* Function GetBoundingBox
|
|
|
|
* @return the component boundary box ( in user coordinates )
|
|
|
|
* @param aUnit = unit selection = 0, or 1..n
|
|
|
|
* @param aConvert = 0, 1 or 2
|
|
|
|
* If aUnit == 0, unit is not used
|
|
|
|
* if aConvert == 0 Convert is non used
|
|
|
|
* Invisible fields are not taken in account
|
|
|
|
**/
|
2011-03-29 19:33:07 +00:00
|
|
|
EDA_RECT GetBoundingBox( int aUnit, int aConvert ) const;
|
2009-04-05 20:49:15 +00:00
|
|
|
|
2011-02-27 19:54:01 +00:00
|
|
|
/**
|
|
|
|
* Function GetBodyBoundingBox
|
|
|
|
* @return the component boundary box ( in user coordinates ) without fields
|
|
|
|
* @param aUnit = unit selection = 0, or 1..n
|
|
|
|
* @param aConvert = 0, 1 or 2
|
|
|
|
* If aUnit == 0, unit is not used
|
|
|
|
* if aConvert == 0 Convert is non used
|
|
|
|
* Fields are not taken in account
|
|
|
|
**/
|
2011-03-29 19:33:07 +00:00
|
|
|
EDA_RECT GetBodyBoundingBox( int aUnit, int aConvert ) const;
|
2011-02-27 19:54:01 +00:00
|
|
|
|
2011-10-31 20:49:48 +00:00
|
|
|
/**
|
|
|
|
* Function SaveDateAndTime
|
|
|
|
* write the date and time of component to \a aFile in the format:
|
|
|
|
* "Ti yy/mm/jj hh:mm:ss"
|
|
|
|
*
|
2011-11-11 20:10:24 +00:00
|
|
|
* @param aFormatter A reference to an #OUTPUTFORMATTER object containing the
|
2011-11-01 15:06:26 +00:00
|
|
|
* output format to write to.
|
|
|
|
* @return True if the date and time were successfully written to \a aFormatter.
|
2011-10-31 20:49:48 +00:00
|
|
|
*/
|
2011-11-01 15:06:26 +00:00
|
|
|
bool SaveDateAndTime( OUTPUTFORMATTER& aFormatter );
|
2011-10-31 20:49:48 +00:00
|
|
|
|
2009-12-15 21:11:05 +00:00
|
|
|
bool LoadDateAndTime( char* aLine );
|
2009-04-05 20:49:15 +00:00
|
|
|
|
2008-12-31 09:27:19 +00:00
|
|
|
/**
|
2011-11-01 15:06:26 +00:00
|
|
|
* Function Save
|
|
|
|
* writes the data structures out to \a aFormatter in the component library "*.lib"
|
|
|
|
* format.
|
2009-08-19 19:34:03 +00:00
|
|
|
*
|
2011-11-01 15:06:26 +00:00
|
|
|
* @param aFormatter A reference to an OUTPUTFORMATTER to write to.
|
2009-10-30 19:26:25 +00:00
|
|
|
* @return True if success writing else false.
|
2008-12-31 09:27:19 +00:00
|
|
|
*/
|
2011-11-01 15:06:26 +00:00
|
|
|
bool Save( OUTPUTFORMATTER& aFormatter );
|
2009-04-05 20:49:15 +00:00
|
|
|
|
|
|
|
/**
|
2011-10-31 20:49:48 +00:00
|
|
|
* Load component definition from \a aReader.
|
2009-04-05 20:49:15 +00:00
|
|
|
*
|
2011-10-31 20:49:48 +00:00
|
|
|
* @param aReader A LINE_READER object to load file from.
|
2009-12-15 21:11:05 +00:00
|
|
|
* @param aErrorMsg - Description of error on load failure.
|
2009-10-30 19:26:25 +00:00
|
|
|
* @return True if the load was successful, false if there was an error.
|
2009-04-05 20:49:15 +00:00
|
|
|
*/
|
2011-10-31 20:49:48 +00:00
|
|
|
bool Load( LINE_READER& aReader, wxString& aErrorMsg );
|
|
|
|
bool LoadField( LINE_READER& aReader, wxString& aErrorMsg );
|
|
|
|
bool LoadDrawEntries( LINE_READER& aReader, wxString& aErrorMsg );
|
2009-12-15 21:11:05 +00:00
|
|
|
bool LoadAliases( char* aLine, wxString& aErrorMsg );
|
2011-10-31 20:49:48 +00:00
|
|
|
bool LoadFootprints( LINE_READER& aReader, wxString& aErrorMsg );
|
2008-12-31 09:27:19 +00:00
|
|
|
|
2010-10-04 18:54:14 +00:00
|
|
|
bool IsPower() { return m_options == ENTRY_POWER; }
|
|
|
|
bool IsNormal() { return m_options == ENTRY_NORMAL; }
|
2010-02-16 17:49:17 +00:00
|
|
|
|
|
|
|
void SetPower() { m_options = ENTRY_POWER; }
|
|
|
|
void SetNormal() { m_options = ENTRY_NORMAL; }
|
|
|
|
|
2010-06-24 18:31:43 +00:00
|
|
|
void LockUnits( bool aLockUnits ) { m_unitsLocked = aLockUnits; }
|
|
|
|
bool UnitsLocked() { return m_unitsLocked; }
|
|
|
|
|
2009-08-19 19:34:03 +00:00
|
|
|
/**
|
2010-06-17 16:30:10 +00:00
|
|
|
* Function SetFields
|
|
|
|
* overwrites all the existing in this component with fields supplied
|
|
|
|
* in \a aFieldsList. The only known caller of this function is the
|
|
|
|
* library component field editor, and it establishes needed behavior.
|
2009-08-19 19:34:03 +00:00
|
|
|
*
|
2010-10-04 18:54:14 +00:00
|
|
|
` * @param aFieldsList is a set of fields to import, removing all previous fields.
|
2008-12-31 09:27:19 +00:00
|
|
|
*/
|
2010-06-17 16:30:10 +00:00
|
|
|
void SetFields( const std::vector <LIB_FIELD>& aFieldsList );
|
2009-09-04 18:57:37 +00:00
|
|
|
|
2009-10-21 20:02:25 +00:00
|
|
|
/**
|
2010-06-17 16:30:10 +00:00
|
|
|
* Function GetFields
|
|
|
|
* returns a list of fields withing this component. The only known caller of
|
|
|
|
* this function is the library component field editor, and it establishes
|
|
|
|
* needed behavior.
|
2009-10-21 20:02:25 +00:00
|
|
|
*
|
2010-06-17 16:30:10 +00:00
|
|
|
* @param aList - List to add fields to
|
2009-10-21 20:02:25 +00:00
|
|
|
*/
|
2011-04-27 19:44:32 +00:00
|
|
|
void GetFields( LIB_FIELDS& aList );
|
2009-10-21 20:02:25 +00:00
|
|
|
|
2010-06-17 16:30:10 +00:00
|
|
|
/**
|
|
|
|
* Function FindField
|
|
|
|
* finds a field within this component matching \a aFieldName and returns
|
|
|
|
* it or NULL if not found.
|
|
|
|
*/
|
2010-10-04 18:54:14 +00:00
|
|
|
LIB_FIELD* FindField( const wxString& aFieldName );
|
2010-06-17 16:30:10 +00:00
|
|
|
|
2009-10-21 20:02:25 +00:00
|
|
|
/**
|
|
|
|
* Return pointer to the requested field.
|
|
|
|
*
|
2009-12-15 21:11:05 +00:00
|
|
|
* @param aId - Id of field to return.
|
2009-10-30 19:26:25 +00:00
|
|
|
* @return The field if found, otherwise NULL.
|
2009-10-21 20:02:25 +00:00
|
|
|
*/
|
2009-12-15 21:11:05 +00:00
|
|
|
LIB_FIELD* GetField( int aId );
|
2009-10-21 20:02:25 +00:00
|
|
|
|
|
|
|
/** Return reference to the value field. */
|
2009-12-15 21:11:05 +00:00
|
|
|
LIB_FIELD& GetValueField();
|
2009-10-21 20:02:25 +00:00
|
|
|
|
|
|
|
/** Return reference to the reference designator field. */
|
2009-12-15 21:11:05 +00:00
|
|
|
LIB_FIELD& GetReferenceField();
|
2009-10-21 20:02:25 +00:00
|
|
|
|
2009-09-04 18:57:37 +00:00
|
|
|
/**
|
|
|
|
* Draw component.
|
|
|
|
*
|
2014-02-19 16:44:48 +00:00
|
|
|
* @param aPanel - Window to draw on. Can be NULL if not available.
|
2009-12-15 21:11:05 +00:00
|
|
|
* @param aDc - Device context to draw on.
|
|
|
|
* @param aOffset - Position to component.
|
|
|
|
* @param aMulti - Component unit if multiple parts per component.
|
|
|
|
* @param aConvert - Component conversion (DeMorgan) if available.
|
|
|
|
* @param aDrawMode - Device context drawing mode, see wxDC.
|
|
|
|
* @param aColor - Color to draw component.
|
2010-12-14 15:56:30 +00:00
|
|
|
* @param aTransform - Coordinate adjustment settings.
|
2009-12-15 21:11:05 +00:00
|
|
|
* @param aShowPinText - Show pin text if true.
|
|
|
|
* @param aDrawFields - Draw field text if true otherwise just draw
|
|
|
|
* body items (useful to draw a body in schematic,
|
|
|
|
* because fields of schematic components replace
|
|
|
|
* the lib component fields).
|
|
|
|
* @param aOnlySelected - Draws only the body items that are selected.
|
|
|
|
* Used for block move redraws.
|
|
|
|
*/
|
2011-01-21 19:30:59 +00:00
|
|
|
void Draw( EDA_DRAW_PANEL* aPanel, wxDC* aDc, const wxPoint& aOffset,
|
2012-09-02 12:06:47 +00:00
|
|
|
int aMulti, int aConvert, GR_DRAWMODE aDrawMode,
|
|
|
|
EDA_COLOR_T aColor = UNSPECIFIED_COLOR,
|
2010-10-20 20:24:26 +00:00
|
|
|
const TRANSFORM& aTransform = DefaultTransform,
|
2009-12-15 21:11:05 +00:00
|
|
|
bool aShowPinText = true, bool aDrawFields = true,
|
|
|
|
bool aOnlySelected = false );
|
2009-09-04 18:57:37 +00:00
|
|
|
|
2009-10-05 17:52:41 +00:00
|
|
|
/**
|
2013-05-18 09:38:23 +00:00
|
|
|
* Plot lib component to plotter.
|
|
|
|
* Lib Fields not are plotted here, because this plot function
|
|
|
|
* is used to plot schematic items, which have they own fields
|
2009-10-05 17:52:41 +00:00
|
|
|
*
|
2009-12-15 21:11:05 +00:00
|
|
|
* @param aPlotter - Plotter object to plot to.
|
|
|
|
* @param aUnit - Component part to plot.
|
|
|
|
* @param aConvert - Component alternate body style to plot.
|
2010-12-14 15:56:30 +00:00
|
|
|
* @param aOffset - Distance to shift the plot coordinates.
|
2009-12-15 21:11:05 +00:00
|
|
|
* @param aTransform - Component plot transform matrix.
|
2009-10-05 17:52:41 +00:00
|
|
|
*/
|
2009-12-15 21:11:05 +00:00
|
|
|
void Plot( PLOTTER* aPlotter, int aUnit, int aConvert, const wxPoint& aOffset,
|
2013-05-18 09:38:23 +00:00
|
|
|
const TRANSFORM& aTransform );
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Plot Lib Fields only of the component to plotter.
|
|
|
|
* is used to plot the full lib component, outside the schematic
|
|
|
|
*
|
|
|
|
* @param aPlotter - Plotter object to plot to.
|
|
|
|
* @param aUnit - Component part to plot.
|
|
|
|
* @param aConvert - Component alternate body style to plot.
|
|
|
|
* @param aOffset - Distance to shift the plot coordinates.
|
|
|
|
* @param aTransform - Component plot transform matrix.
|
|
|
|
*/
|
|
|
|
void PlotLibFields( PLOTTER* aPlotter, int aUnit, int aConvert,
|
|
|
|
const wxPoint& aOffset, const TRANSFORM& aTransform );
|
2009-10-05 17:52:41 +00:00
|
|
|
|
2009-09-29 18:38:21 +00:00
|
|
|
/**
|
2010-06-24 18:31:43 +00:00
|
|
|
* Add a new draw \a aItem to the draw object list.
|
2009-09-29 18:38:21 +00:00
|
|
|
*
|
2010-12-14 15:56:30 +00:00
|
|
|
* @param aItem - New draw object to add to component.
|
2009-09-29 18:38:21 +00:00
|
|
|
*/
|
2011-04-27 19:44:32 +00:00
|
|
|
void AddDrawItem( LIB_ITEM* aItem );
|
2009-09-29 18:38:21 +00:00
|
|
|
|
2009-09-04 18:57:37 +00:00
|
|
|
/**
|
2010-06-24 18:31:43 +00:00
|
|
|
* Remove draw \a aItem from list.
|
2009-09-04 18:57:37 +00:00
|
|
|
*
|
2009-12-15 21:11:05 +00:00
|
|
|
* @param aItem - Draw item to remove from list.
|
|
|
|
* @param aPanel - Panel to remove part from.
|
|
|
|
* @param aDc - Device context to remove part from.
|
2009-09-04 18:57:37 +00:00
|
|
|
*/
|
2011-04-27 19:44:32 +00:00
|
|
|
void RemoveDrawItem( LIB_ITEM* aItem, EDA_DRAW_PANEL* aPanel = NULL, wxDC* aDc = NULL );
|
2009-09-14 13:24:17 +00:00
|
|
|
|
2009-10-30 19:26:25 +00:00
|
|
|
/**
|
2009-09-29 18:38:21 +00:00
|
|
|
* Return the next draw object pointer.
|
|
|
|
*
|
2009-12-15 21:11:05 +00:00
|
|
|
* @param aItem - Pointer to the current draw item. Setting item NULL
|
|
|
|
* with return the first item of type in the list.
|
|
|
|
* @param aType - type of searched item (filter).
|
|
|
|
* if TYPE_NOT_INIT search for all items types
|
2009-10-30 19:26:25 +00:00
|
|
|
* @return - The next drawing object in the list if found, otherwise NULL.
|
2009-09-29 18:38:21 +00:00
|
|
|
*/
|
2011-04-27 19:44:32 +00:00
|
|
|
LIB_ITEM* GetNextDrawItem( LIB_ITEM* aItem = NULL, KICAD_T aType = TYPE_NOT_INIT );
|
2009-09-29 18:38:21 +00:00
|
|
|
|
2009-10-14 19:43:31 +00:00
|
|
|
/**
|
|
|
|
* Return the next pin object from the draw list.
|
|
|
|
*
|
|
|
|
* This is just a pin object specific version of GetNextDrawItem().
|
|
|
|
*
|
2010-12-14 15:56:30 +00:00
|
|
|
* @param aItem - Pointer to the previous pin item, or NULL to get the
|
|
|
|
* first pin in the draw object list.
|
2009-10-30 19:26:25 +00:00
|
|
|
* @return - The next pin object in the list if found, otherwise NULL.
|
2009-10-14 19:43:31 +00:00
|
|
|
*/
|
2009-12-15 21:11:05 +00:00
|
|
|
LIB_PIN* GetNextPin( LIB_PIN* aItem = NULL )
|
2009-09-29 18:38:21 +00:00
|
|
|
{
|
2011-04-27 19:44:32 +00:00
|
|
|
return (LIB_PIN*) GetNextDrawItem( (LIB_ITEM*) aItem, LIB_PIN_T );
|
2009-09-29 18:38:21 +00:00
|
|
|
}
|
|
|
|
|
2009-10-14 19:43:31 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Return a list of pin object pointers from the draw item list.
|
|
|
|
*
|
|
|
|
* Note pin objects are owned by the draw list of the component.
|
|
|
|
* Deleting any of the objects will leave list in a unstable state
|
|
|
|
* and will likely segfault when the list is destroyed.
|
|
|
|
*
|
2009-12-15 21:11:05 +00:00
|
|
|
* @param aList - Pin list to place pin object pointers into.
|
|
|
|
* @param aUnit - Unit number of pin to add to list. Set to 0 to
|
|
|
|
* get pins from any component part.
|
|
|
|
* @param aConvert - Convert number of pin to add to list. Set to 0 to
|
|
|
|
* get pins from any convert of component.
|
2009-10-14 19:43:31 +00:00
|
|
|
*/
|
2011-04-27 19:44:32 +00:00
|
|
|
void GetPins( LIB_PINS& aList, int aUnit = 0, int aConvert = 0 );
|
2009-10-14 19:43:31 +00:00
|
|
|
|
2009-10-30 19:26:25 +00:00
|
|
|
/**
|
2010-06-24 18:31:43 +00:00
|
|
|
* Return pin object with the requested pin \a aNumber.
|
2009-10-30 19:26:25 +00:00
|
|
|
*
|
2009-12-15 21:11:05 +00:00
|
|
|
* @param aNumber - Number of the pin to find.
|
|
|
|
* @param aUnit - Unit of the component to find. Set to 0 if a specific
|
|
|
|
* unit number is not required.
|
|
|
|
* @param aConvert - Alternate body style filter (DeMorgan). Set to 0 if
|
|
|
|
* no alternate body style is required.
|
2009-10-30 19:26:25 +00:00
|
|
|
* @return The pin object if found. Otherwise NULL.
|
|
|
|
*/
|
2009-12-15 21:11:05 +00:00
|
|
|
LIB_PIN* GetPin( const wxString& aNumber, int aUnit = 0, int aConvert = 0 );
|
2009-10-30 19:26:25 +00:00
|
|
|
|
2009-09-14 13:24:17 +00:00
|
|
|
/**
|
2010-06-24 18:31:43 +00:00
|
|
|
* Move the component \a aOffset.
|
2009-09-14 13:24:17 +00:00
|
|
|
*
|
2009-12-15 21:11:05 +00:00
|
|
|
* @param aOffset - Offset displacement.
|
2009-09-14 13:24:17 +00:00
|
|
|
*/
|
2009-12-15 21:11:05 +00:00
|
|
|
void SetOffset( const wxPoint& aOffset );
|
2009-09-14 13:24:17 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Remove duplicate draw items from list.
|
|
|
|
*/
|
|
|
|
void RemoveDuplicateDrawItems();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Test if component has more than one body conversion type (DeMorgan).
|
|
|
|
*
|
2009-10-30 19:26:25 +00:00
|
|
|
* @return True if component has more than one conversion.
|
2009-09-14 13:24:17 +00:00
|
|
|
*/
|
|
|
|
bool HasConversion() const;
|
|
|
|
|
2009-09-29 18:38:21 +00:00
|
|
|
/**
|
|
|
|
* Clears the status flag all draw objects in this component.
|
|
|
|
*/
|
2009-12-15 21:11:05 +00:00
|
|
|
void ClearStatus();
|
2009-09-29 18:38:21 +00:00
|
|
|
|
2009-09-25 18:49:04 +00:00
|
|
|
/**
|
|
|
|
* Checks all draw objects of component to see if they are with block.
|
|
|
|
*
|
|
|
|
* Use this method to mark draw objects as selected during block
|
|
|
|
* functions.
|
|
|
|
*
|
2009-12-15 21:11:05 +00:00
|
|
|
* @param aRect - The bounding rectangle to test in draw items are inside.
|
|
|
|
* @param aUnit - The current unit number to test against.
|
|
|
|
* @param aConvert - Are the draw items being selected a conversion.
|
|
|
|
* @param aEditPinByPin - Used to ignore pin selections when in edit pin
|
|
|
|
* by pin mode is enabled.
|
2009-10-30 19:26:25 +00:00
|
|
|
* @return The number of draw objects found inside the block select
|
|
|
|
* rectangle.
|
2009-09-25 18:49:04 +00:00
|
|
|
*/
|
2011-03-29 19:33:07 +00:00
|
|
|
int SelectItems( EDA_RECT& aRect, int aUnit, int aConvert, bool aEditPinByPin );
|
2009-09-25 18:49:04 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Clears all the draw items marked by a block select.
|
|
|
|
*/
|
2009-12-15 21:11:05 +00:00
|
|
|
void ClearSelectedItems();
|
2009-09-25 18:49:04 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Deletes the select draw items marked by a block select.
|
|
|
|
*
|
|
|
|
* The name and reference field will not be deleted. They are the
|
2009-10-30 19:26:25 +00:00
|
|
|
* minimum drawing items required for any component. Their properties
|
2009-09-25 18:49:04 +00:00
|
|
|
* can be changed but the cannot be removed.
|
|
|
|
*/
|
2009-12-15 21:11:05 +00:00
|
|
|
void DeleteSelectedItems();
|
2009-09-25 18:49:04 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Move the selected draw items marked by a block select.
|
|
|
|
*/
|
2009-12-15 21:11:05 +00:00
|
|
|
void MoveSelectedItems( const wxPoint& aOffset );
|
2009-09-25 18:49:04 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Make a copy of the selected draw items marked by a block select.
|
|
|
|
*
|
|
|
|
* Fields are not copied. Only component body items are copied.
|
|
|
|
* Copying fields would result in duplicate fields which does not
|
|
|
|
* make sense in this context.
|
|
|
|
*/
|
2009-12-15 21:11:05 +00:00
|
|
|
void CopySelectedItems( const wxPoint& aOffset );
|
2009-09-29 18:38:21 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Horizontally (X axis) mirror selected draw items about a point.
|
|
|
|
*
|
2009-12-15 21:11:05 +00:00
|
|
|
* @param aCenter - Center point to mirror around.
|
2009-09-29 18:38:21 +00:00
|
|
|
*/
|
2009-12-15 21:11:05 +00:00
|
|
|
void MirrorSelectedItemsH( const wxPoint& aCenter );
|
2009-09-29 18:38:21 +00:00
|
|
|
|
2011-05-20 18:29:35 +00:00
|
|
|
/**
|
|
|
|
* Vertically (Y axis) mirror selected draw items about a point.
|
|
|
|
*
|
|
|
|
* @param aCenter - Center point to mirror around.
|
|
|
|
*/
|
|
|
|
void MirrorSelectedItemsV( const wxPoint& aCenter );
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Rotate CCW selected draw items about a point.
|
|
|
|
*
|
|
|
|
* @param aCenter - Center point to mirror around.
|
|
|
|
*/
|
|
|
|
void RotateSelectedItems( const wxPoint& aCenter );
|
|
|
|
|
2009-09-29 18:38:21 +00:00
|
|
|
/**
|
|
|
|
* Locate a draw object.
|
|
|
|
*
|
2009-12-15 21:11:05 +00:00
|
|
|
* @param aUnit - Unit number of draw item.
|
|
|
|
* @param aConvert - Body style of draw item.
|
|
|
|
* @param aType - Draw object type, set to 0 to search for any type.
|
|
|
|
* @param aPoint - Coordinate for hit testing.
|
2009-10-30 19:26:25 +00:00
|
|
|
* @return The draw object if found. Otherwise NULL.
|
2009-09-29 18:38:21 +00:00
|
|
|
*/
|
2011-04-27 19:44:32 +00:00
|
|
|
LIB_ITEM* LocateDrawItem( int aUnit, int aConvert, KICAD_T aType, const wxPoint& aPoint );
|
2009-10-05 17:52:41 +00:00
|
|
|
|
2009-10-06 13:52:43 +00:00
|
|
|
/**
|
|
|
|
* Locate a draw object (overlaid)
|
|
|
|
*
|
2009-12-15 21:11:05 +00:00
|
|
|
* @param aUnit - Unit number of draw item.
|
|
|
|
* @param aConvert - Body style of draw item.
|
|
|
|
* @param aType - Draw object type, set to 0 to search for any type.
|
|
|
|
* @param aPoint - Coordinate for hit testing.
|
|
|
|
* @param aTransform = the transform matrix
|
2009-10-30 19:26:25 +00:00
|
|
|
* @return The draw object if found. Otherwise NULL.
|
2009-10-06 13:52:43 +00:00
|
|
|
*/
|
2011-04-27 19:44:32 +00:00
|
|
|
LIB_ITEM* LocateDrawItem( int aUnit, int aConvert, KICAD_T aType,
|
|
|
|
const wxPoint& aPoint, const TRANSFORM& aTransform );
|
2009-10-06 13:52:43 +00:00
|
|
|
|
2009-10-05 17:52:41 +00:00
|
|
|
/**
|
|
|
|
* Return a reference to the draw item list.
|
|
|
|
*
|
2011-04-27 19:44:32 +00:00
|
|
|
* @return LIB_ITEMS& - Reference to the draw item object list.
|
2009-10-05 17:52:41 +00:00
|
|
|
*/
|
2011-04-27 19:44:32 +00:00
|
|
|
LIB_ITEMS& GetDrawItemList() { return drawings; }
|
2009-10-05 17:52:41 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Set the part per package count.
|
|
|
|
*
|
|
|
|
* If the count is greater than the current count, then the all of the
|
|
|
|
* current draw items are duplicated for each additional part. If the
|
|
|
|
* count is less than the current count, all draw objects for parts
|
|
|
|
* greater that count are removed from the component.
|
|
|
|
*
|
|
|
|
* @param count - Number of parts per package.
|
|
|
|
*/
|
|
|
|
void SetPartCount( int count );
|
|
|
|
|
2010-10-25 15:43:42 +00:00
|
|
|
int GetPartCount() { return m_unitCount; }
|
2009-10-05 17:52:41 +00:00
|
|
|
|
2010-11-12 15:17:10 +00:00
|
|
|
/**
|
|
|
|
* Function IsMulti
|
2010-04-24 11:27:38 +00:00
|
|
|
* @return true if the component has multiple parts per package.
|
|
|
|
* When happens, the reference has a sub reference ti identify part
|
|
|
|
*/
|
2010-10-25 15:43:42 +00:00
|
|
|
bool IsMulti() { return m_unitCount > 1; }
|
2010-04-24 11:27:38 +00:00
|
|
|
|
2010-11-12 15:17:10 +00:00
|
|
|
/**
|
* KIWAY Milestone A): Make major modules into DLL/DSOs.
! The initial testing of this commit should be done using a Debug build so that
all the wxASSERT()s are enabled. Also, be sure and keep enabled the
USE_KIWAY_DLLs option. The tree won't likely build without it. Turning it
off is senseless anyways. If you want stable code, go back to a prior version,
the one tagged with "stable".
* Relocate all functionality out of the wxApp derivative into more finely
targeted purposes:
a) DLL/DSO specific
b) PROJECT specific
c) EXE or process specific
d) configuration file specific data
e) configuration file manipulations functions.
All of this functionality was blended into an extremely large wxApp derivative
and that was incompatible with the desire to support multiple concurrently
loaded DLL/DSO's ("KIFACE")s and multiple concurrently open projects.
An amazing amount of organization come from simply sorting each bit of
functionality into the proper box.
* Switch to wxConfigBase from wxConfig everywhere except instantiation.
* Add classes KIWAY, KIFACE, KIFACE_I, SEARCH_STACK, PGM_BASE, PGM_KICAD,
PGM_SINGLE_TOP,
* Remove "Return" prefix on many function names.
* Remove obvious comments from CMakeLists.txt files, and from else() and endif()s.
* Fix building boost for use in a DSO on linux.
* Remove some of the assumptions in the CMakeLists.txt files that windows had
to be the host platform when building windows binaries.
* Reduce the number of wxStrings being constructed at program load time via
static construction.
* Pass wxConfigBase* to all SaveSettings() and LoadSettings() functions so that
these functions are useful even when the wxConfigBase comes from another
source, as is the case in the KICAD_MANAGER_FRAME.
* Move the setting of the KIPRJMOD environment variable into class PROJECT,
so that it can be moved into a project variable soon, and out of FP_LIB_TABLE.
* Add the KIWAY_PLAYER which is associated with a particular PROJECT, and all
its child wxFrames and wxDialogs now have a Kiway() member function which
returns a KIWAY& that that window tree branch is in support of. This is like
wxWindows DNA in that child windows get this member with proper value at time
of construction.
* Anticipate some of the needs for milestones B) and C) and make code
adjustments now in an effort to reduce work in those milestones.
* No testing has been done for python scripting, since milestone C) has that
being largely reworked and re-thought-out.
2014-03-20 00:42:08 +00:00
|
|
|
* Function SubReference
|
2010-04-24 11:27:38 +00:00
|
|
|
* @return the sub reference for component having multiple parts per package.
|
|
|
|
* The sub reference identify the part (or unit)
|
|
|
|
* @param aUnit = the part identifier ( 1 to max count)
|
2013-05-19 19:35:49 +00:00
|
|
|
* @param aAddSeparator = true (default) to prpebd the sub ref
|
|
|
|
* by the separator symbol (if any)
|
2010-04-24 11:27:38 +00:00
|
|
|
* Note: this is a static function.
|
|
|
|
*/
|
* KIWAY Milestone A): Make major modules into DLL/DSOs.
! The initial testing of this commit should be done using a Debug build so that
all the wxASSERT()s are enabled. Also, be sure and keep enabled the
USE_KIWAY_DLLs option. The tree won't likely build without it. Turning it
off is senseless anyways. If you want stable code, go back to a prior version,
the one tagged with "stable".
* Relocate all functionality out of the wxApp derivative into more finely
targeted purposes:
a) DLL/DSO specific
b) PROJECT specific
c) EXE or process specific
d) configuration file specific data
e) configuration file manipulations functions.
All of this functionality was blended into an extremely large wxApp derivative
and that was incompatible with the desire to support multiple concurrently
loaded DLL/DSO's ("KIFACE")s and multiple concurrently open projects.
An amazing amount of organization come from simply sorting each bit of
functionality into the proper box.
* Switch to wxConfigBase from wxConfig everywhere except instantiation.
* Add classes KIWAY, KIFACE, KIFACE_I, SEARCH_STACK, PGM_BASE, PGM_KICAD,
PGM_SINGLE_TOP,
* Remove "Return" prefix on many function names.
* Remove obvious comments from CMakeLists.txt files, and from else() and endif()s.
* Fix building boost for use in a DSO on linux.
* Remove some of the assumptions in the CMakeLists.txt files that windows had
to be the host platform when building windows binaries.
* Reduce the number of wxStrings being constructed at program load time via
static construction.
* Pass wxConfigBase* to all SaveSettings() and LoadSettings() functions so that
these functions are useful even when the wxConfigBase comes from another
source, as is the case in the KICAD_MANAGER_FRAME.
* Move the setting of the KIPRJMOD environment variable into class PROJECT,
so that it can be moved into a project variable soon, and out of FP_LIB_TABLE.
* Add the KIWAY_PLAYER which is associated with a particular PROJECT, and all
its child wxFrames and wxDialogs now have a Kiway() member function which
returns a KIWAY& that that window tree branch is in support of. This is like
wxWindows DNA in that child windows get this member with proper value at time
of construction.
* Anticipate some of the needs for milestones B) and C) and make code
adjustments now in an effort to reduce work in those milestones.
* No testing has been done for python scripting, since milestone C) has that
being largely reworked and re-thought-out.
2014-03-20 00:42:08 +00:00
|
|
|
static wxString SubReference( int aUnit, bool aAddSeparator = true );
|
2013-05-19 19:35:49 +00:00
|
|
|
|
|
|
|
// Accessors to sub ref parameters
|
|
|
|
static int GetSubpartIdSeparator() { return m_subpartIdSeparator; }
|
2013-07-19 18:27:22 +00:00
|
|
|
|
|
|
|
/** return a reference to m_subpartIdSeparator,
|
|
|
|
* only for read/save setting functions
|
|
|
|
*/
|
|
|
|
static int* SubpartIdSeparatorPtr() { return &m_subpartIdSeparator; }
|
|
|
|
|
2013-05-19 19:35:49 +00:00
|
|
|
static int GetSubpartFirstId() { return m_subpartFirstId; }
|
2013-07-19 18:27:22 +00:00
|
|
|
|
|
|
|
/** return a reference to m_subpartFirstId, only for read/save setting functions
|
|
|
|
*/
|
|
|
|
static int* SubpartFirstIdPtr() { return &m_subpartFirstId; }
|
|
|
|
|
|
|
|
/** Set the separator char between the subpart id and the reference
|
|
|
|
* 0 (no separator) or '.' , '-' and '_'
|
|
|
|
* and the ascii char value to calculate the subpart symbol id from the part number:
|
|
|
|
* 'A' or '1' only are allowed. (to print U1.A or U1.1)
|
|
|
|
* if this is a digit, a number is used as id symbol
|
|
|
|
* Note also if the subpart symbol is a digit, the separator cannot be null.
|
|
|
|
* @param aSep = the separator symbol (0 (no separator) or '.' , '-' and '_')
|
|
|
|
* @param aFirstId = the Id of the first part ('A' or '1')
|
|
|
|
*/
|
|
|
|
static void SetSubpartIdNotation( int aSep, int aFirstId );
|
2010-04-24 11:27:38 +00:00
|
|
|
|
2009-10-05 17:52:41 +00:00
|
|
|
/**
|
|
|
|
* Set or clear the alternate body style (DeMorgan) for the component.
|
|
|
|
*
|
|
|
|
* If the component already has an alternate body style set and a
|
|
|
|
* asConvert if false, all of the existing draw items for the alternate
|
|
|
|
* body style are remove. If the alternate body style is not set and
|
|
|
|
* asConvert is true, than the base draw items are duplicated and
|
|
|
|
* added to the component.
|
|
|
|
*
|
2009-12-15 21:11:05 +00:00
|
|
|
* @param aSetConvert - Set or clear the component alternate body style.
|
2009-10-05 17:52:41 +00:00
|
|
|
*/
|
2009-12-15 21:11:05 +00:00
|
|
|
void SetConversion( bool aSetConvert );
|
2010-06-24 18:31:43 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Set the offset in mils of the pin name text from the pin symbol.
|
|
|
|
*
|
|
|
|
* Set the offset to 0 to draw the pin name above the pin symbol.
|
|
|
|
*
|
|
|
|
* @param aOffset - The offset in mils.
|
|
|
|
*/
|
|
|
|
void SetPinNameOffset( int aOffset ) { m_pinNameOffset = aOffset; }
|
|
|
|
|
|
|
|
int GetPinNameOffset() { return m_pinNameOffset; }
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Set or clear the pin name visibility flag.
|
|
|
|
*
|
|
|
|
* @param aShow - True to make the component pin names visible.
|
|
|
|
*/
|
|
|
|
void SetShowPinNames( bool aShow ) { m_showPinNames = aShow; }
|
|
|
|
|
|
|
|
bool ShowPinNames() { return m_showPinNames; }
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Set or clear the pin number visibility flag.
|
|
|
|
*
|
|
|
|
* @param aShow - True to make the component pin numbers visible.
|
|
|
|
*/
|
|
|
|
void SetShowPinNumbers( bool aShow ) { m_showPinNumbers = aShow; }
|
|
|
|
|
|
|
|
bool ShowPinNumbers() { return m_showPinNumbers; }
|
2010-10-04 18:54:14 +00:00
|
|
|
|
|
|
|
bool operator==( const LIB_COMPONENT* aComponent ) const { return this == aComponent; }
|
2008-12-31 09:27:19 +00:00
|
|
|
|
2011-12-14 17:25:42 +00:00
|
|
|
#if defined(DEBUG)
|
|
|
|
void Show( int nestLevel, std::ostream& os ) const { ShowDummy( os ); } // override
|
|
|
|
#endif
|
|
|
|
};
|
2008-12-31 09:27:19 +00:00
|
|
|
|
|
|
|
#endif // CLASS_LIBENTRY_H
|