Add the golang keywords to the set of identifier checks.

This causes the Car example to change as 'make' is reserved which is
changed to 'brand'. This has cascading effects into the samples and
benchmarks for both Java and CPP but it remains sane.

It also adjust the number of expected errors in two of the
ErrorHandler tests as 'true' and 'false' get additionally counted for
golang.

Author: billsegall

sbe-benchmarks/src/main/cpp/SbeCarCodecBench.h

@@ -24,8 +24,8 @@ using namespace uk::co::real_logic::sbe::benchmarks;
 char VEHICLE_CODE[] = {'a', 'b', 'c', 'd', 'e', 'f'};
 uint32_t SOMENUMBERS[] = { 1, 2, 3, 4, 5 };
 char MANUFACTURER_CODE[] = {'1', '2', '3'};
-const char *MAKE = "Honda";
-int MAKELEN = strlen(MAKE);
+const char *BRAND = "Honda";
+int BRANDLEN = strlen(BRAND);
 const char *MODEL = "Civic VTi";
 int MODELLEN = strlen(MODEL);
 
@@ -73,7 +73,7 @@ class SbeCarCodecBench : public CodecBench<SbeCarCodecBench>
                 .next().mph(60).seconds(7.1f)
                 .next().mph(100).seconds(11.8f);
 
-        car.putMake(MAKE, MAKELEN);
+        car.putBrand(BRAND, BRANDLEN);
         car.putModel(MODEL, MODELLEN);
 
         return car.encodedLength();
@@ -130,7 +130,7 @@ class SbeCarCodecBench : public CodecBench<SbeCarCodecBench>
             }
         }
 
-        tmpChar = car.make();
+        tmpChar = car.brand();
         tmpChar = car.model();
 
         return car.encodedLength();

sbe-benchmarks/src/main/java/uk/co/real_logic/sbe/CarBenchmark.java

