Skip to main content

OrphanedNamespaceScopeIndex

Struct OrphanedNamespaceScopeIndex 

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

The namespaces C++ parse recovery drops from a file’s tree.

When tree-sitter cannot parse a construct inside a namespace body it closes an inner scope with a MISSING brace, or skips an opening brace into an ERROR node. Every real } after that then closes one scope too early: a class body’s } closes the namespace, the namespace’s own } closes its parent, and the outermost real closes land in a trailing ERROR node. The declarations between a stolen close and the real one keep their byte positions but lose their namespace_definition ancestors (Catch2’s catch_matchers_templated.hpp, issue #1537).

Braces balance in source that compiles, so the lost scopes are exactly what a brace stack over tree-sitter’s own tokens leaves open. Within one node, in child order: a real { opens a scope (the node’s namespace when the node is a named namespace body, otherwise an opaque scope); a real } closes the innermost open scope, or is owed to the parent when the node has none open; a MISSING brace is not a token and does nothing; a child without errors is balanced and contributes nothing; an error-marked child contributes the closes it owes and the scopes it leaves open. Whatever is open before a child starts, beyond the node’s own scope, is what the parse lost for that child. Consecutive children with the same lost namespaces form one RecoveredNamespaceRegion. A file without parse errors has no regions.

Implementations§

Source§

impl OrphanedNamespaceScopeIndex

Source

pub fn build(root: Node<'_>, source: &str) -> Self

Source

pub fn is_empty(&self) -> bool

Source

pub fn approximate_size(&self) -> usize

The bytes this index holds, for the analyzer cache’s weight.

Source

pub fn region_at(&self, byte: usize) -> Option<&RecoveredNamespaceRegion>

The innermost recovered region containing byte.

Source

pub fn enclosing_namespace_components( &self, node: Node<'_>, source: &str, ) -> Vec<String>

The enclosing namespaces of node, outermost first, restoring the ones parse recovery dropped from its ancestor chain. The one answer both lookup directions and declaration collection use (issue #1537).

Source

pub fn restore_enclosing_namespaces( &self, parsed: Vec<(usize, Vec<String>)>, node_start: usize, ) -> Vec<String>

Self::enclosing_namespace_components for a caller that has already climbed the ancestor chain: parsed lists the node’s named namespace_definition ancestors outermost first, each with its start byte. A region covering the node supplies every namespace outside it; only the parsed ancestors that start inside the region still apply.

Trait Implementations§

Source§

impl Clone for OrphanedNamespaceScopeIndex

Source§

fn clone(&self) -> OrphanedNamespaceScopeIndex

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 Debug for OrphanedNamespaceScopeIndex

Source§

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

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

impl Default for OrphanedNamespaceScopeIndex

Source§

fn default() -> OrphanedNamespaceScopeIndex

Returns the “default value” for a type. Read more

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> CapabilityProvider for T
where T: Any,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

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<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> Same for T

Source§

type Output = T

Should always be Self
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.