Armor core libraries with symbol visibility

CMakeLists.txt

@@ -58,6 +58,7 @@ set(CTEST_TEST_TIMEOUT 90 CACHE STRING "Per-test timeout (s) for CTest")
 FetchContent_MakeAvailable(Catch2 GSL mimicpp)
 
 include(Modules/private/CreateCoverageTargets.cmake)
+include(Modules/private/PhlexSymbolVisibility.cmake)
 
 option(ENABLE_TSAN "Enable Thread Sanitizer" OFF)
 option(ENABLE_ASAN "Enable Address Sanitizer" OFF)

Modules/private/PhlexSymbolVisibility.cmake

@@ -0,0 +1,26 @@
+include(GenerateExportHeader)
+
+function(phlex_apply_symbol_visibility target)
+  set(EXPORT_HEADER "${PROJECT_BINARY_DIR}/include/${target}_export.hpp")
+  set(EXPORT_MACRO_NAME "${target}_EXPORT")
+
+  generate_export_header(
+    ${target}
+    BASE_NAME ${target}
+    EXPORT_FILE_NAME ${EXPORT_HEADER}
+    EXPORT_MACRO_NAME ${EXPORT_MACRO_NAME}
+    STATIC_DEFINE "${target}_STATIC_DEFINE"
+  )
+
+  set_target_properties(
+    ${target}
+    PROPERTIES CXX_VISIBILITY_PRESET hidden VISIBILITY_INLINES_HIDDEN ON
+  )
+
+  target_include_directories(
+    ${target}
+    PUBLIC $<BUILD_INTERFACE:${PROJECT_BINARY_DIR}/include> $<INSTALL_INTERFACE:include>
+  )
+
+  install(FILES "${EXPORT_HEADER}" DESTINATION include)
+endfunction()

phlex/CMakeLists.txt

@@ -33,6 +33,7 @@ cet_make_library(
   Boost::json
   phlex::core
 )