@@ -24,7 +24,7 @@
 
 public class CarBenchmark
 {
-    private static final byte[] MAKE;
+    private static final byte[] BRAND;
     private static final byte[] MODEL;
     private static final byte[] ENG_MAN_CODE;
     private static final byte[] VEHICLE_CODE;
@@ -33,7 +33,7 @@ public class CarBenchmark
     {
         try
         {
-            MAKE = "MAKE".getBytes(CarEncoder.makeCharacterEncoding());
+            BRAND = "BRAND".getBytes(CarEncoder.brandCharacterEncoding());
             MODEL = "MODEL".getBytes(CarEncoder.modelCharacterEncoding());
             ENG_MAN_CODE = "abc".getBytes(EngineEncoder.manufacturerCodeCharacterEncoding());
             VEHICLE_CODE = "abcdef".getBytes(CarEncoder.vehicleCodeCharacterEncoding());
@@ -141,7 +141,7 @@ public static void encode(
                    .next().mph(60).seconds(7.1f)
                    .next().mph(100).seconds(11.8f);
 
-        car.putMake(MAKE, 0, MAKE.length);
+        car.putBrand(BRAND, 0, BRAND.length);
         car.putModel(MODEL, 0, MODEL.length);
     }
 
@@ -207,7 +207,7 @@ private static void decode(
             }
         }
 
-        car.getMake(tempBuffer, 0, tempBuffer.length);
+        car.getBrand(tempBuffer, 0, tempBuffer.length);
         car.getModel(tempBuffer, 0, tempBuffer.length);
     }
 

sbe-benchmarks/src/main/resources/car.xml

@@ -69,7 +69,7 @@
                 <field name="seconds" id="16" type="float"/>
             </group>
         </group>
-        <data name="make" id="17" type="varDataEncoding"/>
+        <data name="brand" id="17" type="varDataEncoding"/>
         <data name="model" id="18" type="varDataEncoding"/>
     </sbe:message>
 </sbe:messageSchema>

sbe-samples/src/main/cpp/GeneratedStubExample.cpp

@@ -32,7 +32,7 @@ using namespace baseline;
 
 char VEHICLE_CODE[] = {'a', 'b', 'c', 'd', 'e', 'f'};
 char MANUFACTURER_CODE[] = {'1', '2', '3'};
-const char *MAKE = "Honda";
+const char *BRAND = "Honda";
 const char *MODEL = "Civic VTi";
 const int messageHeaderVersion = 0;
 
@@ -117,7 +117,7 @@ std::size_t encodeCar(Car &car, char *buffer, std::uint64_t offset, std::uint64_
             .next().mph(60).seconds(7.1f)
             .next().mph(100).seconds(11.8f);
 
-    car.putMake(MAKE, 5)
+    car.putBrand(BRAND, 5)
         .putModel(MODEL, 9)
         .putActivationCode("deadbeef", 8);
 
@@ -198,8 +198,8 @@ std::size_t decodeCar(
     std::cout << "\ncar.performanceFigures.accelerationId=" << Car::PerformanceFigures::accelerationId();
     std::cout << "\ncar.performanceFigures.acceleration.mphId=" << Car::PerformanceFigures::Acceleration::mphId();
     std::cout << "\ncar.performanceFigures.acceleration.secondsId=" << Car::PerformanceFigures::Acceleration::secondsId();
-    std::cout << "\ncar.makeId=" << Car::makeId();
-    std::cout << "\ncar.makeCharacterEncoding=" << Car::makeCharacterEncoding();
+    std::cout << "\ncar.brandId=" << Car::brandId();
+    std::cout << "\ncar.brandCharacterEncoding=" << Car::brandCharacterEncoding();
     std::cout << "\ncar.modelId=" << Car::modelId();
     std::cout << "\ncar.modelCharacterEncoding=" << Car::modelCharacterEncoding();
     std::cout << "\ncar.activationCodeId=" << Car::activationCodeId();
@@ -282,9 +282,9 @@ std::size_t decodeCar(
         }
     }
 
-    bytesCopied = car.getMake(tmp, sizeof(tmp));
-    std::cout << "\ncar.makeLength=" << bytesCopied;
-    std::cout << "\ncar.make=" << std::string(tmp, bytesCopied);
+    bytesCopied = car.getBrand(tmp, sizeof(tmp));
+    std::cout << "\ncar.brandLength=" << bytesCopied;
+    std::cout << "\ncar.brand=" << std::string(tmp, bytesCopied);
 
     bytesCopied = car.getModel(tmp, sizeof(tmp));
     std::cout << "\ncar.modelLength=" << bytesCopied;

sbe-samples/src/main/cpp/OtfExample.cpp

@@ -315,7 +315,7 @@ static char MANUFACTURER_CODE[] = { '1', '2', '3' };
 static const char *FUEL_FIGURES_1_USAGE_DESCRIPTION = "Urban Cycle";
 static const char *FUEL_FIGURES_2_USAGE_DESCRIPTION = "Combined Cycle";
 static const char *FUEL_FIGURES_3_USAGE_DESCRIPTION = "Highway Cycle";
-static const char *MAKE = "Honda";
+static const char *BRAND = "Honda";
 static const char *MODEL = "Civic VTi";
 static const char *ACTIVATION_CODE = "deadbeef";
 
@@ -417,7 +417,7 @@ std::uint64_t encodeHdrAndCar(char *buffer, std::uint64_t length)
         .next().mph(perf2bMph).seconds(perf2bSeconds)
         .next().mph(perf2cMph).seconds(perf2cSeconds);
 
-    car.putMake(MAKE, static_cast<int>(strlen(MAKE)))
+    car.putBrand(BRAND, static_cast<int>(strlen(BRAND)))
         .putModel(MODEL, static_cast<int>(strlen(MODEL)))
         .putActivationCode(ACTIVATION_CODE, static_cast<int>(strlen(ACTIVATION_CODE)));
 
@@ -463,4 +463,4 @@ int main(int argc, char **argv)
     }
 
     return 0;
-}
+}

sbe-samples/src/main/java/uk/co/real_logic/sbe/examples/ExampleUsingGeneratedStub.java

@@ -30,7 +30,7 @@ public class ExampleUsingGeneratedStub
     private static final String ENCODING_FILENAME = "sbe.encoding.filename";
     private static final byte[] VEHICLE_CODE;
     private static final byte[] MANUFACTURER_CODE;
-    private static final byte[] MAKE;
+    private static final byte[] BRAND;
     private static final byte[] MODEL;
     private static final UnsafeBuffer ACTIVATION_CODE;
 
