SwiftTerm

Rápido

Swiftterm es una biblioteca de emuladores terminales VT100/XterM para aplicaciones Swift que se pueden integrar en macOS, aplicaciones iOS, aplicaciones basadas en texto, sin cabeza u otros escenarios personalizados. Se ha utilizado en varios clientes SSH disponibles comercialmente, incluidos mariscos seguros, LA Terminal y Codeedit

Consulte la documentación de la API

Este repositorio contiene un motor de emulador terminal que es agnóstico de la interfaz de usuario, así como frontales para este motor para iOS que usa UIKIT y macOS que usa AppKit. Un emulador terminal basado en Curses (para emular un Xterm dentro de una aplicación de la consola) está disponible como parte de la biblioteca TermKit.

Código de muestra Hay un par de aplicaciones de muestra mínimas para Mac e iOS que muestran cómo usar la biblioteca dentro del directorio TerminalApp .

• La aplicación MAC MAC tiene gran parte de la funcionalidad del terminal de MacOS, pero sin la interfaz de usuario de configuración.
• La aplicación de muestra iOS utiliza una biblioteca SSH para conectarse a un sistema remoto (ya que no hay un shell nativo en iOS para ejecutar), y la muestra está codificada en mi máquina de inicio, puede cambiarlo en el código fuente.

La aplicación complementaria SwiftterMapp construye una aplicación iOS real que usa esta biblioteca y está más completa que las aplicaciones de prueba en este módulo y proporciona una interfaz de usuario de configuración adecuada.

Este es un puerto de mi XterMsharp original, que se basaba en Xterm.js. En este punto, considero que Swiftter es un emulador terminal más avanzado que ambos (selección/accesibilidad del módulo), ya que maneja los grupos UTF, Unicode y Graxeme mejor que aquellos y tiene una cobertura más completa de la emulación terminal. Xtermsharp generalmente intenta mantenerse al día.

Características

• Emulación terminal bastante decente, en o mejor que xtermsharp y xterm.js (y más integral en muchos sentidos)
• Renderización de Unicode (incluyendo emoji, y combinar personajes y emoji)
• El motor reutilizable y conectable permite construir múltiples interfaces de usuario sobre ella.
• Motor de selección (con soporte de macOS en la vista)
• Admite colores (ANSI, 256, Truecolor)
• Admite eventos del mouse
• Admite operaciones de cambio de tamaño de terminal (controladas por host remoto o localmente)
• Hipervínculos en la salida terminal
• Appkit, Uikit Front-end; ncurses front-end proporcionado por separado
• Proceso local y soporte de conexión SSH (se requiere un ensamblaje para el último)
• La representación correcta de CorEtext puede comer a través de las suites de prueba Unicode endurecidas.
• Gráficos de Sixel (use IMG2Sixel para probar)
• Representación gráfica al estilo ITERM2 (use IMGCAT para probar)
• Fuzzado y abusado
• Me parece bastante rápido

Biblioteca

La biblioteca Swiftterm en sí contiene el código fuente tanto para el motor como para los frontales. Los frontales se compilan condicionalmente en función de la plataforma de destino.

El motor está en este directorio, mientras que el código para MacOS vive bajo Mac y código para iOS, vive bajo iOS . Dado que esos dos comparten muchos rasgos comunes, el código compartido está bajo Apple .

Usando Swiftter

SwiftterM usa el Swift Package Manager para su compilación, y puede agregar la biblioteca a su proyecto utilizando la URL para este proyecto o una bifurcación de ella.

MacOS NSVIEW

La implementación de MACOS AppKit NSView TerminalView es un control NSView reutilizable que se puede conectar a cualquier fuente implementando TerminalViewDelegate .
Anticipo que un escenario común será alojar un comando UNIX local, por lo que he incluido LocalProcessTerminalView , que es una implementación que conecta la TerminalView con un pseudo terminal UNIX y ejecuta un comando allí.

iOS uiview

