X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetGraphics.cpp;h=15c87e4e5e98aab81b2f901f28dfa2ef9b3c99ac;hb=87a7f728ca9b8b4d358cf06de980f61b67a927ac;hp=39e5fb5875494a7a6409e0c5eb49eedde6a1dba0;hpb=9383f4c3c6f9cfab2d658701ba66e2b54cd68bea;p=lyx.git diff --git a/src/insets/InsetGraphics.cpp b/src/insets/InsetGraphics.cpp index 39e5fb5875..15c87e4e5e 100644 --- a/src/insets/InsetGraphics.cpp +++ b/src/insets/InsetGraphics.cpp @@ -4,7 +4,7 @@ * Licence details can be found in the file COPYING. * * \author Baruch Even - * \author Herbert Voß + * \author Herbert Voß * * Full author contact details are available in file CREDITS. */ @@ -15,7 +15,6 @@ TODO * What advanced features the users want to do? Implement them in a non latex dependent way, but a logical way. LyX should translate it to latex or any other fitting format. - * Add a way to roll the image file into the file format. * When loading, if the image is not found in the expected place, try to find it in the clipart, or in the same directory with the image. * The image choosing dialog could show thumbnails of the image formats @@ -23,8 +22,6 @@ TODO filename. * Add support for the 'picins' package. * Add support for the 'picinpar' package. - * Improve support for 'subfigure' - Allow to set the various options - that are possible. */ /* NOTES: @@ -56,62 +53,55 @@ TODO #include "BufferView.h" #include "Converter.h" #include "Cursor.h" -#include "support/debug.h" #include "DispatchResult.h" #include "ErrorList.h" #include "Exporter.h" #include "Format.h" #include "FuncRequest.h" #include "FuncStatus.h" -#include "support/gettext.h" +#include "InsetIterator.h" #include "LaTeXFeatures.h" #include "Length.h" #include "Lexer.h" #include "MetricsInfo.h" #include "Mover.h" #include "OutputParams.h" +#include "output_xhtml.h" #include "sgml.h" -#include "EmbeddedFiles.h" +#include "texstream.h" +#include "TocBackend.h" #include "frontends/alert.h" +#include "frontends/Application.h" + +#include "graphics/GraphicsCache.h" +#include "graphics/GraphicsCacheItem.h" +#include "graphics/GraphicsImage.h" #include "support/convert.h" +#include "support/debug.h" #include "support/docstream.h" +#include "support/ExceptionMessage.h" #include "support/filetools.h" +#include "support/gettext.h" #include "support/lyxlib.h" #include "support/lstrings.h" #include "support/os.h" +#include "support/qstring_helpers.h" #include "support/Systemcall.h" -#include -#include +#include #include #include +#include using namespace std; +using namespace lyx::support; 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::isValidLaTeXFilename; -using support::latex_path; -using support::onlyFilename; -using support::removeExtension; -using support::rtrim; -using support::subst; -using support::suffixIs; -using support::Systemcall; -using support::unzipFile; -using support::unzippedFileName; - +namespace Alert = frontend::Alert; namespace { @@ -119,19 +109,33 @@ namespace { /// Note that \p format may be unknown (i. e. an empty string) string findTargetFormat(string const & format, OutputParams const & runparams) { - // Are we using latex or pdflatex? - if (runparams.flavor == OutputParams::PDFLATEX) { + // Are we using latex or XeTeX/LuaTeX/pdflatex? + if (runparams.flavor == OutputParams::PDFLATEX + || runparams.flavor == OutputParams::XETEX + || runparams.flavor == OutputParams::LUATEX) { LYXERR(Debug::GRAPHICS, "findTargetFormat: PDF mode"); - Format const * const f = formats.getFormat(format); + Format const * const f = theFormats().getFormat(format); // Convert vector graphics to pdf if (f && f->vectorFormat()) - return "pdf"; + return "pdf6"; // pdflatex can use jpeg, png and pdf directly if (format == "jpg") return format; // Convert everything else to png return "png"; } + // for HTML, we leave the known formats and otherwise convert to png + if (runparams.flavor == OutputParams::HTML) { + Format const * const f = theFormats().getFormat(format); + // Convert vector graphics to svg + if (f && f->vectorFormat() && theConverters().isReachable(format, "svg")) + return "svg"; + // Leave the known formats alone + if (format == "jpg" || format == "png" || format == "gif") + return format; + // Convert everything else to png + return "png"; + } // If it's postscript, we always do eps. LYXERR(Debug::GRAPHICS, "findTargetFormat: PostScript mode"); if (format != "ps") @@ -141,19 +145,46 @@ string findTargetFormat(string const & format, OutputParams const & runparams) return format; } -} // namespace anon + +void readInsetGraphics(Lexer & lex, Buffer const & buf, bool allowOrigin, + InsetGraphicsParams & params) +{ + bool finished = false; + + while (lex.isOK() && !finished) { + lex.next(); + + string const token = lex.getString(); + LYXERR(Debug::GRAPHICS, "Token: '" << token << '\''); + + if (token.empty()) + continue; + + if (token == "\\end_inset") { + finished = true; + } else { + if (!params.Read(lex, token, buf, allowOrigin)) + lyxerr << "Unknown token, " + << token + << ", skipping." + << endl; + } + } +} + +} // namespace -InsetGraphics::InsetGraphics() - : graphic_label(sgml::uniqueID(from_ascii("graph"))), +InsetGraphics::InsetGraphics(Buffer * buf) + : Inset(buf), graphic_label(sgml::uniqueID(from_ascii("graph"))), graphic_(new RenderGraphic(this)) -{} +{ +} InsetGraphics::InsetGraphics(InsetGraphics const & ig) : Inset(ig), - boost::signals::trackable(), - graphic_label(sgml::uniqueID(from_ascii("graph"))), + graphic_label(sgml::uniqueID(from_ascii("graph"))), graphic_(new RenderGraphic(*ig.graphic_, this)) { setParams(ig.params()); @@ -168,39 +199,52 @@ Inset * InsetGraphics::clone() const InsetGraphics::~InsetGraphics() { - InsetGraphicsMailer(*this).hideDialog(); + hideDialogs("graphics", this); + delete graphic_; } void InsetGraphics::doDispatch(Cursor & 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); + switch (cmd.action()) { + case LFUN_INSET_EDIT: { + InsetGraphicsParams p = params(); + if (!cmd.argument().empty()) + string2params(to_utf8(cmd.argument()), buffer(), p); + editGraphics(p); break; } case LFUN_INSET_MODIFY: { - Buffer const & buffer = cur.buffer(); + if (cmd.getArg(0) != "graphics") { + Inset::doDispatch(cur, cmd); + break; + } + InsetGraphicsParams p; - InsetGraphicsMailer::string2params(to_utf8(cmd.argument()), buffer, p); - if (!p.filename.empty()) - setParams(p); - else - cur.noUpdate(); + string2params(to_utf8(cmd.argument()), buffer(), p); + if (p.filename.empty()) { + cur.noScreenUpdate(); + break; + } + + cur.recordUndo(); + setParams(p); + // if the inset is part of a graphics group, all the + // other members should be updated too. + if (!params_.groupId.empty()) + graphics::unifyGraphicsGroups(buffer(), + to_utf8(cmd.argument())); break; } case LFUN_INSET_DIALOG_UPDATE: - InsetGraphicsMailer(*this).updateDialog(&cur.bv()); + cur.bv().updateDialog("graphics", params2string(params(), buffer())); break; - case LFUN_MOUSE_RELEASE: - if (!cur.selection()) - InsetGraphicsMailer(*this).showDialog(&cur.bv()); + case LFUN_GRAPHICS_RELOAD: + params_.filename.refresh(); + graphic_->reload(); break; default: @@ -213,11 +257,15 @@ void InsetGraphics::doDispatch(Cursor & cur, FuncRequest & cmd) bool InsetGraphics::getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus & flag) const { - switch (cmd.action) { - case LFUN_GRAPHICS_EDIT: + switch (cmd.action()) { case LFUN_INSET_MODIFY: + if (cmd.getArg(0) != "graphics") + return Inset::getStatus(cur, cmd, flag); + // fall through + case LFUN_INSET_EDIT: case LFUN_INSET_DIALOG_UPDATE: - flag.enabled(true); + case LFUN_GRAPHICS_RELOAD: + flag.setEnabled(true); return true; default: @@ -226,30 +274,14 @@ bool InsetGraphics::getStatus(Cursor & cur, FuncRequest const & cmd, } -void InsetGraphics::registerEmbeddedFiles(Buffer const &, - EmbeddedFiles & files) const -{ - files.registerFile(params().filename.absFilename(), - false, this); -} - - -void InsetGraphics::updateEmbeddedFile(Buffer const & buf, - EmbeddedFile const & file) +bool InsetGraphics::showInsetDialog(BufferView * bv) const { - BOOST_ASSERT(buf.embeddedFiles().enabled()); - params_.filename = file; - LYXERR(Debug::FILES, "Update InsetGraphic with File " - << params_.filename.toFilesystemEncoding() - << ", embedding status: " << params_.filename.embedded()); + bv->showDialog("graphics", params2string(params(), bv->buffer()), + const_cast(this)); + return true; } -void InsetGraphics::edit(Cursor & cur, bool) -{ - InsetGraphicsMailer(*this).showDialog(&cur.bv()); -} - void InsetGraphics::metrics(MetricsInfo & mi, Dimension & dim) const { @@ -263,74 +295,97 @@ void InsetGraphics::draw(PainterInfo & pi, int x, int y) const } -Inset::EDITABLE InsetGraphics::editable() const -{ - return IS_EDITABLE; -} - - -void InsetGraphics::write(Buffer const & buf, ostream & os) const +void InsetGraphics::write(ostream & os) const { os << "Graphics\n"; - params().Write(os, buf); + params().Write(os, buffer()); } -void InsetGraphics::read(Buffer const & buf, Lexer & lex) +void InsetGraphics::read(Lexer & lex) { - string const token = lex.getString(); - - if (token == "Graphics") - readInsetGraphics(lex, buf.filePath()); - else - LYXERR(Debug::GRAPHICS, "Not a Graphics inset!"); - - // InsetGraphics is read, with filename in params_. We do not know if this file actually - // exists or is embedded so we need to get the 'availableFile' from buf.embeddedFiles() - if (buf.embeddedFiles().enabled()) { - EmbeddedFiles::EmbeddedFileList::const_iterator it = - buf.embeddedFiles().find(params_.filename.toFilesystemEncoding()); - if (it != buf.embeddedFiles().end()) - // using available file, embedded or external, depending on file availability and - // embedding status. - params_.filename = *it; - } + lex.setContext("InsetGraphics::read"); + //lex >> "Graphics"; + readInsetGraphics(lex, buffer(), true, params_); graphic_->update(params().as_grfxParams()); } -void InsetGraphics::readInsetGraphics(Lexer & lex, string const & bufpath) +void InsetGraphics::outBoundingBox(graphics::BoundingBox & bbox) const { - bool finished = false; - - while (lex.isOK() && !finished) { - lex.next(); + if (bbox.empty()) + return; - string const token = lex.getString(); - LYXERR(Debug::GRAPHICS, "Token: '" << token << '\''); + FileName const file(params().filename.absFileName()); - if (token.empty()) - continue; + // No correction is necessary for a postscript image + bool const zipped = theFormats().isZippedFile(file); + FileName const unzipped_file = zipped ? unzipFile(file) : file; + string const format = theFormats().getFormatFromFile(unzipped_file); + if (zipped) + unzipped_file.removeFile(); + if (Formats::isPostScriptFileFormat(format)) + return; - if (token == "\\end_inset") { - finished = true; - } else { - if (!params_.Read(lex, token, bufpath)) - lyxerr << "Unknown token, " << token << ", skipping." - << std::endl; + // Get the actual image dimensions in pixels + int width = 0; + int height = 0; + graphics::Cache & gc = graphics::Cache::get(); + if (gc.inCache(file)) { + graphics::Image const * image = gc.item(file)->image(); + if (image) { + width = image->width(); + height = image->height(); } } + if (width == 0 || height == 0) + return; + + // Use extractbb to find the dimensions in the typeset output + QProcess extractbb; + extractbb.start("extractbb", QStringList() << "-O" << toqstr(file.absFileName())); + if (!extractbb.waitForStarted() || !extractbb.waitForFinished()) { + LYXERR0("Cannot read output bounding box of " << file); + return; + } + + string const result = extractbb.readAll().constData(); + size_t i = result.find("%%BoundingBox:"); + if (i == string::npos) { + LYXERR0("Cannot find output bounding box of " << file); + return; + } + + string const bb = result.substr(i); + int out_width = convert(token(bb, ' ', 3)); + int out_height = convert(token(bb, ' ', 4)); + + // Compute the scaling ratio and correct the bounding box + double scalex = out_width / double(width); + double scaley = out_height / double(height); + + bbox.xl.value(scalex * bbox.xl.value()); + bbox.xr.value(scalex * bbox.xr.value()); + bbox.yb.value(scaley * bbox.yb.value()); + bbox.yt.value(scaley * bbox.yt.value()); } -string const InsetGraphics::createLatexOptions() const +string InsetGraphics::createLatexOptions(bool const ps) const { // Calculate the options part of the command, we must do it to a string // stream since we might have a trailing comma that we would like to remove // before writing it to the output stream. ostringstream options; - if (!params().bb.empty()) - options << "bb=" << rtrim(params().bb) << ','; + if (!params().bbox.empty()) { + graphics::BoundingBox out_bbox = params().bbox; + outBoundingBox(out_bbox); + string const key = ps ? "bb=" : "viewport="; + options << key << out_bbox.xl.asLatexString() << ' ' + << out_bbox.yb.asLatexString() << ' ' + << out_bbox.xr.asLatexString() << ' ' + << out_bbox.yt.asLatexString() << ','; + } if (params().draft) options << "draft,"; if (params().clip) @@ -382,7 +437,7 @@ string const InsetGraphics::createLatexOptions() const } -docstring const InsetGraphics::toDocbookLength(Length const & len) const +docstring InsetGraphics::toDocbookLength(Length const & len) const { odocstringstream result; switch (len.unit()) { @@ -428,7 +483,8 @@ docstring const InsetGraphics::toDocbookLength(Length const & len) const case Length::PPW: // Percent of PageWidth case Length::PLW: // Percent of LineWidth case Length::PTH: // Percent of TextHeight - case Length::PPH: // Percent of Paper + case Length::PPH: // Percent of PaperHeight + case Length::BLS: // Percent of BaselineSkip // Sigh, this will go wrong. result << len.value() << "%"; break; @@ -439,7 +495,8 @@ docstring const InsetGraphics::toDocbookLength(Length const & len) const return result.str(); } -docstring const InsetGraphics::createDocBookAttributes() const + +docstring 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() ;-) @@ -453,7 +510,7 @@ docstring const InsetGraphics::createDocBookAttributes() const 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 ) + << support::iround(scl) << "\" "; } else { if (!params().width.zero()) { @@ -487,7 +544,7 @@ enum GraphicsCopyStatus { }; -std::pair const +pair const copyFileIfNeeded(FileName const & file_in, FileName const & file_out) { LYXERR(Debug::FILES, "Comparing " << file_in << " and " << file_out); @@ -496,46 +553,44 @@ copyFileIfNeeded(FileName const & file_in, FileName const & file_out) if (checksum_in == checksum_out) // Nothing to do... - return std::make_pair(IDENTICAL_CONTENTS, file_out); + return make_pair(IDENTICAL_CONTENTS, file_out); - Mover const & mover = getMover(formats.getFormatFromFile(file_in)); + Mover const & mover = getMover(theFormats().getFormatFromFile(file_in)); bool const success = mover.copy(file_in, file_out); if (!success) { // FIXME UNICODE LYXERR(Debug::GRAPHICS, - to_utf8(support::bformat(_("Could not copy the file\n%1$s\n" + to_utf8(bformat(_("Could not copy the file\n%1$s\n" "into the temporary directory."), - from_utf8(file_in.absFilename())))); + from_utf8(file_in.absFileName())))); } GraphicsCopyStatus status = success ? SUCCESS : FAILURE; - return std::make_pair(status, file_out); + return make_pair(status, file_out); } -std::pair const +pair const copyToDirIfNeeded(DocFileName const & file, string const & dir) { - using support::rtrim; + string const file_in = file.absFileName(); + string const only_path = onlyPath(file_in); + if (rtrim(only_path, "/") == rtrim(dir, "/")) + return make_pair(IDENTICAL_PATHS, FileName(file_in)); - 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()) { + string mangled = file.mangledFileName(); + if (theFormats().isZippedFile(file)) { // 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 + // 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 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)); + FileName const file_out(makeAbsPath(mangled, dir)); return copyFileIfNeeded(file, file_out); } @@ -554,13 +609,10 @@ string const stripExtensionIfPossible(string const & file, bool nice) // 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); + string const latex_name = latex_path(file, EXCLUDE_EXTENSION); if (!nice || contains(latex_name, '"')) return latex_name; - return latex_path(removeExtension(file), - support::PROTECT_EXTENSION, - support::ESCAPE_DOTS); + return latex_path(removeExtension(file), PROTECT_EXTENSION, ESCAPE_DOTS); } @@ -568,56 +620,54 @@ string const stripExtensionIfPossible(string const & file, string const & to, bo { // No conversion is needed. LaTeX can handle the graphic file as is. // This is true even if the orig_file is compressed. - string const to_format = formats.getFormat(to)->extension(); + string const to_format = theFormats().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, nice); - return latex_path(file, support::EXCLUDE_EXTENSION); + return latex_path(file, EXCLUDE_EXTENSION); } -} // namespace anon +} // namespace -string const InsetGraphics::prepareFile(Buffer const & buf, - OutputParams const & runparams) const +string InsetGraphics::prepareFile(OutputParams const & runparams) const { // The following code depends on non-empty filenames if (params().filename.empty()) return string(); - string const orig_file = params().filename.absFilename(); - string const rel_file = params().filename.relFilename(buf.filePath()); + string const orig_file = params().filename.absFileName(); + // this is for dryrun and display purposes, do not use latexFilename + string const rel_file = params().filename.relFileName(buffer().filePath()); // previewing source code, no file copying or file format conversion if (runparams.dryrun) return stripExtensionIfPossible(rel_file, runparams.nice); - // temp_file will contain the file for LaTeX to act on if, for example, - // we move it to a temp dir or uncompress it. - FileName temp_file = params().filename; - // The master buffer. This is useful when there are multiple levels // of include files - Buffer const * masterBuffer = buf.masterBuffer(); + Buffer const * masterBuffer = buffer().masterBuffer(); // 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 || !params().filename.isReadableFile()) - return params().filename.outputFilename(masterBuffer->filePath()); + return params().filename.outputFileName(masterBuffer->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 = masterBuffer->temppath(); + // temp_file will contain the file for LaTeX to act on if, for example, + // we move it to a temp dir or uncompress it. + FileName temp_file; GraphicsCopyStatus status; - boost::tie(status, temp_file) = - copyToDirIfNeeded(params().filename, temp_path); + tie(status, temp_file) = copyToDirIfNeeded(params().filename, temp_path); if (status == FAILURE) return orig_file; @@ -626,61 +676,36 @@ string const InsetGraphics::prepareFile(Buffer const & buf, // "nice" means that the buffer is exported to LaTeX format but not // run through the LaTeX compiler. string output_file = runparams.nice ? - params().filename.outputFilename(masterBuffer->filePath()) : - onlyFilename(temp_file.absFilename()); - - if (runparams.nice && !isValidLaTeXFilename(output_file)) { - frontend::Alert::warning(_("Invalid filename"), - _("The following filename is likely to cause trouble " - "when running the exported file through LaTeX: ") + - from_utf8(output_file)); + params().filename.outputFileName(masterBuffer->filePath()) : + onlyFileName(temp_file.absFileName()); + + if (runparams.nice) { + if (!isValidLaTeXFileName(output_file)) { + frontend::Alert::warning(_("Invalid filename"), + _("The following filename will cause troubles " + "when running the exported file through LaTeX: ") + + from_utf8(output_file)); + } + // only show DVI-specific warning when export format is plain latex + if (!isValidDVIFileName(output_file) + && runparams.flavor == OutputParams::LATEX) { + frontend::Alert::warning(_("Problematic filename for DVI"), + _("The following filename can cause troubles " + "when running the exported file through LaTeX " + "and opening the resulting DVI: ") + + from_utf8(output_file), true); + } } 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."); - - 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); - } + // determine the export format + string const tex_format = flavor2format(runparams.flavor); + if (theFormats().isZippedFile(params().filename)) { FileName const unzipped_temp_file = - FileName(unzippedFileName(temp_file.absFilename())); + FileName(unzippedFileName(temp_file.absFileName())); output_file = unzippedFileName(output_file); - source_file = FileName(unzippedFileName(source_file.absFilename())); + 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. @@ -693,12 +718,12 @@ string const InsetGraphics::prepareFile(Buffer const & buf, } } - string const from = formats.getFormatFromFile(temp_file); + string const from = theFormats().getFormatFromFile(temp_file); if (from.empty()) LYXERR(Debug::GRAPHICS, "\tCould not get file format."); string const to = findTargetFormat(from, runparams); - string const ext = formats.extension(to); + string const ext = theFormats().extension(to); LYXERR(Debug::GRAPHICS, "\t we have: from " << from << " to " << to); // We're going to be running the exported buffer through the LaTeX @@ -708,15 +733,18 @@ string const InsetGraphics::prepareFile(Buffer const & buf, LYXERR(Debug::GRAPHICS, "\tthe orig file is: " << orig_file); if (from == to) { - if (!runparams.nice && getExtension(temp_file.absFilename()) != ext) { + // source and destination formats are the same + if (!runparams.nice && !FileName(temp_file).hasExtension(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)) { + FileName const new_file = + FileName(changeExtension(temp_file.absFileName(), ext)); + if (temp_file.moveTo(new_file)) { temp_file = new_file; output_file = changeExtension(output_file, ext); - source_file = FileName(changeExtension(source_file.absFilename(), ext)); + source_file = + FileName(changeExtension(source_file.absFileName(), ext)); } else { LYXERR(Debug::GRAPHICS, "Could not rename file `" << temp_file << "' to `" << new_file << "'."); @@ -730,7 +758,8 @@ string const InsetGraphics::prepareFile(Buffer const & buf, return stripExtensionIfPossible(output_file, to, runparams.nice); } - FileName const to_file = FileName(changeExtension(temp_file.absFilename(), ext)); + // so the source and destination formats are different + 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? @@ -754,9 +783,15 @@ string const InsetGraphics::prepareFile(Buffer const & buf, // 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, + Converters::RetVal const rv = + theConverters().convert(&buffer(), temp_file, to_file, params().filename, from, to, el, - Converters::try_default | Converters::try_cache)) { + Converters::try_default | Converters::try_cache); + if (rv == Converters::KILLED) { + LYXERR0("Graphics preparation killed."); + if (buffer().isClone() && buffer().isExporting()) + throw ConversionException(); + } else if (rv == Converters::SUCCESS) { runparams.exportdata->addExternalFile(tex_format, to_file, output_to_file); runparams.exportdata->addExternalFile("dvi", @@ -767,23 +802,30 @@ string const InsetGraphics::prepareFile(Buffer const & buf, } -int InsetGraphics::latex(Buffer const & buf, odocstream & os, - OutputParams const & runparams) const +void InsetGraphics::latex(otexstream & os, + OutputParams const & runparams) const { // If there is no file specified or not existing, // just output a message about it in the latex output. LYXERR(Debug::GRAPHICS, "insetgraphics::latex: Filename = " - << params().filename.absFilename()); - - string const relative_file = - params().filename.relFilename(buf.filePath()); + << params().filename.absFileName()); bool const file_exists = !params().filename.empty() && params().filename.isReadableFile(); - string const message = file_exists ? - string() : string("bb = 0 0 200 100, draft, type=eps"); - // if !message.empty() then there was no existing file - // "filename" found. In this case LaTeX + string message; + if (!file_exists) { + if (params().bbox.empty()) + message = "bb = 0 0 200 100"; + if (!params().draft) { + if (!message.empty()) + message += ", "; + message += "draft"; + } + if (!message.empty()) + message += ", "; + message += "type=eps"; + } + // If no existing file "filename" was found LaTeX // draws only a rectangle with the above bb and the // not found filename in it. LYXERR(Debug::GRAPHICS, "\tMessage = \"" << message << '\"'); @@ -792,13 +834,6 @@ int InsetGraphics::latex(Buffer const & buf, odocstream & os, // after the actual includegraphics command. string before; 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"; @@ -807,7 +842,9 @@ int InsetGraphics::latex(Buffer const & buf, odocstream & os, before += "\\includegraphics"; // Write the options if there are any. - string const opts = createLatexOptions(); + bool const ps = runparams.flavor == OutputParams::LATEX + || runparams.flavor == OutputParams::DVILUATEX; + string const opts = createLatexOptions(ps); LYXERR(Debug::GRAPHICS, "\tOpts = " << opts); if (!opts.empty() && !message.empty()) @@ -821,19 +858,18 @@ int InsetGraphics::latex(Buffer const & buf, odocstream & os, // 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); + string file_path = prepareFile(runparams); + latex_str += file_path; latex_str += '}' + after; // FIXME UNICODE os << from_utf8(latex_str); LYXERR(Debug::GRAPHICS, "InsetGraphics::latex outputting:\n" << latex_str); - // Return how many newlines we issued. - return int(std::count(latex_str.begin(), latex_str.end(),'\n')); } -int InsetGraphics::plaintext(Buffer const & buf, odocstream & os, - OutputParams const &) const +int InsetGraphics::plaintext(odocstringstream & os, + OutputParams const &, size_t) const { // No graphics in ascii output. Possible to use gifscii to convert // images to ascii approximation. @@ -843,8 +879,8 @@ int InsetGraphics::plaintext(Buffer const & buf, odocstream & os, // FIXME UNICODE // FIXME: We have no idea what the encoding of the filename is - docstring const str = bformat(buf.B_("Graphics file: %1$s"), - from_utf8(params().filename.absFilename())); + docstring const str = bformat(buffer().B_("Graphics file: %1$s"), + from_utf8(params().filename.absFileName())); os << '<' << str << '>'; return 2 + str.size(); @@ -857,7 +893,7 @@ static int writeImageObject(char const * format, odocstream & os, { if (runparams.flavor != OutputParams::XML) os << ""; if (runparams.flavor != OutputParams::XML) - os << std::endl << "]]>" ; + os << endl << "]]>" ; return runparams.flavor == OutputParams::XML ? 0 : 2; } @@ -883,7 +919,7 @@ static int writeImageObject(char const * format, odocstream & os, // For explanation on inserting graphics into DocBook checkout: // 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 &, odocstream & os, +int InsetGraphics::docbook(odocstream & os, OutputParams const & runparams) const { // In DocBook v5.0, the graphic tag will be eliminated from DocBook, will @@ -910,6 +946,131 @@ int InsetGraphics::docbook(Buffer const &, odocstream & os, } +string InsetGraphics::prepareHTMLFile(OutputParams const & runparams) const +{ + // The following code depends on non-empty filenames + if (params().filename.empty()) + return string(); + + if (!params().filename.isReadableFile()) + return string(); + + // The master buffer. This is useful when there are multiple levels + // of include files + Buffer const * masterBuffer = buffer().masterBuffer(); + + // We place all temporary files in the master buffer's temp dir. + // This is possible because we use mangled file names. + // FIXME We may want to put these files in some special temporary + // directory. + string const temp_path = masterBuffer->temppath(); + + // Copy to temporary directory. + FileName temp_file; + GraphicsCopyStatus status; + tie(status, temp_file) = copyToDirIfNeeded(params().filename, temp_path); + + if (status == FAILURE) + return string(); + + string const from = theFormats().getFormatFromFile(temp_file); + if (from.empty()) { + LYXERR(Debug::GRAPHICS, "\tCould not get file format."); + return string(); + } + + string const to = findTargetFormat(from, runparams); + string const ext = theFormats().extension(to); + string const orig_file = params().filename.absFileName(); + string output_file = onlyFileName(temp_file.absFileName()); + LYXERR(Debug::GRAPHICS, "\t we have: from " << from << " to " << to); + LYXERR(Debug::GRAPHICS, "\tthe orig file is: " << orig_file); + + if (from == to) { + // source and destination formats are the same + runparams.exportdata->addExternalFile("xhtml", temp_file, output_file); + return output_file; + } + + // so the source and destination formats are different + 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 (compare_timestamps(temp_file, to_file) < 0) { + // FIXME UNICODE + LYXERR(Debug::GRAPHICS, + to_utf8(bformat(_("No conversion of %1$s is needed after all"), + from_utf8(orig_file)))); + runparams.exportdata->addExternalFile("xhtml", to_file, output_to_file); + return output_to_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' + << "\t from " << from << " to " << to); + + // FIXME (Abdel 12/08/06): Is there a need to show these errors? + ErrorList el; + Converters::RetVal const rv = + theConverters().convert(&buffer(), temp_file, to_file, params().filename, + from, to, el, Converters::try_default | Converters::try_cache); + if (rv == Converters::KILLED) { + if (buffer().isClone() && buffer().isExporting()) + throw ConversionException(); + return string(); + } + if (rv != Converters::SUCCESS) + return string(); + runparams.exportdata->addExternalFile("xhtml", to_file, output_to_file); + return output_to_file; +} + + +docstring InsetGraphics::xhtml(XHTMLStream & xs, OutputParams const & op) const +{ + string const output_file = op.dryrun ? string() : prepareHTMLFile(op); + + if (output_file.empty() && !op.dryrun) { + LYXERR0("InsetGraphics::xhtml: Unable to prepare file `" + << params().filename << "' for output. File missing?"); + string const attr = "src='" + params().filename.absFileName() + + "' alt='image: " + output_file + "'"; + xs << html::CompTag("img", attr); + return docstring(); + } + + // FIXME XHTML + // We aren't doing anything with the crop and rotate parameters, and it would + // really be better to do width and height conversion, rather than to output + // these parameters here. + string imgstyle; + bool const havewidth = !params().width.zero(); + bool const haveheight = !params().height.zero(); + if (havewidth || haveheight) { + if (havewidth) + imgstyle += "width:" + params().width.asHTMLString() + ";"; + if (haveheight) + imgstyle += " height:" + params().height.asHTMLString() + ";"; + } else if (params().scale != "100") { + // Note that this will not have the same effect as in LaTeX export: + // There, the image will be scaled from its original size. Here, the + // percentage will be interpreted by the browser, and the image will + // be scaled to a percentage of the window size. + imgstyle = "width:" + params().scale + "%;"; + } + if (!imgstyle.empty()) + imgstyle = "style='" + imgstyle + "' "; + + string const attr = imgstyle + "src='" + output_file + "' alt='image: " + + output_file + "'"; + xs << html::CompTag("img", attr); + return docstring(); +} + + void InsetGraphics::validate(LaTeXFeatures & features) const { // If we have no image, we should not require anything. @@ -917,19 +1078,15 @@ 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 * masterBuffer = features.buffer().masterBuffer(); - string const rel_file = removeExtension(params().filename.relFilename(masterBuffer->filePath())); + string const rel_file = params().filename.onlyFileNameWithoutExt(); if (contains(rel_file, ".")) features.require("lyxdot"); } - - if (params().subcaption) - features.require("subfigure"); } @@ -956,60 +1113,156 @@ InsetGraphicsParams const & InsetGraphics::params() const } -void InsetGraphics::editGraphics(InsetGraphicsParams const & p, - Buffer const & buffer) const +void InsetGraphics::editGraphics(InsetGraphicsParams const & p) const { - formats.edit(buffer, p.filename, - formats.getFormatFromFile(p.filename)); + theFormats().edit(buffer(), p.filename, + theFormats().getFormatFromFile(p.filename)); } -string const InsetGraphicsMailer::name_("graphics"); - -InsetGraphicsMailer::InsetGraphicsMailer(InsetGraphics & inset) - : inset_(inset) -{} +void InsetGraphics::addToToc(DocIterator const & cpit, bool output_active, + UpdateType, TocBackend & backend) const +{ + //FIXME UNICODE + docstring const str = from_utf8(params_.filename.onlyFileName()); + TocBuilder & b = backend.builder("graphics"); + b.pushItem(cpit, str, output_active); + b.pop(); +} -string const InsetGraphicsMailer::inset2string(Buffer const & buffer) const +string InsetGraphics::contextMenuName() const { - return params2string(inset_.params(), buffer); + return "context-graphics"; } -void InsetGraphicsMailer::string2params(string const & in, - Buffer const & buffer, - InsetGraphicsParams & params) +void InsetGraphics::string2params(string const & in, Buffer const & buffer, + InsetGraphicsParams & params) { - params = InsetGraphicsParams(); if (in.empty()) return; istringstream data(in); - Lexer lex(0,0); + Lexer lex; lex.setStream(data); - - string name; - lex >> name; - if (!lex || name != name_) - return print_mailer_error("InsetGraphicsMailer", in, 1, name_); - - InsetGraphics inset; - inset.readInsetGraphics(lex, buffer.filePath()); - params = inset.params(); + lex.setContext("InsetGraphics::string2params"); + lex >> "graphics"; + params = InsetGraphicsParams(); + readInsetGraphics(lex, buffer, false, params); } -string const -InsetGraphicsMailer::params2string(InsetGraphicsParams const & params, - Buffer const & buffer) +string InsetGraphics::params2string(InsetGraphicsParams const & params, + Buffer const & buffer) { ostringstream data; - data << name_ << ' '; + data << "graphics" << ' '; params.Write(data, buffer); data << "\\end_inset\n"; return data.str(); } +docstring InsetGraphics::toolTip(BufferView const &, int, int) const +{ + return from_utf8(params().filename.onlyFileName()); +} + +namespace graphics { + +void getGraphicsGroups(Buffer const & b, set & ids) +{ + Inset & inset = b.inset(); + InsetIterator it = inset_iterator_begin(inset); + InsetIterator const end = inset_iterator_end(inset); + for (; it != end; ++it) { + InsetGraphics const * ins = it->asInsetGraphics(); + if (!ins) + continue; + InsetGraphicsParams const & inspar = ins->getParams(); + if (!inspar.groupId.empty()) + ids.insert(inspar.groupId); + } +} + + +int countGroupMembers(Buffer const & b, string const & groupId) +{ + int n = 0; + if (groupId.empty()) + return n; + Inset & inset = b.inset(); + InsetIterator it = inset_iterator_begin(inset); + InsetIterator const end = inset_iterator_end(inset); + for (; it != end; ++it) { + InsetGraphics const * ins = it->asInsetGraphics(); + if (!ins) + continue; + if (ins->getParams().groupId == groupId) + ++n; + } + return n; +} + + +string getGroupParams(Buffer const & b, string const & groupId) +{ + if (groupId.empty()) + return string(); + Inset & inset = b.inset(); + InsetIterator it = inset_iterator_begin(inset); + InsetIterator const end = inset_iterator_end(inset); + for (; it != end; ++it) { + InsetGraphics const * ins = it->asInsetGraphics(); + if (!ins) + continue; + InsetGraphicsParams const & inspar = ins->getParams(); + if (inspar.groupId == groupId) { + InsetGraphicsParams tmp = inspar; + tmp.filename.erase(); + return InsetGraphics::params2string(tmp, b); + } + } + return string(); +} + + +void unifyGraphicsGroups(Buffer & b, string const & argument) +{ + InsetGraphicsParams params; + InsetGraphics::string2params(argument, b, params); + + // This handles undo groups automagically + UndoGroupHelper ugh(&b); + Inset & inset = b.inset(); + InsetIterator it = inset_iterator_begin(inset); + InsetIterator const end = inset_iterator_end(inset); + for (; it != end; ++it) { + InsetGraphics * ins = it->asInsetGraphics(); + if (!ins) + continue; + InsetGraphicsParams const & inspar = ins->getParams(); + if (params.groupId == inspar.groupId) { + CursorData(it).recordUndo(); + params.filename = inspar.filename; + ins->setParams(params); + } + } +} + + +InsetGraphics * getCurrentGraphicsInset(Cursor const & cur) +{ + Inset * instmp = &cur.inset(); + if (!instmp->asInsetGraphics()) + instmp = cur.nextInset(); + if (!instmp || !instmp->asInsetGraphics()) + return 0; + + return instmp->asInsetGraphics(); +} + +} // namespace graphics + } // namespace lyx