namespaces.py
200 lines
| 7.4 KiB
| text/x-python
|
PythonLexer
/ mercurial / namespaces.py
|
r25961 | from __future__ import absolute_import | ||
from .i18n import _ | ||||
from . import ( | ||||
templatekw, | ||||
util, | ||||
) | ||||
|
r23553 | |||
|
r23555 | def tolist(val): | ||
""" | ||||
a convenience method to return an empty list instead of None | ||||
""" | ||||
if val is None: | ||||
return [] | ||||
else: | ||||
return [val] | ||||
|
r23553 | class namespaces(object): | ||
|
r23718 | """provides an interface to register and operate on multiple namespaces. See | ||
the namespace class below for details on the namespace object. | ||||
|
r23553 | |||
""" | ||||
_names_version = 0 | ||||
|
r23561 | def __init__(self): | ||
|
r23553 | self._names = util.sortdict() | ||
|
r35213 | columns = templatekw.getlogcolumns() | ||
|
r23554 | |||
|
r23558 | # we need current mercurial named objects (bookmarks, tags, and | ||
# branches) to be initialized somewhere, so that place is here | ||||
|
r23873 | bmknames = lambda repo: repo._bookmarks.keys() | ||
bmknamemap = lambda repo, name: tolist(repo._bookmarks.get(name)) | ||||
|
r28567 | bmknodemap = lambda repo, node: repo.nodebookmarks(node) | ||
|
r23967 | n = namespace("bookmarks", templatename="bookmark", | ||
|
r35213 | logfmt=columns['bookmark'], | ||
|
r23967 | listnames=bmknames, | ||
|
r33048 | namemap=bmknamemap, nodemap=bmknodemap, | ||
builtin=True) | ||||
|
r23717 | self.addnamespace(n) | ||
|
r23562 | |||
|
r23873 | tagnames = lambda repo: [t for t, n in repo.tagslist()] | ||
tagnamemap = lambda repo, name: tolist(repo._tagscache.tags.get(name)) | ||||
|
r28567 | tagnodemap = lambda repo, node: repo.nodetags(node) | ||
|
r23967 | n = namespace("tags", templatename="tag", | ||
|
r35213 | logfmt=columns['tag'], | ||
|
r23967 | listnames=tagnames, | ||
|
r24151 | namemap=tagnamemap, nodemap=tagnodemap, | ||
|
r33048 | deprecated={'tip'}, | ||
builtin=True) | ||||
|
r23717 | self.addnamespace(n) | ||
|
r23558 | |||
|
r23873 | bnames = lambda repo: repo.branchmap().keys() | ||
bnamemap = lambda repo, name: tolist(repo.branchtip(name, True)) | ||||
bnodemap = lambda repo, node: [repo[node].branch()] | ||||
|
r23967 | n = namespace("branches", templatename="branch", | ||
|
r35213 | logfmt=columns['branch'], | ||
|
r23967 | listnames=bnames, | ||
|
r33048 | namemap=bnamemap, nodemap=bnodemap, | ||
builtin=True) | ||||
|
r23717 | self.addnamespace(n) | ||
|
r23563 | |||
|
r23736 | def __getitem__(self, namespace): | ||
"""returns the namespace object""" | ||||
return self._names[namespace] | ||||
|
r23761 | def __iter__(self): | ||
return self._names.__iter__() | ||||
|
r32550 | def items(self): | ||
|
r23761 | return self._names.iteritems() | ||
|
r32550 | iteritems = items | ||
|
r23717 | def addnamespace(self, namespace, order=None): | ||
|
r23718 | """register a namespace | ||
|
r23554 | |||
namespace: the name to be registered (in plural form) | ||||
order: optional argument to specify the order of namespaces | ||||
(e.g. 'branches' should be listed before 'bookmarks') | ||||
|
r23718 | |||
|
r23554 | """ | ||
if order is not None: | ||||
|
r23717 | self._names.insert(order, namespace.name, namespace) | ||
|
r23554 | else: | ||
|
r23717 | self._names[namespace.name] = namespace | ||
|
r23559 | |||
|
r23610 | # we only generate a template keyword if one does not already exist | ||
|
r23717 | if namespace.name not in templatekw.keywords: | ||
|
r23610 | def generatekw(**args): | ||
|
r23717 | return templatekw.shownames(namespace.name, **args) | ||
|
r23610 | |||
|
r23717 | templatekw.keywords[namespace.name] = generatekw | ||
|
r23610 | |||
|
r23561 | def singlenode(self, repo, name): | ||
|
r23559 | """ | ||
Return the 'best' node for the given name. Best means the first node | ||||
in the first nonempty list returned by a name-to-nodes mapping function | ||||
in the defined precedence order. | ||||
Raises a KeyError if there is no such node. | ||||
""" | ||||
for ns, v in self._names.iteritems(): | ||||
|
r23717 | n = v.namemap(repo, name) | ||
|
r23559 | if n: | ||
# return max revision number | ||||
if len(n) > 1: | ||||
|
r23561 | cl = repo.changelog | ||
|
r23559 | maxrev = max(cl.rev(node) for node in n) | ||
return cl.node(maxrev) | ||||
return n[0] | ||||
raise KeyError(_('no such name: %s') % name) | ||||
|
r23606 | |||
|
r23715 | class namespace(object): | ||
"""provides an interface to a namespace | ||||
Namespaces are basically generic many-to-many mapping between some | ||||
(namespaced) names and nodes. The goal here is to control the pollution of | ||||
jamming things into tags or bookmarks (in extension-land) and to simplify | ||||
internal bits of mercurial: log output, tab completion, etc. | ||||
More precisely, we define a mapping of names to nodes, and a mapping from | ||||
nodes to names. Each mapping returns a list. | ||||
Furthermore, each name mapping will be passed a name to lookup which might | ||||
not be in its domain. In this case, each method should return an empty list | ||||
and not raise an error. | ||||
This namespace object will define the properties we need: | ||||
'name': the namespace (plural form) | ||||
'templatename': name to use for templating (usually the singular form | ||||
of the plural namespace name) | ||||
|
r23760 | 'listnames': list of all names in the namespace (usually the keys of a | ||
dictionary) | ||||
|
r23715 | 'namemap': function that takes a name and returns a list of nodes | ||
'nodemap': function that takes a node and returns a list of names | ||||
|
r24151 | 'deprecated': set of names to be masked for ordinary use | ||
|
r33048 | 'builtin': bool indicating if this namespace is supported by core | ||
Mercurial. | ||||
|
r23715 | """ | ||
|
r23875 | def __init__(self, name, templatename=None, logname=None, colorname=None, | ||
|
r24151 | logfmt=None, listnames=None, namemap=None, nodemap=None, | ||
|
r33048 | deprecated=None, builtin=False): | ||
|
r23715 | """create a namespace | ||
name: the namespace to be registered (in plural form) | ||||
|
r23872 | templatename: the name to use for templating | ||
|
r23874 | logname: the name to use for log output; if not specified templatename | ||
is used | ||||
|
r23875 | colorname: the name to use for colored log output; if not specified | ||
logname is used | ||||
|
r24180 | logfmt: the format to use for (i18n-ed) log output; if not specified | ||
|
r23967 | it is composed from logname | ||
|
r23760 | listnames: function to list all names | ||
|
r28567 | namemap: function that inputs a name, output node(s) | ||
nodemap: function that inputs a node, output name(s) | ||||
|
r24151 | deprecated: set of names to be masked for ordinary use | ||
|
r33048 | builtin: whether namespace is implemented by core Mercurial | ||
|
r23715 | """ | ||
self.name = name | ||||
self.templatename = templatename | ||||
|
r23874 | self.logname = logname | ||
|
r23875 | self.colorname = colorname | ||
|
r23967 | self.logfmt = logfmt | ||
|
r23760 | self.listnames = listnames | ||
|
r23715 | self.namemap = namemap | ||
self.nodemap = nodemap | ||||
|
r23716 | |||
|
r23874 | # if logname is not specified, use the template name as backup | ||
if self.logname is None: | ||||
self.logname = self.templatename | ||||
|
r23875 | # if colorname is not specified, just use the logname as a backup | ||
if self.colorname is None: | ||||
self.colorname = self.logname | ||||
|
r23967 | # if logfmt is not specified, compose it from logname as backup | ||
if self.logfmt is None: | ||||
# i18n: column positioning for "hg log" | ||||
self.logfmt = ("%s:" % self.logname).ljust(13) + "%s\n" | ||||
|
r24151 | if deprecated is None: | ||
self.deprecated = set() | ||||
else: | ||||
self.deprecated = deprecated | ||||
|
r33048 | self.builtin = builtin | ||
|
r23716 | def names(self, repo, node): | ||
"""method that returns a (sorted) list of names in a namespace that | ||||
match a given node""" | ||||
return sorted(self.nodemap(repo, node)) | ||||
|
r23774 | |||
def nodes(self, repo, name): | ||||
"""method that returns a list of nodes in a namespace that | ||||
match a given name. | ||||
""" | ||||
return sorted(self.namemap(repo, name)) | ||||