#!/bin/sh
# ------------------------------------------------------------------------------
#
# git-qdelete.sh: Implement the Git-MQ "git qdelete" extension command.
#
# Remove patches from the Git-MQ patch series, and optionally delete the
# associated patch files from the Git-MQ patch directory.  Applied patches
# cannot be deleted.
#
# $Id$
#
# ------------------------------------------------------------------------------
#
mq_facility="git qdelete"
#
# I'd have liked to call this a "SYNOPSIS", (which is what it is), but git's
# git-sh-setup script requires the much less appropriate name "OPTIONS_SPEC",
# (which describes only a small subset of its actual content).
#
OPTIONS_SPEC="\
git qdelete [-k | --keep] <patch> ...

Remove patches from the Git-MQ patch series, and from project history;
by default, also delete the associated patch files from the Git-MQ patch
directory.  Patches which have been applied cannot be removed.
--
k,keep!   retain the patch file(s) in the patch directory"
#
# ------------------------------------------------------------------------------
#
# $Id$
#
# Written by Keith Marshall <keith@users.osdn.me>
# Copyright (C) 2018-2020, 2022, Keith Marshall
#
#
# This file is part of the Git-MQ program suite.
#
# The Git-MQ program suite is free software: you can redistribute it
# and/or modify it under the terms of the GNU General Public Licence
# as published by the Free Software Foundation, either version 3 of
# the Licence, or (at your option) any later version.
#
# The Git-MQ program suite is distributed in the hope that it will be
# useful, but WITHOUT ANY WARRANTY; without even the implied warranty
# of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public Licence for more details.
#
# You should have received a copy of the GNU General Public Licence
# along with this program.  If not, see <https://www.gnu.org/licenses/>.
#
# ------------------------------------------------------------------------------
#
# Although they may not always have any effect, all Git-MQ commands, like
# their hg counterparts, are expected to accept the global verbosity, and
# colour control options; ensure that they are declared:
#
OPTIONS_SPEC="$OPTIONS_SPEC
colour?*     generic output colour control -- may have no effect"
${OPTION_VERBOSE_DEFINED-false} || OPTIONS_SPEC="$OPTIONS_SPEC
v,verbose!*  generic verbosity selector -- may have no effect"

# For Git-MQ options, such as "--colour", we prefer a spelling convention
# which conforms to "World English" standards; however, git itself adopts
# "US English" convention.  Thus, we must also accommodate users who will
# specify "--color" instead of "--colour", without creating any ambiguity
# in the possible abbreviations; to achieve this, we check for "--color",
# among the command-line arguments, replacing it with "--colour", BEFORE
# we allow git to parse them.
#
for mq_argv
do case "$mq_argv" in
     --color*) mq_argv=`echo $mq_argv | sed 's/^--colo/&u/'` ;;
     --no-color) mq_argv="--no-colour" ;;
   esac
   ${mq_argv_init-true} && { set -- "$mq_argv"; mq_argv_init=false
   } || set -- "$@" "$mq_argv"
done

# Now, we may let git parse the command line, and set up its shell script
# processing environment, for use within a git working directory tree.
#
SUBDIRECTORY_OK=true . "`git --exec-path`/git-sh-setup" && require_work_tree

libexecdir=`dirname "$0"`
test `basename "$libexecdir"` = bin && libexecdir=`dirname "$libexecdir"`
libexecdir="$libexecdir/libexec/git-mq/${VERSION=1.0}"

mq_require(){ test -f "$1" || die "fatal: '$1' not found."; . "$1"; }
mq_require "$libexecdir/git-mq-setup.sh"

# Check if the "--keep" option has been specified; ignore any of
# the standard Git-MQ options, which may have been specified on the
# command line.
#
while git_mq_getopt "$@"
do test "$1" = "-k" && mq_remove_opt=false; shift
done

# At least one patch name argument is required.  Thus, after option
# processing, at least one argument must remain.
#
test $# -gt 0 || mq_abort 2 "error: must specify at least one patch name"

# Patch deletion requires removal of associated registration records
# from the series file; we require a temporary file, in which to make
# an interim copy of the series file, excluding such deleted records.
#
mq_require mq-tmpfile
mq_tmpfile mq_series_file_tmp '`mktemp --tmpdir="$mq_patchdir"` ||
  $fatal "cannot establish series file update cache"'

# To verify that each argument specifies an existing, registered, and
# unapplied patch, we need to parse both series and status files.
#
mq_map_control_file_refs "$mq_patchdir" series status
for arg; do echo "$arg"; done | awk >&2 "$mq_series $mq_status "'

# After parsing the series and status file records, we verify each
# specified patch name, reading each in turn from the stdin pipe.
#
  FILENAME == "-" {
    if( $0 in state )
    { if( state[$0] == "A" )
      { print prog ": error: cannot delete applied patch \47" $0 "\47";
	status = 2;
      }
      else arg[$0] = 1;
    }
    else
    { print prog ": error: no \47" $0 "\47 in patch series";
      status = 2;
    }
  }
# Provided all specified patches are valid candidates for deletion,
# we atomically write out an updated copy of the series file.
#
  END { if( status ) exit status;
    for( idx = 0; idx < entries; idx++ )
    { $0 = series[idx];
      if( !($1 in arg) ) print > "'"$mq_series_file_tmp"'";
    }
  }' prog="$mq_facility" "$mq_series_file" "$mq_status_file" - && {

# Finally, on successful update, we delete the specified patch files,
# (unless the "--keep" option was specified), and replace the series
# file with the updated copy.
#
    ${mq_remove_opt-true} && cd "$mq_patchdir" && rm "$@"
    mq_update mq_series_file
  }
#
# ------------------------------------------------------------------------------
# $RCSfile$: end of file
