design_block_info.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 1992-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
 */
 
/*
 * @file design_block_info.h
 */
 
#ifndef DESIGN_BLOCK_INFO_H_
#define DESIGN_BLOCK_INFO_H_
 
 
#include <kicommon.h>
#include <boost/ptr_container/ptr_vector.hpp>
#include <import_export.h>
#include <ki_exception.h>
#include <core/sync_queue.h>
#include <lib_tree_item.h>
#include <atomic>
#include <functional>
#include <memory>
 
 
class DESIGN_BLOCK_LIB_TABLE;
class DESIGN_BLOCK_LIST;
class DESIGN_BLOCK_LIST_IMPL;
class PROGRESS_REPORTER;
class wxTopLevelWindow;
class KIWAY;
class wxTextFile;
 
 
/*
 * Helper class to handle the list of design blocks available in libraries. It stores
 * design block names, doc and keywords.
 *
 * This is a virtual class; its implementation lives in common/design_block_info_impl.cpp.
 * To get instances of these classes, see DESIGN_BLOCK_LIST::GetInstance().
 */
class KICOMMON_API DESIGN_BLOCK_INFO : public LIB_TREE_ITEM
{
public:
    virtual ~DESIGN_BLOCK_INFO() {}
 
    // These two accessors do not have to call ensure_loaded(), because constructor
    // fills in these fields:
 
    const wxString& GetDesignBlockName() const { return m_dbname; }
 
    wxString GetLibNickname() const override { return m_nickname; }
 
    wxString GetName() const override { return m_dbname; }
 
    LIB_ID GetLIB_ID() const override { return LIB_ID( m_nickname, m_dbname ); }
 
    wxString GetDesc() override
    {
        ensure_loaded();
        return m_doc;
    }
 
    void SetDesc( const wxString& aDesc ) { m_doc = aDesc; }
 
    wxString GetKeywords()
    {
        ensure_loaded();
        return m_keywords;
    }
 
    std::vector<SEARCH_TERM> GetSearchTerms() override;
 
    int GetOrderNum()
    {
        ensure_loaded();
        return m_num;
    }
 
    bool InLibrary( const wxString& aLibrary ) const;
 
    friend bool operator<( const DESIGN_BLOCK_INFO& lhs, const DESIGN_BLOCK_INFO& rhs );
 
protected:
    void ensure_loaded()
    {
        if( !m_loaded )
            load();
    }
 
    virtual void load(){};
 
    DESIGN_BLOCK_LIST* m_owner; 
 
    bool m_loaded;
 
    wxString m_nickname; 
    wxString m_dbname;   
    int      m_num;      
    wxString m_doc;      
    wxString m_keywords; 
};
 
 
class KICOMMON_API DESIGN_BLOCK_LIST
{
public:
    typedef std::vector<std::unique_ptr<DESIGN_BLOCK_INFO>> DBILIST;
    typedef SYNC_QUEUE<std::unique_ptr<IO_ERROR>>           ERRLIST;
 
    DESIGN_BLOCK_LIST() : m_lib_table( nullptr ) {}
 
    virtual ~DESIGN_BLOCK_LIST() {}
 
    unsigned GetCount() const { return m_list.size(); }
 
    const DBILIST& GetList() const { return m_list; }
 
    void Clear() { m_list.clear(); }
 
    DESIGN_BLOCK_INFO* GetDesignBlockInfo( const wxString& aDesignBlockName );
 
    DESIGN_BLOCK_INFO* GetDesignBlockInfo( const wxString& aLibNickname,
                                           const wxString& aDesignBlockName );
 
    DESIGN_BLOCK_INFO& GetItem( unsigned aIdx ) const { return *m_list[aIdx]; }
 
    unsigned GetErrorCount() const { return m_errors.size(); }
 
    std::unique_ptr<IO_ERROR> PopError()
    {
        std::unique_ptr<IO_ERROR> error;
 
        m_errors.pop( error );
        return error;
    }
 
    virtual bool ReadDesignBlockFiles( DESIGN_BLOCK_LIB_TABLE* aTable,
                                       const wxString*         aNickname = nullptr,
                                       PROGRESS_REPORTER*      aProgressReporter = nullptr ) = 0;
 
    DESIGN_BLOCK_LIB_TABLE* GetTable() const { return m_lib_table; }
 
protected:
    DESIGN_BLOCK_LIB_TABLE* m_lib_table = nullptr; 
 
    DBILIST m_list;
    ERRLIST m_errors; 
};
 
#endif // DESIGN_BLOCK_INFO_H_