Fix cli invocation from nimscript
#109
Conversation
When calling `cli` macro from nimscript, there are compilation issues: - `nim-faststreams` is not available, therefore, `nim-serialization` does not work, due to `equalMem` being gated behind `notJSnotNims`. Dropping support for config files in nimscript contexts fixes that. - `std/strformat` raises `ValueError` for invalid format strings, but does so at runtime rather than checking types at compiletime. As it is only used for simple string concatenation in error cases, changing to simple concatenation avoids verbose error handling. - `getAppFilename()` is unavailable in `nimscript`. This was already fixed by replacing it with `appInvocation()` but two instances of direct `getAppFilename()` calls remained in default arguments. This is fixed by changing those default arguments as well. - The `!= nil` check on the `proc` in `loadImpl` does not work when called from nimscript. This is fixed by changing to `isNil`. - Passing `addr result` around to internal templates correctly creates the config, but the object ultimately being returned is not the same. Passing `var result` directly through the templates ensures that the correct `result` gets modified and is clearer than implicit capture. Applying these fixes fixes running `.nims` files with `cli` macro.
|
Related: status-im/nimbus-eth2#6681 (comment) There, the import is incorrect ( |
|
|
||
| if secondarySources != nil: | ||
| if not isNil(secondarySources): # Nim v2.0.10: `!= nil` broken in nimscript |
There was a problem hiding this comment.
type SecondarySources = object
proc loadImpl[C, SecondarySources](
Configuration: typedesc[C],
secondarySourcesRef: ref SecondarySources,
secondarySources: proc (
config: Configuration, sources: ref SecondarySources
) {.gcsafe.} = nil): Configuration =
if secondarySources != nil:
secondarySources(result, secondarySourcesRef)
template load(
Configuration: type,
secondarySources: untyped = nil): untyped =
block:
let secondarySourcesRef = new SecondarySources
loadImpl(Configuration, secondarySourcesRef, secondarySources)
type
CliConfig_33558379 = object
let config_33558380 = load(CliConfig_33558379)is repro, and it's an issue in v2.0.10 and version-2-0 but not version-2-2 or devel. Using isNil seems fine.
There was a problem hiding this comment.
it worked for me in nim c mode and only bugs out in nim e nimscript mode.
do you have a link that I should refer to in the comment here?
There was a problem hiding this comment.
I don't, because it seems to already be fixed in Nim upstream, and it's not really worth a backport if it's just allowing != nil instead of not isNil.
Can link to this comment in GitHub perhaps.
When calling
climacro from nimscript, there are compilation issues:nim-faststreamsis not available, therefore,nim-serializationdoes not work, due toequalMembeing gated behindnotJSnotNims. Dropping support for config files in nimscript contexts fixes that.std/strformatraisesValueErrorfor invalid format strings, but does so at runtime rather than checking types at compiletime. As it is only used for simple string concatenation in error cases, changing to simple concatenation avoids verbose error handling.getAppFilename()is unavailable innimscript. This was already fixed by replacing it withappInvocation()but two instances of directgetAppFilename()calls remained in default arguments. This is fixed by changing those default arguments as well.The
!= nilcheck on theprocinloadImpldoes not work when called from nimscript. This is fixed by changing toisNil.Passing
addr resultaround to internal templates correctly creates the config, but the object ultimately being returned is not the same. Passingvar resultdirectly through the templates ensures that the correctresultgets modified and is clearer than implicit capture.Applying these fixes fixes running
.nimsfiles withclimacro.