src/insets/InsetGraphics.cpp

   1 /**
   2  * \file InsetGraphics.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Baruch Even
   7  * \author Herbert Voß
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 /*
  13 TODO
  14
  15     * What advanced features the users want to do?
  16       Implement them in a non latex dependent way, but a logical way.
  17       LyX should translate it to latex or any other fitting format.
  18     * When loading, if the image is not found in the expected place, try
  19       to find it in the clipart, or in the same directory with the image.
  20     * The image choosing dialog could show thumbnails of the image formats
  21       it knows of, thus selection based on the image instead of based on
  22       filename.
  23     * Add support for the 'picins' package.
  24     * Add support for the 'picinpar' package.
  25 */
  26
  27 /* NOTES:
  28  * Fileformat:
  29  * The filename is kept in  the lyx file in a relative way, so as to allow
  30  * moving the document file and its images with no problem.
  31  *
  32  *
  33  * Conversions:
  34  *   Postscript output means EPS figures.
  35  *
  36  *   PDF output is best done with PDF figures if it's a direct conversion
  37  *   or PNG figures otherwise.
  38  *      Image format
  39  *      from        to
  40  *      EPS         epstopdf
  41  *      PS          ps2pdf
  42  *      JPG/PNG     direct
  43  *      PDF         direct
  44  *      others      PNG
  45  */
  46
  47 #include <config.h>
  48
  49 #include "insets/InsetGraphics.h"
  50 #include "insets/RenderGraphic.h"
  51
  52 #include "Buffer.h"
  53 #include "BufferView.h"
  54 #include "Converter.h"
  55 #include "Cursor.h"
  56 #include "DispatchResult.h"
  57 #include "EmbeddedFiles.h"
  58 #include "ErrorList.h"
  59 #include "Exporter.h"
  60 #include "Format.h"
  61 #include "FuncRequest.h"
  62 #include "FuncStatus.h"
  63 #include "LaTeXFeatures.h"
  64 #include "Length.h"
  65 #include "Lexer.h"
  66 #include "MetricsInfo.h"
  67 #include "Mover.h"
  68 #include "OutputParams.h"
  69 #include "sgml.h"
  70 #include "TocBackend.h"
  71
  72 #include "frontends/alert.h"
  73 #include "frontends/Application.h"
  74
  75 #include "support/convert.h"
  76 #include "support/debug.h"
  77 #include "support/docstream.h"
  78 #include "support/ExceptionMessage.h"
  79 #include "support/filetools.h"
  80 #include "support/gettext.h"
  81 #include "support/lyxlib.h"
  82 #include "support/lstrings.h"
  83 #include "support/os.h"
  84 #include "support/Systemcall.h"
  85
  86 #include <boost/bind.hpp>
  87 #include <boost/tuple/tuple.hpp>
  88
  89 #include <algorithm>
  90 #include <sstream>
  91
  92 using namespace std;
  93 using namespace lyx::support;
  94
  95 namespace lyx {
  96
  97 namespace Alert = frontend::Alert;
  98
  99 namespace {
 100
 101 /// Find the most suitable image format for images in \p format
 102 /// Note that \p format may be unknown (i. e. an empty string)
 103 string findTargetFormat(string const & format, OutputParams const & runparams)
 104 {
 105         // Are we using latex or pdflatex?
 106         if (runparams.flavor == OutputParams::PDFLATEX) {
 107                 LYXERR(Debug::GRAPHICS, "findTargetFormat: PDF mode");
 108                 Format const * const f = formats.getFormat(format);
 109                 // Convert vector graphics to pdf
 110                 if (f && f->vectorFormat())
 111                         return "pdf";
 112                 // pdflatex can use jpeg, png and pdf directly
 113                 if (format == "jpg")
 114                         return format;
 115                 // Convert everything else to png
 116                 return "png";
 117         }
 118         // If it's postscript, we always do eps.
 119         LYXERR(Debug::GRAPHICS, "findTargetFormat: PostScript mode");
 120         if (format != "ps")
 121                 // any other than ps is changed to eps
 122                 return "eps";
 123         // let ps untouched
 124         return format;
 125 }
 126
 127
 128 void readInsetGraphics(Lexer & lex, string const & bufpath,
 129         InsetGraphicsParams & params)
 130 {
 131         bool finished = false;
 132
 133         while (lex.isOK() && !finished) {
 134                 lex.next();
 135
 136                 string const token = lex.getString();
 137                 LYXERR(Debug::GRAPHICS, "Token: '" << token << '\'');
 138
 139                 if (token.empty())
 140                         continue;
 141
 142                 if (token == "\\end_inset") {
 143                         finished = true;
 144                 } else {
 145                         if (!params.Read(lex, token, bufpath))
 146                                 lyxerr << "Unknown token, " << token << ", skipping."
 147                                         << endl;
 148                 }
 149         }
 150 }
 151
 152 } // namespace anon
 153
 154
 155 InsetGraphics::InsetGraphics(Buffer & buf)
 156         : graphic_label(sgml::uniqueID(from_ascii("graph"))),
 157           graphic_(new RenderGraphic(this))
 158 {
 159         Inset::setBuffer(buf);
 160 }
 161
 162
 163 InsetGraphics::InsetGraphics(InsetGraphics const & ig)
 164         : Inset(ig),
 165           boost::signals::trackable(),
 166                 graphic_label(sgml::uniqueID(from_ascii("graph"))),
 167           graphic_(new RenderGraphic(*ig.graphic_, this))
 168 {
 169         setParams(ig.params());
 170 }
 171
 172
 173 Inset * InsetGraphics::clone() const
 174 {
 175         return new InsetGraphics(*this);
 176 }
 177
 178
 179 InsetGraphics::~InsetGraphics()
 180 {
 181         hideDialogs("graphics", this);
 182 }
 183
 184
 185 void InsetGraphics::setBuffer(Buffer & buffer)
 186 {
 187         if (buffer_) {
 188                 try {
 189                         // a file may not be copied successfully when, e.g. buffer_
 190                         // has already been closed.
 191                         params_.filename = params_.filename.copyTo(buffer);
 192                 } catch (ExceptionMessage const & message) {
 193                         Alert::error(message.title_, message.details_);
 194                         // failed to embed
 195                         params_.filename.setEmbed(false);
 196                 }
 197         }
 198         Inset::setBuffer(buffer);
 199 }
 200
 201
 202 void InsetGraphics::doDispatch(Cursor & cur, FuncRequest & cmd)
 203 {
 204         switch (cmd.action) {
 205         case LFUN_GRAPHICS_EDIT: {
 206                 InsetGraphicsParams p = params();
 207                 if (!cmd.argument().empty())
 208                         string2params(to_utf8(cmd.argument()), buffer(), p);
 209                 editGraphics(p, buffer());
 210                 break;
 211         }
 212
 213         case LFUN_INSET_MODIFY: {
 214                 InsetGraphicsParams p;
 215                 string2params(to_utf8(cmd.argument()), buffer(), p);
 216                 if (!p.filename.empty())
 217                         setParams(p);
 218                 else
 219                         cur.noUpdate();
 220                 break;
 221         }
 222
 223         case LFUN_INSET_DIALOG_UPDATE:
 224                 cur.bv().updateDialog("graphics", params2string(params(),
 225 cur.bv().buffer()));
 226                 break;
 227
 228         case LFUN_MOUSE_RELEASE:
 229                 if (!cur.selection() && cmd.button() == mouse_button::button1)
 230                         cur.bv().showDialog("graphics", params2string(params(),
 231 cur.bv().buffer()), this);
 232                 break;
 233
 234         default:
 235                 Inset::doDispatch(cur, cmd);
 236                 break;
 237         }
 238 }
 239
 240
 241 bool InsetGraphics::getStatus(Cursor & cur, FuncRequest const & cmd,
 242                 FuncStatus & flag) const
 243 {
 244         switch (cmd.action) {
 245         case LFUN_GRAPHICS_EDIT:
 246         case LFUN_INSET_MODIFY:
 247         case LFUN_INSET_DIALOG_UPDATE:
 248                 flag.enabled(true);
 249                 return true;
 250
 251         default:
 252                 return Inset::getStatus(cur, cmd, flag);
 253         }
 254 }
 255
 256
 257 void InsetGraphics::registerEmbeddedFiles(EmbeddedFileList & files) const
 258 {
 259         files.registerFile(params().filename, this, buffer());
 260 }
 261
 262
 263 void InsetGraphics::updateEmbeddedFile(EmbeddedFile const & file)
 264 {
 265         // only properties of an embedded file can be changed here.
 266         params_.filename = file;
 267 }
 268
 269
 270 void InsetGraphics::edit(Cursor & cur, bool, EntryDirection)
 271 {
 272         cur.bv().showDialog("graphics", params2string(params(),
 273 cur.bv().buffer()), this);
 274 }
 275
 276
 277 void InsetGraphics::metrics(MetricsInfo & mi, Dimension & dim) const
 278 {
 279         graphic_->metrics(mi, dim);
 280 }
 281
 282
 283 void InsetGraphics::draw(PainterInfo & pi, int x, int y) const
 284 {
 285         graphic_->draw(pi, x, y);
 286 }
 287
 288
 289 Inset::EDITABLE InsetGraphics::editable() const
 290 {
 291         return IS_EDITABLE;
 292 }
 293
 294
 295 void InsetGraphics::write(ostream & os) const
 296 {
 297         os << "Graphics\n";
 298         params().Write(os, buffer());
 299 }
 300
 301
 302 void InsetGraphics::read(Lexer & lex)
 303 {
 304         lex.setContext("InsetGraphics::read");
 305         //lex >> "Graphics";
 306         readInsetGraphics(lex, buffer().filePath(), params_);
 307         params_.filename.enable(buffer().embedded(), buffer(), false);
 308         graphic_->update(params().as_grfxParams());
 309 }
 310
 311
 312 string InsetGraphics::createLatexOptions() const
 313 {
 314         // Calculate the options part of the command, we must do it to a string
 315         // stream since we might have a trailing comma that we would like to remove
 316         // before writing it to the output stream.
 317         ostringstream options;
 318         if (!params().bb.empty())
 319             options << "bb=" << rtrim(params().bb) << ',';
 320         if (params().draft)
 321             options << "draft,";
 322         if (params().clip)
 323             options << "clip,";
 324         ostringstream size;
 325         double const scl = convert<double>(params().scale);
 326         if (!params().scale.empty() && !float_equal(scl, 0.0, 0.05)) {
 327                 if (!float_equal(scl, 100.0, 0.05))
 328                         size << "scale=" << scl / 100.0 << ',';
 329         } else {
 330                 if (!params().width.zero())
 331                         size << "width=" << params().width.asLatexString() << ',';
 332                 if (!params().height.zero())
 333                         size << "height=" << params().height.asLatexString() << ',';
 334                 if (params().keepAspectRatio)
 335                         size << "keepaspectratio,";
 336         }
 337         if (params().scaleBeforeRotation && !size.str().empty())
 338                 options << size.str();
 339
 340         // Make sure rotation angle is not very close to zero;
 341         // a float can be effectively zero but not exactly zero.
 342         if (!params().rotateAngle.empty()
 343                 && !float_equal(convert<double>(params().rotateAngle), 0.0, 0.001)) {
 344             options << "angle=" << params().rotateAngle << ',';
 345             if (!params().rotateOrigin.empty()) {
 346                 options << "origin=" << params().rotateOrigin[0];
 347                 if (contains(params().rotateOrigin,"Top"))
 348                     options << 't';
 349                 else if (contains(params().rotateOrigin,"Bottom"))
 350                     options << 'b';
 351                 else if (contains(params().rotateOrigin,"Baseline"))
 352                     options << 'B';
 353                 options << ',';
 354             }
 355         }
 356         if (!params().scaleBeforeRotation && !size.str().empty())
 357                 options << size.str();
 358
 359         if (!params().special.empty())
 360             options << params().special << ',';
 361
 362         string opts = options.str();
 363         // delete last ','
 364         if (suffixIs(opts, ','))
 365                 opts = opts.substr(0, opts.size() - 1);
 366
 367         return opts;
 368 }
 369
 370
 371 docstring InsetGraphics::toDocbookLength(Length const & len) const
 372 {
 373         odocstringstream result;
 374         switch (len.unit()) {
 375                 case Length::SP: // Scaled point (65536sp = 1pt) TeX's smallest unit.
 376                         result << len.value() * 65536.0 * 72 / 72.27 << "pt";
 377                         break;
 378                 case Length::PT: // Point = 1/72.27in = 0.351mm
 379                         result << len.value() * 72 / 72.27 << "pt";
 380                         break;
 381                 case Length::BP: // Big point (72bp = 1in), also PostScript point
 382                         result << len.value() << "pt";
 383                         break;
 384                 case Length::DD: // Didot point = 1/72 of a French inch, = 0.376mm
 385                         result << len.value() * 0.376 << "mm";
 386                         break;
 387                 case Length::MM: // Millimeter = 2.845pt
 388                         result << len.value() << "mm";
 389                         break;
 390                 case Length::PC: // Pica = 12pt = 4.218mm
 391                         result << len.value() << "pc";
 392                         break;
 393                 case Length::CC: // Cicero = 12dd = 4.531mm
 394                         result << len.value() * 4.531 << "mm";
 395                         break;
 396                 case Length::CM: // Centimeter = 10mm = 2.371pc
 397                         result << len.value() << "cm";
 398                         break;
 399                 case Length::IN: // Inch = 25.4mm = 72.27pt = 6.022pc
 400                         result << len.value() << "in";
 401                         break;
 402                 case Length::EX: // Height of a small "x" for the current font.
 403                         // Obviously we have to compromise here. Any better ratio than 1.5 ?
 404                         result << len.value() / 1.5 << "em";
 405                         break;
 406                 case Length::EM: // Width of capital "M" in current font.
 407                         result << len.value() << "em";
 408                         break;
 409                 case Length::MU: // Math unit (18mu = 1em) for positioning in math mode
 410                         result << len.value() * 18 << "em";
 411                         break;
 412                 case Length::PTW: // Percent of TextWidth
 413                 case Length::PCW: // Percent of ColumnWidth
 414                 case Length::PPW: // Percent of PageWidth
 415                 case Length::PLW: // Percent of LineWidth
 416                 case Length::PTH: // Percent of TextHeight
 417                 case Length::PPH: // Percent of Paper
 418                         // Sigh, this will go wrong.
 419                         result << len.value() << "%";
 420                         break;
 421                 default:
 422                         result << len.asDocstring();
 423                         break;
 424         }
 425         return result.str();
 426 }
 427
 428
 429 docstring InsetGraphics::createDocBookAttributes() const
 430 {
 431         // Calculate the options part of the command, we must do it to a string
 432         // stream since we copied the code from createLatexParams() ;-)
 433
 434         // FIXME: av: need to translate spec -> Docbook XSL spec
 435         // (http://www.sagehill.net/docbookxsl/ImageSizing.html)
 436         // Right now it only works with my version of db2latex :-)
 437
 438         odocstringstream options;
 439         double const scl = convert<double>(params().scale);
 440         if (!params().scale.empty() && !float_equal(scl, 0.0, 0.05)) {
 441                 if (!float_equal(scl, 100.0, 0.05))
 442                         options << " scale=\""
 443                                 << static_cast<int>( (scl) + 0.5 )
 444                                 << "\" ";
 445         } else {
 446                 if (!params().width.zero()) {
 447                         options << " width=\"" << toDocbookLength(params().width)  << "\" ";
 448                 }
 449                 if (!params().height.zero()) {
 450                         options << " depth=\"" << toDocbookLength(params().height)  << "\" ";
 451                 }
 452                 if (params().keepAspectRatio) {
 453                         // This will be irrelevant unless both width and height are set
 454                         options << "scalefit=\"1\" ";
 455                 }
 456         }
 457
 458
 459         if (!params().special.empty())
 460                 options << from_ascii(params().special) << " ";
 461
 462         // trailing blanks are ok ...
 463         return options.str();
 464 }
 465
 466
 467 namespace {
 468
 469 enum GraphicsCopyStatus {
 470         SUCCESS,
 471         FAILURE,
 472         IDENTICAL_PATHS,
 473         IDENTICAL_CONTENTS
 474 };
 475
 476
 477 pair<GraphicsCopyStatus, FileName> const
 478 copyFileIfNeeded(FileName const & file_in, FileName const & file_out)
 479 {
 480         LYXERR(Debug::FILES, "Comparing " << file_in << " and " << file_out);
 481         unsigned long const checksum_in  = file_in.checksum();
 482         unsigned long const checksum_out = file_out.checksum();
 483
 484         if (checksum_in == checksum_out)
 485                 // Nothing to do...
 486                 return make_pair(IDENTICAL_CONTENTS, file_out);
 487
 488         Mover const & mover = getMover(formats.getFormatFromFile(file_in));
 489         bool const success = mover.copy(file_in, file_out);
 490         if (!success) {
 491                 // FIXME UNICODE
 492                 LYXERR(Debug::GRAPHICS,
 493                         to_utf8(bformat(_("Could not copy the file\n%1$s\n"
 494                                                            "into the temporary directory."),
 495                                                 from_utf8(file_in.absFilename()))));
 496         }
 497
 498         GraphicsCopyStatus status = success ? SUCCESS : FAILURE;
 499         return make_pair(status, file_out);
 500 }
 501
 502
 503 pair<GraphicsCopyStatus, FileName> const
 504 copyToDirIfNeeded(DocFileName const & file, string const & dir)
 505 {
 506         string const file_in = file.absFilename();
 507         string const only_path = onlyPath(file_in);
 508         if (rtrim(onlyPath(file_in) , "/") == rtrim(dir, "/"))
 509                 return make_pair(IDENTICAL_PATHS, file_in);
 510
 511         string mangled = file.mangledFilename();
 512         if (file.isZipped()) {
 513                 // We need to change _eps.gz to .eps.gz. The mangled name is
 514                 // still unique because of the counter in mangledFilename().
 515                 // We can't just call mangledFilename() with the zip
 516                 // extension removed, because base.eps and base.eps.gz may
 517                 // have different content but would get the same mangled
 518                 // name in this case.
 519                 string const base = removeExtension(file.unzippedFilename());
 520                 string::size_type const ext_len = file_in.length() - base.length();
 521                 mangled[mangled.length() - ext_len] = '.';
 522         }
 523         FileName const file_out(makeAbsPath(mangled, dir));
 524
 525         return copyFileIfNeeded(file, file_out);
 526 }
 527
 528
 529 string const stripExtensionIfPossible(string const & file, bool nice)
 530 {
 531         // Remove the extension so the LaTeX compiler will use whatever
 532         // is appropriate (when there are several versions in different
 533         // formats).
 534         // Do this only if we are not exporting for internal usage, because
 535         // pdflatex prefers png over pdf and it would pick up the png images
 536         // that we generate for preview.
 537         // This works only if the filename contains no dots besides
 538         // the just removed one. We can fool here by replacing all
 539         // dots with a macro whose definition is just a dot ;-)
 540         // The automatic format selection does not work if the file
 541         // name is escaped.
 542         string const latex_name = latex_path(file, EXCLUDE_EXTENSION);
 543         if (!nice || contains(latex_name, '"'))
 544                 return latex_name;
 545         return latex_path(removeExtension(file), PROTECT_EXTENSION, ESCAPE_DOTS);
 546 }
 547
 548
 549 string const stripExtensionIfPossible(string const & file, string const & to, bool nice)
 550 {
 551         // No conversion is needed. LaTeX can handle the graphic file as is.
 552         // This is true even if the orig_file is compressed.
 553         string const to_format = formats.getFormat(to)->extension();
 554         string const file_format = getExtension(file);
 555         // for latex .ps == .eps
 556         if (to_format == file_format ||
 557             (to_format == "eps" && file_format ==  "ps") ||
 558             (to_format ==  "ps" && file_format == "eps"))
 559                 return stripExtensionIfPossible(file, nice);
 560         return latex_path(file, EXCLUDE_EXTENSION);
 561 }
 562
 563 } // namespace anon
 564
 565
 566 string InsetGraphics::prepareFile(OutputParams const & runparams) const
 567 {
 568         // The following code depends on non-empty filenames
 569         if (params().filename.empty())
 570                 return string();
 571
 572         string const orig_file = params().filename.availableFile().absFilename();
 573         // this is for dryrun and display purposes, do not use latexFilename
 574         string const rel_file = params().filename.relFilename(buffer().filePath());
 575
 576         // previewing source code, no file copying or file format conversion
 577         if (runparams.dryrun)
 578                 return stripExtensionIfPossible(rel_file, runparams.nice);
 579
 580         // temp_file will contain the file for LaTeX to act on if, for example,
 581         // we move it to a temp dir or uncompress it.
 582         FileName temp_file = params().filename.availableFile();
 583
 584         // The master buffer. This is useful when there are multiple levels
 585         // of include files
 586         Buffer const * masterBuffer = buffer().masterBuffer();
 587
 588         // Return the output name if we are inside a comment or the file does
 589         // not exist.
 590         // We are not going to change the extension or using the name of the
 591         // temporary file, the code is already complicated enough.
 592         if (runparams.inComment || !params().filename.isReadableFile())
 593                 return params().filename.outputFilename(masterBuffer->filePath());
 594
 595         // We place all temporary files in the master buffer's temp dir.
 596         // This is possible because we use mangled file names.
 597         // This is necessary for DVI export.
 598         string const temp_path = masterBuffer->temppath();
 599
 600         GraphicsCopyStatus status;
 601         boost::tie(status, temp_file) =
 602                         copyToDirIfNeeded(params().filename.availableFile(), temp_path);
 603
 604         if (status == FAILURE)
 605                 return orig_file;
 606
 607         // a relative filename should be relative to the master buffer.
 608         // "nice" means that the buffer is exported to LaTeX format but not
 609         // run through the LaTeX compiler.
 610         string output_file = runparams.nice ?
 611                 params().filename.outputFilename(masterBuffer->filePath()) :
 612                 onlyFilename(temp_file.absFilename());
 613
 614         if (runparams.nice && !isValidLaTeXFilename(output_file)) {
 615                 frontend::Alert::warning(_("Invalid filename"),
 616                                          _("The following filename is likely to cause trouble "
 617                                            "when running the exported file through LaTeX: ") +
 618                                             from_utf8(output_file));
 619         }
 620
 621         FileName source_file = runparams.nice ? FileName(params().filename) : temp_file;
 622         string const tex_format = (runparams.flavor == OutputParams::LATEX) ?
 623                         "latex" : "pdflatex";
 624
 625         // If the file is compressed and we have specified that it
 626         // should not be uncompressed, then just return its name and
 627         // let LaTeX do the rest!
 628         if (params().filename.isZipped()) {
 629                 if (params().noUnzip) {
 630                         // We don't know whether latex can actually handle
 631                         // this file, but we can't check, because that would
 632                         // mean to unzip the file and thereby making the
 633                         // noUnzip parameter meaningless.
 634                         LYXERR(Debug::GRAPHICS, "\tpass zipped file to LaTeX.");
 635
 636                         FileName const bb_orig_file = FileName(changeExtension(orig_file, "bb"));
 637                         if (runparams.nice) {
 638                                 runparams.exportdata->addExternalFile(tex_format,
 639                                                 bb_orig_file,
 640                                                 changeExtension(output_file, "bb"));
 641                         } else {
 642                                 // LaTeX needs the bounding box file in the
 643                                 // tmp dir
 644                                 FileName bb_file = FileName(changeExtension(temp_file.absFilename(), "bb"));
 645                                 boost::tie(status, bb_file) =
 646                                         copyFileIfNeeded(bb_orig_file, bb_file);
 647                                 if (status == FAILURE)
 648                                         return orig_file;
 649                                 runparams.exportdata->addExternalFile(tex_format,
 650                                                 bb_file);
 651                         }
 652                         runparams.exportdata->addExternalFile(tex_format,
 653                                         source_file, output_file);
 654                         runparams.exportdata->addExternalFile("dvi",
 655                                         source_file, output_file);
 656                         // We can't strip the extension, because we don't know
 657                         // the unzipped file format
 658                         return latex_path(output_file, EXCLUDE_EXTENSION);
 659                 }
 660
 661                 FileName const unzipped_temp_file =
 662                         FileName(unzippedFileName(temp_file.absFilename()));
 663                 output_file = unzippedFileName(output_file);
 664                 source_file = FileName(unzippedFileName(source_file.absFilename()));
 665                 if (compare_timestamps(unzipped_temp_file, temp_file) > 0) {
 666                         // temp_file has been unzipped already and
 667                         // orig_file has not changed in the meantime.
 668                         temp_file = unzipped_temp_file;
 669                         LYXERR(Debug::GRAPHICS, "\twas already unzipped to " << temp_file);
 670                 } else {
 671                         // unzipped_temp_file does not exist or is too old
 672                         temp_file = unzipFile(temp_file);
 673                         LYXERR(Debug::GRAPHICS, "\tunzipped to " << temp_file);
 674                 }
 675         }
 676
 677         string const from = formats.getFormatFromFile(temp_file);
 678         if (from.empty())
 679                 LYXERR(Debug::GRAPHICS, "\tCould not get file format.");
 680
 681         string const to   = findTargetFormat(from, runparams);
 682         string const ext  = formats.extension(to);
 683         LYXERR(Debug::GRAPHICS, "\t we have: from " << from << " to " << to);
 684
 685         // We're going to be running the exported buffer through the LaTeX
 686         // compiler, so must ensure that LaTeX can cope with the graphics
 687         // file format.
 688
 689         LYXERR(Debug::GRAPHICS, "\tthe orig file is: " << orig_file);
 690
 691         if (from == to) {
 692                 if (!runparams.nice && getExtension(temp_file.absFilename()) != ext) {
 693                         // The LaTeX compiler will not be able to determine
 694                         // the file format from the extension, so we must
 695                         // change it.
 696                         FileName const new_file = FileName(changeExtension(temp_file.absFilename(), ext));
 697                         if (temp_file.moveTo(new_file)) {
 698                                 temp_file = new_file;
 699                                 output_file = changeExtension(output_file, ext);
 700                                 source_file = FileName(changeExtension(source_file.absFilename(), ext));
 701                         } else {
 702                                 LYXERR(Debug::GRAPHICS, "Could not rename file `"
 703                                         << temp_file << "' to `" << new_file << "'.");
 704                         }
 705                 }
 706                 // The extension of temp_file might be != ext!
 707                 runparams.exportdata->addExternalFile(tex_format, source_file,
 708                                                       output_file);
 709                 runparams.exportdata->addExternalFile("dvi", source_file,
 710                                                       output_file);
 711                 return stripExtensionIfPossible(output_file, to, runparams.nice);
 712         }
 713
 714         FileName const to_file = FileName(changeExtension(temp_file.absFilename(), ext));
 715         string const output_to_file = changeExtension(output_file, ext);
 716
 717         // Do we need to perform the conversion?
 718         // Yes if to_file does not exist or if temp_file is newer than to_file
 719         if (compare_timestamps(temp_file, to_file) < 0) {
 720                 // FIXME UNICODE
 721                 LYXERR(Debug::GRAPHICS,
 722                         to_utf8(bformat(_("No conversion of %1$s is needed after all"),
 723                                    from_utf8(rel_file))));
 724                 runparams.exportdata->addExternalFile(tex_format, to_file,
 725                                                       output_to_file);
 726                 runparams.exportdata->addExternalFile("dvi", to_file,
 727                                                       output_to_file);
 728                 return stripExtensionIfPossible(output_to_file, runparams.nice);
 729         }
 730
 731         LYXERR(Debug::GRAPHICS,"\tThe original file is " << orig_file << "\n"
 732                 << "\tA copy has been made and convert is to be called with:\n"
 733                 << "\tfile to convert = " << temp_file << '\n'
 734                 << "\t from " << from << " to " << to);
 735
 736         // FIXME (Abdel 12/08/06): Is there a need to show these errors?
 737         ErrorList el;
 738         if (theConverters().convert(&buffer(), temp_file, to_file, params().filename,
 739                                from, to, el,
 740                                Converters::try_default | Converters::try_cache)) {
 741                 runparams.exportdata->addExternalFile(tex_format,
 742                                 to_file, output_to_file);
 743                 runparams.exportdata->addExternalFile("dvi",
 744                                 to_file, output_to_file);
 745         }
 746
 747         return stripExtensionIfPossible(output_to_file, runparams.nice);
 748 }
 749
 750
 751 int InsetGraphics::latex(odocstream & os,
 752                          OutputParams const & runparams) const
 753 {
 754         // If there is no file specified or not existing,
 755         // just output a message about it in the latex output.
 756         LYXERR(Debug::GRAPHICS, "insetgraphics::latex: Filename = "
 757                 << params().filename.absFilename());
 758
 759         bool const file_exists = !params().filename.empty()
 760                         && params().filename.isReadableFile();
 761         string const message = file_exists ?
 762                 string() : string("bb = 0 0 200 100, draft, type=eps");
 763         // if !message.empty() then there was no existing file
 764         // "filename" found. In this case LaTeX
 765         // draws only a rectangle with the above bb and the
 766         // not found filename in it.
 767         LYXERR(Debug::GRAPHICS, "\tMessage = \"" << message << '\"');
 768
 769         // These variables collect all the latex code that should be before and
 770         // after the actual includegraphics command.
 771         string before;
 772         string after;
 773
 774         if (runparams.moving_arg)
 775                 before += "\\protect";
 776
 777         // We never use the starred form, we use the "clip" option instead.
 778         before += "\\includegraphics";
 779
 780         // Write the options if there are any.
 781         string const opts = createLatexOptions();
 782         LYXERR(Debug::GRAPHICS, "\tOpts = " << opts);
 783
 784         if (!opts.empty() && !message.empty())
 785                 before += ('[' + opts + ',' + message + ']');
 786         else if (!opts.empty() || !message.empty())
 787                 before += ('[' + opts + message + ']');
 788
 789         LYXERR(Debug::GRAPHICS, "\tBefore = " << before << "\n\tafter = " << after);
 790
 791         string latex_str = before + '{';
 792         // Convert the file if necessary.
 793         // Remove the extension so LaTeX will use whatever is appropriate
 794         // (when there are several versions in different formats)
 795         latex_str += prepareFile(runparams);
 796         latex_str += '}' + after;
 797         // FIXME UNICODE
 798         os << from_utf8(latex_str);
 799
 800         LYXERR(Debug::GRAPHICS, "InsetGraphics::latex outputting:\n" << latex_str);
 801         // Return how many newlines we issued.
 802         return int(count(latex_str.begin(), latex_str.end(),'\n'));
 803 }
 804
 805
 806 int InsetGraphics::plaintext(odocstream & os, OutputParams const &) const
 807 {
 808         // No graphics in ascii output. Possible to use gifscii to convert
 809         // images to ascii approximation.
 810         // 1. Convert file to ascii using gifscii
 811         // 2. Read ascii output file and add it to the output stream.
 812         // at least we send the filename
 813         // FIXME UNICODE
 814         // FIXME: We have no idea what the encoding of the filename is
 815
 816         docstring const str = bformat(buffer().B_("Graphics file: %1$s"),
 817                                       from_utf8(params().filename.absFilename()));
 818         os << '<' << str << '>';
 819
 820         return 2 + str.size();
 821 }
 822
 823
 824 static int writeImageObject(char const * format, odocstream & os,
 825         OutputParams const & runparams, docstring const & graphic_label,
 826         docstring const & attributes)
 827 {
 828         if (runparams.flavor != OutputParams::XML)
 829                 os << "<![ %output.print." << format
 830                          << "; [" << endl;
 831
 832         os <<"<imageobject><imagedata fileref=\"&"
 833                  << graphic_label
 834                  << ";."
 835                  << format
 836                  << "\" "
 837                  << attributes;
 838
 839         if (runparams.flavor == OutputParams::XML)
 840                 os <<  " role=\"" << format << "\"/>" ;
 841         else
 842                 os << " format=\"" << format << "\">" ;
 843
 844         os << "</imageobject>";
 845
 846         if (runparams.flavor != OutputParams::XML)
 847                 os << endl << "]]>" ;
 848
 849         return runparams.flavor == OutputParams::XML ? 0 : 2;
 850 }
 851
 852
 853 // For explanation on inserting graphics into DocBook checkout:
 854 // http://en.tldp.org/LDP/LDP-Author-Guide/html/inserting-pictures.html
 855 // See also the docbook guide at http://www.docbook.org/
 856 int InsetGraphics::docbook(odocstream & os,
 857                            OutputParams const & runparams) const
 858 {
 859         // In DocBook v5.0, the graphic tag will be eliminated from DocBook, will
 860         // need to switch to MediaObject. However, for now this is sufficient and
 861         // easier to use.
 862         if (runparams.flavor == OutputParams::XML)
 863                 runparams.exportdata->addExternalFile("docbook-xml",
 864                                                       params().filename);
 865         else
 866                 runparams.exportdata->addExternalFile("docbook",
 867                                                       params().filename);
 868
 869         os << "<inlinemediaobject>";
 870
 871         int r = 0;
 872         docstring attributes = createDocBookAttributes();
 873         r += writeImageObject("png", os, runparams, graphic_label, attributes);
 874         r += writeImageObject("pdf", os, runparams, graphic_label, attributes);
 875         r += writeImageObject("eps", os, runparams, graphic_label, attributes);
 876         r += writeImageObject("bmp", os, runparams, graphic_label, attributes);
 877
 878         os << "</inlinemediaobject>";
 879         return r;
 880 }
 881
 882
 883 void InsetGraphics::validate(LaTeXFeatures & features) const
 884 {
 885         // If we have no image, we should not require anything.
 886         if (params().filename.empty())
 887                 return;
 888
 889         features.includeFile(graphic_label,
 890                              removeExtension(params().filename.absFilename()));
 891
 892         features.require("graphicx");
 893
 894         if (features.runparams().nice) {
 895                 Buffer const * masterBuffer = features.buffer().masterBuffer();
 896                 string const rel_file = removeExtension(params().filename.relFilename(masterBuffer->filePath()));
 897                 if (contains(rel_file, "."))
 898                         features.require("lyxdot");
 899         }
 900 }
 901
 902
 903 bool InsetGraphics::setParams(InsetGraphicsParams const & p)
 904 {
 905         // If nothing is changed, just return and say so.
 906         if (params() == p && !p.filename.empty())
 907                 return false;
 908
 909         // Copy the new parameters.
 910         params_ = p;
 911
 912         // Update the display using the new parameters.
 913         graphic_->update(params().as_grfxParams());
 914
 915         // We have changed data, report it.
 916         return true;
 917 }
 918
 919
 920 InsetGraphicsParams const & InsetGraphics::params() const
 921 {
 922         return params_;
 923 }
 924
 925
 926 void InsetGraphics::editGraphics(InsetGraphicsParams const & p,
 927                                  Buffer const & buffer) const
 928 {
 929         formats.edit(buffer, p.filename,
 930                      formats.getFormatFromFile(p.filename));
 931 }
 932
 933
 934 void InsetGraphics::addToToc(ParConstIterator const & cpit) const
 935 {
 936         TocBackend & backend = buffer().tocBackend();
 937
 938         docstring str = params_.filename.displayName();
 939         if (params_.filename.embedded()) {
 940                 backend.toc("embedded").push_back(TocItem(cpit, 0, str));
 941                 str += _(" (embedded)");
 942         }
 943         backend.toc("graphics").push_back(TocItem(cpit, 0, str));
 944 }
 945
 946
 947 docstring InsetGraphics::contextMenu(BufferView const &, int, int) const
 948 {
 949         return from_ascii("context-graphics");
 950 }
 951
 952
 953 void InsetGraphics::string2params(string const & in, Buffer const & buffer,
 954         InsetGraphicsParams & params)
 955 {
 956         if (in.empty())
 957                 return;
 958
 959         istringstream data(in);
 960         Lexer lex;
 961         lex.setStream(data);
 962         lex.setContext("InsetGraphics::string2params");
 963         lex >> "graphics";
 964         params = InsetGraphicsParams();
 965         readInsetGraphics(lex, buffer.filePath(), params);
 966 }
 967
 968
 969 string InsetGraphics::params2string(InsetGraphicsParams const & params,
 970         Buffer const & buffer)
 971 {
 972         ostringstream data;
 973         data << "graphics" << ' ';
 974         params.Write(data, buffer);
 975         data << "\\end_inset\n";
 976         return data.str();
 977 }
 978
 979
 980 } // namespace lyx