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