* 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.
*/
#include "Format.h"
#include "FuncRequest.h"
#include "FuncStatus.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 "InsetIterator.h"
#include "frontends/alert.h"
#include "frontends/Application.h"
#include "support/os.h"
#include "support/Systemcall.h"
-#include <boost/bind.hpp>
#include <boost/tuple/tuple.hpp>
#include <algorithm>
/// 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) {
+ // Are we using latex or XeTeX/LuaTeX/pdflatex?
+ if (runparams.flavor == OutputParams::PDFLATEX
+ || runparams.flavor == OutputParams::XETEX
+ || runparams.flavor == OutputParams::LUATEX) {
LYXERR(Debug::GRAPHICS, "findTargetFormat: PDF mode");
Format const * const f = formats.getFormat(format);
// Convert vector graphics to pdf
// 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");
if (format != "ps")
} // namespace anon
-InsetGraphics::InsetGraphics(Buffer & buf)
- : graphic_label(sgml::uniqueID(from_ascii("graph"))),
+InsetGraphics::InsetGraphics(Buffer * buf)
+ : Inset(buf), graphic_label(sgml::uniqueID(from_ascii("graph"))),
graphic_(new RenderGraphic(this))
{
- Inset::setBuffer(buf);
}
InsetGraphics::InsetGraphics(InsetGraphics const & ig)
: Inset(ig),
- boost::signals::trackable(),
- graphic_label(sgml::uniqueID(from_ascii("graph"))),
+ graphic_label(sgml::uniqueID(from_ascii("graph"))),
graphic_(new RenderGraphic(*ig.graphic_, this))
{
setParams(ig.params());
InsetGraphics::~InsetGraphics()
{
hideDialogs("graphics", this);
+ delete graphic_;
}
void InsetGraphics::doDispatch(Cursor & cur, FuncRequest & cmd)
{
- switch (cmd.action) {
+ switch (cmd.action()) {
case LFUN_INSET_EDIT: {
InsetGraphicsParams p = params();
if (!cmd.argument().empty())
string2params(to_utf8(cmd.argument()), buffer(), p);
- editGraphics(p, buffer());
+ editGraphics(p);
break;
}
case LFUN_INSET_MODIFY: {
InsetGraphicsParams p;
string2params(to_utf8(cmd.argument()), buffer(), p);
- if (!p.filename.empty())
- setParams(p);
- else
- cur.noUpdate();
+ if (p.filename.empty()) {
+ cur.noScreenUpdate();
+ break;
+ }
+
+ cur.recordUndo();
+ 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:
- cur.bv().updateDialog("graphics", params2string(params(),
- cur.bv().buffer()));
+ cur.bv().updateDialog("graphics", params2string(params(), buffer()));
break;
- case LFUN_MOUSE_RELEASE:
- if (!cur.selection() && cmd.button() == mouse_button::button1)
- cur.bv().showDialog("graphics", params2string(params(),
- cur.bv().buffer()), this);
+ case LFUN_GRAPHICS_RELOAD:
+ params_.filename.refresh();
+ graphic_->reload();
break;
default:
bool InsetGraphics::getStatus(Cursor & cur, FuncRequest const & cmd,
FuncStatus & flag) const
{
- switch (cmd.action) {
+ switch (cmd.action()) {
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:
}
-void InsetGraphics::edit(Cursor & cur, bool, EntryDirection)
+bool InsetGraphics::showInsetDialog(BufferView * bv) const
{
- cur.bv().showDialog("graphics", params2string(params(),
- cur.bv().buffer()), this);
+ bv->showDialog("graphics", params2string(params(), bv->buffer()),
+ const_cast<InsetGraphics *>(this));
+ return true;
}
+
void InsetGraphics::metrics(MetricsInfo & mi, Dimension & dim) const
{
graphic_->metrics(mi, dim);
}
-Inset::EDITABLE InsetGraphics::editable() const
-{
- return IS_EDITABLE;
-}
-
-
void InsetGraphics::write(ostream & os) const
{
os << "Graphics\n";
case Length::PPW: // Percent of PageWidth
case Length::PLW: // Percent of LineWidth
case Length::PTH: // Percent of TextHeight
- case Length::PPH: // Percent of Paper
+ case Length::PPH: // Percent of PaperHeight
// Sigh, this will go wrong.
result << len.value() << "%";
break;
LYXERR(Debug::GRAPHICS,
to_utf8(bformat(_("Could not copy the file\n%1$s\n"
"into the temporary directory."),
- from_utf8(file_in.absFilename()))));
+ from_utf8(file_in.absFileName()))));
}
GraphicsCopyStatus status = success ? SUCCESS : FAILURE;
pair<GraphicsCopyStatus, FileName> const
copyToDirIfNeeded(DocFileName const & file, string const & dir)
{
- string const file_in = file.absFilename();
+ string const file_in = file.absFileName();
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();
+ string mangled = file.mangledFileName();
if (file.isZipped()) {
// We need to change _eps.gz to .eps.gz. The mangled name is
- // still unique because of the counter in mangledFilename().
- // We can't just call mangledFilename() with the zip
+ // still unique because of the counter in mangledFileName().
+ // We can't just call mangledFileName() with the zip
// extension removed, because base.eps and base.eps.gz may
// have different content but would get the same mangled
// name in this case.
- string const base = removeExtension(file.unzippedFilename());
+ string const base = removeExtension(file.unzippedFileName());
string::size_type const ext_len = file_in.length() - base.length();
mangled[mangled.length() - ext_len] = '.';
}
if (params().filename.empty())
return string();
- string const orig_file = params().filename.absFilename();
+ string const orig_file = params().filename.absFileName();
// this is for dryrun and display purposes, do not use latexFilename
- string const rel_file = params().filename.relFilename(buffer().filePath());
+ 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 * masterBuffer = buffer().masterBuffer();
// 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 || !params().filename.isReadableFile())
- return params().filename.outputFilename(masterBuffer->filePath());
+ 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 = masterBuffer->temppath();
+ // 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);
// "nice" means that the buffer is exported to LaTeX format but not
// 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));
+ params().filename.outputFileName(masterBuffer->filePath()) :
+ onlyFileName(temp_file.absFileName());
+
+ if (runparams.nice) {
+ if (!isValidLaTeXFileName(output_file)) {
+ frontend::Alert::warning(_("Invalid filename"),
+ _("The following filename will cause troubles "
+ "when running the exported file through LaTeX: ") +
+ from_utf8(output_file));
+ }
+ // only show DVI-specific warning when export format is plain latex
+ if (!isValidDVIFileName(output_file)
+ && runparams.flavor == OutputParams::LATEX) {
+ frontend::Alert::warning(_("Problematic filename for DVI"),
+ _("The following filename can cause troubles "
+ "when running the exported file through LaTeX "
+ "and opening the resulting DVI: ") +
+ from_utf8(output_file), true);
+ }
}
FileName source_file = runparams.nice ? FileName(params().filename) : temp_file;
+ // determine the export format
string const tex_format = (runparams.flavor == OutputParams::LATEX) ?
"latex" : "pdflatex";
// LaTeX needs the bounding box file in the
// tmp dir
FileName bb_file =
- FileName(changeExtension(temp_file.absFilename(), "bb"));
+ FileName(changeExtension(temp_file.absFileName(), "bb"));
boost::tie(status, bb_file) =
copyFileIfNeeded(bb_orig_file, bb_file);
if (status == FAILURE)
}
FileName const unzipped_temp_file =
- FileName(unzippedFileName(temp_file.absFilename()));
+ FileName(unzippedFileName(temp_file.absFileName()));
output_file = unzippedFileName(output_file);
- source_file = FileName(unzippedFileName(source_file.absFilename()));
+ source_file = FileName(unzippedFileName(source_file.absFileName()));
if (compare_timestamps(unzipped_temp_file, temp_file) > 0) {
// temp_file has been unzipped already and
// orig_file has not changed in the meantime.
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));
+ 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));
+ FileName(changeExtension(source_file.absFileName(), ext));
} else {
LYXERR(Debug::GRAPHICS, "Could not rename file `"
<< temp_file << "' to `" << new_file << "'.");
return stripExtensionIfPossible(output_file, to, runparams.nice);
}
- FileName const to_file = FileName(changeExtension(temp_file.absFilename(), ext));
+ // 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?
}
-int InsetGraphics::latex(odocstream & os,
- OutputParams const & runparams) const
+void InsetGraphics::latex(otexstream & 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());
+ << params().filename.absFileName());
bool const file_exists = !params().filename.empty()
&& params().filename.isReadableFile();
os << from_utf8(latex_str);
LYXERR(Debug::GRAPHICS, "InsetGraphics::latex outputting:\n" << latex_str);
- // Return how many newlines we issued.
- return int(count(latex_str.begin(), latex_str.end(),'\n'));
}
// FIXME: We have no idea what the encoding of the filename is
docstring const str = bformat(buffer().B_("Graphics file: %1$s"),
- from_utf8(params().filename.absFilename()));
+ from_utf8(params().filename.absFileName()));
os << '<' << str << '>';
return 2 + str.size();
}
+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 << html::CompTag("img", attr);
+ return docstring();
+ }
+
+ // FIXME XHTML
+ // We aren't doing anything with the crop and rotate parameters, and it would
+ // really be better to do width and height conversion, rather than to output
+ // these parameters here.
+ string imgstyle;
+ if (!params().width.zero())
+ imgstyle += "width:" + params().width.asHTMLString() + ";";
+ if (!params().height.zero())
+ imgstyle += " height:" + params().height.asHTMLString() + ";";
+ if (!imgstyle.empty())
+ imgstyle = "style='" + imgstyle + "' ";
+
+ string const attr = imgstyle + "src='" + output_file + "' alt='image: "
+ + output_file + "'";
+ xs << html::CompTag("img", attr);
+ return docstring();
+}
+
+
void InsetGraphics::validate(LaTeXFeatures & features) const
{
// If we have no image, we should not require anything.
return;
features.includeFile(graphic_label,
- removeExtension(params().filename.absFilename()));
+ removeExtension(params().filename.absFileName()));
features.require("graphicx");
if (features.runparams().nice) {
Buffer const * masterBuffer = features.buffer().masterBuffer();
string const rel_file = removeExtension(
- params().filename.relFilename(masterBuffer->filePath()));
+ params().filename.relFileName(masterBuffer->filePath()));
if (contains(rel_file, "."))
features.require("lyxdot");
}
}
-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));
}
-void InsetGraphics::addToToc(ParConstIterator const & cpit) const
+void InsetGraphics::addToToc(DocIterator const & cpit) const
{
TocBackend & backend = buffer().tocBackend();
}
-docstring InsetGraphics::contextMenu(BufferView const &, int, int) const
+docstring InsetGraphics::contextMenuName() const
{
return from_ascii("context-graphics");
}
return data.str();
}
+namespace graphics {
-void InsetGraphics::getGraphicsGroups(Buffer const & b, std::set<string> & ids)
+void getGraphicsGroups(Buffer const & b, set<string> & ids)
{
Inset & inset = b.inset();
InsetIterator it = inset_iterator_begin(inset);
}
-string InsetGraphics::getGroupParams(Buffer const & b, std::string const & 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();
if (inspar.groupId == groupId) {
InsetGraphicsParams tmp = inspar;
tmp.filename.erase();
- return params2string(tmp, b);
+ return InsetGraphics::params2string(tmp, b);
}
}
return string();
}
-void InsetGraphics::unifyGraphicsGroups(Buffer const & b, std::string const & argument)
+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);
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 * InsetGraphics::getCurrentGraphicsInset(Cursor const & cur)
+InsetGraphics * getCurrentGraphicsInset(Cursor const & cur)
{
Inset * instmp = &cur.inset();
if (instmp->lyxCode() != GRAPHICS_CODE)
return static_cast<InsetGraphics *>(instmp);
}
+} // namespace graphics
+
} // namespace lyx