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

Access current module data in FunctionDefinition and StructDefinition #5953

Closed
Thunkar opened this issue Sep 6, 2024 · 0 comments · Fixed by #5956
Closed

Access current module data in FunctionDefinition and StructDefinition #5953

Thunkar opened this issue Sep 6, 2024 · 0 comments · Fixed by #5956
Labels
enhancement New feature or request

Comments

@Thunkar
Copy link
Contributor

Thunkar commented Sep 6, 2024

Problem

It's sometimes necessary to learn about module data inside a func/struct annotation. This is required for initializer checks in aztec.nr: Inside #[private] annotation we have to check whether any other function in the contract is an initializer.

Happy Case

The Module object in which the current fn/struct lives is available via annotations:

#[my_struct_annotation]
struct foo {}

#[my_fn_annotation]
fn bar() {}

comptime fn my_fn_annotation(f: FunctionDefinition) {
  let m: Module = f.get_module();
}

comptime fn my_struct_annotation(s: StructDefinition) {
  let m: Module = s.get_module();
}

Workaround

Yes

Workaround Description

It's probably possible to modify all functions in a top-level annotation in the contract, but it is a lot uglier since we would have a giant single annotation and would lose debugability.

Additional Context

No response

Project Impact

Nice-to-have

Blocker Context

No response

Would you like to submit a PR for this Issue?

None

Support Needs

No response

@Thunkar Thunkar added the enhancement New feature or request label Sep 6, 2024
@github-project-automation github-project-automation bot moved this to 📋 Backlog in Noir Sep 6, 2024
github-merge-queue bot pushed a commit that referenced this issue Sep 6, 2024
…#5956)

# Description

## Problem

Resolves #5953

## Summary

## Additional Context

## Documentation

Check one:
- [ ] No documentation needed.
- [x] Documentation included in this PR.
- [ ] **[For Experimental Features]** Documentation to be submitted in a
separate PR.

# PR Checklist

- [x] I have tested the changes locally.
- [x] I have formatted the changes with [Prettier](https://prettier.io/)
and/or `cargo fmt` on default settings.
@github-project-automation github-project-automation bot moved this from 📋 Backlog to ✅ Done in Noir Sep 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant