命令行下的树形打印

命令行下的树形打印

 

最近在处理代码分析问题时，需要将代码的作用域按照树形结构输出。问题的原型大概是下边这个样子的。

图中给了一个简化的代码片段，该代码片段包含5个作用域：全局作用域0、函数fun作用域1、if语句作用域2、else语句作用域3和函数main作用域4。代码作用域有个显著的特点就是具有树形结构，全局作用域作为树根，函数作用域则是其子节点，而局部作用域则是函数作用域的子节点，以此类推。如果要在命令行下输出作用域的组织结构，则是目录树的形式。

将树进行命令行打印并非一件难事，使用的是树的递归深度遍历的思想。代码片段如下：

/*
    树形打印作用域
    root:子树根
    blk:缩进次数
*/
void printTree (Scope*root, int blk)
{
     for( int i= 0;i<blk;i++)printf( "      "); // 缩进
    printf( " |—<%d>\n ", root->id); // 打印"|—<id>"形式
     for ( int i =  0; i < root->children.size(); ++i) // 遍历子节点
    {
        printTree(root->children[i],blk+ 1); // 打印子树，累加缩进次数
    }
}

函数printTree是对树root的一次深度前序遍历，处理每个树根时，先执行当前子树的缩进，然后打印字符串"|—<id>\n"——节点ID，最后顺序遍历子节点，递归执行打印函数。不过这里需要注意的是，打印每个节点时，需要对子节点增加一次缩进。因此使用blk参数记录每颗子树对应的缩进个数，树根的缩进次数初始化为0。打印效果如下：

仔细观察，我们发现打印的效果仍有缺陷。所有的节点缩进都是正常的，但是节点4输出的位置跨越了节点2和3的行，没办法使得节点4打印的连接符号和父节点0连接起来！我们希望输出得更好一点。修改一下代码，我们每次执行缩进的时候都输出字符"|"，这样就能联系所有的子节点了。

for( int i= 0;i<blk;i++)printf( " |    "); // 缩进时输出"|"符号

 

 

但是这样做，仍不够完美，我们换棵树看看效果。

如图所示，比如节点2或者9的子树输出时，冒出很多多余的连接符号，这样影响对树形结构的观察，我们应该把这些多余的连接符去掉！

但是单纯依靠纯粹的递归输出，只能选择是否输出连接符两种手段。如果要通过对树的一次遍历将所有连接符输出正确的话，我们是不能预测接下来输出的节点缩进个数的（有可能是兄弟节点，有可能是子节点，也有可能是前边祖先节点……）。

然而事情总有解决的办法，每个节点输出时是准确知道自己的缩进个数的。这里再次利用递归思想思考这个问题：假设前边的节点输出时都准确的打印了连接符，当前节点输出之前，只要将自身和前一个兄弟节点连接起来即可！

举例来说，当节点8输出时，假设节点0-7都正常输出，没有产生多余的连接符。我们只需要将节点8和节点2（前一个兄弟节点）之间用连接符连接起来即可，其他节点同理！

这样就有一个新的问题产生了，在节点8输出之前，前边的内容已经打印出来了，如何“返回去”重新打印这列连接符呢？答案是——光标移动！

命令行下，字符的打印都是在当前光标之后输出的，光标的位置决定了当前打印字符的位置！如果在打印节点8之前，我们控制光标向上移动（共移动5次——节点8和节点2相差的行数），每移动一次打印一个连接符。不过这里需要注意，每次打印连接符后，光标位置向右移动一列，我们继续移动之前需要将光标列坐标恢复（减1），否则实际打印的将是一个阶梯状的连线！

既然控制光标可以完成我们的目标，具体该如何操作呢？当然，Windows的API提供了解决办法。

WINBASEAPI
BOOL
WINAPI
SetConsoleCursorPosition(
    __in HANDLE hConsoleOutput,
    __in COORD dwCursorPosition
    );

Windows的API函数SetConsoleCursorPosition用来设定光标的位置，参数hConsoleOutput表示输出流句柄，我们使用GetStdHandle(STD_OUTPUT_HANDLE)获取。参数dwCursorPosition是个COORD类型，记录了要设置的光标位置。

typedef  struct _COORD {
    SHORT X;
    SHORT Y;
} COORD, *PCOORD;

我们封装一个简单的函数用于将光标移动到指定位置。

void locate( int x, int y) // 定位到(x,y)
{
    HANDLE out_handle=GetStdHandle(STD_OUTPUT_HANDLE);
    COORD loc;
    loc.X=x;
    loc.Y=y;
    SetConsoleCursorPosition(out_handle, loc);
}

重新思考刚才的光标移动问题，我们是要在输出节点信息前向上移动光标，而非将光标移动到一个绝对的坐标，而是相对坐标！为此，我们还需要获取当前的光标位置，计算出移动到的目的坐标。

Windows的API函数GetConsoleScreenBufferInfo提供了获取光标位置的方法。

WINBASEAPI
BOOL
WINAPI
GetConsoleScreenBufferInfo(
    __in HANDLE hConsoleOutput,
    __out PCONSOLE_SCREEN_BUFFER_INFO lpConsoleScreenBufferInfo
    );

参数hConsoleOutput还是输出流句柄，参数lpConsoleScreenBufferInfo是PCONSOLE_SCREEN_BUFFER_INFO类型。

typedef  struct _CONSOLE_SCREEN_BUFFER_INFO {
    COORD dwSize;
    COORD dwCursorPosition;
    WORD  wAttributes;
    SMALL_RECT srWindow;
    COORD dwMaximumWindowSize;
} CONSOLE_SCREEN_BUFFER_INFO, *PCONSOLE_SCREEN_BUFFER_INFO;

