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

refactor!: use Finalizer to automatically free allocated memory for objects

Browse source 
BREAKING CHANGE: signature change for remote and repository callbacks
during repository clone operation.
This commit is contained in:
Aleksey Kulikov 2022-04-21 14:07:11 +03:00
parent 94c40f9a94
commit b589097c8c
73 changed files with 1073 additions and 1618 deletions
Download patch file Download diff file Expand all files Collapse all files

23
lib/src/annotated.dart
View file

@ -14,20 +14,17 @@ class AnnotatedCommit {
/// It is preferable to use [AnnotatedCommit.fromReference] instead of this
/// one, for commit to contain more information about how it was looked up.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
AnnotatedCommit.lookup({required Repository repo, required Oid oid}) {
_annotatedCommitPointer = bindings.lookup(
repoPointer: repo.pointer,
oidPointer: oid.pointer,
);
_finalizer.attach(this, _annotatedCommitPointer, detach: this);
}
/// Creates an annotated commit from the given [reference].
///
/// **IMPORTANT**: Should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
AnnotatedCommit.fromReference({
required Repository repo,
@ -37,6 +34,7 @@ class AnnotatedCommit {
repoPointer: repo.pointer,
referencePointer: reference.pointer,
);
_finalizer.attach(this, _annotatedCommitPointer, detach: this);
}
/// Creates an annotated commit from a revision string.
@ -44,8 +42,6 @@ class AnnotatedCommit {
/// See `man gitrevisions`, or http://git-scm.com/docs/git-rev-parse.html#_specifying_revisions
/// for information on the syntax accepted.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
AnnotatedCommit.fromRevSpec({
required Repository repo,
@ -55,6 +51,7 @@ class AnnotatedCommit {
repoPointer: repo.pointer,
revspec: spec,
);
_finalizer.attach(this, _annotatedCommitPointer, detach: this);
}
/// Creates an annotated commit from the given fetch head data.
@ -67,8 +64,6 @@ class AnnotatedCommit {
///
/// [oid] is the commit object id of the remote branch.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
AnnotatedCommit.fromFetchHead({
required Repository repo,
@ -82,6 +77,7 @@ class AnnotatedCommit {
remoteUrl: remoteUrl,
oid: oid.pointer,
);
_finalizer.attach(this, _annotatedCommitPointer, detach: this);
}
late final Pointer<git_annotated_commit> _annotatedCommitPointer;
@ -98,5 +94,14 @@ class AnnotatedCommit {
String get refName => bindings.refName(_annotatedCommitPointer);
/// Releases memory allocated for commit object.
void free() => bindings.free(_annotatedCommitPointer);
void free() {
bindings.free(_annotatedCommitPointer);
_finalizer.detach(this);
}
}
// coverage:ignore-start
final _finalizer = Finalizer<Pointer<git_annotated_commit>>(
(pointer) => bindings.free(pointer),
);
// coverage:ignore-end

8
lib/src/bindings/config.dart
View file

@ -281,3 +281,11 @@ void deleteMultivar({
/// Free the configuration and its associated memory and files.
void free(Pointer<git_config> cfg) => libgit2.git_config_free(cfg);
/// Free a config entry.
void freeEntry(Pointer<git_config_entry> entry) =>
libgit2.git_config_entry_free(entry);
/// Free a config iterator.
void freeIterator(Pointer<git_config_iterator> iter) =>
libgit2.git_config_iterator_free(iter);

3
lib/src/bindings/odb.dart
View file

@ -78,8 +78,7 @@ int _forEachCb(
Pointer<git_oid> oid,
Pointer<Void> payload,
) {
final _oid = oid_bindings.copy(oid);
_objects.add(Oid(_oid));
_objects.add(Oid(oid_bindings.copy(oid)));
return 0;
}

56
lib/src/bindings/remote_callbacks.dart
View file

@ -5,6 +5,7 @@ import 'package:libgit2dart/libgit2dart.dart';
import 'package:libgit2dart/src/bindings/credentials.dart'
as credentials_bindings;
import 'package:libgit2dart/src/bindings/libgit2_bindings.dart';
import 'package:libgit2dart/src/bindings/remote.dart' as remote_bindings;
import 'package:libgit2dart/src/util.dart';
class RemoteCallbacks {
@ -65,11 +66,9 @@ class RemoteCallbacks {
return 0;
}
/// A function matching the
/// `Remote Function(Repository repo, String name, String url)` signature to
/// override the remote creation and customization process during a clone
/// operation.
static Remote Function(Repository, String, String)? remoteFunction;
/// Values used to override the remote creation and customization process
/// during a clone operation.
static RemoteCallback? remoteCbData;
/// A callback used to create the git remote, prior to its being used to
/// perform the clone operation.
@ -80,19 +79,31 @@ class RemoteCallbacks {
Pointer<Int8> url,
Pointer<Void> payload,
) {
remote[0] = remoteFunction!(
Repository(repo),
name.cast<Utf8>().toDartString(),
url.cast<Utf8>().toDartString(),
).pointer;
late final Pointer<git_remote> remotePointer;
if (remoteCbData!.fetch == null) {
remotePointer = remote_bindings.create(
repoPointer: repo,
name: remoteCbData!.name,
url: remoteCbData!.url,
);
} else {
remotePointer = remote_bindings.createWithFetchSpec(
repoPointer: repo,
name: remoteCbData!.name,
url: remoteCbData!.url,
fetch: remoteCbData!.fetch!,
);
}
remote[0] = remotePointer;
return 0;
}
/// A function matching the `Repository Function(String path, bool bare)`
/// signature to override the repository creation and customization process
/// Values used to override the repository creation and customization process
/// during a clone operation.
static Repository Function(String, bool)? repositoryFunction;
static RepositoryCallback? repositoryCbData;
/// A callback used to create the new repository into which to clone.
static int repositoryCb(
@ -101,11 +112,20 @@ class RemoteCallbacks {
int bare,
Pointer<Void> payload,
) {
repo[0] = repositoryFunction!(
path.cast<Utf8>().toDartString(),
bare == 1 || false,
final repoPointer = Repository.init(
path: repositoryCbData!.path,
bare: repositoryCbData!.bare,
flags: repositoryCbData!.flags,
mode: repositoryCbData!.mode,
workdirPath: repositoryCbData!.workdirPath,
description: repositoryCbData!.description,
templatePath: repositoryCbData!.templatePath,
initialHead: repositoryCbData!.initialHead,
originUrl: repositoryCbData!.originUrl,
).pointer;
repo[0] = repoPointer;
return 0;
}
@ -236,8 +256,8 @@ class RemoteCallbacks {
sidebandProgress = null;
updateTips = null;
pushUpdateReference = null;
remoteFunction = null;
repositoryFunction = null;
remoteCbData = null;
repositoryCbData = null;
credentials = null;
}
}

13
lib/src/bindings/repository.dart
View file

@ -113,8 +113,9 @@ Pointer<git_repository> clone({
required String url,
required String localPath,
required bool bare,
Remote Function(Repository, String, String)? remote,
Repository Function(String, bool)? repository,
RemoteCallback? remoteCallback,
// Repository Function(String, bool)? repository,
RepositoryCallback? repositoryCallback,
String? checkoutBranch,
required Callbacks callbacks,
}) {
@ -138,14 +139,14 @@ Pointer<git_repository> clone({
const except = -1;
git_remote_create_cb remoteCb = nullptr;
if (remote != null) {
RemoteCallbacks.remoteFunction = remote;
if (remoteCallback != null) {
RemoteCallbacks.remoteCbData = remoteCallback;
remoteCb = Pointer.fromFunction(RemoteCallbacks.remoteCb, except);
}
git_repository_create_cb repositoryCb = nullptr;
if (repository != null) {
RemoteCallbacks.repositoryFunction = repository;
if (repositoryCallback != null) {
RemoteCallbacks.repositoryCbData = repositoryCallback;
repositoryCb = Pointer.fromFunction(RemoteCallbacks.repositoryCb, except);
}

9
lib/src/bindings/signature.dart
View file

@ -64,5 +64,14 @@ Pointer<git_signature> defaultSignature(Pointer<git_repository> repo) {
return out.value;
}
/// Create a copy of an existing signature.
Pointer<git_signature> duplicate(Pointer<git_signature> sig) {
final out = calloc<Pointer<git_signature>>();
libgit2.git_signature_dup(out, sig);
final result = out.value;
calloc.free(out);
return result;
}
/// Free an existing signature.
void free(Pointer<git_signature> sig) => libgit2.git_signature_free(sig);

6
lib/src/bindings/tag.dart
View file

@ -77,8 +77,10 @@ String name(Pointer<git_tag> tag) =>
libgit2.git_tag_name(tag).cast<Utf8>().toDartString();
/// Get the message of a tag.
String message(Pointer<git_tag> tag) =>
libgit2.git_tag_message(tag).cast<Utf8>().toDartString();
String message(Pointer<git_tag> tag) {
final result = libgit2.git_tag_message(tag);
return result == nullptr ? '' : result.cast<Utf8>().toDartString();
}
/// Get the tagger (author) of a tag.
Pointer<git_signature> tagger(Pointer<git_tag> tag) =>

15
lib/src/blame.dart
View file

@ -34,8 +34,6 @@ class Blame with IterableMixin<BlameHunk> {
/// [maxLine] is the last line in the file to blame. The default is the last
/// line of the file.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
Blame.file({
required Repository repo,
@ -57,6 +55,7 @@ class Blame with IterableMixin<BlameHunk> {
minLine: minLine,
maxLine: maxLine,
);
_finalizer.attach(this, _blamePointer, detach: this);
}
/// Returns blame data for a file that has been modified in memory. The
@ -74,6 +73,7 @@ class Blame with IterableMixin<BlameHunk> {
reference: reference._blamePointer,
buffer: buffer,
);
_finalizer.attach(this, _blamePointer, detach: this);
}
/// Pointer to memory address for allocated blame object.
@ -105,12 +105,21 @@ class Blame with IterableMixin<BlameHunk> {
}
/// Releases memory allocated for blame object.
void free() => bindings.free(_blamePointer);
void free() {
bindings.free(_blamePointer);
_finalizer.detach(this);
}
@override
Iterator<BlameHunk> get iterator => _BlameIterator(_blamePointer);
}
// coverage:ignore-start
final _finalizer = Finalizer<Pointer<git_blame>>(
(pointer) => bindings.free(pointer),
);
// coverage:ignore-end
class BlameHunk {
/// Initializes a new instance of the [BlameHunk] class from
/// provided pointer to blame hunk object in memory.

22
lib/src/blob.dart
View file

@ -7,18 +7,17 @@ import 'package:libgit2dart/src/bindings/libgit2_bindings.dart';
class Blob {
/// Initializes a new instance of [Blob] class from provided pointer to
/// blob object in memory.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
Blob(this._blobPointer);
Blob(this._blobPointer) {
_finalizer.attach(this, _blobPointer, detach: this);
}
/// Lookups a blob object for provided [oid] in a [repo]sitory.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
Blob.lookup({required Repository repo, required Oid oid}) {
_blobPointer = bindings.lookup(
repoPointer: repo.pointer,
oidPointer: oid.pointer,
);
_finalizer.attach(this, _blobPointer, detach: this);
}
late final Pointer<git_blob> _blobPointer;
@ -80,8 +79,6 @@ class Blob {
int get size => bindings.size(_blobPointer);
/// Creates an in-memory copy of a blob.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
Blob duplicate() => Blob(bindings.duplicate(_blobPointer));
/// Returns filtered content of a blob.
@ -114,10 +111,19 @@ class Blob {
}
/// Releases memory allocated for blob object.
void free() => bindings.free(_blobPointer);
void free() {
bindings.free(_blobPointer);
_finalizer.detach(this);
}
@override
String toString() {
return 'Blob{oid: $oid, isBinary: $isBinary, size: $size}';
}
}
// coverage:ignore-start
final _finalizer = Finalizer<Pointer<git_blob>>(
(pointer) => bindings.free(pointer),
);
// coverage:ignore-end

31
lib/src/branch.dart
View file

@ -8,9 +8,9 @@ import 'package:libgit2dart/src/bindings/reference.dart' as reference_bindings;
class Branch {
/// Initializes a new instance of [Branch] class from provided pointer to
/// branch object in memory.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
Branch(this._branchPointer);
Branch(this._branchPointer) {
_finalizer.attach(this, _branchPointer, detach: this);
}
/// Creates a new branch pointing at a [target] commit.
///
@ -24,8 +24,6 @@ class Branch {
/// [target] is the commit to which this branch should point. This object must
/// belong to the given [repo].
///
/// **IMPORTANT**: Should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
Branch.create({
required Repository repo,
@ -39,6 +37,7 @@ class Branch {
targetPointer: target.pointer,
force: force,
);
_finalizer.attach(this, _branchPointer, detach: this);
}
/// Lookups a branch by its [name] and [type] in a [repo]sitory. Lookups in
@ -49,8 +48,6 @@ class Branch {
/// If branch [type] is [GitBranch.remote] you must include the remote name
/// in the [name] (e.g. "origin/master").
///
/// **IMPORTANT**: Should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
Branch.lookup({
required Repository repo,
@ -62,6 +59,7 @@ class Branch {
branchName: name,
branchType: type.value,
);
_finalizer.attach(this, _branchPointer, detach: this);
}
late final Pointer<git_reference> _branchPointer;
@ -72,9 +70,6 @@ class Branch {
/// Returns a list of branches that can be found in a [repo]sitory for
/// provided [type]. Default is all branches (local and remote).
///
/// **IMPORTANT**: Branches must be freed manually when no longer needed to
/// prevent memory leak.
///
/// Throws a [LibGit2Error] if error occured.
static List<Branch> list({
required Repository repo,
@ -94,7 +89,6 @@ class Branch {
static void delete({required Repository repo, required String name}) {
final branch = Branch.lookup(repo: repo, name: name);
bindings.delete(branch.pointer);
branch.free();
}
/// Renames an existing local branch reference with provided [oldName].
@ -117,8 +111,6 @@ class Branch {
newBranchName: newName,
force: force,
);
branch.free();
}
/// [Oid] pointed to by a branch.
@ -164,8 +156,6 @@ class Branch {
/// Upstream [Reference] of a local branch.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
Reference get upstream => Reference(bindings.getUpstream(_branchPointer));
@ -222,7 +212,10 @@ class Branch {
}
/// Releases memory allocated for branch object.
void free() => bindings.free(_branchPointer);
void free() {
bindings.free(_branchPointer);
_finalizer.detach(this);
}
@override
String toString() {
@ -230,3 +223,9 @@ class Branch {
'isCheckedOut: $isCheckedOut}';
}
}
// coverage:ignore-start
final _finalizer = Finalizer<Pointer<git_reference>>(
(pointer) => bindings.free(pointer),
);
// coverage:ignore-end

1
lib/src/checkout.dart
View file

@ -116,7 +116,6 @@ class Checkout {
);
object_bindings.free(treeish);
ref.free();
}
/// Updates files in the working tree to match the content of the tree

32
lib/src/commit.dart
View file

@ -8,18 +8,17 @@ import 'package:libgit2dart/src/bindings/libgit2_bindings.dart';
class Commit {
/// Initializes a new instance of [Commit] class from provided pointer to
/// commit object in memory.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
Commit(this._commitPointer);
Commit(this._commitPointer) {
_finalizer.attach(this, _commitPointer, detach: this);
}
/// Lookups commit object for provided [oid] in the [repo]sitory.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
Commit.lookup({required Repository repo, required Oid oid}) {
_commitPointer = bindings.lookup(
repoPointer: repo.pointer,
oidPointer: oid.pointer,
);
_finalizer.attach(this, _commitPointer, detach: this);
}
late final Pointer<git_commit> _commitPointer;
@ -194,8 +193,6 @@ class Commit {
///
/// [mainline] is parent of the commit if it is a merge (i.e. 1, 2).
///
/// **IMPORTANT**: produced index should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
Index revertTo({
required Commit commit,
@ -221,7 +218,7 @@ class Commit {
/// leading newlines.
String get message => bindings.message(_commitPointer);
/// Returns the short "summary" of the git commit message.
/// Short "summary" of the git commit message.
///
/// The returned message is the summary of the commit, comprising the first
/// paragraph of the message with whitespace trimmed and squashed.
@ -229,7 +226,7 @@ class Commit {
/// Throws a [LibGit2Error] if error occured.
String get summary => bindings.summary(_commitPointer);
/// Returns the long "body" of the commit message.
/// Long "body" of the commit message.
///
/// The returned message is the body of the commit, comprising everything but
/// the first paragraph of the message. Leading and trailing whitespaces are
@ -272,8 +269,6 @@ class Commit {
/// Returns the specified parent of the commit at provided 0-based [position].
///
/// **IMPORTANT**: Should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
Commit parent(int position) {
return Commit(
@ -303,8 +298,6 @@ class Commit {
/// Passing 0 as the generation number returns another instance of the base
/// commit itself.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
Commit nthGenAncestor(int n) {
return Commit(bindings.nthGenAncestor(commitPointer: _commitPointer, n: n));
@ -323,12 +316,13 @@ class Commit {
}
/// Creates an in-memory copy of a commit.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
Commit duplicate() => Commit(bindings.duplicate(_commitPointer));
/// Releases memory allocated for commit object.
void free() => bindings.free(_commitPointer);
void free() {
bindings.free(_commitPointer);
_finalizer.detach(this);
}
@override
String toString() {
@ -337,3 +331,9 @@ class Commit {
' author: $author}';
}
}
// coverage:ignore-start
final _finalizer = Finalizer<Pointer<git_commit>>(
(pointer) => bindings.free(pointer),
);
// coverage:ignore-end

108
lib/src/config.dart
View file

@ -11,9 +11,9 @@ import 'package:libgit2dart/src/util.dart';
class Config with IterableMixin<ConfigEntry> {
/// Initializes a new instance of [Config] class from provided
/// pointer to config object in memory.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
Config(this._configPointer);
Config(this._configPointer) {
_finalizer.attach(this, _configPointer, detach: this);
}
/// Opens config file at provided [path].
///
@ -23,8 +23,6 @@ class Config with IterableMixin<ConfigEntry> {
/// Git config file following the default Git config syntax (see
/// `man git-config`).
///
/// **IMPORTANT**: Should be freed to release allocated memory.
///
/// Throws an [Exception] if file not found at provided path.
Config.open([String? path]) {
libgit2.git_libgit2_init();
@ -38,39 +36,44 @@ class Config with IterableMixin<ConfigEntry> {
throw Exception('File not found');
}
}
_finalizer.attach(this, _configPointer, detach: this);
}
/// Opens the system configuration file.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
Config.system() {
libgit2.git_libgit2_init();
_configPointer = bindings.open(bindings.findSystem());
// coverage:ignore-start
_finalizer.attach(this, _configPointer, detach: this);
// coverage:ignore-end
}
/// Opens the global configuration file.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
Config.global() {
libgit2.git_libgit2_init();
_configPointer = bindings.open(bindings.findGlobal());
// coverage:ignore-start
_finalizer.attach(this, _configPointer, detach: this);
// coverage:ignore-end
}
/// Opens the global XDG configuration file.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
Config.xdg() {
libgit2.git_libgit2_init();
_configPointer = bindings.open(bindings.findXdg());
// coverage:ignore-start
_finalizer.attach(this, _configPointer, detach: this);
// coverage:ignore-end
}
/// Pointer to memory address for allocated config object.
@ -83,11 +86,24 @@ class Config with IterableMixin<ConfigEntry> {
/// Returns the [ConfigEntry] of a [variable].
ConfigEntry operator [](String variable) {
return ConfigEntry(
bindings.getEntry(
configPointer: _configPointer,
variable: variable,
),
final entryPointer = bindings.getEntry(
configPointer: _configPointer,
variable: variable,
);
final name = entryPointer.ref.name.cast<Utf8>().toDartString();
final value = entryPointer.ref.value.cast<Utf8>().toDartString();
final includeDepth = entryPointer.ref.include_depth;
final level = GitConfigLevel.values.singleWhere(
(e) => entryPointer.ref.level == e.value,
);
bindings.freeEntry(entryPointer);
return ConfigEntry._(
name: name,
value: value,
includeDepth: includeDepth,
level: level,
);
}
@ -167,36 +183,41 @@ class Config with IterableMixin<ConfigEntry> {
}
/// Releases memory allocated for config object.
void free() => bindings.free(_configPointer);
void free() {
bindings.free(_configPointer);
_finalizer.detach(this);
}
@override
Iterator<ConfigEntry> get iterator =>
_ConfigIterator(bindings.iterator(_configPointer));
}
class ConfigEntry {
/// Initializes a new instance of [ConfigEntry] class from provided
/// pointer to config entry object in memory.
const ConfigEntry(this._configEntryPointer);
// coverage:ignore-start
final _finalizer = Finalizer<Pointer<git_config>>(
(pointer) => bindings.free(pointer),
);
// coverage:ignore-end
/// Pointer to memory address for allocated config entry object.
final Pointer<git_config_entry> _configEntryPointer;
class ConfigEntry {
ConfigEntry._({
required this.name,
required this.value,
required this.includeDepth,
required this.level,
});
/// Name of the entry (normalised).
String get name => _configEntryPointer.ref.name.cast<Utf8>().toDartString();
final String name;
/// Value of the entry.
String get value => _configEntryPointer.ref.value.cast<Utf8>().toDartString();
final String value;
/// Depth of includes where this variable was found
int get includeDepth => _configEntryPointer.ref.include_depth;
final int includeDepth;
/// Which config file this was found in.
GitConfigLevel get level {
return GitConfigLevel.values.singleWhere(
(e) => _configEntryPointer.ref.level == e.value,
);
}
final GitConfigLevel level;
@override
String toString() {
@ -206,7 +227,9 @@ class ConfigEntry {
}
class _ConfigIterator implements Iterator<ConfigEntry> {
_ConfigIterator(this._iteratorPointer);
_ConfigIterator(this._iteratorPointer) {
_iteratorFinalizer.attach(this, _iteratorPointer);
}
/// Pointer to memory address for allocated config iterator.
final Pointer<git_config_iterator> _iteratorPointer;
@ -225,7 +248,20 @@ class _ConfigIterator implements Iterator<ConfigEntry> {
} else {
error = libgit2.git_config_next(entry, _iteratorPointer);
if (error != -31) {
_currentEntry = ConfigEntry(entry.value);
final name = entry.value.ref.name.cast<Utf8>().toDartString();
final value = entry.value.ref.value.cast<Utf8>().toDartString();
final includeDepth = entry.value.ref.include_depth;
final level = GitConfigLevel.values.singleWhere(
(e) => entry.value.ref.level == e.value,
);
_currentEntry = ConfigEntry._(
name: name,
value: value,
includeDepth: includeDepth,
level: level,
);
return true;
} else {
return false;
@ -233,3 +269,9 @@ class _ConfigIterator implements Iterator<ConfigEntry> {
}
}
}
// coverage:ignore-start
final _iteratorFinalizer = Finalizer<Pointer<git_config_iterator>>(
(pointer) => bindings.freeIterator(pointer),
);
// coverage:ignore-end

45
lib/src/diff.dart
View file

@ -10,9 +10,9 @@ import 'package:libgit2dart/src/util.dart';
class Diff {
/// Initializes a new instance of [Diff] class from provided
/// pointer to diff object in memory.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
Diff(this._diffPointer);
Diff(this._diffPointer) {
_finalizer.attach(this, _diffPointer, detach: this);
}
/// Creates a diff between the [repo]sitory [index] and the workdir directory.
///
@ -30,8 +30,6 @@ class Diff {
/// [interhunkLines] is the maximum number of unchanged lines between hunk
/// boundaries before the hunks will be merged into one. Defaults to 0.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
Diff.indexToWorkdir({
required Repository repo,
@ -47,6 +45,7 @@ class Diff {
contextLines: contextLines,
interhunkLines: interhunkLines,
);
_finalizer.attach(this, _diffPointer, detach: this);
}
/// Creates a diff between a [tree] and [repo]sitory [index].
@ -83,6 +82,7 @@ class Diff {
contextLines: contextLines,
interhunkLines: interhunkLines,
);
_finalizer.attach(this, _diffPointer, detach: this);
}
/// Creates a diff between a [tree] and the working directory.
@ -124,6 +124,7 @@ class Diff {
contextLines: contextLines,
interhunkLines: interhunkLines,
);
_finalizer.attach(this, _diffPointer, detach: this);
}
/// Creates a diff between a [tree] and the working directory using index
@ -145,8 +146,6 @@ class Diff {
/// [interhunkLines] is the maximum number of unchanged lines between hunk
/// boundaries before the hunks will be merged into one. Defaults to 0.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
Diff.treeToWorkdirWithIndex({
required Repository repo,
@ -162,6 +161,7 @@ class Diff {
contextLines: contextLines,
interhunkLines: interhunkLines,
);
_finalizer.attach(this, _diffPointer, detach: this);
}
/// Creates a diff with the difference between two [Tree] objects.
@ -204,6 +204,7 @@ class Diff {
contextLines: contextLines,
interhunkLines: interhunkLines,
);
_finalizer.attach(this, _diffPointer, detach: this);
}
/// Creates a diff with the difference between two [Index] objects.
@ -239,6 +240,7 @@ class Diff {
contextLines: contextLines,
interhunkLines: interhunkLines,
);
_finalizer.attach(this, _diffPointer, detach: this);
}
/// Reads the [content]s of a git patch file into a git diff object.
@ -255,6 +257,7 @@ class Diff {
Diff.parse(String content) {
libgit2.git_libgit2_init();
_diffPointer = bindings.parse(content);
_finalizer.attach(this, _diffPointer, detach: this);
}
late final Pointer<git_diff> _diffPointer;
@ -441,7 +444,10 @@ class Diff {
Oid get patchOid => Oid(bindings.patchOid(_diffPointer));
/// Releases memory allocated for diff object.
void free() => bindings.free(_diffPointer);
void free() {
bindings.free(_diffPointer);
_finalizer.detach(this);
}
@override
String toString() {
@ -449,6 +455,12 @@ class Diff {
}
}
// coverage:ignore-start
final _finalizer = Finalizer<Pointer<git_diff>>(
(pointer) => bindings.free(pointer),
);
// coverage:ignore-end
class DiffDelta {
/// Initializes a new instance of [DiffDelta] class from provided
/// pointer to diff delta object in memory.
@ -543,9 +555,9 @@ class DiffFile {
class DiffStats {
/// Initializes a new instance of [DiffStats] class from provided
/// pointer to diff stats object in memory.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
const DiffStats(this._diffStatsPointer);
DiffStats(this._diffStatsPointer) {
_statsFinalizer.attach(this, _diffStatsPointer, detach: this);
}
/// Pointer to memory address for allocated diff delta object.
final Pointer<git_diff_stats> _diffStatsPointer;
@ -573,7 +585,10 @@ class DiffStats {
}
/// Releases memory allocated for diff stats object.
void free() => bindings.statsFree(_diffStatsPointer);
void free() {
bindings.statsFree(_diffStatsPointer);
_statsFinalizer.detach(this);
}
@override
String toString() {
@ -582,6 +597,12 @@ class DiffStats {
}
}
// coverage:ignore-start
final _statsFinalizer = Finalizer<Pointer<git_diff_stats>>(
(pointer) => bindings.statsFree(pointer),
);
// coverage:ignore-end
class DiffHunk {
/// Initializes a new instance of [DiffHunk] class from provided
/// pointers to patch object and diff hunk object in memory and number of

26
lib/src/index.dart
View file

@ -9,19 +9,20 @@ import 'package:libgit2dart/src/bindings/libgit2_bindings.dart';
class Index with IterableMixin<IndexEntry> {
/// Initializes a new instance of [Index] class from provided
/// pointer to index object in memory.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
const Index(this._indexPointer);
Index(this._indexPointer) {
_finalizer.attach(this, _indexPointer, detach: this);
}
/// Creates an in-memory index object.
///
/// This index object cannot be read/written to the filesystem, but may be
/// used to perform in-memory index operations.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
Index.newInMemory() : _indexPointer = bindings.newInMemory();
Index.newInMemory() {
_indexPointer = bindings.newInMemory();
_finalizer.attach(this, _indexPointer, detach: this);
}
final Pointer<git_index> _indexPointer;
late final Pointer<git_index> _indexPointer;
/// Pointer to memory address for allocated index object.
Pointer<git_index> get pointer => _indexPointer;
@ -300,7 +301,10 @@ class Index with IterableMixin<IndexEntry> {
bindings.removeAll(indexPointer: _indexPointer, pathspec: path);
/// Releases memory allocated for index object.
void free() => bindings.free(_indexPointer);
void free() {
bindings.free(_indexPointer);
_finalizer.detach(this);
}
@override
String toString() => 'Index{hasConflicts: $hasConflicts}';
@ -309,6 +313,12 @@ class Index with IterableMixin<IndexEntry> {
Iterator<IndexEntry> get iterator => _IndexIterator(_indexPointer);
}
// coverage:ignore-start
final _finalizer = Finalizer<Pointer<git_index>>(
(pointer) => bindings.free(pointer),
);
// coverage:ignore-end
class IndexEntry {
/// Initializes a new instance of [IndexEntry] class.
const IndexEntry(this._indexEntryPointer);

12
lib/src/libgit2.dart
View file

@ -8,7 +8,7 @@ import 'package:libgit2dart/src/util.dart';
class Libgit2 {
Libgit2._(); // coverage:ignore-line
/// Returns libgit2 version number.
/// Libgit2 version number.
static String get version {
libgit2.git_libgit2_init();
@ -26,7 +26,7 @@ class Libgit2 {
return version;
}
/// Returns list of options libgit2 was compiled with.
/// Options libgit2 was compiled with.
static Set<GitFeature> get features {
libgit2.git_libgit2_init();
final featuresInt = libgit2.git_libgit2_features();
@ -35,15 +35,19 @@ class Libgit2 {
.toSet();
}
/// Returns owner validation setting for repository directories.
/// Owner validation setting for repository directories.
static bool get ownerValidation {
libgit2.git_libgit2_init();
final out = calloc<Int8>();
libgit2.git_libgit2_opts(
git_libgit2_opt_t.GIT_OPT_GET_OWNER_VALIDATION,
out,
);
return out.value == 1 || false;
final result = out.value;
calloc.free(out);
return result == 1 || false;
}
/// Sets owner validation setting for repository directories.

22
lib/src/mailmap.dart
View file

@ -9,21 +9,19 @@ class Mailmap {
///
/// This object is empty, so you'll have to add a mailmap file before you can
/// do anything with it.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
Mailmap.empty() {
libgit2.git_libgit2_init();
_mailmapPointer = bindings.init();
_finalizer.attach(this, _mailmapPointer, detach: this);
}
/// Initializes a new instance of [Mailmap] class from provided buffer.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
Mailmap.fromBuffer(String buffer) {
libgit2.git_libgit2_init();
_mailmapPointer = bindings.fromBuffer(buffer);
_finalizer.attach(this, _mailmapPointer, detach: this);
}
/// Initializes a new instance of [Mailmap] class from a [repo]sitory, loading
@ -34,14 +32,13 @@ class Mailmap {
/// 1. `.mailmap` in the root of the repository's working directory, if
/// present.
/// 2. The blob object identified by the `mailmap.blob` config entry, if set.
/// NOTE: `mailmap.blob` defaults to `HEAD:.mailmap` in bare repositories
/// NOTE: `mailmap.blob` defaults to `HEAD:.mailmap` in bare repositories.
/// 3. The path in the `mailmap.file` config entry, if set.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
Mailmap.fromRepository(Repository repo) {
_mailmapPointer = bindings.fromRepository(repo.pointer);
_finalizer.attach(this, _mailmapPointer, detach: this);
}
/// Pointer to memory address for allocated mailmap object.
@ -94,5 +91,14 @@ class Mailmap {
}
/// Releases memory allocated for mailmap object.
void free() => bindings.free(_mailmapPointer);
void free() {
bindings.free(_mailmapPointer);
_finalizer.detach(this);
}
}
// coverage:ignore-start
final _finalizer = Finalizer<Pointer<git_mailmap>>(
(pointer) => bindings.free(pointer),
);
// coverage:ignore-end

7
lib/src/merge.dart
View file

@ -74,9 +74,6 @@ class Merge {
(e) => analysisInt[1] == e.value,
);
head.free();
ref.free();
return <Object>[analysisSet, mergePreference];
}
@ -140,8 +137,6 @@ class Merge {
/// [fileFlags] is a combination of [GitMergeFileFlag] flags. Defaults to
/// [GitMergeFileFlag.defaults].
///
/// **IMPORTANT**: returned index should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
static Index commits({
required Repository repo,
@ -188,8 +183,6 @@ class Merge {
/// [fileFlags] is a combination of [GitMergeFileFlag] flags. Defaults to
/// [GitMergeFileFlag.defaults].
///
/// **IMPORTANT**: returned index should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
static Index trees({
required Repository repo,

20
lib/src/note.dart
View file

@ -6,7 +6,9 @@ import 'package:libgit2dart/src/bindings/note.dart' as bindings;
class Note {
/// Initializes a new instance of the [Note] class from provided
/// pointer to note and annotatedOid objects in memory.
Note(this._notePointer, this._annotatedOidPointer);
Note(this._notePointer, this._annotatedOidPointer) {
_finalizer.attach(this, _notePointer, detach: this);
}
/// Lookups the note for an [annotatedOid].
///
@ -16,8 +18,6 @@ class Note {
///
/// [notesRef] is the canonical name of the reference to use. Defaults to "refs/notes/commits".
///
/// **IMPORTANT**: Notes must be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
Note.lookup({
required Repository repo,
@ -30,6 +30,7 @@ class Note {
notesRef: notesRef,
);
_annotatedOidPointer = annotatedOid.pointer;
_finalizer.attach(this, _notePointer, detach: this);
}
/// Pointer to memory address for allocated note object.
@ -107,8 +108,6 @@ class Note {
/// Returns list of notes for [repo]sitory.
///
/// **IMPORTANT**: Notes must be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
static List<Note> list(Repository repo) {
final notesPointers = bindings.list(repo.pointer);
@ -132,10 +131,19 @@ class Note {
Oid get annotatedOid => Oid(_annotatedOidPointer);
/// Releases memory allocated for note object.
void free() => bindings.free(_notePointer);
void free() {
bindings.free(_notePointer);
_finalizer.detach(this);
}
@override
String toString() {
return 'Note{oid: $oid, message: $message, annotatedOid: $annotatedOid}';
}
}
// coverage:ignore-start
final _finalizer = Finalizer<Pointer<git_note>>(
(pointer) => bindings.free(pointer),
);
// coverage:ignore-end

38
lib/src/odb.dart
View file

@ -7,20 +7,19 @@ import 'package:libgit2dart/src/util.dart';
class Odb {
/// Initializes a new instance of [Odb] class from provided
/// pointer to Odb object in memory.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
Odb(this._odbPointer);
Odb(this._odbPointer) {
_finalizer.attach(this, _odbPointer, detach: this);
}
/// Creates a new object database with no backends.
///
/// Before the ODB can be used for read/writing, a custom database backend must be
/// manually added.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
Odb.create() {
libgit2.git_libgit2_init();
_odbPointer = bindings.create();
_finalizer.attach(this, _odbPointer, detach: this);
}
late final Pointer<git_odb> _odbPointer;
@ -59,9 +58,6 @@ class Odb {
/// This method queries all available ODB backends trying to read the given
/// [oid].
///
/// **IMPORTANT**: Returned object should be freed to release allocated
/// memory.
///
/// Throws a [LibGit2Error] if error occured.
OdbObject read(Oid oid) {
return OdbObject(
@ -97,13 +93,24 @@ class Odb {
}
/// Releases memory allocated for odb object.
void free() => bindings.free(_odbPointer);
void free() {
bindings.free(_odbPointer);
_finalizer.detach(this);
}
}
// coverage:ignore-start
final _finalizer = Finalizer<Pointer<git_odb>>(
(pointer) => bindings.free(pointer),
);
// coverage:ignore-end
class OdbObject {
/// Initializes a new instance of the [OdbObject] class from
/// provided pointer to odbObject object in memory.
const OdbObject(this._odbObjectPointer);
OdbObject(this._odbObjectPointer) {
_objectfinalizer.attach(this, _odbObjectPointer, detach: this);
}
/// Pointer to memory address for allocated odbObject object.
final Pointer<git_odb_object> _odbObjectPointer;
@ -124,10 +131,19 @@ class OdbObject {
int get size => bindings.objectSize(_odbObjectPointer);
/// Releases memory allocated for odbObject object.
void free() => bindings.objectFree(_odbObjectPointer);
void free() {
bindings.objectFree(_odbObjectPointer);
_objectfinalizer.detach(this);
}
@override
String toString() {
return 'OdbObject{oid: $oid, type: $type, size: $size}';
}
}
// coverage:ignore-start
final _objectfinalizer = Finalizer<Pointer<git_odb_object>>(
(pointer) => bindings.objectFree(pointer),
);
// coverage:ignore-end

4
lib/src/oid.dart
View file

@ -25,13 +25,11 @@ class Oid {
if (sha.length == 40) {
_oidPointer = bindings.fromSHA(sha);
} else {
final odb = repo.odb;
_oidPointer = odb_bindings.existsPrefix(
odbPointer: odb.pointer,
odbPointer: repo.odb.pointer,
shortOidPointer: bindings.fromStrN(sha),
length: sha.length,
);
odb.free();
}
} else {
throw ArgumentError.value('$sha is not a valid sha hex string');

14
lib/src/packbuilder.dart
View file

@ -6,11 +6,10 @@ import 'package:libgit2dart/src/bindings/packbuilder.dart' as bindings;
class PackBuilder {
/// Initializes a new instance of [PackBuilder] class.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
PackBuilder(Repository repo) {
_packbuilderPointer = bindings.init(repo.pointer);
_finalizer.attach(this, _packbuilderPointer, detach: this);
}
/// Pointer to memory address for allocated packbuilder object.
@ -108,10 +107,19 @@ class PackBuilder {
}
/// Releases memory allocated for packbuilder object.
void free() => bindings.free(_packbuilderPointer);
void free() {
bindings.free(_packbuilderPointer);
_finalizer.detach(this);
}
@override
String toString() {
return 'PackBuilder{length: $length, writtenLength: $writtenLength}';
}
}
// coverage:ignore-start
final _finalizer = Finalizer<Pointer<git_packbuilder>>(
(pointer) => bindings.free(pointer),
);
// coverage:ignore-end

29
lib/src/patch.dart
View file

@ -8,9 +8,9 @@ import 'package:libgit2dart/src/util.dart';
class Patch {
/// Initializes a new instance of [Patch] class from provided
/// pointer to patch object in memory and pointers to old and new blobs/buffers.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
Patch(this._patchPointer);
Patch(this._patchPointer) {
_finalizer.attach(this, _patchPointer, detach: this);
}
/// Directly generates a [Patch] from the difference between two blobs.
///
@ -30,8 +30,6 @@ class Patch {
/// [interhunkLines] is the maximum number of unchanged lines between hunk
/// boundaries before the hunks will be merged into one. Defaults to 0.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
Patch.fromBlobs({
required Blob? oldBlob,
@ -51,6 +49,7 @@ class Patch {
contextLines: contextLines,
interhunkLines: interhunkLines,
);
_finalizer.attach(this, _patchPointer, detach: this);
}
/// Directly generates a [Patch] from the difference between the blob and a
@ -72,8 +71,6 @@ class Patch {
/// [interhunkLines] is the maximum number of unchanged lines between hunk
/// boundaries before the hunks will be merged into one. Defaults to 0.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
Patch.fromBlobAndBuffer({
required Blob? blob,
@ -93,6 +90,7 @@ class Patch {
contextLines: contextLines,
interhunkLines: interhunkLines,
);
_finalizer.attach(this, _patchPointer, detach: this);
}
/// Directly generates a [Patch] from the difference between two buffers
@ -113,8 +111,6 @@ class Patch {
/// [interhunkLines] is the maximum number of unchanged lines between hunk
/// boundaries before the hunks will be merged into one. Defaults to 0.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
Patch.fromBuffers({
required String? oldBuffer,
@ -136,6 +132,7 @@ class Patch {
contextLines: contextLines,
interhunkLines: interhunkLines,
);
_finalizer.attach(this, _patchPointer, detach: this);
}
/// Creates a patch for an entry in the diff list.
@ -144,11 +141,10 @@ class Patch {
///
/// [index] is the position of an entry in diff list.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
Patch.fromDiff({required Diff diff, required int index}) {
_patchPointer = bindings.fromDiff(diffPointer: diff.pointer, index: index);
_finalizer.attach(this, _patchPointer, detach: this);
}
late final Pointer<git_patch> _patchPointer;
@ -217,12 +213,21 @@ class Patch {
}
/// Releases memory allocated for patch object.
void free() => bindings.free(_patchPointer);
void free() {
bindings.free(_patchPointer);
_finalizer.detach(this);
}
@override
String toString() => 'Patch{size: ${size()}, delta: $delta}';
}
// coverage:ignore-start
final _finalizer = Finalizer<Pointer<git_patch>>(
(pointer) => bindings.free(pointer),
);
// coverage:ignore-end
/// Line counts of each type in a patch.
class PatchStats {
const PatchStats({

17
lib/src/rebase.dart
View file

@ -17,8 +17,6 @@ class Rebase {
/// [onto] is the branch to rebase onto, default is to rebase onto the given
/// [upstream].
///
/// **IMPORTANT**: Should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
Rebase.init({
required Repository repo,
@ -32,16 +30,16 @@ class Rebase {
upstreamPointer: upstream?.pointer,
ontoPointer: onto?.pointer,
);
_finalizer.attach(this, _rebasePointer, detach: this);
}
/// Opens an existing rebase that was previously started by either an
/// invocation of [Rebase.init] or by another client.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
Rebase.open(Repository repo) {
_rebasePointer = bindings.open(repo.pointer);
_finalizer.attach(this, _rebasePointer, detach: this);
}
/// Pointer to memory address for allocated rebase object.
@ -138,9 +136,18 @@ class Rebase {
void abort() => bindings.abort(_rebasePointer);
/// Releases memory allocated for rebase object.
void free() => bindings.free(_rebasePointer);
void free() {
bindings.free(_rebasePointer);
_finalizer.detach(this);
}
}
// coverage:ignore-start
final _finalizer = Finalizer<Pointer<git_rebase>>(
(pointer) => bindings.free(pointer),
);
// coverage:ignore-end
class RebaseOperation {
/// Initializes a new instance of the [RebaseOperation] class from
/// provided pointer to rebase operation object in memory.

32
lib/src/reference.dart
View file

@ -10,17 +10,14 @@ import 'package:libgit2dart/src/bindings/repository.dart'
class Reference {
/// Initializes a new instance of the [Reference] class.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
Reference(this._refPointer);
Reference(this._refPointer) {
_finalizer.attach(this, _refPointer, detach: this);
}
/// Creates a new reference for provided [target].
///
/// The reference will be created in the [repo]sitory and written to the disk.
///
/// **IMPORTANT**: The generated [Reference] object should be freed to release
/// allocated memory.
///
/// Valid reference [name]s must follow one of two patterns:
/// - Top-level names must contain only capital letters and underscores, and
/// must begin and end with a letter. (e.g. "HEAD", "ORIG_HEAD").
@ -65,17 +62,17 @@ class Reference {
'$target must be either Oid or String reference name',
);
}
_finalizer.attach(this, _refPointer, detach: this);
}
/// Lookups reference [name] in a [repo]sitory.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
///
/// The [name] will be checked for validity.
///
/// Throws a [LibGit2Error] if error occured.
Reference.lookup({required Repository repo, required String name}) {
_refPointer = bindings.lookup(repoPointer: repo.pointer, name: name);
_finalizer.attach(this, _refPointer, detach: this);
}
late Pointer<git_reference> _refPointer;
@ -89,7 +86,6 @@ class Reference {
static void delete({required Repository repo, required String name}) {
final ref = Reference.lookup(repo: repo, name: name);
bindings.delete(ref.pointer);
ref.free();
}
/// Renames an existing reference with provided [oldName].
@ -120,7 +116,6 @@ class Reference {
force: force,
logMessage: logMessage,
);
ref.free();
}
/// List of all the references names that can be found in a [repo]sitory.
@ -153,8 +148,6 @@ class Reference {
}
/// Creates a copy of an existing reference.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
Reference duplicate() => Reference(bindings.duplicate(_refPointer));
/// Type of the reference.
@ -192,7 +185,6 @@ class Reference {
oidPointer: target.pointer,
logMessage: logMessage,
);
free();
_refPointer = newPointer;
} else if (target is String) {
final newPointer = bindings.setTargetSymbolic(
@ -200,7 +192,6 @@ class Reference {
target: target,
logMessage: logMessage,
);
free();
_refPointer = newPointer;
} else {
throw ArgumentError.value(
@ -261,8 +252,6 @@ class Reference {
}
/// [RefLog] object.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
RefLog get log => RefLog(this);
/// Whether reference is a local branch.
@ -292,7 +281,10 @@ class Reference {
bool notEquals(Reference other) => !equals(other);
/// Releases memory allocated for reference object.
void free() => bindings.free(_refPointer);
void free() {
bindings.free(_refPointer);
_finalizer.detach(this);
}
@override
String toString() {
@ -301,3 +293,9 @@ class Reference {
'isTag: $isTag}';
}
}
// coverage:ignore-start
final _finalizer = Finalizer<Pointer<git_reference>>(
(pointer) => bindings.free(pointer),
);
// coverage:ignore-end

14
lib/src/reflog.dart
View file

@ -6,13 +6,12 @@ import 'package:libgit2dart/src/bindings/reflog.dart' as bindings;
class RefLog with IterableMixin<RefLogEntry> {
/// Initializes a new instance of [RefLog] class from provided [Reference].
///
/// **IMPORTANT**: Should be freed to release allocated memory.
RefLog(Reference ref) {
_reflogPointer = bindings.read(
repoPointer: ref.owner.pointer,
name: ref.name,
);
_finalizer.attach(this, _reflogPointer, detach: this);
}
/// Pointer to memory address for allocated reflog object.
@ -89,12 +88,21 @@ class RefLog with IterableMixin<RefLogEntry> {
void write() => bindings.write(_reflogPointer);
/// Releases memory allocated for reflog object.
void free() => bindings.free(_reflogPointer);
void free() {
bindings.free(_reflogPointer);
_finalizer.detach(this);
}
@override
Iterator<RefLogEntry> get iterator => _RefLogIterator(_reflogPointer);
}
// coverage:ignore-start
final _finalizer = Finalizer<Pointer<git_reflog>>(
(pointer) => bindings.free(pointer),
);
// coverage:ignore-end
class RefLogEntry {
/// Initializes a new instance of [RefLogEntry] class from provided
/// pointer to RefLogEntry object in memory.

39
lib/src/remote.dart
View file

@ -8,18 +8,15 @@ class Remote {
///
/// The [name] will be checked for validity.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
Remote.lookup({required Repository repo, required String name}) {
_remotePointer = bindings.lookup(repoPointer: repo.pointer, name: name);
_finalizer.attach(this, _remotePointer, detach: this);
}
/// Adds remote with provided [name] and [url] to the [repo]sitory's
/// configuration with the default [fetch] refspec if none provided.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
Remote.create({
required Repository repo,
@ -41,12 +38,11 @@ class Remote {
fetch: fetch,
);
}
_finalizer.attach(this, _remotePointer, detach: this);
}
late final Pointer<git_remote> _remotePointer;
/// Pointer to memory address for allocated remote object.
Pointer<git_remote> get pointer => _remotePointer;
late final Pointer<git_remote> _remotePointer;
/// Deletes an existing persisted remote with provided [name].
///
@ -298,7 +294,10 @@ class Remote {
}
/// Releases memory allocated for remote object.
void free() => bindings.free(_remotePointer);
void free() {
bindings.free(_remotePointer);
_finalizer.detach(this);
}
@override
String toString() {
@ -307,6 +306,12 @@ class Remote {
}
}
// coverage:ignore-start
final _finalizer = Finalizer<Pointer<git_remote>>(
(pointer) => bindings.free(pointer),
);
// coverage:ignore-end
/// Provides callers information about the progress of indexing a packfile,
/// either directly or part of a fetch or clone that downloads a packfile.
class TransferProgress {
@ -346,3 +351,21 @@ class TransferProgress {
'indexedDeltas: $indexedDeltas, receivedBytes: $receivedBytes}';
}
}
class RemoteCallback {
/// Values used to override the remote creation and customization process
/// during a repository clone operation.
///
/// Remote will have provided [name] and [url] with the default [fetch]
/// refspec if none provided.
const RemoteCallback({required this.name, required this.url, this.fetch});
/// Remote's name.
final String name;
/// Remote's url.
final String url;
/// Remote's fetch refspec.
final String? fetch;
}

116
lib/src/repository.dart
View file

@ -111,13 +111,11 @@ class Repository {
///
/// [bare] whether cloned repo should be bare.
///
/// [remote] is the callback function with
/// `Remote Function(Repository repo, String name, String url)` signature.
/// The [Remote] it returns will be used instead of default one.
/// [remoteCallback] is the [RemoteCallback] object values that will be used
/// in creation and customization process of remote instead of default ones.
///
/// [repository] is the callback function matching the
/// `Repository Function(String path, bool bare)` signature. The [Repository]
/// it returns will be used instead of creating a new one.
/// [repositoryCallback] is the [RepositoryCallback] object values that will
/// be used in creation and customization process of repository.
///
/// [checkoutBranch] is the name of the branch to checkout after the clone.
/// Defaults to using the remote's default branch.
@ -132,8 +130,8 @@ class Repository {
required String url,
required String localPath,
bool bare = false,
Remote Function(Repository, String, String)? remote,
Repository Function(String, bool)? repository,
RemoteCallback? remoteCallback,
RepositoryCallback? repositoryCallback,
String? checkoutBranch,
Callbacks callbacks = const Callbacks(),
}) {
@ -143,8 +141,8 @@ class Repository {
url: url,
localPath: localPath,
bare: bare,
remote: remote,
repository: repository,
remoteCallback: remoteCallback,
repositoryCallback: repositoryCallback,
checkoutBranch: checkoutBranch,
callbacks: callbacks,
);
@ -375,8 +373,6 @@ class Repository {
/// If a configuration file has not been set, the default config set for the
/// repository will be returned, including global and system configurations
/// (if they are available).
///
/// **IMPORTANT**: Should be freed to release allocated memory.
Config get config => Config(bindings.config(_repoPointer));
/// Snapshot of the repository's configuration.
@ -386,24 +382,16 @@ class Repository {
///
/// The contents of this snapshot will not change, even if the underlying
/// config files are modified.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
Config get configSnapshot => Config(bindings.configSnapshot(_repoPointer));
/// Repository's head.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
Reference get head => Reference(bindings.head(_repoPointer));
/// Index file for this repository.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
Index get index => Index(bindings.index(_repoPointer));
/// ODB for this repository.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
Odb get odb => Odb(bindings.odb(_repoPointer));
@ -419,23 +407,17 @@ class Repository {
/// List of all branches that can be found in a repository.
///
/// **IMPORTANT**: Branches should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
List<Branch> get branches => Branch.list(repo: this);
/// List of local branches that can be found in a repository.
///
/// **IMPORTANT**: Branches should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
List<Branch> get branchesLocal =>
Branch.list(repo: this, type: GitBranch.local);
/// List of remote branches that can be found in a repository.
///
/// **IMPORTANT**: Branches should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
List<Branch> get branchesRemote =>
Branch.list(repo: this, type: GitBranch.remote);
@ -465,8 +447,6 @@ class Repository {
///
/// If [sorting] isn't provided default will be used (reverse chronological
/// order, like in git).
///
/// **IMPORTANT**: Commits should be freed to release allocated memory.
List<Commit> log({
required Oid oid,
Set<GitSort> sorting = const {GitSort.none},
@ -477,8 +457,6 @@ class Repository {
walker.push(oid);
final result = walker.walk();
walker.free();
return result;
}
@ -737,6 +715,7 @@ class Repository {
}
}
// ignore: no_leading_underscores_for_local_identifiers
final _packDelegate = packDelegate ?? packAll;
final packbuilder = PackBuilder(this);
@ -745,10 +724,79 @@ class Repository {
}
_packDelegate(packbuilder);
packbuilder.write(path);
final result = packbuilder.writtenLength;
packbuilder.free();
return result;
return packbuilder.writtenLength;
}
}
class RepositoryCallback {
/// Values used to override the repository creation and customization process
/// during a clone operation.
///
/// [path] is the path to the repository.
///
/// [bare] whether new repository should be bare.
///
/// [flags] is a combination of [GitRepositoryInit] flags. Defaults to
/// [GitRepositoryInit.mkdir].
///
/// [mode] is the permissions for the folder. Default to 0 (permissions
/// configured by umask).
///
/// [workdirPath] is the path to the working directory. Can be null for
/// default path.
///
/// [description] if set will be used to initialize the "description" file in
/// the repository, instead of using the template content.
///
/// [templatePath] is the the path to use for the template directory if
/// [GitRepositoryInit.externalTemplate] is set. Defaults to the config or
/// default directory options.
///
/// [initialHead] is the name of the head to point HEAD at. If null, then
/// this will be treated as "master" and the HEAD ref will be set to
/// "refs/heads/master". If this begins with "refs/" it will be used
/// verbatim, otherwise "refs/heads/" will be prefixed.
///
/// [originUrl] if set, then after the rest of the repository initialization
/// is completed, an "origin" remote will be added pointing to this URL.
const RepositoryCallback({
required this.path,
this.bare = false,
this.flags = const {GitRepositoryInit.mkpath},
this.mode = 0,
this.workdirPath,
this.description,
this.templatePath,
this.initialHead,
this.originUrl,
});
/// Path to the repository.
final String path;
/// Whether repository is bare.
final bool bare;
/// Combination of [GitRepositoryInit] flags.
final Set<GitRepositoryInit> flags;
/// Permissions for the repository folder.
final int mode;
/// Path to the working directory.
final String? workdirPath;
/// Description used to initialize the "description" file in the repository.
final String? description;
/// Path used for the template directory.
final String? templatePath;
/// Name of the head HEAD points at.
final String? initialHead;
/// "origin" remote URL that will be added after the rest of the repository
/// initialization is completed.
final String? originUrl;
}

8
lib/src/revparse.dart
View file

@ -15,8 +15,6 @@ class RevParse {
/// point to an intermediate reference. When such expressions are being
/// passed in, reference_out will be valued as well.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
RevParse.ext({required Repository repo, required String spec}) {
final pointers = bindings.revParseExt(
@ -51,8 +49,6 @@ class RevParse {
/// final tag = RevParse.single(repo: repo, spec: 'v1.0') as Tag;
/// ```
///
/// **IMPORTANT**: Should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
static Object single({required Repository repo, required String spec}) {
final object = bindings.revParseSingle(
@ -102,13 +98,9 @@ class RevSpec {
final Pointer<git_revspec> _revSpecPointer;
/// Left element of the revspec.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
Commit get from => Commit(_revSpecPointer.ref.from.cast());
/// Right element of the revspec.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
Commit? get to {
return _revSpecPointer.ref.to == nullptr
? null

14
lib/src/revwalk.dart
View file

@ -5,10 +5,9 @@ import 'package:libgit2dart/src/bindings/revwalk.dart' as bindings;
class RevWalk {
/// Initializes a new instance of the [RevWalk] class.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
RevWalk(Repository repo) {
_revWalkPointer = bindings.create(repo.pointer);
_finalizer.attach(this, _revWalkPointer, detach: this);
}
late final Pointer<git_revwalk> _revWalkPointer;
@ -150,5 +149,14 @@ class RevWalk {
void simplifyFirstParent() => bindings.simplifyFirstParent(_revWalkPointer);
/// Releases memory allocated for [RevWalk] object.
void free() => bindings.free(_revWalkPointer);
void free() {
bindings.free(_revWalkPointer);
_finalizer.detach(this);
}
}
// coverage:ignore-start
final _finalizer = Finalizer<Pointer<git_revwalk>>(
(pointer) => bindings.free(pointer),
);
// coverage:ignore-end

22
lib/src/signature.dart
View file

@ -10,17 +10,16 @@ import 'package:meta/meta.dart';
class Signature {
/// Initializes a new instance of [Signature] class from provided pointer to
/// signature object in memory.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
Signature(this._signaturePointer);
Signature(Pointer<git_signature> pointer) {
_signaturePointer = bindings.duplicate(pointer);
_finalizer.attach(this, _signaturePointer, detach: this);
}
/// Creates new [Signature] from provided [name], [email], and optional [time]
/// in seconds from epoch and [offset] in minutes.
///
/// If [time] isn't provided [Signature] will be created with a timestamp of
/// 'now'.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
Signature.create({
required String name,
required String email,
@ -39,6 +38,7 @@ class Signature {
offset: offset,
);
}
_finalizer.attach(this, _signaturePointer, detach: this);
}
/// Creates a new action signature with default user and now timestamp.
@ -48,6 +48,7 @@ class Signature {
/// on that information.
Signature.defaultSignature(Repository repo) {
_signaturePointer = bindings.defaultSignature(repo.pointer);
_finalizer.attach(this, _signaturePointer, detach: this);
}
late final Pointer<git_signature> _signaturePointer;
@ -79,7 +80,10 @@ class Signature {
}
/// Releases memory allocated for signature object.
void free() => bindings.free(_signaturePointer);
void free() {
bindings.free(_signaturePointer);
_finalizer.detach(this);
}
@override // coverage:ignore-line
int get hashCode =>
@ -91,3 +95,9 @@ class Signature {
'offset: $offset}';
}
}
// coverage:ignore-start
final _finalizer = Finalizer<Pointer<git_signature>>(
(pointer) => bindings.free(pointer),
);
// coverage:ignore-end

18
lib/src/submodule.dart
View file

@ -7,14 +7,13 @@ class Submodule {
/// Lookups submodule information by [name] or path (they are usually the
/// same).
///
/// **IMPORTANT**: Should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
Submodule.lookup({required Repository repo, required String name}) {
_submodulePointer = bindings.lookup(
repoPointer: repo.pointer,
name: name,
);
_finalizer.attach(this, _submodulePointer, detach: this);
}
/// Adds a submodule to the index.
@ -29,8 +28,6 @@ class Submodule {
/// [callbacks] is the combination of callback functions from [Callbacks]
/// object.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
Submodule.add({
required Repository repo,
@ -49,6 +46,8 @@ class Submodule {
bindings.clone(submodule: _submodulePointer, callbacks: callbacks);
bindings.addFinalize(_submodulePointer);
_finalizer.attach(this, _submodulePointer, detach: this);
}
/// Pointer to memory address for allocated submodule object.
@ -264,7 +263,10 @@ class Submodule {
}
/// Releases memory allocated for submodule object.
void free() => bindings.free(_submodulePointer);
void free() {
bindings.free(_submodulePointer);
_finalizer.detach(this);
}
@override
String toString() {
@ -273,3 +275,9 @@ class Submodule {
'workdirOid: $workdirOid, ignore: $ignore, updateRule: $updateRule}';
}
}
// coverage:ignore-start
final _finalizer = Finalizer<Pointer<git_submodule>>(
(pointer) => bindings.free(pointer),
);
// coverage:ignore-end

23
lib/src/tag.dart
View file

@ -8,18 +8,17 @@ import 'package:libgit2dart/src/bindings/tag.dart' as bindings;
class Tag {
/// Initializes a new instance of [Tag] class from provided pointer to
/// tag object in memory.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
Tag(this._tagPointer);
Tag(this._tagPointer) {
_finalizer.attach(this, _tagPointer, detach: this);
}
/// Lookups tag object for provided [oid] in a [repo]sitory.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
Tag.lookup({required Repository repo, required Oid oid}) {
_tagPointer = bindings.lookup(
repoPointer: repo.pointer,
oidPointer: oid.pointer,
);
_finalizer.attach(this, _tagPointer, detach: this);
}
/// Pointer to memory address for allocated tag object.
@ -160,9 +159,6 @@ class Tag {
/// Returned object should be explicitly downcasted to one of four of git
/// object types.
///
/// **IMPORTANT**: returned object should be freed to release allocated
/// memory.
///
/// ```dart
/// final commit = tag.target as Commit;
/// final tree = tag.target as Tree;
@ -215,7 +211,10 @@ class Tag {
}
/// Releases memory allocated for tag object.
void free() => bindings.free(_tagPointer);
void free() {
bindings.free(_tagPointer);
_finalizer.detach(this);
}
@override
String toString() {
@ -223,3 +222,9 @@ class Tag {
'tagger: $tagger}';
}
}
// coverage:ignore-start
final _finalizer = Finalizer<Pointer<git_tag>>(
(pointer) => bindings.free(pointer),
);
// coverage:ignore-end

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

17
lib/src/treebuilder.dart
View file

@ -7,14 +7,13 @@ class TreeBuilder {
/// Initializes a new instance of [TreeBuilder] class from provided
/// [repo]sitory and optional [tree] objects.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
TreeBuilder({required Repository repo, Tree? tree}) {
_treeBuilderPointer = bindings.create(
repoPointer: repo.pointer,
sourcePointer: tree?.pointer ?? nullptr,
);
_finalizer.attach(this, _treeBuilderPointer, detach: this);
}
/// Pointer to memory address for allocated tree builder object.
@ -31,9 +30,6 @@ class TreeBuilder {
/// Returns an entry from the tree builder with provided [filename].
///
/// **IMPORTANT**: the returned entry is owned by the tree builder and
/// should not be freed manually.
///
/// Throws [ArgumentError] if nothing found for provided [filename].
TreeEntry operator [](String filename) {
return TreeEntry(
@ -83,10 +79,19 @@ class TreeBuilder {
}
/// Releases memory allocated for tree builder object and all the entries.
void free() => bindings.free(_treeBuilderPointer);
void free() {
bindings.free(_treeBuilderPointer);
_finalizer.detach(this);
}
@override
String toString() {
return 'TreeBuilder{length: $length}';
}
}
// coverage:ignore-start
final _finalizer = Finalizer<Pointer<git_treebuilder>>(
(pointer) => bindings.free(pointer),
);
// coverage:ignore-end

17
lib/src/worktree.dart
View file

@ -15,8 +15,6 @@ class Worktree {
///
/// [path] is the path to create working tree at.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
Worktree.create({
required Repository repo,
@ -30,15 +28,15 @@ class Worktree {
path: path,
refPointer: ref?.pointer,
);
_finalizer.attach(this, _worktreePointer, detach: this);
}
/// Lookups existing worktree in [repo] with provided [name].
///
/// **IMPORTANT**: Should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
Worktree.lookup({required Repository repo, required String name}) {
_worktreePointer = bindings.lookup(repoPointer: repo.pointer, name: name);
_finalizer.attach(this, _worktreePointer, detach: this);
}
/// Pointer to memory address for allocated branch object.
@ -88,10 +86,19 @@ class Worktree {
bool get isValid => bindings.isValid(_worktreePointer);
/// Releases memory allocated for worktree object.
void free() => bindings.free(_worktreePointer);
void free() {
bindings.free(_worktreePointer);
_finalizer.detach(this);
}
@override
String toString() {
return 'Worktree{name: $name, path: $path}';
}
}
// coverage:ignore-start
final _finalizer = Finalizer<Pointer<git_worktree>>(
(pointer) => bindings.free(pointer),
);
// coverage:ignore-end