[Code] Fix get matrix marker logic

Author: EgorOrachyov

cubool/include/cubool/cubool.h

@@ -290,6 +290,9 @@ CUBOOL_EXPORT CUBOOL_API cuBool_Status cuBool_Matrix_SetMarker(
  * @note Pass null marker if you want to retrieve only the required marker buffer size.
  * @note After the function call the actual size of the marker is stored in the size variable.
  *
+ * @note size is set to the actual marker length plus null terminator symbol.
+ *       For marker "matrix" size variable will be set to 7.
+ *
  * @param matrix Matrix handle to perform operation on
  * @param[in,out] marker Where to store null-terminated UTF-8 encoded marker string.
  * @param[in,out] size Size of the provided buffer in bytes to save marker string.

cubool/sources/cuBool_Matrix_Marker.cpp

@@ -24,6 +24,7 @@
 
 #include <cuBool_Common.hpp>
 #include <cstring>
+#include <cmath>
 
 cuBool_Status cuBool_Matrix_Marker(
         cuBool_Matrix matrix,
@@ -37,11 +38,15 @@ cuBool_Status cuBool_Matrix_Marker(
 
         auto m = (cubool::Matrix*) matrix;
         auto actualSize = m->getDebugMarkerSizeWithNullT();
+        auto toCopy = std::min(*size, actualSize);
 
-        if (marker != nullptr && *size > 0) {
+        if (marker != nullptr && toCopy > 0) {
+            // C str (with \0)
             const auto* text = m->getDebugMarker();
-            std::memcpy(marker, text, *size);
-            marker[*size - 1] = '\0';
+            std::memcpy(marker, text, toCopy);
+
+            // Explicitly terminate (for case size < actualSize)
+            marker[toCopy - 1] = '\0';
         }
 
         *size = actualSize;

cubool/tests/test_matrix_misc.cpp

@@ -23,6 +23,7 @@
 /**********************************************************************************/
 
 #include <testing/testing.hpp>
+#include <cstring>
 
 TEST(cuBool_Matrix, Duplicate) {
     cuBool_Matrix matrix = nullptr, duplicated = nullptr;
@@ -98,4 +99,55 @@ TEST(cuBool_Matrix, ExtractPairs) {
     ASSERT_EQ(cuBool_Finalize(), CUBOOL_STATUS_SUCCESS);
 }
 
+TEST(cuBool_Matrix, Marker) {
+    cuBool_Matrix matrix = nullptr;
+    cuBool_Index m, n;
+
+    m = n = 100;
+
+    const cuBool_Index BUFFER_SIZE = 100;
+    const char* marker = "Test Matrix Marker";
+    cuBool_Index size = 0;
+    char buffer[BUFFER_SIZE];
+
+    ASSERT_EQ(cuBool_Initialize(CUBOOL_HINT_NO), CUBOOL_STATUS_SUCCESS);
+    ASSERT_EQ(cuBool_Matrix_New(&matrix, m, n), CUBOOL_STATUS_SUCCESS);
+    ASSERT_EQ(cuBool_Matrix_SetMarker(matrix, marker), CUBOOL_STATUS_SUCCESS);
+    ASSERT_EQ(cuBool_Matrix_Marker(matrix, nullptr, &size), CUBOOL_STATUS_SUCCESS);
+    ASSERT_LE(size, BUFFER_SIZE);
+    ASSERT_EQ(cuBool_Matrix_Marker(matrix, buffer, &size), CUBOOL_STATUS_SUCCESS);
+    ASSERT_EQ(cuBool_Matrix_Free(matrix), CUBOOL_STATUS_SUCCESS);
+    ASSERT_EQ(cuBool_Finalize(), CUBOOL_STATUS_SUCCESS);
+
+    ASSERT_EQ(std::strlen(buffer), size - 1);
+    ASSERT_LE(std::strcmp(marker, buffer), 0);
+
+    std::cout << "Source marker: " << marker << std::endl;
+    std::cout << "Returned marker: " << buffer << std::endl;
+}
+
+TEST(cuBool_Matrix, MarkerShort) {
+    cuBool_Matrix matrix = nullptr;
+    cuBool_Index m, n;
+
+    m = n = 100;
+
+    const cuBool_Index BUFFER_SIZE = 10;
+    const char* marker = "Test Matrix Marker";
+    cuBool_Index size = BUFFER_SIZE;
+    char buffer[BUFFER_SIZE];
+
+    ASSERT_EQ(cuBool_Initialize(CUBOOL_HINT_NO), CUBOOL_STATUS_SUCCESS);
+    ASSERT_EQ(cuBool_Matrix_New(&matrix, m, n), CUBOOL_STATUS_SUCCESS);
+    ASSERT_EQ(cuBool_Matrix_SetMarker(matrix, marker), CUBOOL_STATUS_SUCCESS);
+    ASSERT_EQ(cuBool_Matrix_Marker(matrix, buffer, &size), CUBOOL_STATUS_SUCCESS);
+    ASSERT_EQ(cuBool_Matrix_Free(matrix), CUBOOL_STATUS_SUCCESS);
+    ASSERT_EQ(cuBool_Finalize(), CUBOOL_STATUS_SUCCESS);
+
+    ASSERT_GE(std::strcmp(marker, buffer), 0);
+
+    std::cout << "Source marker: " << marker << std::endl;
+    std::cout << "Returned marker: " << buffer << std::endl;
+}
+
 CUBOOL_GTEST_MAIN