mdw@git.distorted.org.uk Git - stgit/blob - 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 import stgit.commands.common
  23 from stgit.commands.common import *
  24 from stgit.utils import *
  25 from stgit import stack, git
  26
  27
  28 help = 'print the patch series'
  29 usage = """%prog [options] [<patch-range>]
  30
  31 Show all the patches in the series or just those in the given
  32 range. The applied patches are prefixed with a '+' and the unapplied
  33 ones with a '-'. The current patch is prefixed with a '>'. Empty
  34 patches are prefixed with a '0'. The '*' postfix is appended to hidden
  35 patches."""
  36
  37 options = [make_option('-b', '--branch',
  38                        help = 'use BRANCH instead of the default one'),
  39            make_option('-a', '--all',
  40                        help = 'show all patches, including the hidden ones',
  41                        action = 'store_true'),
  42            make_option('-i', '--invisible',
  43                        help = 'show the hidden patches only',
  44                        action = 'store_true'),
  45            make_option('-m', '--missing', metavar = 'BRANCH',
  46                        help = 'show patches in BRANCH missing in current'),
  47            make_option('-c', '--count',
  48                        help = 'print the number of patches in the series',
  49                        action = 'store_true'),
  50            make_option('-d', '--description',
  51                        help = 'show a short description for each patch',
  52                        action = 'store_true'),
  53            make_option('-e', '--empty',
  54                        help = 'check whether patches are empty '
  55                        '(much slower)',
  56                        action = 'store_true'),
  57            make_option('--showbranch',
  58                        help = 'append the branch name to the listed patches',
  59                        action = 'store_true'),
  60            make_option('--noprefix',
  61                        help = 'do not show the patch status prefix',
  62                        action = 'store_true'),
  63            make_option('-s', '--short',
  64                        help = 'list just the patches around the topmost patch',
  65                        action = 'store_true'),
  66            make_option('-g', '--graphical',
  67                        help = 'run gitk instead of printing',
  68                        action = 'store_true')]
  69
  70
  71 def __get_description(patch):
  72     """Extract and return a patch's short description
  73     """
  74     p = crt_series.get_patch(patch)
  75     descr = (p.get_description() or '').strip()
  76     descr_lines = descr.split('\n')
  77     return descr_lines[0].rstrip()
  78
  79 def __print_patch(patch, hidden, branch_str, prefix, empty_prefix, length,
  80                   options):
  81     """Print a patch name, description and various markers.
  82     """
  83     if options.noprefix:
  84         prefix = ''
  85     elif options.empty and crt_series.empty_patch(patch):
  86         prefix = empty_prefix
  87
  88     patch_str = patch + branch_str
  89     if not options.noprefix and patch in hidden:
  90         patch_str += '*'
  91
  92     if options.description:
  93         print prefix + patch_str.ljust(length) + ' | ' \
  94               + __get_description(patch)
  95     else:
  96         print prefix + patch_str
  97
  98 def func(parser, options, args):
  99     """Show the patch series
 100     """
 101     global crt_series
 102
 103     if options.missing:
 104         # switch the series, the one specified with --missing should
 105         # become the current
 106         cmp_series = crt_series
 107         crt_series = stack.Series(options.missing)
 108         stgit.commands.common.crt_series = crt_series
 109
 110         cmp_patches = cmp_series.get_applied() + cmp_series.get_unapplied()
 111     else:
 112         cmp_patches = []
 113
 114     applied = crt_series.get_applied()
 115     unapplied = crt_series.get_unapplied()
 116
 117     # the filtering range covers the whole series
 118     if args:
 119         show_patches = parse_patches(args, applied + unapplied, len(applied))
 120     else:
 121         show_patches = applied + unapplied
 122
 123     # missing filtering
 124     show_patches = [p for p in show_patches if p not in cmp_patches]
 125
 126     # hidden patches filtering
 127     hidden = crt_series.get_hidden()
 128     if options.invisible:
 129         show_patches = [p for p in show_patches if p in hidden]
 130     elif not options.all:
 131         show_patches = [p for p in show_patches if p not in hidden]
 132
 133     # filter the patches
 134     applied = [p for p in applied if p in show_patches]
 135     unapplied = [p for p in unapplied if p in show_patches]
 136
 137     if options.short:
 138         if len(applied) > 5:
 139             applied = applied[-6:]
 140         if len(unapplied) > 5:
 141             unapplied = unapplied[:5]
 142
 143     patches = applied + unapplied
 144
 145     if options.count:
 146         print len(patches)
 147         return
 148
 149     if not patches:
 150         return
 151
 152     if options.showbranch:
 153         branch_str = '@' + crt_series.get_branch()
 154     else:
 155         branch_str = ''
 156
 157     if options.graphical:
 158         if options.missing:
 159             raise CmdException, '--graphical not supported with --missing'
 160
 161         if applied:
 162             gitk_args = ' %s^..%s' % (git_id(applied[0]), git_id(applied[-1]))
 163         else:
 164             gitk_args = ''
 165
 166         for p in unapplied:
 167             patch_id = git_id(p)
 168             gitk_args += ' %s^..%s' % (patch_id, patch_id)
 169
 170         if os.system('gitk%s' % gitk_args) != 0:
 171             raise CmdException, 'gitk execution failed'
 172     else:
 173         max_len = 0
 174         if len(patches) > 0:
 175             max_len = max([len(i + branch_str) for i in patches])
 176             max_len += 1
 177
 178         if len(applied) > 0:
 179             current = crt_series.get_current()
 180             if applied[-1] == current:
 181                 del applied[-1]
 182             else:
 183                 current = None
 184
 185             for p in applied:
 186                 __print_patch(p, hidden, branch_str, '+ ', '0 ', max_len,
 187                               options)
 188
 189             if current:
 190                 __print_patch(current, hidden, branch_str, '> ', '0>', max_len,
 191                               options)
 192
 193         for p in unapplied:
 194             __print_patch(p, hidden, branch_str, '- ', '0 ', max_len, options)