BornAgain  1.19.0
Simulate and fit neutron and x-ray scattering at grazing incidence
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
PythonSyntaxHighlighter Class Reference

Implementation of highlighting for Python code. More...

Inheritance diagram for PythonSyntaxHighlighter:
[legend]
Collaboration diagram for PythonSyntaxHighlighter:
[legend]

Public Member Functions

 PythonSyntaxHighlighter (QTextDocument *parent=0)
 

Protected Member Functions

void highlightBlock (const QString &text)
 

Private Member Functions

const QTextCharFormat getTextCharFormat (const QString &colorName, const QString &style="")
 
void initializeRules ()
 
bool matchMultiline (const QString &text, const QRegExp &delimiter, const int inState, const QTextCharFormat &style)
 Highlighst multi-line strings, returns true if after processing we are still within the. More...
 

Private Attributes

QHash< QString, QTextCharFormat > basicStyles
 
QStringList braces
 
QStringList keywords
 
QStringList operators
 
QList< HighlightingRule > rules
 
QRegExp triDoubleQuote
 
QRegExp triSingleQuote
 

Detailed Description

Implementation of highlighting for Python code.

Definition at line 61 of file PythonSyntaxHighlighter.h.

Constructor & Destructor Documentation

◆ PythonSyntaxHighlighter()

PythonSyntaxHighlighter::PythonSyntaxHighlighter ( QTextDocument *  parent = 0)

Definition at line 40 of file PythonSyntaxHighlighter.cpp.

40  : QSyntaxHighlighter(parent)
41 {
42  keywords = QStringList() << "and"
43  << "assert"
44  << "break"
45  << "class"
46  << "continue"
47  << "def"
48  << "del"
49  << "elif"
50  << "else"
51  << "except"
52  << "exec"
53  << "finally"
54  << "for"
55  << "from"
56  << "global"
57  << "if"
58  << "import"
59  << "in"
60  << "is"
61  << "lambda"
62  << "not"
63  << "or"
64  << "pass"
65  << "print"
66  << "raise"
67  << "return"
68  << "try"
69  << "while"
70  << "yield"
71  << "None"
72  << "True"
73  << "False";
74 
75  operators = QStringList() << "=" <<
76  // Comparison
77  "=="
78  << "!="
79  << "<"
80  << "<="
81  << ">"
82  << ">=" <<
83  // Arithmetic
84  "\\+"
85  << "-"
86  << "\\*"
87  << "/"
88  << "//"
89  << "%"
90  << "\\*\\*" <<
91  // In-place
92  "\\+="
93  << "-="
94  << "\\*="
95  << "/="
96  << "%=" <<
97  // Bitwise
98  "\\^"
99  << "\\|"
100  << "&"
101  << "~"
102  << ">>"
103  << "<<";
104 
105  braces = QStringList() << "{"
106  << "}"
107  << "\\("
108  << "\\)"
109  << "\\["
110  << "]";
111 
112  basicStyles.insert("keyword", getTextCharFormat("blue"));
113  basicStyles.insert("operator", getTextCharFormat("red"));
114  basicStyles.insert("brace", getTextCharFormat("darkGray"));
115  basicStyles.insert("defclass", getTextCharFormat("black", "bold"));
116  basicStyles.insert("brace", getTextCharFormat("black"));
117  basicStyles.insert("string", getTextCharFormat("magenta"));
118  basicStyles.insert("string2", getTextCharFormat("darkMagenta"));
119  basicStyles.insert("comment", getTextCharFormat("darkGreen", "italic"));
120  basicStyles.insert("self", getTextCharFormat("black", "italic"));
121  basicStyles.insert("numbers", getTextCharFormat("brown"));
122 
123  triSingleQuote.setPattern("'''");
124  triDoubleQuote.setPattern("\"\"\"");
125 
126  initializeRules();
127 }
PythonSyntaxHighlighter::getTextCharFormat
const QTextCharFormat getTextCharFormat(const QString &colorName, const QString &style="")
Definition: PythonSyntaxHighlighter.cpp:238
PythonSyntaxHighlighter::basicStyles
QHash< QString, QTextCharFormat > basicStyles
Definition: PythonSyntaxHighlighter.h:74

