xterm.dart/example/lib/isolate.dart

import 'dart:async';

import 'package:flutter/material.dart';
import 'package:xterm/flutter.dart';
import 'package:xterm/isolate.dart';
import 'package:xterm/theme/terminal_theme.dart';
import 'package:xterm/theme/terminal_themes.dart';
import 'package:xterm/xterm.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'xterm.dart demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
        visualDensity: VisualDensity.adaptivePlatformDensity,
      ),
      home: MyHomePage(
        theme: TerminalThemes.defaultTheme,
        terminalOpacity: 0.8,
      ),
    );
  }
}

class MyHomePage extends StatefulWidget {
  MyHomePage({
    Key? key,
    required this.theme,
    required this.terminalOpacity,
  }) : super(key: key);

  final TerminalTheme theme;
  final double terminalOpacity;

  @override
  _MyHomePageState createState() => _MyHomePageState();
}

class FakeTerminalBackend extends TerminalBackend {
  // we do a late initialization of those backend members as the backend gets
  // transferred into the Isolate.
  // It is not allowed to e.g. transfer closures which we can not guarantee
  // to not exist in our member types.
  // The Isolate will call init() once it starts (from its context) and that is
  // the place where we initialize those members
  late final _exitCodeCompleter;
  // ignore: close_sinks
  late final _outStream;

  @override
  bool get isReady => true;

  @override
  Future<int> get exitCode => _exitCodeCompleter.future;

  @override
  void init() {
    _exitCodeCompleter = Completer<int>();
    _outStream = StreamController<String>();
    _outStream.sink.add('xterm.dart demo');
    _outStream.sink.add('\r\n');
    _outStream.sink.add('\$ ');
  }

  @override
  Stream<String> get out => _outStream.stream;

  @override
  void resize(int width, int height, int pixelWidth, int pixelHeight) {
    // NOOP
  }

  @override
  void write(String input) {
    if (input.length <= 0) {
      return;
    }
    // in a "real" terminal emulation you would connect onInput to the backend
    // (like a pty or ssh connection) that then handles the changes in the
    // terminal.
    // As we don't have a connected backend here we simulate the changes by
    // directly writing to the terminal.
    if (input == '\r') {
      _outStream.sink.add('\r\n');
      _outStream.sink.add('\$ ');
    } else if (input.codeUnitAt(0) == 127) {
      // Backspace handling
      _outStream.sink.add('\b \b');
    } else {
      _outStream.sink.add(input);
    }
  }

  @override
  void terminate() {
    //NOOP
  }

  @override
  void ackProcessed() {
    //NOOP
  }
}

class _MyHomePageState extends State<MyHomePage> {
  TerminalIsolate? terminal;

  Future<TerminalIsolate> _ensureTerminalStarted() async {
    if (terminal == null) {
      terminal = TerminalIsolate(
        backend: FakeTerminalBackend(),
        maxLines: 10000,
        theme: widget.theme,
      );
    }

    if (!terminal!.isReady) {
      await terminal!.start();
    }
    return terminal!;
  }

  void onInput(String input) {}

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      body: FutureBuilder(
        future: _ensureTerminalStarted(),
        builder: (context, snapshot) {
          return SafeArea(
            child: snapshot.hasData
                ? TerminalView(terminal: snapshot.data as TerminalIsolate)
                : Container(
                    constraints: const BoxConstraints.expand(),
                    color: Color(widget.theme.background)
                        .withOpacity(widget.terminalOpacity),
                  ),
          );
        },
      ),
    );
  }
}