Merge pull request #2 from swig-fortran/ownership

Improve memory ownership mechanics

Author: sethrj

.travis.yml

@@ -19,6 +19,7 @@ matrix:
             packages:
             - gfortran
             - python3-sphinx
+            - valgrind
       - os: linux
         env: FLIBCPP_DEV=OFF GENERATOR=make
              FLIBCPP_FORTRAN_STD=f2008

CMakeLists.txt

@@ -12,11 +12,16 @@ project(Flibcpp VERSION 0.2.1 LANGUAGES CXX Fortran)
 # OPTIONS
 #---------------------------------------------------------------------------#
 
+if (FLIBCPP_DEV OR FLIBCPP_BUILD_EXAMPLES OR FLIBCPP_BUILD_TESTS)
+  set(_DEFAULT_BUILD_TESTING ON)
+endif()
+
 option(BUILD_SHARED_LIBS "Build shared libraries" ON)
+option(BUILD_TESTING "Enable CTest" ${_DEFAULT_BUILD_TESTING})
 option(FLIBCPP_DEV "Default to using development-centered options" OFF)
 option(FLIBCPP_BUILD_DOCS "Build documentation with Sphinx" ${FLIBCPP_DEV})
 option(FLIBCPP_BUILD_EXAMPLES "Build examples" ON)
-option(FLIBCPP_BUILD_TESTS "Build unit tests" ${FLIBCPP_DEV})
+option(FLIBCPP_BUILD_TESTS "Build Flibcpp tests" ${BUILD_TESTING})
 option(FLIBCPP_USE_SWIG "Regenerate source files using SWIG" ${FLIBCPP_DEV})
 
 #---------------------------------------------------------------------------#
@@ -37,7 +42,7 @@ set(FLIBCPP_FORTRAN_STD "f2003" CACHE STRING
    "Fortran standard for compiling generated code")
 
 #---------------------------------------------------------------------------#
-# SWIG setup
+# MODULES TO LOAD
 #---------------------------------------------------------------------------#
 
 if (FLIBCPP_USE_SWIG)
@@ -60,6 +65,9 @@ else()
   set(FLIBCPP_USE_SWIG FALSE)
 endif()
 
+# Enable testing based on BUILD_TESTING flag
+include(CTest)
+
 #---------------------------------------------------------------------------#
 # VERSIONING
 #---------------------------------------------------------------------------#
