Bracket Colors

Add bracketcolors plugin. Color {}, [], () based on nesting order

Closes #1148

MAINTAINERS

@@ -33,6 +33,13 @@ M: Pavel Roschin <rpg89(at)post(dot)ru>
 W:
 S: Maintained
 
+bracketcolors
+* P: Asif Amin <asifamin@utexas.edu>
+* g: @asifamin13
+* M: Asif Amin <asifamin@utexas.edu>
+* W: 
+* S: Maintained
+
 codenav
 P: Federico Reghenzani <federico(dot)dev(at)reghe(dot)net>
 g:

Makefile.am

@@ -21,6 +21,10 @@ if ENABLE_AUTOMARK
 SUBDIRS += automark
 endif
 
+if ENABLE_BRACKETCOLORS
+SUBDIRS += bracketcolors
+endif
+
 if ENABLE_CODENAV
 SUBDIRS += codenav
 endif

README

@@ -49,6 +49,7 @@ Available plugins are:
 * ``addons`` -- the Addons plugin
 * ``autoclose`` -- the Autoclose plugin
 * ``automark`` -- the Automark plugin
+* ``bracketcolors`` -- the BracketColors plugin
 * ``codenav`` -- the CodeNav plugin
 * ``commander`` -- the Commander plugin
 * ``debugger`` -- the Debugger plugin

bracketcolors/AUTHORS

@@ -0,0 +1 @@
+Asif Amin <asifamin@utexas.edu>

bracketcolors/Makefile.am

@@ -0,0 +1,4 @@
+include $(top_srcdir)/build/vars.auxfiles.mk
+
+SUBDIRS = src
+plugin = bracketcolors

bracketcolors/README

@@ -0,0 +1,32 @@
+Color brackets, parenthesis, and braces
+=======================================
+
+.. contents::
+
+About
+-----
+
+This plugin enables bracket coloring features. Brackets are colored based on
+nesting level, often referred as "rainbow brackets".
+
+Features
+--------
+
+* Color brackets for: { }, [ ], ( )
+
+Usage
+-----
+
+Install the plugin (https://plugins.geany.org/install.html) then
+load it in Geany's plugin manager.
+
+Requirements
+------------
+
+* Geany >= 1.38
+* C++17
+
+Contact developers
+------------------
+
+Asif Amin <asifamin@utexas.edu>

bracketcolors/src/BracketMap.cc

@@ -0,0 +1,119 @@
+/*
+ *      BracketMap.cc
+ *
+ *      Copyright 2023 Asif Amin <asifamin@utexas.edu>
+ *
+ *      This program is free software; you can redistribute it and/or modify
+ *      it under the terms of the GNU General Public License as published by
+ *      the Free Software Foundation; either version 2 of the License, or
+ *      (at your option) any later version.
+ *
+ *      This program is distributed in the hope that it will be useful,
+ *      but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *      GNU General Public License for more details.
+ *      You should have received a copy of the GNU General Public License
+ *      along with this program; if not, write to the Free Software
+ *      Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ *      MA 02110-1301, USA.
+ */
+
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
+#include <stack>
+#include <set>
+
+#include "BracketMap.h"
+
+
+// -----------------------------------------------------------------------------
+    BracketMap::BracketMap()
+/*
+    Constructor
+----------------------------------------------------------------------------- */
+{
+
+}
+
+
+// -----------------------------------------------------------------------------
+    BracketMap::~BracketMap()
+/*
+    Destructor
+----------------------------------------------------------------------------- */
+{
+
+}
+
+
+// -----------------------------------------------------------------------------
+    void BracketMap::Update(Index index, Length length)
+/*
+
+----------------------------------------------------------------------------- */
+{
+    auto it = mBracketMap.find(index);
+    if (it != mBracketMap.end()) {
+        auto &bracket = it->second;
+        GetLength(bracket) = length;
+    }
+    else {
+        mBracketMap.insert(
+            std::make_pair(index, std::make_tuple(length, 0))
+        );
+    }
+}
+
+
+// -----------------------------------------------------------------------------
+    std::set<BracketMap::Index> BracketMap::ComputeOrder()
+/*
+
+----------------------------------------------------------------------------- */
+{
+    std::stack<Index> orderStack;
+    std::set<Index> updatedBrackets;
+
+    for (auto &it : mBracketMap) {
+
+        const Index &startIndex = it.first;
+        Bracket &bracket = it.second;
+        Length length = GetLength(bracket);
+        Index endPos = startIndex + length;
+
+        if (length == UNDEFINED) {
+            // Invalid brackets
+            GetOrder(bracket) = UNDEFINED;
+            continue;
+        }
+
+
+        if (orderStack.size() == 0) {
+            // First bracket
+            orderStack.push(endPos);
+        }
+        else if (startIndex > orderStack.top()) {
+            // not nested
+            while(orderStack.size() > 0 and orderStack.top() < startIndex) {
+                orderStack.pop();
+            }
+            orderStack.push(endPos);
+        }
+        else {
+            // nested bracket
+            orderStack.push(endPos);
+        }
+
+        Order newOrder = orderStack.size() - 1;
+        Order currOrder = GetOrder(bracket);
+        if (newOrder != currOrder) {
+            updatedBrackets.insert(startIndex);
+        }
+
+        GetOrder(bracket) = newOrder;
+    }
+
+    return updatedBrackets;
+}

bracketcolors/src/BracketMap.h

@@ -0,0 +1,64 @@
+/*
+ *      BracketMap.h
+ *
+ *      Copyright 2023 Asif Amin <asifamin@utexas.edu>
+ *
+ *      This program is free software; you can redistribute it and/or modify
+ *      it under the terms of the GNU General Public License as published by
+ *      the Free Software Foundation; either version 2 of the License, or
+ *      (at your option) any later version.
+ *
+ *      This program is distributed in the hope that it will be useful,
+ *      but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *      GNU General Public License for more details.
+ *      You should have received a copy of the GNU General Public License
+ *      along with this program; if not, write to the Free Software
+ *      Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ *      MA 02110-1301, USA.
+ */
+
+#ifndef __BRACKET_MAP_H__
+#define __BRACKET_MAP_H__
+
+#include <map>
+#include <tuple>
+#include <set>
+
+#include <glib.h>
+
+
+// -----------------------------------------------------------------------------
+    struct BracketMap
+/*
+    Purpose:    data structure which stores and computes nesting order
+----------------------------------------------------------------------------- */
+{
+    typedef gint Length, Order, Index;
+    typedef std::tuple<Length, Order> Bracket;
+    std::map<Index, Bracket> mBracketMap;
+
+    BracketMap();
+    ~BracketMap();
+
+    void Update(Index index, Length length);
+    std::set<Index> ComputeOrder();
+
+    static const gint UNDEFINED = -1;
+
+    static Length& GetLength(Bracket &bracket) {
+        return std::get<0>(bracket);
+    }
+    static Order& GetOrder(Bracket &bracket) {
+        return std::get<1>(bracket);
+    }
+
+    static const Length& GetLength(const Bracket &bracket) {
+        return std::get<0>(bracket);
+    }
+    static const Order& GetOrder(const Bracket &bracket) {
+        return std::get<1>(bracket);
+    }
+};
+
+#endif

bracketcolors/src/Makefile.am

@@ -0,0 +1,15 @@
+include $(top_srcdir)/build/vars.build.mk
+plugin = bracketcolors
+
+geanyplugins_LTLIBRARIES = bracketcolors.la
+
+bracketcolors_srcs = \
+    bracketcolors.cc \
+    BracketMap.cc \
+    BracketMap.h
+
+bracketcolors_la_SOURCES = $(bracketcolors_srcs)
+bracketcolors_la_CXXFLAGS = $(AM_CXXFLAGS) $(AM_CFLAGS) -DG_LOG_DOMAIN=\"BracketColors\"
+bracketcolors_la_LIBADD = $(COMMONLIBS)
+
+include $(top_srcdir)/build/cppcheck.mk