##// END OF EJS Templates
pager: break pager invocation out of command check loop
Matt Mackall -
r21277:2bc778e2 default
parent child Browse files
Show More
@@ -1,148 +1,154
1 # pager.py - display output using a pager
1 # pager.py - display output using a pager
2 #
2 #
3 # Copyright 2008 David Soria Parra <dsp@php.net>
3 # Copyright 2008 David Soria Parra <dsp@php.net>
4 #
4 #
5 # This software may be used and distributed according to the terms of the
5 # This software may be used and distributed according to the terms of the
6 # GNU General Public License version 2 or any later version.
6 # GNU General Public License version 2 or any later version.
7 #
7 #
8 # To load the extension, add it to your configuration file:
8 # To load the extension, add it to your configuration file:
9 #
9 #
10 # [extension]
10 # [extension]
11 # pager =
11 # pager =
12 #
12 #
13 # Run "hg help pager" to get info on configuration.
13 # Run "hg help pager" to get info on configuration.
14
14
15 '''browse command output with an external pager
15 '''browse command output with an external pager
16
16
17 To set the pager that should be used, set the application variable::
17 To set the pager that should be used, set the application variable::
18
18
19 [pager]
19 [pager]
20 pager = less -FRX
20 pager = less -FRX
21
21
22 If no pager is set, the pager extensions uses the environment variable
22 If no pager is set, the pager extensions uses the environment variable
23 $PAGER. If neither pager.pager, nor $PAGER is set, no pager is used.
23 $PAGER. If neither pager.pager, nor $PAGER is set, no pager is used.
24
24
25 You can disable the pager for certain commands by adding them to the
25 You can disable the pager for certain commands by adding them to the
26 pager.ignore list::
26 pager.ignore list::
27
27
28 [pager]
28 [pager]
29 ignore = version, help, update
29 ignore = version, help, update
30
30
31 You can also enable the pager only for certain commands using
31 You can also enable the pager only for certain commands using
32 pager.attend. Below is the default list of commands to be paged::
32 pager.attend. Below is the default list of commands to be paged::
33
33
34 [pager]
34 [pager]
35 attend = annotate, cat, diff, export, glog, log, qdiff
35 attend = annotate, cat, diff, export, glog, log, qdiff
36
36
37 Setting pager.attend to an empty value will cause all commands to be
37 Setting pager.attend to an empty value will cause all commands to be
38 paged.
38 paged.
39
39
40 If pager.attend is present, pager.ignore will be ignored.
40 If pager.attend is present, pager.ignore will be ignored.
41
41
42 To ignore global commands like :hg:`version` or :hg:`help`, you have
42 To ignore global commands like :hg:`version` or :hg:`help`, you have
43 to specify them in your user configuration file.
43 to specify them in your user configuration file.
44
44
45 The --pager=... option can also be used to control when the pager is
45 The --pager=... option can also be used to control when the pager is
46 used. Use a boolean value like yes, no, on, off, or use auto for
46 used. Use a boolean value like yes, no, on, off, or use auto for
47 normal behavior.
47 normal behavior.
48 '''
48 '''
49
49
50 import atexit, sys, os, signal, subprocess, errno, shlex
50 import atexit, sys, os, signal, subprocess, errno, shlex
51 from mercurial import commands, dispatch, util, extensions, cmdutil
51 from mercurial import commands, dispatch, util, extensions, cmdutil
52 from mercurial.i18n import _
52 from mercurial.i18n import _
53
53
54 testedwith = 'internal'
54 testedwith = 'internal'
55
55
56 def _pagerfork(ui, p):
56 def _pagerfork(ui, p):
57 if not util.safehasattr(os, 'fork'):
57 if not util.safehasattr(os, 'fork'):
58 sys.stdout = util.popen(p, 'wb')
58 sys.stdout = util.popen(p, 'wb')
59 if ui._isatty(sys.stderr):
59 if ui._isatty(sys.stderr):
60 sys.stderr = sys.stdout
60 sys.stderr = sys.stdout
61 return
61 return
62 fdin, fdout = os.pipe()
62 fdin, fdout = os.pipe()
63 pid = os.fork()
63 pid = os.fork()
64 if pid == 0:
64 if pid == 0:
65 os.close(fdin)
65 os.close(fdin)
66 os.dup2(fdout, sys.stdout.fileno())
66 os.dup2(fdout, sys.stdout.fileno())
67 if ui._isatty(sys.stderr):
67 if ui._isatty(sys.stderr):
68 os.dup2(fdout, sys.stderr.fileno())
68 os.dup2(fdout, sys.stderr.fileno())
69 os.close(fdout)
69 os.close(fdout)
70 return
70 return
71 os.dup2(fdin, sys.stdin.fileno())
71 os.dup2(fdin, sys.stdin.fileno())
72 os.close(fdin)
72 os.close(fdin)
73 os.close(fdout)
73 os.close(fdout)
74 try:
74 try:
75 os.execvp('/bin/sh', ['/bin/sh', '-c', p])
75 os.execvp('/bin/sh', ['/bin/sh', '-c', p])
76 except OSError, e:
76 except OSError, e:
77 if e.errno == errno.ENOENT:
77 if e.errno == errno.ENOENT:
78 # no /bin/sh, try executing the pager directly
78 # no /bin/sh, try executing the pager directly
79 args = shlex.split(p)
79 args = shlex.split(p)
80 os.execvp(args[0], args)
80 os.execvp(args[0], args)
81 else:
81 else:
82 raise
82 raise
83
83
84 def _pagersubprocess(ui, p):
84 def _pagersubprocess(ui, p):
85 pager = subprocess.Popen(p, shell=True, bufsize=-1,
85 pager = subprocess.Popen(p, shell=True, bufsize=-1,
86 close_fds=util.closefds, stdin=subprocess.PIPE,
86 close_fds=util.closefds, stdin=subprocess.PIPE,
87 stdout=sys.stdout, stderr=sys.stderr)
87 stdout=sys.stdout, stderr=sys.stderr)
88
88
89 stdout = os.dup(sys.stdout.fileno())
89 stdout = os.dup(sys.stdout.fileno())
90 stderr = os.dup(sys.stderr.fileno())
90 stderr = os.dup(sys.stderr.fileno())
91 os.dup2(pager.stdin.fileno(), sys.stdout.fileno())
91 os.dup2(pager.stdin.fileno(), sys.stdout.fileno())
92 if ui._isatty(sys.stderr):
92 if ui._isatty(sys.stderr):
93 os.dup2(pager.stdin.fileno(), sys.stderr.fileno())
93 os.dup2(pager.stdin.fileno(), sys.stderr.fileno())
94
94
95 @atexit.register
95 @atexit.register
96 def killpager():
96 def killpager():
97 if util.safehasattr(signal, "SIGINT"):
97 if util.safehasattr(signal, "SIGINT"):
98 signal.signal(signal.SIGINT, signal.SIG_IGN)
98 signal.signal(signal.SIGINT, signal.SIG_IGN)
99 pager.stdin.close()
99 pager.stdin.close()
100 os.dup2(stdout, sys.stdout.fileno())
100 os.dup2(stdout, sys.stdout.fileno())
101 os.dup2(stderr, sys.stderr.fileno())
101 os.dup2(stderr, sys.stderr.fileno())
102 pager.wait()
102 pager.wait()
103
103
104 def _runpager(ui, p):
104 def _runpager(ui, p):
105 # The subprocess module shipped with Python <= 2.4 is buggy (issue3533).
105 # The subprocess module shipped with Python <= 2.4 is buggy (issue3533).
106 # The compat version is buggy on Windows (issue3225), but has been shipping
106 # The compat version is buggy on Windows (issue3225), but has been shipping
107 # with hg for a long time. Preserve existing functionality.
107 # with hg for a long time. Preserve existing functionality.
108 if sys.version_info >= (2, 5):
108 if sys.version_info >= (2, 5):
109 _pagersubprocess(ui, p)
109 _pagersubprocess(ui, p)
110 else:
110 else:
111 _pagerfork(ui, p)
111 _pagerfork(ui, p)
112
112
113 def uisetup(ui):
113 def uisetup(ui):
114 if '--debugger' in sys.argv or not ui.formatted():
114 if '--debugger' in sys.argv or not ui.formatted():
115 return
115 return
116
116
117 def pagecmd(orig, ui, options, cmd, cmdfunc):
117 def pagecmd(orig, ui, options, cmd, cmdfunc):
118 p = ui.config("pager", "pager", os.environ.get("PAGER"))
118 p = ui.config("pager", "pager", os.environ.get("PAGER"))
119 usepager = False
119
120
120 if p:
121 if not p:
122 pass
123 else:
121 attend = ui.configlist('pager', 'attend', attended)
124 attend = ui.configlist('pager', 'attend', attended)
122 auto = options['pager'] == 'auto'
125 auto = options['pager'] == 'auto'
123 always = util.parsebool(options['pager'])
126 always = util.parsebool(options['pager'])
124
127
125 cmds, _ = cmdutil.findcmd(cmd, commands.table)
128 cmds, _ = cmdutil.findcmd(cmd, commands.table)
126
129
127 ignore = ui.configlist('pager', 'ignore')
130 ignore = ui.configlist('pager', 'ignore')
128 for cmd in cmds:
131 for cmd in cmds:
129 if (always or auto and
132 if (always or auto and
130 (cmd in attend or
133 (cmd in attend or
131 (cmd not in ignore and not attend))):
134 (cmd not in ignore and not attend))):
135 usepager = True
136 break
137
138 if usepager:
132 ui.setconfig('ui', 'formatted', ui.formatted(), 'pager')
139 ui.setconfig('ui', 'formatted', ui.formatted(), 'pager')
133 ui.setconfig('ui', 'interactive', False, 'pager')
140 ui.setconfig('ui', 'interactive', False, 'pager')
134 if util.safehasattr(signal, "SIGPIPE"):
141 if util.safehasattr(signal, "SIGPIPE"):
135 signal.signal(signal.SIGPIPE, signal.SIG_DFL)
142 signal.signal(signal.SIGPIPE, signal.SIG_DFL)
136 _runpager(ui, p)
143 _runpager(ui, p)
137 break
138 return orig(ui, options, cmd, cmdfunc)
144 return orig(ui, options, cmd, cmdfunc)
139
145
140 extensions.wrapfunction(dispatch, '_runcommand', pagecmd)
146 extensions.wrapfunction(dispatch, '_runcommand', pagecmd)
141
147
142 def extsetup(ui):
148 def extsetup(ui):
143 commands.globalopts.append(
149 commands.globalopts.append(
144 ('', 'pager', 'auto',
150 ('', 'pager', 'auto',
145 _("when to paginate (boolean, always, auto, or never)"),
151 _("when to paginate (boolean, always, auto, or never)"),
146 _('TYPE')))
152 _('TYPE')))
147
153
148 attended = ['annotate', 'cat', 'diff', 'export', 'glog', 'log', 'qdiff']
154 attended = ['annotate', 'cat', 'diff', 'export', 'glog', 'log', 'qdiff']
General Comments 0
You need to be logged in to leave comments. Login now