189 lines
6.9 KiB
Markdown
189 lines
6.9 KiB
Markdown
# conctrl
|
||
## 简介
|
||
  这个库提供一系列的函数来简化对Windows控制台窗口的输入输出（主要是输出）控制。通过它，你可以将窗口分割为不同的窗格，你也可以创建分隔线来分隔它们。而不管是窗口、窗格还是分隔线，你可以随时修改它们的大小和位置。
|
||
|
||
|
||
## 特性
|
||
  你可以将控制台窗口分割为若干个**窗格**，窗格之间可创建**分割线**来区别它们。每个窗格拥有一个行缓存，包含若干**行**。你可以改变行缓存的大小。
|
||
|
||
  你可以动态地为**窗格**增加**行**，仅需要向窗格添加文本，窗格将自动把文本分割为适应的行，改变窗格大小它也将自动更新。支持ANSI和UTF-8两种编码格式。
|
||
|
||
  你可以为每一**行**设定字符格式，字符格式由Windows的一些<a href="#constant">常量</a>定义。
|
||
|
||
<font color="red">  这不是一个设计严谨的库，使用需谨慎。</font>
|
||
|
||
## 开发环境
|
||
  Windows，Visual Studio 2017
|
||
|
||
## 编译方式
|
||
* ### 获取项目：
|
||
> `git clone https://github.com/mattuylee/conctrl.git`
|
||
|
||
* ### 编译
|
||
|
||
用Visual Studio打开conctrl.sln，编译方式选择Release，平台x86或者x64根据需求选择，然后选择生成（build）菜单，选择生成解决方案(Build Solution)。得到*conctrl.dll*和*constrl.lib*文件。
|
||
|
||
注：如果编译不成功请检查项目属性，如果配置类型（Configuration Type）为应用程序(.exe)请改为动态链接库(.dll)。
|
||
|
||
|
||
## 使用方法
|
||
* ### C++
|
||
将代码目录里的conctrl.h，编译得到的conctrl.dll和conctrl.lib放在相同目录，在你的代码中添加：
|
||
> `#include "conctrl.h"`
|
||
> `#pragma comment(lib, "conctrl.lib")`
|
||
|
||
<a href="#usage_cpp">查看示例</a>
|
||
* ### 其他语言
|
||
根据调用操作系统动态库的规则调用dll内的导出函数即可。注意，C语言无法像C++一样调用此dll，因此只能显式调用，通过LoadLibrary动态加载DLL。
|
||
|
||
## 注意事项
|
||
  需要注意的是，窗格只是逻辑意义上的窗格，它们属于同一个控制台窗口，共享输入缓冲区，因此这个库仅**适用于需要多个窗格用于输出**而不超过1个窗格同时用来输入。
|
||
|
||
  分隔线是需要占用空间的，由于制表符是双字节字符，因此分隔线长度必须是2的倍数。同时注意，水平分割线的**高度**是1个字符，而**垂直分隔线的宽度是2个字符**。
|
||
|
||
  构建这个库的初衷是为了方便某些高级语言操作控制台，因此没有导出类而是封装了一系列C函数，并将它们的参数都设定为简单的数值型和字符串，避免在高级语言中额外定义数据类型，方便使用。
|
||
|
||
<big>   **你不应该直接操作ConsoleWindow、Pannel、和Spliter类对象**，而应仅将它们的指针作为参数传递。</big>
|
||
|
||
  此库通过调用Windows API实现，因此仅适用于Windows系统。
|
||
|
||
|
||
|
||
## 导出函数列表
|
||
  具体说明和参数列表见头文件**conctrl.h**
