Fixes and improvements (#617)

TactilityKernel/include/tactility/paths.h

@@ -17,7 +17,7 @@ extern "C" {
  * @retval ERROR_BUFFER_OVERFLOW if out_path_size is too small
  * @retval ERROR_NONE on success
  */
-error_t paths_get_user_data_path(char* out_path, size_t out_path_size);
+error_t paths_get_data_path(char* out_path, size_t out_path_size);
 
 #ifdef __cplusplus
 }

TactilityKernel/source/paths.cpp

@@ -8,7 +8,7 @@
 #include <cstdio>
 #include <cstring>
 
-static error_t paths_get_user_data_root_path(char* out_path, size_t out_path_size) {
+static error_t paths_get_data_root_path(char* out_path, size_t out_path_size) {
 #if defined(CONFIG_TT_USER_DATA_LOCATION_INTERNAL)
 #ifdef ESP_PLATFORM
     const char* mount_point = "/data";
@@ -41,10 +41,10 @@ static error_t paths_get_user_data_root_path(char* out_path, size_t out_path_siz
 
 extern "C" {
 
-error_t paths_get_user_data_path(char* out_path, size_t out_path_size) {
+error_t paths_get_data_path(char* out_path, size_t out_path_size) {
 #ifdef ESP_PLATFORM
     char root[64];
-    error_t error = paths_get_user_data_root_path(root, sizeof(root));
+    error_t error = paths_get_data_root_path(root, sizeof(root));
     if (error != ERROR_NONE) {
         return error;
     }

TactilityKernel/source/symbols.c

@@ -249,7 +249,7 @@ const struct ModuleSymbol KERNEL_SYMBOLS[] = {
     DEFINE_MODULE_SYMBOL(keyboard_read_key),
     DEFINE_MODULE_SYMBOL(KEYBOARD_TYPE),
     // drivers/paths
-    DEFINE_MODULE_SYMBOL(paths_get_user_data_path),
+    DEFINE_MODULE_SYMBOL(paths_get_data_path),
     // drivers/pointer
     DEFINE_MODULE_SYMBOL(pointer_enter_sleep),
     DEFINE_MODULE_SYMBOL(pointer_exit_sleep),

TactilityKernel/tests/source/paths_test.cpp

@@ -4,28 +4,28 @@
 
 #include <tactility/paths.h>
 
-// The simulator target is never built with ESP_PLATFORM, so paths_get_user_data_path()
+// The simulator target is never built with ESP_PLATFORM, so paths_get_data_path()
 // always takes the fixed "data" path branch here, guarded by a buffer-size check.
 
-TEST_CASE("paths_get_user_data_path succeeds when the buffer exactly fits") {
+TEST_CASE("paths_get_data_path succeeds when the buffer exactly fits") {
     char buffer[16] = { 0 };
-    CHECK_EQ(paths_get_user_data_path(buffer, sizeof(buffer)), ERROR_NONE);
+    CHECK_EQ(paths_get_data_path(buffer, sizeof(buffer)), ERROR_NONE);
     CHECK_EQ(std::strcmp(buffer, "data"), 0);
 }
 
-TEST_CASE("paths_get_user_data_path succeeds with a buffer sized to exactly fit the string and terminator") {
+TEST_CASE("paths_get_data_path succeeds with a buffer sized to exactly fit the string and terminator") {
     char buffer[5] = { 0 }; // strlen("data") + 1
-    CHECK_EQ(paths_get_user_data_path(buffer, sizeof(buffer)), ERROR_NONE);
+    CHECK_EQ(paths_get_data_path(buffer, sizeof(buffer)), ERROR_NONE);
     CHECK_EQ(std::strcmp(buffer, "data"), 0);
 }
 
-TEST_CASE("paths_get_user_data_path reports a buffer overflow when the buffer is one byte too small") {
+TEST_CASE("paths_get_data_path reports a buffer overflow when the buffer is one byte too small") {
     char buffer[4] = { 0 }; // strlen("data"), no room for the terminator
-    CHECK_EQ(paths_get_user_data_path(buffer, sizeof(buffer)), ERROR_BUFFER_OVERFLOW);
+    CHECK_EQ(paths_get_data_path(buffer, sizeof(buffer)), ERROR_BUFFER_OVERFLOW);
 }
 
-TEST_CASE("paths_get_user_data_path reports a buffer overflow for a zero-size buffer") {
+TEST_CASE("paths_get_data_path reports a buffer overflow for a zero-size buffer") {
     char buffer[1] = { 'x' };
-    CHECK_EQ(paths_get_user_data_path(buffer, 0), ERROR_BUFFER_OVERFLOW);
+    CHECK_EQ(paths_get_data_path(buffer, 0), ERROR_BUFFER_OVERFLOW);
     CHECK_EQ(buffer[0], 'x'); // untouched
 }