Require Fw Types in dictionary #686
Open
Conversation
This file contains hidden or 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
bocchino
requested changes
Apr 30, 2025
Comment on lines
+74
to
+75
| /** The dictionary generation mode */ | ||
| dictionaryMode: Boolean = false, |
There was a problem hiding this comment.
Let's rename this variable to be a predicate:
Suggested change
| /** The dictionary generation mode */ | |
| dictionaryMode: Boolean = false, | |
| /** Whether a dictionary is needed in code generation */ | |
| dictionaryNeeded: Boolean = false, |
| for { | ||
| symbol <- Result.annotateResult( | ||
| helpers.getSymbolForName(mapping)(node1.id, t), | ||
| s"Dictionary requires type ${t} to be defined.") |
There was a problem hiding this comment.
Let's add another check here to ensure that the type has an integer type as its underlying type. If not, we can return a TypeError saying that an integer type is required.
| } | ||
| } | ||
|
|
||
| } | ||
|
|
||
| /** Annotated error for including additional notes */ |
There was a problem hiding this comment.
Suggested change
| /** Annotated error for including additional notes */ | |
| /** An error with a note */ |
| @@ -1452,6 +1452,23 @@ The JSON format is specified in the | |||
| https://fprime.jpl.nasa.gov/devel/docs/reference/fpp-json-dict/[F Prime design | |||
| documentation]. | |||
|
|
|||
| When generating dictionaries with `fpp-to-dict`, the following types must be defined | |||
| in FPP (either in the input model itself or in a dependency file): | |||
There was a problem hiding this comment.
Let's say also that each of the defined types has to be an alias of an integer type.
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.
Closes #666.