58c706c546cd6d699efd4a394b584668172b745f
[stgit] / stgit / commands / series.py
1
2 __copyright__ = """
3 Copyright (C) 2005, Catalin Marinas <catalin.marinas@gmail.com>
4
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License version 2 as
7 published by the Free Software Foundation.
8
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
13
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 """
18
19 import sys, os
20 from optparse import OptionParser, make_option
21
22 from stgit.commands.common import *
23 from stgit.utils import *
24 from stgit import stack, git
25
26
27 help = 'print the patch series'
28 usage = """%prog [options]
29
30 Show all the patches in the series. The applied patches are prefixed
31 with a '+' and the unapplied ones with a '-'. The current patch is
32 prefixed with a '>'. Empty patches are prefixed with a '0'."""
33
34 options = [make_option('-b', '--branch',
35 help = 'use BRANCH instead of the default one'),
36 make_option('-c', '--count',
37 help = 'print the number of patches in the series',
38 action = 'store_true'),
39 make_option('-d', '--description',
40 help = 'show a short description for each patch',
41 action = 'store_true'),
42 make_option('-e', '--empty',
43 help = 'check whether patches are empty '
44 '(much slower)',
45 action = 'store_true'),
46 make_option('-s', '--short',
47 help = 'list just the patches around the topmost patch',
48 action = 'store_true'),
49 make_option('-g', '--graphical',
50 help = 'run gitk instead of printing',
51 action = 'store_true')]
52
53
54 def __get_description(patch):
55 """Extract and return a patch's short description
56 """
57 p = crt_series.get_patch(patch)
58 descr = (p.get_description() or '').strip()
59 descr_lines = descr.split('\n')
60 return descr_lines[0].rstrip()
61
62 def __print_patch(patch, prefix, empty_prefix, length, options):
63 if options.empty and crt_series.empty_patch(patch):
64 prefix = empty_prefix
65 if options.description:
66 print prefix + patch.ljust(length) + ' | ' + __get_description(patch)
67 else:
68 print prefix + patch
69
70 def func(parser, options, args):
71 """Show the patch series
72 """
73 if len(args) != 0:
74 parser.error('incorrect number of arguments')
75
76 applied = crt_series.get_applied()
77 unapplied = crt_series.get_unapplied()
78
79 if options.count:
80 print len(applied) + len(unapplied)
81 return
82
83 if options.short:
84 if len(applied) > 5:
85 applied = applied[-6:]
86 if len(unapplied) > 5:
87 unapplied = unapplied[:5]
88
89 patches = applied + unapplied
90 if not patches:
91 return
92
93 if options.graphical:
94 if applied:
95 gitk_args = ' %s^..%s' % (git_id(applied[0]), git_id(applied[-1]))
96 else:
97 gitk_args = ''
98
99 for p in unapplied:
100 patch_id = git_id(p)
101 gitk_args += ' %s^..%s' % (patch_id, patch_id)
102
103 if os.system('gitk%s' % gitk_args) != 0:
104 raise CmdException, 'gitk execution failed'
105 else:
106 max_len = 0
107 if len(patches) > 0:
108 max_len = max([len(i) for i in patches])
109
110 if len(applied) > 0:
111 for p in applied [0:-1]:
112 __print_patch(p, '+ ', '0 ', max_len, options)
113
114 __print_patch(applied[-1], '> ', '0>', max_len, options)
115
116 for p in unapplied:
117 __print_patch(p, '- ', '0 ', max_len, options)