Skip to content

Commit 69d13b6

Browse files
ZachBrayZachBray
committed
[Java, C#, C++] Rename flags to enable field access order checking.
The aim of this change is to avoid naming collisions with other flags, particularly in financial domains where "order" is used frequently.
1 parent dab9ae2 commit 69d13b6

File tree

11 files changed

+197
-197
lines changed

11 files changed

+197
-197
lines changed

‎build.gradle

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -280,7 +280,7 @@ project(':sbe-tool') {
280280
'sbe.target.language': 'Java',
281281
'sbe.validation.stop.on.error': 'true',
282282
'sbe.validation.xsd': validationXsdPath,
283-
'sbe.generate.access.order.checks': 'true')
283+
'sbe.generate.sequencing.checks': 'true')
284284
args = ['src/test/resources/json-printer-test-schema.xml',
285285
'src/test/resources/composite-elements-schema.xml',
286286
'src/test/resources/field-order-check-schema.xml']
@@ -544,7 +544,7 @@ project(':sbe-benchmarks') {
544544
'sbe.validation.xsd': validationXsdPath,
545545
'sbe.java.encoding.buffer.type': 'org.agrona.concurrent.UnsafeBuffer',
546546
'sbe.java.decoding.buffer.type': 'org.agrona.concurrent.UnsafeBuffer',
547-
'sbe.generate.access.order.checks': 'false')
547+
'sbe.generate.sequencing.checks': 'false')
548548
args = ['src/main/resources/car.xml', 'src/main/resources/fix-message-samples.xml']
549549
}
550550

@@ -734,7 +734,7 @@ tasks.register('generateCSharpCodecsTests', JavaExec) {
734734
'sbe.target.language': 'uk.co.real_logic.sbe.generation.csharp.CSharp',
735735
'sbe.xinclude.aware': 'true',
736736
'sbe.validation.xsd': validationXsdPath,
737-
'sbe.generate.access.order.checks': 'true')
737+
'sbe.generate.sequencing.checks': 'true')
738738
args = ['sbe-tool/src/test/resources/FixBinary.xml',
739739
'sbe-tool/src/test/resources/issue435.xml',
740740
'sbe-tool/src/test/resources/issue483.xml',
@@ -759,7 +759,7 @@ tasks.register('generateJavaIrCodecs', JavaExec) {
759759
'sbe.output.dir': 'sbe-tool/src/main/java',
760760
'sbe.target.language': 'Java',
761761
'sbe.validation.xsd': validationXsdPath,
762-
'sbe.generate.access.order.checks': 'true')
762+
'sbe.generate.sequencing.checks': 'true')
763763
args = ['sbe-tool/src/main/resources/sbe-ir.xml']
764764
}
765765

@@ -770,7 +770,7 @@ tasks.register('generateCppIrCodecs', JavaExec) {
770770
'sbe.output.dir': 'sbe-tool/src/main/cpp',
771771
'sbe.target.language': 'cpp',
772772
'sbe.validation.xsd': validationXsdPath,
773-
'sbe.generate.access.order.checks': 'true')
773+
'sbe.generate.sequencing.checks': 'true')
774774
args = ['sbe-tool/src/main/resources/sbe-ir.xml']
775775
}
776776

‎csharp/sbe-generated/sbe-generated.csproj

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@
88
</PropertyGroup>
99

1010
<PropertyGroup Condition=" '$(Configuration)' == 'Debug' ">
11-
<DefineConstants>TRACE,ENABLE_ACCESS_ORDER_CHECKS</DefineConstants>
11+
<DefineConstants>TRACE,SBE_ENABLE_SEQUENCING_CHECKS</DefineConstants>
1212
</PropertyGroup>
1313

1414
<PropertyGroup Condition=" '$(Configuration)' == 'Release' ">
15-
<DefineConstants>TRACE,ENABLE_ACCESS_ORDER_CHECKS</DefineConstants>
15+
<DefineConstants>TRACE,SBE_ENABLE_SEQUENCING_CHECKS</DefineConstants>
1616
</PropertyGroup>
1717

1818
<ItemGroup>

