#! /bin/sh

# RCS to ChangeLog generator

# Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 2001, 2002, 2003,
#               2004, 2005, 2006, 2007, 2008, 2009, 2010
#               Free Software Foundation, Inc.

# Author: Paul Eggert <eggert@twinsun.com>

# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.

# This program 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 License for more details.

# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.


Copyright='Copyright (C) 2010 Free Software Foundation, Inc.
This program comes with NO WARRANTY, to the extent permitted by law.
You may redistribute copies of this program
under the terms of the GNU General Public License.
For more information about these matters, see the files named COPYING.
Author: Paul Eggert <eggert@twinsun.com>'

Help='
Generate ChangeLog entries from RCS files (perhaps in a CVS repository)
and the ChangeLog file (if any).  An RCS file typically has a name
ending in ",v", and represents the entire history of a file that is
under revision control.  The ChangeLog file logs entries for changes,
in reverse chronological order.

Generate entries for changes entered into RCS (or CVS) more recently
than the newest existing entry in the ChangeLog file.  You can then
edit these entries by hand, and prepend them to the ChangeLog file.

Output the resulting ChangeLog entries to standard output.
Each entry looks something like this:

2004-04-17  Paul Eggert  <eggert@gnu.org>

	* rcs2log (Help): Clarify wording of the usage message.
	Problem reported by Alan Mackenzie in
	<http://mail.gnu.org/archive/html/bug-gnu-emacs/2004-04/msg00188.html>.

ChangeLog entries contain the current date, full name, email address
including hostname, the name of the affected file, and commentary.
RCS and CVS logs lack full names and email addresses, so they are
inferred from login names using a heuristic that can be overridden
via the -u option.

Ignore log entries that start with "#".
Clump together log entries that start with "{topic} ",
where "topic" contains neither white space nor "}".

If no FILE is specified, use all files under the working directory
that are maintained under version control.

Options:

  -c FILE  Output ChangeLog entries for FILE (default ChangeLog).
  -h HOSTNAME  Use HOSTNAME in change log entries (default current host).
  -i INDENT  Indent change log lines by INDENT spaces (default 8).
  -l LENGTH  Try to limit log lines to LENGTH characters (default 79).
  -L FILE  Use FILE (same format as "rlog") for source of logs.
  -R  If no FILEs are given and RCS is used, recurse through working directory.
  -r OPTION  Pass OPTION to subsidiary command (either "rlog" or "cvs -q log").
  -t TABWIDTH  Tab stops are every TABWIDTH characters (default 8).
  -u "LOGIN<tab>FULLNAME<tab>EMAILADDR"  LOGIN has FULLNAME and EMAILADDR.
  -v  Append RCS revision to file names in log lines.
  --help  Output help.
  --version  Output version number.

Report bugs to <bug-gnu-emacs@gnu.org>.'

Id='$Id$'

# Use the traditional C locale.
LANG=C
LANGUAGE=C
LC_ALL=C
LC_COLLATE=C
LC_CTYPE=C
LC_MESSAGES=C
LC_NUMERIC=C
LC_TIME=C
export LANG LANGUAGE LC_ALL LC_COLLATE LC_CTYPE LC_MESSAGES LC_NUMERIC LC_TIME

# These variables each contain a single ASCII character.
# Unfortunately, there's no portable way of writing these characters
# in older Unix implementations, other than putting them directly into
# this text file.
SOH='' # SOH, octal code 001
tab='	'
nl='
'

# Parse options.

# defaults
AWK=${AWK-awk}
TMPDIR=${TMPDIR-/tmp}
changelog=ChangeLog # change log file name
datearg= # rlog date option
hostname= # name of local host (if empty, will deduce it later)
indent=8 # indent of log line
length=79 # suggested max width of log line
logins= # login names for people we know fullnames and mailaddrs of
loginFullnameMailaddrs= # login<tab>fullname<tab>mailaddr triplets
logTZ= # time zone for log dates (if empty, use local time)
recursive= # t if we want recursive rlog
revision= # t if we want revision numbers
rlog_options= # options to pass to rlog
rlogfile= # log file to read from
tabwidth=8 # width of horizontal tab

