readme.md · LoftyGitee/EEditor

# EEditor

一个基于C++反射的开发框架，提供树结构，属性列表，redo/undo，序列化/反序列化等功能，计划融合osg，vtk，qt，occ，vrep等开源软件，提供python，lua等二次开发接口，为桌面端专业软件开发提供基础平台。

## 要解决的问题

在当前软件开发大环境下，开源软件取得了蓬勃发展，其中使用C/C++开发的开源软件库主要集中在性能、算法要求较高的领域，例如视频编解码、CAD、CAE、游戏、三维渲染、数字地球等等，也因此C/C++领域内已经积累了数量非常可观的、专业的开源软件库，这是其他编程语言所不具备的，是一座巨大的宝库。

多年使用C/C++做软件项目，常常惊叹于它的计算性能和包罗万象，也常常受困于低下的开发效率，所以C/C++软件开发中存在一种根本性矛盾：

**从算法和效率上考虑，开发者离不开C++，但从软件成品和客户交付上考虑，开发者想放弃C++**

解决上述矛盾的一种方法是引入脚本语言，使用脚本开发业务代码，可以有效解决开发效率低的问题，而且C/C++与Python、JS等的绑定已经非常方便。我们在项目中应用过类似的技术，甚至尝试使用SWIG这种自动化脚本接口开发工具。但经过实践，还是存在一些问题：

*开发环境的割裂，开发者需要在多种开发语言之间切换，调试不方便

*需要维护三份代码：C/C++代码、胶水代码、脚本代码，非常消耗精力

*并不是所有的C/C++代码都可以快速地绑定到脚本上，有时候为了测试某一个功能是否正确，需要先写胶水代码，再写测试的脚本代码，效率反而是降低了

后来遇到了反射技术，经过长期的摸索，我们总结出了一套可行的开发策略，可以很大程度解决上述问题，这也是开发本项目的出发点。

## 设计理念
这里所说的反射技术，是指在C/C++环境下实现反射，支持以下几个基本操作：

* 通过类的名称（一个字符串）创建一个类

* 可以在不接触类声明的情况下，通过名称遍历并获取到类的属性和方法

* 可以在不接触类声明的情况下，通过名称设置、获取类的属性，调用类的方法

这些操作都通过C/C++接口实现，这里解释为什么反射技术有可能解决上述问题：

* 首先，反射技术提供的接口其实可以看作是一种特殊的脚本语言，使用时主要通过字符串（类名、函数名、变量名）和被调用的代码进行交互，已经是一种非常高层次的抽象。

* 其次，开发环境统一，都在C/C++环境中，避免不同语言切换

* 最后，反射技术是脚本绑定的重要补充，可用于实现胶水代码的自动生成，进而实现自动化脚本绑定

支持上述论点的一个案例就是Unreal引擎，其内部大量使用了反射技术：蓝图与C++的反射接口保持一致、属性编辑界面与C++的反射接口保持一直、Lua脚本方案UnLua通过反射接口实现脚本自动化绑定，等等。

本项目以C/C++反射技术为核心，构建了一套开发框架，依次实现如下的功能：

* 基于clang实现了自动化的C++反射代码生成，不需要编写反射注册代码（不同于rttr库），与Qt、Unreal的反射技术类似，但不需要写很多宏定义，更接近自然的C++类声明

* 实现了一套Variant万能数据结构和Property属性数据结构，封装类的成员变量

* 实现了一套Function数据结构，封装类的成员函数

* 基于Qt实现了由反射信息自动生成界面，包括类型列表，属性编辑。

* 集成常见用功能，包括：日志、字符串、事件系统、代理、文件信息、插件系统。这些功能在一个库中实现，不依赖第三方库，代码可直接编译，可以抽离出来单独使用。

* 集成osg、occ、pcl、vtk等专业C++开源库，借助反射快速实现软件原型开发，支持统一的redo/undo、序列化/反序列功能，不需要做额外开发（还在进行中）

* 基于反射实现C++与python，lua等脚本接口自动绑定（还在进行中）

* 集合上述所有功能，形成一套完整的面向桌面端专业软件开发的基础平台（还在进行中）

## 代码结构说明

### LibCommon：

dll库，集成了常用功能：日志、字符串、事件系统、代理、文件信息、插件系统、元对象系统等。

### ExeCommon：

