Xed编辑器开发第一期:使用Rust从0到1写一个文本编辑器

news2024/11/24 17:39:08
  • 这是一个使用Rust实现的轻量化文本编辑器。
  • 学过Rust的都知道，Rust 从入门到实践中间还隔着好几个Go语言的难度，因此，如果你也正在学习Rust,那么恭喜你，这个项目被你捡到了。
  • 本项目内容较多，大概会分三期左右陆续发布，欢迎关注！

1. 第一篇

本系列教程默认你已经配置了Rust开发环境并具有一定的rust基础。所以直接从项目创建开始讲解；

使用下面的命令创建项目

  • 项目创建
cargo new xed
  • 运行程序
cargo run

如果成功输出Hello World表示项目基本功能正常，本章节完！

2. 第二篇

2.1 读取用户输入

现在修改main.rs，尝试读取用户的输入，你可以随时按下Ctrl + c终止程序；

use std::io;
use std::io::Read;
fn main() {
    let mut buf = [0; 1];
    while io::stdin().read(&mut buf).expect("Failed to read line") == 1 {}
}
  • 这里的内容不多，主要涉及到io的基本操作，所以导包是必要的；
  • 第4行创建了一个可变的buf数组，长度为1，初始值为0;
  • io::stdin().read(&mut buf) 尝试从标准输入流中读取数据，并将其存储在 buf 中。read 方法返回一个 Result 类型，其中包含读取的字节数或一个错误。
  • 所以expect("Failed to read line") 用于处理可能出现的错误情况。如果读取失败，程序将打印出 “Failed to read line” 作为错误信息并终止程序。
  • 最后的==1检查读取的字节数是否为1，否则结束循环；

2.2 实现q命令

本小节实现基本功能:用户输入q按下回车执行退出程序的操作。

use std::io;
use std::io::Read;
fn main() {
    let mut buf = [0; 1];
    while io::stdin().read(&mut buf).expect("Failed to read line") == 1 && buf !=[b'q'] {}
}
  • 程序会检查buf中输入的每一个字符，如果与q相同，就会结束程序；

在 Rust 中，[b'q'] 是一个字节字符串字面量，表示一个包含单个字节 q 的字节数组。

  1. [b'q']：

    • b'q' 是 Rust 中的字节字面量，表示一个字节，即 ASCII 字符 'q' 对应的字节值。
    • 在 Rust 中，使用 b 前缀可以将字符转换为对应的字节值。这种表示方式常用于处理字节数据。

  2. 字节值和字符映射：

    • 在 ASCII 编码中，每个字符都有一个对应的字节值。在 ASCII 编码中，字符 'q' 对应的字节值是 113。
    • 使用 b'q' 可以直接表示这个字节值，而 [b'q'] 则将这个字节值包装在一个长度为 1 的字节数组中。

因此，[b'q'] 表示一个包含单个字节值为 113（即 ASCII 字符 'q' 对应的字节值）的字节数组。在上下文中，buf != [b'q'] 的条件判断将检查 buf 中存储的字节是否不等于 'q' 对应的字节值，即检查输入的数据是否不是 'q'。

  • 等价写法:buf[0] != b'q'

2.3 常规模式与原始模式

上面的情况就是常规模式，也就是程序启动后终端可以正常监听并回显你输入的内容；

而这里说的原始模式的作用和常规模式相反，我们这里可以直接使用crossterm库来实现，添加依赖：

cargo add crossterm

use std::io;
use std::io::Read;
use crossterm::terminal; // 添加依赖
fn main() {
    terminal::enable_raw_mode().expect("Could not run on Raw mode"); // 开启原始模式
    let mut buf = [0; 1];
    while io::stdin().read(&mut buf).expect("Failed to read line") == 1 && buf != [b'q'] {}
}

现在如果你运行程序，你的输入在终端并没有任何回显，并且当你输入q的时候也是直接无提示的退出程序，这就是crossterm帮我们实现的原始模式的基本功能；

如果要禁用原始模式，考虑下面的代码，最后一行就是禁用这个模式的逻辑；

