Better Buffer management

Saturday morning; my favourite coding session ;)
Better management of buffers by tracking file names and matching them to
buffers.   Fixed delete in command mode too.

Author: cmaughan

demo_imgui/main.cpp

@@ -113,7 +113,7 @@ struct ZepContainer : public IZepComponent
         // Add a shader, as a default when no file - for the demo
         if (spEditor->GetBuffers().size() == 0)
         {
-            ZepBuffer* pBuffer = spEditor->AddBuffer("shader.vert");
+            ZepBuffer* pBuffer = spEditor->GetBuffer("shader.vert");
             pBuffer->SetText(shader.c_str());
         }
     }

demo_qt/mainwindow.cpp

@@ -56,7 +56,7 @@ MainWindow::MainWindow()
     }
     else
     {
-        ZepBuffer* pBuffer = pWidget->GetEditor().AddBuffer("shader.vert");
+        ZepBuffer* pBuffer = pWidget->GetEditor().GetBuffer("shader.vert");
         pBuffer->SetText(shader.c_str());
     }
 

src/buffer.cpp

@@ -536,7 +536,7 @@ void ZepBuffer::LockRead()
 // the file path in case you want to write later
 void ZepBuffer::Load(const fs::path& path)
 {
-    m_filePath = path;
+    m_filePath = fs::canonical(path);
 
     auto read = file_read(path);
     if (!read.empty())

src/editor.cpp

@@ -91,6 +91,26 @@ void ZepEditor::SaveBuffer(ZepBuffer& buffer)
     SetCommandText(strText.str());
 }
 
+ZepBuffer* ZepEditor::GetBuffer(const fs::path& filePath)
+{
+    auto path = fs::canonical(filePath);
+    for (auto& pBuffer : m_buffers)
+    {
+        if (fs::equivalent(pBuffer->GetFilePath(), path))
+        {
+            LOG(DEBUG) << "Found equivalent buffer for file: " << path.string();
+            return pBuffer.get();
+        }
+    }
+
+    auto pBuffer = AddBuffer(path.filename().string());
+    if (fs::exists(path))
+    {
+        pBuffer->Load(path);
+    }
+    return pBuffer;
+}
+
 void ZepEditor::InitWithFileOrDir(const std::string& str)
 {
     fs::path startPath(str);
@@ -298,6 +318,7 @@ ZepBuffer* ZepEditor::AddBuffer(const std::string& str)
     // Adding a buffer immediately updates the window state, in case this is the first one
     UpdateWindowState();
 
+    LOG(DEBUG) << "Added buffer: " << str;
     return pBuffer.get();
 }
 

src/editor.h

@@ -12,6 +12,7 @@
 #include <vector>
 #include "mcommon/math/math.h"
 #include "mcommon/animation/timer.h"
+#include "mcommon/file/file.h"
 #include "splits.h"
 
 // Basic Architecture
@@ -166,9 +167,9 @@ class ZepEditor
     }
 
     const tBuffers& GetBuffers() const;
-    ZepBuffer* AddBuffer(const std::string& str);
     ZepBuffer* GetMRUBuffer() const;
     void SaveBuffer(ZepBuffer& buffer);
+    ZepBuffer* GetBuffer(const fs::path& filePath);
 
     void SetRegister(const std::string& reg, const Register& val);
     void SetRegister(const char reg, const Register& val);
@@ -218,6 +219,10 @@ class ZepEditor
 
     ZepTheme& GetTheme() const;
 
+private:
+    // Call GetBuffer publicly, to stop creation of duplicate buffers refering to the same file
+    ZepBuffer* AddBuffer(const std::string& bufferName);
+
 private:
     IZepDisplay* m_pDisplay;
     std::set<IZepComponent*> m_notifyClients;

src/mcommon/file/mfilesystem.h

@@ -175,6 +175,11 @@ inline bool exists(const path& path)
     return stat(path.c_str(), &buffer) == 0;
 }
 
+inline bool equivalent(const path& a, const path& b)
+{
+    return canonical(a).string() == canonical(b).string();
+}
+
 inline path canonical(const path& input)
 {
     return path(ReplaceString(input.string(), "\\", "/"));

src/mode.h

@@ -47,8 +47,7 @@ enum class EditorMode
     None,
     Normal,
     Insert,
-    Visual,
-    Command
+    Visual
 };
 
 class ZepMode : public ZepComponent