Ref #1589: Add error message for bad symbolic reference. #3605
Conversation
dottybot
left a comment
dottybot
left a comment
There was a problem hiding this comment.
Hello, and thank you for opening this PR! 🎉
All contributors have signed the CLA, thank you! ❤️
Commit Messages
We want to keep history, but for that to actually be useful we have
some rules on how to format our commit messages (relevant xkcd).
Please stick to these guidelines for commit messages:
- Separate subject from body with a blank line
- When fixing an issue, start your commit message with
Fix #<ISSUE-NBR>:- Limit the subject line to 72 characters
- Capitalize the subject line
- Do not end the subject line with a period
- Use the imperative mood in the subject line ("Added" instead of "Add")
- Wrap the body at 80 characters
- Use the body to explain what and why vs. how
adapted from https://chris.beams.io/posts/git-commit
Have an awesome day! ☀️
| |the classpath might be incompatible with the version used when compiling $src.""" | ||
| ctx.error(errMsg) | ||
| if (ctx.debug) throw new Error() | ||
| val errMsg = BadSymbolicReference(location, name, denot.owner, src) |
| name: String, | ||
| denotationOwner: Symbol, | ||
| src: String | ||
| )(implicit ctx: Context) extends Message(BadSymbolicReferenceID) { |
There was a problem hiding this comment.
I would change BadSymbolicReference so that it only has denot: SymDenotation. You can derive location, name, owner and src from denot.
| import config.Config | ||
| import config.Printers.{incremental, noPrinter} | ||
| import reporting.diagnostic.Message | ||
| import reporting.diagnostic.messages._ |
There was a problem hiding this comment.
Only import what you need
| private val (location, src) = | ||
| if (file != null) (s" in $file", file.toString) | ||
| else ("", "the signature") | ||
| private val name = ctx.fresh.setSetting(ctx.settings.YdebugNames, true).nameString(denot.name) |
There was a problem hiding this comment.
We usually don't create fields to only store temporary values. If you need to precompute something for msg , you can use a block:
val msg = {
val tmp1 = ...
val tmp2 = ...
doSomethingWith(tmp1, tmp2)
}If a temporary computation is shared like name, we usually make it a def. We might want to create a field if we don't want to perform a computation multiple times. In this case I guess it make sense to keep name a field since ctx.fresh... may be expensive.
| val msg = | ||
| hl"""Bad symbolic reference. A signature$location | ||
| |refers to $name in ${denotationOwner.showKind} ${denotationOwner.showFullName} which is not available. | ||
| |refers to $name in ${denot.owner.showKind} ${denot.owner.showFullName} which is not available. |
There was a problem hiding this comment.
Here you can also store the result of owner in a temporary val within the block
3 participants
Regarding #1589, this PR addresses the following error: