Merge pull request aeron-io#460 from MarketFactory/dotnet-alpha2

dotnet support alpha2

Author: mjpt777

.gitignore

@@ -95,6 +95,7 @@ gocode/src/extension2
 # csharp
 csharp/*/bin
 csharp/*/obj
+csharp/.nuget/nuget.exe
 csharp/.nuget/sbe-tool*.nupkg
 csharp/.nuget/sbe-tool-all.jar
 csharp/.nuget/examples/bin

csharp/.nuget/SBE.nuspec

@@ -2,7 +2,7 @@
 <package>
  <metadata>
  <id>sbe-tool</id>
- <version>0.1.7.0-alpha-1</version>
+ <version>0.1.7.1-alpha-2</version>
  <title>Simple Binary Encoding for .NET</title>
  <authors>MarketFactory Inc, Adaptive Consulting</authors>
  <owners>MarketFactory Inc, Adaptive Consulting</owners>

csharp/.nuget/do-release.sh

@@ -6,35 +6,13 @@ ROOTDIR=`dirname $0`
 VERSIONTXT=`cat $ROOTDIR/../../version.txt`
 VERSION=${VERSIONTXT%-SNAPSHOT} # Seems to be what's used
 
-# Write the version info into the assembly
-# Note we're using 0.VersionNumber during alpha/beta
-ASSEMBLYINFO=$ROOTDIR/../GlobalAssemblyInfo.cs
-(cat << @EOF
-[assembly: System.Reflection.AssemblyCopyright("Copyright © 2017 MarketFactory Inc. Copyright © Adaptive 2014. All rights reserved.")]
-#if DEBUG
-[assembly: System.Reflection.AssemblyDescription("Debug")]
-#else
-[assembly: System.Reflection.AssemblyDescription("Release")]
-#endif
-[assembly: System.Reflection.AssemblyVersion("VERSION")]
-[assembly: System.Reflection.AssemblyFileVersion("VERSION")]
-[assembly: System.Reflection.AssemblyInformationalVersion("VERSION")]
-@EOF
-)| sed -e "s+VERSION+0.$VERSION+g" > $ASSEMBLYINFO.new
-
-# Copy in if new
-if cmp $ASSEMBLYINFO $ASSEMBLYINFO.new
-then
- rm $ASSEMBLYINFO.new
-else
- cp $ASSEMBLYINFO.new $ASSEMBLYINFO
-fi
-
 # Copy in the jar
 cp $ROOTDIR/../../sbe-tool/build/libs/sbe-tool-$VERSIONTXT-all.jar $ROOTDIR/sbe-tool-all.jar
 
 # Build the nuget package
-NUGET=$ROOTDIR/../packages/NuGet.CommandLine.3.5.0/tools/NuGet.exe
+NUGET=$ROOTDIR/nuget.exe
+if [ ! -f $NUGET ]; then echo nuget.exe not found. Obtain it from https://dist.nuget.org/index.html; exit 1; fi
+
 $NUGET pack $ROOTDIR/sbe.nuspec
 
 

csharp/.nuget/examples/CarExample.cs

