drc_rules_release_vocabulary.h

Go to the documentation of this file.

// Generated by tools/generate_drc_rules_vocabulary.py from the release tags. Do not edit it
// by hand. It is committed because generating it needs every release tag, which a source
// archive or a shallow clone does not have. Rerun the script and commit the result when a
// release becomes a downgrade target.
 
#ifndef DRC_RULES_RELEASE_VOCABULARY_H
#define DRC_RULES_RELEASE_VOCABULARY_H
 
#include <cstddef>
#include <iterator>
 
// clang-format off

struct DRC_RULE_VOCABULARY
{
    const char*        m_targetId;
    const char* const* m_tokens;
    size_t             m_tokenCount;
    const char* const* m_functions;
    size_t             m_functionCount;
    const char* const* m_properties;
    size_t             m_propertyCount;
    const char* const* m_units;
    size_t             m_unitCount;
    bool               m_textVariables;
};
 
// KiCad 9.0, the words every release from 9.0.0 to 9.0.9.1 reads.
inline constexpr const char* const KICAD9_0_DRC_RULE_TOKENS[] = {
    "annular_width",
    "assertion",
    "board_edge",
    "buried_via",
    "clearance",
    "condition",
    "connection_width",
    "constraint",
    "courtyard_clearance",
    "creepage",
    "diff_pair_gap",
    "diff_pair_uncoupled",
    "disallow",
    "edge_clearance",
    "error",
    "exclusion",
    "footprint",
    "graphic",
    "hole",
    "hole_clearance",
    "hole_size",
    "hole_to_hole",
    "ignore",
    "inner",
    "layer",
    "length",
    "max",
    "mechanical_clearance",
    "mechanical_hole_clearance",
    "micro_via",
    "min",
    "min_resolved_spokes",
    "none",
    "npth",
    "opt",
    "outer",
    "pad",
    "physical_clearance",
    "physical_hole_clearance",
    "pth",
    "rule",
    "severity",
    "silk_clearance",
    "skew",
    "solid",
    "text",
    "text_height",
    "text_thickness",
    "thermal_relief_gap",
    "thermal_reliefs",
    "thermal_spoke_width",
    "track",
    "track_angle",
    "track_segment_length",
    "track_width",
    "version",
    "via",
    "via_count",
    "via_diameter",
    "warning",
    "within_diff_pairs",
    "zone",
    "zone_connection",
};
 
inline constexpr const char* const KICAD9_0_DRC_RULE_FUNCTIONS[] = {
    "enclosedbyarea",
    "existsonlayer",
    "fromto",
    "getfield",
    "hascomponentclass",
    "hasnetclass",
    "indiffpair",
    "insidearea",
    "insidebackcourtyard",
    "insidecourtyard",
    "insidefrontcourtyard",
    "intersectsarea",
    "intersectsbackcourtyard",
    "intersectscourtyard",
    "intersectsfrontcourtyard",
    "isblindburiedvia",
    "iscoupleddiffpair",
    "ismicrovia",
    "isplated",
    "memberof",
    "memberoffootprint",
    "memberofgroup",
    "memberofsheet",
};
 
inline constexpr const char* const KICAD9_0_DRC_RULE_PROPERTIES[] = {
    "allow_teardrops_to_span_two_tracks",
    "arrow_direction",
    "associated_layer",
    "back_tenting",
    "bold",
    "border",
    "border_style",
    "border_width",
    "cell_separators",
    "center_x",
    "center_y",
    "clearance",
    "clearance_override",
    "component_class",
    "componentclass",
    "copper_layers",
    "corner_radius_size",
    "crossbar_height",
    "curved_teardrops",
    "diameter",
    "do_not_populate",
    "enable",
    "enable_teardrops",
    "end_x",
    "end_y",
    "exclude_from_bill_of_materials",
    "exclude_from_position_files",
    "exempt_from_courtyard_requirement",
    "extension_line_overshoot",
    "external_border",
    "fabrication_property",
    "fill_mode",
    "filled",
    "font",
    "front_tenting",
    "hatch_gap",
    "hatch_width",
    "header_border",
    "height",
    "hole",
    "hole_shape",
    "hole_size_x",
    "hole_size_y",
    "horizontal_justification",
    "hyperlink",
    "initial_side",
    "italic",
    "keep_aligned_with_dimension",
    "keep_out_copper_pours",
    "keep_out_footprints",
    "keep_out_pads",
    "keep_out_tracks",
    "keep_out_vias",
    "keep_upright",
    "keywords",
    "knockout",
    "layer",
    "layer_bottom",
    "layer_top",
    "leader_length",
    "library_description",
    "library_link",
    "line_style",
    "line_width",
    "locked",
    "margin_bottom",
    "margin_left",
    "margin_right",
    "margin_top",
    "max_amplitude",
    "max_length",
    "max_width",
    "min_amplitude",
    "min_spacing",
    "minimum_width",
    "mirrored",
    "name",
    "net",
    "net_class",
    "netclass",
    "netname",
    "not_in_schematic",
    "number_box",
    "override_custom_rules",
    "override_text",
    "pad_connections",
    "pad_number",
    "pad_shape",
    "pad_to_die_length",
    "pad_type",
    "parent",
    "pin_name",
    "pin_type",
    "position_x",
    "position_y",
    "precision",
    "prefer_zone_connections",
    "prefix",
    "radius",
    "reference",
    "remove_islands",
    "rounded",
    "row_separators",
    "separators_style",
    "separators_width",
    "shape",
    "size",
    "size_x",
    "size_y",
    "smoothing_effort",
    "soldermask",
    "soldermask_margin_override",
    "solderpaste_margin_override",
    "source_name",
    "source_type",
    "start_x",
    "start_y",
    "suffix",
    "suppress_trailing_zeroes",
    "target_length",
    "target_skew",
    "text",
    "text_frame",
    "thermal_relief_gap",
    "thermal_relief_spoke_width",
    "thermal_spoke_template",
    "thickness",
    "transform_offset_x",
    "transform_offset_y",
    "tuning_mode",
    "type",
    "units",
    "units_format",
    "update_order",
    "value",
    "vertical_justification",
    "via_type",
    "width",
    "zone_connection_style",
};
 
