Merge pull request #3 from StratifyLabs/feature/cmsdk-port-v2.0

tyler-gilbert · web-flow · commit 574c6da61eb4 · 2022-07-24T20:07:30.000-05:00
Feature/cmsdk port v2.0
diff --git a/.github/workflows/cmake.yml b/.github/workflows/cmake.yml
@@ -32,19 +32,19 @@ jobs:
         working-directory: ${{runner.workspace}}/API/cmake_link
         run: cmake ..
         env:
-          SOS_SDK_PATH: ${{runner.workspace}}/API/CMakeSDK
+          CMSDK_LOCAL_PATH: ${{runner.workspace}}/API/CMakeSDK
 
       - name: Build
         working-directory: ${{runner.workspace}}/API/cmake_link
         shell: bash
         run: make -j12
         env:
-          SOS_SDK_PATH: ${{runner.workspace}}/API/CMakeSDK
+          CMSDK_LOCAL_PATH: ${{runner.workspace}}/API/CMakeSDK
 
       - name: Test
         working-directory: ${{runner.workspace}}/API/cmake_link
         shell: bash
         run: make test
         env:
-          SOS_SDK_PATH: ${{runner.workspace}}/API/CMakeSDK
+          CMSDK_LOCAL_PATH: ${{runner.workspace}}/API/CMakeSDK
           CTEST_OUTPUT_ON_FAILURE: 1
diff --git a/.gitignore b/.gitignore
@@ -6,6 +6,7 @@ cmake*_link/
 build_*/
 tests/sl_report.txt
 doc/xml
+libraries/VarAPI/magic_enum/
 libraries/API/doc/
 libraries/ChronoAPI/doc/
 libraries/FsAPI/doc/
diff --git a/CHANGES.md b/CHANGES.md
@@ -5,7 +5,13 @@
 ## New Features
 
 - Updated CMake files to use CMakeSDK v2.0 or greater
+- Add `magic_enum` to `VarAPI` to convert `enum class` to/from string and to iterate all values
 
+## Bug Fixes
+
+- Remove unused member from `fs::Path`
+- Make `fs::Path` a `static` only class (cannot be constructed)
+- Fixed a regression error with `fs::LocationScope`
 
 # Version 1.4.0
 
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -6,7 +6,6 @@ project(API
 	VERSION ${API_PROJECT_VERSION}
 	)
 
-
 add_subdirectory(libraries/API API)
 add_subdirectory(libraries/VarAPI VarAPI)
 add_subdirectory(libraries/PrinterAPI PrinterAPI)
diff --git a/libraries/API.cmake b/libraries/API.cmake
@@ -1,18 +1,18 @@
 set(API_CONFIG_LIST release debug)
 
 if(NOT DEFINED API_IS_SDK)
-	if(SOS_IS_ARM)
-		#sos_sdk_include_target(StratifyOS_iface "${API_CONFIG_LIST}")
-		sos_sdk_include_target(StratifyOS_crt "${API_CONFIG_LIST}")
+	if(CMSDK_IS_ARM)
+		#cmsdk_include_target(StratifyOS_iface "${API_CONFIG_LIST}")
+		cmsdk_include_target(StratifyOS_crt "${API_CONFIG_LIST}")
 	endif()
-	sos_sdk_include_target(API "${API_CONFIG_LIST}")
-	sos_sdk_include_target(VarAPI "${API_CONFIG_LIST}")
-	sos_sdk_include_target(PrinterAPI "${API_CONFIG_LIST}")
-	sos_sdk_include_target(SysAPI "${API_CONFIG_LIST}")
-	sos_sdk_include_target(ChronoAPI "${API_CONFIG_LIST}")
-	sos_sdk_include_target(FsAPI "${API_CONFIG_LIST}")
-	sos_sdk_include_target(ThreadAPI "${API_CONFIG_LIST}")
-	sos_sdk_include_target(TestAPI "${API_CONFIG_LIST}")
+	cmsdk_include_target(API "${API_CONFIG_LIST}")
+	cmsdk_include_target(VarAPI "${API_CONFIG_LIST}")
+	cmsdk_include_target(PrinterAPI "${API_CONFIG_LIST}")
+	cmsdk_include_target(SysAPI "${API_CONFIG_LIST}")
+	cmsdk_include_target(ChronoAPI "${API_CONFIG_LIST}")
+	cmsdk_include_target(FsAPI "${API_CONFIG_LIST}")
+	cmsdk_include_target(ThreadAPI "${API_CONFIG_LIST}")
+	cmsdk_include_target(TestAPI "${API_CONFIG_LIST}")
 endif()
 
 function(api_add_api_library NAME DEPENDENCIES)
