← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revisionspec.py

  • Committer: Patch Queue Manager
  • Date: 2014-02-12 18:22:22 UTC
  • mfrom: (6589.2.1 trunk)
  • Revision ID: pqm@pqm.ubuntu.com-20140212182222-beouo25gaf1cny76
(vila) The XDG Base Directory Specification uses the XDG_CACHE_HOME,
 not XDG_CACHE_DIR. (Andrew Starr-Bochicchio)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/revisionspec.py
1
 
# Copyright (C) 2005 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
 
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
from __future__ import absolute_import
 
18
 
 
19
 
 
20
from bzrlib.lazy_import import lazy_import
 
21
lazy_import(globals(), """
18
22
import bisect
19
23
import datetime
20
 
import re
21
24
 
22
25
from bzrlib import (
23
 
    errors,
 
26
    branch as _mod_branch,
 
27
    osutils,
24
28
    revision,
25
29
    symbol_versioning,
 
30
    workingtree,
 
31
    )
 
32
from bzrlib.i18n import gettext
 
33
""")
 
34
 
 
35
from bzrlib import (
 
36
    errors,
 
37
    lazy_regex,
 
38
    registry,
26
39
    trace,
27
 
    tsort,
28
40
    )
29
41
 
30
42
 
31
 
_marker = []
32
 
 
33
 
 
34
43
class RevisionInfo(object):
35
44
    """The results of applying a revision specification to a branch."""
36
45
 
48
57
    or treat the result as a tuple.
49
58
    """
50
59
 
51
 
    def __init__(self, branch, revno, rev_id=_marker):
 
60
    def __init__(self, branch, revno=None, rev_id=None):
52
61
        self.branch = branch
53
 
        self.revno = revno
54
 
        if rev_id is _marker:
 
62
        self._has_revno = (revno is not None)
 
63
        self._revno = revno
 
64
        self.rev_id = rev_id
 
65
        if self.rev_id is None and self._revno is not None:
55
66
            # allow caller to be lazy
56
 
            if self.revno is None:
57
 
                self.rev_id = None
58
 
            else:
59
 
                self.rev_id = branch.get_rev_id(self.revno)
60
 
        else:
61
 
            self.rev_id = rev_id
 
67
            self.rev_id = branch.get_rev_id(self._revno)
 
68
 
 
69
    @property
 
70
    def revno(self):
 
71
        if not self._has_revno and self.rev_id is not None:
 
72
            try:
 
73
                self._revno = self.branch.revision_id_to_revno(self.rev_id)
 
74
            except errors.NoSuchRevision:
 
75
                self._revno = None
 
76
            self._has_revno = True
 
77
        return self._revno
62
78
 
63
79
    def __nonzero__(self):
64
 
        # first the easy ones...
65
80
        if self.rev_id is None:
66
81
            return False
67
 
        if self.revno is not None:
68
 
            return True
69
82
        # TODO: otherwise, it should depend on how I was built -
70
83
        # if it's in_history(branch), then check revision_history(),
71
84
        # if it's in_store(branch), do the check below
93
106
        return '<bzrlib.revisionspec.RevisionInfo object %s, %s for %r>' % (
94
107
            self.revno, self.rev_id, self.branch)
95
108
 
 
109
    @staticmethod
 
110
    def from_revision_id(branch, revision_id, revs=symbol_versioning.DEPRECATED_PARAMETER):
 
111
        """Construct a RevisionInfo given just the id.
96
112
 
97
 
# classes in this list should have a "prefix" attribute, against which
98
 
# string specs are matched
99
 
SPEC_TYPES = []
100
 
_revno_regex = None
 
113
        Use this if you don't know or care what the revno is.
 
114
        """
 
115
        if symbol_versioning.deprecated_passed(revs):
 
116
            symbol_versioning.warn(
 
117
                'RevisionInfo.from_revision_id(revs) was deprecated in 2.5.',
 
118
                DeprecationWarning,
 
119
                stacklevel=2)
 
120
        return RevisionInfo(branch, revno=None, rev_id=revision_id)
101
121
 
102
122
 
103
123
class RevisionSpec(object):
105
125
 
106
126
    help_txt = """A parsed revision specification.
107
127
 
108
 
    A revision specification can be an integer, in which case it is
109
 
    assumed to be a revno (though this will translate negative values
110
 
    into positive ones); or it can be a string, in which case it is
111
 
    parsed for something like 'date:' or 'revid:' etc.
 
128
    A revision specification is a string, which may be unambiguous about
 
129
    what it represents by giving a prefix like 'date:' or 'revid:' etc,
 
130
    or it may have no prefix, in which case it's tried against several
 
131
    specifier types in sequence to determine what the user meant.
112
132
 
113
133
    Revision specs are an UI element, and they have been moved out
114
134
    of the branch class to leave "back-end" classes unaware of such
120
140
    """
121
141
 
122
142
    prefix = None
123
 
 
124
 
    def __new__(cls, spec, _internal=False):
125
 
        if _internal:
126
 
            return object.__new__(cls, spec, _internal=_internal)
127
 
 
128
 
        symbol_versioning.warn('Creating a RevisionSpec directly has'
129
 
                               ' been deprecated in version 0.11. Use'
130
 
                               ' RevisionSpec.from_string()'
131
 
                               ' instead.',
132
 
                               DeprecationWarning, stacklevel=2)
133
 
        return RevisionSpec.from_string(spec)
 
143
    # wants_revision_history has been deprecated in 2.5.
 
144
    wants_revision_history = False
 
145
    dwim_catchable_exceptions = (errors.InvalidRevisionSpec,)
 
146
    """Exceptions that RevisionSpec_dwim._match_on will catch.
 
