auto bracket complete feature

- added bracket-complete dir in plugins
  - gtksourceview min depedency change to 4.0.3

meson.build

@@ -29,7 +29,7 @@ glib = dependency('glib-2.0', version: '>= 2.40.0')
 gthread = dependency('gthread-2.0', version: '>= 2.13.0')
 gio = dependency('gio-2.0', version: '>= 2.40.0')
 gtk = dependency('gtk+-3.0', version: '>= 3.19.3')
-gtksourceview = dependency('gtksourceview-4', version: '>= 4.6')
+gtksourceview = dependency('gtksourceview-4', version: '>= 4.0.3')
 libpeas = dependency('libpeas-1.0', version: '>= 1.12.0')
 libpeas_gtk = dependency('libpeas-gtk-1.0', version: '>= 1.12.0')
 gir_dep = dependency('gobject-introspection-1.0', version: '>= 1.42.0', required: false)

plugins/bracket-complete/bracket-complete/bracketcompletion.plugin

@@ -0,0 +1,106 @@
+[Plugin]
+Loader=python3
+Module=bracketcompletion
+IAge=3
+Name[ar]=إكمال الأقواس
+Name[be]=Дапаўненне дужак
+Name[bs]=Zatvaranje zagrada
+Name[ca]=Compleció dels claudàtors
+Name[ca@valencia]=Compleció dels claudàtors
+Name[cs]=Doplňování závorek
+Name[da]=Klammefuldførelse
+Name[de]=Klammern schließen
+Name[el]=Συμπλήρωση αγκύλων
+Name[en_GB]=Bracket Completion
+Name[eo]=Krampo-kompletigo
+Name[es]=Completar paréntesis
+Name[et]=Sulgude lõpetamine
+Name[eu]=Parentesien osaketa
+Name[fi]=Sulkuparin täsmäys
+Name[fr]=Complétion de parenthèses
+Name[fur]=Completament parentesis
+Name[gl]=Completar parénteses
+Name[he]=התאמת סוגריים
+Name[hr]=Dovršavanje zagrada
+Name[hu]=Zárójel-kiegészítés
+Name[id]=Penyelesaian Tanda Kurung
+Name[it]=Completamento parentesi
+Name[ja]=カッコの補完
+Name[kk]=Жақшаларды толықтыру
+Name[ko]=각괄호 일치
+Name[lt]=Skliaustų užbaigimas
+Name[lv]=Iekavu noslēgšana
+Name[nl]=Haakjes-voltooiing
+Name[oc]=Complecion de parentèsis
+Name[pl]=Uzupełnianie nawiasów
+Name[pt]=Conclusão de chavetas
+Name[pt_BR]=Fechamento de parênteses
+Name[ro]=Completare paranteze
+Name[ru]=Дополнение скобок
+Name[sk]=Dopĺňanie pravých zátvoriek
+Name[sl]=Dopolnjevanje oklepajev
+Name[sr]=Допуњавање заграда
+Name[sr@latin]=Dopunjavanje zagrada
+Name[sv]=Parenteskomplettering
+Name[te]=బ్రాకెట్ ముగింపు
+Name[th]=การเติมเต็มคู่วงเล็บ
+Name[tr]=Parantez Tamamlama
+Name[zh_CN]=括号补全
+Name[zh_TW]=括號補完
+Name=Bracket Completion
+Description[ar]=يغلق الأقواس آليا.
+Description[as]=বন্ধনী নিজেই যোগ কৰে ।
+Description[be]=Аўтаматычна дадае канцавыя дужкі.
+Description[be@latin]=Aŭtamatyčna dadaje kancavyja dužki.
+Description[bs]=Automatski dodaj zatvorene zagrade.
+Description[ca]=Afegeix claudàtors de tancada automàticament.
+Description[ca@valencia]=Afig claudàtors de tancada automàticament.
+Description[cs]=Automaticky přidává zavírací závorky.
+Description[da]=Tilføjer automatisk afsluttende klammer.
+Description[de]=Fügt automatisch schließende Klammern hinzu.
+Description[dz]=ཁ་བསྡམ་གུག་ཤད་ཚུ་ རང་བཞིན་གྱིས་ཁ་སྐོང་རྐྱབ་ཨིན།
+Description[el]=Συμπληρώνει αυτόματα τις αγκύλες.
+Description[en_CA]=Automatically adds closing brackets.
+Description[en_GB]=Automatically adds closing brackets.
+Description[eo]=Aŭtomate aldoni fermantajn krampojn.
+Description[es]=Añadir automáticamente cierres de paréntesis.
+Description[eu]=Automatikoki gehitzen ditu itxierako parentesiak.
+Description[fi]=Lisää suluille pääte automaattisesti.
+Description[fr]=Ajouter automatiquement les parenthèses fermantes.
+Description[fur]=Al zonte in automatic lis parentesis sieradis.
+Description[gl]=Engadir automaticamente peches de parénteses.
+Description[gu]=બંધ કરતા કૌંસો ઓપોઆપ ઉમેરાય છે.
+Description[he]=הוספת סוגר לסגירה.
+Description[hr]=Automatski zatvara zagrade.
+Description[hu]=Automatikusan hozzáadja a záró zárójeleket.
+Description[id]=Otomatis menambah kurung tutup.
+Description[it]=Aggiunge automaticamente le parentesi di chiusura
+Description[ja]=終わり括弧を自動的に追加します
+Description[kk]=Жабатын жақшаны автоматты түрде қосады.
+Description[ko]=자동으로 닫는 각괄호를 추가합니다.
+Description[lt]=Automatiškai prideda užveriančius skliaustus.
+Description[lv]=Automātiski pievieno aizverošās iekavas.
+Description[mr]=स्वयं बंद करण्याजोगी ब्रॅकेट समावेष करा.
+Description[nl]=Voegt automatisch ‘haakjes sluiten’ toe.
+Description[oc]=Apondre automaticament las parentèsis tampantas.
+Description[or]=ବନ୍ଦହୋଇଥିବା ବନ୍ଧନିଗୁଡ଼ିକୁ ସ୍ୱୟଂଚାଳିତ ଭାବରେ ଯୋଗକରନ୍ତୁ।
+Description[pl]=Automatycznie dodaje nawiasy zamykające.
+Description[pt]=Adiciona automaticamente fecho de chavetas.
+Description[pt_BR]=Fecha parênteses automaticamente.
+Description[ro]=Adaugă automat paranteze închise.
+Description[ru]=Автоматическое добавление закрывающей скобки.
+Description[sk]=Automatické pridávanie pravých zátvoriek.
+Description[sl]=Samodejno doda zaklepaje
+Description[sr]=Сам додаје затварајуће заграде.
+Description[sr@latin]=Sam dodaje zatvarajuće zagrade.
+Description[sv]=Lägger automatiskt till avslutande parenteser.
+Description[th]=เติมวงเล็บปิดโดยอัตโนมัติ
+Description[tr]=Parantez kapanışını kendiliğinden ekler.
+Description[vi]=Tự động thêm dấu ngoặc đóng.
+Description[zh_CN]=自动添加闭合括号。
+Description[zh_TW]=自動加入關閉用括號。
+Description=Automatically adds closing brackets.
+Authors=Hrutvik Suthar <steve@istique.net>
+Copyright=Copyright @ 2020 Hrutvik Suthar
+Website=https://github.com/HrSuthar/xed
+Version=1.0

