Add namespace flexibility

CMakeLists.txt

@@ -8,6 +8,17 @@ project(sframe
 option(TESTING    "Build tests" OFF)
 option(CLANG_TIDY "Perform linting with clang-tidy" OFF)
 option(SANITIZERS "Enable sanitizers" OFF)
+option(NAMESPACE_SUFFIX "Namespace Suffix for CXX and CMake Export")
+
+if(NAMESPACE_SUFFIX)
+    set(SFRAME_CXX_NAMESPACE "sframe_${NAMESPACE_SUFFIX}" CACHE STRING "Top-level Namespace for CXX")
+    set(SFRAME_EXPORT_NAMESPACE "SFrame${NAMESPACE_SUFFIX}" CACHE STRING "Namespace for CMake Export")
+else()
+    set(SFRAME_CXX_NAMESPACE "sframe" CACHE STRING "Top-level Namespace for CXX")
+    set(SFRAME_EXPORT_NAMESPACE "SFrame" CACHE STRING "Namespace for CMake Export")
+endif()
+message(STATUS "CXX Namespace: ${SFRAME_CXX_NAMESPACE}")
+message(STATUS "CMake Export Namespace: ${SFRAME_EXPORT_NAMESPACE}")
 
 # Use -DCRYPTO=(OPENSSL_1_1 | OPENSSL_3 | BORINGSSL) to configure crypto
 if(NOT DEFINED CRYPTO)
@@ -19,6 +30,12 @@ endif()
 ###
 set_property(GLOBAL PROPERTY USE_FOLDERS ON)
 
+configure_file(
+  "${CMAKE_CURRENT_SOURCE_DIR}/cmake/namespace.h.in"
+  "${CMAKE_CURRENT_BINARY_DIR}/include/namespace.h"
+  @ONLY
+)
+
 set(CMAKE_CXX_STANDARD 11)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 if (CMAKE_CXX_COMPILER_ID MATCHES "Clang" OR CMAKE_CXX_COMPILER_ID MATCHES "GNU")
@@ -104,14 +121,16 @@ target_include_directories( gsl INTERFACE ${GSL_LITE_INCLUDE_DIR} )
 set(LIB_NAME "${PROJECT_NAME}")
 
 file(GLOB_RECURSE LIB_HEADERS CONFIGURE_DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/include/*.h")
+file(GLOB_RECURSE LIB_GENERATED_HEADERS CONFIGURE_DEPENDS "${CMAKE_CURRENT_BINARY_DIR}/include/*.h")
 file(GLOB_RECURSE LIB_SOURCES CONFIGURE_DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/src/*.cpp")
 
-add_library(${LIB_NAME} ${LIB_HEADERS} ${LIB_SOURCES})
+add_library(${LIB_NAME} ${LIB_HEADERS} ${LIB_GENERATED_HEADERS} ${LIB_SOURCES})
 add_dependencies(${LIB_NAME} gsl)
 target_link_libraries(${LIB_NAME} PRIVATE gsl OpenSSL::Crypto)
 target_include_directories(${LIB_NAME}
   PUBLIC
     $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>
+    $<BUILD_INTERFACE:${CMAKE_CURRENT_BINARY_DIR}/include>
     $<INSTALL_INTERFACE:include/${PROJECT_NAME}-${PROJECT_VERSION}>
 )
 

cmake/namespace.h.in

@@ -0,0 +1,4 @@
+#pragma once
+
+// Configurable top-level namespace
+#define SFRAME_NAMESPACE @SFRAME_CXX_NAMESPACE@

include/sframe/sframe.h

@@ -5,9 +5,10 @@
 #include <memory>
 #include <vector>
 
+#include <namespace.h>
 #include <gsl/gsl-lite.hpp>
 
-namespace sframe {
+namespace SFRAME_NAMESPACE {
 
 struct openssl_error : std::runtime_error
 {
@@ -147,4 +148,4 @@ class MLSContext : public SFrame
   KeyState& get_state(KeyID key_id) override;
 };
 
-} // namespace sframe
+} // namespace SFRAME_NAMESPACE

src/crypto.cpp

@@ -1,6 +1,6 @@
 #include "crypto.h"
 
-namespace sframe {
+namespace SFRAME_NAMESPACE {
 
 ///
 /// Information about algorithms
@@ -91,4 +91,4 @@ cipher_overhead(CipherSuite suite)
   }
 }
 
-} // namespace sframe
+} // namespace SFRAME_NAMESPACE

src/crypto.h

@@ -4,7 +4,7 @@
 
 #include <array>
 
-namespace sframe {
+namespace SFRAME_NAMESPACE {
 
 ///
 /// Information about algorithms
@@ -54,4 +54,4 @@ open(CipherSuite suite,
      input_bytes aad,
      input_bytes ct);
 
-} // namespace sframe
+} // namespace SFRAME_NAMESPACE

src/crypto_boringssl.cpp

@@ -9,7 +9,7 @@
 #include <openssl/hmac.h>
 #include <openssl/mem.h>
 
-namespace sframe {
+namespace SFRAME_NAMESPACE {
 
 ///
 /// Convert between native identifiers / errors and OpenSSL ones
@@ -409,6 +409,6 @@ open(CipherSuite suite,
   throw unsupported_ciphersuite_error();
 }
 
-} // namespace sframe
+} // namespace SFRAME_NAMESPACE
 
 #endif // defined(OPENSSL_3)

src/crypto_openssl11.cpp

@@ -6,7 +6,7 @@
 #include <openssl/err.h>
 #include <openssl/evp.h>
 
-namespace sframe {
+namespace SFRAME_NAMESPACE {
 
 ///
 /// Scoped pointers for OpenSSL objects
@@ -468,6 +468,6 @@ open(CipherSuite suite,
   throw unsupported_ciphersuite_error();
 }
 
-} // namespace sframe
+} // namespace SFRAME_NAMESPACE
 
 #endif // defined(OPENSSL_1_1)

src/crypto_openssl3.cpp

@@ -9,7 +9,7 @@
 #include <openssl/kdf.h>
 #include <openssl/params.h>
 
-namespace sframe {
+namespace SFRAME_NAMESPACE {
 
 ///
 /// Convert between native identifiers / errors and OpenSSL ones
@@ -448,6 +448,6 @@ open(CipherSuite suite,
   throw unsupported_ciphersuite_error();
 }
 
-} // namespace sframe
+} // namespace SFRAME_NAMESPACE
 
 #endif // defined(OPENSSL_3)

src/header.cpp

@@ -1,6 +1,6 @@
 #include "header.h"
 
-namespace sframe {
+namespace SFRAME_NAMESPACE {
 
 static size_t
 uint_size(uint64_t val)
@@ -109,4 +109,4 @@ Header::encode(output_bytes buffer) const
   return 1 + kid_size + ctr_size;
 }
 
-} // namespace sframe
+} // namespace SFRAME_NAMESPACE

src/header.h

@@ -2,7 +2,7 @@
 
 #include <sframe/sframe.h>
 
-namespace sframe {
+namespace SFRAME_NAMESPACE {
 
 void
 encode_uint(uint64_t val, output_bytes buffer);
@@ -21,4 +21,4 @@ struct Header
   static constexpr size_t max_size = 1 + 7 + 7;
 };
 
-} // namespace sframe
+} // namespace SFRAME_NAMESPACE

src/sframe.cpp

@@ -10,7 +10,7 @@
 #include <stdexcept>
 #include <tuple>
 
-namespace sframe {
+namespace SFRAME_NAMESPACE {
 
 std::ostream&
 operator<<(std::ostream& str, const input_bytes data)
@@ -294,4 +294,4 @@ MLSContext::get_state(KeyID key_id)
   return epoch->get(suite, sender_id);
 }
 
-} // namespace sframe
+} // namespace SFRAME_NAMESPACE

test/sframe.cpp

@@ -8,7 +8,7 @@
 #include <stdexcept> // for invalid_argument
 #include <string>    // for basic_string, operator==
 
-using namespace sframe;
+using namespace SFRAME_NAMESPACE;
 
 static bytes
 from_hex(const std::string& hex)