-
Notifications
You must be signed in to change notification settings - Fork 514
/
JavaGenerator.java
4718 lines (4148 loc) · 191 KB
/
JavaGenerator.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright 2013-2024 Real Logic Limited.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package uk.co.real_logic.sbe.generation.java;
import uk.co.real_logic.sbe.PrimitiveType;
import uk.co.real_logic.sbe.generation.CodeGenerator;
import uk.co.real_logic.sbe.generation.Generators;
import uk.co.real_logic.sbe.generation.common.FieldPrecedenceModel;
import uk.co.real_logic.sbe.generation.common.PrecedenceChecks;
import uk.co.real_logic.sbe.ir.*;
import org.agrona.DirectBuffer;
import org.agrona.MutableDirectBuffer;
import org.agrona.Strings;
import org.agrona.Verify;
import org.agrona.collections.MutableBoolean;
import org.agrona.generation.DynamicPackageOutputManager;
import org.agrona.sbe.*;
import java.io.IOException;
import java.io.Writer;
import java.util.*;
import java.util.function.Function;
import static uk.co.real_logic.sbe.SbeTool.JAVA_INTERFACE_PACKAGE;
import static uk.co.real_logic.sbe.generation.java.JavaGenerator.CodecType.DECODER;
import static uk.co.real_logic.sbe.generation.java.JavaGenerator.CodecType.ENCODER;
import static uk.co.real_logic.sbe.generation.java.JavaUtil.*;
import static uk.co.real_logic.sbe.ir.GenerationUtil.*;
/**
* Generate codecs for the Java 8 programming language.
*/
@SuppressWarnings("MethodLength")
public class JavaGenerator implements CodeGenerator
{
static final String MESSAGE_HEADER_ENCODER_TYPE = "MessageHeaderEncoder";
static final String MESSAGE_HEADER_DECODER_TYPE = "MessageHeaderDecoder";
enum CodecType
{
DECODER,
ENCODER
}
private static final String META_ATTRIBUTE_ENUM = "MetaAttribute";
private static final String PACKAGE_INFO = "package-info";
private static final String BASE_INDENT = "";
private static final String INDENT = " ";
private static final Set<String> PACKAGES_EMPTY_SET = Collections.emptySet();
private final Ir ir;
private final DynamicPackageOutputManager outputManager;
private final String fqMutableBuffer;
private final String mutableBuffer;
private final String fqReadOnlyBuffer;
private final String readOnlyBuffer;
private final boolean shouldGenerateGroupOrderAnnotation;
private final boolean shouldGenerateInterfaces;
private final boolean shouldDecodeUnknownEnumValues;
private final boolean shouldSupportTypesPackageNames;
private final PrecedenceChecks precedenceChecks;
private final String precedenceChecksFlagName;
private final String precedenceChecksPropName;
private final Set<String> packageNameByTypes = new HashSet<>();
/**
* Create a new Java language {@link CodeGenerator}. Generator support for types in their own package is disabled.
*
* @param ir for the messages and types.
* @param mutableBuffer implementation used for mutating underlying buffers.
* @param readOnlyBuffer implementation used for reading underlying buffers.
* @param shouldGenerateGroupOrderAnnotation in the codecs.
* @param shouldGenerateInterfaces for common methods.
* @param shouldDecodeUnknownEnumValues generate support for unknown enum values when decoding.
* @param outputManager for generating the codecs to.
*/
public JavaGenerator(
final Ir ir,
final String mutableBuffer,
final String readOnlyBuffer,
final boolean shouldGenerateGroupOrderAnnotation,
final boolean shouldGenerateInterfaces,
final boolean shouldDecodeUnknownEnumValues,
final DynamicPackageOutputManager outputManager)
{
this(ir, mutableBuffer, readOnlyBuffer, shouldGenerateGroupOrderAnnotation, shouldGenerateInterfaces,
shouldDecodeUnknownEnumValues, false, outputManager);
}
/**
* Create a new Java language {@link CodeGenerator}.
*
* @param ir for the messages and types.
* @param mutableBuffer implementation used for mutating underlying buffers.
* @param readOnlyBuffer implementation used for reading underlying buffers.
* @param shouldGenerateGroupOrderAnnotation in the codecs.
* @param shouldGenerateInterfaces for common methods.
* @param shouldDecodeUnknownEnumValues generate support for unknown enum values when decoding.
* @param shouldSupportTypesPackageNames generator support for types in their own package.
* @param outputManager for generating the codecs to.
*/
public JavaGenerator(
final Ir ir,
final String mutableBuffer,
final String readOnlyBuffer,
final boolean shouldGenerateGroupOrderAnnotation,
final boolean shouldGenerateInterfaces,
final boolean shouldDecodeUnknownEnumValues,
final boolean shouldSupportTypesPackageNames,
final DynamicPackageOutputManager outputManager)
{
this(
ir,
mutableBuffer,
readOnlyBuffer,
shouldGenerateGroupOrderAnnotation,
shouldGenerateInterfaces,
shouldDecodeUnknownEnumValues,
shouldSupportTypesPackageNames,
PrecedenceChecks.newInstance(new PrecedenceChecks.Context()),
outputManager);
}
/**
* Create a new Java language {@link CodeGenerator}.
*
* @param ir for the messages and types.
* @param mutableBuffer implementation used for mutating underlying buffers.
* @param readOnlyBuffer implementation used for reading underlying buffers.
* @param shouldGenerateGroupOrderAnnotation in the codecs.
* @param shouldGenerateInterfaces for common methods.
* @param shouldDecodeUnknownEnumValues generate support for unknown enum values when decoding.
* @param shouldSupportTypesPackageNames generator support for types in their own package.
* @param precedenceChecks whether and how to generate field precedence checks.
* @param outputManager for generating the codecs to.
*/
public JavaGenerator(
final Ir ir,
final String mutableBuffer,
final String readOnlyBuffer,
final boolean shouldGenerateGroupOrderAnnotation,
final boolean shouldGenerateInterfaces,
final boolean shouldDecodeUnknownEnumValues,
final boolean shouldSupportTypesPackageNames,
final PrecedenceChecks precedenceChecks,
final DynamicPackageOutputManager outputManager)
{
Verify.notNull(ir, "ir");
Verify.notNull(outputManager, "outputManager");
this.ir = ir;
this.shouldSupportTypesPackageNames = shouldSupportTypesPackageNames;
this.outputManager = outputManager;
this.mutableBuffer = validateBufferImplementation(mutableBuffer, MutableDirectBuffer.class);
this.fqMutableBuffer = mutableBuffer;
this.readOnlyBuffer = validateBufferImplementation(readOnlyBuffer, DirectBuffer.class);
this.fqReadOnlyBuffer = readOnlyBuffer;
this.shouldGenerateGroupOrderAnnotation = shouldGenerateGroupOrderAnnotation;
this.shouldGenerateInterfaces = shouldGenerateInterfaces;
this.shouldDecodeUnknownEnumValues = shouldDecodeUnknownEnumValues;
this.precedenceChecks = precedenceChecks;
this.precedenceChecksFlagName = precedenceChecks.context().precedenceChecksFlagName();
this.precedenceChecksPropName = precedenceChecks.context().precedenceChecksPropName();
}
/**
* Generate the composites for dealing with the message header.
*
* @throws IOException if an error is encountered when writing the output.
*/
public void generateMessageHeaderStub() throws IOException
{
generateComposite(ir.headerStructure().tokens());
}
/**
* Generate the stubs for the types used as message fields.
*
* @throws IOException if an error is encountered when writing the output.
*/
public void generateTypeStubs() throws IOException
{
generateMetaAttributeEnum();
for (final List<Token> tokens : ir.types())
{
switch (tokens.get(0).signal())
{
case BEGIN_ENUM:
generateEnum(tokens);
break;
case BEGIN_SET:
generateBitSet(tokens);
break;
case BEGIN_COMPOSITE:
generateComposite(tokens);
break;
default:
break;
}
}
}
/**
* Register the types explicit package - if set and should be supported.
*
* @param token the 0-th token of the type.
* @param ir the intermediate representation.
* @return the overridden package name of the type if set and supported, or {@link Ir#applicableNamespace()}.
*/
private String registerTypesPackageName(final Token token, final Ir ir)
{
if (!shouldSupportTypesPackageNames)
{
return ir.applicableNamespace();
}
if (token.packageName() != null)
{
packageNameByTypes.add(token.packageName());
outputManager.setPackageName(token.packageName());
return token.packageName();
}
return ir.applicableNamespace();
}
/**
* {@inheritDoc}
*/
public void generate() throws IOException
{
packageNameByTypes.clear();
generatePackageInfo();
generateTypeStubs();
generateMessageHeaderStub();
for (final List<Token> tokens : ir.messages())
{
final Token msgToken = tokens.get(0);
final List<Token> messageBody = getMessageBody(tokens);
final boolean hasVarData = -1 != findSignal(messageBody, Signal.BEGIN_VAR_DATA);
int i = 0;
final List<Token> fields = new ArrayList<>();
i = collectFields(messageBody, i, fields);
final List<Token> groups = new ArrayList<>();
i = collectGroups(messageBody, i, groups);
final List<Token> varData = new ArrayList<>();
collectVarData(messageBody, i, varData);
final String decoderClassName = formatClassName(decoderName(msgToken.name()));
final String decoderStateClassName = decoderClassName + "#CodecStates";
final FieldPrecedenceModel decoderPrecedenceModel =
precedenceChecks.createDecoderModel(decoderStateClassName, tokens);
generateDecoder(decoderClassName, msgToken, fields, groups, varData, hasVarData, decoderPrecedenceModel);
final String encoderClassName = formatClassName(encoderName(msgToken.name()));
final String encoderStateClassName = encoderClassName + "#CodecStates";
final FieldPrecedenceModel encoderPrecedenceModel =
precedenceChecks.createEncoderModel(encoderStateClassName, tokens);
generateEncoder(encoderClassName, msgToken, fields, groups, varData, hasVarData, encoderPrecedenceModel);
}
}
private void generateEncoder(
final String className,
final Token msgToken,
final List<Token> fields,
final List<Token> groups,
final List<Token> varData,
final boolean hasVarData,
final FieldPrecedenceModel fieldPrecedenceModel)
throws IOException
{
final String implementsString = implementsInterface(MessageEncoderFlyweight.class.getSimpleName());
try (Writer out = outputManager.createOutput(className))
{
out.append(generateMainHeader(ir.applicableNamespace(), ENCODER, hasVarData));
if (shouldGenerateGroupOrderAnnotation)
{
generateAnnotations(BASE_INDENT, className, groups, out, this::encoderName);
}
out.append(generateDeclaration(className, implementsString, msgToken));
out.append(generateFieldOrderStates(fieldPrecedenceModel));
out.append(generateEncoderFlyweightCode(className, fieldPrecedenceModel, msgToken));
final StringBuilder sb = new StringBuilder();
generateEncoderFields(sb, className, fieldPrecedenceModel, fields, BASE_INDENT);
generateEncoderGroups(sb, className, fieldPrecedenceModel, groups, BASE_INDENT, false);
generateEncoderVarData(sb, className, fieldPrecedenceModel, varData, BASE_INDENT);
generateEncoderDisplay(sb, decoderName(msgToken.name()));
generateFullyEncodedCheck(sb, fieldPrecedenceModel);
out.append(sb);
out.append("}\n");
}
}
private static CharSequence qualifiedStateCase(final FieldPrecedenceModel.State state)
{
return "CodecStates." + state.name();
}
private static CharSequence stateCaseForSwitchCase(final FieldPrecedenceModel.State state)
{
return qualifiedStateCase(state);
}
private static CharSequence unqualifiedStateCase(final FieldPrecedenceModel.State state)
{
return state.name();
}
private CharSequence generateFieldOrderStates(final FieldPrecedenceModel fieldPrecedenceModel)
{
if (null == fieldPrecedenceModel)
{
return "";
}
final StringBuilder sb = new StringBuilder();
sb.append(" private static final boolean ENABLE_BOUNDS_CHECKS = ")
.append("!Boolean.getBoolean(\"agrona.disable.bounds.checks\");\n\n");
sb.append(" private static final boolean ")
.append(precedenceChecksFlagName).append(" = ")
.append("Boolean.parseBoolean(System.getProperty(\n")
.append(" \"").append(precedenceChecksPropName).append("\",\n")
.append(" Boolean.toString(ENABLE_BOUNDS_CHECKS)));\n\n");
sb.append(" /**\n");
sb.append(" * The states in which a encoder/decoder/codec can live.\n");
sb.append(" *\n");
sb.append(" * <p>The state machine diagram below, encoded in the dot language, describes\n");
sb.append(" * the valid state transitions according to the order in which fields may be\n");
sb.append(" * accessed safely. Tools such as PlantUML and Graphviz can render it.\n");
sb.append(" *\n");
sb.append(" * <pre>{@code\n");
fieldPrecedenceModel.generateGraph(sb, " * ");
sb.append(" * }</pre>\n");
sb.append(" */\n");
sb.append(" private static class CodecStates\n")
.append(" {\n");
fieldPrecedenceModel.forEachStateOrderedByStateNumber((state) ->
sb.append(" private static final int ")
.append(unqualifiedStateCase(state))
.append(" = ").append(state.number())
.append(";\n"));
sb.append("\n").append(" private static final String[] STATE_NAME_LOOKUP =\n")
.append(" {\n");
fieldPrecedenceModel.forEachStateOrderedByStateNumber((state) ->
sb.append(" \"").append(state.name()).append("\",\n"));
sb.append(" };\n\n");
sb.append(" private static final String[] STATE_TRANSITIONS_LOOKUP =\n")
.append(" {\n");
fieldPrecedenceModel.forEachStateOrderedByStateNumber((state) ->
{
sb.append(" \"");
final MutableBoolean isFirst = new MutableBoolean(true);
final Set<String> transitionDescriptions = new HashSet<>();
fieldPrecedenceModel.forEachTransitionFrom(state, (transitionGroup) ->
{
if (transitionDescriptions.add(transitionGroup.exampleCode()))
{
if (isFirst.get())
{
isFirst.set(false);
}
else
{
sb.append(", ");
}
sb.append("\\\"").append(transitionGroup.exampleCode()).append("\\\"");
}
});
sb.append("\",\n");
});
sb.append(" };\n\n");
sb.append(" private static String name(final int state)\n")
.append(" {\n")
.append(" return STATE_NAME_LOOKUP[state];\n")
.append(" }\n\n");
sb.append(" private static String transitions(final int state)\n")
.append(" {\n")
.append(" return STATE_TRANSITIONS_LOOKUP[state];\n")
.append(" }\n");
sb.append(" }\n\n");
sb.append(" private int codecState = ")
.append(qualifiedStateCase(fieldPrecedenceModel.notWrappedState()))
.append(";\n\n");
sb.append(" private int codecState()\n")
.append(" {\n")
.append(" return codecState;\n")
.append(" }\n\n");
sb.append(" private void codecState(int newState)\n")
.append(" {\n")
.append(" codecState = newState;\n")
.append(" }\n\n");
return sb;
}
private void generateFullyEncodedCheck(
final StringBuilder sb,
final FieldPrecedenceModel fieldPrecedenceModel)
{
if (null == fieldPrecedenceModel)
{
return;
}
sb.append("\n");
sb.append(" public void checkEncodingIsComplete()\n")
.append(" {\n")
.append(" if (").append(precedenceChecksFlagName).append(")\n")
.append(" {\n")
.append(" switch (codecState)\n")
.append(" {\n");
fieldPrecedenceModel.forEachTerminalEncoderState((state) ->
sb.append(" case ").append(stateCaseForSwitchCase(state)).append(":\n")
.append(" return;\n"));
sb.append(" default:\n")
.append(" throw new IllegalStateException(\"Not fully encoded, current state: \" +\n")
.append(" CodecStates.name(codecState) + \", allowed transitions: \" +\n")
.append(" CodecStates.transitions(codecState));\n")
.append(" }\n")
.append(" }\n")
.append(" }\n\n");
}
private static String accessOrderListenerMethodName(final Token token)
{
return "on" + Generators.toUpperFirstChar(token.name()) + "Accessed";
}
private static String accessOrderListenerMethodName(final Token token, final String suffix)
{
return "on" + Generators.toUpperFirstChar(token.name()) + suffix + "Accessed";
}
private static void generateAccessOrderListenerMethod(
final StringBuilder sb,
final FieldPrecedenceModel fieldPrecedenceModel,
final String indent,
final Token token)
{
if (null == fieldPrecedenceModel)
{
return;
}
sb.append("\n")
.append(indent).append("private void ").append(accessOrderListenerMethodName(token)).append("()\n")
.append(indent).append("{\n");
final FieldPrecedenceModel.CodecInteraction fieldAccess =
fieldPrecedenceModel.interactionFactory().accessField(token);
generateAccessOrderListener(
sb,
indent + " ",
"access field",
fieldPrecedenceModel,
fieldAccess);
sb.append(indent).append("}\n");
}
private CharSequence generateAccessOrderListenerCall(
final FieldPrecedenceModel fieldPrecedenceModel,
final String indent,
final Token token,
final String... arguments)
{
return generateAccessOrderListenerCall(
fieldPrecedenceModel,
indent,
accessOrderListenerMethodName(token),
arguments);
}
private CharSequence generateAccessOrderListenerCall(
final FieldPrecedenceModel fieldPrecedenceModel,
final String indent,
final String methodName,
final String... arguments)
{
if (null == fieldPrecedenceModel)
{
return "";
}
final StringBuilder sb = new StringBuilder();
sb.append(indent).append("if (").append(precedenceChecksFlagName).append(")\n")
.append(indent).append("{\n")
.append(indent).append(" ").append(methodName).append("(");
for (int i = 0; i < arguments.length; i++)
{
if (i > 0)
{
sb.append(", ");
}
sb.append(arguments[i]);
}
sb.append(");\n");
sb.append(indent).append("}\n\n");
return sb;
}
private static void generateAccessOrderListenerMethodForGroupWrap(
final StringBuilder sb,
final String action,
final FieldPrecedenceModel fieldPrecedenceModel,
final String indent,
final Token token)
{
if (null == fieldPrecedenceModel)
{
return;
}
sb.append("\n")
.append(indent).append("private void ").append(accessOrderListenerMethodName(token))
.append("(final int count)\n")
.append(indent).append("{\n")
.append(indent).append(" if (count == 0)\n")
.append(indent).append(" {\n");
final FieldPrecedenceModel.CodecInteraction selectEmptyGroup =
fieldPrecedenceModel.interactionFactory().determineGroupIsEmpty(token);
generateAccessOrderListener(
sb,
indent + " ",
action + " count of repeating group",
fieldPrecedenceModel,
selectEmptyGroup);
sb.append(indent).append(" }\n")
.append(indent).append(" else\n")
.append(indent).append(" {\n");
final FieldPrecedenceModel.CodecInteraction selectNonEmptyGroup =
fieldPrecedenceModel.interactionFactory().determineGroupHasElements(token);
generateAccessOrderListener(
sb,
indent + " ",
action + " count of repeating group",
fieldPrecedenceModel,
selectNonEmptyGroup);
sb.append(indent).append(" }\n")
.append(indent).append("}\n");
}
private static void generateAccessOrderListener(
final StringBuilder sb,
final String indent,
final String action,
final FieldPrecedenceModel fieldPrecedenceModel,
final FieldPrecedenceModel.CodecInteraction interaction)
{
if (interaction.isTopLevelBlockFieldAccess())
{
sb.append(indent).append("if (codecState() == ")
.append(qualifiedStateCase(fieldPrecedenceModel.notWrappedState()))
.append(")\n")
.append(indent).append("{\n");
generateAccessOrderException(sb, indent + " ", action, fieldPrecedenceModel, interaction);
sb.append(indent).append("}\n");
}
else
{
sb.append(indent).append("switch (codecState())\n")
.append(indent).append("{\n");
fieldPrecedenceModel.forEachTransition(interaction, (transitionGroup) ->
{
transitionGroup.forEachStartState((startState) ->
sb.append(indent).append(" case ").append(stateCaseForSwitchCase(startState)).append(":\n"));
sb.append(indent).append(" codecState(")
.append(qualifiedStateCase(transitionGroup.endState())).append(");\n")
.append(indent).append(" break;\n");
});
sb.append(indent).append(" default:\n");
generateAccessOrderException(sb, indent + " ", action, fieldPrecedenceModel, interaction);
sb.append(indent).append("}\n");
}
}
private static void generateAccessOrderException(
final StringBuilder sb,
final String indent,
final String action,
final FieldPrecedenceModel fieldPrecedenceModel,
final FieldPrecedenceModel.CodecInteraction interaction)
{
sb.append(indent).append("throw new IllegalStateException(")
.append("\"Illegal field access order. \" +\n")
.append(indent)
.append(" \"Cannot ").append(action).append(" \\\"").append(interaction.groupQualifiedName())
.append("\\\" in state: \" + CodecStates.name(codecState()) +\n")
.append(indent)
.append(" \". Expected one of these transitions: [\" + CodecStates.transitions(codecState()) +\n")
.append(indent)
.append(" \"]. Please see the diagram in the Javadoc of the class ")
.append(fieldPrecedenceModel.generatedRepresentationClassName()).append(".\");\n");
}
private static void generateAccessOrderListenerMethodForNextGroupElement(
final StringBuilder sb,
final FieldPrecedenceModel fieldPrecedenceModel,
final String indent,
final Token token)
{
if (null == fieldPrecedenceModel)
{
return;
}
sb.append(indent).append("private void onNextElementAccessed()\n")
.append(indent).append("{\n")
.append(indent).append(" final int remaining = ").append("count - index").append(";\n")
.append(indent).append(" if (remaining > 1)\n")
.append(indent).append(" {\n");
final FieldPrecedenceModel.CodecInteraction selectNextElementInGroup =
fieldPrecedenceModel.interactionFactory().moveToNextElement(token);
generateAccessOrderListener(
sb,
indent + " ",
"access next element in repeating group",
fieldPrecedenceModel,
selectNextElementInGroup);
sb.append(indent).append(" }\n")
.append(indent).append(" else if (remaining == 1)\n")
.append(indent).append(" {\n");
final FieldPrecedenceModel.CodecInteraction selectLastElementInGroup =
fieldPrecedenceModel.interactionFactory().moveToLastElement(token);
generateAccessOrderListener(
sb,
indent + " ",
"access next element in repeating group",
fieldPrecedenceModel,
selectLastElementInGroup);
sb.append(indent).append(" }\n")
.append(indent).append("}\n\n");
}
private static void generateAccessOrderListenerMethodForResetGroupCount(
final StringBuilder sb,
final FieldPrecedenceModel fieldPrecedenceModel,
final String indent,
final Token token)
{
if (null == fieldPrecedenceModel)
{
return;
}
sb.append(indent).append("private void onResetCountToIndex()\n")
.append(indent).append("{\n");
final FieldPrecedenceModel.CodecInteraction resetCountToIndex =
fieldPrecedenceModel.interactionFactory().resetCountToIndex(token);
generateAccessOrderListener(
sb,
indent + " ",
"reset count of repeating group",
fieldPrecedenceModel,
resetCountToIndex);
sb.append(indent).append("}\n\n");
}
private static void generateAccessOrderListenerMethodForVarDataLength(
final StringBuilder sb,
final FieldPrecedenceModel fieldPrecedenceModel,
final String indent,
final Token token)
{
if (null == fieldPrecedenceModel)
{
return;
}
sb.append("\n")
.append(indent).append("void ").append(accessOrderListenerMethodName(token, "Length")).append("()\n")
.append(indent).append("{\n");
final FieldPrecedenceModel.CodecInteraction accessLength =
fieldPrecedenceModel.interactionFactory().accessVarDataLength(token);
generateAccessOrderListener(
sb,
indent + INDENT,
"decode length of var data",
fieldPrecedenceModel,
accessLength);
sb.append(indent).append("}\n");
}
private static CharSequence generateDecoderWrapListener(
final FieldPrecedenceModel fieldPrecedenceModel,
final String indent)
{
if (null == fieldPrecedenceModel)
{
return "";
}
final StringBuilder sb = new StringBuilder();
sb.append(indent).append("private void onWrap(final int actingVersion)\n")
.append(indent).append("{\n");
fieldPrecedenceModel.forEachWrappedStateByVersionDesc((version, state) ->
sb.append(indent).append(" if (actingVersion >= ").append(version).append(")\n")
.append(indent).append(" {\n")
.append(indent).append(" codecState(")
.append(qualifiedStateCase(state)).append(");\n")
.append(indent).append(" return;\n")
.append(indent).append(" }\n\n"));
sb.append(indent)
.append(" throw new IllegalStateException(\"Unsupported acting version: \" + actingVersion);\n")
.append(indent).append("}\n\n");
return sb;
}
private CharSequence generateEncoderWrapListener(
final FieldPrecedenceModel fieldPrecedenceModel,
final String indent)
{
if (null == fieldPrecedenceModel)
{
return "";
}
final StringBuilder sb = new StringBuilder();
sb.append(indent).append("if (").append(precedenceChecksFlagName).append(")")
.append("\n").append(indent).append("{\n")
.append(indent).append(" codecState(")
.append(qualifiedStateCase(fieldPrecedenceModel.latestVersionWrappedState()))
.append(");\n")
.append(indent).append("}\n\n");
return sb;
}
private void generateDecoder(
final String className,
final Token msgToken,
final List<Token> fields,
final List<Token> groups,
final List<Token> varData,
final boolean hasVarData,
final FieldPrecedenceModel fieldPrecedenceModel)
throws IOException
{
final String implementsString = implementsInterface(MessageDecoderFlyweight.class.getSimpleName());
try (Writer out = outputManager.createOutput(className))
{
out.append(generateMainHeader(ir.applicableNamespace(), DECODER, hasVarData));
if (shouldGenerateGroupOrderAnnotation)
{
generateAnnotations(BASE_INDENT, className, groups, out, this::decoderName);
}
out.append(generateDeclaration(className, implementsString, msgToken));
out.append(generateFieldOrderStates(fieldPrecedenceModel));
out.append(generateDecoderFlyweightCode(fieldPrecedenceModel, className, msgToken));
final StringBuilder sb = new StringBuilder();
generateDecoderFields(sb, fieldPrecedenceModel, fields, BASE_INDENT);
generateDecoderGroups(sb, fieldPrecedenceModel, className, groups, BASE_INDENT, false);
generateDecoderVarData(sb, fieldPrecedenceModel, varData, BASE_INDENT);
generateDecoderDisplay(sb, msgToken.name(), fields, groups, varData);
generateMessageLength(sb, className, true, groups, varData, BASE_INDENT);
out.append(sb);
out.append("}\n");
}
}
private void generateDecoderGroups(
final StringBuilder sb,
final FieldPrecedenceModel fieldPrecedenceModel, final String outerClassName,
final List<Token> tokens,
final String indent,
final boolean isSubGroup) throws IOException
{
for (int i = 0, size = tokens.size(); i < size; i++)
{
final Token groupToken = tokens.get(i);
if (groupToken.signal() != Signal.BEGIN_GROUP)
{
throw new IllegalStateException("tokens must begin with BEGIN_GROUP: token=" + groupToken);
}
final int index = i;
final String groupName = decoderName(formatClassName(groupToken.name()));
++i;
final int groupHeaderTokenCount = tokens.get(i).componentTokenCount();
i += groupHeaderTokenCount;
final List<Token> fields = new ArrayList<>();
i = collectFields(tokens, i, fields);
final List<Token> groups = new ArrayList<>();
i = collectGroups(tokens, i, groups);
final List<Token> varData = new ArrayList<>();
i = collectVarData(tokens, i, varData);
generateGroupDecoderProperty(sb, groupName, fieldPrecedenceModel, groupToken, indent, isSubGroup);
generateTypeJavadoc(sb, indent + INDENT, groupToken);
if (shouldGenerateGroupOrderAnnotation)
{
generateAnnotations(indent + INDENT, groupName, groups, sb, this::decoderName);
}
generateGroupDecoderClassHeader(sb, groupName, outerClassName, fieldPrecedenceModel, groupToken,
tokens, groups, index, indent + INDENT);
generateDecoderFields(sb, fieldPrecedenceModel, fields, indent + INDENT);
generateDecoderGroups(sb, fieldPrecedenceModel, outerClassName, groups, indent + INDENT, true);
generateDecoderVarData(sb, fieldPrecedenceModel, varData, indent + INDENT);
appendGroupInstanceDecoderDisplay(sb, fields, groups, varData, indent + INDENT);
generateMessageLength(sb, groupName, false, groups, varData, indent + INDENT);
sb.append(indent).append(" }\n");
}
}
private void generateEncoderGroups(
final StringBuilder sb,
final String outerClassName,
final FieldPrecedenceModel fieldPrecedenceModel,
final List<Token> tokens,
final String indent,
final boolean isSubGroup) throws IOException
{
for (int i = 0, size = tokens.size(); i < size; i++)
{
final Token groupToken = tokens.get(i);
if (groupToken.signal() != Signal.BEGIN_GROUP)
{
throw new IllegalStateException("tokens must begin with BEGIN_GROUP: token=" + groupToken);
}
final int index = i;
final String groupName = groupToken.name();
final String groupClassName = encoderName(groupName);
++i;
final int groupHeaderTokenCount = tokens.get(i).componentTokenCount();
i += groupHeaderTokenCount;
final List<Token> fields = new ArrayList<>();
i = collectFields(tokens, i, fields);
final List<Token> groups = new ArrayList<>();
i = collectGroups(tokens, i, groups);
final List<Token> varData = new ArrayList<>();
i = collectVarData(tokens, i, varData);
generateGroupEncoderProperty(sb, groupName, fieldPrecedenceModel, groupToken, indent, isSubGroup);
generateTypeJavadoc(sb, indent + INDENT, groupToken);
if (shouldGenerateGroupOrderAnnotation)
{
generateAnnotations(indent + INDENT, groupClassName, groups, sb, this::encoderName);
}
generateGroupEncoderClassHeader(
sb, groupName, outerClassName, fieldPrecedenceModel, groupToken,
tokens, groups, index, indent + INDENT);
generateEncoderFields(sb, groupClassName, fieldPrecedenceModel, fields, indent + INDENT);
generateEncoderGroups(sb, outerClassName, fieldPrecedenceModel, groups, indent + INDENT, true);
generateEncoderVarData(sb, groupClassName, fieldPrecedenceModel, varData, indent + INDENT);
sb.append(indent).append(" }\n");
}
}
private void generateGroupDecoderClassHeader(
final StringBuilder sb,
final String groupName,
final String parentMessageClassName,
final FieldPrecedenceModel fieldPrecedenceModel,
final Token groupToken,
final List<Token> tokens,
final List<Token> subGroupTokens,
final int index,
final String indent)
{
final String className = formatClassName(groupName);
final int dimensionHeaderLen = tokens.get(index + 1).encodedLength();
final Token blockLengthToken = Generators.findFirst("blockLength", tokens, index);
final Token numInGroupToken = Generators.findFirst("numInGroup", tokens, index);
final PrimitiveType blockLengthType = blockLengthToken.encoding().primitiveType();
final String blockLengthOffset = "limit + " + blockLengthToken.offset();
final String blockLengthGet = generateGet(
blockLengthType, blockLengthOffset, byteOrderString(blockLengthToken.encoding()));
final PrimitiveType numInGroupType = numInGroupToken.encoding().primitiveType();
final String numInGroupOffset = "limit + " + numInGroupToken.offset();
final String numInGroupGet = generateGet(
numInGroupType, numInGroupOffset, byteOrderString(numInGroupToken.encoding()));
generateGroupDecoderClassDeclaration(
sb,
groupName,
parentMessageClassName,
findSubGroupNames(subGroupTokens),
indent,
dimensionHeaderLen);
final String blockLenCast = PrimitiveType.UINT32 == blockLengthType ? "(int)" : "";
final String numInGroupCast = PrimitiveType.UINT32 == numInGroupType ? "(int)" : "";
sb.append("\n")
.append(indent).append(" public void wrap(final ").append(readOnlyBuffer).append(" buffer)\n")
.append(indent).append(" {\n")
.append(indent).append(" if (buffer != this.buffer)\n")
.append(indent).append(" {\n")
.append(indent).append(" this.buffer = buffer;\n")
.append(indent).append(" }\n\n")
.append(indent).append(" index = 0;\n")
.append(indent).append(" final int limit = parentMessage.limit();\n")
.append(indent).append(" parentMessage.limit(limit + HEADER_SIZE);\n")
.append(indent).append(" blockLength = ").append(blockLenCast).append(blockLengthGet).append(";\n")
.append(indent).append(" count = ").append(numInGroupCast).append(numInGroupGet).append(";\n")
.append(indent).append(" }\n\n");
generateAccessOrderListenerMethodForNextGroupElement(sb, fieldPrecedenceModel, indent + " ", groupToken);
sb.append(indent).append(" public ").append(className).append(" next()\n")
.append(indent).append(" {\n")
.append(indent).append(" if (index >= count)\n")