fix: repeated verbatim arguments using depth#132
Open
robmcl4 wants to merge 1 commit into
Open
Conversation
Fixes an issue related to `verbatim` formatted arguments
failing to parse. Consider documents which define a macro
which accepts a verbatim argument, for example \my_macro{..}.
The macro may accept embedded {} blocks, for example:
\my_macro{foo{bar}}. This is valid LaTeX and the argument
should be parsed literally as 'foo{bar}'.
The issue arises because the verbatim parser tracks depth
via an instance variable `depth_counter`. It is initialized
to `depth_counter = 1`. However, after parsing the first
verbatim argument it decreases to `0`, then after the following
it decreases again to `-1`, etc.
This causes early termination of parsing in subsequent verbatim parses
which make meaningful use of the depth counter, and the
remainder of the document will fail to parse correctly.
For example, the following would fail to parse correctly:
`\my_macro{foo} \my_macro{bar{}}`.
The fix is to reset the depth counter to `1` whenever the
parsing procedure begins.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Fixes an issue related to
verbatimformatted arguments failing to parse. Consider documents which define a macro which accepts a verbatim argument, for example\my_macro{..}. The macro may accept embedded{}blocks, for example:\my_macro{foo{bar}}. This is valid LaTeX and the argument should be parsed literally as'foo{bar}'.The issue arises because the verbatim parser tracks depth via an instance variable
depth_counter. It is initialized todepth_counter = 1. However, after parsing the first verbatim argument it decreases to0, then after the following it decreases again to-1, etc.This causes early termination of parsing in subsequent verbatim parses which make meaningful use of the depth counter, and the remainder of the document will fail to parse correctly.
For example, the following would fail to parse correctly:
\my_macro{foo} \my_macro{bar{}}.The fix is to reset the depth counter to
1whenever the parsing procedure begins.