16-bit char: change PropertyType.char to a 16-bit unsigned integer #70

Author: greenrobot-team

generator/lib/src/code_chunks.dart

@@ -254,7 +254,7 @@ class CodeChunks {
     OBXPropertyType.Bool: 'Bool',
     OBXPropertyType.Byte: 'Int8',
     OBXPropertyType.Short: 'Int16',
-    OBXPropertyType.Char: 'Int8',
+    OBXPropertyType.Char: 'Uint16',
     OBXPropertyType.Int: 'Int32',
     OBXPropertyType.Long: 'Int64',
     OBXPropertyType.Float: 'Float32',
@@ -433,10 +433,7 @@ class CodeChunks {
             return readListCodeString(p, "int", OBXPropertyType.Byte);
           }
         case OBXPropertyType.CharVector:
-          // OBXPropertyType.Char currently incorrectly mapped to Int8,
-          // so explicitly use Uint16Reader for now.
-          return readFieldCodeString(
-              p, "fb.ListReader<int>(fb.Uint16Reader(), lazy: false)");
+          return readListCodeString(p, "int", OBXPropertyType.Char);
         case OBXPropertyType.ShortVector:
           // FlatBuffers has Uint16ListReader, but it does not use Uint16List
           // internally. Use implementation of objectbox package.

objectbox/CHANGELOG.md

@@ -34,6 +34,8 @@
   }
   ```
   Note: for queries currently only the `isNull` and `notNull` conditions are supported.
+* Changed `PropertyType.char` from a 8-bit signed integer to a 16-bit unsigned integer to match the 
+  ObjectBox database type.
 * Fix put returning an incorrect error message in a rare case.
 * Require at least Dart SDK 2.16 (shipped with Flutter 2.10.0).
 * Let `Store.awaitQueueCompletion` actually wait on the async queue to become idle. It previously

objectbox/lib/src/annotations.dart

@@ -99,7 +99,7 @@ enum PropertyType {
   /// size: 2-bytes/16-bits
   short,
 
-  /// size: 1-byte/8-bits
+  /// Use with [Property.type] to store [int] as 2 bytes (16-bit unsigned integer).
   char,
 
   /// size: 4-bytes/32-bits

objectbox/lib/src/modelinfo/enums.dart

@@ -168,7 +168,7 @@ abstract class OBXPropertyType {
   /// < 2 bytes
   static const int Short = 3;
 
-  /// < 1 byte
+  /// < 2 bytes
   static const int Char = 4;
 
   /// < 4 bytes

objectbox/lib/src/native/query/property.dart

@@ -122,8 +122,7 @@ extension IntegerPropertyQuery on PropertyQuery<int> {
   List<int> find({int? replaceNullWith}) {
     switch (_type) {
       case OBXPropertyType.Bool:
-      case OBXPropertyType.Byte:
-      case OBXPropertyType.Char: // Int8
+      case OBXPropertyType.Byte: // Int8
         final cDefault = replaceNullWith == null
             ? null
             : (malloc<Int8>()..value = replaceNullWith);
@@ -133,6 +132,7 @@ extension IntegerPropertyQuery on PropertyQuery<int> {
             (Pointer<OBX_int8_array> cItems) =>
                 cItems.ref.items.asTypedList(cItems.ref.count).toList(),
             C.int8_array_free);
+      case OBXPropertyType.Char:
       case OBXPropertyType.Short: // Int16
         final cDefault = replaceNullWith == null
             ? null

objectbox_test/test/box_test.dart

@@ -511,26 +511,27 @@ void main() {
     final int8Max = 127;
     final int16Min = -32768;
     final int16Max = 32767;
+    final uint16Max = 65535;
     final int32Min = -2147483648;
     final int32Max = 2147483647;
     final int64Min = -9223372036854775808;
     final int64Max = 9223372036854775807;
     final List<TestEntity> items = [
-      ...[int8Min, int8Max].map((n) => TestEntity(tChar: n)).toList(),
       ...[int8Min, int8Max].map((n) => TestEntity(tByte: n)).toList(),
       ...[int16Min, int16Max].map((n) => TestEntity(tShort: n)).toList(),
+      ...[0, uint16Max].map((n) => TestEntity(tChar: n)).toList(),
       ...[int32Min, int32Max].map((n) => TestEntity(tInt: n)).toList(),
       ...[int64Min, int64Max].map((n) => TestEntity(tLong: n)).toList()
     ];
     expect('${items[8].tLong}', equals('$int64Min'));
     expect('${items[9].tLong}', equals('$int64Max'));
     final List<TestEntity?> fetchedItems = box.getMany(box.putMany(items));
-    expect(fetchedItems[0]!.tChar, equals(int8Min));
-    expect(fetchedItems[1]!.tChar, equals(int8Max));
-    expect(fetchedItems[2]!.tByte, equals(int8Min));
-    expect(fetchedItems[3]!.tByte, equals(int8Max));
-    expect(fetchedItems[4]!.tShort, equals(int16Min));
-    expect(fetchedItems[5]!.tShort, equals(int16Max));
+    expect(fetchedItems[0]!.tByte, equals(int8Min));
+    expect(fetchedItems[1]!.tByte, equals(int8Max));
+    expect(fetchedItems[2]!.tShort, equals(int16Min));
+    expect(fetchedItems[3]!.tShort, equals(int16Max));
+    expect(fetchedItems[4]!.tChar, equals(0));
+    expect(fetchedItems[5]!.tChar, equals(uint16Max));
     expect(fetchedItems[6]!.tInt, equals(int32Min));
     expect(fetchedItems[7]!.tInt, equals(int32Max));
     expect(fetchedItems[8]!.tLong, equals(int64Min));
@@ -634,7 +635,7 @@ void main() {
         tBool: true,
         tByte: 123,
         tShort: -4567,
-        tChar: 'x'.codeUnitAt(0),
+        tChar: 'Ā'.codeUnitAt(0), // U+0100
         tInt: 789012,
         tFloat: -2.71);
     final fetchedItem = box.get(box.put(item))!;
@@ -644,7 +645,7 @@ void main() {
     expect(fetchedItem.tBool, equals(true));
     expect(fetchedItem.tByte, equals(123));
     expect(fetchedItem.tShort, equals(-4567));
-    expect(fetchedItem.tChar, equals('x'.codeUnitAt(0)));
+    expect(fetchedItem.tChar, equals('Ā'.codeUnitAt(0)));
     expect(fetchedItem.tInt, equals(789012));
     expect((fetchedItem.tFloat! - (-2.71)).abs(), lessThan(0.0000001));
   });

objectbox_test/test/entity.dart

@@ -41,7 +41,7 @@ class TestEntity {
   @Property(type: PropertyType.short)
   int? tShort;
 
-  // OBXPropertyType.Char | 1 byte
+  // OBXPropertyType.Char | 16-bit unsigned integer
   @Property(type: PropertyType.char)
   int? tChar;