plugins/bracket-complete/bracket-complete/bracketcompletion.py

@@ -0,0 +1,318 @@
+# -*- coding: utf-8 -*-
+#
+#  bracketcompletion.py - Bracket completion plugin for Xed
+#
+#
+#  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.
+
+import gi
+gi.require_version('Peas', '1.0')
+#gi.require_version('Xed', '3.0')
+from gi.repository import GObject, Gdk, Xed
+
+common_brackets = {
+    '(' : ')',
+    '[' : ']',
+    '{' : '}',
+    '"' : '"',
+    "'" : "'",
+}
+
+close_brackets = {
+    ')' : '(',
+    ']' : '[',
+    '}' : '{',
+}
+
+language_brackets = {
+    'changelog': { '<' : '>' },
+    'html': { '<' : '>' },
+    'ruby': { '|' : '|' },
+    'sh': { '`' : '`' },
+    'xml': { '<' : '>' },
+    'php': { '<' : '>' },
+}
+
+
+class BracketCompletionPlugin(GObject.Object, Xed.ViewActivatable):
+    __gtype_name__ = "BracketCompletion"
+
+    view = GObject.Property(type=Xed.View)
+
+    def __init__(self):
+        GObject.Object.__init__(self)
+
+    def do_activate(self):
+        self._doc = self.view.get_buffer()
+        self._last_iter = None
+        self._stack = []
+        self._relocate_marks = True
+        self.update_language()
+
+        # Add the markers to the buffer
+        insert = self._doc.get_iter_at_mark(self._doc.get_insert())
+        self._mark_begin = self._doc.create_mark(None, insert, True)
+        self._mark_end = self._doc.create_mark(None, insert, False)
+
+        self._handlers = [
+            None,
+            None,
+            self.view.connect('notify::editable', self.on_notify_editable),
+            self._doc.connect('notify::language', self.on_notify_language),
+            None,
+        ]
+        self.update_active()
+
+    def do_deactivate(self):
+        if self._handlers[0]:
+            self.view.disconnect(self._handlers[0])
+            self.view.disconnect(self._handlers[1])
+            self._doc.disconnect(self._handlers[4])
+        self.view.disconnect(self._handlers[2])
+        self._doc.disconnect(self._handlers[3])
+        self._doc.delete_mark(self._mark_begin)
+        self._doc.delete_mark(self._mark_end)
+
+    def update_active(self):
+        # Don't activate the feature if the buffer isn't editable or if
+        # there are no brackets for the language
+        active = self.view.get_editable() and \
+                 self._brackets is not None
+
+        if active and self._handlers[0] is None:
+            self._handlers[0] = self.view.connect('event-after',
+                                                   self.on_event_after)
+            self._handlers[1] = self.view.connect('key-press-event',
+                                                   self.on_key_press_event)
+            self._handlers[4] = self._doc.connect('delete-range',
+                                                  self.on_delete_range)
+        elif not active and self._handlers[0] is not None:
+            self.view.disconnect(self._handlers[0])
+            self._handlers[0] = None
+            self.view.disconnect(self._handlers[1])
+            self._handlers[1] = None
+            self._doc.disconnect(self._handlers[4])
+            self._handlers[4] = None
+
+    def update_language(self):
+        lang = self._doc.get_language()
+        if lang is None:
+            self._brackets = None
+            return
+
+        lang_id = lang.get_id()
+        if lang_id in language_brackets:
+            self._brackets = language_brackets[lang_id]
+            # we populate the language-specific brackets with common ones lazily
+            self._brackets.update(common_brackets)
+        else:
+            self._brackets = common_brackets
+
+        # get the corresponding keyvals
+        self._bracket_keyvals = set()
+        for b in self._brackets:
+            kv = Gdk.unicode_to_keyval(ord(b[-1]))
+            if (kv):
+                self._bracket_keyvals.add(kv)
+        for b in close_brackets:
+            kv = Gdk.unicode_to_keyval(ord(b[-1]))
+            if (kv):
+                self._bracket_keyvals.add(kv)
+
+    def get_current_token(self):
+        end = self._doc.get_iter_at_mark(self._doc.get_insert())
+        start = end.copy()
+        word = None
+
+        if end.ends_word() or (end.inside_word() and not end.starts_word()):
+            start.backward_word_start()
+            word = self._doc.get_text(start, end)
+
+        if not word and start.backward_char():
+            word = start.get_char()
+            if word.isspace():
+                word = None
+
+        if word:
+            return word, start, end
+        else:
+            return None, None, None
+
+    def get_next_token(self):
+        start = self._doc.get_iter_at_mark(self._doc.get_insert())
+        end = start.copy()
+        word = None
+
+        if start.ends_word() or (start.inside_word() and not start.starts_word()):
+            end.forward_word_end()
+            word = self._doc.get_text(start, end)
+
+        if not word:
+            word = start.get_char()
+            if word.isspace():
+                word = None
+
+        if word:
+            return word, start, end
+        else:
+            return None, None, None
+
+    def compute_indentation(self, cur):
+        """
+        Compute indentation at the given iterator line
+        view : gtk.TextView
+        cur : gtk.TextIter
+        """
+        start = self._doc.get_iter_at_line(cur.get_line())
+        end = start.copy()
+
+        c = end.get_char()
+        while c.isspace() and c not in ('\n', '\r') and end.compare(cur) < 0:
+            if not end.forward_char():
+                break
+            c = end.get_char()
+
+        if start.equal(end):
+            return ''
+        return start.get_slice(end)
+
+    def on_notify_language(self, view, pspec):
+        self.update_language()
+        self.update_active()
+
+    def on_notify_editable(self, view, pspec):
+        self.update_active()
+
+    def on_key_press_event(self, view, event):
+        if event.state & (Gdk.ModifierType.CONTROL_MASK | Gdk.ModifierType.MOD1_MASK):
+            return False
+
+        if event.keyval in (Gdk.KEY_Left, Gdk.KEY_Right):
+            self._stack = []
+
+        if event.keyval == Gdk.KEY_BackSpace:
+            self._stack = []
+
+            if self._last_iter == None:
+                return False
+
+            iter1 = self._doc.get_iter_at_mark(self._doc.get_insert())
+            iter1.backward_char()
+            self._doc.begin_user_action()
+            self._doc.delete(iter1, self._last_iter)
+            self._doc.end_user_action()
+            self._last_iter = None
+            return True
+
+        if event.keyval in (Gdk.KEY_Return, Gdk.KEY_KP_Enter) and \
+           view.get_auto_indent() and self._last_iter != None:
+            # This code has barely been adapted from gtksourceview.c
+            # Note: it might break IM!
+
+            mark = self._doc.get_insert()
+            iter1 = self._doc.get_iter_at_mark(mark)
+
+            indent = self.compute_indentation(iter1)
+            indent = "\n" + indent
+
+            # Insert new line and auto-indent.
+            self._doc.begin_user_action()
+            self._doc.insert(iter1, indent)
+            self._doc.insert(iter1, indent)
+            self._doc.end_user_action()
+
+            # Leave the cursor where we want it to be
+            iter1.backward_chars(len(indent))
+            self._doc.place_cursor(iter1)
+            self.view.scroll_mark_onscreen(mark)
+
+            self._last_iter = None
+            return True
+
+        self._last_iter = None
+        return False
+
+    def on_event_after(self, view, event):
+        if event.type != Gdk.EventType.KEY_PRESS or \
+           event.state & (Gdk.ModifierType.CONTROL_MASK | Gdk.ModifierType.MOD1_MASK) or \
+           event.keyval not in self._bracket_keyvals:
+            return
+
+        # Check if the insert mark is in the range of mark_begin to mark_end
+        # if not we free the stack
+        insert = self._doc.get_insert()
+        iter_begin = self._doc.get_iter_at_mark(self._mark_begin)
+        iter_end = self._doc.get_iter_at_mark(self._mark_end)
+        insert_iter = self._doc.get_iter_at_mark(insert)
+        if not iter_begin.equal(iter_end):
+            if not insert_iter.in_range(iter_begin, iter_end):
+                self._stack = []
+                self._relocate_marks = True
+
+        # Check if the word is not in our brackets
+        word, start, end = self.get_current_token()
+
+        if word not in self._brackets and word not in close_brackets:
+            return
+
+        # If we didn't insert brackets yet we insert them in the insert mark iter
+        if self._relocate_marks == True:
+            insert_iter = self._doc.get_iter_at_mark(insert)
+            self._doc.move_mark(self._mark_begin, insert_iter)
+            self._doc.move_mark(self._mark_end, insert_iter)
+            self._relocate_marks = False
+
+        # Depending on having close bracket or a open bracket we get the opposed
+        # bracket
+        bracket = None
+        bracket2 = None
+
+        if word not in close_brackets:
+            self._stack.append(word)
+            bracket = self._brackets[word]
+        else:
+            bracket2 = close_brackets[word]
+
+        word2, _, _ = self.get_next_token()
+
+        # Check to skip the closing bracket
+        # Example: word = ) and word2 = )
+        if word == word2:
+            if bracket2 != None and self._stack != [] and \
+              self._stack[len(self._stack) - 1] == bracket2:
+                self._stack.pop()
+                self._doc.handler_block(self._handlers[4])
+                self._doc.delete(start, end)
+                self._doc.handler_unblock(self._handlers[4])
+                end.forward_char()
+                self._doc.place_cursor(end)
+            return
+
+        # Insert the closing bracket
+        if bracket != None:
+            self._doc.begin_user_action()
+            self._doc.insert(end, bracket)
+            self._doc.end_user_action()
+
+            # Leave the cursor when we want it to be
+            self._last_iter = end.copy()
+            end.backward_chars(len(bracket))
+            self._doc.place_cursor(end)
+
+    def on_delete_range(self, doc, start, end):
+        self._stack = []
+
+# ex:ts=4:et:

plugins/bracket-complete/meson.build

@@ -0,0 +1,4 @@
+install_subdir(
+    'bracket-complete',
+    install_dir: pluginslibdir
+)

plugins/meson.build

@@ -1,6 +1,7 @@
 pluginsdatadir = join_paths(datadir, 'xed', 'plugins')
 pluginslibdir = join_paths(libdir, 'xed', 'plugins')
 
+subdir('bracket-complete')
 subdir('docinfo')
 subdir('filebrowser')
 subdir('joinlines')