可执行程序，提供LibCommon的测试代码

### LibReflection：

dll库，调用clang获取C++类的信息，并生成反射代码

### ExeReflection：

可执行程序，调用LibReflection，支持在命令行中配置待反射的C++头文件、包含文件路径等信息，生成反射代码。该程序被集成进本项目插件工程的CMake中，可以实现编译过程中自动生成反射代码。

### LibUiQt

基于Qt的界面库，提供了属性控件，树形结构控件，日志控件等，实现了基于反射信息的界面自动化生成。

### ExeUiOverall

可执行程序，本项目的主界面，展示软件最终形态。

### PluginDefault

插件工程，dll库，演示插件的编写方法，拥有反射信息的C++类的写法。

### PluginXml

插件工程，dll库，基于本项目理念设计的一个XML读取插件，演示了基本功能。

## 编译和安装
支持的操作系统是Windows和Ubuntu，主要开发环境是Windows，Ubuntu下可以编译并运行，但具体配置方法后续再更新。这里主要介绍windows下的编译过程。

当然，也可以直接下载release中的发布版进行体验。当前release和本编译过程都使用了vs2019 x64平台。

从源码编译，需要按照以下步骤进行操作：

### Windows-vs2019
* 配置好Depend-hub库

链接是：https://gitee.com/beijing-greitpi-software/depend-hub.git

这个库是我们维护的一个C++第三方库的集合，提供了一些库的编译后版本，可以直接使用，本项目的编译需要依赖Depend-hub中的库文件。其中Qt库比大，需要从Depend-hub所提供百度网盘链接中下载。最终期望得到的Depend-hub文件夹结构如下：

以上三个库qt、llvm、qtTabToolbar是编译必须的，Depend-hub中还有其他第三方库，欢迎使用，也欢迎提供建议增加一些热门的库，方便大家使用。

* 设置Depend-hub的路径

将根目录下的文件CMakeLists.txt拖动到CMake界面中，设置Where to build the binaries，示例如下：

```
Where is the source code=D:/coding/EEditor/

Where to build the binaries=D:/coding/EEditor/build_vs2019_x64
```

然后点击Configure按钮，在弹出的对话框中选择：

```
Visual Studio 16 2019
x64
```

点击Finish按钮结束对话框，此时会存在报错

在界面中找到变量DEPEND_DIR，并选择前面设置好的Depend-hub的文件夹，例如：

```
DEPEND_DIR=D:/coding/Depend-hub
```

然后再点击configure按钮，成功后再点击Generate，再点击Open Project，打开vs2019

* 设置clang的环境变量

由于ExeReflection运行时需要调用libclang.dll，因此需要提前设置环境变量，在windows环境变量path中增加路径（以下为示例，请根据Depend-hub的路径进行调整）：

```
D:/coding/Depend-hub/llvm/llvm-4.0.5-installed/install_vs2019_x64/bin
```

* 编译和生成

在vs2019中点击 生成-生成解决方案，如果出现错误则可以再生成一次，直至成功。

* 运行

本项目中以Exe为开头的项目可以运行，需要在vs中右键项目，设为启动项。
然后点击调式按钮就可以运行。

由于依赖了第三方库，为了避免设置环境变量的繁琐，本项目在Exe工程的cmake文件中增加了环境变量的定义，允许在vs下直接运行而不用设置环境变量

## 效果展示

ExeUiOverall的效果如下图：
![主界面](doc/images/ExeUiOverall.png)

Item列表对话框，展示插件中定义的类的列表，类的简介与代码中的注释是同步的：
![Item列表对话框](doc/images/DialogItemList.gif)

Plugin列表对话框，
![Plugin列表对话框](doc/images/DialogPlugin.gif)

xml插件功能以及redo、undo：
![xml插件功能](doc/images/PluginXml.gif)
![redo-undo](doc/images/PluginXml-redoundo.gif)

树形控件相关操作：
![树形控件相关操作](doc/images/WidgetTree.gif)

## 开发说明
这里说明本项目的开发方式，方便用户使用：

### EVariant类型
EVariant提供了类似于QVariant的功能，可以封装多种类型，实现一致的对外接口，当前支持的类型有：

