Struct swc_common::SyntaxContext
source · [−]pub struct SyntaxContext(_);
Expand description
A SyntaxContext represents a chain of macro expansions (represented by marks).
Implementations
sourceimpl SyntaxContext
impl SyntaxContext
pub const fn empty() -> Self
sourcepub fn has_mark(self, mark: Mark) -> bool
pub fn has_mark(self, mark: Mark) -> bool
Returns true
if self
is marked with mark
.
Panics if mark
is not a valid mark.
pub fn as_u32(self) -> u32
pub fn from_u32(raw: u32) -> SyntaxContext
sourcepub fn apply_mark(self, mark: Mark) -> SyntaxContext
pub fn apply_mark(self, mark: Mark) -> SyntaxContext
Extend a syntax context with a given mark and default transparency for that mark.
sourcepub fn remove_mark(&mut self) -> Mark
pub fn remove_mark(&mut self) -> Mark
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.
sourcepub fn adjust(&mut self, expansion: Mark) -> Option<Mark>
pub fn adjust(&mut self, expansion: Mark) -> Option<Mark>
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).
sourcepub fn glob_adjust(
&mut self,
expansion: Mark,
glob_ctxt: SyntaxContext
) -> Option<Option<Mark>>
pub fn glob_adjust(
&mut self,
expansion: Mark,
glob_ctxt: SyntaxContext
) -> Option<Option<Mark>>
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).
sourcepub fn reverse_glob_adjust(
&mut self,
expansion: Mark,
glob_ctxt: SyntaxContext
) -> Option<Option<Mark>>
pub fn reverse_glob_adjust(
&mut self,
expansion: Mark,
glob_ctxt: SyntaxContext
) -> Option<Option<Mark>>
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));
}
pub fn outer(self) -> Mark
Trait Implementations
sourceimpl Clone for SyntaxContext
impl Clone for SyntaxContext
sourcefn clone(&self) -> SyntaxContext
fn clone(&self) -> SyntaxContext
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresourceimpl Debug for SyntaxContext
impl Debug for SyntaxContext
sourceimpl Default for SyntaxContext
impl Default for SyntaxContext
sourcefn default() -> SyntaxContext
fn default() -> SyntaxContext
sourceimpl<'de> Deserialize<'de> for SyntaxContext
impl<'de> Deserialize<'de> for SyntaxContext
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
sourceimpl EqIgnoreSpan for SyntaxContext
impl EqIgnoreSpan for SyntaxContext
fn eq_ignore_span(&self, other: &Self) -> bool
sourceimpl Hash for SyntaxContext
impl Hash for SyntaxContext
sourceimpl Ord for SyntaxContext
impl Ord for SyntaxContext
sourcefn cmp(&self, other: &SyntaxContext) -> Ordering
fn cmp(&self, other: &SyntaxContext) -> Ordering
1.21.0 · sourcefn max(self, other: Self) -> Self
fn max(self, other: Self) -> Self
1.21.0 · sourcefn min(self, other: Self) -> Self
fn min(self, other: Self) -> Self
1.50.0 · sourcefn clamp(self, min: Self, max: Self) -> Selfwhere
Self: PartialOrd<Self>,
fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: PartialOrd<Self>,
sourceimpl PartialEq<SyntaxContext> for SyntaxContext
impl PartialEq<SyntaxContext> for SyntaxContext
sourcefn eq(&self, other: &SyntaxContext) -> bool
fn eq(&self, other: &SyntaxContext) -> bool
sourceimpl PartialOrd<SyntaxContext> for SyntaxContext
impl PartialOrd<SyntaxContext> for SyntaxContext
sourcefn partial_cmp(&self, other: &SyntaxContext) -> Option<Ordering>
fn partial_cmp(&self, other: &SyntaxContext) -> Option<Ordering>
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read more