Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#988: Improved error message from CTPG parser. #466

Merged
merged 1 commit into from
Oct 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -190,9 +190,7 @@ void parse(std::string&& code, options_type& result) {
result = res.value();
}
else {
std::stringstream ss;
ss << "Error parsing script options: " << error_buffer.str();
throw OptionParserException(ss.str());
throw OptionParserException(error_buffer.str());
}
}

Expand Down Expand Up @@ -238,9 +236,18 @@ void parseOptions(const std::string& code, options_map_t & result) {
std::optional<LinePositions> currentLinePositions = getNextLine(current_pos, code);
while (currentLinePositions) {

std::string line = code.substr(currentLinePositions->mStartPos, currentLinePositions->mEndPos);
std::string line = code.substr(currentLinePositions->mStartPos,
currentLinePositions->mEndPos - currentLinePositions->mStartPos);
Comment on lines +239 to +240
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was actually a bug.
It's std::string::subst(begin, length), not std::string::subst(begin, end)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does this change something on the performance?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here results of our performance tests:
Master branch: 6.9s
This branch: 7.0s

options_type parser_result;
ParserInternals::parse(std::move(line), parser_result);
try {
ParserInternals::parse(std::move(line), parser_result);
} catch(OptionParserException& ex) {
const std::string::difference_type lineNumber =
std::count(code.begin(), code.begin()+currentLinePositions->mStartPos, '\n');
std::stringstream ss;
ss << "Error parsing script options at line " << lineNumber << ": " << ex.what();
throw OptionParserException(ss.str());
}
for (const auto & option: parser_result) {
ScriptOption entry = {
.value = option.value,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,27 @@ TEST(ScriptOptionLinesTest, need_option_termination_character) {
catch( const OptionParserException& e )
{
// and this tests that it has the correct message
EXPECT_STREQ( e.what(), "Error parsing script options: [1:17] PARSE: Syntax error: Unexpected '<eof>'\n");
EXPECT_STREQ( e.what(), "Error parsing script options at line 0: [1:17] PARSE: Syntax error: Unexpected '<eof>'\n");
throw;
}
}, OptionParserException );
}

TEST(ScriptOptionLinesTest, need_option_termination_character_second_line) {
const std::string code =
"%optionA myoption;\n"
"%optionB myoption\n"
"\nmycode";
options_map_t result;
EXPECT_THROW({
try
{
parseOptions(code, result);
}
catch( const OptionParserException& e )
{
// and this tests that it has the correct message
EXPECT_STREQ( e.what(), "Error parsing script options at line 1: [1:18] PARSE: Syntax error: Unexpected '<eof>'\n");
throw;
}
Comment on lines +93 to 109
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would consider spliting the test into two test.
(try catch within the EXPECT_THROW lets my spidy sense tingle ;P )

  1. Tests if the exception is thrown
  2. Tests if the error message is the expected one

}, OptionParserException );
Expand Down
Loading