#include "InsetExternal.h"
#include "insets/ExternalSupport.h"
-#include "insets/ExternalTemplate.h"
#include "insets/RenderButton.h"
#include "insets/RenderGraphic.h"
#include "insets/RenderPreview.h"
#include "Buffer.h"
#include "BufferView.h"
+#include "Converter.h"
#include "Cursor.h"
#include "DispatchResult.h"
#include "Exporter.h"
#include "LyX.h" // use_gui
#include "LyXRC.h"
#include "MetricsInfo.h"
-#include "OutputParams.h"
+#include "output_latex.h"
+#include "output_xhtml.h"
+#include "texstream.h"
+#include "xml.h"
+#include "TocBackend.h"
#include "frontends/alert.h"
#include "frontends/Application.h"
#include "graphics/PreviewLoader.h"
+#include "support/convert.h"
#include "support/debug.h"
#include "support/ExceptionMessage.h"
#include "support/filetools.h"
#include "support/gettext.h"
+#include "support/lassert.h"
#include "support/lstrings.h"
#include "support/lyxlib.h"
-#include "support/convert.h"
-#include "support/Translator.h"
-
-#include <boost/bind.hpp>
+#include "support/TempFile.h"
#include <sstream>
+#include <vector>
using namespace std;
using namespace lyx::support;
namespace {
-lyx::external::DisplayType const defaultDisplayType = lyx::external::NoDisplay;
-
unsigned int const defaultLyxScale = 100;
string defaultTemplateName;
-} // namespace anon
+} // namespace
namespace lyx {
TempName::TempName()
{
- FileName const tempname = FileName::tempName("lyxext");
- // FIXME: This is unsafe
- tempname.removeFile();
// must have an extension for the converter code to work correctly.
- tempname_ = FileName(tempname.absFilename() + ".tmp");
+ support::TempFile f("lyxextXXXXXX.tmp");
+ // Let f go out of scope here and delete the file ourselves in
+ // ~TempName(), since otherwise external processes would not be able
+ // to use the file on windows (bug 9925). This is not as safe as
+ // keeping a support::TempFile member would be, but the best we can do.
+ f.setAutoRemove(false);
+ tempname_ = f.name();
}
-TempName::TempName(TempName const &)
+TempName::TempName(TempName const & that)
{
- tempname_ = TempName()();
+ *this = that;
}
TempName & TempName::operator=(TempName const & other)
{
- if (this != &other)
- tempname_ = TempName()();
+ if (this != &other) {
+ if (!tempname_.empty())
+ tempname_.removeFile();
+ support::TempFile f("lyxextXXXXXX.tmp");
+ f.setAutoRemove(false);
+ tempname_ = f.name();
+ }
return *this;
}
-namespace {
-
-/// The translator between the Display enum and corresponding lyx string.
-Translator<DisplayType, string> const initTranslator()
-{
- Translator<DisplayType, string> translator(DefaultDisplay, "default");
-
- // Fill the display translator
- translator.addPair(MonochromeDisplay, "monochrome");
- translator.addPair(GrayscaleDisplay, "grayscale");
- translator.addPair(ColorDisplay, "color");
- translator.addPair(PreviewDisplay, "preview");
- translator.addPair(NoDisplay, "none");
-
- return translator;
-}
-
-} // namespace anon
-
-
-Translator<DisplayType, string> const & displayTranslator()
+support::FileName TempName::operator()() const
{
- static Translator<DisplayType, string> const translator =
- initTranslator();
- return translator;
+ return tempname_;
}
} // namespace external
InsetExternalParams::InsetExternalParams()
- : display(defaultDisplayType),
+ : display(true),
+ preview_mode(PREVIEW_OFF),
lyxscale(defaultLyxScale),
draft(false)
{
if (defaultTemplateName.empty()) {
external::TemplateManager const & etm =
external::TemplateManager::get();
- templatename_ = etm.getTemplates().begin()->first;
+ if (!etm.getTemplates().empty())
+ templatename_ = etm.getTemplates().begin()->first;
} else
templatename_ = defaultTemplateName;
}
data = T();
}
-} // namespace anon
+} // namespace
void InsetExternalParams::settemplate(string const & name)
clearIfNotFound(extradata, external::Extra, ids);
clearIfNotFound(resizedata, external::Resize, ids);
clearIfNotFound(rotationdata, external::Rotate, ids);
+
+ //
+ preview_mode = et->preview_mode;
}
<< "\ttemplate " << templatename() << '\n';
if (!filename.empty())
- os << "\tfilename " << filename.outputFilename(buf.filePath()) << '\n';
- if (display != defaultDisplayType)
- os << "\tdisplay "
- << external::displayTranslator().find(display)
- << '\n';
+ os << "\tfilename " << filename.outputFileName(buf.filePath()) << '\n';
+
+ if (!display)
+ os << "\tdisplay false\n";
if (lyxscale != defaultLyxScale)
os << "\tlyxscale " << convert<string>(lyxscale) << '\n';
enum {
EX_TEMPLATE = 1,
EX_FILENAME,
- EX_EMBED,
EX_DISPLAY,
EX_LYXSCALE,
EX_DRAFT,
{ "clip", EX_CLIP },
{ "display", EX_DISPLAY},
{ "draft", EX_DRAFT},
- { "embed", EX_EMBED},
{ "extra", EX_EXTRA },
{ "filename", EX_FILENAME},
{ "height", EX_HEIGHT },
case EX_FILENAME: {
lex.eatLine();
string const name = lex.getString();
- filename.set(name, buffer.filePath());
- break;
- }
-
- case EX_EMBED: {
- lex.next();
- string const name = lex.getString();
- filename.setInzipName(name);
- filename.setEmbed(!name.empty());
+ filename = buffer.getReferencedFileName(name);
break;
}
case EX_DISPLAY: {
lex.next();
- string const name = lex.getString();
- display = external::displayTranslator().find(name);
+ display = lex.getString() != "false";
break;
}
- case EX_LYXSCALE:
+ case EX_LYXSCALE: {
lex.next();
- lyxscale = lex.getInteger();
+ int const ls = lex.getInteger();
+ // negative values are not accepted.
+ if (ls >= 0)
+ lyxscale = ls;
+ else
+ lex.printError("ExternalInset::read: Wrong lyxscale: $$Token");
break;
+ }
case EX_DRAFT:
draft = true;
case EX_BOUNDINGBOX:
lex.next();
- clipdata.bbox.xl = lex.getInteger();
+ clipdata.bbox.xl = Length(lex.getString());
lex.next();
- clipdata.bbox.yb = lex.getInteger();
+ clipdata.bbox.yb = Length(lex.getString());
lex.next();
- clipdata.bbox.xr = lex.getInteger();
+ clipdata.bbox.xr = Length(lex.getString());
lex.next();
- clipdata.bbox.yt = lex.getInteger();
+ clipdata.bbox.yt = Length(lex.getString());
break;
case EX_CLIP:
}
-InsetExternal::InsetExternal(Buffer & buf)
- : renderer_(new RenderButton)
+namespace {
+
+docstring screenLabel(InsetExternalParams const & params,
+ Buffer const & buffer)
+{
+ external::Template const * const ptr =
+ external::getTemplatePtr(params);
+ if (!ptr)
+ // FIXME UNICODE
+ return bformat((_("External template %1$s is not installed")),
+ from_utf8(params.templatename()));
+ // FIXME UNICODE
+ docstring gui = _(ptr->guiName);
+ gui += ": ";
+
+ if (params.filename.empty())
+ gui += "???";
+ else
+ gui += from_utf8(params.filename.relFileName(buffer.filePath()));
+
+ return gui;
+}
+
+} // namespace
+
+
+InsetExternal::InsetExternal(Buffer * buf)
+ : Inset(buf), renderer_(new RenderButton)
{
- Inset::setBuffer(buf);
}
+// Mouse hover is not copied and remains empty
InsetExternal::InsetExternal(InsetExternal const & other)
: Inset(other),
- boost::signals::trackable(),
params_(other.params_),
renderer_(other.renderer_->clone(this))
{}
InsetExternal::~InsetExternal()
{
hideDialogs("external", this);
-}
-
-void InsetExternal::setBuffer(Buffer & buffer)
-{
- if (buffer_) {
- try {
- // a file may not be copied successfully when, e.g. buffer_
- // has already been closed.
- params_.filename = params_.filename.copyTo(buffer);
- } catch (ExceptionMessage const & message) {
- Alert::error(message.title_, message.details_);
- // failed to embed
- params_.filename.setEmbed(false);
- }
- }
- Inset::setBuffer(buffer);
+ map<BufferView const *, bool>::iterator it = mouse_hover_.begin();
+ map<BufferView const *, bool>::iterator end = mouse_hover_.end();
+ for (; it != end; ++it)
+ if (it->second)
+ it->first->clearLastInset(this);
}
-void InsetExternal::statusChanged() const
+bool InsetExternal::setMouseHover(BufferView const * bv, bool mouse_hover) const
{
- updateFrontend();
+ mouse_hover_[bv] = mouse_hover;
+ return true;
}
void InsetExternal::doDispatch(Cursor & cur, FuncRequest & cmd)
{
- switch (cmd.action) {
+ switch (cmd.action()) {
- case LFUN_EXTERNAL_EDIT: {
+ case LFUN_INSET_EDIT: {
InsetExternalParams p = params();
if (!cmd.argument().empty())
string2params(to_utf8(cmd.argument()), buffer(), p);
case LFUN_INSET_MODIFY: {
InsetExternalParams p;
string2params(to_utf8(cmd.argument()), buffer(), p);
+ cur.recordUndo();
setParams(p);
break;
}
params2string(params(), cur.bv().buffer()));
break;
- case LFUN_MOUSE_RELEASE:
- if (!cur.selection() && cmd.button() == mouse_button::button1)
- cur.bv().showDialog("external",
- params2string(params(), cur.bv().buffer()),
- this);
- break;
-
default:
Inset::doDispatch(cur, cmd);
}
bool InsetExternal::getStatus(Cursor & cur, FuncRequest const & cmd,
FuncStatus & flag) const
{
- switch (cmd.action) {
+ switch (cmd.action()) {
- case LFUN_EXTERNAL_EDIT:
+ case LFUN_INSET_EDIT:
case LFUN_INSET_MODIFY:
case LFUN_INSET_DIALOG_UPDATE:
- flag.enabled(true);
+ flag.setEnabled(true);
return true;
default:
}
-void InsetExternal::registerEmbeddedFiles(EmbeddedFileList & files) const
-{
- files.registerFile(params_.filename, this, buffer());
-}
-
-
-void InsetExternal::updateEmbeddedFile(EmbeddedFile const & file)
+void InsetExternal::addToToc(DocIterator const & cpit, bool output_active,
+ UpdateType, TocBackend & backend) const
{
- params_.filename = file;
+ docstring str = screenLabel(params_, buffer());
+ TocBuilder & b = backend.builder("external");
+ b.pushItem(cpit, str, output_active);
+ b.pop();
}
-void InsetExternal::edit(Cursor & cur, bool, EntryDirection)
+bool InsetExternal::showInsetDialog(BufferView * bv) const
{
- cur.bv().showDialog("external",
- params2string(params(), cur.bv().buffer()),
- this);
+ bv->showDialog("external", params2string(params(), bv->buffer()),
+ const_cast<InsetExternal *>(this));
+ return true;
}
void InsetExternal::metrics(MetricsInfo & mi, Dimension & dim) const
{
+ if (!isRendererValid())
+ updatePreview();
+
renderer_->metrics(mi, dim);
}
void InsetExternal::draw(PainterInfo & pi, int x, int y) const
{
+ if (!isRendererValid())
+ updatePreview();
+
+ if (renderer_->asButton())
+ renderer_->setRenderState(mouse_hover_[pi.base.bv]);
renderer_->draw(pi, x, y);
}
namespace {
-enum RenderType {
- RENDERBUTTON,
- RENDERGRAPHIC,
- RENDERPREVIEW
-};
-
-
-RenderType getRenderType(InsetExternalParams const & p)
-{
- if (!external::getTemplatePtr(p) ||
- p.filename.empty() ||
- p.display == external::NoDisplay)
- return RENDERBUTTON;
-
- if (p.display == external::PreviewDisplay) {
- if (RenderPreview::status() != LyXRC::PREVIEW_OFF)
- return RENDERPREVIEW;
- return RENDERBUTTON;
- }
-
- if (p.display == external::DefaultDisplay &&
- lyxrc.display_graphics == graphics::NoDisplay)
- return RENDERBUTTON;
- return RENDERGRAPHIC;
-}
-
-
graphics::Params get_grfx_params(InsetExternalParams const & eparams)
{
graphics::Params gparams;
- gparams.filename = eparams.filename.availableFile();
- gparams.icon = eparams.filename.embedded() ? "pin.png" : "";
+ gparams.filename = eparams.filename;
gparams.scale = eparams.lyxscale;
if (eparams.clipdata.clip)
gparams.bb = eparams.clipdata.bbox;
gparams.angle = convert<double>(eparams.rotationdata.adjAngle());
-
- switch (eparams.display) {
- case external::DefaultDisplay:
- gparams.display = graphics::DefaultDisplay;
- break;
- case external::MonochromeDisplay:
- gparams.display = graphics::MonochromeDisplay;
- break;
- case external::GrayscaleDisplay:
- gparams.display = graphics::GrayscaleDisplay;
- break;
- case external::ColorDisplay:
- gparams.display = graphics::ColorDisplay;
- break;
- case external::NoDisplay:
- gparams.display = graphics::NoDisplay;
- break;
- default:
- LASSERT(false, /**/);
- }
- if (gparams.display == graphics::DefaultDisplay)
- gparams.display = graphics::DisplayType(lyxrc.display_graphics);
- // Override the above if we're not using a gui
- if (!use_gui)
- gparams.display = graphics::NoDisplay;
+ gparams.display = eparams.display;
return gparams;
}
-
-docstring screenLabel(InsetExternalParams const & params,
- Buffer const & buffer)
-{
- external::Template const * const ptr =
- external::getTemplatePtr(params);
- if (!ptr)
- // FIXME UNICODE
- return bformat((_("External template %1$s is not installed")),
- from_utf8(params.templatename()));
- // FIXME UNICODE
- docstring gui = _(ptr->guiName);
- return from_utf8(external::doSubstitution(params, buffer,
- to_utf8(gui), false));
-}
-
-} // namespace anon
+} // namespace
static bool isPreviewWanted(InsetExternalParams const & params)
{
- return params.display == external::PreviewDisplay &&
- params.filename.isReadableFile();
+ return params.display && params.filename.isReadableFile();
}
static docstring latexString(InsetExternal const & inset)
{
- odocstringstream os;
+ odocstringstream ods;
+ otexstream os(ods);
// We don't need to set runparams.encoding since it is not used by
// latex().
OutputParams runparams(0);
- runparams.flavor = OutputParams::LATEX;
+ runparams.flavor = Flavor::LaTeX;
inset.latex(os, runparams);
- return os.str();
+ return ods.str();
}
{
InsetExternalParams const & params = inset.params();
- if (RenderPreview::status() != LyXRC::PREVIEW_OFF &&
- isPreviewWanted(params)) {
+ if (RenderPreview::previewText() && isPreviewWanted(params)) {
renderer.setAbsFile(params.filename);
docstring const snippet = latexString(inset);
renderer.addPreview(snippet, buffer);
}
+bool InsetExternal::isPreviewed() const
+{
+ return (external::getTemplatePtr(params_) && !params_.filename.empty()
+ && params_.display
+ && lyxrc.display_graphics
+ && params_.preview_mode != PREVIEW_OFF
+ && (params_.preview_mode != PREVIEW_INSTANT
+ || RenderPreview::previewText()));
+}
+
+
+bool InsetExternal::isRendererValid() const
+{
+ if (!renderer_->asButton())
+ return isPreviewed();
+ return !isPreviewed();
+}
+
+
void InsetExternal::setParams(InsetExternalParams const & p)
{
params_ = p;
// will use this.
defaultTemplateName = params_.templatename();
- switch (getRenderType(params_)) {
- case RENDERBUTTON: {
+ updatePreview();
+}
+
+
+void InsetExternal::updatePreview() const
+{
+ if (!isPreviewed()) {
RenderButton * button_ptr = renderer_->asButton();
if (!button_ptr) {
renderer_.reset(new RenderButton);
button_ptr = renderer_->asButton();
}
+ button_ptr->update(screenLabel(params_, buffer()), true, false);
+ return;
+ }
- button_ptr->update(screenLabel(params_, buffer()), true);
+ switch (params_.preview_mode) {
+ case PREVIEW_OFF:
+ // Already taken care of above.
+ LASSERT(false, return);
+ break;
+ case PREVIEW_INSTANT: {
+ renderer_ = make_unique<RenderMonitoredPreview>(this);
+ RenderMonitoredPreview * preview_ptr = renderer_->asMonitoredPreview();
+ // This connection is closed at the same time as this is destroyed.
+ preview_ptr->connect([this]() { fileChanged(); });
+ add_preview_and_start_loading(*preview_ptr, *this, buffer());
break;
}
-
- case RENDERGRAPHIC: {
+ case PREVIEW_GRAPHICS: {
RenderGraphic * graphic_ptr = renderer_->asGraphic();
if (!graphic_ptr) {
renderer_.reset(new RenderGraphic(this));
graphic_ptr = renderer_->asGraphic();
}
-
graphic_ptr->update(get_grfx_params(params_));
-
- break;
- }
-
- case RENDERPREVIEW: {
- RenderMonitoredPreview * preview_ptr =
- renderer_->asMonitoredPreview();
- if (!preview_ptr) {
- renderer_.reset(new RenderMonitoredPreview(this));
- preview_ptr = renderer_->asMonitoredPreview();
- preview_ptr->fileChanged(
- boost::bind(&InsetExternal::fileChanged, this));
- }
-
- if (preview_ptr->monitoring())
- preview_ptr->stopMonitoring();
- add_preview_and_start_loading(*preview_ptr, *this, buffer());
-
break;
}
}
return;
RenderMonitoredPreview * const ptr = renderer_->asMonitoredPreview();
- LASSERT(ptr, /**/);
+ LASSERT(ptr, return);
ptr->removePreview(*buffer);
add_preview_and_start_loading(*ptr, *this, *buffer);
void InsetExternal::read(Lexer & lex)
{
InsetExternalParams params;
- if (params.read(buffer(), lex)) {
- // exception handling is not needed as long as embedded files are in place.
- params.filename.enable(buffer().embedded(), buffer(), false);
+ if (params.read(buffer(), lex))
setParams(params);
- }
}
-int InsetExternal::latex(odocstream & os, OutputParams const & runparams) const
+void InsetExternal::latex(otexstream & os, OutputParams const & runparams) const
{
if (params_.draft) {
// FIXME UNICODE
os << "\\fbox{\\ttfamily{}"
- << from_utf8(params_.filename.outputFilename(buffer().filePath()))
+ << from_utf8(params_.filename.outputFileName(buffer().filePath()))
<< "}\n";
- return 1;
+ return;
}
// "nice" means that the buffer is exported to LaTeX format but not
// If the template has specified a PDFLaTeX output, then we try and
// use that.
- if (runparams.flavor == OutputParams::PDFLATEX) {
+ if (runparams.flavor == Flavor::PdfLaTeX) {
external::Template const * const et_ptr =
external::getTemplatePtr(params_);
if (!et_ptr)
- return 0;
+ return;
external::Template const & et = *et_ptr;
external::Template::Formats::const_iterator cit =
et.formats.find("PDFLaTeX");
if (cit != et.formats.end()) {
- return external::writeExternal(params_, "PDFLaTeX",
- buffer(), os,
- *(runparams.exportdata),
- external_in_tmpdir,
- dryrun);
+ external::RetVal retval =
+ external::writeExternal(params_, "PDFLaTeX", buffer(), os,
+ *(runparams.exportdata), external_in_tmpdir, dryrun);
+ if (retval == external::KILLED) {
+ LYXERR0("External template preparation killed.");
+ if (buffer().isClone() && buffer().isExporting())
+ throw ConversionException();
+ }
+ return;
}
}
- return external::writeExternal(params_, "LaTeX", buffer(), os,
- *(runparams.exportdata),
- external_in_tmpdir,
- dryrun);
+ external::RetVal retval =
+ external::writeExternal(params_, "LaTeX", buffer(), os,
+ *(runparams.exportdata), external_in_tmpdir, dryrun);
+ if (retval == external::KILLED) {
+ LYXERR0("External template preparation killed.");
+ if (buffer().isClone() && buffer().isExporting())
+ throw ConversionException();
+ }
}
-int InsetExternal::plaintext(odocstream & os,
- OutputParams const & runparams) const
+int InsetExternal::plaintext(odocstringstream & os,
+ OutputParams const & runparams, size_t) const
{
- os << '\n'; // output external material on a new line
- external::writeExternal(params_, "Ascii", buffer(), os,
- *(runparams.exportdata), false,
- runparams.dryrun || runparams.inComment);
+ // this is too slow for constant use
+ if (runparams.for_tooltip)
+ return 0;
+
+ bool const external_in_tmpdir = !runparams.nice;
+ bool const dryrun = runparams.dryrun || runparams.inComment;
+ otexstream ots(os);
+ ots << '\n'; // output external material on a new line
+ external::RetVal retval =
+ external::writeExternal(params_, "Ascii", buffer(), ots,
+ *(runparams.exportdata), external_in_tmpdir, dryrun);
+ if (retval == external::KILLED) {
+ LYXERR0("External template preparation killed.");
+ if (buffer().isClone() && buffer().isExporting())
+ throw ConversionException();
+ }
return PLAINTEXT_NEWLINE;
}
-int InsetExternal::docbook(odocstream & os,
- OutputParams const & runparams) const
+void InsetExternal::generateXML(XMLStream & xs, OutputParams const & runparams, std::string const & format) const
{
- return external::writeExternal(params_, "DocBook", buffer(), os,
- *(runparams.exportdata), false,
- runparams.dryrun || runparams.inComment);
+ bool const external_in_tmpdir = !runparams.nice;
+ bool const dryrun = runparams.dryrun || runparams.inComment;
+ odocstringstream ods;
+ otexstream ots(ods);
+ external::RetVal retval =
+ external::writeExternal(params_, format, buffer(), ots,
+ *(runparams.exportdata), external_in_tmpdir, dryrun);
+ if (retval == external::KILLED) {
+ LYXERR0("External template preparation killed.");
+ if (buffer().isClone() && buffer().isExporting())
+ throw ConversionException();
+ }
+ xs << XMLStream::ESCAPE_NONE << ods.str();
+}
+
+
+void InsetExternal::docbook(XMLStream & xs,
+ OutputParams const & runparams) const
+{
+ generateXML(xs, runparams, "DocBook");
+}
+
+
+docstring InsetExternal::xhtml(XMLStream & xs,
+ OutputParams const & runparams) const
+{
+ generateXML(xs, runparams, "XHTML");
+ return docstring();
}
string format;
switch (features.runparams().flavor) {
- case OutputParams::LATEX:
+ case Flavor::LaTeX:
+ case Flavor::DviLuaTeX:
format = "LaTeX";
break;
- case OutputParams::PDFLATEX:
+ case Flavor::LuaTeX:
+ case Flavor::PdfLaTeX:
+ case Flavor::XeTeX:
format = "PDFLaTeX";
break;
- case OutputParams::XML:
+ case Flavor::DocBook5:
format = "DocBook";
break;
+ case Flavor::Html:
+ format = "html";
+ break;
+ case Flavor::Text:
+ format = "text";
+ break;
+ case Flavor::LyX:
+ format = "lyx";
+ break;
}
external::Template::Formats::const_iterator cit =
et.formats.find(format);
return;
}
- // FIXME: We don't need that always
+ // FIXME: We don't need that always, see InsetGraphics
features.require("lyxdot");
vector<string>::const_iterator it = cit->second.requirements.begin();
external::TemplateManager & etm = external::TemplateManager::get();
- it = cit->second.preambleNames.begin();
- end = cit->second.preambleNames.end();
- for (; it != end; ++it) {
- string const preamble = etm.getPreambleDefByName(*it);
+ for (string const & name : cit->second.preambleNames) {
+ docstring const preamble = etm.getPreambleDefByName(name);
if (!preamble.empty())
features.addPreambleSnippet(preamble);
}
}
-void InsetExternal::addPreview(graphics::PreviewLoader & ploader) const
+void InsetExternal::addPreview(DocIterator const & /*inset_pos*/,
+ graphics::PreviewLoader & ploader) const
{
RenderMonitoredPreview * const ptr = renderer_->asMonitoredPreview();
if (!ptr)
}
+string InsetExternal::contextMenuName() const
+{
+ return "context-external";
+}
+
+
void InsetExternal::string2params(string const & in, Buffer const & buffer,
InsetExternalParams & params)
{