Refactor and add tests for console command parsing #1459
Merged
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
|
There's one (fairly trivial) conflict here, but this seems good to me from a quick skim over things |
Hoikas
reviewed
Sep 12, 2023
| return begin; | ||
| } | ||
|
|
||
| std::pair<pfConsoleCmdGroup*, std::optional<ST::string>> pfConsoleParser::ParseGroupAndName() |
There was a problem hiding this comment.
Slight preference for this to be an std::tuple because of std::pair implying the usage of a map. But that's just a preference because a lot of implementations just have pair use tuple.
There was a problem hiding this comment.
Ah hm, is there a convention that std::pair is specifically for map-related things? I assumed it was just a specialized alternative to a 2-element std::tuple, but I don't know the stdlib too well...
|
(I'll get the rebase done this weekend probably) |
Although they share a bit of code, the core logic is quite different.
This code could only be reached when *line == '\0', so strlen(line) was always 0 and the addition did nothing.
This way the input buffer no longer needs to be modified, because the returned tokens are copied and not returned "in-place" from the buffer.
In preparation for refactoring and extending it into a more usable standalone parser.
This avoids having to pass a non-const reference into every call and allows signaling errors in a less dirty way.
Should now handle embedded zero bytes correctly (as if anyone cares...).
These have to be coupled, because command name parts can also be separated using spaces instead of dots/underscores.
Anything that needs possibly partial or ambiguous lookups (help, tab completion) still needs the complex API that parses "as far as possible".
dgelessus
force-pushed
the
console_parsing
branch
from
02cee5b
to
9d5e3a1
Compare
Hoikas
approved these changes
Sep 16, 2023
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.
Converts the very "old C-like" console command parsing code into its own class that has a bit more structure and uses modern C++ data types. Also, unit tests!
Aside from cleaning up the code, my motivation here is to allow parsing console commands without actually executing them. This would be especially useful for parsing .ini files - thinking of server.ini or cases like in #1244.
Suggestions for improving the parsing API are welcome. It has to be a bit complex unfortunately, to support situations where the input should only be partially parsed (e. g. tab completion), and because of the wacky command name syntax where parsing depends on which commands are defined...