Make "deprecated public" binding APIs private #4177
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jackkoenig
force-pushed
the
privatize-binding
branch
from
cbbde30
to
4054f73
Compare
jackkoenig
commented
Jun 14, 2024
Comment on lines
-12
to
+29
| // Element only direction used for the Binding system only. | ||
| private[chisel3] sealed abstract class BindingDirection | ||
| private[chisel3] object BindingDirection { | ||
|
|
||
| /** Internal type or wire | ||
| */ | ||
| case object Internal extends BindingDirection | ||
|
|
||
| /** Module port with output direction | ||
| */ | ||
| case object Output extends BindingDirection | ||
|
|
||
| /** Module port with input direction | ||
| */ | ||
| case object Input extends BindingDirection | ||
|
|
||
| /** Determine the BindingDirection of an Element given its top binding and resolved direction. | ||
| */ | ||
| def from(binding: TopBinding, direction: ActualDirection): BindingDirection = { | ||
| binding match { | ||
| case _: PortBinding | _: SecretPortBinding => | ||
| direction match { | ||
| case ActualDirection.Output => Output | ||
| case ActualDirection.Input => Input | ||
| case dir => throw new RuntimeException(s"Unexpected port element direction '$dir'") | ||
| } | ||
| case _ => Internal | ||
| private[chisel3] object binding { | ||
|
|
||
| // Element only direction used for the Binding system only. | ||
| sealed abstract class BindingDirection | ||
| object BindingDirection { | ||
|
|
||
| /** Internal type or wire | ||
| */ | ||
| case object Internal extends BindingDirection | ||
|
|
||
| /** Module port with output direction | ||
| */ | ||
| case object Output extends BindingDirection | ||
|
|
||
| /** Module port with input direction | ||
| */ | ||
| case object Input extends BindingDirection | ||
|
|
There was a problem hiding this comment.
This diff looks crazy, but all it is is adding private[chisel3] object binding {, tabbing everything over, and deleting all nested private[chisel3] and deprecation messages. It's split into 2 commits that at least makes that more clear in the normal commit history. I'll merge with a merge commit.
This is done by adding a new package private object "binding" within which all bindings live. This required changing imports in lots of files but it makes it much easier to not accidentally create a public binding in the future.
These are no longer needed now that all binding are packaged up in a package private object.
jackkoenig
force-pushed
the
privatize-binding
branch
from
4054f73
to
cf72316
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is done by adding a new package private object "binding" within
which all bindings live. This required changing imports in lots of files
but it makes it much easier to not accidentally create a public binding
in the future.
Contributor Checklist
docs/src?Type of Improvement
Desired Merge Strategy
Release Notes
These
chisel3.internalAPIs should never have been public in the first place.Reviewer Checklist (only modified by reviewer)
3.6.x,5.x, or6.xdepending on impact, API modification or big change:7.0)?Enable auto-merge (squash), clean up the commit message, and label withPlease Merge.Create a merge commit.