pager.py
174 lines
| 5.5 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 | import atexit | ||
import os | ||||
import signal | ||||
import subprocess | ||||
import sys | ||||
|
r29205 | from mercurial.i18n import _ | ||
|
r28320 | from mercurial import ( | ||
cmdutil, | ||||
commands, | ||||
dispatch, | ||||
|
r30635 | encoding, | ||
|
r28320 | extensions, | ||
util, | ||||
) | ||||
|
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 | |||
|
r26452 | def _runpager(ui, p): | ||
|
r16631 | pager = subprocess.Popen(p, shell=True, bufsize=-1, | ||
close_fds=util.closefds, stdin=subprocess.PIPE, | ||||
|
r30473 | stdout=util.stdout, stderr=util.stderr) | ||
|
r16631 | |||
|
r26454 | # back up original file objects and descriptors | ||
olduifout = ui.fout | ||||
|
r30473 | oldstdout = util.stdout | ||
stdoutfd = os.dup(util.stdout.fileno()) | ||||
stderrfd = os.dup(util.stderr.fileno()) | ||||
|
r26454 | |||
# create new line-buffered stdout so that output can show up immediately | ||||
|
r30473 | ui.fout = util.stdout = newstdout = os.fdopen(util.stdout.fileno(), 'wb', 1) | ||
os.dup2(pager.stdin.fileno(), util.stdout.fileno()) | ||||
if ui._isatty(util.stderr): | ||||
os.dup2(pager.stdin.fileno(), util.stderr.fileno()) | ||||
|
r16631 | |||
@atexit.register | ||||
def killpager(): | ||||
|
r18717 | if util.safehasattr(signal, "SIGINT"): | ||
signal.signal(signal.SIGINT, signal.SIG_IGN) | ||||
|
r16631 | pager.stdin.close() | ||
|
r26454 | ui.fout = olduifout | ||
|
r30473 | util.stdout = oldstdout | ||
|
r26454 | # close new stdout while it's associated with pager; otherwise stdout | ||
# fd would be closed when newstdout is deleted | ||||
newstdout.close() | ||||
# restore original fds: stdout is open again | ||||
|
r30473 | os.dup2(stdoutfd, util.stdout.fileno()) | ||
os.dup2(stderrfd, util.stderr.fileno()) | ||||
|
r16631 | pager.wait() | ||
|
r11182 | |||
|
r6323 | def uisetup(ui): | ||
|
r30722 | class pagerui(ui.__class__): | ||
def _runpager(self, pagercmd): | ||||
_runpager(self, pagercmd) | ||||
ui.__class__ = pagerui | ||||
|
r7216 | def pagecmd(orig, ui, options, cmd, cmdfunc): | ||
|
r30635 | p = ui.config("pager", "pager", encoding.environ.get("PAGER")) | ||
|
r21277 | usepager = False | ||
|
r21278 | always = util.parsebool(options['pager']) | ||
|
r21279 | auto = options['pager'] == 'auto' | ||
|
r14515 | |||
|
r30847 | if not p or '--debugger' in sys.argv or not ui.formatted(): | ||
|
r21277 | pass | ||
|
r21278 | elif always: | ||
usepager = True | ||||
|
r21279 | elif not auto: | ||
usepager = False | ||||
|
r21277 | else: | ||
|
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 | |||
|
r24066 | setattr(ui, 'pageractive', usepager) | ||
|
r21277 | if usepager: | ||
ui.setconfig('ui', 'formatted', ui.formatted(), 'pager') | ||||
ui.setconfig('ui', 'interactive', False, 'pager') | ||||
if util.safehasattr(signal, "SIGPIPE"): | ||||
signal.signal(signal.SIGPIPE, signal.SIG_DFL) | ||||
|
r30722 | ui._runpager(p) | ||
|
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 | |||
|
r12694 | def extsetup(ui): | ||
commands.globalopts.append( | ||||
('', 'pager', 'auto', | ||||
_("when to paginate (boolean, always, auto, or never)"), | ||||
_('TYPE'))) | ||||
|
r9841 | attended = ['annotate', 'cat', 'diff', 'export', 'glog', 'log', 'qdiff'] | ||