Migrate from manual bindings to auto generated bindings by ffigen package (#84)

* add ffigen to dependencies

* use bindings by ffigen

* dart format --fix -l 120 .

* manual edit bindings

* add struct packed config

* dart format --fix -l 120 .

* fix codecov ignore

* bump version

* Update pointer_int8.dart

* private dylib

Author: sensuikan1973

.codecov.yml

@@ -32,4 +32,4 @@ comment: # See: https://docs.codecov.io/docs/pull-request-comments
   require_head: true
 
 ignore: # See: https://docs.codecov.io/docs/ignoring-paths
-  - lib/src/ffi/bindings/structs
+  - lib/src/ffi/bindings.dart

CHANGELOG.md

@@ -1,3 +1,7 @@
+# 2.0.0
+
+- [internal migration] Migrate from manual bindings to auto generated bindings by ffigen package.
+
 # 1.5.0
 
 - delete deprecated functions.

README.md

@@ -81,6 +81,13 @@ dartdoc && open doc/api/index.html
 libedax_build_command="make libbuild ARCH=x64-modern COMP=gcc OS=osx" dst="." ./scripts/build_libedax.sh
 ```
 
+#### generate bindings
+
+```sh
+# Before this, you must run build_libedax.sh
+pub run ffigen --config ffigen.yaml --verbose severe
+```
+
 ### reference
 
 - [dart:ffi](https://dart.dev/guides/libraries/c-interop)

analysis_options.yaml

@@ -2,4 +2,4 @@ include: package:pedantic_sensuikan1973/analysis_options.yaml
 
 analyzer:
   exclude:
-    - lib/src/ffi/bindings/structs
+    - lib/src/ffi/bindings.dart

example/pubspec.lock

@@ -91,7 +91,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "1.5.0"
+    version: "2.0.0"
   meta:
     dependency: transitive
     description:

example/pubspec.yaml

@@ -1,5 +1,5 @@
 name: libedax4dart_example
-version: 1.5.0-example
+version: 2.0.0-example
 publish_to: none
 
 environment:

ffigen.yaml

@@ -0,0 +1,56 @@
+# See: https://pub.dev/packages/ffigen#configurations
+name: 'LibEdaxBindings'
+description: 'bindings to libedax'
+output: 'lib/src/ffi/bindings.dart'
+sort: true
+headers:
+  entry-points:
+    - './edax-reversi/src/all.c'
+structs:
+  pack:
+    # See: https://github.com/sensuikan1973/libedax4dart/pull/74#issuecomment-890427516
+    # See: https://github.com/dart-lang/sdk/issues/46644
+    'sockaddr_storage': 1
+functions:
+  include:
+    - 'bit_count'
+    - 'edax_book_count_bestpath'
+    - 'edax_book_load'
+    - 'edax_book_new'
+    - 'edax_book_off'
+    - 'edax_book_on'
+    - 'edax_book_randomness'
+    - 'edax_book_show'
+    - 'edax_book_stop_count_bestpath'
+    - 'edax_can_move'
+    - 'edax_get_board'
+    - 'edax_get_bookmove_with_position_by_moves'
+    - 'edax_get_bookmove_with_position'
+    - 'edax_get_bookmove'
+    - 'edax_get_current_player'
+    - 'edax_get_disc'
+    - 'edax_get_last_move'
+    - 'edax_get_mobility_count'
+    - 'edax_get_moves'
+    - 'edax_go'
+    - 'edax_hint_next_no_multipv_depth'
+    - 'edax_hint_next'
+    - 'edax_hint_prepare'
+    - 'edax_hint'
+    - 'edax_init'
+    - 'edax_is_game_over'
+    - 'edax_mode'
+    - 'edax_move'
+    - 'edax_new'
+    - 'edax_opening'
+    - 'edax_play'
+    - 'edax_redo'
+    - 'edax_rotate'
+    - 'edax_set_option'
+    - 'edax_setboard'
+    - 'edax_stop'
+    - 'edax_undo'
+    - 'edax_version'
+    - 'edax_vmirror'
+    - 'libedax_initialize'
+    - 'libedax_terminate'

lib/extensions/pointer_int8.dart

@@ -0,0 +1,10 @@
+// See: https://github.com/dart-lang/ffigen/issues/72
+
+import 'dart:ffi';
+
+import 'package:ffi/ffi.dart';
+
+extension Int8PointerString on Pointer<Int8> {
+  // See: https://pub.dev/packages/ffigen#how-does-ffigen-handle-c-strings
+  String toStr() => cast<Utf8>().toDartString();
+}

lib/extensions/string.dart

@@ -0,0 +1,9 @@
+// See: https://github.com/dart-lang/ffigen/issues/72
+
+import 'dart:ffi';
+
+import 'package:ffi/ffi.dart';
+
+extension Int8Pointer on String {
+  Pointer<Int8> toInt8Pointer() => toNativeUtf8().cast<Int8>();
+}

lib/src/board.dart

@@ -1,15 +1,15 @@
 import 'package:meta/meta.dart';
 
 import 'constants.dart';
-import 'ffi/bindings/structs/board.dart' as c_board;
+import 'ffi/bindings.dart' as bindings;
 import 'util.dart';
 
 @immutable
 class Board {
   const Board(this.player, this.opponent);
 
   /// initialize from C struct
-  Board.fromCStruct(final c_board.Board cBoard)
+  Board.fromCStruct(final bindings.Board cBoard)
       : player = cBoard.player,
         opponent = cBoard.opponent;