[SWIG] 多继承与接口（%interface、%interface_impl、%interface

本文主要是介绍[SWIG] 多继承与接口（%interface、%interface_impl、%interface_custom），希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

原文链接：https://www.yuque.com/cpptd/swig/xvh0b6
SWIG系列笔记：https://www.yuque.com/cpptd/swig

文章目录

- - 引言
  - SWIG中的接口
  - 将模板类申明为接口
  - - - 1. idescription.hpp
      - 2. example.hpp
      - 3. example.i
  - 源码：swiginterface.i

引言

SWIG报错：

warning 833: Warning for ITask, base IParameter ignored. Multiple inheritance is not supported in C#.

与C#类似，许多语言都没有多继承，但是它们有接口的概念，一个类可以实现多个接口。因此，我们可以将C++多继承改为多接口的实现。

注：C++虽然支持多继承，但不推荐使用多继承，它会带来很多很多复杂的耦合问题。但C++推荐一种多继承的形式：一个是主的继承类，其他都是接口（or抽象基类）。这也是后来的语言所提倡的（它们也是借鉴C++的经验）：单继承是父类，其他是实现接口。

SWIG中的接口

关于接口的申明，SWIG提供了三种方法，分别是：%interface、%interface_impl、interface_custom。

请添加图片描述
说明：

Cpp是C++中的类图
A、B、C是包装后，目标语言中的类图（这里以C#举例）

将模板类申明为接口

在一些很奇怪的场景下，我们也要将模板类申明成接口。

1. idescription.hpp

这是一个接口，它是模板类。

#pragma once
#include<string>namespace example{template <typename DerivedClassName>class IDescription{public:IDescription(const std::string& name) :_mName(name) {}virtual ~IDescription() = default;public:std::string name() const{return _mName;}DerivedClassName& setName(const std::string& name){_mName = name;return *(DerivedClassName*)this;}std::string description() const{return _mDescription;}DerivedClassName& setDescription(const std::string& description){_mDescription = description;return *(DerivedClassName*)this;}protected:std::string		_mName; 		//<- 名称std::string		_mDescription;	//<- 详细说明};};

2. example.hpp

这里有一个基类和派生类。派生类DerivedClass继承了基类BaseClass，并实现了IDescription接口。

#pragma once
#include<string>#include"idescription.hpp"namespace example{class BaseClass{public:virtual ~BaseClass() = default;virtual std::string className(){return "BaseClass";}};class DerivedClass : public BaseClass, public IDescription<DerivedClass>{public:DerivedClass(const std::string& name) : IDescription(name){}std::string className() override{return "DerivedClass";}};};

3. example.i

%module example%{
#include "idescription.hpp"
#include "example.hpp"
%}%include"std_string.i"//自定义一个template_interface宏，完成对模板类的接口定义
%include <swiginterface.i>
%define %template_interface(CTYPE, TEMPLATE_IMPL, INTERFACE...)
%interface_custom(#TEMPLATE_IMPL, #INTERFACE, CTYPE);
%template(#TEMPLATE_IMPL) CTYPE;
%enddef%include"idescription.hpp"%template_interface(example::IDescription<example::DerivedClass>, DerivedClassDescription, IDerivedClassDescription); //这句话要在%include"example.hpp"之前，即在example::IDescription<example::DerivedClass>之前
%include"example.hpp"

源码：swiginterface.i

/* -----------------------------------------------------------------------------* swiginterface.i** SWIG interface feature and typemaps implementation providing:*   %interface*   %interface_impl*   %interface_custom* ----------------------------------------------------------------------------- */%define INTERFACE_TYPEMAPS(CTYPE...)
%typemap(cstype) CTYPE "$&csinterfacename"
%typemap(cstype) CTYPE *, CTYPE [], CTYPE & "$csinterfacename"
%typemap(cstype) CTYPE *const& "$*csinterfacename"
%typemap(csin) CTYPE, CTYPE & "$csinput.GetInterfaceCPtr()"
%typemap(csin) CTYPE *, CTYPE *const&, CTYPE [] "$csinput == null ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : $csinput.GetInterfaceCPtr()"
%typemap(csout, excode=SWIGEXCODE) CTYPE {$&csclassname ret = new $&csclassname($imcall, true);$excodereturn ($&csinterfacename)ret;}
%typemap(csout, excode=SWIGEXCODE) CTYPE & {$csclassname ret = new $csclassname($imcall, $owner);$excodereturn ($csinterfacename)ret;}
%typemap(csout, excode=SWIGEXCODE) CTYPE *, CTYPE [] {global::System.IntPtr cPtr = $imcall;$csclassname ret = (cPtr == global::System.IntPtr.Zero) ? null : new $csclassname(cPtr, $owner);$excodereturn ($csinterfacename)ret;}
%typemap(csout, excode=SWIGEXCODE) CTYPE *const& {global::System.IntPtr cPtr = $imcall;$*csclassname ret = (cPtr == global::System.IntPtr.Zero) ? null : new $*csclassname(cPtr, $owner);$excodereturn ($*csinterfacename)ret;}
%typemap(csdirectorin) CTYPE "($&csinterfacename)new $&csclassname($iminput, true)"
%typemap(csdirectorin) CTYPE & "($csinterfacename)new $csclassname($iminput, false)"
%typemap(csdirectorin) CTYPE *, CTYPE [] "($iminput == global::System.IntPtr.Zero) ? null : ($csinterfacename)new $csclassname($iminput, false)"
%typemap(csdirectorin) CTYPE *const& "($iminput == global::System.IntPtr.Zero) ? null : ($*csinterfacename)new $*csclassname($iminput, false)"
%typemap(csdirectorout) CTYPE, CTYPE *, CTYPE *const&, CTYPE [], CTYPE & "$cscall.GetInterfaceCPtr()"
%typemap(csinterfacecode, declaration="  [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]\n  global::System.Runtime.InteropServices.HandleRef GetInterfaceCPtr();\n", cptrmethod="$interfacename_GetInterfaceCPtr") CTYPE %{[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]global::System.Runtime.InteropServices.HandleRef $interfacename.GetInterfaceCPtr() {return new global::System.Runtime.InteropServices.HandleRef(this, $imclassname.$csclazzname$interfacename_GetInterfaceCPtr(swigCPtr.Handle));}
%}
%enddef%define %interface(CTYPE...)
%feature("interface", name="%sSwigInterface") CTYPE;
INTERFACE_TYPEMAPS(CTYPE)
%enddef%define %interface_impl(CTYPE...)
%rename("%sSwigImpl") CTYPE;
%feature("interface", name="%(rstrip:[SwigImpl])s") CTYPE;
INTERFACE_TYPEMAPS(CTYPE)
%enddef%define %interface_custom(PROXY, INTERFACE, CTYPE...)
%rename(PROXY) CTYPE;
%feature("interface", name=INTERFACE) CTYPE;
INTERFACE_TYPEMAPS(CTYPE)
%enddef