← Back to branch summary

~ubuntu-branches/ubuntu/saucy/monodevelop/saucy

« back to all changes in this revision

Viewing changes to contrib/NGit/NGit.Revwalk/Generator.cs

  • Committer: Package Import Robot
  • Author(s): Jo Shields
  • Date: 2012-05-27 18:08:20 UTC
  • mfrom: (1.8.5) (1.5.8 sid)
  • Revision ID: package-import@ubuntu.com-20120527180820-f1ub6lhg0s50wci1
Tags: 3.0.2+dfsg-3
* [fcecfe7] Fix monodevelop-core-addins.pc.in to point to actual 
  installed location of assemblies.
* [26e1a07] DebSrc 3.0 does not support Quilt's -p parameter, so 
  manually adjust the path in the patch file.

Show diffs side-by-side

added added

removed removed

Lines of Context:
contrib/NGit/NGit.Revwalk/Generator.cs
1
 
/*
2
 
This code is derived from jgit (http://eclipse.org/jgit).
3
 
Copyright owners are documented in jgit's IP log.
4
 
 
5
 
This program and the accompanying materials are made available
6
 
under the terms of the Eclipse Distribution License v1.0 which
7
 
accompanies this distribution, is reproduced below, and is
8
 
available at http://www.eclipse.org/org/documents/edl-v10.php
9
 
 
10
 
All rights reserved.
11
 
 
12
 
Redistribution and use in source and binary forms, with or
13
 
without modification, are permitted provided that the following
14
 
conditions are met:
15
 
 
16
 
- Redistributions of source code must retain the above copyright
17
 
  notice, this list of conditions and the following disclaimer.
18
 
 
19
 
- Redistributions in binary form must reproduce the above
20
 
  copyright notice, this list of conditions and the following
21
 
  disclaimer in the documentation and/or other materials provided
22
 
  with the distribution.
23
 
 
24
 
- Neither the name of the Eclipse Foundation, Inc. nor the
25
 
  names of its contributors may be used to endorse or promote
26
 
  products derived from this software without specific prior
27
 
  written permission.
28
 
 
29
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30
 
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31
 
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32
 
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33
 
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34
 
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35
 
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36
 
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37
 
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38
 
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39
 
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40
 
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41
 
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42
 
*/
43
 
 
44
 
using NGit.Revwalk;
45
 
using Sharpen;
46
 
 
47
 
namespace NGit.Revwalk
48
 
{
49
 
        /// <summary>Produces commits for RevWalk to return to applications.</summary>
50
 
        /// <remarks>
51
 
        /// Produces commits for RevWalk to return to applications.
52
 
        /// <p>
53
 
        /// Implementations of this basic class provide the real work behind RevWalk.
54
 
        /// Conceptually a Generator is an iterator or a queue, it returns commits until
55
 
        /// there are no more relevant. Generators may be piped/stacked together to
56
 
        /// create a more complex set of operations.
57
 
        /// </remarks>
58
 
        /// <seealso cref="PendingGenerator">PendingGenerator</seealso>
59
 
        /// <seealso cref="StartGenerator">StartGenerator</seealso>
60
 
        public abstract class Generator
61
 
        {
62
 
                /// <summary>Commits are sorted by commit date and time, descending.</summary>
63
 
                /// <remarks>Commits are sorted by commit date and time, descending.</remarks>
64
 
                internal const int SORT_COMMIT_TIME_DESC = 1 << 0;
65
 
 
66
 
                /// <summary>
67
 
                /// Output may have
68
 
                /// <see cref="RevWalk.REWRITE">RevWalk.REWRITE</see>
69
 
                /// marked on it.
70
 
                /// </summary>
71
 
                internal const int HAS_REWRITE = 1 << 1;
72
 
 
73
 
                /// <summary>
74
 
                /// Output needs
75
 
                /// <see cref="RewriteGenerator">RewriteGenerator</see>
76
 
                /// .
77
 
                /// </summary>
78
 
                internal const int NEEDS_REWRITE = 1 << 2;
79
 
 
80
 
                /// <summary>Topological ordering is enforced (all children before parents).</summary>
81
 
                /// <remarks>Topological ordering is enforced (all children before parents).</remarks>
82
 
                internal const int SORT_TOPO = 1 << 3;
83
 
 
84
 
                /// <summary>
85
 
                /// Output may have
86
 
                /// <see cref="RevWalk.UNINTERESTING">RevWalk.UNINTERESTING</see>
87
 
                /// marked on it.
88
 
                /// </summary>
89
 
                internal const int HAS_UNINTERESTING = 1 << 4;
90
 
 
91
 
                /// <summary>Connect the supplied queue to this generator's own free list (if any).</summary>
92
 
                /// <remarks>Connect the supplied queue to this generator's own free list (if any).</remarks>
93
 
                /// <param name="q">another FIFO queue that wants to share our queue's free list.</param>
94
 
                internal virtual void ShareFreeList(BlockRevQueue q)
95
 
                {
96
 
                }
97
 
 
98
 
                // Do nothing by default.
99
 
                /// <summary>Obtain flags describing the output behavior of this generator.</summary>
100
 
                /// <remarks>Obtain flags describing the output behavior of this generator.</remarks>
101
 
                /// <returns>
102
 
                /// one or more of the constants declared in this class, describing
103
 
                /// how this generator produces its results.
104
 
                /// </returns>
105
 
                internal abstract int OutputType();
106
 
 
107
 
                /// <summary>Return the next commit to the application, or the next generator.</summary>
108
 
                /// <remarks>Return the next commit to the application, or the next generator.</remarks>
109
 
                /// <returns>next available commit; null if no more are to be returned.</returns>
110
 
                /// <exception cref="NGit.Errors.MissingObjectException">NGit.Errors.MissingObjectException
111
 
                ///     </exception>
112
 
                /// <exception cref="NGit.Errors.IncorrectObjectTypeException">NGit.Errors.IncorrectObjectTypeException
113
 
                ///     </exception>
114
 
                /// <exception cref="System.IO.IOException">System.IO.IOException</exception>
115
 
                internal abstract RevCommit Next();
116
 
        }
117
 
}