diff --git a/data/schema/language.xsd b/data/schema/language.xsd index 4e7e7a1..8c21c35 100644 --- a/data/schema/language.xsd +++ b/data/schema/language.xsd @@ -1,684 +1,680 @@ - - diff --git a/src/lib/rule.cpp b/src/lib/rule.cpp index 2023b6a..d3a5d44 100644 --- a/src/lib/rule.cpp +++ b/src/lib/rule.cpp @@ -1,707 +1,712 @@ /* Copyright (C) 2016 Volker Krause Copyright (C) 2018 Christoph Cullmann Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ #include "context_p.h" #include "rule_p.h" #include "definition_p.h" #include "ksyntaxhighlighting_logging.h" #include "xml_p.h" #include #include using namespace KSyntaxHighlighting; static bool isOctalChar(QChar c) { return c.isNumber() && c != QLatin1Char('9') && c != QLatin1Char('8'); } static bool isHexChar(QChar c) { return c.isNumber() || c == QLatin1Char('a') || c == QLatin1Char('A') || c == QLatin1Char('b') || c == QLatin1Char('B') || c == QLatin1Char('c') || c == QLatin1Char('C') || c == QLatin1Char('d') || c == QLatin1Char('D') || c == QLatin1Char('e') || c == QLatin1Char('E') || c == QLatin1Char('f') || c == QLatin1Char('F'); } static int matchEscapedChar(const QString &text, int offset) { if (text.at(offset) != QLatin1Char('\\') || text.size() < offset + 2) return offset; const auto c = text.at(offset + 1); static const auto controlChars = QStringLiteral("abefnrtv\"'?\\"); if (controlChars.contains(c)) return offset + 2; if (c == QLatin1Char('x')) { // hex encoded character auto newOffset = offset + 2; for (int i = 0; i < 2 && newOffset + i < text.size(); ++i, ++newOffset) { if (!isHexChar(text.at(newOffset))) break; } if (newOffset == offset + 2) return offset; return newOffset; } if (isOctalChar(c)) { // octal encoding auto newOffset = offset + 2; for (int i = 0; i < 2 && newOffset + i < text.size(); ++i, ++newOffset) { if (!isOctalChar(text.at(newOffset))) break; } if (newOffset == offset + 2) return offset; return newOffset; } return offset; } static QString replaceCaptures(const QString &pattern, const QStringList &captures, bool quote) { auto result = pattern; for (int i = captures.size() - 1; i >= 1; --i) { result.replace(QLatin1Char('%') + QString::number(i), quote ? QRegularExpression::escape(captures.at(i)) : captures.at(i)); } return result; } Definition Rule::definition() const { return m_def.definition(); } void Rule::setDefinition(const Definition &def) { m_def = def; // cache for DefinitionData::wordDelimiters, is accessed VERY often m_wordDelimiter = &DefinitionData::get(m_def.definition())->wordDelimiters; } ContextSwitch Rule::context() const { return m_context; } bool Rule::isLookAhead() const { return m_lookAhead; } -bool Rule::isDynamic() const -{ - return m_dynamic; -} - bool Rule::firstNonSpace() const { return m_firstNonSpace; } int Rule::requiredColumn() const { return m_column; } FoldingRegion Rule::beginRegion() const { return m_beginRegion; } FoldingRegion Rule::endRegion() const { return m_endRegion; } bool Rule::load(QXmlStreamReader &reader) { Q_ASSERT(reader.tokenType() == QXmlStreamReader::StartElement); m_attribute = reader.attributes().value(QStringLiteral("attribute")).toString(); if (reader.name() != QLatin1String("IncludeRules")) // IncludeRules uses this with a different semantic m_context.parse(reader.attributes().value(QStringLiteral("context"))); m_firstNonSpace = Xml::attrToBool(reader.attributes().value(QStringLiteral("firstNonSpace"))); m_lookAhead = Xml::attrToBool(reader.attributes().value(QStringLiteral("lookAhead"))); bool colOk = false; m_column = reader.attributes().value(QStringLiteral("column")).toInt(&colOk); if (!colOk) m_column = -1; - m_dynamic = Xml::attrToBool(reader.attributes().value(QStringLiteral("dynamic"))); auto regionName = reader.attributes().value(QLatin1String("beginRegion")); if (!regionName.isEmpty()) m_beginRegion = FoldingRegion(FoldingRegion::Begin, DefinitionData::get(m_def.definition())->foldingRegionId(regionName.toString())); regionName = reader.attributes().value(QLatin1String("endRegion")); if (!regionName.isEmpty()) m_endRegion = FoldingRegion(FoldingRegion::End, DefinitionData::get(m_def.definition())->foldingRegionId(regionName.toString())); auto result = doLoad(reader); if (m_lookAhead && m_context.isStay()) result = false; reader.readNext(); while (!reader.atEnd()) { switch (reader.tokenType()) { case QXmlStreamReader::StartElement: { auto rule = Rule::create(reader.name()); if (rule) { rule->setDefinition(m_def.definition()); if (rule->load(reader)) { m_subRules.push_back(rule); reader.readNext(); } } else { reader.skipCurrentElement(); } break; } case QXmlStreamReader::EndElement: return result; default: reader.readNext(); break; } } return result; } void Rule::resolveContext() { m_context.resolve(m_def.definition()); foreach (const auto &rule, m_subRules) rule->resolveContext(); } void Rule::resolveAttributeFormat(Context *lookupContext) { /** * try to get our format from the definition we stem from */ if (!m_attribute.isEmpty()) { m_attributeFormat = DefinitionData::get(definition())->formatByName(m_attribute); if (!m_attributeFormat.isValid()) { qCWarning(Log) << "Rule: Unknown format" << m_attribute << "in context" << lookupContext->name() << "of definition" << definition().name(); } } /** * lookup formats for our sub-rules */ foreach (const auto &rule, m_subRules) { rule->resolveAttributeFormat(lookupContext); } } bool Rule::doLoad(QXmlStreamReader& reader) { Q_UNUSED(reader); return true; } -MatchResult Rule::match(const QString &text, int offset, const QStringList &captures) +MatchResult Rule::match(const QString &text, int offset, const QStringList &captures) const { Q_ASSERT(!text.isEmpty()); const auto result = doMatch(text, offset, captures); if (result.offset() == offset || result.offset() == text.size()) return result; foreach (const auto &subRule, m_subRules) { const auto subResult = subRule->match(text, result.offset(), QStringList()); if (subResult.offset() > result.offset()) return MatchResult(subResult.offset(), result.captures()); } return result; } Rule::Ptr Rule::create(const QStringRef& name) { Rule *rule = nullptr; if (name == QLatin1String("AnyChar")) rule = new AnyChar; else if (name == QLatin1String("DetectChar")) rule = new DetectChar; else if (name == QLatin1String("Detect2Chars")) rule = new Detect2Char; else if (name == QLatin1String("DetectIdentifier")) rule = new DetectIdentifier; else if (name == QLatin1String("DetectSpaces")) rule = new DetectSpaces; else if (name == QLatin1String("Float")) rule = new Float; else if (name == QLatin1String("Int")) rule = new Int; else if (name == QLatin1String("HlCChar")) rule = new HlCChar; else if (name == QLatin1String("HlCHex")) rule = new HlCHex; else if (name == QLatin1String("HlCOct")) rule = new HlCOct; else if (name == QLatin1String("HlCStringChar")) rule = new HlCStringChar; else if (name == QLatin1String("IncludeRules")) rule = new IncludeRules; else if (name == QLatin1String("keyword")) rule = new KeywordListRule; else if (name == QLatin1String("LineContinue")) rule = new LineContinue; else if (name == QLatin1String("RangeDetect")) rule = new RangeDetect; else if (name == QLatin1String("RegExpr")) rule = new RegExpr; else if (name == QLatin1String("StringDetect")) rule = new StringDetect; else if (name == QLatin1String("WordDetect")) rule = new WordDetect; else qCWarning(Log) << "Unknown rule type:" << name; return Ptr(rule); } bool Rule::isWordDelimiter(QChar c) const { // perf tells contains is MUCH faster than binary search here, very short array return m_wordDelimiter.contains(c); } bool AnyChar::doLoad(QXmlStreamReader& reader) { m_chars = reader.attributes().value(QStringLiteral("String")).toString(); if (m_chars.size() == 1) qCDebug(Log) << "AnyChar rule with just one char: use DetectChar instead."; return !m_chars.isEmpty(); } -MatchResult AnyChar::doMatch(const QString& text, int offset, const QStringList&) +MatchResult AnyChar::doMatch(const QString& text, int offset, const QStringList&) const { if (m_chars.contains(text.at(offset))) return offset + 1; return offset; } bool DetectChar::doLoad(QXmlStreamReader& reader) { const auto s = reader.attributes().value(QStringLiteral("char")); if (s.isEmpty()) return false; m_char = s.at(0); - if (isDynamic()) { + m_dynamic = Xml::attrToBool(reader.attributes().value(QStringLiteral("dynamic"))); + if (m_dynamic) { m_captureIndex = m_char.digitValue(); } return true; } -MatchResult DetectChar::doMatch(const QString& text, int offset, const QStringList &captures) +MatchResult DetectChar::doMatch(const QString& text, int offset, const QStringList &captures) const { - if (isDynamic()) { + if (m_dynamic) { if (captures.size() <= m_captureIndex || captures.at(m_captureIndex).isEmpty()) return offset; if (text.at(offset) == captures.at(m_captureIndex).at(0)) return offset + 1; return offset; } if (text.at(offset) == m_char) return offset + 1; return offset; } bool Detect2Char::doLoad(QXmlStreamReader& reader) { const auto s1 = reader.attributes().value(QStringLiteral("char")); const auto s2 = reader.attributes().value(QStringLiteral("char1")); if (s1.isEmpty() || s2.isEmpty()) return false; m_char1 = s1.at(0); m_char2 = s2.at(0); return true; } -MatchResult Detect2Char::doMatch(const QString& text, int offset, const QStringList &captures) +MatchResult Detect2Char::doMatch(const QString& text, int offset, const QStringList &) const { - Q_UNUSED(captures); // TODO if (text.size() - offset < 2) return offset; if (text.at(offset) == m_char1 && text.at(offset + 1) == m_char2) return offset + 2; return offset; } -MatchResult DetectIdentifier::doMatch(const QString& text, int offset, const QStringList&) +MatchResult DetectIdentifier::doMatch(const QString& text, int offset, const QStringList&) const { if (!text.at(offset).isLetter() && text.at(offset) != QLatin1Char('_')) return offset; for (int i = offset + 1; i < text.size(); ++i) { const auto c = text.at(i); if (!c.isLetterOrNumber() && c != QLatin1Char('_')) return i; } return text.size(); } -MatchResult DetectSpaces::doMatch(const QString& text, int offset, const QStringList&) +MatchResult DetectSpaces::doMatch(const QString& text, int offset, const QStringList&) const { while(offset < text.size() && text.at(offset).isSpace()) ++offset; return offset; } -MatchResult Float::doMatch(const QString& text, int offset, const QStringList&) +MatchResult Float::doMatch(const QString& text, int offset, const QStringList&) const { if (offset > 0 && !isWordDelimiter(text.at(offset - 1))) return offset; auto newOffset = offset; while (newOffset < text.size() && text.at(newOffset).isDigit()) ++newOffset; if (newOffset >= text.size() || text.at(newOffset) != QLatin1Char('.')) return offset; ++newOffset; while (newOffset < text.size() && text.at(newOffset).isDigit()) ++newOffset; if (newOffset == offset + 1) // we only found a decimal point return offset; auto expOffset = newOffset; if (expOffset >= text.size() || (text.at(expOffset) != QLatin1Char('e') && text.at(expOffset) != QLatin1Char('E'))) return newOffset; ++expOffset; if (expOffset < text.size() && (text.at(expOffset) == QLatin1Char('+') || text.at(expOffset) == QLatin1Char('-'))) ++expOffset; bool foundExpDigit = false; while (expOffset < text.size() && text.at(expOffset).isDigit()) { ++expOffset; foundExpDigit = true; } if (!foundExpDigit) return newOffset; return expOffset; } -MatchResult HlCChar::doMatch(const QString& text, int offset, const QStringList&) +MatchResult HlCChar::doMatch(const QString& text, int offset, const QStringList&) const { if (text.size() < offset + 3) return offset; if (text.at(offset) != QLatin1Char('\'') || text.at(offset + 1) == QLatin1Char('\'')) return offset; auto newOffset = matchEscapedChar(text, offset + 1); if (newOffset == offset + 1) { if (text.at(newOffset) == QLatin1Char('\\')) return offset; else ++newOffset; } if (newOffset >= text.size()) return offset; if (text.at(newOffset) == QLatin1Char('\'')) return newOffset + 1; return offset; } -MatchResult HlCHex::doMatch(const QString& text, int offset, const QStringList&) +MatchResult HlCHex::doMatch(const QString& text, int offset, const QStringList&) const { if (offset > 0 && !isWordDelimiter(text.at(offset - 1))) return offset; if (text.size() < offset + 3) return offset; if (text.at(offset) != QLatin1Char('0') || (text.at(offset + 1) != QLatin1Char('x') && text.at(offset + 1) != QLatin1Char('X'))) return offset; if (!isHexChar(text.at(offset + 2))) return offset; offset += 3; while (offset < text.size() && isHexChar(text.at(offset))) ++offset; // TODO Kate matches U/L suffix, QtC does not? return offset; } -MatchResult HlCOct::doMatch(const QString& text, int offset, const QStringList&) +MatchResult HlCOct::doMatch(const QString& text, int offset, const QStringList&) const { if (offset > 0 && !isWordDelimiter(text.at(offset - 1))) return offset; if (text.size() < offset + 2) return offset; if (text.at(offset) != QLatin1Char('0')) return offset; if (!isOctalChar(text.at(offset + 1))) return offset; offset += 2; while (offset < text.size() && isOctalChar(text.at(offset))) ++offset; return offset; } -MatchResult HlCStringChar::doMatch(const QString& text, int offset, const QStringList&) +MatchResult HlCStringChar::doMatch(const QString& text, int offset, const QStringList&) const { return matchEscapedChar(text, offset); } QString IncludeRules::contextName() const { return m_contextName; } QString IncludeRules::definitionName() const { return m_defName; } bool IncludeRules::includeAttribute() const { return m_includeAttribute; } bool IncludeRules::doLoad(QXmlStreamReader& reader) { const auto s = reader.attributes().value(QLatin1String("context")); const auto split = s.split(QLatin1String("##"), QString::KeepEmptyParts); if (split.isEmpty()) return false; m_contextName = split.at(0).toString(); if (split.size() > 1) m_defName = split.at(1).toString(); m_includeAttribute = Xml::attrToBool(reader.attributes().value(QLatin1String("includeAttrib"))); return !m_contextName.isEmpty() || !m_defName.isEmpty(); } -MatchResult IncludeRules::doMatch(const QString& text, int offset, const QStringList&) +MatchResult IncludeRules::doMatch(const QString& text, int offset, const QStringList&) const { Q_UNUSED(text); qCWarning(Log) << "Unresolved include rule for" << m_contextName << "##" << m_defName; return offset; } -MatchResult Int::doMatch(const QString& text, int offset, const QStringList &captures) +MatchResult Int::doMatch(const QString& text, int offset, const QStringList &captures) const { if (offset > 0 && !isWordDelimiter(text.at(offset - 1))) return offset; Q_UNUSED(captures); // ### the doc says this can be dynamic, but how?? while(offset < text.size() && text.at(offset).isDigit()) ++offset; return offset; } bool KeywordListRule::doLoad(QXmlStreamReader& reader) { m_listName = reader.attributes().value(QLatin1String("String")).toString(); if (reader.attributes().hasAttribute(QLatin1String("insensitive"))) { m_hasCaseSensitivityOverride = true; m_caseSensitivityOverride = Xml::attrToBool(reader.attributes().value(QLatin1String("insensitive"))) ? Qt::CaseInsensitive : Qt::CaseSensitive; } else { m_hasCaseSensitivityOverride = false; } return !m_listName.isEmpty(); } -MatchResult KeywordListRule::doMatch(const QString& text, int offset, const QStringList&) +MatchResult KeywordListRule::doMatch(const QString& text, int offset, const QStringList&) const { if (m_keywordList.isEmpty()) { const auto def = definition(); Q_ASSERT(def.isValid()); auto defData = DefinitionData::get(def); m_keywordList = defData->keywordList(m_listName); } auto newOffset = offset; while (text.size() > newOffset && !isWordDelimiter(text.at(newOffset))) ++newOffset; if (newOffset == offset) return offset; if (m_hasCaseSensitivityOverride) { if (m_keywordList.contains(text.midRef(offset, newOffset - offset), m_caseSensitivityOverride)) return newOffset; } else { if (m_keywordList.contains(text.midRef(offset, newOffset - offset))) return newOffset; } // we don't match, but we can skip until newOffset as we can't start a keyword in-between return MatchResult(offset, newOffset); } bool LineContinue::doLoad(QXmlStreamReader& reader) { const auto s = reader.attributes().value(QStringLiteral("char")); if (s.isEmpty()) m_char = QLatin1Char('\\'); else m_char = s.at(0); return true; } -MatchResult LineContinue::doMatch(const QString& text, int offset, const QStringList&) +MatchResult LineContinue::doMatch(const QString& text, int offset, const QStringList&) const { if (offset == text.size() - 1 && text.at(offset) == m_char) return offset + 1; return offset; } bool RangeDetect::doLoad(QXmlStreamReader& reader) { const auto s1 = reader.attributes().value(QStringLiteral("char")); const auto s2 = reader.attributes().value(QStringLiteral("char1")); if (s1.isEmpty() || s2.isEmpty()) return false; m_begin = s1.at(0); m_end = s2.at(0); return true; } -MatchResult RangeDetect::doMatch(const QString& text, int offset, const QStringList&) +MatchResult RangeDetect::doMatch(const QString& text, int offset, const QStringList&) const { if (text.size() - offset < 2) return offset; if (text.at(offset) != m_begin) return offset; auto newOffset = offset + 1; while (newOffset < text.size()) { if (text.at(newOffset) == m_end) return newOffset + 1; ++newOffset; } return offset; } bool RegExpr::doLoad(QXmlStreamReader& reader) { - m_pattern = reader.attributes().value(QStringLiteral("String")).toString(); - m_regexp.setPattern(m_pattern); + m_regexp.setPattern(reader.attributes().value(QStringLiteral("String")).toString()); + const auto isMinimal = Xml::attrToBool(reader.attributes().value(QStringLiteral("minimal"))); const auto isCaseInsensitive = Xml::attrToBool(reader.attributes().value(QStringLiteral("insensitive"))); m_regexp.setPatternOptions( (isMinimal ? QRegularExpression::InvertedGreedinessOption : QRegularExpression::NoPatternOption) | (isCaseInsensitive ? QRegularExpression::CaseInsensitiveOption : QRegularExpression::NoPatternOption)); - return !m_pattern.isEmpty(); // m_regexp.isValid() would be better, but parses the regexp and thus is way too expensive -} -MatchResult RegExpr::doMatch(const QString& text, int offset, const QStringList &captures) -{ + // optimize the pattern for the non-dynamic case, we use them OFTEN + m_dynamic = Xml::attrToBool(reader.attributes().value(QStringLiteral("dynamic"))); + if (!m_dynamic) { + m_regexp.optimize(); + } + + // always using m_regexp.isValid() would be better, but parses the regexp and thus is way too expensive for release builds Q_ASSERT(m_regexp.isValid()); + return !m_regexp.pattern().isEmpty(); +} - if (isDynamic()) - m_regexp.setPattern(replaceCaptures(m_pattern, captures, true)); +MatchResult RegExpr::doMatch(const QString& text, int offset, const QStringList &captures) const +{ + /** + * for dynamic case: create new pattern with right instantiation + */ + const auto ®exp = m_dynamic ? QRegularExpression(replaceCaptures(m_regexp.pattern(), captures, true), m_regexp.patternOptions()) : m_regexp; - auto result = m_regexp.match(text, offset, QRegularExpression::NormalMatch, QRegularExpression::DontCheckSubjectStringMatchOption); + auto result = regexp.match(text, offset, QRegularExpression::NormalMatch, QRegularExpression::DontCheckSubjectStringMatchOption); if (result.capturedStart() == offset) return MatchResult(offset + result.capturedLength(), result.capturedTexts()); return MatchResult(offset, result.capturedStart()); } bool StringDetect::doLoad(QXmlStreamReader& reader) { m_string = reader.attributes().value(QStringLiteral("String")).toString(); m_caseSensitivity = Xml::attrToBool(reader.attributes().value(QStringLiteral("insensitive"))) ? Qt::CaseInsensitive : Qt::CaseSensitive; + m_dynamic = Xml::attrToBool(reader.attributes().value(QStringLiteral("dynamic"))); return !m_string.isEmpty(); } -MatchResult StringDetect::doMatch(const QString& text, int offset, const QStringList &captures) +MatchResult StringDetect::doMatch(const QString& text, int offset, const QStringList &captures) const { - auto pattern = m_string; - if (isDynamic()) - pattern = replaceCaptures(m_string, captures, false); + /** + * for dynamic case: create new pattern with right instantiation + */ + const auto &pattern = m_dynamic ? replaceCaptures(m_string, captures, false) : m_string; + if (text.midRef(offset, pattern.size()).compare(pattern, m_caseSensitivity) == 0) return offset + pattern.size(); return offset; } bool WordDetect::doLoad(QXmlStreamReader& reader) { m_word = reader.attributes().value(QStringLiteral("String")).toString(); m_caseSensitivity = Xml::attrToBool(reader.attributes().value(QStringLiteral("insensitive"))) ? Qt::CaseInsensitive : Qt::CaseSensitive; return !m_word.isEmpty(); } -MatchResult WordDetect::doMatch(const QString& text, int offset, const QStringList &captures) +MatchResult WordDetect::doMatch(const QString& text, int offset, const QStringList &) const { - Q_UNUSED(captures); // TODO if (text.size() - offset < m_word.size()) return offset; if (offset > 0 && !isWordDelimiter(text.at(offset - 1))) return offset; if (text.midRef(offset, m_word.size()).compare(m_word, m_caseSensitivity) != 0) return offset; if (text.size() == offset + m_word.size() || isWordDelimiter(text.at(offset + m_word.size()))) return offset + m_word.size(); return offset; } diff --git a/src/lib/rule_p.h b/src/lib/rule_p.h index 8d2036d..881deb2 100644 --- a/src/lib/rule_p.h +++ b/src/lib/rule_p.h @@ -1,270 +1,270 @@ /* Copyright (C) 2016 Volker Krause Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ #ifndef KSYNTAXHIGHLIGHTING_RULE_P_H #define KSYNTAXHIGHLIGHTING_RULE_P_H #include "contextswitch_p.h" #include "definition.h" #include "definitionref_p.h" #include "foldingregion.h" #include "format.h" #include "keywordlist_p.h" #include "matchresult_p.h" #include #include #include #include class QXmlStreamReader; namespace KSyntaxHighlighting { class Rule { public: Rule() = default; virtual ~Rule() = default; typedef std::shared_ptr Ptr; Definition definition() const; void setDefinition(const Definition &def); const Format &attributeFormat() const { return m_attributeFormat; } ContextSwitch context() const; bool isLookAhead() const; - bool isDynamic() const; bool firstNonSpace() const; int requiredColumn() const; FoldingRegion beginRegion() const; FoldingRegion endRegion() const; bool load(QXmlStreamReader &reader); void resolveContext(); void resolveAttributeFormat(Context *lookupContext); - MatchResult match(const QString &text, int offset, const QStringList &captures); + MatchResult match(const QString &text, int offset, const QStringList &captures) const; static Rule::Ptr create(const QStringRef &name); protected: virtual bool doLoad(QXmlStreamReader &reader); - virtual MatchResult doMatch(const QString &text, int offset, const QStringList &captures) = 0; + virtual MatchResult doMatch(const QString &text, int offset, const QStringList &captures) const = 0; bool isWordDelimiter(QChar c) const; private: Q_DISABLE_COPY(Rule) DefinitionRef m_def; QString m_attribute; Format m_attributeFormat; ContextSwitch m_context; QVector m_subRules; int m_column = -1; FoldingRegion m_beginRegion; FoldingRegion m_endRegion; bool m_firstNonSpace = false; bool m_lookAhead = false; - bool m_dynamic = false; // cache for DefinitionData::wordDelimiters, is accessed VERY often QStringRef m_wordDelimiter; }; class AnyChar : public Rule { protected: bool doLoad(QXmlStreamReader & reader) override; - MatchResult doMatch(const QString & text, int offset, const QStringList&) override; + MatchResult doMatch(const QString & text, int offset, const QStringList&) const override; private: QString m_chars; }; class DetectChar : public Rule { protected: bool doLoad(QXmlStreamReader & reader) override; - MatchResult doMatch(const QString & text, int offset, const QStringList &captures) override; + MatchResult doMatch(const QString & text, int offset, const QStringList &captures) const override; private: QChar m_char; - int m_captureIndex; + bool m_dynamic = false; + int m_captureIndex = 0; }; class Detect2Char : public Rule { protected: bool doLoad(QXmlStreamReader & reader) override; - MatchResult doMatch(const QString & text, int offset, const QStringList &captures) override; + MatchResult doMatch(const QString & text, int offset, const QStringList &captures) const override; private: QChar m_char1; QChar m_char2; }; class DetectIdentifier : public Rule { protected: - MatchResult doMatch(const QString & text, int offset, const QStringList&) override; + MatchResult doMatch(const QString & text, int offset, const QStringList&) const override; }; class DetectSpaces : public Rule { protected: - MatchResult doMatch(const QString & text, int offset, const QStringList&) override; + MatchResult doMatch(const QString & text, int offset, const QStringList&) const override; }; class Float : public Rule { protected: - MatchResult doMatch(const QString & text, int offset, const QStringList&) override; + MatchResult doMatch(const QString & text, int offset, const QStringList&) const override; }; class IncludeRules : public Rule { public: QString contextName() const; QString definitionName() const; bool includeAttribute() const; protected: bool doLoad(QXmlStreamReader & reader) override; - MatchResult doMatch(const QString & text, int offset, const QStringList&) override; + MatchResult doMatch(const QString & text, int offset, const QStringList&) const override; private: QString m_contextName; QString m_defName; bool m_includeAttribute; }; class Int : public Rule { protected: - MatchResult doMatch(const QString & text, int offset, const QStringList &captures) override; + MatchResult doMatch(const QString & text, int offset, const QStringList &captures) const override; }; class HlCChar : public Rule { protected: - MatchResult doMatch(const QString & text, int offset, const QStringList&) override; + MatchResult doMatch(const QString & text, int offset, const QStringList&) const override; }; class HlCHex : public Rule { protected: - MatchResult doMatch(const QString & text, int offset, const QStringList&) override; + MatchResult doMatch(const QString & text, int offset, const QStringList&) const override; }; class HlCOct : public Rule { protected: - MatchResult doMatch(const QString & text, int offset, const QStringList&) override; + MatchResult doMatch(const QString & text, int offset, const QStringList&) const override; }; class HlCStringChar : public Rule { protected: - MatchResult doMatch(const QString & text, int offset, const QStringList&) override; + MatchResult doMatch(const QString & text, int offset, const QStringList&) const override; }; class KeywordListRule : public Rule { protected: bool doLoad(QXmlStreamReader & reader) override; - MatchResult doMatch(const QString & text, int offset, const QStringList&) override; + MatchResult doMatch(const QString & text, int offset, const QStringList&) const override; private: QString m_listName; - KeywordList m_keywordList; + mutable KeywordList m_keywordList; bool m_hasCaseSensitivityOverride; Qt::CaseSensitivity m_caseSensitivityOverride; }; class LineContinue : public Rule { protected: bool doLoad(QXmlStreamReader & reader) override; - MatchResult doMatch(const QString & text, int offset, const QStringList&) override; + MatchResult doMatch(const QString & text, int offset, const QStringList&) const override; private: QChar m_char; }; class RangeDetect : public Rule { protected: bool doLoad(QXmlStreamReader & reader) override; - MatchResult doMatch(const QString & text, int offset, const QStringList&) override; + MatchResult doMatch(const QString & text, int offset, const QStringList&) const override; private: QChar m_begin; QChar m_end; }; class RegExpr : public Rule { protected: bool doLoad(QXmlStreamReader & reader) override; - MatchResult doMatch(const QString & text, int offset, const QStringList &captures) override; + MatchResult doMatch(const QString & text, int offset, const QStringList &captures) const override; private: - QString m_pattern; QRegularExpression m_regexp; + bool m_dynamic = false; }; class StringDetect : public Rule { protected: bool doLoad(QXmlStreamReader & reader) override; - MatchResult doMatch(const QString & text, int offset, const QStringList &captures) override; + MatchResult doMatch(const QString & text, int offset, const QStringList &captures) const override; private: QString m_string; Qt::CaseSensitivity m_caseSensitivity; + bool m_dynamic = false; }; class WordDetect : public Rule { protected: bool doLoad(QXmlStreamReader & reader) override; - MatchResult doMatch(const QString & text, int offset, const QStringList &captures) override; + MatchResult doMatch(const QString & text, int offset, const QStringList &captures) const override; private: QString m_word; Qt::CaseSensitivity m_caseSensitivity; }; } #endif // KSYNTAXHIGHLIGHTING_RULE_P_H