@@ -19,7 +19,7 @@
 
 class Example
 {
- public static void Main()
+ public static void ExampleMain()
  {
  // This byte array is used for encoding and decoding, this is what you would send on the wire or save to disk
  var byteBuffer = new byte[4096];
@@ -230,23 +230,23 @@ public static void Decode(Car car,
  sb.Append("\ncar.engine.Booster.BoostType=").Append(engine.Booster.BoostType);
  sb.Append("\ncar.engine.Booster.HorsePower=").Append(engine.Booster.HorsePower);
 
- var fuelFiguresGroup = car.FuelFigures; // decode a repeatable group (we will change the API to support foreach soon)
+ // The first way to access a repeating group is by using Next()
+ var fuelFiguresGroup = car.FuelFigures; 
  while (fuelFiguresGroup.HasNext)
  {
  var fuelFigures = fuelFiguresGroup.Next();
  sb.Append("\ncar.fuelFigures.speed=").Append(fuelFigures.Speed);
  sb.Append("\ncar.fuelFigures.mpg=").Append(fuelFigures.Mpg);
  }
 
- // the nested group
- var performanceFiguresGroup = car.PerformanceFigures;
- while (performanceFiguresGroup.HasNext)
+ // The second way to access a repeating group is to use an iterator
+ foreach (Car.PerformanceFiguresGroup performanceFigures in car.PerformanceFigures)
  {
- var performanceFigures = performanceFiguresGroup.Next();
  sb.Append("\ncar.performanceFigures.octaneRating=").Append(performanceFigures.OctaneRating);
 
+ // The third way to access a repeating group is loop over the count of elements
  var accelerationGroup = performanceFigures.Acceleration;
- while (accelerationGroup.HasNext)
+ for (int i = 0; i < accelerationGroup.Count; i++)
  {
  var acceleration = accelerationGroup.Next();
  sb.Append("\ncar.performanceFigures.acceleration.mph=").Append(acceleration.Mph);

csharp/.nuget/examples/baseline/Car.cs

@@ -228,9 +228,9 @@ public static string SomeNumbersMetaAttribute(MetaAttribute metaAttribute)
  return "";
  }
 
- public const uint SomeNumbersNullValue = 4294967294U;
+ public const uint SomeNumbersNullValue = 4294967295U;
  public const uint SomeNumbersMinValue = 0U;
- public const uint SomeNumbersMaxValue = 4294967293U;
+ public const uint SomeNumbersMaxValue = 4294967294U;
 
  public const int SomeNumbersLength = 5;
 
@@ -509,6 +509,14 @@ public FuelFiguresGroup Next()
  return this;
  }
 
+ public System.Collections.IEnumerator GetEnumerator()
+ {
+ while (this.HasNext)
+ {
+ yield return this.Next();
+ }
+ }
+
  public const int SpeedId = 11;
  public const int SpeedSinceVersion = 0;
  public const int SpeedDeprecated = 0;
@@ -716,6 +724,14 @@ public PerformanceFiguresGroup Next()
  return this;
  }
 
+ public System.Collections.IEnumerator GetEnumerator()
+ {
+ while (this.HasNext)
+ {
+ yield return this.Next();
+ }
+ }
+
  public const int OctaneRatingId = 14;
  public const int OctaneRatingSinceVersion = 0;
  public const int OctaneRatingDeprecated = 0;
@@ -836,6 +852,14 @@ public AccelerationGroup Next()
  return this;
  }
 
+ public System.Collections.IEnumerator GetEnumerator()
+ {
+ while (this.HasNext)
+ {
+ yield return this.Next();
+ }
+ }
+
  public const int MphId = 16;
  public const int MphSinceVersion = 0;
  public const int MphDeprecated = 0;

csharp/.nuget/examples/baseline/VarStringEncoding.cs

@@ -21,7 +21,7 @@ public void Wrap(DirectBuffer buffer, int offset, int actingVersion)
 
  public const int Size = -1;
 
- public const uint LengthNullValue = 4294967294U;
+ public const uint LengthNullValue = 4294967295U;
  public const uint LengthMinValue = 0U;
  public const uint LengthMaxValue = 1073741824U;
 

csharp/README.md

@@ -34,11 +34,23 @@ Roadmap
 -------
 The csharp generator is as of May 2017 a preview release. API stability is not guaranteed. Documentation is a work in progress. The current roadmap contains: 
 
- * Documentation
+ * Improved Documentation
  * Testing/bug fixes
  * Better nuget Packaging 
- * Dotnet core support (The code is known to work but is not built/distributed for dotnet core)
- * Possible changes to make soem objects iterable
+ * Dotnet standard 2.9 support when available
+ * Possible changes to make group objects accessible without requiring
+ a linear progression.
+
+Nuget Package
+-------------
+The nuget package can be built using ~csharp/.nuget/do-release.sh. It has a dependency on the [nuget.exe]
+(https://dist.nuget.org/index.html).
+
+Before release it will probbalty be necessary to copy in changed files for the example contained in the published nuget
+package. This is a manual process for now.
+
+Once the nuget package is built it can be tested within the example project by adding a local disk path to the nuget
+file locations and then updating sbe-tool within the example. 
 
 
 Want to build things yourself?
@@ -48,5 +60,7 @@ For now you can:
  * build the SBE csharp generator using `gradlew`
  * generate the csharp codecs using `gradlew GenerateCSharpCodecs`
  * Use the [Visual Studio 2017 Community solution](https://github.com/real-logic/simple-binary-encoding/blob/master/csharp/csharp.sln) to build the solution, run the unit tests, examples and benchmarks
+ * Use the command script
+ * [csharpbuild.cmd](https://github.com/real-logic/simple-binary-encoding/blob/master/csharp/csharpbuild.cmd) to build the dotnet core support
  * Use the bash script [runtests.sh](https://github.com/real-logic/simple-binary-encoding/blob/master/csharp/runtests.sh) to run the tests
  * Build the nuget package via [do-release.sh](https://github.com/real-logic/simple-binary-encoding/blob/master/csharp/.nuget/do-release.sh) although this remains a largely manual process.

csharp/csharp.sln

@@ -3,22 +3,17 @@ Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio 15
 VisualStudioVersion = 15.0.26430.6
 MinimumVisualStudioVersion = 10.0.40219.1
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "sbe-dll", "sbe-dll\sbe-dll.csproj", "{CE883FD9-14A5-409C-AEBC-86BEA4E3C502}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "sbe-dll", "sbe-dll\sbe-dll.csproj", "{CE883FD9-14A5-409C-AEBC-86BEA4E3C502}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "sbe-samples-car", "sbe-samples\sbe-samples-car.csproj", "{1B325F15-0C54-49F5-A4B9-16088222CC0E}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "sbe-samples-car", "sbe-samples\sbe-samples-car.csproj", "{1B325F15-0C54-49F5-A4B9-16088222CC0E}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "sbe-samples-extension", "sbe-samples\sbe-samples-extension.csproj", "{3B325F15-0C54-49F5-A4B9-16088222CC0E}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "sbe-samples-extension", "sbe-samples\sbe-samples-extension.csproj", "{3B325F15-0C54-49F5-A4B9-16088222CC0E}"
 EndProject
-Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{DF19E161-4491-4C5E-9393-70B1CD14315E}"
-ProjectSection(SolutionItems) = preProject
-README.md = README.md
-EndProjectSection
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "sbe-benchmarks", "sbe-benchmarks\sbe-benchmarks.csproj", "{B4A22C65-AC09-43A7-B7D6-141A0B9EC0E0}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "sbe-benchmarks", "sbe-benchmarks\sbe-benchmarks.csproj", "{B4A22C65-AC09-43A7-B7D6-141A0B9EC0E0}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "sbe-generated", "sbe-generated\sbe-generated.csproj", "{A623D315-CC7F-40D9-ACC1-3A5253FA141D}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "sbe-generated", "sbe-generated\sbe-generated.csproj", "{A623D315-CC7F-40D9-ACC1-3A5253FA141D}"
-EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "sbe-tests", "sbe-tests\sbe-tests.csproj", "{385951E3-F332-462D-9D4C-DD17A8DBACB3}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "sbe-tests", "sbe-tests\sbe-tests.csproj", "{385951E3-F332-462D-9D4C-DD17A8DBACB3}"
 EndProject
 Global
 GlobalSection(SolutionConfigurationPlatforms) = preSolution

csharp/sbe-samples/CarExample.cs

@@ -19,7 +19,7 @@
 
 class Example
 {
- public static void Main()
+ public static void ExampleMain()
  {
  // This byte array is used for encoding and decoding, this is what you would send on the wire or save to disk
  var byteBuffer = new byte[4096];
@@ -230,23 +230,23 @@ public static void Decode(Car car,
  sb.Append("\ncar.engine.Booster.BoostType=").Append(engine.Booster.BoostType);
  sb.Append("\ncar.engine.Booster.HorsePower=").Append(engine.Booster.HorsePower);
 
- var fuelFiguresGroup = car.FuelFigures; // decode a repeatable group (we will change the API to support foreach soon)
+ // The first way to access a repeating group is by using Next()
+ var fuelFiguresGroup = car.FuelFigures; 
  while (fuelFiguresGroup.HasNext)
  {
  var fuelFigures = fuelFiguresGroup.Next();
  sb.Append("\ncar.fuelFigures.speed=").Append(fuelFigures.Speed);
  sb.Append("\ncar.fuelFigures.mpg=").Append(fuelFigures.Mpg);
  }
 
- // the nested group
- var performanceFiguresGroup = car.PerformanceFigures;
- while (performanceFiguresGroup.HasNext)
+ // The second way to access a repeating group is to use an iterator
+ foreach (Car.PerformanceFiguresGroup performanceFigures in car.PerformanceFigures)
  {
- var performanceFigures = performanceFiguresGroup.Next();
  sb.Append("\ncar.performanceFigures.octaneRating=").Append(performanceFigures.OctaneRating);
 
+ // The third way to access a repeating group is loop over the count of elements
  var accelerationGroup = performanceFigures.Acceleration;
- while (accelerationGroup.HasNext)
+ for (int i = 0; i < accelerationGroup.Count; i++)
  {
  var acceleration = accelerationGroup.Next();
  sb.Append("\ncar.performanceFigures.acceleration.mph=").Append(acceleration.Mph);

csharp/sbe-samples/ExtensionExample.cs

@@ -20,7 +20,7 @@
 
 class Example
 {
- public static void Main()
+ public static void ExampleMain()
  {
  // This byte array is used for encoding and decoding, this is what you would send on the wire or save to disk
  var byteBuffer = new byte[4096];
@@ -318,7 +318,7 @@ static ExtensionExample()
  }
  }
 
- public static void Main()
+ public static void ExtensionMain()
  {
  // This byte array is used for encoding and decoding, this is what ou would send on the wire or save to disk
  var byteBuffer = new byte[4096];