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

Refactor Lookupable #4519

Merged
merged 1 commit into from
Nov 20, 2024
Merged

Refactor Lookupable #4519

merged 1 commit into from
Nov 20, 2024

Conversation

jackkoenig
Copy link
Contributor

@jackkoenig jackkoenig commented Nov 19, 2024

See Release Notes for description.

Contributor Checklist

  • Did you add Scaladoc to every public function/method?
  • Did you add at least one test demonstrating the PR?
  • Did you delete any extraneous printlns/debugging code?
  • Did you specify the type of improvement?
  • Did you add appropriate documentation in docs/src?
  • Did you request a desired merge strategy?
  • Did you add text to be included in the Release Notes for this change?

Type of Improvement

  • Feature (or new API)
  • API deprecation

Desired Merge Strategy

  • Squash

Release Notes

Historically, the Lookupable API is able to change the type of fields looked up from Definitions or Instances. This enabled Module fields to be looked up as Instances, as well as user-defined types to opt-in to this same Instance-boxing behavior.

This path-dependent type changing behavior is now deprecated. Looking up Modules is also deprecated, instead, the user should cast them Instances (via .toInstance). It is also deprecated to mark user-defined types as @instantiable. Instead, users should define Lookupable for their types using the new Lookupable.product[1-5] factory methods. See the Chisel website for more details.

  • Deprecate user-extension of trait Lookupable.
  • Deprecate Lookupable.lookupModule. Users should use Instances instead
    of Modules.
  • Deprecate Lookupable.isInstantiable. User should use new factories to
    implement Lookupable for their user-defined types instead.
  • Deprecate Lookupable.SimpleLookupable.
  • Add Lookupable.isLookupable factory for "simple" Lookupables.
  • Add Lookupable.product1-5 factories for Lookupables for user-defined types.
  • Add Lookupable for Tuple3-5 (already existed for Tuple2).
  • Add private LookupableImpl which is simpler to implement.

Reviewer Checklist (only modified by reviewer)

  • Did you add the appropriate labels? (Select the most appropriate one based on the "Type of Improvement")
  • Did you mark the proper milestone (Bug fix: 3.6.x, 5.x, or 6.x depending on impact, API modification or big change: 7.0)?
  • Did you review?
  • Did you check whether all relevant Contributor checkboxes have been checked?
  • Did you do one of the following when ready to merge:
    • Squash: You/ the contributor Enable auto-merge (squash), clean up the commit message, and label with Please Merge.
    • Merge: Ensure that contributor has cleaned up their commit history, then merge with Create a merge commit.

@jackkoenig jackkoenig added the Deprecation Deprecates an API, will be included in release notes label Nov 19, 2024
@jackkoenig jackkoenig added this to the 7.0 milestone Nov 19, 2024
@jackkoenig jackkoenig requested review from azidar and mwachs5 November 19, 2024 22:44
@@ -11,6 +11,10 @@ trait IsInstantiable

object IsInstantiable {
implicit class IsInstantiableExtensions[T <: IsInstantiable](i: T) {
@deprecated(
"Use of @instantiable on user-defined types is deprecated. Implement Lookupable for your type instead.",
Copy link
Contributor

Choose a reason for hiding this comment

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

should we point to website docs on this?

Copy link
Contributor

@azidar azidar left a comment

Choose a reason for hiding this comment

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

I'll approve, but please add a simpler example to both the documentation and the unit tests. Thanks!

Historically, the Lookupable API is able to change the type of fields
looked up from Definitions or Instances. This enabled Module fields to
be looked up as Instances, as well as user-defined types to opt-in to
this same Instance-boxing behavior.

This path-dependent type changing behavior is now deprecated. Looking up
Modules is also deprecated, instead, the user should cast them Instances
(via `.toInstance`). It is also deprecated to mark user-defined types as
`@instantiable`. Instead, users should define Lookupable for their types
using the new Lookupable.product[1-5] factory methods. See the Chisel
website for more details.

* Deprecate user-extension of trait Lookupable.
* Deprecate Lookupable.lookupModule. Users should use Instances instead
  of Modules.
* Deprecate Lookupable.isInstantiable. User should use new factories to
  implement Lookupable for their user-defined types instead.
* Deprecate Lookupable.SimpleLookupable.
* Add Lookupable.isLookupable factory for "simple" Lookupables.
* Add Lookupable.product1-5 factories for Lookupables for user-defined types.
* Add Lookupable for Tuple3-5 (already existed for Tuple2).
* Add private LookupableImpl which is simpler to implement.
@jackkoenig jackkoenig enabled auto-merge (squash) November 20, 2024 05:06
@jackkoenig jackkoenig merged commit ec4e2d5 into main Nov 20, 2024
15 checks passed
@jackkoenig jackkoenig deleted the refactor-lookupable branch November 20, 2024 05:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Deprecation Deprecates an API, will be included in release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants