Merge the preview mechanism for lilypond-book with the standard one.

- Handle the preprocessing in the main lyxpreview script with the
    command-line arguments --lilypond and --lilypond-book=exe.
  - Remove the obsoleted file lyxpreview-lytex2bitmap.py and the
    corresponding lines in configure.py.

Fix for the japanese preview still to come.

git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@39658 a592a061-630c-0410-9148-cb99ea01b6c8
This commit is contained in:
Julien Rioux 2011-09-11 18:22:59 +00:00
parent 2bd747fad4
commit 10868c31ac
6 changed files with 41 additions and 450 deletions

View File

@ -3014,7 +3014,6 @@ lib_scripts_files = Split('''
listerrors
lyxpak.py
lyxpreview2bitmap.py
lyxpreview-lytex2bitmap.py
lyxpreview-platex2bitmap.py
lyxpreview_tools.py
lyxstangle.R

View File

@ -1505,7 +1505,6 @@ dist_scripts_PYTHON = \
scripts/listerrors \
scripts/lyxpak.py \
scripts/lyxpreview2bitmap.py \
scripts/lyxpreview-lytex2bitmap.py \
scripts/lyxpreview-platex2bitmap.py \
scripts/lyxpreview_tools.py \
scripts/prefs2prefs.py \

View File

@ -596,7 +596,6 @@ def checkFormatEntries(dtl_tools):
\Format jlyx cjklyx "CJK LyX 1.4.x (euc-jp)" "" "" "" "document"
\Format klyx cjklyx "CJK LyX 1.4.x (euc-kr)" "" "" "" "document"
\Format lyxpreview lyxpreview "LyX Preview" "" "" "" ""
\Format lyxpreview-lytex lyxpreview-lytex "LyX Preview (LilyPond book)" "" "" "" ""
\Format lyxpreview-platex lyxpreview-platex "LyX Preview (pLaTeX)" "" "" "" ""
\Format pdftex pdftex_t PDFTEX "" "" "" ""
\Format program "" Program "" "" "" ""
@ -860,16 +859,6 @@ def checkConverterEntries(java='', perl=''):
version_number = match.groups()[0]
version = version_number.split('.')
if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 13):
if dv2dt == 'dv2dt':
addToRC(r'\converter lyxpreview-lytex ppm "python -tt $$s/scripts/lyxpreview-lytex2bitmap.py" ""')
else:
# set empty converter to override the default imagemagick
addToRC(r'\converter lyxpreview-lytex ppm "" ""')
if dvipng == "dvipng" and dv2dt == 'dv2dt':
addToRC(r'\converter lyxpreview-lytex png "python -tt $$s/scripts/lyxpreview-lytex2bitmap.py" ""')
else:
# set empty converter to override the default imagemagick
addToRC(r'\converter lyxpreview-lytex png "" ""')
# Note: The --lily-output-dir flag is required because lilypond-book
# does not process input again unless the input has changed,
# even if the output format being requested is different. So

View File

@ -1,430 +0,0 @@
#! /usr/bin/env python
# -*- coding: utf-8 -*-
# file lyxpreview-lytex2bitmap.py
# This file is part of LyX, the document processor.
# Licence details can be found in the file COPYING.
# author Angus Leeming
# with much advice from members of the preview-latex project:
# David Kastrup, dak@gnu.org and
# Jan-Åke Larsson, jalar@mai.liu.se.
# Full author contact details are available in file CREDITS
# This script takes a LaTeX file and generates a collection of
# png or ppm image files, one per previewed snippet.
# Pre-requisites:
# * A latex executable;
# * preview.sty;
# * dvipng;
# * pngtoppm (if outputing ppm format images).
# preview.sty and dvipng are part of the preview-latex project
# http://preview-latex.sourceforge.net/
# preview.sty can alternatively be obtained from
# CTAN/support/preview-latex/
# Example usage:
# lyxpreview-lytex2bitmap.py png 0lyxpreview.tex 128 000000 faf0e6
# This script takes six arguments:
# FORMAT: The desired output format. Either 'png' or 'ppm'.
# TEXFILE: the name of the .tex file to be converted.
# DPI: a scale factor, used to ascertain the resolution of the
# generated image which is then passed to gs.
# FG_COLOR: the foreground color as a hexadecimal string, eg '000000'.
# BG_COLOR: the background color as a hexadecimal string, eg 'faf0e6'.
# CONVERTER: the converter (optional). Default is latex.
# Decomposing TEXFILE's name as DIR/BASE.tex, this script will,
# if executed successfully, leave in DIR:
# * a (possibly large) number of image files with names
# like BASE[0-9]+.png
# * a file BASE.metrics, containing info needed by LyX to position
# the images correctly on the screen.
import glob, os, re, shutil, string, sys
from legacy_lyxpreview2ppm import legacy_conversion, \
legacy_conversion_step2, legacy_extract_metrics_info
from lyxpreview_tools import copyfileobj, error, find_exe, \
find_exe_or_terminate, make_texcolor, mkstemp, run_command, warning, \
write_metrics_info
# Pre-compiled regular expressions.
latex_file_re = re.compile("\.tex$")
def usage(prog_name):
return "Usage: %s <format> <latex file> <dpi> <fg color> <bg color>\n"\
"\twhere the colors are hexadecimal strings, eg 'faf0e6'"\
% prog_name
# Returns a list of tuples containing page number and ascent fraction
# extracted from dvipng output.
# Use write_metrics_info to create the .metrics file with this info
def extract_metrics_info(dvipng_stdout):
# "\[[0-9]+" can match two kinds of numbers: page numbers from dvipng
# and glyph numbers from mktexpk. The glyph numbers always match
# "\[[0-9]+\]" while the page number never is followed by "\]". Thus:
page_re = re.compile("\[([0-9]+)[^]]");
metrics_re = re.compile("depth=(-?[0-9]+) height=(-?[0-9]+)")
success = 0
page = ""
pos = 0
results = []
while 1:
match = page_re.search(dvipng_stdout, pos)
if match == None:
break
page = match.group(1)
pos = match.end()
match = metrics_re.search(dvipng_stdout, pos)
if match == None:
break
success = 1
# Calculate the 'ascent fraction'.
descent = string.atof(match.group(1))
ascent = string.atof(match.group(2))
frac = 0.5
if ascent >= 0 or descent >= 0:
if abs(ascent + descent) > 0.1:
frac = ascent / (ascent + descent)
# Sanity check
if frac < 0:
frac = 0.5
results.append((page, frac))
pos = match.end() + 2
if success == 0:
error("Failed to extract metrics info from dvipng")
return results
def color_pdf(latex_file, bg_color, fg_color):
use_preview_pdf_re = re.compile("(\s*\\\\usepackage\[[^]]+)((pdftex|xetex)\]{preview})")
tmp = mkstemp()
fg = ""
if fg_color != "0.000000,0.000000,0.000000":
fg = ' \\AtBeginDocument{\\let\\oldpreview\\preview\\renewcommand\\preview{\\oldpreview\\color[rgb]{%s}}}\n' % (fg_color)
success = 0
try:
for line in open(latex_file, 'r').readlines():
match = use_preview_pdf_re.match(line)
if match == None:
tmp.write(line)
continue
success = 1
tmp.write(" \\usepackage{color}\n" \
" \\pagecolor[rgb]{%s}\n" \
"%s" \
"%s\n" \
% (bg_color, fg, match.group()))
continue
except:
# Unable to open the file, but do nothing here because
# the calling function will act on the value of 'success'.
warning('Warning in color_pdf! Unable to open "%s"' % latex_file)
warning(`sys.exc_type` + ',' + `sys.exc_value`)
if success:
copyfileobj(tmp, open(latex_file,"wb"), 1)
return success
def fix_latex_file(latex_file):
documentclass_re = re.compile("(\\\\documentclass\[)(1[012]pt,?)(.+)")
tmp = mkstemp()
changed = 0
for line in open(latex_file, 'r').readlines():
match = documentclass_re.match(line)
if match == None:
tmp.write(line)
continue
changed = 1
tmp.write("%s%s%s\n" % (match.group(1), match.group(3)))
if changed:
copyfileobj(tmp, open(latex_file,"wb"), 1)
return
def convert_to_ppm_format(pngtopnm, basename):
png_file_re = re.compile("\.png$")
for png_file in glob.glob("%s*.png" % basename):
ppm_file = png_file_re.sub(".ppm", png_file)
p2p_cmd = '%s "%s"' % (pngtopnm, png_file)
p2p_status, p2p_stdout = run_command(p2p_cmd)
if p2p_status != None:
error("Unable to convert %s to ppm format" % png_file)
ppm = open(ppm_file, 'w')
ppm.write(p2p_stdout)
os.remove(png_file)
def main(argv):
# Parse and manipulate the command line arguments.
if len(argv) != 6 and len(argv) != 7:
error(usage(argv[0]))
output_format = string.lower(argv[1])
dir, latex_file = os.path.split(argv[2])
if len(dir) != 0:
os.chdir(dir)
dpi = string.atoi(argv[3])
fg_color = make_texcolor(argv[4], False)
bg_color = make_texcolor(argv[5], False)
fg_color_gr = make_texcolor(argv[4], True)
bg_color_gr = make_texcolor(argv[5], True)
# External programs used by the script.
path = string.split(os.environ["PATH"], os.pathsep)
if len(argv) == 7:
latex = argv[6]
else:
latex = find_exe_or_terminate(["latex", "pplatex", "platex", "latex2e"], path)
lilypond_book = find_exe_or_terminate(["lilypond-book"], path)
# Omit font size specification in latex file.
fix_latex_file(latex_file)
# Make a copy of the latex file
lytex_file = latex_file_re.sub(".lytex", latex_file)
shutil.copyfile(latex_file, lytex_file)
# Determine whether we need pdf or eps output
pdf_output = latex in ["lualatex", "pdflatex", "xelatex"]
# Preprocess the latex file through lilypond-book.
if pdf_output:
lytex_call = '%s --safe --pdf --latex-program=%s "%s"' % (lilypond_book, latex, lytex_file)
else:
lytex_call = '%s --safe --latex-program=%s "%s"' % (lilypond_book, latex, lytex_file)
lytex_status, lytex_stdout = run_command(lytex_call)
if lytex_status != None:
warning("%s failed to compile %s" \
% (os.path.basename(lilypond_book), lytex_file))
warning(lytex_stdout)
# This can go once dvipng becomes widespread.
dvipng = find_exe(["dvipng"], path)
if dvipng == None:
# The data is input to legacy_conversion in as similar
# as possible a manner to that input to the code used in
# LyX 1.3.x.
vec = [ argv[0], argv[2], argv[3], argv[1], argv[4], argv[5], latex ]
return legacy_conversion(vec)
pngtopnm = ""
if output_format == "ppm":
pngtopnm = find_exe_or_terminate(["pngtopnm"], path)
# Move color information for PDF into the latex file.
if not color_pdf(latex_file, bg_color_gr, fg_color_gr):
error("Unable to move color info into the latex file")
# Compile the latex file.
latex_call = '%s "%s"' % (latex, latex_file)
latex_status, latex_stdout = run_command(latex_call)
if latex_status != None:
warning("%s had problems compiling %s" \
% (os.path.basename(latex), latex_file))
warning(latex_stdout)
if latex == "xelatex":
warning("Using XeTeX")
# FIXME: skip unnecessary dvips trial in legacy_conversion_step2
return legacy_conversion_step2(latex_file, dpi, output_format)
# The dvi output file name
dvi_file = latex_file_re.sub(".dvi", latex_file)
# Check for PostScript specials in the dvi, badly supported by dvipng
# This is required for correct rendering of PSTricks and TikZ
dv2dt = find_exe_or_terminate(["dv2dt"], path)
dv2dt_call = '%s "%s"' % (dv2dt, dvi_file)
# The output from dv2dt goes to stdout
dv2dt_status, dv2dt_output = run_command(dv2dt_call)
psliteral_re = re.compile("^special[1-4] [0-9]+ '(\"|ps:)")
# Parse the dtl file looking for PostScript specials.
# Pages using PostScript specials are recorded in ps_pages and then
# used to create a different LaTeX file for processing in legacy mode.
page_has_ps = False
page_index = 0
ps_pages = []
for line in dv2dt_output.split("\n"):
# New page
if line.startswith("bop"):
page_has_ps = False
page_index += 1
# End of page
if line.startswith("eop") and page_has_ps:
# We save in a list all the PostScript pages
ps_pages.append(page_index)
if psliteral_re.match(line) != None:
# Literal PostScript special detected!
page_has_ps = True
pages_parameter = ""
if len(ps_pages) == page_index:
# All pages need PostScript, so directly use the legacy method.
vec = [argv[0], argv[2], argv[3], argv[1], argv[4], argv[5], latex]
return legacy_conversion(vec)
elif len(ps_pages) > 0:
# Don't process Postscript pages with dvipng by selecting the
# wanted pages through the -pp parameter. E.g., dvipng -pp 4-12,14,64
pages_parameter = " -pp "
skip = True
last = -1
# Use page ranges, as a list of pages could exceed command line
# maximum length (especially under Win32)
for index in xrange(1, page_index + 1):
if (not index in ps_pages) and skip:
# We were skipping pages but current page shouldn't be skipped.
# Add this page to -pp, it could stay alone or become the
# start of a range.
pages_parameter += str(index)
# Save the starting index to avoid things such as "11-11"
last = index
# We're not skipping anymore
skip = False
elif (index in ps_pages) and (not skip):
# We weren't skipping but current page should be skipped
if last != index - 1:
# If the start index of the range is the previous page
# then it's not a range
pages_parameter += "-" + str(index - 1)
# Add a separator
pages_parameter += ","
# Now we're skipping
skip = True
# Remove the trailing separator
pages_parameter = pages_parameter.rstrip(",")
# We've to manage the case in which the last page is closing a range
if (not index in ps_pages) and (not skip) and (last != index):
pages_parameter += "-" + str(index)
# Run the dvi file through dvipng.
dvipng_call = '%s -Ttight -depth -height -D %d -fg "%s" -bg "%s" %s "%s"' \
% (dvipng, dpi, fg_color, bg_color, pages_parameter, dvi_file)
dvipng_status, dvipng_stdout = run_command(dvipng_call)
if dvipng_status != None:
warning("%s failed to generate images from %s ... looking for PDF" \
% (os.path.basename(dvipng), dvi_file))
# FIXME: skip unnecessary dvips trial in legacy_conversion_step2
return legacy_conversion_step2(latex_file, dpi, output_format)
if len(ps_pages) > 0:
# Some pages require PostScript.
# Create a new LaTeX file just for the snippets needing
# the legacy method
original_latex = open(latex_file, "r")
legacy_latex_file = latex_file_re.sub("_legacy.tex", latex_file)
legacy_latex = open(legacy_latex_file, "w")
page_index = 0
skip_page = False
for line in original_latex:
if line.startswith("\\begin{preview}"):
page_index += 1
# Skips all pages processed by dvipng
skip_page = page_index not in ps_pages
if not skip_page:
legacy_latex.write(line)
if line.startswith("\\end{preview}"):
skip_page = False
legacy_latex.close()
original_latex.close()
# Pass the new LaTeX file to the legacy method
vec = [ argv[0], latex_file_re.sub("_legacy.tex", argv[2]), \
argv[3], argv[1], argv[4], argv[5], latex ]
legacy_conversion(vec, True)
# Now we need to mix metrics data from dvipng and the legacy method
metrics_file = latex_file_re.sub(".metrics", latex_file)
dvipng_metrics = extract_metrics_info(dvipng_stdout)
legacy_metrics = legacy_extract_metrics_info(latex_file_re.sub("_legacy.log", latex_file))
# Check whether a page is present in dvipng_metrics, otherwise
# add it getting the metrics from legacy_metrics
legacy_index = -1;
for i in range(page_index):
# If we exceed the array bounds or the dvipng_metrics doesn't
# match the current one, this page belongs to the legacy method
if (i > len(dvipng_metrics) - 1) or (dvipng_metrics[i][0] != str(i + 1)):
legacy_index += 1
# Add this metric from the legacy output
dvipng_metrics.insert(i, (str(i + 1), legacy_metrics[legacy_index][1]))
# Legacy output filename
legacy_output = os.path.join(dir, latex_file_re.sub("_legacy%s.%s" %
(legacy_metrics[legacy_index][0], output_format), latex_file))
# Check whether legacy method actually created the file
if os.path.isfile(legacy_output):
# Rename the file by removing the "_legacy" suffix
# and adjusting the index
bitmap_output = os.path.join(dir, latex_file_re.sub("%s.%s" %
(str(i + 1), output_format), latex_file))
os.rename(legacy_output, bitmap_output)
# Actually create the .metrics file
write_metrics_info(dvipng_metrics, metrics_file)
else:
# Extract metrics info from dvipng_stdout.
# In this case we just used dvipng, so no special metrics
# handling is needed.
metrics_file = latex_file_re.sub(".metrics", latex_file)
write_metrics_info(extract_metrics_info(dvipng_stdout), metrics_file)
# Convert images to ppm format if necessary.
if output_format == "ppm":
convert_to_ppm_format(pngtopnm, latex_file_re.sub("", latex_file))
return 0
if __name__ == "__main__":
main(sys.argv)

View File

@ -43,6 +43,9 @@
# --fg=<color>: The foreground color as a hexadecimal string, eg '000000'.
# --bg=<color>: The background color as a hexadecimal string, eg 'faf0e6'.
# --latex=<exe>: The converter for latex files. Default is latex.
# --lilypond: Preprocess through lilypond-book. Default is false.
# --lilypond-book=<exe>:
# The converter for lytex files. Default is lilypond-book.
# Decomposing TEXFILE's name as DIR/BASE.tex, this script will,
# if executed successfully, leave in DIR:
@ -67,15 +70,15 @@
# Moreover dvipng can't work with PDF files, so, if the CONVERTER
# paramter is pdflatex we have to fallback to legacy route (step 2).
import getopt, glob, os, re, string, sys
import getopt, glob, os, re, shutil, string, sys
from legacy_lyxpreview2ppm import legacy_conversion, \
legacy_conversion_step2, legacy_extract_metrics_info
from lyxpreview_tools import copyfileobj, error, filter_pages, find_exe, \
find_exe_or_terminate, join_metrics_and_rename, latex_commands, \
latex_file_re, make_texcolor, mkstemp, run_command, warning, \
write_metrics_info
latex_file_re, make_texcolor, mkstemp, pdflatex_commands, run_command, \
warning, write_metrics_info
def usage(prog_name):
@ -89,6 +92,9 @@ Options:
--fg=<color>: Foreground color (default: black, ie '000000')
--bg=<color>: Background color (default: white, ie 'ffffff')
--latex=<exe>: Specify the executable for latex (default: latex)
--lilypond: Preprocess through lilypond-book (default: false)
--lilypond-book=<exe>:
The executable for lilypond-book (default: lilypond-book)
The colors are hexadecimal strings, eg 'faf0e6'."""
return msg % prog_name
@ -300,13 +306,16 @@ def main(argv):
fg_color = "000000"
bg_color = "ffffff"
latex = None
lilypond = False
lilypond_book = None
output_format = "png"
script_name = argv[0]
# Parse and manipulate the command line arguments.
try:
(opts, args) = getopt.gnu_getopt(argv[1:], "h", ["bg=",
"dpi=", "fg=", "help", "latex=", "png", "ppm"])
"dpi=", "fg=", "help", "latex=", "lilypond", "lilypond-book=",
"png", "ppm"])
except getopt.GetoptError:
error(usage(script_name))
@ -326,6 +335,10 @@ def main(argv):
fg_color = val
elif opt == "--latex":
latex = [val]
elif opt == "--lilypond":
lilypond = True
elif opt == "--lilypond-book":
lilypond_book = [val]
elif opt in ("--png", "--ppm"):
output_format = opt[2:]
@ -345,10 +358,31 @@ def main(argv):
# External programs used by the script.
latex = find_exe_or_terminate(latex or latex_commands)
if lilypond:
lilypond_book = find_exe_or_terminate(lilypond_book or ["lilypond-book"])
# These flavors of latex are known to produce pdf output
pdf_output = latex in pdflatex_commands
# Omit font size specification in latex file.
fix_latex_file(latex_file)
if lilypond:
if pdf_output:
lilypond_book += ' --pdf'
# Make a copy of the latex file
lytex_file = latex_file_re.sub(".lytex", latex_file)
shutil.copyfile(latex_file, lytex_file)
# Preprocess the latex file through lilypond-book.
lytex_call = '%s --safe --latex-program=%s "%s"' % (lilypond_book,
latex, lytex_file)
lytex_status, lytex_stdout = run_command(lytex_call)
if lytex_status != None:
warning("%s failed to compile %s" \
% (os.path.basename(lilypond_book), lytex_file))
# This can go once dvipng becomes widespread.
dvipng = find_exe(["dvipng"])
if dvipng == None:

View File

@ -388,9 +388,7 @@ namespace graphics {
PreviewLoader::Impl::Impl(PreviewLoader & p, Buffer const & b)
: parent_(p), buffer_(b)
{
if (b.params().bufferFormat() == "lilypond-book")
pconverter_ = setConverter("lyxpreview-lytex");
else if (b.params().encoding().package() == Encoding::japanese)
if (b.params().encoding().package() == Encoding::japanese)
pconverter_ = setConverter("lyxpreview-platex");
else
pconverter_ = setConverter("lyxpreview");
@ -604,6 +602,8 @@ void PreviewLoader::Impl::startLoading(bool wait)
// FIXME what about LuaTeX?
if (buffer_.params().useNonTeXFonts)
cs << " --latex=xelatex";
if (buffer_.params().bufferFormat() == "lilypond-book")
cs << " --lilypond";
string const command = libScriptSearch(cs.str());