]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetExternal.cpp
infrastructure for 'graceful asserts'
[lyx.git] / src / insets / InsetExternal.cpp
index 9da0d772e743a9ec36aee286e793e759f70168e2..ea2c0c41767df2ee1d309efba77a8230b750be1e 100644 (file)
 #include "insets/RenderPreview.h"
 
 #include "Buffer.h"
+#include "BufferView.h"
 #include "Cursor.h"
-#include "support/debug.h"
 #include "DispatchResult.h"
 #include "Exporter.h"
 #include "FuncStatus.h"
 #include "FuncRequest.h"
-#include "support/gettext.h"
 #include "LaTeXFeatures.h"
 #include "Lexer.h"
+#include "LyX.h" // use_gui
 #include "LyXRC.h"
 #include "MetricsInfo.h"
 #include "OutputParams.h"
 
 #include "frontends/alert.h"
+#include "frontends/Application.h"
 
 #include "graphics/PreviewLoader.h"
 
+#include "support/debug.h"
 #include "support/ExceptionMessage.h"
 #include "support/filetools.h"
+#include "support/gettext.h"
 #include "support/lstrings.h"
 #include "support/lyxlib.h"
 #include "support/convert.h"
@@ -64,8 +67,6 @@ namespace lyx {
 
 namespace Alert = frontend::Alert;
 
-extern bool use_gui;
-
 namespace external {
 
 TempName::TempName()
@@ -182,13 +183,13 @@ void InsetExternalParams::settemplate(string const & name)
 }
 
 
-void InsetExternalParams::write(Buffer const & buffer, ostream & os) const
+void InsetExternalParams::write(Buffer const & buf, ostream & os) const
 {
        os << "External\n"
           << "\ttemplate " << templatename() << '\n';
 
        if (!filename.empty()) {
-               os << "\tfilename " << filename.outputFilename(buffer.filePath()) << '\n';
+               os << "\tfilename " << filename.outputFilename(buf.filePath()) << '\n';
                os << "\tembed " << (filename.embedded() ? filename.inzipName() : "\"\"") << '\n';
        }
        if (display != defaultDisplayType)
@@ -244,7 +245,7 @@ void InsetExternalParams::write(Buffer const & buffer, ostream & os) const
 
 bool InsetExternalParams::read(Buffer const & buffer, Lexer & lex)
 {
-       enum ExternalTags {
+       enum {
                EX_TEMPLATE = 1,
                EX_FILENAME,
                EX_EMBED,
@@ -263,15 +264,15 @@ bool InsetExternalParams::read(Buffer const & buffer, Lexer & lex)
                EX_END
        };
 
-       keyword_item external_tags[] = {
+       LexerKeyword external_tags[] = {
                { "\\end_inset",     EX_END },
                { "boundingBox",     EX_BOUNDINGBOX },
                { "clip",            EX_CLIP },
                { "display",         EX_DISPLAY},
                { "draft",           EX_DRAFT},
+               { "embed",           EX_EMBED},
                { "extra",           EX_EXTRA },
                { "filename",        EX_FILENAME},
-               { "embed",           EX_EMBED},
                { "height",          EX_HEIGHT },
                { "keepAspectRatio", EX_KEEPASPECTRATIO },
                { "lyxscale",        EX_LYXSCALE},
@@ -282,7 +283,7 @@ bool InsetExternalParams::read(Buffer const & buffer, Lexer & lex)
                { "width",           EX_WIDTH }
        };
 
-       PushPopHelper pph(lex, external_tags, EX_END);
+       PushPopHelper pph(lex, external_tags);
 
        bool found_end  = false;
        bool read_error = false;
@@ -406,9 +407,11 @@ bool InsetExternalParams::read(Buffer const & buffer, Lexer & lex)
 }
 
 
-InsetExternal::InsetExternal()
+InsetExternal::InsetExternal(Buffer & buf)
        : renderer_(new RenderButton)
-{}
+{
+       Inset::setBuffer(buf);
+}
 
 
 InsetExternal::InsetExternal(InsetExternal const & other)
@@ -419,15 +422,26 @@ InsetExternal::InsetExternal(InsetExternal const & other)
 {}
 
 
-Inset * InsetExternal::clone() const
+InsetExternal::~InsetExternal()
 {
-       return new InsetExternal(*this);
+       hideDialogs("external", this);
 }
 
 
-InsetExternal::~InsetExternal()
+void InsetExternal::setBuffer(Buffer & buffer)
 {
-       InsetExternalMailer(*this).hideDialog();
+       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);
 }
 
 
@@ -442,37 +456,30 @@ void InsetExternal::doDispatch(Cursor & cur, FuncRequest & cmd)
        switch (cmd.action) {
 
        case LFUN_EXTERNAL_EDIT: {
-               Buffer const & buffer = cur.buffer();
-               InsetExternalParams p;
-               InsetExternalMailer::string2params(to_utf8(cmd.argument()), buffer, p);
-               external::editExternal(p, buffer);
+               InsetExternalParams p =  params();
+               if (!cmd.argument().empty())
+                       string2params(to_utf8(cmd.argument()), buffer(), p);
+               external::editExternal(p, buffer());
                break;
        }
 
        case LFUN_INSET_MODIFY: {
-               Buffer const & buffer = cur.buffer();
                InsetExternalParams p;
-               InsetExternalMailer::string2params(to_utf8(cmd.argument()), buffer, p);
-               if (!p.filename.empty()) {
-                       try {
-                               p.filename.enable(buffer.embedded(), &buffer);
-                       } catch (ExceptionMessage const & message) {
-                               Alert::error(message.title_, message.details_);
-                               // do not set parameter if an error happens
-                               break;
-                       }
-               }
-               setParams(p, buffer);
+               string2params(to_utf8(cmd.argument()), buffer(), p);
+               setParams(p);
                break;
        }
 
        case LFUN_INSET_DIALOG_UPDATE:
-               InsetExternalMailer(*this).updateDialog(&cur.bv());
+               cur.bv().updateDialog("external",
+                       params2string(params(), cur.bv().buffer()));
                break;
 
        case LFUN_MOUSE_RELEASE:
-               if (!cur.selection())
-                       InsetExternalMailer(*this).showDialog(&cur.bv());
+               if (!cur.selection() && cmd.button() == mouse_button::button1)
+                       cur.bv().showDialog("external",
+                               params2string(params(), cur.bv().buffer()),
+                               this);
                break;
 
        default:
@@ -498,27 +505,23 @@ bool InsetExternal::getStatus(Cursor & cur, FuncRequest const & cmd,
 }
 
 
-void InsetExternal::registerEmbeddedFiles(Buffer const & buffer,
-       EmbeddedFileList & files) const
+void InsetExternal::registerEmbeddedFiles(EmbeddedFileList & files) const
 {
-       files.registerFile(params_.filename, this, buffer);
+       files.registerFile(params_.filename, this, buffer());
 }
 
 
-void InsetExternal::updateEmbeddedFile(Buffer const & buf,
-       EmbeddedFile const & file)
+void InsetExternal::updateEmbeddedFile(EmbeddedFile const & file)
 {
-       // when embedding is enabled, change of embedding status leads to actions
-       EmbeddedFile temp = file;
-       temp.enable(buf.embedded(), &buf);
-       // this will not be set if an exception is thorwn in enable()
-       params_.filename = temp;
+       params_.filename = file;
 }
 
 
-void InsetExternal::edit(Cursor & cur, bool)
+void InsetExternal::edit(Cursor & cur, bool, EntryDirection)
 {
-       InsetExternalMailer(*this).showDialog(&cur.bv());
+       cur.bv().showDialog("external",
+               params2string(params(), cur.bv().buffer()),
+               this);
 }
 
 
@@ -591,7 +594,7 @@ graphics::Params get_grfx_params(InsetExternalParams const & eparams)
                gparams.display = graphics::NoDisplay;
                break;
        default:
-               BOOST_ASSERT(false);
+               LASSERT(false, /**/);
        }
        if (gparams.display == graphics::DefaultDisplay)
                gparams.display = graphics::DisplayType(lyxrc.display_graphics);
@@ -603,7 +606,7 @@ graphics::Params get_grfx_params(InsetExternalParams const & eparams)
 }
 
 
-docstring const getScreenLabel(InsetExternalParams const & params,
+docstring screenLabel(InsetExternalParams const & params,
                            Buffer const & buffer)
 {
        external::Template const * const ptr =
@@ -618,21 +621,51 @@ docstring const getScreenLabel(InsetExternalParams const & params,
                                to_utf8(gui), false));
 }
 
-void add_preview_and_start_loading(RenderMonitoredPreview &,
-                                  InsetExternal const &,
-                                  Buffer const &);
-
 } // namespace anon
 
 
+static bool isPreviewWanted(InsetExternalParams const & params)
+{
+       return params.display == external::PreviewDisplay &&
+               params.filename.isReadableFile();
+}
+
+
+static docstring latexString(InsetExternal const & inset)
+{
+       odocstringstream os;
+       // We don't need to set runparams.encoding since it is not used by
+       // latex().
+       OutputParams runparams(0);
+       runparams.flavor = OutputParams::LATEX;
+       inset.latex(os, runparams);
+       return os.str();
+}
+
+
+static void add_preview_and_start_loading(RenderMonitoredPreview & renderer,
+                                  InsetExternal const & inset,
+                                  Buffer const & buffer)
+{
+       InsetExternalParams const & params = inset.params();
+
+       if (RenderPreview::status() != LyXRC::PREVIEW_OFF &&
+           isPreviewWanted(params)) {
+               renderer.setAbsFile(params.filename);
+               docstring const snippet = latexString(inset);
+               renderer.addPreview(snippet, buffer);
+               renderer.startLoading(buffer);
+       }
+}
+
+
 InsetExternalParams const & InsetExternal::params() const
 {
        return params_;
 }
 
 
-void InsetExternal::setParams(InsetExternalParams const & p,
-                             Buffer const & buffer)
+void InsetExternal::setParams(InsetExternalParams const & p)
 {
        params_ = p;
 
@@ -648,7 +681,7 @@ void InsetExternal::setParams(InsetExternalParams const & p,
                        button_ptr = renderer_->asButton();
                }
 
-               button_ptr->update(getScreenLabel(params_, buffer), true);
+               button_ptr->update(screenLabel(params_, buffer()), true);
                break;
        }
 
@@ -676,7 +709,7 @@ void InsetExternal::setParams(InsetExternalParams const & p,
 
                if (preview_ptr->monitoring())
                        preview_ptr->stopMonitoring();
-               add_preview_and_start_loading(*preview_ptr, *this, buffer);
+               add_preview_and_start_loading(*preview_ptr, *this, buffer());
 
                break;
        }
@@ -691,37 +724,36 @@ void InsetExternal::fileChanged() const
                return;
 
        RenderMonitoredPreview * const ptr = renderer_->asMonitoredPreview();
-       BOOST_ASSERT(ptr);
+       LASSERT(ptr, /**/);
 
        ptr->removePreview(*buffer);
        add_preview_and_start_loading(*ptr, *this, *buffer);
 }
 
 