while :
do
	case $1 in
	-c)	changelog=${2?}; shift;;
	-i)	indent=${2?}; shift;;
	-h)	hostname=${2?}; shift;;
	-l)	length=${2?}; shift;;
	-L)	rlogfile=${2?}; shift;;
	-[nu])	# -n is obsolescent; it is replaced by -u.
		case $1 in
		-n)	case ${2?}${3?}${4?} in
			*"$tab"* | *"$nl"*)
				echo >&2 "$0: -n '$2' '$3' '$4': tabs, newlines not allowed"
				exit 1;;
			esac
			login=$2
			lfm=$2$tab$3$tab$4
			shift; shift; shift;;
		-u)
			# If $2 is not tab-separated, use colon for separator.
			case ${2?} in
			*"$nl"*)
				echo >&2 "$0: -u '$2': newlines not allowed"
				exit 1;;
			*"$tab"*)
				t=$tab;;
			*)
				t=':';;
			esac
			case $2 in
			*"$t"*"$t"*"$t"*)
				echo >&2 "$0: -u '$2': too many fields"
				exit 1;;
			*"$t"*"$t"*)
				uf="[^$t]*$t" # An unselected field, followed by a separator.
				sf="\\([^$t]*\\)" # The selected field.
				login=`expr "X$2" : "X$sf"`
				lfm="$login$tab"`
					expr "X$2" : "$uf$sf"
				  `"$tab"`
					expr "X$2" : "$uf$uf$sf"
				`;;
			*)
				echo >&2 "$0: -u '$2': not enough fields"
				exit 1;;
			esac
			shift;;
		esac
		case $logins in
		'') logins=$login;;
		?*) logins=$logins$nl$login;;
		esac
		case $loginFullnameMailaddrs in
		'') loginFullnameMailaddrs=$lfm;;
		?*) loginFullnameMailaddrs=$loginFullnameMailaddrs$nl$lfm;;
		esac;;
	-r)
		case $rlog_options in
		'') rlog_options=${2?};;
		?*) rlog_options=$rlog_options$nl${2?};;
		esac
		shift;;
	-R)	recursive=t;;
	-t)	tabwidth=${2?}; shift;;
	-v)	revision=t;;
	--version)
		set $Id
		rcs2logVersion=$3
		echo >&2 "rcs2log (GNU Emacs) $rcs2logVersion$nl$Copyright"
		exit 0;;
	-*)	echo >&2 "Usage: $0 [OPTION]... [FILE ...]$nl$Help"
		case $1 in
		--help) exit 0;;
		*) exit 1;;
		esac;;
	*)	break;;
	esac
	shift
done

month_data='
	m[0]="Jan"; m[1]="Feb"; m[2]="Mar"
	m[3]="Apr"; m[4]="May"; m[5]="Jun"
	m[6]="Jul"; m[7]="Aug"; m[8]="Sep"
	m[9]="Oct"; m[10]="Nov"; m[11]="Dec"
'

logdir=$TMPDIR/rcs2log$$
llogout=$logdir/l
trap exit 1 2 13 15
trap "rm -fr $logdir 2>/dev/null" 0
(umask 077 && exec mkdir $logdir) || exit

