dart_pty

Language: 中文简体 | English

创建终端的 dart 实现。

当前已经实现纯 dart 动态调用底层库获得终端,不再需要依赖项目的 so 库

介绍

创建一个伪终端并执行一个子进程。也是终端模拟器的底层实现。 与一些语言提供的执行进程不同,它不仅能够无缓冲的拿到 stdout、stderr 输出,还能拿到所有的终端序列,也能对进程进行交互。

举个简单的例子

我们在 shell 执行以下命令:

echo -e "\033[31m hello \033[0m"

这个时候会看见终端打印了红色的“hello”,因为终端模拟器不仅拿到了字符“hello”,还拿到了前后改变颜色的控制序列。

我们通过 java 的 runtime.exec 函数,或者 python 的 system 函数,c 语言的 system 函数,这一系列高级语言所提供的执行进程的函数,我们执行 python,会发现无论如何也拿不到命令的输出,其原因在于终端与管道的缓冲机制。

所以此项目在于实现获得进程实时的输出流,并提供与进程交互的功能。

使用方法

参考 test.dart

import 'dart:io';

import 'package:dart_pty/src/interface/pseudo_terminal_interface.dart';

Future<void> main() async {
  final Map<String, String> environment = {'TEST': 'TEST_VALUE'};
  String executable = 'sh';
  if (Platform.isWindows) {
    executable = 'wsl';
  }
  final PseudoTerminal pseudoTerminal = PseudoTerminal(
    executable: executable,
    environment: environment,
    workingDirectory: '/',
  );
  await Future<void>.delayed(const Duration(milliseconds: 100));
  pseudoTerminal.out!.listen((line) {
    print('\x1b[31m' + '>' * 40);
    print('\x1b[32m$line');
    print('\x1b[31m' + '<' * 40);
  });
  pseudoTerminal.startPolling();
  await Future.delayed(const Duration(milliseconds: 100), () async {
    while (true) {
      final String input = stdin.readLineSync()!;
      input.split('').forEach((element) {
        pseudoTerminal.write(element);
      });
      pseudoTerminal.write('\n');
      pseudoTerminal.schedulingRead();
      await Future<void>.delayed(const Duration(milliseconds: 100));
    }
  });
}

运行效果:

截图

相关文章

简言之是通过 open unix 系列设备的 /dev/ptmx 节点和主要的 dup2 函数来获得的这样一个伪终端。

Q&A

伪终端是否意味着他并不是一个真的终端?

在 unix 设备的 /dev 下只要极少的节点是成对的,也就是说写进其中一个节点会立马从另一个节点输出, 这样成对的文件节点就称为终端。 但这类成对的节点非常少,并且对普通用户来说,它们是不可知的,我们并不知道哪些是成对的。 但我们可以通过 open /dev/ptmx 的方式来获得一对成对的节点,即为伪终端, 几乎所有的日常使用的终端模拟器都是伪终端。

能不用集成 so 库就能实现本地终端吗?

已经实现~

Libraries

dart_pty