1# -*- coding: utf-8 -*- 2 3# Copyright (c) 2005 - 2021 Detlev Offenbach <detlev@die-offenbachs.de> 4# 5 6""" 7Module implementing a Ruby lexer with some additional methods. 8""" 9 10import contextlib 11 12from PyQt5.Qsci import QsciLexerRuby 13 14from .Lexer import Lexer 15import Preferences 16 17 18class LexerRuby(Lexer, QsciLexerRuby): 19 """ 20 Subclass to implement some additional lexer dependant methods. 21 """ 22 def __init__(self, parent=None): 23 """ 24 Constructor 25 26 @param parent parent widget of this lexer 27 """ 28 QsciLexerRuby.__init__(self, parent) 29 Lexer.__init__(self) 30 31 self.commentString = "#" 32 33 self.keywordSetDescriptions = [ 34 self.tr("Keywords"), 35 ] 36 37 def initProperties(self): 38 """ 39 Public slot to initialize the properties. 40 """ 41 with contextlib.suppress(AttributeError): 42 self.setFoldCompact(Preferences.getEditor("AllFoldCompact")) 43 self.setFoldComments(Preferences.getEditor("RubyFoldComment")) 44 45 def autoCompletionWordSeparators(self): 46 """ 47 Public method to return the list of separators for autocompletion. 48 49 @return list of separators (list of strings) 50 """ 51 return ['.'] 52 53 def isCommentStyle(self, style): 54 """ 55 Public method to check, if a style is a comment style. 56 57 @param style style to check (integer) 58 @return flag indicating a comment style (boolean) 59 """ 60 return style in [QsciLexerRuby.Comment] 61 62 def isStringStyle(self, style): 63 """ 64 Public method to check, if a style is a string style. 65 66 @param style style to check (integer) 67 @return flag indicating a string style (boolean) 68 """ 69 return style in [QsciLexerRuby.DoubleQuotedString, 70 QsciLexerRuby.HereDocument, 71 QsciLexerRuby.PercentStringQ, 72 QsciLexerRuby.PercentStringq, 73 QsciLexerRuby.PercentStringr, 74 QsciLexerRuby.PercentStringw, 75 QsciLexerRuby.PercentStringx, 76 QsciLexerRuby.SingleQuotedString] 77 78 def defaultKeywords(self, kwSet): 79 """ 80 Public method to get the default keywords. 81 82 @param kwSet number of the keyword set (integer) 83 @return string giving the keywords (string) or None 84 """ 85 return QsciLexerRuby.keywords(self, kwSet) 86