use crossterm::terminal; /* add this line */
use std::io;
use std::io::Read;
fn main() {
    terminal::enable_raw_mode().expect("Could not turn on Raw mode");
    let mut buf = [0; 1];
    while io::stdin().read(&mut buf).expect("Failed to read line") == 1 && buf != [b'q'] {}
    terminal::disable_raw_mode().expect("Could not turn off raw mode"); /* add this line */
}

但是这样运行后会出现一个错误：

当在 terminal::enable_raw_mode() 之后的函数中发生错误并导致 panic 时，disable_raw_mode() 将不会被调用，导致终端保持在原始模式。这种情况可能会导致程序结束时终端状态不正确，用户体验受到影响。

所以为了解决这个问题，让我们创建 一个 名为 CleanUp的struct;

struct CleanUp;

impl Drop for CleanUp {
    fn drop(&mut self) {
        terminal::disable_raw_mode().expect("Could not disable raw mode");
    }
}

然后修改原来的代码：

use crossterm::terminal; // 添加依赖
use std::io;
use std::io::Read;
struct CleanUp;

impl Drop for CleanUp {
    fn drop(&mut self) {
        terminal::disable_raw_mode().expect("Could not disable raw mode");
    }
}

fn main() {
    let _clean_up = CleanUp; // 看这里
    terminal::enable_raw_modde().expect("Could not run on Raw mode"); // 开启原始模式
    let mut buf = [0; 1];
    while io::stdin().read(&mut buf).expect("Failed to read line") == 1 && buf != [b'q'] {}
   // terminal::disable_raw_mode().expect("Could not turn off raw mode"); /* add this line */
    panic!(""); // 看这里
}

  • 现在我们新增了一个struct并实现了Drop这个trait;此时drop()函数会在我们的struct实例，也就是_clean_up超出作用域或者该实例出现panic时候执行；

  • 一旦上面的情况发生，drop()被执行，那么将成功禁用原始模式；

但是现在还有问题，此时使用Ctrl +c 无法退出程序；不妨看看当我们按下这些按键的时候输出了什么东西；

fn main() {
    let _clean_up = CleanUp;
    terminal::enable_raw_mode().expect("Could not run on Raw mode"); // 开启原始模式
    let mut buf = [0; 1];
    while io::stdin().read(&mut buf).expect("Failed to read line") == 1 && buf != [b'q'] {
        let character = buf[0] as char;
        if character.is_control() {
            println!("{}\r", character as u8)
        } else {
            println!("{}\r", character)
        }
    }
}
  • is_control()判断按下的是否为控制键位，在正常情况下，控制键位输入的字符我们并不需要；
  • ASCII的0-31都是控制字符，127也是；
  • 所以32-126就是可打印的字符，也是我们在编辑文本时需要进行输入回显的；
  • 另外，请注意我们在打印信息的时候使用的是\r而不是\n;此时我们在终端输入数据之后，光标会自动调整到屏幕的左侧。

现在请运行程序并尝试按下控制键位，例如方向键、 或 Escape 、 或 Page Up Page Down 、 Home End Backspace Delete 或 Enter 或 。尝试使用 Ctrl 组合键，如 Ctrl-A、Ctrl-B 等。你会发现：

  • 方向键：Page Up、Page Down、Home 和 End 都向终端输入 3 或 4 个字节： 27 、、 '[' ，然后是一两个其他字符。这称为转义序列。所有转义序列都以 27 字节开头。按 Escape 键发送单个 27 字节作为输入。

  • Backspace 是字节 127 。Delete 是一个 4 字节的转义序列。

  • Enter 是 byte 10 ，这是一个换行符，也称为 '\n' 或 byte 13 ，这是回车符，也称为 \r 。

  • 另外：Ctrl-A 是 1 ， Ctrl-B 是 2 ， Ctrl-C 是3…这确实有效的 将Ctrl 组合键将字母 A-Z 映射到代码 1-26

通过上面的步骤，我们基本了解了按键是如何转为字节的。

2.4 crossterm提供的事件抽象

crossterm 还提供了对各种关键事件的抽象，因此我们不必记住上面那一堆映射关系；而是使用这个crate带来的实现方法；

