Skip to content

Commit 558df22

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 558df22

File tree

9 files changed

+190
-190
lines changed

9 files changed

+190
-190
lines changed

‎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/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");

‎sbe-tool/src/main/java/uk/co/real_logic/sbe/ir/generated/FrameCodecDecoder.java‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ public final class FrameCodecDecoder
1313
{
1414
private static final boolean ENABLE_BOUNDS_CHECKS = !Boolean.getBoolean("agrona.disable.bounds.checks");
1515

16-
private static final boolean ENABLE_ACCESS_ORDER_CHECKS = Boolean.parseBoolean(System.getProperty(
17-
"sbe.enable.access.order.checks",
16+
private static final boolean SBE_ENABLE_SEQUENCING_CHECKS = Boolean.parseBoolean(System.getProperty(
17+
"sbe.enable.sequencing.checks",
1818
Boolean.toString(ENABLE_BOUNDS_CHECKS)));
1919

2020
/**
@@ -172,7 +172,7 @@ public FrameCodecDecoder wrap(
172172
this.actingVersion = actingVersion;
173173
limit(offset + actingBlockLength);
174174

175-
if (ENABLE_ACCESS_ORDER_CHECKS)
175+
if (SBE_ENABLE_SEQUENCING_CHECKS)
176176
{
177177
onWrap(actingVersion);
178178
}
@@ -213,7 +213,7 @@ public int sbeDecodedLength()
213213
final int decodedLength = encodedLength();
214214
limit(currentLimit);
215215

216-
if (ENABLE_ACCESS_ORDER_CHECKS)
216+
if (SBE_ENABLE_SEQUENCING_CHECKS)
217217
{
218218
codecState(currentCodecState);
219219
}
@@ -299,7 +299,7 @@ public static int irIdMaxValue()
299299

300300
public int irId()
301301
{
302-
if (ENABLE_ACCESS_ORDER_CHECKS)
302+
if (SBE_ENABLE_SEQUENCING_CHECKS)
303303
{
304304
onIrIdAccessed();
305305
}
@@ -366,7 +366,7 @@ public static int irVersionMaxValue()
366366

367367
public int irVersion()
368368
{
369-
if (ENABLE_ACCESS_ORDER_CHECKS)
369+
if (SBE_ENABLE_SEQUENCING_CHECKS)
370370
{
371371
onIrVersionAccessed();
372372
}
@@ -433,7 +433,7 @@ public static int schemaVersionMaxValue()
433433

434434
public int schemaVersion()
435435
{
436-
if (ENABLE_ACCESS_ORDER_CHECKS)
436+
if (SBE_ENABLE_SEQUENCING_CHECKS)
437437
{
438438
onSchemaVersionAccessed();
439439
}
@@ -504,7 +504,7 @@ private void onPackageNameAccessed()
504504

505505
public int packageNameLength()
506506
{
507-
if (ENABLE_ACCESS_ORDER_CHECKS)
507+
if (SBE_ENABLE_SEQUENCING_CHECKS)
508508
{
509509
onPackageNameLengthAccessed();
510510
}
@@ -515,7 +515,7 @@ public int packageNameLength()
515515

516516
public int skipPackageName()
517517
{
518-
if (ENABLE_ACCESS_ORDER_CHECKS)
518+
if (SBE_ENABLE_SEQUENCING_CHECKS)
519519
{
520520
onPackageNameAccessed();
521521
}
@@ -531,7 +531,7 @@ public int skipPackageName()
531531

532532
public int getPackageName(final MutableDirectBuffer dst, final int dstOffset, final int length)
533533
{
534-
if (ENABLE_ACCESS_ORDER_CHECKS)
534+
if (SBE_ENABLE_SEQUENCING_CHECKS)
535535
{
536536
onPackageNameAccessed();
537537
}
@@ -548,7 +548,7 @@ public int getPackageName(final MutableDirectBuffer dst, final int dstOffset, fi
548548

549549
public int getPackageName(final byte[] dst, final int dstOffset, final int length)
550550
{
551-
if (ENABLE_ACCESS_ORDER_CHECKS)
551+
if (SBE_ENABLE_SEQUENCING_CHECKS)
552552
{
553553
onPackageNameAccessed();
554554
}
@@ -565,7 +565,7 @@ public int getPackageName(final byte[] dst, final int dstOffset, final int lengt
565565

566566
public void wrapPackageName(final DirectBuffer wrapBuffer)
567567
{
568-
if (ENABLE_ACCESS_ORDER_CHECKS)
568+
if (SBE_ENABLE_SEQUENCING_CHECKS)
569569
{
570570
onPackageNameAccessed();
571571
}
@@ -579,7 +579,7 @@ public void wrapPackageName(final DirectBuffer wrapBuffer)
579579

580580
public String packageName()
581581
{
582-
if (ENABLE_ACCESS_ORDER_CHECKS)
582+
if (SBE_ENABLE_SEQUENCING_CHECKS)
583583
{
584584
onPackageNameAccessed();
585585
}
@@ -662,7 +662,7 @@ private void onNamespaceNameAccessed()
662662

663663
public int namespaceNameLength()
664664
{
665-
if (ENABLE_ACCESS_ORDER_CHECKS)
665+
if (SBE_ENABLE_SEQUENCING_CHECKS)
666666
{
667667
onNamespaceNameLengthAccessed();
668668
}
@@ -673,7 +673,7 @@ public int namespaceNameLength()
673673

674674
public int skipNamespaceName()
675675
{
676-
if (ENABLE_ACCESS_ORDER_CHECKS)
676+
if (SBE_ENABLE_SEQUENCING_CHECKS)
677677
{
678678
onNamespaceNameAccessed();
679679
}
@@ -689,7 +689,7 @@ public int skipNamespaceName()
689689

690690
public int getNamespaceName(final MutableDirectBuffer dst, final int dstOffset, final int length)
691691
{
692-
if (ENABLE_ACCESS_ORDER_CHECKS)
692+
if (SBE_ENABLE_SEQUENCING_CHECKS)
693693
{
694694
onNamespaceNameAccessed();
695695
}
@@ -706,7 +706,7 @@ public int getNamespaceName(final MutableDirectBuffer dst, final int dstOffset,
706706

707707
public int getNamespaceName(final byte[] dst, final int dstOffset, final int length)
708708
{
709-
if (ENABLE_ACCESS_ORDER_CHECKS)
709+
if (SBE_ENABLE_SEQUENCING_CHECKS)
710710
{
711711
onNamespaceNameAccessed();
712712
}
@@ -723,7 +723,7 @@ public int getNamespaceName(final byte[] dst, final int dstOffset, final int len
723723

724724
public void wrapNamespaceName(final DirectBuffer wrapBuffer)
725725
{
726-
if (ENABLE_ACCESS_ORDER_CHECKS)
726+
if (SBE_ENABLE_SEQUENCING_CHECKS)
727727
{
728728
onNamespaceNameAccessed();
729729
}
@@ -737,7 +737,7 @@ public void wrapNamespaceName(final DirectBuffer wrapBuffer)
737737

738738
public String namespaceName()
739739
{
740-
if (ENABLE_ACCESS_ORDER_CHECKS)
740+
if (SBE_ENABLE_SEQUENCING_CHECKS)
741741
{
742742
onNamespaceNameAccessed();
743743
}
@@ -820,7 +820,7 @@ private void onSemanticVersionAccessed()
820820

821821
public int semanticVersionLength()
822822
{
823-
if (ENABLE_ACCESS_ORDER_CHECKS)
823+
if (SBE_ENABLE_SEQUENCING_CHECKS)
824824
{
825825
onSemanticVersionLengthAccessed();
826826
}
@@ -831,7 +831,7 @@ public int semanticVersionLength()
831831

832832
public int skipSemanticVersion()
833833
{
834-
if (ENABLE_ACCESS_ORDER_CHECKS)
834+
if (SBE_ENABLE_SEQUENCING_CHECKS)
835835
{
836836
onSemanticVersionAccessed();
837837
}
@@ -847,7 +847,7 @@ public int skipSemanticVersion()
847847

848848
public int getSemanticVersion(final MutableDirectBuffer dst, final int dstOffset, final int length)
849849
{
850-
if (ENABLE_ACCESS_ORDER_CHECKS)
850+
if (SBE_ENABLE_SEQUENCING_CHECKS)
851851
{
852852
onSemanticVersionAccessed();
853853
}
@@ -864,7 +864,7 @@ public int getSemanticVersion(final MutableDirectBuffer dst, final int dstOffset
864864

865865
public int getSemanticVersion(final byte[] dst, final int dstOffset, final int length)
866866
{
867-
if (ENABLE_ACCESS_ORDER_CHECKS)
867+
if (SBE_ENABLE_SEQUENCING_CHECKS)
868868
{
869869
onSemanticVersionAccessed();
870870
}
@@ -881,7 +881,7 @@ public int getSemanticVersion(final byte[] dst, final int dstOffset, final int l
881881

882882
public void wrapSemanticVersion(final DirectBuffer wrapBuffer)
883883
{
884-
if (ENABLE_ACCESS_ORDER_CHECKS)
884+
if (SBE_ENABLE_SEQUENCING_CHECKS)
885885
{
886886
onSemanticVersionAccessed();
887887
}
@@ -895,7 +895,7 @@ public void wrapSemanticVersion(final DirectBuffer wrapBuffer)
895895

896896
public String semanticVersion()
897897
{
898-
if (ENABLE_ACCESS_ORDER_CHECKS)
898+
if (SBE_ENABLE_SEQUENCING_CHECKS)
899899
{
900900
onSemanticVersionAccessed();
901901
}

0 commit comments

Comments
 (0)