macro_rules! c_family_modifiers {
(@splice $cont:tt [$($acc:tt)*] $($rest:tt)*) => {
$crate::role_table!(@owners $cont [$($acc)*
Static, Extern, Register, Inline, Inline2, Inline3, Forceinline, ThreadLocal,
Thread, Const, Constexpr, Volatile, Volatile2, Restrict, Restrict2, Atomic,
Noreturn, Noreturn2, Nonnull, Alignas, Alignas2, Extension,
] $($rest)*);
};
}
macro_rules! c_family_decl_keywords {
(@splice $cont:tt [$($acc:tt)*] $($rest:tt)*) => {
$crate::role_table!(@owners $cont [$($acc)* Struct, Union, Enum, Typedef,] $($rest)*);
};
}
macro_rules! c_family_primitives {
(@splice $cont:tt [$($acc:tt)*] $($rest:tt)*) => {
$crate::role_table!(@owners $cont [$($acc)*
PrimitiveType, TypeSpecifier, Signed, Unsigned, Long, Short,
] $($rest)*);
};
}
macro_rules! cpp_family_comparison_payers {
(@splice $cont:tt [$($acc:tt)*] $($rest:tt)*) => {
$crate::role_table!(@owners $cont [$($acc)*
LT gated_by applied, GT gated_by applied, LTEQ gated_by applied,
GTEQ gated_by applied, EQEQ gated_by applied, BANGEQ gated_by applied,
NotEq gated_by applied, LTEQGT gated_by applied,
] $($rest)*);
};
}
macro_rules! cpp_family_short_circuit_payers {
(@splice $cont:tt [$($acc:tt)*] $($rest:tt)*) => {
$crate::role_table!(@owners $cont [$($acc)*
AMPAMP gated_by applied, PIPEPIPE gated_by applied,
And gated_by applied, Or gated_by applied,
] $($rest)*);
};
}
macro_rules! cpp_family_binary_owners {
(@splice $cont:tt [$($acc:tt)*] $($rest:tt)*) => {
$crate::role_table!(@owners $cont [$($acc)*
BinaryExpression(holds_payer),
BinaryExpression2(holds_payer),
FoldExpression(holds_payer),
] $($rest)*);
};
}
macro_rules! c_family_comparison_payers {
(@splice $cont:tt [$($acc:tt)*] $($rest:tt)*) => {
$crate::role_table!(@owners $cont [$($acc)*
LTEQ, GTEQ, EQEQ, BANGEQ,
LT under [BinaryExpression, BinaryExpression2], GT under [BinaryExpression, BinaryExpression2],
] $($rest)*);
};
}
macro_rules! c_family_short_circuit_payers {
(@splice $cont:tt [$($acc:tt)*] $($rest:tt)*) => {
$crate::role_table!(@owners $cont [$($acc)* AMPAMP, PIPEPIPE,] $($rest)*);
};
}
macro_rules! c_family_binary_owners {
(@splice $cont:tt [$($acc:tt)*] $($rest:tt)*) => {
$crate::role_table!(@owners $cont [$($acc)*
BinaryExpression(holds_payer),
BinaryExpression2(holds_payer),
] $($rest)*);
};
}
#[must_use]
pub(crate) fn cpp_family_operator_is_applied<'a>(
node: &crate::Node<'a>,
ancestors: crate::Ancestors<'a, '_>,
) -> bool {
ancestors
.parent(node)
.is_some_and(|parent| match parent.kind() {
"binary_expression" => true,
"fold_expression" => parent
.child_by_field_name("operator")
.is_some_and(|op| op.id() == node.id()),
_ => false,
})
}
macro_rules! cpp_family_gates {
($lang:ident) => {
fn applied<'a>(
node: &$crate::Node<'a>,
_code: &[u8],
ancestors: $crate::Ancestors<'a, '_>,
) -> bool {
$crate::roles::c_family::cpp_family_operator_is_applied(node, ancestors)
}
fn has_body(node: &$crate::Node<'_>, _code: &[u8]) -> bool {
$crate::checker::cpp_specifier_has_body(node)
}
};
}
macro_rules! cpp_family_func_openers {
(@splice $cont:tt [$($acc:tt)*] $($rest:tt)*) => {
$crate::role_table!(@owners $cont [$($acc)*
FunctionDefinition(callable opens Function),
FunctionDefinition2(callable opens Function),
FunctionDefinition3(callable opens Function),
FunctionDefinition4(callable opens Function),
] $($rest)*);
};
}
macro_rules! cpp_family_containers {
(@splice $cont:tt [$($acc:tt)*] $($rest:tt)*) => {
$crate::role_table!(@owners $cont [$($acc)*
TranslationUnit(opens Unit),
NamespaceDefinition(opens Namespace),
StructSpecifier(opens Struct gated_by has_body no_chain),
ClassSpecifier(opens Class gated_by has_body no_chain),
] $($rest)*);
};
}
macro_rules! c_family_calls {
(@splice $cont:tt [$($acc:tt)*] $($rest:tt)*) => {
$crate::role_table!(@owners $cont [$($acc)* CallExpression, CallExpression2,] $($rest)*);
};
}
macro_rules! c_family_strings {
(@splice $cont:tt [$($acc:tt)*] $($rest:tt)*) => {
$crate::role_table!(@owners $cont [$($acc)* StringLiteral, ConcatenatedString,] $($rest)*);
};
}
macro_rules! c_family_loops {
(@splice $cont:tt [$($acc:tt)*] $($rest:tt)*) => {
$crate::role_table!(@owners $cont [$($acc)*
ForStatement, WhileStatement, DoStatement,
] $($rest)*);
};
}
macro_rules! cpp_family_loops {
(@splice $cont:tt [$($acc:tt)*] $($rest:tt)*) => {
$crate::role_table!(@owners $cont [$($acc)*
ForStatement, WhileStatement, DoStatement, ForRangeLoop,
] $($rest)*);
};
}
macro_rules! cpp_family_exits {
(@splice $cont:tt [$($acc:tt)*] $($rest:tt)*) => {
$crate::role_table!(@owners $cont [$($acc)*
ReturnStatement, ThrowStatement, CoReturnStatement, CoYieldStatement,
] $($rest)*);
};
}
pub(crate) use {
c_family_binary_owners, c_family_calls, c_family_comparison_payers, c_family_decl_keywords,
c_family_loops, c_family_modifiers, c_family_primitives, c_family_short_circuit_payers,
c_family_strings, cpp_family_binary_owners, cpp_family_comparison_payers,
cpp_family_containers, cpp_family_exits, cpp_family_func_openers, cpp_family_gates,
cpp_family_loops, cpp_family_short_circuit_payers,
};
macro_rules! c_family_doc_entries {
(@splice $cont:tt [$($acc:tt)*] $($rest:tt)*) => {
$crate::role_table!(@owners $cont [$($acc)*
TypeDefinition,
PreprocDef,
PreprocFunctionDef,
LinkageSpecification,
Enumerator,
StructSpecifier(gated_by has_body no_chain),
UnionSpecifier(gated_by has_body no_chain),
EnumSpecifier(gated_by has_body no_chain),
FieldDeclaration(gated_by field_declares no_chain),
ExpressionStatement(gated_by is_macro_call_statement no_chain),
ExpressionStatement2(gated_by is_macro_call_statement no_chain),
] $($rest)*);
};
}
macro_rules! c_doc_declarations {
(@splice $cont:tt [$($acc:tt)*] $($rest:tt)*) => {
$crate::role_table!(@owners $cont [$($acc)*
Declaration,
FunctionDefinition,
FunctionDefinition2,
] $($rest)*);
};
}
macro_rules! cpp_doc_entries {
(@splice $cont:tt [$($acc:tt)*] $($rest:tt)*) => {
$crate::role_table!(@owners $cont [$($acc)*
Declaration,
Declaration2,
Declaration3,
Declaration4,
FunctionDefinition,
FunctionDefinition2,
FunctionDefinition3,
FunctionDefinition4,
NamespaceDefinition,
UsingDeclaration,
AliasDeclaration,
FriendDeclaration,
TemplateDeclaration,
ClassSpecifier(gated_by has_body no_chain),
] $($rest)*);
};
}
macro_rules! c_family_doc_conditionals {
(@splice $cont:tt [$($acc:tt)*] $($rest:tt)*) => {
$crate::role_table!(@owners $cont [$($acc)*
PreprocIf(gated_by conditional_declares),
PreprocIf2(gated_by conditional_declares),
PreprocIf3(gated_by conditional_declares),
PreprocIf4(gated_by conditional_declares),
PreprocIfdef(gated_by conditional_declares),
PreprocIfdef2(gated_by conditional_declares),
PreprocIfdef3(gated_by conditional_declares),
PreprocIfdef4(gated_by conditional_declares),
PreprocElse(gated_by conditional_declares),
PreprocElse2(gated_by conditional_declares),
PreprocElse3(gated_by conditional_declares),
PreprocElse4(gated_by conditional_declares),
PreprocElif(gated_by conditional_declares),
PreprocElif2(gated_by conditional_declares),
PreprocElif3(gated_by conditional_declares),
PreprocElif4(gated_by conditional_declares),
PreprocElifdef(gated_by conditional_declares),
PreprocElifdef2(gated_by conditional_declares),
PreprocElifdef3(gated_by conditional_declares),
PreprocElifdef4(gated_by conditional_declares),
] $($rest)*);
};
}
macro_rules! objc_doc_conditionals {
(@splice $cont:tt [$($acc:tt)*] $($rest:tt)*) => {
$crate::role_table!(@owners $cont [$($acc)*
PreprocIf(gated_by conditional_declares),
PreprocIf2(gated_by conditional_declares),
PreprocIf3(gated_by conditional_declares),
PreprocIf4(gated_by conditional_declares),
PreprocIfdef(gated_by conditional_declares),
PreprocIfdef2(gated_by conditional_declares),
PreprocIfdef3(gated_by conditional_declares),
PreprocElse(gated_by conditional_declares),
PreprocElse2(gated_by conditional_declares),
PreprocElse3(gated_by conditional_declares),
PreprocElse4(gated_by conditional_declares),
PreprocElse5(gated_by conditional_declares),
PreprocElif(gated_by conditional_declares),
PreprocElif2(gated_by conditional_declares),
PreprocElif3(gated_by conditional_declares),
PreprocElif4(gated_by conditional_declares),
PreprocElif5(gated_by conditional_declares),
PreprocElifdef(gated_by conditional_declares),
PreprocElifdef2(gated_by conditional_declares),
] $($rest)*);
};
}
macro_rules! preproc_conditional_kind {
($lang:ident [$($kind:ident),+ $(,)?]) => {
#[inline]
#[must_use]
pub(crate) fn is_preproc_conditional_kind(kind: u16) -> bool {
$(kind == $crate::$lang::$kind as u16)||+
}
};
}
macro_rules! c_family_conditional_kinds {
($lang:ident) => {
$crate::roles::c_family::preproc_conditional_kind!($lang [
PreprocIf, PreprocIf2, PreprocIf3, PreprocIf4,
PreprocIfdef, PreprocIfdef2, PreprocIfdef3, PreprocIfdef4,
PreprocElse, PreprocElse2, PreprocElse3, PreprocElse4,
PreprocElif, PreprocElif2, PreprocElif3, PreprocElif4,
PreprocElifdef, PreprocElifdef2, PreprocElifdef3, PreprocElifdef4,
]);
};
}
macro_rules! objc_conditional_kinds {
() => {
$crate::roles::c_family::preproc_conditional_kind!(Objc [
PreprocIf, PreprocIf2, PreprocIf3, PreprocIf4,
PreprocIfdef, PreprocIfdef2, PreprocIfdef3,
PreprocElse, PreprocElse2, PreprocElse3, PreprocElse4, PreprocElse5,
PreprocElif, PreprocElif2, PreprocElif3, PreprocElif4, PreprocElif5,
PreprocElifdef, PreprocElifdef2,
]);
};
}
macro_rules! c_family_doc_gates {
(with_has_body $code:ident) => {
fn has_body(node: &$crate::Node<'_>, _: &[u8]) -> bool {
$crate::checker::cpp_specifier_has_body(node)
}
c_family_doc_gates!($code);
};
($code:ident) => {
$crate::roles::byte_gate!(
opens_with_doxygen_marker,
$crate::lang_helpers::doc_comment::doxygen
);
fn field_declares(node: &$crate::Node<'_>, _: &[u8]) -> bool {
$crate::roles::c_family::field_declaration_declares(node)
}
fn is_macro_call_statement(node: &$crate::Node<'_>, _: &[u8]) -> bool {
$crate::lang_helpers::doxygen::statement_is_macro_call(node)
}
fn conditional_declares<'a>(
node: &$crate::Node<'a>,
_: &[u8],
ancestors: $crate::Ancestors<'a, '_>,
) -> bool {
$crate::lang_helpers::doxygen::conditional_declares::<$crate::$code>(node, ancestors)
}
};
}
#[must_use]
pub(crate) fn field_declaration_declares(node: &crate::Node<'_>) -> bool {
node.child_by_field_name("declarator").is_some()
|| node.child_by_field_name("type").is_none_or(|t| {
!matches!(
t.kind(),
"struct_specifier" | "union_specifier" | "enum_specifier" | "class_specifier"
) || crate::checker::cpp_specifier_has_body(&t)
})
}
pub(crate) use {
c_doc_declarations, c_family_conditional_kinds, c_family_doc_conditionals,
c_family_doc_entries, c_family_doc_gates, cpp_doc_entries, objc_conditional_kinds,
objc_doc_conditionals, preproc_conditional_kind,
};