/* * This program source code file is part of KiCad, a free EDA CAD application. * * Copyright (C) 2017 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 . */ #ifndef FOOTPRINT_FILTER_H #define FOOTPRINT_FILTER_H #include #include #include /** * Footprint display filter. Takes a list of footprints and filtering settings, * and provides an iterable view of the filtered data. */ class FOOTPRINT_FILTER { public: /** * Construct a filter. * * @param aList - unfiltered list of footprints */ FOOTPRINT_FILTER( FOOTPRINT_LIST& aList ); /** * Construct a filter without assigning a footprint list. The filter MUST NOT * be iterated over until SetList() is called. */ FOOTPRINT_FILTER(); /** * Set the list to filter. */ void SetList( FOOTPRINT_LIST& aList ); /** * Clear all filter criteria. */ void ClearFilters(); /** * Add library name to filter criteria. */ void FilterByLibrary( wxString const& aLibName ); /** * Set a pin count to filter by. */ void FilterByPinCount( int aPinCount ); /** * Set a list of footprint filters to filter by. */ void FilterByFootprintFilters( wxArrayString const& aFilters ); /** * Add a pattern to filter by name, including wildcards and optionally a colon-delimited * library name. */ void FilterByPattern( wxString const& aPattern ); /** * Inner iterator class returned by begin() and end(). */ class ITERATOR : public boost::iterator_facade { public: ITERATOR(); ITERATOR( ITERATOR const& aOther ); ITERATOR( FOOTPRINT_FILTER& aFilter ); private: friend class boost::iterator_core_access; friend class FOOTPRINT_FILTER; void increment(); bool equal( ITERATOR const& aOther ) const; FOOTPRINT_INFO& dereference() const; size_t m_pos; FOOTPRINT_FILTER* m_filter; /** * Check if the stored component matches an item by footprint filter. */ bool FootprintFilterMatch( FOOTPRINT_INFO& aItem ); /** * Check if the stored component matches an item by pin count. */ bool PinCountMatch( FOOTPRINT_INFO& aItem ); }; /** * Get an iterator to the beginning of the filtered view. */ ITERATOR begin(); /** * Get an iterator to the end of the filtered view. The end iterator is * invalid and may not be dereferenced, only compared against. */ ITERATOR end(); private: /** * Filter setting constants. The filter type is a bitwise OR of these flags, * and only footprints matching all selected filter types are shown. */ enum FP_FILTER_T : int { UNFILTERED_FP_LIST = 0, FILTERING_BY_COMPONENT_KEYWORD = 0x0001, FILTERING_BY_PIN_COUNT = 0x0002, FILTERING_BY_LIBRARY = 0x0004, FILTERING_BY_NAME = 0x0008 }; FOOTPRINT_LIST* m_list; wxString m_lib_name; wxString m_filter_pattern; int m_pin_count; int m_filter_type; EDA_PATTERN_MATCH_WILDCARD_EXPLICIT m_filter; std::vector> m_footprint_filters; }; #endif // FOOTPRINT_FILTER_H