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