]> git.lyx.org Git - lyx.git/blobdiff - src/insets/insetinclude.C
Rename LatexRunParams::fragile as moving_arg.
[lyx.git] / src / insets / insetinclude.C
index 008d510e0dfecae68a69ba175d5574cd83f17ef3..5af3b2ccb7d4eb200c42001885ca3059d2effc6f 100644 (file)
@@ -1,28 +1,45 @@
-#include <config.h>
+/**
+ * \file insetinclude.C
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
+ *
+ * \author Lars Gullik Bjønnes
+ *
+ * Full author contact details are available in file CREDITS
+ */
 
-#ifdef __GNUG__
-#pragma implementation
-#endif
+#include <config.h>
 
 #include "insetinclude.h"
 #include "buffer.h"
 #include "bufferlist.h"
 #include "BufferView.h"
 #include "debug.h"
-#include "lyxrc.h"
-#include "frontends/LyXView.h"
-#include "LaTeXFeatures.h"
+#include "funcrequest.h"
 #include "gettext.h"
-#include "lyxtextclasslist.h"
+#include "LaTeXFeatures.h"
+#include "latexrunparams.h"
+#include "Lsstream.h"
+#include "lyxlex.h"
+#include "lyxrc.h"
+#include "Lsstream.h"
 
 #include "frontends/Dialogs.h"
+#include "frontends/LyXView.h"
+#include "frontends/Painter.h"
 
 #include "support/filetools.h"
 #include "support/FileInfo.h"
-#include "support/lstrings.h"
+#include "support/FileMonitor.h"
+#include "support/lstrings.h" // contains
+#include "support/tostr.h"
 
-#include <cstdlib>
+#include "graphics/PreviewedInset.h"
+#include "graphics/PreviewImage.h"
 
+#include <boost/bind.hpp>
+
+#include <cstdlib>
 
 using std::ostream;
 using std::endl;
@@ -31,29 +48,56 @@ using std::pair;
 
 extern BufferList bufferlist;
 
+
+class InsetInclude::PreviewImpl : public grfx::PreviewedInset {
+public:
+       ///
+       PreviewImpl(InsetInclude & p) : PreviewedInset(p) {}
+
+       ///
+       bool previewWanted() const;
+       ///
+       string const latexString() const;
+       ///
+       InsetInclude & parent() const {
+               return *static_cast<InsetInclude*>(inset());
+       }
+
+       ///
+       bool monitoring() const { return monitor_.get(); }
+       ///
+       void startMonitoring();
+       ///
+       void stopMonitoring() { monitor_.reset(); }
+
+private:
+       /// Invoked by monitor_ should the parent file change.
+       void restartLoading();
+       ///
+       boost::scoped_ptr<FileMonitor> monitor_;
+};
+
+
 namespace {
 
 string const uniqueID()
 {
        static unsigned int seed = 1000;
-
-       ostringstream ost;
-       ost << "file" << ++seed;
-
-       // Needed if we use lyxstring.
-       return ost.str().c_str();
+       return "file" + tostr(++seed);
 }
 
 } // namespace anon
 
 
 InsetInclude::InsetInclude(Params const & p)
-       : params_(p), include_label(uniqueID())
+       : params_(p), include_label(uniqueID()),
+         preview_(new PreviewImpl(*this))
 {}
 
 
 InsetInclude::InsetInclude(InsetCommandParams const & p, Buffer const & b)
-       : include_label(uniqueID())
+       : include_label(uniqueID()),
+         preview_(new PreviewImpl(*this))
 {
        params_.cparams = p;
        params_.masterFilename_ = b.fileName();
@@ -62,7 +106,38 @@ InsetInclude::InsetInclude(InsetCommandParams const & p, Buffer const & b)
 
 InsetInclude::~InsetInclude()
 {
-       hideDialog();
+       InsetIncludeMailer mailer(*this);
+       mailer.hideDialog();
+}
+
+
+dispatch_result InsetInclude::localDispatch(FuncRequest const & cmd)
+{
+       switch (cmd.action) {
+
+       case LFUN_INSET_MODIFY: {
+               InsetInclude::Params p;
+               InsetIncludeMailer::string2params(cmd.argument, p);
+               if (!p.cparams.getCmdName().empty()) {
+                       set(p);
+                       params_.masterFilename_ = cmd.view()->buffer()->fileName();
+                       cmd.view()->updateInset(this);
+               }
+               return DISPATCHED;
+       }
+
+       case LFUN_INSET_DIALOG_UPDATE: 
+               InsetIncludeMailer(*this).updateDialog(cmd.view());
+               return DISPATCHED;
+
+       case LFUN_MOUSE_RELEASE:
+       case LFUN_INSET_EDIT:
+               InsetIncludeMailer(*this).showDialog(cmd.view());
+               return DISPATCHED;
+
+       default:
+               return UNDISPATCHED;
+       }
 }
 
 
@@ -74,11 +149,8 @@ InsetInclude::Params const & InsetInclude::params() const
 
 bool InsetInclude::Params::operator==(Params const & o) const
 {
-       if (cparams == o.cparams && flag == o.flag &&
-           noload == o.noload && masterFilename_ == o.masterFilename_)
-               return true;
-
-       return false;
+       return cparams == o.cparams && flag == o.flag &&
+           masterFilename_ == o.masterFilename_;
 }
 
 
@@ -92,7 +164,6 @@ void InsetInclude::set(Params const & p)
 {
        params_ = p;
 
-       // Just to be safe...
        string command;
 
        switch (params_.flag) {
@@ -111,6 +182,12 @@ void InsetInclude::set(Params const & p)
        }
 
        params_.cparams.setCmdName(command);
+
+       if (preview_->monitoring())
+               preview_->stopMonitoring();
+
+       if (grfx::PreviewedInset::activated() && params_.flag == INPUT)
+               preview_->generatePreview();
 }
 
 
@@ -123,21 +200,10 @@ Inset * InsetInclude::clone(Buffer const & buffer, bool) const
 }
 
 