147
 
 
148
    If the revspec is part of ``dwim_revspecs``, it may be tried with an
 
149
    invalid revspec and raises some exception. The exceptions mentioned here
 
150
    will not be reported to the user but simply ignored without stopping the
 
151
    dwim processing.
 
152
    """
134
153
 
135
154
    @staticmethod
136
155
    def from_string(spec):
145
164
 
146
165
        if spec is None:
147
166
            return RevisionSpec(None, _internal=True)
148
 
 
149
 
        assert isinstance(spec, basestring), \
150
 
            "You should only supply strings not %s" % (type(spec),)
151
 
 
152
 
        for spectype in SPEC_TYPES:
153
 
            if spec.startswith(spectype.prefix):
154
 
                trace.mutter('Returning RevisionSpec %s for %s',
155
 
                             spectype.__name__, spec)
156
 
                return spectype(spec, _internal=True)
 
167
        match = revspec_registry.get_prefix(spec)
 
168
        if match is not None:
 
169
            spectype, specsuffix = match
 
170
            trace.mutter('Returning RevisionSpec %s for %s',
 
171
                         spectype.__name__, spec)
 
172
            return spectype(spec, _internal=True)
157
173
        else:
158
 
            # RevisionSpec_revno is special cased, because it is the only
159
 
            # one that directly handles plain integers
160
 
            # TODO: This should not be special cased rather it should be
161
 
            # a method invocation on spectype.canparse()
162
 
            global _revno_regex
163
 
            if _revno_regex is None:
164
 
                _revno_regex = re.compile(r'^(?:(\d+(\.\d+)*)|-\d+)(:.*)?$')
165
 
            if _revno_regex.match(spec) is not None:
166
 
                return RevisionSpec_revno(spec, _internal=True)
167
 
 
168
 
            raise errors.NoSuchRevisionSpec(spec)
 
174
            # Otherwise treat it as a DWIM, build the RevisionSpec object and
 
175
            # wait for _match_on to be called.
 
176
            return RevisionSpec_dwim(spec, _internal=True)
169
177
 
170
178
    def __init__(self, spec, _internal=False):
171
179
        """Create a RevisionSpec referring to the Null revision.
175
183
            called directly. Only from RevisionSpec.from_string()
176
184
        """
177
185
        if not _internal:
178
 
            # XXX: Update this after 0.10 is released
179
186
            symbol_versioning.warn('Creating a RevisionSpec directly has'
180
187
                                   ' been deprecated in version 0.11. Use'
181
188
                                   ' RevisionSpec.from_string()'
188
195
 
189
196
    def _match_on(self, branch, revs):
190
197
        trace.mutter('Returning RevisionSpec._match_on: None')
191
 
        return RevisionInfo(branch, 0, None)
 
198
        return RevisionInfo(branch, None, None)
192
199
 
193
200
    def _match_on_and_check(self, branch, revs):
194
201
        info = self._match_on(branch, revs)
195
202
        if info:
196
203
            return info
197
 
        elif info == (0, None):
198
 
            # special case - the empty tree
 
204
        elif info == (None, None):
 
205
            # special case - nothing supplied
199
206
            return info
200
207
        elif self.prefix:
201
208
            raise errors.InvalidRevisionSpec(self.user_spec, branch)
204
211
 
205
212
    def in_history(self, branch):
206
213
        if branch:
207
 
            revs = branch.revision_history()
 
214
            if self.wants_revision_history:
 
215
                symbol_versioning.warn(
 
216
                    "RevisionSpec.wants_revision_history was "
 
217
                    "deprecated in 2.5 (%s)." % self.__class__.__name__,
 
218
                    DeprecationWarning)
 
219
                branch.lock_read()
 
220
                try:
 
221
                    graph = branch.repository.get_graph()
 
222
                    revs = list(graph.iter_lefthand_ancestry(
 
223
                        branch.last_revision(), [revision.NULL_REVISION]))
 
224
                finally:
 
225
                    branch.unlock()
 
226
                revs.reverse()
 
227
            else:
 
228
                revs = None
208
229
        else:
209
230
            # this should never trigger.
210
231
            # TODO: make it a deprecated code path. RBC 20060928
220
241
    # will do what you expect.
221
242
    in_store = in_history
222
243
    in_branch = in_store
223
 
        
 
244
 
 
245
    def as_revision_id(self, context_branch):
 
246
        """Return just the revision_id for this revisions spec.
 
247
 
 
248
        Some revision specs require a context_branch to be able to determine
 
249
        their value. Not all specs will make use of it.
 
250
        """
 
251
        return self._as_revision_id(context_branch)
 
252
 
 
253
    def _as_revision_id(self, context_branch):
 
254
        """Implementation of as_revision_id()
 
255
 
 
256
        Classes should override this function to provide appropriate
 
257
        functionality. The default is to just call '.in_history().rev_id'
 
258
        """
 
259
        return self.in_history(context_branch).rev_id
 
260
 
 
261
    def as_tree(self, context_branch):
 
262
        """Return the tree object for this revisions spec.
 
263
 
 
264
        Some revision specs require a context_branch to be able to determine
 
265
        the revision id and access the repository. Not all specs will make
 
266
        use of it.
 
267
        """
 
268
        return self._as_tree(context_branch)
 
269
 
 
270
    def _as_tree(self, context_branch):
 
271
        """Implementation of as_tree().
 
