Remove class Status from exception handler. (#4393)

* Switch from inheritance to templates for the error tree visitor. Converted old visitor base class into a concept.

* Adjusted C API build to take into account that the exception handler is no longer header-only.

* More build adjustments

* Attempt to remove a duplicate symbol linkage causing CI fail

Author: eric-hughes-tiledb

CMakeLists.txt

@@ -569,15 +569,13 @@ if (TILEDB_TESTS)
   # C API support
   add_dependencies(tests unit_capi_handle unit_capi_exception_wrapper)
   # C API basics
-  add_dependencies(tests unit_capi_error unit_capi_config unit_capi_context)
+  add_dependencies(tests unit_capi_config unit_capi_context)
   add_dependencies(tests unit_capi_array)
   add_dependencies(tests unit_capi_buffer)
   add_dependencies(tests unit_capi_buffer_list)
   add_dependencies(tests unit_capi_data_order)
   add_dependencies(tests unit_capi_datatype)
   add_dependencies(tests unit_capi_filesystem)
-  add_dependencies(tests unit_capi_object_type)
-  add_dependencies(tests unit_capi_object_walk_order)
   add_dependencies(tests unit_capi_query_type)
   add_dependencies(tests unit_capi_vfs)
   # C API array schema

tiledb/api/c_api/context/context_api.cc

@@ -1,5 +1,5 @@
 /**
- * @file tiledb/api/c_api/error/context_api.cc
+ * @file tiledb/api/c_api/context/context_api.cc
  *
  * @section LICENSE
  *

tiledb/api/c_api/context/context_api_internal.h

@@ -88,7 +88,7 @@ bool save_error(tiledb_ctx_handle_t* ctx, const tiledb::common::Status& st);
  * @tparam E Exception type to throw if context is not valid
  * @param ctx A context of unknown validity
  */
-template <class E = CAPIStatusException>
+template <class E = CAPIException>
 inline void ensure_context_is_valid(const tiledb_ctx_handle_t* ctx) {
   ensure_handle_is_valid<tiledb_ctx_handle_t, E>(ctx);
 }

tiledb/api/c_api/data_order/CMakeLists.txt

@@ -25,26 +25,17 @@
 #
 
 include(common NO_POLICY_SCOPE)
+include(object_library)
 
 list(APPEND SOURCES
   data_order_api.cc
 )
 gather_sources(${SOURCES})
 
-#
-# Object library for other units to depend upon
-#
-add_library(capi_data_order OBJECT ${SOURCES})
-target_link_libraries(capi_data_order PUBLIC export)
-target_link_libraries(capi_data_order PUBLIC baseline $<TARGET_OBJECTS:baseline>)
-target_link_libraries(capi_data_order PUBLIC constants $<TARGET_OBJECTS:constants>)
-
-#
-# Test-compile of object library ensures link-completeness
-#
-add_executable(compile_capi_data_order EXCLUDE_FROM_ALL)
-target_sources(compile_capi_data_order PRIVATE test/compile_capi_data_order_main.cc)
-target_link_libraries(compile_capi_data_order PRIVATE capi_data_order)
-add_dependencies(all_link_complete compile_capi_data_order)
+commence(object_library capi_data_order)
+  this_target_sources(${SOURCES})
+  this_target_link_libraries(export)
+  this_target_object_libraries(baseline constants exception_wrapper)
+conclude(object_library)
 
 add_test_subdirectory()

tiledb/api/c_api/datatype/CMakeLists.txt

@@ -23,28 +23,18 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 #
-
 include(common NO_POLICY_SCOPE)
+include(object_library)
 
 list(APPEND SOURCES
-  datatype_api.cc
+    datatype_api.cc
 )
 gather_sources(${SOURCES})
 
-#
-# Object library for other units to depend upon
-#
-add_library(capi_datatype OBJECT ${SOURCES})
-target_link_libraries(capi_datatype PUBLIC export)
-target_link_libraries(capi_datatype PUBLIC baseline $<TARGET_OBJECTS:baseline>)
-target_link_libraries(capi_datatype PUBLIC constants $<TARGET_OBJECTS:constants>)
-
-#
-# Test-compile of object library ensures link-completeness
-#
-add_executable(compile_capi_datatype EXCLUDE_FROM_ALL)
-target_sources(compile_capi_datatype PRIVATE test/compile_capi_datatype_main.cc)
-target_link_libraries(compile_capi_datatype PRIVATE capi_datatype)
-add_dependencies(all_link_complete compile_capi_datatype)
+commence(object_library capi_datatype)
+  this_target_sources(${SOURCES})
+  this_target_link_libraries(export)
+  this_target_object_libraries(baseline constants capi_enumeration_stub)
+conclude(object_library)
 
 add_test_subdirectory()

tiledb/api/c_api/error/CMakeLists.txt

@@ -25,25 +25,17 @@
 #
 
 include(common NO_POLICY_SCOPE)
+include(object_library)
 
 list(APPEND SOURCES
     error_api.cc
 )
 gather_sources(${SOURCES})
 
-#
-# Object library uses `StorageManagerStub` to support API wrappers
-#
-add_library(capi_error OBJECT ${SOURCES})
-target_link_libraries(capi_error PUBLIC export)
-target_link_libraries(capi_error PUBLIC baseline $<TARGET_OBJECTS:baseline>)
-
-#
-# Test-compile of object library ensures link-completeness
-#
-add_executable(compile_capi_error EXCLUDE_FROM_ALL)
-target_link_libraries(compile_capi_error PRIVATE capi_error)
-target_sources(compile_capi_error PRIVATE test/compile_capi_error_main.cc)
-add_dependencies(all_link_complete compile_capi_error)
+commence(object_library capi_error)
+  this_target_sources(${SOURCES})
+  this_target_link_libraries(export)
+  this_target_object_libraries(baseline exception_wrapper)
+conclude(object_library)
 
 add_test_subdirectory()

tiledb/api/c_api/error/error_api.cc

@@ -36,14 +36,6 @@
 
 namespace tiledb::api {
 
-bool create_error(tiledb_error_handle_t** error, const Status& st) {
-  if (st.ok()) {
-    return false;
-  }
-  *error = tiledb_error_handle_t::make_handle(st.to_string());
-  return true;
-}
-
 void create_error(tiledb_error_handle_t** error, const std::string& message) {
   *error = tiledb_error_handle_t::make_handle(message);
 }

tiledb/api/c_api/error/error_api_internal.h

@@ -72,28 +72,6 @@ struct tiledb_error_handle_t
 };
 
 namespace tiledb::api {
-/**
- * Conditionally create a C API error object based on a `Status`.
- *
- * The error object in the C API, unlike almost every other, is created outside
- * a `tiledb_*_alloc` function. This function is the one that creates such
- * objects for other functions that can return errors.
- *
- * Note that this function can throw, since it allocates to create an error
- * handle. In that case the argument error is ignored and superseded by an
- * out-of-memory exception, which the C API wrapper will process.
- *
- * @pre `error != nullptr`. Error arguments must always be validated, because
- * on error they're assigned an error handle and on success they're assigned
- * `nullptr`.
- *
- * @param error A non-null pointer to `tiledb_error_t *` object
- * @param st A status that might contain an error
- * @return true if `st` contained an error, false if it did not
- */
-bool create_error(
-    tiledb_error_handle_t** error, const tiledb::common::Status& st);
-
 /*
  * Create a C API error object with a given string.
  *

tiledb/api/c_api/error/test/CMakeLists.txt

@@ -23,21 +23,9 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 #
+include(unit_test)
 
-add_executable(unit_capi_error EXCLUDE_FROM_ALL)
-find_package(Catch_EP REQUIRED)
-target_link_libraries(unit_capi_error PUBLIC Catch2::Catch2WithMain)
-
-# Sources for code under test
-target_link_libraries(unit_capi_error PUBLIC capi_error)
-
-# Sources for tests
-target_sources(unit_capi_error PUBLIC
-    unit_capi_error.cc
-    )
-
-add_test(
-    NAME "unit_capi_error"
-    COMMAND $<TARGET_FILE:unit_capi_error>
-    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-)
+commence(unit_test capi_error)
+  this_target_sources(unit_capi_error.cc)
+  this_target_object_libraries(capi_error)
+conclude(unit_test)

tiledb/api/c_api/filesystem/CMakeLists.txt

@@ -25,26 +25,17 @@
 #
 
 include(common NO_POLICY_SCOPE)
+include(object_library)
 
 list(APPEND SOURCES
   filesystem_api.cc
 )
 gather_sources(${SOURCES})
 
-#
-# Object library for other units to depend upon
-#
-add_library(capi_filesystem OBJECT ${SOURCES})
-target_link_libraries(capi_filesystem PUBLIC export)
-target_link_libraries(capi_filesystem PUBLIC baseline $<TARGET_OBJECTS:baseline>)
-target_link_libraries(capi_filesystem PUBLIC constants $<TARGET_OBJECTS:constants>)
-
-#
-# Test-compile of object library ensures link-completeness
-#
-add_executable(compile_capi_filesystem EXCLUDE_FROM_ALL)
-target_sources(compile_capi_filesystem PRIVATE test/compile_capi_filesystem_main.cc)
-target_link_libraries(compile_capi_filesystem PRIVATE capi_filesystem)
-add_dependencies(all_link_complete compile_capi_filesystem)
+commence(object_library capi_filesystem)
+  this_target_sources(${SOURCES})
+  this_target_link_libraries(export)
+  this_target_object_libraries(baseline constants exception_wrapper)
+conclude(object_library)
 
 add_test_subdirectory()

tiledb/api/c_api/object/CMakeLists.txt

@@ -37,13 +37,16 @@ gather_sources(${SOURCES})
 # on StorageManager that would require us to link the entire library
 # for this to work.
 #
-# TODO: Remove StorageManager dependency from the object APIs and
-# make this a real object library for unit test use.
+# Maturity Warning: `capi_object` can't be a full object library unit the
+# `StorageManager` dependency is removed. Note that the test-compile is
+# commented out. This is the reason that it hasn't been converted to use the
+# `object_library` environment for CMake.
 #
 add_library(capi_object OBJECT ${SOURCES})
 target_link_libraries(capi_object PUBLIC export)
 target_link_libraries(capi_object PUBLIC baseline $<TARGET_OBJECTS:baseline>)
 target_link_libraries(capi_object PUBLIC constants $<TARGET_OBJECTS:constants>)
+target_link_libraries(capi_object PUBLIC exception_wrapper $<TARGET_OBJECTS:exception_wrapper>)
 
 #
 # Test-compile of object library ensures link-completeness

tiledb/api/c_api/object/test/CMakeLists.txt

@@ -24,26 +24,14 @@
 # THE SOFTWARE.
 #
 
-find_package(Catch_EP REQUIRED)
+include(unit_test)
 
-add_executable(unit_capi_object_type EXCLUDE_FROM_ALL)
-target_sources(unit_capi_object_type PUBLIC unit_capi_object_type.cc)
-target_link_libraries(unit_capi_object_type PUBLIC capi_object)
-target_link_libraries(unit_capi_object_type PUBLIC Catch2::Catch2WithMain)
+commence(unit_test capi_object_type)
+  this_target_sources(unit_capi_object_type.cc)
+  this_target_object_libraries(capi_object)
+conclude(unit_test)
 
-add_test(
-  NAME "unit_capi_object_type"
-  COMMAND $<TARGET_FILE:unit_capi_object_type>
-  WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-)
-
-add_executable(unit_capi_object_walk_order EXCLUDE_FROM_ALL)
-target_sources(unit_capi_object_walk_order PUBLIC unit_capi_object_walk_order.cc)
-target_link_libraries(unit_capi_object_walk_order PUBLIC capi_object)
-target_link_libraries(unit_capi_object_walk_order PUBLIC Catch2::Catch2WithMain)
-
-add_test(
-  NAME "unit_capi_object_walk_order"
-  COMMAND $<TARGET_FILE:unit_capi_object_walk_order>
-  WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-)
+commence(unit_test capi_object_walk_order)
+  this_target_sources(unit_capi_object_walk_order.cc)
+  this_target_object_libraries(capi_object)
+conclude(unit_test)

tiledb/api/c_api/query/CMakeLists.txt

@@ -25,26 +25,17 @@
 #
 
 include(common NO_POLICY_SCOPE)
+include(object_library)
 
 list(APPEND SOURCES
   query_api.cc
 )
 gather_sources(${SOURCES})
 
-#
-# Object library for other units to depend upon
-#
-add_library(capi_query OBJECT ${SOURCES})
-target_link_libraries(capi_query PUBLIC export)
-target_link_libraries(capi_query PUBLIC baseline $<TARGET_OBJECTS:baseline>)
-target_link_libraries(capi_query PUBLIC constants $<TARGET_OBJECTS:constants>)
-
-#
-# Test-compile of object library ensures link-completeness
-#
-add_executable(compile_capi_query EXCLUDE_FROM_ALL)
-target_sources(compile_capi_query PRIVATE test/compile_capi_query_main.cc)
-target_link_libraries(compile_capi_query PRIVATE capi_query)
-add_dependencies(all_link_complete compile_capi_query)
+commence(object_library capi_query)
+  this_target_sources(${SOURCES})
+  this_target_link_libraries(export)
+  this_target_object_libraries(baseline constants exception_wrapper)
+conclude(object_library)
 
 add_test_subdirectory()

tiledb/api/c_api/string/CMakeLists.txt

@@ -38,7 +38,7 @@ gather_sources(${SOURCES})
 commence(object_library capi_string)
   this_target_sources(${SOURCES})
   this_target_link_libraries(export)
-  this_target_object_libraries(baseline)
+  this_target_object_libraries(baseline capi_context_stub)
 conclude(object_library)
 
 add_test_subdirectory()

tiledb/api/c_api_support/argument_validation.h

@@ -38,12 +38,14 @@
 
 namespace tiledb::api {
 
-class CAPIStatusException : public common::StatusException {
+class CAPIException : public common::StatusException {
  public:
-  explicit CAPIStatusException(const std::string& message)
+  explicit CAPIException(const std::string& message)
       : StatusException("C API", message) {
   }
 };
+// Legacy alias to forestall massive sudden code change
+using CAPIStatusException = CAPIException;
 
 /*
  * Validation functions
@@ -67,7 +69,7 @@ class CAPIStatusException : public common::StatusException {
  */
 inline void ensure_output_pointer_is_valid(void* p) {
   if (p == nullptr) {
-    throw CAPIStatusException("Invalid output pointer for object");
+    throw CAPIException("Invalid output pointer for object");
   }
 }
 

tiledb/api/c_api_support/exception_wrapper/CMakeLists.txt

@@ -23,8 +23,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 #
-
 include(common NO_POLICY_SCOPE)
+include(object_library)
 
 #
 # `exception_wrapper` object library
@@ -34,14 +34,15 @@ include(common NO_POLICY_SCOPE)
 # OBJECT syntax.
 
 # No actual source files at present.
-#list(APPEND SOURCES
-#)
-#gather_sources(${SOURCES})
+list(APPEND SOURCES
+    exception_wrapper.cc
+)
+gather_sources(${SOURCES})
 
-add_library(exception_wrapper OBJECT exception_wrapper.cc)
-target_link_libraries(exception_wrapper PUBLIC export)
-target_link_libraries(exception_wrapper PUBLIC baseline $<TARGET_OBJECTS:baseline>)
-target_link_libraries(exception_wrapper PUBLIC thread_pool $<TARGET_OBJECTS:thread_pool>)
-target_link_libraries(exception_wrapper PUBLIC config $<TARGET_OBJECTS:config>)
+commence(object_library exception_wrapper)
+  this_target_sources(${SOURCES})
+  this_target_link_libraries(export)
+  this_target_object_libraries(baseline thread_pool config)
+conclude(object_library)
 
 add_test_subdirectory()