如何编写包装类以将 Qt 信号映射到 C# 事件(通过 C++/CLI)

How to write wrapper classes for mapping Qt Signals to C# events (through C++/CLI)

本文关键字:通过 事件 C++ CLI 包装类 何编写 Qt 映射 信号      更新时间:2023-10-16

通过C++/CLI包装器调用C++/Qt类就像在公园里散步一样。

但是我被困在将C++/Qt信号映射到C#事件。

我尝试结合一些可用的操作方法/答案,但没有得到任何工作结果:

  • 如何将Qt信号映射到托管C++中的事件(C++/CLI)
  • 从非托管代码调用托管代码,反之亦然
  • 以及其他一些不那么直接相关的...

这里的问题是,这些操作方法/答案已经很老了。我目前正在使用 Qt5.5(即将推出 5.6)和 .NET 4.6。我试图使一切适应当前的最新技术水平,但可能失败了。

可能是因为树木太多而看不到森林,所以我想要求一个工作示例来完成当前框架版本的任务,以便我可以发现差异并从错误中学习。

[编辑]你可以查看这个 github 存储库,了解这个来源。QtSignal 到 C#Event 的部分被注释掉,以使此代码处于工作状态。

Github 存储库:https://github.com/qwc/QtSignalToCSharpEvent

对于那些仍然想在不玩耍的情况下阅读所有内容的人......继续阅读...这是我当前的非工作代码:

所以我有一个纯Qt5的课程

#ifndef PUREQT_H
#define PUREQT_H
#include <QObject>
#include <QString>
#include "PureQt_global.h"
class PUREQTSHARED_EXPORT PureQt : public QObject    {
    Q_OBJECT
public:
    PureQt(QString name);
    ~PureQt(){}
    QString getSomeVar();
    void someFunc(const QString & string);
public slots:
signals:
    void someFuncWasCalled(const QString &string);
private:
    QString someVar;
};
#endif // PUREQT_H

通过以下相当简单的实现:

#include "PureQt.h"
PureQt::PureQt(QString name)    {
    this->someVar = "ctor("+name+")";
}
QString PureQt::getSomeVar()    {
    return this->someVar;
}
void PureQt::someFunc(const QString &string)    {
    this->someVar += "someFunc("+string+")";
    emit someFuncWasCalled(this->someVar);
}

然后,我使用 C++/CLI 实现了一个托管包装器,以便能够从 C# 调用非托管代码。请注意,我已经尝试添加代码以获取事件管理的信号。

#pragma once
#include "conversion.h"
#include "../pureqt/PureQt.h"
#include "SignalProxy.h"
using namespace System;
using namespace System::Collections::Generic;
using namespace System::Runtime::InteropServices;
namespace ManagedCppQtSpace {
    // different variants... from tinkering around.
    delegate void someFuncWasCalled(String^);
    delegate void someFuncWasCalledU(QString str);
    [StructLayoutAttribute(LayoutKind::Sequential)]
    public ref struct DelegateWrapper {
        [MarshalAsAttribute(UnmanagedType::FunctionPtr)]
        someFuncWasCalledU^ delegate;
    };
    public ref class ManagedCppQt
    {
    public:    
        ManagedCppQt(String^ name){
            pureQtObject = new PureQt(StringToQString(name));
            proxy = new SignalProxy(pureQtObject);
            wrapper = gcnew DelegateWrapper();
            wrapper->delegate = gcnew someFuncWasCalledU(this, ManagedCppQt::signalCallback);
            signalCallbackProxy callbackproxy;
            Marshal::StructureToPtr(wrapper, callbackproxy, false); // currently im stuck here with a compile error, but the problem may lie somewhere else...
            proxy->setCallback(callbackproxy);
        };
        ~ManagedCppQt(){
            delete pureQtObject;
        };
        event someFuncWasCalled ^ someFuncCalled;
        void someFunc(String^ string){
            pureQtObject->someFunc(StringToQString(string));
        };
        String^ getSomeString() {
            return QStringToString(pureQtObject->getSomeVar());
        }
        void signalCallback(QString str) {
            someFuncCalled(QStringToString(str));
        }
        DelegateWrapper ^ wrapper;
    private:
        PureQt * pureQtObject;
        SignalProxy * proxy;
    };
}

因此,要将来自Qt的信号和插槽处理与能够在托管代码中引发事件的回调联系起来,当没有更改基本代码的选项时,有些人需要一个代理类(因为它也用于其他非托管C++项目)。

