diff --git a/desktop/.gitignore b/desktop/.gitignore new file mode 100644 index 0000000..3820a95 --- /dev/null +++ b/desktop/.gitignore @@ -0,0 +1,45 @@ +# Miscellaneous +*.class +*.log +*.pyc +*.swp +.DS_Store +.atom/ +.build/ +.buildlog/ +.history +.svn/ +.swiftpm/ +migrate_working_dir/ + +# IntelliJ related +*.iml +*.ipr +*.iws +.idea/ + +# The .vscode folder contains launch configuration and tasks you configure in +# VS Code which you may wish to be included in version control, so this line +# is commented out by default. +#.vscode/ + +# Flutter/Dart/Pub related +**/doc/api/ +**/ios/Flutter/.last_build_id +.dart_tool/ +.flutter-plugins-dependencies +.pub-cache/ +.pub/ +/build/ +/coverage/ + +# Symbolication related +app.*.symbols + +# Obfuscation related +app.*.map.json + +# Android Studio will place build artifacts here +/android/app/debug +/android/app/profile +/android/app/release diff --git a/desktop/.metadata b/desktop/.metadata new file mode 100644 index 0000000..24ae2c0 --- /dev/null +++ b/desktop/.metadata @@ -0,0 +1,30 @@ +# This file tracks properties of this Flutter project. +# Used by Flutter tool to assess capabilities and perform upgrades etc. +# +# This file should be version controlled and should not be manually edited. + +version: + revision: "ad70ec4617166f1c38e5d2bfd388af71fda14f06" + channel: "stable" + +project_type: app + +# Tracks metadata for the flutter migrate command +migration: + platforms: + - platform: root + create_revision: ad70ec4617166f1c38e5d2bfd388af71fda14f06 + base_revision: ad70ec4617166f1c38e5d2bfd388af71fda14f06 + - platform: windows + create_revision: ad70ec4617166f1c38e5d2bfd388af71fda14f06 + base_revision: ad70ec4617166f1c38e5d2bfd388af71fda14f06 + + # User provided section + + # List of Local paths (relative to this file) that should be + # ignored by the migrate tool. + # + # Files that are not part of the templates will be ignored by default. + unmanaged_files: + - 'lib/main.dart' + - 'ios/Runner.xcodeproj/project.pbxproj' diff --git a/desktop/README.md b/desktop/README.md new file mode 100644 index 0000000..8bf74d8 --- /dev/null +++ b/desktop/README.md @@ -0,0 +1,55 @@ +# Rtty Desktop (桌面端) + +Rtty 的 Flutter Windows 桌面终端客户端。连接 `rtty-server`（Rust 后端），消费 +服务端下发的**原始 ANSI 二进制帧**，通过 `xterm`（Dart 版 xterm.js）做工业级 +ANSI 渲染，保证对 vim / htop / tmux 等全屏软件 100% 兼容。 + +## 架构 + +``` +rtty-server (Rust) + │ WebSocket (ws://host:8080/ws) + │ • JSON 控制帧 (ready / snapshot / control / error) + │ • 二进制帧 = 原始 ANSI 字节流 (PC 端渲染) + ▼ +rtty-desktop (Flutter / Windows) + • RttyClient —— WebSocket 连接管理 + 协议解析 + • Terminal —— xterm 终端网格 / ANSI 解析 + • ConnectionBar —— 顶部连接控制条 +``` + +## 运行 + +```bash +# 1. 先启动 Rust 服务端（仓库根目录） +cd .. && cargo run + +# 2. 启动桌面端 +cd desktop +flutter run -d windows +``` + +## 构建 + +```bash +flutter build windows --release +# 产物：build/windows/x64/runner/Release/rtty_desktop.exe +``` + +## 测试 + +```bash +# Widget 测试（无需服务端） +flutter test test/widget_test.dart + +# 端到端集成测试（需先启动 Rust 服务端） +flutter test test/e2e_ws_test.dart +``` + +## 协议要点 + +- 连接 `ws://host:port/ws`（可选 `?session=` 复用会话）。 +- 服务端 `ready` 帧携带会话 ID 与初始尺寸，驱动 xterm 网格。 +- PTY 输出以二进制帧下发，桌面端直接喂给 xterm 渲染。 +- 键盘输入与终端回写经 `{"type":"input","data":...}` 发回服务端写入 PTY。 +- 窗口尺寸变化时发送 `{"type":"resize","cols":..,"rows":..}` 同步网格。 diff --git a/desktop/analysis_options.yaml b/desktop/analysis_options.yaml new file mode 100644 index 0000000..0d29021 --- /dev/null +++ b/desktop/analysis_options.yaml @@ -0,0 +1,28 @@ +# This file configures the analyzer, which statically analyzes Dart code to +# check for errors, warnings, and lints. +# +# The issues identified by the analyzer are surfaced in the UI of Dart-enabled +# IDEs (https://dart.dev/tools#ides-and-editors). The analyzer can also be +# invoked from the command line by running `flutter analyze`. + +# The following line activates a set of recommended lints for Flutter apps, +# packages, and plugins designed to encourage good coding practices. +include: package:flutter_lints/flutter.yaml + +linter: + # The lint rules applied to this project can be customized in the + # section below to disable rules from the `package:flutter_lints/flutter.yaml` + # included above or to enable additional rules. A list of all available lints + # and their documentation is published at https://dart.dev/lints. + # + # Instead of disabling a lint rule for the entire project in the + # section below, it can also be suppressed for a single line of code + # or a specific dart file by using the `// ignore: name_of_lint` and + # `// ignore_for_file: name_of_lint` syntax on the line or in the file + # producing the lint. + rules: + # avoid_print: false # Uncomment to disable the `avoid_print` rule + # prefer_single_quotes: true # Uncomment to enable the `prefer_single_quotes` rule + +# Additional information about this file can be found at +# https://dart.dev/guides/language/analysis-options diff --git a/desktop/lib/main.dart b/desktop/lib/main.dart new file mode 100644 index 0000000..b1dbd91 --- /dev/null +++ b/desktop/lib/main.dart @@ -0,0 +1,28 @@ +import 'package:flutter/material.dart'; +import 'package:flutter/services.dart'; + +import 'src/terminal_screen.dart'; +import 'src/theme.dart'; + +void main() { + WidgetsFlutterBinding.ensureInitialized(); + + // 锁定竖排字符方向（终端场景无需旋转）。 + SystemChrome.setPreferredOrientations(DeviceOrientation.values); + + runApp(const RttyApp()); +} + +class RttyApp extends StatelessWidget { + const RttyApp({super.key}); + + @override + Widget build(BuildContext context) { + return MaterialApp( + title: 'Rtty Desktop', + debugShowCheckedModeBanner: false, + theme: RttyTheme.app(), + home: const TerminalScreen(), + ); + } +} diff --git a/desktop/lib/src/connection_bar.dart b/desktop/lib/src/connection_bar.dart new file mode 100644 index 0000000..c75e961 --- /dev/null +++ b/desktop/lib/src/connection_bar.dart @@ -0,0 +1,319 @@ +import 'package:flutter/material.dart'; + +import 'rtty_client.dart'; +import 'theme.dart'; + +/// 顶部连接控制条。 +/// +/// 精炼的工业风控制条：状态指示灯 + 服务器地址输入 + 会话 ID + 连接按钮。 +/// 断开状态下可编辑，连接成功后锁定并显示会话信息。 +class ConnectionBar extends StatelessWidget { + const ConnectionBar({ + super.key, + required this.state, + required this.hostController, + required this.portController, + required this.sessionController, + required this.sessionId, + required this.terminalSize, + required this.onConnect, + required this.onDisconnect, + }); + + final ConnState state; + final TextEditingController hostController; + final TextEditingController portController; + final TextEditingController sessionController; + final String? sessionId; + final String terminalSize; + final VoidCallback onConnect; + final VoidCallback onDisconnect; + + bool get _connected => + state == ConnState.connected || state == ConnState.connecting; + + @override + Widget build(BuildContext context) { + return Container( + height: 56, + decoration: BoxDecoration( + color: RttyTheme.surface, + border: Border(bottom: BorderSide(color: RttyTheme.border)), + ), + padding: const EdgeInsets.symmetric(horizontal: 16), + child: Row( + children: [ + _StatusLight(state: state), + const SizedBox(width: 12), + _ConnectionLabel(state: state), + const SizedBox(width: 16), + _Divider(), + const SizedBox(width: 16), + _EditableField( + label: 'HOST', + controller: hostController, + enabled: !_connected, + width: 150, + ), + const SizedBox(width: 8), + _EditableField( + label: 'PORT', + controller: portController, + enabled: !_connected, + width: 64, + numeric: true, + ), + const SizedBox(width: 8), + if (!_connected) ...[ + _EditableField( + label: 'SESSION', + controller: sessionController, + enabled: true, + width: 120, + hint: 'auto', + ), + ] else ...[ + _SessionBadge(sessionId: sessionId), + ], + const Spacer(), + _TerminalSizeBadge(text: terminalSize), + const SizedBox(width: 12), + _ConnectButton( + state: state, + onConnect: onConnect, + onDisconnect: onDisconnect, + ), + ], + ), + ); + } +} + +class _StatusLight extends StatelessWidget { + const _StatusLight({required this.state}); + + final ConnState state; + + Color get _color => switch (state) { + ConnState.disconnected => RttyTheme.textFaint, + ConnState.connecting => RttyTheme.accent, + ConnState.connected => RttyTheme.primary, + ConnState.error => RttyTheme.danger, + }; + + @override + Widget build(BuildContext context) { + return Container( + width: 10, + height: 10, + decoration: BoxDecoration( + color: _color, + shape: BoxShape.circle, + boxShadow: [ + BoxShadow( + color: _color.withValues(alpha: 0.55), + blurRadius: 6, + spreadRadius: 1, + ), + ], + ), + ); + } +} + +class _ConnectionLabel extends StatelessWidget { + const _ConnectionLabel({required this.state}); + + final ConnState state; + + @override + Widget build(BuildContext context) { + final (label, color) = switch (state) { + ConnState.disconnected => ('DISCONNECTED', RttyTheme.textFaint), + ConnState.connecting => ('CONNECTING', RttyTheme.accent), + ConnState.connected => ('CONNECTED', RttyTheme.primary), + ConnState.error => ('CONNECTION ERROR', RttyTheme.danger), + }; + return Text( + label, + style: TextStyle( + color: color, + fontSize: 11, + fontWeight: FontWeight.w700, + letterSpacing: 1.4, + ), + ); + } +} + +class _Divider extends StatelessWidget { + const _Divider(); + + @override + Widget build(BuildContext context) { + return Container(width: 1, height: 24, color: RttyTheme.border); + } +} + +class _EditableField extends StatelessWidget { + const _EditableField({ + required this.label, + required this.controller, + required this.enabled, + required this.width, + this.numeric = false, + this.hint, + }); + + final String label; + final TextEditingController controller; + final bool enabled; + final double width; + final bool numeric; + final String? hint; + + @override + Widget build(BuildContext context) { + return SizedBox( + width: width, + child: TextField( + controller: controller, + enabled: enabled, + keyboardType: + numeric ? TextInputType.number : TextInputType.text, + style: const TextStyle( + color: RttyTheme.text, + fontSize: 12, + fontFamily: 'Consolas', + decorationThickness: 0, + ), + cursorColor: RttyTheme.primary, + decoration: InputDecoration( + labelText: label, + labelStyle: const TextStyle( + color: RttyTheme.textFaint, + fontSize: 10, + letterSpacing: 1.2, + fontWeight: FontWeight.w600, + ), + hintText: hint, + hintStyle: const TextStyle(color: RttyTheme.textFaint, fontSize: 12), + isDense: true, + contentPadding: + const EdgeInsets.symmetric(horizontal: 8, vertical: 10), + enabledBorder: OutlineInputBorder( + borderRadius: BorderRadius.circular(6), + borderSide: const BorderSide(color: RttyTheme.border), + ), + focusedBorder: OutlineInputBorder( + borderRadius: BorderRadius.circular(6), + borderSide: const BorderSide(color: RttyTheme.primaryDim), + ), + disabledBorder: OutlineInputBorder( + borderRadius: BorderRadius.circular(6), + borderSide: BorderSide( + color: RttyTheme.border.withValues(alpha: 0.5), + ), + ), + ), + ), + ); + } +} + +class _SessionBadge extends StatelessWidget { + const _SessionBadge({required this.sessionId}); + + final String? sessionId; + + @override + Widget build(BuildContext context) { + return Container( + padding: const EdgeInsets.symmetric(horizontal: 10, vertical: 6), + decoration: BoxDecoration( + color: RttyTheme.surfaceHi, + borderRadius: BorderRadius.circular(6), + border: Border.all(color: RttyTheme.border), + ), + child: Text( + 'SID ${sessionId ?? '—'}', + style: const TextStyle( + color: RttyTheme.textDim, + fontSize: 11, + fontFamily: 'Consolas', + letterSpacing: 0.4, + ), + ), + ); + } +} + +class _TerminalSizeBadge extends StatelessWidget { + const _TerminalSizeBadge({required this.text}); + + final String text; + + @override + Widget build(BuildContext context) { + return Text( + text, + style: const TextStyle( + color: RttyTheme.textFaint, + fontSize: 11, + fontFamily: 'Consolas', + ), + ); + } +} + +class _ConnectButton extends StatelessWidget { + const _ConnectButton({ + required this.state, + required this.onConnect, + required this.onDisconnect, + }); + + final ConnState state; + final VoidCallback onConnect; + final VoidCallback onDisconnect; + + @override + Widget build(BuildContext context) { + final connected = state == ConnState.connected; + final connecting = state == ConnState.connecting; + + final bg = connected + ? RttyTheme.primaryDim.withValues(alpha: 0.25) + : RttyTheme.primary.withValues(alpha: 0.14); + final fg = connected ? RttyTheme.danger : RttyTheme.primary; + final label = connected + ? 'DISCONNECT' + : connecting + ? 'CONNECTING…' + : 'CONNECT'; + + return SizedBox( + height: 34, + child: FilledButton( + onPressed: connected ? onDisconnect : onConnect, + style: FilledButton.styleFrom( + backgroundColor: bg, + foregroundColor: fg, + padding: const EdgeInsets.symmetric(horizontal: 18), + shape: RoundedRectangleBorder( + borderRadius: BorderRadius.circular(6), + side: BorderSide(color: fg.withValues(alpha: 0.5)), + ), + ), + child: Text( + label, + style: const TextStyle( + fontSize: 11, + fontWeight: FontWeight.w700, + letterSpacing: 1.2, + ), + ), + ), + ); + } +} diff --git a/desktop/lib/src/rtty_client.dart b/desktop/lib/src/rtty_client.dart new file mode 100644 index 0000000..25a6a63 --- /dev/null +++ b/desktop/lib/src/rtty_client.dart @@ -0,0 +1,167 @@ +import 'dart:async'; +import 'dart:convert'; + +import 'package:web_socket_channel/io.dart'; +import 'package:web_socket_channel/web_socket_channel.dart'; +import 'package:xterm/xterm.dart'; + +/// 连接状态。 +enum ConnState { disconnected, connecting, connected, error } + +/// WebSocket 终端客户端。 +/// +/// 负责与 Rtty 服务端建立连接： +/// - 消费服务端的 JSON 控制帧（ready / snapshot / control / error / session_closed）； +/// - 把 PTY 输出的原始 ANSI 二进制帧交给 [Terminal] 渲染； +/// - 把终端产生的输出（用户键入 + 控制序列响应）以 `input` 消息发回服务端。 +class RttyClient { + RttyClient(this.terminal) { + // xterm 需要把终端输出（键入、控制序列响应）回传给后端。 + terminal.onOutput = _handleTerminalOutput; + } + + final Terminal terminal; + + WebSocketChannel? _channel; + StreamSubscription? _sub; + + ConnState _state = ConnState.disconnected; + ConnState get state => _state; + + String? _sessionId; + String? get sessionId => _sessionId; + + String? _error; + String? get error => _error; + + bool get isConnected => _state == ConnState.connected; + + /// 状态变化回调。 + void Function(ConnState state)? onStateChanged; + + /// 就绪回调（收到 ready 帧，携带会话 ID 与初始尺寸）。 + void Function(String id, int cols, int rows)? onReady; + + /// 会话结束回调。 + void Function()? onSessionClosed; + + /// 原始 ANSI 数据回调（用于调试 / 集成测试）。 + void Function(String data)? onRawData; + + /// 连接到服务端。 + Future connect({ + required String host, + required int port, + String? session, + }) async { + await disconnect(); + + _setState(ConnState.connecting); + _error = null; + + final query = session != null && session.isNotEmpty + ? '?session=${Uri.encodeQueryComponent(session)}' + : ''; + final uri = Uri.parse('ws://$host:$port/ws$query'); + + try { + _channel = IOWebSocketChannel.connect(uri); + _sub = _channel!.stream.listen( + _handleIncoming, + onError: (Object e) { + _error = e.toString(); + _setState(ConnState.error); + }, + onDone: () { + if (_state == ConnState.connected) { + _setState(ConnState.disconnected); + } + }, + ); + _setState(ConnState.connected); + } catch (e) { + _error = e.toString(); + _setState(ConnState.error); + } + } + + /// 断开连接。 + Future disconnect() async { + await _sub?.cancel(); + _sub = null; + await _channel?.sink.close(); + _channel = null; + _sessionId = null; + if (_state != ConnState.disconnected) { + _setState(ConnState.disconnected); + } + } + + void _handleIncoming(dynamic message) { + if (message is List) { + // PC 端原始 ANSI 字节流。 + final text = utf8.decode(message, allowMalformed: true); + onRawData?.call(text); + terminal.write(text); + } else if (message is String) { + _handleJsonFrame(message); + } + } + + void _handleJsonFrame(String text) { + final Object? decoded; + try { + decoded = jsonDecode(text); + } catch (_) { + return; + } + if (decoded is! Map) return; + + switch (decoded['type']) { + case 'ready': + final id = decoded['id'] as String? ?? ''; + final cols = (decoded['cols'] as num?)?.toInt() ?? terminal.viewWidth; + final rows = (decoded['rows'] as num?)?.toInt() ?? terminal.viewHeight; + _sessionId = id; + _setState(ConnState.connected); + onReady?.call(id, cols, rows); + case 'mobile_snapshot': + // 桌面端使用原始 ANSI 渲染，忽略语义化快照。 + break; + case 'control_response': + case 'error': + case 'session_closed': + onSessionClosed?.call(); + _setState(ConnState.disconnected); + default: + break; + } + } + + /// xterm 需要把终端输出回传给后端。 + void _handleTerminalOutput(String data) { + if (!isConnected || _channel == null) return; + final frame = jsonEncode({'type': 'input', 'data': data}); + _channel!.sink.add(frame); + } + + /// 发送 resize 指令。 + void sendResize(int cols, int rows) { + if (!isConnected || _channel == null) return; + final frame = jsonEncode({'type': 'resize', 'cols': cols, 'rows': rows}); + _channel!.sink.add(frame); + } + + /// 发送原始输入字节到服务端（写入 PTY）。 + void sendInput(String data) { + if (!isConnected || _channel == null) return; + final frame = jsonEncode({'type': 'input', 'data': data}); + _channel!.sink.add(frame); + } + + void _setState(ConnState state) { + if (_state == state) return; + _state = state; + onStateChanged?.call(state); + } +} diff --git a/desktop/lib/src/terminal_screen.dart b/desktop/lib/src/terminal_screen.dart new file mode 100644 index 0000000..3922a7f --- /dev/null +++ b/desktop/lib/src/terminal_screen.dart @@ -0,0 +1,366 @@ +import 'package:flutter/material.dart'; +import 'package:xterm/xterm.dart'; + +import 'connection_bar.dart'; +import 'rtty_client.dart'; +import 'theme.dart'; + +/// 主终端页面。 +/// +/// 组织连接控制条 + xterm 终端渲染区 + 底部状态栏。 +/// 断开时展示终端提示页，连接后进入实时渲染。 +class TerminalScreen extends StatefulWidget { + const TerminalScreen({super.key}); + + @override + State createState() => _TerminalScreenState(); +} + +class _TerminalScreenState extends State { + late final Terminal _terminal; + late final RttyClient _client; + + final _host = TextEditingController(text: '127.0.0.1'); + final _port = TextEditingController(text: '8080'); + final _session = TextEditingController(); + + ConnState _state = ConnState.disconnected; + String? _sessionId; + int _cols = 0; + int _rows = 0; + + @override + void initState() { + super.initState(); + _terminal = Terminal(onOutput: (_) {}); + _client = RttyClient(_terminal); + _client.onStateChanged = (s) => setState(() => _state = s); + _client.onReady = (id, cols, rows) { + setState(() { + _sessionId = id; + _cols = cols; + _rows = rows; + }); + }; + _client.onSessionClosed = () { + if (mounted) { + setState(() { + _state = ConnState.disconnected; + _sessionId = null; + }); + } + }; + } + + @override + void dispose() { + _client.disconnect(); + _host.dispose(); + _port.dispose(); + _session.dispose(); + super.dispose(); + } + + Future _connect() async { + final host = _host.text.trim(); + final port = int.tryParse(_port.text.trim()) ?? 8080; + final session = _session.text.trim(); + if (host.isEmpty) return; + + _terminal.write('\x1b[2J\x1b[H'); + await _client.connect(host: host, port: port, session: session); + } + + Future _disconnect() => _client.disconnect(); + + @override + Widget build(BuildContext context) { + final sizeText = _state == ConnState.connected + ? '$_cols × $_rows' + : '—'; + + return Scaffold( + backgroundColor: RttyTheme.background, + body: Column( + children: [ + ConnectionBar( + state: _state, + hostController: _host, + portController: _port, + sessionController: _session, + sessionId: _sessionId, + terminalSize: sizeText, + onConnect: _connect, + onDisconnect: _disconnect, + ), + Expanded(child: _buildBody()), + const _StatusBar(), + ], + ), + ); + } + + Widget _buildBody() { + if (_state == ConnState.connected) { + return _TerminalViewport( + terminal: _terminal, + cols: _cols, + rows: _rows, + onResize: _handleResize, + ); + } + return _IdlePane(state: _state); + } + + void _handleResize(int cols, int rows) { + setState(() { + _cols = cols; + _rows = rows; + }); + _client.sendResize(cols, rows); + } +} + +/// 终端渲染视口。监听尺寸变化并同步给服务端。 +class _TerminalViewport extends StatefulWidget { + const _TerminalViewport({ + required this.terminal, + required this.cols, + required this.rows, + required this.onResize, + }); + + final Terminal terminal; + final int cols; + final int rows; + final void Function(int cols, int rows) onResize; + + @override + State<_TerminalViewport> createState() => _TerminalViewportState(); +} + +class _TerminalViewportState extends State<_TerminalViewport> { + @override + Widget build(BuildContext context) { + return LayoutBuilder( + builder: (context, constraints) { + // 估算每格宽高，把像素尺寸转成网格尺寸并触发 resize。 + final style = RttyTheme.terminalStyle(); + final fontSize = style.fontSize; + final colWidth = fontSize * 0.62; + final rowHeight = fontSize * style.height; + + final cols = (constraints.maxWidth / colWidth).floor().clamp(20, 500); + final rows = + (constraints.maxHeight / rowHeight).floor().clamp(5, 300); + + // 网格变化时通知服务端。 + if (cols != widget.cols || rows != widget.rows) { + WidgetsBinding.instance.addPostFrameCallback((_) { + widget.terminal.resize(cols, rows); + widget.onResize(cols, rows); + }); + } + + return Container( + color: RttyTheme.background, + padding: const EdgeInsets.all(16), + child: ClipRRect( + borderRadius: BorderRadius.circular(4), + child: Container( + decoration: BoxDecoration( + color: RttyTheme.background, + border: Border.all(color: RttyTheme.border), + borderRadius: BorderRadius.circular(4), + ), + padding: const EdgeInsets.fromLTRB(12, 10, 12, 10), + child: TerminalView( + widget.terminal, + theme: RttyTheme.terminal(), + textStyle: style, + autofocus: true, + mouseCursor: SystemMouseCursors.text, + ), + ), + ), + ); + }, + ); + } +} + +/// 未连接时的提示面板。 +class _IdlePane extends StatelessWidget { + const _IdlePane({required this.state}); + + final ConnState state; + + @override + Widget build(BuildContext context) { + final (title, subtitle) = switch (state) { + ConnState.disconnected => ( + 'AWAITING CONNECTION', + '输入服务端地址后点击 CONNECT 建立终端会话', + ), + ConnState.connecting => ( + 'CONNECTING', + '正在协商 WebSocket 终端会话…', + ), + ConnState.error => ( + 'CONNECTION LOST', + '无法建立连接，请检查服务端是否已启动', + ), + ConnState.connected => ('', ''), + }; + + return Center( + child: Column( + mainAxisSize: MainAxisSize.min, + children: [ + _ScanlineGlyph(state: state), + const SizedBox(height: 28), + Text( + title, + style: const TextStyle( + color: RttyTheme.textDim, + fontSize: 18, + fontWeight: FontWeight.w700, + letterSpacing: 3, + ), + ), + const SizedBox(height: 10), + Text( + subtitle, + style: const TextStyle(color: RttyTheme.textFaint, fontSize: 12), + ), + ], + ), + ); + } +} + +/// 终端提示区的装饰性扫描线字形。 +class _ScanlineGlyph extends StatelessWidget { + const _ScanlineGlyph({required this.state}); + + final ConnState state; + + @override + Widget build(BuildContext context) { + final color = switch (state) { + ConnState.connected => RttyTheme.primary, + ConnState.connecting => RttyTheme.accent, + ConnState.error => RttyTheme.danger, + _ => RttyTheme.textFaint, + }; + + return Container( + width: 96, + height: 96, + decoration: BoxDecoration( + border: Border.all(color: color.withValues(alpha: 0.5), width: 1.5), + borderRadius: BorderRadius.circular(12), + ), + child: CustomPaint(painter: _ScanlinePainter(color)), + ); + } +} + +class _ScanlinePainter extends CustomPainter { + _ScanlinePainter(this.color); + + final Color color; + + @override + void paint(Canvas canvas, Size size) { + final paint = Paint() + ..color = color.withValues(alpha: 0.18) + ..strokeWidth = 1; + const spacing = 6.0; + for (double y = 0; y < size.height; y += spacing) { + canvas.drawLine(Offset(0, y), Offset(size.width, y), paint); + } + final cursorPaint = Paint() + ..color = color.withValues(alpha: 0.8) + ..strokeWidth = 2; + canvas.drawRect( + Rect.fromLTWH(size.width * 0.3, size.height * 0.45, 24, 14), + cursorPaint..style = PaintingStyle.stroke, + ); + } + + @override + bool shouldRepaint(covariant _ScanlinePainter old) => old.color != color; +} + +/// 底部状态栏：会话 ID、连接状态、按键提示。 +class _StatusBar extends StatelessWidget { + const _StatusBar(); + + @override + Widget build(BuildContext context) { + return Container( + height: 26, + decoration: BoxDecoration( + color: RttyTheme.surface, + border: Border(top: BorderSide(color: RttyTheme.border)), + ), + padding: const EdgeInsets.symmetric(horizontal: 16), + child: Row( + children: const [ + _StatusDot(), + SizedBox(width: 8), + Text( + 'RTTY DESKTOP', + style: TextStyle( + color: RttyTheme.textFaint, + fontSize: 10, + letterSpacing: 1.6, + fontWeight: FontWeight.w600, + ), + ), + SizedBox(width: 20), + _Hint('鼠标拖选复制', RttyTheme.textFaint), + SizedBox(width: 14), + _Hint('右键粘贴', RttyTheme.textFaint), + Spacer(), + Text( + 'FLUTTER × XTERM × ALCATTERM ENGINE', + style: TextStyle(color: RttyTheme.textFaint, fontSize: 10), + ), + ], + ), + ); + } +} + +class _StatusDot extends StatelessWidget { + const _StatusDot(); + + @override + Widget build(BuildContext context) { + return Container( + width: 6, + height: 6, + decoration: const BoxDecoration( + color: RttyTheme.primary, + shape: BoxShape.circle, + ), + ); + } +} + +class _Hint extends StatelessWidget { + const _Hint(this.text, this.color); + + final String text; + final Color color; + + @override + Widget build(BuildContext context) { + return Text( + text, + style: TextStyle(color: color, fontSize: 10, fontFamily: 'Consolas'), + ); + } +} diff --git a/desktop/lib/src/theme.dart b/desktop/lib/src/theme.dart new file mode 100644 index 0000000..2bd7669 --- /dev/null +++ b/desktop/lib/src/theme.dart @@ -0,0 +1,82 @@ +import 'package:flutter/material.dart'; +import 'package:xterm/xterm.dart'; + +/// Rtty 桌面端主题。 +/// +/// 设计方向：工业终端美学。深炭黑底 + 磷光青绿功能色， +/// 借鉴老式 CRT 终端的磷光质感，克制而精确。 +class RttyTheme { + RttyTheme._(); + + // ---- 基础色板 ---- + static const Color background = Color(0xFF0B0E11); // 炭黑 + static const Color surface = Color(0xFF12161B); // 面板 + static const Color surfaceHi = Color(0xFF1A2027); // 高亮面板 + static const Color border = Color(0xFF232B33); // 边框 + static const Color primary = Color(0xFF3DDC97); // 磷光青绿 + static const Color primaryDim = Color(0xFF1E7A5A); + static const Color accent = Color(0xFFFFB454); // 琥珀 + static const Color danger = Color(0xFFE5534B); // 红 + static const Color text = Color(0xFFD5DEE7); + static const Color textDim = Color(0xFF7B8A99); + static const Color textFaint = Color(0xFF4A5866); + + static ThemeData app() { + final base = ThemeData.dark(useMaterial3: true); + return base.copyWith( + scaffoldBackgroundColor: background, + colorScheme: ColorScheme.dark( + primary: primary, + secondary: accent, + surface: surface, + error: danger, + onPrimary: const Color(0xFF06130D), + onSurface: text, + ), + textTheme: base.textTheme.copyWith( + bodySmall: base.textTheme.bodySmall?.copyWith(color: textDim), + labelSmall: base.textTheme.labelSmall?.copyWith( + color: textFaint, + letterSpacing: 1.2, + fontSize: 10, + fontWeight: FontWeight.w600, + ), + ), + ); + } + + /// xterm 终端主题。 + static TerminalTheme terminal() => TerminalTheme( + cursor: primary, + selection: const Color(0xFF2A5566).withValues(alpha: 0.45), + searchHitBackground: accent.withValues(alpha: 0.25), + searchHitBackgroundCurrent: accent, + searchHitForeground: const Color(0xFF14100A), + foreground: const Color(0xFFCBD5DF), + background: const Color(0xFF0B0E11), + black: const Color(0xFF0B0E11), + white: const Color(0xFFDDE6EE), + red: const Color(0xFFE5534B), + green: const Color(0xFF3DDC97), + yellow: const Color(0xFFFFB454), + blue: const Color(0xFF5AB0FF), + magenta: const Color(0xFFD77BFF), + cyan: const Color(0xFF4ED6E0), + brightBlack: const Color(0xFF4A5866), + brightRed: const Color(0xFFFF6B6B), + brightGreen: const Color(0xFF6BFFC2), + brightYellow: const Color(0xFFFFCE7A), + brightBlue: const Color(0xFF82C4FF), + brightMagenta: const Color(0xFFE8A6FF), + brightCyan: const Color(0xFF82EDF4), + brightWhite: const Color(0xFFFFFDF8), + ); + + /// xterm 终端字体。 + static TerminalStyle terminalStyle() => const TerminalStyle( + fontFamily: 'Consolas', + fontFamilyFallback: ['Cascadia Mono', 'JetBrains Mono', 'Menlo'], + fontSize: 14, + height: 1.15, + ); +} diff --git a/desktop/pubspec.lock b/desktop/pubspec.lock new file mode 100644 index 0000000..5721623 --- /dev/null +++ b/desktop/pubspec.lock @@ -0,0 +1,293 @@ +# Generated by pub +# See https://dart.dev/tools/pub/glossary#lockfile +packages: + async: + dependency: transitive + description: + name: async + sha256: e2eb0491ba5ddb6177742d2da23904574082139b07c1e33b8503b9f46f3e1a37 + url: "https://pub.flutter-io.cn" + source: hosted + version: "2.13.1" + boolean_selector: + dependency: transitive + description: + name: boolean_selector + sha256: "8aab1771e1243a5063b8b0ff68042d67334e3feab9e95b9490f9a6ebf73b42ea" + url: "https://pub.flutter-io.cn" + source: hosted + version: "2.1.2" + characters: + dependency: transitive + description: + name: characters + sha256: faf38497bda5ead2a8c7615f4f7939df04333478bf32e4173fcb06d428b5716b + url: "https://pub.flutter-io.cn" + source: hosted + version: "1.4.1" + clock: + dependency: transitive + description: + name: clock + sha256: fddb70d9b5277016c77a80201021d40a2247104d9f4aa7bab7157b7e3f05b84b + url: "https://pub.flutter-io.cn" + source: hosted + version: "1.1.2" + collection: + dependency: transitive + description: + name: collection + sha256: "2f5709ae4d3d59dd8f7cd309b4e023046b57d8a6c82130785d2b0e5868084e76" + url: "https://pub.flutter-io.cn" + source: hosted + version: "1.19.1" + convert: + dependency: transitive + description: + name: convert + sha256: b30acd5944035672bc15c6b7a8b47d773e41e2f17de064350988c5d02adb1c68 + url: "https://pub.flutter-io.cn" + source: hosted + version: "3.1.2" + crypto: + dependency: transitive + description: + name: crypto + sha256: c8ea0233063ba03258fbcf2ca4d6dadfefe14f02fab57702265467a19f27fadf + url: "https://pub.flutter-io.cn" + source: hosted + version: "3.0.7" + cupertino_icons: + dependency: "direct main" + description: + name: cupertino_icons + sha256: "41e005c33bd814be4d3096aff55b1908d419fde52ca656c8c47719ec745873cd" + url: "https://pub.flutter-io.cn" + source: hosted + version: "1.0.9" + equatable: + dependency: transitive + description: + name: equatable + sha256: "3bce007a596ff8b3119c45d68aaef631272537c03d30e5d4534dd24bf4c5eaa2" + url: "https://pub.flutter-io.cn" + source: hosted + version: "2.1.0" + fake_async: + dependency: transitive + description: + name: fake_async + sha256: "5368f224a74523e8d2e7399ea1638b37aecfca824a3cc4dfdf77bf1fa905ac44" + url: "https://pub.flutter-io.cn" + source: hosted + version: "1.3.3" + flutter: + dependency: "direct main" + description: flutter + source: sdk + version: "0.0.0" + flutter_lints: + dependency: "direct dev" + description: + name: flutter_lints + sha256: "3105dc8492f6183fb076ccf1f351ac3d60564bff92e20bfc4af9cc1651f4e7e1" + url: "https://pub.flutter-io.cn" + source: hosted + version: "6.0.0" + flutter_test: + dependency: "direct dev" + description: flutter + source: sdk + version: "0.0.0" + leak_tracker: + dependency: transitive + description: + name: leak_tracker + sha256: "33e2e26bdd85a0112ec15400c8cbffea70d0f9c3407491f672a2fad47915e2de" + url: "https://pub.flutter-io.cn" + source: hosted + version: "11.0.2" + leak_tracker_flutter_testing: + dependency: transitive + description: + name: leak_tracker_flutter_testing + sha256: "1dbc140bb5a23c75ea9c4811222756104fbcd1a27173f0c34ca01e16bea473c1" + url: "https://pub.flutter-io.cn" + source: hosted + version: "3.0.10" + leak_tracker_testing: + dependency: transitive + description: + name: leak_tracker_testing + sha256: "8d5a2d49f4a66b49744b23b018848400d23e54caf9463f4eb20df3eb8acb2eb1" + url: "https://pub.flutter-io.cn" + source: hosted + version: "3.0.2" + lints: + dependency: transitive + description: + name: lints + sha256: "12f842a479589fea194fe5c5a3095abc7be0c1f2ddfa9a0e76aed1dbd26a87df" + url: "https://pub.flutter-io.cn" + source: hosted + version: "6.1.0" + matcher: + dependency: transitive + description: + name: matcher + sha256: dc0b7dc7651697ea4ff3e69ef44b0407ea32c487a39fff6a4004fa585e901861 + url: "https://pub.flutter-io.cn" + source: hosted + version: "0.12.19" + material_color_utilities: + dependency: transitive + description: + name: material_color_utilities + sha256: "9c337007e82b1889149c82ed242ed1cb24a66044e30979c44912381e9be4c48b" + url: "https://pub.flutter-io.cn" + source: hosted + version: "0.13.0" + meta: + dependency: transitive + description: + name: meta + sha256: "1741988757a65eb6b36abe716829688cf01910bbf91c34354ff7ec1c3de2b349" + url: "https://pub.flutter-io.cn" + source: hosted + version: "1.18.0" + path: + dependency: transitive + description: + name: path + sha256: "75cca69d1490965be98c73ceaea117e8a04dd21217b37b292c9ddbec0d955bc5" + url: "https://pub.flutter-io.cn" + source: hosted + version: "1.9.1" + quiver: + dependency: transitive + description: + name: quiver + sha256: ea0b925899e64ecdfbf9c7becb60d5b50e706ade44a85b2363be2a22d88117d2 + url: "https://pub.flutter-io.cn" + source: hosted + version: "3.2.2" + sky_engine: + dependency: transitive + description: flutter + source: sdk + version: "0.0.0" + source_span: + dependency: transitive + description: + name: source_span + sha256: "56a02f1f4cd1a2d96303c0144c93bd6d909eea6bee6bf5a0e0b685edbd4c47ab" + url: "https://pub.flutter-io.cn" + source: hosted + version: "1.10.2" + stack_trace: + dependency: transitive + description: + name: stack_trace + sha256: "8b27215b45d22309b5cddda1aa2b19bdfec9df0e765f2de506401c071d38d1b1" + url: "https://pub.flutter-io.cn" + source: hosted + version: "1.12.1" + stream_channel: + dependency: transitive + description: + name: stream_channel + sha256: "969e04c80b8bcdf826f8f16579c7b14d780458bd97f56d107d3950fdbeef059d" + url: "https://pub.flutter-io.cn" + source: hosted + version: "2.1.4" + string_scanner: + dependency: transitive + description: + name: string_scanner + sha256: "921cd31725b72fe181906c6a94d987c78e3b98c2e205b397ea399d4054872b43" + url: "https://pub.flutter-io.cn" + source: hosted + version: "1.4.1" + term_glyph: + dependency: transitive + description: + name: term_glyph + sha256: "7f554798625ea768a7518313e58f83891c7f5024f88e46e7182a4558850a4b8e" + url: "https://pub.flutter-io.cn" + source: hosted + version: "1.2.2" + test_api: + dependency: transitive + description: + name: test_api + sha256: "949a932224383300f01be9221c39180316445ecb8e7547f70a41a35bf421fb9e" + url: "https://pub.flutter-io.cn" + source: hosted + version: "0.7.11" + typed_data: + dependency: transitive + description: + name: typed_data + sha256: f9049c039ebfeb4cf7a7104a675823cd72dba8297f264b6637062516699fa006 + url: "https://pub.flutter-io.cn" + source: hosted + version: "1.4.0" + vector_math: + dependency: transitive + description: + name: vector_math + sha256: d530bd74fea330e6e364cda7a85019c434070188383e1cd8d9777ee586914c5b + url: "https://pub.flutter-io.cn" + source: hosted + version: "2.2.0" + vm_service: + dependency: transitive + description: + name: vm_service + sha256: "0016aef94fc66495ac78af5859181e3f3bf2026bd8eecc72b9565601e19ab360" + url: "https://pub.flutter-io.cn" + source: hosted + version: "15.2.0" + web: + dependency: transitive + description: + name: web + sha256: "868d88a33d8a87b18ffc05f9f030ba328ffefba92d6c127917a2ba740f9cfe4a" + url: "https://pub.flutter-io.cn" + source: hosted + version: "1.1.1" + web_socket: + dependency: transitive + description: + name: web_socket + sha256: "34d64019aa8e36bf9842ac014bb5d2f5586ca73df5e4d9bf5c936975cae6982c" + url: "https://pub.flutter-io.cn" + source: hosted + version: "1.0.1" + web_socket_channel: + dependency: "direct main" + description: + name: web_socket_channel + sha256: d645757fb0f4773d602444000a8131ff5d48c9e47adfe9772652dd1a4f2d45c8 + url: "https://pub.flutter-io.cn" + source: hosted + version: "3.0.3" + xterm: + dependency: "direct main" + description: + name: xterm + sha256: "168dfedca77cba33fdb6f52e2cd001e9fde216e398e89335c19b524bb22da3a2" + url: "https://pub.flutter-io.cn" + source: hosted + version: "4.0.0" + zmodem: + dependency: transitive + description: + name: zmodem + sha256: "3b7e5b29f3a7d8aee472029b05165a68438eff2f3f7766edf13daba1e297adbf" + url: "https://pub.flutter-io.cn" + source: hosted + version: "0.0.6" +sdks: + dart: ">=3.12.2 <4.0.0" + flutter: ">=3.19.0" diff --git a/desktop/pubspec.yaml b/desktop/pubspec.yaml new file mode 100644 index 0000000..bd39845 --- /dev/null +++ b/desktop/pubspec.yaml @@ -0,0 +1,91 @@ +name: rtty_desktop +description: "A new Flutter project." +# The following line prevents the package from being accidentally published to +# pub.dev using `flutter pub publish`. This is preferred for private packages. +publish_to: 'none' # Remove this line if you wish to publish to pub.dev + +# The following defines the version and build number for your application. +# A version number is three numbers separated by dots, like 1.2.43 +# followed by an optional build number separated by a +. +# Both the version and the builder number may be overridden in flutter +# build by specifying --build-name and --build-number, respectively. +# In Android, build-name is used as versionName while build-number used as versionCode. +# Read more about Android versioning at https://developer.android.com/studio/publish/versioning +# In iOS, build-name is used as CFBundleShortVersionString while build-number is used as CFBundleVersion. +# Read more about iOS versioning at +# https://developer.apple.com/library/archive/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html +# In Windows, build-name is used as the major, minor, and patch parts +# of the product and file versions while build-number is used as the build suffix. +version: 1.0.0+1 + +environment: + sdk: ^3.12.2 + +# Dependencies specify other packages that your package needs in order to work. +# To automatically upgrade your package dependencies to the latest versions +# consider running `flutter pub upgrade --major-versions`. Alternatively, +# dependencies can be manually updated by changing the version numbers below to +# the latest version available on pub.dev. To see which dependencies have newer +# versions available, run `flutter pub outdated`. +dependencies: + flutter: + sdk: flutter + + # The following adds the Cupertino Icons font to your application. + # Use with the CupertinoIcons class for iOS style icons. + cupertino_icons: ^1.0.8 + web_socket_channel: ^3.0.3 + xterm: ^4.0.0 + +dev_dependencies: + flutter_test: + sdk: flutter + + # The "flutter_lints" package below contains a set of recommended lints to + # encourage good coding practices. The lint set provided by the package is + # activated in the `analysis_options.yaml` file located at the root of your + # package. See that file for information about deactivating specific lint + # rules and activating additional ones. + flutter_lints: ^6.0.0 + +# For information on the generic Dart part of this file, see the +# following page: https://dart.dev/tools/pub/pubspec + +# The following section is specific to Flutter packages. +flutter: + + # The following line ensures that the Material Icons font is + # included with your application, so that you can use the icons in + # the material Icons class. + uses-material-design: true + + # To add assets to your application, add an assets section, like this: + # assets: + # - images/a_dot_burr.jpeg + # - images/a_dot_ham.jpeg + + # An image asset can refer to one or more resolution-specific "variants", see + # https://flutter.dev/to/resolution-aware-images + + # For details regarding adding assets from package dependencies, see + # https://flutter.dev/to/asset-from-package + + # To add custom fonts to your application, add a fonts section here, + # in this "flutter" section. Each entry in this list should have a + # "family" key with the font family name, and a "fonts" key with a + # list giving the asset and other descriptors for the font. For + # example: + # fonts: + # - family: Schyler + # fonts: + # - asset: fonts/Schyler-Regular.ttf + # - asset: fonts/Schyler-Italic.ttf + # style: italic + # - family: Trajan Pro + # fonts: + # - asset: fonts/TrajanPro.ttf + # - asset: fonts/TrajanPro_Bold.ttf + # weight: 700 + # + # For details regarding fonts from package dependencies, + # see https://flutter.dev/to/font-from-package diff --git a/desktop/test/e2e_ws_test.dart b/desktop/test/e2e_ws_test.dart new file mode 100644 index 0000000..b3ae2b4 --- /dev/null +++ b/desktop/test/e2e_ws_test.dart @@ -0,0 +1,61 @@ +// 端到端集成测试：桌面端连接层 ↔ Rust 服务端。 +// +// 运行前需先启动 Rust 服务端：cd .. && cargo run +// 运行：flutter test test/e2e_ws_test.dart +import 'dart:io'; + +import 'package:flutter_test/flutter_test.dart'; +import 'package:xterm/xterm.dart'; + +import '../lib/src/rtty_client.dart'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + + test('RttyClient connects to Rust server and renders command output', + () async { + final terminal = Terminal(); + final client = RttyClient(terminal); + + final states = []; + String? sessionId; + final raw = StringBuffer(); + client.onStateChanged = (s) => states.add(s); + client.onReady = (id, cols, rows) => sessionId = '$id:$cols:$rows'; + client.onRawData = (d) => raw.write(d); + + await client.connect(host: '127.0.0.1', port: 8080); + + // 等待连接就绪（socket 已连接 + 收到 ready 帧）。 + final deadline = DateTime.now().add(const Duration(seconds: 5)); + while ((!client.isConnected || sessionId == null) && + DateTime.now().isBefore(deadline)) { + await Future.delayed(const Duration(milliseconds: 100)); + } + + expect(client.isConnected, isTrue, + reason: '未能连接服务端 states=$states'); + expect(sessionId, isNotNull, + reason: '未收到 ready 帧 states=$states'); + + // 发送命令，等待回显。 + client.sendInput('echo RTTY_E2E_${DateTime.now().millisecondsSinceEpoch}\r\n'); + + String? matchedLine; + final outDeadline = DateTime.now().add(const Duration(seconds: 8)); + while (DateTime.now().isBefore(outDeadline)) { + await Future.delayed(const Duration(milliseconds: 150)); + final text = raw.toString(); + final lines = text.split('\n'); + matchedLine = lines.where((l) => l.contains('RTTY_E2E')).lastOrNull; + if (matchedLine != null) break; + } + + expect(matchedLine, isNotNull, + reason: '未捕获到命令回显。流末尾：' + '${raw.toString().split('').length > 200 ? raw.toString().substring(raw.toString().length - 200) : raw.toString()}'); + + await client.disconnect(); + expect(client.state, ConnState.disconnected); + }); +} diff --git a/desktop/test/widget_test.dart b/desktop/test/widget_test.dart new file mode 100644 index 0000000..16012b0 --- /dev/null +++ b/desktop/test/widget_test.dart @@ -0,0 +1,15 @@ +import 'package:flutter_test/flutter_test.dart'; + +import 'package:rtty_desktop/main.dart'; +import 'package:rtty_desktop/src/terminal_screen.dart'; + +void main() { + testWidgets('Rtty desktop renders terminal screen', (WidgetTester tester) async { + await tester.pumpWidget(const RttyApp()); + + // 未连接状态应显示连接提示与连接控制条。 + expect(find.text('AWAITING CONNECTION'), findsOneWidget); + expect(find.text('CONNECT'), findsOneWidget); + expect(find.byType(TerminalScreen), findsOneWidget); + }); +} diff --git a/desktop/windows/.gitignore b/desktop/windows/.gitignore new file mode 100644 index 0000000..d492d0d --- /dev/null +++ b/desktop/windows/.gitignore @@ -0,0 +1,17 @@ +flutter/ephemeral/ + +# Visual Studio user-specific files. +*.suo +*.user +*.userosscache +*.sln.docstates + +# Visual Studio build-related files. +x64/ +x86/ + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!*.[Cc]ache/ diff --git a/desktop/windows/CMakeLists.txt b/desktop/windows/CMakeLists.txt new file mode 100644 index 0000000..922ed5a --- /dev/null +++ b/desktop/windows/CMakeLists.txt @@ -0,0 +1,108 @@ +# Project-level configuration. +cmake_minimum_required(VERSION 3.14) +project(rtty_desktop LANGUAGES CXX) + +# The name of the executable created for the application. Change this to change +# the on-disk name of your application. +set(BINARY_NAME "rtty_desktop") + +# Explicitly opt in to modern CMake behaviors to avoid warnings with recent +# versions of CMake. +cmake_policy(VERSION 3.14...3.25) + +# Define build configuration option. +get_property(IS_MULTICONFIG GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG) +if(IS_MULTICONFIG) + set(CMAKE_CONFIGURATION_TYPES "Debug;Profile;Release" + CACHE STRING "" FORCE) +else() + if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES) + set(CMAKE_BUILD_TYPE "Debug" CACHE + STRING "Flutter build mode" FORCE) + set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS + "Debug" "Profile" "Release") + endif() +endif() +# Define settings for the Profile build mode. +set(CMAKE_EXE_LINKER_FLAGS_PROFILE "${CMAKE_EXE_LINKER_FLAGS_RELEASE}") +set(CMAKE_SHARED_LINKER_FLAGS_PROFILE "${CMAKE_SHARED_LINKER_FLAGS_RELEASE}") +set(CMAKE_C_FLAGS_PROFILE "${CMAKE_C_FLAGS_RELEASE}") +set(CMAKE_CXX_FLAGS_PROFILE "${CMAKE_CXX_FLAGS_RELEASE}") + +# Use Unicode for all projects. +add_definitions(-DUNICODE -D_UNICODE) + +# Compilation settings that should be applied to most targets. +# +# Be cautious about adding new options here, as plugins use this function by +# default. In most cases, you should add new options to specific targets instead +# of modifying this function. +function(APPLY_STANDARD_SETTINGS TARGET) + target_compile_features(${TARGET} PUBLIC cxx_std_17) + target_compile_options(${TARGET} PRIVATE /W4 /WX /wd"4100") + target_compile_options(${TARGET} PRIVATE /EHsc) + target_compile_definitions(${TARGET} PRIVATE "_HAS_EXCEPTIONS=0") + target_compile_definitions(${TARGET} PRIVATE "$<$:_DEBUG>") +endfunction() + +# Flutter library and tool build rules. +set(FLUTTER_MANAGED_DIR "${CMAKE_CURRENT_SOURCE_DIR}/flutter") +add_subdirectory(${FLUTTER_MANAGED_DIR}) + +# Application build; see runner/CMakeLists.txt. +add_subdirectory("runner") + + +# Generated plugin build rules, which manage building the plugins and adding +# them to the application. +include(flutter/generated_plugins.cmake) + + +# === Installation === +# Support files are copied into place next to the executable, so that it can +# run in place. This is done instead of making a separate bundle (as on Linux) +# so that building and running from within Visual Studio will work. +set(BUILD_BUNDLE_DIR "$") +# Make the "install" step default, as it's required to run. +set(CMAKE_VS_INCLUDE_INSTALL_TO_DEFAULT_BUILD 1) +if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT) + set(CMAKE_INSTALL_PREFIX "${BUILD_BUNDLE_DIR}" CACHE PATH "..." FORCE) +endif() + +set(INSTALL_BUNDLE_DATA_DIR "${CMAKE_INSTALL_PREFIX}/data") +set(INSTALL_BUNDLE_LIB_DIR "${CMAKE_INSTALL_PREFIX}") + +install(TARGETS ${BINARY_NAME} RUNTIME DESTINATION "${CMAKE_INSTALL_PREFIX}" + COMPONENT Runtime) + +install(FILES "${FLUTTER_ICU_DATA_FILE}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" + COMPONENT Runtime) + +install(FILES "${FLUTTER_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) + +if(PLUGIN_BUNDLED_LIBRARIES) + install(FILES "${PLUGIN_BUNDLED_LIBRARIES}" + DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) +endif() + +# Copy the native assets provided by the build.dart from all packages. +set(NATIVE_ASSETS_DIR "${PROJECT_BUILD_DIR}native_assets/windows/") +install(DIRECTORY "${NATIVE_ASSETS_DIR}" + DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) + +# Fully re-copy the assets directory on each build to avoid having stale files +# from a previous install. +set(FLUTTER_ASSET_DIR_NAME "flutter_assets") +install(CODE " + file(REMOVE_RECURSE \"${INSTALL_BUNDLE_DATA_DIR}/${FLUTTER_ASSET_DIR_NAME}\") + " COMPONENT Runtime) +install(DIRECTORY "${PROJECT_BUILD_DIR}/${FLUTTER_ASSET_DIR_NAME}" + DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" COMPONENT Runtime) + +# Install the AOT library on non-Debug builds only. +install(FILES "${AOT_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" + CONFIGURATIONS Profile;Release + COMPONENT Runtime) diff --git a/desktop/windows/flutter/CMakeLists.txt b/desktop/windows/flutter/CMakeLists.txt new file mode 100644 index 0000000..903f489 --- /dev/null +++ b/desktop/windows/flutter/CMakeLists.txt @@ -0,0 +1,109 @@ +# This file controls Flutter-level build steps. It should not be edited. +cmake_minimum_required(VERSION 3.14) + +set(EPHEMERAL_DIR "${CMAKE_CURRENT_SOURCE_DIR}/ephemeral") + +# Configuration provided via flutter tool. +include(${EPHEMERAL_DIR}/generated_config.cmake) + +# TODO: Move the rest of this into files in ephemeral. See +# https://github.com/flutter/flutter/issues/57146. +set(WRAPPER_ROOT "${EPHEMERAL_DIR}/cpp_client_wrapper") + +# Set fallback configurations for older versions of the flutter tool. +if (NOT DEFINED FLUTTER_TARGET_PLATFORM) + set(FLUTTER_TARGET_PLATFORM "windows-x64") +endif() + +# === Flutter Library === +set(FLUTTER_LIBRARY "${EPHEMERAL_DIR}/flutter_windows.dll") + +# Published to parent scope for install step. +set(FLUTTER_LIBRARY ${FLUTTER_LIBRARY} PARENT_SCOPE) +set(FLUTTER_ICU_DATA_FILE "${EPHEMERAL_DIR}/icudtl.dat" PARENT_SCOPE) +set(PROJECT_BUILD_DIR "${PROJECT_DIR}/build/" PARENT_SCOPE) +set(AOT_LIBRARY "${PROJECT_DIR}/build/windows/app.so" PARENT_SCOPE) + +list(APPEND FLUTTER_LIBRARY_HEADERS + "flutter_export.h" + "flutter_windows.h" + "flutter_messenger.h" + "flutter_plugin_registrar.h" + "flutter_texture_registrar.h" +) +list(TRANSFORM FLUTTER_LIBRARY_HEADERS PREPEND "${EPHEMERAL_DIR}/") +add_library(flutter INTERFACE) +target_include_directories(flutter INTERFACE + "${EPHEMERAL_DIR}" +) +target_link_libraries(flutter INTERFACE "${FLUTTER_LIBRARY}.lib") +add_dependencies(flutter flutter_assemble) + +# === Wrapper === +list(APPEND CPP_WRAPPER_SOURCES_CORE + "core_implementations.cc" + "standard_codec.cc" +) +list(TRANSFORM CPP_WRAPPER_SOURCES_CORE PREPEND "${WRAPPER_ROOT}/") +list(APPEND CPP_WRAPPER_SOURCES_PLUGIN + "plugin_registrar.cc" +) +list(TRANSFORM CPP_WRAPPER_SOURCES_PLUGIN PREPEND "${WRAPPER_ROOT}/") +list(APPEND CPP_WRAPPER_SOURCES_APP + "flutter_engine.cc" + "flutter_view_controller.cc" +) +list(TRANSFORM CPP_WRAPPER_SOURCES_APP PREPEND "${WRAPPER_ROOT}/") + +# Wrapper sources needed for a plugin. +add_library(flutter_wrapper_plugin STATIC + ${CPP_WRAPPER_SOURCES_CORE} + ${CPP_WRAPPER_SOURCES_PLUGIN} +) +apply_standard_settings(flutter_wrapper_plugin) +set_target_properties(flutter_wrapper_plugin PROPERTIES + POSITION_INDEPENDENT_CODE ON) +set_target_properties(flutter_wrapper_plugin PROPERTIES + CXX_VISIBILITY_PRESET hidden) +target_link_libraries(flutter_wrapper_plugin PUBLIC flutter) +target_include_directories(flutter_wrapper_plugin PUBLIC + "${WRAPPER_ROOT}/include" +) +add_dependencies(flutter_wrapper_plugin flutter_assemble) + +# Wrapper sources needed for the runner. +add_library(flutter_wrapper_app STATIC + ${CPP_WRAPPER_SOURCES_CORE} + ${CPP_WRAPPER_SOURCES_APP} +) +apply_standard_settings(flutter_wrapper_app) +target_link_libraries(flutter_wrapper_app PUBLIC flutter) +target_include_directories(flutter_wrapper_app PUBLIC + "${WRAPPER_ROOT}/include" +) +add_dependencies(flutter_wrapper_app flutter_assemble) + +# === Flutter tool backend === +# _phony_ is a non-existent file to force this command to run every time, +# since currently there's no way to get a full input/output list from the +# flutter tool. +set(PHONY_OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/_phony_") +set_source_files_properties("${PHONY_OUTPUT}" PROPERTIES SYMBOLIC TRUE) +add_custom_command( + OUTPUT ${FLUTTER_LIBRARY} ${FLUTTER_LIBRARY_HEADERS} + ${CPP_WRAPPER_SOURCES_CORE} ${CPP_WRAPPER_SOURCES_PLUGIN} + ${CPP_WRAPPER_SOURCES_APP} + ${PHONY_OUTPUT} + COMMAND ${CMAKE_COMMAND} -E env + ${FLUTTER_TOOL_ENVIRONMENT} + "${FLUTTER_ROOT}/packages/flutter_tools/bin/tool_backend.bat" + ${FLUTTER_TARGET_PLATFORM} $ + VERBATIM +) +add_custom_target(flutter_assemble DEPENDS + "${FLUTTER_LIBRARY}" + ${FLUTTER_LIBRARY_HEADERS} + ${CPP_WRAPPER_SOURCES_CORE} + ${CPP_WRAPPER_SOURCES_PLUGIN} + ${CPP_WRAPPER_SOURCES_APP} +) diff --git a/desktop/windows/flutter/generated_plugin_registrant.cc b/desktop/windows/flutter/generated_plugin_registrant.cc new file mode 100644 index 0000000..8b6d468 --- /dev/null +++ b/desktop/windows/flutter/generated_plugin_registrant.cc @@ -0,0 +1,11 @@ +// +// Generated file. Do not edit. +// + +// clang-format off + +#include "generated_plugin_registrant.h" + + +void RegisterPlugins(flutter::PluginRegistry* registry) { +} diff --git a/desktop/windows/flutter/generated_plugin_registrant.h b/desktop/windows/flutter/generated_plugin_registrant.h new file mode 100644 index 0000000..dc139d8 --- /dev/null +++ b/desktop/windows/flutter/generated_plugin_registrant.h @@ -0,0 +1,15 @@ +// +// Generated file. Do not edit. +// + +// clang-format off + +#ifndef GENERATED_PLUGIN_REGISTRANT_ +#define GENERATED_PLUGIN_REGISTRANT_ + +#include + +// Registers Flutter plugins. +void RegisterPlugins(flutter::PluginRegistry* registry); + +#endif // GENERATED_PLUGIN_REGISTRANT_ diff --git a/desktop/windows/flutter/generated_plugins.cmake b/desktop/windows/flutter/generated_plugins.cmake new file mode 100644 index 0000000..b93c4c3 --- /dev/null +++ b/desktop/windows/flutter/generated_plugins.cmake @@ -0,0 +1,23 @@ +# +# Generated file, do not edit. +# + +list(APPEND FLUTTER_PLUGIN_LIST +) + +list(APPEND FLUTTER_FFI_PLUGIN_LIST +) + +set(PLUGIN_BUNDLED_LIBRARIES) + +foreach(plugin ${FLUTTER_PLUGIN_LIST}) + add_subdirectory(flutter/ephemeral/.plugin_symlinks/${plugin}/windows plugins/${plugin}) + target_link_libraries(${BINARY_NAME} PRIVATE ${plugin}_plugin) + list(APPEND PLUGIN_BUNDLED_LIBRARIES $) + list(APPEND PLUGIN_BUNDLED_LIBRARIES ${${plugin}_bundled_libraries}) +endforeach(plugin) + +foreach(ffi_plugin ${FLUTTER_FFI_PLUGIN_LIST}) + add_subdirectory(flutter/ephemeral/.plugin_symlinks/${ffi_plugin}/windows plugins/${ffi_plugin}) + list(APPEND PLUGIN_BUNDLED_LIBRARIES ${${ffi_plugin}_bundled_libraries}) +endforeach(ffi_plugin) diff --git a/desktop/windows/runner/CMakeLists.txt b/desktop/windows/runner/CMakeLists.txt new file mode 100644 index 0000000..394917c --- /dev/null +++ b/desktop/windows/runner/CMakeLists.txt @@ -0,0 +1,40 @@ +cmake_minimum_required(VERSION 3.14) +project(runner LANGUAGES CXX) + +# Define the application target. To change its name, change BINARY_NAME in the +# top-level CMakeLists.txt, not the value here, or `flutter run` will no longer +# work. +# +# Any new source files that you add to the application should be added here. +add_executable(${BINARY_NAME} WIN32 + "flutter_window.cpp" + "main.cpp" + "utils.cpp" + "win32_window.cpp" + "${FLUTTER_MANAGED_DIR}/generated_plugin_registrant.cc" + "Runner.rc" + "runner.exe.manifest" +) + +# Apply the standard set of build settings. This can be removed for applications +# that need different build settings. +apply_standard_settings(${BINARY_NAME}) + +# Add preprocessor definitions for the build version. +target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION=\"${FLUTTER_VERSION}\"") +target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION_MAJOR=${FLUTTER_VERSION_MAJOR}") +target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION_MINOR=${FLUTTER_VERSION_MINOR}") +target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION_PATCH=${FLUTTER_VERSION_PATCH}") +target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION_BUILD=${FLUTTER_VERSION_BUILD}") + +# Disable Windows macros that collide with C++ standard library functions. +target_compile_definitions(${BINARY_NAME} PRIVATE "NOMINMAX") + +# Add dependency libraries and include directories. Add any application-specific +# dependencies here. +target_link_libraries(${BINARY_NAME} PRIVATE flutter flutter_wrapper_app) +target_link_libraries(${BINARY_NAME} PRIVATE "dwmapi.lib") +target_include_directories(${BINARY_NAME} PRIVATE "${CMAKE_SOURCE_DIR}") + +# Run the Flutter tool portions of the build. This must not be removed. +add_dependencies(${BINARY_NAME} flutter_assemble) diff --git a/desktop/windows/runner/Runner.rc b/desktop/windows/runner/Runner.rc new file mode 100644 index 0000000..96019b2 --- /dev/null +++ b/desktop/windows/runner/Runner.rc @@ -0,0 +1,121 @@ +// Microsoft Visual C++ generated resource script. +// +#pragma code_page(65001) +#include "resource.h" + +#define APSTUDIO_READONLY_SYMBOLS +///////////////////////////////////////////////////////////////////////////// +// +// Generated from the TEXTINCLUDE 2 resource. +// +#include "winres.h" + +///////////////////////////////////////////////////////////////////////////// +#undef APSTUDIO_READONLY_SYMBOLS + +///////////////////////////////////////////////////////////////////////////// +// English (United States) resources + +#if !defined(AFX_RESOURCE_DLL) || defined(AFX_TARG_ENU) +LANGUAGE LANG_ENGLISH, SUBLANG_ENGLISH_US + +#ifdef APSTUDIO_INVOKED +///////////////////////////////////////////////////////////////////////////// +// +// TEXTINCLUDE +// + +1 TEXTINCLUDE +BEGIN + "resource.h\0" +END + +2 TEXTINCLUDE +BEGIN + "#include ""winres.h""\r\n" + "\0" +END + +3 TEXTINCLUDE +BEGIN + "\r\n" + "\0" +END + +#endif // APSTUDIO_INVOKED + + +///////////////////////////////////////////////////////////////////////////// +// +// Icon +// + +// Icon with lowest ID value placed first to ensure application icon +// remains consistent on all systems. +IDI_APP_ICON ICON "resources\\app_icon.ico" + + +///////////////////////////////////////////////////////////////////////////// +// +// Version +// + +#if defined(FLUTTER_VERSION_MAJOR) && defined(FLUTTER_VERSION_MINOR) && defined(FLUTTER_VERSION_PATCH) && defined(FLUTTER_VERSION_BUILD) +#define VERSION_AS_NUMBER FLUTTER_VERSION_MAJOR,FLUTTER_VERSION_MINOR,FLUTTER_VERSION_PATCH,FLUTTER_VERSION_BUILD +#else +#define VERSION_AS_NUMBER 1,0,0,0 +#endif + +#if defined(FLUTTER_VERSION) +#define VERSION_AS_STRING FLUTTER_VERSION +#else +#define VERSION_AS_STRING "1.0.0" +#endif + +VS_VERSION_INFO VERSIONINFO + FILEVERSION VERSION_AS_NUMBER + PRODUCTVERSION VERSION_AS_NUMBER + FILEFLAGSMASK VS_FFI_FILEFLAGSMASK +#ifdef _DEBUG + FILEFLAGS VS_FF_DEBUG +#else + FILEFLAGS 0x0L +#endif + FILEOS VOS__WINDOWS32 + FILETYPE VFT_APP + FILESUBTYPE 0x0L +BEGIN + BLOCK "StringFileInfo" + BEGIN + BLOCK "040904e4" + BEGIN + VALUE "CompanyName", "com.example" "\0" + VALUE "FileDescription", "rtty_desktop" "\0" + VALUE "FileVersion", VERSION_AS_STRING "\0" + VALUE "InternalName", "rtty_desktop" "\0" + VALUE "LegalCopyright", "Copyright (C) 2026 com.example. All rights reserved." "\0" + VALUE "OriginalFilename", "rtty_desktop.exe" "\0" + VALUE "ProductName", "rtty_desktop" "\0" + VALUE "ProductVersion", VERSION_AS_STRING "\0" + END + END + BLOCK "VarFileInfo" + BEGIN + VALUE "Translation", 0x409, 1252 + END +END + +#endif // English (United States) resources +///////////////////////////////////////////////////////////////////////////// + + + +#ifndef APSTUDIO_INVOKED +///////////////////////////////////////////////////////////////////////////// +// +// Generated from the TEXTINCLUDE 3 resource. +// + + +///////////////////////////////////////////////////////////////////////////// +#endif // not APSTUDIO_INVOKED diff --git a/desktop/windows/runner/flutter_window.cpp b/desktop/windows/runner/flutter_window.cpp new file mode 100644 index 0000000..955ee30 --- /dev/null +++ b/desktop/windows/runner/flutter_window.cpp @@ -0,0 +1,71 @@ +#include "flutter_window.h" + +#include + +#include "flutter/generated_plugin_registrant.h" + +FlutterWindow::FlutterWindow(const flutter::DartProject& project) + : project_(project) {} + +FlutterWindow::~FlutterWindow() {} + +bool FlutterWindow::OnCreate() { + if (!Win32Window::OnCreate()) { + return false; + } + + RECT frame = GetClientArea(); + + // The size here must match the window dimensions to avoid unnecessary surface + // creation / destruction in the startup path. + flutter_controller_ = std::make_unique( + frame.right - frame.left, frame.bottom - frame.top, project_); + // Ensure that basic setup of the controller was successful. + if (!flutter_controller_->engine() || !flutter_controller_->view()) { + return false; + } + RegisterPlugins(flutter_controller_->engine()); + SetChildContent(flutter_controller_->view()->GetNativeWindow()); + + flutter_controller_->engine()->SetNextFrameCallback([&]() { + this->Show(); + }); + + // Flutter can complete the first frame before the "show window" callback is + // registered. The following call ensures a frame is pending to ensure the + // window is shown. It is a no-op if the first frame hasn't completed yet. + flutter_controller_->ForceRedraw(); + + return true; +} + +void FlutterWindow::OnDestroy() { + if (flutter_controller_) { + flutter_controller_ = nullptr; + } + + Win32Window::OnDestroy(); +} + +LRESULT +FlutterWindow::MessageHandler(HWND hwnd, UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept { + // Give Flutter, including plugins, an opportunity to handle window messages. + if (flutter_controller_) { + std::optional result = + flutter_controller_->HandleTopLevelWindowProc(hwnd, message, wparam, + lparam); + if (result) { + return *result; + } + } + + switch (message) { + case WM_FONTCHANGE: + flutter_controller_->engine()->ReloadSystemFonts(); + break; + } + + return Win32Window::MessageHandler(hwnd, message, wparam, lparam); +} diff --git a/desktop/windows/runner/flutter_window.h b/desktop/windows/runner/flutter_window.h new file mode 100644 index 0000000..6da0652 --- /dev/null +++ b/desktop/windows/runner/flutter_window.h @@ -0,0 +1,33 @@ +#ifndef RUNNER_FLUTTER_WINDOW_H_ +#define RUNNER_FLUTTER_WINDOW_H_ + +#include +#include + +#include + +#include "win32_window.h" + +// A window that does nothing but host a Flutter view. +class FlutterWindow : public Win32Window { + public: + // Creates a new FlutterWindow hosting a Flutter view running |project|. + explicit FlutterWindow(const flutter::DartProject& project); + virtual ~FlutterWindow(); + + protected: + // Win32Window: + bool OnCreate() override; + void OnDestroy() override; + LRESULT MessageHandler(HWND window, UINT const message, WPARAM const wparam, + LPARAM const lparam) noexcept override; + + private: + // The project to run. + flutter::DartProject project_; + + // The Flutter instance hosted by this window. + std::unique_ptr flutter_controller_; +}; + +#endif // RUNNER_FLUTTER_WINDOW_H_ diff --git a/desktop/windows/runner/main.cpp b/desktop/windows/runner/main.cpp new file mode 100644 index 0000000..b8814c0 --- /dev/null +++ b/desktop/windows/runner/main.cpp @@ -0,0 +1,43 @@ +#include +#include +#include + +#include "flutter_window.h" +#include "utils.h" + +int APIENTRY wWinMain(_In_ HINSTANCE instance, _In_opt_ HINSTANCE prev, + _In_ wchar_t *command_line, _In_ int show_command) { + // Attach to console when present (e.g., 'flutter run') or create a + // new console when running with a debugger. + if (!::AttachConsole(ATTACH_PARENT_PROCESS) && ::IsDebuggerPresent()) { + CreateAndAttachConsole(); + } + + // Initialize COM, so that it is available for use in the library and/or + // plugins. + ::CoInitializeEx(nullptr, COINIT_APARTMENTTHREADED); + + flutter::DartProject project(L"data"); + + std::vector command_line_arguments = + GetCommandLineArguments(); + + project.set_dart_entrypoint_arguments(std::move(command_line_arguments)); + + FlutterWindow window(project); + Win32Window::Point origin(10, 10); + Win32Window::Size size(1280, 720); + if (!window.Create(L"rtty_desktop", origin, size)) { + return EXIT_FAILURE; + } + window.SetQuitOnClose(true); + + ::MSG msg; + while (::GetMessage(&msg, nullptr, 0, 0)) { + ::TranslateMessage(&msg); + ::DispatchMessage(&msg); + } + + ::CoUninitialize(); + return EXIT_SUCCESS; +} diff --git a/desktop/windows/runner/resource.h b/desktop/windows/runner/resource.h new file mode 100644 index 0000000..66a65d1 --- /dev/null +++ b/desktop/windows/runner/resource.h @@ -0,0 +1,16 @@ +//{{NO_DEPENDENCIES}} +// Microsoft Visual C++ generated include file. +// Used by Runner.rc +// +#define IDI_APP_ICON 101 + +// Next default values for new objects +// +#ifdef APSTUDIO_INVOKED +#ifndef APSTUDIO_READONLY_SYMBOLS +#define _APS_NEXT_RESOURCE_VALUE 102 +#define _APS_NEXT_COMMAND_VALUE 40001 +#define _APS_NEXT_CONTROL_VALUE 1001 +#define _APS_NEXT_SYMED_VALUE 101 +#endif +#endif diff --git a/desktop/windows/runner/resources/app_icon.ico b/desktop/windows/runner/resources/app_icon.ico new file mode 100644 index 0000000..c04e20c Binary files /dev/null and b/desktop/windows/runner/resources/app_icon.ico differ diff --git a/desktop/windows/runner/runner.exe.manifest b/desktop/windows/runner/runner.exe.manifest new file mode 100644 index 0000000..153653e --- /dev/null +++ b/desktop/windows/runner/runner.exe.manifest @@ -0,0 +1,14 @@ + + + + + PerMonitorV2 + + + + + + + + + diff --git a/desktop/windows/runner/utils.cpp b/desktop/windows/runner/utils.cpp new file mode 100644 index 0000000..3cb7146 --- /dev/null +++ b/desktop/windows/runner/utils.cpp @@ -0,0 +1,69 @@ +#include "utils.h" + +#include +#include +#include +#include + +#include + +void CreateAndAttachConsole() { + if (::AllocConsole()) { + FILE *unused; + if (freopen_s(&unused, "CONOUT$", "w", stdout)) { + _dup2(_fileno(stdout), 1); + } + if (freopen_s(&unused, "CONOUT$", "w", stderr)) { + _dup2(_fileno(stdout), 2); + } + std::ios::sync_with_stdio(); + FlutterDesktopResyncOutputStreams(); + } +} + +std::vector GetCommandLineArguments() { + // Convert the UTF-16 command line arguments to UTF-8 for the Engine to use. + int argc; + wchar_t** argv = ::CommandLineToArgvW(::GetCommandLineW(), &argc); + if (argv == nullptr) { + return std::vector(); + } + + std::vector command_line_arguments; + + // Skip the first argument as it's the binary name. + for (int i = 1; i < argc; i++) { + command_line_arguments.push_back(Utf8FromUtf16(argv[i])); + } + + ::LocalFree(argv); + + return command_line_arguments; +} + +std::string Utf8FromUtf16(const wchar_t* utf16_string) { + if (utf16_string == nullptr) { + return std::string(); + } + // First, find the length of the string with a safe upper bound (CWE-126). + // UNICODE_STRING_MAX_CHARS (32767) is the maximum length of a UNICODE_STRING. + int input_length = static_cast(wcsnlen(utf16_string, UNICODE_STRING_MAX_CHARS)); + // Now use that bounded length to determine the required buffer size. + // When an explicit length is passed, WideCharToMultiByte does not include + // the null terminator in its returned size. + int target_length = ::WideCharToMultiByte( + CP_UTF8, WC_ERR_INVALID_CHARS, utf16_string, + input_length, nullptr, 0, nullptr, nullptr); + std::string utf8_string; + if (target_length == 0 || static_cast(target_length) > utf8_string.max_size()) { + return utf8_string; + } + utf8_string.resize(target_length); + int converted_length = ::WideCharToMultiByte( + CP_UTF8, WC_ERR_INVALID_CHARS, utf16_string, + input_length, utf8_string.data(), target_length, nullptr, nullptr); + if (converted_length == 0) { + return std::string(); + } + return utf8_string; +} diff --git a/desktop/windows/runner/utils.h b/desktop/windows/runner/utils.h new file mode 100644 index 0000000..3879d54 --- /dev/null +++ b/desktop/windows/runner/utils.h @@ -0,0 +1,19 @@ +#ifndef RUNNER_UTILS_H_ +#define RUNNER_UTILS_H_ + +#include +#include + +// Creates a console for the process, and redirects stdout and stderr to +// it for both the runner and the Flutter library. +void CreateAndAttachConsole(); + +// Takes a null-terminated wchar_t* encoded in UTF-16 and returns a std::string +// encoded in UTF-8. Returns an empty std::string on failure. +std::string Utf8FromUtf16(const wchar_t* utf16_string); + +// Gets the command line arguments passed in as a std::vector, +// encoded in UTF-8. Returns an empty std::vector on failure. +std::vector GetCommandLineArguments(); + +#endif // RUNNER_UTILS_H_ diff --git a/desktop/windows/runner/win32_window.cpp b/desktop/windows/runner/win32_window.cpp new file mode 100644 index 0000000..60608d0 --- /dev/null +++ b/desktop/windows/runner/win32_window.cpp @@ -0,0 +1,288 @@ +#include "win32_window.h" + +#include +#include + +#include "resource.h" + +namespace { + +/// Window attribute that enables dark mode window decorations. +/// +/// Redefined in case the developer's machine has a Windows SDK older than +/// version 10.0.22000.0. +/// See: https://docs.microsoft.com/windows/win32/api/dwmapi/ne-dwmapi-dwmwindowattribute +#ifndef DWMWA_USE_IMMERSIVE_DARK_MODE +#define DWMWA_USE_IMMERSIVE_DARK_MODE 20 +#endif + +constexpr const wchar_t kWindowClassName[] = L"FLUTTER_RUNNER_WIN32_WINDOW"; + +/// Registry key for app theme preference. +/// +/// A value of 0 indicates apps should use dark mode. A non-zero or missing +/// value indicates apps should use light mode. +constexpr const wchar_t kGetPreferredBrightnessRegKey[] = + L"Software\\Microsoft\\Windows\\CurrentVersion\\Themes\\Personalize"; +constexpr const wchar_t kGetPreferredBrightnessRegValue[] = L"AppsUseLightTheme"; + +// The number of Win32Window objects that currently exist. +static int g_active_window_count = 0; + +using EnableNonClientDpiScaling = BOOL __stdcall(HWND hwnd); + +// Scale helper to convert logical scaler values to physical using passed in +// scale factor +int Scale(int source, double scale_factor) { + return static_cast(source * scale_factor); +} + +// Dynamically loads the |EnableNonClientDpiScaling| from the User32 module. +// This API is only needed for PerMonitor V1 awareness mode. +void EnableFullDpiSupportIfAvailable(HWND hwnd) { + HMODULE user32_module = LoadLibraryA("User32.dll"); + if (!user32_module) { + return; + } + auto enable_non_client_dpi_scaling = + reinterpret_cast( + GetProcAddress(user32_module, "EnableNonClientDpiScaling")); + if (enable_non_client_dpi_scaling != nullptr) { + enable_non_client_dpi_scaling(hwnd); + } + FreeLibrary(user32_module); +} + +} // namespace + +// Manages the Win32Window's window class registration. +class WindowClassRegistrar { + public: + ~WindowClassRegistrar() = default; + + // Returns the singleton registrar instance. + static WindowClassRegistrar* GetInstance() { + if (!instance_) { + instance_ = new WindowClassRegistrar(); + } + return instance_; + } + + // Returns the name of the window class, registering the class if it hasn't + // previously been registered. + const wchar_t* GetWindowClass(); + + // Unregisters the window class. Should only be called if there are no + // instances of the window. + void UnregisterWindowClass(); + + private: + WindowClassRegistrar() = default; + + static WindowClassRegistrar* instance_; + + bool class_registered_ = false; +}; + +WindowClassRegistrar* WindowClassRegistrar::instance_ = nullptr; + +const wchar_t* WindowClassRegistrar::GetWindowClass() { + if (!class_registered_) { + WNDCLASS window_class{}; + window_class.hCursor = LoadCursor(nullptr, IDC_ARROW); + window_class.lpszClassName = kWindowClassName; + window_class.style = CS_HREDRAW | CS_VREDRAW; + window_class.cbClsExtra = 0; + window_class.cbWndExtra = 0; + window_class.hInstance = GetModuleHandle(nullptr); + window_class.hIcon = + LoadIcon(window_class.hInstance, MAKEINTRESOURCE(IDI_APP_ICON)); + window_class.hbrBackground = 0; + window_class.lpszMenuName = nullptr; + window_class.lpfnWndProc = Win32Window::WndProc; + RegisterClass(&window_class); + class_registered_ = true; + } + return kWindowClassName; +} + +void WindowClassRegistrar::UnregisterWindowClass() { + UnregisterClass(kWindowClassName, nullptr); + class_registered_ = false; +} + +Win32Window::Win32Window() { + ++g_active_window_count; +} + +Win32Window::~Win32Window() { + --g_active_window_count; + Destroy(); +} + +bool Win32Window::Create(const std::wstring& title, + const Point& origin, + const Size& size) { + Destroy(); + + const wchar_t* window_class = + WindowClassRegistrar::GetInstance()->GetWindowClass(); + + const POINT target_point = {static_cast(origin.x), + static_cast(origin.y)}; + HMONITOR monitor = MonitorFromPoint(target_point, MONITOR_DEFAULTTONEAREST); + UINT dpi = FlutterDesktopGetDpiForMonitor(monitor); + double scale_factor = dpi / 96.0; + + HWND window = CreateWindow( + window_class, title.c_str(), WS_OVERLAPPEDWINDOW, + Scale(origin.x, scale_factor), Scale(origin.y, scale_factor), + Scale(size.width, scale_factor), Scale(size.height, scale_factor), + nullptr, nullptr, GetModuleHandle(nullptr), this); + + if (!window) { + return false; + } + + UpdateTheme(window); + + return OnCreate(); +} + +bool Win32Window::Show() { + return ShowWindow(window_handle_, SW_SHOWNORMAL); +} + +// static +LRESULT CALLBACK Win32Window::WndProc(HWND const window, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept { + if (message == WM_NCCREATE) { + auto window_struct = reinterpret_cast(lparam); + SetWindowLongPtr(window, GWLP_USERDATA, + reinterpret_cast(window_struct->lpCreateParams)); + + auto that = static_cast(window_struct->lpCreateParams); + EnableFullDpiSupportIfAvailable(window); + that->window_handle_ = window; + } else if (Win32Window* that = GetThisFromHandle(window)) { + return that->MessageHandler(window, message, wparam, lparam); + } + + return DefWindowProc(window, message, wparam, lparam); +} + +LRESULT +Win32Window::MessageHandler(HWND hwnd, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept { + switch (message) { + case WM_DESTROY: + window_handle_ = nullptr; + Destroy(); + if (quit_on_close_) { + PostQuitMessage(0); + } + return 0; + + case WM_DPICHANGED: { + auto newRectSize = reinterpret_cast(lparam); + LONG newWidth = newRectSize->right - newRectSize->left; + LONG newHeight = newRectSize->bottom - newRectSize->top; + + SetWindowPos(hwnd, nullptr, newRectSize->left, newRectSize->top, newWidth, + newHeight, SWP_NOZORDER | SWP_NOACTIVATE); + + return 0; + } + case WM_SIZE: { + RECT rect = GetClientArea(); + if (child_content_ != nullptr) { + // Size and position the child window. + MoveWindow(child_content_, rect.left, rect.top, rect.right - rect.left, + rect.bottom - rect.top, TRUE); + } + return 0; + } + + case WM_ACTIVATE: + if (child_content_ != nullptr) { + SetFocus(child_content_); + } + return 0; + + case WM_DWMCOLORIZATIONCOLORCHANGED: + UpdateTheme(hwnd); + return 0; + } + + return DefWindowProc(window_handle_, message, wparam, lparam); +} + +void Win32Window::Destroy() { + OnDestroy(); + + if (window_handle_) { + DestroyWindow(window_handle_); + window_handle_ = nullptr; + } + if (g_active_window_count == 0) { + WindowClassRegistrar::GetInstance()->UnregisterWindowClass(); + } +} + +Win32Window* Win32Window::GetThisFromHandle(HWND const window) noexcept { + return reinterpret_cast( + GetWindowLongPtr(window, GWLP_USERDATA)); +} + +void Win32Window::SetChildContent(HWND content) { + child_content_ = content; + SetParent(content, window_handle_); + RECT frame = GetClientArea(); + + MoveWindow(content, frame.left, frame.top, frame.right - frame.left, + frame.bottom - frame.top, true); + + SetFocus(child_content_); +} + +RECT Win32Window::GetClientArea() { + RECT frame; + GetClientRect(window_handle_, &frame); + return frame; +} + +HWND Win32Window::GetHandle() { + return window_handle_; +} + +void Win32Window::SetQuitOnClose(bool quit_on_close) { + quit_on_close_ = quit_on_close; +} + +bool Win32Window::OnCreate() { + // No-op; provided for subclasses. + return true; +} + +void Win32Window::OnDestroy() { + // No-op; provided for subclasses. +} + +void Win32Window::UpdateTheme(HWND const window) { + DWORD light_mode; + DWORD light_mode_size = sizeof(light_mode); + LSTATUS result = RegGetValue(HKEY_CURRENT_USER, kGetPreferredBrightnessRegKey, + kGetPreferredBrightnessRegValue, + RRF_RT_REG_DWORD, nullptr, &light_mode, + &light_mode_size); + + if (result == ERROR_SUCCESS) { + BOOL enable_dark_mode = light_mode == 0; + DwmSetWindowAttribute(window, DWMWA_USE_IMMERSIVE_DARK_MODE, + &enable_dark_mode, sizeof(enable_dark_mode)); + } +} diff --git a/desktop/windows/runner/win32_window.h b/desktop/windows/runner/win32_window.h new file mode 100644 index 0000000..e901dde --- /dev/null +++ b/desktop/windows/runner/win32_window.h @@ -0,0 +1,102 @@ +#ifndef RUNNER_WIN32_WINDOW_H_ +#define RUNNER_WIN32_WINDOW_H_ + +#include + +#include +#include +#include + +// A class abstraction for a high DPI-aware Win32 Window. Intended to be +// inherited from by classes that wish to specialize with custom +// rendering and input handling +class Win32Window { + public: + struct Point { + unsigned int x; + unsigned int y; + Point(unsigned int x, unsigned int y) : x(x), y(y) {} + }; + + struct Size { + unsigned int width; + unsigned int height; + Size(unsigned int width, unsigned int height) + : width(width), height(height) {} + }; + + Win32Window(); + virtual ~Win32Window(); + + // Creates a win32 window with |title| that is positioned and sized using + // |origin| and |size|. New windows are created on the default monitor. Window + // sizes are specified to the OS in physical pixels, hence to ensure a + // consistent size this function will scale the inputted width and height as + // as appropriate for the default monitor. The window is invisible until + // |Show| is called. Returns true if the window was created successfully. + bool Create(const std::wstring& title, const Point& origin, const Size& size); + + // Show the current window. Returns true if the window was successfully shown. + bool Show(); + + // Release OS resources associated with window. + void Destroy(); + + // Inserts |content| into the window tree. + void SetChildContent(HWND content); + + // Returns the backing Window handle to enable clients to set icon and other + // window properties. Returns nullptr if the window has been destroyed. + HWND GetHandle(); + + // If true, closing this window will quit the application. + void SetQuitOnClose(bool quit_on_close); + + // Return a RECT representing the bounds of the current client area. + RECT GetClientArea(); + + protected: + // Processes and route salient window messages for mouse handling, + // size change and DPI. Delegates handling of these to member overloads that + // inheriting classes can handle. + virtual LRESULT MessageHandler(HWND window, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept; + + // Called when CreateAndShow is called, allowing subclass window-related + // setup. Subclasses should return false if setup fails. + virtual bool OnCreate(); + + // Called when Destroy is called. + virtual void OnDestroy(); + + private: + friend class WindowClassRegistrar; + + // OS callback called by message pump. Handles the WM_NCCREATE message which + // is passed when the non-client area is being created and enables automatic + // non-client DPI scaling so that the non-client area automatically + // responds to changes in DPI. All other messages are handled by + // MessageHandler. + static LRESULT CALLBACK WndProc(HWND const window, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept; + + // Retrieves a class instance pointer for |window| + static Win32Window* GetThisFromHandle(HWND const window) noexcept; + + // Update the window frame's theme to match the system theme. + static void UpdateTheme(HWND const window); + + bool quit_on_close_ = false; + + // window handle for top level window. + HWND window_handle_ = nullptr; + + // window handle for hosted content. + HWND child_content_ = nullptr; +}; + +#endif // RUNNER_WIN32_WINDOW_H_