Merge pull request #453 from MarketFactory/dotnet-alpha1

Initial restoration of csharp generator (alpha1)

Author: mjpt777

.gitattributes

@@ -0,0 +1,63 @@
+###############################################################################
+# Set default behavior to automatically normalize line endings.
+###############################################################################
+* text=auto
+
+###############################################################################
+# Set default behavior for command prompt diff.
+#
+# This is need for earlier builds of msysgit that does not have it on by
+# default for csharp files.
+# Note: This is only used by command line
+###############################################################################
+#*.cs     diff=csharp
+
+###############################################################################
+# Set the merge driver for project and solution files
+#
+# Merging from the command prompt will add diff markers to the files if there
+# are conflicts (Merging from VS is not affected by the settings below, in VS
+# the diff markers are never inserted). Diff markers may cause the following 
+# file extensions to fail to load in VS. An alternative would be to treat
+# these files as binary and thus will always conflict and require user
+# intervention with every merge. To do so, just uncomment the entries below
+###############################################################################
+#*.sln       merge=binary
+#*.csproj    merge=binary
+#*.vbproj    merge=binary
+#*.vcxproj   merge=binary
+#*.vcproj    merge=binary
+#*.dbproj    merge=binary
+#*.fsproj    merge=binary
+#*.lsproj    merge=binary
+#*.wixproj   merge=binary
+#*.modelproj merge=binary
+#*.sqlproj   merge=binary
+#*.wwaproj   merge=binary
+
+###############################################################################
+# behavior for image files
+#
+# image files are treated as binary by default.
+###############################################################################
+#*.jpg   binary
+#*.png   binary
+#*.gif   binary
+
+###############################################################################
+# diff behavior for common document formats
+# 
+# Convert binary document formats to text before diffing them. This feature
+# is only available from the command line. Turn it on by uncommenting the 
+# entries below.
+###############################################################################
+#*.doc   diff=astextplain
+#*.DOC   diff=astextplain
+#*.docx  diff=astextplain
+#*.DOCX  diff=astextplain
+#*.dot   diff=astextplain
+#*.DOT   diff=astextplain
+#*.pdf   diff=astextplain
+#*.PDF   diff=astextplain
+#*.rtf   diff=astextplain
+#*.RTF   diff=astextplain

.gitignore

@@ -91,5 +91,25 @@ gocode/src/example-schema/cpu.out
 gocode/src/extension
 gocode/src/extension2
 
