SwiftTerm

Swiftterm

O SwiftTerm é uma biblioteca de emulador de terminal VT100/Xterm para aplicativos SWIFT que podem ser incorporados em macos, aplicativos iOS, aplicativos baseados em texto, aplicativos sem cabeça ou outros cenários personalizados. Foi usado em vários clientes SSH disponíveis comercialmente, incluindo moluscos seguros, LA Terminal e CodeEdit

Verifique a documentação da API

Esse repositório contém um mecanismo de emulador de terminal que é agnóstico da interface do usuário, bem como os front-ends para este mecanismo para iOS usando o UIKIT e o macOS usando o AppKit. Um emulador de terminal baseado em maldições (para emular um Xterm dentro de um aplicativo de console) está disponível como parte da biblioteca do Termkit.

Código de exemplo Existem alguns aplicativos de amostra mínima para Mac e iOS mostrando como usar a biblioteca dentro do diretório TerminalApp .

• O aplicativo MAC de amostra possui grande parte da funcionalidade do terminal do macOS.App, mas sem a interface do usuário da configuração.
• O aplicativo iOS de amostra usa uma biblioteca SSH para conectar -se a um sistema remoto (pois não há shell nativo no iOS para executar), e a amostra é codificada na minha máquina doméstica, você pode alterá -lo no código -fonte.

O App Companion SwiftterMapp cria um aplicativo iOS real que usa essa biblioteca e é mais completo do que os aplicativos de teste neste módulo e fornece uma interface de configuração adequada.

Esta é uma porta do meu Xtermsharp original, que foi baseado no XTERM.JS. Nesse ponto, considero o Swiftterm um emulador terminal mais avançado do que ambos (seleção/acessibilidade do módulo), pois lida com os clusters UTF, Unicode e Grapheme melhor que aqueles e tem uma cobertura mais completa da emulação terminal. O XtermSharp geralmente está tentando acompanhar.

Características

• Emulação de terminal bastante decente, dentro ou melhor que o XtermSharp e o XterM.JS (e mais abrangente de várias maneiras)
• Renderização Unicode (incluindo emoji e combinação de personagens e emoji)
• O mecanismo reutilizável e reutilizável permite que várias interfaces de usuário sejam construídas sobre ele.
• Motor de seleção (com suporte macOS na visualização)
• Suporta cores (ANSI, 256, Truecolor)
• Suporta eventos do mouse
• Suporta operações de redimensionamento do terminal (controlado por host remoto ou localmente)
• Hiperlinks na saída do terminal
• Appkit, Uikit Front-end; Ncurses Front-end fornecido separadamente
• Processo local e suporte de conexão SSH (alguma montagem necessária para a última)
• A renderização adequada do Coretext pode mastigar os suítes de teste do Unicode endurecido.
• Graphics Sixel (use img2sixel para testar)
• Renderização gráfica no estilo Iterm2 (use o imgcat para testar)
• Fuzzed e abusado
• Parece muito rápido para mim

Biblioteca Swiftterm

A própria biblioteca Swiftterm contém o código-fonte para o motor e para os front-end-ends. Os front-ends são compilados condicionalmente com base na plataforma de destino.

O mecanismo está nesse diretório, enquanto o código para MacOS vive no Mac , e código para iOS, vive no iOS . Dado que esses dois compartilham muitas características comuns, o código compartilhado está sob Apple .

Usando o Swiftterm

O Swiftterm usa o Swift Package Manager para sua compilação e você pode adicionar a biblioteca ao seu projeto usando o URL para este projeto ou um garfo.

MacOS NSView

O MacOS Appkit NSView Implementation TerminalView é um controle reutilizável do NSView que pode ser conectado a qualquer fonte implementando o TerminalViewDelegate .
Eu prevê que um cenário comum será hospedar um comando local UNIX, por isso incluí LocalProcessTerminalView , que é uma implementação que conecta o TerminalView a um pseudo-terminal do Unix e executa um comando lá.

iOS uiview