272
 
 
273
        Classes should override this function to provide appropriate
 
274
        functionality. The default is to just call '.as_revision_id()'
 
275
        and get the revision tree from context_branch's repository.
 
276
        """
 
277
        revision_id = self.as_revision_id(context_branch)
 
278
        return context_branch.repository.revision_tree(revision_id)
 
279
 
224
280
    def __repr__(self):
225
281
        # this is mostly for helping with testing
226
282
        return '<%s %s>' % (self.__class__.__name__,
227
283
                              self.user_spec)
228
 
    
 
284
 
229
285
    def needs_branch(self):
230
286
        """Whether this revision spec needs a branch.
231
287
 
235
291
 
236
292
    def get_branch(self):
237
293
        """When the revision specifier contains a branch location, return it.
238
 
        
 
294
 
239
295
        Otherwise, return None.
240
296
        """
241
297
        return None
243
299
 
244
300
# private API
245
301
 
 
302
class RevisionSpec_dwim(RevisionSpec):
 
303
    """Provides a DWIMish revision specifier lookup.
 
304
 
 
305
    Note that this does not go in the revspec_registry because by definition
 
306
    there is no prefix to identify it.  It's solely called from
 
307
    RevisionSpec.from_string() because the DWIMification happen when _match_on
 
308
    is called so the string describing the revision is kept here until needed.
 
309
    """
 
310
 
 
311
    help_txt = None
 
312
 
 
313
    _revno_regex = lazy_regex.lazy_compile(r'^(?:(\d+(\.\d+)*)|-\d+)(:.*)?$')
 
314
 
 
315
    # The revspecs to try
 
316
    _possible_revspecs = []
 
317
 
 
318
    def _try_spectype(self, rstype, branch):
 
319
        rs = rstype(self.spec, _internal=True)
 
320
        # Hit in_history to find out if it exists, or we need to try the
 
321
        # next type.
 
322
        return rs.in_history(branch)
 
323
 
 
324
    def _match_on(self, branch, revs):
 
325
        """Run the lookup and see what we can get."""
 
326
 
 
327
        # First, see if it's a revno
 
328
        if self._revno_regex.match(self.spec) is not None:
 
329
            try:
 
330
                return self._try_spectype(RevisionSpec_revno, branch)
 
331
            except RevisionSpec_revno.dwim_catchable_exceptions:
 
332
                pass
 
333
 
 
334
        # Next see what has been registered
 
335
        for objgetter in self._possible_revspecs:
 
336
            rs_class = objgetter.get_obj()
 
337
            try:
 
338
                return self._try_spectype(rs_class, branch)
 
339
            except rs_class.dwim_catchable_exceptions:
 
340
                pass
 
341
 
 
342
        # Try the old (deprecated) dwim list:
 
343
        for rs_class in dwim_revspecs:
 
344
            try:
 
345
                return self._try_spectype(rs_class, branch)
 
346
            except rs_class.dwim_catchable_exceptions:
 
347
                pass
 
348
 
 
349
        # Well, I dunno what it is. Note that we don't try to keep track of the
 
350
        # first of last exception raised during the DWIM tries as none seems
 
351
        # really relevant.
 
352
        raise errors.InvalidRevisionSpec(self.spec, branch)
 
353
 
 
354
    @classmethod
 
355
    def append_possible_revspec(cls, revspec):
 
356
        """Append a possible DWIM revspec.
 
357
 
 
358
        :param revspec: Revision spec to try.
 
359
        """
 
360
        cls._possible_revspecs.append(registry._ObjectGetter(revspec))
 
361
 
 
362
    @classmethod
 
363
    def append_possible_lazy_revspec(cls, module_name, member_name):
 
364
        """Append a possible lazily loaded DWIM revspec.
 
365
 
 
366
        :param module_name: Name of the module with the revspec
 
367
        :param member_name: Name of the revspec within the module
 
368
        """
 
369
        cls._possible_revspecs.append(
 
370
            registry._LazyObjectGetter(module_name, member_name))
 
371
 
 
372
 
246
373
class RevisionSpec_revno(RevisionSpec):
247
374
    """Selects a revision using a number."""
248
375
 
