[CMake] clean: keep minimal required instructions

Author: nim65s

CMakeLists.txt

@@ -2,46 +2,74 @@
 
 CMAKE_MINIMUM_REQUIRED(VERSION 3.1)
 
-SET(PROJECT_NAMESPACE stack-of-tasks)
+# Project properties
+SET(PROJECT_ORG stack-of-tasks)
 SET(PROJECT_NAME dynamic-graph-python)
 SET(PROJECT_DESCRIPTION "Dynamic graph library Python bindings")
-SET(PROJECT_URL "http://github.com/${PROJECT_NAMESPACE}/${PROJECT_NAME}")
+SET(PROJECT_URL "https://github.com/${PROJECT_ORG}/${PROJECT_NAME}")
 
+# Project options
+OPTION(SUFFIX_SO_VERSION "Suffix library name with its version" ON)
+
+# Project configuration
 SET(PROJECT_USE_CMAKE_EXPORT TRUE)
 SET(CUSTOM_HEADER_DIR "dynamic-graph/python")
 SET(CXX_DISABLE_WERROR TRUE)
 SET(DOXYGEN_USE_MATHJAX YES)
 
+# JRL-cmakemodule setup
 INCLUDE(cmake/base.cmake)
 INCLUDE(cmake/boost.cmake)
-INCLUDE(cmake/eigen.cmake)
 INCLUDE(cmake/python.cmake)
-INCLUDE(cmake/test.cmake)
 INCLUDE(cmake/sphinx.cmake)
 
-SET(PKG_CONFIG_ADDITIONAL_VARIABLES plugindir ${PKG_CONFIG_ADDITIONAL_VARIABLES})
-
-OPTION(SUFFIX_SO_VERSION
-  "Suffix shared library name by a string depending on git status of project"
-  ON)
-
+# Project definition
 COMPUTE_PROJECT_ARGS(PROJECT_ARGS LANGUAGES CXX)
 PROJECT(${PROJECT_NAME} ${PROJECT_ARGS})
 
+# Project dependencies
 FINDPYTHON()
-INCLUDE_DIRECTORIES(SYSTEM ${PYTHON_INCLUDE_DIRS})
 
-ADD_PROJECT_DEPENDENCY(Eigen3 REQUIRED PKG_CONFIG_REQUIRES eigen3)
 ADD_PROJECT_DEPENDENCY(dynamic-graph REQUIRED PKG_CONFIG_REQUIRES dynamic-graph)
-
-PKG_CONFIG_APPEND_LIBS("dynamic-graph-python")
-
 SET(BOOST_COMPONENTS filesystem system thread program_options unit_test_framework python)
 SEARCH_FOR_BOOST()
 
+
+# Main Library
+SET(${PROJECT_NAME}_HEADERS
+  include/${CUSTOM_HEADER_DIR}/api.hh
+  include/${CUSTOM_HEADER_DIR}/convert-dg-to-py.hh
+  include/${CUSTOM_HEADER_DIR}/dynamic-graph-py.hh
+  include/${CUSTOM_HEADER_DIR}/exception.hh
+  include/${CUSTOM_HEADER_DIR}/exception-python.hh
+  include/${CUSTOM_HEADER_DIR}/interpreter.hh
+  include/${CUSTOM_HEADER_DIR}/python-compat.hh
+  include/${CUSTOM_HEADER_DIR}/signal-wrapper.hh
+  )
+
+SET(${PROJECT_NAME}_SOURCES
+  src/interpreter.cc
+  src/dynamic_graph/python-compat.cc
+  )
+
+ADD_LIBRARY(${PROJECT_NAME} SHARED
+  ${${PROJECT_NAME}_SOURCES} ${${PROJECT_NAME}_HEADERS})
+TARGET_INCLUDE_DIRECTORIES(${PROJECT_NAME} SYSTEM PUBLIC ${PYTHON_INCLUDE_DIRS})
+TARGET_INCLUDE_DIRECTORIES(${PROJECT_NAME} PUBLIC $<INSTALL_INTERFACE:include>)
+TARGET_LINK_LIBRARIES(${PROJECT_NAME} ${Boost_LIBRARIES}
+  ${PYTHON_LIBRARY} ${Boost_PYTHON_LIBRARIES} dynamic-graph::dynamic-graph)
+
+IF(SUFFIX_SO_VERSION)
+  SET_TARGET_PROPERTIES(${PROJECT_NAME} PROPERTIES SOVERSION ${PROJECT_VERSION})
+ENDIF(SUFFIX_SO_VERSION)
+
+TARGET_COMPILE_DEFINITIONS(${PROJECT_NAME} PRIVATE PYTHON_LIBRARY="${PYTHON_LIBRARY}")
+
+INSTALL(TARGETS ${PROJECT_NAME} EXPORT ${TARGETS_EXPORT_NAME} DESTINATION lib)
+
 ADD_SUBDIRECTORY(src)