@@ -45,7 +45,7 @@ public class ExampleUsingGeneratedStub
         {
             VEHICLE_CODE = "abcdef".getBytes(CarEncoder.vehicleCodeCharacterEncoding());
             MANUFACTURER_CODE = "123".getBytes(EngineEncoder.manufacturerCodeCharacterEncoding());
-            MAKE = "Honda".getBytes(CarEncoder.makeCharacterEncoding());
+            BRAND = "Honda".getBytes(CarEncoder.brandCharacterEncoding());
             MODEL = "Civic VTi".getBytes(CarEncoder.modelCharacterEncoding());
             ACTIVATION_CODE = new UnsafeBuffer("abcdef".getBytes(CarEncoder.activationCodeCharacterEncoding()));
         }
@@ -158,7 +158,7 @@ public static int encode(final CarEncoder car, final UnsafeBuffer directBuffer,
 
         // An exception will be raised if the string length is larger than can be encoded in the varDataEncoding length field
         // Please use a suitable schema type for varDataEncoding.length: uint8 <= 254, uint16 <= 65534
-        car.make(new String(MAKE, StandardCharsets.UTF_8))
+        car.brand(new String(BRAND, StandardCharsets.UTF_8))
             .putModel(MODEL, srcOffset, MODEL.length)
             .putActivationCode(ACTIVATION_CODE, 0, ACTIVATION_CODE.capacity());
 
@@ -238,7 +238,7 @@ public static void decode(
             }
         }
 
-        sb.append("\ncar.make=").append(car.make());
+        sb.append("\ncar.brand=").append(car.brand());
 
         sb.append("\ncar.model=").append(
             new String(buffer, 0, car.getModel(buffer, 0, buffer.length), CarEncoder.modelCharacterEncoding()));

sbe-samples/src/main/java/uk/co/real_logic/sbe/examples/ExampleUsingGeneratedStubExtension.java

@@ -31,7 +31,7 @@ public class ExampleUsingGeneratedStubExtension
     private static final String ENCODING_FILENAME = "sbe.encoding.filename";
     private static final byte[] VEHICLE_CODE;
     private static final byte[] MANUFACTURER_CODE;
-    private static final byte[] MAKE;
+    private static final byte[] BRAND;
     private static final byte[] MODEL;
     private static final UnsafeBuffer ACTIVATION_CODE;
 
@@ -46,7 +46,7 @@ public class ExampleUsingGeneratedStubExtension
         {
             VEHICLE_CODE = "abcdef".getBytes(baseline.CarEncoder.vehicleCodeCharacterEncoding());
             MANUFACTURER_CODE = "123".getBytes(baseline.EngineEncoder.manufacturerCodeCharacterEncoding());
-            MAKE = "Honda".getBytes(baseline.CarEncoder.makeCharacterEncoding());
+            BRAND = "Honda".getBytes(baseline.CarEncoder.brandCharacterEncoding());
             MODEL = "Civic VTi".getBytes(baseline.CarEncoder.modelCharacterEncoding());
             ACTIVATION_CODE = new UnsafeBuffer("abcdef".getBytes(baseline.CarEncoder.activationCodeCharacterEncoding()));
         }
@@ -157,7 +157,7 @@ public static int encode(final baseline.CarEncoder car, final UnsafeBuffer direc
             .next().mph(60).seconds(7.1f)
             .next().mph(100).seconds(11.8f);
 
-        car.putMake(MAKE, srcOffset, MAKE.length)
+        car.putBrand(BRAND, srcOffset, BRAND.length)
             .putModel(MODEL, srcOffset, MODEL.length)
             .putActivationCode(ACTIVATION_CODE, 0, ACTIVATION_CODE.capacity());
 
@@ -240,8 +240,8 @@ public static void decode(
             }
         }
 
-        sb.append("\ncar.make=").append(
-            new String(buffer, 0, car.getMake(buffer, 0, buffer.length), extension.CarEncoder.makeCharacterEncoding()));
+        sb.append("\ncar.brand=").append(
+            new String(buffer, 0, car.getBrand(buffer, 0, buffer.length), extension.CarEncoder.brandCharacterEncoding()));
 
         sb.append("\ncar.model=").append(
             new String(buffer, 0, car.getModel(buffer, 0, buffer.length), extension.CarEncoder.modelCharacterEncoding()));

sbe-samples/src/main/resources/example-extension-schema.xml

@@ -83,7 +83,7 @@
                 <field name="seconds" id="17" type="float"/>
             </group>
         </group>