| EVariantType | C++类型 | 说明 |  
| :--: | :--: | :--: |  
| INT | int | 整型 |  
| DOUBLE | double | 浮点型 |  
| BOOL | bool | 布尔型 |
| LONG | long | 长整型 |
| VEC3 | EVec3 | 三维向量 |
| VEC4 | EVec4 | 四维向量 |
| COLOR | EColor | 颜色 |
| MATRIX_4x4 | EMatrix | 矩阵 |
| STRING | EString | 字符串 |
| INTPTR_T | intptr_t | 指针 |
| EMPTY | - | 空类型 |

其中E打头的类型是本项目自定义的类型，还在不断扩充中。
EVariant的用法请参考ExeCommon的文件main_test_EVariant.cpp

### EItem类和EItemMeta类

EItemMeta类包含了与反射信息相关的定义，索引了EItemMetaProperty对象表示类的属性，索引了EItemMetaFunction对象表示类的成员函数。

EItemMeta的使用方法可以参考ExeCommon的文件main_test_EItemTest.cpp，这个例子展示了EItemTest这个类初始化，然后通过EItemMeta进行设置的过程，亮点是可以通过EItemMetaProperty接口修改类的属性，通过EItemMetaFunction调用类的函数。

EItem是本项目中可以包含反射信息的基础类，提供的主要功能有：

* 通过getOrCreatMeta函数对外提供EItemMeta对象
* 按照组合模式（设计模式的一种）提供了树形结构构建接口

### 类的声明
以EItemInPlugin这个类为例子说明包含反射类的定义方法：

* 对象采用std提供的智能指针进行管理

* 以ui_为开头的函数，在属性控件中会增加相对应的按钮，按钮触发时会调用该函数

* 以ui_为开头的变量，在属性控件中会增加相对应的设置控件，变量类型不同，控件不同

* OnSet_XXX函数是属性发生更改时被调用，OnGet_XXX函数是界面获取属性值的时候会被调用

* 类上方的注释文本会代入反射信息中，最终反映在界面的ItemList对话框中。

* 类需要继承EItem类或其子类

```cpp
#ifndef E_ITEM_IN_PLUGIN_H
#define E_ITEM_IN_PLUGIN_H
#include <DefineCommon.h>
#include <EMatrix4x4.h>
#include <EString.h>
#include <EItem.h>
#include "EItemInPluginParent.h"

class EItemInPlugin;
typedef SmartPtr(EItemInPlugin) EItemInPluginPtr;

/**
 * @brief 
 * A class for refection and plugin testing  
 * @param param1
 * @param param2
 * @return
 */
class EItemInPlugin : public EItemInPluginParent
{
public:
    EItemInPlugin();
    virtual ~EItemInPlugin();

/*some function that may be called by ui*/
    void ui_testAdd(double v1, double v2);

//some properties that will show in ui
    int ui_testInt = 5.0;
	void OnSet_ui_testInt(const int& value);
	void OnGet_ui_testInt(int& value);

double ui_testDouble = 9.9;
    void OnSet_ui_testDouble(const double& value);
    void OnGet_ui_testDouble(double& value);

bool ui_testBool = true;
	void OnSet_ui_testBool(const bool& value);
	void OnGet_ui_testBool(bool& value);

EVec3 ui_testVec3 = EVec3(1,2,3);
    void OnSet_ui_testVec3(const EVec3& value);
    void OnGet_ui_testVec3(EVec3& value);

EVec4 ui_testVec4 = EVec4(3,3,3,3);
	void OnSet_ui_testVec4(const EVec4& value);
	void OnGet_ui_testVec4(EVec4& value);

EMatrix4x4 ui_testMatrix;
	void OnSet_ui_testMatrix(const EMatrix4x4& value);
	void OnGet_ui_testMatrix(EMatrix4x4& value);

EString ui_testString = "Hello From EItemInPlugin";
	void OnSet_ui_testString(const EString& value);
	void OnGet_ui_testString(EString& value);

protected:

};
#endif // E_ITEM_IN_PLUGIN_H
```

### 类的实现

有两个地方需要注意，第一个是要引用Autogen目录下的EItemInPlugin_autogen.h，这个文件是ExeReflection扫描EItemInPlugin.h之后自动生成的。一个是在构造函数中需要调用EItemInPlugin_construct_autogen完成元对象信息的注入。

