Skip to content

Generate location() accessor for each node type #74

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.

Sign up for GitHub

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

Merged
alexcrocha merged 1 commit into from
Dec 18, 2025
Merged

Generate location() accessor for each node type #74

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
68 changes: 66 additions & 2 deletions rust/ruby-rbs/build.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -350,6 +350,16 @@ fn generate(config: &Config) -> Result<(), Box<dyn Error>> {
writeln!(file, " pub fn as_node(self) -> Node {{")?;
writeln!(file, " Node::{}(self)", node.variant_name())?;
writeln!(file, " }}")?;
writeln!(file)?;
writeln!(file, " /// Returns the location of this node.")?;
writeln!(file, " #[must_use]")?;
writeln!(file, " pub fn location(&self) -> RBSLocation {{")?;
writeln!(
file,
" RBSLocation::new(unsafe {{ (*self.pointer).base.location }})"
)?;
writeln!(file, " }}")?;
writeln!(file)?;

if let Some(fields) = &node.fields {
for field in fields {
Expand Down Expand Up @@ -379,10 +389,64 @@ fn generate(config: &Config) -> Result<(), Box<dyn Error>> {
write_node_field_accessor(&mut file, field, "RBSHash")?;
}
"rbs_location" => {
write_node_field_accessor(&mut file, field, "RBSLocation")?;
if field.optional {
writeln!(
file,
" pub fn {}(&self) -> Option<RBSLocation> {{",
field.name
)?;
writeln!(
file,
" let ptr = unsafe {{ (*self.pointer).{} }};",
field.c_name()
)?;
writeln!(file, " if ptr.is_null() {{")?;
writeln!(file, " None")?;
writeln!(file, " }} else {{")?;
writeln!(file, " Some(RBSLocation {{ pointer: ptr }})")?;
writeln!(file, " }}")?;
writeln!(file, " }}")?;
} else {
writeln!(file, " pub fn {}(&self) -> RBSLocation {{", field.name)?;
writeln!(
file,
" RBSLocation {{ pointer: unsafe {{ (*self.pointer).{} }} }}",
field.c_name()
)?;
writeln!(file, " }}")?;
}
}
"rbs_location_list" => {
write_node_field_accessor(&mut file, field, "RBSLocationList")?;
if field.optional {
writeln!(
file,
" pub fn {}(&self) -> Option<RBSLocationList> {{",
field.name
)?;
writeln!(
file,
" let ptr = unsafe {{ (*self.pointer).{} }};",
field.c_name()
)?;
writeln!(file, " if ptr.is_null() {{")?;
writeln!(file, " None")?;
writeln!(file, " }} else {{")?;
writeln!(file, " Some(RBSLocationList {{ pointer: ptr }})")?;
writeln!(file, " }}")?;
writeln!(file, " }}")?;
} else {
writeln!(
file,
" pub fn {}(&self) -> RBSLocationList {{",
field.name
)?;
writeln!(
file,
" RBSLocationList {{ pointer: unsafe {{ (*self.pointer).{} }} }}",
field.c_name()
)?;
writeln!(file, " }}")?;
}
}
"rbs_namespace" => {
write_node_field_accessor(&mut file, field, "NamespaceNode")?;
Expand Down
47 changes: 35 additions & 12 deletions rust/ruby-rbs/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,27 +134,24 @@ impl Iterator for RBSHashIter {

pub struct RBSLocation {
pointer: *const rbs_location_t,
Copy link
Copy Markdown
Member

@st0012 st0012 Dec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this positional change required for the function? Or it's just cosmetic

Copy link
Copy Markdown
Author

@alexcrocha alexcrocha Dec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just cosmetic.
I have been wanting to a code clean up PR for a while. And since I am working with RBSLocation here, I decided to standardize right away.

Copy link
Copy Markdown
Author

@alexcrocha alexcrocha Dec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ended up removing it altogether as it's not needed, as per feedback below.

#[allow(dead_code)]
parser: *mut rbs_parser_t,
}

impl RBSLocation {
pub fn new(pointer: *const rbs_location_t, parser: *mut rbs_parser_t) -> Self {
Self { pointer, parser }
pub fn new(pointer: *const rbs_location_t) -> Self {
Self { pointer }
}

pub fn start_loc(&self) -> i32 {
pub fn start(&self) -> i32 {
unsafe { (*self.pointer).rg.start.byte_pos }
}

pub fn end_loc(&self) -> i32 {
pub fn end(&self) -> i32 {
unsafe { (*self.pointer).rg.end.byte_pos }
}
}

pub struct RBSLocationListIter {
current: *mut rbs_location_list_node_t,
parser: *mut rbs_parser_t,
}

impl Iterator for RBSLocationListIter {
Expand All @@ -165,7 +162,7 @@ impl Iterator for RBSLocationListIter {
None
} else {
let pointer_data = unsafe { *self.current };
let loc = RBSLocation::new(pointer_data.loc, self.parser);
let loc = RBSLocation::new(pointer_data.loc);
self.current = pointer_data.next;
Some(loc)
}
Expand All @@ -174,20 +171,18 @@ impl Iterator for RBSLocationListIter {

pub struct RBSLocationList {
pointer: *mut rbs_location_list,
parser: *mut rbs_parser_t,
}

impl RBSLocationList {
pub fn new(pointer: *mut rbs_location_list, parser: *mut rbs_parser_t) -> Self {
Self { pointer, parser }
pub fn new(pointer: *mut rbs_location_list) -> Self {
Self { pointer }
}

/// Returns an iterator over the locations.
#[must_use]
pub fn iter(&self) -> RBSLocationListIter {
RBSLocationListIter {
current: unsafe { (*self.pointer).head },
parser: self.parser,
}
}
}
Expand Down Expand Up @@ -435,4 +430,32 @@ mod tests {
visitor.visited
);
}

#[test]
fn test_node_location_ranges() {
let rbs_code = r#"type foo = 1"#;
let signature = parse(rbs_code.as_bytes()).unwrap();

let declaration = signature.declarations().iter().next().unwrap();
let Node::TypeAlias(type_alias) = declaration else {
panic!("Expected TypeAlias");
};

// TypeAlias spans the entire declaration
let loc = type_alias.location();
assert_eq!(0, loc.start());
assert_eq!(12, loc.end());

// The literal "1" is at position 11-12
let Node::LiteralType(literal) = type_alias.type_() else {
panic!("Expected LiteralType");
};
let Node::Integer(integer) = literal.literal() else {
panic!("Expected Integer");
};

let int_loc = integer.location();
assert_eq!(11, int_loc.start());
assert_eq!(12, int_loc.end());
}
}
Loading