Skip to content

Commit

Permalink
[#19] parse output from rst2html for error info
Browse files Browse the repository at this point in the history
  • Loading branch information
@kreuzberger
kreuzberger committed Jul 13, 2021
1 parent b6d5cbb commit 86293a8
Show file tree
Hide file tree
Showing 16 changed files with 567 additions and 446 deletions.
2 changes: 1 addition & 1 deletion doc/templates/rstcheck_warnng.rst → doc/templates/rstcheck_warnings.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Chapter


Section
=======
======

.. code::
Expand Down
4 changes: 2 additions & 2 deletions editor/SphinxHtmlPage.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -147,10 +147,10 @@ void HtmlPage::updateView()
void HtmlPage::onBuildQueueFinished()
{
if (!htmlFile().isEmpty()) {
auto pos = SphinxWidgetHelpers::scrollBarPos(mView);
auto pos = WidgetHelpers::scrollBarPos(mView);
reload();
//mView->update();
SphinxWidgetHelpers::setScrollBarPos(mView, pos);
WidgetHelpers::setScrollBarPos(mView, pos);
}
}

Expand Down
4 changes: 2 additions & 2 deletions editor/SphinxPreviewPage.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,9 @@ PreviewPage::~PreviewPage() {}
void PreviewPage::setHtml(const QString &html)
{
// preserve scroll position
auto pos = SphinxWidgetHelpers::scrollBarPos(mView);
auto pos = WidgetHelpers::scrollBarPos(mView);
mView->setHtml(html);
SphinxWidgetHelpers::setScrollBarPos(mView, pos);
WidgetHelpers::setScrollBarPos(mView, pos);
}

void PreviewPage::updateView()
Expand Down
166 changes: 86 additions & 80 deletions editor/SphinxRest2Html.cpp
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
#include "SphinxRest2Html.h"
#include "../options/SphinxSettings.h"
#include "../qtcreator-sphinx-pluginconstants.h"
#include "SphinxWidgetHelpers.h"

#include <coreplugin/icore.h>
#include <coreplugin/messagemanager.h>
#include <utils/temporarydirectory.h>
#include <utils/temporaryfile.h>

#include <texteditor/semantichighlighter.h>
#include <texteditor/textdocument.h>
Expand All @@ -24,40 +24,11 @@ namespace qtc::plugin::sphinx {

static ReST2Html *theRest2HtmlInstance = nullptr;

class ReST2HtmlFucture : public QFutureInterface<TextEditor::HighlightingResult>, public QObject
{
public:
explicit ReST2HtmlFucture(const Offenses &offenses) { reportResults(offenses); }
};

class TextMark : public TextEditor::TextMark
{
public:
static Utils::Theme::Color colorForSeverity(int severity)
{
switch (severity) {
case 1:
return Utils::Theme::TextColorNormal;
case 2:
return Utils::Theme::CodeModel_Warning_TextMarkColor;
case 3:
return Utils::Theme::CodeModel_Error_TextMarkColor;
case 4:
return Utils::Theme::CodeModel_Error_TextMarkColor;
default:
return Utils::Theme::TextColorNormal;
}
}
TextMark(const Utils::FilePath &fileName, int line, int severity, const QString &text)
: TextEditor::TextMark(fileName, line, "rest2html")
{
setColor(colorForSeverity(severity));
setPriority(TextEditor::TextMark::Priority(severity));
setLineAnnotation(text);
QString tooltip = text;
setToolTip(tooltip);
}
};
//class ReST2HtmlFuture : public QFutureInterface<TextEditor::HighlightingResult>, public QObject
//{
//public:
// explicit ReST2HtmlFuture(const Offenses &offenses) { reportResults(offenses); }
//};

ReST2Html::ReST2Html()
{
Expand Down Expand Up @@ -96,6 +67,7 @@ ReST2Html::ReST2Html()
}

mLogFile = logFilePath();
mMessageFilter = {"Unknown directive"};
}

ReST2Html::~ReST2Html()
Expand Down Expand Up @@ -144,7 +116,12 @@ bool ReST2Html::run(TextEditor::TextDocument *document /*, const QString &fileNa
mDocument = document;

mReST2HtmlProcess->write(mStartSeq.toUtf8().constData());
mReST2HtmlProcess->write(data.constData(), data.length());
QVariantMap content;
content["source"] = data.constData();
content["source_path"] = document->filePath().toString();
QJsonDocument json;
json.setObject(QJsonObject::fromVariantMap(content));
mReST2HtmlProcess->write(json.toJson().constData(), json.toJson().length());
mReST2HtmlProcess->write(mEndSeq.toUtf8().constData());
mReST2HtmlProcess->write("\n");
}
Expand All @@ -153,14 +130,11 @@ bool ReST2Html::run(TextEditor::TextDocument *document /*, const QString &fileNa

std::unique_ptr<QTemporaryFile> ReST2Html::logFilePath() const
{
auto relResource = QString(qtc::plugin::sphinx::Constants::SnippetGroupId).toLower();

const QString fileTemplate = QLatin1String("/rst2html") + QLatin1String("-XXXXXX.log");

auto temporary_dir = Utils::TemporaryDirectory(relResource);
temporary_dir.setAutoRemove(false);
auto temporary_dir = WidgetHelpers::log_directory();

auto temporaryFile = std::make_unique<QTemporaryFile>(temporary_dir.path() + fileTemplate);
auto temporaryFile = std::make_unique<QTemporaryFile>(temporary_dir + fileTemplate);
temporaryFile->open();
temporaryFile->setAutoRemove(false);

Expand All @@ -179,17 +153,22 @@ void ReST2Html::initReST2HtmlProcess(const QString &workingDirectoy)
QObject::connect(mReST2HtmlProcess, signal, [&](int status, QProcess::ExitStatus /*exitStatus*/) {
if (status) {
Core::MessageManager::instance()->writeFlashing(
QString("rst2html exited with error: %1\n").arg(status)
+ QString::fromUtf8(mReST2HtmlProcess->readAllStandardError().trimmed()));
QString("rst2html exited with error: %1\n").arg(status) + mErrorBuffer);
}
});