下面是使用这些抽象重构之火的main.rs:

use crossterm::event::{Event, KeyCode, KeyEvent};
use crossterm::{event, terminal}; // 添加依赖
use std::io;
use std::io::Read;
struct CleanUp;

impl Drop for CleanUp {
    fn drop(&mut self) {
        terminal::disable_raw_mode().expect("Could not disable raw mode");
    }
}

fn main() {
    let _clean_up = CleanUp;
    terminal::enable_raw_mode().expect("Could not run on Raw mode"); // 开启原始模式
    let mut buf = [0; 1];
    // 从这里开始重构
    loop {
        if let Event::Key(event) = event::read().expect("Failed to read line") {
            match event {
                KeyEvent {
                    code: KeyCode::Char('q'),
                    modifiers: event::KeyModifiers::NONE,
                    kind: event::KeyEventKind::Press,
                    state: event::KeyEventState::NONE,
                } => break,
                _ => {
                    // todo
                }
            }
            println!("{:?}\r", event);
        };
    }
}
  • Event 是一个 enum 。由于我们目前只对按键感兴趣，因此我们检查返回的 Event 键是否为 Key .然后，我们检查按下的键是否为 q 。如果用户按下 q ，我们就会中断 loop ，程序将终止。
  • 当然，枚举中其他几个字段也是必须的，参考下文档中枚举的定义如下:
pub struct KeyEvent {
    pub code: KeyCode,
    pub modifiers: KeyModifiers,
    pub kind: KeyEventKind,
    pub state: KeyEventState,
}

其中的kind也是枚举：

pub enum KeyEventKind {
    Press,
    Repeat,
    Release,
}

sate的定义：

    pub struct KeyEventState: u8 {
        /// The key event origins from the keypad.
        const KEYPAD = 0b0000_0001;
        /// Caps Lock was enabled for this key event.
        ///
        /// **Note:** this is set for the initial press of Caps Lock itself.
        const CAPS_LOCK = 0b0000_1000;
        /// Num Lock was enabled for this key event.
        ///
        /// **Note:** this is set for the initial press of Num Lock itself.
        const NUM_LOCK = 0b0000_1000;
        const NONE = 0b0000_0000;
    }

看着有点怕但是不要怕，当下只需要理解代码中按下q执行程序退出的逻辑就可以。

下面是一个示例输出，它会在你按下按键的时候记录并打印相关的事件信息。你可以测试一下按下q是否正常退出程序。

image-20240514221935305

2.4 超时处理

现在的情况是，read()会无限期的在等待我们的键盘输入后返回。如果我们一直没有输入，那它就已知等待，这是个问题。因此我们需要有一个超时处理的逻辑，比如超过一定时间没用户没有任何操作就执行超时对应的处理逻辑。

use crossterm::event::{Event, KeyCode, KeyEvent};
use crossterm::{event, terminal}; // 添加依赖
use std::io;
use std::io::Read;
use std::time::Duration; // 新增依赖
struct CleanUp;

impl Drop for CleanUp {
    fn drop(&mut self) {
        terminal::disable_raw_mode().expect("Could not disable raw mode");
    }
}

fn main() {
    let _clean_up = CleanUp;
    terminal::enable_raw_mode().expect("Could not run on Raw mode"); // 开启原始模式
    let mut buf = [0; 1];
    // 从这里开始重构
    loop {
        if event::poll(Duration::from_millis(500)).expect("Program timed out") { // 超时处理
            if let Event::Key(event) = event::read().expect("Failed to read line") {
            match event {
                KeyEvent {
                    code: KeyCode::Char('q'),
                    modifiers: event::KeyModifiers::NONE,
                    kind: event::KeyEventKind::Press,
                    state: event::KeyEventState::NONE,
                } => break,
                _ => {
                    // todo
                }
            }
            println!("{:?}\r", event);
        };
        }
    }
}

上面的代码中新增的超时处理中用到了crossterm::event::poll这个方法，如果在给定时间内没有 Event 可用， poll 则返回 false ,具体的函数定义信息如下：