+phlex_apply_symbol_visibility(phlex_configuration_internal)
 
 cet_make_library(
   LIBRARY_NAME

phlex/app/CMakeLists.txt

@@ -16,6 +16,7 @@ cet_make_library(
   Boost::json
   Boost::boost
 )
+phlex_apply_symbol_visibility(run_phlex)
 
 install(FILES load_module.hpp run.hpp version.hpp DESTINATION include/phlex/app)
 

phlex/app/load_module.hpp

@@ -1,6 +1,8 @@
 #ifndef PHLEX_APP_LOAD_MODULE_HPP
 #define PHLEX_APP_LOAD_MODULE_HPP
 
+#include "run_phlex_export.hpp"
+
 #include "phlex/core/fwd.hpp"
 #include "phlex/driver.hpp"
 
@@ -12,12 +14,17 @@ namespace phlex::experimental {
   namespace detail {
     // Adjust_config adds the module_label as a parameter, and it checks if the 'py'
     // parameter exists, inserting the 'cpp: "pymodule"' configuration if necessary.
-    boost::json::object adjust_config(std::string const& label, boost::json::object raw_config);
+    run_phlex_EXPORT boost::json::object adjust_config(std::string const& label,
+                                                       boost::json::object raw_config);
   }
 
-  void load_module(framework_graph& g, std::string const& label, boost::json::object config);
-  void load_source(framework_graph& g, std::string const& label, boost::json::object config);
-  detail::next_index_t load_driver(boost::json::object const& config);
+  run_phlex_EXPORT void load_module(framework_graph& g,
+                                    std::string const& label,
+                                    boost::json::object config);
+  run_phlex_EXPORT void load_source(framework_graph& g,
+                                    std::string const& label,
+                                    boost::json::object config);
+  run_phlex_EXPORT detail::next_index_t load_driver(boost::json::object const& config);
 }
 
 #endif // PHLEX_APP_LOAD_MODULE_HPP

phlex/app/run.hpp

@@ -1,12 +1,14 @@
 #ifndef PHLEX_APP_RUN_HPP
 #define PHLEX_APP_RUN_HPP
 
+#include "run_phlex_export.hpp"
+
 #include "boost/json.hpp"
 
 #include <optional>
 
 namespace phlex::experimental {
-  void run(boost::json::object const& configurations, int max_parallelism);
+  run_phlex_EXPORT void run(boost::json::object const& configurations, int max_parallelism);
 }
 
 #endif // PHLEX_APP_RUN_HPP

phlex/app/version.hpp

@@ -1,7 +1,9 @@
 #ifndef PHLEX_APP_VERSION_HPP
 #define PHLEX_APP_VERSION_HPP
 
+#include "run_phlex_export.hpp"
+
 namespace phlex::experimental {
-  char const* version();
+  run_phlex_EXPORT char const* version();
 }
 #endif // PHLEX_APP_VERSION_HPP

phlex/concurrency.hpp

@@ -1,10 +1,12 @@
 #ifndef PHLEX_CONCURRENCY_HPP
 #define PHLEX_CONCURRENCY_HPP
 
+#include "phlex_core_export.hpp"
+
 #include <cstddef>
 
 namespace phlex {
-  struct concurrency {
+  struct phlex_core_EXPORT concurrency {
     static concurrency const unlimited;
     static concurrency const serial;
 

phlex/configuration.hpp

@@ -1,6 +1,8 @@
 #ifndef PHLEX_CONFIGURATION_HPP
 #define PHLEX_CONFIGURATION_HPP
 
+#include "phlex_configuration_internal_export.hpp"
+
 #include "boost/json.hpp"
 #include "phlex/core/product_query.hpp"
 #include "phlex/model/identifier.hpp"
@@ -22,8 +24,8 @@ namespace phlex {
     }
 
     // Used later for product_query
-    std::optional<phlex::experimental::identifier> value_if_exists(boost::json::object const& obj,
-                                                                   std::string_view parameter);
+    phlex_configuration_internal_EXPORT std::optional<phlex::experimental::identifier>
+    value_if_exists(boost::json::object const& obj, std::string_view parameter);
 
     // helper for unpacking json array
     template <typename T, std::size_t... I>
@@ -34,7 +36,7 @@ namespace phlex {
     }
   }
 
-  class configuration {
+  class phlex_configuration_internal_EXPORT configuration {
   public:
     configuration() = default;
     explicit configuration(boost::json::object const& config) : config_{config} {}
@@ -89,15 +91,15 @@ namespace phlex {
   // To enable direct conversions from Boost JSON types to our own types, we implement
   // tag_invoke(...) function overloads, which are the customization points Boost JSON
   // provides.
-  configuration tag_invoke(boost::json::value_to_tag<configuration> const&,
-                           boost::json::value const& jv);
+  phlex_configuration_internal_EXPORT configuration
+  tag_invoke(boost::json::value_to_tag<configuration> const&, boost::json::value const& jv);
 
-  product_query tag_invoke(boost::json::value_to_tag<product_query> const&,
-                           boost::json::value const& jv);
+  phlex_configuration_internal_EXPORT product_query
+  tag_invoke(boost::json::value_to_tag<product_query> const&, boost::json::value const& jv);
 
   namespace experimental {
-    identifier tag_invoke(boost::json::value_to_tag<identifier> const&,
-                          boost::json::value const& jv);
+    phlex_configuration_internal_EXPORT identifier
+    tag_invoke(boost::json::value_to_tag<identifier> const&, boost::json::value const& jv);
   }
 
   template <std::size_t N>

phlex/core/CMakeLists.txt

@@ -40,6 +40,7 @@ cet_make_library(
   Boost::json
   spdlog::spdlog
 )
+phlex_apply_symbol_visibility(phlex_core)
 install(
   FILES
     concepts.hpp

phlex/core/consumer.hpp

@@ -1,13 +1,15 @@
 #ifndef PHLEX_CORE_CONSUMER_HPP
 #define PHLEX_CORE_CONSUMER_HPP
 
+#include "phlex_core_export.hpp"
+
 #include "phlex/model/algorithm_name.hpp"
 
 #include <string>
 #include <vector>
 
 namespace phlex::experimental {
-  class consumer {
+  class phlex_core_EXPORT consumer {
   public:
     consumer(algorithm_name name, std::vector<std::string> predicates);
 

phlex/core/declared_fold.hpp

@@ -1,6 +1,8 @@
 #ifndef PHLEX_CORE_DECLARED_FOLD_HPP
 #define PHLEX_CORE_DECLARED_FOLD_HPP
 
+#include "phlex_core_export.hpp"
+
 #include "phlex/concurrency.hpp"
 #include "phlex/core/concepts.hpp"
 #include "phlex/core/fold/send.hpp"
@@ -34,7 +36,7 @@
 #include <utility>
 
 namespace phlex::experimental {
-  class declared_fold : public products_consumer {
+  class phlex_core_EXPORT declared_fold : public products_consumer {
   public:
     declared_fold(algorithm_name name,
                   std::vector<std::string> predicates,

phlex/core/declared_observer.hpp

@@ -1,6 +1,8 @@
 #ifndef PHLEX_CORE_DECLARED_OBSERVER_HPP
 #define PHLEX_CORE_DECLARED_OBSERVER_HPP
 
+#include "phlex_core_export.hpp"
+
 #include "phlex/core/concepts.hpp"
 #include "phlex/core/fwd.hpp"
 #include "phlex/core/input_arguments.hpp"
@@ -30,7 +32,7 @@
 
 namespace phlex::experimental {
 
-  class declared_observer : public products_consumer {
+  class phlex_core_EXPORT declared_observer : public products_consumer {
   public:
     declared_observer(algorithm_name name,
                       std::vector<std::string> predicates,

phlex/core/declared_output.hpp

@@ -1,6 +1,8 @@
 #ifndef PHLEX_CORE_DECLARED_OUTPUT_HPP
 #define PHLEX_CORE_DECLARED_OUTPUT_HPP
 
+#include "phlex_core_export.hpp"
+
 #include "phlex/core/consumer.hpp"
 #include "phlex/core/fwd.hpp"
 #include "phlex/core/message.hpp"
@@ -20,7 +22,7 @@ namespace phlex::experimental {
   namespace detail {
     using output_function_t = std::function<void(product_store const&)>;
   }
-  class declared_output : public consumer {
+  class phlex_core_EXPORT declared_output : public consumer {
   public:
     declared_output(algorithm_name name,
                     std::size_t concurrency,

phlex/core/declared_predicate.hpp

@@ -1,6 +1,8 @@
 #ifndef PHLEX_CORE_DECLARED_PREDICATE_HPP
 #define PHLEX_CORE_DECLARED_PREDICATE_HPP
 
+#include "phlex_core_export.hpp"
+
 #include "phlex/core/concepts.hpp"
 #include "phlex/core/detail/filter_impl.hpp"
 #include "phlex/core/fwd.hpp"
@@ -32,7 +34,7 @@
 
 namespace phlex::experimental {
 
-  class declared_predicate : public products_consumer {
+  class phlex_core_EXPORT declared_predicate : public products_consumer {
   public:
     declared_predicate(algorithm_name name,
                        std::vector<std::string> predicates,

phlex/core/declared_provider.hpp

@@ -1,6 +1,8 @@
 #ifndef PHLEX_CORE_DECLARED_PROVIDER_HPP
 #define PHLEX_CORE_DECLARED_PROVIDER_HPP
 
+#include "phlex_core_export.hpp"
+
 #include "phlex/core/concepts.hpp"
 #include "phlex/core/fwd.hpp"
 #include "phlex/core/message.hpp"
@@ -22,7 +24,7 @@
 
 namespace phlex::experimental {
 
-  class declared_provider {
+  class phlex_core_EXPORT declared_provider {
   public:
     declared_provider(algorithm_name name, product_query output_product);
     virtual ~declared_provider();

phlex/core/declared_transform.hpp

@@ -1,6 +1,8 @@
 #ifndef PHLEX_CORE_DECLARED_TRANSFORM_HPP
 #define PHLEX_CORE_DECLARED_TRANSFORM_HPP
 
+#include "phlex_core_export.hpp"
+
 // FIXME: Add comments explaining the process.  For each implementation, explain what part
 //        of the process a given section of code is addressing.
 
@@ -36,7 +38,7 @@
 
 namespace phlex::experimental {
 
-  class declared_transform : public products_consumer {
+  class phlex_core_EXPORT declared_transform : public products_consumer {
   public:
     declared_transform(algorithm_name name,
                        std::vector<std::string> predicates,

phlex/core/declared_unfold.hpp

@@ -1,6 +1,8 @@
 #ifndef PHLEX_CORE_DECLARED_UNFOLD_HPP
 #define PHLEX_CORE_DECLARED_UNFOLD_HPP
 
+#include "phlex_core_export.hpp"
+
 #include "phlex/core/concepts.hpp"
 #include "phlex/core/fwd.hpp"
 #include "phlex/core/input_arguments.hpp"
@@ -31,7 +33,7 @@
 
 namespace phlex::experimental {
 
-  class generator {
+  class phlex_core_EXPORT generator {
   public:
     explicit generator(product_store_const_ptr const& parent,
                        std::string node_name,
@@ -52,7 +54,7 @@ namespace phlex::experimental {
     std::map<data_cell_index::hash_type, std::size_t> child_counts_;
   };
 
-  class declared_unfold : public products_consumer {
+  class phlex_core_EXPORT declared_unfold : public products_consumer {
   public:
     declared_unfold(algorithm_name name,
                     std::vector<std::string> predicates,

phlex/core/detail/filter_impl.hpp

@@ -1,6 +1,8 @@
 #ifndef PHLEX_CORE_DETAIL_FILTER_IMPL_HPP
 #define PHLEX_CORE_DETAIL_FILTER_IMPL_HPP
 
+#include "phlex_core_export.hpp"
+
 #include "phlex/core/fwd.hpp"
 #include "phlex/core/product_query.hpp"
 #include "phlex/model/product_store.hpp"
@@ -29,7 +31,7 @@ namespace phlex::experimental {
     return value == true_value;
   }
 
-  class decision_map {
+  class phlex_core_EXPORT decision_map {
     using decisions_t = oneapi::tbb::concurrent_hash_map<std::size_t, unsigned int>;
 
   public:
@@ -47,7 +49,7 @@ namespace phlex::experimental {
     decisions_t results_;
   };
 
-  class data_map {
+  class phlex_core_EXPORT data_map {
     using stores_t =
       oneapi::tbb::concurrent_hash_map<std::size_t, std::vector<product_store_const_ptr>>;
 

phlex/core/detail/make_algorithm_name.hpp

@@ -4,6 +4,8 @@
 // This simple utility is placed in an implementation file to avoid including the
 // phlex/configuration.hpp in framework code.
 
+#include "phlex_core_export.hpp"
+
 #include <string>
 
 namespace phlex {
@@ -14,7 +16,8 @@ namespace phlex::experimental {
   class algorithm_name;
 
   namespace detail {
-    algorithm_name make_algorithm_name(configuration const* config, std::string name);
+    phlex_core_EXPORT algorithm_name make_algorithm_name(configuration const* config,
+                                                         std::string name);
   }
 }
 

phlex/core/detail/maybe_predicates.hpp

@@ -4,6 +4,8 @@
 // This simple utility is placed in an implementation file to avoid including the
 // phlex/configuration.hpp in framework code.
 
+#include "phlex_core_export.hpp"
+
 #include <optional>
 #include <string>
 #include <vector>
@@ -13,7 +15,8 @@ namespace phlex {
 }
 
 namespace phlex::experimental::detail {
-  std::optional<std::vector<std::string>> maybe_predicates(configuration const* config);
+  phlex_core_EXPORT std::optional<std::vector<std::string>> maybe_predicates(
+    configuration const* config);
 }
 
 #endif // PHLEX_CORE_DETAIL_MAYBE_PREDICATES_HPP