#ifndef SIGNALPROXY_H
#define SIGNALPROXY_H
#include <QObject>
#include "../pureqt/PureQt.h"
typedef void (*signalCallbackProxy) (QString str);
class SignalProxy : public QObject
{
    Q_OBJECT
public:
    explicit SignalProxy(PureQt* pqt);
    ~SignalProxy();
    void setCallback(signalCallbackProxy callback);
signals:
public slots:
    void someFuncSlot(QString str);
private:
    PureQt* pureQt;
    signalCallbackProxy scallback;
};
#endif // SIGNALPROXY_H

通过实施:

#include "SignalProxy.h"
SignalProxy::SignalProxy(PureQt* pqt){
    pureQt = pqt;
    this->connect(pureQt, SIGNAL(PureQt::someFuncWasCalled(QString)), this, SLOT(someFuncSlot(QString)));
}
SignalProxy::~SignalProxy()
{}
void SignalProxy::setCallback(signalCallbackProxy callback){
    this->scallback = callback;
}
void SignalProxy::someFuncSlot(QString str){
    if(this->scallback != NULL)
        this->scallback(str);
}

所以。现在,如何正确链接这两个世界,Qt信号->托管.NET事件?

我还尝试了一些简单的方法,这些方法会导致编译错误,例如:

QObject::connect(pureQtObject, &PureQt::someFuncWasCalled, &MangagedCppQtSpace::ManagedCppQt::signalCallback);

而不是代理类,或使用 lambda 函数:

QObject::connect(pureQtObject, &PureQt::someFuncWasCalled, [] (QString str) {
    signalCallback(str);// or ManagedCppQt::signalCallback, but for this the method has to be static, and it isn't possible to raise events from static methods...
}

这里的问题是将Qt与CLI混合C++。要获得功能信号和插槽,Qt需要进程头文件来生成自己的元数据。问题是该工具将无法理解C++ CLI 功能。

要解决此问题,首先您必须回退到C++接口,并在那里安全地执行C++ CLI 操作。

所以你需要像这样的额外类,它不知道.net并创建到标准C++的桥梁:

class PureQtReceiverDelegate { // this should go to separate header file
   virtual void NotifySomeFunc(const char *utf8) = 0;
};
class PureQtReceiver : public QObject {
    Q_OBJECT
public:
    PureQtReceiver(PureQtReceiverDelegate *delegate, PureQt *parent)
    : QObject(parent)
    , mDelegate(delegate)
    {
        bool ok = connect(parent, SIGNAL(PureQt::someFuncWasCalled(QString)),
                this, SLOT(someFuncReceiver(QString)));
        Q_ASSERT(ok);
    }
public slots:
    void someFuncReceiver(const QString & string)
    {
        delegate->NotifySomeFunc(string.toUtf8().data());
    }
private:
    PureQtReceiverDelegate *delegate;
};

现在,您的 C++CLI 类应该实现此PureQtReceiverDelegate,并将字符串转换为 .net 版本并发布通知。

请注意,您可以/应该在C++CLI头文件中转发声明Qt特定类。


如果您使用的是Qt4,则上述解决方案很好,请不要使用C++11。

如果您使用的是Qt 5并且有可用的C++11,那么有更方便的解决方案:您可以在连接到QObject时使用lambda表达式。因此,您的ManagedCppQt可能如下所示:

页眉:

#pragma once
#include "conversion.h"
using namespace System;
using namespace System::Collections::Generic;
using namespace System::Runtime::InteropServices;
// forward declaration
class PureQt;
namespace ManagedCppQtSpace {
    delegate void someFuncWasCalled(String^);
    public ref class ManagedCppQt
    {
    public:    
        ManagedCppQt(String^ name);
        ~ManagedCppQt();
        event someFuncWasCalled ^ someFuncCalled;
        void someFunc(String^ string);
        String^ getSomeString();
        void signalCallback(QString str);
    private:
        PureQt * pureQtObject;
    };
}

在 CPP 中:

#include "../pureqt/PureQt.h"
using namespace ManagedCppQtSpace;
ManagedCppQt:ManagedCppQt(String^ name) {
    pureQtObject = new PureQt(QStringFromString(name));
    QObject::connect(pureQtObject, &PureQt::someFuncWasCalled,
                     [this](const QString &string){
                         if (this->someFuncCalled) {
                              String^ s = StringFromQString(string);
                              this->someFuncCalled(s);
                         }
                     });
}
ManagedCppQt::~ManagedCppQt(){
    delete pureQtObject;
}

这更容易、更快速、更易于维护。