lset.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 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 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 LSET_H
#define LSET_H
 
#include <layer_ids.h>
#include <base_set.h>
 
class LSEQ;
class LAYER_RANGE;
 
class KICOMMON_API LSET : public BASE_SET
{
public:
 
    LSET() : BASE_SET( PCB_LAYER_ID_COUNT ) {} // all bits are set to zero in BASE_SET()
 
    LSET( const BASE_SET& aOther ) : BASE_SET( aOther ) {}
 
    LSET( std::initializer_list<PCB_LAYER_ID> aList );
 
    LSET( const std::vector<PCB_LAYER_ID>& aList );
 
    LSET( const LSEQ& aSeq );
 
    LSET( const LAYER_RANGE& aRange );
 
    LSET( unsigned long __val ) = delete;
 
    bool Contains( PCB_LAYER_ID aLayer ) const
    {
        // At the moment, LSET cannot store negative layers, but PCB_LAYER_ID can contain them
        if( aLayer < 0 )
           return false;
 
        try
        {
            return test( aLayer );
        }
        catch( std::out_of_range& )
        {
            return false;
        }
    }
 
    static wxString Name( PCB_LAYER_ID aLayerId );
 
    static int NameToLayer( wxString& aName );
 
    static bool IsBetween( PCB_LAYER_ID aStart, PCB_LAYER_ID aEnd, PCB_LAYER_ID aLayer );
 
    static LSET InternalCuMask();
 
    static LSET FrontAssembly();
 
    static LSET BackAssembly();
 
    static LSET AllCuMask( int aCuLayerCount = MAX_CU_LAYERS );
 
    static LSET ExternalCuMask();
 
    static LSET AllNonCuMask();
 
    static LSET AllLayersMask();
 
    static LSET FrontTechMask();
 
    static LSET FrontBoardTechMask();
 
    static LSET BackTechMask();
 
    static LSET BackBoardTechMask();
 
    static LSET AllTechMask();
 
    static LSET AllBoardTechMask();
 
    static LSET FrontMask();
 
    static LSET BackMask();
 
    static LSET SideSpecificMask();
 
    static LSET UserMask();
 
    static LSET PhysicalLayersMask();
 
    static LSET UserDefinedLayers();
 
    static LSET ForbiddenFootprintLayers();
 
    LSEQ CuStack() const;
 
    LSEQ TechAndUserUIOrder() const;
 
    LSEQ UIOrder() const;
 
    LSEQ Seq( const LSEQ& aSequence ) const;
 
    LSEQ Seq() const;
 
    LSEQ SeqStackupTop2Bottom( PCB_LAYER_ID aSelectedLayer = UNDEFINED_LAYER ) const;
 
    LSEQ SeqStackupForPlotting() const;
 
    void RunOnLayers( const std::function<void( PCB_LAYER_ID )>& aFunction ) const
    {
        for( size_t ii = 0; ii < size(); ++ii )
        {
            if( test( ii ) )
                aFunction( PCB_LAYER_ID( ii ) );
        }
    }
 
    std::string FmtHex() const;
 
    int ParseHex( const char* aStart, int aCount );
    int ParseHex( const std::string& str );
 
    std::string FmtBin() const;
 
    PCB_LAYER_ID ExtractLayer() const;
 
 
    LSET& Flip( int aCopperLayersCount = 0 );
 
    static int LayerCount( PCB_LAYER_ID aStart, PCB_LAYER_ID aEnd, int aCopperLayerCount );
 
#ifndef SWIG
    // Custom iterator to iterate over all set bits
    class KICOMMON_API all_set_layers_iterator : public BASE_SET::set_bits_iterator
    {
    public:
        all_set_layers_iterator( const BASE_SET& set, size_t index ) :
                BASE_SET::set_bits_iterator( set, index )
        {
        }
 
        PCB_LAYER_ID operator*() const { return PCB_LAYER_ID( BASE_SET::set_bits_iterator::operator*() ); }
 
        all_set_layers_iterator& operator++()
        {
            BASE_SET::set_bits_iterator::operator++();
            return *this;
        }
    };
 
    all_set_layers_iterator begin() const { return all_set_layers_iterator( *this, 0 ); }
    all_set_layers_iterator end() const { return all_set_layers_iterator( *this, size() ); }
 
    // Custom iterators for Copper and Non-Copper layers
    class KICOMMON_API copper_layers_iterator : public BASE_SET::set_bits_iterator
    {
    public:
        copper_layers_iterator( const BASE_SET& set, size_t index );
        PCB_LAYER_ID            operator*() const;
        copper_layers_iterator& operator++();
 
    private:
        void advance_to_next_set_copper_bit();
        void next_copper_layer();
    };
 
    class KICOMMON_API non_copper_layers_iterator : public BASE_SET::set_bits_iterator
    {
    public:
        non_copper_layers_iterator( const BASE_SET& set, size_t index );
        PCB_LAYER_ID                operator*() const;
        non_copper_layers_iterator& operator++();
 
    private:
        void advance_to_next_set_non_copper_bit();
    };
 
    copper_layers_iterator copper_layers_begin() const;
    copper_layers_iterator copper_layers_end() const;
    non_copper_layers_iterator non_copper_layers_begin() const;
    non_copper_layers_iterator non_copper_layers_end() const;
 
#endif
 
};
#endif // LSET_H