symbol_lib_table.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2016 Wayne Stambaugh <[email protected]>
 * Copyright (C) 2016-2023 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_LIB_TABLE_H_
#define _SYMBOL_LIB_TABLE_H_
 
#include <lib_table_base.h>
#include <sch_io/sch_io.h>
#include <sch_io/sch_io_mgr.h>
#include <lib_id.h>
 
//class LIB_SYMBOL;
class SYMBOL_LIB_TABLE_GRID;
class DIALOG_SYMBOL_LIB_TABLE;
 
 
class SYMBOL_LIB_TABLE_ROW : public LIB_TABLE_ROW
{
public:
    typedef SCH_IO_MGR::SCH_FILE_T LIB_T;
 
    SYMBOL_LIB_TABLE_ROW( const wxString& aNick, const wxString& aURI, const wxString& aType,
                          const wxString& aOptions = wxEmptyString,
                          const wxString& aDescr = wxEmptyString ) :
        LIB_TABLE_ROW( aNick, aURI, aOptions, aDescr )
    {
        SetType( aType );
        SetEnabled( true );
    }
 
    SYMBOL_LIB_TABLE_ROW() :
        type( SCH_IO_MGR::SCH_KICAD )
    {
        SetEnabled( true );
    }
 
    bool operator==( const SYMBOL_LIB_TABLE_ROW& aRow ) const;
 
    bool operator!=( const SYMBOL_LIB_TABLE_ROW& aRow ) const   { return !( *this == aRow ); }
 
    LIB_T SchLibType() const { return type; }
 
    const wxString GetType() const override         { return SCH_IO_MGR::ShowType( type ); }
 
    void SetType( const wxString& aType ) override;
 
    bool Refresh() override;
 
    bool SupportsSubLibraries() const { return plugin ? plugin->SupportsSubLibraries() : false; }
 
    bool SupportsSettingsDialog() const override
    {
        // Only database libraries have dialog-configurable options at the moment
        return type == SCH_IO_MGR::SCH_FILE_T::SCH_DATABASE;
    }
 
    void ShowSettingsDialog( wxWindow* aWindow ) const override;
 
    void GetSubLibraryNames( std::vector<wxString>& aNames ) const;
 
    wxString GetSubLibraryDescription( const wxString& aName ) const;
 
    void GetAvailableSymbolFields( std::vector<wxString>& aNames ) const
    {
        if( plugin )
            plugin->GetAvailableSymbolFields( aNames );
    }
 
    void GetDefaultSymbolFields( std::vector<wxString>& aNames ) const
    {
        if( plugin )
            plugin->GetDefaultSymbolFields( aNames );
    }
 
    SCH_IO_MGR::SCH_FILE_T GetFileType() { return type; }
 
protected:
    SYMBOL_LIB_TABLE_ROW( const SYMBOL_LIB_TABLE_ROW& aRow ) :
        LIB_TABLE_ROW( aRow ),
        type( aRow.type )
    {
        SetEnabled( aRow.GetIsEnabled() );
    }
 
private:
    friend class SYMBOL_LIB_TABLE;
 
    virtual LIB_TABLE_ROW* do_clone() const override
    {
        return new SYMBOL_LIB_TABLE_ROW( *this );
    }
 
    void setPlugin( SCH_IO* aPlugin )
    {
        plugin.reset( aPlugin );
    }
 
    IO_RELEASER<SCH_IO> plugin;
    LIB_T               type;
};
 
 
class SYMBOL_LIB_TABLE : public LIB_TABLE
{
public:
    PROJECT::ELEM ProjectElementType() override { return PROJECT::ELEM::SYMBOL_LIB_TABLE; }
 
    static const char* PropPowerSymsOnly;
    static const char* PropNonPowerSymsOnly;
 
    virtual void Parse( LIB_TABLE_LEXER* aLexer ) override;
 
    virtual void Format( OUTPUTFORMATTER* aOutput, int aIndentLevel ) const override;
 
    SYMBOL_LIB_TABLE( SYMBOL_LIB_TABLE* aFallBackTable = nullptr );
 
    SYMBOL_LIB_TABLE_ROW* FindRow( const wxString& aNickName, bool aCheckIfEnabled = false );
 
    int GetModifyHash();
 
    //-----<PLUGIN API SUBSET, REBASED ON aNickname>---------------------------
 
    void EnumerateSymbolLib( const wxString& aNickname, wxArrayString& aAliasNames,
                             bool aPowerSymbolsOnly = false );
 
    void LoadSymbolLib( std::vector<LIB_SYMBOL*>& aAliasList, const wxString& aNickname,
                        bool aPowerSymbolsOnly = false );
 
    LIB_SYMBOL* LoadSymbol( const wxString& aNickname, const wxString& aName );
 
    LIB_SYMBOL* LoadSymbol( const LIB_ID& aLibId )
    {
        return LoadSymbol( aLibId.GetLibNickname(), aLibId.GetLibItemName() );
    }
 
    enum SAVE_T
    {
        SAVE_OK,
        SAVE_SKIPPED,
    };
 
    SAVE_T SaveSymbol( const wxString& aNickname, const LIB_SYMBOL* aSymbol,
                       bool aOverwrite = true );
 
    void DeleteSymbol( const wxString& aNickname, const wxString& aSymbolName );
 
    bool IsSymbolLibWritable( const wxString& aNickname );
 
    bool IsSymbolLibLoaded( const wxString& aNickname );
 
    void DeleteSymbolLib( const wxString& aNickname );
 
    void CreateSymbolLib( const wxString& aNickname );
 
    //-----</PLUGIN API SUBSET, REBASED ON aNickname>---------------------------
 
    LIB_SYMBOL* LoadSymbolWithOptionalNickname( const LIB_ID& aId );
 
    static bool LoadGlobalTable( SYMBOL_LIB_TABLE& aTable );
 
    static wxString GetGlobalTableFileName();
 
    static const wxString GlobalPathEnvVariableName();
 
    static SYMBOL_LIB_TABLE& GetGlobalLibTable();
 
    static const wxString& GetSymbolLibTableFileName();
 
    bool operator==( const SYMBOL_LIB_TABLE& aOther ) const;
 
    bool operator!=( const SYMBOL_LIB_TABLE& aOther ) const { return !( *this == aOther ); }
 
 
private:
    friend class SYMBOL_LIB_TABLE_GRID;
    friend class PANEL_SYM_LIB_TABLE;
 
    static int m_modifyHash;     
};
 
 
#endif  // _SYMBOL_LIB_TABLE_H_