From d00336a1d2df80dea7bb903d772eb93bf6470310 Mon Sep 17 00:00:00 2001 From: Simon Binder Date: Tue, 15 Oct 2019 19:23:04 +0200 Subject: [PATCH 1/2] Don't use Pointer.allocate and Pointer.free Both methods will be removed in Dart 2.6 --- moor_ffi/lib/src/ffi/blob.dart | 3 ++- moor_ffi/lib/src/ffi/utils.dart | 9 +++++++++ moor_ffi/lib/src/impl/database.dart | 19 ++++++++++--------- moor_ffi/lib/src/impl/prepared_statement.dart | 2 +- moor_ffi/pubspec.yaml | 9 +++++---- 5 files changed, 27 insertions(+), 15 deletions(-) diff --git a/moor_ffi/lib/src/ffi/blob.dart b/moor_ffi/lib/src/ffi/blob.dart index 5f0d2e87..468de480 100644 --- a/moor_ffi/lib/src/ffi/blob.dart +++ b/moor_ffi/lib/src/ffi/blob.dart @@ -4,6 +4,7 @@ import 'dart:ffi'; import 'dart:typed_data'; import 'package:moor_ffi/src/ffi/utils.dart'; +import 'package:ffi/ffi.dart' as ffi; /// Pointer to arbitrary blobs in C. class CBlob extends Struct { @@ -11,7 +12,7 @@ class CBlob extends Struct { int data; static Pointer allocate(Uint8List blob) { - final str = Pointer.allocate(count: blob.length); + final str = ffi.allocate(count: blob.length); final asList = str.asExternalTypedData(count: blob.length) as Uint8List; asList.setAll(0, blob); diff --git a/moor_ffi/lib/src/ffi/utils.dart b/moor_ffi/lib/src/ffi/utils.dart index 518d5841..dbcb2dc8 100644 --- a/moor_ffi/lib/src/ffi/utils.dart +++ b/moor_ffi/lib/src/ffi/utils.dart @@ -1,3 +1,12 @@ import 'dart:ffi'; +import 'package:ffi/ffi.dart' as ffi; + bool isNullPointer(Pointer ptr) => ptr == nullptr; + +extension FreePointerExtension on Pointer { + // todo rename to "free" after https://github.com/dart-lang/sdk/issues/38860 + void $free() { + ffi.free(this); + } +} diff --git a/moor_ffi/lib/src/impl/database.dart b/moor_ffi/lib/src/impl/database.dart index 2d06e084..c38a3418 100644 --- a/moor_ffi/lib/src/impl/database.dart +++ b/moor_ffi/lib/src/impl/database.dart @@ -2,6 +2,7 @@ import 'dart:ffi'; import 'dart:io'; import 'dart:typed_data'; +import 'package:ffi/ffi.dart'; import 'package:moor_ffi/database.dart'; import 'package:moor_ffi/src/api/result.dart'; import 'package:moor_ffi/src/bindings/constants.dart'; @@ -31,15 +32,15 @@ class Database implements BaseDatabase { /// Opens an sqlite3 database from a filename. factory Database.open(String fileName) { - final dbOut = Pointer>.allocate(); + final dbOut = allocate>(); final pathC = CBlob.allocateString(fileName); final resultCode = bindings.sqlite3_open_v2(pathC, dbOut, _openingFlags, nullptr.cast()); final dbPointer = dbOut.load>(); - dbOut.free(); - pathC.free(); + dbOut.$free(); + pathC.$free(); if (resultCode == Errors.SQLITE_OK) { return Database._(dbPointer); @@ -88,15 +89,15 @@ class Database implements BaseDatabase { _ensureOpen(); final sqlPtr = CBlob.allocateString(sql); - final errorOut = Pointer>.allocate(); + final errorOut = allocate>(); final result = bindings.sqlite3_exec(_db, sqlPtr, nullptr, nullptr, errorOut); - sqlPtr.free(); + sqlPtr.$free(); final errorPtr = errorOut.load>(); - errorOut.free(); + errorOut.$free(); String errorMsg; if (!isNullPointer(errorPtr)) { @@ -114,15 +115,15 @@ class Database implements BaseDatabase { PreparedStatement prepare(String sql) { _ensureOpen(); - final stmtOut = Pointer>.allocate(); + final stmtOut = allocate>(); final sqlPtr = CBlob.allocateString(sql); final resultCode = bindings.sqlite3_prepare_v2(_db, sqlPtr, -1, stmtOut, nullptr.cast()); - sqlPtr.free(); + sqlPtr.$free(); final stmt = stmtOut.load>(); - stmtOut.free(); + stmtOut.$free(); if (resultCode != Errors.SQLITE_OK) { // we don't need to worry about freeing the statement. If preparing the diff --git a/moor_ffi/lib/src/impl/prepared_statement.dart b/moor_ffi/lib/src/impl/prepared_statement.dart index 8b6cfe6c..4805e87a 100644 --- a/moor_ffi/lib/src/impl/prepared_statement.dart +++ b/moor_ffi/lib/src/impl/prepared_statement.dart @@ -95,7 +95,7 @@ class PreparedStatement implements BasePreparedStatement { _bound = false; } for (var pointer in _allocatedWhileBinding) { - pointer.free(); + pointer.$free(); } _allocatedWhileBinding.clear(); } diff --git a/moor_ffi/pubspec.yaml b/moor_ffi/pubspec.yaml index 3d6be9d4..5d199139 100644 --- a/moor_ffi/pubspec.yaml +++ b/moor_ffi/pubspec.yaml @@ -1,15 +1,16 @@ name: moor_ffi -description: "Provides experimental sqlite bindings using dart:ffi, including a moor executor" -version: 0.0.1 +description: "Provides sqlite bindings using dart:ffi, including a moor executor" +version: 0.1.0-dev author: Simon Binder homepage: https://github.com/simolus3/moor/tree/develop/moor_ffi issue_tracker: https://github.com/simolus3/moor/issues environment: - sdk: ">=2.5.0-dev <2.6.0" + sdk: ">=2.6.0-dev <3.0.0" dependencies: - moor: ">=1.7.0 <2.1.0" + moor: ">=1.7.0 <3.0.0" + ffi: 0.1.3-dev.1 # todo replace with carret after the next dev release, then non-dev version once Dart 2.6 is out collection: ^1.0.0 dev_dependencies: From aabf565479855e7d560b7a4a50acdf97cf53a770 Mon Sep 17 00:00:00 2001 From: Simon Binder Date: Thu, 17 Oct 2019 19:00:51 +0200 Subject: [PATCH 2/2] Migrate moor_ffi to Dart 2.6 --- moor_ffi/CHANGELOG.md | 3 ++ moor_ffi/lib/src/bindings/types.dart | 6 +-- moor_ffi/lib/src/ffi/blob.dart | 50 +++++++++---------- moor_ffi/lib/src/ffi/utils.dart | 7 ++- moor_ffi/lib/src/impl/database.dart | 22 ++++---- moor_ffi/lib/src/impl/errors.dart | 4 +- moor_ffi/lib/src/impl/prepared_statement.dart | 11 ++-- moor_ffi/pubspec.yaml | 6 +-- moor_ffi/test/ffi/blob_test.dart | 5 +- 9 files changed, 55 insertions(+), 59 deletions(-) diff --git a/moor_ffi/CHANGELOG.md b/moor_ffi/CHANGELOG.md index ffc0a280..a08eb9af 100644 --- a/moor_ffi/CHANGELOG.md +++ b/moor_ffi/CHANGELOG.md @@ -1,3 +1,6 @@ +## 0.1.0-dev.1 +- Support Dart 2.6 (starting from `2.6.0-dev.8.0`) + ## 0.0.1 - Initial release. Contains standalone bindings and a moor implementation. \ No newline at end of file diff --git a/moor_ffi/lib/src/bindings/types.dart b/moor_ffi/lib/src/bindings/types.dart index dc5efb50..c4941439 100644 --- a/moor_ffi/lib/src/bindings/types.dart +++ b/moor_ffi/lib/src/bindings/types.dart @@ -15,7 +15,7 @@ import 'dart:ffi'; /// is its destructor. There are many other interfaces (such as /// [sqlite3_prepare_v2()], [sqlite3_create_function()], and /// [sqlite3_busy_timeout()] to name but three) that are methods on an -class Database extends Struct {} +class Database extends Struct {} /// SQL Statement Object /// @@ -38,7 +38,7 @@ class Database extends Struct {} /// /// Refer to documentation on individual methods above for additional /// information. -class Statement extends Struct {} +class Statement extends Struct {} /// Dynamically Typed Value Object /// @@ -74,4 +74,4 @@ class Statement extends Struct {} /// [sqlite3_result_value()] and [sqlite3_bind_value()]. /// The [sqlite3_value_blob | sqlite3_value_type()] family of /// interfaces require protected sqlite3_value objects. -class Value extends Struct {} +class Value extends Struct {} diff --git a/moor_ffi/lib/src/ffi/blob.dart b/moor_ffi/lib/src/ffi/blob.dart index 468de480..068abdb3 100644 --- a/moor_ffi/lib/src/ffi/blob.dart +++ b/moor_ffi/lib/src/ffi/blob.dart @@ -7,14 +7,11 @@ import 'package:moor_ffi/src/ffi/utils.dart'; import 'package:ffi/ffi.dart' as ffi; /// Pointer to arbitrary blobs in C. -class CBlob extends Struct { - @Uint8() - int data; - +class CBlob extends Struct { static Pointer allocate(Uint8List blob) { final str = ffi.allocate(count: blob.length); - final asList = str.asExternalTypedData(count: blob.length) as Uint8List; + final asList = str.asTypedList(blob.length); asList.setAll(0, blob); return str.cast(); @@ -28,37 +25,38 @@ class CBlob extends Struct { ..setAll(0, encoded); return CBlob.allocate(data); } +} - /// Reads [bytesToRead] bytes from the current position. - Uint8List read(int bytesToRead) { - assert(bytesToRead >= 0); - final str = addressOf.cast(); - if (isNullPointer(str)) return null; - - final data = str.asExternalTypedData(count: bytesToRead) as Uint8List; - return Uint8List.fromList(data); - } - - /// More efficient version of [readString] that doesn't have to find a nil- - /// terminator. [length] is the amount of bytes to read. The string will be - /// decoded via [utf8]. - String readAsStringWithLength(int length) { - return utf8.decode(read(length)); - } - +extension CBlobPointer on Pointer { /// Reads a 0-terminated string, decoded with utf8. /// /// Warning: This method is very, very slow. If there is any way to know the /// length of the string to read, [readAsStringWithLength] will be orders of /// magnitude faster. String readString() { - final str = addressOf; - if (isNullPointer(str)) return null; + if (isNullPointer) return null; var len = 0; - while (str.elementAt(++len).load().data != 0) {} + final asUintPointer = cast(); + while (asUintPointer[++len] != 0) {} - final units = read(len); + final units = readBytes(len); return utf8.decode(units); } + + /// More efficient version of [readString] that doesn't have to find a nil- + /// terminator. [length] is the amount of bytes to read. The string will be + /// decoded via [utf8]. + String readAsStringWithLength(int length) { + return utf8.decode(readBytes(length)); + } + + /// Reads [length] bytes from this address. + Uint8List readBytes(int length) { + assert(length >= 0); + if (isNullPointer) return null; + + final data = cast().asTypedList(length); + return Uint8List.fromList(data); + } } diff --git a/moor_ffi/lib/src/ffi/utils.dart b/moor_ffi/lib/src/ffi/utils.dart index dbcb2dc8..374ab091 100644 --- a/moor_ffi/lib/src/ffi/utils.dart +++ b/moor_ffi/lib/src/ffi/utils.dart @@ -2,11 +2,10 @@ import 'dart:ffi'; import 'package:ffi/ffi.dart' as ffi; -bool isNullPointer(Pointer ptr) => ptr == nullptr; +extension FreePointerExtension on Pointer { + bool get isNullPointer => this == nullptr; -extension FreePointerExtension on Pointer { - // todo rename to "free" after https://github.com/dart-lang/sdk/issues/38860 - void $free() { + void free() { ffi.free(this); } } diff --git a/moor_ffi/lib/src/impl/database.dart b/moor_ffi/lib/src/impl/database.dart index c38a3418..2ca07d69 100644 --- a/moor_ffi/lib/src/impl/database.dart +++ b/moor_ffi/lib/src/impl/database.dart @@ -37,10 +37,10 @@ class Database implements BaseDatabase { final resultCode = bindings.sqlite3_open_v2(pathC, dbOut, _openingFlags, nullptr.cast()); - final dbPointer = dbOut.load>(); + final dbPointer = dbOut.value; - dbOut.$free(); - pathC.$free(); + dbOut.free(); + pathC.free(); if (resultCode == Errors.SQLITE_OK) { return Database._(dbPointer); @@ -94,14 +94,14 @@ class Database implements BaseDatabase { final result = bindings.sqlite3_exec(_db, sqlPtr, nullptr, nullptr, errorOut); - sqlPtr.$free(); + sqlPtr.free(); - final errorPtr = errorOut.load>(); - errorOut.$free(); + final errorPtr = errorOut.value; + errorOut.free(); String errorMsg; - if (!isNullPointer(errorPtr)) { - errorMsg = errorPtr.load().readString(); + if (!errorPtr.isNullPointer) { + errorMsg = errorPtr.readString(); // the message was allocated from sqlite, we need to free it bindings.sqlite3_free(errorPtr.cast()); } @@ -120,10 +120,10 @@ class Database implements BaseDatabase { final resultCode = bindings.sqlite3_prepare_v2(_db, sqlPtr, -1, stmtOut, nullptr.cast()); - sqlPtr.$free(); + sqlPtr.free(); - final stmt = stmtOut.load>(); - stmtOut.$free(); + final stmt = stmtOut.value; + stmtOut.free(); if (resultCode != Errors.SQLITE_OK) { // we don't need to worry about freeing the statement. If preparing the diff --git a/moor_ffi/lib/src/impl/errors.dart b/moor_ffi/lib/src/impl/errors.dart index 10987f40..dd485947 100644 --- a/moor_ffi/lib/src/impl/errors.dart +++ b/moor_ffi/lib/src/impl/errors.dart @@ -12,11 +12,11 @@ class SqliteException implements Exception { // hold the error message string is managed internally. The application does // not need to worry about freeing the result." // https://www.sqlite.org/c3ref/errcode.html - final dbMessage = bindings.sqlite3_errmsg(db).load().readString(); + final dbMessage = bindings.sqlite3_errmsg(db).readString(); String explanation; if (code != null) { - explanation = bindings.sqlite3_errstr(code).load().readString(); + explanation = bindings.sqlite3_errstr(code).readString(); } return SqliteException(dbMessage, explanation); diff --git a/moor_ffi/lib/src/impl/prepared_statement.dart b/moor_ffi/lib/src/impl/prepared_statement.dart index 4805e87a..1ae7eda1 100644 --- a/moor_ffi/lib/src/impl/prepared_statement.dart +++ b/moor_ffi/lib/src/impl/prepared_statement.dart @@ -40,8 +40,7 @@ class PreparedStatement implements BasePreparedStatement { for (var i = 0; i < columnCount; i++) { // name pointer doesn't need to be disposed, that happens when we finalize - names[i] = - bindings.sqlite3_column_name(_stmt, i).load().readString(); + names[i] = bindings.sqlite3_column_name(_stmt, i).readString(); } while (_step() == Errors.SQLITE_ROW) { @@ -62,14 +61,10 @@ class PreparedStatement implements BasePreparedStatement { final length = bindings.sqlite3_column_bytes(_stmt, index); return bindings .sqlite3_column_text(_stmt, index) - .load() .readAsStringWithLength(length); case Types.SQLITE_BLOB: final length = bindings.sqlite3_column_bytes(_stmt, index); - return bindings - .sqlite3_column_blob(_stmt, index) - .load() - .read(length); + return bindings.sqlite3_column_blob(_stmt, index).readBytes(length); case Types.SQLITE_NULL: default: return null; @@ -95,7 +90,7 @@ class PreparedStatement implements BasePreparedStatement { _bound = false; } for (var pointer in _allocatedWhileBinding) { - pointer.$free(); + pointer.free(); } _allocatedWhileBinding.clear(); } diff --git a/moor_ffi/pubspec.yaml b/moor_ffi/pubspec.yaml index 5d199139..c8f1f261 100644 --- a/moor_ffi/pubspec.yaml +++ b/moor_ffi/pubspec.yaml @@ -1,16 +1,16 @@ name: moor_ffi description: "Provides sqlite bindings using dart:ffi, including a moor executor" -version: 0.1.0-dev +version: 0.1.0-dev.1 author: Simon Binder homepage: https://github.com/simolus3/moor/tree/develop/moor_ffi issue_tracker: https://github.com/simolus3/moor/issues environment: - sdk: ">=2.6.0-dev <3.0.0" + sdk: ">=2.6.0-dev.8.0 <3.0.0" dependencies: moor: ">=1.7.0 <3.0.0" - ffi: 0.1.3-dev.1 # todo replace with carret after the next dev release, then non-dev version once Dart 2.6 is out + ffi: ^0.1.3-dev.3 # todo non-dev version once Dart 2.6 is out collection: ^1.0.0 dev_dependencies: diff --git a/moor_ffi/test/ffi/blob_test.dart b/moor_ffi/test/ffi/blob_test.dart index ab3612aa..c8f585ea 100644 --- a/moor_ffi/test/ffi/blob_test.dart +++ b/moor_ffi/test/ffi/blob_test.dart @@ -1,5 +1,6 @@ import 'package:moor/moor.dart'; import 'package:moor_ffi/src/ffi/blob.dart'; +import 'package:moor_ffi/src/ffi/utils.dart'; import 'package:test/test.dart'; void main() { @@ -7,7 +8,7 @@ void main() { final content = 'Hasta Mañana'; final blob = CBlob.allocateString(content); - expect(blob.load().readString(), content); + expect(blob.readString(), content); blob.free(); }); @@ -15,7 +16,7 @@ void main() { final data = List.generate(256, (x) => x); final blob = CBlob.allocate(Uint8List.fromList(data)); - expect(blob.load().read(256), data); + expect(blob.readBytes(256), data); blob.free(); }); }