-void InsetInclude::edit(BufferView * bv, int, int, mouse_button::state)
-{
-       bv->owner()->getDialogs()->showInclude(this);
-}
-
-
-void InsetInclude::edit(BufferView * bv, bool)
-{
-       edit(bv, 0, 0, mouse_button::none);
-}
-
-
 void InsetInclude::write(Buffer const *, ostream & os) const
 {
-       os << "Include " << params_.cparams.getCommand() << "\n";
+       os << "Include " << params_.cparams.getCommand() << '\n'
+          << "preview " << tostr(params_.cparams.preview()) << '\n';
 }
 
 
@@ -186,12 +252,6 @@ string const InsetInclude::getScreenLabel(Buffer const *) const
 }
 
 
-string const InsetInclude::getRelFileBaseName() const
-{
-       return OnlyFilename(ChangeExtension(params_.cparams.getContents(), string()));
-}
-
-
 string const InsetInclude::getFileName() const
 {
        return MakeAbsPath(params_.cparams.getContents(),
@@ -207,7 +267,7 @@ string const InsetInclude::getMasterFilename() const
 
 bool InsetInclude::loadIfNeeded() const
 {
-       if (params_.noload || isVerbatim())
+       if (isVerbatim())
                return false;
 
        if (!IsLyXFilename(getFileName()))
@@ -221,12 +281,12 @@ bool InsetInclude::loadIfNeeded() const
        if (!finfo.isOK())
                return false;
 
-       return bufferlist.readFile(getFileName(), !finfo.writable()) != 0;
+       return bufferlist.loadLyXFile(getFileName(), false) != 0;
 }
 
 
 int InsetInclude::latex(Buffer const * buffer, ostream & os,
-                       bool /*fragile*/, bool /*fs*/) const
+                       LatexRunParams const & runparams) const
 {
        string incfile(params_.cparams.getContents());
 
@@ -242,9 +302,9 @@ int InsetInclude::latex(Buffer const * buffer, ostream & os,
                        lyxerr << "WARNING: Included file `"
                               << MakeDisplayPath(getFileName())
                               << "' has textclass `"
-                              << textclasslist[tmp->params.textclass].name()
+                              << tmp->params.getLyXTextClass().name()
                               << "' while parent file has textclass `"
-                              << textclasslist[buffer->params.textclass].name()
+                              << buffer->params.getLyXTextClass().name()
                               << "'." << endl;
                        //return 0;
                }
@@ -252,8 +312,7 @@ int InsetInclude::latex(Buffer const * buffer, ostream & os,
                // write it to a file (so far the complete file)
                string writefile = ChangeExtension(getFileName(), ".tex");
 
-               if (!buffer->tmppath.empty()
-                   && !buffer->niceFile) {
+               if (!buffer->tmppath.empty() && !runparams.nice) {
                        incfile = subst(incfile, '/','@');
 #ifdef __EMX__
                        incfile = subst(incfile, ':', '$');
@@ -267,9 +326,8 @@ int InsetInclude::latex(Buffer const * buffer, ostream & os,
 
                tmp->markDepClean(buffer->tmppath);
 
-               tmp->makeLaTeXFile(writefile,
-                                  OnlyPath(getMasterFilename()),
-                                  buffer->niceFile, true);
+               tmp->makeLaTeXFile(writefile, OnlyPath(getMasterFilename()),
+                                  runparams, true);
        }
 
        if (isVerbatim()) {
@@ -342,7 +400,8 @@ int InsetInclude::linuxdoc(Buffer const * buffer, ostream & os) const
 }
 
 
-int InsetInclude::docbook(Buffer const * buffer, ostream & os) const
+int InsetInclude::docbook(Buffer const * buffer, ostream & os,
+                         bool /*mixcont*/) const
 {
        string incfile(params_.cparams.getContents());
 
@@ -432,16 +491,170 @@ vector<string> const InsetInclude::getLabelList() const
 }
 
 
-vector<pair<string,string> > const InsetInclude::getKeys() const
+void InsetInclude::fillWithBibKeys(vector<pair<string,string> > & keys) const
 {
-       vector<pair<string,string> > keys;
-
        if (loadIfNeeded()) {
                Buffer * tmp = bufferlist.getBuffer(getFileName());
                tmp->setParentName("");
-               keys = tmp->getBibkeyList();
+               tmp->fillWithBibKeys(keys);
                tmp->setParentName(getMasterFilename());
        }
+}
 
-       return keys;
+
+int InsetInclude::ascent(BufferView * bv, LyXFont const & font) const
+{
+       return preview_->previewReady() ?
+               preview_->pimage()->ascent() : InsetButton::ascent(bv, font);
+}
+
+
+int InsetInclude::descent(BufferView * bv, LyXFont const & font) const
+{
+       return preview_->previewReady() ?
+               preview_->pimage()->descent() : InsetButton::descent(bv, font);
+}
+
+
+int InsetInclude::width(BufferView * bv, LyXFont const & font) const
+{
+       return preview_->previewReady() ?
+               preview_->pimage()->width() : InsetButton::width(bv, font);
+}
+
+
+void InsetInclude::draw(BufferView * bv, LyXFont const & font, int y,
+                       float & xx) const
+{
+       cache(bv);
+       if (!preview_->previewReady()) {
+               InsetButton::draw(bv, font, y, xx);
+               return;
+       }
+
+       if (!preview_->monitoring())
+               preview_->startMonitoring();
+
+       int const x = int(xx);
+       int const w = width(bv, font);
+       int const d = descent(bv, font);
+       int const a = ascent(bv, font);
+       int const h = a + d;
+
+       bv->painter().image(x, y - a, w, h,
+                           *(preview_->pimage()->image()));
+
+       xx += w;
+}
+
+
+//
+// preview stuff
+//
+
+void InsetInclude::addPreview(grfx::PreviewLoader & ploader) const
+{
+       preview_->addPreview(ploader);
+}
+
+
+bool InsetInclude::PreviewImpl::previewWanted() const
+{
+       return parent().params_.flag == InsetInclude::INPUT &&
+               parent().params_.cparams.preview() &&
+               IsFileReadable(parent().getFileName());
+}
+
+
+string const InsetInclude::PreviewImpl::latexString() const
+{
+       if (!view() || !view()->buffer())
+               return string();
+
+       ostringstream os;
+       LatexRunParams runparams;
+       runparams.flavor = LatexRunParams::LATEX;
+       parent().latex(view()->buffer(), os, runparams);
+
+       return STRCONV(os.str());
+}
+
+
+void InsetInclude::PreviewImpl::startMonitoring()
+{
+       monitor_.reset(new FileMonitor(parent().getFileName(), 2000));
+       monitor_->connect(boost::bind(&PreviewImpl::restartLoading, this));
+       monitor_->start();
+}
+
+
+void InsetInclude::PreviewImpl::restartLoading()
+{
+       lyxerr << "restartLoading()" << std::endl;
+       removePreview();
+       if (view())
+               view()->updateInset(&parent());
+       generatePreview();
+}
+
+
+string const InsetIncludeMailer::name_("include");
+
+InsetIncludeMailer::InsetIncludeMailer(InsetInclude & inset)
+       : inset_(inset)
+{}
+
+
+string const InsetIncludeMailer::inset2string() const
+{
+       return params2string(inset_.params());
+}
+
+
+void InsetIncludeMailer::string2params(string const & in,
+                                      InsetInclude::Params & params)
+{
+       params = InsetInclude::Params();
+
+       if (in.empty())
+               return;
+       
+       istringstream data(STRCONV(in));
+       LyXLex lex(0,0);
+       lex.setStream(data);
+
+       if (lex.isOK()) {
+               lex.next();
+               string const token = lex.getString();
+               if (token != name_)
+                       return;
+       }
+
+       // This is part of the inset proper that is usually swallowed
+       // by Buffer::readInset
+       if (lex.isOK()) {
+               lex.next();
+               string const token = lex.getString();
+               if (token != "Include")
+                       return;
+       }
+
+       if (lex.isOK()) {
+               InsetInclude inset(params);
+               inset.read(0, lex);
+               params = inset.params();
+       }
+}
+
+
+string const
+InsetIncludeMailer::params2string(InsetInclude::Params const & params)
+{
+       InsetInclude inset(params);
+       inset.set(params);
+       ostringstream data;
+       data << name_ << ' ';
+       inset.write(0, data);
+       data << "\\end_inset\n";
+       return STRCONV(data.str());
 }