footprint_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) 2011 Jean-Pierre Charras, <jp.charras@wanadoo.fr>
 * Copyright (C) 1992-2020 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 footprint_info.h
 */

#ifndef FOOTPRINT_INFO_H_
#define FOOTPRINT_INFO_H_


#include <boost/ptr_container/ptr_vector.hpp>
#include <import_export.h>
#include <ki_exception.h>
#include <sync_queue.h>
#include <lib_tree_item.h>
#include <atomic>
#include <functional>
#include <memory>


class FP_LIB_TABLE;
class FOOTPRINT_LIST;
class FOOTPRINT_LIST_IMPL;
class FOOTPRINT_ASYNC_LOADER;
class PROGRESS_REPORTER;
class wxTopLevelWindow;
class KIWAY;
class wxTextFile;


/*
 * Helper class to handle the list of footprints available in libraries. It stores
 * footprint names, doc and keywords.
 *
 * This is a virtual class; its implementation lives in pcbnew/footprint_info_impl.cpp.
 * To get instances of these classes, see FOOTPRINT_LIST::GetInstance().
 */
class APIEXPORT FOOTPRINT_INFO : public LIB_TREE_ITEM
{
public:
    virtual ~FOOTPRINT_INFO()
    {
    }

    // These two accessors do not have to call ensure_loaded(), because constructor
    // fills in these fields:

    const wxString& GetFootprintName() const { return m_fpname; }

    wxString GetLibNickname() const override { return m_nickname; }

    wxString GetName() const override { return m_fpname; }

    LIB_ID GetLibId() const override
    {
        return LIB_ID( m_nickname, m_fpname );
    }

    wxString GetDescription() override
    {
        ensure_loaded();
        return m_doc;
    }

    wxString GetKeywords()
    {
        ensure_loaded();
        return m_keywords;
    }

    wxString GetSearchText() override
    {
        // Matches are scored by offset from front of string, so inclusion of this spacer
        // discounts matches found after it.
        static const wxString discount( wxT( "        " ) );

        return GetKeywords() + discount + GetDescription();
    }

    unsigned GetPadCount()
    {
        ensure_loaded();
        return m_pad_count;
    }

    unsigned GetUniquePadCount()
    {
        ensure_loaded();
        return m_unique_pad_count;
    }

    int GetOrderNum()
    {
        ensure_loaded();
        return m_num;
    }

    bool InLibrary( const wxString& aLibrary ) const;

    friend bool operator<( const FOOTPRINT_INFO& lhs, const FOOTPRINT_INFO& rhs );

private:
    friend bool operator<( const FOOTPRINT_INFO& item1, const FOOTPRINT_INFO& item2 );

protected:
    void ensure_loaded()
    {
        if( !m_loaded )
            load();
    }

    virtual void load() { };

    FOOTPRINT_LIST* m_owner; 

    bool            m_loaded;

    wxString        m_nickname;         
    wxString        m_fpname;           
    int             m_num;              
    unsigned        m_pad_count;        
    unsigned        m_unique_pad_count; 
    wxString        m_doc;              
    wxString        m_keywords;         
};


class APIEXPORT FOOTPRINT_LIST
{
public:
    typedef std::vector<std::unique_ptr<FOOTPRINT_INFO>> FPILIST;
    typedef SYNC_QUEUE<std::unique_ptr<IO_ERROR>>        ERRLIST;

    FOOTPRINT_LIST() : m_lib_table( 0 )
    {
    }

    virtual ~FOOTPRINT_LIST()
    {
    }

    virtual void WriteCacheToFile( const wxString& aFilePath ) {};
    virtual void ReadCacheFromFile( const wxString& aFilePath ){};

    unsigned GetCount() const
    {
        return m_list.size();
    }

    const FPILIST& GetList() const
    {
        return m_list;
    }

    void Clear()
    {
        m_list.clear();
    }

    FOOTPRINT_INFO* GetFootprintInfo( const wxString& aFootprintName );

    FOOTPRINT_INFO* GetFootprintInfo( const wxString& aLibNickname,
                                      const wxString& aFootprintName );

    FOOTPRINT_INFO& GetItem( unsigned aIdx )
    {
        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 ReadFootprintFiles( FP_LIB_TABLE* aTable, const wxString* aNickname = nullptr,
                                     PROGRESS_REPORTER* aProgressReporter = nullptr ) = 0;

    void DisplayErrors( wxTopLevelWindow* aCaller = NULL );

    FP_LIB_TABLE* GetTable() const
    {
        return m_lib_table;
    }

    static FOOTPRINT_LIST* GetInstance( KIWAY& aKiway );

protected:
    virtual void startWorkers( FP_LIB_TABLE* aTable, wxString const* aNickname,
                               FOOTPRINT_ASYNC_LOADER* aLoader, unsigned aNThreads ) = 0;

    virtual bool joinWorkers() = 0;

    virtual void stopWorkers() = 0;

private:
    friend class FOOTPRINT_ASYNC_LOADER;

protected:
    FP_LIB_TABLE* m_lib_table; 

    FPILIST m_list;
    ERRLIST m_errors; 
};


class APIEXPORT FOOTPRINT_ASYNC_LOADER
{
public:
    FOOTPRINT_ASYNC_LOADER();

    ~FOOTPRINT_ASYNC_LOADER();

    void SetList( FOOTPRINT_LIST* aList );

    void Start( FP_LIB_TABLE* aTable, wxString const* aNickname = nullptr,
                unsigned aNThreads = DEFAULT_THREADS );

    bool Join();

    void Abort();

private:
    static constexpr unsigned DEFAULT_THREADS = 6;

    friend class FOOTPRINT_LIST;
    friend class FOOTPRINT_LIST_IMPL;

    FOOTPRINT_LIST*  m_list;
    std::string      m_last_table;

    int              m_total_libs;
};


#endif // FOOTPRINT_INFO_H_