+# csharp
+csharp/*/bin
+csharp/*/obj
+csharp/.nuget/sbe-tool*.nupkg
+csharp/.nuget/sbe-tool-all.jar
+csharp/.nuget/examples/bin
+csharp/.nuget/examples/obj
+csharp/.nuget/examples/packages
+csharp/.nuget/examples/.vs
+csharp/.vs
+csharp/TestResults
+csharp/packages
+csharp/sbe-generated/baseline
+csharp/sbe-generated/baseline-bigendian
+csharp/sbe-generated/extension
+csharp/sbe-generated/issue435
+csharp/sbe-generated/since-deprecated
+csharp/sbe-generated/mktdata/*.cs
+csharp/sbe-generated/uk_co_real_logic_sbe_benchmarks_fix
+
 # Mac
 .DS_Store

README.md

@@ -3,7 +3,7 @@ Simple Binary Encoding (SBE)
 
 [SBE](https://github.com/FIXTradingCommunity/fix-simple-binary-encoding) is an OSI layer 6 presentation for 
 encoding and decoding binary application messages for low-latency financial applications. This repository contains 
-the reference implementations in Java, C++, and Golang.
+the reference implementations in Java, C++, Golang, and Csharp.
 
 Further details on the background and usage of SBE can be found on the
 [Wiki](https://github.com/real-logic/simple-binary-encoding/wiki).
@@ -13,13 +13,15 @@ An XSD for SBE specs can be found
 
 For the latest version information and changes see the [Change Log](https://github.com/real-logic/simple-binary-encoding/wiki/Change-Log) with **downloads** at [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Csbe). 
 
-This SBE implementation is designed with work very efficiently with the [Aeron](https://github.com/real-logic/Aeron) 
-messaging system for low-latency and high-throughput communications. SBE has a dependency on [Agrona](https://github.com/real-logic/Agrona) 
-for its buffer implementations.
+The Java and C++ SBE implementations are designed with work very efficiently with the
+[Aeron](https://github.com/real-logic/Aeron) messaging system for low-latency and
+high-throughput communications. The Java SBE implementation has a dependency on
+[Agrona](https://github.com/real-logic/Agrona) for its buffer implementations.
 
 License (See LICENSE file for full license)
 -------------------------------------------
 Copyright 2014 - 2017 Real Logic Limited
+Copyright 2017 MarketFactory Inc
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -85,7 +87,6 @@ Jars for the executable, source, and javadoc for the various modules can be foun
 
     <module>/build/libs
 
-
 C++ Build using CMake
 ---------------------
 NOTE: Linux, Mac OS, and Windows only for the moment. See
@@ -124,7 +125,25 @@ tests and containes some examples
     # make # test, examples, bench
 
 Users of golang generated code should see the [user
-documentation](https://github.com/real-logic/simple-binary-encoding/wiki/Golang-User-Guide). Developers
-wishing to enhance the golang generator should see the [developer
+documentation](https://github.com/real-logic/simple-binary-encoding/wiki/Golang-User-Guide).
+
+Developers wishing to enhance the golang generator should see the [developer
 documentation](https://github.com/real-logic/simple-binary-encoding/blob/master/gocode/README.md)
 
+C# Build
+--------
+As of April 2017, the csharp build is considered a preview release. API stability is not yet guaranteed. User and Developer guides are not yet released or are incomplete.
+
+First build using Gradle to generate the SBE jar and then use it to
+generate the C# code used for testing and the examples.
+
+    $ ./gradlew
+    $ ./gradlew generateCsharpCodecs
+
+You can then use the [Visual Studio 2017 Community solution](https://github.com/real-logic/simple-binary-encoding/blob/master/csharp/csharp.sln) to build and explore the
+example. This solution also builds some tests which can be run via the provided
+[runtests.sh](https://github.com/real-logic/simple-binary-encoding/blob/master/csharp/runtests.sh) script.
+
+Users of csharp generated code should see the [user documentation (coming)](https://github.com/real-logic/simple-binary-encoding/wiki/Csharp-User-Guide).
+
+Developers wishing to enhance the csharp generator should see the [developer documentation (coming)](https://github.com/real-logic/simple-binary-encoding/blob/master/csharp/README.md)

build.gradle

@@ -82,6 +82,12 @@ def projectPom = {
             email = '[email protected]'
             url = 'https://github.com/RichardWarburton'
         }
+        developer {
+            id = 'BillSegall'
+            name = 'Bill Segall'
+            email = '[email protected]'
+            url = 'https://github.com/BillSegall'
+        }
     }
 }
 
@@ -500,7 +506,7 @@ task(generateGolangCodecsWithXSD, type:JavaExec) {
              'sbe-tool/src/test/resources/FixBinary.xml',
              'sbe-tool/src/test/resources/issue435.xml',
              'sbe-tool/src/test/resources/since-deprecated-test-schema.xml',
-             'gocode/resources/example-bigendian.xml',
+             'sbe-tool/src/test/resources/example-bigendian-test-schema.xml',
              'gocode/resources/example-composite.xml',
              'gocode/resources/example-extension-2-schema.xml',
              'gocode/resources/group-with-data-extension-schema.xml',
@@ -518,6 +524,24 @@ task generateGolangCodecs {
         'generateGolangCodecsWithXSD'
 }
 
+task(generateCsharpCodecs, type:JavaExec) {
+    main = 'uk.co.real_logic.sbe.SbeTool'
+    classpath = project(':sbe-all').sourceSets.main.runtimeClasspath
+    systemProperties(
+        'sbe.output.dir': 'csharp/sbe-generated',
+        'sbe.target.language': 'uk.co.real_logic.sbe.generation.csharp.Csharp',
+        'sbe.validation.xsd': validationXsdPath)
+    args = [ 
+             'sbe-tool/src/test/resources/FixBinary.xml',
+             'sbe-tool/src/test/resources/issue435.xml',
+             'sbe-tool/src/test/resources/since-deprecated-test-schema.xml',
+             'sbe-tool/src/test/resources/example-bigendian-test-schema.xml',
+             'sbe-samples/src/main/resources/example-schema.xml',
+             'sbe-samples/src/main/resources/example-extension-schema.xml',
+             'sbe-benchmarks/src/main/resources/fix-message-samples.xml'
+           ]
+}
+
 task(generateJavaIrCodecs, type: JavaExec) {
     main = 'uk.co.real_logic.sbe.SbeTool'
     classpath = project(':sbe-all').sourceSets.main.runtimeClasspath