472 lines
15 KiB
C++
472 lines
15 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
|
|
* Copyright (C) 2008 Wayne Stambaugh <stambaughw@gmail.com>
|
|
* Copyright (C) 2004-2021 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 class_library.h
|
|
* @brief Definition for part library class.
|
|
*/
|
|
|
|
#ifndef CLASS_LIBRARY_H
|
|
#define CLASS_LIBRARY_H
|
|
|
|
#include <map>
|
|
#include <boost/ptr_container/ptr_vector.hpp>
|
|
#include <wx/filename.h>
|
|
|
|
#include <sch_io_mgr.h>
|
|
#include <project.h>
|
|
|
|
class LIB_PART;
|
|
class LIB_ID;
|
|
class LINE_READER;
|
|
class OUTPUTFORMATTER;
|
|
class SCH_LEGACY_PLUGIN;
|
|
class SCH_PLUGIN;
|
|
|
|
|
|
#define DOC_EXT "dcm"
|
|
|
|
/*
|
|
* Part Library version and file header macros.
|
|
*/
|
|
#define LIB_VERSION_MAJOR 2
|
|
#define LIB_VERSION_MINOR 4
|
|
|
|
/* Must be the first line of part library (.lib) files. */
|
|
#define LIBFILE_IDENT "EESchema-LIBRARY Version"
|
|
|
|
#define LIB_VERSION( major, minor ) ( major * 100 + minor )
|
|
|
|
#define IS_LIB_CURRENT_VERSION( major, minor ) \
|
|
( \
|
|
LIB_VERSION( major1, minor1 ) == \
|
|
LIB_VERSION( LIB_VERSION_MAJOR, LIB_VERSION_MINOR) \
|
|
)
|
|
|
|
/*
|
|
* Library versions 2.4 and lower use the old separate library (.lib) and
|
|
* document (.dcm) files. Part libraries after 2.4 merged the library
|
|
* and document files into a single library file. This macro checks if the
|
|
* library version supports the old format
|
|
*/
|
|
#define USE_OLD_DOC_FILE_FORMAT( major, minor ) \
|
|
( LIB_VERSION( major, minor ) <= LIB_VERSION( 2, 4 ) )
|
|
|
|
enum class SCH_LIB_TYPE
|
|
{
|
|
LT_EESCHEMA,
|
|
LT_SYMBOL
|
|
};
|
|
|
|
// Helper class to filter a list of libraries, and/or a list of PART_LIB
|
|
// in dialogs
|
|
class SCHLIB_FILTER
|
|
{
|
|
public:
|
|
SCHLIB_FILTER()
|
|
{
|
|
m_filterPowerParts = false;
|
|
m_forceLoad = false;
|
|
}
|
|
|
|
/**
|
|
* add a lib name to the allowed libraries
|
|
*/
|
|
void AddLib( const wxString& aLibName )
|
|
{
|
|
m_allowedLibs.Add( aLibName );
|
|
m_forceLoad = false;
|
|
}
|
|
|
|
|
|
/**
|
|
* add a lib name to the allowed libraries
|
|
*/
|
|
void LoadFrom( const wxString& aLibName )
|
|
{
|
|
m_allowedLibs.Clear();
|
|
m_allowedLibs.Add( aLibName );
|
|
m_forceLoad = true;
|
|
}
|
|
|
|
/**
|
|
* Clear the allowed libraries list (allows all libs)
|
|
*/
|
|
void ClearLibList()
|
|
{
|
|
m_allowedLibs.Clear();
|
|
m_forceLoad = false;
|
|
}
|
|
|
|
/**
|
|
* set the filtering of power parts
|
|
*/
|
|
void FilterPowerParts( bool aFilterEnable )
|
|
{
|
|
m_filterPowerParts = aFilterEnable;
|
|
}
|
|
|
|
// Accessors
|
|
|
|
/**
|
|
* @return true if the filtering of power parts is on
|
|
*/
|
|
bool GetFilterPowerParts() const { return m_filterPowerParts; }
|
|
|
|
|
|
/**
|
|
* @return am wxArrayString of the names of allowed libs
|
|
*/
|
|
const wxArrayString& GetAllowedLibList() const { return m_allowedLibs; }
|
|
|
|
/**
|
|
* @return the name of the lib to use to load a part, or an a empty string
|
|
* Useful to load (in lib editor or lib viewer) a part from a given library
|
|
*/
|
|
const wxString& GetLibSource() const
|
|
{
|
|
static wxString dummy;
|
|
|
|
if( m_forceLoad && m_allowedLibs.GetCount() > 0 )
|
|
return m_allowedLibs[0];
|
|
else
|
|
return dummy;
|
|
}
|
|
|
|
private:
|
|
wxArrayString m_allowedLibs; ///< a list of lib names to list some libraries
|
|
///< if empty: no filter
|
|
bool m_filterPowerParts; ///< true to filter (show only) power parts
|
|
bool m_forceLoad; // When true, load a part lib from the lib
|
|
// which is given in m_allowedLibs[0]
|
|
};
|
|
|
|
|
|
/* Helpers for creating a list of part libraries. */
|
|
class PART_LIB;
|
|
class wxRegEx;
|
|
|
|
/**
|
|
* LIB_PART map sorting.
|
|
*/
|
|
struct LibPartMapSort
|
|
{
|
|
bool operator() ( const wxString& aItem1, const wxString& aItem2 ) const
|
|
{
|
|
return aItem1 < aItem2;
|
|
}
|
|
};
|
|
|
|
/// Part map used by part library object.
|
|
|
|
typedef std::map< wxString, LIB_PART*, LibPartMapSort > LIB_PART_MAP;
|
|
typedef std::vector< LIB_PART* > LIB_PARTS;
|
|
typedef boost::ptr_vector< PART_LIB > PART_LIBS_BASE;
|
|
|
|
|
|
/**
|
|
* A collection of #PART_LIB objects.
|
|
*
|
|
* It extends from PROJECT::_ELEM so it can be hung in the PROJECT. It does not use any
|
|
* UI calls, but rather simply throws an IO_ERROR when there is a problem.
|
|
*/
|
|
class PART_LIBS : public PART_LIBS_BASE, public PROJECT::_ELEM
|
|
{
|
|
public:
|
|
KICAD_T Type() override { return PART_LIBS_T; }
|
|
|
|
static int s_modify_generation; ///< helper for GetModifyHash()
|
|
|
|
PART_LIBS()
|
|
{
|
|
++s_modify_generation;
|
|
}
|
|
|
|
/// Return the modification hash for all libraries. The value returned
|
|
/// changes on every library modification.
|
|
int GetModifyHash();
|
|
|
|
/**
|
|
* Allocate and adds a part library to the library list.
|
|
*
|
|
* @param aFileName - File name object of part library.
|
|
* @throw IO_ERROR if there's any problem loading.
|
|
*/
|
|
PART_LIB* AddLibrary( const wxString& aFileName );
|
|
|
|
/**
|
|
* Insert a part library into the library list.
|
|
*
|
|
* @param aFileName - File name object of part library.
|
|
* @param aIterator - Iterator to insert library in front of.
|
|
* @return PART_LIB* - the new PART_LIB, which remains owned by this PART_LIBS container.
|
|
* @throw IO_ERROR if there's any problem loading.
|
|
*/
|
|
PART_LIB* AddLibrary( const wxString& aFileName, PART_LIBS::iterator& aIterator );
|
|
|
|
/**
|
|
* Load all of the project's libraries into this container, which should
|
|
* be cleared before calling it.
|
|
*
|
|
* @note This method is only to be used when loading legacy projects. All further symbol
|
|
* library access should be done via the symbol library table.
|
|
*/
|
|
void LoadAllLibraries( PROJECT* aProject, bool aShowProgress=true );
|
|
|
|
/**
|
|
* Save or load the names of the currently configured part libraries (without paths).
|
|
*/
|
|
static void LibNamesAndPaths( PROJECT* aProject, bool doSave,
|
|
wxString* aPaths, wxArrayString* aNames=NULL );
|
|
|
|
/**
|
|
* Return the name of the cache library after potentially fixing it from
|
|
* an older naming scheme. That is, the old file is renamed if needed.
|
|
*
|
|
* @param aFullProjectFilename - the *.pro filename with absolute path.
|
|
*/
|
|
static const wxString CacheName( const wxString& aFullProjectFilename );
|
|
|
|
/**
|
|
* Find a part library by \a aName.
|
|
*
|
|
* @param aName - Library file name without path or extension to find.
|
|
* @return Part library if found, otherwise NULL.
|
|
*/
|
|
PART_LIB* FindLibrary( const wxString& aName );
|
|
|
|
PART_LIB* FindLibraryByFullFileName( const wxString& aFullFileName );
|
|
|
|
PART_LIB* GetCacheLibrary();
|
|
|
|
/**
|
|
* Return the list of part library file names without path and extension.
|
|
*
|
|
* @param aSorted - Sort the list of name if true. Otherwise use the library load order.
|
|
* @return The list of library names.
|
|
*/
|
|
wxArrayString GetLibraryNames( bool aSorted = true );
|
|
|
|
/**
|
|
* Search all libraries in the list for a part.
|
|
*
|
|
* A part object will always be returned. If the entry found
|
|
* is an alias. The root part will be found and returned.
|
|
*
|
|
* @param aLibId - The #LIB_ID of the symbol to search for.
|
|
* @param aLibraryName - Name of the library to search for part.
|
|
* @return LIB_PART* - The part object if found, otherwise NULL.
|
|
*/
|
|
LIB_PART* FindLibPart( const LIB_ID& aLibId, const wxString& aLibraryName = wxEmptyString );
|
|
|
|
/**
|
|
* Search all libraries in the list for a #LIB_PART using a case insensitive comparison.
|
|
*
|
|
* Helper function used in dialog to find all candidates.
|
|
* During a long time, eeschema was using a case insensitive search.
|
|
* Therefore, for old schematics (<= 2013), or libs, for some components,
|
|
* the chip name (name of alias in lib) can be broken.
|
|
* This function can be used to display a list of candidates, in component properties dialog.
|
|
*
|
|
* @param aEntryName - Name of entries to search for (case insensitive).
|
|
* @param aLibraryName - Name of the library to search.
|
|
* @param aCandidates - a std::vector to store candidates
|
|
*/
|
|
void FindLibraryNearEntries( std::vector<LIB_PART*>& aCandidates, const wxString& aEntryName,
|
|
const wxString& aLibraryName = wxEmptyString );
|
|
|
|
int GetLibraryCount() { return size(); }
|
|
};
|
|
|
|
|
|
/**
|
|
* Object used to load, save, search, and otherwise manipulate symbol library files.
|
|
*
|
|
* @warning This code is obsolete with the exception of the cache library. All other
|
|
* symbol library I/O is managed by the #SCH_IO_MGR object.
|
|
*/
|
|
class PART_LIB
|
|
{
|
|
public:
|
|
PART_LIB( SCH_LIB_TYPE aType, const wxString& aFileName,
|
|
SCH_IO_MGR::SCH_FILE_T aPluginType = SCH_IO_MGR::SCH_LEGACY );
|
|
~PART_LIB();
|
|
|
|
/**
|
|
* @return a magic number that changes if the library has changed
|
|
*/
|
|
int GetModHash() const { return m_mod_hash; }
|
|
|
|
SCH_IO_MGR::SCH_FILE_T GetPluginType() const { return m_pluginType; }
|
|
|
|
void SetPluginType( SCH_IO_MGR::SCH_FILE_T aPluginType );
|
|
|
|
void Create( const wxString& aFileName = wxEmptyString );
|
|
|
|
void SetFileName( const wxString& aFileName ) { fileName = aFileName; }
|
|
|
|
bool IsModified() const
|
|
{
|
|
return isModified;
|
|
}
|
|
|
|
bool IsCache() const;
|
|
|
|
void SetCache();
|
|
|
|
bool IsBuffering() const;
|
|
|
|
void EnableBuffering( bool aEnable = true );
|
|
|
|
void Save( bool aSaveDocFile = true );
|
|
|
|
/**
|
|
* @return true if current user does not have write access to the library file.
|
|
*/
|
|
bool IsReadOnly() const { return !fileName.IsFileWritable(); }
|
|
|
|
/**
|
|
* Load a string array with the names of all the entries in this library.
|
|
*
|
|
* @param aNames - String array to place entry names into.
|
|
*/
|
|
void GetPartNames( wxArrayString& aNames ) const;
|
|
|
|
/**
|
|
* Load a vector with all the entries in this library.
|
|
*
|
|
* @param aParts - vector to receive the aliases.
|
|
*/
|
|
void GetParts( std::vector<LIB_PART*>& aPart) const;
|
|
|
|
/**
|
|
* Find #LIB_PART by \a aName.
|
|
*
|
|
* @param aName - Name of part, case sensitive.
|
|
* @return LIB_PART pointer part if found, else NULL.
|
|
*/
|
|
LIB_PART* FindPart( const wxString& aName ) const;
|
|
|
|
LIB_PART* FindPart( const LIB_ID& aLibId ) const;
|
|
|
|
/**
|
|
* Add \a aPart entry to library.
|
|
*
|
|
* @note A #LIB_PART can have an alias list so these alias will be added in library.
|
|
* and the any existing duplicate aliases will be removed from the library.
|
|
*
|
|
* @param aPart - Part to add, caller retains ownership, a clone is added.
|
|
*/
|
|
void AddPart( LIB_PART* aPart );
|
|
|
|
/**
|
|
* Safely remove \a aEntry from the library and return the next entry.
|
|
*
|
|
* The next entry returned depends on the entry being removed. If the entry being
|
|
* remove also removes the part, then the next entry from the list is returned.
|
|
* If the entry being used only removes an alias from a part, then the next alias
|
|
* of the part is returned.
|
|
*
|
|
* @param aEntry - Entry to remove from library.
|
|
* @return The next entry in the library or NULL if the library is empty.
|
|
*/
|
|
LIB_PART* RemovePart( LIB_PART* aEntry );
|
|
|
|
/**
|
|
* Replace an existing part entry in the library.
|
|
*
|
|
* Note a part can have an alias list,
|
|
* so these alias will be added in library (and previously existing alias removed)
|
|
* @param aOldPart - The part to replace.
|
|
* @param aNewPart - The new part.
|
|
*/
|
|
LIB_PART* ReplacePart( LIB_PART* aOldPart, LIB_PART* aNewPart );
|
|
|
|
/**
|
|
* Return the file name without path or extension.
|
|
*
|
|
* @return Name of library file.
|
|
*/
|
|
const wxString GetName() const { return fileName.GetName(); }
|
|
|
|
/**
|
|
* Return the full file library name with path and extension.
|
|
*
|
|
* @return wxString - Full library file name with path and extension.
|
|
*/
|
|
wxString GetFullFileName() const { return fileName.GetFullPath(); }
|
|
|
|
/**
|
|
* Return the logical name of the library.
|
|
*
|
|
* @return wxString - The logical name of this library.
|
|
*/
|
|
const wxString GetLogicalName() const
|
|
{
|
|
/* for now is the filename without path or extension.
|
|
|
|
Technically the library should not know its logical name!
|
|
This will eventually come out of a pair of lookup tables using a
|
|
reverse lookup using the full name or library pointer as a key.
|
|
Search will be by project lookup table and then user lookup table if
|
|
not found.
|
|
*/
|
|
return fileName.GetName();
|
|
}
|
|
|
|
|
|
/**
|
|
* Allocate and load a symbol library file.
|
|
*
|
|
* @param aFileName - File name of the part library to load.
|
|
* @return PART_LIB* - the allocated and loaded PART_LIB, which is owned by the caller.
|
|
* @throw IO_ERROR if there's any problem loading the library.
|
|
*/
|
|
static PART_LIB* LoadLibrary( const wxString& aFileName );
|
|
|
|
private:
|
|
SCH_LIB_TYPE type; ///< Library type indicator.
|
|
wxFileName fileName; ///< Library file name.
|
|
wxDateTime timeStamp; ///< Library save time and date.
|
|
int versionMajor; ///< Library major version number.
|
|
int versionMinor; ///< Library minor version number.
|
|
wxString header; ///< first line of loaded library.
|
|
bool isModified; ///< Library modification status.
|
|
int m_mod_hash; ///< incremented each time library is changed.
|
|
|
|
SCH_IO_MGR::SCH_FILE_T m_pluginType;
|
|
std::unique_ptr< SCH_PLUGIN > m_plugin;
|
|
std::unique_ptr< PROPERTIES > m_properties; ///< Library properties
|
|
};
|
|
|
|
|
|
/**
|
|
* Case insensitive library name comparison.
|
|
*/
|
|
bool operator==( const PART_LIB& aLibrary, const wxString& aName );
|
|
bool operator!=( const PART_LIB& aLibrary, const wxString& aName );
|
|
|
|
#endif // CLASS_LIBRARY_H
|