src/insets/insetgraphics.C

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