ipc2581_function_mode.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 IPC2581_FUNCTION_MODE_H
#define IPC2581_FUNCTION_MODE_H
 
#include <bitset>
#include <initializer_list>
#include <optional>
#include <vector>
 
#include <layer_ids.h>
#include <wx/string.h>
 
namespace IPC2581
{

enum class SECTION
{
    PADSTACKS,          
    BOM_AVL,            
    PACKAGES,           
    COMPONENTS,         
    STACKUP,            
    PROFILE,            
    SOLDERMASK,         
    SOLDERPASTE,        
    SILKSCREEN,         
    DRILL_ROUT,         
    DOCUMENTATION,      
    OUTER_COPPER,       
    INNER_COPPER,       
    DIELECTRIC,         
    MISC_FAB,           
    LOGICAL_NET,        
    PHYSICAL_NET,       
    DFX,                
 
    COUNT
};

enum class MODE
{
    USERDEF,
    BOM,
    STACKUP,
    FABRICATION,
    ASSEMBLY,
    TEST,
    STENCIL,
    DFX,
 
    COUNT
};

enum class SECTION_RULE
{
    EXCLUDED,
    RULE_OPTIONAL,
    REQUIRED
};

enum class REVISION
{
    B,
    C
};

enum class SUPPRESS
{
    COMPONENT_REFDES,       
    COMPONENT_PACKAGEREF,   
    PINREF_COMPONENTREF,    
    PAD_PADSTACKDEFREF,     
    BOM_REFDES,             
    BOM_REFDES_LAYERREF,    
    BOM_REFDES_PACKAGEREF,  
    BOM_HEADER_STEPREF,     
 
    COUNT
};

class SECTION_SET : public std::bitset<static_cast<size_t>( SECTION::COUNT )>
{
public:
    using BASE = std::bitset<static_cast<size_t>( SECTION::COUNT )>;
 
    SECTION_SET() = default;
 
    // The inherited bitset operators return BASE and this converts the result back
    SECTION_SET( const BASE& aBits ) : BASE( aBits ) {}
 
    SECTION_SET( std::initializer_list<SECTION> aSections )
    {
        for( SECTION section : aSections )
            Set( section );
    }
 
    bool Contains( SECTION aSection ) const { return test( static_cast<size_t>( aSection ) ); }
 
    SECTION_SET& Set( SECTION aSection, bool aOn = true )
    {
        set( static_cast<size_t>( aSection ), aOn );
        return *this;
    }
};

class SUPPRESS_SET : public std::bitset<static_cast<size_t>( SUPPRESS::COUNT )>
{
public:
    bool Contains( SUPPRESS aWhat ) const { return test( static_cast<size_t>( aWhat ) ); }
 
    SUPPRESS_SET& Set( SUPPRESS aWhat, bool aOn = true )
    {
        set( static_cast<size_t>( aWhat ), aOn );
        return *this;
    }
};

struct CONFLICT
{
    std::optional<SECTION> m_section;
    std::optional<SECTION> m_requires;
    wxString               m_message;
};
 
struct RESOLVE_RESULT
{
    SECTION_SET           m_included;
    SUPPRESS_SET          m_suppressions;
    std::vector<CONFLICT> m_conflicts;
 
    bool Ok() const { return m_conflicts.empty(); }
};

char SectionKeyChar( SECTION aSection );

std::optional<SECTION> SectionFromKeyChar( char aKey );

SECTION_RULE SectionRule( MODE aMode, SECTION aSection );

SECTION_SET RequiredSections( MODE aMode );

SECTION_SET OptionalSections( MODE aMode );

SECTION_SET RecommendedOptionalSections( MODE aMode );

SECTION_SET UnsupportedSections();

SECTION_SET LegacySections();

bool NeedsCadData( const SECTION_SET& aSet );

wxString SectionKeyString( const SECTION_SET& aSet );

bool SectionSetFromKeyString( const wxString& aKey, SECTION_SET& aResult );

wxString ModeToken( MODE aMode );

std::optional<MODE> ModeFromToken( const wxString& aToken );

bool ModeSupported( MODE aMode, REVISION aRevision );

std::optional<SECTION> SectionForBoardLayer( PCB_LAYER_ID aLayer );

std::optional<SECTION> SectionForLayerFunction( const wxString& aLayerFunction,
                                                const wxString& aSide = wxEmptyString );

RESOLVE_RESULT ResolveSections( REVISION aRevision, MODE aMode, const SECTION_SET& aRequested );
 
} // namespace IPC2581
 
#endif // IPC2581_FUNCTION_MODE_H