image-20240515084930391

2.5 错误处理

一路走来，我们对程序的错误处理都是使用expect()进行简单的捕获，这显然并不是一个很好的选择和习惯，下面通过使用Result来对错误进行进一步的处理，修改main.rs:

use crossterm::event::{Event, KeyCode, KeyEvent};
use crossterm::{event, terminal};
use std::time::Duration; /* add this line */

struct CleanUp;

impl Drop for CleanUp {
    fn drop(&mut self) {
        terminal::disable_raw_mode().expect("Unable to disable raw mode")
    }
}

fn main() -> std::result::Result<(), std::io::Error> {
    let _clean_up = CleanUp;
    terminal::enable_raw_mode()?;
    loop {
        if event::poll(Duration::from_millis(500))? {
            if let Event::Key(event) = event::read()? {
                match event {
                    KeyEvent {
                        code: KeyCode::Char('q'),
                        modifiers: event::KeyModifiers::NONE,
                        kind: _,
                        state: _,
                    } => break,
                    _ => {
                        //todo
                    }
                }
                println!("{:?}\r", event);
            };
        } else {
            println!("No input yet\r");
        }
    }
    Ok(())
}

修改部分如下,注意，对于main方法本身也是指定了返回值类型，这在下面的贴图中没有展现。

image-20240515090210813

  • ? 算符只能用于返回 Result 的方法中，因此 Option 我们必须修改 our main() 以返回 Result .可以 crossterm::Result<T> 扩展为 std::result::Result<T, std::io::Error>

  • 因此，对于我们的 main() 函数，返回类型可以转换为 std::result::Result<(), std::io::Error> 。

本期完,下期内容抢先知:

  • Ctrl+Q退出
  • 键盘输入重构
  • 屏幕清理
  • 光标定位
  • 退出清屏
  • 波浪号占位符(类似于vim)
  • 追加缓冲区

写在最后：

如果这篇内容跟下来，你还是觉得比较难，那么我推荐你暂时放一下，这里推荐一个我之前写的开源项目untools,这也是一个使用Rust编写的工具库，可以拿来练手，顺手点个star的同时也欢迎有想法有能力的同学PR;
在这里插入图片描述

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/1678965.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

WebLogic SSL应用

WebLogic SSL应用

SSL 安全套接字层(SSL)是通过在客户端和Web服务器端之间进行身份验证，并对双方交换的数据进行加密，从而提供安全连接。 验证类型： 单向：客户端验证Web服务器端证书 双向：客户端验证Web服务器证书， Web服务器验证客户端证书 Weblogic Server12c 支持 SSL 3.0 和 TLS1.0 …
阅读更多...
HCIP【Hybird实验】

HCIP【Hybird实验】

目录 一、实验拓扑图&#xff1a; 二、实验要求&#xff1a; 三、实验思路&#xff1a; 四、实验过程&#xff1a; 1、配置PC的IP地址&#xff08;不用配置网关&#xff0c;这个拓扑图没有使用到三层设备&#xff09; 2、交换机配置 3、PC间进行测试&#xff1a; 一、实…
阅读更多...
如何设计实用的ITSM自助服务台

如何设计实用的ITSM自助服务台

在现代IT服务管理&#xff08;ITSM&#xff09;领域中&#xff0c;自助服务台已成为IT运维环境的核心组件。它作为企业内部信息中心与其他部门用户之间的桥梁&#xff0c;一个以用户为中心的平台&#xff0c;更注重用户的自主性和自助能力&#xff0c;使用户能够直接访问所需的…
阅读更多...
ModuleNotFoundError: No module named ‘openpyxl‘的解决方案

ModuleNotFoundError: No module named ‘openpyxl‘的解决方案

问题描述&#xff1a; ModuleNotFoundError: No module named ‘openpyxl’ 这个错误表示你的 Python 环境中没有安装 openpyxl 这个模块。openpyxl 是一个用于读写 Excel 2010 xlsx/xlsm/xltx/xltm 文件的 Python 库。 解决方案&#xff1a; 要解决这个问题&#xff0c;你需…
阅读更多...
第十四届蓝桥杯大赛软件赛国赛C/C++ 大学 B 组 抓娃娃