249
376
    help_txt = """Selects a revision using a number.
250
377
 
251
378
    Use an integer to specify a revision in the history of the branch.
252
 
    Optionally a branch can be specified. The 'revno:' prefix is optional.
253
 
    A negative number will count from the end of the branch (-1 is the
254
 
    last revision, -2 the previous one). If the negative number is larger
255
 
    than the branch's history, the first revision is returned.
256
 
    examples:
257
 
      revno:1                   -> return the first revision
 
379
    Optionally a branch can be specified.  A negative number will count
 
380
    from the end of the branch (-1 is the last revision, -2 the previous
 
381
    one). If the negative number is larger than the branch's history, the
 
382
    first revision is returned.
 
383
    Examples::
 
384
 
 
385
      revno:1                   -> return the first revision of this branch
258
386
      revno:3:/path/to/branch   -> return the 3rd revision of
259
387
                                   the branch '/path/to/branch'
260
388
      revno:-1                  -> The last revision in a branch.
267
395
 
268
396
    def _match_on(self, branch, revs):
269
397
        """Lookup a revision by revision number"""
 
398
        branch, revno, revision_id = self._lookup(branch)
 
399
        return RevisionInfo(branch, revno, revision_id)
 
400
 
 
401
    def _lookup(self, branch):
270
402
        loc = self.spec.find(':')
271
403
        if loc == -1:
272
404
            revno_spec = self.spec
286
418
                dotted = False
287
419
            except ValueError:
288
420
                # dotted decimal. This arguably should not be here
289
 
                # but the from_string method is a little primitive 
 
421
                # but the from_string method is a little primitive
290
422
                # right now - RBC 20060928
291
423
                try:
292
424
                    match_revno = tuple((int(number) for number in revno_spec.split('.')))
296
428
                dotted = True
297
429
 
298
430
        if branch_spec:
299
 
            # the user has override the branch to look in.
300
 
            # we need to refresh the revision_history map and
301
 
            # the branch object.
302
 
            from bzrlib.branch import Branch
303
 
            branch = Branch.open(branch_spec)
304
 
            # Need to use a new revision history
305
 
            # because we are using a specific branch
306
 
            revs = branch.revision_history()
 
431
            # the user has overriden the branch to look in.
 
432
            branch = _mod_branch.Branch.open(branch_spec)
307
433
 
308
434
        if dotted:
309
 
            branch.lock_read()
310
435
            try:
311
 
                last_rev = branch.last_revision()
312
 
                merge_sorted_revisions = tsort.merge_sort(
313
 
                    branch.repository.get_revision_graph(last_rev),
314
 
                    last_rev,
315
 
                    generate_revno=True)
316
 
                def match(item):
317
 
                    return item[3] == match_revno
318
 
                revisions = filter(match, merge_sorted_revisions)
319
 
            finally:
320
 
                branch.unlock()
321
 
            if len(revisions) != 1:
322
 
                return RevisionInfo(branch, None, None)
 
436
                revision_id = branch.dotted_revno_to_revision_id(match_revno,
 
437
                    _cache_reverse=True)
 
438
            except errors.NoSuchRevision:
 
439
                raise errors.InvalidRevisionSpec(self.user_spec, branch)
323
440
            else:
324
441
                # there is no traditional 'revno' for dotted-decimal revnos.
325
 
                # so for  API compatability we return None.
326
 
                return RevisionInfo(branch, None, revisions[0][1])
 
442
                # so for API compatibility we return None.
 
443
                return branch, None, revision_id
327
444
        else:
 
445
            last_revno, last_revision_id = branch.last_revision_info()
328
446
            if revno < 0:
329
447
                # if get_rev_id supported negative revnos, there would not be a
330
448
                # need for this special case.
331
 
                if (-revno) >= len(revs):
 
449
                if (-revno) >= last_revno:
332
450
                    revno = 1
333
451
                else:
334
 
                    revno = len(revs) + revno + 1
 
452
                    revno = last_revno + revno + 1
335
453
            try:
336
 
                revision_id = branch.get_rev_id(revno, revs)
 
454
                revision_id = branch.get_rev_id(revno)
337
455
            except errors.NoSuchRevision:
338
456
                raise errors.InvalidRevisionSpec(self.user_spec, branch)
339
 
        return RevisionInfo(branch, revno, revision_id)
340
 
        
 
457
        return branch, revno, revision_id
 
458
 
 
459
    def _as_revision_id(self, context_branch):
 
460
        # We would have the revno here, but we don't really care
 
461
        branch, revno, revision_id = self._lookup(context_branch)
 
462
        return revision_id
 
463
 
341
464
    def needs_branch(self):
342
465
        return self.spec.find(':') == -1
343
466
 
347
470
        else:
348
471
            return self.spec[self.spec.find(':')+1:]
349
472
 
350
 
# Old compatibility 
 
473
# Old compatibility
351
474
RevisionSpec_int = RevisionSpec_revno
352
475
 
353
 
SPEC_TYPES.append(RevisionSpec_revno)
354
 
 
355
 
 
356
 
class RevisionSpec_revid(RevisionSpec):
 
476
 
 
477
class RevisionIDSpec(RevisionSpec):
 
478
 
 
479
    def _match_on(self, branch, revs):
 
480
        revision_id = self.as_revision_id(branch)
 
481
        return RevisionInfo.from_revision_id(branch, revision_id)
 
482
 
 
483
 
 
484
class RevisionSpec_revid(RevisionIDSpec):
357
485
    """Selects a revision using the revision id."""
358
486
 
359
487
    help_txt = """Selects a revision using the revision id.
360
488
 
361
489
    Supply a specific revision id, that can be used to specify any
362
 
    revision id in the ancestry of the branch. 
 
490
    revision id in the ancestry of the branch.
363
491
    Including merges, and pending merges.
364
 
    examples:
 
492
    Examples::
 
493
 
365
494
      revid:aaaa@bbbb-123456789 -> Select revision 'aaaa@bbbb-123456789'
366
 
    """    
 
495
    """
 
496
 
367
497
    prefix = 'revid:'
368
498
 
369
 
    def _match_on(self, branch, revs):
370
 
        try:
371
 
            revno = revs.index(self.spec) + 1
372
 
        except ValueError:
373
 
            revno = None
374
 
        return RevisionInfo(branch, revno, self.spec)
 
499
    def _as_revision_id(self, context_branch):
 
500
        # self.spec comes straight from parsing the command line arguments,
 
501
        # so we expect it to be a Unicode string. Switch it to the internal
 
502
        # representation.
 
503
        return osutils.safe_revision_id(self.spec, warn=False)
375
504
 
376
 
SPEC_TYPES.append(RevisionSpec_revid)
377
505
 
378
506
 
379
507
class RevisionSpec_last(RevisionSpec):
383
511
 
384
512
    Supply a positive number to get the nth revision from the end.
385
513
    This is the same as supplying negative numbers to the 'revno:' spec.
386
 
    examples:
 
