drc_rule_editor_enums.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 2
 * 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, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */
 
#ifndef DRC_RULE_EDITOR_ENUMS_H_
#define DRC_RULE_EDITOR_ENUMS_H_
 
#include <wx/string.h>
#include <vector>
 

struct VALIDATION_RESULT
{
    bool                     isValid = true;
    std::vector<wxString>    errors;
 
    void AddError( const wxString& aError )
    {
        isValid = false;
        errors.push_back( aError );
    }
 
    void Merge( const VALIDATION_RESULT& aOther )
    {
        if( !aOther.isValid )
        {
            isValid = false;
            errors.insert( errors.end(), aOther.errors.begin(), aOther.errors.end() );
        }
    }
};
 
 
struct RULE_GENERATION_CONTEXT
{
    wxString ruleName;
    wxString comment;
    wxString conditionExpression;
    wxString layerClause;
    wxString constraintCode;
};
 
 
enum DRC_RULE_EDITOR_ITEM_TYPE
{
    ROOT = 0,
    CATEGORY,
    RULE_TYPE,
    CONSTRAINT,
    RULE,
};
 
enum DRC_RULE_EDITOR_CONSTRAINT_NAME
{
    MINIMUM_CLEARANCE = 0,
    CREEPAGE_DISTANCE,
    MINIMUM_CONNECTION_WIDTH,
    COPPER_TO_HOLE_CLEARANCE,
    HOLE_TO_HOLE_CLEARANCE,
    MINIMUM_THERMAL_RELIEF_SPOKE_COUNT,
    MINIMUM_ANNULAR_WIDTH,
    COPPER_TO_EDGE_CLEARANCE,
    COURTYARD_CLEARANCE,
    PHYSICAL_CLEARANCE,
    MINIMUM_THROUGH_HOLE,
    HOLE_SIZE,
    HOLE_TO_HOLE_DISTANCE,
    MINIMUM_UVIA_HOLE,
    MINIMUM_UVIA_DIAMETER,
    MINIMUM_VIA_DIAMETER,
    VIA_STYLE,
    MINIMUM_TEXT_HEIGHT_AND_THICKNESS,
    SILK_TO_SILK_CLEARANCE,
    SILK_TO_SOLDERMASK_CLEARANCE,
    MINIMUM_SOLDERMASK_SILVER,
    SOLDERMASK_EXPANSION,
    SOLDERPASTE_EXPANSION,
    MAXIMUM_ALLOWED_DEVIATION,
    MINIMUM_ANGULAR_RING,
    MATCHED_LENGTH_DIFF_PAIR,
    ROUTING_DIFF_PAIR,
    ROUTING_WIDTH,
    MAXIMUM_VIA_COUNT,
    ABSOLUTE_LENGTH,
    PERMITTED_LAYERS,
    ALLOWED_ORIENTATION,
    VIAS_UNDER_SMD,
    CUSTOM_RULE
};
 

enum class DRC_LAYER_CATEGORY
{
    COPPER_ONLY,           
    SILKSCREEN_ONLY,       
    SOLDERMASK_ONLY,       
    SOLDERPASTE_ONLY,      
    TOP_BOTTOM_ANY,        
    GENERAL_ANY_LAYER,     
    NO_LAYER_SELECTOR      
};
 

enum DRC_LAYER_SELECTOR_ID : int
{
    LAYER_SEL_ANY    = -10,   
    LAYER_SEL_OUTER  = -11,   
    LAYER_SEL_INNER  = -12,   
    LAYER_SEL_TOP    = -13,   
    LAYER_SEL_BOTTOM = -14,   
};
 
 
#endif // DRC_RULE_EDITOR_ENUMS_H_