* Licence details can be found in the file COPYING.
*
* \author Baruch Even
- * \author Herbert Voß
+ * \author Herbert Voß
*
* Full author contact details are available in file CREDITS.
*/
* What advanced features the users want to do?
Implement them in a non latex dependent way, but a logical way.
LyX should translate it to latex or any other fitting format.
- * Add a way to roll the image file into the file format.
* When loading, if the image is not found in the expected place, try
to find it in the clipart, or in the same directory with the image.
* The image choosing dialog could show thumbnails of the image formats
filename.
* Add support for the 'picins' package.
* Add support for the 'picinpar' package.
- * Improve support for 'subfigure' - Allow to set the various options
- that are possible.
*/
/* NOTES:
#include "BufferView.h"
#include "Converter.h"
#include "Cursor.h"
-#include "debug.h"
#include "DispatchResult.h"
+#include "ErrorList.h"
#include "Exporter.h"
#include "Format.h"
#include "FuncRequest.h"
#include "FuncStatus.h"
-#include "gettext.h"
+#include "InsetIterator.h"
#include "LaTeXFeatures.h"
#include "Length.h"
#include "Lexer.h"
#include "MetricsInfo.h"
#include "Mover.h"
#include "OutputParams.h"
+#include "output_xhtml.h"
#include "sgml.h"
+#include "TocBackend.h"
#include "frontends/alert.h"
+#include "frontends/Application.h"
#include "support/convert.h"
+#include "support/debug.h"
+#include "support/docstream.h"
+#include "support/ExceptionMessage.h"
#include "support/filetools.h"
-#include "support/lyxalgo.h" // count
-#include "support/lyxlib.h" // sum
+#include "support/gettext.h"
+#include "support/lyxlib.h"
#include "support/lstrings.h"
#include "support/os.h"
#include "support/Systemcall.h"
-#include <boost/bind.hpp>
#include <boost/tuple/tuple.hpp>
+#include <algorithm>
#include <sstream>
+using namespace std;
+using namespace lyx::support;
namespace lyx {
-using support::bformat;
-using support::changeExtension;
-using support::compare_timestamps;
-using support::contains;
-using support::DocFileName;
-using support::FileName;
-using support::float_equal;
-using support::getExtension;
-using support::isFileReadable;
-using support::latex_path;
-using support::onlyFilename;
-using support::removeExtension;
-using support::rtrim;
-using support::subst;
-using support::Systemcall;
-using support::unzipFile;
-using support::unzippedFileName;
-
-using std::endl;
-using std::string;
-using std::auto_ptr;
-using std::istringstream;
-using std::ostream;
-using std::ostringstream;
-
+namespace Alert = frontend::Alert;
namespace {
/// Note that \p format may be unknown (i. e. an empty string)
string findTargetFormat(string const & format, OutputParams const & runparams)
{
- // Are we using latex or pdflatex?
- if (runparams.flavor == OutputParams::PDFLATEX) {
- LYXERR(Debug::GRAPHICS) << "findTargetFormat: PDF mode" << endl;
+ // Are we using latex or XeTeX/pdflatex?
+ if (runparams.flavor == OutputParams::PDFLATEX
+ || runparams.flavor == OutputParams::XETEX) {
+ LYXERR(Debug::GRAPHICS, "findTargetFormat: PDF mode");
Format const * const f = formats.getFormat(format);
// Convert vector graphics to pdf
if (f && f->vectorFormat())
// Convert everything else to png
return "png";
}
+ // for HTML, we leave the known formats and otherwise convert to png
+ if (runparams.flavor == OutputParams::HTML) {
+ if (format == "jpg" || format == "png" || format == "gif")
+ return format;
+ return "png";
+ }
// If it's postscript, we always do eps.
- LYXERR(Debug::GRAPHICS) << "findTargetFormat: PostScript mode" << endl;
+ LYXERR(Debug::GRAPHICS, "findTargetFormat: PostScript mode");
if (format != "ps")
// any other than ps is changed to eps
return "eps";
return format;
}
+
+void readInsetGraphics(Lexer & lex, string const & bufpath,
+ InsetGraphicsParams & params)
+{
+ bool finished = false;
+
+ while (lex.isOK() && !finished) {
+ lex.next();
+
+ string const token = lex.getString();
+ LYXERR(Debug::GRAPHICS, "Token: '" << token << '\'');
+
+ if (token.empty())
+ continue;
+
+ if (token == "\\end_inset") {
+ finished = true;
+ } else {
+ if (!params.Read(lex, token, bufpath))
+ lyxerr << "Unknown token, "
+ << token
+ << ", skipping."
+ << endl;
+ }
+ }
+}
+
} // namespace anon
-InsetGraphics::InsetGraphics()
- : graphic_label(sgml::uniqueID(from_ascii("graph"))),
+InsetGraphics::InsetGraphics(Buffer * buf)
+ : Inset(buf), graphic_label(sgml::uniqueID(from_ascii("graph"))),
graphic_(new RenderGraphic(this))
-{}
+{
+}
InsetGraphics::InsetGraphics(InsetGraphics const & ig)
- : InsetBase(ig),
- boost::signals::trackable(),
- graphic_label(sgml::uniqueID(from_ascii("graph"))),
+ : Inset(ig),
+ graphic_label(sgml::uniqueID(from_ascii("graph"))),
graphic_(new RenderGraphic(*ig.graphic_, this))
{
setParams(ig.params());
}
-auto_ptr<InsetBase> InsetGraphics::doClone() const
+Inset * InsetGraphics::clone() const
{
- return auto_ptr<InsetBase>(new InsetGraphics(*this));
+ return new InsetGraphics(*this);
}
InsetGraphics::~InsetGraphics()
{
- InsetGraphicsMailer(*this).hideDialog();
+ hideDialogs("graphics", this);
+ delete graphic_;
}
void InsetGraphics::doDispatch(Cursor & cur, FuncRequest & cmd)
{
switch (cmd.action) {
- case LFUN_GRAPHICS_EDIT: {
- Buffer const & buffer = *cur.bv().buffer();
- InsetGraphicsParams p;
- InsetGraphicsMailer::string2params(to_utf8(cmd.argument()), buffer, p);
- editGraphics(p, buffer);
+ case LFUN_INSET_EDIT: {
+ InsetGraphicsParams p = params();
+ if (!cmd.argument().empty())
+ string2params(to_utf8(cmd.argument()), buffer(), p);
+ editGraphics(p);
break;
}
case LFUN_INSET_MODIFY: {
- Buffer const & buffer = cur.buffer();
InsetGraphicsParams p;
- InsetGraphicsMailer::string2params(to_utf8(cmd.argument()), buffer, p);
- if (!p.filename.empty())
- setParams(p);
- else
+ string2params(to_utf8(cmd.argument()), buffer(), p);
+ if (p.filename.empty()) {
cur.noUpdate();
+ break;
+ }
+
+ setParams(p);
+ // if the inset is part of a graphics group, all the
+ // other members should be updated too.
+ if (!params_.groupId.empty())
+ graphics::unifyGraphicsGroups(buffer(),
+ to_utf8(cmd.argument()));
break;
}
case LFUN_INSET_DIALOG_UPDATE:
- InsetGraphicsMailer(*this).updateDialog(&cur.bv());
+ cur.bv().updateDialog("graphics", params2string(params(), buffer()));
break;
- case LFUN_MOUSE_RELEASE:
- InsetGraphicsMailer(*this).showDialog(&cur.bv());
+ case LFUN_GRAPHICS_RELOAD:
+ params_.filename.refresh();
+ graphic_->reload();
break;
default:
- InsetBase::doDispatch(cur, cmd);
+ Inset::doDispatch(cur, cmd);
break;
}
}
FuncStatus & flag) const
{
switch (cmd.action) {
- case LFUN_GRAPHICS_EDIT:
+ case LFUN_INSET_EDIT:
case LFUN_INSET_MODIFY:
case LFUN_INSET_DIALOG_UPDATE:
- flag.enabled(true);
+ case LFUN_GRAPHICS_RELOAD:
+ flag.setEnabled(true);
return true;
default:
- return InsetBase::getStatus(cur, cmd, flag);
+ return Inset::getStatus(cur, cmd, flag);
}
}
-void InsetGraphics::edit(Cursor & cur, bool)
+bool InsetGraphics::showInsetDialog(BufferView * bv) const
{
- InsetGraphicsMailer(*this).showDialog(&cur.bv());
+ bv->showDialog("graphics", params2string(params(), bv->buffer()),
+ const_cast<InsetGraphics *>(this));
+ return true;
}
-bool InsetGraphics::metrics(MetricsInfo & mi, Dimension & dim) const
+
+void InsetGraphics::metrics(MetricsInfo & mi, Dimension & dim) const
{
graphic_->metrics(mi, dim);
- bool const changed = dim_ != dim;
- dim_ = dim;
- return changed;
}
void InsetGraphics::draw(PainterInfo & pi, int x, int y) const
{
- setPosCache(pi, x, y);
graphic_->draw(pi, x, y);
}
-InsetBase::EDITABLE InsetGraphics::editable() const
-{
- return IS_EDITABLE;
-}
-
-
-void InsetGraphics::write(Buffer const & buf, ostream & os) const
+void InsetGraphics::write(ostream & os) const
{
os << "Graphics\n";
- params().Write(os, buf.filePath());
+ params().Write(os, buffer());
}
-void InsetGraphics::read(Buffer const & buf, Lexer & lex)
+void InsetGraphics::read(Lexer & lex)
{
- string const token = lex.getString();
-
- if (token == "Graphics")
- readInsetGraphics(lex, buf.filePath());
- else
- LYXERR(Debug::GRAPHICS) << "Not a Graphics inset!" << endl;
-
+ lex.setContext("InsetGraphics::read");
+ //lex >> "Graphics";
+ readInsetGraphics(lex, buffer().filePath(), params_);
graphic_->update(params().as_grfxParams());
}
-void InsetGraphics::readInsetGraphics(Lexer & lex, string const & bufpath)
-{
- bool finished = false;
-
- while (lex.isOK() && !finished) {
- lex.next();
-
- string const token = lex.getString();
- LYXERR(Debug::GRAPHICS) << "Token: '" << token << '\''
- << endl;
-
- if (token.empty()) {
- continue;
- } else if (token == "\\end_inset") {
- finished = true;
- } else {
- if (!params_.Read(lex, token, bufpath))
- lyxerr << "Unknown token, " << token << ", skipping."
- << std::endl;
- }
- }
-}
-
-
-string const InsetGraphics::createLatexOptions() const
+string InsetGraphics::createLatexOptions() const
{
// Calculate the options part of the command, we must do it to a string
// stream since we might have a trailing comma that we would like to remove
options << "draft,";
if (params().clip)
options << "clip,";
+ ostringstream size;
double const scl = convert<double>(params().scale);
if (!params().scale.empty() && !float_equal(scl, 0.0, 0.05)) {
if (!float_equal(scl, 100.0, 0.05))
- options << "scale=" << scl / 100.0 << ',';
+ size << "scale=" << scl / 100.0 << ',';
} else {
if (!params().width.zero())
- options << "width=" << params().width.asLatexString() << ',';
+ size << "width=" << params().width.asLatexString() << ',';
if (!params().height.zero())
- options << "height=" << params().height.asLatexString() << ',';
+ size << "height=" << params().height.asLatexString() << ',';
if (params().keepAspectRatio)
- options << "keepaspectratio,";
+ size << "keepaspectratio,";
}
+ if (params().scaleBeforeRotation && !size.str().empty())
+ options << size.str();
// Make sure rotation angle is not very close to zero;
// a float can be effectively zero but not exactly zero.
options << ',';
}
}
+ if (!params().scaleBeforeRotation && !size.str().empty())
+ options << size.str();
if (!params().special.empty())
options << params().special << ',';
string opts = options.str();
// delete last ','
- return opts.substr(0, opts.size() - 1);
+ if (suffixIs(opts, ','))
+ opts = opts.substr(0, opts.size() - 1);
+
+ return opts;
}
-docstring const InsetGraphics::toDocbookLength(Length const & len) const
+docstring InsetGraphics::toDocbookLength(Length const & len) const
{
odocstringstream result;
switch (len.unit()) {
return result.str();
}
-docstring const InsetGraphics::createDocBookAttributes() const
+
+docstring InsetGraphics::createDocBookAttributes() const
{
// Calculate the options part of the command, we must do it to a string
// stream since we copied the code from createLatexParams() ;-)
- // FIXME: av: need to translate spec -> Docbook XSL spec (http://www.sagehill.net/docbookxsl/ImageSizing.html)
+ // FIXME: av: need to translate spec -> Docbook XSL spec
+ // (http://www.sagehill.net/docbookxsl/ImageSizing.html)
// Right now it only works with my version of db2latex :-)
odocstringstream options;
namespace {
-enum CopyStatus {
+enum GraphicsCopyStatus {
SUCCESS,
FAILURE,
IDENTICAL_PATHS,
};
-std::pair<CopyStatus, FileName> const
+pair<GraphicsCopyStatus, FileName> const
copyFileIfNeeded(FileName const & file_in, FileName const & file_out)
{
- unsigned long const checksum_in = support::sum(file_in);
- unsigned long const checksum_out = support::sum(file_out);
+ LYXERR(Debug::FILES, "Comparing " << file_in << " and " << file_out);
+ unsigned long const checksum_in = file_in.checksum();
+ unsigned long const checksum_out = file_out.checksum();
if (checksum_in == checksum_out)
// Nothing to do...
- return std::make_pair(IDENTICAL_CONTENTS, file_out);
+ return make_pair(IDENTICAL_CONTENTS, file_out);
Mover const & mover = getMover(formats.getFormatFromFile(file_in));
bool const success = mover.copy(file_in, file_out);
if (!success) {
// FIXME UNICODE
- LYXERR(Debug::GRAPHICS)
- << to_utf8(support::bformat(_("Could not copy the file\n%1$s\n"
+ LYXERR(Debug::GRAPHICS,
+ to_utf8(bformat(_("Could not copy the file\n%1$s\n"
"into the temporary directory."),
- from_utf8(file_in.absFilename())))
- << std::endl;
+ from_utf8(file_in.absFilename()))));
}
- CopyStatus status = success ? SUCCESS : FAILURE;
- return std::make_pair(status, file_out);
+ GraphicsCopyStatus status = success ? SUCCESS : FAILURE;
+ return make_pair(status, file_out);
}
-std::pair<CopyStatus, FileName> const
+pair<GraphicsCopyStatus, FileName> const
copyToDirIfNeeded(DocFileName const & file, string const & dir)
{
- using support::rtrim;
-
string const file_in = file.absFilename();
- string const only_path = support::onlyPath(file_in);
- if (rtrim(support::onlyPath(file_in) , "/") == rtrim(dir, "/"))
- return std::make_pair(IDENTICAL_PATHS, file_in);
+ string const only_path = onlyPath(file_in);
+ if (rtrim(onlyPath(file_in) , "/") == rtrim(dir, "/"))
+ return make_pair(IDENTICAL_PATHS, file_in);
string mangled = file.mangledFilename();
if (file.isZipped()) {
string::size_type const ext_len = file_in.length() - base.length();
mangled[mangled.length() - ext_len] = '.';
}
- FileName const file_out(support::makeAbsPath(mangled, dir));
+ FileName const file_out(makeAbsPath(mangled, dir));
return copyFileIfNeeded(file, file_out);
}
// dots with a macro whose definition is just a dot ;-)
// The automatic format selection does not work if the file
// name is escaped.
- string const latex_name = latex_path(file,
- support::EXCLUDE_EXTENSION);
+ string const latex_name = latex_path(file, EXCLUDE_EXTENSION);
if (!nice || contains(latex_name, '"'))
return latex_name;
- return latex_path(removeExtension(file),
- support::PROTECT_EXTENSION,
- support::ESCAPE_DOTS);
+ return latex_path(removeExtension(file), PROTECT_EXTENSION, ESCAPE_DOTS);
}
(to_format == "eps" && file_format == "ps") ||
(to_format == "ps" && file_format == "eps"))
return stripExtensionIfPossible(file, nice);
- return latex_path(file, support::EXCLUDE_EXTENSION);
+ return latex_path(file, EXCLUDE_EXTENSION);
}
} // namespace anon
-string const InsetGraphics::prepareFile(Buffer const & buf,
- OutputParams const & runparams) const
+string InsetGraphics::prepareFile(OutputParams const & runparams) const
{
// The following code depends on non-empty filenames
if (params().filename.empty())
return string();
string const orig_file = params().filename.absFilename();
- string const rel_file = params().filename.relFilename(buf.filePath());
+ // this is for dryrun and display purposes, do not use latexFilename
+ string const rel_file = params().filename.relFilename(buffer().filePath());
// previewing source code, no file copying or file format conversion
if (runparams.dryrun)
return stripExtensionIfPossible(rel_file, runparams.nice);
- // temp_file will contain the file for LaTeX to act on if, for example,
- // we move it to a temp dir or uncompress it.
- FileName temp_file = params().filename;
-
// The master buffer. This is useful when there are multiple levels
// of include files
- Buffer const * m_buffer = buf.getMasterBuffer();
+ Buffer const * masterBuffer = buffer().masterBuffer();
// Return the output name if we are inside a comment or the file does
// not exist.
// We are not going to change the extension or using the name of the
// temporary file, the code is already complicated enough.
- if (runparams.inComment || !isFileReadable(params().filename))
- return params().filename.outputFilename(m_buffer->filePath());
+ if (runparams.inComment || !params().filename.isReadableFile())
+ return params().filename.outputFilename(masterBuffer->filePath());
// We place all temporary files in the master buffer's temp dir.
// This is possible because we use mangled file names.
// This is necessary for DVI export.
- string const temp_path = m_buffer->temppath();
+ string const temp_path = masterBuffer->temppath();
- CopyStatus status;
+ // temp_file will contain the file for LaTeX to act on if, for example,
+ // we move it to a temp dir or uncompress it.
+ FileName temp_file;
+ GraphicsCopyStatus status;
boost::tie(status, temp_file) =
copyToDirIfNeeded(params().filename, temp_path);
if (status == FAILURE)
return orig_file;
- // a relative filename should be relative to the master
- // buffer.
+ // a relative filename should be relative to the master buffer.
// "nice" means that the buffer is exported to LaTeX format but not
- // run through the LaTeX compiler.
- string output_file = support::os::external_path(runparams.nice ?
- params().filename.outputFilename(m_buffer->filePath()) :
- onlyFilename(temp_file.absFilename()));
+ // run through the LaTeX compiler.
+ string output_file = runparams.nice ?
+ params().filename.outputFilename(masterBuffer->filePath()) :
+ onlyFilename(temp_file.absFilename());
+
+ if (runparams.nice && !isValidLaTeXFilename(output_file)) {
+ frontend::Alert::warning(_("Invalid filename"),
+ _("The following filename is likely to cause trouble "
+ "when running the exported file through LaTeX: ") +
+ from_utf8(output_file));
+ }
+
FileName source_file = runparams.nice ? FileName(params().filename) : temp_file;
string const tex_format = (runparams.flavor == OutputParams::LATEX) ?
"latex" : "pdflatex";
// this file, but we can't check, because that would
// mean to unzip the file and thereby making the
// noUnzip parameter meaningless.
- LYXERR(Debug::GRAPHICS)
- << "\tpass zipped file to LaTeX.\n";
+ LYXERR(Debug::GRAPHICS, "\tpass zipped file to LaTeX.");
- FileName const bb_orig_file = FileName(changeExtension(orig_file, "bb"));
+ FileName const bb_orig_file =
+ FileName(changeExtension(orig_file, "bb"));
if (runparams.nice) {
runparams.exportdata->addExternalFile(tex_format,
bb_orig_file,
} else {
// LaTeX needs the bounding box file in the
// tmp dir
- FileName bb_file = FileName(changeExtension(temp_file.absFilename(), "bb"));
+ FileName bb_file =
+ FileName(changeExtension(temp_file.absFilename(), "bb"));
boost::tie(status, bb_file) =
copyFileIfNeeded(bb_orig_file, bb_file);
if (status == FAILURE)
source_file, output_file);
// We can't strip the extension, because we don't know
// the unzipped file format
- return latex_path(output_file,
- support::EXCLUDE_EXTENSION);
+ return latex_path(output_file, EXCLUDE_EXTENSION);
}
FileName const unzipped_temp_file =
// temp_file has been unzipped already and
// orig_file has not changed in the meantime.
temp_file = unzipped_temp_file;
- LYXERR(Debug::GRAPHICS)
- << "\twas already unzipped to " << temp_file
- << endl;
+ LYXERR(Debug::GRAPHICS, "\twas already unzipped to " << temp_file);
} else {
// unzipped_temp_file does not exist or is too old
temp_file = unzipFile(temp_file);
- LYXERR(Debug::GRAPHICS)
- << "\tunzipped to " << temp_file << endl;
+ LYXERR(Debug::GRAPHICS, "\tunzipped to " << temp_file);
}
}
string const from = formats.getFormatFromFile(temp_file);
- if (from.empty()) {
- LYXERR(Debug::GRAPHICS)
- << "\tCould not get file format." << endl;
- }
+ if (from.empty())
+ LYXERR(Debug::GRAPHICS, "\tCould not get file format.");
+
string const to = findTargetFormat(from, runparams);
string const ext = formats.extension(to);
- LYXERR(Debug::GRAPHICS)
- << "\t we have: from " << from << " to " << to << '\n';
+ LYXERR(Debug::GRAPHICS, "\t we have: from " << from << " to " << to);
// We're going to be running the exported buffer through the LaTeX
// compiler, so must ensure that LaTeX can cope with the graphics
// file format.
- LYXERR(Debug::GRAPHICS)
- << "\tthe orig file is: " << orig_file << endl;
+ LYXERR(Debug::GRAPHICS, "\tthe orig file is: " << orig_file);
if (from == to) {
- if (!runparams.nice && getExtension(temp_file.absFilename()) != ext) {
+ // source and destination formats are the same
+ if (!runparams.nice && !FileName(temp_file).hasExtension(ext)) {
// The LaTeX compiler will not be able to determine
// the file format from the extension, so we must
// change it.
- FileName const new_file = FileName(changeExtension(temp_file.absFilename(), ext));
- if (support::rename(temp_file, new_file)) {
+ FileName const new_file =
+ FileName(changeExtension(temp_file.absFilename(), ext));
+ if (temp_file.moveTo(new_file)) {
temp_file = new_file;
output_file = changeExtension(output_file, ext);
- source_file = FileName(changeExtension(source_file.absFilename(), ext));
- } else
- LYXERR(Debug::GRAPHICS)
- << "Could not rename file `"
- << temp_file << "' to `" << new_file
- << "'." << endl;
+ source_file =
+ FileName(changeExtension(source_file.absFilename(), ext));
+ } else {
+ LYXERR(Debug::GRAPHICS, "Could not rename file `"
+ << temp_file << "' to `" << new_file << "'.");
+ }
}
// The extension of temp_file might be != ext!
runparams.exportdata->addExternalFile(tex_format, source_file,
return stripExtensionIfPossible(output_file, to, runparams.nice);
}
+ // so the source and destination formats are different
FileName const to_file = FileName(changeExtension(temp_file.absFilename(), ext));
string const output_to_file = changeExtension(output_file, ext);
// Yes if to_file does not exist or if temp_file is newer than to_file
if (compare_timestamps(temp_file, to_file) < 0) {
// FIXME UNICODE
- LYXERR(Debug::GRAPHICS)
- << to_utf8(bformat(_("No conversion of %1$s is needed after all"),
- from_utf8(rel_file)))
- << std::endl;
+ LYXERR(Debug::GRAPHICS,
+ to_utf8(bformat(_("No conversion of %1$s is needed after all"),
+ from_utf8(rel_file))));
runparams.exportdata->addExternalFile(tex_format, to_file,
output_to_file);
runparams.exportdata->addExternalFile("dvi", to_file,
return stripExtensionIfPossible(output_to_file, runparams.nice);
}
- LYXERR(Debug::GRAPHICS)
- << "\tThe original file is " << orig_file << "\n"
+ LYXERR(Debug::GRAPHICS,"\tThe original file is " << orig_file << "\n"
<< "\tA copy has been made and convert is to be called with:\n"
<< "\tfile to convert = " << temp_file << '\n'
- << "\t from " << from << " to " << to << '\n';
+ << "\t from " << from << " to " << to);
// FIXME (Abdel 12/08/06): Is there a need to show these errors?
ErrorList el;
- if (theConverters().convert(&buf, temp_file, to_file, params().filename,
- from, to, el,
- Converters::try_default | Converters::try_cache)) {
+ if (theConverters().convert(&buffer(), temp_file, to_file, params().filename,
+ from, to, el,
+ Converters::try_default | Converters::try_cache)) {
runparams.exportdata->addExternalFile(tex_format,
to_file, output_to_file);
runparams.exportdata->addExternalFile("dvi",
}
-int InsetGraphics::latex(Buffer const & buf, odocstream & os,
- OutputParams const & runparams) const
+int InsetGraphics::latex(odocstream & os,
+ OutputParams const & runparams) const
{
// If there is no file specified or not existing,
// just output a message about it in the latex output.
- LYXERR(Debug::GRAPHICS)
- << "insetgraphics::latex: Filename = "
- << params().filename.absFilename() << endl;
+ LYXERR(Debug::GRAPHICS, "insetgraphics::latex: Filename = "
+ << params().filename.absFilename());
- string const relative_file =
- params().filename.relFilename(buf.filePath());
-
- bool const file_exists = !params().filename.empty() &&
- isFileReadable(params().filename);
+ bool const file_exists = !params().filename.empty()
+ && params().filename.isReadableFile();
string const message = file_exists ?
string() : string("bb = 0 0 200 100, draft, type=eps");
// if !message.empty() then there was no existing file
// "filename" found. In this case LaTeX
// draws only a rectangle with the above bb and the
// not found filename in it.
- LYXERR(Debug::GRAPHICS)
- << "\tMessage = \"" << message << '\"' << endl;
+ LYXERR(Debug::GRAPHICS, "\tMessage = \"" << message << '\"');
// These variables collect all the latex code that should be before and
// after the actual includegraphics command.
string before;
string after;
- // Do we want subcaptions?
- if (params().subcaption) {
- if (runparams.moving_arg)
- before += "\\protect";
- before += "\\subfigure[" + params().subcaptionText + "]{";
- after = '}';
- }
if (runparams.moving_arg)
before += "\\protect";
// Write the options if there are any.
string const opts = createLatexOptions();
- LYXERR(Debug::GRAPHICS) << "\tOpts = " << opts << endl;
+ LYXERR(Debug::GRAPHICS, "\tOpts = " << opts);
if (!opts.empty() && !message.empty())
before += ('[' + opts + ',' + message + ']');
else if (!opts.empty() || !message.empty())
before += ('[' + opts + message + ']');
- LYXERR(Debug::GRAPHICS)
- << "\tBefore = " << before
- << "\n\tafter = " << after << endl;
+ LYXERR(Debug::GRAPHICS, "\tBefore = " << before << "\n\tafter = " << after);
string latex_str = before + '{';
// Convert the file if necessary.
// Remove the extension so LaTeX will use whatever is appropriate
// (when there are several versions in different formats)
- latex_str += prepareFile(buf, runparams);
+ latex_str += prepareFile(runparams);
latex_str += '}' + after;
// FIXME UNICODE
os << from_utf8(latex_str);
- LYXERR(Debug::GRAPHICS) << "InsetGraphics::latex outputting:\n"
- << latex_str << endl;
+ LYXERR(Debug::GRAPHICS, "InsetGraphics::latex outputting:\n" << latex_str);
// Return how many newlines we issued.
- return int(lyx::count(latex_str.begin(), latex_str.end(),'\n'));
+ return int(count(latex_str.begin(), latex_str.end(),'\n'));
}
-int InsetGraphics::plaintext(Buffer const &, odocstream & os,
- OutputParams const &) const
+int InsetGraphics::plaintext(odocstream & os, OutputParams const &) const
{
// No graphics in ascii output. Possible to use gifscii to convert
// images to ascii approximation.
// FIXME UNICODE
// FIXME: We have no idea what the encoding of the filename is
- docstring const str = bformat(_("Graphics file: %1$s"),
- from_utf8(params().filename.absFilename()));
+ docstring const str = bformat(buffer().B_("Graphics file: %1$s"),
+ from_utf8(params().filename.absFilename()));
os << '<' << str << '>';
return 2 + str.size();
}
-namespace {
-
-int writeImageObject(char * format, odocstream & os, OutputParams const & runparams,
- docstring const graphic_label, docstring const attributes)
+static int writeImageObject(char const * format, odocstream & os,
+ OutputParams const & runparams, docstring const & graphic_label,
+ docstring const & attributes)
{
- if (runparams.flavor != OutputParams::XML) {
- os << "<![ %output.print."
- << format
- << "; ["
- << std::endl;
- }
- os <<"<imageobject><imagedata fileref=\"&"
- << graphic_label
- << ";."
- << format
- << "\" "
- << attributes;
- if (runparams.flavor == OutputParams::XML) {
- os << " role=\"" << format << "\"/>" ;
- }
- else {
- os << " format=\"" << format << "\">" ;
- }
- os << "</imageobject>";
- if (runparams.flavor != OutputParams::XML) {
- os << std::endl << "]]>" ;
- }
- return runparams.flavor == OutputParams::XML ? 0 : 2;
-}
-// end anonymous namespace
+ if (runparams.flavor != OutputParams::XML)
+ os << "<![ %output.print." << format
+ << "; [" << endl;
+
+ os <<"<imageobject><imagedata fileref=\"&"
+ << graphic_label
+ << ";."
+ << format
+ << "\" "
+ << attributes;
+
+ if (runparams.flavor == OutputParams::XML)
+ os << " role=\"" << format << "\"/>" ;
+ else
+ os << " format=\"" << format << "\">" ;
+
+ os << "</imageobject>";
+
+ if (runparams.flavor != OutputParams::XML)
+ os << endl << "]]>" ;
+
+ return runparams.flavor == OutputParams::XML ? 0 : 2;
}
// For explanation on inserting graphics into DocBook checkout:
// http://en.tldp.org/LDP/LDP-Author-Guide/html/inserting-pictures.html
// See also the docbook guide at http://www.docbook.org/
-int InsetGraphics::docbook(Buffer const &, odocstream & os,
+int InsetGraphics::docbook(odocstream & os,
OutputParams const & runparams) const
{
// In DocBook v5.0, the graphic tag will be eliminated from DocBook, will
// need to switch to MediaObject. However, for now this is sufficient and
// easier to use.
- if (runparams.flavor == OutputParams::XML) {
+ if (runparams.flavor == OutputParams::XML)
runparams.exportdata->addExternalFile("docbook-xml",
params().filename);
- } else {
+ else
runparams.exportdata->addExternalFile("docbook",
params().filename);
- }
+
os << "<inlinemediaobject>";
int r = 0;
}
+string InsetGraphics::prepareHTMLFile(OutputParams const & runparams) const
+{
+ // The following code depends on non-empty filenames
+ if (params().filename.empty())
+ return string();
+
+ string const orig_file = params().filename.absFilename();
+
+ // The master buffer. This is useful when there are multiple levels
+ // of include files
+ Buffer const * masterBuffer = buffer().masterBuffer();
+
+ if (!params().filename.isReadableFile())
+ return string();
+
+ // We place all temporary files in the master buffer's temp dir.
+ // This is possible because we use mangled file names.
+ // FIXME We may want to put these files in some special temporary
+ // directory.
+ string const temp_path = masterBuffer->temppath();
+
+ // Copy to temporary directory.
+ FileName temp_file;
+ GraphicsCopyStatus status;
+ boost::tie(status, temp_file) =
+ copyToDirIfNeeded(params().filename, temp_path);
+
+ if (status == FAILURE)
+ return string();
+
+ string output_file = onlyFilename(temp_file.absFilename());
+
+ string const from = formats.getFormatFromFile(temp_file);
+ if (from.empty())
+ LYXERR(Debug::GRAPHICS, "\tCould not get file format.");
+
+ string const to = findTargetFormat(from, runparams);
+ string const ext = formats.extension(to);
+ LYXERR(Debug::GRAPHICS, "\t we have: from " << from << " to " << to);
+ LYXERR(Debug::GRAPHICS, "\tthe orig file is: " << orig_file);
+
+ if (from == to) {
+ // source and destination formats are the same
+ runparams.exportdata->addExternalFile("xhtml", temp_file, output_file);
+ return output_file;
+ }
+
+ // so the source and destination formats are different
+ FileName const to_file = FileName(changeExtension(temp_file.absFilename(), ext));
+ string const output_to_file = changeExtension(output_file, ext);
+
+ // Do we need to perform the conversion?
+ // Yes if to_file does not exist or if temp_file is newer than to_file
+ if (compare_timestamps(temp_file, to_file) < 0) {
+ // FIXME UNICODE
+ LYXERR(Debug::GRAPHICS,
+ to_utf8(bformat(_("No conversion of %1$s is needed after all"),
+ from_utf8(orig_file))));
+ runparams.exportdata->addExternalFile("xhtml", to_file, output_to_file);
+ return output_to_file;
+ }
+
+ LYXERR(Debug::GRAPHICS,"\tThe original file is " << orig_file << "\n"
+ << "\tA copy has been made and convert is to be called with:\n"
+ << "\tfile to convert = " << temp_file << '\n'
+ << "\t from " << from << " to " << to);
+
+ // FIXME (Abdel 12/08/06): Is there a need to show these errors?
+ ErrorList el;
+ bool const success =
+ theConverters().convert(&buffer(), temp_file, to_file, params().filename,
+ from, to, el, Converters::try_default | Converters::try_cache);
+ if (!success)
+ return string();
+ runparams.exportdata->addExternalFile("xhtml", to_file, output_to_file);
+ return output_to_file;
+}
+
+
+docstring InsetGraphics::xhtml(XHTMLStream & xs, OutputParams const & op) const
+{
+ string const output_file = prepareHTMLFile(op);
+ if (output_file.empty()) {
+ LYXERR0("InsetGraphics::xhtml: Unable to prepare file `"
+ << params().filename << "' for output. File missing?");
+ string const attr = "src='" + params().filename.absFilename()
+ + "' alt='image: " + output_file + "'";
+ xs << CompTag("img", attr);
+ return docstring();
+ }
+
+ // FIXME XHTML
+ // Do we want to do something with the parameters, other than use them to
+ // crop, etc, the image?
+ // Speaking of which: Do the cropping, rotating, etc.
+ string const attr = "src='" + output_file + "' alt='image: "
+ + output_file + "'";
+ xs << CompTag("img", attr);
+ return docstring();
+}
+
+
void InsetGraphics::validate(LaTeXFeatures & features) const
{
// If we have no image, we should not require anything.
features.require("graphicx");
if (features.runparams().nice) {
- Buffer const * m_buffer = features.buffer().getMasterBuffer();
- string const rel_file = removeExtension(params().filename.relFilename(m_buffer->filePath()));
+ Buffer const * masterBuffer = features.buffer().masterBuffer();
+ string const rel_file = removeExtension(
+ params().filename.relFilename(masterBuffer->filePath()));
if (contains(rel_file, "."))
features.require("lyxdot");
}
-
- if (params().subcaption)
- features.require("subfigure");
}
}
-void InsetGraphics::editGraphics(InsetGraphicsParams const & p,
- Buffer const & buffer) const
+void InsetGraphics::editGraphics(InsetGraphicsParams const & p) const
{
- formats.edit(buffer, p.filename,
+ formats.edit(buffer(), p.filename,
formats.getFormatFromFile(p.filename));
}
-string const InsetGraphicsMailer::name_("graphics");
+void InsetGraphics::addToToc(DocIterator const & cpit)
+{
+ TocBackend & backend = buffer().tocBackend();
-InsetGraphicsMailer::InsetGraphicsMailer(InsetGraphics & inset)
- : inset_(inset)
-{}
+ //FIXME UNICODE
+ docstring const str = from_utf8(params_.filename.onlyFileName());
+ backend.toc("graphics").push_back(TocItem(cpit, 0, str));
+}
-string const InsetGraphicsMailer::inset2string(Buffer const & buffer) const
+docstring InsetGraphics::contextMenu(BufferView const &, int, int) const
{
- return params2string(inset_.params(), buffer);
+ return from_ascii("context-graphics");
}
-void InsetGraphicsMailer::string2params(string const & in,
- Buffer const & buffer,
- InsetGraphicsParams & params)
+void InsetGraphics::string2params(string const & in, Buffer const & buffer,
+ InsetGraphicsParams & params)
{
- params = InsetGraphicsParams();
if (in.empty())
return;
istringstream data(in);
- Lexer lex(0,0);
+ Lexer lex;
lex.setStream(data);
-
- string name;
- lex >> name;
- if (!lex || name != name_)
- return print_mailer_error("InsetGraphicsMailer", in, 1, name_);
-
- InsetGraphics inset;
- inset.readInsetGraphics(lex, buffer.filePath());
- params = inset.params();
+ lex.setContext("InsetGraphics::string2params");
+ lex >> "graphics";
+ params = InsetGraphicsParams();
+ readInsetGraphics(lex, buffer.filePath(), params);
}
-string const
-InsetGraphicsMailer::params2string(InsetGraphicsParams const & params,
- Buffer const & buffer)
+string InsetGraphics::params2string(InsetGraphicsParams const & params,
+ Buffer const & buffer)
{
ostringstream data;
- data << name_ << ' ';
- params.Write(data, buffer.filePath());
+ data << "graphics" << ' ';
+ params.Write(data, buffer);
data << "\\end_inset\n";
return data.str();
}
+namespace graphics {
+
+void getGraphicsGroups(Buffer const & b, set<string> & ids)
+{
+ Inset & inset = b.inset();
+ InsetIterator it = inset_iterator_begin(inset);
+ InsetIterator const end = inset_iterator_end(inset);
+ for (; it != end; ++it)
+ if (it->lyxCode() == GRAPHICS_CODE) {
+ InsetGraphics & ins = static_cast<InsetGraphics &>(*it);
+ InsetGraphicsParams inspar = ins.getParams();
+ if (!inspar.groupId.empty())
+ ids.insert(inspar.groupId);
+ }
+}
+
+
+int countGroupMembers(Buffer const & b, string const & groupId)
+{
+ int n = 0;
+ if (groupId.empty())
+ return n;
+ Inset & inset = b.inset();
+ InsetIterator it = inset_iterator_begin(inset);
+ InsetIterator const end = inset_iterator_end(inset);
+ for (; it != end; ++it)
+ if (it->lyxCode() == GRAPHICS_CODE) {
+ InsetGraphics & ins = static_cast<InsetGraphics &>(*it);
+ if (ins.getParams().groupId == groupId)
+ ++n;
+ }
+ return n;
+}
+
+
+string getGroupParams(Buffer const & b, string const & groupId)
+{
+ if (groupId.empty())
+ return string();
+ Inset & inset = b.inset();
+ InsetIterator it = inset_iterator_begin(inset);
+ InsetIterator const end = inset_iterator_end(inset);
+ for (; it != end; ++it)
+ if (it->lyxCode() == GRAPHICS_CODE) {
+ InsetGraphics & ins = static_cast<InsetGraphics &>(*it);
+ InsetGraphicsParams inspar = ins.getParams();
+ if (inspar.groupId == groupId) {
+ InsetGraphicsParams tmp = inspar;
+ tmp.filename.erase();
+ return InsetGraphics::params2string(tmp, b);
+ }
+ }
+ return string();
+}
+
+
+void unifyGraphicsGroups(Buffer & b, string const & argument)
+{
+ InsetGraphicsParams params;
+ InsetGraphics::string2params(argument, b, params);
+
+ b.undo().beginUndoGroup();
+ Inset & inset = b.inset();
+ InsetIterator it = inset_iterator_begin(inset);
+ InsetIterator const end = inset_iterator_end(inset);
+ for (; it != end; ++it) {
+ if (it->lyxCode() == GRAPHICS_CODE) {
+ InsetGraphics & ins = static_cast<InsetGraphics &>(*it);
+ InsetGraphicsParams inspar = ins.getParams();
+ if (params.groupId == inspar.groupId) {
+ b.undo().recordUndo(it);
+ params.filename = inspar.filename;
+ ins.setParams(params);
+ }
+ }
+ }
+ b.undo().endUndoGroup();
+}
+
+
+InsetGraphics * getCurrentGraphicsInset(Cursor const & cur)
+{
+ Inset * instmp = &cur.inset();
+ if (instmp->lyxCode() != GRAPHICS_CODE)
+ instmp = cur.nextInset();
+ if (!instmp || instmp->lyxCode() != GRAPHICS_CODE)
+ return 0;
+
+ return static_cast<InsetGraphics *>(instmp);
+}
+
+} // namespace graphics
} // namespace lyx