Added support for multi-cursor comments to the comment plugin

runtime/plugins/comment/comment.lua

@@ -1,4 +1,4 @@
-VERSION = "1.0.0"
+VERSION = "1.1.0"
 
 local util = import("micro/util")
 local config = import("micro/config")
@@ -78,66 +78,31 @@ end
 function isCommented(bp, lineN, commentRegex)
     local line = bp.Buf:Line(lineN)
     local regex = commentRegex:gsub("%s+", "%s*")
-    if string.match(line, regex) then
-        return true
-    end
-    return false
+    return string.match(line, regex)
 end
 
 function commentLine(bp, lineN, indentLen)
-    updateCommentType(bp.Buf)
-
     local line = bp.Buf:Line(lineN)
-    local commentType = bp.Buf.Settings["commenttype"]
-    local sel = -bp.Cursor.CurSelection
-    local curpos = -bp.Cursor.Loc
-    local index = string.find(commentType, "%%s") - 1
-    local indent = string.sub(line, 1, indentLen)
     local trimmedLine = string.sub(line, indentLen + 1)
     trimmedLine = trimmedLine:gsub("%%", "%%%%")
+    local indent = string.sub(line, 1, indentLen)
+    local commentType = bp.Buf.Settings["commenttype"]
     local commentedLine = commentType:gsub("%%s", trimmedLine)
     bp.Buf:Replace(buffer.Loc(0, lineN), buffer.Loc(#line, lineN), indent .. commentedLine)
-    if bp.Cursor:HasSelection() then
-        bp.Cursor.CurSelection[1].Y = sel[1].Y
-        bp.Cursor.CurSelection[2].Y = sel[2].Y
-        bp.Cursor.CurSelection[1].X = sel[1].X
-        bp.Cursor.CurSelection[2].X = sel[2].X
-    else
-        bp.Cursor.X = curpos.X + index
-        bp.Cursor.Y = curpos.Y
-    end
-    bp.Cursor:Relocate()
-    bp.Cursor:StoreVisualX()
 end
 
 function uncommentLine(bp, lineN, commentRegex)
-    updateCommentType(bp.Buf)
-
     local line = bp.Buf:Line(lineN)
-    local commentType = bp.Buf.Settings["commenttype"]
-    local sel = -bp.Cursor.CurSelection
-    local curpos = -bp.Cursor.Loc
-    local index = string.find(commentType, "%%s") - 1
     if not string.match(line, commentRegex) then
         commentRegex = commentRegex:gsub("%s+", "%s*")
     end
     if string.match(line, commentRegex) then
         uncommentedLine = string.match(line, commentRegex)
         bp.Buf:Replace(buffer.Loc(0, lineN), buffer.Loc(#line, lineN), util.GetLeadingWhitespace(line) .. uncommentedLine)
-        if bp.Cursor:HasSelection() then
-            bp.Cursor.CurSelection[1].Y = sel[1].Y
-            bp.Cursor.CurSelection[2].Y = sel[2].Y
-            bp.Cursor.CurSelection[1].X = sel[1].X
-            bp.Cursor.CurSelection[2].X = sel[2].X
-        else
-            bp.Cursor.X = curpos.X - index
-            bp.Cursor.Y = curpos.Y
-        end
     end
-    bp.Cursor:Relocate()
-    bp.Cursor:StoreVisualX()
 end
 
+-- unused
 function toggleCommentLine(bp, lineN, commentRegex)
     if isCommented(bp, lineN, commentRegex) then
         uncommentLine(bp, lineN, commentRegex)
@@ -146,9 +111,9 @@ function toggleCommentLine(bp, lineN, commentRegex)
     end
 end
 
-function toggleCommentSelection(bp, startLine, endLine, commentRegex)
+function toggleCommentSelection(bp, lines, commentRegex)
     local allComments = true
-    for line = startLine, endLine do
+    for line,_ in pairs(lines) do
         if not isCommented(bp, line, commentRegex) then
             allComments = false
             break
@@ -158,21 +123,22 @@ function toggleCommentSelection(bp, startLine, endLine, commentRegex)
     -- NOTE: we assume that the indentation is either tabs only or spaces only
     local indentMin = -1
     if not allComments then
-        for line = startLine, endLine do
+        for line,_ in pairs(lines) do
             local indentLen = #util.GetLeadingWhitespace(bp.Buf:Line(line))
             if indentMin == -1 or indentLen < indentMin then
                 indentMin = indentLen
             end
         end
     end
 
-    for line = startLine, endLine do
+    for line,_ in pairs(lines) do
         if allComments then
             uncommentLine(bp, line, commentRegex)
         else
             commentLine(bp, line, indentMin)
         end
     end
+    return not allComments
 end
 
 function comment(bp, args)
@@ -181,22 +147,43 @@ function comment(bp, args)
     local commentType = bp.Buf.Settings["commenttype"]
     local commentRegex = "^%s*" .. commentType:gsub("%%","%%%%"):gsub("%$","%$"):gsub("%)","%)"):gsub("%(","%("):gsub("%?","%?"):gsub("%*", "%*"):gsub("%-", "%-"):gsub("%.", "%."):gsub("%+", "%+"):gsub("%]", "%]"):gsub("%[", "%["):gsub("%%%%s", "(.*)")
 
-    if bp.Cursor:HasSelection() then
-        if bp.Cursor.CurSelection[1]:GreaterThan(-bp.Cursor.CurSelection[2]) then
-            local endLine = bp.Cursor.CurSelection[1].Y
-            if bp.Cursor.CurSelection[1].X == 0 then
-                endLine = endLine - 1
+    local lines = {}
+    local curData = {}
+    -- gather cursor data and lines to (un)comment
+    for i = 0,#bp.Buf:getCursors()-1 do
+        local cursor = bp.Buf:getCursor(i)        
+        local hasSelection = cursor:HasSelection()
+        table.insert(curData, {
+            sel = -cursor.CurSelection,
+            curpos = -cursor.Loc,
+            cursor = cursor,
+            hasSelection = hasSelection
+        })
+        if hasSelection then
+            for lineN = cursor.CurSelection[1].Y, cursor.CurSelection[2].Y do
+                lines[lineN] = true
             end
-            toggleCommentSelection(bp, bp.Cursor.CurSelection[2].Y, endLine, commentRegex)
         else
-            local endLine = bp.Cursor.CurSelection[2].Y
-            if bp.Cursor.CurSelection[2].X == 0 then
-                endLine = endLine - 1
-            end
-            toggleCommentSelection(bp, bp.Cursor.CurSelection[1].Y, endLine, commentRegex)
+            lines[cursor.Y] = true
         end
-    else
-        toggleCommentLine(bp, bp.Cursor.Y, commentRegex)
+    end
+    -- (un)comment selected lines
+    local commented = toggleCommentSelection(bp, lines, commentRegex)
+    -- restore cursors
+    local displacement = (string.find(commentType, "%%s") - 1) * (commented and 1 or -1)
+    for i=1,#curData do
+        local cursor = curData[i].cursor
+        if curData[i].hasSelection then
+            cursor.CurSelection[1].Y = curData[i].sel[1].Y
+            cursor.CurSelection[2].Y = curData[i].sel[2].Y
+            cursor.CurSelection[1].X = curData[i].sel[1].X + displacement
+            cursor.CurSelection[2].X = curData[i].sel[2].X + displacement
+        else
+            cursor.Y = curData[i].curpos.Y
+            cursor.X = curData[i].curpos.X + displacement
+        end
+        cursor:Relocate()
+        cursor:StoreVisualX()
     end
 end
 
@@ -210,3 +197,5 @@ function init()
     config.TryBindKey("CtrlUnderscore", "lua:comment.comment", false)
     config.AddRuntimeFile("comment", config.RTHelp, "help/comment.md")
 end
+
+-- So if im just writting, what finger do i use th e most to input spaces. Funnily engouh, I mostly use the right hand do do that, and not my left hand at all. That's quite insteresting. Altough iut must be said, I've been looking at how my hands moving while typing, and ids anything but efficient :( But oh well. it only goes to show how ineficient typing on a regular key board can be :/