Inheritance diagram for krita.sceditor.highlighter.PythonHighlighter:

Public Member Functions
	__init__ (self, edit)

	highlightBlock (self, text)

	highlightRules (self, text, start, finish)

	updateFonts (self, font)

	updateHighlighter (self, font)

	updateRules (self)

Public Attributes
	base_format

	callableFormat

	document

	empty_format

	keywordFormat

	keywords

	magicFormat

	multiLineStringBegin

	multiLineStringEnd

	multiLineStringFormat

	qtFormat

	quotationFormat1

	quotationFormat2

	rules

	selfFormat

	singleLineCommentFormat

Static Public Attributes
tuple	keywords

Detailed Description

Definition at line 18 of file highlighter.py.

Constructor & Destructor Documentation

◆ init()

krita.sceditor.highlighter.PythonHighlighter.__init__	(		self,
			edit )

Reimplemented in krita.sceditor.highlighter.QtQmlHighlighter.

Definition at line 29 of file highlighter.py.

    def __init__(self, edit):
        document = edit.document()
        QtGui.QSyntaxHighlighter.__init__(self, document)
 
        base_format = QtGui.QTextCharFormat()
        base_format.setFont(edit.font())
 
        self.base_format = base_format
        self.document = document
 
        self.updateHighlighter(base_format.font())
 

Member Function Documentation

◆ highlightBlock()

krita.sceditor.highlighter.PythonHighlighter.highlightBlock	(		self,
			text )

Definition at line 41 of file highlighter.py.

    def highlightBlock(self, text):
 
        self.setCurrentBlockState(0)
 
        if text.trimmed().isEmpty():
            self.setFormat(0, len(text), self.empty_format)
            return
 
        self.setFormat(0, len(text), self.base_format)
 
        startIndex = 0
        if self.previousBlockState() != 1:
            startIndex = self.multiLineStringBegin.indexIn(text)
 
        if startIndex > -1:
            self.highlightRules(text, 0, startIndex)
        else:
            self.highlightRules(text, 0, len(text))
 
        while startIndex >= 0:
 
            endIndex = self.multiLineStringEnd.indexIn(text,
                                                       startIndex + len(self.multiLineStringBegin.pattern()))
            if endIndex == -1:
                self.setCurrentBlockState(1)
                commentLength = text.length() - startIndex
            else:
                commentLength = endIndex - startIndex + \
                    self.multiLineStringEnd.matchedLength()
                self.highlightRules(text, endIndex, len(text))
 
            self.setFormat(startIndex, commentLength, self.multiLineStringFormat)
            startIndex = self.multiLineStringBegin.indexIn(text,
                                                           startIndex + commentLength)
 

References KisPipeBrushParasite.dim, KisSpinBoxUnitManager.dim, FlattenSpec.dim, and xcfLayer.dim.

◆ highlightRules()

krita.sceditor.highlighter.PythonHighlighter.highlightRules	(	self,
		text,
		start,
		finish )

Definition at line 76 of file highlighter.py.

    def highlightRules(self, text, start, finish):
 
        for expression, format in self.rules:
 
            index = expression.indexIn(text, start)
            while index >= start and index < finish:
                length = expression.matchedLength()
                self.setFormat(index, min(length, finish - index), format)
                index = expression.indexIn(text, index + length)
 

References krita.sceditor.highlighter.PythonHighlighter.rules, krita.sceditor.highlighter.QtQmlHighlighter.rules, scripter.ui_scripter.syntax.syntax.PythonHighlighter.rules, KisCompositeProgressProxy.setFormat(), KisNodeProgressProxy.setFormat(), KoFakeProgressProxy.setFormat(), KoProgressBar.setFormat(), KoUpdater.setFormat(), KoProgressProxy.setFormat(), and RecorderConfig.setFormat().

◆ updateFonts()

krita.sceditor.highlighter.PythonHighlighter.updateFonts	(		self,
			font )