Existe uma implementação equivalente do UIKIT UIVIEW para TerminalView , que, como seu Companheiro NSView, é uma visualização incorporável e reutilizável que pode ser conectada ao seu aplicativo implementando o mesmo TerminalViewDelegate. Ao contrário do caso NSView em execução em um Mac, onde um cenário comum será executar comandos locais, já que o iOS não oferece acesso a processos, o cenário mais comum será conectar esse terminal a um host remoto. E a maneira mais segura de se conectar a um sistema remoto é com o SSH.

Código compartilhado entre macOS e iOS

O código iOS e UIKIT compartilham muito do código, esse código vive no diretório da Apple.

Usando ssh

Atualmente, a biblioteca principal não fornece uma maneira conveniente de se conectar ao SSH, apenas para evitar a dependência adicional. Mas este módulo Git faz referência a um módulo que puxa um cliente SSH pré -compilado (Swiftsh de Frugghi), juntamente com um UIKitSsshTerminalView na amostra iOS que conecta o TerminalView para iOS a uma conexão SSH.

Trabalhando no Swiftterm

Se você estiver usando o Xcode, existem dois projetos de Toplevel, um para Mac e outro para iOS no diretório TerminalApp, um chamado "IOSTERMINAL.XCODEPROJ" e um chamado "MacTerminal.xcodeproj".

Isso é necessário porque o Xcode não fornece a conclusão do código para iOS se você tiver um projeto MAC no projeto. Então eu tive que dividi -los. Ambos os projetos fazem referência ao mesmo pacote Swiftterm.

Ao trabalhar com esses projetos, se você escolher o aplicativo de terminal, ele executará este. Para executar o conjunto de testes, selecione o destino 'Swiftterm' e você pode usar 'SwifttermFuzz' para executar o Fuzzher.

Você pode usar swift build para construir o pacote e swift test para executar o conjunto de testes - mas esteja avisado de que o conjunto de testes espera que o diretório esctest seja checado para ser executado. Você pode ver como eu as executo em ações do GitHub no arquivo .github/workflows/swift.yml se você quiser fazer isso localmente.

Se estiver usando o Xcode, você pode selecionar o projeto "Swiftterm" e, em seguida, usar o Command-U para executar o conjunto de testes.

Trabalho pendente

O Github Issues tem uma lista dos recursos e aprimoramentos desejados

Planos de longo prazo

A longo prazo, eu também quero adicionar um TvOS Uiview, um front-end Swiftgtk para Linux.

Capturas de tela

Cor de 24 bits

Midnight Commander

Suporte sólido UTF-8, excelente renderização:

Suporta hiperlinks emitidos por aplicativos modernos:

suporte iOS:

Sixel Suporte:

Recursos

• Guia do usuário VT100 da Digital
• Guia do terminal - muito bom e visual, mas não normativo
• Sequências de controle Xterm
• Informações do programador de terminal de vídeo VT510

Documentos adicionais e úteis:

• VT330/VT340 Manual de referência do programador Volume 2: Programação gráfica
• Um analisador para os terminais de vídeo compatíveis com ANSI de DEC
• Códigos e padrões
• Os documentos do console do Linux eles são um subconjunto de VT100, mas muitas vezes simples de seguir.
• Graphics Sixel

Suítes de teste:

• Vttest - velho, mas ainda bom
• ESCTEST - Fantástico: George Nachman, o autor de Iterm, criou essa suíte de teste e se tornou um padrão Freedesktop. Desde então, Thomas E. Dickey, o mantenedor e mantenedor do Xtert de muitos aplicativos de texto contribuiu para esse esforço.

Autores

• Agradecemos aos desenvolvedores do XTERM.JS que originalmente escreveram um emulador de terminal que foi licenciado sob uma licença que permitia a reutilização máxima.
• Marcin Krzyzanowski, que magistralmente melhorou e selecionou o mecanismo de renderização no Appkit/Coretext para ser o renderizador glorioso de que é hoje - e por suas contribuições para o mecanismo de renderização
• Greg Munn, que fez muito trabalho em Xtermsharp para apoiar as necessidades do Visual Studio para Mac
• O Anders Borum contribuiu com correções de confiabilidade, o analisador Sixel e as mudanças necessárias para colocar o Swiftterm em produção.
• Miguel de Icaza -me- que está procurando uma desculpa para escrever algum código SWIFT.