Skip to content

Commit 39343dd

Browse files
raydacraydac
committed
improved notification in DSL builder, var name mechanism now is more tolerant and Java generator is aware about Java key words
1 parent baecfd5 commit 39343dd

File tree

5 files changed

+154
-23
lines changed

5 files changed

+154
-23
lines changed

‎jbbp/src/main/java/com/igormaznitsa/jbbp/compiler/conversion/JBBPToJava6Converter.java‎

Lines changed: 97 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,70 @@ public final class JBBPToJava6Converter extends CompiledBlockVisitor {
5151
private static final int FLAG_DETECTED_VAR_FIELDS = 4;
5252
private static final int FLAG_ADD_ASSERT_NOT_NEGATIVE_EXPR = 8;
5353

54+
private static final Set<String> RESERVED_JAVA_KEYWORDS;
55+
56+
static {
57+
final Set<String> reserved = new HashSet<String>();
58+
59+
reserved.add("abstract");
60+
reserved.add("assert");
61+
reserved.add("boolean");
62+
reserved.add("break");
63+
reserved.add("byte");
64+
reserved.add("case");
65+
reserved.add("catch");
66+
reserved.add("char");
67+
reserved.add("class");
68+
reserved.add("continue");
69+
reserved.add("default");
70+
reserved.add("do");
71+
reserved.add("double");
72+
reserved.add("else");
73+
reserved.add("enum");
74+
reserved.add("extends");
75+
reserved.add("final");
76+
reserved.add("finally");
77+
reserved.add("float");
78+
reserved.add("for");
79+
reserved.add("if");
80+
reserved.add("implements");
81+
reserved.add("import");
82+
reserved.add("instanceof");
83+
reserved.add("int");
84+
reserved.add("interface");
85+
reserved.add("long");
86+
reserved.add("native");
87+
reserved.add("new");
88+
reserved.add("package");
89+
reserved.add("private");
90+
reserved.add("protected");
91+
reserved.add("public");
92+
reserved.add("return");
93+
reserved.add("short");
94+
reserved.add("static");
95+
reserved.add("strictfp");
96+
reserved.add("super");
97+
reserved.add("switch");
98+
reserved.add("synchronized");
99+
reserved.add("this");
100+
reserved.add("throw");
101+
reserved.add("throws");
102+
reserved.add("transient");
103+
reserved.add("try");
104+
reserved.add("void");
105+
reserved.add("volatile");
106+
reserved.add("while");
107+
reserved.add("true");
108+
reserved.add("null");
109+
reserved.add("false");
110+
reserved.add("var");
111+
reserved.add("const");
112+
reserved.add("goto");
113+
114+
RESERVED_JAVA_KEYWORDS = Collections.unmodifiableSet(reserved);
115+
}
116+
117+
54118
/**
55119
* Name of the field to be used as link to the root structure instance in
56120
* child structures.
@@ -266,7 +330,7 @@ public void visitEnd() {
266330

267331
@Override
268332
public void visitStructureStart(final int offsetInCompiledBlock, final JBBPNamedFieldInfo nullableNameFieldInfo, final JBBPIntegerValueEvaluator nullableArraySize) {
269-
final String structName = (nullableNameFieldInfo == null ? makeAnonymousStructName() : nullableNameFieldInfo.getFieldName()).toLowerCase(Locale.ENGLISH);
333+
final String structName = (nullableNameFieldInfo == null ? makeAnonymousStructName() : prepFldName(nullableNameFieldInfo.getFieldName())).toLowerCase(Locale.ENGLISH);
270334
final String structBaseTypeName = structName.toUpperCase(Locale.ENGLISH);
271335
final String arraySizeIn = nullableArraySize == null ? null : evaluatorToString(NAME_INPUT_STREAM, offsetInCompiledBlock, nullableArraySize, this.flagSet, true);
272336
final String arraySizeOut = nullableArraySize == null ? null : evaluatorToString(NAME_OUTPUT_STREAM, offsetInCompiledBlock, nullableArraySize, this.flagSet, true);
@@ -339,14 +403,34 @@ private void processSkipRemainingFlagForWriting(final String structFieldName) {
339403
}
340404
}
341405

406+
private String prepFldName(final String fieldName) {
407+
String result = fieldName;
408+
if (RESERVED_JAVA_KEYWORDS.contains(fieldName)) {
409+
result = '_' + result;
410+
} else if (fieldName.startsWith("_")) {
411+
if (fieldName.endsWith("_")) {
412+
final String withoutUnderscores = fieldName.substring(1, fieldName.length() - 1);
413+
if (RESERVED_JAVA_KEYWORDS.contains(withoutUnderscores)) {
414+
result = '_' + result + anonymousFieldCounter.incrementAndGet() + '_';
415+
}
416+
} else {
417+
final String withoutUnderscore = fieldName.substring(1);
418+
if (RESERVED_JAVA_KEYWORDS.contains(withoutUnderscore)) {
419+
result += '_';
420+
}
421+
}
422+
}
423+
return result;
424+
}
425+
342426
@Override
343427
public void visitStructureEnd(final int offsetInCompiledBlock, final JBBPNamedFieldInfo nullableNameFieldInfo) {
344428
this.structStack.remove(0);
345429
}
346430

347431
@Override
348432
public void visitValField(final int offsetInCompiledBlock, final JBBPNamedFieldInfo nameFieldInfo, final JBBPIntegerValueEvaluator expression) {
349-
final String fieldName = nameFieldInfo.getFieldName();
433+
final String fieldName = prepFldName(nameFieldInfo.getFieldName());
350434
FieldType type = FieldType.VAL;
351435

352436
registerNamedField(nameFieldInfo, type);
@@ -372,7 +456,7 @@ public void visitValField(final int offsetInCompiledBlock, final JBBPNamedFieldI
372456

373457
@Override
374458
public void visitPrimitiveField(final int offsetInCompiledBlock, final int primitiveType, final JBBPNamedFieldInfo nullableNameFieldInfo, final JBBPByteOrder byteOrder, final boolean readWholeStreamAsArray, final boolean altFieldType, final JBBPIntegerValueEvaluator nullableArraySize) {
375-
final String fieldName = nullableNameFieldInfo == null ? makeAnonymousFieldName() : nullableNameFieldInfo.getFieldName();
459+
final String fieldName = nullableNameFieldInfo == null ? makeAnonymousFieldName() : prepFldName(nullableNameFieldInfo.getFieldName());
376460
FieldType type = FieldType.findForCode(primitiveType);
377461

378462
if (altFieldType) {
@@ -440,7 +524,7 @@ private void registerGetterSetter(final String fieldType, final String fieldName
440524

441525
@Override
442526
public void visitBitField(final int offsetInCompiledBlock, final JBBPNamedFieldInfo nullableNameFieldInfo, final JBBPIntegerValueEvaluator notNullFieldSize, final JBBPIntegerValueEvaluator nullableArraySize) {
443-
final String fieldName = nullableNameFieldInfo == null ? makeAnonymousFieldName() : nullableNameFieldInfo.getFieldName();
527+
final String fieldName = nullableNameFieldInfo == null ? makeAnonymousFieldName() : prepFldName(nullableNameFieldInfo.getFieldName());
444528

445529
registerNamedField(nullableNameFieldInfo, FieldType.BIT);
446530

@@ -513,7 +597,7 @@ public void visitCustomField(final int offsetInCompiledBlock, final JBBPFieldTyp
513597

514598
registerNamedField(nullableNameFieldInfo, FieldType.CUSTOM);
515599

516-
final String fieldName = nullableNameFieldInfo == null ? makeAnonymousFieldName() : nullableNameFieldInfo.getFieldName();
600+
final String fieldName = nullableNameFieldInfo == null ? makeAnonymousFieldName() : prepFldName(nullableNameFieldInfo.getFieldName());
517601
final String fieldModifier = makeModifier(nullableNameFieldInfo);
518602

519603
final String specialFieldName = makeSpecialFieldName();
@@ -527,7 +611,7 @@ public void visitCustomField(final int offsetInCompiledBlock, final JBBPFieldTyp
527611
if (nullableNameFieldInfo != null) {
528612
this.specialSection.printf("private static final JBBPNamedFieldInfo %s = %s;%n",
529613
specialFieldName_fieldNameInfo,
530-
"new JBBPNamedFieldInfo(\"" + nullableNameFieldInfo.getFieldName() + "\",\"" + nullableNameFieldInfo.getFieldPath() + "\"," + nullableNameFieldInfo.getFieldOffsetInCompiledBlock() + ")"
614+
"new JBBPNamedFieldInfo(\"" + prepFldName(nullableNameFieldInfo.getFieldName()) + "\",\"" + nullableNameFieldInfo.getFieldPath() + "\"," + nullableNameFieldInfo.getFieldOffsetInCompiledBlock() + ")"
531615
);
532616
}
533617

@@ -572,7 +656,7 @@ public void visitVarField(final int offsetInCompiledBlock, final JBBPNamedFieldI
572656

573657
registerNamedField(nullableNameFieldInfo, FieldType.VAR);
574658

575-
final String fieldName = nullableNameFieldInfo == null ? makeAnonymousFieldName() : nullableNameFieldInfo.getFieldName();
659+
final String fieldName = nullableNameFieldInfo == null ? makeAnonymousFieldName() : prepFldName(nullableNameFieldInfo.getFieldName());
576660
final String fieldModifier = makeModifier(nullableNameFieldInfo);
577661

578662
final String specialFieldName = makeSpecialFieldName();
@@ -581,7 +665,7 @@ public void visitVarField(final int offsetInCompiledBlock, final JBBPNamedFieldI
581665
if (nullableNameFieldInfo != null) {
582666
this.specialSection.printf("private static final JBBPNamedFieldInfo %s = %s;%n",
583667
specialFieldName_fieldNameInfo,
584-
"new JBBPNamedFieldInfo(\"" + nullableNameFieldInfo.getFieldName() + "\",\"" + nullableNameFieldInfo.getFieldPath() + "\"," + nullableNameFieldInfo.getFieldOffsetInCompiledBlock() + ")"
668+
"new JBBPNamedFieldInfo(\"" + prepFldName(nullableNameFieldInfo.getFieldName()) + "\",\"" + nullableNameFieldInfo.getFieldPath() + "\"," + nullableNameFieldInfo.getFieldOffsetInCompiledBlock() + ")"
585669
);
586670
}
587671

@@ -1364,7 +1448,7 @@ JavaSrcTextBuffer getGettersSetters() {
13641448
}
13651449
}
13661450

1367-
private static final class NamedFieldInfo {
1451+
private final class NamedFieldInfo {
13681452

13691453
final JBBPNamedFieldInfo info;
13701454
final Struct struct;
@@ -1377,14 +1461,15 @@ private static final class NamedFieldInfo {
13771461
}
13781462

13791463
String makeSrcPath(final Struct currentStruct) {
1464+
final String fieldName = prepFldName(info.getFieldName());
13801465
if (this.struct == currentStruct) {
1381-
return "this." + info.getFieldName();
1466+
return "this." + fieldName;
13821467
} else {
13831468
final String structPath = this.struct.getPath();
13841469
if (currentStruct.isRoot()) {
1385-
return "this." + (structPath.length() == 0 ? "" : structPath + ".") + info.getFieldName();
1470+
return "this." + (structPath.length() == 0 ? "" : structPath + ".") + fieldName;
13861471
} else {
1387-
return "this." + NAME_ROOT_STRUCT + '.' + (structPath.length() == 0 ? "" : structPath + ".") + info.getFieldName();
1472+
return "this." + NAME_ROOT_STRUCT + '.' + (structPath.length() == 0 ? "" : structPath + ".") + fieldName;
13881473
}
13891474
}
13901475
}

‎jbbp/src/main/java/com/igormaznitsa/jbbp/compiler/tokenizer/JBBPTokenizer.java‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -257,8 +257,15 @@ private JBBPTokenizerException checkFieldName(final String name, final int posit
257257
if (normalized.indexOf('.') >= 0) {
258258
return new JBBPTokenizerException("Field name must not contain '.' char", position);
259259
}
260-
if (this.reservedTypeNames.contains(normalized) || normalized.startsWith("$")) {
261-
return new JBBPTokenizerException("'" + name + "' can't be used as field name", position);
260+
261+
if (normalized.length() > 0) {
262+
if (normalized.equalsIgnoreCase("_")
263+
|| normalized.startsWith("$")
264+
|| normalized.equals("$$")
265+
|| Character.isDigit(normalized.charAt(0))
266+
) {
267+
return new JBBPTokenizerException("'" + name + "' can't be used as field name", position);
268+
}
262269
}
263270
}
264271
return null;

‎jbbp/src/main/java/com/igormaznitsa/jbbp/utils/JBBPDslBuilder.java‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -93,13 +93,18 @@ protected static String assertTextNotNullAndTrimmedNotEmpty(final String text) {
9393

9494
protected static String assertNameIfNotNull(final String name) {
9595
if (name != null) {
96+
if (name.equals("_")) {
97+
throw new IllegalArgumentException("Only underscore is not allowed as name");
98+
}
99+
96100
for (int i = 0; i < name.length(); i++) {
97101
final char c = name.charAt(i);
98-
if (i == 0 && (Character.isDigit(c))) {
99-
throw new IllegalArgumentException("Digit can't be first char");
102+
if (i == 0 && Character.isDigit(c)) {
103+
throw new IllegalArgumentException("Digit can't be first char");
100104
}
105+
101106
if (!Character.isLetterOrDigit(c) && c != '_') {
102-
throw new IllegalArgumentException("Only letters and digits allowed: " + name);
107+
throw new IllegalArgumentException("Only letters, digits and underscore allowed: " + name);
103108
}
104109
}
105110
}

‎jbbp/src/test/java/com/igormaznitsa/jbbp/compiler/JBBPCompilerTest.java‎

Lines changed: 34 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -284,12 +284,40 @@ public void testCompile_ErrorForNonClosedStructure() throws Exception {
284284

285285
@Test
286286
public void testCompile_ErrorForIllegaFieldName() throws Exception {
287-
try {
288-
JBBPCompiler.compile(" byte int;");
289-
fail("Must throw Tokenizer Exception");
290-
} catch (JBBPTokenizerException ex) {
291-
assertEquals(2, ex.getPosition());
292-
}
287+
assertThrows(JBBPTokenizerException.class, new Executable() {
288+
@Override
289+
public void execute() throws Throwable {
290+
JBBPCompiler.compile(" byte _;");
291+
}
292+
});
293+
294+
assertThrows(JBBPTokenizerException.class, new Executable() {
295+
@Override
296+
public void execute() throws Throwable {
297+
JBBPCompiler.compile(" byte $a;");
298+
}
299+
});
300+
301+
assertThrows(JBBPTokenizerException.class, new Executable() {
302+
@Override
303+
public void execute() throws Throwable {
304+
JBBPCompiler.compile(" byte $$;");
305+
}
306+
});
307+
308+
assertThrows(JBBPTokenizerException.class, new Executable() {
309+
@Override
310+
public void execute() throws Throwable {
311+
JBBPCompiler.compile(" byte a.b;");
312+
}
313+
});
314+
315+
assertThrows(JBBPTokenizerException.class, new Executable() {
316+
@Override
317+
public void execute() throws Throwable {
318+
JBBPCompiler.compile(" byte 1d;");
319+
}
320+
});
293321
}
294322

295323
@Test

‎jbbp/src/test/java/com/igormaznitsa/jbbp/compiler/conversion/JBBPToJBBPToJava6ConverterCompilationTest.java‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,12 @@ private void assertCompilation(final String classSrc) throws Exception {
4242
assertNotNull(saveAndCompile(new JavaClassContent(PACKAGE_NAME + '.' + CLASS_NAME, classSrc)));
4343
}
4444

45+
@Test
46+
public void testVarNamesAsJavaTypes() throws Exception {
47+
final JBBPParser parser = JBBPParser.prepare("ubyte;int integer; int number; int try; int byte; int _byte; int _byte_; int char; int short; int long; int double; int float; int [long+double+char] string;");
48+
assertCompilation(makeSources(parser, "some multiline text\nto be added into header", true));
49+
}
50+
4551
@Test
4652
public void testExpression() throws Exception {
4753
final JBBPParser parser = JBBPParser.prepare("bit:8 bitf; var somevar; bool bbb; long aaa; ubyte kkk; {{int lrn; {int [(lrn/aaa*1*(2*somevar-4)&$joomla)/(100%9>>bitf)&56|~kkk^78&bbb];}}}");

0 commit comments

Comments
 (0)