283 lines
8.8 KiB
C++
283 lines
8.8 KiB
C++
/***********************************/
|
|
/* Headers for library definition */
|
|
/***********************************/
|
|
|
|
#ifndef CLASS_LIBRARY_H
|
|
#define CLASS_LIBRARY_H
|
|
|
|
|
|
#include "class_libentry.h"
|
|
|
|
|
|
/**
|
|
* Component library object.
|
|
*
|
|
* Component libraries are used to load, save, search, and otherwise manipulate
|
|
* component library files.
|
|
*/
|
|
|
|
class LibraryStruct
|
|
{
|
|
public:
|
|
int m_Type; /* type indicator */
|
|
wxString m_Name; /* Library file name (without path). */
|
|
wxString m_FullFileName; /* Full File Name (with path) of library. */
|
|
wxString m_Header; /* first line of loaded library. */
|
|
LibraryStruct* m_Pnext; /* Point on next lib in chain. */
|
|
unsigned long m_TimeStamp; // Signature temporelle
|
|
int m_Flags; // variable used in some functions
|
|
bool m_IsLibCache; /* False for the "standard" libraries,
|
|
* True for the library cache */
|
|
|
|
public:
|
|
LibraryStruct( int type, const wxString& name, const wxString& fullname );
|
|
~LibraryStruct();
|
|
|
|
/**
|
|
* Save library to file.
|
|
*
|
|
* Two files are created. The component objects are save as component
|
|
* library (*.lib) files. The alias objects are save as document
|
|
* definition (*.dcm) files. If the component library already exists,
|
|
* it is backup up in file *.bak. If the document definition file
|
|
* already exists, it is backed up in file *.bck.
|
|
*
|
|
* @param aFullFileName - The library filename with path.
|
|
*
|
|
* @return bool - true if success writing else false.
|
|
*/
|
|
bool Save( const wxString& aFullFileName );
|
|
|
|
/**
|
|
* Load library from file.
|
|
*
|
|
* @param errMsg - Error message if load fails.
|
|
*
|
|
* @return bool - True if load was successful otherwise false.
|
|
*/
|
|
bool Load( wxString& errMsg );
|
|
|
|
bool LoadDocs( wxString& errMsg );
|
|
|
|
private:
|
|
bool SaveHeader( FILE* file );
|
|
|
|
bool LoadHeader( FILE* file, int* LineNum );
|
|
void LoadAliases( EDA_LibComponentStruct* component );
|
|
|
|
void RemoveEntry( const wxString& name );
|
|
|
|
public:
|
|
LibraryStruct( const wxChar* fileName = NULL );
|
|
|
|
/**
|
|
* Get library entry status.
|
|
*
|
|
* @return true if there are no entries in the library.
|
|
*/
|
|
bool IsEmpty()
|
|
{
|
|
return m_Entries.empty();
|
|
}
|
|
|
|
/**
|
|
* Get the number of entries in the library.
|
|
*
|
|
* @return The number of component and alias entries.
|
|
*/
|
|
int GetCount()
|
|
{
|
|
return m_Entries.size();
|
|
}
|
|
|
|
bool IsModified()
|
|
{
|
|
return m_IsModified;
|
|
}
|
|
|
|
/**
|
|
* Load a string array with the names of all the entries in this library.
|
|
*
|
|
* @param names - String array to place entry names into.
|
|
* @param sort - Sort names if true.
|
|
* @param makeUpperCase - Force entry names to upper case.
|
|
*/
|
|
void GetEntryNames( wxArrayString& names, bool sort = true,
|
|
bool makeUpperCase = true );
|
|
|
|
/**
|
|
* Load string array with entry names matching name and/or key word.
|
|
*
|
|
* This currently mimics the old behavior of calling KeyWordOk() and
|
|
* WildCompareString(). The names array will be populated with the
|
|
* library entry names that meat the search criteria on exit.
|
|
*
|
|
* @todo Convert the search functions to use regular expressions which
|
|
* should give better search capability.
|
|
*
|
|
* @param names - String array to place entry names into.
|
|
* @param nameSearch - Name wild card search criteria.
|
|
* @param keySearch - Key word search criteria.
|
|
* @param sort - Sort names if true.
|
|
*/
|
|
void SearchEntryNames( wxArrayString& names,
|
|
const wxString& nameSearch = wxEmptyString,
|
|
const wxString& keySearch = wxEmptyString,
|
|
bool sort = true );
|
|
|
|
/**
|
|
* Find entry by name.
|
|
*
|
|
* @param name - Name of entry, case insensitive.
|
|
*
|
|
* @return Pointer to entry if found. NULL if not found.
|
|
*/
|
|
LibCmpEntry* FindEntry( const wxChar* name );
|
|
|
|
/**
|
|
* Find entry by name and type.
|
|
*
|
|
* @param name - Name of entry, case insensitive.
|
|
* @param type - Type of entry, root or alias.
|
|
*
|
|
* @return Pointer to entry if found. NULL if not found.
|
|
*/
|
|
LibCmpEntry* FindEntry( const wxChar* name, LibrEntryType type );
|
|
|
|
/**
|
|
* Find component by name.
|
|
*
|
|
* This is a helper for FindEntry so casting a LibCmpEntry pointer to
|
|
* a EDA_LibComponentStruct pointer is not required.
|
|
*
|
|
* @param name - Name of component, case insensitive.
|
|
* @param searchAliases - Searches for component by alias name as well as
|
|
* component name if true.
|
|
*
|
|
* @return Pointer to component if found. NULL if not found.
|
|
*/
|
|
EDA_LibComponentStruct* FindComponent( const wxChar* name,
|
|
bool searchAliases = true );
|
|
|
|
/**
|
|
* Find alias by name.
|
|
*
|
|
* This is a helper for FindEntry so casting a LibCmpEntry pointer to
|
|
* a EDA_LibCmpAliasStruct pointer is not required.
|
|
*
|
|
* @param name - Name of alias, case insensitive.
|
|
*
|
|
* @return Pointer to alias if found. NULL if not found.
|
|
*/
|
|
EDA_LibCmpAliasStruct* FindAlias( const wxChar* name )
|
|
{
|
|
return (EDA_LibCmpAliasStruct*) FindEntry( name, ALIAS );
|
|
}
|
|
|
|
/**
|
|
* Add a new alias entry to the library.
|
|
*
|
|
* First check if a component or alias with the same name already exists
|
|
* in the library and add alias if no conflict occurs. Once the alias
|
|
* is added to the library it is owned by the library. Deleting the
|
|
* alias pointer will render the library unstable. Use RemoveEntry to
|
|
* remove the alias from the library.
|
|
*
|
|
* @param alias - Alias to add to library.
|
|
*
|
|
* @return bool - True if alias added to library. False if conflict
|
|
* exists.
|
|
*/
|
|
bool AddAlias( EDA_LibCmpAliasStruct* alias );
|
|
|
|
/**
|
|
* Add component entry to library.
|
|
*
|
|
* @param cmp - Component to add.
|
|
*
|
|
* @return Pointer to added component if successful.
|
|
*/
|
|
EDA_LibComponentStruct* AddComponent( EDA_LibComponentStruct* cmp );
|
|
|
|
/**
|
|
* Remove an entry from the library.
|
|
*
|
|
* If the entry is an alias, the alias is removed from the library and from
|
|
* the alias list of the root component. If the entry is a root component
|
|
* with no aliases, it is removed from the library. If the entry is a root
|
|
* component with aliases, the root component is renamed to the name of
|
|
* the first alias and the root name for all remaining aliases are updated
|
|
* to reflect the new root name.
|
|
*
|
|
* @param entry - Entry to remove from library.
|
|
*/
|
|
void RemoveEntry( LibCmpEntry* entry );
|
|
|
|
/**
|
|
* Replace an existing component entry in the library.
|
|
*
|
|
* @param oldComponent - The component to replace.
|
|
* @param newComponent - The new component.
|
|
*/
|
|
EDA_LibComponentStruct* ReplaceComponent(
|
|
EDA_LibComponentStruct* oldComponent,
|
|
EDA_LibComponentStruct* newComponent );
|
|
|
|
/**
|
|
* Return the first entry in the library.
|
|
*
|
|
* @return The first entry or NULL if the library has no entries.
|
|
*/
|
|
LibCmpEntry* GetFirstEntry()
|
|
{
|
|
return &m_Entries.front();
|
|
}
|
|
|
|
/**
|
|
* Find next library entry by name.
|
|
*
|
|
* If the name of the entry is the last entry in the library, the first
|
|
* entry in the list is returned.
|
|
*
|
|
* @param name - Name of current entry.
|
|
*
|
|
* @return LibCmpEntry - Pointer to next entry if entry name is found.
|
|
* Otherwise NULL.
|
|
*/
|
|
LibCmpEntry* GetNextEntry( const wxChar* name );
|
|
|
|
|
|
/**
|
|
* Find previous library entry by name.
|
|
*
|
|
* If the name of the entry is the first entry in the library, the last
|
|
* entry in the list is returned.
|
|
*
|
|
* @param name - Name of current entry.
|
|
*
|
|
* @return LibCmpEntry - Pointer to previous entry if entry name is found.
|
|
* Otherwise NULL.
|
|
*/
|
|
LibCmpEntry* GetPreviousEntry( const wxChar* name );
|
|
|
|
wxString GetName();
|
|
|
|
protected:
|
|
wxFileName m_fileName; /* Library file name. */
|
|
wxDateTime m_DateTime; /* Library save time and date. */
|
|
wxString m_Version; /* Library save version. */
|
|
LIB_ENTRY_LIST m_Entries; /* Parts themselves are saved here. */
|
|
bool m_IsModified; /* Library modification status. */
|
|
|
|
friend class EDA_LibComponentStruct;
|
|
};
|
|
|
|
|
|
/**
|
|
* Case insensitive library name comparison.
|
|
*/
|
|
extern bool operator==( const LibraryStruct& lib, const wxChar* name );
|
|
extern bool operator!=( const LibraryStruct& lib, const wxChar* name );
|
|
|
|
#endif // CLASS_LIBRARY_H
|