footprint_filter.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The 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 <https://www.gnu.org/licenses/>.
 */
 
#ifndef FOOTPRINT_FILTER_H
#define FOOTPRINT_FILTER_H
 
#include <boost/iterator/iterator_facade.hpp>
#include <eda_pattern_match.h>
#include <footprint_info.h>
#include <wx/arrstr.h>
 

bool FootprintFilterMatchesName( const EDA_PATTERN_MATCH& aFilter, const wxString& aLibNickname,
                                 const wxString& aFootprintName );
 

class FOOTPRINT_FILTER
{
public:
    FOOTPRINT_FILTER( FOOTPRINT_LIST& aList );

    FOOTPRINT_FILTER();

    void SetList( FOOTPRINT_LIST& aList );

    void ClearFilters();

    void FilterByLibrary( const wxString& aLibName );

    void FilterByPinCount( int aPinCount );

    void FilterByFootprintFilters( const wxArrayString& aFilters );

    void FilterByTextPattern( const wxString& aPattern );

    class ITERATOR
            : public boost::iterator_facade<ITERATOR, FOOTPRINT_INFO, boost::forward_traversal_tag>
    {
    public:
        ITERATOR();
        ITERATOR( const ITERATOR& aOther );
        ITERATOR( FOOTPRINT_FILTER& aFilter );
 
    private:
        friend class boost::iterator_core_access;
        friend class FOOTPRINT_FILTER;
 
        void increment();
        bool equal( const ITERATOR& aOther ) const;
        FOOTPRINT_INFO& dereference() const;
 
        size_t            m_pos;
        FOOTPRINT_FILTER* m_filter;

        bool FootprintFilterMatch( FOOTPRINT_INFO& aItem );

        bool PinCountMatch( FOOTPRINT_INFO& aItem );
    };

    ITERATOR begin();

    ITERATOR end();
 
private:
    enum FP_FILTER_T : int
    {
        UNFILTERED_FP_LIST               = 0,
        FILTERING_BY_COMPONENT_FP_FILTER = 0x0001,
        FILTERING_BY_PIN_COUNT           = 0x0002,
        FILTERING_BY_LIBRARY             = 0x0004,
        FILTERING_BY_TEXT_PATTERN        = 0x0008
    };
 
    FOOTPRINT_LIST* m_list;
 
    wxString        m_lib_name;
    wxString        m_filter_pattern;
    int             m_pin_count;
    int             m_filter_type;
 
    std::vector<std::unique_ptr<EDA_COMBINED_MATCHER>> m_pattern_filters;
    std::vector<std::unique_ptr<EDA_PATTERN_MATCH>>    m_footprint_filters;
};
 
#endif // FOOTPRINT_FILTER_H