pager.py
115 lines
| 3.7 KiB
| text/x-python
|
PythonLexer
/ hgext / pager.py
|
r6323 | # pager.py - display output using a pager | ||
# | ||||
# Copyright 2008 David Soria Parra <dsp@php.net> | ||||
# | ||||
|
r8225 | # This software may be used and distributed according to the terms of the | ||
|
r10263 | # GNU General Public License version 2 or any later version. | ||
|
r6323 | # | ||
|
r12083 | # To load the extension, add it to your configuration file: | ||
|
r6323 | # | ||
# [extension] | ||||
|
r10112 | # pager = | ||
|
r6323 | # | ||
|
r29967 | # Run 'hg help pager' to get info on configuration. | ||
|
r6462 | |||
|
r8894 | '''browse command output with an external pager | ||
|
r6462 | |||
|
r9212 | To set the pager that should be used, set the application variable:: | ||
|
r6462 | |||
[pager] | ||||
|
r17305 | pager = less -FRX | ||
|
r6462 | |||
|
r9267 | If no pager is set, the pager extensions uses the environment variable | ||
$PAGER. If neither pager.pager, nor $PAGER is set, no pager is used. | ||||
|
r6462 | |||
You can disable the pager for certain commands by adding them to the | ||||
|
r9212 | pager.ignore list:: | ||
|
r6462 | |||
[pager] | ||||
ignore = version, help, update | ||||
|
r9267 | You can also enable the pager only for certain commands using | ||
|
r9841 | pager.attend. Below is the default list of commands to be paged:: | ||
|
r6462 | |||
[pager] | ||||
|
r9841 | attend = annotate, cat, diff, export, glog, log, qdiff | ||
Setting pager.attend to an empty value will cause all commands to be | ||||
paged. | ||||
|
r6462 | |||
If pager.attend is present, pager.ignore will be ignored. | ||||
|
r21281 | Lastly, you can enable and disable paging for individual commands with | ||
the attend-<command> option. This setting takes precedence over | ||||
existing attend and ignore options and defaults:: | ||||
[pager] | ||||
attend-cat = false | ||||
|
r10973 | To ignore global commands like :hg:`version` or :hg:`help`, you have | ||
|
r12083 | to specify them in your user configuration file. | ||
|
r12694 | |||
|
r27128 | To control whether the pager is used at all for an individual command, | ||
you can use --pager=<value>:: | ||||
- use as needed: `auto`. | ||||
- require the pager: `yes` or `on`. | ||||
- suppress the pager: `no` or `off` (any unrecognized value | ||||
will also work). | ||||
|
r21281 | |||
|
r6462 | ''' | ||
|
r28320 | from __future__ import absolute_import | ||
|
r6323 | |||
|
r28320 | from mercurial import ( | ||
cmdutil, | ||||
commands, | ||||
dispatch, | ||||
extensions, | ||||
) | ||||
|
r6323 | |||
|
r29841 | # Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' for | ||
|
r25186 | # extensions which SHIP WITH MERCURIAL. Non-mainline extensions should | ||
# be specifying the version(s) of Mercurial they are tested with, or | ||||
# leave the attribute unspecified. | ||||
|
r29841 | testedwith = 'ships-with-hg-core' | ||
|
r16743 | |||
|
r6323 | def uisetup(ui): | ||
|
r30722 | |||
|
r7216 | def pagecmd(orig, ui, options, cmd, cmdfunc): | ||
|
r21279 | auto = options['pager'] == 'auto' | ||
|
r30993 | if auto and not ui.pageractive: | ||
|
r21279 | usepager = False | ||
|
r9841 | attend = ui.configlist('pager', 'attend', attended) | ||
|
r21280 | ignore = ui.configlist('pager', 'ignore') | ||
|
r19940 | cmds, _ = cmdutil.findcmd(cmd, commands.table) | ||
for cmd in cmds: | ||||
|
r21281 | var = 'attend-%s' % cmd | ||
if ui.config('pager', var): | ||||
usepager = ui.configbool('pager', var) | ||||
break | ||||
|
r21279 | if (cmd in attend or | ||
(cmd not in ignore and not attend)): | ||||
|
r21277 | usepager = True | ||
|
r19940 | break | ||
|
r21277 | |||
|
r30993 | if usepager: | ||
|
r30995 | # Slight hack: the attend list is supposed to override | ||
# the ignore list for the pager extension, but the | ||||
# core code doesn't know about attend, so we have to | ||||
# lobotomize the ignore list so that the extension's | ||||
# behavior is preserved. | ||||
ui.setconfig('pager', 'ignore', '', 'pager') | ||||
|
r30993 | ui.pager('extension-via-attend-' + cmd) | ||
|
r7216 | return orig(ui, options, cmd, cmdfunc) | ||
|
r6417 | |||
|
r24067 | # Wrap dispatch._runcommand after color is loaded so color can see | ||
# ui.pageractive. Otherwise, if we loaded first, color's wrapped | ||||
# dispatch._runcommand would run without having access to ui.pageractive. | ||||
def afterloaded(loaded): | ||||
extensions.wrapfunction(dispatch, '_runcommand', pagecmd) | ||||
extensions.afterloaded('color', afterloaded) | ||||
|
r9841 | |||
|
r31033 | attended = [ | ||
'the-default-attend-list-is-now-empty-but-that-breaks-the-extension', | ||||
] | ||||