514
    Examples::
 
515
 
387
516
      last:1        -> return the last revision
388
517
      last:3        -> return the revision 2 before the end.
389
 
    """    
 
518
    """
390
519
 
391
520
    prefix = 'last:'
392
521
 
393
522
    def _match_on(self, branch, revs):
 
523
        revno, revision_id = self._revno_and_revision_id(branch)
 
524
        return RevisionInfo(branch, revno, revision_id)
 
525
 
 
526
    def _revno_and_revision_id(self, context_branch):
 
527
        last_revno, last_revision_id = context_branch.last_revision_info()
 
528
 
394
529
        if self.spec == '':
395
 
            if not revs:
396
 
                raise errors.NoCommits(branch)
397
 
            return RevisionInfo(branch, len(revs), revs[-1])
 
530
            if not last_revno:
 
531
                raise errors.NoCommits(context_branch)
 
532
            return last_revno, last_revision_id
398
533
 
399
534
        try:
400
535
            offset = int(self.spec)
401
536
        except ValueError, e:
402
 
            raise errors.InvalidRevisionSpec(self.user_spec, branch, e)
 
537
            raise errors.InvalidRevisionSpec(self.user_spec, context_branch, e)
403
538
 
404
539
        if offset <= 0:
405
 
            raise errors.InvalidRevisionSpec(self.user_spec, branch,
 
540
            raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
406
541
                                             'you must supply a positive value')
407
 
        revno = len(revs) - offset + 1
 
542
 
 
543
        revno = last_revno - offset + 1
408
544
        try:
409
 
            revision_id = branch.get_rev_id(revno, revs)
 
545
            revision_id = context_branch.get_rev_id(revno)
410
546
        except errors.NoSuchRevision:
411
 
            raise errors.InvalidRevisionSpec(self.user_spec, branch)
412
 
        return RevisionInfo(branch, revno, revision_id)
413
 
 
414
 
SPEC_TYPES.append(RevisionSpec_last)
 
547
            raise errors.InvalidRevisionSpec(self.user_spec, context_branch)
 
548
        return revno, revision_id
 
549
 
 
550
    def _as_revision_id(self, context_branch):
 
551
        # We compute the revno as part of the process, but we don't really care
 
552
        # about it.
 
553
        revno, revision_id = self._revno_and_revision_id(context_branch)
 
554
        return revision_id
 
555
 
415
556
 
416
557
 
417
558
class RevisionSpec_before(RevisionSpec):
419
560
 
420
561
    help_txt = """Selects the parent of the revision specified.
421
562
 
422
 
    Supply any revision spec to return the parent of that revision.
 
563
    Supply any revision spec to return the parent of that revision.  This is
 
564
    mostly useful when inspecting revisions that are not in the revision history
 
565
    of a branch.
 
566
 
423
567
    It is an error to request the parent of the null revision (before:0).
424
 
    This is mostly useful when inspecting revisions that are not in the
425
 
    revision history of a branch.
426
 
 
427
 
    examples:
 
568
 
 
569
    Examples::
 
570
 
428
571
      before:1913    -> Return the parent of revno 1913 (revno 1912)
429
572
      before:revid:aaaa@bbbb-1234567890  -> return the parent of revision
430
573
                                            aaaa@bbbb-1234567890
431
 
      bzr diff -r before:revid:aaaa..revid:aaaa
432
 
            -> Find the changes between revision 'aaaa' and its parent.
433
 
               (what changes did 'aaaa' introduce)
 
574
      bzr diff -r before:1913..1913
 
575
            -> Find the changes between revision 1913 and its parent (1912).
 
576
               (What changes did revision 1913 introduce).
 
577
               This is equivalent to:  bzr diff -c 1913
434
578
    """
435
579
 
436
580
    prefix = 'before:'
437
 
    
 
581
 
438
582
    def _match_on(self, branch, revs):
439
583
        r = RevisionSpec.from_string(self.spec)._match_on(branch, revs)
440
584
        if r.revno == 0:
444
588
            # We need to use the repository history here
445
589
            rev = branch.repository.get_revision(r.rev_id)
446
590
            if not rev.parent_ids:
447
 
                revno = 0
448
 
                revision_id = None
 
591
                revision_id = revision.NULL_REVISION
449
592
            else:
450
593
                revision_id = rev.parent_ids[0]
451
 
                try:
452
 
                    revno = revs.index(revision_id) + 1
453
 
                except ValueError:
454
 
                    revno = None
 
594
            revno = None
455
595
        else:
456
596
            revno = r.revno - 1
457
597
            try:
461
601
                                                 branch)
462
602
        return RevisionInfo(branch, revno, revision_id)
463
603
 
464
 
SPEC_TYPES.append(RevisionSpec_before)
 
604
    def _as_revision_id(self, context_branch):
 
605
        base_revision_id = RevisionSpec.from_string(self.spec)._as_revision_id(context_branch)
 
606
        if base_revision_id == revision.NULL_REVISION:
 
607
            raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
 
608
                                         'cannot go before the null: revision')
 
609
        context_repo = context_branch.repository
 
610
        context_repo.lock_read()
 
611
        try:
 
612
            parent_map = context_repo.get_parent_map([base_revision_id])
 
613
        finally:
 
614
            context_repo.unlock()
 
615
        if base_revision_id not in parent_map:
 
616
            # Ghost, or unknown revision id
 
617
            raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
 
618
                'cannot find the matching revision')
 
619
        parents = parent_map[base_revision_id]
 
620
        if len(parents) < 1:
 
621
            raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
 
