lyx_mirror/lib/scripts/lyxpreview2ppm.sh

#!/bin/sh
#
# \file lyxpreview2ppm.sh
# Copyright 2002 the LyX Team
# Read the file COPYING
#
# \author Angus Leeming, leeming@lyx.org
#
# with much help from David Kastrup, david.kastrup@t-online.de.
# The sed script was created with advice from Praveen D V, praveend@sasken.com
# and the sed users' list, sed-users@yahoogroups.com.

# This script takes a LaTeX file and generates PPM files, one per page.
# The idea is to use it with preview.sty to create small bitmap previews of
# things like math equations.

# The script takes two arguments, the name of the file to be converted and
# the resolution of the generated image, to be passed to gs.
if [ $# -ne 2 ]; then
	exit 1
fi

# A couple of helper functions
FIND_IT () {
	which ${EXECUTABLE} > /dev/null
	STATUS=$?
	if [ ${STATUS} -ne 0 ]; then
		echo "Unable to find \"${EXECUTABLE}\". Please install."
		exit 1
	fi
}

BAIL_OUT () {
	# Remove everything except the original .tex file.
	FILES=`ls ${BASE}* | sed -e "/${BASE}.tex/d"`
	rm -f ${FILES} texput.log
	exit 1
}

# We use latex, dvips and gs, so check that they're all there.
EXECUTABLE=latex; FIND_IT
EXECUTABLE=dvips; FIND_IT
EXECUTABLE=gs;    FIND_IT

# Initialise some variables.
TEXFILE=`basename $1`
RESOLUTION=$2

DIR=`dirname $1`
BASE=`basename $1 .tex`
DVIFILE=${BASE}.dvi
PSFILE=${BASE}.ps
METRICSFILE=${BASE}.metrics

# LaTeX -> DVI.
cd ${DIR}
latex ${TEXFILE}
STATUS=$?
if [ ${STATUS} -ne 0 ]; then
	# LaTeX failed.
	# preview.sty has known problems with the showlabels option,
	# so remove it and try again.
	# This "fix" should be removed once preview-latex 0.73 is released.
	sed -e '/^\\usepackage/,/{preview}$/s/,showlabels//' \
		< ${TEXFILE} > .${TEXFILE}
	cmp -s ${TEXFILE} .${TEXFILE}
	STATUS=$?
	if [ ${STATUS} -eq 0 ]; then
		rm -f .${TEXFILE}
		echo "Failed: latex ${TEXFILE}"
		BAIL_OUT
	fi

	mv -f .${TEXFILE} ${TEXFILE}
	latex ${TEXFILE}
	STATUS=$?
	if [ ${STATUS} -ne 0 ]; then
		echo "Failed: latex ${TEXFILE}"
		BAIL_OUT
	fi
fi

# DVI -> PostScript
dvips -o ${PSFILE} ${DVIFILE}
STATUS=$?
if [ ${STATUS} -ne 0 ]; then
	echo "Failed: dvips -o ${PSFILE} ${DVIFILE}"
	BAIL_OUT
fi

# PostScript -> Bitmap files
# Older versions of gs have problems with a large degree of anti-aliasing
# at high resolutions
ALPHA=4
if [ ${RESOLUTION} -gt 150 ]; then
	ALPHA=2
fi

gs -q -dNOPAUSE -dBATCH -dSAFER -sDEVICE=pnmraw -sOutputFile=${BASE}%03d.ppm \
    -dGraphicsAlphaBit=${ALPHA} -dTextAlphaBits=${ALPHA} -r${RESOLUTION} \
    ${PSFILE}

STATUS=$?
if [ ${STATUS} -ne 0 ]; then
	echo "Failed: gs ${PSFILE}"
	BAIL_OUT
fi

# Attempt to generate a file ${METRICSFILE} that contains only the tightpage
# bounding box info, extract from ${PSFILE}

# 1. Create a file containing the sed instructions
SEDFILE=${BASE}.sed
cat - > ${SEDFILE} <<EOF
# Delete everything that's enclosed between %%BeginDocument and %%EndDocument
/^\%\%BeginDocument/,/^\%\%EndDocument/d

# Extract the tightpage bounding box info.
# Given this snippet:
# %%Page: 1 1
# 1 0 bop
# -32890 -32890 32890 32890 492688 0 744653
# The sed command gives this:
# %%Page 1: -32890 -32890 32890 32890 492688 0 744653

/^\%\%Page:/{
  s/\: \(.*\) .*$/ \1: /;N;N
  s/\n[^\n]*\n//p
}

# Delete everything (so only the stuff that's printed, above, goes into the
# metrics file).
d
EOF

# 2. Run sed!
sed -f ${SEDFILE} < ${PSFILE} > ${METRICSFILE}
rm -f ${SEDFILE}

# The ppm files have spurious (?! say some !) white space on the left and right
# sides. If you want this removed set REMOVE_WS=1.
REMOVE_WS=0

which pnmcrop > /dev/null
STATUS=$?

if [ ${STATUS} -ne 0 ]; then
	REMOVE_WS=0
fi

if [ ${REMOVE_WS} -eq 1 ]; then
	TMP=.${BASE}.ppm
	for FILE in `ls ${BASE}???.ppm`
	do
		pnmcrop -left ${FILE} | pnmcrop -right > ${TMP}
		STATUS=$?
		if [ ${STATUS} -eq 0 ]; then
			mv -f ${TMP} ${FILE}
		fi
	done
fi

# All was successful, so remove everything except the ppm files and the
# metrics file.
FILES=`ls ${BASE}* | sed -e "/${BASE}.metrics/d" -e "/${BASE}[0-9]\{3\}.ppm/d"`
rm -f ${FILES}