SWIG: Moved common SWIG syntax to ${libname}.i

This commit moves common SWIG syntax to a ${libname}.i for sensor libraries. Much of the swig content was originally duplicated for each wrapper language which has lead to inconsistencies between wrappers over time. This commit moves all swig syntax to a common file. Language specific swig syntax can be added with #ifdef SWIG<LANGUAGE>. The src/CMakeLists.txt will look first for a language-specific .i file, then fall back to ${libname}.i. In this way, it's possible to override the common ${libname}.i file. If a fallback .i file does NOT exist, UPM CMake will generate a simple interface file for all languages. Example: If no src/abp/pyupm_abp.i and no src/abp/abp.i then generate ${CMAKE_CURRENT_BINARY_DIR}/abp.i When src/CMakeLists.txt uses a common ${libname}.i, it adds a -module <language>upm_${libname} to the swig command line. In the example below, a -module argument is provided for both Java and Javascript, while the python module takes all syntax from pyupm_abp.i. SWIG FILE Language CMake added SWIG args --------------- ---------- --------------------- src/abp/abp.i java -module javaupm_abp src/abp/abp.i javascript -module jsupm_abp src/abp/pyupm_abp.i python This commit removes ~4500 redundant lines for the UPM repository and helps promote uniformity for the SWIG'ed languages. Signed-off-by: Noel Eck <noel.eck@intel.com>

Author: noel-eck

docs/creating_java_bindings.md

@@ -259,7 +259,7 @@ We extend the sensor class with another method, _installISR\(jobject runnable\)_
 
 Java callbacks are added at the SWIG interface level. For ease-of-use, a collection of macros are available in src/_upm.i.
 
-src/a110x/javaupm_a110x.i:
+src/a110x/a110x.i:
 ```c++
 JAVA_ADD_INSTALLISR(upm::A110X)
 ```

docs/max31855.md

@@ -14,8 +14,7 @@ First thing to do is to create a tree structure like this in upm/src/max31855:
 
 * max31855.cxx
 * max31855.hpp
-* jsupm_max31855.i
-* pyupm_max31855.i
+* max31855.i
 * CMakeLists.txt
 
 And then an example file to use & test our lib with in upm/examples/max31855.cxx.

scripts/build-android.sh

@@ -66,7 +66,7 @@ cmake \
 make -j8 -Cbuild
 
 # Anotate the .java src from doxygen
-find src/ -name "javaupm_*.i" > build/upm.i.list
+find src/ -name "*.i" > build/upm.i.list
 #../doxy/doxyport build/upm.i.list \
 # -s src/interfaces/,src/bacnetmstp,src/bmg160,src/bma250e,src/bmm150 \
 # -m doxy/samples.mapping.txt \

scripts/build-doc.sh

@@ -22,10 +22,10 @@ mkdir -p ${BUILD_LOGS_DIR}
 cd ${ROOT_DIR} && make -j8 -Cbuild 2> ${BUILD_LOGS_DIR}/build-doc.log
 
 # Make Java Documentation
-cd ${BUILD_DIR} && find ../src/ -name "javaupm_*.i" > upm.i.list && \
+cd ${BUILD_DIR} && find ../src/ -name "*.i" > upm.i.list && \
 ../doxy/doxyport/doxyport upm.i.list \
  --cmake ./compile_commands.json \
- --source ../src/interfaces/,../src/bacnetmstp \
+ --source ../src/interfaces/,../src/bacnetmstp,src \
  --destination src/ \
  --convert-protected-to-private \
  --output upm-java-files.txt \

src/CMakeLists.txt

@@ -228,18 +228,63 @@ function (_get_target_dependency_interface_include_dirs target varIncludeDirs)
  set(${varIncludeDirs} "${${varIncludeDirs}}" PARENT_SCOPE)
 endfunction (_get_target_dependency_interface_include_dirs target varIncludeDirs)
 
