[5.3] Add back removed APIs from the TileDB.Interop namespace. (#269)

teo-tsirpanis · web-flow · commit 520296ab65d3 · 2023-09-08T22:25:53.000+03:00
* Make `MarshaledString` and `MarshaledStringOut` public but obsolete and hidden.

* Bring back the old safe handles and obsolete and hide them.

* Bring back `SpanExtensions` and obsolete and hide it.

* Bring back two empty types and obsolete and hide them.

* Fix compile errors.

* Run CI on release branches.

* Bump version to 5.3.1.

* Deprecate `tiledb_filter_webp_format_t`.
diff --git a/.github/workflows/tiledb-csharp.yml b/.github/workflows/tiledb-csharp.yml
@@ -2,9 +2,9 @@ name: CI
 
 on:
   push:
-    branches: [ main ]
+    branches: [ main, 'release/*' ]
   pull_request:
-    branches: [ main ]
+    branches: [ main, 'release/*' ]
   workflow_dispatch:
   workflow_call:
 
diff --git a/sources/TileDB.CSharp/Array.cs b/sources/TileDB.CSharp/Array.cs
@@ -5,6 +5,8 @@
 using TileDB.CSharp.Marshalling;
 using TileDB.CSharp.Marshalling.SafeHandles;
 using TileDB.Interop;
+using ArrayHandle = TileDB.CSharp.Marshalling.SafeHandles.ArrayHandle;
+using ArraySchemaHandle = TileDB.CSharp.Marshalling.SafeHandles.ArraySchemaHandle;
 
 namespace TileDB.CSharp
 {
diff --git a/sources/TileDB.CSharp/ArraySchema.cs b/sources/TileDB.CSharp/ArraySchema.cs
@@ -2,6 +2,10 @@
 using System.Collections.Generic;
 using TileDB.CSharp.Marshalling.SafeHandles;
 using TileDB.Interop;
+using ArraySchemaHandle = TileDB.CSharp.Marshalling.SafeHandles.ArraySchemaHandle;
+using FilterListHandle = TileDB.CSharp.Marshalling.SafeHandles.FilterListHandle;
+using DomainHandle = TileDB.CSharp.Marshalling.SafeHandles.DomainHandle;
+using AttributeHandle = TileDB.CSharp.Marshalling.SafeHandles.AttributeHandle;
 
 namespace TileDB.CSharp
 {
diff --git a/sources/TileDB.CSharp/ArraySchemaEvolution.cs b/sources/TileDB.CSharp/ArraySchemaEvolution.cs
@@ -1,6 +1,7 @@
 using System;
 using TileDB.CSharp.Marshalling.SafeHandles;
 using TileDB.Interop;
+using ArraySchemaEvolutionHandle = TileDB.CSharp.Marshalling.SafeHandles.ArraySchemaEvolutionHandle;
 
 namespace TileDB.CSharp
 {
diff --git a/sources/TileDB.CSharp/Attribute.cs b/sources/TileDB.CSharp/Attribute.cs
@@ -2,8 +2,10 @@
 using System.Linq;
 using System.Runtime.InteropServices;
 using System.Text;
-using TileDB.CSharp.Marshalling.SafeHandles;
 using TileDB.Interop;
+using TileDB.CSharp.Marshalling.SafeHandles;
+using AttributeHandle = TileDB.CSharp.Marshalling.SafeHandles.AttributeHandle;
+using FilterListHandle = TileDB.CSharp.Marshalling.SafeHandles.FilterListHandle;
 
 namespace TileDB.CSharp
 {
diff --git a/sources/TileDB.CSharp/Config.cs b/sources/TileDB.CSharp/Config.cs
@@ -2,6 +2,7 @@
 using System.Text;
 using TileDB.CSharp.Marshalling.SafeHandles;
 using TileDB.Interop;
+using ConfigHandle = TileDB.CSharp.Marshalling.SafeHandles.ConfigHandle;
 
 namespace TileDB.CSharp
 {
diff --git a/sources/TileDB.CSharp/ConfigIterator.cs b/sources/TileDB.CSharp/ConfigIterator.cs
@@ -1,6 +1,8 @@
 ﻿using System;
 using TileDB.CSharp.Marshalling.SafeHandles;
 using TileDB.Interop;
+using ConfigHandle = TileDB.CSharp.Marshalling.SafeHandles.ConfigHandle;
+using ConfigIteratorHandle = TileDB.CSharp.Marshalling.SafeHandles.ConfigIteratorHandle;
 
 namespace TileDB.CSharp
 {
diff --git a/sources/TileDB.CSharp/Context.cs b/sources/TileDB.CSharp/Context.cs
@@ -7,6 +7,7 @@
 using System.Text;
 using TileDB.CSharp.Marshalling.SafeHandles;
 using TileDB.Interop;
+using ContextHandle = TileDB.CSharp.Marshalling.SafeHandles.ContextHandle;
 
 namespace TileDB.CSharp
 {
diff --git a/sources/TileDB.CSharp/Dimension.cs b/sources/TileDB.CSharp/Dimension.cs
@@ -4,6 +4,8 @@
 using TileDB.CSharp.Marshalling;
 using TileDB.CSharp.Marshalling.SafeHandles;
 using TileDB.Interop;
+using DimensionHandle = TileDB.CSharp.Marshalling.SafeHandles.DimensionHandle;
+using FilterListHandle = TileDB.CSharp.Marshalling.SafeHandles.FilterListHandle;
 
 namespace TileDB.CSharp
 {
diff --git a/sources/TileDB.CSharp/Domain.cs b/sources/TileDB.CSharp/Domain.cs
@@ -1,6 +1,8 @@
 using System;
 using TileDB.CSharp.Marshalling.SafeHandles;
 using TileDB.Interop;
+using DomainHandle = TileDB.CSharp.Marshalling.SafeHandles.DomainHandle;
+using DimensionHandle = TileDB.CSharp.Marshalling.SafeHandles.DimensionHandle;
 
 namespace TileDB.CSharp
 {
diff --git a/sources/TileDB.CSharp/File.cs b/sources/TileDB.CSharp/File.cs
@@ -1,6 +1,7 @@
 using System.ComponentModel;
 using TileDB.CSharp.Marshalling.SafeHandles;
 using TileDB.Interop;
+using ArraySchemaHandle = TileDB.CSharp.Marshalling.SafeHandles.ArraySchemaHandle;
 
 namespace TileDB.CSharp
 {
diff --git a/sources/TileDB.CSharp/Filter.cs b/sources/TileDB.CSharp/Filter.cs
@@ -3,6 +3,7 @@
 using System.Runtime.InteropServices;
 using TileDB.CSharp.Marshalling.SafeHandles;
 using TileDB.Interop;
+using FilterHandle = TileDB.CSharp.Marshalling.SafeHandles.FilterHandle;
 
 namespace TileDB.CSharp
 {
diff --git a/sources/TileDB.CSharp/FilterList.cs b/sources/TileDB.CSharp/FilterList.cs
@@ -1,6 +1,8 @@
 ﻿using System;
 using TileDB.CSharp.Marshalling.SafeHandles;
 using TileDB.Interop;
+using FilterHandle = TileDB.CSharp.Marshalling.SafeHandles.FilterHandle;
+using FilterListHandle = TileDB.CSharp.Marshalling.SafeHandles.FilterListHandle;
 
 namespace TileDB.CSharp
 {
diff --git a/sources/TileDB.CSharp/FragmentInfo.cs b/sources/TileDB.CSharp/FragmentInfo.cs
@@ -3,6 +3,8 @@
 using TileDB.CSharp.Marshalling;
 using TileDB.CSharp.Marshalling.SafeHandles;
 using TileDB.Interop;
+using ArraySchemaHandle = TileDB.CSharp.Marshalling.SafeHandles.ArraySchemaHandle;
+using ConfigHandle = TileDB.CSharp.Marshalling.SafeHandles.ConfigHandle;
 
 namespace TileDB.CSharp
 {
diff --git a/sources/TileDB.CSharp/Group.cs b/sources/TileDB.CSharp/Group.cs
@@ -1,6 +1,7 @@
 using System;
 using TileDB.CSharp.Marshalling.SafeHandles;
 using TileDB.Interop;
+using GroupHandle = TileDB.CSharp.Marshalling.SafeHandles.GroupHandle;
 
 namespace TileDB.CSharp
 {
diff --git a/sources/TileDB.CSharp/Interop/InteropAux.cs b/sources/TileDB.CSharp/Interop/InteropAux.cs
@@ -0,0 +1,13 @@
+﻿using System.ComponentModel;
+using System;
+using TileDB.CSharp;
+
+namespace TileDB.Interop
+{
+    [Obsolete(Obsoletions.TileDBInteropMessage, DiagnosticId = Obsoletions.TileDBInteropDiagId, UrlFormat = Obsoletions.SharedUrlFormat)]
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    // placeholder struct to avoid errors loading generated code
+    public partial struct __sFILE
+    {
+    }
+}
diff --git a/sources/TileDB.CSharp/Interop/SpanExtensions.cs b/sources/TileDB.CSharp/Interop/SpanExtensions.cs
@@ -0,0 +1,31 @@
+﻿// Copyright (c) .NET Foundation and Contributors. All Rights Reserved. Licensed under the MIT License (MIT). See License.md in the repository root for more information.
+//https://github.com/dotnet/ClangSharp/blob/67c1e5243b9d58f2b28f10e3f9a82f7537fd9d88/sources/ClangSharp.Interop/Internals/SpanExtensions.cs
+
+using System;
+using System.ComponentModel;
+using System.Text;
+using TileDB.CSharp;
+
+namespace TileDB.Interop
+{
+    [Obsolete(Obsoletions.TileDBInteropMessage, DiagnosticId = Obsoletions.TileDBInteropDiagId, UrlFormat = Obsoletions.SharedUrlFormat)]
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    public static unsafe class SpanExtensions
+    {
+        public static string AsString(this Span<byte> self) => AsString((ReadOnlySpan<byte>)self);
+
+        public static string AsString(this ReadOnlySpan<byte> self)
+        {
+            if (self.IsEmpty)
+            {
+                return string.Empty;
+            }
+
+            fixed (byte* pSelf = self)
+            {
+                return Encoding.ASCII.GetString(pSelf, self.Length);
+            }
+        }
+    }
+
+}//namespace
diff --git a/sources/TileDB.CSharp/Interop/TileDBSafeHandle.cs b/sources/TileDB.CSharp/Interop/TileDBSafeHandle.cs
diff --git a/sources/TileDB.CSharp/Interop/tiledb_filter_webp_format_t.cs b/sources/TileDB.CSharp/Interop/tiledb_filter_webp_format_t.cs
diff --git a/sources/TileDB.CSharp/Marshalling/MarshaledString.cs b/sources/TileDB.CSharp/Marshalling/MarshaledString.cs
diff --git a/sources/TileDB.CSharp/Marshalling/MarshaledStringOut.cs b/sources/TileDB.CSharp/Marshalling/MarshaledStringOut.cs
diff --git a/sources/TileDB.CSharp/Query.cs b/sources/TileDB.CSharp/Query.cs
diff --git a/sources/TileDB.CSharp/QueryCondition.cs b/sources/TileDB.CSharp/QueryCondition.cs
diff --git a/sources/TileDB.CSharp/TileDB.CSharp.csproj b/sources/TileDB.CSharp/TileDB.CSharp.csproj
diff --git a/sources/TileDB.CSharp/VFS.cs b/sources/TileDB.CSharp/VFS.cs

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,8 @@`
`5`	`5`	`using TileDB.CSharp.Marshalling;`
`6`	`6`	`using TileDB.CSharp.Marshalling.SafeHandles;`
`7`	`7`	`using TileDB.Interop;`
	`8`	`+using ArrayHandle = TileDB.CSharp.Marshalling.SafeHandles.ArrayHandle;`
	`9`	`+using ArraySchemaHandle = TileDB.CSharp.Marshalling.SafeHandles.ArraySchemaHandle;`
`8`	`10`
`9`	`11`	`namespace TileDB.CSharp`
`10`	`12`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`using System;`
`2`	`2`	`using TileDB.CSharp.Marshalling.SafeHandles;`
`3`	`3`	`using TileDB.Interop;`
	`4`	`+using ArraySchemaEvolutionHandle = TileDB.CSharp.Marshalling.SafeHandles.ArraySchemaEvolutionHandle;`
`4`	`5`
`5`	`6`	`namespace TileDB.CSharp`
`6`	`7`	`{`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,7 @@`
`2`	`2`	`using System.Text;`
`3`	`3`	`using TileDB.CSharp.Marshalling.SafeHandles;`
`4`	`4`	`using TileDB.Interop;`
	`5`	`+using ConfigHandle = TileDB.CSharp.Marshalling.SafeHandles.ConfigHandle;`
`5`	`6`
`6`	`7`	`namespace TileDB.CSharp`
`7`	`8`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,8 @@`
`1`	`1`	`using System;`
`2`	`2`	`using TileDB.CSharp.Marshalling.SafeHandles;`
`3`	`3`	`using TileDB.Interop;`
	`4`	`+using ConfigHandle = TileDB.CSharp.Marshalling.SafeHandles.ConfigHandle;`
	`5`	`+using ConfigIteratorHandle = TileDB.CSharp.Marshalling.SafeHandles.ConfigIteratorHandle;`
`4`	`6`
`5`	`7`	`namespace TileDB.CSharp`
`6`	`8`	`{`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,7 @@`
`7`	`7`	`using System.Text;`
`8`	`8`	`using TileDB.CSharp.Marshalling.SafeHandles;`
`9`	`9`	`using TileDB.Interop;`
	`10`	`+using ContextHandle = TileDB.CSharp.Marshalling.SafeHandles.ContextHandle;`
`10`	`11`
`11`	`12`	`namespace TileDB.CSharp`
`12`	`13`	`{`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,8 @@`
`4`	`4`	`using TileDB.CSharp.Marshalling;`
`5`	`5`	`using TileDB.CSharp.Marshalling.SafeHandles;`
`6`	`6`	`using TileDB.Interop;`
	`7`	`+using DimensionHandle = TileDB.CSharp.Marshalling.SafeHandles.DimensionHandle;`
	`8`	`+using FilterListHandle = TileDB.CSharp.Marshalling.SafeHandles.FilterListHandle;`
`7`	`9`
`8`	`10`	`namespace TileDB.CSharp`
`9`	`11`	`{`