‎sbe-tool/src/main/java/uk/co/real_logic/sbe/generation/common/AccessOrderModel.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
public final class AccessOrderModel
4242
{
4343
private static final boolean GENERATE_ACCESS_ORDER_CHECKS = Boolean.parseBoolean(
44-
System.getProperty("sbe.generate.access.order.checks", "false"));
44+
System.getProperty("sbe.generate.sequencing.checks", "false"));
4545
private final Map<Token, String> groupPathsByField = new HashMap<>();
4646
private final Set<Token> topLevelBlockFields = new HashSet<>();
4747
private final CodecInteraction.HashConsingFactory interactionFactory =

‎sbe-tool/src/main/java/uk/co/real_logic/sbe/generation/cpp/CppGenerator.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ private static CharSequence generateFullyEncodedCheck(final AccessOrderModel acc
207207

208208
sb.append(indent).append("void checkEncodingIsComplete()\n")
209209
.append(indent).append("{\n")
210-
.append("#if defined(ENABLE_ACCESS_ORDER_CHECKS)\n")
210+
.append("#if defined(SBE_ENABLE_SEQUENCING_CHECKS)\n")
211211
.append(indent).append(INDENT).append("switch (m_codecState)\n")
212212
.append(indent).append(INDENT).append("{\n");
213213

@@ -321,7 +321,7 @@ private static CharSequence generateAccessOrderListenerCall(
321321
}
322322

323323
final StringBuilder sb = new StringBuilder();
324-
sb.append("#if defined(ENABLE_ACCESS_ORDER_CHECKS)\n")
324+
sb.append("#if defined(SBE_ENABLE_SEQUENCING_CHECKS)\n")
325325
.append(indent).append(methodName).append("(");
326326

327327
for (int i = 0; i < arguments.length; i++)
@@ -3083,7 +3083,7 @@ private CharSequence generateDecoderWrapListenerCall(final AccessOrderModel acce
30833083
if (accessOrderModel.versionCount() == 1)
30843084
{
30853085
final StringBuilder sb = new StringBuilder();
3086-
sb.append("#if defined(ENABLE_ACCESS_ORDER_CHECKS)\n")
3086+
sb.append("#if defined(SBE_ENABLE_SEQUENCING_CHECKS)\n")
30873087
.append(TWO_INDENT).append("codecState(")
30883088
.append(qualifiedStateCase(accessOrderModel.latestVersionWrappedState())).append(");\n")
30893089
.append("#endif\n");
@@ -3101,7 +3101,7 @@ private CharSequence generateEncoderWrapListener(final AccessOrderModel accessOr
31013101
}
31023102

31033103
final StringBuilder sb = new StringBuilder();
3104-
sb.append("#if defined(ENABLE_ACCESS_ORDER_CHECKS)\n")
3104+
sb.append("#if defined(SBE_ENABLE_SEQUENCING_CHECKS)\n")
31053105
.append(TWO_INDENT).append("codecState(")
31063106
.append(qualifiedStateCase(accessOrderModel.latestVersionWrappedState()))
31073107
.append(");\n")

‎sbe-tool/src/main/java/uk/co/real_logic/sbe/generation/csharp/CSharpGenerator.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1583,7 +1583,7 @@ private static CharSequence generateFullyEncodedCheck(
15831583

15841584
sb.append(indent).append("public void CheckEncodingIsComplete()\n")
15851585
.append(indent).append("{\n")
1586-
.append("#if ENABLE_ACCESS_ORDER_CHECKS\n")
1586+
.append("#if SBE_ENABLE_SEQUENCING_CHECKS\n")
15871587
.append(indent).append(INDENT).append("switch (_codecState)\n")
15881588
.append(indent).append(INDENT).append("{\n");
15891589

@@ -1670,7 +1670,7 @@ private static CharSequence generateAccessOrderListenerCall(
16701670
}
16711671

16721672
final StringBuilder sb = new StringBuilder();
1673-
sb.append("#if ENABLE_ACCESS_ORDER_CHECKS\n")
1673+
sb.append("#if SBE_ENABLE_SEQUENCING_CHECKS\n")
16741674
.append(indent).append(methodName).append("(");
16751675

16761676
for (int i = 0; i < arguments.length; i++)
@@ -1936,7 +1936,7 @@ private CharSequence generateEncoderWrapListener(
19361936
}
19371937

19381938
final StringBuilder sb = new StringBuilder();
1939-
sb.append("#if ENABLE_ACCESS_ORDER_CHECKS\n")
1939+
sb.append("#if SBE_ENABLE_SEQUENCING_CHECKS\n")
19401940
.append(indent).append("codecState(")
19411941
.append(qualifiedStateCase(accessOrderModel.latestVersionWrappedState()))
19421942
.append(");\n")
@@ -2556,7 +2556,7 @@ private CharSequence generateDisplay(
25562556
append(sb, TWO_INDENT, " int originalLimit = this.Limit;");
25572557
if (null != accessOrderModel)
25582558
{
2559-
sb.append("#if ENABLE_ACCESS_ORDER_CHECKS\n");
2559+
sb.append("#if SBE_ENABLE_SEQUENCING_CHECKS\n");
25602560
append(sb, TWO_INDENT, " CodecState originalState = _codecState;");
25612561
sb.append(THREE_INDENT).append("_codecState = ")
25622562
.append(qualifiedStateCase(accessOrderModel.notWrappedState())).append(";\n");
@@ -2588,7 +2588,7 @@ private CharSequence generateDisplay(
25882588
sb.append('\n');
25892589
if (null != accessOrderModel)
25902590
{
2591-
sb.append("#if ENABLE_ACCESS_ORDER_CHECKS\n");
2591+
sb.append("#if SBE_ENABLE_SEQUENCING_CHECKS\n");
25922592
append(sb, TWO_INDENT, " _codecState = originalState;");
25932593
sb.append("#endif\n");
25942594
}

‎sbe-tool/src/main/java/uk/co/real_logic/sbe/generation/java/JavaGenerator.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -307,9 +307,9 @@ private static CharSequence generateFieldOrderStates(final AccessOrderModel acce
307307

308308
sb.append(" private static final boolean ENABLE_BOUNDS_CHECKS = ")
309309
.append("!Boolean.getBoolean(\"agrona.disable.bounds.checks\");\n\n");
310-
sb.append(" private static final boolean ENABLE_ACCESS_ORDER_CHECKS = ")
310+
sb.append(" private static final boolean SBE_ENABLE_SEQUENCING_CHECKS = ")
311311
.append("Boolean.parseBoolean(System.getProperty(\n")
312-
.append(" \"sbe.enable.access.order.checks\",\n")
312+
.append(" \"sbe.enable.sequencing.checks\",\n")
313313
.append(" Boolean.toString(ENABLE_BOUNDS_CHECKS)));\n\n");
314314

315315
sb.append(" /**\n");
@@ -410,7 +410,7 @@ private static void generateFullyEncodedCheck(
410410

411411
sb.append(" public void checkEncodingIsComplete()\n")
412412
.append(" {\n")
413-
.append(" if (ENABLE_ACCESS_ORDER_CHECKS)\n")
413+
.append(" if (SBE_ENABLE_SEQUENCING_CHECKS)\n")
414414
.append(" {\n")
415415
.append(" switch (codecState)\n")
416416
.append(" {\n");
@@ -493,7 +493,7 @@ private static CharSequence generateAccessOrderListenerCall(
493493
}
494494

495495
final StringBuilder sb = new StringBuilder();
496-
sb.append(indent).append("if (ENABLE_ACCESS_ORDER_CHECKS)\n")
496+
sb.append(indent).append("if (SBE_ENABLE_SEQUENCING_CHECKS)\n")
497497
.append(indent).append("{\n")
498498
.append(indent).append(" ").append(methodName).append("(");
499499

@@ -755,7 +755,7 @@ private CharSequence generateEncoderWrapListener(
755755
}
756756

757757
final StringBuilder sb = new StringBuilder();
758-
sb.append(indent).append("if (ENABLE_ACCESS_ORDER_CHECKS)")
758+
sb.append(indent).append("if (SBE_ENABLE_SEQUENCING_CHECKS)")
759759
.append("\n").append(indent).append("{\n")
760760
.append(indent).append(" codecState(")
761761
.append(qualifiedStateCase(accessOrderModel.latestVersionWrappedState()))
@@ -3424,7 +3424,7 @@ private CharSequence generateDecoderFlyweightCode(
34243424

34253425
if (null != accessOrderModel)
34263426
{
3427-
methods.append(" if (ENABLE_ACCESS_ORDER_CHECKS)\n")
3427+
methods.append(" if (SBE_ENABLE_SEQUENCING_CHECKS)\n")
34283428
.append(" {\n")
34293429
.append(" codecState(currentCodecState);\n")
34303430
.append(" }\n\n");

0 commit comments

Comments
 (0)