622
                'No parents for revision.')
 
623
        return parents[0]
 
624
 
465
625
 
466
626
 
467
627
class RevisionSpec_tag(RevisionSpec):
468
 
    """To be implemented."""
469
 
 
470
 
    help_txt = """To be implemented."""
 
628
    """Select a revision identified by tag name"""
 
629
 
 
630
    help_txt = """Selects a revision identified by a tag name.
 
631
 
 
632
    Tags are stored in the branch and created by the 'tag' command.
 
633
    """
471
634
 
472
635
    prefix = 'tag:'
 
636
    dwim_catchable_exceptions = (errors.NoSuchTag, errors.TagsNotSupported)
473
637
 
474
638
    def _match_on(self, branch, revs):
475
 
        raise errors.InvalidRevisionSpec(self.user_spec, branch,
476
 
                                         'tag: namespace registered,'
477
 
                                         ' but not implemented')
478
 
 
479
 
SPEC_TYPES.append(RevisionSpec_tag)
 
639
        # Can raise tags not supported, NoSuchTag, etc
 
640
        return RevisionInfo.from_revision_id(branch,
 
641
            branch.tags.lookup_tag(self.spec))
 
642
 
 
643
    def _as_revision_id(self, context_branch):
 
644
        return context_branch.tags.lookup_tag(self.spec)
 
645
 
480
646
 
481
647
 
482
648
class _RevListToTimestamps(object):
483
649
    """This takes a list of revisions, and allows you to bisect by date"""
484
650
 
485
 
    __slots__ = ['revs', 'branch']
 
651
    __slots__ = ['branch']
486
652
 
487
 
    def __init__(self, revs, branch):
488
 
        self.revs = revs
 
653
    def __init__(self, branch):
489
654
        self.branch = branch
490
655
 
491
656
    def __getitem__(self, index):
492
657
        """Get the date of the index'd item"""
493
 
        r = self.branch.repository.get_revision(self.revs[index])
 
658
        r = self.branch.repository.get_revision(self.branch.get_rev_id(index))
494
659
        # TODO: Handle timezone.
495
660
        return datetime.datetime.fromtimestamp(r.timestamp)
496
661
 
497
662
    def __len__(self):
498
 
        return len(self.revs)
 
663
        return self.branch.revno()
499
664
 
500
665
 
501
666
class RevisionSpec_date(RevisionSpec):
508
673
    Matches the first entry after a given date (either at midnight or
509
674
    at a specified time).
510
675
 
511
 
    One way to display all the changes since yesterday would be:
512
 
        bzr log -r date:yesterday..-1
513
 
 
514
 
    examples:
 
676
    One way to display all the changes since yesterday would be::
 
677
 
 
678
        bzr log -r date:yesterday..
 
679
 
 
680
    Examples::
 
681
 
515
682
      date:yesterday            -> select the first revision since yesterday
516
683
      date:2006-08-14,17:10:14  -> select the first revision after
517
684
                                   August 14th, 2006 at 5:10pm.
518
 
    """    
 
685
    """
519
686
    prefix = 'date:'