-ADD_SUBDIRECTORY(include/${CUSTOM_HEADER_DIR})
 ADD_SUBDIRECTORY(doc)
-ADD_SUBDIRECTORY(unitTesting)
+ADD_SUBDIRECTORY(tests)
 
+PKG_CONFIG_APPEND_LIBS(${PROJECT_NAME})
 INSTALL(FILES package.xml DESTINATION share/${PROJECT_NAME})

cmake

@@ -1,80 +1,21 @@
-# Copyright 2010-2020, Florent Lamiraux, Thomas Moulard, Olivier Stasse, Guilhem Saurel, JRL, CNRS/AIST, LAAS-CNRS
-
-#
-#
-#  Python interpreter
-#
-#
-
-SET(LIBRARY_NAME ${PROJECT_NAME})
-ADD_LIBRARY(${LIBRARY_NAME} SHARED interpreter.cc dynamic_graph/python-compat.cc)
-
-TARGET_INCLUDE_DIRECTORIES(${LIBRARY_NAME}
-  PUBLIC
-  $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}>
-  $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/src>
-  $<BUILD_INTERFACE:${CMAKE_CURRENT_BINARY_DIR}/../include>
-  $<BUILD_INTERFACE:${CMAKE_CURRENT_BINARY_DIR}/>
-  INTERFACE
-  $<INSTALL_INTERFACE:include>
-)
-
-TARGET_LINK_LIBRARIES(${LIBRARY_NAME} ${PYTHON_LIBRARY})
-
-IF(UNIX)
-  TARGET_LINK_LIBRARIES(${LIBRARY_NAME} ${Boost_LIBRARIES})
-  TARGET_LINK_LIBRARIES(${LIBRARY_NAME} ${Boost_PYTHON_LIBRARIES})
-  TARGET_LINK_LIBRARIES(${LIBRARY_NAME} ${CMAKE_DL_LIBS})
-ENDIF(UNIX)
-
-IF (SUFFIX_SO_VERSION)
-  SET_TARGET_PROPERTIES(${LIBRARY_NAME} PROPERTIES SOVERSION ${PROJECT_VERSION})
-ENDIF ()
-
-TARGET_LINK_LIBRARIES(${LIBRARY_NAME} dynamic-graph::dynamic-graph)
-
-INSTALL(TARGETS ${LIBRARY_NAME}
-  EXPORT ${TARGETS_EXPORT_NAME}
-  PUBLIC_HEADER
-  INCLUDES DESTINATION include
-  LIBRARY DESTINATION lib
-  ARCHIVE DESTINATION lib
-  )
-
-#
-#
 #  Python bindings
-#
-#
 
 ADD_SUBDIRECTORY(dynamic_graph)
 
-SET (PYTHON_SOURCES
-    __init__.py
-    attrpath.py
-    entity.py
-    signal_base.py
-    script_shortcuts.py
-    tools.py
-    )
+SET(PYTHON_SOURCES
+  __init__.py
+  attrpath.py
+  entity.py
+  signal_base.py
+  script_shortcuts.py
+  tools.py
+  )
 
