formatter: add support for docheader and docfooter templates

templatepartsmap() is a minimal copy of changeset_templater.__init__(). I
tried to factor out a common function, but it was unnecessarily complicated.

mercurial/formatter.py

@@ -1,497 +1,516 b''
 # formatter.py - generic output formatting for mercurial
 #
 # Copyright 2012 Matt Mackall <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 """Generic output formatting for Mercurial
 
 The formatter provides API to show data in various ways. The following
 functions should be used in place of ui.write():
 
 - fm.write() for unconditional output
 - fm.condwrite() to show some extra data conditionally in plain output
 - fm.context() to provide changectx to template output
 - fm.data() to provide extra data to JSON or template output
 - fm.plain() to show raw text that isn't provided to JSON or template output
 
 To show structured data (e.g. date tuples, dicts, lists), apply fm.format*()
 beforehand so the data is converted to the appropriate data type. Use
 fm.isplain() if you need to convert or format data conditionally which isn't
 supported by the formatter API.
 
 To build nested structure (i.e. a list of dicts), use fm.nested().
 
 See also https://www.mercurial-scm.org/wiki/GenericTemplatingPlan
 
 fm.condwrite() vs 'if cond:':
 
 In most cases, use fm.condwrite() so users can selectively show the data
 in template output. If it's costly to build data, use plain 'if cond:' with
 fm.write().
 
 fm.nested() vs fm.formatdict() (or fm.formatlist()):
 
 fm.nested() should be used to form a tree structure (a list of dicts of
 lists of dicts...) which can be accessed through template keywords, e.g.
 "{foo % "{bar % {...}} {baz % {...}}"}". On the other hand, fm.formatdict()
 exports a dict-type object to template, which can be accessed by e.g.
 "{get(foo, key)}" function.
 
 Doctest helper:
 
 >>> def show(fn, verbose=False, **opts):
 ...     import sys
 ...     from . import ui as uimod
 ...     ui = uimod.ui()
 ...     ui.fout = sys.stdout  # redirect to doctest
 ...     ui.verbose = verbose
 ...     return fn(ui, ui.formatter(fn.__name__, opts))
 
 Basic example:
 
 >>> def files(ui, fm):
 ...     files = [('foo', 123, (0, 0)), ('bar', 456, (1, 0))]
 ...     for f in files:
 ...         fm.startitem()
 ...         fm.write('path', '%s', f[0])
 ...         fm.condwrite(ui.verbose, 'date', '  %s',
 ...                      fm.formatdate(f[2], '%Y-%m-%d %H:%M:%S'))
 ...         fm.data(size=f[1])
 ...         fm.plain('\\n')
 ...     fm.end()
 >>> show(files)
 foo
 bar
 >>> show(files, verbose=True)
 foo  1970-01-01 00:00:00
 bar  1970-01-01 00:00:01
 >>> show(files, template='json')
 [
  {
   "date": [0, 0],
   "path": "foo",
   "size": 123
  },
  {
   "date": [1, 0],
   "path": "bar",
   "size": 456
  }
 ]
 >>> show(files, template='path: {path}\\ndate: {date|rfc3339date}\\n')
 path: foo
 date: 1970-01-01T00:00:00+00:00
 path: bar
 date: 1970-01-01T00:00:01+00:00
 
 Nested example:
 
 >>> def subrepos(ui, fm):
 ...     fm.startitem()
 ...     fm.write('repo', '[%s]\\n', 'baz')
 ...     files(ui, fm.nested('files'))
 ...     fm.end()
 >>> show(subrepos)
 [baz]
 foo
 bar
 >>> show(subrepos, template='{repo}: {join(files % "{path}", ", ")}\\n')
 baz: foo, bar
 """
 
 from __future__ import absolute_import
 
 import collections
 import contextlib
 import itertools
 import os
 
 from .i18n import _
 from .node import (
     hex,
     short,
 )
 
 from . import (
     error,
     pycompat,
     templatefilters,
     templatekw,
     templater,
     util,
 )
 
 pickle = util.pickle
 
 class _nullconverter(object):
     '''convert non-primitive data types to be processed by formatter'''
     @staticmethod
     def formatdate(date, fmt):
         '''convert date tuple to appropriate format'''
         return date
     @staticmethod
     def formatdict(data, key, value, fmt, sep):
         '''convert dict or key-value pairs to appropriate dict format'''
         # use plain dict instead of util.sortdict so that data can be
         # serialized as a builtin dict in pickle output
         return dict(data)
     @staticmethod
     def formatlist(data, name, fmt, sep):
         '''convert iterable to appropriate list format'''
         return list(data)
 
 class baseformatter(object):
     def __init__(self, ui, topic, opts, converter):
         self._ui = ui
         self._topic = topic
         self._style = opts.get("style")
         self._template = opts.get("template")
         self._converter = converter
         self._item = None
         # function to convert node to string suitable for this output
         self.hexfunc = hex
     def __enter__(self):
         return self
     def __exit__(self, exctype, excvalue, traceback):
         if exctype is None:
             self.end()
     def _showitem(self):
         '''show a formatted item once all data is collected'''
         pass
     def startitem(self):
         '''begin an item in the format list'''
         if self._item is not None:
             self._showitem()
         self._item = {}
     def formatdate(self, date, fmt='%a %b %d %H:%M:%S %Y %1%2'):
         '''convert date tuple to appropriate format'''
         return self._converter.formatdate(date, fmt)
     def formatdict(self, data, key='key', value='value', fmt='%s=%s', sep=' '):
         '''convert dict or key-value pairs to appropriate dict format'''
         return self._converter.formatdict(data, key, value, fmt, sep)
     def formatlist(self, data, name, fmt='%s', sep=' '):
         '''convert iterable to appropriate list format'''
         # name is mandatory argument for now, but it could be optional if
         # we have default template keyword, e.g. {item}
         return self._converter.formatlist(data, name, fmt, sep)
     def context(self, **ctxs):
         '''insert context objects to be used to render template keywords'''
         pass
     def data(self, **data):
         '''insert data into item that's not shown in default output'''
         data = pycompat.byteskwargs(data)
         self._item.update(data)
     def write(self, fields, deftext, *fielddata, **opts):
         '''do default text output while assigning data to item'''
         fieldkeys = fields.split()
         assert len(fieldkeys) == len(fielddata)
         self._item.update(zip(fieldkeys, fielddata))
     def condwrite(self, cond, fields, deftext, *fielddata, **opts):
         '''do conditional write (primarily for plain formatter)'''
         fieldkeys = fields.split()
         assert len(fieldkeys) == len(fielddata)
         self._item.update(zip(fieldkeys, fielddata))
     def plain(self, text, **opts):
         '''show raw text for non-templated mode'''
         pass
     def isplain(self):
         '''check for plain formatter usage'''
         return False
     def nested(self, field):
         '''sub formatter to store nested data in the specified field'''
         self._item[field] = data = []
         return _nestedformatter(self._ui, self._converter, data)
     def end(self):
         '''end output for the formatter'''
         if self._item is not None:
             self._showitem()
 
 def nullformatter(ui, topic):
     '''formatter that prints nothing'''
     return baseformatter(ui, topic, opts={}, converter=_nullconverter)
 
 class _nestedformatter(baseformatter):
     '''build sub items and store them in the parent formatter'''
     def __init__(self, ui, converter, data):
         baseformatter.__init__(self, ui, topic='', opts={}, converter=converter)
         self._data = data
     def _showitem(self):
         self._data.append(self._item)
 
 def _iteritems(data):
     '''iterate key-value pairs in stable order'''
     if isinstance(data, dict):
         return sorted(data.iteritems())
     return data
 
 class _plainconverter(object):
     '''convert non-primitive data types to text'''
     @staticmethod
     def formatdate(date, fmt):
         '''stringify date tuple in the given format'''
         return util.datestr(date, fmt)
     @staticmethod
     def formatdict(data, key, value, fmt, sep):
         '''stringify key-value pairs separated by sep'''
         return sep.join(fmt % (k, v) for k, v in _iteritems(data))
     @staticmethod
     def formatlist(data, name, fmt, sep):
         '''stringify iterable separated by sep'''
         return sep.join(fmt % e for e in data)
 
 class plainformatter(baseformatter):
     '''the default text output scheme'''
     def __init__(self, ui, out, topic, opts):
         baseformatter.__init__(self, ui, topic, opts, _plainconverter)
         if ui.debugflag:
             self.hexfunc = hex
         else:
             self.hexfunc = short
         if ui is out:
             self._write = ui.write
         else:
             self._write = lambda s, **opts: out.write(s)
     def startitem(self):
         pass
     def data(self, **data):
         pass
     def write(self, fields, deftext, *fielddata, **opts):
         self._write(deftext % fielddata, **opts)
     def condwrite(self, cond, fields, deftext, *fielddata, **opts):
         '''do conditional write'''
         if cond:
             self._write(deftext % fielddata, **opts)
     def plain(self, text, **opts):
         self._write(text, **opts)
     def isplain(self):
         return True
     def nested(self, field):
         # nested data will be directly written to ui
         return self
     def end(self):
         pass
 
 class debugformatter(baseformatter):
     def __init__(self, ui, out, topic, opts):
         baseformatter.__init__(self, ui, topic, opts, _nullconverter)
         self._out = out
         self._out.write("%s = [\n" % self._topic)
     def _showitem(self):
         self._out.write("    " + repr(self._item) + ",\n")
     def end(self):
         baseformatter.end(self)
         self._out.write("]\n")
 
 class pickleformatter(baseformatter):
     def __init__(self, ui, out, topic, opts):
         baseformatter.__init__(self, ui, topic, opts, _nullconverter)
         self._out = out
         self._data = []
     def _showitem(self):
         self._data.append(self._item)
     def end(self):
         baseformatter.end(self)
         self._out.write(pickle.dumps(self._data))
 
 class jsonformatter(baseformatter):
     def __init__(self, ui, out, topic, opts):
         baseformatter.__init__(self, ui, topic, opts, _nullconverter)
         self._out = out
         self._out.write("[")
         self._first = True
     def _showitem(self):
         if self._first:
             self._first = False
         else:
             self._out.write(",")
 
         self._out.write("\n {\n")
         first = True
         for k, v in sorted(self._item.items()):
             if first:
                 first = False
             else:
                 self._out.write(",\n")
             u = templatefilters.json(v, paranoid=False)
             self._out.write('  "%s": %s' % (k, u))
         self._out.write("\n }")
     def end(self):
         baseformatter.end(self)
         self._out.write("\n]\n")
 
 class _templateconverter(object):
     '''convert non-primitive data types to be processed by templater'''
     @staticmethod
     def formatdate(date, fmt):
         '''return date tuple'''
         return date
     @staticmethod
     def formatdict(data, key, value, fmt, sep):
         '''build object that can be evaluated as either plain string or dict'''
         data = util.sortdict(_iteritems(data))
         def f():
             yield _plainconverter.formatdict(data, key, value, fmt, sep)
         return templatekw.hybriddict(data, key=key, value=value, fmt=fmt,
                                      gen=f())
     @staticmethod
     def formatlist(data, name, fmt, sep):
         '''build object that can be evaluated as either plain string or list'''
         data = list(data)
         def f():
             yield _plainconverter.formatlist(data, name, fmt, sep)
         return templatekw.hybridlist(data, name=name, fmt=fmt, gen=f())
 
 class templateformatter(baseformatter):
     def __init__(self, ui, out, topic, opts):
         baseformatter.__init__(self, ui, topic, opts, _templateconverter)
         self._out = out
         spec = lookuptemplate(ui, topic, opts.get('template', ''))
         self._tref = spec.ref
         self._t = loadtemplater(ui, spec, cache=templatekw.defaulttempl)
+        self._parts = templatepartsmap(spec, self._t,
+                                       ['docheader', 'docfooter'])
         self._counter = itertools.count()
         self._cache = {}  # for templatekw/funcs to store reusable data
+        self._renderitem('docheader', {})
+
     def context(self, **ctxs):
         '''insert context objects to be used to render template keywords'''
         ctxs = pycompat.byteskwargs(ctxs)
         assert all(k == 'ctx' for k in ctxs)
         self._item.update(ctxs)
 
     def _showitem(self):
         item = self._item.copy()
         item['index'] = next(self._counter)
         self._renderitem(self._tref, item)
 
-    def _renderitem(self, ref, item):
+    def _renderitem(self, part, item):
+        if part not in self._parts:
+            return
+        ref = self._parts[part]
+
         # TODO: add support for filectx. probably each template keyword or
         # function will have to declare dependent resources. e.g.
         # @templatekeyword(..., requires=('ctx',))
         props = {}
         if 'ctx' in item:
             props.update(templatekw.keywords)
         # explicitly-defined fields precede templatekw
         props.update(item)
         if 'ctx' in item:
             # but template resources must be always available
             props['templ'] = self._t
             props['repo'] = props['ctx'].repo()
             props['revcache'] = {}
         props = pycompat.strkwargs(props)
         g = self._t(ref, ui=self._ui, cache=self._cache, **props)
         self._out.write(templater.stringify(g))
 
+    def end(self):
+        baseformatter.end(self)
+        self._renderitem('docfooter', {})
+
 templatespec = collections.namedtuple(r'templatespec',
                                       r'ref tmpl mapfile')
 
 def lookuptemplate(ui, topic, tmpl):
     """Find the template matching the given -T/--template spec 'tmpl'
 
     'tmpl' can be any of the following:
 
      - a literal template (e.g. '{rev}')
      - a map-file name or path (e.g. 'changelog')
      - a reference to [templates] in config file
      - a path to raw template file
 
     A map file defines a stand-alone template environment. If a map file
     selected, all templates defined in the file will be loaded, and the
     template matching the given topic will be rendered. No aliases will be
     loaded from user config.
 
     If no map file selected, all templates in [templates] section will be
     available as well as aliases in [templatealias].
     """
 
     # looks like a literal template?
     if '{' in tmpl:
         return templatespec('', tmpl, None)
 
     # perhaps a stock style?
     if not os.path.split(tmpl)[0]:
         mapname = (templater.templatepath('map-cmdline.' + tmpl)
                    or templater.templatepath(tmpl))
         if mapname and os.path.isfile(mapname):
             return templatespec(topic, None, mapname)
 
     # perhaps it's a reference to [templates]
     if ui.config('templates', tmpl):
         return templatespec(tmpl, None, None)
 
     if tmpl == 'list':
         ui.write(_("available styles: %s\n") % templater.stylelist())
         raise error.Abort(_("specify a template"))
 
     # perhaps it's a path to a map or a template
     if ('/' in tmpl or '\\' in tmpl) and os.path.isfile(tmpl):
         # is it a mapfile for a style?
         if os.path.basename(tmpl).startswith("map-"):
             return templatespec(topic, None, os.path.realpath(tmpl))
         with util.posixfile(tmpl, 'rb') as f:
             tmpl = f.read()
         return templatespec('', tmpl, None)
 
     # constant string?
     return templatespec('', tmpl, None)
 
+def templatepartsmap(spec, t, partnames):
+    """Create a mapping of {part: ref}"""
+    partsmap = {spec.ref: spec.ref}  # initial ref must exist in t
+    if spec.mapfile:
+        partsmap.update((p, p) for p in partnames if p in t)
+    return partsmap
+
 def loadtemplater(ui, spec, cache=None):
     """Create a templater from either a literal template or loading from
     a map file"""
     assert not (spec.tmpl and spec.mapfile)
     if spec.mapfile:
         return templater.templater.frommapfile(spec.mapfile, cache=cache)
     return maketemplater(ui, spec.tmpl, cache=cache)
 
 def maketemplater(ui, tmpl, cache=None):
     """Create a templater from a string template 'tmpl'"""
     aliases = ui.configitems('templatealias')
     t = templater.templater(cache=cache, aliases=aliases)
     t.cache.update((k, templater.unquotestring(v))
                    for k, v in ui.configitems('templates'))
     if tmpl:
         t.cache[''] = tmpl
     return t
 
 def formatter(ui, out, topic, opts):
     template = opts.get("template", "")
     if template == "json":
         return jsonformatter(ui, out, topic, opts)
     elif template == "pickle":
         return pickleformatter(ui, out, topic, opts)
     elif template == "debug":
         return debugformatter(ui, out, topic, opts)
     elif template != "":
         return templateformatter(ui, out, topic, opts)
     # developer config: ui.formatdebug
     elif ui.configbool('ui', 'formatdebug'):
         return debugformatter(ui, out, topic, opts)
     # deprecated config: ui.formatjson
     elif ui.configbool('ui', 'formatjson'):
         return jsonformatter(ui, out, topic, opts)
     return plainformatter(ui, out, topic, opts)
 
 @contextlib.contextmanager
 def openformatter(ui, filename, topic, opts):
     """Create a formatter that writes outputs to the specified file
 
     Must be invoked using the 'with' statement.
     """
     with util.posixfile(filename, 'wb') as out:
         with formatter(ui, out, topic, opts) as fm:
             yield fm
 
 @contextlib.contextmanager
 def _neverending(fm):
     yield fm
 
 def maybereopen(fm, filename, opts):
     """Create a formatter backed by file if filename specified, else return
     the given formatter
 
     Must be invoked using the 'with' statement. This will never call fm.end()
     of the given formatter.
     """
     if filename:
         return openformatter(fm._ui, filename, fm._topic, opts)
     else:
         return _neverending(fm)

tests/test-branches.t

@@ -1,727 +1,740 b''
   $ hg init a
   $ cd a
 
 Verify checking branch of nullrev before the cache is created doesnt crash
   $ hg log -r 'branch(.)' -T '{branch}\n'
 
 Basic test
   $ echo 'root' >root
   $ hg add root
   $ hg commit -d '0 0' -m "Adding root node"
 
   $ echo 'a' >a
   $ hg add a
   $ hg branch a
   marked working directory as branch a
   (branches are permanent and global, did you want a bookmark?)
   $ hg commit -d '1 0' -m "Adding a branch"
 
   $ hg branch q
   marked working directory as branch q
   $ echo 'aa' >a
   $ hg branch -C
   reset working directory to branch a
   $ hg commit -d '2 0' -m "Adding to a branch"
 
   $ hg update -C 0
   0 files updated, 0 files merged, 1 files removed, 0 files unresolved
   $ echo 'b' >b
   $ hg add b
   $ hg branch b
   marked working directory as branch b
   $ hg commit -d '2 0' -m "Adding b branch"
 
   $ echo 'bh1' >bh1
   $ hg add bh1
   $ hg commit -d '3 0' -m "Adding b branch head 1"
 
   $ hg update -C 2
   1 files updated, 0 files merged, 2 files removed, 0 files unresolved
   $ echo 'bh2' >bh2
   $ hg add bh2
   $ hg commit -d '4 0' -m "Adding b branch head 2"
 
   $ echo 'c' >c
   $ hg add c
   $ hg branch c
   marked working directory as branch c
   $ hg commit -d '5 0' -m "Adding c branch"
 
 reserved names
 
   $ hg branch tip
   abort: the name 'tip' is reserved
   [255]
   $ hg branch null
   abort: the name 'null' is reserved
   [255]
   $ hg branch .
   abort: the name '.' is reserved
   [255]
 
 invalid characters
 
   $ hg branch 'foo:bar'
   abort: ':' cannot be used in a name
   [255]
 
   $ hg branch 'foo
   > bar'
   abort: '\n' cannot be used in a name
   [255]
 
 trailing or leading spaces should be stripped before testing duplicates
 
   $ hg branch 'b '
   abort: a branch of the same name already exists
   (use 'hg update' to switch to it)
   [255]
 
   $ hg branch ' b'
   abort: a branch of the same name already exists
   (use 'hg update' to switch to it)
   [255]
 
 verify update will accept invalid legacy branch names
 
   $ hg init test-invalid-branch-name
   $ cd test-invalid-branch-name
   $ hg pull -u "$TESTDIR"/bundles/test-invalid-branch-name.hg
   pulling from *test-invalid-branch-name.hg (glob)
   requesting all changes
   adding changesets
   adding manifests
   adding file changes
   added 3 changesets with 3 changes to 2 files
   1 files updated, 0 files merged, 0 files removed, 0 files unresolved
 
   $ hg update '"colon:test"'
   1 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ cd ..
 
   $ echo 'd' >d
   $ hg add d
   $ hg branch 'a branch name much longer than the default justification used by branches'
   marked working directory as branch a branch name much longer than the default justification used by branches
   $ hg commit -d '6 0' -m "Adding d branch"
 
   $ hg branches
   a branch name much longer than the default justification used by branches 7:10ff5895aa57
   b                              4:aee39cd168d0
   c                              6:589736a22561 (inactive)
   a                              5:d8cbc61dbaa6 (inactive)
   default                        0:19709c5a4e75 (inactive)
 
 -------
 
   $ hg branches -a
   a branch name much longer than the default justification used by branches 7:10ff5895aa57
   b                              4:aee39cd168d0
 
 --- Branch a
 
   $ hg log -b a
   changeset:   5:d8cbc61dbaa6
   branch:      a
   parent:      2:881fe2b92ad0
   user:        test
   date:        Thu Jan 01 00:00:04 1970 +0000
   summary:     Adding b branch head 2
   
   changeset:   2:881fe2b92ad0
   branch:      a
   user:        test
   date:        Thu Jan 01 00:00:02 1970 +0000
   summary:     Adding to a branch
   
   changeset:   1:dd6b440dd85a
   branch:      a
   user:        test
   date:        Thu Jan 01 00:00:01 1970 +0000
   summary:     Adding a branch
   
 
 ---- Branch b
 
   $ hg log -b b
   changeset:   4:aee39cd168d0
   branch:      b
   user:        test
   date:        Thu Jan 01 00:00:03 1970 +0000
   summary:     Adding b branch head 1
   
   changeset:   3:ac22033332d1
   branch:      b
   parent:      0:19709c5a4e75
   user:        test
   date:        Thu Jan 01 00:00:02 1970 +0000
   summary:     Adding b branch
   
 
 ---- going to test branch closing
 
   $ hg branches
   a branch name much longer than the default justification used by branches 7:10ff5895aa57
   b                              4:aee39cd168d0
   c                              6:589736a22561 (inactive)
   a                              5:d8cbc61dbaa6 (inactive)
   default                        0:19709c5a4e75 (inactive)
   $ hg up -C b
   2 files updated, 0 files merged, 4 files removed, 0 files unresolved
   $ echo 'xxx1' >> b
   $ hg commit -d '7 0' -m 'adding cset to branch b'
   $ hg up -C aee39cd168d0
   1 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ echo 'xxx2' >> b
   $ hg commit -d '8 0' -m 'adding head to branch b'
   created new head
   $ echo 'xxx3' >> b
   $ hg commit -d '9 0' -m 'adding another cset to branch b'
   $ hg branches
   b                             10:bfbe841b666e
   a branch name much longer than the default justification used by branches 7:10ff5895aa57
   c                              6:589736a22561 (inactive)
   a                              5:d8cbc61dbaa6 (inactive)
   default                        0:19709c5a4e75 (inactive)
   $ hg heads --closed
   changeset:   10:bfbe841b666e
   branch:      b
   tag:         tip
   user:        test
   date:        Thu Jan 01 00:00:09 1970 +0000
   summary:     adding another cset to branch b
   
   changeset:   8:eebb944467c9
   branch:      b
   parent:      4:aee39cd168d0
   user:        test
   date:        Thu Jan 01 00:00:07 1970 +0000
   summary:     adding cset to branch b
   
   changeset:   7:10ff5895aa57
   branch:      a branch name much longer than the default justification used by branches
   user:        test
   date:        Thu Jan 01 00:00:06 1970 +0000
   summary:     Adding d branch
   
   changeset:   6:589736a22561
   branch:      c
   user:        test
   date:        Thu Jan 01 00:00:05 1970 +0000
   summary:     Adding c branch
   
   changeset:   5:d8cbc61dbaa6
   branch:      a
   parent:      2:881fe2b92ad0
   user:        test
   date:        Thu Jan 01 00:00:04 1970 +0000
   summary:     Adding b branch head 2
   
   changeset:   0:19709c5a4e75
   user:        test
   date:        Thu Jan 01 00:00:00 1970 +0000
   summary:     Adding root node
   
   $ hg heads
   changeset:   10:bfbe841b666e
   branch:      b
   tag:         tip
   user:        test
   date:        Thu Jan 01 00:00:09 1970 +0000
   summary:     adding another cset to branch b
   
   changeset:   8:eebb944467c9
   branch:      b
   parent:      4:aee39cd168d0
   user:        test
   date:        Thu Jan 01 00:00:07 1970 +0000
   summary:     adding cset to branch b
   
   changeset:   7:10ff5895aa57
   branch:      a branch name much longer than the default justification used by branches
   user:        test
   date:        Thu Jan 01 00:00:06 1970 +0000
   summary:     Adding d branch
   
   changeset:   6:589736a22561
   branch:      c
   user:        test
   date:        Thu Jan 01 00:00:05 1970 +0000
   summary:     Adding c branch
   
   changeset:   5:d8cbc61dbaa6
   branch:      a
   parent:      2:881fe2b92ad0
   user:        test
   date:        Thu Jan 01 00:00:04 1970 +0000
   summary:     Adding b branch head 2
   
   changeset:   0:19709c5a4e75
   user:        test
   date:        Thu Jan 01 00:00:00 1970 +0000
   summary:     Adding root node
   
   $ hg commit -d '9 0' --close-branch -m 'prune bad branch'
   $ hg branches -a
   b                              8:eebb944467c9
   a branch name much longer than the default justification used by branches 7:10ff5895aa57
   $ hg up -C b
   1 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ hg commit -d '9 0' --close-branch -m 'close this part branch too'
   $ hg commit -d '9 0' --close-branch -m 're-closing this branch'
   abort: can only close branch heads
   [255]
 
   $ hg log -r tip --debug
   changeset:   12:e3d49c0575d8fc2cb1cd6859c747c14f5f6d499f
   branch:      b
   tag:         tip
   phase:       draft
   parent:      8:eebb944467c9fb9651ed232aeaf31b3c0a7fc6c1
   parent:      -1:0000000000000000000000000000000000000000
   manifest:    8:6f9ed32d2b310e391a4f107d5f0f071df785bfee
   user:        test
   date:        Thu Jan 01 00:00:09 1970 +0000
   extra:       branch=b
   extra:       close=1
   description:
   close this part branch too
   
   
 --- b branch should be inactive
 
   $ hg branches
   a branch name much longer than the default justification used by branches 7:10ff5895aa57
   c                              6:589736a22561 (inactive)
   a                              5:d8cbc61dbaa6 (inactive)
   default                        0:19709c5a4e75 (inactive)
   $ hg branches -c
   a branch name much longer than the default justification used by branches 7:10ff5895aa57
   b                             12:e3d49c0575d8 (closed)
   c                              6:589736a22561 (inactive)
   a                              5:d8cbc61dbaa6 (inactive)
   default                        0:19709c5a4e75 (inactive)
   $ hg branches -a
   a branch name much longer than the default justification used by branches 7:10ff5895aa57
   $ hg branches -q
   a branch name much longer than the default justification used by branches
   c
   a
   default
   $ hg heads b
   no open branch heads found on branches b
   [1]
   $ hg heads --closed b
   changeset:   12:e3d49c0575d8
   branch:      b
   tag:         tip
   parent:      8:eebb944467c9
   user:        test
   date:        Thu Jan 01 00:00:09 1970 +0000
   summary:     close this part branch too
   
   changeset:   11:d3f163457ebf
   branch:      b
   user:        test
   date:        Thu Jan 01 00:00:09 1970 +0000
   summary:     prune bad branch
   
   $ echo 'xxx4' >> b
   $ hg commit -d '9 0' -m 'reopen branch with a change'
   reopening closed branch head 12
 
 --- branch b is back in action
 
   $ hg branches -a
   b                             13:e23b5505d1ad
   a branch name much longer than the default justification used by branches 7:10ff5895aa57
 
 ---- test heads listings
 
   $ hg heads
   changeset:   13:e23b5505d1ad
   branch:      b
   tag:         tip
   user:        test
   date:        Thu Jan 01 00:00:09 1970 +0000
   summary:     reopen branch with a change
   
   changeset:   7:10ff5895aa57
   branch:      a branch name much longer than the default justification used by branches
   user:        test
   date:        Thu Jan 01 00:00:06 1970 +0000
   summary:     Adding d branch
   
   changeset:   6:589736a22561
   branch:      c
   user:        test
   date:        Thu Jan 01 00:00:05 1970 +0000
   summary:     Adding c branch
   
   changeset:   5:d8cbc61dbaa6
   branch:      a
   parent:      2:881fe2b92ad0
   user:        test
   date:        Thu Jan 01 00:00:04 1970 +0000
   summary:     Adding b branch head 2
   
   changeset:   0:19709c5a4e75
   user:        test
   date:        Thu Jan 01 00:00:00 1970 +0000
   summary:     Adding root node
   
 
 branch default
 
   $ hg heads default
   changeset:   0:19709c5a4e75
   user:        test
   date:        Thu Jan 01 00:00:00 1970 +0000
   summary:     Adding root node
   
 
 branch a
 
   $ hg heads a
   changeset:   5:d8cbc61dbaa6
   branch:      a
   parent:      2:881fe2b92ad0
   user:        test
   date:        Thu Jan 01 00:00:04 1970 +0000
   summary:     Adding b branch head 2
   
   $ hg heads --active a
   no open branch heads found on branches a
   [1]
 
 branch b
 
   $ hg heads b
   changeset:   13:e23b5505d1ad
   branch:      b
   tag:         tip
   user:        test
   date:        Thu Jan 01 00:00:09 1970 +0000
   summary:     reopen branch with a change
   
   $ hg heads --closed b
   changeset:   13:e23b5505d1ad
   branch:      b
   tag:         tip
   user:        test
   date:        Thu Jan 01 00:00:09 1970 +0000
   summary:     reopen branch with a change
   
   changeset:   11:d3f163457ebf
   branch:      b
   user:        test
   date:        Thu Jan 01 00:00:09 1970 +0000
   summary:     prune bad branch
   
 default branch colors:
 
   $ cat <<EOF >> $HGRCPATH
   > [extensions]
   > color =
   > [color]
   > mode = ansi
   > EOF
 
   $ hg up -C c
   3 files updated, 0 files merged, 2 files removed, 0 files unresolved
   $ hg commit -d '9 0' --close-branch -m 'reclosing this branch'
   $ hg up -C b
   2 files updated, 0 files merged, 3 files removed, 0 files unresolved
   $ hg branches --color=always
   \x1b[0;32mb\x1b[0m\x1b[0;33m                             13:e23b5505d1ad\x1b[0m (esc)
   \x1b[0;0ma branch name much longer than the default justification used by branches\x1b[0m\x1b[0;33m 7:10ff5895aa57\x1b[0m (esc)
   \x1b[0;0ma\x1b[0m\x1b[0;33m                              5:d8cbc61dbaa6\x1b[0m (inactive) (esc)
   \x1b[0;0mdefault\x1b[0m\x1b[0;33m                        0:19709c5a4e75\x1b[0m (inactive) (esc)
 
 default closed branch color:
 
   $ hg branches --color=always --closed
   \x1b[0;32mb\x1b[0m\x1b[0;33m                             13:e23b5505d1ad\x1b[0m (esc)
   \x1b[0;0ma branch name much longer than the default justification used by branches\x1b[0m\x1b[0;33m 7:10ff5895aa57\x1b[0m (esc)
   \x1b[0;30;1mc\x1b[0m\x1b[0;33m                             14:f894c25619d3\x1b[0m (closed) (esc)
   \x1b[0;0ma\x1b[0m\x1b[0;33m                              5:d8cbc61dbaa6\x1b[0m (inactive) (esc)
   \x1b[0;0mdefault\x1b[0m\x1b[0;33m                        0:19709c5a4e75\x1b[0m (inactive) (esc)
 
   $ cat <<EOF >> $HGRCPATH
   > [extensions]
   > color =
   > [color]
   > branches.active = green
   > branches.closed = blue
   > branches.current = red
   > branches.inactive = magenta
   > log.changeset = cyan
   > EOF
 
 custom branch colors:
 
   $ hg branches --color=always
   \x1b[0;31mb\x1b[0m\x1b[0;36m                             13:e23b5505d1ad\x1b[0m (esc)
   \x1b[0;32ma branch name much longer than the default justification used by branches\x1b[0m\x1b[0;36m 7:10ff5895aa57\x1b[0m (esc)
   \x1b[0;35ma\x1b[0m\x1b[0;36m                              5:d8cbc61dbaa6\x1b[0m (inactive) (esc)
   \x1b[0;35mdefault\x1b[0m\x1b[0;36m                        0:19709c5a4e75\x1b[0m (inactive) (esc)
 
 custom closed branch color:
 
   $ hg branches --color=always --closed
   \x1b[0;31mb\x1b[0m\x1b[0;36m                             13:e23b5505d1ad\x1b[0m (esc)
   \x1b[0;32ma branch name much longer than the default justification used by branches\x1b[0m\x1b[0;36m 7:10ff5895aa57\x1b[0m (esc)
   \x1b[0;34mc\x1b[0m\x1b[0;36m                             14:f894c25619d3\x1b[0m (closed) (esc)
   \x1b[0;35ma\x1b[0m\x1b[0;36m                              5:d8cbc61dbaa6\x1b[0m (inactive) (esc)
   \x1b[0;35mdefault\x1b[0m\x1b[0;36m                        0:19709c5a4e75\x1b[0m (inactive) (esc)
 
 template output:
 
   $ hg branches -Tjson --closed
   [
    {
     "active": true,
     "branch": "b",
     "closed": false,
     "current": true,
     "node": "e23b5505d1ad24aab6f84fd8c7cb8cd8e5e93be0",
     "rev": 13
    },
    {
     "active": true,
     "branch": "a branch name much longer than the default justification used by branches",
     "closed": false,
     "current": false,
     "node": "10ff5895aa5793bd378da574af8cec8ea408d831",
     "rev": 7
    },
    {
     "active": false,
     "branch": "c",
     "closed": true,
     "current": false,
     "node": "f894c25619d3f1484639d81be950e0a07bc6f1f6",
     "rev": 14
    },
    {
     "active": false,
     "branch": "a",
     "closed": false,
     "current": false,
     "node": "d8cbc61dbaa6dc817175d1e301eecb863f280832",
     "rev": 5
    },
    {
     "active": false,
     "branch": "default",
     "closed": false,
     "current": false,
     "node": "19709c5a4e75bf938f8e349aff97438539bb729e",
     "rev": 0
    }
   ]
 
   $ hg branches --closed -T '{if(closed, "{branch}\n")}'
   c
 
   $ hg branches -T '{word(0, branch)}: {desc|firstline}\n'
   b: reopen branch with a change
   a: Adding d branch
   a: Adding b branch head 2
   default: Adding root node
 
+  $ cat <<'EOF' > "$TESTTMP/map-myjson"
+  > docheader = '\{\n'
+  > docfooter = '\n}\n'
+  > branches = '{ifeq(index, 0, "", ",\n")} {dict(branch, node|short)|json}'
+  > EOF
+  $ hg branches -T "$TESTTMP/map-myjson"
+  {
+   {"branch": "b", "node": "e23b5505d1ad"},
+   {"branch": "a branch *", "node": "10ff5895aa57"}, (glob)
+   {"branch": "a", "node": "d8cbc61dbaa6"},
+   {"branch": "default", "node": "19709c5a4e75"}
+  }
+
 Tests of revision branch name caching
 
 We rev branch cache is updated automatically. In these tests we use a trick to
 trigger rebuilds. We remove the branch head cache and run 'hg head' to cause a
 rebuild that also will populate the rev branch cache.
 
 revision branch cache is created when building the branch head cache
   $ rm -rf .hg/cache; hg head a -T '{rev}\n'
   5
   $ f --hexdump --size .hg/cache/rbc-*
   .hg/cache/rbc-names-v1: size=87
   0000: 64 65 66 61 75 6c 74 00 61 00 62 00 63 00 61 20 |default.a.b.c.a |
   0010: 62 72 61 6e 63 68 20 6e 61 6d 65 20 6d 75 63 68 |branch name much|
   0020: 20 6c 6f 6e 67 65 72 20 74 68 61 6e 20 74 68 65 | longer than the|
   0030: 20 64 65 66 61 75 6c 74 20 6a 75 73 74 69 66 69 | default justifi|
   0040: 63 61 74 69 6f 6e 20 75 73 65 64 20 62 79 20 62 |cation used by b|
   0050: 72 61 6e 63 68 65 73                            |ranches|
   .hg/cache/rbc-revs-v1: size=120
   0000: 19 70 9c 5a 00 00 00 00 dd 6b 44 0d 00 00 00 01 |.p.Z.....kD.....|
   0010: 88 1f e2 b9 00 00 00 01 ac 22 03 33 00 00 00 02 |.........".3....|
   0020: ae e3 9c d1 00 00 00 02 d8 cb c6 1d 00 00 00 01 |................|
   0030: 58 97 36 a2 00 00 00 03 10 ff 58 95 00 00 00 04 |X.6.......X.....|
   0040: ee bb 94 44 00 00 00 02 5f 40 61 bb 00 00 00 02 |...D...._@a.....|
   0050: bf be 84 1b 00 00 00 02 d3 f1 63 45 80 00 00 02 |..........cE....|
   0060: e3 d4 9c 05 80 00 00 02 e2 3b 55 05 00 00 00 02 |.........;U.....|
   0070: f8 94 c2 56 80 00 00 03                         |...V....|
 
 no errors when revbranchcache is not writable
 
   $ echo >> .hg/cache/rbc-revs-v1
   $ mv .hg/cache/rbc-revs-v1 .hg/cache/rbc-revs-v1_
   $ mkdir .hg/cache/rbc-revs-v1
   $ rm -f .hg/cache/branch* && hg head a -T '{rev}\n'
   5
   $ rmdir .hg/cache/rbc-revs-v1
   $ mv .hg/cache/rbc-revs-v1_ .hg/cache/rbc-revs-v1
 
 no errors when wlock cannot be acquired
 
 #if unix-permissions
   $ mv .hg/cache/rbc-revs-v1 .hg/cache/rbc-revs-v1_
   $ rm -f .hg/cache/branch*
   $ chmod 555 .hg
   $ hg head a -T '{rev}\n'
   5
   $ chmod 755 .hg
   $ mv .hg/cache/rbc-revs-v1_ .hg/cache/rbc-revs-v1
 #endif
 
 recovery from invalid cache revs file with trailing data
   $ echo >> .hg/cache/rbc-revs-v1
   $ rm -f .hg/cache/branch* && hg head a -T '{rev}\n' --debug
   5
   truncating cache/rbc-revs-v1 to 120
   $ f --size .hg/cache/rbc-revs*
   .hg/cache/rbc-revs-v1: size=120
 recovery from invalid cache file with partial last record
   $ mv .hg/cache/rbc-revs-v1 .
   $ f -qDB 119 rbc-revs-v1 > .hg/cache/rbc-revs-v1
   $ f --size .hg/cache/rbc-revs*
   .hg/cache/rbc-revs-v1: size=119
   $ rm -f .hg/cache/branch* && hg head a -T '{rev}\n' --debug
   5
   truncating cache/rbc-revs-v1 to 112
   $ f --size .hg/cache/rbc-revs*
   .hg/cache/rbc-revs-v1: size=120
 recovery from invalid cache file with missing record - no truncation
   $ mv .hg/cache/rbc-revs-v1 .
   $ f -qDB 112 rbc-revs-v1 > .hg/cache/rbc-revs-v1
   $ rm -f .hg/cache/branch* && hg head a -T '{rev}\n' --debug
   5
   $ f --size .hg/cache/rbc-revs*
   .hg/cache/rbc-revs-v1: size=120
 recovery from invalid cache file with some bad records
   $ mv .hg/cache/rbc-revs-v1 .
   $ f -qDB 8 rbc-revs-v1 > .hg/cache/rbc-revs-v1
   $ f --size .hg/cache/rbc-revs*
   .hg/cache/rbc-revs-v1: size=8
   $ f -qDB 112 rbc-revs-v1 >> .hg/cache/rbc-revs-v1
   $ f --size .hg/cache/rbc-revs*
   .hg/cache/rbc-revs-v1: size=120
   $ hg log -r 'branch(.)' -T '{rev} ' --debug
   history modification detected - truncating revision branch cache to revision 13
   history modification detected - truncating revision branch cache to revision 1
   3 4 8 9 10 11 12 13 truncating cache/rbc-revs-v1 to 8
   $ rm -f .hg/cache/branch* && hg head a -T '{rev}\n' --debug
   5
   truncating cache/rbc-revs-v1 to 104
   $ f --size --hexdump --bytes=16 .hg/cache/rbc-revs*
   .hg/cache/rbc-revs-v1: size=120
   0000: 19 70 9c 5a 00 00 00 00 dd 6b 44 0d 00 00 00 01 |.p.Z.....kD.....|
 cache is updated when committing
   $ hg branch i-will-regret-this
   marked working directory as branch i-will-regret-this
   $ hg ci -m regrets
   $ f --size .hg/cache/rbc-*
   .hg/cache/rbc-names-v1: size=106
   .hg/cache/rbc-revs-v1: size=128
 update after rollback - the cache will be correct but rbc-names will will still
 contain the branch name even though it no longer is used
   $ hg up -qr '.^'
   $ hg rollback -qf
   $ f --size --hexdump .hg/cache/rbc-*
   .hg/cache/rbc-names-v1: size=106
   0000: 64 65 66 61 75 6c 74 00 61 00 62 00 63 00 61 20 |default.a.b.c.a |
   0010: 62 72 61 6e 63 68 20 6e 61 6d 65 20 6d 75 63 68 |branch name much|
   0020: 20 6c 6f 6e 67 65 72 20 74 68 61 6e 20 74 68 65 | longer than the|
   0030: 20 64 65 66 61 75 6c 74 20 6a 75 73 74 69 66 69 | default justifi|
   0040: 63 61 74 69 6f 6e 20 75 73 65 64 20 62 79 20 62 |cation used by b|
   0050: 72 61 6e 63 68 65 73 00 69 2d 77 69 6c 6c 2d 72 |ranches.i-will-r|
   0060: 65 67 72 65 74 2d 74 68 69 73                   |egret-this|
   .hg/cache/rbc-revs-v1: size=120
   0000: 19 70 9c 5a 00 00 00 00 dd 6b 44 0d 00 00 00 01 |.p.Z.....kD.....|
   0010: 88 1f e2 b9 00 00 00 01 ac 22 03 33 00 00 00 02 |.........".3....|
   0020: ae e3 9c d1 00 00 00 02 d8 cb c6 1d 00 00 00 01 |................|
   0030: 58 97 36 a2 00 00 00 03 10 ff 58 95 00 00 00 04 |X.6.......X.....|
   0040: ee bb 94 44 00 00 00 02 5f 40 61 bb 00 00 00 02 |...D...._@a.....|
   0050: bf be 84 1b 00 00 00 02 d3 f1 63 45 80 00 00 02 |..........cE....|
   0060: e3 d4 9c 05 80 00 00 02 e2 3b 55 05 00 00 00 02 |.........;U.....|
   0070: f8 94 c2 56 80 00 00 03                         |...V....|
 cache is updated/truncated when stripping - it is thus very hard to get in a
 situation where the cache is out of sync and the hash check detects it
   $ hg --config extensions.strip= strip -r tip --nob
   $ f --size .hg/cache/rbc-revs*
   .hg/cache/rbc-revs-v1: size=112
 
 cache is rebuilt when corruption is detected
   $ echo > .hg/cache/rbc-names-v1
   $ hg log -r '5:&branch(.)' -T '{rev} ' --debug
   referenced branch names not found - rebuilding revision branch cache from scratch
   8 9 10 11 12 13 truncating cache/rbc-revs-v1 to 40
   $ f --size --hexdump .hg/cache/rbc-*
   .hg/cache/rbc-names-v1: size=79
   0000: 62 00 61 00 63 00 61 20 62 72 61 6e 63 68 20 6e |b.a.c.a branch n|
   0010: 61 6d 65 20 6d 75 63 68 20 6c 6f 6e 67 65 72 20 |ame much longer |
   0020: 74 68 61 6e 20 74 68 65 20 64 65 66 61 75 6c 74 |than the default|
   0030: 20 6a 75 73 74 69 66 69 63 61 74 69 6f 6e 20 75 | justification u|
   0040: 73 65 64 20 62 79 20 62 72 61 6e 63 68 65 73    |sed by branches|
   .hg/cache/rbc-revs-v1: size=112
   0000: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 |................|
   0010: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 |................|
   0020: 00 00 00 00 00 00 00 00 d8 cb c6 1d 00 00 00 01 |................|
   0030: 58 97 36 a2 00 00 00 02 10 ff 58 95 00 00 00 03 |X.6.......X.....|
   0040: ee bb 94 44 00 00 00 00 5f 40 61 bb 00 00 00 00 |...D...._@a.....|
   0050: bf be 84 1b 00 00 00 00 d3 f1 63 45 80 00 00 00 |..........cE....|
   0060: e3 d4 9c 05 80 00 00 00 e2 3b 55 05 00 00 00 00 |.........;U.....|
 
 Test that cache files are created and grows correctly:
 
   $ rm .hg/cache/rbc*
   $ hg log -r "5 & branch(5)" -T "{rev}\n"
   5
   $ f --size --hexdump .hg/cache/rbc-*
   .hg/cache/rbc-names-v1: size=1
   0000: 61                                              |a|
   .hg/cache/rbc-revs-v1: size=112
   0000: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 |................|
   0010: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 |................|
   0020: 00 00 00 00 00 00 00 00 d8 cb c6 1d 00 00 00 00 |................|
   0030: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 |................|
   0040: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 |................|
   0050: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 |................|
   0060: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 |................|
 
   $ cd ..
 
 Test for multiple incorrect branch cache entries:
 
   $ hg init b
   $ cd b
   $ touch f
   $ hg ci -Aqmf
   $ echo >> f
   $ hg ci -Amf
   $ hg branch -q branch
   $ hg ci -Amf
 
   $ f --size --hexdump .hg/cache/rbc-*
   .hg/cache/rbc-names-v1: size=14
   0000: 64 65 66 61 75 6c 74 00 62 72 61 6e 63 68       |default.branch|
   .hg/cache/rbc-revs-v1: size=24
   0000: 66 e5 f5 aa 00 00 00 00 fa 4c 04 e5 00 00 00 00 |f........L......|
   0010: 56 46 78 69 00 00 00 01                         |VFxi....|
   $ : > .hg/cache/rbc-revs-v1
 
 No superfluous rebuilding of cache:
   $ hg log -r "branch(null)&branch(branch)" --debug
   $ f --size --hexdump .hg/cache/rbc-*
   .hg/cache/rbc-names-v1: size=14
   0000: 64 65 66 61 75 6c 74 00 62 72 61 6e 63 68       |default.branch|
   .hg/cache/rbc-revs-v1: size=24
   0000: 66 e5 f5 aa 00 00 00 00 fa 4c 04 e5 00 00 00 00 |f........L......|
   0010: 56 46 78 69 00 00 00 01                         |VFxi....|
 
   $ cd ..