520
 
    _date_re = re.compile(
 
687
    _date_regex = lazy_regex.lazy_compile(
521
688
            r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
522
689
            r'(,|T)?\s*'
523
690
            r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
541
708
        elif self.spec.lower() == 'tomorrow':
542
709
            dt = today + datetime.timedelta(days=1)
543
710
        else:
544
 
            m = self._date_re.match(self.spec)
 
711
            m = self._date_regex.match(self.spec)
545
712
            if not m or (not m.group('date') and not m.group('time')):
546
713
                raise errors.InvalidRevisionSpec(self.user_spec,
547
714
                                                 branch, 'invalid date')
573
740
                    hour=hour, minute=minute, second=second)
574
741
        branch.lock_read()
575
742
        try:
576
 
            rev = bisect.bisect(_RevListToTimestamps(revs, branch), dt)
 
743
            rev = bisect.bisect(_RevListToTimestamps(branch), dt, 1)
577
744
        finally:
578
745
            branch.unlock()
579
 
        if rev == len(revs):
580
 
            return RevisionInfo(branch, None)
581
 
        else:
582
 
            return RevisionInfo(branch, rev + 1)
 
746
        if rev == branch.revno():
 
747
            raise errors.InvalidRevisionSpec(self.user_spec, branch)
 
748
        return RevisionInfo(branch, rev)
583
749
 
584
 
SPEC_TYPES.append(RevisionSpec_date)
585
750
 
586
751
 
587
752
class RevisionSpec_ancestor(RevisionSpec):
599
764
    that your branch introduces, while excluding the changes that you
600
765
    have not merged from the remote branch.
601
766
 
602
 
    examples:
 
767
    Examples::
 
768
 
603
769
      ancestor:/path/to/branch
604
770
      $ bzr diff -r ancestor:../../mainline/branch
605
771
    """
606
772
    prefix = 'ancestor:'
607
773
 
608
774
    def _match_on(self, branch, revs):
 
775
        trace.mutter('matching ancestor: on: %s, %s', self.spec, branch)
 
776
        return self._find_revision_info(branch, self.spec)
 
777
 
 
778
    def _as_revision_id(self, context_branch):
 
779
        return self._find_revision_id(context_branch, self.spec)
 
780
 
 
781
    @staticmethod
 
782
    def _find_revision_info(branch, other_location):
 
783
        revision_id = RevisionSpec_ancestor._find_revision_id(branch,
 
784
                                                              other_location)
 
785
        return RevisionInfo(branch, None, revision_id)
 
786
 
 
787
    @staticmethod
 
788
    def _find_revision_id(branch, other_location):
609
789
        from bzrlib.branch import Branch
610
790
 
611
 
        trace.mutter('matching ancestor: on: %s, %s', self.spec, branch)
612
 
        other_branch = Branch.open(self.spec)
613
 
        revision_a = branch.last_revision()
614
 
        revision_b = other_branch.last_revision()
615
 
        for r, b in ((revision_a, branch), (revision_b, other_branch)):
616
 
            if r in (None, revision.NULL_REVISION):
617
 
                raise errors.NoCommits(b)
618
 
        revision_source = revision.MultipleRevisionSources(
619
 
                branch.repository, other_branch.repository)
620
 
        rev_id = revision.common_ancestor(revision_a, revision_b,
621
 
                                          revision_source)
 
791
        branch.lock_read()
622
792
        try:
623
 
            revno = branch.revision_id_to_revno(rev_id)
624
 
        except errors.NoSuchRevision:
625
 
            revno = None
626
 
        return RevisionInfo(branch, revno, rev_id)
627
 
        
628
 
SPEC_TYPES.append(RevisionSpec_ancestor)
 
793
            revision_a = revision.ensure_null(branch.last_revision())
 
794
            if revision_a == revision.NULL_REVISION:
 
795
                raise errors.NoCommits(branch)
 
796
            if other_location == '':
 
797
                other_location = branch.get_parent()
 
798
            other_branch = Branch.open(other_location)
 
799
            other_branch.lock_read()
 
800
            try:
 
801
                revision_b = revision.ensure_null(other_branch.last_revision())
 
802
                if revision_b == revision.NULL_REVISION:
 
803
                    raise errors.NoCommits(other_branch)
 
804
                graph = branch.repository.get_graph(other_branch.repository)
 
805
                rev_id = graph.find_unique_lca(revision_a, revision_b)
 
806
            finally:
 
807
                other_branch.unlock()
 
808
            if rev_id == revision.NULL_REVISION:
 
809
                raise errors.NoCommonAncestor(revision_a, revision_b)
 
810
            return rev_id
 
811
        finally:
 
812
            branch.unlock()
 
813
 
 
814
 
629
815
 
630
816
 
631
817
class RevisionSpec_branch(RevisionSpec):
635
821
 
636
822
    Supply the path to a branch to select its last revision.
637
823
 
638
 
    examples:
 
824
    Examples::
 
825
 
639
826
      branch:/path/to/branch
640
827
    """
641
828
    prefix = 'branch:'
 
829
    dwim_catchable_exceptions = (errors.NotBranchError,)
642
830
 
643
831
    def _match_on(self, branch, revs):
644
832
        from bzrlib.branch import Branch
646
834
        revision_b = other_branch.last_revision()
647
835
        if revision_b in (None, revision.NULL_REVISION):
648
836
            raise errors.NoCommits(other_branch)
649
 
        # pull in the remote revisions so we can diff
650
 
        branch.fetch(other_branch, revision_b)
651
 
        try:
652
 
            revno = branch.revision_id_to_revno(revision_b)
653
 
        except errors.NoSuchRevision:
654
 
            revno = None
655
 
        return RevisionInfo(branch, revno, revision_b)
656
 
        
657
 
SPEC_TYPES.append(RevisionSpec_branch)
 
837
        if branch is None:
 
838
            branch = other_branch
 
839
        else:
 
840
            try:
 
841
                # pull in the remote revisions so we can diff
 
842
                branch.fetch(other_branch, revision_b)
 
843
            except errors.ReadOnlyError:
 
844
                branch = other_branch
 
845
        return RevisionInfo(branch, None, revision_b)
 
846
 
 
847
    def _as_revision_id(self, context_branch):
 
848
        from bzrlib.branch import Branch
 
849
        other_branch = Branch.open(self.spec)
 
850
        last_revision = other_branch.last_revision()
 
851
        last_revision = revision.ensure_null(last_revision)
 
852
        context_branch.fetch(other_branch, last_revision)
 
853
        if last_revision == revision.NULL_REVISION:
 
854
            raise errors.NoCommits(other_branch)
 
855
        return last_revision
 
856
 
 
857
    def _as_tree(self, context_branch):
 
858
        from bzrlib.branch import Branch
 
859
        other_branch = Branch.open(self.spec)
 
860
        last_revision = other_branch.last_revision()
 
861
        last_revision = revision.ensure_null(last_revision)
 
862
        if last_revision == revision.NULL_REVISION:
 
863
            raise errors.NoCommits(other_branch)
 
864
        return other_branch.repository.revision_tree(last_revision)
 
865
 
 
866
    def needs_branch(self):
 
867
        return False
 
868
 
 
869
    def get_branch(self):
 
870
        return self.spec
 
871
 
 
872
 
 
873
 
 
874
class RevisionSpec_submit(RevisionSpec_ancestor):
 
875
    """Selects a common ancestor with a submit branch."""
 
876
 
 
877
    help_txt = """Selects a common ancestor with the submit branch.
 
878
 
 
879
    Diffing against this shows all the changes that were made in this branch,
 
880
    and is a good predictor of what merge will do.  The submit branch is
 
881
    used by the bundle and merge directive commands.  If no submit branch
 
882
    is specified, the parent branch is used instead.
 
883
 
 
884
    The common ancestor is the last revision that existed in both
 
885
    branches. Usually this is the branch point, but it could also be
 
886
    a revision that was merged.
 
887
 
 
888
    Examples::
 
889
 
 
890
      $ bzr diff -r submit:
 
891
    """
 
892
 
 
893
    prefix = 'submit:'
 
894
 
 
895
    def _get_submit_location(self, branch):
 
896
        submit_location = branch.get_submit_branch()
 
897
        location_type = 'submit branch'
 
898
        if submit_location is None:
 
899
            submit_location = branch.get_parent()
 
900
            location_type = 'parent branch'
 
901
        if submit_location is None:
 
902
            raise errors.NoSubmitBranch(branch)
 
903
        trace.note(gettext('Using {0} {1}').format(location_type,
 
904
                                                        submit_location))
 
905
        return submit_location
 
906
 
 
907
    def _match_on(self, branch, revs):
 
908
        trace.mutter('matching ancestor: on: %s, %s', self.spec, branch)
 
909
        return self._find_revision_info(branch,
 
910
            self._get_submit_location(branch))
 
911
 
 
912
    def _as_revision_id(self, context_branch):
 
913
        return self._find_revision_id(context_branch,
 
914
            self._get_submit_location(context_branch))
 
915
 
 
916
 
 
917
class RevisionSpec_annotate(RevisionIDSpec):
 
918
 
 
919
    prefix = 'annotate:'
 
920
 
 
921
    help_txt = """Select the revision that last modified the specified line.
 
922
 
 
923
    Select the revision that last modified the specified line.  Line is
 
924
    specified as path:number.  Path is a relative path to the file.  Numbers
 
925
    start at 1, and are relative to the current version, not the last-
 
926
    committed version of the file.
 
927
    """
 
928
 
 
929
    def _raise_invalid(self, numstring, context_branch):
 
930
        raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
 
931
            'No such line: %s' % numstring)
 
