lib/scripts/legacy_lyxpreview2ppm.py

   1 #! /usr/bin/env python -tt
   2 # -*- coding: iso-8859-1 -*-
   3
   4 # file legacy_lyxpreview2ppm.py
   5 # This file is part of LyX, the document processor.
   6 # Licence details can be found in the file COPYING.
   7
   8 # author Angus Leeming
   9 # Full author contact details are available in file CREDITS
  10
  11 # with much advice from members of the preview-latex project:
  12 #   David Kastrup, dak@gnu.org and
  13 #   Jan-Åke Larsson, jalar@mai.liu.se.
  14 # and with much help testing the code under Windows from
  15 #   Paul A. Rubin, rubin@msu.edu.
  16
  17 # This script takes a LaTeX file and generates a collection of
  18 # ppm image files, one per previewed snippet.
  19 # Example usage:
  20 # legacy_lyxpreview2bitmap.py 0lyxpreview.tex 128 ppm 000000 faf0e6
  21
  22 # This script takes five arguments:
  23 # TEXFILE:       the name of the .tex file to be converted.
  24 # SCALEFACTOR:   a scale factor, used to ascertain the resolution of the
  25 #                generated image which is then passed to gs.
  26 # OUTPUTFORMAT:  the format of the output bitmap image files.
  27 #                This particular script can produce only "ppm" format output.
  28 # FG_COLOR:      the foreground color as a hexadecimal string, eg '000000'.
  29 # BG_COLOR:      the background color as a hexadecimal string, eg 'faf0e6'.
  30
  31 # Decomposing TEXFILE's name as DIR/BASE.tex, this script will,
  32 # if executed successfully, leave in DIR:
  33 # * a (possibly large) number of image files with names
  34 #   like BASE[0-9]+.ppm
  35 # * a file BASE.metrics, containing info needed by LyX to position
  36 #   the images correctly on the screen.
  37
  38 # The script uses several external programs and files:
  39 # * A latex executable;
  40 # * preview.sty;
  41 # * dvips;
  42 # * gs;
  43 # * pnmcrop (optional).
  44
  45 # preview.sty is part of the preview-latex project
  46 #   http://preview-latex.sourceforge.net/
  47 # Alternatively, it can be obtained from
  48 #   CTAN/support/preview-latex/
  49
  50 # The script uses the deprecated dvi->ps->ppm conversion route.
  51 # If possible, please grab 'dvipng'; it's faster and more robust.
  52 # If you have it then this script will not be invoked by
  53 # lyxpreview2bitmap.py.
  54 # Warning: this legacy support will be removed one day...
  55
  56 import glob, os, pipes, re, string, sys
  57
  58 from lyxpreview_tools import copyfileobj, error, find_exe, \
  59      find_exe_or_terminate, mkstemp, run_command
  60
  61 # Pre-compiled regular expression.
  62 latex_file_re = re.compile("\.tex$")
  63
  64
  65 def usage(prog_name):
  66     return "Usage: %s <latex file> <dpi> ppm <fg color> <bg color>\n"\
  67            "\twhere the colors are hexadecimal strings, eg 'faf0e6'"\
  68            % prog_name
  69
  70
  71 def extract_metrics_info(log_file, metrics_file):
  72     metrics = open(metrics_file, 'w')
  73
  74     log_re = re.compile("Preview: ([ST])")
  75     data_re = re.compile("(-?[0-9]+) (-?[0-9]+) (-?[0-9]+) (-?[0-9]+)")
  76
  77     tp_ascent  = 0.0
  78     tp_descent = 0.0
  79
  80     success = 0
  81     try:
  82         for line in open(log_file, 'r').readlines():
  83             match = log_re.match(line)
  84             if match == None:
  85                 continue
  86
  87             snippet = (match.group(1) == 'S')
  88             success = 1
  89             match = data_re.search(line)
  90             if match == None:
  91                 error("Unexpected data in %s\n%s" % (log_file, line))
  92
  93             if snippet:
  94                 ascent  = string.atoi(match.group(2))
  95                 descent = string.atoi(match.group(3))
  96
  97                 frac = 0.5
  98                 if ascent >= 0 and descent >= 0:
  99                     ascent = float(ascent) + tp_ascent
 100                     descent = float(descent) - tp_descent
 101
 102                     if abs(ascent + descent) > 0.1:
 103                         frac = ascent / (ascent + descent)
 104
 105                     # Sanity check
 106                     if frac < 0 or frac > 1:
 107                             frac = 0.5
 108
 109                 metrics.write("Snippet %s %f\n" % (match.group(1), frac))
 110
 111             else:
 112                 tp_descent = string.atof(match.group(2))
 113                 tp_ascent  = string.atof(match.group(4))
 114
 115     except:
 116         # Unable to open the file, but do nothing here because
 117         # the calling function will act on the value of 'success'.
 118         warning('Warning in extract_metrics_info! Unable to open "%s"' % log_file)
 119         warning(`sys.exc_type` + ',' + `sys.exc_value`)
 120
 121     return success
 122
 123
 124 def extract_resolution(log_file, dpi):
 125     fontsize_re = re.compile("Preview: Fontsize")
 126     magnification_re = re.compile("Preview: Magnification")
 127     extract_decimal_re = re.compile("([0-9\.]+)")
 128     extract_integer_re = re.compile("([0-9]+)")
 129
 130     found_fontsize = 0
 131     found_magnification = 0
 132
 133     # Default values
 134     magnification = 1000.0
 135     fontsize = 10.0
 136
 137     try:
 138         for line in open(log_file, 'r').readlines():
 139             if found_fontsize and found_magnification:
 140                 break
 141
 142             if not found_fontsize:
 143                 match = fontsize_re.match(line)
 144                 if match != None:
 145                     match = extract_decimal_re.search(line)
 146                     if match == None:
 147                         error("Unable to parse: %s" % line)
 148                     fontsize = string.atof(match.group(1))
 149                     found_fontsize = 1
 150                     continue
 151
 152             if not found_magnification:
 153                 match = magnification_re.match(line)
 154                 if match != None:
 155                     match = extract_integer_re.search(line)
 156                     if match == None:
 157                         error("Unable to parse: %s" % line)
 158                     magnification = string.atof(match.group(1))
 159                     found_magnification = 1
 160                     continue
 161
 162     except:
 163         warning('Warning in extract_resolution! Unable to open "%s"' % log_file)
 164         warning(`sys.exc_type` + ',' + `sys.exc_value`)
 165
 166     # This is safe because both fontsize and magnification have
 167     # non-zero default values.
 168     return dpi * (10.0 / fontsize) * (1000.0 / magnification)
 169
 170
 171 def legacy_latex_file(latex_file, fg_color, bg_color):
 172     use_preview_re = re.compile("(\\\\usepackage\[[^]]+)(\]{preview})")
 173
 174     tmp = mkstemp()
 175
 176     success = 0
 177     try:
 178         for line in open(latex_file, 'r').readlines():
 179             match = use_preview_re.match(line)
 180             if match == None:
 181                 tmp.write(line)
 182                 continue
 183
 184             success = 1
 185             tmp.write("%s,dvips,tightpage%s\n\n" \
 186                       "\\AtBeginDocument{\\AtBeginDvi{%%\n" \
 187                       "\\special{!userdict begin/bop-hook{//bop-hook exec\n" \
 188                       "<%s%s>{255 div}forall setrgbcolor\n" \
 189                       "clippath fill setrgbcolor}bind def end}}}\n" \
 190                       % (match.group(1), match.group(2), fg_color, bg_color))
 191
 192     except:
 193         # Unable to open the file, but do nothing here because
 194         # the calling function will act on the value of 'success'.
 195         warning('Warning in legacy_latex_file! Unable to open "%s"' % latex_file)
 196         warning(`sys.exc_type` + ',' + `sys.exc_value`)
 197
 198     if success:
 199         copyfileobj(tmp, open(latex_file,"wb"), 1)
 200
 201     return success
 202
 203
 204 def crop_files(pnmcrop, basename):
 205     t = pipes.Template()
 206     t.append('%s -left' % pnmcrop, '--')
 207     t.append('%s -right' % pnmcrop, '--')
 208
 209     for file in glob.glob("%s*.ppm" % basename):
 210         tmp = mkstemp()
 211         new = t.open(file, "r")
 212         copyfileobj(new, tmp)
 213         if not new.close():
 214             copyfileobj(tmp, open(file,"wb"), 1)
 215
 216
 217 def legacy_conversion(argv):
 218     # Parse and manipulate the command line arguments.
 219     if len(argv) != 6:
 220         error(usage(argv[0]))
 221
 222     dir, latex_file = os.path.split(argv[1])
 223     if len(dir) != 0:
 224         os.chdir(dir)
 225
 226     dpi = string.atoi(argv[2])
 227
 228     output_format = argv[3]
 229     if output_format != "ppm":
 230         error("This script will generate ppm format images only.")
 231
 232     fg_color = argv[4]
 233     bg_color = argv[5]
 234
 235     # External programs used by the script.
 236     path = string.split(os.environ["PATH"], os.pathsep)
 237     latex   = find_exe_or_terminate(["pplatex", "latex2e", "latex"], path)
 238     dvips   = find_exe_or_terminate(["dvips"], path)
 239     gs      = find_exe_or_terminate(["gswin32c", "gs"], path)
 240     pnmcrop = find_exe(["pnmcrop"], path)
 241
 242     # Move color information into the latex file.
 243     if not legacy_latex_file(latex_file, fg_color, bg_color):
 244         error("Unable to move color info into the latex file")
 245
 246     # Compile the latex file.
 247     latex_call = '%s "%s"' % (latex, latex_file)
 248
 249     latex_status, latex_stdout = run_command(latex_call)
 250     if latex_status != None:
 251         error("%s failed to compile %s" \
 252               % (os.path.basename(latex), latex_file))
 253
 254     # Run the dvi file through dvips.
 255     dvi_file = latex_file_re.sub(".dvi", latex_file)
 256     ps_file  = latex_file_re.sub(".ps",  latex_file)
 257
 258     dvips_call = '%s -o "%s" "%s"' % (dvips, ps_file, dvi_file)
 259
 260     dvips_status, dvips_stdout = run_command(dvips_call)
 261     if dvips_status != None:
 262         error("Failed: %s %s" % (os.path.basename(dvips), dvi_file))
 263
 264     # Extract resolution data for gs from the log file.
 265     log_file = latex_file_re.sub(".log", latex_file)
 266     resolution = extract_resolution(log_file, dpi)
 267
 268     # Older versions of gs have problems with a large degree of
 269     # anti-aliasing at high resolutions
 270     alpha = 4
 271     if resolution > 150:
 272         alpha = 2
 273
 274     # Generate the bitmap images
 275     gs_call = '%s -dNOPAUSE -dBATCH -dSAFER -sDEVICE=pnmraw ' \
 276               '-sOutputFile="%s%%d.ppm" ' \
 277               '-dGraphicsAlphaBit=%d -dTextAlphaBits=%d ' \
 278               '-r%f "%s"' \
 279               % (gs, latex_file_re.sub("", latex_file), \
 280                  alpha, alpha, resolution, ps_file)
 281
 282     gs_status, gs_stdout = run_command(gs_call)
 283     if gs_status != None:
 284         error("Failed: %s %s" % (os.path.basename(gs), ps_file))
 285
 286     # Crop the images
 287     if pnmcrop != None:
 288         crop_files(pnmcrop, latex_file_re.sub("", latex_file))
 289
 290     # Extract metrics info from the log file.
 291     metrics_file = latex_file_re.sub(".metrics", latex_file)
 292     if not extract_metrics_info(log_file, metrics_file):
 293         error("Failed to extract metrics info from %s" % log_file)
 294
 295     return 0
 296
 297
 298 if __name__ == "__main__":
 299     legacy_conversion(sys.argv)