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 <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
 */

#ifndef SYMBOL_LIBRARY_H
#define SYMBOL_LIBRARY_H

#include <map>
#include <mutex>
#include <boost/ptr_container/ptr_vector.hpp>
#include <wx/filename.h>

#include <sch_io_mgr.h>
#include <project.h>

class LIB_SYMBOL;
class LIB_ID;
class LINE_READER;
class OUTPUTFORMATTER;
class SCH_LEGACY_PLUGIN;
class SCH_PLUGIN;


#define DOC_EXT           "dcm"

/*
 * Symbol Library version and file header  macros.
 */
#define LIB_VERSION_MAJOR 2
#define LIB_VERSION_MINOR 4

/* Must be the first line of symbol 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.  Symbol 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 SYMBOL_LIB
// in dialogs
class SCHLIB_FILTER
{
public:
    SCHLIB_FILTER()
    {
        m_filterPowerSymbols = false;
        m_forceLoad = false;
    }

    void AddLib( const wxString& aLibName )
    {
        m_allowedLibs.Add( aLibName );
        m_forceLoad = false;
    }


    void LoadFrom( const wxString& aLibName )
    {
        m_allowedLibs.Clear();
        m_allowedLibs.Add( aLibName );
        m_forceLoad = true;
    }

    void ClearLibList()
    {
        m_allowedLibs.Clear();
        m_forceLoad = false;
    }

    void FilterPowerSymbols( bool aFilterEnable )
    {
        m_filterPowerSymbols = aFilterEnable;
    }

    // Accessors

    bool GetFilterPowerSymbols() const { return m_filterPowerSymbols; }


    const wxArrayString& GetAllowedLibList() const { return m_allowedLibs; }

    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;        
    bool          m_filterPowerSymbols; 
    bool          m_forceLoad;          // When true, load a symbol lib from the lib
                                        // which is given in m_allowedLibs[0]
};


/* Helpers for creating a list of symbol libraries. */
class SYMBOL_LIB;
class wxRegEx;

struct LibSymbolMapSort
{
    bool operator() ( const wxString& aItem1, const wxString& aItem2 ) const
    {
        return aItem1 < aItem2;
    }
};


typedef std::map< wxString, LIB_SYMBOL*, LibSymbolMapSort > LIB_SYMBOL_MAP;
typedef boost::ptr_vector< SYMBOL_LIB >                     SYMBOL_LIBS_BASE;


class SYMBOL_LIBS : public SYMBOL_LIBS_BASE, public PROJECT::_ELEM
{
public:
    KICAD_T Type() override { return SYMBOL_LIBS_T; }

    static int        s_modify_generation;         
    static std::mutex s_generationMutex;

    SYMBOL_LIBS()
    {
        IncrementModifyGeneration();
    }

    static void IncrementModifyGeneration()
    {
        std::lock_guard<std::mutex> mut( SYMBOL_LIBS::s_generationMutex );
        ++SYMBOL_LIBS::s_modify_generation;
    }

    static int GetModifyGeneration()
    {
        std::lock_guard<std::mutex> mut( SYMBOL_LIBS::s_generationMutex );
        return SYMBOL_LIBS::s_modify_generation;
    }

    int GetModifyHash();

    SYMBOL_LIB* AddLibrary( const wxString& aFileName );

    SYMBOL_LIB* AddLibrary( const wxString& aFileName, SYMBOL_LIBS::iterator& aIterator );

    void LoadAllLibraries( PROJECT* aProject, bool aShowProgress=true );

    static void LibNamesAndPaths( PROJECT* aProject, bool doSave,
                                  wxString* aPaths, wxArrayString* aNames = nullptr );

    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* LoadLibrary( 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_PLUGIN > m_plugin;
    std::unique_ptr< PROPERTIES > m_properties;   
};


bool operator==( const SYMBOL_LIB& aLibrary, const wxString& aName );
bool operator!=( const SYMBOL_LIB& aLibrary, const wxString& aName );

#endif  //  SYMBOL_LIBRARY_H