##// END OF EJS Templates
namespaces: add 'listnames' property...
Sean Farley -
r23760:50229b4c default
parent child Browse files
Show More
@@ -1,129 +1,136
1 1 from i18n import _
2 2 from mercurial import util
3 3 import templatekw
4 4
5 5 def tolist(val):
6 6 """
7 7 a convenience method to return an empty list instead of None
8 8 """
9 9 if val is None:
10 10 return []
11 11 else:
12 12 return [val]
13 13
14 14 class namespaces(object):
15 15 """provides an interface to register and operate on multiple namespaces. See
16 16 the namespace class below for details on the namespace object.
17 17
18 18 """
19 19
20 20 _names_version = 0
21 21
22 22 def __init__(self):
23 23 self._names = util.sortdict()
24 24
25 25 # shorten the class name for less indentation
26 26 ns = namespace
27 27
28 28 # we need current mercurial named objects (bookmarks, tags, and
29 29 # branches) to be initialized somewhere, so that place is here
30 30 n = ns("bookmarks", "bookmark",
31 lambda repo: repo._bookmarks.keys(),
31 32 lambda repo, name: tolist(repo._bookmarks.get(name)),
32 33 lambda repo, name: repo.nodebookmarks(name))
33 34 self.addnamespace(n)
34 35
35 36 n = ns("tags", "tag",
37 lambda repo: [t for t, n in repo.tagslist()],
36 38 lambda repo, name: tolist(repo._tagscache.tags.get(name)),
37 39 lambda repo, name: repo.nodetags(name))
38 40 self.addnamespace(n)
39 41
40 42 n = ns("branches", "branch",
43 lambda repo: repo.branchmap().keys(),
41 44 lambda repo, name: tolist(repo.branchtip(name)),
42 45 lambda repo, node: [repo[node].branch()])
43 46 self.addnamespace(n)
44 47
45 48 def __getitem__(self, namespace):
46 49 """returns the namespace object"""
47 50 return self._names[namespace]
48 51
49 52 def addnamespace(self, namespace, order=None):
50 53 """register a namespace
51 54
52 55 namespace: the name to be registered (in plural form)
53 56 order: optional argument to specify the order of namespaces
54 57 (e.g. 'branches' should be listed before 'bookmarks')
55 58
56 59 """
57 60 if order is not None:
58 61 self._names.insert(order, namespace.name, namespace)
59 62 else:
60 63 self._names[namespace.name] = namespace
61 64
62 65 # we only generate a template keyword if one does not already exist
63 66 if namespace.name not in templatekw.keywords:
64 67 def generatekw(**args):
65 68 return templatekw.shownames(namespace.name, **args)
66 69
67 70 templatekw.keywords[namespace.name] = generatekw
68 71
69 72 def singlenode(self, repo, name):
70 73 """
71 74 Return the 'best' node for the given name. Best means the first node
72 75 in the first nonempty list returned by a name-to-nodes mapping function
73 76 in the defined precedence order.
74 77
75 78 Raises a KeyError if there is no such node.
76 79 """
77 80 for ns, v in self._names.iteritems():
78 81 n = v.namemap(repo, name)
79 82 if n:
80 83 # return max revision number
81 84 if len(n) > 1:
82 85 cl = repo.changelog
83 86 maxrev = max(cl.rev(node) for node in n)
84 87 return cl.node(maxrev)
85 88 return n[0]
86 89 raise KeyError(_('no such name: %s') % name)
87 90
88 91 class namespace(object):
89 92 """provides an interface to a namespace
90 93
91 94 Namespaces are basically generic many-to-many mapping between some
92 95 (namespaced) names and nodes. The goal here is to control the pollution of
93 96 jamming things into tags or bookmarks (in extension-land) and to simplify
94 97 internal bits of mercurial: log output, tab completion, etc.
95 98
96 99 More precisely, we define a mapping of names to nodes, and a mapping from
97 100 nodes to names. Each mapping returns a list.
98 101
99 102 Furthermore, each name mapping will be passed a name to lookup which might
100 103 not be in its domain. In this case, each method should return an empty list
101 104 and not raise an error.
102 105
103 106 This namespace object will define the properties we need:
104 107 'name': the namespace (plural form)
105 108 'templatename': name to use for templating (usually the singular form
106 109 of the plural namespace name)
110 'listnames': list of all names in the namespace (usually the keys of a
111 dictionary)
107 112 'namemap': function that takes a name and returns a list of nodes
108 113 'nodemap': function that takes a node and returns a list of names
109 114
110 115 """
111 116
112 def __init__(self, name, templatename, namemap, nodemap):
117 def __init__(self, name, templatename, listnames, namemap, nodemap):
113 118 """create a namespace
114 119
115 120 name: the namespace to be registered (in plural form)
121 listnames: function to list all names
116 122 templatename: the name to use for templating
117 123 namemap: function that inputs a node, output name(s)
118 124 nodemap: function that inputs a name, output node(s)
119 125
120 126 """
121 127 self.name = name
122 128 self.templatename = templatename
129 self.listnames = listnames
123 130 self.namemap = namemap
124 131 self.nodemap = nodemap
125 132
126 133 def names(self, repo, node):
127 134 """method that returns a (sorted) list of names in a namespace that
128 135 match a given node"""
129 136 return sorted(self.nodemap(repo, node))
General Comments 0
You need to be logged in to leave comments. Login now