inline constexpr const char* const KICAD9_0_DRC_RULE_UNITS[] = {
    "in",
    "mil",
    "mm",
};
 
// KiCad 10.0, the words every release from 10.0.0 to 10.0.7 reads.
inline constexpr const char* const KICAD10_0_DRC_RULE_TOKENS[] = {
    "annular_width",
    "assertion",
    "assign_component_class",
    "blind_via",
    "board_edge",
    "bridged_mask",
    "buried_via",
    "clearance",
    "condition",
    "connection_width",
    "constraint",
    "courtyard_clearance",
    "creepage",
    "diff_pair_gap",
    "diff_pair_uncoupled",
    "disallow",
    "edge_clearance",
    "error",
    "exclusion",
    "footprint",
    "graphic",
    "hole",
    "hole_clearance",
    "hole_size",
    "hole_to_hole",
    "ignore",
    "inner",
    "layer",
    "length",
    "max",
    "mechanical_clearance",
    "mechanical_hole_clearance",
    "micro_via",
    "min",
    "min_resolved_spokes",
    "none",
    "npth",
    "opt",
    "outer",
    "pad",
    "physical_clearance",
    "physical_hole_clearance",
    "pth",
    "rule",
    "severity",
    "silk_clearance",
    "skew",
    "solder_mask_expansion",
    "solder_mask_sliver",
    "solder_paste_abs_margin",
    "solder_paste_rel_margin",
    "solid",
    "text",
    "text_height",
    "text_thickness",
    "thermal_relief_gap",
    "thermal_reliefs",
    "thermal_spoke_width",
    "through_via",
    "track",
    "track_angle",
    "track_segment_length",
    "track_width",
    "version",
    "via",
    "via_count",
    "via_dangling",
    "via_diameter",
    "warning",
    "within_diff_pairs",
    "zone",
    "zone_connection",
};
 
inline constexpr const char* const KICAD10_0_DRC_RULE_FUNCTIONS[] = {
    "enclosedbyarea",
    "existsonlayer",
    "fromto",
    "getfield",
    "hascomponentclass",
    "hasexactnetclass",
    "hasnetclass",
    "indiffpair",
    "insidearea",
    "insidebackcourtyard",
    "insidecourtyard",
    "insidefrontcourtyard",
    "intersectsarea",
    "intersectsbackcourtyard",
    "intersectscourtyard",
    "intersectsfrontcourtyard",
    "isblindburiedvia",
    "isblindvia",
    "isburiedvia",
    "iscoupleddiffpair",
    "ismicrovia",
    "isplated",
    "memberof",
    "memberoffootprint",
    "memberofgroup",
    "memberofsheet",
    "memberofsheetorchildren",
};
 
