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

[C++] check for not wrapped state in decodeLength() #1046

Merged
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 @@ -536,6 +536,18 @@ private static void generateAccessOrderException(
.append(fieldPrecedenceModel.generatedRepresentationClassName()).append(".\");\n");
}

private static void generateAccessOrderException(
final StringBuilder sb,
final String indent,
final String action)
{
sb.append(indent).append("throw AccessOrderError(")
.append("std::string(\"Illegal access. \") + \n")
.append(indent).append(INDENT)
.append("\"Cannot call \\\"").append(action)
.append("()\\\" in state: \" + codecStateName(codecState()));\n");
}

private static void generateAccessOrderListenerMethodForNextGroupElement(
final StringBuilder sb,
final FieldPrecedenceModel fieldPrecedenceModel,
Expand Down Expand Up @@ -3027,6 +3039,7 @@ private CharSequence generateMessageFlyweightCode(

" SBE_NODISCARD std::uint64_t decodeLength() const\n" +
" {\n" +
"%22$s" +
" %10$s skipper(m_buffer, m_offset, m_bufferLength, m_actingBlockLength, m_actingVersion);\n" +
" skipper.skip();\n" +
" return skipper.encodedLength();\n" +
Expand Down Expand Up @@ -3071,7 +3084,8 @@ private CharSequence generateMessageFlyweightCode(
generateCodecStateTransitionForWrappingLatestVersion(fieldPrecedenceModel),
generateOnWrappedListener(fieldPrecedenceModel),
generateCodecStateTransitionForWrapping(fieldPrecedenceModel),
generateHiddenCopyConstructor(" ", className));
generateHiddenCopyConstructor(" ", className),
generateCheckForNotWrappedState("decodeLength", fieldPrecedenceModel));
}

private CharSequence generateAccessOrderErrorType(final FieldPrecedenceModel fieldPrecedenceModel)
Expand Down Expand Up @@ -3311,6 +3325,31 @@ private CharSequence generateCodecStateTransitionForWrapping(final FieldPreceden
return generateAccessOrderListenerCall(fieldPrecedenceModel, TWO_INDENT, "onWrapped", "actingVersion");
}

private CharSequence generateCheckForNotWrappedState(
final String action,
final FieldPrecedenceModel fieldPrecedenceModel)
{
if (null == fieldPrecedenceModel)
{
return "";
}

final StringBuilder sb = new StringBuilder();
sb.append("#if defined(").append(precedenceChecksFlagName).append(")\n")
.append(TWO_INDENT)
.append("if (codecState() == ")
.append(qualifiedStateCase(fieldPrecedenceModel.notWrappedState()))
.append(")\n")
.append(TWO_INDENT).append("{\n");

generateAccessOrderException(sb, THREE_INDENT, action);

sb.append(TWO_INDENT).append("}\n")
.append("#endif\n");

return sb;
}

private CharSequence generateCodecStateTransitionForWrappingLatestVersion(
final FieldPrecedenceModel fieldPrecedenceModel
)
Expand Down
40 changes: 40 additions & 0 deletions sbe-tool/src/test/cpp/FieldAccessOrderCheckTest.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -5048,3 +5048,43 @@ TEST_F(FieldAccessOrderCheckTest, worksWithInsertionOperator)
EXPECT_EQ(decoder.getBAsString(), "abc");
EXPECT_EQ(decoder.getCAsString(), "def");
}

TEST_F(FieldAccessOrderCheckTest, shouldThrowExceptionWhenNotWrapped)
{
MultipleVarLength encoder;
encoder.wrapForEncode(m_buffer, OFFSET, BUFFER_LEN);
encoder.a(42);
encoder.putB("abc");
encoder.putC("def");
encoder.checkEncodingIsComplete();

MultipleVarLength decoder;

EXPECT_THROW(
{
try
{
decoder.decodeLength();
}
catch (const std::exception &e)
{
EXPECT_THAT(
e.what(),
HasSubstr("Illegal access. Cannot call \"decodeLength()\" in state: NOT_WRAPPED")
);
throw;
}
},
std::logic_error
);

decoder.wrapForDecode(
m_buffer,
OFFSET,
MultipleVarLength::sbeBlockLength(),
MultipleVarLength::sbeSchemaVersion(),
BUFFER_LEN
);

decoder.decodeLength();
}
Loading