-void InsetExternal::write(Buffer const & buffer, ostream & os) const
+void InsetExternal::write(ostream & os) const
 {
-       params_.write(buffer, os);
+       params_.write(buffer(), os);
 }
 
 
-void InsetExternal::read(Buffer const & buffer, Lexer & lex)
+void InsetExternal::read(Lexer & lex)
 {
        InsetExternalParams params;
-       if (params.read(buffer, lex)) {
+       if (params.read(buffer(), lex)) {
                // exception handling is not needed as long as embedded files are in place.
-               params.filename.enable(buffer.embedded(), & buffer);
-               setParams(params, buffer);
+               params.filename.enable(buffer().embedded(), buffer(), false);
+               setParams(params);
        }
 }
 
 
-int InsetExternal::latex(Buffer const & buf, odocstream & os,
-                        OutputParams const & runparams) const
+int InsetExternal::latex(odocstream & os, OutputParams const & runparams) const
 {
        if (params_.draft) {
                // FIXME UNICODE
                os << "\\fbox{\\ttfamily{}"
-                  << from_utf8(params_.filename.outputFilename(buf.filePath()))
+                  << from_utf8(params_.filename.outputFilename(buffer().filePath()))
                   << "}\n";
                return 1;
        }
@@ -747,35 +779,35 @@ int InsetExternal::latex(Buffer const & buf, odocstream & os,
 
                if (cit != et.formats.end()) {
                        return external::writeExternal(params_, "PDFLaTeX",
-                                                      buf, os,
+                                                      buffer(), os,
                                                       *(runparams.exportdata),
                                                       external_in_tmpdir,
                                                       dryrun);
                }
        }
 
-       return external::writeExternal(params_, "LaTeX", buf, os,
+       return external::writeExternal(params_, "LaTeX", buffer(), os,
                                       *(runparams.exportdata),
                                       external_in_tmpdir,
                                       dryrun);
 }
 
 
-int InsetExternal::plaintext(Buffer const & buf, odocstream & os,
+int InsetExternal::plaintext(odocstream & os,
                             OutputParams const & runparams) const
 {
        os << '\n'; // output external material on a new line
-       external::writeExternal(params_, "Ascii", buf, os,
+       external::writeExternal(params_, "Ascii", buffer(), os,
                                *(runparams.exportdata), false,
                                runparams.dryrun || runparams.inComment);
        return PLAINTEXT_NEWLINE;
 }
 
 
-int InsetExternal::docbook(Buffer const & buf, odocstream & os,
+int InsetExternal::docbook(odocstream & os,
                           OutputParams const & runparams) const
 {
-       return external::writeExternal(params_, "DocBook", buf, os,
+       return external::writeExternal(params_, "DocBook", buffer(), os,
                                       *(runparams.exportdata), false,
                                       runparams.dryrun || runparams.inComment);
 }
@@ -829,112 +861,58 @@ void InsetExternal::validate(LaTeXFeatures & features) const
 }
 
 
-//
-// preview stuff
-//
-
-namespace {
-
-bool preview_wanted(InsetExternalParams const & params)
-{
-       return params.display == external::PreviewDisplay &&
-               params.filename.isReadableFile();
-}
-
-
-docstring const latex_string(InsetExternal const & inset, Buffer const & buffer)
-{
-       odocstringstream os;
-       // We don't need to set runparams.encoding since it is not used by
-       // latex().
-       OutputParams runparams(0);
-       runparams.flavor = OutputParams::LATEX;
-       inset.latex(buffer, os, runparams);
-       return os.str();
-}
-
-
-void add_preview_and_start_loading(RenderMonitoredPreview & renderer,
-                                  InsetExternal const & inset,
-                                  Buffer const & buffer)
-{
-       InsetExternalParams const & params = inset.params();
-
-       if (RenderPreview::status() != LyXRC::PREVIEW_OFF &&
-           preview_wanted(params)) {
-               renderer.setAbsFile(params.filename);
-               docstring const snippet = latex_string(inset, buffer);
-               renderer.addPreview(snippet, buffer);
-               renderer.startLoading(buffer);
-       }
-}
-
-} // namespace anon
-
-
 void InsetExternal::addPreview(graphics::PreviewLoader & ploader) const
 {
        RenderMonitoredPreview * const ptr = renderer_->asMonitoredPreview();
        if (!ptr)
                return;
 
-       if (preview_wanted(params())) {
+       if (isPreviewWanted(params())) {
                ptr->setAbsFile(params_.filename);
-               docstring const snippet = latex_string(*this, ploader.buffer());
+               docstring const snippet = latexString(*this);
                ptr->addPreview(snippet, ploader);
        }
 }
 
 
-/// Mailer stuff
-
-string const InsetExternalMailer::name_("external");
-
-InsetExternalMailer::InsetExternalMailer(InsetExternal & inset)
-       : inset_(inset)
-{}
-
-
-string const InsetExternalMailer::inset2string(Buffer const & buffer) const
-{
-       return params2string(inset_.params(), buffer);
-}
-
-
-void InsetExternalMailer::string2params(string const & in,
-                                       Buffer const & buffer,
-                                       InsetExternalParams & params)
+void InsetExternal::string2params(string const & in, Buffer const & buffer,
+       InsetExternalParams & params)
 {
        params = InsetExternalParams();
        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("InsetExternalMailer", in, 1, name_);
+       if (!lex || name != "external") {
+               LYXERR0("InsetExternal::string2params(" << in << ")\n"
+                                         "Expected arg 1 to be \"external\"\n");
+               return;
+       }
 
        // This is part of the inset proper that is usually swallowed
        // by Text::readInset
        string id;
        lex >> id;
-       if (!lex || id != "External")
-               return print_mailer_error("InsetBoxMailer", in, 2, "External");
+       if (!lex || id != "External") {
+               LYXERR0("InsetExternal::string2params(" << in << ")\n"
+                                         "Expected arg 2 to be \"External\"\n");
+               return;
+       }
 
        params.read(buffer, lex);
 }
 
 
-string const
-InsetExternalMailer::params2string(InsetExternalParams const & params,
-                                  Buffer const & buffer)
+string InsetExternal::params2string(InsetExternalParams const & params,
+       Buffer const & buffer)
 {
        ostringstream data;
-       data << name_ << ' ';
+       data << "external" << ' ';
        params.write(buffer, data);
        data << "\\end_inset\n";
        return data.str();