inline constexpr const char* const KICAD10_0_DRC_RULE_PROPERTIES[] = {
    "allow_teardrops_to_span_two_tracks",
    "arrow_direction",
    "associated_layer",
    "auto_thickness",
    "back_covering",
    "back_plugging",
    "back_tenting",
    "backdrill_mode",
    "barcode_type",
    "best_length_ratio",
    "best_width_ratio",
    "bold",
    "border",
    "border_style",
    "border_width",
    "bottom_backdrill_size",
    "bottom_counterbore_depth",
    "bottom_countersink_angle",
    "capping",
    "cell_separators",
    "center_x",
    "center_y",
    "clearance",
    "clearance_override",
    "column_width",
    "component_class",
    "componentclass",
    "copper_layers",
    "corner_radius",
    "corner_radius_ratio",
    "corner_radius_size",
    "crossbar_height",
    "curved_teardrops",
    "diameter",
    "do_not_populate",
    "enable",
    "enable_teardrops",
    "end_x",
    "end_y",
    "error_correction",
    "exclude_from_bill_of_materials",
    "exclude_from_position_files",
    "exempt_from_courtyard_requirement",
    "extension_line_overshoot",
    "external_border",
    "fabrication_property",
    "fill",
    "fill_mode",
    "filling",
    "font",
    "front_covering",
    "front_plugging",
    "front_tenting",
    "hatch_gap",
    "hatch_minimum_hole_ratio",
    "hatch_width",
    "header_border",
    "height",
    "hole",
    "hole_shape",
    "hole_size_x",
    "hole_size_y",
    "horizontal_justification",
    "hyperlink",
    "initial_side",
    "italic",
    "keep_aligned_with_dimension",
    "keep_out_footprints",
    "keep_out_pads",
    "keep_out_tracks",
    "keep_out_vias",
    "keep_out_zone_fills",
    "keep_upright",
    "keywords",
    "knockout",
    "layer",
    "layer_bottom",
    "layer_top",
    "leader_length",
    "library_description",
    "library_link",
    "line_style",
    "line_width",
    "locked",
    "margin_bottom",
    "margin_left",
    "margin_right",
    "margin_top",
    "margin_x",
    "margin_y",
    "max_amplitude",
    "max_length",
    "max_width",
    "max_width_ratio",
    "min_amplitude",
    "min_spacing",
    "minimum_width",
    "mirrored",
    "name",
    "net",
    "net_class",
    "netclass",
    "netname",
    "not_in_schematic",
    "number_box",
    "orientation",
    "override_custom_rules",
    "override_text",
    "pad_connections",
    "pad_number",
    "pad_shape",
    "pad_to_die_delay",
    "pad_to_die_length",
    "pad_type",
    "parent",
    "pin_name",
    "pin_type",
    "position_x",
    "position_y",
    "precision",
    "prefer_zone_connections",
    "prefix",
    "radius",
    "reference",
    "remove_islands",
    "rounded",
    "row_height",
    "row_separators",
    "scale",
    "separators_style",
    "separators_width",
    "shape",
    "show_text",
    "size",
    "size_x",
    "size_y",
    "smoothing_amount",
    "smoothing_effort",
    "soldermask",
    "soldermask_margin_override",
    "solderpaste_margin_override",
    "solderpaste_margin_ratio_override",
    "source_name",
    "source_type",
    "start_x",
    "start_y",
    "suffix",
    "suppress_trailing_zeroes",
    "target_delay",
    "target_length",
    "target_skew",
    "target_skew_delay",
    "text",
    "text_frame",
    "text_size",
    "thermal_relief_gap",
    "thermal_relief_spoke_angle",
    "thermal_relief_spoke_width",
    "thermal_spoke_template",
    "thickness",
    "top_backdrill_size",
    "top_counterbore_depth",
    "top_countersink_angle",
    "transform_offset_x",
    "transform_offset_y",
    "tuning_mode",
    "type",
    "units",
    "units_format",
    "update_order",
    "vertical_justification",
    "via_type",
    "visible",
    "width",
    "zone_connection_style",
};
 
inline constexpr const char* const KICAD10_0_DRC_RULE_UNITS[] = {
    "deg",
    "fs",
    "in",
    "mil",
    "mm",
    "ps",
};
 
inline constexpr DRC_RULE_VOCABULARY DRC_RULE_VOCABULARIES[] = {
    {
        "9.0",
        KICAD9_0_DRC_RULE_TOKENS,
        std::size( KICAD9_0_DRC_RULE_TOKENS ),
        KICAD9_0_DRC_RULE_FUNCTIONS,
        std::size( KICAD9_0_DRC_RULE_FUNCTIONS ),
        KICAD9_0_DRC_RULE_PROPERTIES,
        std::size( KICAD9_0_DRC_RULE_PROPERTIES ),
        KICAD9_0_DRC_RULE_UNITS,
        std::size( KICAD9_0_DRC_RULE_UNITS ),
        false,
    },
    {
        "10.0",
        KICAD10_0_DRC_RULE_TOKENS,
        std::size( KICAD10_0_DRC_RULE_TOKENS ),
        KICAD10_0_DRC_RULE_FUNCTIONS,
        std::size( KICAD10_0_DRC_RULE_FUNCTIONS ),
        KICAD10_0_DRC_RULE_PROPERTIES,
        std::size( KICAD10_0_DRC_RULE_PROPERTIES ),
        KICAD10_0_DRC_RULE_UNITS,
        std::size( KICAD10_0_DRC_RULE_UNITS ),
        true,
    },
};
 
// clang-format on
 
#endif // DRC_RULES_RELEASE_VOCABULARY_H