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
|
# (Be in -*- python -*- mode.)
#
# ====================================================================
# Copyright (c) 2000-2008 CollabNet. All rights reserved.
#
# This software is licensed as described in the file COPYING, which
# you should have received as part of this distribution. The terms
# are also available at http://subversion.tigris.org/license-1.html.
# If newer versions of this license are posted there, you may use a
# newer version instead, at your option.
#
# This software consists of voluntary contributions made by many
# individuals. For exact contribution history, see the revision
# history and logs, available at http://cvs2svn.tigris.org/.
# ====================================================================
"""This module describes the interface to the CVS repository."""
class RevisionRecorder:
"""An object that can record text and deltas from CVS files."""
def __init__(self):
"""Initialize the RevisionRecorder.
Please note that a RevisionRecorder is instantiated in every
program run, even if the data-collection pass will not be
executed. (This is to allow it to register the artifacts that it
produces.) Therefore, the __init__() method should not do much,
and more substantial preparation for use (like actually creating
the artifacts) should be done in start()."""
pass
def register_artifacts(self, which_pass):
"""Register artifacts that will be needed during data recording.
WHICH_PASS is the pass that will call our callbacks, so it should
be used to do the registering (e.g., call
WHICH_PASS.register_temp_file() and/or
WHICH_PASS.register_temp_file_needed())."""
pass
def start(self):
"""Data will soon start being collected.
Any non-idempotent initialization should be done here."""
pass
def start_file(self, cvs_file_items):
"""Prepare to receive data for the file with the specified CVS_FILE_ITEMS.
CVS_FILE_ITEMS is an instance of CVSFileItems describing the file
dependency topology right after the file tree was parsed out of
the RCS file. (I.e., it reflects the original CVS dependency
structure.) Please note that the CVSFileItems instance will be
changed later."""
pass
def record_text(self, cvs_rev, log, text):
"""Record information about a revision and optionally return a token.
CVS_REV is a CVSRevision instance describing a revision that has
log message LOG and text TEXT (as retrieved from the RCS file).
(TEXT is full text for the HEAD revision, and deltas for other
revisions.)"""
raise NotImplementedError()
def finish_file(self, cvs_file_items):
"""The current file is finished; finish and clean up.
CVS_FILE_ITEMS is a CVSFileItems instance describing the file's
items at the end of processing of the RCS file in CollectRevsPass.
It may be modified relative to the CVS_FILE_ITEMS instance passed
to the corresponding start_file() call (revisions might be
deleted, topology changed, etc)."""
pass
def finish(self):
"""All recording is done; clean up."""
pass
class NullRevisionRecorder(RevisionRecorder):
"""A do-nothing variety of RevisionRecorder."""
def record_text(self, cvs_rev, log, text):
return None
class RevisionExcluder:
"""An interface for informing a RevisionReader about excluded revisions.
Currently, revisions can be excluded via the --exclude option and
various fixups for CVS peculiarities. This interface can be used to
inform the associated RevisionReader about CVSItems that are being
excluded. (The recorder might use that information to free some
temporary data or adjust its expectations about which revisions will
later be read.)"""
def __init__(self):
"""Initialize the RevisionExcluder.
Please note that a RevisionExcluder is instantiated in every
program run, even if the branch-exclusion pass will not be
executed. (This is to allow its register_artifacts() method to be
called.) Therefore, the __init__() method should not do much, and
more substantial preparation for use (like actually creating the
artifacts) should be done in start()."""
pass
def register_artifacts(self, which_pass):
"""Register artifacts that will be needed during branch exclusion.
WHICH_PASS is the pass that will call our callbacks, so it should
be used to do the registering (e.g., call
WHICH_PASS.register_temp_file() and/or
WHICH_PASS.register_temp_file_needed())."""
pass
def start(self):
"""Prepare to handle branch exclusions."""
pass
def process_file(self, cvs_file_items):
"""Called for files whose trees were modified in FilterSymbolsPass.
This callback is called once for each CVSFile whose topology was
modified in FilterSymbolsPass."""
raise NotImplementedError()
def finish(self):
"""Called after all branch exclusions for all files are done."""
pass
class NullRevisionExcluder(RevisionExcluder):
"""A do-nothing variety of RevisionExcluder."""
def process_file(self, cvs_file_items):
pass
class RevisionReader(object):
"""An object that can read the contents of CVSRevisions."""
def register_artifacts(self, which_pass):
"""Register artifacts that will be needed during branch exclusion.
WHICH_PASS is the pass that will call our callbacks, so it should
be used to do the registering (e.g., call
WHICH_PASS.register_temp_file() and/or
WHICH_PASS.register_temp_file_needed())."""
pass
def start(self):
"""Prepare for calls to get_content_stream."""
pass
def get_content_stream(self, cvs_rev, suppress_keyword_substitution=False):
"""Return a file-like object from which the contents of CVS_REV
can be read.
CVS_REV is a CVSRevision. If SUPPRESS_KEYWORD_SUBSTITUTION is
True, then suppress the substitution of RCS/CVS keywords in the
output."""
raise NotImplementedError
def finish(self):
"""Inform the reader that all calls to get_content_stream are done.
Start may be called again at a later point."""
pass
|
GitWeb