Initial native implementation of FS methods

Author: dvd-bnc

.gitignore

@@ -44,3 +44,6 @@ app.*.map.json
 /android/app/debug
 /android/app/profile
 /android/app/release
+
+**/zig-out
+**/.zig-cache

.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+
+        {
+            "name": "files",
+            "request": "launch",
+            "type": "dart",
+            "args": ["--enable-experiment=native-assets"]
+        },
+        {
+            "name": "files (profile mode)",
+            "request": "launch",
+            "type": "dart",
+            "flutterMode": "profile",
+            "args": ["--enable-experiment=native-assets"]
+        },
+        {
+            "name": "files (release mode)",
+            "request": "launch",
+            "type": "dart",
+            "flutterMode": "release",
+            "args": ["--enable-experiment=native-assets"]
+        }
+    ]
+}

hook/build.dart

@@ -0,0 +1,17 @@
+import 'package:code_assets/code_assets.dart';
+import 'package:hooks/hooks.dart';
+
+void main(List<String> args) async {
+  await build(args, (input, output) async {
+    final targetOS = input.config.code.targetOS;
+    if (targetOS != OS.linux) return;
+
+    output.assets.code.add(
+      CodeAsset(
+        package: input.packageName,
+        name: 'libfs.dart',
+        linkMode: DynamicLoadingSystem(Uri.file('src/zig-out/lib/libfs.so')),
+      ),
+    );
+  });
+}

ios/Flutter/ephemeral/flutter_lldb_helper.py

@@ -0,0 +1,32 @@
+#
+# Generated file, do not edit.
+#
+
+import lldb
+
+def handle_new_rx_page(frame: lldb.SBFrame, bp_loc, extra_args, intern_dict):
+    """Intercept NOTIFY_DEBUGGER_ABOUT_RX_PAGES and touch the pages."""
+    base = frame.register["x0"].GetValueAsAddress()
+    page_len = frame.register["x1"].GetValueAsUnsigned()
+
+    # Note: NOTIFY_DEBUGGER_ABOUT_RX_PAGES will check contents of the
+    # first page to see if handled it correctly. This makes diagnosing
+    # misconfiguration (e.g. missing breakpoint) easier.
+    data = bytearray(page_len)
+    data[0:8] = b'IHELPED!'
+
+    error = lldb.SBError()
+    frame.GetThread().GetProcess().WriteMemory(base, data, error)
+    if not error.Success():
+        print(f'Failed to write into {base}[+{page_len}]', error)
+        return
+
+def __lldb_init_module(debugger: lldb.SBDebugger, _):
+    target = debugger.GetDummyTarget()
+    # Caveat: must use BreakpointCreateByRegEx here and not
+    # BreakpointCreateByName. For some reasons callback function does not
+    # get carried over from dummy target for the later.
+    bp = target.BreakpointCreateByRegex("^NOTIFY_DEBUGGER_ABOUT_RX_PAGES$")
+    bp.SetScriptCallbackFunction('{}.handle_new_rx_page'.format(__name__))
+    bp.SetAutoContinue(True)
+    print("-- LLDB integration loaded --")

ios/Flutter/ephemeral/flutter_lldbinit

@@ -0,0 +1,5 @@
+#
+# Generated file, do not edit.
+#
+
+command script import --relative-to-command-file flutter_lldb_helper.py

lib/backend/database/helper.dart

@@ -1,16 +1,17 @@
-import 'dart:io';
-
 import 'package:files/backend/database/model.dart';
+import 'package:files/backend/fs.dart' as fs;
 import 'package:files/backend/providers.dart';
