在QProcess输出中保留ANSI转义序列

时间:2017-09-22 18:47:14

标签: linux bash qt ansi qprocess

我正在创建一个程序,我在Qt中使用QProcess框架在Ubuntu 16.04 Qt 5.5.1上启用C ++ 11来运行进程。我正在将流程输出流定向到QTextEdit。

我想将此输出着色以使用本机终端使用嵌入的ANSI转义颜色序列解释的相同颜色。但是,我无法解析转义序列,因为它们似乎在QProcess输出中缺失。我原本以为QString正在剥离它们,但经过一些测试后我不相信这种情况。

如果我可以在QProcess输出中保留转义序列,我发现some information指向ANSI转义颜色解释方向。

以下是我在Qt代码中所做的一个示例项目。

源文件......

#include "mainwindow.h"
#include "ui_mainwindow.h"
#include <QString>
#include <QProcess>
#include <QStringList>

MainWindow::MainWindow(QWidget *parent) :
    QMainWindow(parent),
    ui(new Ui::MainWindow)
{
    ui->setupUi(this);

    QStringList input = {"gcc will_not_build.c"};
    QProcess * proc = new QProcess();

    proc->setReadChannel(QProcess::StandardOutput);
    proc->setProcessChannelMode(QProcess::MergedChannels);
    proc->setWorkingDirectory("/path/to/test/c/file/");

    //Start bash
    proc->start("bash");
    proc->waitForStarted();

    // Write as many commands to this process as needed
    foreach(QString str, input){
        proc->write(str.toUtf8() + "\n");
        proc->waitForBytesWritten(-1);
    }

    // Let bash close gracefully
    proc->write("exit $?\n");
    proc->waitForBytesWritten(-1);

    proc->closeWriteChannel();
    proc->waitForFinished();
    proc->waitForReadyRead();

    QByteArray read_data = proc->readAll();

    // The use of tr(read_data) also works here.
    QString output = tr(read_data);//QString::fromStdString (read_data.toStdString ());

    proc->closeReadChannel(QProcess::StandardOutput);

    proc->close();
    delete proc;

    // Add the output to the text box
    ui->textEdit->append (output);
}

MainWindow::~MainWindow()
{
    delete ui;
}

标题文件......

#ifndef MAINWINDOW_H
#define MAINWINDOW_H

#include <QMainWindow>

namespace Ui {
class MainWindow;
}

class MainWindow : public QMainWindow
{
    Q_OBJECT

public:
    explicit MainWindow(QWidget *parent = 0);
    ~MainWindow();

private:
    Ui::MainWindow *ui;
};

#endif // MAINWINDOW_H 

表单文件......

<?xml version="1.0" encoding="UTF-8"?>
<ui version="4.0">
 <class>MainWindow</class>
 <widget class="QMainWindow" name="MainWindow">
  <property name="geometry">
   <rect>
    <x>0</x>
    <y>0</y>
    <width>400</width>
    <height>300</height>
   </rect>
  </property>
  <property name="windowTitle">
   <string>MainWindow</string>
  </property>
  <widget class="QWidget" name="centralWidget">
   <widget class="QTextEdit" name="textEdit">
    <property name="geometry">
     <rect>
      <x>33</x>
      <y>19</y>
      <width>331</width>
      <height>211</height>
     </rect>
    </property>
   </widget>
  </widget>
  <widget class="QMenuBar" name="menuBar">
   <property name="geometry">
    <rect>
     <x>0</x>
     <y>0</y>
     <width>400</width>
     <height>19</height>
    </rect>
   </property>
  </widget>
  <widget class="QToolBar" name="mainToolBar">
   <attribute name="toolBarArea">
    <enum>TopToolBarArea</enum>
   </attribute>
   <attribute name="toolBarBreak">
    <bool>false</bool>
   </attribute>
  </widget>
  <widget class="QStatusBar" name="statusBar"/>
 </widget>
 <layoutdefault spacing="6" margin="11"/>
 <resources/>
 <connections/>
</ui>

C源文件......

int main(){
    // Intentionally will not build
    I will not build :)
}

我的输出如下:

QProcess gcc输出

本机Linux终端的输出如下所示:

Linux终端gcc输出颜色

有谁知道如何在QProcess输出中保留ANSI转义颜色序列,以便模拟Linux终端颜色?

