Method readEndDelimitedFrames

app/src/IO/FrameReader.cpp:360–412

* @brief Extracts frames terminated by an end delimiter from the buffer. */

 * @brief Extracts frames terminated by an end delimiter from the buffer.
 */
void IO::FrameReader::readEndDelimitedFrames()
{
  Q_ASSERT(m_circularBuffer.capacity() > 0);
  Q_ASSERT(!m_finishSequences.isEmpty());
  Q_ASSERT(m_operationMode == SerialStudio::QuickPlot
           || m_frameDetectionMode == SerialStudio::EndDelimiterOnly);

  constexpr int kMaxFramesPerCall = 32768;
  int iterations                  = 0;
  while (iterations < kMaxFramesPerCall) {
    ++iterations;

    int endIndex                = -1;
    const QByteArray* delimiter = nullptr;

    if (m_finishSequences.size() == 1) [[likely]] {
      endIndex  = m_circularBuffer.findPatternKMP(m_finishSequences[0], m_finishSequenceLps[0]);
      delimiter = &m_finishSequences[0];
    } else {
      const auto match = m_circularBuffer.findFirstOfPatterns(m_finishSequences);
      if (match.position >= 0) {
        endIndex  = match.position;
        delimiter = &m_finishSequences[match.patternIndex];
      }
    }

    if (endIndex == -1)
      break;

    CapturedDataPtr ptr;
    CapturedData* cd = claimCapturedSlot(ptr);
    m_circularBuffer.peekRangeInto(0, endIndex, cd->data);

    const auto crcPosition = endIndex + delimiter->size();
    const auto frameEndPos = crcPosition + m_checksumLength;
    if (cd->data.isEmpty()) {
      consumeBytes(frameEndPos);
      continue;
    }

    const auto result = checksum(cd->data, crcPosition);
    if (result == ValidationStatus::ChecksumIncomplete)
      break;

    if (result == ValidationStatus::FrameOk)
      enqueueCaptured(std::move(ptr), cd, frameEndPos);
    else
      consumeBytes(frameEndPos);
  }

  if (iterations >= kMaxFramesPerCall) [[unlikely]]
    qWarning() << "[FrameReader] Loop iteration limit reached in readEndDelimitedFrames";
}

/**
 * @brief Extracts frames bounded by consecutive start delimiters.