X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2Finsetgraphics.C;h=56d990bda04622110fd3bbeac131ce8b7aee81cb;hb=e28331ed63062dea10d0a21b9ec12034b4b17b9a;hp=94225b8c05356e2a9d3d3eee27b8a5a219a55bf1;hpb=c1319d2c6738ff3e72283917ea903f4878298d41;p=lyx.git diff --git a/src/insets/insetgraphics.C b/src/insets/insetgraphics.C index 94225b8c05..56d990bda0 100644 --- a/src/insets/insetgraphics.C +++ b/src/insets/insetgraphics.C @@ -29,9 +29,6 @@ TODO /* NOTES: * Fileformat: - * Current version is 1 (inset file format version), when changing it - * it should be changed in the Write() function when writing in one place - * and when reading one should change the version check and the error message. * The filename is kept in the lyx file in a relative way, so as to allow * moving the document file and its images with no problem. * @@ -58,50 +55,57 @@ TODO #include "buffer.h" #include "BufferView.h" #include "converter.h" +#include "cursor.h" #include "debug.h" #include "dispatchresult.h" +#include "exporter.h" #include "format.h" #include "funcrequest.h" +#include "FuncStatus.h" #include "gettext.h" #include "LaTeXFeatures.h" -#include "latexrunparams.h" -#include "lyx_main.h" +#include "lyxlength.h" #include "lyxlex.h" -#include "lyxrc.h" #include "metricsinfo.h" +#include "mover.h" +#include "outputparams.h" +#include "sgml.h" #include "frontends/Alert.h" -#include "frontends/LyXView.h" +#include "support/convert.h" #include "support/filetools.h" -#include "support/lyxalgo.h" // lyx::count -#include "support/lyxlib.h" // float_equal +#include "support/lyxalgo.h" // count +#include "support/lyxlib.h" // sum +#include "support/lstrings.h" #include "support/os.h" #include "support/systemcall.h" -#include "support/tostr.h" #include #include -#include "support/std_sstream.h" - -namespace support = lyx::support; -using lyx::support::AbsolutePath; -using lyx::support::bformat; -using lyx::support::ChangeExtension; -using lyx::support::contains; -using lyx::support::FileName; -using lyx::support::float_equal; -using lyx::support::GetExtension; -using lyx::support::getExtFromContents; -using lyx::support::IsFileReadable; -using lyx::support::LibFileSearch; -using lyx::support::rtrim; -using lyx::support::Systemcall; -using lyx::support::unzipFile; -using lyx::support::unzippedFileName; - -namespace os = lyx::support::os; +#include + + +namespace lyx { + +using support::bformat; +using support::changeExtension; +using support::compare_timestamps; +using support::contains; +using support::DocFileName; +using support::FileName; +using support::float_equal; +using support::getExtension; +using support::isFileReadable; +using support::latex_path; +using support::onlyFilename; +using support::removeExtension; +using support::rtrim; +using support::subst; +using support::Systemcall; +using support::unzipFile; +using support::unzippedFileName; using std::endl; using std::string; @@ -113,67 +117,52 @@ using std::ostringstream; namespace { -/////////////////////////////////////////////////////////////////////////// -int const VersionNumber = 1; -/////////////////////////////////////////////////////////////////////////// - -// This function is a utility function -// ... that should be with ChangeExtension ... -inline -string const RemoveExtension(string const & filename) -{ - return ChangeExtension(filename, string()); -} - - -string const uniqueID() +/// Find the most suitable image format for images in \p format +/// Note that \p format may be unknown (i. e. an empty string) +string findTargetFormat(string const & format, OutputParams const & runparams) { - static unsigned int seed = 1000; - return "graph" + tostr(++seed); -} - - -string findTargetFormat(string const & suffix, LatexRunParams const & runparams) -{ - // Are we using latex or pdflatex). - if (runparams.flavor == LatexRunParams::PDFLATEX) { + // Are we using latex or pdflatex? + if (runparams.flavor == OutputParams::PDFLATEX) { lyxerr[Debug::GRAPHICS] << "findTargetFormat: PDF mode" << endl; - if (contains(suffix, "ps") || suffix == "pdf") + Format const * const f = formats.getFormat(format); + // Convert vector graphics to pdf + if (f && f->vectorFormat()) return "pdf"; - if (suffix == "jpg") // pdflatex can use jpeg - return suffix; - return "png"; // and also png + // pdflatex can use jpeg, png and pdf directly + if (format == "jpg") + return format; + // Convert everything else to png + return "png"; } // If it's postscript, we always do eps. lyxerr[Debug::GRAPHICS] << "findTargetFormat: PostScript mode" << endl; - if (suffix != "ps") // any other than ps - return "eps"; // is changed to eps - return suffix; // let ps untouched + if (format != "ps") + // any other than ps is changed to eps + return "eps"; + // let ps untouched + return format; } } // namespace anon InsetGraphics::InsetGraphics() - : graphic_label(uniqueID()), - graphic_(new RenderGraphic) -{ - graphic_->connect(boost::bind(&InsetGraphics::statusChanged, this)); -} + : graphic_label(sgml::uniqueID(from_ascii("graph"))), + graphic_(new RenderGraphic(this)) +{} InsetGraphics::InsetGraphics(InsetGraphics const & ig) : InsetOld(ig), boost::signals::trackable(), - graphic_label(uniqueID()), - graphic_(new RenderGraphic(*ig.graphic_)) + graphic_label(sgml::uniqueID(from_ascii("graph"))), + graphic_(new RenderGraphic(*ig.graphic_, this)) { - graphic_->connect(boost::bind(&InsetGraphics::statusChanged, this)); setParams(ig.params()); } -auto_ptr InsetGraphics::clone() const +auto_ptr InsetGraphics::doClone() const { return auto_ptr(new InsetGraphics(*this)); } @@ -185,56 +174,82 @@ InsetGraphics::~InsetGraphics() } -void InsetGraphics::statusChanged() const -{ - LyX::cref().updateInset(this); -} - - -DispatchResult -InsetGraphics::priv_dispatch(FuncRequest const & cmd, idx_type &, pos_type &) +void InsetGraphics::doDispatch(LCursor & cur, FuncRequest & cmd) { switch (cmd.action) { + case LFUN_GRAPHICS_EDIT: { + Buffer const & buffer = *cur.bv().buffer(); + InsetGraphicsParams p; + InsetGraphicsMailer::string2params(to_utf8(cmd.argument()), buffer, p); + editGraphics(p, buffer); + break; + } + case LFUN_INSET_MODIFY: { - Buffer const & buffer = *cmd.view()->buffer(); + Buffer const & buffer = cur.buffer(); InsetGraphicsParams p; - InsetGraphicsMailer::string2params(cmd.argument, buffer, p); - if (!p.filename.empty()) { + InsetGraphicsMailer::string2params(to_utf8(cmd.argument()), buffer, p); + if (!p.filename.empty()) setParams(p); - cmd.view()->updateInset(this); - } - return DispatchResult(true, true); + else + cur.noUpdate(); + break; } case LFUN_INSET_DIALOG_UPDATE: - InsetGraphicsMailer(*this).updateDialog(cmd.view()); - return DispatchResult(true, true); + InsetGraphicsMailer(*this).updateDialog(&cur.bv()); + break; - case LFUN_INSET_EDIT: case LFUN_MOUSE_RELEASE: - InsetGraphicsMailer(*this).showDialog(cmd.view()); - return DispatchResult(true, true); + InsetGraphicsMailer(*this).showDialog(&cur.bv()); + break; + + default: + InsetBase::doDispatch(cur, cmd); + break; + } +} + + +bool InsetGraphics::getStatus(LCursor & cur, FuncRequest const & cmd, + FuncStatus & flag) const +{ + switch (cmd.action) { + case LFUN_GRAPHICS_EDIT: + case LFUN_INSET_MODIFY: + case LFUN_INSET_DIALOG_UPDATE: + flag.enabled(true); + return true; default: - return DispatchResult(false); + return InsetBase::getStatus(cur, cmd, flag); } } -void InsetGraphics::metrics(MetricsInfo & mi, Dimension & dim) const +void InsetGraphics::edit(LCursor & cur, bool) +{ + InsetGraphicsMailer(*this).showDialog(&cur.bv()); +} + + +bool InsetGraphics::metrics(MetricsInfo & mi, Dimension & dim) const { graphic_->metrics(mi, dim); + bool const changed = dim_ != dim; dim_ = dim; + return changed; } void InsetGraphics::draw(PainterInfo & pi, int x, int y) const { + setPosCache(pi, x, y); graphic_->draw(pi, x, y); } -InsetOld::EDITABLE InsetGraphics::editable() const +InsetBase::EDITABLE InsetGraphics::editable() const { return IS_EDITABLE; } @@ -275,18 +290,7 @@ void InsetGraphics::readInsetGraphics(LyXLex & lex, string const & bufpath) continue; } else if (token == "\\end_inset") { finished = true; - } else if (token == "FormatVersion") { - lex.next(); - int version = lex.getInteger(); - if (version > VersionNumber) - lyxerr - << "This document was created with a newer Graphics widget" - ", You should use a newer version of LyX to read this" - " file." - << endl; - // TODO: Possibly open up a dialog? - } - else { + } else { if (!params_.Read(lex, token, bufpath)) lyxerr << "Unknown token, " << token << ", skipping." << std::endl; @@ -302,46 +306,141 @@ string const InsetGraphics::createLatexOptions() const // before writing it to the output stream. ostringstream options; if (!params().bb.empty()) - options << " bb=" << rtrim(params().bb) << ",\n"; + options << "bb=" << rtrim(params().bb) << ','; if (params().draft) - options << " draft,\n"; + options << "draft,"; if (params().clip) - options << " clip,\n"; - if (!float_equal(params().scale, 0.0, 0.05)) { - if (!float_equal(params().scale, 100.0, 0.05)) - options << " scale=" << params().scale / 100.0 - << ",\n"; + options << "clip,"; + double const scl = convert(params().scale); + if (!params().scale.empty() && !float_equal(scl, 0.0, 0.05)) { + if (!float_equal(scl, 100.0, 0.05)) + options << "scale=" << scl / 100.0 << ','; } else { if (!params().width.zero()) - options << " width=" << params().width.asLatexString() << ",\n"; + options << "width=" << params().width.asLatexString() << ','; if (!params().height.zero()) - options << " height=" << params().height.asLatexString() << ",\n"; + options << "height=" << params().height.asLatexString() << ','; if (params().keepAspectRatio) - options << " keepaspectratio,\n"; + options << "keepaspectratio,"; } // Make sure rotation angle is not very close to zero; // a float can be effectively zero but not exactly zero. - if (!float_equal(params().rotateAngle, 0, 0.001)) { - options << " angle=" << params().rotateAngle << ",\n"; + if (!params().rotateAngle.empty() + && !float_equal(convert(params().rotateAngle), 0.0, 0.001)) { + options << "angle=" << params().rotateAngle << ','; if (!params().rotateOrigin.empty()) { - options << " origin=" << params().rotateOrigin[0]; + options << "origin=" << params().rotateOrigin[0]; if (contains(params().rotateOrigin,"Top")) options << 't'; else if (contains(params().rotateOrigin,"Bottom")) options << 'b'; else if (contains(params().rotateOrigin,"Baseline")) options << 'B'; - options << ",\n"; + options << ','; } } if (!params().special.empty()) - options << params().special << ",\n"; + options << params().special << ','; string opts = options.str(); - // delete last ",\n" - return opts.substr(0, opts.size() - 2); + // delete last ',' + return opts.substr(0, opts.size() - 1); +} + + +docstring const InsetGraphics::toDocbookLength(LyXLength const & len) const +{ + odocstringstream result; + switch (len.unit()) { + case LyXLength::SP: // Scaled point (65536sp = 1pt) TeX's smallest unit. + result << len.value() * 65536.0 * 72 / 72.27 << "pt"; + break; + case LyXLength::PT: // Point = 1/72.27in = 0.351mm + result << len.value() * 72 / 72.27 << "pt"; + break; + case LyXLength::BP: // Big point (72bp = 1in), also PostScript point + result << len.value() << "pt"; + break; + case LyXLength::DD: // Didot point = 1/72 of a French inch, = 0.376mm + result << len.value() * 0.376 << "mm"; + break; + case LyXLength::MM: // Millimeter = 2.845pt + result << len.value() << "mm"; + break; + case LyXLength::PC: // Pica = 12pt = 4.218mm + result << len.value() << "pc"; + break; + case LyXLength::CC: // Cicero = 12dd = 4.531mm + result << len.value() * 4.531 << "mm"; + break; + case LyXLength::CM: // Centimeter = 10mm = 2.371pc + result << len.value() << "cm"; + break; + case LyXLength::IN: // Inch = 25.4mm = 72.27pt = 6.022pc + result << len.value() << "in"; + break; + case LyXLength::EX: // Height of a small "x" for the current font. + // Obviously we have to compromise here. Any better ratio than 1.5 ? + result << len.value() / 1.5 << "em"; + break; + case LyXLength::EM: // Width of capital "M" in current font. + result << len.value() << "em"; + break; + case LyXLength::MU: // Math unit (18mu = 1em) for positioning in math mode + result << len.value() * 18 << "em"; + break; + case LyXLength::PTW: // Percent of TextWidth + case LyXLength::PCW: // Percent of ColumnWidth + case LyXLength::PPW: // Percent of PageWidth + case LyXLength::PLW: // Percent of LineWidth + case LyXLength::PTH: // Percent of TextHeight + case LyXLength::PPH: // Percent of Paper + // Sigh, this will go wrong. + result << len.value() << "%"; + break; + default: + result << len.asDocstring(); + break; + } + return result.str(); +} + +docstring const InsetGraphics::createDocBookAttributes() const +{ + // Calculate the options part of the command, we must do it to a string + // stream since we copied the code from createLatexParams() ;-) + + // FIXME: av: need to translate spec -> Docbook XSL spec (http://www.sagehill.net/docbookxsl/ImageSizing.html) + // Right now it only works with my version of db2latex :-) + + odocstringstream options; + double const scl = convert(params().scale); + if (!params().scale.empty() && !float_equal(scl, 0.0, 0.05)) { + if (!float_equal(scl, 100.0, 0.05)) + options << " scale=\"" + << static_cast( (scl) + 0.5 ) + << "\" "; + } else { + if (!params().width.zero()) { + options << " width=\"" << toDocbookLength(params().width) << "\" "; + } + if (!params().height.zero()) { + options << " depth=\"" << toDocbookLength(params().height) << "\" "; + } + if (params().keepAspectRatio) { + // This will be irrelevant unless both width and height are set + options << "scalefit=\"1\" "; + } + } + + + if (!params().special.empty()) + options << from_ascii(params().special) << " "; + + // trailing blanks are ok ... + return options.str(); } @@ -355,28 +454,9 @@ enum CopyStatus { }; -std::pair const -copyToDirIfNeeded(string const & file_in, string const & dir) +std::pair const +copyFileIfNeeded(FileName const & file_in, FileName const & file_out) { - using support::rtrim; - - BOOST_ASSERT(AbsolutePath(file_in)); - - string const only_path = support::OnlyPath(file_in); - if (rtrim(support::OnlyPath(file_in) , "/") == rtrim(dir, "/")) - return std::make_pair(IDENTICAL_PATHS, file_in); - - string mangled; - if (support::zippedFile(file_in)) { - string const ext = GetExtension(file_in); - string const unzipped = support::unzippedFileName(file_in); - mangled = FileName(unzipped).mangledFilename(); - mangled += "." + ext; - } else - mangled = FileName(file_in).mangledFilename(); - - string const file_out = support::MakeAbsPath(mangled, dir); - unsigned long const checksum_in = support::sum(file_in); unsigned long const checksum_out = support::sum(file_out); @@ -384,12 +464,14 @@ copyToDirIfNeeded(string const & file_in, string const & dir) // Nothing to do... return std::make_pair(IDENTICAL_CONTENTS, file_out); - bool const success = support::copy(file_in, file_out); + Mover const & mover = getMover(formats.getFormatFromFile(file_in)); + bool const success = mover.copy(file_in, file_out); if (!success) { + // FIXME UNICODE lyxerr[Debug::GRAPHICS] - << support::bformat(_("Could not copy the file\n%1$s\n" - "into the temporary directory."), - file_in) + << to_utf8(support::bformat(_("Could not copy the file\n%1$s\n" + "into the temporary directory."), + from_utf8(file_in.absFilename()))) << std::endl; } @@ -398,74 +480,190 @@ copyToDirIfNeeded(string const & file_in, string const & dir) } +std::pair const +copyToDirIfNeeded(DocFileName const & file, string const & dir) +{ + using support::rtrim; + + string const file_in = file.absFilename(); + string const only_path = support::onlyPath(file_in); + if (rtrim(support::onlyPath(file_in) , "/") == rtrim(dir, "/")) + return std::make_pair(IDENTICAL_PATHS, file_in); + + string mangled = file.mangledFilename(); + if (file.isZipped()) { + // We need to change _eps.gz to .eps.gz. The mangled name is + // still unique because of the counter in mangledFilename(). + // We can't just call mangledFilename() with the zip + // extension removed, because base.eps and base.eps.gz may + // have different content but would get the same mangled + // name in this case. + string const base = removeExtension(file.unzippedFilename()); + string::size_type const ext_len = file_in.length() - base.length(); + mangled[mangled.length() - ext_len] = '.'; + } + FileName const file_out(support::makeAbsPath(mangled, dir)); + + return copyFileIfNeeded(file, file_out); +} + + +string const stripExtensionIfPossible(string const & file) +{ + // Remove the extension so the LaTeX will use whatever + // is appropriate (when there are several versions in + // different formats) + // This works only if the filename contains no dots besides + // the just removed one. We can fool here by replacing all + // dots with a macro whose definition is just a dot ;-) + // The automatic format selection does not work if the file + // name is escaped. + string const latex_name = latex_path(file, + support::EXCLUDE_EXTENSION); + if (contains(latex_name, '"')) + return latex_name; + return latex_path(removeExtension(file), + support::PROTECT_EXTENSION, + support::ESCAPE_DOTS); +} + + string const stripExtensionIfPossible(string const & file, string const & to) { // No conversion is needed. LaTeX can handle the graphic file as is. // This is true even if the orig_file is compressed. - if (formats.getFormat(to)->extension() == GetExtension(file)) - return RemoveExtension(file); - return file; + string const to_format = formats.getFormat(to)->extension(); + string const file_format = getExtension(file); + // for latex .ps == .eps + if (to_format == file_format || + (to_format == "eps" && file_format == "ps") || + (to_format == "ps" && file_format == "eps")) + return stripExtensionIfPossible(file); + return latex_path(file, support::EXCLUDE_EXTENSION); } } // namespace anon string const InsetGraphics::prepareFile(Buffer const & buf, - LatexRunParams const & runparams) const + OutputParams const & runparams) const { - string orig_file = params().filename.absFilename(); - string const rel_file = params().filename.relFilename(buf.filePath()); - - // LaTeX can cope if the graphics file doesn't exist, so just return the - // filename. - if (!IsFileReadable(orig_file)) { - lyxerr[Debug::GRAPHICS] - << "InsetGraphics::prepareFile\n" - << "No file '" << orig_file << "' can be found!" << endl; - return rel_file; - } + // The following code depends on non-empty filenames + if (params().filename.empty()) + return string(); - // If the file is compressed and we have specified that it - // should not be uncompressed, then just return its name and - // let LaTeX do the rest! - bool const zipped = params().filename.isZipped(); + string const orig_file = params().filename.absFilename(); + string const rel_file = params().filename.relFilename(buf.filePath()); - if (zipped && params().noUnzip) { - lyxerr[Debug::GRAPHICS] - << "\tpass zipped file to LaTeX but with full path.\n"; - // LaTeX needs an absolute path, otherwise the - // coresponding *.eps.bb file isn't found - return orig_file; - } + // previewing source code, no file copying or file format conversion + if (runparams.dryrun) + return stripExtensionIfPossible(rel_file); // temp_file will contain the file for LaTeX to act on if, for example, // we move it to a temp dir or uncompress it. - string temp_file = orig_file; + FileName temp_file = params().filename; + + // The master buffer. This is useful when there are multiple levels + // of include files + Buffer const * m_buffer = buf.getMasterBuffer(); + + // Return the output name if we are inside a comment or the file does + // not exist. + // We are not going to change the extension or using the name of the + // temporary file, the code is already complicated enough. + if (runparams.inComment || !isFileReadable(params().filename)) + return params().filename.outputFilename(m_buffer->filePath()); + + // We place all temporary files in the master buffer's temp dir. + // This is possible because we use mangled file names. + // This is necessary for DVI export. + string const temp_path = m_buffer->temppath(); + + CopyStatus status; + boost::tie(status, temp_file) = + copyToDirIfNeeded(params().filename, temp_path); - if (zipped) { - CopyStatus status; - boost::tie(status, temp_file) = - copyToDirIfNeeded(orig_file, buf.temppath()); + if (status == FAILURE) + return orig_file; - if (status == FAILURE) - return orig_file; + // a relative filename should be relative to the master + // buffer. + // "nice" means that the buffer is exported to LaTeX format but not + // run through the LaTeX compiler. + string output_file = support::os::external_path(runparams.nice ? + params().filename.outputFilename(m_buffer->filePath()) : + onlyFilename(temp_file.absFilename())); + FileName source_file = runparams.nice ? FileName(params().filename) : temp_file; + string const tex_format = (runparams.flavor == OutputParams::LATEX) ? + "latex" : "pdflatex"; + + // If the file is compressed and we have specified that it + // should not be uncompressed, then just return its name and + // let LaTeX do the rest! + if (params().filename.isZipped()) { + if (params().noUnzip) { + // We don't know whether latex can actually handle + // this file, but we can't check, because that would + // mean to unzip the file and thereby making the + // noUnzip parameter meaningless. + lyxerr[Debug::GRAPHICS] + << "\tpass zipped file to LaTeX.\n"; + + FileName const bb_orig_file = FileName(changeExtension(orig_file, "bb")); + if (runparams.nice) { + runparams.exportdata->addExternalFile(tex_format, + bb_orig_file, + changeExtension(output_file, "bb")); + } else { + // LaTeX needs the bounding box file in the + // tmp dir + FileName bb_file = FileName(changeExtension(temp_file.absFilename(), "bb")); + boost::tie(status, bb_file) = + copyFileIfNeeded(bb_orig_file, bb_file); + if (status == FAILURE) + return orig_file; + runparams.exportdata->addExternalFile(tex_format, + bb_file); + } + runparams.exportdata->addExternalFile(tex_format, + source_file, output_file); + runparams.exportdata->addExternalFile("dvi", + source_file, output_file); + // We can't strip the extension, because we don't know + // the unzipped file format + return latex_path(output_file, + support::EXCLUDE_EXTENSION); + } - orig_file = unzippedFileName(temp_file); - if (!IsFileReadable(orig_file)) { - unzipFile(temp_file); + FileName const unzipped_temp_file = + FileName(unzippedFileName(temp_file.absFilename())); + output_file = unzippedFileName(output_file); + source_file = FileName(unzippedFileName(source_file.absFilename())); + if (compare_timestamps(unzipped_temp_file, temp_file) > 0) { + // temp_file has been unzipped already and + // orig_file has not changed in the meantime. + temp_file = unzipped_temp_file; lyxerr[Debug::GRAPHICS] - << "\tunzipped to " << orig_file << endl; + << "\twas already unzipped to " << temp_file + << endl; + } else { + // unzipped_temp_file does not exist or is too old + temp_file = unzipFile(temp_file); + lyxerr[Debug::GRAPHICS] + << "\tunzipped to " << temp_file << endl; } } - string const from = getExtFromContents(orig_file); + string const from = formats.getFormatFromFile(temp_file); + if (from.empty()) { + lyxerr[Debug::GRAPHICS] + << "\tCould not get file format." << endl; + } string const to = findTargetFormat(from, runparams); + string const ext = formats.extension(to); lyxerr[Debug::GRAPHICS] << "\t we have: from " << from << " to " << to << '\n'; - if (from == to && !lyxrc.use_tempdir) - return stripExtensionIfPossible(orig_file, to); - // We're going to be running the exported buffer through the LaTeX // compiler, so must ensure that LaTeX can cope with the graphics // file format. @@ -473,68 +671,71 @@ string const InsetGraphics::prepareFile(Buffer const & buf, lyxerr[Debug::GRAPHICS] << "\tthe orig file is: " << orig_file << endl; - bool conversion_needed = true; - if (lyxrc.use_tempdir) { - CopyStatus status; - boost::tie(status, temp_file) = - copyToDirIfNeeded(orig_file, buf.temppath()); - - if (status == FAILURE) - return orig_file; - else if (status == IDENTICAL_CONTENTS) - conversion_needed = false; + if (from == to) { + if (!runparams.nice && getExtension(temp_file.absFilename()) != ext) { + // The LaTeX compiler will not be able to determine + // the file format from the extension, so we must + // change it. + FileName const new_file = FileName(changeExtension(temp_file.absFilename(), ext)); + if (support::rename(temp_file, new_file)) { + temp_file = new_file; + output_file = changeExtension(output_file, ext); + source_file = FileName(changeExtension(source_file.absFilename(), ext)); + } else + lyxerr[Debug::GRAPHICS] + << "Could not rename file `" + << temp_file << "' to `" << new_file + << "'." << endl; + } + // The extension of temp_file might be != ext! + runparams.exportdata->addExternalFile(tex_format, source_file, + output_file); + runparams.exportdata->addExternalFile("dvi", source_file, + output_file); + return stripExtensionIfPossible(output_file, to); } - if (from == to) - return stripExtensionIfPossible(temp_file, to); - - string const to_file_base = RemoveExtension(temp_file); - string const to_file = ChangeExtension(to_file_base, to); + FileName const to_file = FileName(changeExtension(temp_file.absFilename(), ext)); + string const output_to_file = changeExtension(output_file, ext); // Do we need to perform the conversion? // Yes if to_file does not exist or if temp_file is newer than to_file - if (!conversion_needed || - support::compare_timestamps(temp_file, to_file) < 0) { + if (compare_timestamps(temp_file, to_file) < 0) { + // FIXME UNICODE lyxerr[Debug::GRAPHICS] - << bformat(_("No conversion of %1$s is needed after all"), - rel_file) + << to_utf8(bformat(_("No conversion of %1$s is needed after all"), + from_utf8(rel_file))) << std::endl; - return to_file_base; + runparams.exportdata->addExternalFile(tex_format, to_file, + output_to_file); + runparams.exportdata->addExternalFile("dvi", to_file, + output_to_file); + return stripExtensionIfPossible(output_file); } lyxerr[Debug::GRAPHICS] << "\tThe original file is " << orig_file << "\n" << "\tA copy has been made and convert is to be called with:\n" << "\tfile to convert = " << temp_file << '\n' - << "\tto_file_base = " << to_file_base << '\n' << "\t from " << from << " to " << to << '\n'; - // if no special converter defined, than we take the default one - // from ImageMagic: convert from:inname.from to:outname.to - if (!converters.convert(&buf, temp_file, to_file_base, from, to)) { - string const command = - "sh " + LibFileSearch("scripts", "convertDefault.sh") + - ' ' + from + ':' + temp_file + ' ' + - to + ':' + to_file_base + '.' + to; - lyxerr[Debug::GRAPHICS] - << "No converter defined! I use convertDefault.sh:\n\t" - << command << endl; - Systemcall one; - one.startscript(Systemcall::Wait, command); - if (!IsFileReadable(ChangeExtension(to_file_base, to))) { - string str = bformat(_("No information for converting %1$s " - "format files to %2$s.\n" - "Try defining a convertor in the preferences."), from, to); - Alert::error(_("Could not convert image"), str); - } + // FIXME (Abdel 12/08/06): Is there a need to show these errors? + ErrorList el; + if (theConverters().convert(&buf, temp_file, to_file, params().filename, + from, to, el, + Converters::try_default | Converters::try_cache)) { + runparams.exportdata->addExternalFile(tex_format, + to_file, output_to_file); + runparams.exportdata->addExternalFile("dvi", + to_file, output_to_file); } - return to_file_base; + return stripExtensionIfPossible(output_file); } -int InsetGraphics::latex(Buffer const & buf, ostream & os, - LatexRunParams const & runparams) const +int InsetGraphics::latex(Buffer const & buf, odocstream & os, + OutputParams const & runparams) const { // If there is no file specified or not existing, // just output a message about it in the latex output. @@ -545,19 +746,12 @@ int InsetGraphics::latex(Buffer const & buf, ostream & os, string const relative_file = params().filename.relFilename(buf.filePath()); - // A missing (e)ps-extension is no problem for LaTeX, so - // we have to test three different cases -#warning uh, but can our cache handle it ? no. - string const file_ = params().filename.absFilename(); - bool const file_exists = - !file_.empty() && - (IsFileReadable(file_) || // original - IsFileReadable(file_ + ".eps") || // original.eps - IsFileReadable(file_ + ".ps")); // original.ps + bool const file_exists = !params().filename.empty() && + isFileReadable(params().filename); string const message = file_exists ? string() : string("bb = 0 0 200 100, draft, type=eps"); - // if !message.empty() than there was no existing file - // "filename(.(e)ps)" found. In this case LaTeX + // if !message.empty() then there was no existing file + // "filename" found. In this case LaTeX // draws only a rectangle with the above bb and the // not found filename in it. lyxerr[Debug::GRAPHICS] @@ -569,9 +763,15 @@ int InsetGraphics::latex(Buffer const & buf, ostream & os, string after; // Do we want subcaptions? if (params().subcaption) { + if (runparams.moving_arg) + before += "\\protect"; before += "\\subfigure[" + params().subcaptionText + "]{"; after = '}'; } + + if (runparams.moving_arg) + before += "\\protect"; + // We never use the starred form, we use the "clip" option instead. before += "\\includegraphics"; @@ -580,75 +780,107 @@ int InsetGraphics::latex(Buffer const & buf, ostream & os, lyxerr[Debug::GRAPHICS] << "\tOpts = " << opts << endl; if (!opts.empty() && !message.empty()) - before += ("[%\n" + opts + ',' + message + ']'); + before += ('[' + opts + ',' + message + ']'); else if (!opts.empty() || !message.empty()) - before += ("[%\n" + opts + message + ']'); + before += ('[' + opts + message + ']'); lyxerr[Debug::GRAPHICS] << "\tBefore = " << before << "\n\tafter = " << after << endl; - - // "nice" means that the buffer is exported to LaTeX format but not - // run through the LaTeX compiler. - if (runparams.nice) { - os << before <<'{' << relative_file << '}' << after; - return 1; - } - - // Make the filename relative to the lyx file - // and remove the extension so the LaTeX will use whatever is - // appropriate (when there are several versions in different formats) - string const latex_str = message.empty() ? - (before + '{' + os::external_path(prepareFile(buf, runparams)) + '}' + after) : - (before + '{' + relative_file + " not found!}" + after); - os << latex_str; + string latex_str = before + '{'; + // Convert the file if necessary. + // Remove the extension so LaTeX will use whatever is appropriate + // (when there are several versions in different formats) + latex_str += prepareFile(buf, runparams); + latex_str += '}' + after; + // FIXME UNICODE + os << from_utf8(latex_str); lyxerr[Debug::GRAPHICS] << "InsetGraphics::latex outputting:\n" << latex_str << endl; // Return how many newlines we issued. - return int(lyx::count(latex_str.begin(), latex_str.end(),'\n') + 1); + return int(lyx::count(latex_str.begin(), latex_str.end(),'\n')); } -int InsetGraphics::ascii(Buffer const &, ostream & os, - LatexRunParams const &) const +int InsetGraphics::plaintext(Buffer const &, odocstream & os, + OutputParams const &) const { // No graphics in ascii output. Possible to use gifscii to convert // images to ascii approximation. // 1. Convert file to ascii using gifscii // 2. Read ascii output file and add it to the output stream. // at least we send the filename + // FIXME UNICODE + // FIXME: We have no idea what the encoding of the filename is os << '<' << bformat(_("Graphics file: %1$s"), - params().filename.absFilename()) << ">\n"; + from_utf8(params().filename.absFilename())) + << ">\n"; return 0; } -int InsetGraphics::linuxdoc(Buffer const & buf, ostream & os, - LatexRunParams const &) const -{ - string const file_name = buf.niceFile() ? - params().filename.relFilename(buf.filePath()): - params().filename.absFilename(); +namespace { - os << "\n"; - os << ""; - return 0; +int writeImageObject(char * format, odocstream & os, OutputParams const & runparams, + docstring const graphic_label, docstring const attributes) +{ + if (runparams.flavor != OutputParams::XML) { + os << "" ; + } + else { + os << " format=\"" << format << "\">" ; + } + os << ""; + if (runparams.flavor != OutputParams::XML) { + os << std::endl << "]]>" ; + } + return runparams.flavor == OutputParams::XML ? 0 : 2; +} +// end anonymous namespace } // For explanation on inserting graphics into DocBook checkout: -// http://en.tldp.org/LDP/LDP-Author-Guide/inserting-pictures.html +// http://en.tldp.org/LDP/LDP-Author-Guide/html/inserting-pictures.html // See also the docbook guide at http://www.docbook.org/ -int InsetGraphics::docbook(Buffer const &, ostream & os, - LatexRunParams const &) const +int InsetGraphics::docbook(Buffer const &, odocstream & os, + OutputParams const & runparams) const { // In DocBook v5.0, the graphic tag will be eliminated from DocBook, will // need to switch to MediaObject. However, for now this is sufficient and // easier to use. - os << ""; - return 0; + if (runparams.flavor == OutputParams::XML) { + runparams.exportdata->addExternalFile("docbook-xml", + params().filename); + } else { + runparams.exportdata->addExternalFile("docbook", + params().filename); + } + os << ""; + + int r = 0; + docstring attributes = createDocBookAttributes(); + r += writeImageObject("png", os, runparams, graphic_label, attributes); + r += writeImageObject("pdf", os, runparams, graphic_label, attributes); + r += writeImageObject("eps", os, runparams, graphic_label, attributes); + r += writeImageObject("bmp", os, runparams, graphic_label, attributes); + + os << ""; + return r; } @@ -659,10 +891,17 @@ void InsetGraphics::validate(LaTeXFeatures & features) const return; features.includeFile(graphic_label, - RemoveExtension(params().filename.absFilename())); + removeExtension(params().filename.absFilename())); features.require("graphicx"); + if (features.runparams().nice) { + Buffer const * m_buffer = features.buffer().getMasterBuffer(); + string const rel_file = removeExtension(params().filename.relFilename(m_buffer->filePath())); + if (contains(rel_file, ".")) + features.require("lyxdot"); + } + if (params().subcaption) features.require("subfigure"); } @@ -691,6 +930,14 @@ InsetGraphicsParams const & InsetGraphics::params() const } +void InsetGraphics::editGraphics(InsetGraphicsParams const & p, + Buffer const & buffer) const +{ + formats.edit(buffer, p.filename, + formats.getFormatFromFile(p.filename)); +} + + string const InsetGraphicsMailer::name_("graphics"); InsetGraphicsMailer::InsetGraphicsMailer(InsetGraphics & inset) @@ -709,7 +956,6 @@ void InsetGraphicsMailer::string2params(string const & in, InsetGraphicsParams & params) { params = InsetGraphicsParams(); - if (in.empty()) return; @@ -717,18 +963,14 @@ void InsetGraphicsMailer::string2params(string const & in, LyXLex lex(0,0); lex.setStream(data); - if (lex.isOK()) { - lex.next(); - string const token = lex.getString(); - if (token != name_) - return; - } + string name; + lex >> name; + if (!lex || name != name_) + return print_mailer_error("InsetGraphicsMailer", in, 1, name_); - if (lex.isOK()) { - InsetGraphics inset; - inset.readInsetGraphics(lex, buffer.filePath()); - params = inset.params(); - } + InsetGraphics inset; + inset.readInsetGraphics(lex, buffer.filePath()); + params = inset.params(); } @@ -742,3 +984,6 @@ InsetGraphicsMailer::params2string(InsetGraphicsParams const & params, data << "\\end_inset\n"; return data.str(); } + + +} // namespace lyx