Struct SyntaxContext

#[repr(C)]
pub struct SyntaxContext(/* private fields */);

Available on crate feature __common only.

Expand description

A SyntaxContext represents a chain of macro expansions (represented by marks).

Implementations§

§

impl SyntaxContext

pub fn within_ignored_ctxt<F, Ret>(op: F) -> Ret
where F: FnOnce() -> Ret,

Available on crate features __ecma and __utils only.

In op, EqIgnoreSpan of [Ident] will ignore the syntax context.

§

impl SyntaxContext

pub const fn empty() -> SyntaxContext

Available on crate features __ecma and __utils only.

pub fn has_mark(self, mark: Mark) -> bool

Available on crate features __ecma and __utils only.

Returns true if self is marked with mark.

Panics if mark is not a valid mark.

pub fn as_u32(self) -> u32

Available on crate features __ecma and __utils only.

pub fn from_u32(raw: u32) -> SyntaxContext

Available on crate features __ecma and __utils only.

pub fn apply_mark(self, mark: Mark) -> SyntaxContext

Available on crate features __ecma and __utils only.

Extend a syntax context with a given mark and default transparency for that mark.

pub fn remove_mark(&mut self) -> Mark

Available on crate features __ecma and __utils only.

Pulls a single mark off of the syntax context. This effectively moves the context up one macro definition level. That is, if we have a nested macro definition as follows:

macro_rules! f {
   macro_rules! g {
       ...
   }
}

and we have a SyntaxContext that is referring to something declared by an invocation of g (call it g1), calling remove_mark will result in the SyntaxContext for the invocation of f that created g1. Returns the mark that was removed.

pub fn adjust(&mut self, expansion: Mark) -> Option

Available on crate features __ecma and __utils only.

Adjust this context for resolution in a scope created by the given expansion. For example, consider the following three resolutions of f:

mod foo {
    pub fn f() {}
} // `f`'s `SyntaxContext` is empty.
m!(f);
macro m($f:ident) {
    mod bar {
        pub fn f() {} // `f`'s `SyntaxContext` has a single `Mark` from `m`.
        pub fn $f() {} // `$f`'s `SyntaxContext` is empty.
    }
    foo::f(); // `f`'s `SyntaxContext` has a single `Mark` from `m`
              //^ Since `mod foo` is outside this expansion, `adjust` removes the mark from `f`,
              //| and it resolves to `::foo::f`.
    bar::f(); // `f`'s `SyntaxContext` has a single `Mark` from `m`
              //^ Since `mod bar` not outside this expansion, `adjust` does not change `f`,
              //| and it resolves to `::bar::f`.
    bar::$f(); // `f`'s `SyntaxContext` is empty.
               //^ Since `mod bar` is not outside this expansion, `adjust` does not change `$f`,
               //| and it resolves to `::bar::$f`.
}

This returns the expansion whose definition scope we use to privacy check the resolution, or None if we privacy check as usual (i.e. not w.r.t. a macro definition scope).

pub fn glob_adjust( &mut self, expansion: Mark, glob_ctxt: SyntaxContext, ) -> Option<Option>

Available on crate features __ecma and __utils only.

Adjust this context for resolution in a scope created by the given expansion via a glob import with the given SyntaxContext. For example:

m!(f);
macro m($i:ident) {
    mod foo {
        pub fn f() {} // `f`'s `SyntaxContext` has a single `Mark` from `m`.
        pub fn $i() {} // `$i`'s `SyntaxContext` is empty.
    }
    n(f);
    macro n($j:ident) {
        use foo::*;
        f(); // `f`'s `SyntaxContext` has a mark from `m` and a mark from `n`
             //^ `glob_adjust` removes the mark from `n`, so this resolves to `foo::f`.
        $i(); // `$i`'s `SyntaxContext` has a mark from `n`
              //^ `glob_adjust` removes the mark from `n`, so this resolves to `foo::$i`.
        $j(); // `$j`'s `SyntaxContext` has a mark from `m`
              //^ This cannot be glob-adjusted, so this is a resolution error.
    }
}

This returns None if the context cannot be glob-adjusted. Otherwise, it returns the scope to use when privacy checking (see adjust for details).

pub fn reverse_glob_adjust( &mut self, expansion: Mark, glob_ctxt: SyntaxContext, ) -> Option<Option>

Available on crate features __ecma and __utils only.

Undo glob_adjust if possible:

if let Some(privacy_checking_scope) = self.reverse_glob_adjust(expansion, glob_ctxt) {
    assert!(self.glob_adjust(expansion, glob_ctxt) == Some(privacy_checking_scope));
}