|
||
|
||
* **CreateConsoleWindow**，
|
||
创建控制器，调用其他任何函数之前应先调用此函数
|
||
|
||
* DestroyConsoleWindow,
|
||
销毁控制器，它将销毁所有创建的窗格，并抹除上面的字符
|
||
|
||
* ResizeScreenBuffer,
|
||
设置控制台屏幕缓冲区大小（不是窗口大小）
|
||
|
||
* SetConsoleWindowTitle,
|
||
设置控制台窗口标题
|
||
|
||
* **CreatePannel**,
|
||
创建一个窗格
|
||
|
||
* DestroyPannel,
|
||
销毁窗格
|
||
|
||
* SetMaxLineCache,
|
||
设置窗格行缓存的最大值（单位行）
|
||
|
||
* **AddPannelText**,
|
||
向窗格添加文本
|
||
|
||
* **AddPannelLine**,
|
||
向窗格添加文本行
|
||
|
||
* ClearPannel,
|
||
清除窗格文本和行缓存
|
||
|
||
* **MovePannel**,
|
||
移动或重新设置窗格大小
|
||
|
||
* ScrollPannelBackward,
|
||
向前翻页
|
||
|
||
* ScrollPannelForward,
|
||
向后翻页
|
||
|
||
* ScrollPannelTo,
|
||
跳转到指定行
|
||
|
||
* **FocusOnPannel**,
|
||
将光标定位到指定窗格的指定位置
|
||
|
||
* **CreateSpliter**,
|
||
创建分割线
|
||
|
||
* DestroySpliter,
|
||
删除分割线
|
||
|
||
* MoveSpliter,
|
||
移动或修改分割线长度
|
||
|
||
## 缺陷
|
||
* 对用户输入的控制比较无力
|
||
* 只能对整行设定字符样式
|
||
* 分割线的交点没有做特殊处理很难看
|
||
* 不支持Unicode
|
||
* **功能没有全部测试**
|
||
* 由于未知原因，g++编译测试示例时失败，仅VS编译成功（不是get_s的原因==）
|
||
* 其他
|
||
|
||
|
||
## 使用示例
|
||
<a name="usage_cpp"></a>
|
||
### C++（VC）
|
||
|
||
```C++
|
||
#include <stdio.h>
|
||
#include <string.h>
|
||
#include <Windows.h>
|
||
#include "conctrl.h"
|
||
int main() {
|
||
ConsoleWindow* window = CreateConsoleWindow(80, 40);
|
||
Pannel* messagePannel = CreatePannel(window, 0, 0, 78, 25);
|
||
Pannel* writePannel = CreatePannel(window, 0, 26, 80, 40);
|
||
Spliter* spliter = CreateSpliter(window, 0, 25, 80, false, FOREGROUND_GREEN);
|
||
AddPannelText(messagePannel, "输入任意内容，回车发送", true, true, 7);
|
||
FocusOnPannel(writePannel, 0, 0);
|
||
while (true) {
|
||
char str[1024];
|
||
gets_s(str, 1023);
|
||
AddPannelText(messagePannel, str, false, false, FOREGROUND_RED | FOREGROUND_GREEN);
|
||
ClearPannel(writePannel);
|
||
FocusOnPannel(writePannel, 0, 0);
|
||
}
|
||
}
|
||
```
|
||
|
||
## 文件列表
|
||
<pre>
|
||
README.md
|
||
conctrl
|
||
|----coding.cpp //编码转换
|
||
|----coding.h
|
||
|----conctrl.cpp //定义导出函数
|
||
|----conctrl.def //导出定义文件
|
||
|----conctrl.h //声明导出函数，提供给用户
|
||
|----console-window.cpp //定义控制台窗口控制器
|
||
|----console-window.h
|
||
|----pannel.cpp //定义窗格
|
||
|----pannel.h
|
||
|----spliter.cpp //定义分割线
|
||
|----spliter.h
|
||
</pre>
|
||
|
||
## 辅助资料
|
||
|
||
<a name="constant"></a>
|
||
### Windows控制台字符样式常量
|
||
|
||
定义于consoleapi2.h，使用引入windows.h或自定义
|
||
```C
|
||
#define FOREGROUND_BLUE 0x0001 // text color contains blue.
|
||
#define FOREGROUND_GREEN 0x0002 // text color contains green.
|
||
#define FOREGROUND_RED 0x0004 // text color contains red.
|
||
#define FOREGROUND_INTENSITY 0x0008 // text color is intensified.
|
||
#define BACKGROUND_BLUE 0x0010 // background color contains blue.
|
||
#define BACKGROUND_GREEN 0x0020 // background color contains green.
|
||
#define BACKGROUND_RED 0x0040 // background color contains red.
|
||
#define BACKGROUND_INTENSITY 0x0080 // background color is intensified.
|
||
#define COMMON_LVB_LEADING_BYTE 0x0100 // Leading Byte of DBCS
|
||
#define COMMON_LVB_TRAILING_BYTE 0x0200 // Trailing Byte of DBCS
|
||
#define COMMON_LVB_GRID_HORIZONTAL 0x0400 // DBCS: Grid attribute: top horizontal.
|
||
#define COMMON_LVB_GRID_LVERTICAL 0x0800 // DBCS: Grid attribute: left vertical.
|
||
#define COMMON_LVB_GRID_RVERTICAL 0x1000 // DBCS: Grid attribute: right vertical.
|
||
#define COMMON_LVB_REVERSE_VIDEO 0x4000 // DBCS: Reverse fore/back ground attribute.
|
||
#define COMMON_LVB_UNDERSCORE 0x8000 // DBCS: Underscore.
|
||
#define COMMON_LVB_SBCSDBCS 0x0300 // SBCS or DBCS flag.
|
||
```
|
||
|
||
## 项目地址
|
||
[https://github.com/mattuylee/conctrl.git](https://github.com/mattuylee/conctrl.git)
|