design_block_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) 2012-2024 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 DESIGN_BLOCK_LIB_TABLE_H_
#define DESIGN_BLOCK_LIB_TABLE_H_
 
#include <kicommon.h>
#include <lib_table_base.h>
#include <design_block_io.h>
#include <design_block_info_impl.h>
 
class DESIGN_BLOCK;
class DESIGN_BLOCK_LIB_TABLE_GRID;
 
class KICOMMON_API DESIGN_BLOCK_LIB_TABLE_ROW : public LIB_TABLE_ROW
{
public:
    DESIGN_BLOCK_LIB_TABLE_ROW( const wxString& aNick, const wxString& aURI, const wxString& aType,
                                const wxString& aOptions, const wxString& aDescr = wxEmptyString ) :
            LIB_TABLE_ROW( aNick, aURI, aOptions, aDescr )
    {
        SetType( aType );
    }
 
    DESIGN_BLOCK_LIB_TABLE_ROW() : type( DESIGN_BLOCK_IO_MGR::KICAD_SEXP ) {}
 
    bool operator==( const DESIGN_BLOCK_LIB_TABLE_ROW& aRow ) const;
 
    bool operator!=( const DESIGN_BLOCK_LIB_TABLE_ROW& aRow ) const { return !( *this == aRow ); }
 
    const wxString GetType() const override { return DESIGN_BLOCK_IO_MGR::ShowType( type ); }
 
    void SetType( const wxString& aType ) override;
 
    DESIGN_BLOCK_IO_MGR::DESIGN_BLOCK_FILE_T GetFileType() { return type; }
 
protected:
    DESIGN_BLOCK_LIB_TABLE_ROW( const DESIGN_BLOCK_LIB_TABLE_ROW& aRow ) :
            LIB_TABLE_ROW( aRow ), type( aRow.type )
    {
    }
 
private:
    virtual LIB_TABLE_ROW* do_clone() const override
    {
        return new DESIGN_BLOCK_LIB_TABLE_ROW( *this );
    }
 
    void setPlugin( DESIGN_BLOCK_IO* aPlugin ) { plugin.reset( aPlugin ); }
 
    friend class DESIGN_BLOCK_LIB_TABLE;
 
private:
    IO_RELEASER<DESIGN_BLOCK_IO>             plugin;
    DESIGN_BLOCK_IO_MGR::DESIGN_BLOCK_FILE_T type;
};
 
 
class KICOMMON_API DESIGN_BLOCK_LIB_TABLE : public LIB_TABLE
{
public:
    PROJECT::ELEM ProjectElementType() override { return PROJECT::ELEM::DESIGN_BLOCK_LIB_TABLE; }
 
    virtual void Parse( LIB_TABLE_LEXER* aLexer ) override;
 
    virtual void Format( OUTPUTFORMATTER* aOutput, int aIndentLevel ) const override;
 
    DESIGN_BLOCK_LIB_TABLE( DESIGN_BLOCK_LIB_TABLE* aFallBackTable = nullptr );
 
    bool operator==( const DESIGN_BLOCK_LIB_TABLE& aFpTable ) const;
 
    bool operator!=( const DESIGN_BLOCK_LIB_TABLE& r ) const { return !( *this == r ); }
 
    const DESIGN_BLOCK_LIB_TABLE_ROW* FindRow( const wxString& aNickName,
                                               bool            aCheckIfEnabled = false );
 
    void DesignBlockEnumerate( wxArrayString& aDesignBlockNames, const wxString& aNickname,
                               bool aBestEfforts );
 
    long long GenerateTimestamp( const wxString* aNickname );
 
    void PrefetchLib( const wxString& aNickname );
 
    DESIGN_BLOCK* DesignBlockLoad( const wxString& aNickname, const wxString& aDesignBlockName,
                                   bool aKeepUUID = false );
 
    bool DesignBlockExists( const wxString& aNickname, const wxString& aDesignBlockName );
 
    const DESIGN_BLOCK* GetEnumeratedDesignBlock( const wxString& aNickname,
                                                  const wxString& aDesignBlockName );
    enum SAVE_T
    {
        SAVE_OK,
        SAVE_SKIPPED,
    };
 
    SAVE_T DesignBlockSave( const wxString& aNickname, const DESIGN_BLOCK* aDesignBlock,
                            bool aOverwrite = true );
 
    void DesignBlockDelete( const wxString& aNickname, const wxString& aDesignBlockName );
 
    bool IsDesignBlockLibWritable( const wxString& aNickname );
 
    void DesignBlockLibDelete( const wxString& aNickname );
 
    void DesignBlockLibCreate( const wxString& aNickname );
 
    DESIGN_BLOCK* DesignBlockLoadWithOptionalNickname( const LIB_ID& aDesignBlockId,
                                                       bool          aKeepUUID = false );
 
    static bool LoadGlobalTable( DESIGN_BLOCK_LIB_TABLE& aTable );
 
    static DESIGN_BLOCK_LIB_TABLE& GetGlobalLibTable();
 
    static DESIGN_BLOCK_LIST_IMPL& GetGlobalList();
 
    static wxString GetGlobalTableFileName();
 
    static const wxString GlobalPathEnvVariableName();
 
private:
    friend class DESIGN_BLOCK_LIB_TABLE_GRID;
};
 
#endif // DESIGN_BLOCK_LIB_TABLE_H_