@@ -24,12 +24,12 @@ function(api_add_api_library_option NAME DEPENDENCIES LIB_OPTION)
 	set(LOCAL_NAME ${NAME})
 
 
-	sos_sdk_library_target(RELEASE ${LOCAL_NAME} "${LIB_OPTION}" release ${SOS_ARCH})
+	cmsdk_library_target(RELEASE ${LOCAL_NAME} "${LIB_OPTION}" release ${CMSDK_ARCH})
 
-	#sos_sdk_add_subdirectory(PRIVATE_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/src)
-	sos_sdk_add_out_of_source_directory(PRIVATE_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/src ${RELEASE_TARGET}_src)
-	sos_sdk_add_out_of_source_directory(INTERFACE_SOURCES include ${RELEASE_TARGET}_include)
-	#sos_sdk_add_subdirectory(INTERFACE_SOURCES include)
+	#cmsdk_add_subdirectory(PRIVATE_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/src)
+	cmsdk_add_out_of_source_directory(PRIVATE_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/src ${RELEASE_TARGET}_src)
+	cmsdk_add_out_of_source_directory(INTERFACE_SOURCES include ${RELEASE_TARGET}_include)
+	#cmsdk_add_subdirectory(INTERFACE_SOURCES include)
 
 
 	add_library(${RELEASE_TARGET} STATIC)
@@ -64,30 +64,30 @@ function(api_add_api_library_option NAME DEPENDENCIES LIB_OPTION)
 		PRIVATE
 		)
 
-	sos_sdk_library_target(DEBUG ${LOCAL_NAME} "${LIB_OPTION}" debug ${SOS_ARCH})
+	cmsdk_library_target(DEBUG ${LOCAL_NAME} "${LIB_OPTION}" debug ${CMSDK_ARCH})
 	add_library(${DEBUG_TARGET} STATIC)
-	sos_sdk_copy_target(${RELEASE_TARGET} ${DEBUG_TARGET})
+	cmsdk_copy_target(${RELEASE_TARGET} ${DEBUG_TARGET})
 
 	target_compile_options(${DEBUG_TARGET}
 		PRIVATE
 		-Os
 		)
 
-	sos_sdk_library_add_arch_targets("${DEBUG_OPTIONS}" ${SOS_ARCH} "${DEPENDENCIES}")
+	cmsdk_library_add_arch_targets("${DEBUG_OPTIONS}" ${CMSDK_ARCH} "${DEPENDENCIES}")
 
 	target_compile_options(${RELEASE_TARGET}
 		PRIVATE
 		-Os
 		)
 
-	sos_sdk_library_add_arch_targets("${RELEASE_OPTIONS}" ${SOS_ARCH} "${DEPENDENCIES}")
+	cmsdk_library_add_arch_targets("${RELEASE_OPTIONS}" ${CMSDK_ARCH} "${DEPENDENCIES}")
 
 	install(DIRECTORY include/
 		DESTINATION include/${LOCAL_NAME}
 		PATTERN CMakelists.txt EXCLUDE)
 
 	install(FILES ${LOCAL_NAME}.cmake
-		DESTINATION ${SOS_SDK_PATH}/cmake/targets)
+		DESTINATION ${CMSDK_LOCAL_PATH}/cmake/targets)
 
 
 
@@ -97,7 +97,7 @@ function(api_add_test_executable NAME RAM_SIZE DEPENDENCIES)
 
 	set(LOCAL_NAME ${NAME})
 
-	sos_sdk_app_target(RELEASE ${LOCAL_NAME} "unittest" release ${SOS_ARCH})
+	cmsdk_app_target(RELEASE ${LOCAL_NAME} "unittest" release ${CMSDK_ARCH})
   message(STATUS "API UnitTest Executable ${RELEASE_TARGET}")
 	add_executable(${RELEASE_TARGET})
 	add_dependencies(API_test ${RELEASE_TARGET})
@@ -117,15 +117,15 @@ function(api_add_test_executable NAME RAM_SIZE DEPENDENCIES)
 
 	set(CTEST_OUTPUT_ON_FAILURE ON)
 
-	sos_sdk_app_add_arch_targets("${RELEASE_OPTIONS}" "${DEPENDENCIES}" ${RAM_SIZE})
+	cmsdk_app_add_arch_targets("${RELEASE_OPTIONS}" "${DEPENDENCIES}" ${RAM_SIZE})
 
 	target_compile_options(${RELEASE_TARGET}
 		PRIVATE
 		-Os
 		)
 
