kilo TextEditor-1
文章目录
-
- 设置
- 进入原始模式
-
- read()
- 关闭回显
- 退出时关闭原始模式
- 关闭规范模式
- 显示按键
- 关闭 Ctrl-C 和 Ctrl-Z 信号
- 关闭 Ctrl-S 和 Ctrl-Q
- 关闭 Ctrl-V
- 修复 Ctrl-M
- 关闭所有输出处理
- 其他标志
- read()超时
- 错误处理
- 原始输入和输出
-
- Ctrl-Q退出
- 重构键盘输入
- 清屏
- 重新定位光标
- 退出时清屏
- 波浪号
- 全局状态
- 窗口大小，简单方法
- 窗口大小，困难方法
- 最后一行
- 追加缓冲区
- 刷新屏幕时隐藏光标
- 一次清除一行
- 欢迎信息
- 移动光标
- 箭头键
- 防止将光标移出屏幕
- Page Up/Down 键
- Home / End
- Delete键
设置
kilo: kilo.c
$(CC) kilo.c -o kilo -Wall -Wextra -pedantic -std=c99
进入原始模式
read()
#include 参数 count 是请求读取的字节数，读上来的数据保存在缓冲区 buf 中，同时文件的当前读写位置向后移。注意这个读写位置和使用C标准I/O库时的读写位置有可能不同，这个读写位置是记在内核中的，而使用C标准I/O库时的读写位置是用户空间I/O缓冲区中的位置。
fread就是通过read来实现的，fread是C语言的库，而read是系统调用
STDIN_FILENO为标准输入，传参fd
关闭回显
#include 为了便于通过程序来获得和修改终端参数，Linux还提供了tcgetattr函数和tcsetattr函数。tcgetattr用于获取终端的相关参数，而tcsetattr函数用于设置终端参数。
termios结构体作为控制终端的参数，成员：
tcflag_t c_iflag; /* 输入模式,控制终端输入方式 */ tcflag_t c_oflag; /* 输出模式,控制终端输出方式 */ tcflag_t c_cflag; /* 控制模式,指定终端硬件控制信息 */ tcflag_t c_lflag; /* 本地模式,控制终端编辑功能 */ cc_t c_cc[NCCS]; /* 控制字符 */
这里将c_lflag和反转的ECHO按位与，在c_lflag中将ECHO为1的位置0，从而取消回显能力，这样就是原始模式（RAW MODE）
退出时关闭原始模式
#include 对C语言有所了解的人都知道main函数是整个程序的入口，但是其实不然，在内核中可以使用链接器来设置程序的开始地方。当内核使⽤⼀个exec函数执⾏C程序时，在调⽤main函数之前先调⽤⼀个特殊的启动例程，可执⾏程序将此例程指定为程序的起始地址。启动例程从内核获取命令⾏参数和环境变量，然后为调⽤main函数做好准备。
前面我们关注的是程序开始进入时的调用函数，而atexit函数是一个特殊的函数，它是在正常程序退出时调用的函数，我们把他叫为登记函数（函数原型：
int atexit (void (*)(void)))：⼀个进程可以登记若⼲个（具体⾃⼰验证⼀下）个函数，这些函数由exit⾃动调⽤，这些函数被称为终⽌处理函数， atexit函数可以登记这些函数。 exit调⽤终⽌处理函数的顺序和atexit登记的顺序相反（网上很多说造成顺序相反的原因是参数压栈造成的，参数的压栈是先进后出，和函数的栈帧相同），如果⼀个函数被多次登记，也会被多次调⽤。
TCSAFLUSH：等所有的数据传输完毕，并且清空输入输出的缓冲区才改变属性
关闭规范模式
raw.c_lflag &= ~(ECHO | ICANON);
ICANON意味使用标准输入模式，这样就关闭了回显并退出了标准输入模式，此时按q可立即退出而不用再按回车
显示按键
#include iscntrl()测试字符是否为控制字符。
关闭 Ctrl-C 和 Ctrl-Z 信号
默认情况下用于停止程序，关闭是为了防止和我们的编辑器的快捷键冲突
raw.c_lflag &= ~(ECHO | ICANON | ISIG);
ISIG表示当输入INTR、QUIT、SUSP或DSUSP时，产生相应的信号
关闭 Ctrl-S 和 Ctrl-Q
默认情况下，用于软件流控制，停止数据传输到终端，直到您按下按键。
raw.c_iflag &= ~(IXON);
关闭 Ctrl-V
raw.c_lflag &= ~(ECHO | ICANON | ISIG | IEXTEN);
修复 Ctrl-M
此时输入Ctrl-M 和 Ctrl-J 发现显示的值是一样的，无法分辨
raw.c_iflag &= ~(ICRNL | IXON);
ICRNL将输入的回车转化成换行，这样 Ctrl-M 正确显示
关闭所有输出处理
事实证明，终端在输出端进行了类似的转换。 它将我们打印的每个换行符 “\n” 转换为回车符，"\r"后跟 换行符 “\r\n”。终端需要这两个字符 以开始新的文本行。回车将光标移回 当前行的开头，换行符将光标向下移动一行， 如有必要，滚动屏幕。
raw.c_oflag &= ~(OPOST);
int main() {
enableRawMode();
char c;
while (read(STDIN_FILENO, &c, 1) == 1 && c != 'q') {
if (iscntrl(c)) {
printf("%d\r\n", c);
} else {
printf("%d ('%c')\r\n", c, c);
}
}
return 0;
}
其他标志
void enableRawMode() {
tcgetattr(STDIN_FILENO, &orig_termios);
atexit(disableRawMode);
struct termios raw = orig_termios;
raw.c_iflag &= ~(BRKINT | ICRNL | INPCK | ISTRIP | IXON);
raw.c_oflag &= ~(OPOST);
raw.c_cflag |= (CS8);
raw.c_lflag &= ~(ECHO | ICANON | IEXTEN | ISIG);
tcsetattr(STDIN_FILENO, TCSAFLUSH, &raw);
}
当BRKINT打开时，断开条件将导致向程序发送SIGINT信号，如按Ctrl-C。
INPCK启用奇偶校验，这似乎不适用于现代终端仿真器。
ISTRIP导致每个输入字节的第8位被剥离，这意味着它将把它设置为0。这可能已经被关闭了。
CS8不是一个标志，它是一个具有多个位的位掩码，我们使用按位或(|)操作符设置，不像我们关闭的所有标志。它将字符大小(CS)设置为每字节8位。在我的系统中，它已经是这样设置的。
read()超时
raw.c_cc[VMIN] = 0;
raw.c_cc[VTIME] = 1;
c_cc控制字符，用于保存终端驱动程序中的特殊字符，如输入结束符等。
VMIN非规范模式读取时的最小字符数，VTIME非规范模式读取时的超时时间（单位100毫秒）
超时后自动解除read的阻塞，不改变传入的字符串的内容。
错误处理
void die(const char *s) {
perror(s);
exit(1);
}
void disableRawMode() {
if (tcsetattr(STDIN_FILENO, TCSAFLUSH, &orig_termios) == -1)
die("tcsetattr");
}
void enableRawMode() {
if (tcgetattr(STDIN_FILENO, &orig_termios) == -1) die("tcgetattr");
...
if (tcsetattr(STDIN_FILENO, TCSAFLUSH, &raw) == -1) die("tcsetattr");
}
int main() {
enableRawMode();
while (1) {
char c = '\0';
if (read(STDIN_FILENO, &c, 1) == -1 && errno != EAGAIN) die("read");
...
}
return 0;
}
erron通过系统调用设置，在错误事件中的某些库函数表明了什么发生了错误，
perror(s) 用来将上一个函数发生错误的原因输出到标准设备(stderr)。参数 s 所指的字符串会先打印出，后面再加上错误原因字符串。此错误原因依照全局变量errno的值来决定要输出的字符串。
EAGAIN是Linux中的一个常见错误代码，表示非阻塞操作中没有完成就返回
原始输入和输出
Ctrl-Q退出
#define CTRL_KEY(k) ((k) & 0x1f)
if (c == CTRL_KEY('q')) break;
重构键盘输入
char editorReadKey() {
int nread;
char c;
while ((nread = read(STDIN_FILENO, &c, 1)) != 1) {
if (nread == -1 && errno != EAGAIN) die("read");
}
return c;
}
/*** input ***/
void editorProcessKeypress() {
char c = editorReadKey();
switch (c) {
case CTRL_KEY('q'):{
exit(0);
break;
}
}
}
int main() {
enableRawMode();
while (1) {
editorRefreshScreen();
editorProcessKeypress();
}
return 0;
}
清屏
void editorRefreshScreen() {
write(STDOUT_FILENO, "\x1b[2J", 4);
}
Linux特殊终端控制符-CSDN博客
重新定位光标
write(STDOUT_FILENO, "\x1b[H", 3);
退出时清屏
void die(const char *s) {
write(STDOUT_FILENO, "\x1b[2J", 4);
write(STDOUT_FILENO, "\x1b[H", 3);
perror(s);
exit(1);
}
void editorProcessKeypress() {
char c = editorReadKey();
switch (c) {
case CTRL_KEY('q'):
write(STDOUT_FILENO, "\x1b[2J", 4);
write(STDOUT_FILENO, "\x1b[H", 3);
exit(0);
break;
}
}
波浪号
void editorDrawRows() {
int y;
for (y = 0; y < 24; y++) {
write(STDOUT_FILENO, "~\r\n", 3);
}
}
void editorRefreshScreen() {
write(STDOUT_FILENO, "\x1b[2J", 4);
write(STDOUT_FILENO, "\x1b[H", 3);
editorDrawRows();
write(STDOUT_FILENO, "\x1b[H", 3);
}
全局状态
要获取终端的大小，从而确定输出多少个波浪号
设置全局结构体配置信息
struct editorConfig {
int screenrows;
int screencols;
struct termios orig_termios;
};
struct editorConfig E;
窗口大小，简单方法
大多数UNIX系统都提供了一种功能，可以对当前终端窗口的大小进行跟踪，在窗口大小发生变化时，使内核通知前台进程组。内核为每个终端和伪终端保存一个winsize结构：
Struct winsize
{
unsigned short ws_row; /* rows， in character */
unsigned short ws_col; /* columns, in characters */
unsigned short ws_xpixel; /* horizontal size, pixels (unused) */
unsigned short ws_ypixel; /* vertical size, pixels (unused) */
};
#include void initEditor() {
if (getWindowSize(&E.screenrows, &E.screencols) == -1) die("getWindowSize");
}
int main() {
enableRawMode();
initEditor();
while (1) {
editorRefreshScreen();
editorProcessKeypress();
}
return 0;
}
void editorDrawRows() {
int y;
for (y = 0; y < E.screenrows; y++) {
write(STDOUT_FILENO, "~\r\n", 3);
}
}
窗口大小，困难方法
策略是将光标定位在屏幕的右下角，然后使用转义序列，让我们查询光标的位置。
int getCursorPosition(int *rows, int *cols) {
//查询光标位置
if (write(STDOUT_FILENO, "\x1b[6n", 4) != 4) return -1;
//显示响应信息 结果是 27[40;132R
//char c;
//while (read(STDIN_FILENO, &c, 1) == 1) {
// if (iscntrl(c)) {
// printf("%d\r\n", c);
// } else {
// printf("%d ('%c')\r\n", c, c);
// }
//}
//解析响应
char buf[32];
unsigned int i = 0;
while (i < sizeof(buf) - 1) {
if (read(STDIN_FILENO, &buf[i], 1) != 1) break;
if (buf[i] == 'R') break;
i++;
}
buf[i] = '\0';
// 此时buf是 [40;132
//0x1b = 27 = 最后一行
当在一行打印~后会打印\r\n，这会导致滚屏，之后最后一行没有波浪号，我们对此特殊处理
void editorDrawRows() {
int y;
for (y = 0; y < E.screenrows; y++) {
write(STDOUT_FILENO, "~", 1);
if (y < E.screenrows - 1) {
write(STDOUT_FILENO, "\r\n", 2);
}
}
}
追加缓冲区
将调用write()特殊终端控制符的代码整合在一起，统一调用write()，这样可以确保屏幕一起更新，而不会有小停顿，这就需要动态组建字符串
#include void editorDrawRows(struct abuf *ab) {
int y;
for (y = 0; y < E.screenrows; y++) {
abAppend(ab, "~", 1);
if (y < E.screenrows - 1) {
abAppend(ab, "\r\n", 2);
}
}
}
void editorRefreshScreen() {
struct abuf ab = ABUF_INIT;
abAppend(&ab, "\x1b[2J", 4);//清屏
abAppend(&ab, "\x1b[H", 3);//重新定位光标
editorDrawRows(&ab);
abAppend(&ab, "\x1b[H", 3);
write(STDOUT_FILENO, ab.b, ab.len);
abFree(&ab);
}
刷新屏幕时隐藏光标
void editorRefreshScreen() {
struct abuf ab = ABUF_INIT;
abAppend(&ab, "\x1b[?25l", 6);//隐藏光标
abAppend(&ab, "\x1b[2J", 4);
abAppend(&ab, "\x1b[H", 3);
editorDrawRows(&ab);
abAppend(&ab, "\x1b[H", 3);
abAppend(&ab, "\x1b[?25h", 6);//显示光标
write(STDOUT_FILENO, ab.b, ab.len);
abFree(&ab);
}
一次清除一行
当刷新屏幕时，每刷新一行就清除一行要比刷新前清除整个屏幕更好，因为避免了当卡顿发生时，还没写完屏幕但是已经清屏的情况
void editorDrawRows(struct abuf *ab) {
int y;
for (y = 0; y < E.screenrows; y++) {
abAppend(ab, "~", 1);
abAppend(ab, "\x1b[K", 3);//清空光标右边内容
if (y < E.screenrows - 1) {
abAppend(ab, "\r\n", 2);
}
}
}
void editorRefreshScreen() {
struct abuf ab = ABUF_INIT;
abAppend(&ab, "\x1b[?25l", 6);
//abAppend(&ab, "\x1b[2J", 4);
abAppend(&ab, "\x1b[H", 3);
editorDrawRows(&ab);
abAppend(&ab, "\x1b[H", 3);
abAppend(&ab, "\x1b[?25h", 6);
write(STDOUT_FILENO, ab.b, ab.len);
abFree(&ab);
}
欢迎信息
#define KILO_VERSION "0.0.1"
void editorDrawRows(struct abuf *ab) {
int y;
for (y = 0; y < E.screenrows; y++) {
//在屏幕上三分之一处添加欢迎信息
if (y == E.screenrows / 3) {
char welcome[80];
//欢迎信息的字符数
int welcomelen = snprintf(welcome, sizeof(welcome),
"Kilo editor -- version %s", KILO_VERSION);
//截断欢迎信息
if (welcomelen > E.screencols) welcomelen = E.screencols;
//取欢迎信息剩余的两侧字符空位
int padding = (E.screencols - welcomelen) / 2;
//先在欢迎信息左空位加一个~
if (padding) {
abAppend(ab, "~", 1);
padding--;
}
//填充剩余左空位
while (padding--) abAppend(ab, " ", 1);
//装载欢迎信息
abAppend(ab, welcome, welcomelen);
} else {
abAppend(ab, "~", 1);
}
abAppend(ab, "\x1b[K", 3);
if (y < E.screenrows - 1) {
abAppend(ab, "\r\n", 2);
}
}
}
移动光标
添加光标坐标
struct editorConfig {
int cx, cy;
int screenrows;
int screencols;
struct termios orig_termios;
};
void initEditor() {
E.cx = 0;
E.cy = 0;
if (getWindowSize(&E.screenrows, &E.screencols) == -1) die("getWindowSize");
}
void editorRefreshScreen() {
struct abuf ab = ABUF_INIT;
abAppend(&ab, "\x1b[?25l", 6);
abAppend(&ab, "\x1b[H", 3);
editorDrawRows(&ab);
//添加光标移动指令
char buf[32];
snprintf(buf, sizeof(buf), "\x1b[%d;%dH", E.cy + 1, E.cx + 1);
abAppend(&ab, buf, strlen(buf));
abAppend(&ab, "\x1b[?25h", 6);
write(STDOUT_FILENO, ab.b, ab.len);
abFree(&ab);
}
void editorMoveCursor(char key) {
switch (key) {
case 'a':
E.cx--;
break;
case 'd':
E.cx++;
break;
case 'w':
E.cy--;
break;
case 's':
E.cy++;
break;
}
}
void editorProcessKeypress() {
char c = editorReadKey();
switch (c) {
case CTRL_KEY('q'):
write(STDOUT_FILENO, "\x1b[2J", 4);
write(STDOUT_FILENO, "\x1b[H", 3);
exit(0);
break;
case 'w':
case 's':
case 'a':
case 'd':
editorMoveCursor(c);
break;
}
}
箭头键
箭头上下左右是'\x1b[' + 'A' / 'B' / 'C' / 'D'，映射到wasd
同时用枚举类型描述箭头键，使用较大的整形常量来标识，以免和其他键冲突
enum editorKey {
ARROW_LEFT = 1000,
ARROW_RIGHT,
ARROW_UP,
ARROW_DOWN
};
int editorReadKey() {
int nread;
char c;
while ((nread = read(STDIN_FILENO, &c, 1)) != 1) {
if (nread == -1 && errno != EAGAIN) die("read");
}
if (c == '\x1b') {
char seq[3];
if (read(STDIN_FILENO, &seq[0], 1) != 1) return '\x1b';
if (read(STDIN_FILENO, &seq[1], 1) != 1) return '\x1b';
if (seq[0] == '[') {
switch (seq[1]) {
case 'A': return ARROW_UP;
case 'B': return ARROW_DOWN;
case 'C': return ARROW_RIGHT;
case 'D': return ARROW_LEFT;
}
}
return '\x1b';
} else {
return c;
}
}
void editorMoveCursor(int key) {
switch (key) {
case ARROW_LEFT:
E.cx--;
break;
case ARROW_RIGHT:
E.cx++;
break;
case ARROW_UP:
E.cy--;
break;
case ARROW_DOWN:
E.cy++;
break;
}
}
void editorProcessKeypress() {
int c = editorReadKey();
switch (c) {
case CTRL_KEY('q'):
write(STDOUT_FILENO, "\x1b[2J", 4);
write(STDOUT_FILENO, "\x1b[H", 3);
exit(0);
break;
case ARROW_UP:
case ARROW_DOWN:
case ARROW_LEFT:
case ARROW_RIGHT:
editorMoveCursor(c);
break;
}
}
防止将光标移出屏幕
做边界检测
void editorMoveCursor(int key) {
switch (key) {
case ARROW_LEFT:
if (E.cx != 0) {
E.cx--;
}
break;
case ARROW_RIGHT:
if (E.cx != E.screencols - 1) {
E.cx++;
}
break;
case ARROW_UP:
if (E.cy != 0) {
E.cy--;
}
break;
case ARROW_DOWN:
if (E.cy != E.screenrows - 1) {
E.cy++;
}
break;
}
}
Page Up/Down 键
Page键为
enum editorKey {
ARROW_LEFT = 1000,
ARROW_RIGHT,
ARROW_UP,
ARROW_DOWN,
PAGE_UP,
PAGE_DOWN
};
int editorReadKey() {
int nread;
char c;
while ((nread = read(STDIN_FILENO, &c, 1)) != 1) {
if (nread == -1 && errno != EAGAIN) die("read");
}
if (c == '\x1b') {
char seq[3];
if (read(STDIN_FILENO, &seq[0], 1) != 1) return '\x1b';
if (read(STDIN_FILENO, &seq[1], 1) != 1) return '\x1b';
if (seq[0] == '[') {
//检测Page键
if (seq[1] >= '0' && seq[1] <= '9') {
if (read(STDIN_FILENO, &seq[2], 1) != 1) return '\x1b';
if (seq[2] == '~') {
switch (seq[1]) {
case '5': return PAGE_UP;
case '6': return PAGE_DOWN;
}
}
} else {
switch (seq[1]) {
case 'A': return ARROW_UP;
case 'B': return ARROW_DOWN;
case 'C': return ARROW_RIGHT;
case 'D': return ARROW_LEFT;
}
}
}
return '\x1b';
} else {
return c;
}
}
void editorProcessKeypress() {
int c = editorReadKey();
switch (c) {
case CTRL_KEY('q'):
write(STDOUT_FILENO, "\x1b[2J", 4);
write(STDOUT_FILENO, "\x1b[H", 3);
exit(0);
break;
case PAGE_UP:
case PAGE_DOWN:
{
int times = E.screenrows;
while (times--)
editorMoveCursor(c == PAGE_UP ? ARROW_UP : ARROW_DOWN);
}
break;
case ARROW_UP:
case ARROW_DOWN:
case ARROW_LEFT:
case ARROW_RIGHT:
editorMoveCursor(c);
break;
}
}
Home / End
Home
End
enum editorKey {
ARROW_LEFT = 1000,
ARROW_RIGHT,
ARROW_UP,
ARROW_DOWN,
HOME_KEY,
END_KEY,
PAGE_UP,
PAGE_DOWN
};
int editorReadKey() {
int nread;
char c;
while ((nread = read(STDIN_FILENO, &c, 1)) != 1) {
if (nread == -1 && errno != EAGAIN) die("read");
}
if (c == '\x1b') {
char seq[3];
if (read(STDIN_FILENO, &seq[0], 1) != 1) return '\x1b';
if (read(STDIN_FILENO, &seq[1], 1) != 1) return '\x1b';
if (seq[0] == '[') {
if (seq[1] >= '0' && seq[1] <= '9') {
if (read(STDIN_FILENO, &seq[2], 1) != 1) return '\x1b';
if (seq[2] == '~') {
switch (seq[1]) {
case '1': return HOME_KEY;
case '4': return END_KEY;
case '5': return PAGE_UP;
case '6': return PAGE_DOWN;
case '7': return HOME_KEY;
case '8': return END_KEY;
}
}
} else {
switch (seq[1]) {
case 'A': return ARROW_UP;
case 'B': return ARROW_DOWN;
case 'C': return ARROW_RIGHT;
case 'D': return ARROW_LEFT;
case 'H': return HOME_KEY;
case 'F': return END_KEY;
}
}
} else if (seq[0] == 'O') {
switch (seq[1]) {
case 'H': return HOME_KEY;
case 'F': return END_KEY;
}
}
return '\x1b';
} else {
return c;
}
}
void editorProcessKeypress() {
int c = editorReadKey();
switch (c) {
case CTRL_KEY('q'):
write(STDOUT_FILENO, "\x1b[2J", 4);
write(STDOUT_FILENO, "\x1b[H", 3);
exit(0);
break;
case HOME_KEY:
E.cx = 0;
break;
case END_KEY:
E.cx = E.screencols - 1;
break;
case PAGE_UP:
case PAGE_DOWN:
{
int times = E.screenrows;
while (times--)
editorMoveCursor(c == PAGE_UP ? ARROW_UP : ARROW_DOWN);
}
break;
case ARROW_UP:
case ARROW_DOWN:
case ARROW_LEFT:
case ARROW_RIGHT:
editorMoveCursor(c);
break;
}
}
Delete键
enum editorKey {
ARROW_LEFT = 1000,
ARROW_RIGHT,
ARROW_UP,
ARROW_DOWN,
DEL_KEY,
HOME_KEY,
END_KEY,
PAGE_UP,
PAGE_DOWN
};
int editorReadKey() {
int nread;
char c;
while ((nread = read(STDIN_FILENO, &c, 1)) != 1) {
if (nread == -1 && errno != EAGAIN) die("read");
}
if (c == '\x1b') {
char seq[3];
if (read(STDIN_FILENO, &seq[0], 1) != 1) return '\x1b';
if (read(STDIN_FILENO, &seq[1], 1) != 1) return '\x1b';
if (seq[0] == '[') {
if (seq[1] >= '0' && seq[1] <= '9') {
if (read(STDIN_FILENO, &seq[2], 1) != 1) return '\x1b';
if (seq[2] == '~') {
switch (seq[1]) {
case '1': return HOME_KEY;
case '3': return DEL_KEY;
case '4': return END_KEY;
case '5': return PAGE_UP;
case '6': return PAGE_DOWN;
case '7': return HOME_KEY;
case '8': return END_KEY;
}
}
} else {
switch (seq[1]) {
case 'A': return ARROW_UP;
case 'B': return ARROW_DOWN;
case 'C': return ARROW_RIGHT;
case 'D': return ARROW_LEFT;
case 'H': return HOME_KEY;
case 'F': return END_KEY;
}
}
} else if (seq[0] == 'O') {
switch (seq[1]) {
case 'H': return HOME_KEY;
case 'F': return END_KEY;
}
}
return '\x1b';
} else {
return c;
}
}