Skip to content

Latest commit

 

History

History
270 lines (187 loc) · 7.53 KB

Readme_zh.md

File metadata and controls

270 lines (187 loc) · 7.53 KB
 ___ __, __, _, _ _ _, _  _, _,     _,  _, _, _ ___ __,  _, _,  _,  __, __,
  |  |_  |_) |\/| | |\ | /_\ |     / ` / \ |\ |  |  |_) / \ |   |   |_  |_)
  |  |   | \ |  | | | \| | | | ,   \ , \ / | \|  |  | \ \ / | , | , |   | \
  ~  ~~~ ~ ~ ~  ~ ~ ~  ~ ~ ~ ~~~    ~   ~  ~  ~  ~  ~ ~  ~  ~~~ ~~~ ~~~ ~ ~

为 VBS、JScript 而生，由 VBS 写就的 COM 组件。

实用且便携的 Windows Terminal 控制类，可实现彩色输出、光标控制等功能。

浏览

开始

环境要求

  • 视窗操作系统
  • Windows Terminal

安装

以管理员权限运行以下命令：

git clone https://github.com/OldLiu001/TerminalController.vbs.git
cd TerminalController.vbs
regsvr32 TerminalController.wsc

警告：不要使用右键菜单注册 TerminalController.wsc 。

使用下列代码创建类的实例：

VBScript

Set objTerminalController = CreateObject("Terminal.Controller")

JScript

var objTerminalController = new ActiveXObject("Terminal.Controller");

便携

制作便携版本后，其他用户无需进行上述的安装操作即可使用您的脚本。

VBScript

方法1：使用 “Windows 脚本宿主文件” (WSF)

复制脚本 TerminalController.vbs 到您脚本所在的文件夹下。

假设您的脚本的文件名为 MyScript.vbs ，使用如下的代码模板：

Template.wsf

<job id="MyScript">
	<script language="VBScript" src="TerminalController.vbs"/>
	<script language="VBScript" src="MyScript.vbs"/>
</job>

将其放置到您脚本所在的文件夹下。

或将脚本和类库都嵌入单个 WSF 中：

Template_Embedded.wsf

<job id="MyScript">
	<script language="VBScript">
		' 此处写 "TerminalController.vbs" 文件的内容
	</script>
	<script language="VBScript">
		' 此处写 "MyScript.vbs" 文件的内容
	</script>
</job>

当然，您可以只将必要的部分嵌入 WSF 中，此处不再赘述。

创建类的实例：

Set objTerminalController = New TerminalController

方法2：使用 “ExecuteGlobal”

复制脚本 TerminalController.vbs 到您脚本所在的文件夹下。

将下列代码添加至脚本末尾：

Sub Import(strFileName)
	With CreateObject("Scripting.FileSystemObject")
		ExecuteGlobal .OpenTextFile( _
			.GetParentFolderName( _
			.GetFile(WScript.ScriptFullName)) & _
			"\" & strFileName).ReadAll
	End With
End Sub

在脚本开头导入类库：

Import "TerminalController.vbs"

创建类的实例：

Set objTerminalController = New TerminalController

方法3： 将类库嵌入脚本中

将脚本 TerminalController.vbs 的内容添加至您的脚本末尾。

创建类的实例：

Set objTerminalController = New TerminalController

JScript

假设您的脚本名为 MyScript.js 。

类似 VBScript ，您可使用下列代码模板：

Template.wsf

<job id="MyScript">
	<script language="VBScript" src="TerminalController.vbs"/>
	<script language="VBScript">
		Function GenerateObject(ByVal strClassName)
			Set GenerateObject = EVal("New " & strClassName)
		End Function
	</script>
	<script language="JScript" src="MyScript.js" />
</job>

Template_Embedded.wsf

<job id="MyScript">
	<script language="VBScript">
		' 此处写 "TerminalController.vbs" 文件的内容
	</script>
	<script language="VBScript">
		Function GenerateObject(ByVal strClassName)
			Set GenerateObject = EVal("New " & strClassName)
		End Function
	</script>
	<script language="JScript">
		// 此处写 "MyScript.js" 文件的内容
	</script>
</job>

创建类的实例：

var objTerminalController = GenerateObject("TerminalController");

用法

首先设置处理输出的回调函数。

可直接使用下列代码：

VBScript

Function Printer(ByVal strControlSequence)
	WScript.StdOut.Write strControlSequence
End Function
objTerminalController.SetPrinter GetRef("Printer")

JScript

objTerminalController.SetPrinter(function (strControlSequence) {
	WScript.StdOut.Write(strControlSequence);
});

然后可以使用下列的若干方法控制终端：

名称 参数 等价控制序列 描述
SaveCursorPosition - Chr(27) & "7" 储存光标位置
RestoreCursorPosition - Chr(27) & "8" 恢复光标位置
HideCursor - Chr(27) & "[?25l" 隐藏光标
ShowCursor - Chr(27) & "[?25h" 显示光标
SaveScreen - Chr(27) & "[?1049h" 保存屏幕
RestoreScreen - Chr(27) & "[?1049l" 恢复屏幕
ClearScreen - Chr(27) & "[2J" 清除屏幕
LimitScoll lngTop, lngBottom Chr(27) & "[" & lngTop & ";" & lngBottom & "r" 限制滚动
ReleseScoll - Chr(27) & "[r" 解除滚动限制
MoveCursorToTopLeft - Chr(27) & "[H" 将光标移动至终端左上角
MoveCursorTo lngRow, lngColumn Chr(27) & "[" & lngRow & ";" & lngColumn & "H" 将光标移动至指定位置
MoveCursorToRow lngRow Chr(27) & "[" & lngRow & "H" 将光标移动至指定行
MoveCursorToColumn lngColumn Chr(27) & "[" & lngColumn & "G" 将光标移动至指定列
MoveCursorUp lngCount Chr(27) & "[" & lngCount & "A" 光标上移若干行
MoveCursorDown lngCount Chr(27) & "[" & lngCount & "B" 光标下移若干行
MoveCursorLeft lngCount Chr(27) & "[" & lngCount & "D" 光标左移若干字符
MoveCursorRight lngCount Chr(27) & "[" & lngCount & "C" 光标右移若干字符
SetTextStyle strTextStyle Chr(27) & "[" & strTextStyle & "m" 设置文本类型
SetTextColor strForeground, strBackground Chr(27) & "[" & strForeground & ";" & strBackground & "m" 设置文本颜色
ResetTextAttributes - Chr(27) & "[0m" 重置文本属性

也有一些属性，可以获取终端的信息：

名称 类型 描述
RowLength Long 终端的总列数
ColumnLength Long 终端的总行数

参考

匈牙利命名：lng Long, str String, obj Object, arr Array.

颜色可选值：黑 Black, 红 Red, 绿 Green, 黄 Yellow, 蓝 Blue, 品红 Magenta, 青 Cyan, 白 White, 亮黑 BrightBlack, 亮红 BrightRed, 亮绿 BrightGreen, 亮黄 BrightYellow, 亮蓝 BrightBlue, 亮品红 BrightMagenta, 亮青 BrightCyan, 亮白 BrightWhite, 默认 Default.

文本类型可选值：常规 Normal, 粗体 Bold, 暗淡 Dim, 斜体 Italic, 下划线 Underline, 闪烁 Blink, 反色 Reverse, 隐藏 Invisible, 删除线 Strikeout.

示例

参照