-	if(SOS_IS_LINK)
-		sos_sdk_add_test(${LOCAL_NAME} ${LIB_OPTION}unittest release)
+	if(CMSDK_IS_LINK)
+		cmsdk_add_test(${LOCAL_NAME} ${LIB_OPTION}unittest release)
 	endif()
 
 endfunction()
diff --git a/libraries/API/CMakeLists.txt b/libraries/API/CMakeLists.txt
@@ -11,4 +11,4 @@ target_sources(${RELEASE_TARGET}
 
 install(FILES
   ../API.cmake
-  DESTINATION ${SOS_SDK_PATH}/cmake/targets)
+  DESTINATION ${CMSDK_LOCAL_PATH}/cmake/targets)
diff --git a/libraries/API/api.cmake b/libraries/API/api.cmake
@@ -9,11 +9,11 @@ macro(api_target NAME DIRECTORIES)
 
   install(DIRECTORY include/ DESTINATION include/${NAME})
 
-  sos_sdk_add_subdirectory(PRIVATE_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/src)
-  sos_sdk_add_subdirectory(PUBLIC_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/include)
+  cmsdk_add_subdirectory(PRIVATE_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/src)
+  cmsdk_add_subdirectory(PUBLIC_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/include)
   set(FORMAT_LIST ${PRIVATE_SOURCES} ${PUBLIC_SOURCES})
 
-  sos_sdk_library_target(RELEASE ${NAME} "" release ${SOS_ARCH})
+  cmsdk_library_target(RELEASE ${NAME} "" release ${CMSDK_ARCH})
   add_library(${RELEASE_TARGET} STATIC)
 
   set_property(TARGET ${RELEASE_TARGET}
@@ -49,7 +49,7 @@ macro(api_target NAME DIRECTORIES)
     -Os
     )
 
-  if(SOS_IS_ARM)
+  if(CMSDK_IS_ARM)
     target_compile_options(${RELEASE_TARGET}
       PUBLIC
       -fno-threadsafe-statics
@@ -73,7 +73,7 @@ macro(api_target NAME DIRECTORIES)
 
   string(COMPARE EQUAL ${NAME} API IS_API)
   set(LOCAL_DIRECTORIES ${DIRECTORIES})
-  if(IS_API AND SOS_IS_ARM)
+  if(IS_API AND CMSDK_IS_ARM)
     #list(APPEND LOCAL_DIRECTORIES StratifyOS_crt)
     target_compile_options(${RELEASE_TARGET}
       INTERFACE
@@ -87,37 +87,28 @@ macro(api_target NAME DIRECTORIES)
     $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
     )
 
-  sos_sdk_library_target(DEBUG ${NAME} "" debug ${SOS_ARCH})
+  cmsdk_library_target(DEBUG ${NAME} "" debug ${CMSDK_ARCH})
   add_library(${DEBUG_TARGET} STATIC)
-  sos_sdk_copy_target(${RELEASE_TARGET} ${DEBUG_TARGET})
+  cmsdk_copy_target(${RELEASE_TARGET} ${DEBUG_TARGET})
 
-  sos_sdk_library_add_arch_targets("${RELEASE_OPTIONS}" ${SOS_ARCH} "${LOCAL_DIRECTORIES}")
-  sos_sdk_library_add_arch_targets("${DEBUG_OPTIONS}" ${SOS_ARCH} "${LOCAL_DIRECTORIES}")
+  cmsdk_library_add_arch_targets("${RELEASE_OPTIONS}" ${CMSDK_ARCH} "${LOCAL_DIRECTORIES}")
+  cmsdk_library_add_arch_targets("${DEBUG_OPTIONS}" ${CMSDK_ARCH} "${LOCAL_DIRECTORIES}")
 
   if(IS_API)
     get_target_property(RELEASE_LINK_LIBS ${RELEASE_TARGET} INTERFACE_LINK_LIBRARIES)
     get_target_property(DEBUG_LINK_LIBS ${DEBUG_TARGET} INTERFACE_LINK_LIBRARIES)
-    if(SOS_IS_ARM)
-      target_link_libraries(API_release_${SOS_ARCH} PUBLIC StratifyOS_crt_release_${SOS_ARCH} stdc++ supc++)
-      target_link_libraries(API_debug_${SOS_ARCH} PUBLIC StratifyOS_crt_debug_${SOS_ARCH} stdc++ supc++)
-      message(STATUS "API_release_${SOS_ARCH} -> crt stdc++ supc++")
-      message(STATUS "API_debug_${SOS_ARCH} -> crt stdc++ supc++")
-      foreach(ARCH ${SOS_ARCH_LIST})
+    if(CMSDK_IS_ARM)
+      target_link_libraries(API_release_${CMSDK_ARCH} PUBLIC StratifyOS_crt_release_${CMSDK_ARCH} stdc++ supc++)
+      target_link_libraries(API_debug_${CMSDK_ARCH} PUBLIC StratifyOS_crt_debug_${CMSDK_ARCH} stdc++ supc++)
+      message(STATUS "API_release_${CMSDK_ARCH} -> crt stdc++ supc++")
+      message(STATUS "API_debug_${CMSDK_ARCH} -> crt stdc++ supc++")
+      foreach(ARCH ${CMSDK_ARCH_LIST})
         target_link_libraries(API_release_${ARCH} PUBLIC StratifyOS_crt_release_${ARCH} stdc++ supc++)
         target_link_libraries(API_debug_${ARCH} PUBLIC StratifyOS_crt_debug_${ARCH} stdc++ supc++)
         message(STATUS "API_release_${ARCH} -> crt stdc++ supc++")
         message(STATUS "API_debug_${ARCH} -> crt stdc++ supc++")
       endforeach()
     endif()
   endif()
-
-  add_custom_target(
-    ${NAME}_format
-    COMMAND /usr/local/bin/clang-format
-    -i
-    --verbose
-    ${FORMAT_LIST}
-  )
-
 endmacro()
 
diff --git a/libraries/API/src/api.cpp b/libraries/API/src/api.cpp
@@ -24,7 +24,7 @@ const char *ApiInfo::version() {
     __PROJECT_VERSION_MINOR) "." MCU_STRINGIFY(__PROJECT_VERSION_PATCH);
 }
 