Definition at line 86 of file highlighter.py.

    def updateFonts(self, font):
 
        self.base_format.setFont(font)
        self.empty_format = QtGui.QTextCharFormat(self.base_format)
        # self.empty_format.setFontPointSize(font.pointSize()/4.0)
 
        self.keywordFormat = QtGui.QTextCharFormat(self.base_format)
        self.keywordFormat.setForeground(QtCore.Qt.GlobalColor.darkBlue)
        self.keywordFormat.setFontWeight(QtGui.QFont.Weight.Bold)
        self.callableFormat = QtGui.QTextCharFormat(self.base_format)
        self.callableFormat.setForeground(QtCore.Qt.GlobalColor.darkBlue)
        self.magicFormat = QtGui.QTextCharFormat(self.base_format)
        self.magicFormat.setForeground(QtGui.QColor(224, 128, 0))
        self.qtFormat = QtGui.QTextCharFormat(self.base_format)
        self.qtFormat.setForeground(QtCore.Qt.GlobalColor.blue)
        self.qtFormat.setFontWeight(QtGui.QFont.Weight.Bold)
        self.selfFormat = QtGui.QTextCharFormat(self.base_format)
        self.selfFormat.setForeground(QtCore.Qt.GlobalColor.red)
        # self.selfFormat.setFontItalic(True)
        self.singleLineCommentFormat = QtGui.QTextCharFormat(self.base_format)
        self.singleLineCommentFormat.setForeground(QtCore.Qt.GlobalColor.darkGreen)
        self.multiLineStringFormat = QtGui.QTextCharFormat(self.base_format)
        self.multiLineStringFormat.setBackground(
            QtGui.QBrush(QtGui.QColor(127, 127, 255)))
        self.quotationFormat1 = QtGui.QTextCharFormat(self.base_format)
        self.quotationFormat1.setForeground(QtCore.Qt.GlobalColor.blue)
        self.quotationFormat2 = QtGui.QTextCharFormat(self.base_format)
        self.quotationFormat2.setForeground(QtCore.Qt.GlobalColor.blue)
 

References krita.sceditor.highlighter.PythonHighlighter.base_format, and krita.sceditor.highlighter.PythonHighlighter.empty_format.

◆ updateHighlighter()

krita.sceditor.highlighter.PythonHighlighter.updateHighlighter	(		self,
			font )

Definition at line 134 of file highlighter.py.

    def updateHighlighter(self, font):
 
        self.updateFonts(font)
        self.updateRules()
        self.setDocument(self.document)

References KoTextShapeDataBase.document(), View.document(), KisAslXmlWriter::Private.document, KisAslXmlWriter.document(), KoShapeAnchor::TextLocation.document(), KoTextShapeDataBasePrivate.document, krita::Document::Private.document, Document.document(), KisAnimationImporter::Private.document, KisCloneDocumentStroke.document, KisDecorationsWrapperLayer::Private.document, KisDecorationsWrapperLayer.document(), KisView.document, KisView.document(), KisViewManager.document(), KoItemToolTip.document, KisTimeBasedItemModel::Private.document, KisTimeBasedItemModel.document(), krita.sceditor.highlighter.PythonHighlighter.document, KisKraLoader::Private.document, scripter.ui_scripter.syntax.syntax.PythonHighlighter.document, ToolReferenceImages.document(), KisTimeBasedItemModel.setDocument(), View.setDocument(), KisDecorationsWrapperLayer.setDocument(), krita.sceditor.widget.EditorView.setDocument(), krita.sceditor.highlighter.PythonHighlighter.updateFonts(), krita.sceditor.highlighter.PythonHighlighter.updateRules(), and krita.sceditor.highlighter.QtQmlHighlighter.updateRules().

◆ updateRules()

krita.sceditor.highlighter.PythonHighlighter.updateRules ( self )

Reimplemented in krita.sceditor.highlighter.QtQmlHighlighter.