@@ -72,7 +80,7 @@ file(STRINGS "${CMAKE_CURRENT_SOURCE_DIR}/cmake/git-version.txt"
 if (NOT FLIBCPP_VERSION_STRING MATCHES "\\$Format:")
   # First line are decorators, second is hash
   list(GET FLIBCPP_VERSION_STRING 0 _tag)
-  string(REGEX REPLACE ".*, *(tag: *)?" "" _tag "${_tag}")
+  string(REGEX REPLACE "tag: *" "" _tag "${_tag}")
   list(GET FLIBCPP_VERSION_STRING 1 _hash)
   string(REGEX REPLACE " +" "" _hash "${_hash}")
   set(FLIBCPP_VERSION_STRING "${_tag}-g${_hash}")
@@ -249,10 +257,6 @@ install(FILES
 # TESTING AND DOCS
 #---------------------------------------------------------------------------#
 
-if (FLIBCPP_BUILD_TESTS OR FLIBCPP_BUILD_EXAMPLES)
-  enable_testing()
-endif()
-
 if (FLIBCPP_BUILD_TESTS)
   add_subdirectory(test)
 endif()

example/CMakeLists.txt

@@ -17,10 +17,12 @@ swig_fortran_add_example(sort
 swig_fortran_add_example(vecstr
   flc_string flc_vector)
 
-add_test(
-  NAME examples
-  COMMAND "${CMAKE_CURRENT_SOURCE_DIR}/run-examples.sh"
-  WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}")
+if (BUILD_TESTING)
+  add_test(
+    NAME examples
+    COMMAND "${CMAKE_CURRENT_SOURCE_DIR}/run-examples.sh"
+    WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}")
+endif()
 
 ##---------------------------------------------------------------------------##
 ## end of common/CMakeLists.txt

example/sort.f90

@@ -38,6 +38,12 @@ program sort_example
 
   ! Write output
   write(STDOUT, "(a, 4(f8.3,','))") "First few elements:", x(:min(4, size(x)))
+
+  call rng%release()
+
+  ! Valgrind fails without deallocating the array, but technically it's not
+  ! necessary in Fortran to do this
+  deallocate(x)
 contains
 
 ! Loop until the user inputs a positive integer. Catch error conditions. 

example/vecstr.f90

@@ -27,6 +27,7 @@ program vecstr_example
 
   if (vec%empty()) then
     write(STDOUT, *) "No vectors provided"
+    call vec%release()
     stop 0
   endif
 

include/flc.i

@@ -7,6 +7,10 @@
 
 %module "flc"
 
+#if defined(SWIGIMPORTED) && !defined(SWIGIMPORTED)
+#error "To import the FLC module correctly, use ``%include \"import_flc.i\"``"
+#endif
+
 %define %flc_add_header
 %insert("fbegin") %{
 ! Flibcpp project, https://github.com/swig-fortran/flibcpp
@@ -79,7 +83,7 @@ using std::size_t;
  * Linked into auto-generated file flibcpp_version.cpp
  ************************/
 
-%apply const char* { const char flibcpp_version[] };
+%apply char* { const char flibcpp_version[] };
 %fortranbindc flibcpp_version_major;
 %fortranbindc flibcpp_version_minor;
 %fortranbindc flibcpp_version_patch;

include/flc_random.i

@@ -27,6 +27,7 @@
 #endif
 
 %rename(Engine) std::SWIG_MERSENNE_TWISTER;
+%fortran_autofree_rvalue(std::SWIG_MERSENNE_TWISTER);
 
 namespace std {
 class SWIG_MERSENNE_TWISTER
@@ -35,9 +36,9 @@ class SWIG_MERSENNE_TWISTER
     typedef SWIG_MERSENNE_RESULT_TYPE result_type;
 
     SWIG_MERSENNE_TWISTER();
-    explicit SWIG_MERSENNE_TWISTER(result_type);
-    void seed(result_type);
-    void discard(unsigned long long);
+    explicit SWIG_MERSENNE_TWISTER(result_type seed_value);
+    void seed(result_type seed_value);
+    void discard(unsigned long long count);
 };
 } // namespace std
 

include/flc_string.i

@@ -22,6 +22,9 @@
   $result = ($1 == std::string::npos ? 0 : $1 + 1);
 }
 
+// Automatically free temporary strings as appropriate
+%fortran_autofree_rvalue(std::string);
+
 namespace std {
 class string {
   public:

include/flc_vector.i

@@ -51,6 +51,9 @@
 %define %specialize_std_vector_pod(T)
 namespace std {
   template<> class vector<T> {
+    // Automatically free temporary vectors as appropriate
+    %fortran_autofree_rvalue(std::vector<T>);
+
     SWIG_STD_VECTOR_COMMON(T, const T&)
     SWIG_STD_VECTOR_REF(T)
     %extend {
@@ -72,6 +75,7 @@ namespace std {
 
 /* ------------------------------------------------------------------------- */
 
+%fortran_autofree_rvalue(std::vector<std::string>);
 %extend std::vector<std::string> {
   void set_ref(size_type index, std::string& str) {
     SWIG_check_range(index, $self->size(),

include/import_flc.i

@@ -5,8 +5,10 @@
  * Distributed under an MIT open source license: see LICENSE for details.
  */
 
-#ifdef SWIGIMPORTED
-#error "To use this header, %include "import_flc.i", don't %import it"
+// Make sure that the downstream module isn't doing ``%import "import_flc.i"``
+// or ``%import "flc.i"``: only ``%include "import_flc.i"``
+#ifndef SWIGIMPORTED
+#define FLC_SWIGIMPORTED
 #endif
 
 // Set up macros, etc.

scripts/travis/test.sh

@@ -3,7 +3,12 @@
 # File  : scripts/travis/test.sh
 ###############################################################################
 
-cd ${BUILD_ROOT} && ctest --output-on-failure
+cd ${BUILD_ROOT}
+
+ctest --output-on-failure
+if [ "${FLIBCPP_DEV}" = "ON" ]; then
+  ctest -E examples -D ExperimentalMemCheck --output-on-failure
+fi
 
 ###############################################################################
 # end of scripts/travis/test.sh

src/flc.f90

@@ -71,7 +71,7 @@ function swigc_flibcpp_version_get() &
 contains
  ! MODULE SUBPROGRAMS
 
-subroutine SWIGTM_fout_const_SS_char_Sm_(imout, fout)
+subroutine SWIGTM_fout_char_Sm_(imout, fout)
   use, intrinsic :: ISO_C_BINDING
   type(SwigArrayWrapper), intent(in) :: imout
   character(kind=C_CHAR, len=:), allocatable, intent(out) :: fout
@@ -91,7 +91,7 @@ function get_serr() &
 type(SwigArrayWrapper) :: fresult 
 
 fresult = swigc_get_serr()
-call SWIGTM_fout_const_SS_char_Sm_(fresult, swig_result)
+call SWIGTM_fout_char_Sm_(fresult, swig_result)
 if (.false.) call SWIG_free(fresult%data)
 end function
 
@@ -102,7 +102,7 @@ function get_flibcpp_version() &
 type(SwigArrayWrapper) :: fresult 
 
 fresult = swigc_flibcpp_version_get()
-call SWIGTM_fout_const_SS_char_Sm_(fresult, swig_result)
+call SWIGTM_fout_char_Sm_(fresult, swig_result)
 if (.false.) call SWIG_free(fresult%data)
 end function
 

src/flcFORTRAN_wrap.cxx

@@ -345,7 +345,7 @@ SWIGEXPORT SwigArrayWrapper _wrap_get_serr() {
   char *result = 0 ;
 
   result = (char *)flc_get_serr();
-  fresult.size = strlen(reinterpret_cast< const char* >(result));
+  fresult.size = strlen((char*)(result));
   fresult.data = const_cast< char * >(result);
   return fresult;
 }
@@ -356,7 +356,7 @@ SWIGEXPORT SwigArrayWrapper _wrap_flibcpp_version_get() {
   char *result = 0 ;
 
   result = (char *)(char *)flibcpp_version;
-  fresult.size = strlen(reinterpret_cast< const char* >(result));
+  fresult.size = strlen((char*)(result));
   fresult.data = const_cast< char * >(result);
   return fresult;
 }