lib_tree_model_adapter.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2017 Chris Pavlina <pavlina.chris@gmail.com>
 * Copyright (C) 2014 Henner Zeller <h.zeller@acm.org>
 * Copyright (C) 2014-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 3 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, see <http://www.gnu.org/licenses/>.
 */

#ifndef LIB_TREE_MODEL_ADAPTER_H
#define LIB_TREE_MODEL_ADAPTER_H

#include <lib_id.h>
#include <lib_tree_model.h>
#include <wx/hashmap.h>
#include <wx/dataview.h>
#include <wx/headerctrl.h>
#include <vector>
#include <functional>
#include <set>

class APP_SETTINGS_BASE;
class TOOL_INTERACTIVE;
class EDA_BASE_FRAME;


class LIB_TREE_MODEL_ADAPTER: public wxDataViewModel
{
public:
    ~LIB_TREE_MODEL_ADAPTER();

    enum SYM_FILTER_TYPE
    {
        SYM_FILTER_NONE,        
        SYM_FILTER_POWER,       
    };

    enum TREE_COLS
    {
        PART_COL = 0,   
        DESC_COL,       
        NUM_COLS        
    };

    void SaveColWidths();
    void SavePinnedItems();

    void SetFilter( SYM_FILTER_TYPE aFilter );

    SYM_FILTER_TYPE GetFilter() const { return m_filter; }

    void ShowUnits( bool aShow );

    void SetPreselectNode( const LIB_ID& aLibId, int aUnit );

    void DoAddLibrary( const wxString& aNodeName, const wxString& aDesc,
                       const std::vector<LIB_TREE_ITEM*>& aItemList, bool presorted );


    void AssignIntrinsicRanks() { m_tree.AssignIntrinsicRanks(); }

    void UpdateSearchString( const wxString& aSearch, bool aState );

    void AttachTo( wxDataViewCtrl* aDataViewCtrl );

    void FinishTreeInitialization();

    LIB_ID GetAliasFor( const wxDataViewItem& aSelection ) const;

    int GetUnitFor( const wxDataViewItem& aSelection ) const;

    LIB_TREE_NODE::TYPE GetTypeFor( const wxDataViewItem& aSelection ) const;

    LIB_TREE_NODE* GetTreeNodeFor( const wxDataViewItem& aSelection ) const;

    virtual wxString GenerateInfo( const LIB_ID& aLibId, int aUnit ) { return wxEmptyString; };

    int GetItemCount() const;

    virtual int GetLibrariesCount() const
    {
        return m_tree.m_Children.size();
    }

    wxDataViewItem FindItem( const LIB_ID& aLibId );

    unsigned int GetChildren( const wxDataViewItem& aItem,
                              wxDataViewItemArray& aChildren ) const override;

    // Freezing/Thawing.  Used when updating the table model so that we don't try and fetch
    // values during updating.  Primarily a problem on OSX which doesn't pay attention to the
    // wxDataViewCtrl's freeze count when updating the keyWindow.
    void Freeze() { m_freeze++; }
    void Thaw() { m_freeze--; }
    bool IsFrozen() const { return m_freeze; }

    void RefreshTree();

    // Allows subclasses to nominate a context menu handler.
    virtual TOOL_INTERACTIVE* GetContextMenuTool() { return nullptr; }

protected:
    static wxDataViewItem ToItem( const LIB_TREE_NODE* aNode );

    static LIB_TREE_NODE* ToNode( wxDataViewItem aItem );

    static unsigned int IntoArray( const LIB_TREE_NODE& aNode, wxDataViewItemArray& aChildren );

    LIB_TREE_MODEL_ADAPTER( EDA_BASE_FRAME* aParent, const wxString& aPinnedKey );

    LIB_TREE_NODE_LIB& DoAddLibraryNode( const wxString& aNodeName, const wxString& aDesc );

    bool HasContainerColumns( const wxDataViewItem& aItem ) const override;

    bool IsContainer( const wxDataViewItem& aItem ) const override;

    wxDataViewItem GetParent( const wxDataViewItem& aItem ) const override;

    unsigned int GetColumnCount() const override { return NUM_COLS; }

    wxString GetColumnType( unsigned int aCol ) const override { return "string"; }

    void GetValue( wxVariant&              aVariant,
                   const wxDataViewItem&   aItem,
                   unsigned int            aCol ) const override;

    bool SetValue( const wxVariant&        aVariant,
                   const wxDataViewItem&   aItem,
                   unsigned int            aCol ) override { return false; }

    bool GetAttr( const wxDataViewItem&   aItem,
                  unsigned int            aCol,
                  wxDataViewItemAttr&     aAttr ) const override;

    const wxString GetPinningSymbol() const
    {
        return wxString::FromUTF8( "☆ " );
    }

private:
    void FindAndExpand( LIB_TREE_NODE& aNode, std::function<bool( const LIB_TREE_NODE* )> aFunc,
                        LIB_TREE_NODE** aHighScore );

    LIB_TREE_NODE* ShowResults();

    LIB_TREE_NODE* ShowPreselect();

    LIB_TREE_NODE* ShowSingleLibrary();

protected:
    LIB_TREE_NODE_ROOT      m_tree;

private:
    EDA_BASE_FRAME*         m_parent;

    SYM_FILTER_TYPE         m_filter;
    bool                    m_show_units;
    LIB_ID                  m_preselect_lib_id;
    int                     m_preselect_unit;
    int                     m_freeze;

    wxDataViewColumn*       m_col_part;
    wxDataViewColumn*       m_col_desc;
    wxDataViewCtrl*         m_widget;

    int                     m_colWidths[NUM_COLS];
    wxArrayString           m_pinnedLibs;
    wxString                m_pinnedKey;
};

#endif // LIB_TREE_MODEL_ADAPTER_H