Home Articles

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

Asked
Viewed 1854 times
0

我正在创建一个程序,我在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转义颜色转换为富文本颜色,所以我知道有人已经走了这条路 . 然后,在构建项目时,由于某种原因,Qt Creator不会在其自己的终端中着色构建输出 .

2 Answers

  • 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

  • 0

    QProcess 不是't interfere with the process output, it'只是 gcc - 许多其他发出彩色输出的程序 - 默认情况下只有当它检测到它在TTY设备上写入时才会发出颜色转义序列 .

    如果要禁用此启发式并要求始终生成彩色输出,则必须将 -fdiagnostics-color=always 选项添加到编译器命令行 .

Related