第十四届蓝桥杯大赛软件赛国赛C/C++ 大学 B 组 抓娃娃

//前缀和 #include<bits/stdc.h> using namespace std; #define int long long const int n1e611; int a,b,c,d[n],l,r; signed main() {ios::sync_with_stdio(false);cin.tie(0),cout.tie(0);cin>>a>>b;map<int,int>t;for(int i1;i<a;i){cin>…
阅读更多...
PCIe协议之-TLP Header详解（二）

PCIe协议之-TLP Header详解（二）

✨前言&#xff1a; 在PCIe中&#xff0c;存在几种不同类型的请求&#xff0c;主要包括IO(Request)请求、存储器(Request)请求和配置(Request)请求。这些请求类型允许CPU与连接在PCIe总线上的设备进行通信和控制。 &#x1f31f;1. IO(Request)请求 定义与作用: IO请求&…
阅读更多...
武汉星起航深耕亚马逊跨境领域，助全球卖家实现国际销售新突破

武汉星起航深耕亚马逊跨境领域，助全球卖家实现国际销售新突破

随着全球贸易的日益繁荣和互联网的快速发展&#xff0c;跨境电商行业迎来了前所未有的发展机遇。作为全球领先的电商平台&#xff0c;亚马逊以其丰富的商品品类、全球配送网络以及高效的物流体系&#xff0c;成为了众多卖家拓展国际市场的重要渠道。在这一背景下&#xff0c;武…
阅读更多...
邦注科技 即热式节能模温机的原理及应用介绍

邦注科技 即热式节能模温机的原理及应用介绍

模温机是一种用于控制模具温度的设备&#xff0c;它在各种工业领域中发挥着重要作用&#xff0c;特别是在塑料加工行业中。以下是关于模温机的原理及应用的详细介绍&#xff1a; 原理 模温机的工作原理主要是通过加热和冷却功能&#xff0c;维持模具温度在一个恒定的范围内。…
阅读更多...
银河麒麟操作系统下使用QT连接TiDB数据库开发步骤

银河麒麟操作系统下使用QT连接TiDB数据库开发步骤

目标：实现项目软件+硬件都运行在国产化操作系统平台上。 方法：在虚拟机中安装麒麟系统V10Sp1+Qt5.14.2+MySql8.0+TiDB软件，编译MySql驱动，测试连接TiDB数据库项目。 步骤： 1、使用虚拟机软件VMWare安装银河麒麟操作系统。 2、在银河麒麟系统上安装QT5.14.2软件。 3、…
阅读更多...
WS2812C是一款将控制电路和RGB芯片集成在一个5050元器件封装中的智能控制LED光源

WS2812C是一款将控制电路和RGB芯片集成在一个5050元器件封装中的智能控制LED光源

一般说明 WS2812C是一款将控制电路和RGB芯片集成在一个5050元器件封装中的智能控制LED光源。内部包括智能数字端口数据锁存器和信号整形放大驱动电路。还包括一个精密的内部振荡器和一个 12V电压可编程恒流控制部分&#xff0c;有效保证像素点光源颜色高度一致。 …
阅读更多...
渲染农场是什么意思?瑞云渲染为你解答

渲染农场是什么意思?瑞云渲染为你解答

渲染农场是一种通过集合多台计算机的计算能力来加速图像渲染过程的系统。它尤其适用于动画、电影特效和高端视觉效果的制作&#xff0c;这些领域通常需要处理非常复杂和计算密集型的渲染任务。 渲染农场就是一大群电脑&#xff0c;他们一起可以快速渲染出漂亮的图像。在做动画片…
阅读更多...
Java05基础 数组

Java05基础 数组

Java05数组 一、数组 数组指的是一种容器&#xff0c;可以用来存储同种数据类型的多个值。 1、数组的静态初始化 初始化&#xff1a;就是在内存中&#xff0c;为数组容器开辟空间&#xff0c;并将数据存入容器中的过程 1.1 数组定义格式 //格式一 数据类型[] 数组名 …
阅读更多...
2024最新互联网公司工作时长排行榜出炉！

