utilities/runlatex.sh

#!/bin/sh
#
# Run pdflatex on the specified file.
# Attempt to avoid useless repeats.
# This version is heavily customized to be used for perfbook.
# It is assumed to be used together with runfirstlatex.sh
# and Makefile of perfbook.
#
# Usage: sh runlatex.sh file[.tex]
#
# 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 2 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, you can access it online at
# http://www.gnu.org/licenses/gpl-2.0.html.
#
# Copyright (C) IBM Corporation, 2012-2019
# Copyright (C) Facebook, 2019
# Copyright (C) Akira Yokosawa, 2016, 2017, 2023
#
# Authors: Paul E. McKenney <paulmck@us.ibm.com>
#          Akira Yokosawa <akiyks@gmail.com>

: ${LATEX:=pdflatex}

diff_warning () {
	if diff -q $basename-warning.log $basename-warning-prev.log >/dev/null
	then
		echo "No more improvement is expected, giving up."
		return 0 ;
	else
#		echo "Some improvements are observed, continuing."
		return 1 ;
	fi
}

identical_warnings () {
	if test -r $basename-warning-prev.log
	then
		if test "$iter" -gt "$min_iter" && diff_warning
		then
			return 0 ;
		fi
	fi
	return 1 ;
}

excerpt_warnings () {
	if grep -q "LaTeX Warning:" $basename.log
	then
		echo "----- Excerpt around remaining warning messages -----"
		grep -B 8 -A 5 "LaTeX Warning:" $basename.log | tee $basename-warning.log
		echo "----- You can see $basename-warning.log for the warnings above. -----"
		echo "----- If you need to, see $basename.log for details. -----"
		rm -f $basename-warning-prev.log
		exit 1
	fi
}

iterate_latex () {
	perl utilities/adjustindexformat.pl $basename.idx > $basename-adjust.idx
	cp -f $basename-adjust.idx $basename.idx
	makeindex $basename.idx > /dev/null 2>&1
	makeindex $basename-ppl.idx > /dev/null 2>&1
	makeindex $basename-api.idx > /dev/null 2>&1
	if grep -q '## Warning' $basename.ilg $basename-ppl.ilg $basename-api.ilg
	then
		echo "----- Warning in makeindex, see .ilg log files. -----"
		exit 1
	fi
	makeglossaries $basename > /dev/null 2>&1
	$LATEX $LATEX_OPT $basename > /dev/null 2>&1 < /dev/null
	exitcode=$?
	ENCGUESS_CMD=`command -v encguess`
	if [ "x$ENCGUESS_CMD" != "x" ]
	then
		if encguess -s iso-8859-1 $basename.log | grep -q ISO-8859-1
		then
			mv $basename.log $basename-tmp.log
			iconv -f ISO-8859-1 -t UTF-8 $basename-tmp.log > $basename.log
			rm $basename-tmp.log
		fi
	fi
	if grep -q '! Emergency stop.' $basename.log
	then
		grep -B 10 -A 5 '! Emergency stop.' $basename.log
		echo "----- Fatal latex error, see $basename.log for details. -----"
		exit 2
	fi
	if [ $exitcode -ne 0 ]; then
		tail -n 20 $basename.log
		echo "\n!!! $LATEX aborted !!!"
		exit $exitcode
	fi
	if test -r $basename-warning.log
	then
		mv -f $basename-warning.log $basename-warning-prev.log
	fi
	grep 'LaTeX Warning:' $basename.log > $basename-warning.log
	return 0 ;
}

if test -z "$1"
then
	echo No latex file specified, aborting.
	exit 1
fi

basename=`echo $1 | sed -e 's/\.tex$//'`
pdfname=`env printf "%-19s" $basename.pdf`

if ! test -r $basename-first.log
then
	echo "No need to update aux and bbl files."
	echo "$LATEX 1 for $basename.pdf"
	iter=1
else
	rm -f $basename-first.log
	echo "$LATEX 2 for $pdfname # for possible bib update"
	iter=2
fi
iterate_latex
min_iter=2
while grep -q 'LaTeX Warning: There were undefined references' $basename.log
do
	if test $undefined_refs
	then
		echo "Undefined refs remain, giving up."
		excerpt_warnings
	fi
	if identical_warnings
	then
		break
	fi
	iter=`expr $iter + 1`
	echo "$LATEX $iter for $pdfname # remaining undefined refs"
	undefined_refs=1
	iterate_latex
done
min_iter=3
while grep -q 'LaTeX Warning: Label(s) may have changed' $basename.log
do
	if identical_warnings
	then
		break
	fi
	iter=`expr $iter + 1`
	echo "$LATEX $iter for $pdfname # label(s) may have changed"
	iterate_latex
done
excerpt_warnings
rm -f $basename-warning.log $basename-warning-prev.log
echo "'$basename.pdf' is ready."
# cleveref version check (Ubuntu 18.04 LTS has buggy one
if grep -q -F "packageversion{0.21.1}" `kpsewhich cleveref.sty`
then
	echo "############################################################"
	echo "### Buggy version of LaTeX package 'cleveref' detected!! ###"
	echo "### (Known issue on Ubuntu 18.04 LTS)                    ###"
	echo "### Required TeX Live is 2019/Debian or later.           ###"
	echo "### Consider upgrading to Ubuntu 20.04 LTS or later.     ###"
	echo "############################################################"
fi
# to avoid redundant run of bibtex and pdflatex
touch $basename.bbl
touch $basename.pdf
sh utilities/mpostcheck.sh
exit 0