932
 
 
933
    def _as_revision_id(self, context_branch):
 
934
        path, numstring = self.spec.rsplit(':', 1)
 
935
        try:
 
936
            index = int(numstring) - 1
 
937
        except ValueError:
 
938
            self._raise_invalid(numstring, context_branch)
 
939
        tree, file_path = workingtree.WorkingTree.open_containing(path)
 
940
        tree.lock_read()
 
941
        try:
 
942
            file_id = tree.path2id(file_path)
 
943
            if file_id is None:
 
944
                raise errors.InvalidRevisionSpec(self.user_spec,
 
945
                    context_branch, "File '%s' is not versioned." %
 
946
                    file_path)
 
947
            revision_ids = [r for (r, l) in tree.annotate_iter(file_id)]
 
948
        finally:
 
949
            tree.unlock()
 
950
        try:
 
951
            revision_id = revision_ids[index]
 
952
        except IndexError:
 
953
            self._raise_invalid(numstring, context_branch)
 
954
        if revision_id == revision.CURRENT_REVISION:
 
955
            raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
 
956
                'Line %s has not been committed.' % numstring)
 
957
        return revision_id
 
958
 
 
959
 
 
960
class RevisionSpec_mainline(RevisionIDSpec):
 
961
 
 
962
    help_txt = """Select mainline revision that merged the specified revision.
 
963
 
 
964
    Select the revision that merged the specified revision into mainline.
 
965
    """
 
966
 
 
967
    prefix = 'mainline:'
 
968
 
 
969
    def _as_revision_id(self, context_branch):
 
970
        revspec = RevisionSpec.from_string(self.spec)
 
971
        if revspec.get_branch() is None:
 
972
            spec_branch = context_branch
 
973
        else:
 
974
            spec_branch = _mod_branch.Branch.open(revspec.get_branch())
 
975
        revision_id = revspec.as_revision_id(spec_branch)
 
976
        graph = context_branch.repository.get_graph()
 
977
        result = graph.find_lefthand_merger(revision_id,
 
978
                                            context_branch.last_revision())
 
979
        if result is None:
 
980
            raise errors.InvalidRevisionSpec(self.user_spec, context_branch)
 
981
        return result
 
982
 
 
983
 
 
984
# The order in which we want to DWIM a revision spec without any prefix.
 
985
# revno is always tried first and isn't listed here, this is used by
 
986
# RevisionSpec_dwim._match_on
 
987
dwim_revspecs = symbol_versioning.deprecated_list(
 
988
    symbol_versioning.deprecated_in((2, 4, 0)), "dwim_revspecs", [])
 
989
 
 
990
RevisionSpec_dwim.append_possible_revspec(RevisionSpec_tag)
 
991
RevisionSpec_dwim.append_possible_revspec(RevisionSpec_revid)
 
992
RevisionSpec_dwim.append_possible_revspec(RevisionSpec_date)
 
993
RevisionSpec_dwim.append_possible_revspec(RevisionSpec_branch)
 
994
 
 
995
revspec_registry = registry.Registry()
 
996
def _register_revspec(revspec):
 
997
    revspec_registry.register(revspec.prefix, revspec)
 
998
 
 
999
_register_revspec(RevisionSpec_revno)
 
1000
_register_revspec(RevisionSpec_revid)
 
1001
_register_revspec(RevisionSpec_last)
 
1002
_register_revspec(RevisionSpec_before)
 
1003
_register_revspec(RevisionSpec_tag)
 
1004
_register_revspec(RevisionSpec_date)
 
1005
_register_revspec(RevisionSpec_ancestor)
 
1006
_register_revspec(RevisionSpec_branch)
 
1007
_register_revspec(RevisionSpec_submit)
 
1008
_register_revspec(RevisionSpec_annotate)
 
1009
_register_revspec(RevisionSpec_mainline)