1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
|
using System;
using System.Diagnostics;
using System.Globalization;
using LibGit2Sharp.Core;
namespace LibGit2Sharp
{
/// <summary>
/// A base class for things that wrap a <see cref="Reference"/> (branch, tag, etc).
/// </summary>
/// <typeparam name="TObject">The type of the referenced Git object.</typeparam>
[DebuggerDisplay("{DebuggerDisplay,nq}")]
public abstract class ReferenceWrapper<TObject> : IEquatable<ReferenceWrapper<TObject>>, IBelongToARepository where TObject : GitObject
{
/// <summary>
/// The repository.
/// </summary>
protected readonly Repository repo;
private readonly Lazy<TObject> objectBuilder;
private static readonly LambdaEqualityHelper<ReferenceWrapper<TObject>> equalityHelper =
new LambdaEqualityHelper<ReferenceWrapper<TObject>>(x => x.CanonicalName, x => x.TargetObject);
private readonly string canonicalName;
/// <summary>
/// Needed for mocking purposes.
/// </summary>
protected ReferenceWrapper()
{ }
/// <param name="repo">The repository.</param>
/// <param name="reference">The reference.</param>
/// <param name="canonicalNameSelector">A function to construct the reference's canonical name.</param>
protected internal ReferenceWrapper(Repository repo, Reference reference, Func<Reference, string> canonicalNameSelector)
{
Ensure.ArgumentNotNull(repo, "repo");
Ensure.ArgumentNotNull(reference, "reference");
Ensure.ArgumentNotNull(canonicalNameSelector, "canonicalNameSelector");
this.repo = repo;
canonicalName = canonicalNameSelector(reference);
objectBuilder = new Lazy<TObject>(() => RetrieveTargetObject(reference));
}
/// <summary>
/// Gets the full name of this reference.
/// </summary>
public virtual string CanonicalName
{
get { return canonicalName; }
}
/// <summary>
/// Gets the name of this reference.
/// </summary>
public virtual string Name
{
get { return Shorten(); }
}
/// <summary>
/// Returns the <see cref="CanonicalName"/>, a <see cref="string"/> representation of the current reference.
/// </summary>
/// <returns>The <see cref="CanonicalName"/> that represents the current reference.</returns>
public override string ToString()
{
return CanonicalName;
}
/// <summary>
/// Gets the <typeparamref name="TObject"/> this <see cref="ReferenceWrapper{TObject}"/> points to.
/// </summary>
protected TObject TargetObject
{
get { return objectBuilder.Value; }
}
/// <summary>
/// Removes redundent leading namespaces (regarding the kind of
/// reference being wrapped) from the canonical name.
/// </summary>
/// <returns>The friendly shortened name</returns>
protected abstract string Shorten();
private TObject RetrieveTargetObject(Reference reference)
{
var directReference = reference.ResolveToDirectReference();
if (directReference == null)
{
return null;
}
var target = directReference.Target;
if (target == null)
{
return null;
}
return repo.Lookup<TObject>(target.Id);
}
/// <summary>
/// Determines whether the specified <see cref="ReferenceWrapper{TObject}"/> is equal to the current <see cref="ReferenceWrapper{TObject}"/>.
/// </summary>
/// <param name="other">The <see cref="ReferenceWrapper{TObject}"/> to compare with the current <see cref="ReferenceWrapper{TObject}"/>.</param>
/// <returns>True if the specified <see cref="ReferenceWrapper{TObject}"/> is equal to the current <see cref="ReferenceWrapper{TObject}"/>; otherwise, false.</returns>
public bool Equals(ReferenceWrapper<TObject> other)
{
return equalityHelper.Equals(this, other);
}
/// <summary>
/// Determines whether the specified <see cref="Object"/> is equal to the current <see cref="ReferenceWrapper{TObject}"/>.
/// </summary>
/// <param name="obj">The <see cref="Object"/> to compare with the current <see cref="ReferenceWrapper{TObject}"/>.</param>
/// <returns>True if the specified <see cref="Object"/> is equal to the current <see cref="ReferenceWrapper{TObject}"/>; otherwise, false.</returns>
public override bool Equals(object obj)
{
return Equals(obj as ReferenceWrapper<TObject>);
}
/// <summary>
/// Returns the hash code for this instance.
/// </summary>
/// <returns>A 32-bit signed integer hash code.</returns>
public override int GetHashCode()
{
return equalityHelper.GetHashCode(this);
}
/// <summary>
/// Tests if two <see cref="ReferenceWrapper{TObject}"/> are equal.
/// </summary>
/// <param name="left">First <see cref="ReferenceWrapper{TObject}"/> to compare.</param>
/// <param name="right">Second <see cref="ReferenceWrapper{TObject}"/> to compare.</param>
/// <returns>True if the two objects are equal; false otherwise.</returns>
public static bool operator ==(ReferenceWrapper<TObject> left, ReferenceWrapper<TObject> right)
{
return Equals(left, right);
}
/// <summary>
/// Tests if two <see cref="ReferenceWrapper{TObject}"/> are different.
/// </summary>
/// <param name="left">First <see cref="ReferenceWrapper{TObject}"/> to compare.</param>
/// <param name="right">Second <see cref="ReferenceWrapper{TObject}"/> to compare.</param>
/// <returns>True if the two objects are different; false otherwise.</returns>
public static bool operator !=(ReferenceWrapper<TObject> left, ReferenceWrapper<TObject> right)
{
return !Equals(left, right);
}
private string DebuggerDisplay
{
get
{
return string.Format(CultureInfo.InvariantCulture,
"{0} => \"{1}\"", CanonicalName,
(TargetObject != null) ? TargetObject.Id.ToString(7) : "?");
}
}
IRepository IBelongToARepository.Repository { get { return repo; } }
}
}
|