Existe una implementación equivalente de UIKIT UIView para TerminalView que, al igual que su compañero NSView, es una vista integrable y reutilizable que se puede conectar a su aplicación mediante la implementación del mismo terminalViewDelegate. A diferencia del caso NSVIEW que se ejecuta en una Mac, donde un escenario común será ejecutar comandos locales, dado que iOS no ofrece acceso a los procesos, el escenario más común será conectar este terminal a un host remoto. Y la forma más segura de conectarse a un sistema remoto es con SSH.

Código compartido entre macOS e iOS

El código iOS y Uikit comparten gran parte del código, ese código vive bajo el directorio de Apple.

Usando SSH

La biblioteca Core actualmente no proporciona una forma conveniente de conectarse a SSH, puramente para evitar la dependencia adicional. Pero este módulo GIT hace referencia a un módulo que extrae a un cliente SSH precompilado (Swiftsh de Frugghi), junto con una vista UIKitSsshTerminalView en la muestra de iOS que conecta la TerminalView para iOS a una conexión SSH.

Trabajando en Swiftter

Si está utilizando XCode, hay dos proyectos de Toplevel, uno para Mac y otro para iOS en el directorio de TerminalApp, uno llamado "Iosterminal.xCodeproj" y uno llamado "MacMerminal.xCodeproj".

Esto es necesario porque XCode no proporciona finalización de código para iOS si tiene un proyecto Mac en el proyecto. Entonces tuve que dividirlos. Ambos proyectos hacen referencia al mismo paquete Swiftterm.

Al trabajar con estos proyectos, si elige la aplicación terminal, ejecutará esta. Para ejecutar el conjunto de pruebas, seleccione el objetivo 'Swiftterm' en su lugar, y puede usar 'SwiftterMfuzz' para ejecutar el fuzzer.

Puede usar swift build para construir el paquete y swift test para ejecutar la suite de prueba, pero tenga en cuenta que la suite de prueba espera que el directorio esctest se revise. Puede ver cómo ejecuto estos en acciones de GitHub en el archivo .github/workflows/swift.yml si desea hacer esto localmente.

Si usa Xcode, puede seleccionar el proyecto "Swiftterm" y luego usar el comandante-U para ejecutar el conjunto de pruebas.

Trabajo pendiente

Los problemas de GitHub tienen una lista de características y mejoras deseadas

Planes a largo plazo

A largo plazo, también quiero agregar un TVOS UIView, un front-end swiftgtk para Linux.

Capturas de pantalla

Color de 24 bits

Comandante de medianoche

Soporte sólido UTF-8, excelente representación:

Admite hipervínculos emitidos por aplicaciones modernas:

Soporte de iOS:

Soporte de Sixel:

Recursos

• Guía del usuario de Digital VT100
• Guía de terminal: muy agradable y visual, pero no normativo
• Secuencias de control xterm
• Información del programador de terminales de video VT510

Documentos adicionales y útiles:

• Manual de referencia del programador VT330/VT340 Volumen 2: Programación de gráficos
• Un analizador para los terminales de video compatibles con ANSI de DEC
• Códigos y estándares
• Documentos de la consola Linux Son un subconjunto de VT100, pero a menudo fáciles de seguir.
• Gráficos de Sixel

Suites de prueba:

• Vttest - viejo, pero sigue siendo bueno
• ESCTEST - Fantástico: George Nachman, el autor de ITERM, creó este conjunto de pruebas, y se convirtió en un estándar de Freedesktop. Desde entonces, Thomas E. Dickey, el mantenedor Xterm y el mantenedor de muchas aplicaciones de texto han contribuido a este esfuerzo.

Autores

• Gracias a los desarrolladores de Xterm.JS que originalmente escribió un emulador terminal que tenía licencia bajo una licencia que permitió la máxima reutilización.
• Marcin Krzyzanowski, quien mejoró y seleccionó magistralmente el motor de representación en AppKit/Coretext para ser el glorioso renderizador que es hoy, y por sus contribuciones al motor de representación
• Greg Munn que hizo mucho trabajo en xtermsharp para apoyar las necesidades de Visual Studio para Mac
• Anders Borum ha contribuido con soluciones de confiabilidad, el analizador Sixel y los cambios necesarios para utilizar Swiftterm en producción.
• Miguel de icaza -me- que han estado buscando una excusa para escribir un código rápido.