-FOREACH (SOURCE ${PYTHON_SOURCES})
-    PYTHON_INSTALL_ON_SITE(dynamic_graph ${SOURCE})
-ENDFOREACH (SOURCE)
+FOREACH(source ${PYTHON_SOURCES})
+  PYTHON_INSTALL_ON_SITE(dynamic_graph ${source})
+ENDFOREACH(source)
 
 # --- ADD the wrap on the dg modules
-# Tracer plugin
-IF(WIN32)
-    SET(TRACER_PLUGIN ${DYNAMIC_GRAPH_PLUGINDIR}/tracer${CMAKE_STATIC_LIBRARY_SUFFIX})
-ELSE(WIN32)
-    SET(TRACER_PLUGIN ${DYNAMIC_GRAPH_PLUGINDIR}/tracer${CMAKE_SHARED_LIBRARY_SUFFIX})
-ENDIF(WIN32)
-DYNAMIC_GRAPH_PYTHON_MODULE("tracer" ${TRACER_PLUGIN} tracer-wrap)
-
-# TracerRealTime plugin
-IF(WIN32)
-    SET(TRACERREALTIME_PLUGIN ${DYNAMIC_GRAPH_PLUGINDIR}/tracer-real-time${CMAKE_STATIC_LIBRARY_SUFFIX})
-ELSE(WIN32)
-    SET(TRACERREALTIME_PLUGIN ${DYNAMIC_GRAPH_PLUGINDIR}/tracer-real-time${CMAKE_SHARED_LIBRARY_SUFFIX})
-ENDIF(WIN32)
-DYNAMIC_GRAPH_PYTHON_MODULE("tracer_real_time" ${TRACERREALTIME_PLUGIN} tracer_real_time-wrap)
+LINK_DIRECTORIES(${DYNAMIC_GRAPH_PLUGINDIR})
+DYNAMIC_GRAPH_PYTHON_MODULE("tracer" tracer tracer-wrap)
+DYNAMIC_GRAPH_PYTHON_MODULE("tracer_real_time" tracer-real-time tracer_real_time-wrap)

include/dynamic-graph/python/CMakeLists.txt

@@ -2,27 +2,26 @@
 
 SET(PYTHON_MODULE wrap)
 
-ADD_LIBRARY(${PYTHON_MODULE}
-    MODULE
-    convert-dg-to-py.cc
-    debug-py.cc
-    dynamic-graph-py.cc
-    entity-py.cc
-    exception-python.cc
-    factory-py.cc
-    pool-py.cc
-    python-compat.cc
-    signal-base-py.cc
-    signal-caster-py.cc
-    signal-wrapper.cc
-    )
+ADD_LIBRARY(${PYTHON_MODULE} MODULE
+  convert-dg-to-py.cc
+  debug-py.cc
+  dynamic-graph-py.cc
+  entity-py.cc
+  exception-python.cc
+  factory-py.cc
+  pool-py.cc
+  python-compat.cc
+  signal-base-py.cc
+  signal-caster-py.cc
+  signal-wrapper.cc
+  )
 
-TARGET_LINK_LIBRARIES(${PYTHON_MODULE} ${PYTHON_LIBRARY})
-TARGET_LINK_LIBRARIES(${PYTHON_MODULE} dynamic-graph::dynamic-graph)
+TARGET_INCLUDE_DIRECTORIES(${PYTHON_MODULE} SYSTEM PUBLIC ${PYTHON_INCLUDE_DIRS})
+TARGET_LINK_LIBRARIES(${PYTHON_MODULE} ${PYTHON_LIBRARY}
+  dynamic-graph::dynamic-graph)
 
 # Remove prefix lib
