correct macros.genSym comment doc #20633
Closed
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
Araq
reviewed
Oct 24, 2022
| ## Generates a fresh symbol that is guaranteed to be unique. The symbol | ||
| ## needs to occur in a declaration context. | ||
| ## Generates a fresh symbol. | ||
| ## if `ident` is not empty, the generated symbol maybe ambiguous. |
There was a problem hiding this comment.
No, it's really always unique, it's just that the string representation of the code might not reflect this:
of opcGenSym:
decodeBC(rkNode)
let k = regs[rb].intVal
let name = if regs[rc].node.strVal.len == 0: ":tmp"
else: regs[rc].node.strVal
if k < 0 or k > ord(high(TSymKind)):
internalError(c.config, c.debug[pc], "request to create symbol of invalid kind")
var sym = newSym(k.TSymKind, getIdent(c.cache, name), nextSymId c.idgen, c.module.owner, c.debug[pc])
incl(sym.flags, sfGenSym)
regs[ra].node = newSymNode(sym)
regs[ra].node.flags.incl nfIsRefThere was a problem hiding this comment.
the problem is the symbol id is unique but the ident id is not. which will cause ambiguous, I've seen serveral issue about macro users submited issues about this.
There was a problem hiding this comment.
So users need to understand symbols but your documentation patch makes it worse.
There was a problem hiding this comment.
okay then, someone may have good one in mind.
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.
refs: #17851