eric6/QScintilla/TypingCompleters/CompleterRuby.py

changeset 6942
2602857055c5
parent 6645
ad476851d7e0
child 6997
24eabcea4c59
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/eric6/QScintilla/TypingCompleters/CompleterRuby.py	Sun Apr 14 15:09:21 2019 +0200
@@ -0,0 +1,214 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2007 - 2019 Detlev Offenbach <detlev@die-offenbachs.de>
+#
+
+"""
+Module implementing a typing completer for Ruby.
+"""
+
+from __future__ import unicode_literals
+
+import re
+
+from PyQt5.QtCore import QRegExp
+from PyQt5.Qsci import QsciLexerRuby
+
+from .CompleterBase import CompleterBase
+
+import Preferences
+
+
+class CompleterRuby(CompleterBase):
+    """
+    Class implementing typing completer for Ruby.
+    """
+    def __init__(self, editor, parent=None):
+        """
+        Constructor
+        
+        @param editor reference to the editor object (QScintilla.Editor)
+        @param parent reference to the parent object (QObject)
+        """
+        CompleterBase.__init__(self, editor, parent)
+        
+        self.__beginRX = QRegExp(r"""^=begin """)
+        self.__beginNlRX = QRegExp(r"""^=begin\r?\n""")
+        self.__hereRX = QRegExp(r"""<<-?['"]?(\w*)['"]?\r?\n""")
+        
+        self.readSettings()
+    
+    def readSettings(self):
+        """
+        Public slot called to reread the configuration parameters.
+        """
+        self.setEnabled(Preferences.getEditorTyping("Ruby/EnabledTypingAids"))
+        self.__insertClosingBrace = \
+            Preferences.getEditorTyping("Ruby/InsertClosingBrace")
+        self.__indentBrace = \
+            Preferences.getEditorTyping("Ruby/IndentBrace")
+        self.__skipBrace = \
+            Preferences.getEditorTyping("Ruby/SkipBrace")
+        self.__insertQuote = \
+            Preferences.getEditorTyping("Ruby/InsertQuote")
+        self.__insertBlank = \
+            Preferences.getEditorTyping("Ruby/InsertBlank")
+        self.__insertHereDoc = \
+            Preferences.getEditorTyping("Ruby/InsertHereDoc")
+        self.__insertInlineDoc = \
+            Preferences.getEditorTyping("Ruby/InsertInlineDoc")
+
+    def charAdded(self, charNumber):
+        """
+        Public slot called to handle the user entering a character.
+        
+        @param charNumber value of the character entered (integer)
+        """
+        char = chr(charNumber)
+        if char not in ['(', ')', '{', '}', '[', ']', ',', "'", '"',
+                        '\n', ' ']:
+            return  # take the short route
+        
+        line, col = self.editor.getCursorPosition()
+        
+        if self.__inComment(line, col) or \
+           self.__inDoubleQuotedString() or \
+           self.__inSingleQuotedString() or \
+           self.__inHereDocument() or \
+           self.__inInlineDocument():
+            return
+        
+        # open parenthesis
+        # insert closing parenthesis and self
+        if char == '(':
+            txt = self.editor.text(line)[:col]
+            if self.__insertClosingBrace:
+                self.editor.insert(')')
+        
+        # closing parenthesis
+        # skip matching closing parenthesis
+        elif char in [')', '}', ']']:
+            txt = self.editor.text(line)
+            if col < len(txt) and char == txt[col]:
+                if self.__skipBrace:
+                    self.editor.setSelection(line, col, line, col + 1)
+                    self.editor.removeSelectedText()
+        
+        # space
+        # complete inline documentation
+        elif char == ' ':
+            txt = self.editor.text(line)[:col]
+            if self.__insertInlineDoc and self.__beginRX.exactMatch(txt):
+                self.editor.insert('=end')
+        
+        # comma
+        # insert blank
+        elif char == ',':
+            if self.__insertBlank:
+                self.editor.insert(' ')
+                self.editor.setCursorPosition(line, col + 1)
+        
+        # open curly brace
+        # insert closing brace
+        elif char == '{':
+            if self.__insertClosingBrace:
+                self.editor.insert('}')
+        
+        # open bracket
+        # insert closing bracket
+        elif char == '[':
+            if self.__insertClosingBrace:
+                self.editor.insert(']')
+        
+        # double quote
+        # insert double quote
+        elif char == '"':
+            if self.__insertQuote:
+                self.editor.insert('"')
+        
+        # quote
+        # insert quote
+        elif char == '\'':
+            if self.__insertQuote:
+                self.editor.insert('\'')
+        
+        # new line
+        # indent to opening brace, complete inline documentation
+        elif char == '\n':
+            txt = self.editor.text(line - 1)
+            if self.__insertInlineDoc and self.__beginNlRX.exactMatch(txt):
+                self.editor.insert('=end')
+            elif self.__insertHereDoc and self.__hereRX.exactMatch(txt):
+                self.editor.insert(self.__hereRX.cap(1))
+            elif self.__indentBrace and re.search(":\r?\n", txt) is None:
+                openCount = len(re.findall("[({[]", txt))
+                closeCount = len(re.findall(r"[)}\]]", txt))
+                if openCount > closeCount:
+                    openCount = 0
+                    closeCount = 0
+                    openList = list(re.finditer("[({[]", txt))
+                    index = len(openList) - 1
+                    while index > -1 and openCount == closeCount:
+                        lastOpenIndex = openList[index].start()
+                        txt2 = txt[lastOpenIndex:]
+                        openCount = len(re.findall("[({[]", txt2))
+                        closeCount = len(re.findall(r"[)}\]]", txt2))
+                        index -= 1
+                    if openCount > closeCount and lastOpenIndex > col:
+                        self.editor.insert(' ' * (lastOpenIndex - col + 1))
+                        self.editor.setCursorPosition(line, lastOpenIndex + 1)
+    
+    def __inComment(self, line, col):
+        """
+        Private method to check, if the cursor is inside a comment.
+        
+        @param line current line (integer)
+        @param col current position within line (integer)
+        @return flag indicating, if the cursor is inside a comment (boolean)
+        """
+        txt = self.editor.text(line)
+        if col == len(txt):
+            col -= 1
+        while col >= 0:
+            if txt[col] == "#":
+                return True
+            col -= 1
+        return False
+    
+    def __inDoubleQuotedString(self):
+        """
+        Private method to check, if the cursor is within a double quoted
+        string.
+        
+        @return flag indicating, if the cursor is inside a double
+            quoted string (boolean)
+        """
+        return self.editor.currentStyle() == QsciLexerRuby.DoubleQuotedString
+    
+    def __inSingleQuotedString(self):
+        """
+        Private method to check, if the cursor is within a single quoted
+        string.
+        
+        @return flag indicating, if the cursor is inside a single
+            quoted string (boolean)
+        """
+        return self.editor.currentStyle() == QsciLexerRuby.SingleQuotedString
+    
+    def __inHereDocument(self):
+        """
+        Private method to check, if the cursor is within a here document.
+        
+        @return flag indicating, if the cursor is inside a here document
+            (boolean)
+        """
+        return self.editor.currentStyle() == QsciLexerRuby.HereDocument
+    
+    def __inInlineDocument(self):
+        """
+        Private method to check, if the cursor is within an inline document.
+        
+        @return flag indicating, if the cursor is inside an inline document
+            (boolean)
+        """
+        return self.editor.currentStyle() == QsciLexerRuby.POD

eric ide

mercurial