contrib/eqn2graph/eqn2graph.sh

   1 #! /bin/sh
   2 #
   3 # eqn2graph -- compile EQN equation descriptions to bitmap images
   4 #
   5 # by Eric S. Raymond <esr@thyrsus.com>, July 2002
   6 #
   7 # In Unixland, the magic is in knowing what to string together...
   8 #
   9 # Take an eqn equation on stdin, emit cropped bitmap on stdout.
  10 # The pic markup should *not* be wrapped in .EQ/.EN, this script will do that.
  11 # A -U option on the command line enables gpic/groff "unsafe" mode.
  12 # A -format FOO option changes the image output format to any format
  13 # supported by convert(1).  All other options are passed to convert(1).
  14 # The default format is PNG.
  15 #
  16 # This is separate from pic2graph because pic processing has some weird
  17 # clipping effect on the output, mangling equations that are very wide
  18 # or deep.  Besides, this tool can supply its own delimiters.
  19 #
  20
  21 # Requires the groff suite and the ImageMagick tools.  Both are open source.
  22 # This code is released to the public domain.
  23 #
  24 # Here are the assumptions behind the option processing:
  25 #
  26 # 1. None of the options of eqn(1) are relevant.
  27 #
  28 # 2. Only the -U option of groff(1) is relevant.
  29 #
  30 # 3. Many options of convert(1) are potentially relevant, (especially
  31 # -density, -interlace, -transparency, -border, and -comment).
  32 #
  33 # Thus, we pass -U to groff(1), and everything else to convert(1).
  34 #
  35 groff_opts=""
  36 convert_opts=""
  37 format="png"
  38
  39 while [ "$1" ]
  40 do
  41     case $1 in
  42     -unsafe)
  43         groff_opts="-U";;
  44     -format)
  45         format=$2
  46         shift;;
  47     -v | --version)
  48         echo "GNU eqn2graph (groff) version @VERSION@"
  49         exit 0;;
  50     --help)
  51         echo "usage: eqn2graph [ option ...] < in > out"
  52         exit 0;;
  53     *)
  54         convert_opts="$convert_opts $1";;
  55     esac
  56     shift
  57 done
  58
  59 # create temporary directory
  60 tmp=
  61 for d in "$GROFF_TMPDIR" "$TMPDIR" "$TMP" "$TEMP" /tmp; do
  62     test -z "$d" && continue
  63
  64     tmp=`(umask 077 && mktemp -d -q "$d/eqn2graph-XXXXXX") 2> /dev/null` \
  65     && test -n "$tmp" && test -d "$tmp" \
  66     && break
  67
  68     tmp=$d/eqn2graph$$-$RANDOM
  69     (umask 077 && mkdir $tmp) 2> /dev/null && break
  70 done;
  71 if test -z "$tmp"; then
  72     echo "$0: cannot create temporary directory" >&2
  73     { (exit 1); exit 1; }
  74 fi
  75
  76 trap 'exit_status=$?; rm -rf $tmp && exit $exit_status' EXIT INT TERM
  77
  78 # Here goes:
  79 # 1. Add .EQ/.EN.
  80 # 2. Process through eqn(1) to emit troff markup.
  81 # 3. Process through groff(1) to emit Postscript.
  82 # 4. Use convert(1) to crop the Postscript and turn it into a bitmap.
  83 read equation
  84 (echo ".EQ"; echo 'delim $$'; echo ".EN"; echo '$'"$equation"'$') | \
  85         groff -e $groff_opts -Tps -P-pletter > $tmp/eqn2graph.ps \
  86         && convert -trim $convert_opts $tmp/eqn2graph.ps $tmp/eqn2graph.$format \
  87         && cat $tmp/eqn2graph.$format
  88
  89 # End