```cpp
#include "EItemInPlugin.h"
#include "DefineCommon.h"
#include "EVariant.h"
#include <Autogen/EItemInPlugin_autogen.h>

EItemInPlugin::EItemInPlugin()
{
    ELOG_DEBUG("EItemInPlugin is constructed, m_data=%d", (intptr_t)(this->m_data));

EItemInPlugin_construct_autogen(this);
}

EItemInPlugin::~EItemInPlugin()
{
    ELOG_DEBUG("EItemInPlugin is deleted");
}
...
```

### 反射代码
以PluginDefault为例，请注意文件夹PluginDefault/Autogen，这里有一个CMakeLists.txt文件，对应到vs中是PluginDefaultAutogen项目。

PluginDefaultAutogen项目在CMake中配置了自定义生成规则，调用ExeRfelection扫描PluginDefault项目的头文件并生成XXX_autogen.h放在Autogen文件夹下。

ExeReflection扫描的规则是对类中以ui_为开头变量和函数进行处理，在XXX_autogen.h文件中写入反射定义代码，通过EItemMeta提供的接口给里面写入变量和函数的信息，然后在类的构造函数中通过宏xxx_construct_autogen完成反射信息注册。

可以参考PluginDefault/Autogen/EItemInPlugin_autogen.h文件了解具体代码。

### 插件声明和注册
插件实际上是一个dll文件（windows平台下），LibCommon中定义了一套插件管理系统，涉及的类有：EPlugin、EPluginLoader。

EPlugin类是插件入口，提供了插件加载和注册的接口。一个插件项目会存在一个EPlugin的子类，例如PluginDefault插件的EPluginDefault类。

EPluginLoader是插件管理类，符合单例模式，主界面在启动时会调用该类依次加载插件。

插件类的具体使用方法请参考，PluginDefault插件项目，这是最简单的一个插件工程。

### 日志

提供了一套简单的日志系统，使用方法如下：

```cpp
ELOG_INFO("Testing log for information");
ELOG_DEBUG("Debug %d info=%s", 10, "Hello");
ELOG_ERROR("Error string");
```

日志有三个等级，INFO、DEBUG、ERROR，按照所要打印的信息的等级来使用。

输出的信息格式是：

```cpp
//时间 日志等级 代码文件:行数 函数名 日志内容
22:23:51 INFO  D:\coding\EEditor\LibCommon\EPluginLoader.cpp:119 EPluginLoader_loadLibrary: Detail Error
```

示例可以在ExeCommon的代码中找到

### 属性界面

属性界面可以根据一个EItem对象存储的Property和Function的信息生成对应的控件，属性的更改支持redo和undo，目前所支持的类型如下：

int类型

![属性控件：int类型](doc/images/WidgetPropertyInt.png)

double类型

![属性控件：double类型](doc/images/WidgetPropertyDouble.png)

bool类型

![属性控件：bool类型](doc/images/WidgetPropertyBool.png)

EVec3类型

![属性控件：EVec3类型](doc/images/WidgetPropertyVec3.png)

EVec4类型

![属性控件：EVec4类型](doc/images/WidgetPropertyVec4.png)

EColor类型

![属性控件：EColor类型](doc/images/WidgetPropertyColor.png)

EMatrix类型，支持欧拉角和四元数

![属性控件：EMatrix类型](doc/images/WidgetPropertyMatrix.png)

EString类型

![属性控件：EString类型](doc/images/WidgetPropertyString.png)

Function类型，一个触发按钮

![属性控件：Function类型](doc/images/WidgetPropertyButton.png)

## 开发计划

本项目当前规划的功能有下面几项：

* 增加序列化和反序列化
* 以EItem为基础，定义一套二维界面定义接口，使得插件开发时不依赖Qt，并且为未来脱离Qt框架做好准备。
* 以EItem为基础，定义一套三维接口，提供osg的部分功能，为实现三维编辑器做准备。
* 美化界面外观
* 提供脚本接口，计划首先支持python
* 对标一个专业软件作为开发目标，继续推进本项目完善。

## 总结
本项目还在持续开发中，当前实现的功能较为简单，希望有更多志同道合的朋友可以与我们联系，提出需求，我们将继续完善这套框架。

请联系：greatpi2024@163.com

LoftyGitee/EEditor

简介

发行版

贡献者

近期动态

LoftyGitee/EEditor .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

LoftyGitee/EEditor