-        <data name="make" id="18" type="varDataEncoding"/>
+        <data name="brand" id="18" type="varDataEncoding"/>
         <data name="model" id="19" type="varDataEncoding"/>
         <data name="activationCode" id="20" type="varDataEncoding"/>
     </sbe:message>

sbe-samples/src/main/resources/example-schema.xml

@@ -81,7 +81,7 @@
                 <field name="seconds" id="17" type="float"/>
             </group>
         </group>
-        <data name="make" id="18" type="varDataEncoding"/>
+        <data name="brand" id="18" type="varDataEncoding"/>
         <data name="model" id="19" type="varDataEncoding"/>
         <data name="activationCode" id="20" type="varDataEncoding"/>
     </sbe:message>

sbe-tool/src/main/java/uk/co/real_logic/sbe/util/ValidationUtil.java

@@ -198,4 +198,97 @@ private static boolean isJavaIdentifier(final String token)
 
         return true;
     }
+
+    private static final Set<String> GOLANG_KEYWORDS = new HashSet<>(
+        Arrays.asList(new String[]
+        {
+            /* https://golang.org/ref/spec#Keywords */
+            "break",    "default",     "func",   "interface", "select",
+            "case",     "defer",       "go",     "map",       "struct",
+            "chan",     "else",        "goto",   "package",   "switch",
+            "const",    "fallthrough", "if",     "range",     "type",
+            "continue", "for",         "import", "return",    "var",
+
+            /* https://golang.org/ref/spec#Predeclared_identifiers */
+            /* types */
+            "bool", "byte",  "complex64", "complex128", "error",  "float32", "float64",
+            "int",  "int8",  "int16",     "int32",      "int64",  "rune",    "string",
+            "uint", "uint8", "uint16",    "uint32",     "uint64", "uintptr",
+            /* constants */
+            "true", "false", "iota",
+            /* zero value */
+            "nil",
+            /* functions */
+            "append", "cap", "close", "complex", "copy",    "delete", "imag", "len",
+            "make",   "new", "panic", "print",   "println", "real",   "recover"
+        }));
+
+    /**
+     * "Check" value for validity of usage as a golang identifier. From:
+     * https://golang.org/ref/spec#Identifiers
+     *
+     * identifier = letter { letter | unicode_digit }
+     * letter        = unicode_letter | "_" .
+     *
+     * unicode_letter and unicode_digit are defined in section 4.5 of the the unicode
+     * standard at http://www.unicode.org/versions/Unicode8.0.0/ and
+     * the Java Character and Digit functions are unicode friendly
+     *
+     * @param value to check
+     * @return true for validity as a golang name. false if not.
+     */
+    public static boolean isSbeGolangName(final String value)
+    {
+        if (possibleGolangKeyword(value))
+        {
+            if (isGolangKeyword(value))
+            {
+                return false;
+            }
+        }
+        else
+        {
+            return false;
+        }
+
+        return true;
+    }
+
+    public static boolean isGolangKeyword(final String token)
+    {
+        return GOLANG_KEYWORDS.contains(token);
+    }
+
+    private static boolean possibleGolangKeyword(final String value)
+    {
+        for (int i = 0, size = value.length(); i < size; i++)
+        {
+            final char c = value.charAt(i);
+
+            if (i == 0 && isSbeGolangIdentifierStart(c))
+            {
+                continue;
+            }
+
+            if (isSbeGolangIdentifierPart(c))
+            {
+                continue;
+            }
+
+            return false;
+        }
+
+        return true;
+    }
+
+    private static boolean isSbeGolangIdentifierStart(final char c)
+    {
+        return Character.isLetter(c) || c == '_';
+    }
+
+    private static boolean isSbeGolangIdentifierPart(final char c)
+    {
+        return Character.isLetterOrDigit(c) || c == '_';
+    }
+
 }

sbe-tool/src/main/java/uk/co/real_logic/sbe/xml/XmlSchemaParser.java

@@ -310,6 +310,11 @@ public static void checkForValidName(final Node node, final String name)
         {
             handleError(node, "name is not valid for Java: " + name);
         }
+
+        if (!ValidationUtil.isSbeGolangName(name))
+        {
+            handleError(node, "name is not valid for Golang: " + name);
+        }
     }
 
     private static void addTypeWithNameCheck(final Map<String, Type> typeByNameMap, final Type type, final Node node)