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

add Path property type #3511

Merged
merged 2 commits into from Aug 29, 2023
Merged

add Path property type #3511

merged 2 commits into from Aug 29, 2023

Conversation

albertchen-sifive
Copy link
Contributor

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)
    Adds new public PathType class that represents a path to a hardware instance or member. Adds PathPropertyType/PathPropertyLiteral and PropertyType instances for module/data/mem.

Desired Merge Strategy

  • Squash: The PR will be squashed and merged (choose this if you have no preference).

Release Notes

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.5.x, 3.6.x, or 5.x depending on impact, API modification or big change: 6.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.

@albertchen-sifive albertchen-sifive added the Feature New feature, will be included in release notes label Aug 28, 2023
Comment on lines 38 to 42
def apply(data: Data): PathType = {
new PathType {
def toTarget(): IsMember = data.toAbsoluteTarget
}
}
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm going to approve this as is, but we really validate at this point if the Data can have a target. I'm mainly thinking about things like PathType(3.U) which will result an an exception thrown later when .toAbsoluteTarget is actually called.


/** Represent a Path type for referencing a hardware instance or member in a Property[PathType]
*/
sealed abstract class PathType {
Copy link
Contributor

Choose a reason for hiding this comment

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

Should this be PathType or perhaps just Path? It's Path in firrtl.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

renamed to Path

Copy link
Contributor

@jackkoenig jackkoenig left a comment

Choose a reason for hiding this comment

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

Implementation LGTM, just wondering if we should be calling this Path instead of PathType.

@sequencer
Copy link
Member

Interesting. Maybe this is the real replacement to TraceAPI

@albertchen-sifive albertchen-sifive merged commit 2fd6f40 into main Aug 29, 2023
15 checks passed
@albertchen-sifive albertchen-sifive deleted the path-properties branch August 29, 2023 02:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature New feature, will be included in release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants