Equivalent of \let via macros options
#3737
Comments
edemaine
added a commit
that referenced
this issue
Oct 22, 2022
Issue #3737 turned out to be how we handled the return value of `expandOnce`. We assumed that, if the return value isn't an `Array`, it's an `instanceof Token`. This isn't necessary true with a user's `macros` object, and given that we don't currently export `Token`, it's pretty difficult to bypass. Given that we never actually use the array return values from `expandOnce`, I changed the return value for `expandOnce` to either a `number` (to indicate the number of expanded tokens, so you could still look up the tokens in the stack if you wanted to) or `false` (to indicate no expansion happened). We can't use `0` for the latter because an actual expansion might result in zero tokens. The resulting code is arguably cleaner. I also documented that `macros` can have object expansions, and specified how to simulate `\let`. Fixes #3737
|
Is this fixed? |
|
No, it's not fixed yet in release. #3738 fixes it, but it's currently under review. Thanks for the reminder to respond to the review though. 🙂 |
|
@edemaine happy to help 😉 |
|
@MrOddlyFormal in case you're trying to use There's an undocumented |
edemaine
added a commit
that referenced
this issue
Apr 17, 2023
* fix: Support `\let` via `macros` option Issue #3737 turned out to be how we handled the return value of `expandOnce`. We assumed that, if the return value isn't an `Array`, it's an `instanceof Token`. This isn't necessary true with a user's `macros` object, and given that we don't currently export `Token`, it's pretty difficult to bypass. Given that we never actually use the array return values from `expandOnce`, I changed the return value for `expandOnce` to either a `number` (to indicate the number of expanded tokens, so you could still look up the tokens in the stack if you wanted to) or `false` (to indicate no expansion happened). We can't use `0` for the latter because an actual expansion might result in zero tokens. The resulting code is arguably cleaner. I also documented that `macros` can have object expansions, and specified how to simulate `\let`. Fixes #3737 * Revise macros documentation according to comments
KaTeX-bot
added a commit
that referenced
this issue
Apr 17, 2023
|
🎉 This issue has been resolved in version 0.16.6 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Describe the bug:
It's certainly not convenient to do the equivalent of
\let\Oldint=\intvia a user-constructuedmacrosoption. In fact, it may not be possible.To Reproduce:
Steps to reproduce the behavior, in Node or browser console:
macros = {};katex.renderToString("\\let\\Oldint=\\int\\def\\int{\\Oldint\\limits}", {macros, globalGroup: true});Object.values(macros).forEach((val) => val.tokens.forEach((token) => delete token.loc))— removelocpointers which prevent serializationconsole.log(JSON.stringify(macros))→
{"\\Oldint":{"tokens":[{"text":"\\int","noexpand":true}],"numArgs":0,"unexpandable":false},"\\int":{"tokens":[{"text":"\\limits"},{"text":"\\Oldint"}],"numArgs":0,"delimiters":[[]]}}katex.renderToString("\\int", {macros})works finekatex.renderToString("\\int", {macros: {"\\Oldint":{"tokens":[{"text":"\\int","noexpand":true}],"numArgs":0,"unexpandable":false},"\\int":{"tokens":[{"text":"\\limits"},{"text":"\\Oldint"}],"numArgs":0,"delimiters":[[]]}}})causes an infinite loop (!).Expected behavior:
Manually constructing the
macrosobject in the same shape as produced by\letshould simulate the behavior of\let.We might also want to document this shape, or otherwise make it easier to request
\letbehavior for built-in commands.Also, an infinite loop should not be possible, even with invalid
macrosinput. I would expectmaxExpandto hit a limit here if nothing else.Screenshots:
If applicable, add screenshots to help explain your problem.
Environment (please complete the following information):
Additional context:
From #3736
The text was updated successfully, but these errors were encountered: