FreeCAD模块开发指南 第2章 FreeCAD源代码结构

FreeCAD官方存储库有标准的github项目布局，存储库根目录中包含README，License, Continuous Integration安装文件。src/文件夹中的FreeCAD源代码结构树反映了其模块化的设计。

FreeCAD源文件夹中的文件和文件夹列表

---

[本段将由python脚本生成]

FreeCAD Mod文件夹中的模块列表

---

[本段将由python脚本生成]

文档

---

Doxygen生成的文档

源代码文档由doxygen从C++和python源代码文档字符串生成。doxygen项目支持的doxygen官网在编写源代码文件和文档生成方面表现出色。FreeCAD项目有一个专门的维基 Doxygen页面：https://www.freecadweb.org/wiki/Doxygen。
Schematic of documentation generation by doxygen
生成的doxygen文档（静态html内容）可以在作者的个人网站上找到Doxygen generated online documentation of source for 0.19dev on 2019-06-24。

FreeCAD 维基

除了doxygen生成的源文档，FreeCAD维基是源文档的另一个来源，提供了关于软件设计，特定模块等主题的更多信息。
https://www.freecadweb.org/wiki/Main_Page
有3个用户中心

Crystal Clear app display.png 用户中心: 此页面包含对一般用户有用的文档：所有工作台的列表，有关如何安装并使用FreeCAD应用程序的详细说明，教程以及所有你需要的入门资料。
Crystal Clear app terminal.png 超级用户中心: 此页面收集了适用于高级用户和有兴趣编写python脚本的人员的文档。在这里您还能找到宏存储库，有关如何安装和使用这些宏的说明，以及关于如何根据特定需求来自定义FreeCAD的更多信息。
Crystal Clear app tutorials.png 开发人员中心: 此页面包含面向开发人员的资料：如何自己编译FreeCAD，FreeCAD的源代码结构以及如何浏览，如何开发新的工作台，或将FreeCAD嵌入您自己的程序中。
其中，开发人员中心是模块开发人员的必读资料。

用户手册

一位开发人员已经为FreeCAD 0.18版编写了合适的用户手册。

Crystal Clear manual.png FreeCAD用户手册以更线性方式呈现此维基中的信息。它被设计得可以像书一样阅读，从上面的用户中心开始，轻松地向你介绍许许多多的其他页面。

构建FreeCAD环境

---

CMake简介

CMake是FreeCAD的跨平台构建工具。 除了生成用于构建FC的制作文件外，它还生成Windows的安装程序，Linux的DEB / RPM软件包以及MacOSX映像包。
有关CMake的快速入门，请参见附录2 cmake速查表。

FreeCAD中的CMake

根目录中的项目顶层CMakeLists.txt很长，它检测第三方库并处理编译器和操作系统的差异。相应地，源代码树中的[src / CMakeLists.txt]要简短得多，并带有add_directory(subfolder_name)。
存储库根目录中的CMake
文件夹中有* .cmake文件，用于检测库。 如果添加了带有c ++代码的新工作台，则可能需要CMake的第三方检测器。