-const char *ApiInfo::git_hash() { return SOS_GIT_HASH; }
+const char *ApiInfo::git_hash() { return CMSDK_GIT_HASH; }
 
 void api::api_assert(bool value, const char *function, int line) {
   if (!value) {
diff --git a/libraries/FsAPI/include/fs/FileObject.hpp b/libraries/FsAPI/include/fs/FileObject.hpp
@@ -146,7 +146,7 @@ class FileObject : public api::ExecutionContext, public FileInfoFlags {
 
   public:
     explicit LocationScope(const FileObject &object)
-      : m_resource({&object, object.location()}) {}
+      : m_resource({&object, object.location()}, &deleter) {}
   };
 
   using LocationGuard = LocationScope;
@@ -186,8 +186,8 @@ class FileObject : public api::ExecutionContext, public FileInfoFlags {
     StringType result;
     const auto file_location = location();
     read(var::View(result.data(), result.capacity()));
-    size_t offset = 0;
-    for (auto c : var::StringView(result)) {
+    size_t offset{};
+    for (auto c : result.string_view()) {
       if (c == term) {
         const auto new_length = offset + 1;
         seek(file_location + new_length);
diff --git a/libraries/FsAPI/include/fs/Path.hpp b/libraries/FsAPI/include/fs/Path.hpp
@@ -31,6 +31,7 @@ namespace fs {
  */
 
 class Path {
+  Path() = default;
 public:
   API_NO_DISCARD static var::StringView suffix(var::StringView path);
   API_NO_DISCARD static var::StringView name(var::StringView path);
@@ -49,9 +50,6 @@ class Path {
    *
    */
   API_NO_DISCARD static bool is_hidden(var::StringView path);
-
-private:
-  var::StringView m_path;
 };
 } // namespace fs
 
diff --git a/libraries/ThreadAPI/CMakeLists.txt b/libraries/ThreadAPI/CMakeLists.txt
@@ -11,7 +11,7 @@ set(DIRECTORIES
 api_target(ThreadAPI "${DIRECTORIES}")
 
 message(STATUS "Check to see if running linux and need to link to pthread and rt")
-if(SOS_IS_LINUX)
+if(CMSDK_IS_LINUX)
   message(STATUS "Running on Linux -- need to add pthread and rt dependencies")
   set(CONFIG_LIST release debug)
   foreach(CONFIG ${CONFIG_LIST})
diff --git a/libraries/VarAPI/CMakeLists.txt b/libraries/VarAPI/CMakeLists.txt
@@ -1,7 +1,19 @@
 cmake_minimum_required(VERSION 3.12)
 
-
 include(${CMAKE_CURRENT_LIST_DIR}/../API/api.cmake)
 
 api_target(VarAPI API)
 
+if(NOT EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/magic_enum)
+  set(MAGIC_ENUM_GIT_REPOSITORY "https://github.com/Neargye/magic_enum.git")
+  set(MAGIC_ENUM_BRANCH "v0.8.0")
+  execute_process(
+    COMMAND git clone --branch ${MAGIC_ENUM_BRANCH} ${MAGIC_ENUM_GIT_REPOSITORY}
+    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+  )
+endif()
+
+file(COPY ${CMAKE_CURRENT_SOURCE_DIR}/magic_enum/include/magic_enum.hpp
+  DESTINATION ${CMAKE_CURRENT_SOURCE_DIR}/include/var)
+file(COPY ${CMAKE_CURRENT_SOURCE_DIR}/magic_enum/include/magic_enum_fuse.hpp
+  DESTINATION ${CMAKE_CURRENT_SOURCE_DIR}/include/var)
diff --git a/libraries/VarAPI/include/CMakeLists.txt b/libraries/VarAPI/include/CMakeLists.txt
@@ -8,6 +8,7 @@ set(SOURCES
   var/Flags.hpp
   var/View.hpp
   var/List.hpp
+  var/MagicEnum.hpp
   var/Deque.hpp
   var/Stack.hpp
   var/Queue.hpp
diff --git a/libraries/VarAPI/include/var/MagicEnum.hpp b/libraries/VarAPI/include/var/MagicEnum.hpp
@@ -0,0 +1,43 @@
+//
+// Created by Tyler Gilbert on 7/14/22.
+//
+
+#ifndef VAR_API_MAGIC_ENUM_HPP_
+#define VAR_API_MAGIC_ENUM_HPP_
+
+#include "magic_enum.hpp"
+
+#include "String.hpp"
+
+namespace var {
+
+template <class Type> class MagicEnum {
+  MagicEnum() = default;
+
+public:
+  static StringView to_string_view(Type value) {
+    return StringView{magic_enum::enum_name(value)};
+  }
+
+  static constexpr auto from_cstring(const char *name) {
+    return magic_enum::enum_cast<Type>(name);
+  }
+
+  static auto from_string(var::StringView name) {
+    return magic_enum::enum_cast<Type>(name.to_std_string_view());
+  }
+
+  static Type from_string_with_invalid(var::StringView name, Type invalid) {
+    const auto result = from_string(name);
+    return result.has_value() ? result.value() : invalid;
+  }
+
+  static size_t count() { return magic_enum::enum_count<Type>(); }
+
+  static constexpr auto list() { return magic_enum::enum_values<Type>(); }
+
+private:
+};
+
+} // namespace var
+#endif // VAR_API_MAGIC_ENUM_HPP_
diff --git a/libraries/VarAPI/include/var/StringView.hpp b/libraries/VarAPI/include/var/StringView.hpp
diff --git a/libraries/VarAPI/include/var/magic_enum.hpp b/libraries/VarAPI/include/var/magic_enum.hpp
diff --git a/libraries/VarAPI/include/var/magic_enum_fuse.hpp b/libraries/VarAPI/include/var/magic_enum_fuse.hpp
diff --git a/libraries/VarAPI/src/StringView.cpp b/libraries/VarAPI/src/StringView.cpp
diff --git a/tests/API/api.cmake b/tests/API/api.cmake
diff --git a/tests/VarAPI/src/UnitTest.hpp b/tests/VarAPI/src/UnitTest.hpp
diff --git a/tests/common/main.cpp b/tests/common/main.cpp

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,6 @@ project(API`
`6`	`6`	`VERSION ${API_PROJECT_VERSION}`
`7`	`7`	`)`
`8`	`8`
`9`		`-`
`10`	`9`	`add_subdirectory(libraries/API API)`
`11`	`10`	`add_subdirectory(libraries/VarAPI VarAPI)`
`12`	`11`	`add_subdirectory(libraries/PrinterAPI PrinterAPI)`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ const char *ApiInfo::version() {`
`24`	`24`	`__PROJECT_VERSION_MINOR) "." MCU_STRINGIFY(__PROJECT_VERSION_PATCH);`
`25`	`25`	`}`
`26`	`26`
`27`		`-const char *ApiInfo::git_hash() { return SOS_GIT_HASH; }`
	`27`	`+const char *ApiInfo::git_hash() { return CMSDK_GIT_HASH; }`
`28`	`28`
`29`	`29`	`void api::api_assert(bool value, const char *function, int line) {`
`30`	`30`	`if (!value) {`