templatekw.py
438 lines
| 14.5 KiB
| text/x-python
|
PythonLexer
/ mercurial / templatekw.py
|
r10053 | # templatekw.py - common changeset template keywords | ||
# | ||||
# Copyright 2005-2009 Matt Mackall <mpm@selenic.com> | ||||
# | ||||
# This software may be used and distributed according to the terms of the | ||||
|
r10264 | # GNU General Public License version 2 or any later version. | ||
|
r10053 | |||
|
r10055 | from node import hex | ||
|
r14318 | import patch, util, error | ||
|
r15155 | import hbisect | ||
|
r10053 | |||
|
r17631 | # This helper class allows us to handle both: | ||
# "{files}" (legacy command-line-specific list hack) and | ||||
# "{files % '{file}\n'}" (hgweb-style with inlining and function support) | ||||
class _hybrid(object): | ||||
|
r18970 | def __init__(self, gen, values, joinfmt=None): | ||
|
r17631 | self.gen = gen | ||
self.values = values | ||||
|
r18970 | if joinfmt: | ||
self.joinfmt = joinfmt | ||||
else: | ||||
self.joinfmt = lambda x: x.values()[0] | ||||
|
r17631 | def __iter__(self): | ||
return self.gen | ||||
def __call__(self): | ||||
for x in self.values: | ||||
yield x | ||||
|
r22393 | def __len__(self): | ||
return len(self.values) | ||||
|
r17631 | |||
def showlist(name, values, plural=None, element=None, **args): | ||||
if not element: | ||||
element = name | ||||
f = _showlist(name, values, plural, **args) | ||||
return _hybrid(f, [{element: x} for x in values]) | ||||
def _showlist(name, values, plural=None, **args): | ||||
|
r10053 | '''expand set of values. | ||
name is name of key in template map. | ||||
values is list of strings or dicts. | ||||
plural is plural of name, if not simply name + 's'. | ||||
expansion works like this, given name 'foo'. | ||||
if values is empty, expand 'no_foos'. | ||||
if 'foo' not in template map, return values as a string, | ||||
joined by space. | ||||
expand 'start_foos'. | ||||
for each value, expand 'foo'. if 'last_foo' in template | ||||
map, expand it instead of 'foo' for last key. | ||||
expand 'end_foos'. | ||||
''' | ||||
|
r10260 | templ = args['templ'] | ||
|
r10282 | if plural: | ||
names = plural | ||||
|
r10053 | else: names = name + 's' | ||
if not values: | ||||
noname = 'no_' + names | ||||
if noname in templ: | ||||
yield templ(noname, **args) | ||||
return | ||||
if name not in templ: | ||||
if isinstance(values[0], str): | ||||
yield ' '.join(values) | ||||
else: | ||||
for v in values: | ||||
yield dict(v, **args) | ||||
return | ||||
startname = 'start_' + names | ||||
if startname in templ: | ||||
yield templ(startname, **args) | ||||
vargs = args.copy() | ||||
def one(v, tag=name): | ||||
try: | ||||
vargs.update(v) | ||||
except (AttributeError, ValueError): | ||||
try: | ||||
for a, b in v: | ||||
vargs[a] = b | ||||
except ValueError: | ||||
vargs[name] = v | ||||
return templ(tag, **vargs) | ||||
lastname = 'last_' + name | ||||
if lastname in templ: | ||||
last = values.pop() | ||||
else: | ||||
last = None | ||||
for v in values: | ||||
yield one(v) | ||||
if last is not None: | ||||
yield one(last, tag=lastname) | ||||
endname = 'end_' + names | ||||
if endname in templ: | ||||
yield templ(endname, **args) | ||||
|
r10056 | def getfiles(repo, ctx, revcache): | ||
if 'files' not in revcache: | ||||
|
r13878 | revcache['files'] = repo.status(ctx.p1().node(), ctx.node())[:3] | ||
|
r10056 | return revcache['files'] | ||
|
r10057 | def getlatesttags(repo, ctx, cache): | ||
'''return date, distance and name for the latest tag of rev''' | ||||
if 'latesttags' not in cache: | ||||
# Cache mapping from rev to a tuple with tag date, tag | ||||
# distance and tag name | ||||
cache['latesttags'] = {-1: (0, 0, 'null')} | ||||
latesttags = cache['latesttags'] | ||||
rev = ctx.rev() | ||||
todo = [rev] | ||||
while todo: | ||||
rev = todo.pop() | ||||
if rev in latesttags: | ||||
continue | ||||
ctx = repo[rev] | ||||
|
r20218 | tags = [t for t in ctx.tags() | ||
if (repo.tagtype(t) and repo.tagtype(t) != 'local')] | ||||
|
r10057 | if tags: | ||
latesttags[rev] = ctx.date()[0], 0, ':'.join(sorted(tags)) | ||||
continue | ||||
try: | ||||
# The tuples are laid out so the right one can be found by | ||||
# comparison. | ||||
pdate, pdist, ptag = max( | ||||
latesttags[p.rev()] for p in ctx.parents()) | ||||
except KeyError: | ||||
# Cache miss - recurse | ||||
todo.append(rev) | ||||
todo.extend(p.rev() for p in ctx.parents()) | ||||
continue | ||||
latesttags[rev] = pdate, pdist + 1, ptag | ||||
return latesttags[rev] | ||||
|
r10060 | def getrenamedfn(repo, endrev=None): | ||
rcache = {} | ||||
if endrev is None: | ||||
endrev = len(repo) | ||||
def getrenamed(fn, rev): | ||||
'''looks up all renames for a file (up to endrev) the first | ||||
time the file is given. It indexes on the changerev and only | ||||
parses the manifest if linkrev != changerev. | ||||
Returns rename info for fn at changerev rev.''' | ||||
if fn not in rcache: | ||||
rcache[fn] = {} | ||||
fl = repo.file(fn) | ||||
for i in fl: | ||||
lr = fl.linkrev(i) | ||||
renamed = fl.renamed(fl.node(i)) | ||||
rcache[fn][lr] = renamed | ||||
if lr >= endrev: | ||||
break | ||||
if rev in rcache[fn]: | ||||
return rcache[fn][rev] | ||||
# If linkrev != rev (i.e. rev not found in rcache) fallback to | ||||
# filectx logic. | ||||
try: | ||||
return repo[rev][fn].renamed() | ||||
except error.LookupError: | ||||
return None | ||||
return getrenamed | ||||
|
r10055 | def showauthor(repo, ctx, templ, **args): | ||
|
r13585 | """:author: String. The unmodified author of the changeset.""" | ||
|
r10054 | return ctx.user() | ||
|
r15155 | def showbisect(repo, ctx, templ, **args): | ||
""":bisect: String. The changeset bisection status.""" | ||||
return hbisect.label(repo, ctx.node()) | ||||
|
r13156 | def showbranch(**args): | ||
|
r13585 | """:branch: String. The name of the branch on which the changeset was | ||
committed. | ||||
""" | ||||
|
r13156 | return args['ctx'].branch() | ||
|
r10260 | def showbranches(**args): | ||
|
r13585 | """:branches: List of strings. The name of the branch on which the | ||
changeset was committed. Will be empty if the branch name was | ||||
default. | ||||
""" | ||||
|
r10260 | branch = args['ctx'].branch() | ||
|
r10054 | if branch != 'default': | ||
|
r10260 | return showlist('branch', [branch], plural='branches', **args) | ||
|
r20076 | return showlist('branch', [], plural='branches', **args) | ||
|
r10054 | |||
|
r13386 | def showbookmarks(**args): | ||
|
r13592 | """:bookmarks: List of strings. Any bookmarks associated with the | ||
changeset. | ||||
""" | ||||
|
r20520 | repo = args['ctx']._repo | ||
|
r13386 | bookmarks = args['ctx'].bookmarks() | ||
|
r20520 | hybrid = showlist('bookmark', bookmarks, **args) | ||
for value in hybrid.values: | ||||
value['current'] = repo._bookmarkcurrent | ||||
return hybrid | ||||
|
r13386 | |||
|
r11655 | def showchildren(**args): | ||
|
r13585 | """:children: List of strings. The children of the changeset.""" | ||
|
r11655 | ctx = args['ctx'] | ||
childrevs = ['%d:%s' % (cctx, cctx) for cctx in ctx.children()] | ||||
|
r17631 | return showlist('children', childrevs, element='child', **args) | ||
|
r11655 | |||
|
r21896 | def showcurrentbookmark(**args): | ||
""":currentbookmark: String. The active bookmark, if it is | ||||
associated with the changeset""" | ||||
import bookmarks as bookmarks # to avoid circular import issues | ||||
repo = args['repo'] | ||||
if bookmarks.iscurrent(repo): | ||||
current = repo._bookmarkcurrent | ||||
if current in args['ctx'].bookmarks(): | ||||
return current | ||||
return '' | ||||
|
r10055 | def showdate(repo, ctx, templ, **args): | ||
|
r13585 | """:date: Date information. The date when the changeset was committed.""" | ||
|
r10054 | return ctx.date() | ||
|
r10055 | def showdescription(repo, ctx, templ, **args): | ||
|
r13585 | """:desc: String. The text of the changeset description.""" | ||
|
r10054 | return ctx.description().strip() | ||
|
r10055 | def showdiffstat(repo, ctx, templ, **args): | ||
|
r13585 | """:diffstat: String. Statistics of changes with the following format: | ||
"modified files: +added/-removed lines" | ||||
""" | ||||
|
r14403 | stats = patch.diffstatdata(util.iterlines(ctx.diff())) | ||
|
r14437 | maxname, maxtotal, adds, removes, binary = patch.diffstatsum(stats) | ||
|
r14403 | return '%s: +%s/-%s' % (len(stats), adds, removes) | ||
|
r10055 | |||
|
r10260 | def showextras(**args): | ||
|
r20015 | """:extras: List of dicts with key, value entries of the 'extras' | ||
field of this changeset.""" | ||||
|
r20183 | extras = args['ctx'].extra() | ||
c = [{'key': x[0], 'value': x[1]} for x in sorted(extras.items())] | ||||
f = _showlist('extra', c, plural='extras', **args) | ||||
return _hybrid(f, c, lambda x: '%s=%s' % (x['key'], x['value'])) | ||||
|
r10054 | |||
|
r10260 | def showfileadds(**args): | ||
|
r13585 | """:file_adds: List of strings. Files added by this changeset.""" | ||
|
r10260 | repo, ctx, revcache = args['repo'], args['ctx'], args['revcache'] | ||
|
r17631 | return showlist('file_add', getfiles(repo, ctx, revcache)[1], | ||
element='file', **args) | ||||
|
r10056 | |||
|
r10260 | def showfilecopies(**args): | ||
|
r13585 | """:file_copies: List of strings. Files copied in this changeset with | ||
their sources. | ||||
""" | ||||
|
r10394 | cache, ctx = args['cache'], args['ctx'] | ||
|
r10260 | copies = args['revcache'].get('copies') | ||
|
r10060 | if copies is None: | ||
if 'getrenamed' not in cache: | ||||
|
r10260 | cache['getrenamed'] = getrenamedfn(args['repo']) | ||
|
r10060 | copies = [] | ||
getrenamed = cache['getrenamed'] | ||||
for fn in ctx.files(): | ||||
rename = getrenamed(fn, ctx.rev()) | ||||
if rename: | ||||
copies.append((fn, rename[0])) | ||||
|
r10282 | |||
|
r10060 | c = [{'name': x[0], 'source': x[1]} for x in copies] | ||
|
r18715 | f = _showlist('file_copy', c, plural='file_copies', **args) | ||
|
r18970 | return _hybrid(f, c, lambda x: '%s (%s)' % (x['name'], x['source'])) | ||
|
r10060 | |||
# showfilecopiesswitch() displays file copies only if copy records are | ||||
# provided before calling the templater, usually with a --copies | ||||
# command line switch. | ||||
|
r10260 | def showfilecopiesswitch(**args): | ||
|
r13585 | """:file_copies_switch: List of strings. Like "file_copies" but displayed | ||
only if the --copied switch is set. | ||||
""" | ||||
|
r10260 | copies = args['revcache'].get('copies') or [] | ||
|
r10060 | c = [{'name': x[0], 'source': x[1]} for x in copies] | ||
|
r18715 | f = _showlist('file_copy', c, plural='file_copies', **args) | ||
|
r18970 | return _hybrid(f, c, lambda x: '%s (%s)' % (x['name'], x['source'])) | ||
|
r10058 | |||
|
r10260 | def showfiledels(**args): | ||
|
r13585 | """:file_dels: List of strings. Files removed by this changeset.""" | ||
|
r10260 | repo, ctx, revcache = args['repo'], args['ctx'], args['revcache'] | ||
|
r17631 | return showlist('file_del', getfiles(repo, ctx, revcache)[2], | ||
element='file', **args) | ||||
|
r10056 | |||
|
r10260 | def showfilemods(**args): | ||
|
r13585 | """:file_mods: List of strings. Files modified by this changeset.""" | ||
|
r10260 | repo, ctx, revcache = args['repo'], args['ctx'], args['revcache'] | ||
|
r17631 | return showlist('file_mod', getfiles(repo, ctx, revcache)[0], | ||
element='file', **args) | ||||
|
r10056 | |||
|
r10260 | def showfiles(**args): | ||
|
r13585 | """:files: List of strings. All files modified, added, or removed by this | ||
changeset. | ||||
""" | ||||
|
r10260 | return showlist('file', args['ctx'].files(), **args) | ||
|
r10054 | |||
|
r10057 | def showlatesttag(repo, ctx, templ, cache, **args): | ||
|
r13585 | """:latesttag: String. Most recent global tag in the ancestors of this | ||
changeset. | ||||
""" | ||||
|
r10057 | return getlatesttags(repo, ctx, cache)[2] | ||
def showlatesttagdistance(repo, ctx, templ, cache, **args): | ||||
|
r13585 | """:latesttagdistance: Integer. Longest path to the latest tag.""" | ||
|
r10057 | return getlatesttags(repo, ctx, cache)[1] | ||
|
r10260 | def showmanifest(**args): | ||
repo, ctx, templ = args['repo'], args['ctx'], args['templ'] | ||||
|
r10055 | args = args.copy() | ||
|
r20683 | args.update({'rev': repo.manifest.rev(ctx.changeset()[0]), | ||
'node': hex(ctx.changeset()[0])}) | ||||
|
r10055 | return templ('manifest', **args) | ||
def shownode(repo, ctx, templ, **args): | ||||
|
r13585 | """:node: String. The changeset identification hash, as a 40 hexadecimal | ||
digit string. | ||||
""" | ||||
|
r10054 | return ctx.hex() | ||
|
r17357 | def showp1rev(repo, ctx, templ, **args): | ||
""":p1rev: Integer. The repository-local revision number of the changeset's | ||||
first parent, or -1 if the changeset has no parents.""" | ||||
return ctx.p1().rev() | ||||
|
r17355 | |||
|
r17357 | def showp2rev(repo, ctx, templ, **args): | ||
""":p2rev: Integer. The repository-local revision number of the changeset's | ||||
second parent, or -1 if the changeset has no second parent.""" | ||||
return ctx.p2().rev() | ||||
|
r17355 | |||
|
r17357 | def showp1node(repo, ctx, templ, **args): | ||
""":p1node: String. The identification hash of the changeset's first parent, | ||||
as a 40 digit hexadecimal string. If the changeset has no parents, all | ||||
digits are 0.""" | ||||
return ctx.p1().hex() | ||||
|
r17355 | |||
|
r17357 | def showp2node(repo, ctx, templ, **args): | ||
""":p2node: String. The identification hash of the changeset's second | ||||
parent, as a 40 digit hexadecimal string. If the changeset has no second | ||||
parent, all digits are 0.""" | ||||
return ctx.p2().hex() | ||||
|
r17355 | |||
|
r15422 | def showphase(repo, ctx, templ, **args): | ||
|
r15947 | """:phase: String. The changeset phase name.""" | ||
|
r15823 | return ctx.phasestr() | ||
def showphaseidx(repo, ctx, templ, **args): | ||||
|
r15947 | """:phaseidx: Integer. The changeset phase index.""" | ||
|
r15422 | return ctx.phase() | ||
|
r10055 | def showrev(repo, ctx, templ, **args): | ||
|
r13585 | """:rev: Integer. The repository-local changeset revision number.""" | ||
|
r10054 | return ctx.rev() | ||
|
r21897 | def showsubrepos(**args): | ||
""":subrepos: List of strings. Updated subrepositories in the changeset.""" | ||||
ctx = args['ctx'] | ||||
substate = ctx.substate | ||||
if not substate: | ||||
return showlist('subrepo', [], **args) | ||||
psubstate = ctx.parents()[0].substate or {} | ||||
subrepos = [] | ||||
for sub in substate: | ||||
if sub not in psubstate or substate[sub] != psubstate[sub]: | ||||
subrepos.append(sub) # modified or newly added in ctx | ||||
for sub in psubstate: | ||||
if sub not in substate: | ||||
subrepos.append(sub) # removed in ctx | ||||
return showlist('subrepo', sorted(subrepos), **args) | ||||
|
r23609 | def shownames(namespace, **args): | ||
"""helper method to generate a template keyword for a namespace""" | ||||
ctx = args['ctx'] | ||||
repo = ctx._repo | ||||
names = repo.names.names(repo, namespace, ctx.node()) | ||||
return showlist(repo.names.templatename(namespace), names, | ||||
plural=namespace, **args) | ||||
|
r10260 | # keywords are callables like: | ||
# fn(repo, ctx, templ, cache, revcache, **args) | ||||
# with: | ||||
# repo - current repository instance | ||||
# ctx - the changectx being displayed | ||||
# templ - the templater instance | ||||
# cache - a cache dictionary for the whole templater run | ||||
# revcache - a cache dictionary for the current revision | ||||
|
r10054 | keywords = { | ||
'author': showauthor, | ||||
|
r15155 | 'bisect': showbisect, | ||
|
r13156 | 'branch': showbranch, | ||
|
r10054 | 'branches': showbranches, | ||
|
r13386 | 'bookmarks': showbookmarks, | ||
|
r11655 | 'children': showchildren, | ||
|
r21896 | 'currentbookmark': showcurrentbookmark, | ||
|
r10054 | 'date': showdate, | ||
'desc': showdescription, | ||||
|
r10055 | 'diffstat': showdiffstat, | ||
|
r10054 | 'extras': showextras, | ||
|
r10056 | 'file_adds': showfileadds, | ||
|
r10058 | 'file_copies': showfilecopies, | ||
|
r10060 | 'file_copies_switch': showfilecopiesswitch, | ||
|
r10056 | 'file_dels': showfiledels, | ||
'file_mods': showfilemods, | ||||
|
r10054 | 'files': showfiles, | ||
|
r10057 | 'latesttag': showlatesttag, | ||
'latesttagdistance': showlatesttagdistance, | ||||
|
r10055 | 'manifest': showmanifest, | ||
|
r10054 | 'node': shownode, | ||
|
r17357 | 'p1rev': showp1rev, | ||
'p1node': showp1node, | ||||
'p2rev': showp2rev, | ||||
'p2node': showp2node, | ||||
|
r15422 | 'phase': showphase, | ||
|
r15823 | 'phaseidx': showphaseidx, | ||
|
r10054 | 'rev': showrev, | ||
|
r21897 | 'subrepos': showsubrepos, | ||
|
r10054 | } | ||
|
r17187 | def _showparents(**args): | ||
""":parents: List of strings. The parents of the changeset in "rev:node" | ||||
format. If the changeset has only one "natural" parent (the predecessor | ||||
revision) nothing is shown.""" | ||||
pass | ||||
dockeywords = { | ||||
'parents': _showparents, | ||||
} | ||||
dockeywords.update(keywords) | ||||
|
r20078 | del dockeywords['branches'] | ||
|
r17187 | |||
|
r13585 | # tell hggettext to extract docstrings from these functions: | ||
|
r17187 | i18nfunctions = dockeywords.values() | ||