Update comments to better indicate the supported VT functions #4752
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.
Summary of the Pull Request
Most of the methods in the
ITermDispatch
interface have a comment following them that indicates the VT function that they implement. These comments are then used by the script in PR #1884 to generate a table of supported VT functions. This PR updates some of those comments, to more accurately reflect the functions that are actually supported.References
PR #1884
PR Checklist
Detailed Description of the Pull Request / Additional comments
In some cases there are methods that implement multiple VT functions which are essentially aliases. Originally the comments listed only one of the functions, so I've now updated them to list both. This includes
HPA
as an alias ofCHA
, andHVP
as an alias ofCUP
.Similarly, some control characters are implemented in terms of another VT function, but only the main function was listed in the comment. Again I've now updated the comments to list both the main function and any related control characters. This includes
BS
(sharing the same method asCUB
),HT
(the same method asCHT
), andLF
,FF
, andVT
(the same method asIND
andNEL
).Then there were some minor corrections. The
DeviceAttributes
method was commented asDA
, but it really should beDA1
.DesignateCharset
was simply commented as DesignateCharset, when it should beSCS
. TheDECSCNM
comment was missing a space, so it wasn't picked up by the script. And theSetColumns
comment mistakenly includedDECSCPP
, but we don't actually support that.Finally there is the
DeviceStatusReport
method, which potentially covers a wide range of different reports. But for now we only support the Cursor Position Report, so I've commented it asDSR, DSR-CPR
to more clearly indicate our level of support. In the long term we'll probably need a better way of handling these reports though.Validation Steps Performed
I've run the script from PR #1884 and confirmed that the output is now a more accurate reflection of our actual VT support.