~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revisionspec.py

  • Committer: Aaron Bentley
  • Date: 2007-03-11 16:16:00 UTC
  • mto: (2323.6.9 0.15-integration)
  • mto: This revision was merged to the branch mainline in revision 2342.
  • Revision ID: aaron.bentley@utoronto.ca-20070311161600-hvtsmkf3d2z72562
Allow leading junk before merge directive header

Show diffs side-by-side

added added

removed removed

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