[FIX] : fix serialization / deserialization and C Api for Places

aiekick · aiekick · commit 295abccaae40 · 2024-02-20T22:21:07.000+01:00
diff --git a/ImGuiFileDialog.cpp b/ImGuiFileDialog.cpp
@@ -837,6 +837,27 @@ bool IGFD::Utils::ReplaceString(std::string& str, const ::std::string& oldStr, c
     return false;
 }
 
+std::vector<std::string> IGFD::Utils::SplitStringToVector(const std::string& vText, const std::string& vDelimiterPattern, const bool& vPushEmpty) {
+    std::vector<std::string> arr;
+    if (!vText.empty()) {
+        size_t start = 0;
+        size_t end   = vText.find(vDelimiterPattern, start);
+        while (end != std::string::npos) {
+            auto token = vText.substr(start, end - start);
+            if (!token.empty() || (token.empty() && vPushEmpty)) {  //-V728
+                arr.push_back(token);
+            }
+            start = end + vDelimiterPattern.size();
+            end   = vText.find(vDelimiterPattern, start);
+        }
+        auto token = vText.substr(start);
+        if (!token.empty() || (token.empty() && vPushEmpty)) {  //-V728
+            arr.push_back(token);
+        }
+    }
+    return arr;
+}
+
 std::vector<std::string> IGFD::Utils::SplitStringToVector(const std::string& vText, const char& vDelimiter, const bool& vPushEmpty) {
     std::vector<std::string> arr;
     if (!vText.empty()) {
@@ -3071,45 +3092,52 @@ bool IGFD::PlacesFeature::m_DrawPlacesPane(FileDialogInternal& vFileDialogIntern
 }
 
 std::string IGFD::PlacesFeature::SerializePlaces(const bool& vForceSerialisationForAll) {
-    // todo : do the code
     std::string res;
-    /*size_t idx = 0;
-    for (auto& it : m_Groups) {
-        if (vForceSerialisationForAll && it.canBeSaved) continue;
-        if (idx++ != 0) res += "##";  // ## because reserved by imgui, so an input text cant have ##
-        res += it.name + "##" + it.path;
-    }*/
+    size_t idx = 0;
+    for (const auto& group : m_Groups) {
+        if (group.second->canBeSaved) {
+            // ## is used because reserved by imgui, so an input text cannot have ##
+            res += "###" + group.first + "###";
+            for (const auto& place : group.second->places) {
+                if (place.canBeSaved) {
+                    if (idx++ != 0) res += "##";
+                    res += place.name + "##" + place.path;
+                }
+            }
+        }
+    }
     return res;
 }
 
 void IGFD::PlacesFeature::DeserializePlaces(const std::string& vPlaces) {
-    // todo : do the code
-    /*if (!vPlaces.empty()) {
-        m_Groups.clear();
-        auto arr = IGFD::Utils::SplitStringToVector(vPlaces, '#', false);
-        for (size_t i = 0; i < arr.size(); i += 2) {
-            if (i + 1 < arr.size()) {  // for avoid crash if arr size is impair due to user mistake after edition
-                PlaceStruct place;
-                place.name = arr[i];
-                // if bad format we jump this place
-                place.path = arr[i + 1];
-                m_Bookmarks.push_back(place);
+    if (!vPlaces.empty()) {
+        const auto& groups = IGFD::Utils::SplitStringToVector(vPlaces, "###", false);
+        if (groups.size() > 1) {
+            for (size_t i = 0; i < groups.size(); i += 2) {
+                auto group_ptr = GetPlacesGroupPtr(groups[i]);
+                if (group_ptr != nullptr) {
+                    const auto& places = IGFD::Utils::SplitStringToVector(groups[i + 1], "##", false);
+                    if (places.size() > 1) {
+                        for (size_t j = 0; j < places.size(); j += 2) {
+                            group_ptr->AddPlace(places[j], places[j + 1], true);  // was saved so we set canBeSaved to true
+                        }
+                    }
+                }
             }
         }
-    }*/
+    }
 }
 
 bool IGFD::PlacesFeature::AddPlacesGroup(const std::string& vGroupName, const size_t& vDisplayOrder, const bool& vCanBeEdited) {
     if (vGroupName.empty()) {
         return false;
     }
-    auto group_ptr = std::make_shared<GroupStruct>();
-    group_ptr->displayOrder  = vDisplayOrder;
+    auto group_ptr          = std::make_shared<GroupStruct>();
+    group_ptr->displayOrder = vDisplayOrder;
     group_ptr->name         = vGroupName;
-    group_ptr->canBeEdited   = vCanBeEdited;
+    group_ptr->canBeSaved = group_ptr->canBeEdited = vCanBeEdited; // can be user edited mean can be saved
     m_Groups[vGroupName]     = group_ptr;
-    // tofix the set of existing order number
-    m_OrderedGroups[group_ptr->displayOrder] = group_ptr;
+    m_OrderedGroups[group_ptr->displayOrder] = group_ptr; // an exisitng display order will be overwrote for code simplicity
     return true;
 }
 
@@ -3131,7 +3159,10 @@ IGFD::PlacesFeature::GroupStruct* IGFD::PlacesFeature::GetPlacesGroupPtr(const s
 }
 
 bool IGFD::PlacesFeature::GroupStruct::AddPlace(const std::string& vPlaceName, const std::string& vPlacePath, const bool& vCanBeSaved, const FileStyle& vStyle) {
-    if (vPlaceName.empty() || vPlacePath.empty()) return false;
+    if (vPlaceName.empty() || vPlacePath.empty()) {
+        return false;
+    }
+    canBeSaved |= vCanBeSaved; // if one place must be saved so we mark the group to be saved
     PlaceStruct place;
     place.name       = vPlaceName;
     place.path       = vPlacePath;
@@ -3141,7 +3172,9 @@ bool IGFD::PlacesFeature::GroupStruct::AddPlace(const std::string& vPlaceName, c
 }
 
 bool IGFD::PlacesFeature::GroupStruct::RemovePlace(const std::string& vPlaceName) {
-    if (vPlaceName.empty()) return false;
+    if (vPlaceName.empty()) {
+        return false;
+    }
     for (auto places_it = places.begin(); places_it != places.end(); ++places_it) {
         if ((*places_it).name == vPlaceName) {
             places.erase(places_it);
@@ -4931,20 +4964,42 @@ IGFD_C_API void IGFD_DeserializePlaces(ImGuiFileDialog* vContextPtr, const char*
     }
 }
 
-IGFD_C_API void IGFD_AddPlace(ImGuiFileDialog* vContextPtr, const char* vPlaceName, const char* vPlacePath) {
+IGFD_C_API bool IGFD_AddPlacesGroup(ImGuiFileDialog* vContextPtr, const char* vGroupName, size_t vDisplayOrder, bool vCanBeEdited) {
+    if (vContextPtr != nullptr) {
+        return vContextPtr->AddPlacesGroup(vGroupName, vDisplayOrder, vCanBeEdited);
+    }
+    return false;
+}
+
+IGFD_C_API bool IGFD_RemovePlacesGroup(ImGuiFileDialog* vContextPtr, const char* vGroupName) {
     if (vContextPtr != nullptr) {
-        // todo : do the code
-        //vContextPtr->AddPlace(vPlaceName, vPlacePath);
+        return vContextPtr->RemovePlacesGroup(vGroupName);
     }
+    return false;
 }
 
-IGFD_C_API void IGFD_RemovePlace(ImGuiFileDialog* vContextPtr, const char* vPlaceName) {
+IGFD_C_API bool IGFD_AddPlace(ImGuiFileDialog* vContextPtr, const char* vGroupName, const char* vPlaceName, const char* vPlacePath, bool vCanBeSaved, const char* vIconText) {
     if (vContextPtr != nullptr) {
-        //todo : do the code
-        //vContextPtr->RemovePlace(vPlaceName);
+        auto group_ptr = vContextPtr->GetPlacesGroupPtr(vGroupName);
+        if (group_ptr != nullptr) {
+            IGFD::FileStyle style;
+            style.icon = vIconText;
+            return group_ptr->AddPlace(vPlaceName, vPlacePath, vCanBeSaved, style);
+        }
     }
+    return false;
 }
 
+IGFD_C_API bool IGFD_RemovePlace(ImGuiFileDialog* vContextPtr, const char* vGroupName, const char* vPlaceName) {
+    if (vContextPtr != nullptr) {
+        auto group_ptr = vContextPtr->GetPlacesGroupPtr(vGroupName);
+        if (group_ptr != nullptr) {
+            return group_ptr->RemovePlace(vPlaceName);
+        }
+    }
+    return false;
+}     
+
 #endif
 
 #ifdef USE_THUMBNAILS
diff --git a/ImGuiFileDialog.h b/ImGuiFileDialog.h
@@ -1514,6 +1514,7 @@ class IGFD_API Utils {
     static void SetBuffer(char* vBuffer, size_t vBufferLen, const std::string& vStr);
     static std::string UTF8Encode(const std::wstring& wstr);
     static std::wstring UTF8Decode(const std::string& str);
+    static std::vector<std::string> SplitStringToVector(const std::string& vText, const std::string& vDelimiterPattern, const bool& vPushEmpty);
     static std::vector<std::string> SplitStringToVector(const std::string& vText, const char& vDelimiter, const bool& vPushEmpty);
     static std::string LowerCaseString(const std::string& vString);  // turn all text in lower case for search facilitie
     static size_t GetCharCountInString(const std::string& vString, const char& vChar);
@@ -2038,6 +2039,7 @@ class IGFD_API PlacesFeature {
     };
 
     struct GroupStruct {
+        bool canBeSaved     = false;                       // defined by code, can be used for prevent serialization / deserialization
         size_t displayOrder = 0U;                         // the display order will be usedf first, then alphanumeric
         std::string name;                                 // the group name, will be displayed
         std::vector<PlaceStruct> places;                  // the places (name + path)
@@ -2068,14 +2070,14 @@ class IGFD_API PlacesFeature {
     bool m_DrawPlacesPane(FileDialogInternal& vFileDialogInternal, const ImVec2& vSize);  // draw place Pane
 
 public:
-    std::string SerializePlaces(                              // serialize place : return place buffer to save in a file
-        const bool& vForceSerialisationForAll = true);        // for avoid serialization of places with flag canBeSaved to false
-    void DeserializePlaces(                                   // deserialize place : load place buffer to load in the dialog (saved from
-        const std::string& vPlaces);                          // previous use with SerializePlaces()) place buffer to load
+    std::string SerializePlaces(                                    // serialize place : return place buffer to save in a file
+        const bool& vForceSerialisationForAll = true);              // for avoid serialization of places with flag canBeSaved to false
+    void DeserializePlaces(                                         // deserialize place : load place buffer to load in the dialog (saved from
+        const std::string& vPlaces);                                // previous use with SerializePlaces()) place buffer to load
     bool AddPlacesGroup(                                            // add a group
-        const std::string& vGroupName,                        // the group name
-        const size_t& vDisplayOrder,                          // the display roder of the group
-        const bool& vCanBeEdited);                            // let the user add/remove place in the group
+        const std::string& vGroupName,                              // the group name
+        const size_t& vDisplayOrder,                                // the display roder of the group
+        const bool& vCanBeEdited);                                  // let the user add/remove place in the group
     bool RemovePlacesGroup(const std::string& vGroupName);          // remove the group
     GroupStruct* GetPlacesGroupPtr(const std::string& vGroupName);  // get the group, if not existed, will be created
 #endif  // USE_PLACES_FEATURE
@@ -2447,14 +2449,29 @@ IGFD_C_API void IGFD_DeserializePlaces(  // deserialize place : load bookmar buf
     ImGuiFileDialog* vContextPtr,           // ImGuiFileDialog context
     const char* vPlaces);                // place buffer to load
 
-IGFD_C_API void IGFD_AddPlace(  // add a place by code
+IGFD_C_API bool IGFD_AddPlacesGroup(  // add a places group by code
+    ImGuiFileDialog* vContextPtr,     // ImGuiFileDialog context
+    const char* vGroupName,           // the group name
+    size_t vDisplayOrder,             // the display roder of the group
+    bool vCanBeEdited);               // let the user add/remove place in the group
+
+IGFD_C_API bool IGFD_RemovePlacesGroup(  // remove a place group by code, return true if succeed
+    ImGuiFileDialog* vContextPtr,        // ImGuiFileDialog context
+    const char* vGroupName);             // place name to remove
+
+IGFD_C_API bool IGFD_AddPlace(     // add a place by code
     ImGuiFileDialog* vContextPtr,  // ImGuiFileDialog context
-    const char* vPlaceName,     // place name
-    const char* vPlacePath);    // place path
+    const char* vGroupName,        // the group name
+    const char* vPlaceName,        // place name
+    const char* vPlacePath,        // place path
+    bool vCanBeSaved,              // place can be saved
+    const char* vIconText);        // wanted text or icon of the file with extention filter (can be used with font icon)
 
-IGFD_C_API void IGFD_RemovePlace(  // remove a place by code, return true if succeed
-    ImGuiFileDialog* vContextPtr,     // ImGuiFileDialog context
+IGFD_C_API bool IGFD_RemovePlace(  // remove a place by code, return true if succeed
+    ImGuiFileDialog* vContextPtr,  // ImGuiFileDialog context
+    const char* vGroupName,        // the group name
     const char* vPlaceName);       // place name to remove
+
 #endif
 
 #ifdef USE_THUMBNAILS
