Skip to content
This repository was archived by the owner on Apr 1, 2025. It is now read-only.

Commit b13fee1

Browse files
enioluwaschwarr
enioluwas
and
chwarr
authored
[c#] Add support for System.Collections.Immutable collections
Co-authored-by: Christopher Warrington <chwarr@microsoft.com>
1 parent 39d23f7 commit b13fee1

File tree

19 files changed

+448
-23
lines changed

19 files changed

+448
-23
lines changed

‎CHANGELOG.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,11 @@ different versioning scheme, following the Haskell community's
4343
code will be generated for them. See [issue \#1131, Bond-over-gRPC will be
4444
deprecated February 2022](https://github.com/microsoft/bond/issues/1131),
4545
for the full announcement.
46+
* Added codegen and deserialization support for container type aliases to
47+
use
48+
[System.Collections.Immutable](https://learn.microsoft.com/dotnet/api/system.collections.immutable)
49+
collections. (Pull request
50+
[\#1161](https://github.com/microsoft/bond/pull/1161))
4651

4752
## 10.0: 2022-03-07 ##
4853

‎compiler/src/Language/Bond/Codegen/Cs/Util.hs‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ module Language.Bond.Codegen.Cs.Util
1616
import Data.Int (Int64)
1717
import Data.Monoid
1818
import Prelude
19-
import Data.Text.Lazy (Text)
19+
import Data.Text.Lazy (Text, isPrefixOf)
20+
import Data.Text.Lazy.Builder (toLazyText)
2021
import Text.Shakespeare.Text
2122
import Paths_bond (version)
2223
import Data.Version (showVersion)
@@ -112,15 +113,20 @@ paramConstraints = newlineBeginSep 2 constraint
112113
constraint (TypeParam _ Nothing) = mempty
113114
constraint (TypeParam name (Just Value)) = [lt|where #{name} : struct|]
114115

116+
isImmutableCollection :: MappingContext -> Type -> Bool
117+
isImmutableCollection cs t = [lt|System.Collections.Immutable.Immutable|] `isPrefixOf` toLazyText (getInstanceTypeName cs t)
118+
115119
-- Initial value for C# field/property or Nothing if C# implicit default is OK
116120
defaultValue :: MappingContext -> Field -> Maybe Text
117121
defaultValue cs Field {fieldDefault = Nothing, ..} = implicitDefault fieldType
118122
where
119123
newInstance t = Just [lt|new #{getInstanceTypeName cs t}()|]
124+
staticEmptyField t = Just [lt|#{getInstanceTypeName cs t}.Empty|]
120125
implicitDefault (BT_Bonded t) = Just [lt|global::Bond.Bonded<#{getTypeName cs t}>.Empty|]
121126
implicitDefault t@(BT_TypeParam _) = Just [lt|global::Bond.GenericFactory.Create<#{getInstanceTypeName cs t}>()|]
122127
implicitDefault t@BT_Blob = newInstance t
123128
implicitDefault t@(BT_UserDefined a@Alias {..} args)
129+
| isImmutableCollection cs t = staticEmptyField t
124130
| customAliasMapping cs a = newInstance t
125131
| otherwise = implicitDefault $ resolveAlias a args
126132
implicitDefault t

‎compiler/tests/TestMain.hs‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,16 @@ tests = testGroup "Compiler tests"
144144
, verifyCsCodegen "inheritance"
145145
, verifyCsCodegen "aliases"
146146
, verifyCsCodegen "complex_inheritance"
147+
, verifyCodegen
148+
[ "c#"
149+
, "--using=ImmutableArray=System.Collections.Immutable.ImmutableArray<{0}>"
150+
, "--using=ImmutableList=System.Collections.Immutable.ImmutableList<{0}>"
151+
, "--using=ImmutableHashSet=System.Collections.Immutable.ImmutableHashSet<{0}>"
152+
, "--using=ImmutableSortedSet=System.Collections.Immutable.ImmutableSortedSet<{0}>"
153+
, "--using=ImmutableDictionary=System.Collections.Immutable.ImmutableDictionary<{0},{1}>"
154+
, "--using=ImmutableSortedDictionary=System.Collections.Immutable.ImmutableSortedDictionary<{0},{1}>"
155+
]
156+
"immutable_collections"
147157
, verifyCodegenVariation
148158
[ "c#"
149159
, "--preview-constructor-parameters"

‎compiler/tests/generated/collection-interfaces/immutable_collections_types.cs‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
2+
3+
// suppress "Missing XML comment for publicly visible type or member"
4+
#pragma warning disable 1591
5+
6+
7+
#region ReSharper warnings
8+
// ReSharper disable PartialTypeWithSinglePart
9+
// ReSharper disable RedundantNameQualifier
10+
// ReSharper disable InconsistentNaming
11+
// ReSharper disable CheckNamespace
12+
// ReSharper disable UnusedParameter.Local
13+
// ReSharper disable RedundantUsingDirective
14+
#endregion
15+
16+
namespace tests
17+
{
18+
using System.Collections.Generic;
19+
20+
[global::Bond.Schema]
21+
[System.CodeDom.Compiler.GeneratedCode("gbc", "0.12.1.0")]
22+
public partial class ImmutableCollectionsHolder
23+
{
24+
[global::Bond.Id(0)]
25+
public System.Collections.Immutable.ImmutableArray<string> ImmutableArrayString { get; set; }
26+
27+
[global::Bond.Id(1)]
28+
public System.Collections.Immutable.ImmutableList<string> ImmutableListString { get; set; }
29+
30+
[global::Bond.Id(2)]
31+
public System.Collections.Immutable.ImmutableHashSet<string> ImmutableHashSetString { get; set; }
32+
33+
[global::Bond.Id(3)]
34+
public System.Collections.Immutable.ImmutableSortedSet<int> ImmutableSortedSetInt { get; set; }
35+
36+
[global::Bond.Id(4)]
37+
public System.Collections.Immutable.ImmutableDictionary<string,string> ImmutableDictionaryStringMap { get; set; }
38+
39+
[global::Bond.Id(5)]
40+
public System.Collections.Immutable.ImmutableSortedDictionary<int,string> ImmutableSortedDictionaryStringMap { get; set; }
41+
42+
public ImmutableCollectionsHolder()
43+
: this("tests.ImmutableCollectionsHolder", "ImmutableCollectionsHolder")
44+
{}
45+
46+
protected ImmutableCollectionsHolder(string fullName, string name)
47+
{
48+
ImmutableArrayString = System.Collections.Immutable.ImmutableArray<string>.Empty;
49+
ImmutableListString = System.Collections.Immutable.ImmutableList<string>.Empty;
50+
ImmutableHashSetString = System.Collections.Immutable.ImmutableHashSet<string>.Empty;
51+
ImmutableSortedSetInt = System.Collections.Immutable.ImmutableSortedSet<int>.Empty;
52+
ImmutableDictionaryStringMap = System.Collections.Immutable.ImmutableDictionary<string,string>.Empty;
53+
ImmutableSortedDictionaryStringMap = System.Collections.Immutable.ImmutableSortedDictionary<int,string>.Empty;
54+
}
55+
}
56+
} // tests

‎compiler/tests/generated/immutable_collections_types.cs‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
2+
3+
// suppress "Missing XML comment for publicly visible type or member"
4+
#pragma warning disable 1591
5+
6+
7+
#region ReSharper warnings
8+
// ReSharper disable PartialTypeWithSinglePart
9+
// ReSharper disable RedundantNameQualifier
10+
// ReSharper disable InconsistentNaming
11+
// ReSharper disable CheckNamespace
12+
// ReSharper disable UnusedParameter.Local
13+
// ReSharper disable RedundantUsingDirective
14+
#endregion
15+
16+
namespace tests
17+
{
18+
using System.Collections.Generic;
19+
20+
[global::Bond.Schema]
21+
[System.CodeDom.Compiler.GeneratedCode("gbc", "0.12.1.0")]
22+
public partial class ImmutableCollectionsHolder
23+
{
24+
[global::Bond.Id(0)]
25+
public System.Collections.Immutable.ImmutableArray<string> ImmutableArrayString { get; set; }
26+
27+
[global::Bond.Id(1)]
28+
public System.Collections.Immutable.ImmutableList<string> ImmutableListString { get; set; }
29+
30+
[global::Bond.Id(2)]
31+
public System.Collections.Immutable.ImmutableHashSet<string> ImmutableHashSetString { get; set; }
32+
33+
[global::Bond.Id(3)]
34+
public System.Collections.Immutable.ImmutableSortedSet<int> ImmutableSortedSetInt { get; set; }
35+
36+
[global::Bond.Id(4)]
37+
public System.Collections.Immutable.ImmutableDictionary<string,string> ImmutableDictionaryStringMap { get; set; }
38+
39+
[global::Bond.Id(5)]
40+
public System.Collections.Immutable.ImmutableSortedDictionary<int,string> ImmutableSortedDictionaryStringMap { get; set; }
41+
42+
public ImmutableCollectionsHolder()
43+
: this("tests.ImmutableCollectionsHolder", "ImmutableCollectionsHolder")
44+
{}
45+
46+
protected ImmutableCollectionsHolder(string fullName, string name)
47+
{
48+
ImmutableArrayString = System.Collections.Immutable.ImmutableArray<string>.Empty;
49+
ImmutableListString = System.Collections.Immutable.ImmutableList<string>.Empty;
50+
ImmutableHashSetString = System.Collections.Immutable.ImmutableHashSet<string>.Empty;
51+
ImmutableSortedSetInt = System.Collections.Immutable.ImmutableSortedSet<int>.Empty;
52+
ImmutableDictionaryStringMap = System.Collections.Immutable.ImmutableDictionary<string,string>.Empty;
53+
ImmutableSortedDictionaryStringMap = System.Collections.Immutable.ImmutableSortedDictionary<int,string>.Empty;
54+
}
55+
}
56+
} // tests

‎compiler/tests/schema/immutable_collections.bond‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
namespace tests
2+
3+
using ImmutableArray<T> = list<T>;
4+
using ImmutableList<T> = list<T>;
5+
using ImmutableHashSet<T> = set<T>;
6+
using ImmutableSortedSet<T> = set<T>;
7+
using ImmutableDictionary<K, V> = map<K, V>;
8+
using ImmutableSortedDictionary<K, V> = map<K, V>;
9+
10+
struct ImmutableCollectionsHolder
11+
{
12+
0: ImmutableArray<string> ImmutableArrayString;
13+
1: ImmutableList<string> ImmutableListString;
14+
2: ImmutableHashSet<string> ImmutableHashSetString;
15+
3: ImmutableSortedSet<int32> ImmutableSortedSetInt;
16+
4: ImmutableDictionary<string, string> ImmutableDictionaryStringMap;
17+
5: ImmutableSortedDictionary<int32, string> ImmutableSortedDictionaryStringMap;
18+
}

‎cs/cs.sln‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -247,6 +247,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "default-ignore-output", "te
247247
{21E175D5-BBDD-4B63-8FB7-38899BF2F9D1} = {21E175D5-BBDD-4B63-8FB7-38899BF2F9D1}
248248
EndProjectSection
249249
EndProject
250+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "immutable_collections", "..\examples\cs\core\immutable_collections\immutable_collections.csproj", "{9CC2754E-501D-4DB3-8EAA-8B91025E5DF6}"
251+
EndProject
250252
Global
251253
GlobalSection(SolutionConfigurationPlatforms) = preSolution
252254
Debug|Any CPU = Debug|Any CPU
@@ -881,6 +883,24 @@ Global
881883
{98BF6B10-F821-4402-8923-5F7B726BBFC8}.Release|Mixed Platforms.Build.0 = Release|Any CPU
882884
{98BF6B10-F821-4402-8923-5F7B726BBFC8}.Release|Win32.ActiveCfg = Release|Any CPU
883885
{98BF6B10-F821-4402-8923-5F7B726BBFC8}.Release|Win32.Build.0 = Release|Any CPU
886+
{9CC2754E-501D-4DB3-8EAA-8B91025E5DF6}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
887+
{9CC2754E-501D-4DB3-8EAA-8B91025E5DF6}.Debug|Any CPU.Build.0 = Debug|Any CPU
888+
{9CC2754E-501D-4DB3-8EAA-8B91025E5DF6}.Debug|Mixed Platforms.ActiveCfg = Debug|Any CPU
889+
{9CC2754E-501D-4DB3-8EAA-8B91025E5DF6}.Debug|Mixed Platforms.Build.0 = Debug|Any CPU
890+
{9CC2754E-501D-4DB3-8EAA-8B91025E5DF6}.Debug|Win32.ActiveCfg = Debug|Any CPU
891+
{9CC2754E-501D-4DB3-8EAA-8B91025E5DF6}.Debug|Win32.Build.0 = Debug|Any CPU
892+
{9CC2754E-501D-4DB3-8EAA-8B91025E5DF6}.Fields|Any CPU.ActiveCfg = Release|Any CPU
893+
{9CC2754E-501D-4DB3-8EAA-8B91025E5DF6}.Fields|Any CPU.Build.0 = Release|Any CPU
894+
{9CC2754E-501D-4DB3-8EAA-8B91025E5DF6}.Fields|Mixed Platforms.ActiveCfg = Release|Any CPU
895+
{9CC2754E-501D-4DB3-8EAA-8B91025E5DF6}.Fields|Mixed Platforms.Build.0 = Release|Any CPU
896+
{9CC2754E-501D-4DB3-8EAA-8B91025E5DF6}.Fields|Win32.ActiveCfg = Release|Any CPU
897+
{9CC2754E-501D-4DB3-8EAA-8B91025E5DF6}.Fields|Win32.Build.0 = Release|Any CPU
898+
{9CC2754E-501D-4DB3-8EAA-8B91025E5DF6}.Release|Any CPU.ActiveCfg = Release|Any CPU
899+
{9CC2754E-501D-4DB3-8EAA-8B91025E5DF6}.Release|Any CPU.Build.0 = Release|Any CPU
900+
{9CC2754E-501D-4DB3-8EAA-8B91025E5DF6}.Release|Mixed Platforms.ActiveCfg = Release|Any CPU
901+
{9CC2754E-501D-4DB3-8EAA-8B91025E5DF6}.Release|Mixed Platforms.Build.0 = Release|Any CPU
902+
{9CC2754E-501D-4DB3-8EAA-8B91025E5DF6}.Release|Win32.ActiveCfg = Release|Any CPU
903+
{9CC2754E-501D-4DB3-8EAA-8B91025E5DF6}.Release|Win32.Build.0 = Release|Any CPU
884904
EndGlobalSection
885905
GlobalSection(SolutionProperties) = preSolution
886906
HideSolutionNode = FALSE
@@ -920,6 +940,7 @@ Global
920940
{4FACD9A1-B8AC-4D76-B4B5-B71607EA8F8C} = {621A2166-EEE0-4A27-88AA-5BE5AC996452}
921941
{3805B86E-2BE3-4FFA-A11C-B4981069EC88} = {4268A1D3-AF40-4120-B021-D95A0F754221}
922942
{98BF6B10-F821-4402-8923-5F7B726BBFC8} = {8CF1F5CD-548F-4323-869E-AA5903C88B6A}
943+
{9CC2754E-501D-4DB3-8EAA-8B91025E5DF6} = {621A2166-EEE0-4A27-88AA-5BE5AC996452}
923944
EndGlobalSection
924945
GlobalSection(ExtensibilityGlobals) = postSolution
925946
SolutionGuid = {6EB58560-CA9C-4F6C-B916-CCA6C7FE2A2B}

‎cs/nuget/bond.csharp.test.csproj‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
<PackageReference Include="Newtonsoft.Json" Version="9.0.1" />
1616
<PackageReference Include="NUnit" Version="3.10.*" />
1717
<PackageReference Include="NUnit3TestAdapter" Version="3.10.*" />
18+
<PackageReference Include="System.Collections.Immutable" Version="1.7.1" />
1819
</ItemGroup>
1920

2021
<ItemGroup>
@@ -39,5 +40,8 @@
3940
<BondCodegen Update="..\test\core\UnitTest.bond">
4041
<Options>$(BondOptions) --using="DateTime=System.DateTime"</Options>
4142
</BondCodegen>
43+
<BondCodegen Update="ImmutableCollections.bond">
44+
<Options>$(BondOptions) --using="ImmutableArray=System.Collections.Immutable.ImmutableArray&lt;{0}&gt;" --using="ImmutableList=System.Collections.Immutable.ImmutableList&lt;{0}&gt;" --using="ImmutableHashSet=System.Collections.Immutable.ImmutableHashSet&lt;{0}&gt;" --using="ImmutableSortedSet=System.Collections.Immutable.ImmutableSortedSet&lt;{0}&gt;" --using="ImmutableDictionary=System.Collections.Immutable.ImmutableDictionary&lt;{0},{1}&gt;" --using="ImmutableSortedDictionary=System.Collections.Immutable.ImmutableSortedDictionary&lt;{0},{1}&gt;"</Options>
45+
</BondCodegen>
4246
</ItemGroup>
4347
</Project>

‎cs/src/core/Comparer.cs‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,16 @@ static Expression ObjectsEqual(Expression left, Expression right)
5959
return Expression.Call(null, comparerEqual.MakeGenericMethod(type), left, right);
6060

6161
if (type.IsBondContainer())
62-
return EnumerablesEqual(left, right);
62+
{
63+
if (type.IsValueType())
64+
{
65+
return StructsEqual(left, right);
66+
}
67+
else
68+
{
69+
return EnumerablesEqual(left, right);
70+
}
71+
}
6372

6473
if (type.IsGenericType() && type.GetGenericTypeDefinition() == typeof(KeyValuePair<,>))
6574
return KeyValuePairEqual(left, right);

0 commit comments

Comments
 (0)