Fonts & Markers

- Seperated out the Display interface and added a Font interface.  This
is for future improvements to enable different size font display
- It is now possible to provide different font sizes for predefined
types, and the main text buffer can be scaled independent of the rest of
the UI.
- Beginning markdown support: #Heading will show bigger font
- Markers now handle their own updates when the buffer changes
- Markers are outside the undo system, but flexible enough now for users
to update them as needed.  I am still working on improving marker
abilities and making them flexible enough for various scenarios.
- Integrated a simple signal/slot mechanism to make messaging easier.  I
hope this will be better than the messaging system in the long term, and
more flexible.
- Fix the bug where you couldn't 'j' down in certain wrapped text buffer
cases

Author: cmaughan

demos/demo_common.h

@@ -2,7 +2,7 @@
 
 namespace Zep
 {
-const float DemoFontPtSize = 11.0f;
+const float DemoFontPtSize = 14.0f;
 } // Zep
 
 

demos/demo_imgui/main.cpp

@@ -101,12 +101,16 @@ void main()
 
 std::string startupFile;
 
-Zep::NVec2f GetDisplayScale()
+Zep::NVec2f GetPixelScale()
 {
     float ddpi = 0.0f;
     float hdpi = 0.0f;
     float vdpi = 0.0f;
-    auto res = SDL_GetDisplayDPI(0, &ddpi, &hdpi, &vdpi);
+
+    auto window = SDL_GL_GetCurrentWindow();
+    auto index = window ? SDL_GetWindowDisplayIndex(window) : 0;
+
+    auto res = SDL_GetDisplayDPI(index, &ddpi, &hdpi, &vdpi);
     if (res == 0 && hdpi != 0)
     {
         return Zep::NVec2f(hdpi, vdpi) / 96.0f;
@@ -153,15 +157,44 @@ bool ReadCommandLine(int argc, char** argv, int& exitCode)
 }
 
 // A helper struct to init the editor and handle callbacks
-struct ZepContainer : public IZepComponent, public IZepReplProvider
+struct ZepContainerImGui : public IZepComponent, public IZepReplProvider
 {
-    ZepContainer(const std::string& startupFilePath, const std::string& configPath)
-        : spEditor(std::make_unique<ZepEditor_ImGui>(configPath))
+    ZepContainerImGui(const std::string& startupFilePath, const std::string& configPath)
+        : spEditor(std::make_unique<ZepEditor_ImGui>(configPath, GetPixelScale()))
     {
         chibi_init(scheme, SDL_GetBasePath());
 
+        // ZepEditor_ImGui will have created the fonts for us; but we need to build
+        // the font atlas
+        auto fontPath = std::string(SDL_GetBasePath()) + "Cousine-Regular.ttf";
+        auto& display = static_cast<ZepDisplay_ImGui&>(spEditor->GetDisplay());
+
+        int fontPixelHeight = (int)dpi_pixel_height_from_point_size(DemoFontPtSize, GetPixelScale().y);
+
+        auto& io = ImGui::GetIO();
+        ImVector<ImWchar> ranges;
+        ImFontGlyphRangesBuilder builder;
+        builder.AddRanges(io.Fonts->GetGlyphRangesDefault()); // Add one of the default ranges
+        builder.AddRanges(io.Fonts->GetGlyphRangesCyrillic()); // Add one of the default ranges
+        builder.AddRanges(greek_range);
+        builder.BuildRanges(&ranges); // Build the final result (ordered ranges with all the unique characters submitted)
+    
+        ImFontConfig cfg;
+        cfg.OversampleH = 4;
+        cfg.OversampleV = 4;
+
+        auto pImFont = ImGui::GetIO().Fonts->AddFontFromFileTTF(fontPath.c_str(), float(fontPixelHeight), &cfg, ranges.Data);
+
+        display.SetFont(ZepTextType::UI, std::make_shared<ZepFont_ImGui>(display, pImFont, fontPixelHeight));
+        display.SetFont(ZepTextType::Text, std::make_shared<ZepFont_ImGui>(display, pImFont, fontPixelHeight));
+        display.SetFont(ZepTextType::Heading1, std::make_shared<ZepFont_ImGui>(display, pImFont, int(fontPixelHeight * 1.75)));
+        display.SetFont(ZepTextType::Heading2, std::make_shared<ZepFont_ImGui>(display, pImFont, int(fontPixelHeight * 1.5)));
+        display.SetFont(ZepTextType::Heading3, std::make_shared<ZepFont_ImGui>(display, pImFont, int(fontPixelHeight * 1.25)));
+
+        unsigned int flags = 0; // ImGuiFreeType::NoHinting;
+        ImGuiFreeType::BuildFontAtlas(ImGui::GetIO().Fonts, flags);
+
         spEditor->RegisterCallback(this);
-        spEditor->SetPixelScale(GetDisplayScale());
 
         ZepMode_Orca::Register(*spEditor);
 
@@ -198,7 +231,7 @@ struct ZepContainer : public IZepComponent, public IZepReplProvider
 #endif
     }
 
-    ZepContainer()
+    ZepContainerImGui()
     {
         spEditor->UnRegisterCallback(this);
     }
@@ -230,7 +263,7 @@ struct ZepContainer : public IZepComponent, public IZepReplProvider
         if (range.first >= range.second)
             return "<No Expression>";
 
-        const auto& text = buffer.GetGapBuffer();
+        const auto& text = buffer.GetWorkingBuffer();
         auto eval = std::string(text.begin() + range.first.Index(), text.begin() + range.second.Index());
 
         // Flash the evaluated expression
@@ -324,7 +357,7 @@ struct ZepContainer : public IZepComponent, public IZepReplProvider
                     if (pSyntax->GetSyntaxAt(spTipMsg->location).foreground == ThemeColor::Identifier)
                     {
                         auto spMarker = std::make_shared<RangeMarker>(*spTipMsg->pBuffer);
-                        spMarker->description = "This is an identifier";
+                        spMarker->SetDescription("This is an identifier");
                         spMarker->SetHighlightColor(ThemeColor::Identifier);
                         spMarker->SetTextColor(ThemeColor::Text);
                         spTipMsg->spMarker = spMarker;
@@ -333,7 +366,7 @@ struct ZepContainer : public IZepComponent, public IZepReplProvider
                     else if (pSyntax->GetSyntaxAt(spTipMsg->location).foreground == ThemeColor::Keyword)
                     {
                         auto spMarker = std::make_shared<RangeMarker>(*spTipMsg->pBuffer);
-                        spMarker->description = "This is a keyword";
+                        spMarker->SetDescription("This is a keyword");
                         spMarker->SetHighlightColor(ThemeColor::Keyword);
                         spMarker->SetTextColor(ThemeColor::Text);
                         spTipMsg->spMarker = spMarker;
@@ -436,37 +469,17 @@ int main(int argc, char** argv)
     ImGui_ImplSDL2_InitForOpenGL(window, gl_context);
     ImGui_ImplOpenGL3_Init(glsl_version);
 
+    // ** Zep specific code, before Initializing font map
+    ZepContainerImGui zep(startupFile, SDL_GetBasePath());
+
     // Setup style
     ImGui::StyleColorsDark();
 
-    ImVector<ImWchar> ranges;
-    ImFontGlyphRangesBuilder builder;
-    builder.AddRanges(io.Fonts->GetGlyphRangesDefault()); // Add one of the default ranges
-    builder.AddRanges(io.Fonts->GetGlyphRangesCyrillic()); // Add one of the default ranges
-    //builder.AddRanges(io.Fonts->GetGlyphRangesThai()); // Add one of the default ranges
-    ImWchar greek_range[] = { 0x300, 0x52F, 0x1f00, 0x1fff, 0, 0 };
-    builder.AddRanges(greek_range);
-    builder.BuildRanges(&ranges); // Build the final result (ordered ranges with all the unique characters submitted)
-
-    ImFontConfig cfg;
-    cfg.OversampleH = 4;
-    cfg.OversampleV = 4;
-
-    float fontPixelHeight = dpi_pixel_height_from_point_size(DemoFontPtSize, GetDisplayScale().y);
-    io.Fonts->AddFontFromFileTTF((std::string(SDL_GetBasePath()) + "Cousine-Regular.ttf").c_str(), fontPixelHeight, &cfg, ranges.Data);
-
-    ZLOG(INFO, "DPI Scale: " << MUtils::NVec2f(GetDisplayScale().x, GetDisplayScale().y));
-    ZLOG(INFO, "Font Pixel Size: " << fontPixelHeight);
-
-    unsigned int flags = 0; // ImGuiFreeType::NoHinting;
-    ImGuiFreeType::BuildFontAtlas(io.Fonts, flags);
+    ZLOG(INFO, "DPI Scale: " << MUtils::NVec2f(GetPixelScale().x, GetPixelScale().y));
 
     bool show_demo_window = false;
     ImVec4 clear_color = ImVec4(0.45f, 0.55f, 0.60f, 1.00f);
 
-    // ** Zep specific code
-    ZepContainer zep(startupFile, SDL_GetBasePath());
-
     MUtils::TimeProvider::Instance().StartThread();
 
     // Main loop

demos/demo_qt/mainwindow.cpp

@@ -167,7 +167,7 @@ std::string MainWindow::ReplParse(ZepBuffer& buffer, const GlyphIterator& cursor
     ZEP_UNUSED(cursorOffset);
     ZEP_UNUSED(type);
 
-    auto ret = chibi_repl(scheme, NULL, buffer.GetGapBuffer().string());
+    auto ret = chibi_repl(scheme, NULL, buffer.GetWorkingBuffer().string());
     ret = RTrim(ret);
     return ret;
 }

extensions/orca/orca.cpp

@@ -101,7 +101,7 @@ void Orca::ReadFromBuffer(ZepBuffer* pBuffer)
     m_size = NVec2i(m_field.width, m_field.height);
 
     // Copy the buffer into the field
-    auto& text = pBuffer->GetGapBuffer();
+    auto& text = pBuffer->GetWorkingBuffer();
     auto sz = text.size();
     for (int y = 0; y < m_field.height; y++)
     {
@@ -138,7 +138,7 @@ void Orca::WriteToBuffer(ZepBuffer* pBuffer, ZepWindow& window)
     m_lastCursorPos = window.BufferToDisplay();
 
     // Copy the calculated buffer data from the orca buffer
-    auto& text = pBuffer->GetMutableText();
+    auto& text = pBuffer->GetMutableWorkingBuffer();
     for (int y = 0; y < m_field.height; y++)
     {
         for (int x = 0; x < m_field.width; x++)

extensions/orca/syntax_orca.cpp

@@ -49,7 +49,7 @@ SyntaxResult ZepSyntax_Orca::GetSyntaxAt(const GlyphIterator& itr) const
 
 void ZepSyntax_Orca::UpdateSyntax()
 {
-    auto& buffer = m_buffer.GetGapBuffer();
+    auto& buffer = m_buffer.GetWorkingBuffer();
 
     // We don't do anything in orca mode, we get dynamically because Orca tells us the colors
     m_targetChar = long(0);

extensions/repl/mode_repl.cpp

@@ -147,7 +147,7 @@ bool ZepReplExCommand::AddKeyPress(uint32_t key, uint32_t modifiers)
     {
         ChangeRecord record;
         auto& buffer = m_pReplWindow->GetBuffer();
-        std::string str = std::string(buffer.GetGapBuffer().begin() + m_startLocation.Index(), buffer.GetGapBuffer().end());
+        std::string str = std::string(buffer.GetWorkingBuffer().begin() + m_startLocation.Index(), buffer.GetWorkingBuffer().end());
         if (str.size() <= 1)
         {
             MoveToEnd();

include/zep/buffer.h

@@ -6,6 +6,7 @@
 #include "zep/mcommon/file/path.h"
 #include "zep/mcommon/string/stringutils.h"
 #include "zep/mcommon/logger.h"
+#include "zep/mcommon/signals.h"
 
 #include "zep/glyph_iterator.h"
 
@@ -92,37 +93,16 @@ enum class ReplaceRangeMode
     Replace,
 };
 
-struct MarkerMove
-{
-    MarkerMove(ByteIndex markerFrom, ByteIndex markerTo, const std::shared_ptr<RangeMarker> spMarker)
-        : from(markerFrom),
-        to(markerTo),
-        marker(spMarker)
-    {
-
-    }
-
-    ByteIndex from;
-    ByteIndex to;
-    std::shared_ptr<RangeMarker> marker;
-};
-
-using tMarkerMoves = std::vector<MarkerMove>;
-using tMarkers = std::vector<std::shared_ptr<RangeMarker>>;
 struct ChangeRecord
 {
     std::string strDeleted;
     std::string strInserted;
-    tMarkerMoves markerMoves;
-    tMarkers markerDeletes;
     GlyphIterator itrStart;
     GlyphIterator itrEnd;
 
     void Clear()
     {
         strDeleted.clear();
-        markerMoves.clear();
-        markerDeletes.clear();
         itrStart.Invalidate();
         itrEnd.Invalidate();
     }
@@ -180,14 +160,16 @@ class ZepBuffer : public ZepComponent
     GlyphIterator End() const;
     GlyphIterator Begin() const;
 
-    const GapBuffer<uint8_t>& GetGapBuffer() const
+    const GapBuffer<uint8_t>& GetWorkingBuffer() const
     {
-        return m_gapBuffer;
+        return m_workingBuffer;
     }
-    GapBuffer<uint8_t>& GetMutableText()
+
+    GapBuffer<uint8_t>& GetMutableWorkingBuffer()
     {
-        return m_gapBuffer;
+        return m_workingBuffer;
     }
+
     const std::vector<ByteIndex> GetLineEnds() const
     {
         return m_lineEnds;
@@ -247,7 +229,6 @@ class ZepBuffer : public ZepComponent
 
     void ForEachMarker(uint32_t types, Direction dir, const GlyphIterator& begin, const GlyphIterator& end, std::function<bool(const std::shared_ptr<RangeMarker>&)> fnCB) const;
     std::shared_ptr<RangeMarker> FindNextMarker(GlyphIterator start, Direction dir, uint32_t markerType);
-    void ApplyMarkerChanges(ChangeRecord& record, Direction direction);
 
     void SetBufferType(BufferType type);
     BufferType GetBufferType() const;
@@ -287,15 +268,16 @@ class ZepBuffer : public ZepComponent
     uint64_t ToHandle() const;
     static ZepBuffer* FromHandle(ZepEditor& editor, uint64_t handle);
 
+    Zep::signal<void(ZepBuffer& buffer, const GlyphIterator&, const std::string&)> sigPreInsert;
+    Zep::signal<void(ZepBuffer& buffer, const GlyphIterator&, const GlyphIterator&)> sigPreDelete;
+
 private:
     void MarkUpdate();
 
-    void UpdateForInsert(const GlyphIterator& startOffset, const GlyphIterator& endOffset, ChangeRecord& changeRecord);
-    void UpdateForDelete(const GlyphIterator& startOffset, const GlyphIterator& endOffset, ChangeRecord& changeRecord);
-
 private:
     // Buffer & record of the line end locations
-    GapBuffer<uint8_t> m_gapBuffer;
+    GapBuffer<uint8_t> m_workingBuffer;
+
     std::vector<ByteIndex> m_lineEnds;
 
     // File and modification info