+import 'package:isar_community/isar.dart';
 
 class EntityStatCacheHelper {
   Future<EntityStat> get(String path) async {
     final stat = isar.entityStats.where().pathEqualTo(path).findFirstSync();
 
     if (stat == null) {
-      final fetchedStat = EntityStat.fromStat(
+      final file = fs.File.fromPath(path);
+      final fetchedStat = EntityStat.fromFileInfo(
         path,
-        await FileStat.stat(path),
+        await file.queryInfo().result,
       );
       await set(fetchedStat);
       return fetchedStat;

lib/backend/database/model.dart

@@ -1,19 +1,52 @@
-import 'dart:io';
-
+import 'package:files/backend/fs.dart' as fs;
 import 'package:files/backend/providers.dart';
 import 'package:flutter/foundation.dart';
-import 'package:isar/isar.dart';
-
-export 'package:isar/isar.dart';
+import 'package:isar_community/isar.dart';
 
 part 'model.g.dart';
 
+typedef _FileInfoSnapshot = ({
+  DateTime changed,
+  DateTime modified,
+  DateTime accessed,
+  EntityType type,
+  int mode,
+  int size,
+});
+
+_FileInfoSnapshot _getSnapshotForInfo(fs.FileInfo info) {
+  final attributes = info.listAttributes()!;
+
+  assert(attributes.contains('standard::type'));
+  // assert(attributes.contains('time::modified'));
+  // assert(attributes.contains('time::access'));
+  // assert(attributes.contains('time::created'));
+  assert(attributes.contains('standard::size'));
+
+  final defaultTime = DateTime.fromMillisecondsSinceEpoch(0);
+
+  return (
+    changed: info.getCreationTime() ?? defaultTime,
+    modified: info.getModificationTime() ?? defaultTime,
+    accessed: info.getAccessTime() ?? defaultTime,
+    type: switch (info.getFileType()) {
+      1 || 4 || 5 => EntityType.file,
+      2 || 6 => EntityType.directory,
+      3 => EntityType.link,
+      final t => throw ArgumentError.value(t),
+    },
+    mode: 0, // TODO
+    size: info.getSize(),
+  );
+}
+
 @Collection()
 class EntityStat with ChangeNotifier {
   EntityStat();
 
   EntityStat.fastInit({
     required this.path,
+    required this.info,
     required this.changed,
     required this.modified,
     required this.accessed,
@@ -22,21 +55,29 @@ class EntityStat with ChangeNotifier {
     required this.size,
   });
 
-  EntityStat.fromStat(String path, FileStat stat)
-      : this.fastInit(
-          path: path,
-          changed: stat.changed,
-          modified: stat.modified,
-          accessed: stat.accessed,
-          type: EntityType.fromDartIo(stat.type),
-          mode: stat.mode,
-          size: stat.size,
-        );
+  factory EntityStat.fromFileInfo(String path, fs.FileInfo info) {
+    final snapshot = _getSnapshotForInfo(info);
+
+    return EntityStat.fastInit(
+      path: path,
+      info: info,
+      changed: snapshot.changed,
+      modified: snapshot.modified,
+      accessed: snapshot.accessed,
+      type: snapshot.type,
+      mode: snapshot.mode,
+      size: snapshot.size,
+    );
+  }
+
   Id? id;
 
   @Index(unique: true, type: IndexType.hash)
   late String path;
 
+  @Ignore()
+  late fs.FileInfo info;
+
   late DateTime changed;
   late DateTime modified;
   late DateTime accessed;
@@ -47,60 +88,30 @@ class EntityStat with ChangeNotifier {
   late int size;
 
   Future<void> fetchUpdate() async {
-    final ioStat = await FileStat.stat(path);
-
-    if (!_statIdentical(ioStat)) {
-      changed = ioStat.changed;
-      modified = ioStat.modified;
-      accessed = ioStat.accessed;
-      type = EntityType.fromDartIo(ioStat.type);
-      mode = ioStat.mode;
-      size = ioStat.size;
+    final file = fs.File.fromPath(path);
+    final info = await file.queryInfo().result;
+    final snapshot = _getSnapshotForInfo(info);
+
+    if (!_infoIdentical(snapshot)) {
+      changed = snapshot.changed;
+      modified = snapshot.modified;
+      accessed = snapshot.accessed;
+      type = snapshot.type;
+      mode = snapshot.mode;
+      size = snapshot.size;
       await helper.set(this);
       notifyListeners();
     }
   }
 
-  bool _statIdentical(FileStat other) {
+  bool _infoIdentical(_FileInfoSnapshot other) {
     return changed == other.changed &&
         modified == other.modified &&
         accessed == other.accessed &&
-        type == EntityType.fromDartIo(other.type) &&
+        type == other.type &&
         mode == other.mode &&
         size == other.size;
   }
 }
 
-enum EntityType {
-  file,
-  directory,
-  link,
-  notFound;
-
-  static EntityType fromDartIo(FileSystemEntityType type) {
-    switch (type) {
-      case FileSystemEntityType.file:
-        return EntityType.file;
-      case FileSystemEntityType.directory:
-        return EntityType.directory;
-      case FileSystemEntityType.link:
-        return EntityType.link;
-      case FileSystemEntityType.notFound:
-      default:
-        return EntityType.notFound;
-    }
-  }
-
-  FileSystemEntityType get toDartIo {
-    switch (this) {
-      case EntityType.file:
-        return FileSystemEntityType.file;
-      case EntityType.directory:
-        return FileSystemEntityType.directory;
-      case EntityType.link:
-        return FileSystemEntityType.link;
-      case EntityType.notFound:
-        return FileSystemEntityType.notFound;
-    }
-  }
-}
+enum EntityType { file, directory, link, notFound }