Fix visibility of symbols and RPATH

Author: robertodr

CHANGELOG.md

@@ -1,5 +1,30 @@
 # Change Log
 
+## [Unreleased]
+
+### Added
+
+- A new CMake module `options_wrappers.cmake` that adds new wrapper macros for
+  the CMake `option` command.
+
+### Fixed
+
+- Visibility of symbols in the shared library is _finally_ handled properly.
+  The necessary flags to the C++ compiler were not set for the subtargets built
+  as CMake `OBJECT` libraries. This results in a modest decrease in library
+  size.
+- `RPATH` handling for the standalone executable `run_pcm`.
+  For the executable in `<build_dir>/bin` the `RPATH` will contain
+  `<build_dir>/lib64` (or `<build_dir>/lib`) as path to `libpcm.so.1`.
+  For the executable in `<install_prefix>/bin` the `RPATH` will contain
+  `<install_prefix>/lib64` (or `<install_prefix>/lib`) as path to `libpcm.so.1`.
+
+### Changed
+
+- As a result of the visibility change, unit tests can only be linked against
+  the static library, since all symbols are always visible in a static archive
+  library.
+
 ## [Version 1.1.12] - 2018-01-20
 
 ### Added

CMakeLists.txt

@@ -1,5 +1,5 @@
 # This file is autogenerated by Autocmake v1.0.0-alpha-x http://autocmake.org
-# Copyright (c) 2015-2017 by Radovan Bast, Roberto Di Remigio, Jonas Juselius, and contributors.
+# Copyright (c) 2015-2018 by Radovan Bast, Roberto Di Remigio, Jonas Juselius, and contributors.
 
 # set minimum cmake version
 cmake_minimum_required(VERSION 2.8.10 FATAL_ERROR)
@@ -28,10 +28,9 @@ include(Fortran_C)
 include(CXXFlags)
 include(CFlags)
 include(FortranFlags)
+include(options_wrappers)
 include(autocmake_custom_color_messages)
-include(GNUdirs)
 include(autocmake_ccache)
-include(rpath)
 include(windows)
 include(autocmake_definitions)
 include(autocmake_code_coverage)

cmake/autocmake.yml

@@ -22,10 +22,9 @@ modules:
       - 'custom/compilers/FortranFlags.cmake'
   - plugins:
     - source:
+      - 'custom/options_wrappers.cmake'
       - '%(url_root)modules/custom_color_messages.cmake'
-      - 'custom/GNUdirs.cmake'
       - '%(url_root)modules/ccache.cmake'
-      - 'custom/rpath.cmake'
       - 'custom/windows.cmake'
       - '%(url_root)modules/definitions.cmake'
       - '%(url_root)modules/code_coverage.cmake'

cmake/custom/FindRT.cmake

@@ -0,0 +1,33 @@
+# Options handling utilities
+include(CMakeDependentOption)
+# Macro for printing an option in a consistent manner
+# Written by Lori A. Burns (@loriab) and Ryan M. Richard (@ryanmrichard)
+# Syntax: print_option(<option to print> <was specified>)
+macro(print_option variable default)
+  if(NOT DEFINED ${variable} OR "${${variable}}" STREQUAL "")
+    message(STATUS "Setting (unspecified) option ${variable}: ${default}")
+  else()
+    message(STATUS "Setting option ${variable}: ${${variable}}")
+  endif()
+endmacro()
+
+# Wraps an option with default ON/OFF. Adds nice messaging to option()
+# Written by Lori A. Burns (@loriab) and Ryan M. Richard (@ryanmrichard)
+# Syntax: option_with_print(<option name> <description> <default value>)
+macro(option_with_print variable msge default)
+  print_option(${variable} ${default})
+  option(${variable} ${msge} ${default})
+endmacro(option_with_print)
+
+# Wraps an option with a default other than ON/OFF and prints it
+# Written by Lori A. Burns (@loriab) and Ryan M. Richard (@ryanmrichard)
+# NOTE: Can\'t combine with above b/c CMake handles ON/OFF options specially
+# NOTE2: CMake variables are always defined so need to further check for if
+#       they are the NULL string. This is also why weneed the force
+# Syntax: option_with_default(<option name> <description> <default value>)
+macro(option_with_default variable msge default)
+  print_option(${variable} "${default}")
+  if(NOT DEFINED ${variable} OR "${${variable}}" STREQUAL "")
+    set(${variable} "${default}" CACHE STRING ${msge} FORCE)
+  endif()
+endmacro(option_with_default)

cmake/custom/GNUdirs.cmake

@@ -13,8 +13,11 @@ endif()
 set(BOOST_MINIMUM_REQUIRED 1.54.0)
 set(BOOST_COMPONENTS_REQUIRED "")
 
-set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/lib)
-set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/lib)
+include(GNUInstallDirs)
+
+set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/${CMAKE_INSTALL_LIBDIR})
+set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/${CMAKE_INSTALL_LIBDIR})
+set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/${CMAKE_INSTALL_BINDIR})
 
 include_directories(${PROJECT_SOURCE_DIR}/include)
 add_subdirectory(${PROJECT_SOURCE_DIR}/include)

cmake/custom/options_wrappers.cmake

@@ -1,6 +1,6 @@
 #.rst:
 #
-# Enables creation of static library.
+# Enables creation of static/shared library.
 # If the shared library is created, make it as static as possible.
 #
 # Variables modified (provided the corresponding language is enabled)::
@@ -15,6 +15,7 @@
 #   define: "'-DSTATIC_LIBRARY_ONLY={0}'.format(arguments['--static'])"
 
 option(STATIC_LIBRARY_ONLY "Create the static library only" OFF)
+option(SHARED_LIBRARY_ONLY "Create the shared library only" OFF)
 option(ENABLE_GENERIC "Enable mostly static linking in shared library" OFF)
 
 if(ENABLE_GENERIC)

cmake/custom/pcmsolver.cmake

@@ -1,4 +1,6 @@
-option(ENABLE_TESTS "Enable PCMSolver unit tests" ON)
+# Unit tests need to be linked to the static version of the library
+cmake_dependent_option(ENABLE_TESTS "Enable PCMSolver unit tests" ON
+                       "NOT SHARED_LIBRARY_ONLY" OFF)
 
 macro(add_Catch_test _name _labels)
   # _labels is not a list, it's a string... Transform it into a list
@@ -10,7 +12,7 @@ macro(add_Catch_test _name _labels)
   unset(_labels)
 
   add_test(NAME ${_name}
-           COMMAND ${PROJECT_BINARY_DIR}/tests/unit_tests [${_name}] --success --out ${PROJECT_BINARY_DIR}/tests/${_name}.log --durations yes
+           COMMAND unit_tests [${_name}] --success --out ${PROJECT_BINARY_DIR}/tests/${_name}.log --durations yes
            WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR})
 
   if(labels)