node-ncurses 技术文档

1. 安装指南

环境要求

• node.js -- 版本 v0.8.0 及以上

安装步骤

1. 确保你已经安装了符合要求的 node.js 版本。
2. 使用 npm 安装 node-ncurses 模块：

   npm install ncurses
   

2. 项目使用说明

项目简介

node-ncurses 是一个为 node.js 提供的 ncurses 绑定库。它允许你在终端中使用 ncurses 的功能，如窗口管理、键盘输入处理、颜色设置等。

注意事项

• Mac OSX 用户：在某些情况下，可能会遇到终端输出异常的问题。这是一个已知问题，通常需要更频繁地调用 Window.refresh() 来确保显示正常。

基本使用

1. 引入 node-ncurses 模块：

   var nc = require('ncurses');
   

2. 创建一个窗口：

   var win = new nc.Window();
   

3. 使用窗口提供的 API 进行操作，如刷新窗口、绘制内容等。

3. 项目API使用文档

模块函数

• colorPair(colorPair, fgColor, bgColor) - 设置给定颜色对的前景色和背景色，返回颜色对编号。
• colorFg(colorPair) - 返回给定颜色对的前景色。
• colorBg(colorPair) - 返回给定颜色对的背景色。
• setEscDelay(delay) - 设置按下 ESC 键后的等待时间（毫秒）。
• cleanup() - 恢复终端状态，通常在处理异常时使用。
• redraw() - 重绘所有窗口。
• flash() - 闪烁屏幕。
• bell() - 发出终端铃声。
• leave() - 保存当前 ncurses 状态并退出。
• restore() - 恢复由 leave() 保存的状态。

模块属性

• ACS - 包含所有可用 ACS 字符的对象。
• attrs - 包含所有可用终端属性的对象。
• colors - 包含基本 8 种 ANSI 颜色的对象。
• keys - 包含键盘上所有键的映射对象。
• numwins - 返回当前打开的窗口数量。
• lines - 终端的总行数。
• cols - 终端的总列数。
• tabsize - 终端的制表符大小。
• hasMouse - 指示终端是否支持鼠标功能。
• hasColors - 指示终端是否支持颜色。
• numColors - 指示终端支持的最大颜色数量。
• maxColorPairs - 指示终端支持的最大前景-背景颜色对数量。
• echo - 启用/禁用本地键盘输入回显。
• showCursor - 显示/隐藏光标。
• raw - 启用/禁用终端的原始模式。

窗口事件

• inputChar(char, charCode, isKey) - 当按键被按下时触发，isKey 为 true 时表示按下的是非字符键。

窗口函数

• clearok(clearOnRefresh) - 如果 clearOnRefresh 为 true，下次调用 refresh() 时将完全清除屏幕并重新绘制。
• scrollok(scroll) - 控制当光标移动到窗口或滚动区域的边缘时发生的行为。
• idlok(useInsDelLine) - 如果 useInsDelLine 为 true，ncurses 将考虑使用终端的硬件插入/删除行功能。
• idcok(useInsDelChar) - 如果 useInsDelChar 为 true，ncurses 将考虑使用终端的硬件插入/删除字符功能。
• leaveok(moveCursor) - 如果 moveCursor 为 true，ncurses 将允许光标留在更新发生的位置。
• immedok(immedUpdate) - 如果 immedUpdate 为 true，任何虚拟窗口的变化都会自动调用 refresh()。
• standout(enable) - 如果 enable 为 true，启用突出显示属性。
• syncok(autoSyncUp) - 如果 autoSyncUp 为 true，任何窗口变化都会自动调用 syncup()。
• syncdown() - 触摸窗口中在任何祖先窗口中被触摸的位置。
• syncup() - 触摸此窗口中发生变化的所有祖先窗口中的位置。
• cursyncup() - 更新窗口的所有祖先窗口的当前光标位置。
• hide() - 隐藏窗口。
• show() - 显示窗口。
• top() - 将窗口置于最前。
• bottom() - 将窗口置于最后（stdscr 始终是最底层的窗口）。
• move(row, column) - 将窗口移动到指定的行和列。
• refresh() - 更新物理屏幕以匹配虚拟屏幕。
• frame(header, footer) - 在窗口周围绘制框架，并使用可选参数调用 label()。
• boldframe(header, footer) - 与 frame() 相同，但框架被高亮显示。
• label(header, footer) - 在窗口顶部显示可选的居中标题和底部显示可选的居中页脚。

4. 项目安装方式

使用 npm 安装

npm install ncurses

手动安装

1. 克隆项目仓库：

   git clone https://github.com/your-repo/node-ncurses.git
   

2. 进入项目目录：

   cd node-ncurses
   

3. 安装依赖：

   npm install
   

通过以上步骤，你就可以成功安装并使用 node-ncurses 模块了。