Skip to content

Commit cb14754

Browse files
authored
[ffigen] Better typedefs for NativeFunctions (dart-lang#621)
* Fix dart-lang#614 * Update test expectations * Hacky fix * Refactor * Fix analysis * Fix analysis * Fix analysis
1 parent f3b2369 commit cb14754

10 files changed

Lines changed: 111 additions & 54 deletions

File tree

‎pkgs/ffigen/CHANGELOG.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
- Fix return_of_invalid_type analysis error for ObjCBlocks.
77
- Fix crash in ObjC methods and blocks that return structs by value.
88
- Fix ObjC methods returning instancetype having the wrong type in sublasses.
9+
- When generating typedefs for `Pointer<NativeFunction<Function>>`, also
10+
generate a typedef for the `Function`.
911
- Bump min SDK version to 3.2.0-114.0.dev.
1012

1113
# 9.0.1

‎pkgs/ffigen/example/libclang-example/generated_bindings.dart‎

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9747,10 +9747,10 @@ typedef DartClang_getIBOutletCollectionType = CXType Function(CXCursor arg0);
97479747
///
97489748
/// The visitor should return one of the \c CXChildVisitResult values
97499749
/// to direct clang_visitCursorChildren().
9750-
typedef CXCursorVisitor = ffi.Pointer<
9751-
ffi.NativeFunction<
9752-
ffi.Int32 Function(
9753-
CXCursor cursor, CXCursor parent, CXClientData client_data)>>;
9750+
typedef CXCursorVisitor
9751+
= ffi.Pointer<ffi.NativeFunction<CXCursorVisitor_function>>;
9752+
typedef CXCursorVisitor_function = ffi.Int32 Function(
9753+
CXCursor cursor, CXCursor parent, CXClientData client_data);
97549754

97559755
/// Describes how the traversal of the children of a particular
97569756
/// cursor should proceed after visiting a particular child cursor.
@@ -10425,13 +10425,13 @@ typedef DartClang_toggleCrashRecovery = void Function(int isEnabled);
1042510425
/// the second and third arguments provide the inclusion stack. The
1042610426
/// array is sorted in order of immediate inclusion. For example,
1042710427
/// the first element refers to the location that included 'included_file'.
10428-
typedef CXInclusionVisitor = ffi.Pointer<
10429-
ffi.NativeFunction<
10430-
ffi.Void Function(
10431-
CXFile included_file,
10432-
ffi.Pointer<CXSourceLocation> inclusion_stack,
10433-
ffi.UnsignedInt include_len,
10434-
CXClientData client_data)>>;
10428+
typedef CXInclusionVisitor
10429+
= ffi.Pointer<ffi.NativeFunction<CXInclusionVisitor_function>>;
10430+
typedef CXInclusionVisitor_function = ffi.Void Function(
10431+
CXFile included_file,
10432+
ffi.Pointer<CXSourceLocation> inclusion_stack,
10433+
ffi.UnsignedInt include_len,
10434+
CXClientData client_data);
1043510435
typedef NativeClang_getInclusions = ffi.Void Function(
1043610436
CXTranslationUnit tu, CXInclusionVisitor visitor, CXClientData client_data);
1043710437
typedef DartClang_getInclusions = void Function(
@@ -11103,9 +11103,10 @@ typedef DartClang_indexLoc_getCXSourceLocation = CXSourceLocation Function(
1110311103
///
1110411104
/// The visitor should return one of the \c CXVisitorResult values
1110511105
/// to direct \c clang_Type_visitFields.
11106-
typedef CXFieldVisitor = ffi.Pointer<
11107-
ffi
11108-
.NativeFunction<ffi.Int32 Function(CXCursor C, CXClientData client_data)>>;
11106+
typedef CXFieldVisitor
11107+
= ffi.Pointer<ffi.NativeFunction<CXFieldVisitor_function>>;
11108+
typedef CXFieldVisitor_function = ffi.Int32 Function(
11109+
CXCursor C, CXClientData client_data);
1110911110
typedef NativeClang_Type_visitFields = ffi.UnsignedInt Function(
1111011111
CXType T, CXFieldVisitor visitor, CXClientData client_data);
1111111112
typedef DartClang_Type_visitFields = int Function(

‎pkgs/ffigen/lib/src/code_generator/func_type.dart‎

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -113,26 +113,35 @@ class FunctionType extends Type {
113113

114114
/// Represents a NativeFunction<Function>.
115115
class NativeFunc extends Type {
116-
final FunctionType type;
116+
// Either a FunctionType or a Typealias of a FunctionType.
117+
final Type _type;
117118

118-
NativeFunc(this.type);
119+
NativeFunc(this._type) {
120+
assert(_type is FunctionType || _type is Typealias);
121+
}
122+
123+
FunctionType get type {
124+
if (_type is Typealias) {
125+
return _type.typealiasType as FunctionType;
126+
}
127+
return _type as FunctionType;
128+
}
119129

120130
@override
121131
void addDependencies(Set<Binding> dependencies) {
122-
type.addDependencies(dependencies);
132+
_type.addDependencies(dependencies);
123133
}
124134

125135
@override
126136
String getCType(Writer w) =>
127-
'${w.ffiLibraryPrefix}.NativeFunction<${type.getCType(w)}>';
137+
'${w.ffiLibraryPrefix}.NativeFunction<${_type.getCType(w)}>';
128138

129139
@override
130-
String getDartType(Writer w) =>
131-
'${w.ffiLibraryPrefix}.NativeFunction<${type.getCType(w)}>';
140+
String getDartType(Writer w) => getCType(w);
132141

133142
@override
134-
String toString() => 'NativeFunction<${type.toString()}>';
143+
String toString() => 'NativeFunction<${_type.toString()}>';
135144

136145
@override
137-
String cacheKey() => 'NatFn(${type.cacheKey()})';
146+
String cacheKey() => 'NatFn(${_type.cacheKey()})';
138147
}

‎pkgs/ffigen/lib/src/code_generator/typealias.dart‎

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,47 @@ class Typealias extends BindingType {
1818
final Type type;
1919
final bool _useDartType;
2020

21-
Typealias({
21+
factory Typealias({
2222
String? usr,
2323
String? originalName,
2424
String? dartDoc,
2525
required String name,
26-
required this.type,
26+
required Type type,
2727

2828
/// If true, the binding string uses Dart type instead of C type.
2929
///
3030
/// E.g if C type is ffi.Void func(ffi.Int32), Dart type is void func(int).
3131
bool useDartType = false,
3232
bool isInternal = false,
33+
}) {
34+
final funcType = _getFunctionTypeFromPointer(type);
35+
if (funcType != null) {
36+
type = PointerType(NativeFunc(Typealias._(
37+
name: '${name}_function',
38+
type: funcType,
39+
useDartType: useDartType,
40+
isInternal: isInternal,
41+
)));
42+
}
43+
return Typealias._(
44+
usr: usr,
45+
originalName: originalName,
46+
dartDoc: dartDoc,
47+
name: name,
48+
type: type,
49+
useDartType: useDartType,
50+
isInternal: isInternal,
51+
);
52+
}
53+
54+
Typealias._({
55+
String? usr,
56+
String? originalName,
57+
String? dartDoc,
58+
required String name,
59+
required this.type,
60+
bool useDartType = false,
61+
bool isInternal = false,
3362
}) : _useDartType = useDartType,
3463
super(
3564
usr: usr,
@@ -47,6 +76,13 @@ class Typealias extends BindingType {
4776
type.addDependencies(dependencies);
4877
}
4978

79+
static FunctionType? _getFunctionTypeFromPointer(Type type) {
80+
if (type is! PointerType) return null;
81+
final pointee = type.child;
82+
if (pointee is! NativeFunc) return null;
83+
return pointee.type;
84+
}
85+
5086
@override
5187
BindingString toBindingString(Writer w) {
5288
final sb = StringBuffer();

‎pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_dart_handle_bindings.dart‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,8 @@ class NativeLibrary {
6868
late final _func4 = _func4Ptr.asFunction<void Function(Typedef1)>();
6969
}
7070

71-
typedef Typedef1
72-
= ffi.Pointer<ffi.NativeFunction<ffi.Void Function(ffi.Handle)>>;
71+
typedef Typedef1 = ffi.Pointer<ffi.NativeFunction<Typedef1_function>>;
72+
typedef Typedef1_function = ffi.Void Function(ffi.Handle);
7373

7474
final class Struct1 extends ffi.Opaque {}
7575

‎pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_native_func_typedef_bindings.dart‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,11 +73,16 @@ final class Struct extends ffi.Struct {
7373
}
7474

7575
typedef WithTypedefReturnType
76-
= ffi.Pointer<ffi.NativeFunction<InsideReturnType Function()>>;
77-
typedef InsideReturnType = ffi.Pointer<ffi.NativeFunction<ffi.Void Function()>>;
76+
= ffi.Pointer<ffi.NativeFunction<WithTypedefReturnType_function>>;
77+
typedef WithTypedefReturnType_function = InsideReturnType Function();
78+
typedef InsideReturnType
79+
= ffi.Pointer<ffi.NativeFunction<InsideReturnType_function>>;
80+
typedef InsideReturnType_function = ffi.Void Function();
7881

7982
final class Struct2 extends ffi.Struct {
8083
external VoidFuncPointer constFuncPointer;
8184
}
8285

83-
typedef VoidFuncPointer = ffi.Pointer<ffi.NativeFunction<ffi.Void Function()>>;
86+
typedef VoidFuncPointer
87+
= ffi.Pointer<ffi.NativeFunction<VoidFuncPointer_function>>;
88+
typedef VoidFuncPointer_function = ffi.Void Function();

‎pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_struct_fptr_fields_bindings.dart‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,4 +69,5 @@ final class S extends ffi.Struct {
6969
}
7070

7171
typedef ArithmeticOperation
72-
= ffi.Pointer<ffi.NativeFunction<ffi.Int Function(ffi.Int a, ffi.Int b)>>;
72+
= ffi.Pointer<ffi.NativeFunction<ArithmeticOperation_function>>;
73+
typedef ArithmeticOperation_function = ffi.Int Function(ffi.Int a, ffi.Int b);

‎pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_typedef_bindings.dart‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,8 @@ final class Struct1 extends ffi.Struct {
9292
}
9393

9494
typedef NamedFunctionProto
95-
= ffi.Pointer<ffi.NativeFunction<ffi.Void Function()>>;
95+
= ffi.Pointer<ffi.NativeFunction<NamedFunctionProto_function>>;
96+
typedef NamedFunctionProto_function = ffi.Void Function();
9697

9798
final class AnonymousStructInTypedef extends ffi.Opaque {}
9899

‎pkgs/ffigen/test/large_integration_tests/_expected_libclang_bindings.dart‎

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7430,10 +7430,10 @@ abstract class CXChildVisitResult {
74307430
}
74317431

74327432
/// Visitor invoked for each cursor found by a traversal.
7433-
typedef CXCursorVisitor = ffi.Pointer<
7434-
ffi.NativeFunction<
7435-
ffi.Int32 Function(
7436-
CXCursor cursor, CXCursor parent, CXClientData client_data)>>;
7433+
typedef CXCursorVisitor
7434+
= ffi.Pointer<ffi.NativeFunction<CXCursorVisitor_function>>;
7435+
typedef CXCursorVisitor_function = ffi.Int32 Function(
7436+
CXCursor cursor, CXCursor parent, CXClientData client_data);
74377437

74387438
/// Opaque pointer representing client data that will be passed through to
74397439
/// various callbacks and visitors.
@@ -7761,13 +7761,13 @@ abstract class CXCompletionContext {
77617761

77627762
/// Visitor invoked for each file in a translation unit (used with
77637763
/// clang_getInclusions()).
7764-
typedef CXInclusionVisitor = ffi.Pointer<
7765-
ffi.NativeFunction<
7766-
ffi.Void Function(
7767-
CXFile included_file,
7768-
ffi.Pointer<CXSourceLocation> inclusion_stack,
7769-
ffi.UnsignedInt include_len,
7770-
CXClientData client_data)>>;
7764+
typedef CXInclusionVisitor
7765+
= ffi.Pointer<ffi.NativeFunction<CXInclusionVisitor_function>>;
7766+
typedef CXInclusionVisitor_function = ffi.Void Function(
7767+
CXFile included_file,
7768+
ffi.Pointer<CXSourceLocation> inclusion_stack,
7769+
ffi.UnsignedInt include_len,
7770+
CXClientData client_data);
77717771

77727772
abstract class CXEvalResultKind {
77737773
static const int CXEval_Int = 1;
@@ -8224,9 +8224,10 @@ abstract class CXIndexOptFlags {
82248224
}
82258225

82268226
/// Visitor invoked for each field found by a traversal.
8227-
typedef CXFieldVisitor = ffi.Pointer<
8228-
ffi
8229-
.NativeFunction<ffi.Int32 Function(CXCursor C, CXClientData client_data)>>;
8227+
typedef CXFieldVisitor
8228+
= ffi.Pointer<ffi.NativeFunction<CXFieldVisitor_function>>;
8229+
typedef CXFieldVisitor_function = ffi.Int32 Function(
8230+
CXCursor C, CXClientData client_data);
82308231

82318232
const int CINDEX_VERSION_MAJOR = 0;
82328233

‎pkgs/ffigen/test/large_integration_tests/_expected_sqlite_bindings.dart‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10855,7 +10855,8 @@ final class sqlite3_vfs extends ffi.Struct {
1085510855
typedef sqlite3_int64 = sqlite_int64;
1085610856
typedef sqlite_int64 = ffi.LongLong;
1085710857
typedef sqlite3_syscall_ptr
10858-
= ffi.Pointer<ffi.NativeFunction<ffi.Void Function()>>;
10858+
= ffi.Pointer<ffi.NativeFunction<sqlite3_syscall_ptr_function>>;
10859+
typedef sqlite3_syscall_ptr_function = ffi.Void Function();
1085910860

1086010861
final class sqlite3_mem_methods extends ffi.Struct {
1086110862
/// Memory allocation function
@@ -12008,14 +12009,14 @@ final class fts5_api extends ffi.Struct {
1200812009
xDestroy)>> xCreateFunction;
1200912010
}
1201012011

12011-
typedef fts5_extension_function = ffi.Pointer<
12012-
ffi.NativeFunction<
12013-
ffi.Void Function(
12014-
ffi.Pointer<Fts5ExtensionApi> pApi,
12015-
ffi.Pointer<Fts5Context> pFts,
12016-
ffi.Pointer<sqlite3_context> pCtx,
12017-
ffi.Int nVal,
12018-
ffi.Pointer<ffi.Pointer<sqlite3_value>> apVal)>>;
12012+
typedef fts5_extension_function
12013+
= ffi.Pointer<ffi.NativeFunction<fts5_extension_function_function>>;
12014+
typedef fts5_extension_function_function = ffi.Void Function(
12015+
ffi.Pointer<Fts5ExtensionApi> pApi,
12016+
ffi.Pointer<Fts5Context> pFts,
12017+
ffi.Pointer<sqlite3_context> pCtx,
12018+
ffi.Int nVal,
12019+
ffi.Pointer<ffi.Pointer<sqlite3_value>> apVal);
1201912020

1202012021
const String SQLITE_VERSION = '3.32.3';
1202112022

0 commit comments

Comments
 (0)