nullsafety hints and minor refactorings

Author: vaind

objectbox/lib/src/bindings/bindings.dart

@@ -58,7 +58,7 @@ void initializeDartAPI() {
   if (_dartAPIinitialized == null) {
     final errCode = C.dartc_init_api(NativeApi.initializeApiDLData);
     _dartAPIinitialized = (OBX_SUCCESS == errCode);
-    if (!_dartAPIinitialized) {
+    if (!_dartAPIinitialized /*!*/) {
       _dartAPIinitException = latestNativeError(
           codeIfMissing: errCode,
           dartMsg: "Dart/Flutter SDK you're using is not compatible with "

objectbox/lib/src/bindings/flatbuffers.dart

@@ -45,7 +45,7 @@ class BuilderWithCBuffer {
 typedef _dart_memset = void Function(Pointer<Uint8>, int, int);
 typedef _c_memset = Void Function(Pointer<Uint8>, Int32, IntPtr);
 
-_dart_memset fbMemset;
+_dart_memset /*?*/ fbMemset;
 
 class Allocator extends fb.Allocator {
   // We may, in practice, have only two active allocations: one used and one
@@ -76,7 +76,7 @@ class Allocator extends fb.Allocator {
     final index = _flipIndex();
     _allocs[index] = f.allocate<Uint8>(count: size);
     _data[index] = ByteData.view(_allocs[index].asTypedList(size).buffer);
-    return _data[index];
+    return _data[index] /*!*/;
   }
 
   @override
@@ -119,7 +119,7 @@ class Allocator extends fb.Allocator {
     assert(_data[_index] == data);
     assert(_allocs[_index].address != 0);
 
-    fbMemset(_allocs[_index], 0, data.lengthInBytes);
+    fbMemset /*!*/ (_allocs[_index], 0, data.lengthInBytes);
   }
 
   void freeAll() {

objectbox/lib/src/bindings/helpers.dart

@@ -24,7 +24,7 @@ bool checkObxSuccess(int code) {
 }
 
 Pointer<T> checkObxPtr<T extends NativeType>(Pointer<T> /*?*/ ptr,
-    [String dartMsg]) {
+    [String /*?*/ dartMsg]) {
   if (ptr == null || ptr.address == 0) {
     throw latestNativeError(dartMsg: dartMsg);
   }
@@ -156,3 +156,16 @@ class CursorHelper<T> {
     return _entity.objectFromFB(_store, readData);
   }
 }
+
+T withNativeBytes<T>(
+    Uint8List data, T Function(Pointer<Void> ptr, int size) fn) {
+  final size = data.length;
+  assert(size == data.lengthInBytes);
+  final ptr = allocate<Uint8>(count: size);
+  try {
+    ptr.asTypedList(size).setAll(0, data); // copies `data` to `ptr`
+    return fn(ptr.cast<Void>(), size);
+  } finally {
+    free(ptr);
+  }
+}

objectbox/lib/src/bindings/structs.dart

@@ -1,9 +1,7 @@
 import 'dart:ffi';
-import 'dart:typed_data' show Uint8List;
 
 import 'package:ffi/ffi.dart' show allocate, free, Utf8;
 
-import '../common.dart';
 import 'bindings.dart';
 
 // ignore_for_file: public_member_api_docs
@@ -31,56 +29,6 @@ R executeWithIdArray<R>(List<int> items, R Function(Pointer<OBX_id_array>) fn) {
   }
 }
 
-class OBX_bytes_wrapper {
-  final Pointer<OBX_bytes> _cBytes;
-
-  int get size => _cBytes == nullptr ? 0 : _cBytes.ref.size;
-
-  Uint8List get data => safeDataAccess(_cBytes);
-
-  /// Get access to the data (no-copy)
-  static Uint8List safeDataAccess(Pointer<OBX_bytes> /*?*/ cBytes) =>
-      cBytes == null || cBytes.address == 0 || cBytes.ref.size == 0
-          ? throw ObjectBoxException(
-              dartMsg: "can't access data of empty OBX_bytes")
-          : cBytes.ref.data.cast<Uint8>().asTypedList(cBytes.ref.size);
-
-  bool get isEmpty => size == 0;
-
-  Pointer<Void> get ptr => _cBytes.ref.data;
-
-  /// Returns a pointer to OBX_bytes with copy of the passed data.
-  /// Warning: this creates two unmanaged pointers which must be freed manually:
-  /// [freeManaged()].
-  /// ObjectBox requires object data to be aligned to the length of 4.
-  OBX_bytes_wrapper.managedCopyOf(Uint8List data, {/*required*/ bool align})
-      : _cBytes = allocate<OBX_bytes>() {
-    final bytes = _cBytes.ref;
-
-    bytes.size = align ? ((data.length + 3.0) ~/ 4.0) * 4 : data.length;
-
-    // NOTE: currently there's no way to get access to the underlying memory of
-    // Uint8List to avoid a copy.
-    // See https://github.com/dart-lang/ffi/issues/27
-    // if (data.length == bytes.length) {
-    //   bytes._dataPtr = data.some-way-to-get-the-underlying-memory-pointer
-    //   return ptr;
-    // }
-
-    // create a copy of the data
-    bytes.data = allocate<Uint8>(count: bytes.size).cast<Void>();
-    for (var i = 0; i < data.length; ++i) {
-      bytes.data.cast<Uint8>()[i] = data[i];
-    }
-  }
-
-  /// Free a dart-created OBX_bytes pointer.
-  void freeManaged() {
-    free(_cBytes.ref.data);
-    free(_cBytes);
-  }
-}
-
 class OBX_string_array_wrapper {
   final Pointer<OBX_string_array> _cPtr;
 

objectbox/lib/src/box.dart

@@ -104,7 +104,7 @@ class Box<T> {
     final newId = C.box_put_object4(
         _cBox, _builder.bufPtr, _builder.fbb.size, _getOBXPutMode(mode));
     id = _handlePutObjectResult(object, id, newId);
-    if (_hasToManyRelations) _putToManyRelFields(object, mode, tx);
+    if (_hasToManyRelations) _putToManyRelFields(object, mode, tx /*!*/);
     _builder.resetIfLarge();
     return id;
   }
@@ -170,7 +170,8 @@ class Box<T> {
   ///
   /// Pass growableResult: true for the resulting list to be growable.
   List<T /*?*/ > getMany(List<int> ids, {bool growableResult = false}) {
-    final result = List<T>.filled(ids.length, null, growable: growableResult);
+    final result =
+        List<T /*?*/ >.filled(ids.length, null, growable: growableResult);
     if (ids.isEmpty) return result;
     final tx = Transaction(_store, TxMode.read);
     try {

objectbox/lib/src/common.dart

@@ -61,7 +61,7 @@ class ObjectBoxException implements Exception {
       if (nativeCode != 0 || nativeMsg != null) result += ': ';
     }
     if (nativeCode != 0) result += '$nativeCode ';
-    if (nativeMsg != null) result += nativeMsg;
+    if (nativeMsg != null) result += nativeMsg /*!*/;
     return result.trimRight();
   }
 }

objectbox/lib/src/modelinfo/modelbacklink.dart

@@ -11,8 +11,8 @@ class ModelBacklink {
   ModelBacklink(this.name, this.srcEntity, this.srcField);
 
   ModelBacklink.fromMap(Map<String, dynamic> data)
-      : this(data['name'] as String, data['srcEntity'] as String,
-            data['srcField'] as String);
+      : this(data['name'] as String /*!*/, data['srcEntity'] as String /*!*/,
+            data['srcField'] as String /*!*/);
 
   Map<String, String> toMap() =>
       {'name': name, 'srcEntity': srcEntity, 'srcField': srcField};

objectbox/lib/src/modelinfo/modelentity.dart

@@ -66,7 +66,7 @@ class ModelEntity {
         id = IdUid.fromString(data['id'] as String),
         lastPropertyId = IdUid.fromString(data['lastPropertyId'] as String) {
     name = data['name'] as String;
-    flags = data['flags'] as int ?? 0;
+    flags = data['flags'] as int /*?*/ ?? 0;
 
     if (data['properties'] == null) throw Exception('properties is null');
     for (final p in data['properties']) {
@@ -169,7 +169,7 @@ class ModelEntity {
   ModelProperty /*?*/ findSameProperty(ModelProperty other) {
     ModelProperty /*?*/ ret;
     if (other.id.uid != 0) ret = _findPropertyByUid(other.id.uid);
-    return ret ??= findPropertyByName(other.name);
+    return ret ?? findPropertyByName(other.name);
   }
 
   ModelProperty createProperty(String name, [int uid = 0]) {
@@ -197,7 +197,7 @@ class ModelEntity {
     model.retiredPropertyUids.add(prop.id.uid);
 
     if (prop.indexId != null) {
-      model.retiredIndexUids.add(prop.indexId.uid);
+      model.retiredIndexUids.add(prop.indexId /*!*/ .uid);
     }
   }
 
@@ -221,7 +221,7 @@ class ModelEntity {
   ModelRelation /*?*/ findSameRelation(ModelRelation other) {
     ModelRelation /*?*/ ret;
     if (other.id.uid != 0) ret = _findRelationByUid(other.id.uid);
-    return ret ??= _findRelationByName(other.name);
+    return ret ?? _findRelationByName(other.name);
   }
 
   ModelRelation createRelation(String name, [int uid = 0]) {

objectbox/lib/src/modelinfo/modelinfo.dart

@@ -177,8 +177,7 @@ class ModelInfo {
   ModelEntity /*?*/ findSameEntity(ModelEntity other) {
     ModelEntity /*?*/ ret;
     if (other.id.uid != 0) ret = findEntityByUid(other.id.uid);
-    ret ??= findEntityByName(other.name);
-    return ret;
+    return ret ?? findEntityByName(other.name);
   }
 
   ModelEntity createEntity(String name, [int uid = 0]) {

objectbox/lib/src/observable.dart

@@ -12,7 +12,7 @@ import 'store.dart';
 /// Simple wrapper used below in ObservableStore to reduce code duplication.
 /// Contains shared code for single-entity observer and the generic/global one.
 class _Observer<StreamValueType> {
-  StreamController<StreamValueType> /*?*/ controller;
+  /*late final*/ StreamController<StreamValueType> controller;
   Pointer<OBX_observer> /*?*/ _cObserver;
   ReceivePort /*?*/ receivePort;
 
@@ -23,7 +23,7 @@ class _Observer<StreamValueType> {
     _debugLog('started');
   }
 
-  Stream<StreamValueType> get stream => controller /*!*/ .stream;
+  Stream<StreamValueType> get stream => controller.stream;
 
   _Observer() {
     initializeDartAPI();