QObject::connect(mReST2HtmlProcess, &QProcess::readyReadStandardOutput, [&]() {
mOutputBuffer.append(QString::fromUtf8(mReST2HtmlProcess->readAllStandardOutput()));
if (mOutputBuffer.endsWith(mEndSeq + "\n")) {
finishReST2HtmlHighlight();
finishReST2HtmlOutput();
}
});
QObject::connect(mReST2HtmlProcess, &QProcess::readyReadStandardError, [&]() {
mErrorBuffer.append(QString::fromUtf8(mReST2HtmlProcess->readAllStandardError()));
});

mErrorBuffer.clear();
mOutputBuffer.clear();

mReST2HtmlProcess->start(mPythonFilePath,
{mReST2HtmlScript, mStartSeq, mEndSeq, mLogFile->fileName()},
Expand Down Expand Up @@ -220,7 +199,7 @@ void ReST2Html::restartReST2HtmlProcess(const QString &workingDirectory)
initReST2HtmlProcess(workingDirectory);
}

void ReST2Html::finishReST2HtmlHighlight()
void ReST2Html::finishReST2HtmlOutput()
{
QTextDocument *doc = mDocument ? mDocument->document() : nullptr;
if (!doc || mStartRevision != doc->revision()) {
Expand All @@ -229,27 +208,39 @@ void ReST2Html::finishReST2HtmlHighlight()
}

bool isHtml = (mOutputBuffer.startsWith("<!DOCTYPE html>")) ? true : false;
// normal output or error output?
if (!isHtml) {
qCInfo(log_rst2html()) << "received error output in rst2html" << mOutputBuffer;
Offenses offenses = processReST2HtmlErrorOutput();
const Utils::FilePath filePath = mDocument->filePath();
for (Diagnostic &diag : mDiagnostics[filePath]) {
diag.textMark = std::make_shared<TextMark>(filePath, diag.line, diag.severity, diag.message);
mDocument->addMark(diag.textMark.get());
}
ReST2HtmlFucture ReST2HtmlFucture(offenses);
TextEditor::SemanticHighlighter::incrementalApplyExtraAdditionalFormats(
mDocument->syntaxHighlighter(), ReST2HtmlFucture.future(), 0, offenses.count(), mExtraFormats);
TextEditor::SemanticHighlighter::clearExtraAdditionalFormatsUntilEnd(
mDocument->syntaxHighlighter(), ReST2HtmlFucture.future());
} else {
processReST2HtmlOutput();
if (isHtml) {
processReST2HtmlOutput(mOutputBuffer);
}
if (!mErrorBuffer.isEmpty()) {
processReST2HtmlErrors(mErrorBuffer);
}

mOutputBuffer.clear();
mErrorBuffer.clear();

mBusy = false;
}

void ReST2Html::processReST2HtmlErrors(const QString &buffer)
{
qCInfo(log_rst2html()) << "received error output in rst2html" << buffer;
/*Offenses offenses = */
processReST2HtmlErrorOutput(buffer);
const Utils::FilePath filePath = mDocument->filePath();
for (auto &diag : mDiagnostics[filePath]) {
diag.textMark = std::make_shared<Marks::TextMark>(filePath,
diag.line,
diag.severity,
diag.message);
mDocument->addMark(diag.textMark.get());
}
// ReST2HtmlFuture ReST2HtmlFuture(offenses);
// TextEditor::SemanticHighlighter::incrementalApplyExtraAdditionalFormats(
// mDocument->syntaxHighlighter(), ReST2HtmlFuture.future(), 0, offenses.count(), mExtraFormats);
// TextEditor::SemanticHighlighter::clearExtraAdditionalFormatsUntilEnd(mDocument->syntaxHighlighter(),
// ReST2HtmlFuture.future());
}

static int kindOfSeverity(const QStringRef &severity)
{
int kind = 0;
Expand All @@ -271,51 +262,68 @@ static int kindOfSeverity(const QStringRef &severity)
return kind;
}

Offenses ReST2Html::processReST2HtmlErrorOutput()
void ReST2Html::processReST2HtmlErrorOutput(const QString &buffer)
{
// SystemMessage: <string>:13: (SEVERE/4) Problems with "include" directive path:
// InputError: [Errno 2] No such file or directory: 'test.rst'.

Offenses result;
Diagnostics &diag = mDiagnostics[mDocument->filePath()] = Diagnostics();

mOutHtml.clear();
// Offenses result;

const QVector<QStringRef> lines = mOutputBuffer.splitRef('\n');
const QVector<QStringRef> lines = buffer.splitRef('\n');
for (const QStringRef &line : lines) {
if (line == mEndSeq)
break;

QVector<QStringRef> fields = line.split(':');
if (fields.size() < 2)
continue;
int lineN = fields[0].toInt();
int kind = kindOfSeverity(fields[1]);

auto filename = fields[0].toString();
int lineN = fields[1].toInt();
int kind = kindOfSeverity(fields[2]);
int column = -1;
//fields[2].toInt();
int length = -1;
//int length = -1;
//fields[3].toInt();
result << TextEditor::HighlightingResult(uint(lineN), uint(column), uint(length), kind);
//result << TextEditor::HighlightingResult(uint(lineN), uint(column), uint(length), kind);

//<string>:9: (ERROR/3) Content block expected for the \"code\" directive
QRegularExpression messageRegEx = QRegularExpression(
"\\((INFO|WARNING|ERROR|SEVERE)/\\d+\\)(.*)");
QRegularExpressionMatch match = messageRegEx.match(fields[1]);
QRegularExpressionMatch match = messageRegEx.match(fields[2]);
QString message;
if (match.hasMatch()) {
message = match.captured(2).trimmed();
for (const auto &f : mMessageFilter) {
if (message.startsWith(f)) {
message.clear();
break;
}
}
}
diag.push_back(Diagnostic{lineN, kind, message, nullptr});
}
// filename handling
if (filename == "<string>" || filename.isEmpty())
continue;

mOutputBuffer.clear();
if (0 < lineN && 0 < kind && !message.isEmpty()) {
QFileInfo fi = (QFileInfo::exists(filename))
? filename
: mReST2HtmlProcess->workingDirectory() + "/" + filename;

return result;
qCInfo(log_rst2html) << "adding diag for " << fi.absoluteFilePath() << " at " << lineN
<< column << kind;
auto &diag = mDiagnostics[Utils::FilePath::fromFileInfo(fi)];
diag[lineN] = (Marks::Diagnostic{lineN, kind, message, nullptr});
}
}

// return {};
}