References basicStyles, braces, getTextCharFormat(), initializeRules(), keywords, operators, triDoubleQuote, and triSingleQuote.

Here is the call graph for this function:

Member Function Documentation

◆ getTextCharFormat()

const QTextCharFormat PythonSyntaxHighlighter::getTextCharFormat ( const QString &  colorName,
const QString &  style = "" 
)
private

Definition at line 238 of file PythonSyntaxHighlighter.cpp.

240 {
241  QTextCharFormat charFormat;
242  QColor color(colorName);
243  charFormat.setForeground(color);
244  if (style.contains("bold", Qt::CaseInsensitive))
245  charFormat.setFontWeight(QFont::Bold);
246  if (style.contains("italic", Qt::CaseInsensitive))
247  charFormat.setFontItalic(true);
248  return charFormat;
249 }

Referenced by PythonSyntaxHighlighter().

◆ highlightBlock()

void PythonSyntaxHighlighter::highlightBlock ( const QString &  text)
protected

Definition at line 175 of file PythonSyntaxHighlighter.cpp.

176 {
177  for (HighlightingRule currRule : rules) {
178  int idx = currRule.pattern.indexIn(text, 0);
179  while (idx >= 0) {
180  // Get index of Nth match
181  idx = currRule.pattern.pos(currRule.nth);
182  int length = currRule.pattern.cap(currRule.nth).length();
183  setFormat(idx, length, currRule.format);
184  idx = currRule.pattern.indexIn(text, idx + length);
185  }
186  }
187  setCurrentBlockState(0);
188 
189  // Do multi-line strings
190  if (!matchMultiline(text, triSingleQuote, 1, basicStyles.value("string2")))
191  matchMultiline(text, triDoubleQuote, 2, basicStyles.value("string2"));
192 }
HighlightingRule
Container to describe a highlighting rule.
Definition: PythonSyntaxHighlighter.h:45
PythonSyntaxHighlighter::matchMultiline
bool matchMultiline(const QString &text, const QRegExp &delimiter, const int inState, const QTextCharFormat &style)
Highlighst multi-line strings, returns true if after processing we are still within the.
Definition: PythonSyntaxHighlighter.cpp:194
PythonSyntaxHighlighter::rules
QList< HighlightingRule > rules
Definition: PythonSyntaxHighlighter.h:84

References basicStyles, matchMultiline(), rules, triDoubleQuote, and triSingleQuote.

Here is the call graph for this function:

◆ initializeRules()

void PythonSyntaxHighlighter::initializeRules ( )
private

Definition at line 129 of file PythonSyntaxHighlighter.cpp.

130 {
131  for (QString currKeyword : keywords) {
132  rules.append(HighlightingRule(QString("\\b%1\\b").arg(currKeyword), 0,
133  basicStyles.value("keyword")));
134  }
135  for (QString currOperator : operators) {
136  rules.append(
137  HighlightingRule(QString("%1").arg(currOperator), 0, basicStyles.value("operator")));
138  }
139  for (QString currBrace : braces) {
140  rules.append(HighlightingRule(QString("%1").arg(currBrace), 0, basicStyles.value("brace")));
141  }
142  // 'self'
143  rules.append(HighlightingRule("\\bself\\b", 0, basicStyles.value("self")));
144 
145  // Double-quoted string, possibly containing escape sequences
146  // FF: originally in python : r'"[^"\\]*(\\.[^"\\]*)*"'
147  rules.append(
148  HighlightingRule("\"[^\"\\\\]*(\\\\.[^\"\\\\]*)*\"", 0, basicStyles.value("string")));
149  // Single-quoted string, possibly containing escape sequences
150  // FF: originally in python : r"'[^'\\]*(\\.[^'\\]*)*'"
151  rules.append(HighlightingRule("'[^'\\\\]*(\\\\.[^'\\\\]*)*'", 0, basicStyles.value("string")));
152 
153  // 'def' followed by an identifier
154  // FF: originally: r'\bdef\b\s*(\w+)'
155  rules.append(HighlightingRule("\\bdef\\b\\s*(\\w+)", 1, basicStyles.value("defclass")));
156  // 'class' followed by an identifier
157  // FF: originally: r'\bclass\b\s*(\w+)'
158  rules.append(HighlightingRule("\\bclass\\b\\s*(\\w+)", 1, basicStyles.value("defclass")));
159 
160  // From '#' until a newline
161  // FF: originally: r'#[^\\n]*'
162  rules.append(HighlightingRule("#[^\\n]*", 0, basicStyles.value("comment")));
163 
164  // Numeric literals
165  rules.append(HighlightingRule("\\b[+-]?[0-9]+[lL]?\\b", 0,
166  basicStyles.value("numbers"))); // r'\b[+-]?[0-9]+[lL]?\b'
167  rules.append(
168  HighlightingRule("\\b[+-]?0[xX][0-9A-Fa-f]+[lL]?\\b", 0,
169  basicStyles.value("numbers"))); // r'\b[+-]?0[xX][0-9A-Fa-f]+[lL]?\b'
170  rules.append(HighlightingRule(
171  "\\b[+-]?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?\\b", 0,
172  basicStyles.value("numbers"))); // r'\b[+-]?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?\b'
173 }