作为旁注,我在Qt Creator源代码中进行了挖掘,并且有一个类可以将ANSI转义颜色转换为Rich Text颜色,所以我知道有人在这条路上走了。然后,在构建项目时,由于某种原因,Qt Creator不会在其自己的终端中着色构建输出。

2 个答案:

答案 0 :(得分:1)

感谢我对问题的非常有见地的回答,我找到了解决问题的方法。我会分享......

QProcess没有错,也不是QString。问题在于程序执行的环境。由于这些程序的输出(gcc等)未连接到TTY设备,因此将剥离所有ANSI转义序列。但有一种方法to trick the output to appear as if it were connected to a TTY device

只需将unbuffer添加到命令中。

由于我的使用实际上是在创建一个Qt Creator插件,所以我已经链接了许多Qt Creator源代码。只是发生了一个名为AnsiEscapeCodeHandler的便捷类,它已经存在,可以将ANSI转义序列转换为QTextCharFormat's和相应的ANSI转义序列剥离字符串。

为了说明我如何使用这个类,但现在在我的示例中,我将从可下载的Qt Creator源代码中将ansieescapecodehandler.hansiescapecodehandler.cpp复制到我的测试项目中。我不得不从AnsiEscapeCodeHandler源文件中删除几行,以便在Qt Creator源的其余部分的上下文之外进行编译,但就是这样。

新的源文件......

#include "mainwindow.h"
#include "ui_mainwindow.h"
#include <QString>
#include <QProcess>
#include <QStringList>

MainWindow::MainWindow(QWidget *parent) :
    QMainWindow(parent),
    ui(new Ui::MainWindow)
{
    ui->setupUi(this);

    QStringList input = {"unbuffer gcc will_not_build.c"};
    QProcess * proc = new QProcess();

    proc->setReadChannel(QProcess::StandardOutput);
    proc->setProcessChannelMode(QProcess::MergedChannels);
    proc->setWorkingDirectory("/path/to/test/c/file/");

    //Start bash
    proc->start("bash");
    proc->waitForStarted();

    // Write as many commands to this process as needed
    foreach(QString str, input){
        proc->write(str.toUtf8() + "\n");
        proc->waitForBytesWritten(-1);
    }

    // Let bash close gracefully
    proc->write("exit $?\n");
    proc->waitForBytesWritten(-1);

    proc->closeWriteChannel();
    proc->waitForFinished();
    proc->waitForReadyRead();

    QByteArray read_data = proc->readAll();

    // The use of tr(read_data) also works here.
    QString output = tr(read_data);//QString::fromStdString (read_data.toStdString ());

    proc->closeReadChannel(QProcess::StandardOutput);

    proc->close();
    delete proc;

    // Strip default character set escape sequences, since those seem to be left
    // See https://stackoverflow.com/questions/36279015/what-does-x1bb-do
    output.remove("\x1b(B", Qt::CaseInsensitive);

    // Since it is just one single text stream define here instead of globally
    Utils::AnsiEscapeCodeHandler ansi_handler;

    FormattedTextList result = ansi_handler.parseText (Utils::FormattedText(output, ui->textEdit->currentCharFormat ()));

    // Loop through the text/format results
    foreach(Utils::FormattedText ft, result){
        ui->textEdit->setCurrentCharFormat (ft.format);
        ui->textEdit->insertPlainText (ft.text);
    }
}

MainWindow::~MainWindow()
{
    delete ui;
}

新的头文件......

#ifndef MAINWINDOW_H
#define MAINWINDOW_H

#include <QMainWindow>

// This exists in the qtcreator-src code and handles ansi escape code color parsing
#include "ansiescapecodehandler.h"

namespace Ui {
class MainWindow;
}

class MainWindow : public QMainWindow
{
    Q_OBJECT

public:
    explicit MainWindow(QWidget *parent = 0);
    ~MainWindow();

private:
    Ui::MainWindow *ui;

    typedef QList<Utils::FormattedText> FormattedTextList;
};

#endif // MAINWINDOW_H

新的彩色输出...... QProcess gcc output

答案 1 :(得分:0)

gcc不会干扰过程输出,它只是-fdiagnostics-color=always - 发出彩色输出的许多其他程序 - 默认情况下只发出彩色转义序列检测到它是在TTY设备上写的。

如果要禁用此启发式并要求始终生成彩色输出,则必须将try: cursor.execute("savepoint my_save_point") cursor.execute(query) except: cursor.execute("rollback to savepoint my_save_point") finally: cursor.execute("release savepoint my_save_point") 选项添加到编译器命令行。