Skip to main content

CppDeclarator

Struct CppDeclarator 

Source
pub struct CppDeclarator { /* private fields */ }
Expand description

A declarator: the part that names the entity, possibly wrapped in pointers, references, arrays, function parameter lists and template argument lists.

Implementations§

Source§

impl CppDeclarator

Source

pub fn get_name(&self) -> Option<CppNameToken>

The declared name.

Found among the child nodes rather than the direct tokens: a qualified or templated name (ns::Foo<int>) is itself a node, so the identifier is one level down.

A parenthesised declarator keeps it further down still — int (*f)(int) is Declarator > Declarator > NameExpr, and the parentheses exist precisely to bind the operators to that name rather than to the function’s. A walk that stopped at the first level answered None for every shape the language uses to declare a function pointer: measured on int (*f)(int);, int (&f)(void); and neovim’s static char *(names[3]) = … — three declarations that plainly name something and that sema::scopes::is_unnamed_declaration read as “a call statement, not a declaration”.

Source

pub fn get_name_text(&self) -> Option<String>

Source

pub fn get_pointer_types(&self) -> Vec<CppPointerType>

The pointer and reference types this declarator writes, its nested declarators’ included.

int* p is Declarator > Declarator > PointerType (measured), so a one-level search finds nothing; a declaration’s own type parts are the chain of PointerType/ReferenceType/RValueReferenceType nodes under it.

Source

pub fn is_a_reference(&self) -> bool

Is this the declarator of a reference — int& r, int&& rr?

Source

pub fn is_a_pointer(&self) -> bool

Is this the declarator of a pointer — int* p? A pointer-to-a-reference is not a C++ type, so the two answers cannot both be true for one declarator in practice; the reference is checked first by the callers that care.

Source

pub fn get_type_suffix(&self) -> String

The declarator’s type parts, without its name: *, &, &&, [3], in source order.

What a type spelling needs from a declarator. The name is the declarator’s own and not part of the type, and the parameter list of a function declarator is a signature rather than a type.

Source

pub fn get_declarator_text(&self) -> String

The full spelling of this declarator including the name, trivia removed.

Source

pub fn get_param_list(&self) -> Option<CppParamList>

The parameter list, if this declarator declares a function.

§The parenthesised declarator, whose list is a sibling

void (foo) (int a, char *b); parses as

InitDeclarator  "(foo) (int a, char *b)"
  Declarator    "(foo)"
    Declarator  "foo"
  ParameterList "(int a, char *b)"      <- beside the declarator, not inside it

so the direct-child search found nothing and the declaration read as a function with no parameters. Lua writes its whole public API that way (LUA_API void (lua_setfield) (lua_State *L, int idx, const char *k);), and the measurements were: a Function fact with no parameter_list (the hover card printed lua_setfield(…) and no inlay hint was placed), and its parameters filed as file-scope variables.

The guard is the *: void (*bar)(int a); has the same node shape and is a variable declared as a function pointer, whose list belongs to the pointed-to type rather than to bar. A parenthesised declarator with a pointer or a reference inside it is that shape, and it keeps answering None.

Source

pub fn get_trailing_return_type(&self) -> Option<CppTypeId>

The trailing return type after ->, if this declarator has one.

The returned node is the TypeId inside the TrailingReturnType wrapper, so its text is the type as written (int*) and does not include the ->.

Source

pub fn get_pointer_type(&self) -> Option<CppPointerType>

The first pointer/reference operator, if any.

Source

pub fn is_function(&self) -> bool

Is this a function declarator?

True when there is a parameter list or a trailing return type. This is the test that decides whether a following { is a function body or a brace initializer.

Source

pub fn is_array(&self) -> bool

Is this an array declarator?

Source

pub fn get_array_type(&self) -> Option<CppArrayType>

Source

pub fn get_structured_binding(&self) -> Option<CppStructuredBinding>

The structured binding this declarator introduces, if it is one: the [a, b] of auto [a, b] = pair;.

Two shapes reach here, because the & of auto& [k, v] is an abstract declarator and the pattern comes after it: the StructuredBinding is either a child of this declarator or a child of the InitDeclarator beside it. Both are searched, so a caller asking “is this a binding?” gets one answer rather than having to know which spelling produced the node.

Source

pub fn is_structured_binding(&self) -> bool

Is this a structured binding declarator?

Source

pub fn get_binding_names(&self) -> Vec<CppNameToken>

The names a structured binding introduces. Empty for an ordinary declarator.

Trait Implementations§

Source§

impl Clone for CppDeclarator

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl CppAstNode for CppDeclarator

Source§

fn syntax(&self) -> &CppSyntaxNode

Source§

fn can_cast(kind: CppSyntaxKind) -> bool

Is a node of this kind a node of type Self? Read more
Source§

fn cast(syntax: CppSyntaxNode) -> Option<Self>

Source§

fn child<N: CppAstNode>(&self) -> Option<N>

The first child node of type N.
Source§

fn token<N: CppAstToken>(&self) -> Option<N>

The first child token of type N.
Source§

fn token_by_kind(&self, kind: CppTokenKind) -> Option<CppGeneralToken>

The first child token with the given kind, as a generic token.
Source§

fn children<N: CppAstNode>(&self) -> CppAstChildren<N> ⓘ

All child nodes of type N.
Source§

fn tokens<N: CppAstToken>(&self) -> CppAstTokenChildren<N> ⓘ

All child tokens of type N.
Source§

fn descendants<N: CppAstNode>(&self) -> impl Iterator<Item = N>

All descendant nodes of type N.
Source§

fn walk_descendants<N: CppAstNode>(&self) -> impl Iterator<Item = WalkEvent<N>>

All descendants of type N, with enter/leave events.
Source§

fn ancestors<N: CppAstNode>(&self) -> impl Iterator<Item = N>

All ancestor nodes of type N, innermost first.
Source§

fn get_root(&self) -> CppSyntaxNode

The root of the tree this node belongs to.
Source§

fn previous_sibling<N: CppAstNode>(&self) -> Option<N>

The sibling node immediately before this one, when it is of type N. Read more
Source§

fn next_sibling<N: CppAstNode>(&self) -> Option<N>

The sibling node immediately after this one, when it is of type N.
Source§

fn get_parent<N: CppAstNode>(&self) -> Option<N>

The parent node, if it is of type N.
Source§

fn get_position(&self) -> TextSize

Source§

fn get_range(&self) -> TextRange

Source§

fn get_self_or_ancestor<N: CppAstNode>(&self) -> Option<N>

The containing node of type N, starting from this node itself.
Source§

fn get_syntax_id(&self) -> CppSyntaxId

A storable, comparable handle to this node. See CppSyntaxId.
Source§

fn dump(&self) -> String

The tree, rendered for debugging.
Source§

impl Debug for CppDeclarator

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Eq for CppDeclarator

Source§

impl Hash for CppDeclarator

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for CppDeclarator

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for CppDeclarator

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.