#include <config.h>
#include "insetexternal.h"
-#include "insets/renderers.h"
+#include "insets/ExternalSupport.h"
+#include "insets/ExternalTemplate.h"
+#include "insets/render_button.h"
+#include "insets/render_graphic.h"
#include "buffer.h"
#include "BufferView.h"
-#include "converter.h"
#include "debug.h"
-#include "ExternalTemplate.h"
#include "funcrequest.h"
#include "gettext.h"
#include "LaTeXFeatures.h"
#include "latexrunparams.h"
#include "lyxlex.h"
#include "lyxrc.h"
-#include "support/std_sstream.h"
+#include "metricsinfo.h"
#include "frontends/lyx_gui.h"
+#include "frontends/LyXView.h"
-#include "support/filetools.h"
-#include "support/forkedcall.h"
#include "support/lstrings.h"
-#include "support/lyxalgo.h"
#include "support/lyxlib.h"
-#include "support/path.h"
-#include "support/path_defines.h"
#include "support/tostr.h"
#include "support/translator.h"
#include <boost/bind.hpp>
+#include "support/std_sstream.h"
+
namespace support = lyx::support;
namespace external = lyx::external;
using std::endl;
-
+using std::string;
using std::auto_ptr;
using std::istringstream;
using std::ostream;
namespace lyx {
namespace graphics {
+
/// The translator between the DisplayType and the corresponding lyx string.
extern Translator<DisplayType, string> displayTranslator;
-}
-}
+
+} // namespace graphics
+} // namespace lyx
+
namespace {
unsigned int defaultLyxScale = 100;
-/// Substitute meta-variables in string s, makeing use of params and buffer.
-string const doSubstitution(InsetExternal::Params const & params,
- Buffer const & buffer, string const & s);
-
-/// Invoke the external editor.
-void editExternal(InsetExternal::Params const & params, Buffer const & buffer);
-
-
-external::Template const * getTemplatePtr(string const & name)
-{
- external::TemplateManager const & etm =
- external::TemplateManager::get();
- return etm.getTemplateByName(name);
-}
-
-
-external::Template const * getTemplatePtr(InsetExternal::Params const & params)
-{
- external::TemplateManager const & etm =
- external::TemplateManager::get();
- return etm.getTemplateByName(params.templatename());
-}
-
} // namespace anon
-InsetExternal::TempName::TempName()
+namespace lyx {
+namespace external {
+
+TempName::TempName()
{
tempname_ = support::tempName(string(), "lyxext");
support::unlink(tempname_);
}
-InsetExternal::TempName::TempName(InsetExternal::TempName const &)
+TempName::TempName(TempName const &)
{
tempname_ = TempName()();
}
-InsetExternal::TempName::~TempName()
+TempName::~TempName()
{
support::unlink(tempname_);
}
-InsetExternal::TempName &
-InsetExternal::TempName::operator=(InsetExternal::TempName const & other)
+TempName &
+TempName::operator=(TempName const & other)
{
if (this != &other)
tempname_ = TempName()();
return *this;
}
+} // namespace external
+} // namespace lyx
+
-InsetExternal::Params::Params()
+InsetExternalParams::InsetExternalParams()
: display(defaultDisplayType),
lyxscale(defaultLyxScale)
{}
-void InsetExternal::Params::settemplate(string const & name)
+namespace {
+
+template <typename T>
+void clearIfNotFound(T & data, external::TransformID value,
+ vector<external::TransformID> const & ids)
+{
+ typedef vector<external::TransformID>::const_iterator
+ const_iterator;
+
+ const_iterator it = ids.begin();
+ const_iterator end = ids.end();
+ it = std::find(it, end, value);
+ if (it == end)
+ data = T();
+}
+
+} // namespace anon
+
+
+void InsetExternalParams::settemplate(string const & name)
{
templatename_ = name;
+
+ external::TemplateManager const & etm =
+ external::TemplateManager::get();
+ external::Template const * const et = etm.getTemplateByName(name);
+ if (!et)
+ // Be safe. Don't lose data.
+ return;
+
+ // Ascertain which transforms the template supports.
+ // Empty all those that it doesn't.
+ vector<external::TransformID> const & ids = et->transformIds;
+ clearIfNotFound(clipdata, external::Clip, ids);
+ clearIfNotFound(extradata, external::Extra, ids);
+ clearIfNotFound(resizedata, external::Resize, ids);
+ clearIfNotFound(rotationdata, external::Rotate, ids);
}
-void InsetExternal::Params::write(Buffer const & buffer, ostream & os) const
+void InsetExternalParams::write(Buffer const & buffer, ostream & os) const
{
os << "External\n"
<< "\ttemplate " << templatename() << '\n';
<< '\n';
if (display != defaultDisplayType)
- os << "\tdisplay " << lyx::graphics::displayTranslator.find(display)
+ os << "\tdisplay "
+ << lyx::graphics::displayTranslator.find(display)
<< '\n';
if (lyxscale != defaultLyxScale)
os << "\tlyxscale " << tostr(lyxscale) << '\n';
+
+ if (!clipdata.bbox.empty())
+ os << "\tboundingBox " << clipdata.bbox << '\n';
+ if (clipdata.clip)
+ os << "\tclip\n";
+
+ external::ExtraData::const_iterator it = extradata.begin();
+ external::ExtraData::const_iterator end = extradata.end();
+ for (; it != end; ++it) {
+ if (!it->second.empty())
+ os << "\textra " << it->first << " \""
+ << it->second << "\"\n";
+ }
+
+ if (!rotationdata.no_rotation()) {
+ os << "\trotateAngle " << rotationdata.angle() << '\n';
+ if (rotationdata.origin() != external::RotationData::DEFAULT)
+ os << "\trotateOrigin "
+ << rotationdata.originString() << '\n';
+ }
+
+ if (!resizedata.no_resize()) {
+ using support::float_equal;
+
+ if (!float_equal(resizedata.scale, 0.0, 0.05)) {
+ if (!float_equal(resizedata.scale, 100.0, 0.05))
+ os << "\tscale "
+ << resizedata.scale << '\n';
+ } else {
+ if (!resizedata.width.zero())
+ os << "\twidth "
+ << resizedata.width.asString() << '\n';
+ if (!resizedata.height.zero())
+ os << "\theight "
+ << resizedata.height.asString() << '\n';
+ }
+ if (resizedata.keepAspectRatio)
+ os << "\tkeepAspectRatio\n";
+ }
}
-bool InsetExternal::Params::read(Buffer const & buffer, LyXLex & lex)
+bool InsetExternalParams::read(Buffer const & buffer, LyXLex & lex)
{
enum ExternalTags {
EX_TEMPLATE = 1,
EX_FILENAME,
EX_DISPLAY,
EX_LYXSCALE,
+ EX_BOUNDINGBOX,
+ EX_CLIP,
+ EX_EXTRA,
+ EX_HEIGHT,
+ EX_KEEPASPECTRATIO,
+ EX_ROTATEANGLE,
+ EX_ROTATEORIGIN,
+ EX_SCALE,
+ EX_WIDTH,
EX_END
};
keyword_item external_tags[] = {
{ "\\end_inset", EX_END },
+ { "boundingBox", EX_BOUNDINGBOX },
+ { "clip", EX_CLIP },
{ "display", EX_DISPLAY},
+ { "extra", EX_EXTRA },
{ "filename", EX_FILENAME},
+ { "height", EX_HEIGHT },
+ { "keepAspectRatio", EX_KEEPASPECTRATIO },
{ "lyxscale", EX_LYXSCALE},
- { "template", EX_TEMPLATE }
+ { "rotateAngle", EX_ROTATEANGLE },
+ { "rotateOrigin", EX_ROTATEORIGIN },
+ { "scale", EX_SCALE },
+ { "template", EX_TEMPLATE },
+ { "width", EX_WIDTH }
};
pushpophelper pph(lex, external_tags, EX_END);
lyxscale = lex.getInteger();
break;
+ case EX_BOUNDINGBOX:
+ lex.next();
+ clipdata.bbox.xl = lex.getInteger();
+ lex.next();
+ clipdata.bbox.yb = lex.getInteger();
+ lex.next();
+ clipdata.bbox.xr = lex.getInteger();
+ lex.next();
+ clipdata.bbox.yt = lex.getInteger();
+ break;
+
+ case EX_CLIP:
+ clipdata.clip = true;
+ break;
+
+ case EX_EXTRA: {
+ lex.next();
+ string const name = lex.getString();
+ lex.next();
+ extradata.set(name, lex.getString());
+ break;
+ }
+
+ case EX_HEIGHT:
+ lex.next();
+ resizedata.height = LyXLength(lex.getString());
+ break;
+
+ case EX_KEEPASPECTRATIO:
+ resizedata.keepAspectRatio = true;
+ break;
+
+ case EX_ROTATEANGLE:
+ lex.next();
+ rotationdata.angle(lex.getFloat());
+ break;
+
+ case EX_ROTATEORIGIN:
+ lex.next();
+ rotationdata.origin(lex.getString());
+ break;
+
+ case EX_SCALE:
+ lex.next();
+ resizedata.scale = lex.getFloat();
+ break;
+
+ case EX_WIDTH:
+ lex.next();
+ resizedata.width = LyXLength(lex.getString());
+ break;
+
case EX_END:
found_end = true;
break;
break;
}
- if (!found_end) {
- lex.printError("ExternalInset::read: "
- "Missing \\end_inset.");
- }
+ if (!found_end)
+ lex.printError("ExternalInset::read: Missing \\end_inset.");
// This is a trick to make sure that the data are self-consistent.
settemplate(templatename_);
- lyxerr[Debug::EXTERNAL]
- << "InsetExternal::Params::read: "
- << "template: '" << templatename()
- << "' filename: '" << filename.absFilename()
- << "' display: '" << display
- << "' scale: '" << lyxscale
- << '\'' << endl;
+ if (lyxerr.debugging(Debug::EXTERNAL)) {
+ lyxerr << "InsetExternalParams::read:\n";
+ write(buffer, lyxerr);
+ }
return !read_error;
}
InsetExternal::InsetExternal()
- : renderer_(new ButtonRenderer)
+ : renderer_(new RenderButton)
{}
params_(other.params_),
renderer_(other.renderer_->clone())
{
- GraphicRenderer * ptr = dynamic_cast<GraphicRenderer *>(renderer_.get());
- if (ptr) {
+ RenderGraphic * ptr =
+ dynamic_cast<RenderGraphic *>(renderer_.get());
+ if (ptr)
ptr->connect(boost::bind(&InsetExternal::statusChanged, this));
- }
}
}
-void InsetExternal::statusChanged()
+void InsetExternal::cache(BufferView * view) const
+{
+ BOOST_ASSERT(view);
+ view_ = view->owner()->view();
+}
+
+BufferView * InsetExternal::view() const
{
- BufferView * bv = renderer_->view();
+ return view_.lock().get();
+}
+
+
+void InsetExternal::statusChanged() const
+{
+ BufferView * const bv = view();
if (bv)
bv->updateInset(this);
}
BOOST_ASSERT(cmd.view());
Buffer const & buffer = *cmd.view()->buffer();
- InsetExternal::Params p;
+ InsetExternalParams p;
InsetExternalMailer::string2params(cmd.argument, buffer, p);
- editExternal(p, buffer);
+ external::editExternal(p, buffer);
return DISPATCHED_NOUPDATE;
}
BOOST_ASSERT(cmd.view());
Buffer const & buffer = *cmd.view()->buffer();
- InsetExternal::Params p;
+ InsetExternalParams p;
InsetExternalMailer::string2params(cmd.argument, buffer, p);
setParams(p, buffer);
cmd.view()->updateInset(this);
void InsetExternal::draw(PainterInfo & pi, int x, int y) const
{
+ cache(pi.base.bv);
renderer_->draw(pi, x, y);
}
namespace {
-lyx::graphics::Params get_grfx_params(InsetExternal::Params const & eparams)
+lyx::graphics::Params get_grfx_params(InsetExternalParams const & eparams)
{
lyx::graphics::Params gparams;
gparams.filename = eparams.filename.absFilename();
gparams.scale = eparams.lyxscale;
- gparams.display = eparams.display;
+ if (eparams.clipdata.clip)
+ gparams.bb = eparams.clipdata.bbox;
+ gparams.angle = eparams.rotationdata.angle();
+ gparams.display = eparams.display;
if (gparams.display == lyx::graphics::DefaultDisplay)
gparams.display = lyxrc.display_graphics;
-
// Override the above if we're not using a gui
if (!lyx_gui::use_gui)
gparams.display = lyx::graphics::NoDisplay;
}
-string const getScreenLabel(InsetExternal::Params const & params,
+string const getScreenLabel(InsetExternalParams const & params,
Buffer const & buffer)
{
- external::Template const * const ptr = getTemplatePtr(params);
+ external::Template const * const ptr =
+ external::getTemplatePtr(params);
if (!ptr)
return support::bformat(_("External template %1$s is not installed"),
params.templatename());
- return doSubstitution(params, buffer, ptr->guiName);
+ return external::doSubstitution(params, buffer, ptr->guiName);
}
} // namespace anon
-InsetExternal::Params const & InsetExternal::params() const
+InsetExternalParams const & InsetExternal::params() const
{
return params_;
}
-void InsetExternal::setParams(Params const & p, Buffer const & buffer)
+void InsetExternal::setParams(InsetExternalParams const & p,
+ Buffer const & buffer)
{
// The stored params; what we would like to happen in an ideal world.
params_ = p;
// We display the inset as a button by default.
- bool display_button = (!getTemplatePtr(params_) ||
+ bool display_button = (!external::getTemplatePtr(params_) ||
params_.filename.empty() ||
params_.display == lyx::graphics::NoDisplay);
if (display_button) {
- ButtonRenderer * button_ptr =
- dynamic_cast<ButtonRenderer *>(renderer_.get());
+ RenderButton * button_ptr =
+ dynamic_cast<RenderButton *>(renderer_.get());
if (!button_ptr) {
- button_ptr = new ButtonRenderer;
+ button_ptr = new RenderButton;
renderer_.reset(button_ptr);
}
button_ptr->update(getScreenLabel(params_, buffer), true);
} else {
- GraphicRenderer * graphic_ptr =
- dynamic_cast<GraphicRenderer *>(renderer_.get());
+ RenderGraphic * graphic_ptr =
+ dynamic_cast<RenderGraphic *>(renderer_.get());
if (!graphic_ptr) {
- graphic_ptr = new GraphicRenderer;
+ graphic_ptr = new RenderGraphic;
graphic_ptr->connect(
boost::bind(&InsetExternal::statusChanged, this));
renderer_.reset(graphic_ptr);
void InsetExternal::read(Buffer const & buffer, LyXLex & lex)
{
- Params params;
+ InsetExternalParams params;
if (params.read(buffer, lex))
setParams(params, buffer);
}
-int InsetExternal::write(string const & format,
- Buffer const & buf, ostream & os,
- bool external_in_tmpdir) const
-{
- external::Template const * const et_ptr = getTemplatePtr(params_);
- if (!et_ptr)
- return 0;
- external::Template const & et = *et_ptr;
-
- external::Template::Formats::const_iterator cit =
- et.formats.find(format);
- if (cit == et.formats.end()) {
- lyxerr[Debug::EXTERNAL]
- << "External template format '" << format
- << "' not specified in template "
- << params_.templatename() << endl;
- return 0;
- }
-
- updateExternal(format, buf, external_in_tmpdir);
- string const str = doSubstitution(params_, buf, cit->second.product);
- os << str;
- return int(lyx::count(str.begin(), str.end(),'\n') + 1);
-}
-
-
int InsetExternal::latex(Buffer const & buf, ostream & os,
LatexRunParams const & runparams) const
{
// If the template has specified a PDFLaTeX output, then we try and
// use that.
if (runparams.flavor == LatexRunParams::PDFLATEX) {
- external::Template const * const et_ptr = getTemplatePtr(params_);
+ external::Template const * const et_ptr =
+ external::getTemplatePtr(params_);
if (!et_ptr)
return 0;
external::Template const & et = *et_ptr;
external::Template::Formats::const_iterator cit =
et.formats.find("PDFLaTeX");
if (cit != et.formats.end())
- return write("PDFLaTeX", buf, os, external_in_tmpdir);
+ return external::writeExternal(params_, "PDFLaTeX",
+ buf, os, external_in_tmpdir);
}
- return write("LaTeX", buf, os, external_in_tmpdir);
+ return external::writeExternal(params_, "LaTeX",
+ buf, os, external_in_tmpdir);
}
int InsetExternal::ascii(Buffer const & buf, ostream & os, int) const
{
- return write("Ascii", buf, os);
+ return external::writeExternal(params_, "Ascii", buf, os);
}
int InsetExternal::linuxdoc(Buffer const & buf, ostream & os) const
{
- return write("LinuxDoc", buf, os);
+ return external::writeExternal(params_, "LinuxDoc", buf, os);
}
int InsetExternal::docbook(Buffer const & buf, ostream & os, bool) const
{
- return write("DocBook", buf, os);
+ return external::writeExternal(params_, "DocBook", buf, os);
}
void InsetExternal::validate(LaTeXFeatures & features) const
{
- external::Template const * const et_ptr = getTemplatePtr(params_);
+ external::Template const * const et_ptr =
+ external::getTemplatePtr(params_);
if (!et_ptr)
return;
external::Template const & et = *et_ptr;
- external::Template::Formats::const_iterator cit = et.formats.find("LaTeX");
+ external::Template::Formats::const_iterator cit =
+ et.formats.find("LaTeX");
if (cit == et.formats.end())
return;
}
-void InsetExternal::updateExternal(string const & format,
- Buffer const & buf,
- bool external_in_tmpdir) const
-{
- external::Template const * const et_ptr = getTemplatePtr(params_);
- if (!et_ptr)
- return;
- external::Template const & et = *et_ptr;
-
- if (!et.automaticProduction)
- return;
-
- external::Template::Formats::const_iterator cit =
- et.formats.find(format);
- if (cit == et.formats.end())
- return;
-
- external::Template::Format const & outputFormat = cit->second;
- if (outputFormat.updateResult.empty())
- return;
-
- string from_format = et.inputFormat;
- if (from_format.empty())
- return;
-
- string from_file = params_.filename.absFilename();
-
- if (from_format == "*") {
- if (from_file.empty())
- return;
-
- // Try and ascertain the file format from its contents.
- from_format = support::getExtFromContents(from_file);
- if (from_format.empty())
- return;
- }
-
- string const to_format = outputFormat.updateFormat;
- if (to_format.empty())
- return;
-
- if (!converters.isReachable(from_format, to_format)) {
- lyxerr[Debug::EXTERNAL]
- << "InsetExternal::updateExternal. "
- << "Unable to convert from "
- << from_format << " to " << to_format << endl;
- return;
- }
-
- if (external_in_tmpdir && !from_file.empty()) {
- // We are running stuff through LaTeX
- string const temp_file =
- support::MakeAbsPath(params_.filename.mangledFilename(),
- buf.temppath());
- unsigned long const from_checksum = support::sum(from_file);
- unsigned long const temp_checksum = support::sum(temp_file);
-
- // Nothing to do...
- if (from_checksum == temp_checksum)
- return;
-
- // Cannot proceed...
- if (!support::copy(from_file, temp_file))
- return;
- from_file = temp_file;
- }
-
- string const to_file = doSubstitution(params_, buf,
- outputFormat.updateResult);
- string const abs_to_file = support::MakeAbsPath(to_file, buf.filePath());
-
- // Do we need to perform the conversion?
- // Yes if to_file does not exist or if from_file is newer than to_file
- if (support::compare_timestamps(from_file, abs_to_file) < 0)
- return;
-
- string const to_filebase = support::ChangeExtension(to_file, string());
- converters.convert(&buf, from_file, to_filebase, from_format, to_format);
-}
-
-
-namespace {
-
-/// Substitute meta-variables in this string
-string const doSubstitution(InsetExternal::Params const & params,
- Buffer const & buffer, string const & s)
-{
- string result;
- string const buffer_path = buffer.filePath();
- string const filename = params.filename.outputFilename(buffer_path);
- string const basename = support::ChangeExtension(filename, string());
- string const filepath = support::OnlyPath(filename);
-
- result = support::subst(s, "$$FName", filename);
- result = support::subst(result, "$$Basename", basename);
- result = support::subst(result, "$$FPath", filepath);
- result = support::subst(result, "$$Tempname", params.tempname());
- result = support::subst(result, "$$Sysdir", support::system_lyxdir());
-
- // Handle the $$Contents(filename) syntax
- if (support::contains(result, "$$Contents(\"")) {
-
- string::size_type const pos = result.find("$$Contents(\"");
- string::size_type const end = result.find("\")", pos);
- string const file = result.substr(pos + 12, end - (pos + 12));
- string contents;
-
- string const filepath = support::IsFileReadable(file) ?
- buffer.filePath() : buffer.temppath();
- support::Path p(filepath);
-
- if (support::IsFileReadable(file))
- contents = support::GetFileContents(file);
-
- result = support::subst(result,
- ("$$Contents(\"" + file + "\")").c_str(),
- contents);
- }
-
- return result;
-}
-
-
-void editExternal(InsetExternal::Params const & params, Buffer const & buffer)
-{
- external::Template const * const et_ptr = getTemplatePtr(params);
- if (!et_ptr)
- return;
- external::Template const & et = *et_ptr;
-
- if (et.editCommand.empty())
- return;
-
- string const command = doSubstitution(params, buffer, et.editCommand);
-
- support::Path p(buffer.filePath());
- support::Forkedcall call;
- if (lyxerr.debugging(Debug::EXTERNAL)) {
- lyxerr << "Executing '" << command << "' in '"
- << buffer.filePath() << '\'' << endl;
- }
- call.startscript(support::Forkedcall::DontWait, command);
-}
-
-} // namespace anon
-
string const InsetExternalMailer::name_("external");
InsetExternalMailer::InsetExternalMailer(InsetExternal & inset)
void InsetExternalMailer::string2params(string const & in,
Buffer const & buffer,
- InsetExternal::Params & params)
+ InsetExternalParams & params)
{
- params = InsetExternal::Params();
+ params = InsetExternalParams();
if (in.empty())
return;
string const
-InsetExternalMailer::params2string(InsetExternal::Params const & params,
+InsetExternalMailer::params2string(InsetExternalParams const & params,
Buffer const & buffer)
{
ostringstream data;