-SET_TARGET_PROPERTIES(${PYTHON_MODULE}
-    PROPERTIES PREFIX "")
+SET_TARGET_PROPERTIES(${PYTHON_MODULE} PROPERTIES PREFIX "")
 
 INSTALL(TARGETS ${PYTHON_MODULE}
   EXPORT ${TARGETS_EXPORT_NAME}

include/dynamic-graph/python/link-to-python.hh.in

@@ -1,10 +1,15 @@
 // -*- mode: c++ -*-
 // Copyright 2011, Florent Lamiraux, CNRS.
 
+#ifdef WIN32
+#include <Windows.h>
+#else
+#include <dlfcn.h>
+#endif
+
 #include <iostream>
 #include "dynamic-graph/debug.h"
 #include "dynamic-graph/python/interpreter.hh"
-#include "dynamic-graph/python/link-to-python.hh"
 
 std::ofstream dg_debugfile("/tmp/dynamic-graph-traces.txt", std::ios::trunc& std::ios::out);
 
@@ -61,7 +66,7 @@ Interpreter::Interpreter() {
   // load python dynamic library
   // this is silly, but required to be able to import dl module.
 #ifndef WIN32
-  dlopen(libpython.c_str(), RTLD_LAZY | RTLD_GLOBAL);
+  dlopen(PYTHON_LIBRARY, RTLD_LAZY | RTLD_GLOBAL);
 #endif
   Py_Initialize();
   PyEval_InitThreads();

src/CMakeLists.txt

@@ -0,0 +1,46 @@
+# Copyright 2010-2020, Florent Lamiraux, Thomas Moulard, Olivier Stasse, Guilhem Saurel, JRL, CNRS/AIST, LAAS-CNRS
+
+# Test the interpreter
+ADD_UNIT_TEST(interpreter-test interpreter-test.cc)
+TARGET_LINK_LIBRARIES(interpreter-test ${PROJECT_NAME})
+
+# Test runfile
+ADD_UNIT_TEST(interpreter-test-runfile interpreter-test-runfile.cc)
+TARGET_LINK_LIBRARIES(interpreter-test-runfile ${PYTHON_LIBRARY} ${Boost_LIBRARIES} ${PROJECT_NAME})
+TARGET_COMPILE_DEFINITIONS(interpreter-test-runfile PRIVATE PATH="${CMAKE_CURRENT_LIST_DIR}/")
+
+# Test the module generation
+## Create an entity
+
+SET(LIBRARY_NAME "custom_entity")
+ADD_LIBRARY(${LIBRARY_NAME} SHARED "${LIBRARY_NAME}.cpp")
+IF(SUFFIX_SO_VERSION)
+  SET_TARGET_PROPERTIES(${LIBRARY_NAME}
+    PROPERTIES SOVERSION ${PROJECT_VERSION})
+ENDIF(SUFFIX_SO_VERSION)
+
+target_link_libraries(${LIBRARY_NAME} dynamic-graph::dynamic-graph)
+
+## Create its bindings
+## This mimics DYNAMIC_GRAPH_PYTHON_MODULE(${LIBRARY_NAME} ${LIBRARY_NAME} "${LIBRARY_NAME}-wrap")
+
+CONFIGURE_FILE(
+  ${PROJECT_SOURCE_DIR}/cmake/dynamic_graph/submodule/__init__.py.cmake
+  ${CMAKE_CURRENT_BINARY_DIR}/${LIBRARY_NAME}/__init__.py
+  )
+SET(PYTHON_MODULE "${LIBRARY_NAME}-wrap")
+SET(SOURCE_PYTHON_MODULE "cmake/dynamic_graph/python-module-py.cc")
+ADD_LIBRARY(${PYTHON_MODULE} MODULE ${PROJECT_SOURCE_DIR}/${SOURCE_PYTHON_MODULE})
+SET_TARGET_PROPERTIES(${PYTHON_MODULE} PROPERTIES
+  PREFIX ""
+  OUTPUT_NAME ${LIBRARY_NAME}/wrap)
+
+TARGET_LINK_LIBRARIES(${PYTHON_MODULE} "-Wl,--no-as-needed")
+TARGET_LINK_LIBRARIES(${PYTHON_MODULE} ${LIBRARY_NAME} ${PYTHON_LIBRARY})
+TARGET_INCLUDE_DIRECTORIES(${PYTHON_MODULE} SYSTEM PUBLIC ${PYTHON_INCLUDE_DIRS})
+
+## Test it
+ADD_PYTHON_UNIT_TEST("test-custom-entity" "tests/test_custom_entity.py" src tests)
+
+# also test other bindings, using this custom entity
+ADD_PYTHON_UNIT_TEST("test-bindings" "tests/test_bindings.py" src tests)