将 vector/array 从非托管 C++ 传递到 C#
Passing a vector/array from unmanaged C++ to C#
我想将大约 100 - 10,000 点从非托管 C++ 传递到 C#。
C++ 端看起来像这样:
__declspec(dllexport) void detect_targets( char * , int , /* More arguments */ )
{
std::vector<double> id_x_y_z;
// Now what's the best way to pass this vector to C#
}
现在我的 C# 端看起来像这样:
using System;
using System.Runtime.InteropServices;
class HelloCpp
{
[DllImport("detector.dll")]
public static unsafe extern void detect_targets( string fn , /* More arguments */ );
static void Main()
{
detect_targets("test.png" , /* More arguments */ );
}
}
我需要如何更改我的代码才能将 std::vector 从非托管 C++ 及其所有内容传递给 C#?
我能想到不止一种选择,但无论如何都包括复制数组的数据。使用 [out] 参数,您可以尝试:
C++代码
__declspec(dllexport) void __stdcall detect_targets(wchar_t * fn, double **data, long* len)
{
std::vector<double> id_x_y_z = { 1, 2, 3 };
*len = id_x_y_z.size();
auto size = (*len)*sizeof(double);
*data = static_cast<double*>(CoTaskMemAlloc(size));
memcpy(*data, id_x_y_z.data(), size);
}
C#代码
[DllImport("detector.dll")]
public static extern void detect_targets(
string fn,
[MarshalAs(UnmanagedType.LPArray, SizeParamIndex = 2)] out double[] points,
out int count);
static void Main()
{
int len;
double[] points;
detect_targets("test.png", out points, out len);
}
我使用 C++ CLI 包装器实现了这个。 C++ CLI 是 C++ C# 互操作的三种可能方法之一。其他两种方法是 P/Invoke 和 COM。 (我看到一些好人推荐使用 C++ CLI 而不是其他方法)
为了将信息从本机代码编组到托管代码,您需要首先将本机代码包装在托管的 C++ CLI 中 class。创建一个新项目以包含本机代码及其 C++ CLI 包装器。确保为此项目启用 /clr
编译器开关。将此项目构建为 dll。为了使用这个库,只需在 C# 中添加它的引用并对其进行调用。如果两个项目都在同一个解决方案中,您可以这样做。
这是我的一个简单程序的源文件,用于将 std::vector<double>
从本机代码编组为 C# 托管代码。
1) 项目 EntityLib(C++ CLI dll)(带包装器的本机代码)
文件NativeEntity.h
#pragma once
#include <vector>
class NativeEntity {
private:
std::vector<double> myVec;
public:
NativeEntity();
std::vector<double> GetVec() { return myVec; }
};
文件NativeEntity.cpp
#include "stdafx.h"
#include "NativeEntity.h"
NativeEntity::NativeEntity() {
myVec = { 33.654, 44.654, 55.654 , 121.54, 1234.453}; // Populate vector your way
}
文件ManagedEntity.h(包装Class)
#pragma once
#include "NativeEntity.h"
#include <vector>
namespace EntityLibrary {
using namespace System;
public ref class ManagedEntity {
public:
ManagedEntity();
~ManagedEntity();
array<double> ^GetVec();
private:
NativeEntity* nativeObj; // Our native object is thus being wrapped
};
}
文件ManagedEntity.cpp
#include "stdafx.h"
#include "ManagedEntity.h"
using namespace EntityLibrary;
using namespace System;
ManagedEntity::ManagedEntity() {
nativeObj = new NativeEntity();
}
ManagedEntity::~ManagedEntity() {
delete nativeObj;
}
array<double>^ ManagedEntity::GetVec()
{
std::vector<double> tempVec = nativeObj->GetVec();
const int SIZE = tempVec.size();
array<double> ^tempArr = gcnew array<double> (SIZE);
for (int i = 0; i < SIZE; i++)
{
tempArr[i] = tempVec[i];
}
return tempArr;
}
2) SimpleClient 项目(C# exe)
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using EntityLibrary;
namespace SimpleClient {
class Program {
static void Main(string[] args) {
var entity = new ManagedEntity();
for (int i = 0; i < entity.GetVec().Length; i++ )
Console.WriteLine(entity.GetVec()[i]);
}
}
}
只要托管代码不调整向量的大小,您就可以访问缓冲区并将其作为指针传递给 vector.data()
(对于 C++0x)或 &vector[0]
。这导致零拷贝系统。
示例 C++ API:
#define EXPORT extern "C" __declspec(dllexport)
typedef intptr_t ItemListHandle;
EXPORT bool GenerateItems(ItemListHandle* hItems, double** itemsFound, int* itemCount)
{
auto items = new std::vector<double>();
for (int i = 0; i < 500; i++)
{
items->push_back((double)i);
}
*hItems = reinterpret_cast<ItemListHandle>(items);
*itemsFound = items->data();
*itemCount = items->size();
return true;
}
EXPORT bool ReleaseItems(ItemListHandle hItems)
{
auto items = reinterpret_cast<std::vector<double>*>(hItems);
delete items;
return true;
}
来电者:
static unsafe void Main()
{
double* items;
int itemsCount;
using (GenerateItemsWrapper(out items, out itemsCount))
{
double sum = 0;
for (int i = 0; i < itemsCount; i++)
{
sum += items[i];
}
Console.WriteLine("Average is: {0}", sum / itemsCount);
}
Console.ReadLine();
}
#region wrapper
[DllImport("Win32Project1", ExactSpelling = true, CallingConvention = CallingConvention.Cdecl)]
static unsafe extern bool GenerateItems(out ItemsSafeHandle itemsHandle,
out double* items, out int itemCount);
[DllImport("Win32Project1", ExactSpelling = true, CallingConvention = CallingConvention.Cdecl)]
static unsafe extern bool ReleaseItems(IntPtr itemsHandle);
static unsafe ItemsSafeHandle GenerateItemsWrapper(out double* items, out int itemsCount)
{
ItemsSafeHandle itemsHandle;
if (!GenerateItems(out itemsHandle, out items, out itemsCount))
{
throw new InvalidOperationException();
}
return itemsHandle;
}
class ItemsSafeHandle : SafeHandleZeroOrMinusOneIsInvalid
{
public ItemsSafeHandle()
: base(true)
{
}
protected override bool ReleaseHandle()
{
return ReleaseItems(handle);
}
}
#endregion
我想将大约 100 - 10,000 点从非托管 C++ 传递到 C#。
C++ 端看起来像这样:
__declspec(dllexport) void detect_targets( char * , int , /* More arguments */ )
{
std::vector<double> id_x_y_z;
// Now what's the best way to pass this vector to C#
}
现在我的 C# 端看起来像这样:
using System;
using System.Runtime.InteropServices;
class HelloCpp
{
[DllImport("detector.dll")]
public static unsafe extern void detect_targets( string fn , /* More arguments */ );
static void Main()
{
detect_targets("test.png" , /* More arguments */ );
}
}
我需要如何更改我的代码才能将 std::vector 从非托管 C++ 及其所有内容传递给 C#?
我能想到不止一种选择,但无论如何都包括复制数组的数据。使用 [out] 参数,您可以尝试:
C++代码
__declspec(dllexport) void __stdcall detect_targets(wchar_t * fn, double **data, long* len)
{
std::vector<double> id_x_y_z = { 1, 2, 3 };
*len = id_x_y_z.size();
auto size = (*len)*sizeof(double);
*data = static_cast<double*>(CoTaskMemAlloc(size));
memcpy(*data, id_x_y_z.data(), size);
}
C#代码
[DllImport("detector.dll")]
public static extern void detect_targets(
string fn,
[MarshalAs(UnmanagedType.LPArray, SizeParamIndex = 2)] out double[] points,
out int count);
static void Main()
{
int len;
double[] points;
detect_targets("test.png", out points, out len);
}
我使用 C++ CLI 包装器实现了这个。 C++ CLI 是 C++ C# 互操作的三种可能方法之一。其他两种方法是 P/Invoke 和 COM。 (我看到一些好人推荐使用 C++ CLI 而不是其他方法)
为了将信息从本机代码编组到托管代码,您需要首先将本机代码包装在托管的 C++ CLI 中 class。创建一个新项目以包含本机代码及其 C++ CLI 包装器。确保为此项目启用 /clr
编译器开关。将此项目构建为 dll。为了使用这个库,只需在 C# 中添加它的引用并对其进行调用。如果两个项目都在同一个解决方案中,您可以这样做。
这是我的一个简单程序的源文件,用于将 std::vector<double>
从本机代码编组为 C# 托管代码。
1) 项目 EntityLib(C++ CLI dll)(带包装器的本机代码)
文件NativeEntity.h
#pragma once
#include <vector>
class NativeEntity {
private:
std::vector<double> myVec;
public:
NativeEntity();
std::vector<double> GetVec() { return myVec; }
};
文件NativeEntity.cpp
#include "stdafx.h"
#include "NativeEntity.h"
NativeEntity::NativeEntity() {
myVec = { 33.654, 44.654, 55.654 , 121.54, 1234.453}; // Populate vector your way
}
文件ManagedEntity.h(包装Class)
#pragma once
#include "NativeEntity.h"
#include <vector>
namespace EntityLibrary {
using namespace System;
public ref class ManagedEntity {
public:
ManagedEntity();
~ManagedEntity();
array<double> ^GetVec();
private:
NativeEntity* nativeObj; // Our native object is thus being wrapped
};
}
文件ManagedEntity.cpp
#include "stdafx.h"
#include "ManagedEntity.h"
using namespace EntityLibrary;
using namespace System;
ManagedEntity::ManagedEntity() {
nativeObj = new NativeEntity();
}
ManagedEntity::~ManagedEntity() {
delete nativeObj;
}
array<double>^ ManagedEntity::GetVec()
{
std::vector<double> tempVec = nativeObj->GetVec();
const int SIZE = tempVec.size();
array<double> ^tempArr = gcnew array<double> (SIZE);
for (int i = 0; i < SIZE; i++)
{
tempArr[i] = tempVec[i];
}
return tempArr;
}
2) SimpleClient 项目(C# exe)
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using EntityLibrary;
namespace SimpleClient {
class Program {
static void Main(string[] args) {
var entity = new ManagedEntity();
for (int i = 0; i < entity.GetVec().Length; i++ )
Console.WriteLine(entity.GetVec()[i]);
}
}
}
只要托管代码不调整向量的大小,您就可以访问缓冲区并将其作为指针传递给 vector.data()
(对于 C++0x)或 &vector[0]
。这导致零拷贝系统。
示例 C++ API:
#define EXPORT extern "C" __declspec(dllexport)
typedef intptr_t ItemListHandle;
EXPORT bool GenerateItems(ItemListHandle* hItems, double** itemsFound, int* itemCount)
{
auto items = new std::vector<double>();
for (int i = 0; i < 500; i++)
{
items->push_back((double)i);
}
*hItems = reinterpret_cast<ItemListHandle>(items);
*itemsFound = items->data();
*itemCount = items->size();
return true;
}
EXPORT bool ReleaseItems(ItemListHandle hItems)
{
auto items = reinterpret_cast<std::vector<double>*>(hItems);
delete items;
return true;
}
来电者:
static unsafe void Main()
{
double* items;
int itemsCount;
using (GenerateItemsWrapper(out items, out itemsCount))
{
double sum = 0;
for (int i = 0; i < itemsCount; i++)
{
sum += items[i];
}
Console.WriteLine("Average is: {0}", sum / itemsCount);
}
Console.ReadLine();
}
#region wrapper
[DllImport("Win32Project1", ExactSpelling = true, CallingConvention = CallingConvention.Cdecl)]
static unsafe extern bool GenerateItems(out ItemsSafeHandle itemsHandle,
out double* items, out int itemCount);
[DllImport("Win32Project1", ExactSpelling = true, CallingConvention = CallingConvention.Cdecl)]
static unsafe extern bool ReleaseItems(IntPtr itemsHandle);
static unsafe ItemsSafeHandle GenerateItemsWrapper(out double* items, out int itemsCount)
{
ItemsSafeHandle itemsHandle;
if (!GenerateItems(out itemsHandle, out items, out itemsCount))
{
throw new InvalidOperationException();
}
return itemsHandle;
}
class ItemsSafeHandle : SafeHandleZeroOrMinusOneIsInvalid
{
public ItemsSafeHandle()
: base(true)
{
}
protected override bool ReleaseHandle()
{
return ReleaseItems(handle);
}
}
#endregion