# If no rlog-format log file is given, generate one into $rlogfile.
case $rlogfile in
'')
	rlogfile=$logdir/r

	# If no rlog options are given,
	# log the revisions checked in since the first ChangeLog entry.
	# Since ChangeLog is only by date, some of these revisions may be
	# duplicates of what's already in ChangeLog; it's the user's
	# responsibility to remove them.
	case $rlog_options in
	'')
		if test -s "$changelog"
		then
			e='
				/^[0-9]+-[0-9][0-9]-[0-9][0-9]/{
					# ISO 8601 date
					print $1
					exit
				}
				/^... ... [ 0-9][0-9] [ 0-9][0-9]:[0-9][0-9]:[0-9][0-9] [0-9]+ /{
					# old-fashioned date and time (Emacs 19.31 and earlier)
					'"$month_data"'
					year = $5
					for (i=0; i<=11; i++) if (m[i] == $2) break
					dd = $3
					printf "%d-%02d-%02d\n", year, i+1, dd
					exit
				}
			'
			d=`$AWK "$e" <"$changelog"` || exit
			case $d in
			?*) datearg="-d>$d";;
			esac
		fi;;
	esac

	# Use TZ specified by ChangeLog local variable, if any.
	if test -s "$changelog"
	then
		extractTZ='
			/^.*change-log-time-zone-rule['"$tab"' ]*:['"$tab"' ]*"\([^"]*\)".*/{
				s//\1/; p; q
			}
			/^.*change-log-time-zone-rule['"$tab"' ]*:['"$tab"' ]*t.*/{
				s//UTC0/; p; q
			}
		'
		logTZ=`tail "$changelog" | sed -n "$extractTZ"`
		case $logTZ in
		?*) TZ=$logTZ; export TZ;;
		esac
	fi

	# If CVS is in use, examine its repository, not the normal RCS files.
	if test ! -f CVS/Repository
	then
		rlog=rlog
		repository=
	else
		rlog='cvs -q log'
		repository=`sed 1q <CVS/Repository` || exit
		test ! -f CVS/Root || CVSROOT=`cat <CVS/Root` || exit
		pository=
		case $CVSROOT in
		/* | :fork:* | :local:*) ;;
		*/*)
			# remote repository
			pository=`expr "X$CVSROOT" : '[^/]*\(.*\)'`;;
		esac
		case $pository in
		'')
			# local repository
			case $repository in
			/*) ;;
			*)
				repository=${CVSROOT?}/$repository
				case $repository in
				:fork:* | :local:*)
					repository=`expr "$repository" : ':[^:]*:\(.*\)'`;;
				esac;;
			esac
			if test ! -d "$repository"
			then
				echo >&2 "$0: $repository: bad repository (see CVS/Repository)"
				exit 1
			fi
			pository=$repository;;
		esac

		# Ensure that $pository ends in exactly one slash.
		while :
		do
			case $pository in
			*//) pository=`expr "X$pository" : 'X\(.*\)/'`;;
			*/) break;;
			*) pository=$pository/; break;;
			esac
		done

		# If no rlog options are given, and if we are in a tagged CVS branch,
		# log only the changes in that branch.
		case $rlog_options in
		'')
			if test -f CVS/Tag
			then
				CVSTAG=`cat <CVS/Tag` || exit
				case $CVSTAG in
				T?*)
					rlog_options=-r`expr "$CVSTAG" : 'T\(.*\)'`;;
				*)
					echo >&2 "$0: invalid CVS/Tag"; exit 1;;
				esac
			fi;;
		esac
	fi

	# Use $rlog's -zLT option, if $rlog supports it.
	case `$rlog -zLT 2>&1` in
	*' option'*) ;;
	*)
		case $rlog_options in
		'') rlog_options=-zLT;;
		?*) rlog_options=-zLT$nl$rlog_options;;
		esac;;
	esac

	# With no arguments, examine all files under the RCS directory.
	case $# in
	0)
		case $repository in
		'')
			oldIFS=$IFS
			IFS=$nl
			case $recursive in
			t)
				RCSdirs=`find . -name RCS -type d -print`
				filesFromRCSfiles='s|,v$||; s|/RCS/|/|; s|^\./||'
				files=`
					{
						case $RCSdirs in
						?*) find $RCSdirs \
								-type f \
								! -name '*_' \
								! -name ',*,' \
								! -name '.*_' \
								! -name .rcsfreeze.log \
								! -name .rcsfreeze.ver \
								-print;;
						esac
						find . -name '*,v' -print
					} |
					sort -u |
					sed "$filesFromRCSfiles"
				`;;
			*)
				files=
				for file in RCS/.* RCS/* .*,v *,v
				do
					case $file in
					RCS/. | RCS/.. | RCS/,*, | RCS/*_) continue;;
					RCS/.rcsfreeze.log | RCS/.rcsfreeze.ver) continue;;
					RCS/.\* | RCS/\* | .\*,v | \*,v) test -f "$file" || continue;;
					RCS/*,v | RCS/.*,v) ;;
					RCS/* | RCS/.*) test -f "$file" || continue;;
					esac
					case $files in
					'') files=$file;;
					?*) files=$files$nl$file;;
					esac
				done
				case $files in
				'') exit 0;;
				esac;;
			esac
			set x $files
			shift
			IFS=$oldIFS;;
		esac;;
	esac

	case $datearg in
	?*) $rlog $rlog_options "$datearg" ${1+"$@"} >$rlogfile;;
	'') $rlog $rlog_options ${1+"$@"} >$rlogfile;;
	esac || exit;;
esac


# Prefer the POSIX-style -k options, since POSIX 1003.1-2001 prohibits
# support for the traditional-style +M -N options.
SORT_K_OPTIONS='-k 3,4r -k 5 -k 1'
sort $SORT_K_OPTIONS </dev/null 2>/dev/null || SORT_K_OPTIONS='+2 -4r +4 +0'


# Get the full name of each author the logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set initialize_fullname
# to awk code that initializes the `fullname' awk associative array.
# Warning: foreic logs mention, and set in