--- a/src/eric7/QScintilla/Lexers/SubstyledLexer.py Wed Jul 13 11:16:20 2022 +0200
+++ b/src/eric7/QScintilla/Lexers/SubstyledLexer.py Wed Jul 13 14:55:47 2022 +0200
@@ -20,12 +20,13 @@
"""
Class to implement the sub-styled lexer mixin class.
"""
+
def __init__(self):
"""
Constructor
"""
super().__init__()
-
+
self.baseStyles = []
# list of style numbers, that support sub-styling
self.defaultSubStyles = {}
@@ -44,51 +45,52 @@
# 'font_bold: bold font (bool)
# 'font_italic: italic font (bool)
# 'font_underline: underlined font (bool)
-
+
self.__subStyles = {}
self.__subStylesInitialized = False
-
+
def loadAllDefaultSubStyles(self):
"""
Public method to load the default sub-style definitions.
"""
self.__subStyles = copy.deepcopy(self.defaultSubStyles)
-
+
self.__subStylesInitialized = True
-
+
def loadDefaultSubStyles(self, style):
"""
Public method to load the default sub-styles for a given base style.
-
+
@param style style number
@type int
"""
if style in self.defaultSubStyles:
- self.__subStyles[style] = copy.deepcopy(
- self.defaultSubStyles[style])
-
+ self.__subStyles[style] = copy.deepcopy(self.defaultSubStyles[style])
+
def loadSubstyles(self):
"""
Public method to load the sub-styles from the settings file.
"""
settings = Preferences.getSettings()
-
+
# Step 1: check if sub-styles were defined and saved
subStylesDefined = False
for baseStyle in self.baseStyles:
key = "Scintilla/{0}/style{1}/SubStyleLength".format(
- self.language(), baseStyle)
+ self.language(), baseStyle
+ )
subStylesDefined |= settings.contains(key)
# Step 2.1: load default sub-styles, if none were defined
if not subStylesDefined:
self.loadAllDefaultSubStyles()
-
+
# Step 2.2: load from settings file
else:
self.__subStyles = {}
for baseStyle in self.baseStyles:
key = "Scintilla/{0}/style{1}/SubStyleLength".format(
- self.language(), baseStyle)
+ self.language(), baseStyle
+ )
if settings.contains(key):
subStyleLength = int(settings.value(key))
if subStyleLength:
@@ -100,11 +102,13 @@
if settings.contains(substyleKey + "Description"):
subStyleData = {}
subStyleData["Description"] = settings.value(
- substyleKey + "Description", "")
+ substyleKey + "Description", ""
+ )
subStyleData["Words"] = settings.value(
- substyleKey + "Words", "")
+ substyleKey + "Words", ""
+ )
style = {}
-
+
key = substyleKey + "fore"
if settings.contains(key):
style["fore"] = int(settings.value(key))
@@ -114,79 +118,75 @@
key = substyleKey + "eolfill"
if settings.contains(key):
style["eolfill"] = Preferences.toBool(
- settings.value(key))
+ settings.value(key)
+ )
key = substyleKey + "font_family"
if settings.contains(key):
style["font_family"] = settings.value(key)
key = substyleKey + "font_size"
if settings.contains(key):
- style["font_size"] = (
- int(settings.value(key))
- )
+ style["font_size"] = int(settings.value(key))
key = substyleKey + "font_bold"
if settings.contains(key):
style["font_bold"] = Preferences.toBool(
- settings.value(key))
+ settings.value(key)
+ )
key = substyleKey + "font_italic"
if settings.contains(key):
style["font_italic"] = Preferences.toBool(
- settings.value(key))
+ settings.value(key)
+ )
key = substyleKey + "font_underline"
if settings.contains(key):
- style["font_underline"] = (
- Preferences.toBool(settings.value(key))
+ style["font_underline"] = Preferences.toBool(
+ settings.value(key)
)
-
+
subStyleData["Style"] = style
-
- self.__subStyles[baseStyle][subStyle] = (
- subStyleData
- )
-
+
+ self.__subStyles[baseStyle][subStyle] = subStyleData
+
else:
# initialize with default
- self.__subStyles[baseStyle][subStyle] = (
- copy.deepcopy(self.defaultSubStyles
- [baseStyle][subStyle])
+ self.__subStyles[baseStyle][subStyle] = copy.deepcopy(
+ self.defaultSubStyles[baseStyle][subStyle]
)
-
+
self.__subStylesInitialized = True
-
+
def readSubstyles(self, editor):
"""
Public method to load the sub-styles and configure the editor.
-
+
@param editor reference to the editor object
@type QsciScintilla
"""
- subStyleBasesLength = editor.SendScintilla(
- editor.SCI_GETSUBSTYLEBASES, 0, None)
+ subStyleBasesLength = editor.SendScintilla(editor.SCI_GETSUBSTYLEBASES, 0, None)
if not subStyleBasesLength:
# lexer does not support sub-styling
return
-
+
self.loadSubstyles()
-
+
# free existing sub-styles first
editor.SendScintilla(editor.SCI_FREESUBSTYLES)
subStyleBases = b"\00" * (subStyleBasesLength + 1)
editor.SendScintilla(editor.SCI_GETSUBSTYLEBASES, 0, subStyleBases)
- distanceToSecondary = editor.SendScintilla(
- editor.SCI_DISTANCETOSECONDARYSTYLES)
-
+ distanceToSecondary = editor.SendScintilla(editor.SCI_DISTANCETOSECONDARYSTYLES)
+
subStyleBases = [b for b in bytearray(subStyleBases[:-1])]
if distanceToSecondary:
- subStyleBases.extend(b + distanceToSecondary
- for b in subStyleBases[:])
+ subStyleBases.extend(b + distanceToSecondary for b in subStyleBases[:])
for baseStyleNo in subStyleBases:
if baseStyleNo in self.__subStyles:
subStylesData = self.__subStyles[baseStyleNo]
subStyleLength = len(subStylesData)
subStyleStart = editor.SendScintilla(
- editor.SCI_ALLOCATESUBSTYLES, baseStyleNo, subStyleLength)
+ editor.SCI_ALLOCATESUBSTYLES, baseStyleNo, subStyleLength
+ )
if subStyleStart < 0:
continue
-
+
for subStyleIndex, subStyleKey in enumerate(
sorted(subStylesData.keys())
):
@@ -194,39 +194,40 @@
subStyle = subStylesData[subStyleKey]
# set the words
editor.SendScintilla(
- editor.SCI_SETIDENTIFIERS,
- styleNo,
- subStyle["Words"].encode())
-
+ editor.SCI_SETIDENTIFIERS, styleNo, subStyle["Words"].encode()
+ )
+
# set the style
style = subStyle["Style"]
color = (
QColor(
- style["fore"] >> 16 & 0xff,
- style["fore"] >> 8 & 0xff,
- style["fore"] & 0xff,)
- if "fore" in style else
- self.color(baseStyleNo)
+ style["fore"] >> 16 & 0xFF,
+ style["fore"] >> 8 & 0xFF,
+ style["fore"] & 0xFF,
+ )
+ if "fore" in style
+ else self.color(baseStyleNo)
)
self.setColor(color, styleNo)
-
+
color = (
QColor(
- style["paper"] >> 16 & 0xff,
- style["paper"] >> 8 & 0xff,
- style["paper"] & 0xff,)
- if "paper" in style else
- self.paper(baseStyleNo)
+ style["paper"] >> 16 & 0xFF,
+ style["paper"] >> 8 & 0xFF,
+ style["paper"] & 0xFF,
+ )
+ if "paper" in style
+ else self.paper(baseStyleNo)
)
self.setPaper(color, styleNo)
-
+
eolFill = (
style["eolfill"]
- if "eolfill" in style else
- self.eolFill(baseStyleNo)
+ if "eolfill" in style
+ else self.eolFill(baseStyleNo)
)
self.setEolFill(eolFill, styleNo)
-
+
font = self.font(baseStyleNo)
if "font_family" in style:
font.setFamily(style["font_family"])
@@ -239,53 +240,53 @@
if "font_underline" in style:
font.setUnderline(style["font_underline"])
self.setFont(font, styleNo)
-
+
def writeSubstyles(self):
"""
Public method to save the sub-styles.
"""
if not self.__subStylesInitialized:
return
-
+
settings = Preferences.getSettings()
-
+
# Step 1: remove all sub-style definitions first
for baseStyle in self.baseStyles:
key = "Scintilla/{0}/style{1}/SubStyleLength".format(
- self.language(), baseStyle)
+ self.language(), baseStyle
+ )
if settings.contains(key):
subStyleLength = int(settings.value(key))
if subStyleLength:
for subStyle in range(subStyleLength):
- substyleKey = (
- "Scintilla/{0}/style{1}/substyle{2}/"
- ).format(self.language(), baseStyle, subStyle)
+ substyleKey = ("Scintilla/{0}/style{1}/substyle{2}/").format(
+ self.language(), baseStyle, subStyle
+ )
settings.remove(substyleKey)
-
+
# Step 2: save the defined sub-styles
for baseStyle in self.baseStyles:
key = "Scintilla/{0}/style{1}/SubStyleLength".format(
- self.language(), baseStyle)
+ self.language(), baseStyle
+ )
settings.setValue(key, len(self.__subStyles[baseStyle]))
for subStyleIndex, subStyle in enumerate(
sorted(self.__subStyles[baseStyle].keys())
):
substyleKey = "Scintilla/{0}/style{1}/substyle{2}/".format(
- self.language(), baseStyle, subStyleIndex)
+ self.language(), baseStyle, subStyleIndex
+ )
subStyleData = self.__subStyles[baseStyle][subStyle]
-
- if (
- not subStyleData["Description"] and
- not subStyleData["Words"]
- ):
+
+ if not subStyleData["Description"] and not subStyleData["Words"]:
# invalid or incomplete sub-style definition
continue
-
- settings.setValue(substyleKey + "Description",
- subStyleData["Description"])
- settings.setValue(substyleKey + "Words",
- subStyleData["Words"])
-
+
+ settings.setValue(
+ substyleKey + "Description", subStyleData["Description"]
+ )
+ settings.setValue(substyleKey + "Words", subStyleData["Words"])
+
style = subStyleData["Style"]
if "fore" in style:
color = style["fore"]
@@ -312,47 +313,46 @@
settings.setValue(substyleKey + "font_italic", italic)
underline = (
style["font_underline"]
- if "font_underline" in style else
- font.underline()
+ if "font_underline" in style
+ else font.underline()
)
settings.setValue(substyleKey + "font_underline", underline)
-
+
def hasSubstyles(self):
"""
Public method to indicate the support of sub-styles.
-
+
@return flag indicating sub-styling support
@rtype bool
"""
return True
-
+
def getBaseStyles(self):
"""
Public method to get the list of supported base styles.
-
+
@return list of base styles
@rtype list of int
"""
return self.baseStyles[:]
-
+
def substylesCount(self, style):
"""
Public method to get the number of defined sub-styles.
-
+
@param style base style number
@type int
@return number of defined sub-styles
@rtype int
"""
- count = (len(self.__subStyles[style]) if style in self.__subStyles
- else 0)
-
+ count = len(self.__subStyles[style]) if style in self.__subStyles else 0
+
return count
-
+
def setSubstyleDescription(self, description, style, substyle):
"""
Public method to set the description for a sub-style.
-
+
@param description description to be set
@type str
@param style base style number
@@ -361,14 +361,12 @@
@type int
"""
if style in self.__subStyles and substyle in self.__subStyles[style]:
- self.__subStyles[style][substyle]["Description"] = (
- description.strip()
- )
-
+ self.__subStyles[style][substyle]["Description"] = description.strip()
+
def substyleDescription(self, style, substyle):
"""
Public method to get the description of a sub-style.
-
+
@param style base style number
@type int
@param substyle sub-style number
@@ -378,17 +376,16 @@
"""
desc = (
self.__subStyles[style][substyle]["Description"].strip()
- if (style in self.__subStyles and
- substyle in self.__subStyles[style]) else
- ""
+ if (style in self.__subStyles and substyle in self.__subStyles[style])
+ else ""
)
-
+
return desc
-
+
def setSubstyleWords(self, words, style, substyle):
"""
Public method to set the words for a sub-style.
-
+
@param words words to be set separated by white-space
@type str
@param style base style number
@@ -398,11 +395,11 @@
"""
if style in self.__subStyles and substyle in self.__subStyles[style]:
self.__subStyles[style][substyle]["Words"] = words.strip()
-
+
def substyleWords(self, style, substyle):
"""
Public method to get the words of a sub-style.
-
+
@param style base style number
@type int
@param substyle sub-style number
@@ -412,17 +409,16 @@
"""
words = (
self.__subStyles[style][substyle]["Words"].strip()
- if (style in self.__subStyles and
- substyle in self.__subStyles[style]) else
- ""
+ if (style in self.__subStyles and substyle in self.__subStyles[style])
+ else ""
)
-
+
return words
-
+
def setSubstyleColor(self, color, style, substyle):
"""
Public method to set the foreground color of a sub-style.
-
+
@param color foreground color to be set
@type QColor
@param style base style number
@@ -434,11 +430,11 @@
self.__subStyles[style][substyle]["Style"]["fore"] = (
color.red() << 16 | color.green() << 8 | color.blue()
)
-
+
def substyleColor(self, style, substyle):
"""
Public method to get the sub-style foreground color.
-
+
@param style base style number
@type int
@param substyle sub-style number
@@ -447,22 +443,22 @@
@rtype QColor
"""
color = self.color(style)
-
+
if style in self.__subStyles and substyle in self.__subStyles[style]:
styleData = self.__subStyles[style][substyle]["Style"]
if "fore" in styleData:
color = QColor(
- styleData["fore"] >> 16 & 0xff,
- styleData["fore"] >> 8 & 0xff,
- styleData["fore"] & 0xff,
+ styleData["fore"] >> 16 & 0xFF,
+ styleData["fore"] >> 8 & 0xFF,
+ styleData["fore"] & 0xFF,
)
-
+
return color
-
+
def setSubstylePaper(self, color, style, substyle):
"""
Public method to set the background color of a sub-style.
-
+
@param color background color to be set
@type QColor
@param style base style number
@@ -474,11 +470,11 @@
self.__subStyles[style][substyle]["Style"]["paper"] = (
color.red() << 16 | color.green() << 8 | color.blue()
)
-
+
def substylePaper(self, style, substyle):
"""
Public method to get the sub-style background color.
-
+
@param style base style number
@type int
@param substyle sub-style number
@@ -487,22 +483,22 @@
@rtype QColor
"""
color = self.paper(style)
-
+
if style in self.__subStyles and substyle in self.__subStyles[style]:
styleData = self.__subStyles[style][substyle]["Style"]
if "paper" in styleData:
color = QColor(
- styleData["paper"] >> 16 & 0xff,
- styleData["paper"] >> 8 & 0xff,
- styleData["paper"] & 0xff,
+ styleData["paper"] >> 16 & 0xFF,
+ styleData["paper"] >> 8 & 0xFF,
+ styleData["paper"] & 0xFF,
)
-
+
return color
-
+
def setSubstyleEolFill(self, eolFill, style, substyle):
"""
Public method to set the eolfill flag of a sub-style.
-
+
@param eolFill eolfill flag to be set
@type bool
@param style base style number
@@ -511,14 +507,12 @@
@type int
"""
if style in self.__subStyles and substyle in self.__subStyles[style]:
- self.__subStyles[style][substyle]["Style"]["eolfill"] = (
- eolFill
- )
-
+ self.__subStyles[style][substyle]["Style"]["eolfill"] = eolFill
+
def substyleEolFill(self, style, substyle):
"""
Public method to get the eolfill flag.
-
+
@param style base style number
@type int
@param substyle sub-style number
@@ -527,17 +521,17 @@
@rtype bool
"""
eolFill = self.eolFill(style)
-
+
if style in self.__subStyles and substyle in self.__subStyles[style]:
styleData = self.__subStyles[style][substyle]["Style"]
eolFill = styleData.get("eolfill", self.eolFill(style))
-
+
return eolFill
-
+
def setSubstyleFont(self, font, style, substyle):
"""
Public method to set the font of a sub-style.
-
+
@param font font to be set
@type QFont
@param style base style number
@@ -546,26 +540,18 @@
@type int
"""
if style in self.__subStyles and substyle in self.__subStyles[style]:
- self.__subStyles[style][substyle]["Style"]["font_family"] = (
- font.family()
- )
- self.__subStyles[style][substyle]["Style"]["font_size"] = (
- font.pointSize()
- )
- self.__subStyles[style][substyle]["Style"]["font_bold"] = (
- font.bold()
- )
- self.__subStyles[style][substyle]["Style"]["font_italic"] = (
- font.italic()
- )
- self.__subStyles[style][substyle]["Style"]["font_underline"] = (
- font.underline()
- )
-
+ self.__subStyles[style][substyle]["Style"]["font_family"] = font.family()
+ self.__subStyles[style][substyle]["Style"]["font_size"] = font.pointSize()
+ self.__subStyles[style][substyle]["Style"]["font_bold"] = font.bold()
+ self.__subStyles[style][substyle]["Style"]["font_italic"] = font.italic()
+ self.__subStyles[style][substyle]["Style"][
+ "font_underline"
+ ] = font.underline()
+
def substyleFont(self, style, substyle):
"""
Public method to get the sub-style font.
-
+
@param style base style number
@type int
@param substyle sub-style number
@@ -574,7 +560,7 @@
@rtype QFont
"""
font = self.font(style)
-
+
if style in self.__subStyles and substyle in self.__subStyles[style]:
styleData = self.__subStyles[style][substyle]["Style"]
if "font_family" in styleData:
@@ -587,13 +573,13 @@
font.setItalic(styleData["font_italic"])
if "font_underline" in styleData:
font.setUnderline(styleData["font_underline"])
-
+
return font
-
+
def substyleDefaultDescription(self, style, substyle):
"""
Public method to get the default description of a sub-style.
-
+
@param style base style number
@type int
@param substyle sub-style number
@@ -602,20 +588,17 @@
@rtype str
"""
description = ""
-
- if (
- style in self.defaultSubStyles and
- substyle in self.defaultSubStyles[style]
- ):
+
+ if style in self.defaultSubStyles and substyle in self.defaultSubStyles[style]:
substyleData = self.defaultSubStyles[style][substyle]
description = substyleData["Description"].strip()
-
+
return description
-
+
def substyleDefaultWords(self, style, substyle):
"""
Public method to get the default words of a sub-style.
-
+
@param style base style number
@type int
@param substyle sub-style number
@@ -624,20 +607,17 @@
@rtype str
"""
words = ""
-
- if (
- style in self.defaultSubStyles and
- substyle in self.defaultSubStyles[style]
- ):
+
+ if style in self.defaultSubStyles and substyle in self.defaultSubStyles[style]:
substyleData = self.defaultSubStyles[style][substyle]
words = substyleData["Words"].strip()
-
+
return words
-
+
def substyleDefaultColor(self, style, substyle):
"""
Public method to get the sub-style default foreground color.
-
+
@param style base style number
@type int
@param substyle sub-style number
@@ -646,25 +626,22 @@
@rtype QColor
"""
color = self.defaultColor(style)
-
- if (
- style in self.defaultSubStyles and
- substyle in self.defaultSubStyles[style]
- ):
+
+ if style in self.defaultSubStyles and substyle in self.defaultSubStyles[style]:
styleData = self.defaultSubStyles[style][substyle]["Style"]
if "fore" in styleData:
color = QColor(
- styleData["fore"] >> 16 & 0xff,
- styleData["fore"] >> 8 & 0xff,
- styleData["fore"] & 0xff,
+ styleData["fore"] >> 16 & 0xFF,
+ styleData["fore"] >> 8 & 0xFF,
+ styleData["fore"] & 0xFF,
)
-
+
return color
-
+
def substyleDefaultPaper(self, style, substyle):
"""
Public method to get the sub-style default background color.
-
+
@param style base style number
@type int
@param substyle sub-style number
@@ -673,25 +650,22 @@
@rtype QColor
"""
color = self.defaultPaper(style)
-
- if (
- style in self.defaultSubStyles and
- substyle in self.defaultSubStyles[style]
- ):
+
+ if style in self.defaultSubStyles and substyle in self.defaultSubStyles[style]:
styleData = self.defaultSubStyles[style][substyle]["Style"]
if "paper" in styleData:
color = QColor(
- styleData["paper"] >> 16 & 0xff,
- styleData["paper"] >> 8 & 0xff,
- styleData["paper"] & 0xff,
+ styleData["paper"] >> 16 & 0xFF,
+ styleData["paper"] >> 8 & 0xFF,
+ styleData["paper"] & 0xFF,
)
-
+
return color
-
+
def substyleDefaultEolFill(self, style, substyle):
"""
Public method to get the default eolfill flag.
-
+
@param style base style number
@type int
@param substyle sub-style number
@@ -700,20 +674,17 @@
@rtype bool
"""
eolFill = self.defaultEolFill(style)
-
- if (
- style in self.defaultSubStyles and
- substyle in self.defaultSubStyles[style]
- ):
+
+ if style in self.defaultSubStyles and substyle in self.defaultSubStyles[style]:
styleData = self.defaultSubStyles[style][substyle]["Style"]
eolFill = styleData.get("eolfill", self.defaultEolFill(style))
-
+
return eolFill
-
+
def substyleDefaultFont(self, style, substyle):
"""
Public method to get the default sub-style font.
-
+
@param style base style number
@type int
@param substyle sub-style number
@@ -722,11 +693,8 @@
@rtype QFont
"""
font = self.defaultFont(style)
-
- if (
- style in self.defaultSubStyles and
- substyle in self.defaultSubStyles[style]
- ):
+
+ if style in self.defaultSubStyles and substyle in self.defaultSubStyles[style]:
styleData = self.defaultSubStyles[style][substyle]["Style"]
if "font_family" in styleData:
font.setFamily(styleData["font_family"])
@@ -738,13 +706,13 @@
font.setItalic(styleData["font_italic"])
if "font_underline" in styleData:
font.setUnderline(styleData["font_underline"])
-
+
return font
-
+
def addSubstyle(self, style):
"""
Public method to add an empty sub-style to a given base style.
-
+
@param style base style number
@type int
@return allocated sub-style number or -1 to indicate an error
@@ -760,13 +728,13 @@
}
else:
subStyle = -1
-
+
return subStyle
-
+
def delSubstyle(self, style, substyle):
"""
Public method to delete a given sub-style definition.
-
+
@param style base style number
@type int
@param substyle sub-style number
@@ -775,17 +743,17 @@
@rtype bool
"""
ok = False
-
+
if style in self.__subStyles and substyle in self.__subStyles[style]:
del self.__subStyles[style][substyle]
ok = True
-
+
return ok
-
+
def hasSubstyle(self, style, substyle):
"""
Public method to test for a given sub-style definition.
-
+
@param style base style number
@type int
@param substyle sub-style number
@@ -793,13 +761,12 @@
@return flag indicating the existence of a sub-style definition
@rtype bool
"""
- return (style in self.__subStyles and
- substyle in self.__subStyles[style])
-
+ return style in self.__subStyles and substyle in self.__subStyles[style]
+
def isBaseStyle(self, style):
"""
Public method to test, if a given style may have sub-styles.
-
+
@param style base style number
@type int
@return flag indicating that the style may have sub-styles
