File indexing completed on 2024-05-12 15:50:01

 /*
     SPDX-FileCopyrightText: 2016 Volker Krause <vkrause@kde.org>
 
     SPDX-License-Identifier: MIT
 */
 
 #include "abstracthighlighter.h"
 #include "abstracthighlighter_p.h"
 #include "context_p.h"
 #include "definition_p.h"
 #include "foldingregion.h"
 #include "format.h"
 #include "ksyntaxhighlighting_logging.h"
 #include "repository.h"
 #include "rule_p.h"
 #include "state.h"
 #include "state_p.h"
 #include "theme.h"
 
 using namespace KSyntaxHighlighting;
 
 AbstractHighlighterPrivate::AbstractHighlighterPrivate()
 {
 }
 
 AbstractHighlighterPrivate::~AbstractHighlighterPrivate()
 {
 }
 
 void AbstractHighlighterPrivate::ensureDefinitionLoaded()
 {
     auto defData = DefinitionData::get(m_definition);
     if (Q_UNLIKELY(!m_definition.isValid() && defData->repo && !m_definition.name().isEmpty())) {
         qCDebug(Log) << "Definition became invalid, trying re-lookup.";
         m_definition = defData->repo->definitionForName(m_definition.name());
         defData = DefinitionData::get(m_definition);
     }
 
     if (Q_UNLIKELY(!defData->repo && !defData->fileName.isEmpty())) {
         qCCritical(Log) << "Repository got deleted while a highlighter is still active!";
     }
 
     if (m_definition.isValid()) {
         defData->load();
     }
 }
 
 AbstractHighlighter::AbstractHighlighter()
     : d_ptr(new AbstractHighlighterPrivate)
 {
 }
 
 AbstractHighlighter::AbstractHighlighter(AbstractHighlighterPrivate *dd)
     : d_ptr(dd)
 {
 }
 
 AbstractHighlighter::~AbstractHighlighter()
 {
     delete d_ptr;
 }
 
 Definition AbstractHighlighter::definition() const
 {
     return d_ptr->m_definition;
 }
 
 void AbstractHighlighter::setDefinition(const Definition &def)
 {
     Q_D(AbstractHighlighter);
     d->m_definition = def;
 }
 
 Theme AbstractHighlighter::theme() const
 {
     Q_D(const AbstractHighlighter);
     return d->m_theme;
 }
 
 void AbstractHighlighter::setTheme(const Theme &theme)
 {
     Q_D(AbstractHighlighter);
     d->m_theme = theme;
 }
 
 /**
  * Returns the index of the first non-space character. If the line is empty,
  * or only contains white spaces, text.size() is returned.
  */
 static inline int firstNonSpaceChar(QStringView text)
 {
     for (int i = 0; i < text.length(); ++i) {
         if (!text[i].isSpace()) {
             return i;
         }
     }
     return text.size();
 }
 
 #if KSYNTAXHIGHLIGHTING_BUILD_DEPRECATED_SINCE(5, 87)
 State AbstractHighlighter::highlightLine(const QString &text, const State &state)
 {
     return highlightLine(QStringView(text), state);
 }
 #endif
 
 State AbstractHighlighter::highlightLine(QStringView text, const State &state)
 {
     Q_D(AbstractHighlighter);
 
     // verify definition, deal with no highlighting being enabled
     d->ensureDefinitionLoaded();
     const auto defData = DefinitionData::get(d->m_definition);
     if (!d->m_definition.isValid() || !defData->isLoaded()) {
         applyFormat(0, text.size(), Format());
         return State();
     }
 
     // verify/initialize state
     auto newState = state;
     auto stateData = StateData::get(newState);
     const auto definitionId = DefinitionData::get(d->m_definition)->id;
     if (!stateData->isEmpty() && stateData->m_defId != definitionId) {
         qCDebug(Log) << "Got invalid state, resetting.";
         stateData->clear();
     }
     if (stateData->isEmpty()) {
         stateData->push(defData->initialContext(), QStringList());
         stateData->m_defId = definitionId;
     }
 
     // process empty lines
     if (text.isEmpty()) {
         /**
          * handle line empty context switches
          * guard against endless loops
          * see https://phabricator.kde.org/D18509
          */
         int endlessLoopingCounter = 0;
         while (!stateData->topContext()->lineEmptyContext().isStay() || !stateData->topContext()->lineEndContext().isStay()) {
             /**
              * line empty context switches
              */
             if (!stateData->topContext()->lineEmptyContext().isStay()) {
                 if (!d->switchContext(stateData, stateData->topContext()->lineEmptyContext(), QStringList())) {
                     /**
                      * end when trying to #pop the main context
                      */
                     break;
                 }
                 /**
                  * line end context switches only when lineEmptyContext is #stay. This avoids
                  * skipping empty lines after a line continuation character (see bug 405903)
                  */
             } else if (!d->switchContext(stateData, stateData->topContext()->lineEndContext(), QStringList())) {
                 break;
             }
 
             // guard against endless loops
             ++endlessLoopingCounter;
             if (endlessLoopingCounter > 1024) {
                 qCDebug(Log) << "Endless switch context transitions for line empty context, aborting highlighting of line.";
                 break;
             }
         }
         auto context = stateData->topContext();
         applyFormat(0, 0, context->attributeFormat());
         return newState;
     }
 
     int offset = 0;
     int beginOffset = 0;
     bool lineContinuation = false;
 
     /**
      * for expensive rules like regexes we do:
      *   - match them for the complete line, as this is faster than re-trying them at all positions
      *   - store the result of the first position that matches (or -1 for no match in the full line) in the skipOffsets hash for re-use
      *   - have capturesForLastDynamicSkipOffset as guard for dynamic regexes to invalidate the cache if they might have changed
      */
     QVarLengthArray<QPair<Rule *, int>, 8> skipOffsets;
     QStringList capturesForLastDynamicSkipOffset;
 
     auto getSkipOffsetValue = [&skipOffsets](Rule *r) -> int {
         auto i = std::find_if(skipOffsets.begin(), skipOffsets.end(), [r](const auto &v) {
             return v.first == r;
         });
         if (i == skipOffsets.end())
             return 0;
         return i->second;
     };
 
     auto insertSkipOffset = [&skipOffsets](Rule *r, int i) {
         auto it = std::find_if(skipOffsets.begin(), skipOffsets.end(), [r](const auto &v) {
             return v.first == r;
         });
         if (it == skipOffsets.end()) {
             skipOffsets.push_back({r, i});
         } else {
             it->second = i;
         }
     };
 
     /**
      * current active format
      * stored as pointer to avoid deconstruction/constructions inside the internal loop
      * the pointers are stable, the formats are either in the contexts or rules
      */
     auto currentFormat = &stateData->topContext()->attributeFormat();
 
     /**
      * cached first non-space character, needs to be computed if < 0
      */
     int firstNonSpace = -1;
     int lastOffset = offset;
     int endlessLoopingCounter = 0;
     do {
         /**
          * avoid that we loop endless for some broken hl definitions
          */
         if (lastOffset == offset) {
             ++endlessLoopingCounter;
             if (endlessLoopingCounter > 1024) {
                 qCDebug(Log) << "Endless state transitions, aborting highlighting of line.";
                 break;
             }
         } else {
             // ensure we made progress, clear the endlessLoopingCounter
             Q_ASSERT(offset > lastOffset);
             lastOffset = offset;
             endlessLoopingCounter = 0;
         }
 
         /**
          * try to match all rules in the context in order of declaration in XML
          */
         bool isLookAhead = false;
         int newOffset = 0;
         const Format *newFormat = nullptr;
         for (const auto &rule : stateData->topContext()->rules()) {
             /**
              * filter out rules that require a specific column
              */
             if ((rule->requiredColumn() >= 0) && (rule->requiredColumn() != offset)) {
                 continue;
             }
 
             /**
              * filter out rules that only match for leading whitespace
              */
             if (rule->firstNonSpace()) {
                 /**
                  * compute the first non-space lazy
                  * avoids computing it for contexts without any such rules
                  */
                 if (firstNonSpace < 0) {
                     firstNonSpace = firstNonSpaceChar(text);
                 }
 
                 /**
                  * can we skip?
                  */
                 if (offset > firstNonSpace) {
                     continue;
                 }
             }
 
             /**
              * shall we skip application of this rule? two cases:
              *   - rule can't match at all => currentSkipOffset < 0
              *   - rule will only match for some higher offset => currentSkipOffset > offset
              *
              * we need to invalidate this if we are dynamic and have different captures then last time
              */
             if (rule->isDynamic() && (capturesForLastDynamicSkipOffset != stateData->topCaptures())) {
                 skipOffsets.clear();
             }
             const auto currentSkipOffset = getSkipOffsetValue(rule.get());
             if (currentSkipOffset < 0 || currentSkipOffset > offset) {
                 continue;
             }
 
             const auto newResult = rule->doMatch(text, offset, stateData->topCaptures());
             newOffset = newResult.offset();
 
             /**
              * update skip offset if new one rules out any later match or is larger than current one
              */
             if (newResult.skipOffset() < 0 || newResult.skipOffset() > currentSkipOffset) {
                 insertSkipOffset(rule.get(), newResult.skipOffset());
 
                 // remember new captures, if dynamic to enforce proper reset above on change!
                 if (rule->isDynamic()) {
                     capturesForLastDynamicSkipOffset = stateData->topCaptures();
                 }
             }
 
             if (newOffset <= offset) {
                 continue;
             }
 
             /**
              * apply folding.
              * special cases:
              *   - rule with endRegion + beginRegion: in endRegion, the length is 0
              *   - rule with lookAhead: length is 0
              */
             if (rule->endRegion().isValid() && rule->beginRegion().isValid()) {
                 applyFolding(offset, 0, rule->endRegion());
             } else if (rule->endRegion().isValid()) {
                 applyFolding(offset, rule->isLookAhead() ? 0 : newOffset - offset, rule->endRegion());
             }
             if (rule->beginRegion().isValid()) {
                 applyFolding(offset, rule->isLookAhead() ? 0 : newOffset - offset, rule->beginRegion());
             }
 
             if (rule->isLookAhead()) {
                 Q_ASSERT(!rule->context().isStay());
                 d->switchContext(stateData, rule->context(), newResult.captures());
                 isLookAhead = true;
                 break;
             }
 
             d->switchContext(stateData, rule->context(), newResult.captures());
             newFormat = rule->attributeFormat().isValid() ? &rule->attributeFormat() : &stateData->topContext()->attributeFormat();
             if (newOffset == text.size() && rule->isLineContinue()) {
                 lineContinuation = true;
             }
             break;
         }
         if (isLookAhead) {
             continue;
         }
 
         if (newOffset <= offset) { // no matching rule
             if (stateData->topContext()->fallthrough()) {
                 d->switchContext(stateData, stateData->topContext()->fallthroughContext(), QStringList());
                 continue;
             }
 
             newOffset = offset + 1;
             newFormat = &stateData->topContext()->attributeFormat();
         }
 
         /**
          * if we arrive here, some new format has to be set!
          */
         Q_ASSERT(newFormat);
 
         /**
          * on format change, apply the last one and switch to new one
          */
         if (newFormat != currentFormat && newFormat->id() != currentFormat->id()) {
             if (offset > 0) {
                 applyFormat(beginOffset, offset - beginOffset, *currentFormat);
             }
             beginOffset = offset;
             currentFormat = newFormat;
         }
 
         /**
          * we must have made progress if we arrive here!
          */
         Q_ASSERT(newOffset > offset);
         offset = newOffset;
 
     } while (offset < text.size());
 
     /**
      * apply format for remaining text, if any
      */
     if (beginOffset < offset) {
         applyFormat(beginOffset, text.size() - beginOffset, *currentFormat);
     }
 
     /**
      * handle line end context switches
      * guard against endless loops
      * see https://phabricator.kde.org/D18509
      */
     {
         int endlessLoopingCounter = 0;
         while (!stateData->topContext()->lineEndContext().isStay() && !lineContinuation) {
             if (!d->switchContext(stateData, stateData->topContext()->lineEndContext(), QStringList())) {
                 break;
             }
 
             // guard against endless loops
             ++endlessLoopingCounter;
             if (endlessLoopingCounter > 1024) {
                 qCDebug(Log) << "Endless switch context transitions for line end context, aborting highlighting of line.";
                 break;
             }
         }
     }
 
     return newState;
 }
 
 bool AbstractHighlighterPrivate::switchContext(StateData *data, const ContextSwitch &contextSwitch, const QStringList &captures)
 {
     // kill as many items as requested from the stack, will always keep the initial context alive!
     const bool initialContextSurvived = data->pop(contextSwitch.popCount());
 
     // if we have a new context to add, push it
     // then we always "succeed"
     if (contextSwitch.context()) {
         data->push(contextSwitch.context(), captures);
         return true;
     }
 
     // else we abort, if we did try to pop the initial context
     return initialContextSurvived;
 }
 
 void AbstractHighlighter::applyFolding(int offset, int length, FoldingRegion region)
 {
     Q_UNUSED(offset);
     Q_UNUSED(length);
     Q_UNUSED(region);
 }