Add OpenCSG as a submodule (optional). (openscad#4596)

`cmake -DUSE_BUILTIN_OPENCSG=ON` now builds OpenCSG from a submodule rather than looking for it on the system.

Author: kintel

.github/workflows/manual.yml

@@ -59,6 +59,11 @@ on:
         description: 'Enable UBSAN'
         required: false
         default: false
+      use_builtin_opencsg:
+        type: boolean
+        description: 'Use built-in OpenCSG'
+        required: false
+        default: false
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -108,7 +113,7 @@ jobs:
         python-version: '3.11'
     - name: Build
       run: |
-        cmake ${CMAKE_EXTRA} -DCMAKE_BUILD_TYPE=${{ inputs.build_type }} -DEXPERIMENTAL=${{ inputs.enable_experimental }} -DUSE_MIMALLOC=${{ inputs.use_mimalloc }} -DSANITIZE_MEMORY=${{ inputs.enable_msan }} -DSANITIZE_ADDRESS=${{ inputs.enable_asan }} -DSANITIZE_THREAD=${{ inputs.enable_tsan }} -DSANITIZE_UNDEFINED=${{ inputs.enable_ubsan }} -B b .
+        cmake ${CMAKE_EXTRA} -DCMAKE_BUILD_TYPE=${{ inputs.build_type }} -DEXPERIMENTAL=${{ inputs.enable_experimental }} -DUSE_MIMALLOC=${{ inputs.use_mimalloc }} -DSANITIZE_MEMORY=${{ inputs.enable_msan }} -DSANITIZE_ADDRESS=${{ inputs.enable_asan }} -DSANITIZE_THREAD=${{ inputs.enable_tsan }} -DSANITIZE_UNDEFINED=${{ inputs.enable_ubsan }} -DUSE_BUILTIN_OPENCSG=${{ inputs.use_builtin_opencsg }} -B b .
         cmake --build b -j 2
         echo "Build exit code: $?"
     - name: Test

.gitmodules

@@ -10,3 +10,6 @@
 [submodule "sanitizers-cmake"]
 	path = submodules/sanitizers-cmake
 	url = https://github.com/arsenm/sanitizers-cmake.git
+[submodule "OpenCSG"]
+	path = submodules/OpenCSG
+	url = https://github.com/openscad/OpenCSG.git

CMakeLists.txt

@@ -41,6 +41,7 @@ option(PROFILE "Enable compiling with profiling / test coverage instrumentation"
 option(MXECROSS "Enable setup for MXE cross platform build" OFF)
 option(OFFLINE_DOCS "Download Documentation for offline usage" OFF)
 option(USE_MIMALLOC "Use mimalloc as malloc replacement." ON)
+option(USE_BUILTIN_OPENCSG "Use OpenCSG from submodule." OFF)
 option(USE_CCACHE "Use ccache to speed up compilation." ON)
 option(ENABLE_CAIRO "Enable support for cairo vector graphics library." ON)
 option(ENABLE_SPNAV "Enable support for libspnav input driver." ON)
@@ -185,9 +186,21 @@ macro(find_graphics)
   if(NULLGL)
     target_compile_definitions(OpenSCAD PRIVATE NULLGL)
   else()
-    find_package(OpenCSG REQUIRED QUIET)
-    target_link_libraries(OpenSCAD PRIVATE ${OPENCSG_LIBRARY})
-    message(STATUS "OpenCSG: ${OPENCSG_VERSION_STRING}")
+    if(NOT USE_BUILTIN_OPENCSG)
+      find_package(OpenCSG REQUIRED QUIET)
+      target_link_libraries(OpenSCAD PRIVATE ${OPENCSG_LIBRARY})
+      message(STATUS "OpenCSG: ${OPENCSG_VERSION_STRING}")
+      if(MSVC)
+        find_path(OPENCSG_INCLUDE_DIRS opencsg/opencsg.h)
+        target_include_directories(OpenSCAD SYSTEM PRIVATE "${OPENCSG_INCLUDE_DIRS}/opencsg")
+      else()
+        find_path(OPENCSG_INCLUDE_DIRS opencsg.h)
+        target_include_directories(OpenSCAD SYSTEM PRIVATE ${OPENCSG_INCLUDE_DIRS})
+      endif()
+    else()
+      target_link_libraries(OpenSCAD PRIVATE OpenCSG)
+      message(STATUS "OpenCSG: <submodule>")
+    endif()
     target_compile_definitions(OpenSCAD PRIVATE ENABLE_OPENCSG)
 
     find_package(GLEW REQUIRED QUIET)
@@ -409,6 +422,10 @@ if(NOT MSVC)
   endif()
 endif()
 
+if(USE_BUILTIN_OPENCSG)
+  include("submodules/CMakeLists-OpenCSG.txt")
+endif(USE_BUILTIN_OPENCSG)
+
 # Automatically add the current source and build directories to the include path.
 set(CMAKE_INCLUDE_CURRENT_DIR ON) # (does not propagate down to subdirectories)
 
@@ -564,8 +581,8 @@ elseif(UNIX)
       set(OFFSCREEN_METHOD "Unix GLX on X11")
       message(STATUS "Offscreen OpenGL Context - using Unix GLX on X11")
       set(PLATFORM_SOURCES ${PLATFORM_SOURCES} src/glview/offscreen-old/OffscreenContextGLX.cc)
-      find_library(X11_LIBRARY X11)
-      target_link_libraries(OpenSCAD PRIVATE ${X11_LIBRARY})
+      find_package(X11 REQUIRED)
+      target_link_libraries(OpenSCAD PRIVATE X11::X11)
     endif()
   endif()
 elseif(WIN32)

cmake/Modules/info.cmake

@@ -50,6 +50,7 @@ message(STATUS "Headless build:        ${HEADLESS}")
 message(STATUS "NULLGL build:          ${NULLGL}")
 message(STATUS "Profiling/coverage:    ${PROFILE}")
 message(STATUS "Use mimalloc:          ${USE_MIMALLOC}")
+message(STATUS "Use built-in OpenCSG:  ${USE_BUILTIN_OPENCSG}")
 message(STATUS "CSG node id-prefix:    ${IDPREFIX}")
 message(STATUS "Offline documentation: ${OFFLINE_DOCS}")
 message(STATUS " ")

submodules/CMakeLists-OpenCSG.txt

@@ -0,0 +1,35 @@
+set(USE_PBUFFER 1)
+if (USE_PBUFFER)
+  set(PBUFFER_SOURCES
+    submodules/OpenCSG/src/pBufferTexture.cpp
+    submodules/OpenCSG/RenderTexture/RenderTexture.cpp
+  )
+endif(USE_PBUFFER)    
+
+set(OPENCSG_SOURCES
+  submodules/OpenCSG/src/area.cpp
+  submodules/OpenCSG/src/batch.cpp
+  submodules/OpenCSG/src/context.cpp
+  submodules/OpenCSG/src/channelManager.cpp
+  submodules/OpenCSG/src/frameBufferObject.cpp
+  submodules/OpenCSG/src/frameBufferObjectExt.cpp
+  submodules/OpenCSG/src/occlusionQuery.cpp
+  submodules/OpenCSG/src/opencsgRender.cpp
+  submodules/OpenCSG/src/openglHelper.cpp
+  submodules/OpenCSG/src/primitive.cpp
+  submodules/OpenCSG/src/primitiveHelper.cpp
+  submodules/OpenCSG/src/renderGoldfeather.cpp
+  submodules/OpenCSG/src/renderSCS.cpp
+  submodules/OpenCSG/src/scissorMemo.cpp
+  submodules/OpenCSG/src/settings.cpp
+  submodules/OpenCSG/src/stencilManager.cpp
+  ${PBUFFER_SOURCES}
+)
+
+add_library(OpenCSGObjects OBJECT ${OPENCSG_SOURCES})
+target_include_directories(OpenCSGObjects PRIVATE OpenCSG submodules/OpenCSG submodules/OpenCSG/include)
+target_link_libraries(OpenCSGObjects PRIVATE GLEW::glew)
+
+add_library(OpenCSG INTERFACE)
+target_include_directories(OpenCSG INTERFACE submodules/OpenCSG/include)
+target_sources(OpenCSG INTERFACE $<TARGET_OBJECTS:OpenCSGObjects>)

submodules/OpenCSG

@@ -0,0 +1 @@
+7b24d76 OpenCSG 1.5.1