PCONSOLE_SCREEN_BUFFER_INFO是结构体类型_CONSOLE_SCREEN_BUFFER_INFO（CONSOLE_SCREEN_BUFFER_INFO）的指针，其成员dwCursorPosition记录了光标的坐标。于是我们封装一个光标相对移动的函数。

void move( int x, int y) // 移动光标
{
    HANDLE out_handle=GetStdHandle(STD_OUTPUT_HANDLE);
    CONSOLE_SCREEN_BUFFER_INFO info;
    GetConsoleScreenBufferInfo(out_handle,&info);
    COORD loc;
    loc.X=info.dwCursorPosition.X+x;
    loc.Y=info.dwCursorPosition.Y+y;
    SetConsoleCursorPosition(out_handle, loc);
}

有了move函数，就可以完成上述问题连接符的“填充”了。但是有一点需要注意，在输出连接符的时候，最终改变了光标的原本的位置。我们需要在“填充”前保存光标位置，“填充”后恢复光标位置！为此再封装两个函数。

int x,y; // 光标位置
void pushCursor() // 保存光标位置
{
    HANDLE out_handle=GetStdHandle(STD_OUTPUT_HANDLE);
    CONSOLE_SCREEN_BUFFER_INFO info;
    GetConsoleScreenBufferInfo(out_handle,&info);
    x=info.dwCursorPosition.X;
    y=info.dwCursorPosition.Y;
}
void popCursor() // 恢复光标位置
{
    HANDLE out_handle=GetStdHandle(STD_OUTPUT_HANDLE);
    COORD loc;
    loc.X=x;
    loc.Y=y;
    SetConsoleCursorPosition(out_handle, loc);
}

然后我们重新修改刚才的打印代码。

/*
    树形打印作用域
    root:子树根
    blk:缩进次数
    y:记录打印的行数
*/
void printTree(Scope*root, int blk, int& y)
{
     for( int i= 0;i<blk;i++)printf( "      "); // 缩进
     // 记录打印位置
    root->y=y;
     // 填充不连续的列
     if(root->parent){ // 有父节点
        vector<Scope*>& brother=root->parent->children; // 兄弟节点
         // 查找节点在兄弟列表的位置
        vector<Scope*>::iterator pos=lower_bound(brother.begin(),brother.end(),root,Scope::scope_less());
         if(pos!=brother.begin()){ // 不是第一个兄弟
        Scope* prev=(*--pos); // 前一个兄弟
         int disp=root->y-prev->y- 1; // 求差值
        pushCursor(); // 保存光标位置
         while(disp--){ // 不停上移动光标，输出|
            move( 0,- 1); // 上移
            printf( " | "); // 打印|
            move(- 1, 0); // 左移回复光标位置
        }
        popCursor(); // 恢复光标位置
        }
    }
    printf( " |—<%d>\n ", root->id);
     for ( int i =  0; i < root->children.size(); ++i)
    {
        printTree(root->children[i],blk+ 1,++y); // 累加缩进次数和行数
    }
}

我们添加一个引用参数y记录打印了多少行，每次打印节点时将行数记录到节点内部。然后按照树节点的数据结构查找前一个兄弟节点。

struct Scope
{
     struct scope_less
    {
         bool  operator()(Scope*left,Scope*right){
         return left->id<right->id; // 按照id确定节点大小
        }
    };
     int id;
    Scope*parent; // 记录父亲节点
    vector<Scope*> children; // 子作用域
     int y; // 行位置
};

找到前一个兄弟节点后，计算当前打印节点行数和兄弟节点行数的差值，然后“填充”连接符即可。输出结构如下：

如图所示的输出结果，已经达到了我们最初的要求。

以上是Windows提供的光标控制的API函数，那么在Linux下，我们该如何处理光标移动呢？其实C语言的printf函数使用ANSI控制码实现了对光标控制、修改颜色（Windows下使用API函数SetConsoleTextAttribute设定颜色，GetConsoleScreenBufferInfo得到的CONSOLE_SCREEN_BUFFER_INFO::wAttributes获取颜色）等功能！比如： printf("\033[s");用于保存光标位置，printf("\033[u");用于恢复光标位置。printf("\033[1A");将光标上移一行，printf("\033[1D");将光标左移一列。具体控制格式参考下表：

颜色代码:

QUOTE:

字背景颜色范围:  40-- 49                   字颜色:  30-- 39

         40: 黑                           30: 黑

         41: 红                           31: 红

         42: 绿                           32: 绿

         43: 黄                           33: 黄

         44: 蓝                           34: 蓝

         45: 紫                           35: 紫

         46: 深绿                         36: 深绿

         47: 白色                         37: 白色

ANSI控制码:

QUOTE:

        \ 033[0m            关闭所有属性 

        \ 033[1m            设置高亮度     

        \ 033[4m            下划线 

        \ 033[5m            闪烁 

        \ 033[7m            反显 

        \ 033[8m            消隐 

        \ 033[30m -- \ 033[37m               设置前景色 

        \ 033[40m -- \ 033[47m               设置背景色 

        \ 033[nA             光标上移n行 

        \ 033[nB             光标下移n行 

        \ 033[nC             光标右移n行 

        \ 033[nD             光标左移n行 

        \ 033[y;xH           设置光标位置 

        \ 033[2J             清屏 

        \ 033[K              清除从光标到行尾的内容 

        \ 033[s              保存光标位置 

        \ 033[u              恢复光标位置 

        \ 033[?25l           隐藏光标 

        \ 033[?25h           显示光标

综上所述，我们可以通过操作系统提供的光标控制功能实现命令行下树形结构的完美打印，希望本文对你有所帮助！