symbol_library.h

Go to the documentation of this file.

/*
 * 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 <[email protected]>
 * Copyright (C) 2004-2022 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
 */
 
#ifndef SYMBOL_LIBRARY_H
#define SYMBOL_LIBRARY_H
 
#include <mutex>
#include <boost/ptr_container/ptr_vector.hpp>
#include <wx/filename.h>
 
#include <project.h>
#include <sch_io/sch_io_mgr.h>
#include <symbol_library_common.h>
 
 
class LIB_SYMBOL;
class LIB_ID;
class LINE_READER;
class OUTPUTFORMATTER;
class SCH_IO;
class SYMBOL_LIB;
 
 
/* Helpers for creating a list of symbol libraries. */
typedef boost::ptr_vector< SYMBOL_LIB >                     SYMBOL_LIBS_BASE;
 
 
class SYMBOL_LIBS : public SYMBOL_LIBS_BASE, public PROJECT::_ELEM
{
public:
    PROJECT::ELEM ProjectElementType() override { return PROJECT::ELEM::SCH_SYMBOL_LIBS; }
 
    SYMBOL_LIBS() {}
 
    SYMBOL_LIB* AddLibrary( const wxString& aFileName );
 
    SYMBOL_LIB* AddLibrary( const wxString& aFileName, SYMBOL_LIBS::iterator& aIterator );
 
    bool ReloadLibrary( const wxString& aFileName );
 
    void LoadAllLibraries( PROJECT* aProject, bool aShowProgress=true );
 
    static void GetLibNamesAndPaths( PROJECT* aProject, wxString* aPaths,
                                     wxArrayString* aNames = nullptr );
 
    static void SetLibNamesAndPaths( PROJECT* aProject, const wxString& aPaths,
                                     const wxArrayString& aNames );
 
    static const wxString CacheName( const wxString& aFullProjectFilename );
 
    SYMBOL_LIB* FindLibrary( const wxString& aName );
 
    SYMBOL_LIB* FindLibraryByFullFileName( const wxString& aFullFileName );
 
    SYMBOL_LIB* GetCacheLibrary();
 
    wxArrayString GetLibraryNames( bool aSorted = true );
 
    LIB_SYMBOL* FindLibSymbol( const LIB_ID& aLibId, const wxString& aLibraryName = wxEmptyString );
 
    void FindLibraryNearEntries( std::vector<LIB_SYMBOL*>& aCandidates, const wxString& aEntryName,
                                 const wxString& aLibraryName = wxEmptyString );
 
    int GetLibraryCount() { return size(); }
};
 
 
class SYMBOL_LIB
{
public:
    SYMBOL_LIB( SCH_LIB_TYPE aType, const wxString& aFileName,
                SCH_IO_MGR::SCH_FILE_T aPluginType = SCH_IO_MGR::SCH_LEGACY );
    ~SYMBOL_LIB();
 
    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 );
 
    bool IsReadOnly() const { return !fileName.IsFileWritable(); }
 
    void GetSymbolNames( wxArrayString& aNames ) const;
 
    void GetSymbols( std::vector<LIB_SYMBOL*>& aSymbols ) const;
 
    LIB_SYMBOL* FindSymbol( const wxString& aName ) const;
 
    LIB_SYMBOL* FindSymbol( const LIB_ID& aLibId ) const;
 
    void AddSymbol( LIB_SYMBOL* aSymbol );
 
    LIB_SYMBOL* RemoveSymbol( LIB_SYMBOL* aEntry );
 
    LIB_SYMBOL* ReplaceSymbol( LIB_SYMBOL* aOldSymbol, LIB_SYMBOL* aNewSymbol );
 
    const wxString GetName() const            { return fileName.GetName(); }
 
    wxString GetFullFileName() const          { return fileName.GetFullPath(); }
 
    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();
    }
 
    static SYMBOL_LIB* LoadSymbolLibrary( const wxString& aFileName );
 
private:
    SCH_LIB_TYPE    type;           
    wxFileName      fileName;       
    wxDateTime      timeStamp;      
    int             versionMajor;   
    int             versionMinor;   
    wxString        header;         
    bool            isModified;     
    int             m_mod_hash;     
 
    SCH_IO_MGR::SCH_FILE_T        m_pluginType;
    std::unique_ptr< SCH_IO > m_plugin;
    std::unique_ptr<std::map<std::string, UTF8>> m_properties;   
};
 
 
bool operator==( const SYMBOL_LIB& aLibrary, const wxString& aName );
bool operator!=( const SYMBOL_LIB& aLibrary, const wxString& aName );
 
#endif  //  SYMBOL_LIBRARY_H