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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
using System;
using System.Diagnostics;
using System.Globalization;
using LibGit2Sharp.Core;
using LibGit2Sharp.Core.Handles;
namespace LibGit2Sharp
{
/// <summary>
/// A Reference to another git object
/// </summary>
[DebuggerDisplay("{DebuggerDisplay,nq}")]
public abstract class Reference : IEquatable<Reference>
{
private static readonly LambdaEqualityHelper<Reference> equalityHelper =
new LambdaEqualityHelper<Reference>(x => x.CanonicalName, x => x.TargetIdentifier);
private readonly IRepository repo;
private readonly string canonicalName;
private readonly string targetIdentifier;
/// <summary>
/// Needed for mocking purposes.
/// </summary>
protected Reference()
{ }
/// <summary>
/// Initializes a new instance of the <see cref="Reference"/> class.
/// </summary>
/// <param name="canonicalName">The canonical name.</param>
/// <param name="targetIdentifier">The target identifier.</param>
[Obsolete("This ctor will be removed in a future release.")]
protected Reference(string canonicalName, string targetIdentifier)
: this(null, canonicalName, targetIdentifier)
{
}
/// <remarks>
/// This would be protected+internal, were that supported by C#.
/// Do not use except in subclasses.
/// </remarks>
internal Reference(IRepository repo, string canonicalName, string targetIdentifier)
{
this.repo = repo;
this.canonicalName = canonicalName;
this.targetIdentifier = targetIdentifier;
}
internal static T BuildFromPtr<T>(ReferenceSafeHandle handle, Repository repo) where T : Reference
{
GitReferenceType type = Proxy.git_reference_type(handle);
string name = Proxy.git_reference_name(handle);
Reference reference;
switch (type)
{
case GitReferenceType.Symbolic:
string targetIdentifier = Proxy.git_reference_symbolic_target(handle);
var targetRef = repo.Refs[targetIdentifier];
reference = new SymbolicReference(repo, name, targetIdentifier, targetRef);
break;
case GitReferenceType.Oid:
ObjectId targetOid = Proxy.git_reference_target(handle);
reference = new DirectReference(name, repo, targetOid);
break;
default:
throw new LibGit2SharpException(String.Format(CultureInfo.InvariantCulture, "Unable to build a new reference from a type '{0}'.", type));
}
return reference as T;
}
/// <summary>
/// Determines if the proposed reference name is well-formed.
/// </summary>
/// <para>
/// - Top-level names must contain only capital letters and underscores,
/// and must begin and end with a letter. (e.g. "HEAD", "ORIG_HEAD").
///
/// - Names prefixed with "refs/" can be almost anything. You must avoid
/// the characters '~', '^', ':', '\\', '?', '[', and '*', and the
/// sequences ".." and "@{" which have special meaning to revparse.
/// </para>
/// <param name="canonicalName">The name to be checked.</param>
/// <returns>true is the name is valid; false otherwise.</returns>
public static bool IsValidName(string canonicalName)
{
return Proxy.git_reference_is_valid_name(canonicalName);
}
/// <summary>
/// Gets the full name of this reference.
/// </summary>
public virtual string CanonicalName
{
get { return canonicalName; }
}
/// <summary>
/// Recursively peels the target of the reference until a direct reference is encountered.
/// </summary>
/// <returns>The <see cref="DirectReference"/> this <see cref="Reference"/> points to.</returns>
public abstract DirectReference ResolveToDirectReference();
/// <summary>
/// Gets the target declared by the reference.
/// <para>
/// If this reference is a <see cref="SymbolicReference"/>, returns the canonical name of the target.
/// Otherwise, if this reference is a <see cref="DirectReference"/>, returns the sha of the target.
/// </para>
/// </summary>
// TODO: Maybe find a better name for this property.
public virtual string TargetIdentifier
{
get { return targetIdentifier; }
}
/// <summary>
/// Determines whether the specified <see cref="Object"/> is equal to the current <see cref="Reference"/>.
/// </summary>
/// <param name="obj">The <see cref="Object"/> to compare with the current <see cref="Reference"/>.</param>
/// <returns>True if the specified <see cref="Object"/> is equal to the current <see cref="Reference"/>; otherwise, false.</returns>
public override bool Equals(object obj)
{
return Equals(obj as Reference);
}
/// <summary>
/// Determines whether the specified <see cref="Reference"/> is equal to the current <see cref="Reference"/>.
/// </summary>
/// <param name="other">The <see cref="Reference"/> to compare with the current <see cref="Reference"/>.</param>
/// <returns>True if the specified <see cref="Reference"/> is equal to the current <see cref="Reference"/>; otherwise, false.</returns>
public bool Equals(Reference other)
{
return equalityHelper.Equals(this, other);
}
/// <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="Reference"/> are equal.
/// </summary>
/// <param name="left">First <see cref="Reference"/> to compare.</param>
/// <param name="right">Second <see cref="Reference"/> to compare.</param>
/// <returns>True if the two objects are equal; false otherwise.</returns>
public static bool operator ==(Reference left, Reference right)
{
return Equals(left, right);
}
/// <summary>
/// Tests if two <see cref="Reference"/> are different.
/// </summary>
/// <param name="left">First <see cref="Reference"/> to compare.</param>
/// <param name="right">Second <see cref="Reference"/> to compare.</param>
/// <returns>True if the two objects are different; false otherwise.</returns>
public static bool operator !=(Reference left, Reference right)
{
return !Equals(left, right);
}
/// <summary>
/// Returns the <see cref="CanonicalName"/>, a <see cref="String"/> representation of the current <see cref="Reference"/>.
/// </summary>
/// <returns>The <see cref="CanonicalName"/> that represents the current <see cref="Reference"/>.</returns>
public override string ToString()
{
return CanonicalName;
}
internal static string LocalBranchPrefix
{
get { return "refs/heads/"; }
}
internal static string RemoteTrackingBranchPrefix
{
get { return "refs/remotes/"; }
}
internal static string TagPrefix
{
get { return "refs/tags/"; }
}
internal static string NotePrefix
{
get { return "refs/notes/"; }
}
private string DebuggerDisplay
{
get
{
return string.Format(CultureInfo.InvariantCulture,
"{0} => \"{1}\"", CanonicalName, TargetIdentifier);
}
}
}
}
|
