Siklos/libgit2dart
1
0
Fork 0
mirror of https://github.com/SkinnyMind/libgit2dart.git synced 2025-05-05 04:39:07 -04:00
Code Issues Projects Releases Wiki Activity

refactor!: use Finalizer to automatically free allocated memory for objects (#48)

Browse source 
BREAKING CHANGE: signature change for remote and repository callbacks during repository clone operation.
This commit is contained in:
Aleksey Kulikov 2022-04-28 11:04:48 +03:00 • committed by GitHub
parent 94c40f9a94
commit a3213a88a2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
103 changed files with 2278 additions and 2595 deletions
Download patch file Download diff file Expand all files Collapse all files

45
lib/src/tree.dart
View file

@ -7,18 +7,17 @@ import 'package:libgit2dart/src/bindings/tree.dart' as bindings;
class Tree {
/// Initializes a new instance of [Tree] class from provided pointer to
/// tree object in memory.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
Tree(this._treePointer);
Tree(this._treePointer) {
_finalizer.attach(this, _treePointer, detach: this);
}
/// Lookups a tree object for provided [oid] in a [repo]sitory.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
Tree.lookup({required Repository repo, required Oid oid}) {
_treePointer = bindings.lookup(
repoPointer: repo.pointer,
oidPointer: oid.pointer,
);
_finalizer.attach(this, _treePointer, detach: this);
}
late final Pointer<git_tree> _treePointer;
@ -63,7 +62,7 @@ class Tree {
),
);
} else if (value is String && value.contains('/')) {
return TreeEntry(
return TreeEntry._byPath(
bindings.getByPath(
rootPointer: _treePointer,
path: value,
@ -90,7 +89,10 @@ class Tree {
int get length => bindings.entryCount(_treePointer);
/// Releases memory allocated for tree object.
void free() => bindings.free(_treePointer);
void free() {
bindings.free(_treePointer);
_finalizer.detach(this);
}
@override
String toString() {
@ -98,10 +100,24 @@ class Tree {
}
}
// coverage:ignore-start
final _finalizer = Finalizer<Pointer<git_tree>>(
(pointer) => bindings.free(pointer),
);
// coverage:ignore-end
class TreeEntry {
/// Initializes a new instance of [TreeEntry] class from provided pointer to
/// tree entry object in memory.
const TreeEntry(this._treeEntryPointer);
TreeEntry(this._treeEntryPointer);
/// Initializes a new instance of [TreeEntry] class from provided pointer to
/// tree entry object in memory.
///
/// Unlike the other lookup methods, must be freed.
TreeEntry._byPath(this._treeEntryPointer) {
_entryFinalizer.attach(this, _treeEntryPointer, detach: this);
}
/// Pointer to memory address for allocated tree entry object.
final Pointer<git_tree_entry> _treeEntryPointer;
@ -119,8 +135,19 @@ class TreeEntry {
}
/// Releases memory allocated for tree entry object.
void free() => bindings.entryFree(_treeEntryPointer);
///
/// **IMPORTANT**: Only tree entries looked up by path should be freed.
void free() {
bindings.entryFree(_treeEntryPointer);
_entryFinalizer.detach(this);
}
@override
String toString() => 'TreeEntry{oid: $oid, name: $name, filemode: $filemode}';
}
// coverage:ignore-start
final _entryFinalizer = Finalizer<Pointer<git_tree_entry>>(
(pointer) => bindings.entryFree(pointer),
);
// coverage:ignore-end