Add branch iterator #66

Merged
jezell merged 9 commits from branch-iterator into master 2014-04-26 13:25:26 -05:00
4 changed files with 93 additions and 50 deletions
Showing only changes of commit 37b950bc90 - Show all commits

106
branch.go
View File

@ -19,27 +19,44 @@ const (
BranchRemote = C.GIT_BRANCH_REMOTE BranchRemote = C.GIT_BRANCH_REMOTE
) )
type branchIterator struct { type Branch struct {
ptr *C.git_branch_iterator *Reference
} }
func newBranchIteratorFromC(ptr *C.git_branch_iterator) ReferenceIterator { func (r *Reference) Branch() *Branch {
i := &branchIterator{ptr: ptr} return &Branch{Reference: r}
}
type branchIterator struct {
ptr *C.git_branch_iterator
repo *Repository
}
type BranchIterator interface {
ReferenceIterator
NextBranch() (BranchInfo, error)
}
type BranchInfo struct {
Branch *Branch
Type BranchType
}
func newBranchIteratorFromC(repo *Repository, ptr *C.git_branch_iterator) BranchIterator {
i := &branchIterator{repo: repo, ptr: ptr}
runtime.SetFinalizer(i, (*branchIterator).Free) runtime.SetFinalizer(i, (*branchIterator).Free)
return i return i
} }
func (i *branchIterator) NextName() (string, error) { func (i *branchIterator) NextName() (string, error) {
ref, err := i.Next() b, err := i.NextBranch()
if err != nil { if err != nil {
return "", err return "", err
} }
defer ref.Free() return b.Branch.Name()
return ref.Name(), err
} }
func (i *branchIterator) Next() (*Reference, error) { func (i *branchIterator) NextBranch() (BranchInfo, error) {
runtime.LockOSThread() runtime.LockOSThread()
defer runtime.UnlockOSThread() defer runtime.UnlockOSThread()
@ -50,12 +67,22 @@ func (i *branchIterator) Next() (*Reference, error) {
ecode := C.git_branch_next(&refPtr, &refType, i.ptr) ecode := C.git_branch_next(&refPtr, &refType, i.ptr)
if ecode == C.GIT_ITEROVER { if ecode == C.GIT_ITEROVER {
return nil, ErrIterOver return BranchInfo{}, ErrIterOver
} else if ecode < 0 { } else if ecode < 0 {
return nil, MakeGitError(ecode) return BranchInfo{}, MakeGitError(ecode)
} }
return newReferenceFromC(refPtr), nil branch := newReferenceFromC(refPtr).Branch()
return BranchInfo{branch, BranchType(refType)}, nil
}
func (i *branchIterator) NextReference() (*Reference, error) {
b, err := i.NextBranch()
if err != nil {
return nil, err
}
return b.Branch.Reference, err
} }
func (i *branchIterator) Free() { func (i *branchIterator) Free() {
@ -63,7 +90,7 @@ func (i *branchIterator) Free() {
C.git_branch_iterator_free(i.ptr) C.git_branch_iterator_free(i.ptr)
} }
func (repo *Repository) NewBranchIterator(flags BranchType) (ReferenceIterator, error) { func (repo *Repository) NewBranchIterator(flags BranchType) (BranchIterator, error) {
refType := C.git_branch_t(flags) refType := C.git_branch_t(flags)
var ptr *C.git_branch_iterator var ptr *C.git_branch_iterator
@ -76,10 +103,10 @@ func (repo *Repository) NewBranchIterator(flags BranchType) (ReferenceIterator,
return nil, MakeGitError(ecode) return nil, MakeGitError(ecode)
} }
return newBranchIteratorFromC(ptr), nil return newBranchIteratorFromC(repo, ptr), nil
} }
func (repo *Repository) CreateBranch(branchName string, target *Commit, force bool, signature *Signature, msg string) (*Reference, error) { func (repo *Repository) CreateBranch(branchName string, target *Commit, force bool, signature *Signature, msg string) (*Branch, error) {
ref := new(Reference) ref := new(Reference)
cBranchName := C.CString(branchName) cBranchName := C.CString(branchName)
@ -103,21 +130,21 @@ func (repo *Repository) CreateBranch(branchName string, target *Commit, force bo
if ret < 0 { if ret < 0 {
return nil, MakeGitError(ret) return nil, MakeGitError(ret)
} }
return ref, nil return ref.Branch(), nil
} }
func (b *Reference) DeleteBranch() error { func (b *Branch) Delete() error {
runtime.LockOSThread() runtime.LockOSThread()
defer runtime.UnlockOSThread() defer runtime.UnlockOSThread()
ret := C.git_branch_delete(b.ptr) ret := C.git_branch_delete(b.Reference.ptr)
if ret < 0 { if ret < 0 {
return MakeGitError(ret) return MakeGitError(ret)
} }
return nil return nil
} }
func (b *Reference) MoveBranch(newBranchName string, force bool, signature *Signature, msg string) (*Reference, error) { func (b *Branch) MoveBranch(newBranchName string, force bool, signature *Signature, msg string) (*Branch, error) {
var ptr *C.git_reference var ptr *C.git_reference
cNewBranchName := C.CString(newBranchName) cNewBranchName := C.CString(newBranchName)
cForce := cbool(force) cForce := cbool(force)
@ -136,19 +163,19 @@ func (b *Reference) MoveBranch(newBranchName string, force bool, signature *Sign
runtime.LockOSThread() runtime.LockOSThread()
defer runtime.UnlockOSThread() defer runtime.UnlockOSThread()
ret := C.git_branch_move(&ptr, b.ptr, cNewBranchName, cForce, cSignature, cmsg) ret := C.git_branch_move(&ptr, b.Reference.ptr, cNewBranchName, cForce, cSignature, cmsg)
if ret < 0 { if ret < 0 {
return nil, MakeGitError(ret) return nil, MakeGitError(ret)
} }
return newReferenceFromC(ptr), nil return newReferenceFromC(ptr).Branch(), nil
} }
func (b *Reference) IsBranchHead() (bool, error) { func (b *Branch) IsHead() (bool, error) {
runtime.LockOSThread() runtime.LockOSThread()
defer runtime.UnlockOSThread() defer runtime.UnlockOSThread()
ret := C.git_branch_is_head(b.ptr) ret := C.git_branch_is_head(b.Reference.ptr)
switch ret { switch ret {
case 1: case 1:
return true, nil return true, nil
@ -159,7 +186,7 @@ func (b *Reference) IsBranchHead() (bool, error) {
} }
func (repo *Repository) LookupBranch(branchName string, bt BranchType) (*Reference, error) { func (repo *Repository) LookupBranch(branchName string, bt BranchType) (*Branch, error) {
var ptr *C.git_reference var ptr *C.git_reference
cName := C.CString(branchName) cName := C.CString(branchName)
@ -171,17 +198,17 @@ func (repo *Repository) LookupBranch(branchName string, bt BranchType) (*Referen
if ret < 0 { if ret < 0 {
return nil, MakeGitError(ret) return nil, MakeGitError(ret)
} }
return newReferenceFromC(ptr), nil return newReferenceFromC(ptr).Branch(), nil
} }
func (b *Reference) BranchName() (string, error) { func (b *Branch) Name() (string, error) {
var cName *C.char var cName *C.char
defer C.free(unsafe.Pointer(cName)) defer C.free(unsafe.Pointer(cName))
runtime.LockOSThread() runtime.LockOSThread()
defer runtime.UnlockOSThread() defer runtime.UnlockOSThread()
ret := C.git_branch_name(&cName, b.ptr) ret := C.git_branch_name(&cName, b.Reference.ptr)
if ret < 0 { if ret < 0 {
return "", MakeGitError(ret) return "", MakeGitError(ret)
} }
@ -206,26 +233,26 @@ func (repo *Repository) RemoteName(canonicalBranchName string) (string, error) {
return C.GoString(nameBuf.ptr), nil return C.GoString(nameBuf.ptr), nil
} }
func (b *Reference) SetUpstream(upstreamName string) error { func (b *Branch) SetUpstream(upstreamName string) error {
cName := C.CString(upstreamName) cName := C.CString(upstreamName)
runtime.LockOSThread() runtime.LockOSThread()
defer runtime.UnlockOSThread() defer runtime.UnlockOSThread()
ret := C.git_branch_set_upstream(b.ptr, cName) ret := C.git_branch_set_upstream(b.Reference.ptr, cName)
if ret < 0 { if ret < 0 {
return MakeGitError(ret) return MakeGitError(ret)
} }
return nil return nil
} }
func (b *Reference) Upstream() (*Reference, error) { func (b *Branch) Upstream() (*Reference, error) {
var ptr *C.git_reference var ptr *C.git_reference
runtime.LockOSThread() runtime.LockOSThread()
defer runtime.UnlockOSThread() defer runtime.UnlockOSThread()
ret := C.git_branch_upstream(&ptr, b.ptr) ret := C.git_branch_upstream(&ptr, b.Reference.ptr)
if ret < 0 { if ret < 0 {
return nil, MakeGitError(ret) return nil, MakeGitError(ret)
} }
@ -248,3 +275,20 @@ func (repo *Repository) UpstreamName(canonicalBranchName string) (string, error)
return C.GoString(nameBuf.ptr), nil return C.GoString(nameBuf.ptr), nil
} }
// Create a channel from the iterator. You can use range on the
// returned channel to iterate over all the branches. The channel
// will be closed in case any error is found.
func BranchIteratorChannel(v BranchIterator) <-chan BranchInfo {
ch := make(chan BranchInfo)
go func() {
defer close(ch)
b, err := v.NextBranch()
for err == nil {
ch <- b
b, err = v.NextBranch()
}
}()
return ch
}

View File

@ -12,16 +12,15 @@ func TestBranchIterator(t *testing.T) {
i, err := repo.NewBranchIterator(BranchLocal) i, err := repo.NewBranchIterator(BranchLocal)
checkFatal(t, err) checkFatal(t, err)
ref, err := i.Next() b, err := i.NextBranch()
checkFatal(t, err) checkFatal(t, err)
if ref.Name() != "refs/heads/master" { if name, _ := b.Branch.Name(); name != "master" {
t.Fatalf("expected refs/heads/master, not %v", ref.Name()) t.Fatalf("expected master")
} }
ref, err = i.Next() if b.Type != BranchLocal {
if ref != nil { t.Fatalf("expected BranchLocal, not %v", t)
t.Fatal("expected nil")
} }
b, err = i.NextBranch()
if err != ErrIterOver { if err != ErrIterOver {
t.Fatal("expected iterover") t.Fatal("expected iterover")
} }
@ -40,8 +39,8 @@ func TestBranchIterator(t *testing.T) {
t.Fatal("expected single match") t.Fatal("expected single match")
} }
if list[0] != "refs/heads/master" { if list[0] != "master" {
t.Fatal("expected refs/heads/master") t.Fatal("expected master")
} }
} }

View File

@ -22,9 +22,8 @@ type Reference struct {
} }
func newReferenceFromC(ptr *C.git_reference) *Reference { func newReferenceFromC(ptr *C.git_reference) *Reference {
ref := &Reference{ptr} ref := &Reference{ptr: ptr}
runtime.SetFinalizer(ref, (*Reference).Free) runtime.SetFinalizer(ref, (*Reference).Free)
return ref return ref
} }
@ -192,11 +191,12 @@ type NameIterator interface {
type ReferenceIterator interface { type ReferenceIterator interface {
NameIterator NameIterator
Next() (*Reference, error) NextReference() (*Reference, error)
} }
type gitReferenceIterator struct { type gitReferenceIterator struct {
ptr *C.git_reference_iterator ptr *C.git_reference_iterator
repo *Repository
} }
// NewReferenceIterator creates a new iterator over reference names // NewReferenceIterator creates a new iterator over reference names
@ -211,7 +211,7 @@ func (repo *Repository) NewReferenceIterator() (ReferenceIterator, error) {
return nil, MakeGitError(ret) return nil, MakeGitError(ret)
} }
iter := &gitReferenceIterator{ptr: ptr} iter := &gitReferenceIterator{ptr: ptr, repo: repo}
runtime.SetFinalizer(iter, (*gitReferenceIterator).Free) runtime.SetFinalizer(iter, (*gitReferenceIterator).Free)
return iter, nil return iter, nil
} }
@ -275,7 +275,7 @@ func NameIteratorChannel(v NameIterator) <-chan string {
// Next retrieves the next reference. If the iterationis over, the // Next retrieves the next reference. If the iterationis over, the
// returned error is git.ErrIterOver // returned error is git.ErrIterOver
func (v *gitReferenceIterator) Next() (*Reference, error) { func (v *gitReferenceIterator) NextReference() (*Reference, error) {
var ptr *C.git_reference var ptr *C.git_reference
ret := C.git_reference_next(&ptr, v.ptr) ret := C.git_reference_next(&ptr, v.ptr)
if ret == ITEROVER { if ret == ITEROVER {
@ -301,10 +301,10 @@ func ReferenceIteratorChannel(v ReferenceIterator) <-chan *Reference {
ch := make(chan *Reference) ch := make(chan *Reference)
go func() { go func() {
defer close(ch) defer close(ch)
name, err := v.Next() name, err := v.NextReference()
for err == nil { for err == nil {
ch <- name ch <- name
name, err = v.Next() name, err = v.NextReference()
} }
}() }()

View File

@ -122,10 +122,10 @@ func TestReferenceIterator(t *testing.T) {
iter, err = repo.NewReferenceIterator() iter, err = repo.NewReferenceIterator()
checkFatal(t, err) checkFatal(t, err)
count := 0 count := 0
_, err = iter.Next() _, err = iter.NextReference()
for err == nil { for err == nil {
count++ count++
_, err = iter.Next() _, err = iter.NextReference()
} }
if err != ErrIterOver { if err != ErrIterOver {
t.Fatal("Iteration not over") t.Fatal("Iteration not over")