#!/bin/sh
# ------------------------------------------------------------------------------
#
# git-qnext: Implements the "git qnext" extension command.
#
# This is derived from git-qtop.shar, which provides each of the qit-qtop,
# git-qprev, and git-qnext extension commands, for identification of the most
# recently applied patch, its immediately applied predecessor, or its next
# unguarded successor respectively, from a patch queue series file.
#
# $Id$
#
# ------------------------------------------------------------------------------
#
# 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).
#
OPTION_VERBOSE_DEFINED=true OPTIONS_SPEC="\
git qnext [-v | --verbose] [-s | --summary]

Identify the next available unguarded, unapplied patch.
--
s,summary!   include summary line from patch header
v,verbose!   provide more detailed identification"
#
# ------------------------------------------------------------------------------
#
# $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"

# Parse any command line options, which the user may have specified;
# the git_mq_getopt function will implicitly handle the default global
# options, but we must explicitly handle command specific effects.
#
while git_mq_getopt "$@"
do case $1 in
     -v) mq_output='printf "%*d %s %s\n", fw, idx, state[$1],' ;;
     -s) mq_qseries_append_summary=1 ;;
   esac
   shift
done

test "${mq_output+set}" = set && {
  mq_require mq-why-guarded
  mq_qseries_break_at_unguarded='break;
    print why_guarded( "Skipping " $1 " -- guarded by" );'
}

mq_qseries_report_setup='
    for( idx0 = applied + 1; entries > idx0; idx0++ )
    { $0 = series[idx0];
      if( state[$1] == "U" )
	'"${mq_qseries_break_at_unguarded-break}"';
    }
    if( idx0 < entries )
      entries = idx0 + 1;
    else
    { print "All patches have been applied.";
      exit 1;
    }'

# Hand off the listing task to the generalized "git qseries" output
# module; this serves as a common back-end handler for all commands
# which are related to "git qseries"; it also specifies the default
# style for the output from these commands.
#
mq_require mq-series-list
#
# ------------------------------------------------------------------------------
# $RCSfile$: end of file