References basicStyles, braces, keywords, operators, and rules.

Referenced by PythonSyntaxHighlighter().

◆ matchMultiline()

bool PythonSyntaxHighlighter::matchMultiline ( const QString &  text,
const QRegExp &  delimiter,
const int  inState,
const QTextCharFormat &  style 
)
private

Highlighst multi-line strings, returns true if after processing we are still within the.

Definition at line 194 of file PythonSyntaxHighlighter.cpp.

196 {
197  int start = -1;
198  int add = -1;
199  int end = -1;
200  int length = 0;
201 
202  // If inside triple-single quotes, start at 0
203  if (previousBlockState() == inState) {
204  start = 0;
205  add = 0;
206  }
207  // Otherwise, look for the delimiter on this line
208  else {
209  start = delimiter.indexIn(text);
210  // Move past this match
211  add = delimiter.matchedLength();
212  }
213  // As long as there's a delimiter match on this line...
214  while (start >= 0) {
215  // Look for the ending delimiter
216  end = delimiter.indexIn(text, start + add);
217  // Ending delimiter on this line?
218  if (end >= add) {
219  length = end - start + add + delimiter.matchedLength();
220  setCurrentBlockState(0);
221  }
222  // No; multi-line string
223  else {
224  setCurrentBlockState(inState);
225  length = text.length() - start + add;
226  }
227  // Apply formatting and look for next
228  setFormat(start, length, style);
229  start = delimiter.indexIn(text, start + length);
230  }
231  // Return True if still inside a multi-line string, False otherwise
232  if (currentBlockState() == inState)
233  return true;
234  else
235  return false;
236 }

Referenced by highlightBlock().

Member Data Documentation

◆ basicStyles

QHash<QString, QTextCharFormat> PythonSyntaxHighlighter::basicStyles
private

Definition at line 74 of file PythonSyntaxHighlighter.h.

Referenced by PythonSyntaxHighlighter(), highlightBlock(), and initializeRules().

◆ braces

QStringList PythonSyntaxHighlighter::braces
private

Definition at line 72 of file PythonSyntaxHighlighter.h.

Referenced by PythonSyntaxHighlighter(), and initializeRules().

◆ keywords

QStringList PythonSyntaxHighlighter::keywords
private

Definition at line 70 of file PythonSyntaxHighlighter.h.

Referenced by PythonSyntaxHighlighter(), and initializeRules().

◆ operators

QStringList PythonSyntaxHighlighter::operators
private

Definition at line 71 of file PythonSyntaxHighlighter.h.

Referenced by PythonSyntaxHighlighter(), and initializeRules().

◆ rules

QList<HighlightingRule> PythonSyntaxHighlighter::rules
private

Definition at line 84 of file PythonSyntaxHighlighter.h.

Referenced by highlightBlock(), and initializeRules().

◆ triDoubleQuote

QRegExp PythonSyntaxHighlighter::triDoubleQuote
private

Definition at line 86 of file PythonSyntaxHighlighter.h.

Referenced by PythonSyntaxHighlighter(), and highlightBlock().

◆ triSingleQuote

QRegExp PythonSyntaxHighlighter::triSingleQuote
private

Definition at line 85 of file PythonSyntaxHighlighter.h.

Referenced by PythonSyntaxHighlighter(), and highlightBlock().

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