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

Feature/omit non private modifiers on private types #1398

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

polarene
Copy link

When generating the string representation of functions inside a private type, all non-private modifiers (PUBLIC, INTERNAL) are omitted.

Fixes #1301

@polarene
Copy link
Author

If you accept this PR, please add the "hacktoberfest-accepted" label, thank you.

@@ -299,10 +300,10 @@ public class TypeSpec private constructor(
}

// Functions.
for (funSpec in funSpecs) {
for (funSpec in funSpecsOmittingVisibility()) {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Not sure it makes sense to filter out the modifiers both here and when passing the implicit modifiers to funSpec.emit() - maybe we should simply add unnecessary visibility modifiers to implicitModifiers if the type is private? Any reason why that wouldn't work?

Copy link
Member

Choose a reason for hiding this comment

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

Hopefully that also adds support for properties which I suspect exhibit the same behavior.

Copy link
Author

@polarene polarene Oct 28, 2022

Choose a reason for hiding this comment

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

Honestly, I don't know the library this deep... I tried to reverse engineer how the mechanism works and found out that filtering here before emit() caused the least amount of code changes. What would you suggest as a better approach? Also, I limited the scope to functions only, following the issue description, but if you want we can extend it to properties as well, need to double-check.

Copy link
Author

@polarene polarene Oct 28, 2022

Choose a reason for hiding this comment

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

I think when I did the initial implementation, I tried to add visibility modifiers to implicitModifiers but that didn't work for PUBLIC, since it undergoes a contrived logic I couldn't fully grasp and didn't feel confident modifying that, so I turned to this approach.

Copy link
Author

Choose a reason for hiding this comment

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

@Egorand so what should we do with this implementation, do you have any advice?

Copy link
Collaborator

Choose a reason for hiding this comment

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

I think the least amount of changes should not be the priority here, and your PR IMO adds complexity rather than reducing it. I believe implicitModifiers is the right tool for the job, and it'd be great to remove the obstacles preventing it from working correctly - e.g. the custom handling of PUBLIC should probably be removed in favour of achieving the same result with implicitModifiers. This will likely require deeper knowledge of the library's inner workings and understand if you don't have the time to invest, but I don't think current approach is the best one.

Copy link
Author

Choose a reason for hiding this comment

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

Ok, thanks for your feedback. You're right, this solution increases complexity and it was a quick workaround for implicitModifiers not working as expected. I'll try to dedicate some time to this issue and rework the solution following your guidelines.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Thank you!

@Egorand Egorand changed the base branch from master to main July 5, 2023 09:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Omit more permissive modifiers on restricted visibility types
3 participants