2024最新互联网公司工作时长排行榜出炉！

“工作时长”&#xff0c;是选择公司的一个非常重要的参考指标。 我们在选择一个公司的时候&#xff0c;除了需要关注总收入package 以外&#xff0c;还需要考虑这家公司的加班时长是否人性化。 我们的工作时长是周工作小时数。法定工作时间是40小时(955)。大小周通常折算为周…
阅读更多...
高质量新闻数据集OpenNewsArchive：880万篇主流新闻报道，国产大模型开源数据又添猛料

高质量新闻数据集OpenNewsArchive：880万篇主流新闻报道，国产大模型开源数据又添猛料

在构建国产大语言模型的道路上&#xff0c;高质量新闻是不可或缺的重要语料之一。这类语料集准确性、逻辑性、时效性于一体&#xff0c;同时包含丰富的事实知识&#xff0c;可以大幅提升模型的文本生成质量、词汇表达能力、事件理解分析能力以及时序内容的适应性和预测能力&…
阅读更多...
UE4_环境_局部雾化效果

UE4_环境_局部雾化效果

学习笔记&#xff0c;不喜勿喷&#xff01;侵权立删&#xff01;祝愿大家生活越来越好&#xff01; 本文重点介绍下材质节点SphereMask节点在体积雾中的使用方法。 一、球体遮罩SphereMask材质节点介绍&#xff1a; 球体蒙版&#xff08;SphereMask&#xff09; 表达式根据距…
阅读更多...
云端储存的笔记软件， 效率翻倍的办公小助手

云端储存的笔记软件， 效率翻倍的办公小助手

在繁忙的办公环境中&#xff0c;文件堆积如山&#xff0c;电脑屏幕上贴满了各色便签&#xff0c;电话铃声、邮件提示声此起彼伏。你努力地在这些混乱中寻找一丝头绪&#xff0c;试图把握住工作的节奏。 然而&#xff0c;传统的方法似乎已经无法满足现代高效工作的需求。想象一…
阅读更多...
特斯拉全自动驾驶（FSD）系统发展与解析

特斯拉全自动驾驶（FSD）系统发展与解析

引言 自动驾驶技术在近年来迅猛发展&#xff0c;多家科技巨头和汽车制造商纷纷投入巨资研发&#xff0c;试图领跑这一未来出行的革命。在众多企业中&#xff0c;特斯拉的全自动驾驶&#xff08;Full Self-Driving, FSD&#xff09;系统以其独特的“纯视觉”策略脱颖而出&#…
阅读更多...
webpack优化构建体积示例-并行压缩：

webpack优化构建体积示例-并行压缩：

uglifyjs-webpack-plugin和terser-webpack-plugin都可以开启多进程并进行压缩来减小构件体积大小。 当在 Webpack 配置中启用 minimize: true 时&#xff0c;构建时间通常会增加&#xff0c;这是因为 Webpack 会在构建过程中添加一个额外的步骤&#xff1a;代码压缩。代码压缩是…
阅读更多...
深度学习设计模式之工厂方法模式

深度学习设计模式之工厂方法模式

文章目录 前言一、工厂方法模式介绍二、详细分析1.核心组成2.实现步骤3.示例代码4.优缺点优点缺点 5.应用场景 总结 前言 本篇文章主要学习工厂方法模式&#xff0c;工厂方法模式是对简单工厂模式进一步的抽象&#xff0c;由子类去决定实例化哪个类。 一、工厂方法模式介绍 工…
阅读更多...
摆脱手工录入烦恼，OCR技术大幅提高增值税发票处理效率

摆脱手工录入烦恼，OCR技术大幅提高增值税发票处理效率

最近&#xff0c;我邂逅了一位得力助手——OCR技术&#xff0c;它犹如一位神通广大的魔法师&#xff0c;为增值税发票处理带来了翻天覆地的变革&#xff01; 曾几何时&#xff0c;处理增值税发票如同走进了一片迷雾重重的森林&#xff0c;每一步都小心翼翼&#xff0c;生怕出错…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023