Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add name_stable_ptr methods and GetName trait for AST objects #7254

Merged
merged 4 commits into from
Feb 11, 2025
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions crates/cairo-lang-defs/src/ids.rs
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ use cairo_lang_debug::debug::DebugWithDb;
use cairo_lang_diagnostics::Maybe;
pub use cairo_lang_filesystem::ids::UnstableSalsaId;
use cairo_lang_filesystem::ids::{CrateId, FileId};
use cairo_lang_syntax::node::ast::TerminalIdentifierGreen;
use cairo_lang_syntax::node::ast::{TerminalIdentifierGreen, TerminalIdentifierPtr};
use cairo_lang_syntax::node::db::SyntaxGroup;
use cairo_lang_syntax::node::helpers::{GetIdentifier, NameGreen};
use cairo_lang_syntax::node::helpers::{GetIdentifier, GetName, NameGreen};
use cairo_lang_syntax::node::ids::SyntaxStablePtrId;
use cairo_lang_syntax::node::kind::SyntaxKind;
use cairo_lang_syntax::node::stable_ptr::SyntaxStablePtr;
Expand Down Expand Up @@ -55,9 +55,11 @@ pub trait LanguageElementId {

pub trait NamedLanguageElementLongId {
fn name(&self, db: &dyn DefsGroup) -> SmolStr;
fn name_stable_ptr(&self, db: &dyn DefsGroup) -> TerminalIdentifierPtr;
}
pub trait NamedLanguageElementId: LanguageElementId {
fn name(&self, db: &dyn DefsGroup) -> SmolStr;
fn name_stable_ptr(&self, db: &dyn DefsGroup) -> TerminalIdentifierPtr;
}
pub trait TopLevelLanguageElementId: NamedLanguageElementId {
fn full_path(&self, db: &dyn DefsGroup) -> String {
Expand Down Expand Up @@ -109,11 +111,18 @@ macro_rules! define_named_language_element_id {
let terminal_green = self.1.name_green(syntax_db);
terminal_green.identifier(syntax_db)
}
fn name_stable_ptr(&self, db: &dyn DefsGroup) -> TerminalIdentifierPtr {
let syntax_db = db.upcast();
self.1.lookup(syntax_db).name(syntax_db).stable_ptr()
}
}
impl NamedLanguageElementId for $short_id {
fn name(&self, db: &dyn DefsGroup) -> SmolStr {
db.$lookup(*self).name(db)
}
fn name_stable_ptr(&self, db: &dyn DefsGroup) -> TerminalIdentifierPtr {
db.$lookup(*self).name_stable_ptr(db)
}
}
};
}
Expand Down Expand Up @@ -254,6 +263,13 @@ macro_rules! toplevel_enum {
)*
}
}
fn name_stable_ptr(&self, db: &dyn DefsGroup) -> TerminalIdentifierPtr {
match self {
$(
$enum_name::$variant(id) => id.name_stable_ptr(db),
)*
}
}
}
impl TopLevelLanguageElementId for $enum_name {}
}
Expand Down Expand Up @@ -1192,6 +1208,7 @@ impl ImplItemId {
}

define_language_element_id_as_enum! {
#[toplevel]
/// Items for resolver lookups.
/// These are top items that hold semantic information.
/// Semantic info lookups should be performed against these items.
Expand Down
39 changes: 36 additions & 3 deletions crates/cairo-lang-syntax/src/node/helpers.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ use super::ast::{
ImplItem, ItemConstant, ItemEnum, ItemExternFunction, ItemExternFunctionPtr, ItemExternType,
ItemImpl, ItemImplAlias, ItemInlineMacro, ItemModule, ItemStruct, ItemTrait, ItemTypeAlias,
ItemUse, Member, Modifier, ModuleItem, OptionArgListParenthesized, Statement, StatementBreak,
StatementContinue, StatementExpr, StatementLet, StatementReturn, TerminalIdentifierGreen,
TokenIdentifierGreen, TraitItem, TraitItemConstant, TraitItemFunction, TraitItemFunctionPtr,
TraitItemImpl, TraitItemType, UsePathLeaf, Variant, WrappedArgList,
StatementContinue, StatementExpr, StatementLet, StatementReturn, TerminalIdentifier,
TerminalIdentifierGreen, TokenIdentifierGreen, TraitItem, TraitItemConstant, TraitItemFunction,
TraitItemFunctionPtr, TraitItemImpl, TraitItemType, UsePathLeaf, Variant, WrappedArgList,
};
use super::db::SyntaxGroup;
use super::ids::SyntaxStablePtrId;
Expand Down Expand Up @@ -156,6 +156,39 @@ impl NameGreen for TraitItemFunctionPtr {
}
}

/// Provides methods to extract a _name_ of AST objects.
pub trait GetName {
/// Gets a [`TerminalIdentifier`] that represents a _name_ of this AST object.
fn name(&self, db: &dyn SyntaxGroup) -> ast::TerminalIdentifier;
}

impl GetName for FunctionWithBody {
fn name(&self, db: &dyn SyntaxGroup) -> TerminalIdentifier {
self.declaration(db).name(db)
}
}

impl GetName for ItemExternFunction {
fn name(&self, db: &dyn SyntaxGroup) -> TerminalIdentifier {
self.declaration(db).name(db)
}
}

impl GetName for TraitItemFunction {
fn name(&self, db: &dyn SyntaxGroup) -> TerminalIdentifier {
self.declaration(db).name(db)
}
}

impl GetName for UsePathLeaf {
fn name(&self, db: &dyn SyntaxGroup) -> TerminalIdentifier {
match self.alias_clause(db) {
ast::OptionAliasClause::Empty(_) => self.ident(db).identifier_ast(db),
ast::OptionAliasClause::AliasClause(alias) => alias.alias(db),
}
}
}

pub trait GenericParamEx {
/// Returns the name of a generic param if one exists.
fn name(&self, db: &dyn SyntaxGroup) -> Option<ast::TerminalIdentifier>;
Expand Down