pkgs/ffigen/test/native_objc_test/global_test.dart

// Copyright (c) 2024, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.

// Objective C support is only available on mac.
@TestOn('mac-os')
import 'dart:ffi';
import 'dart:io';

import 'package:ffi/ffi.dart';
import 'package:objective_c/objective_c.dart';
import 'package:path/path.dart' as path;
import 'package:test/test.dart';

import '../test_utils.dart';
import 'global_test_bindings.dart';
import 'util.dart';

void main() {
  late GlobalTestObjCLibrary lib;
  group('global', () {
    setUpAll(() {
      lib = GlobalTestObjCLibrary(DynamicLibrary.open(findDylib("objc_test")));
    });

    test('Global string', () {
      expect(lib.globalString.toDartString(), 'Hello World');
      lib.globalString = 'Something else'.toNSString();
      expect(lib.globalString.toDartString(), 'Something else');
      lib.globalString = 'Hello World'.toNSString();
    });

    @pragma('vm:never-inline')
    ReferenceTracker globalObjectRefCountingInner(Arena arena) {
      final obj = NSObject();
      final globalObjectTracker = ReferenceTracker(arena);
      globalObjectTracker.track(obj);
      lib.globalObject = obj;
      expect(globalObjectTracker.isAlive, true);
      return globalObjectTracker;
    }

    test('Global object ref counting', () {
      using((Arena arena) {
        final globalObjectTracker = globalObjectRefCountingInner(arena);
        expect(globalObjectTracker.isAlive, true);
        lib.globalObject = null;
        doGC();
        expect(globalObjectTracker.isAlive, false);
      });
    }, skip: !canDoGC);

    test('Global block', () {
      lib.globalBlock = ObjCBlock_Int32_Int32.fromFunction((int x) => x * 10);
      expect(lib.globalBlock!(123), 1230);
      lib.globalBlock = ObjCBlock_Int32_Int32.fromFunction((int x) => x + 1000);
      expect(lib.globalBlock!(456), 1456);
    });

    @pragma('vm:never-inline')
    (ReferenceTracker, ReferenceTracker) globalBlockRefCountingInner(
      Arena arena,
    ) {
      final blk1Tracker = ReferenceTracker(arena);
      final blk1 = ObjCBlock_Int32_Int32.fromFunction((int x) => x * 10);
      blk1Tracker.trackBlock(blk1);
      lib.globalBlock = blk1;
      expect(blk1Tracker.isAlive, true);

      final blk2Tracker = ReferenceTracker(arena);
      final blk2 = ObjCBlock_Int32_Int32.fromFunction((int x) => x + 1000);
      blk2Tracker.trackBlock(blk2);
      lib.globalBlock = blk2;

      expect(blk2Tracker.isAlive, true);
      expect(blk1Tracker.isAlive, true);

      expect(blk1, isNotNull);
      expect(blk2, isNotNull);

      return (blk1Tracker, blk2Tracker);
    }

    test('Global block ref counting', () {
      using((Arena arena) {
        final (blk1Tracker, blk2Tracker) = globalBlockRefCountingInner(arena);
        doGC();

        expect(blk2Tracker.isAlive, true);
        expect(blk1Tracker.isAlive, false);

        lib.globalBlock = null;
        doGC();
        expect(blk2Tracker.isAlive, false);
        expect(blk1Tracker.isAlive, false);
      });
    }, skip: !canDoGC);
  });
}