+# This function decides which swig interface file to use for the
+# CMAKE_CURRENT_SOURCE_DIR. If no .i file exists, create one.
+#
+# if ${filePrefix}_${libname}.i exists
+# return its full path
+# elif ${libname}.i exists
+# return its full path
+# else
+# create ${libname}.i via template and return its full path
+#
+function (_get_current_dot_i_file filePrefix varDotIFile)
+ set(${varDotIFile} "${CMAKE_CURRENT_SOURCE_DIR}/${libname}.i")
+ if (EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/${filePrefix}_${libname}.i")
+ set(${varDotIFile} "${CMAKE_CURRENT_SOURCE_DIR}/${filePrefix}_${libname}.i")
+ endif()
+ # If a SWIG .i file DOES NOT exist, make a simple one from the template
+ if (NOT EXISTS "${${varDotIFile}}")
+ # This file will exist OUTSIDE the source tree
+ set(${varDotIFile} "${CMAKE_CURRENT_BINARY_DIR}/${libname}.i")
+
+ # First, create the include variables
+ set(SWIG_HASH_INCLUDES)
+ foreach (_hpp ${module_hpp})
+ set(SWIG_HASH_INCLUDES "#include \"${_hpp}\"")
+ endforeach()
+ string(REPLACE "#" "%" SWIG_PERCENT_INCLUDES "${SWIG_HASH_INCLUDES}")
+
+ # Write the interface file
+ configure_file (${PROJECT_SOURCE_DIR}/src/swigme.i.in "${${varDotIFile}}" @ONLY)
+ endif()
+
+ set(${varDotIFile} "${${varDotIFile}}" PARENT_SCOPE)
+endfunction()
+
 # Create a single swig target for python
+# This is a macro since the function which calls it (upm_swig_python) depends
+# on values set inside this macro
 macro(_upm_swig_python)
  # Transitive headers don't appear to get picked up by swig_add_module call for
  # wrapper generation. Get them manually and add them here.
  _get_target_dependency_interface_include_dirs(${libname} DEPEND_DIRS)
 
- include_directories (${CMAKE_CURRENT_SOURCE_DIR}/..
+ include_directories (${CMAKE_CURRENT_SOURCE_DIR}
  ${CMAKE_CURRENT_BINARY_DIR}/..
  ${DEPEND_DIRS})
 
- set_source_files_properties (pyupm_${libname}.i PROPERTIES CPLUSPLUS ON)
- set_source_files_properties (pyupm_${libname}.i PROPERTIES SWIG_FLAGS "-I${CMAKE_CURRENT_BINARY_DIR}/..")
+ # Decide between ${libname}.i or a language-specific .i
+ _get_current_dot_i_file(pyupm SWIG_CURRENT_DOT_I_FILE)
+ # If this module is using ${libname}.i, provide a module name for UseSWIG AND SWIG_FLAGS
+ if (${SWIG_CURRENT_DOT_I_FILE} MATCHES ${libname}.i)
+ set_source_files_properties(${SWIG_CURRENT_DOT_I_FILE} PROPERTIES
+ SWIG_MODULE_NAME pyupm_${libname}
+ SWIG_FLAGS ";-module;pyupm_${libname};")
+ endif()
+
+ # Tell UseSWIG that this is CXX
+ set_property(SOURCE ${SWIG_CURRENT_DOT_I_FILE} PROPERTY CPLUSPLUS ON)
 
  # Set current python binary dir
  set (CMAKE_CURRENT_PYTHON_BINARY_DIR
@@ -255,9 +300,9 @@ macro(_upm_swig_python)
  # Swig module name (example: pyupm_a110x-python2)
  set (python_wrapper_name pyupm_${libname}-python${PYTHON_VERSION_MAJOR})
  if (CMAKE_VERSION VERSION_LESS "3.8")
- swig_add_module (${python_wrapper_name} python pyupm_${libname}.i)
+  swig_add_module (${python_wrapper_name} python ${SWIG_CURRENT_DOT_I_FILE})
  else ()
- swig_add_library (${python_wrapper_name} LANGUAGE python SOURCES pyupm_${libname}.i)
+  swig_add_library (${python_wrapper_name} LANGUAGE python SOURCES ${SWIG_CURRENT_DOT_I_FILE})
  endif ()
  # Get target library name (example _pyupm_a110x-python2)
  set (python_wrapper_target ${SWIG_MODULE_${python_wrapper_name}_REAL_NAME})
@@ -361,16 +406,29 @@ function(upm_swig_node)
  # wrapper generation. Get them manually and add them here.
  _get_target_dependency_interface_include_dirs(${libname} DEPEND_DIRS)
 
- include_directories (${CMAKE_CURRENT_SOURCE_DIR}/..
+ include_directories (${CMAKE_CURRENT_SOURCE_DIR}
  ${CMAKE_CURRENT_BINARY_DIR}/..
  ${DEPEND_DIRS})
 
- set_property (SOURCE jsupm_${libname}.i PROPERTY SWIG_FLAGS "-node" "-DV8_VERSION=${V8_VERSION_HEX}")
- set_source_files_properties (jsupm_${libname}.i PROPERTIES CPLUSPLUS ON)
+ # Decide between ${libname}.i or a language-specific .i
+ _get_current_dot_i_file(jsupm SWIG_CURRENT_DOT_I_FILE)
+ # If this module is using ${libname}.i, provide a module name for UseSWIG AND SWIG_FLAGS
+ if (${SWIG_CURRENT_DOT_I_FILE} MATCHES ${libname}.i)
+ set_source_files_properties(${SWIG_CURRENT_DOT_I_FILE} PROPERTIES
+ SWIG_MODULE_NAME jsupm_${libname}
+ SWIG_FLAGS ";-module;jsupm_${libname};")
+ endif()
+
+ # Tell UseSWIG that this is CXX
+ set_property(SOURCE ${SWIG_CURRENT_DOT_I_FILE} PROPERTY CPLUSPLUS ON)
+ # Append additional flags for NodeJS
+ set_property(SOURCE ${SWIG_CURRENT_DOT_I_FILE} APPEND PROPERTY
+ SWIG_FLAGS ";-node;-DV8_VERSION=${V8_VERSION_HEX}")
+
  if (CMAKE_VERSION VERSION_LESS "3.8")
- swig_add_module (jsupm_${libname} javascript jsupm_${libname}.i)
+ swig_add_module (jsupm_${libname} javascript ${SWIG_CURRENT_DOT_I_FILE})
  else ()
- swig_add_library (jsupm_${libname} LANGUAGE javascript SOURCES jsupm_${libname}.i)
+ swig_add_library (jsupm_${libname} LANGUAGE javascript SOURCES ${SWIG_CURRENT_DOT_I_FILE})
  endif ()
  add_dependencies(jsupm_${libname} ${libname})
  swig_link_libraries (jsupm_${libname} ${NODE_LIBRARIES} ${libname})
@@ -427,20 +485,33 @@ function(upm_swig_java)
  # wrapper generation. Get them manually and add them here.
  _get_target_dependency_interface_include_dirs(${libname} DEPEND_DIRS)
 
- include_directories (
- ${JAVA_INCLUDE_PATH}
- ${JAVA_INCLUDE_PATH2}
- ${CMAKE_CURRENT_BINARY_DIR}/..
- ${CMAKE_CURRENT_BINARY_DIR}/..
- ${DEPEND_DIRS}
- )
+ include_directories (${JAVA_INCLUDE_PATH}
+ ${JAVA_INCLUDE_PATH2}
+ ${CMAKE_CURRENT_SOURCE_DIR}
+ ${CMAKE_CURRENT_BINARY_DIR}/..
+ ${DEPEND_DIRS})
+
+ # Decide between ${libname}.i or a language-specific .i
+ _get_current_dot_i_file(javaupm SWIG_CURRENT_DOT_I_FILE)
+ # If this module is using ${libname}.i, provide a module name for UseSWIG AND SWIG_FLAGS
+ if (${SWIG_CURRENT_DOT_I_FILE} MATCHES ${libname}.i)
+ set_source_files_properties(${SWIG_CURRENT_DOT_I_FILE} PROPERTIES
+ SWIG_MODULE_NAME javaupm_${libname}
+ SWIG_FLAGS ";-module;javaupm_${libname};")
+ endif()
+
+ # Tell UseSWIG that this is CXX
+ set_property(SOURCE ${SWIG_CURRENT_DOT_I_FILE} PROPERTY CPLUSPLUS ON)
+
+ # Set a -package as well (which is slightly different than the module name,
+ # module: javaupm_a110x vs package: upm_a110x
+ set_property(SOURCE ${SWIG_CURRENT_DOT_I_FILE} APPEND PROPERTY
+ SWIG_FLAGS ";-package;upm_${libname}")
 
- set_source_files_properties (javaupm_${libname}.i PROPERTIES CPLUSPLUS ON)
- set_source_files_properties (javaupm_${libname}.i PROPERTIES SWIG_FLAGS ";-package;upm_${libname};-I${CMAKE_BINARY_DIR}/src")
  if (CMAKE_VERSION VERSION_LESS "3.8")
- swig_add_module (javaupm_${libname} java javaupm_${libname}.i)
+ swig_add_module (javaupm_${libname} java ${SWIG_CURRENT_DOT_I_FILE})
  else ()
- swig_add_library (javaupm_${libname} LANGUAGE java SOURCES javaupm_${libname}.i)
+ swig_add_library (javaupm_${libname} LANGUAGE java SOURCES ${SWIG_CURRENT_DOT_I_FILE})
  endif ()
 
  # If the C++ target depends on C++ interfaces, make the JAVA target

src/_upm.i

@@ -1,7 +1,7 @@
 /*
  * This file provides additional non-wrapper code functionality for use
  * throughout the UPM repository. This file is intended to be %imported
- * from the top-level upm.i (not directly by UPM libraries).
+ * from the top-level common_top.i (not directly by UPM libraries).
  *
  * No wrapper code will be generated from importing this .i file.
  */

src/a110x/a110x.i

@@ -0,0 +1,18 @@
+%include "../common_top.i"
+
+/* BEGIN Java syntax ------------------------------------------------------- */
+#ifdef SWIGJAVA
+/* Macro for loading javaupm_a110x */
+JAVA_JNI_LOADLIBRARY(javaupm_a110x)
+
+/* Macro adding an installisr call w/JAVA runnable to A110X */
+JAVA_ADD_INSTALLISR(upm::A110X)
+#endif
+/* END Java syntax */
+
+/* BEGIN Common SWIG syntax ------------------------------------------------- */
+%{
+#include "a110x.hpp"
+%}
+%include "a110x.hpp"
+/* END Common SWIG syntax */