Definition at line 115 of file highlighter.py.

    def updateRules(self):
 
        self.rules = []
        self.rules += map(lambda s: (QtCore.QRegularExpression(r"\b" + s + r"\b"),
                                     self.keywordFormat), self.keywords)
 
        self.rules.append((QtCore.QRegularExpression(r"\b[A-Za-z_]+\‍(.*\‍)"), self.callableFormat))
        self.rules.append((QtCore.QRegularExpression(r"\b__[a-z]+__\b"), self.magicFormat))
        self.rules.append((QtCore.QRegularExpression(r"\bself\b"), self.selfFormat))
        self.rules.append((QtCore.QRegularExpression(r"\bQ([A-Z][a-z]*)+\b"), self.qtFormat))
 
        self.rules.append((QtCore.QRegularExpression(r"#[^\n]*"), self.singleLineCommentFormat))
 
        self.multiLineStringBegin = QtCore.QRegularExpression(r'\"\"\"')
        self.multiLineStringEnd = QtCore.QRegularExpression(r'\"\"\"')
 
        self.rules.append((QtCore.QRegularExpression(r'\"[^\n]*\"'), self.quotationFormat1))
        self.rules.append((QtCore.QRegularExpression(r"'[^\n]*'"), self.quotationFormat2))
 

Member Data Documentation

◆ base_format

krita.sceditor.highlighter.PythonHighlighter.base_format

Definition at line 36 of file highlighter.py.

◆ callableFormat

krita.sceditor.highlighter.PythonHighlighter.callableFormat

Definition at line 95 of file highlighter.py.

◆ document

krita.sceditor.highlighter.PythonHighlighter.document

Definition at line 37 of file highlighter.py.

◆ empty_format

krita.sceditor.highlighter.PythonHighlighter.empty_format

Definition at line 46 of file highlighter.py.

◆ keywordFormat

krita.sceditor.highlighter.PythonHighlighter.keywordFormat

Definition at line 92 of file highlighter.py.

◆ keywords [1/2]

tuple krita.sceditor.highlighter.PythonHighlighter.keywords

static

Initial value:

=  (
        "and",       "del",       "for",       "is",        "raise",
        "assert",    "elif",      "from",      "lambda",    "return",
        "break",     "else",      "global",    "not",       "try",
        "class",     "except",    "if",        "or",        "while",
        "continue",  "exec",      "import",    "pass",      "yield",
        "def",       "finally",   "in",        "print"
    )

Definition at line 20 of file highlighter.py.

◆ keywords [2/2]

krita.sceditor.highlighter.PythonHighlighter.keywords

Definition at line 119 of file highlighter.py.

◆ magicFormat

krita.sceditor.highlighter.PythonHighlighter.magicFormat

Definition at line 97 of file highlighter.py.

◆ multiLineStringBegin

krita.sceditor.highlighter.PythonHighlighter.multiLineStringBegin

Definition at line 128 of file highlighter.py.

◆ multiLineStringEnd

krita.sceditor.highlighter.PythonHighlighter.multiLineStringEnd

Definition at line 129 of file highlighter.py.

◆ multiLineStringFormat

krita.sceditor.highlighter.PythonHighlighter.multiLineStringFormat

Definition at line 72 of file highlighter.py.

◆ qtFormat

krita.sceditor.highlighter.PythonHighlighter.qtFormat

Definition at line 99 of file highlighter.py.

◆ quotationFormat1

krita.sceditor.highlighter.PythonHighlighter.quotationFormat1

Definition at line 110 of file highlighter.py.

◆ quotationFormat2

krita.sceditor.highlighter.PythonHighlighter.quotationFormat2

Definition at line 112 of file highlighter.py.

◆ rules

krita.sceditor.highlighter.PythonHighlighter.rules

Definition at line 117 of file highlighter.py.

◆ selfFormat

krita.sceditor.highlighter.PythonHighlighter.selfFormat

Definition at line 102 of file highlighter.py.

◆ singleLineCommentFormat

krita.sceditor.highlighter.PythonHighlighter.singleLineCommentFormat

Definition at line 105 of file highlighter.py.

The documentation for this class was generated from the following file:

plugins/extensions/pykrita/plugin/krita/sceditor/highlighter.py

Public Member Functions

Public Attributes

Static Public Attributes