set(CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cMake")

以下假设代码演示了如何使用CMake指定不从源代码构建OpenFOAM，而是可以将其作为二进制文件进行安装。 对于其他依赖项，例如像netgen和gmsh之类的FEM网格划分工具，也可以这样做。

if(NOT MSVC)
    OPTION(BUILD_FEM_FOAM "Build the FreeCAD FEM module with the OpenFOAM CFD solver" ON)
else
    OPTION(BUILD_FEM_FOAM "Build the FreeCAD FEM module with the OpenFOAM CFD solver" OFF)
endif(NOT MSVC)

深入探索，我们可以在顶层CMake文件[src / CMakeLists.txt]中看到以下内容

# -------------------- OpenFOAM --------------------
    if (BUILD_FEM_FOAM)
        find_package(FOAM)
    endif(BUILD_FEM_FOAM)

cMake/FindSMESH.cmake代码分析

# Try to find Salome SMESH
# Once complete, this will define
#
# SMESH_FOUND         - if the current system has Salome SMESH
# SMESH_INCLUDE_DIR   - path to the Salome SMESH include directory
# SMESH_LIBRARIES     - path to the Salome SMESH libraries
#


IF (CMAKE_COMPILER_IS_GNUCC)
    FIND_PATH(SMESH_INCLUDE_DIR SMESH_Mesh.hxx
    # These are default search paths, why specify them?
    # /usr/include
    # /usr/local/include
    PATH_SUFFIXES smesh
    )
    FIND_LIBRARY(SMESH_LIBRARY SMESH
    #  /usr/lib
    #  /usr/local/lib
    )
ELSE (CMAKE_COMPILER_IS_GNUCC)
    # Not yet implemented
ENDIF (CMAKE_COMPILER_IS_GNUCC)

SET(SMESH_FOUND FALSE)
IF(SMESH_LIBRARY)
  SET(SMESH_FOUND TRUE)
  GET_FILENAME_COMPONENT(SMESH_LIBRARY_DIR ${SMESH_LIBRARY} PATH)
  set(SMESH_LIBRARIES
    ${SMESH_LIBRARY_DIR}/libDriver.so
    ${SMESH_LIBRARY_DIR}/libDriverDAT.so
    ${SMESH_LIBRARY_DIR}/libDriverSTL.so
    ${SMESH_LIBRARY_DIR}/libDriverUNV.so
    ${SMESH_LIBRARY_DIR}/libSMDS.so
    ${SMESH_LIBRARY_DIR}/libSMESH.so
    ${SMESH_LIBRARY_DIR}/libSMESHDS.so
    ${SMESH_LIBRARY_DIR}/libStdMeshers.so
  )
ENDIF(SMESH_LIBRARY)

持续集成(CI)

---

持续集成（CI）基本上是构建和测试自动化的范例。 CI对于有效维护软件项目至关重要。 FreeCAD使用多种CI工具。

Travis CI

Travis与github紧密集成，并在FreeCAD github存储库中广泛使用。 有关如何为代码存储库设置Travis CI的更多信息，请阅读此实用指南。
Travis使用YAML文件。 对于Linux和MacOS平台，FreeCAD的主要Travis配置文件是.travis.yml。
对于Windows，配置文件为.travis/build.bat。

其他CI工具

除Travis外，还有一个完整的CI软件生态系统，您可以通过专门的维基百科页面了解有关它们的更多信息。
.circleci/config.yml文件将建立镜像容器以设置测试环境。

arcconfig 和 phabricator

"phabricator.uri" : "http://pha.geofinder.eu/" 

流浪者云虚拟机

FreeCAD有一个子文件夹来设置云虚拟机，用于构建和测试。

Docker容器配置

subuser/freecad-dev[.subuser.json]添加了用于在Docker容器中开发freecad的子用户文件。

AppVoyer

注册并设置github和bitbucket存储库很简单，请参见官方文档https://www.appveyor.com/docs/。FreeCAD项目使用AppVoyer在Windows上进行构建，尽管它是跨平台的解决方案。

打包和部署

---

Linux RPM和Deb，AppImage

FreeCAD已经出现在主要linux发行版的官方存储库中，但版本可能已过时。 对于Ubuntu，有PPA可以安装最新甚至每天更新的开发版本。 建议开发人员安装最新版本，尤其是Qt5 + Python3组合。

Windows 和 OSX 预构建

Windows安装程序由NSIS生成，并且是开源的Windows安装程序生成工具。 为Windows打包是在另一个子项目FreeCADInstProj中，请参阅[https://github.com/FreeCAD/FreeCAD/tree/master/src/WindowsInstaller](https://github.com/FreeCAD/FreeCAD/tree/master/ src / WindowsInstaller）。

其他跨平台软件包管理器

存储库根目录中的package文件夹包含[conda]()配方以构建Anaconda软件包。 Conda是流行的二进制python软件包（从其他语言编译的python模块）分发系统。
fedora子文件夹包含配置。

学习路径

1. 作为用户，熟悉FreeCAD GUI操作。
   请参见FreeCAD维基 用户中心
   ，youtube上的教程和用户手册。
2. 熟悉Python脚本，从宏录制中学习。
   FreeCAD的优秀特性是所有GUI操作都记录在Python控制台中。
   FreeCAD维基 高级用户中心 FreeCAD维基 开发人员中心。
3. 熟悉FreeCAD源代码中的关键类：Base，App，Gui，Part。
   用C++，Python GIL，Coin3D，OCC编程确实很有挑战性。不过，作为模块开发人员，不需要了解OCC。 FreeCAD有一个在线API文档，用于导入类例如如属性，文档对象等，请参见https://www.freecadweb.org/wiki/Power_users_hub#API_Functions。
   要探索源代码，可在iesensor.com上找到doxygen生成的文档。 此外，Sourcetrail也是帮助此工作的工具之一，它是一个功能强大的工具，可免费用于非商业用途，用于探索大型软件项目，请参见FreeCAD论坛讨论。可以从https://www.sourcetrail.com/下载该软件。
4. 开发/扩展纯Python模块，可以避免具有挑战性的Python包装工作。
5. 开发/扩展C ++和Python混合模块。
6. 编写3D渲染代码，即ViewProvider派生的类。

---

版权声明：本文翻译自《Module developer's guide to FreeCAD source code》，遵循 CC 4.0 BY-SA 协议（https://creativecommons.org/licenses/by-sa/4.0/），转载请附上原文出处链接及本声明。原文链接：https://github.com/qingfengxia/FreeCAD_Mod_Dev_Guide/blob/f9d5ebc48f94dece49c88afe7ad4542751a0f074/chapters/2.FreeCAD_source_code_structure.md#appvoyer。