pager.py
101 lines
| 3.3 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 | # | ||
|
r6462 | # Run "hg help pager" to get info on configuration. | ||
|
r8894 | '''browse command output with an external pager | ||
|
r6462 | |||
|
r9212 | To set the pager that should be used, set the application variable:: | ||
|
r6462 | |||
[pager] | ||||
|
r12892 | pager = less -FRSX | ||
|
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. | ||||
|
r10973 | To ignore global commands like :hg:`version` or :hg:`help`, you have | ||
|
r12083 | to specify them in your user configuration file. | ||
|
r12694 | |||
The --pager=... option can also be used to control when the pager is | ||||
used. Use a boolean value like yes, no, on, off, or use auto for | ||||
normal behavior. | ||||
|
r6462 | ''' | ||
|
r6323 | |||
|
r16631 | import atexit, sys, os, signal, subprocess | ||
|
r12694 | from mercurial import commands, dispatch, util, extensions | ||
from mercurial.i18n import _ | ||||
|
r6323 | |||
|
r12876 | def _runpager(p): | ||
|
r16631 | pager = subprocess.Popen(p, shell=True, bufsize=-1, | ||
close_fds=util.closefds, stdin=subprocess.PIPE, | ||||
stdout=sys.stdout, stderr=sys.stderr) | ||||
stdout = os.dup(sys.stdout.fileno()) | ||||
stderr = os.dup(sys.stderr.fileno()) | ||||
os.dup2(pager.stdin.fileno(), sys.stdout.fileno()) | ||||
if util.isatty(sys.stderr): | ||||
os.dup2(pager.stdin.fileno(), sys.stderr.fileno()) | ||||
@atexit.register | ||||
def killpager(): | ||||
pager.stdin.close() | ||||
os.dup2(stdout, sys.stdout.fileno()) | ||||
os.dup2(stderr, sys.stderr.fileno()) | ||||
pager.wait() | ||||
|
r11182 | |||
|
r6323 | def uisetup(ui): | ||
|
r14515 | if ui.plain() or '--debugger' in sys.argv or not util.isatty(sys.stdout): | ||
|
r11414 | return | ||
|
r7216 | def pagecmd(orig, ui, options, cmd, cmdfunc): | ||
|
r6417 | p = ui.config("pager", "pager", os.environ.get("PAGER")) | ||
|
r14515 | |||
if p: | ||||
|
r9841 | attend = ui.configlist('pager', 'attend', attended) | ||
|
r12694 | auto = options['pager'] == 'auto' | ||
always = util.parsebool(options['pager']) | ||||
if (always or auto and | ||||
(cmd in attend or | ||||
(cmd not in ui.configlist('pager', 'ignore') and not attend))): | ||||
|
r11328 | ui.setconfig('ui', 'formatted', ui.formatted()) | ||
|
r10516 | ui.setconfig('ui', 'interactive', False) | ||
|
r16652 | if util.safehasattr(signal, "SIGPIPE"): | ||
|
r16632 | signal.signal(signal.SIGPIPE, signal.SIG_DFL) | ||
|
r12876 | _runpager(p) | ||
|
r7216 | return orig(ui, options, cmd, cmdfunc) | ||
|
r6417 | |||
|
r7216 | extensions.wrapfunction(dispatch, '_runcommand', pagecmd) | ||
|
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'] | ||