void ReST2Html::processReST2HtmlOutput()
void ReST2Html::processReST2HtmlOutput(const QString &buffer)
{
mOutHtml.clear();
const QVector<QStringRef> lines = mOutputBuffer.splitRef('\n');
const QVector<QStringRef> lines = buffer.splitRef('\n');
for (const QStringRef &line : lines) {
if (line == mEndSeq)
break;
Expand All @@ -324,8 +332,6 @@ void ReST2Html::processReST2HtmlOutput()
}

emit htmlChanged(mOutHtml);

mOutputBuffer.clear();
}

qtc::plugin::sphinx::ReST2Html::Range ReST2Html::lineColumnLengthToRange(int line, int column, int length)
Expand Down
27 changes: 10 additions & 17 deletions editor/SphinxRest2Html.h
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#pragma once

#include "SphinxWidgetHelpers.h"
#include <texteditor/semantichighlighter.h>

#include <utils/fileutils.h>

#include <QElapsedTimer>
Expand All @@ -24,8 +24,8 @@ namespace qtc::plugin::sphinx {

class TextMark;

typedef TextEditor::HighlightingResult Offense;
typedef QVector<TextEditor::HighlightingResult> Offenses;
//typedef TextEditor::HighlightingResult Offense;
//typedef QVector<TextEditor::HighlightingResult> Offenses;

class ReST2Html : public QObject
{
Expand All @@ -42,14 +42,6 @@ class ReST2Html : public QObject
void htmlChanged(const QString &);

private:
struct Diagnostic
{
int line;
int severity;
QString message;
std::shared_ptr<TextMark> textMark;
};

class Range
{
public:
Expand Down Expand Up @@ -82,14 +74,13 @@ class ReST2Html : public QObject
}
};

using Diagnostics = std::vector<Diagnostic>;

void initReST2HtmlProcess(const QString &);
void restartReST2HtmlProcess(const QString &);
void closeReST2HtmlProcess();
void finishReST2HtmlHighlight();
void processReST2HtmlOutput();
Offenses processReST2HtmlErrorOutput();
void finishReST2HtmlOutput();
void processReST2HtmlOutput(const QString &buffer);
void processReST2HtmlErrors(const QString &buffer);
/*Offenses*/ void processReST2HtmlErrorOutput(const QString &buffer);
Range lineColumnLengthToRange(int line, int column, int length);
std::unique_ptr<QTemporaryFile> logFilePath() const;

Expand All @@ -100,18 +91,20 @@ class ReST2Html : public QObject
QTemporaryFile mTemporaryFile;
QString mPythonFilePath;
QString mOutputBuffer;
QString mErrorBuffer;

int mStartRevision = 0;
QPointer<TextEditor::TextDocument> mDocument;
QHash<int, QTextCharFormat> mExtraFormats;

QHash<Utils::FilePath, Diagnostics> mDiagnostics;
QHash<Utils::FilePath, Marks::Diagnostics> mDiagnostics;
std::vector<TextMark *> mTextMarks;

QElapsedTimer mTimer;
QString mStartSeq = "%<$<!<";
QString mEndSeq = ">!>$>%";
QString mOutHtml;
std::unique_ptr<QTemporaryFile> mLogFile = nullptr;
QList<QString> mMessageFilter;
};
} // namespace qtc::plugin::sphinx
Loading

0 comments on commit 86293a8

Please sign in to comment.