Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions dartdoc_options.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
dartdoc:
warnings:
- unresolved-doc-reference
ignore:
- ambiguous-reexport
3 changes: 2 additions & 1 deletion lib/10.0/tizen.dart
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
library tizen_interop;
/// Tizen Interop for Tizen 10.0.
library tizen_interop_10_0;

import 'dart:ffi';

Expand Down
10 changes: 5 additions & 5 deletions lib/6.0/tizen.dart
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
library tizen_interop;
/// Tizen Interop for Tizen 6.0.
library tizen_interop_6_0;

import 'dart:ffi';

Expand Down Expand Up @@ -126,8 +127,7 @@ export '../../src/bindings/6.0/generated_bindings_appcore_agent.dart';
export '../../src/bindings/6.0/generated_bindings_asp.dart';
export '../../src/bindings/6.0/generated_bindings_badge.dart';
export '../../src/bindings/6.0/generated_bindings_bundle.dart';
export '../../src/bindings/6.0/generated_bindings_calendar_service2.dart'
hide UnnamedUnion1, UnnamedStruct1;
export '../../src/bindings/6.0/generated_bindings_calendar_service2.dart';
export '../../src/bindings/6.0/generated_bindings_capi_appfw_alarm.dart';
export '../../src/bindings/6.0/generated_bindings_capi_appfw_app_common.dart';
export '../../src/bindings/6.0/generated_bindings_capi_appfw_app_control.dart';
Expand Down Expand Up @@ -229,8 +229,6 @@ export '../../src/bindings/6.0/generated_bindings_storage.dart';
export '../../src/bindings/6.0/generated_bindings_stt.dart';
export '../../src/bindings/6.0/generated_bindings_stt_engine.dart';
export '../../src/bindings/6.0/generated_bindings_tbm.dart';
export '../../src/bindings/6.0/generated_bindings_time.dart'
hide UnnamedUnion1, UnnamedStruct1;
export '../../src/bindings/6.0/generated_bindings_ttrace.dart';
export '../../src/bindings/6.0/generated_bindings_tts.dart';
export '../../src/bindings/6.0/generated_bindings_tts_engine.dart';
Expand All @@ -240,6 +238,8 @@ export '../../src/bindings/6.0/generated_bindings_vc_engine.dart';
export '../../src/bindings/6.0/generated_bindings_vc_manager.dart';
export '../../src/bindings/6.0/generated_bindings_wifi_direct.dart';
export '../../src/bindings/6.0/generated_bindings_yaca.dart';
export '../../src/bindings/6.0/generated_bindings_time.dart'
hide UnnamedUnion1, UnnamedStruct1;

final _lookupProvider = LookupProvider();

Expand Down
7 changes: 4 additions & 3 deletions lib/6.5/tizen.dart
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
library tizen_interop;
/// Tizen Interop for Tizen 6.5.
library tizen_interop_6_5;

import 'dart:ffi';

Expand Down Expand Up @@ -238,8 +239,6 @@ export '../../src/bindings/6.5/generated_bindings_storage.dart';
export '../../src/bindings/6.5/generated_bindings_stt.dart';
export '../../src/bindings/6.5/generated_bindings_stt_engine.dart';
export '../../src/bindings/6.5/generated_bindings_tbm.dart';
export '../../src/bindings/6.5/generated_bindings_time.dart'
hide UnnamedUnion1, UnnamedStruct1;
export '../../src/bindings/6.5/generated_bindings_ttrace.dart';
export '../../src/bindings/6.5/generated_bindings_tts.dart';
export '../../src/bindings/6.5/generated_bindings_tts_engine.dart';
Expand All @@ -249,6 +248,8 @@ export '../../src/bindings/6.5/generated_bindings_vc_engine.dart';
export '../../src/bindings/6.5/generated_bindings_vc_manager.dart';
export '../../src/bindings/6.5/generated_bindings_wifi_direct.dart';
export '../../src/bindings/6.5/generated_bindings_yaca.dart';
export '../../src/bindings/6.5/generated_bindings_time.dart'
hide UnnamedUnion1, UnnamedStruct1;

final _lookupProvider = LookupProvider();

Expand Down
3 changes: 2 additions & 1 deletion lib/7.0/tizen.dart
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
library tizen_interop;
/// Tizen Interop for Tizen 7.0.
library tizen_interop_7_0;

import 'dart:ffi';

Expand Down
3 changes: 2 additions & 1 deletion lib/8.0/tizen.dart
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
library tizen_interop;
/// Tizen Interop for Tizen 8.0.
library tizen_interop_8_0;

import 'dart:ffi';

Expand Down
3 changes: 2 additions & 1 deletion lib/9.0/tizen.dart
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
library tizen_interop;
/// Tizen Interop for Tizen 9.0.
library tizen_interop_9_0;

import 'dart:ffi';

Expand Down
4 changes: 4 additions & 0 deletions lib/src/extensions.dart
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import 'dart:ffi';

import 'package:ffi/ffi.dart';

/// @nodoc
extension Int8Pointer on Pointer<Int8> {
int get length => cast<Utf8>().length;

Expand All @@ -14,12 +15,14 @@ extension Int8Pointer on Pointer<Int8> {
}
}

/// @nodoc
extension StringInt8Pointer on String {
Pointer<Int8> toNativeInt8({Allocator allocator = malloc}) {
return toNativeUtf8(allocator: allocator).cast<Int8>();
}
}

/// @nodoc
extension CharPointer on Pointer<Char> {
int get length => cast<Utf8>().length;

Expand All @@ -28,6 +31,7 @@ extension CharPointer on Pointer<Char> {
}
}

/// @nodoc
extension StringCharPointer on String {
Pointer<Char> toNativeChar({Allocator allocator = malloc}) {
return toNativeUtf8(allocator: allocator).cast<Char>();
Expand Down
1 change: 1 addition & 0 deletions pubspec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,6 @@ dependencies:
dev_dependencies:
ffigen: ^11.0.0
lints: ^3.0.0
path: ^1.9.1
symgen:
path: packages/symgen
28 changes: 18 additions & 10 deletions scripts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,24 @@
(see `CallbackDataCollector.type_substitute()` and maps used there: `KNOWN_TYPES`, `SPECIAL_TYPES`).
* Run `./generate_callbacks.sh` to update `callbacks.cc` with callbacks data.

8. Convert Doxygen-style comments into Dartdoc format for the generated bindings:

```sh
dart run ./scripts/convert_description.dart <version>
```

This script will automatically process all `generated_bindings_*.dart` files inside the `lib/src/bindings/<version>` directory.

## Generating documentation

The `generate_doc_script.py` script generates markdown API documentation for all supported Tizen versions. It scans the `configs` directory and creates or overwrites `doc/tizen<version>_api.md` for each version.

Run the script with:

```sh
python3 scripts/generate_doc_script.py
```

## Handling Type Duplication Issues

When splitting single binding code into library-specific binding codes from version 0.5.2 onwards, type duplication issues may occur between binding codes. Here are common issues and their solutions:
Expand Down Expand Up @@ -154,13 +172,3 @@ type-map:
export '../../src/bindings/6.0/generated_bindings_capi_media_camera.dart'
hide UnnamedUnion1, UnnamedStruct1;
```

## Generating documentation

The `generate_doc_script.py` script generates markdown API documentation for all supported Tizen versions. It scans the `configs` directory and creates or overwrites `doc/tizen<version>_api.md` for each version.

Run the script with:

```sh
python3 scripts/generate_doc_script.py
```
Loading
Loading