]> git.lyx.org Git - lyx.git/blobdiff - src/insets/insetinclude.C
The speed patch: redraw only rows that have changed
[lyx.git] / src / insets / insetinclude.C
index db89cc757cdf43996d9b8a133f89d6db8f43bef0..5afd3f382273c667b96711b17879f2b54c472540 100644 (file)
 #include "bufferlist.h"
 #include "bufferparams.h"
 #include "BufferView.h"
+#include "cursor.h"
 #include "debug.h"
 #include "dispatchresult.h"
+#include "exporter.h"
 #include "funcrequest.h"
+#include "FuncStatus.h"
 #include "gettext.h"
 #include "LaTeXFeatures.h"
 #include "lyx_main.h"
+#include "lyxrc.h"
 #include "lyxlex.h"
 #include "metricsinfo.h"
 #include "outputparams.h"
 
+#include "frontends/Alert.h"
 #include "frontends/LyXView.h"
 #include "frontends/Painter.h"
 
+#include "graphics/PreviewImage.h"
 #include "graphics/PreviewLoader.h"
 
 #include "insets/render_preview.h"
 
-#include "support/FileInfo.h"
+#include "support/filename.h"
 #include "support/filetools.h"
 #include "support/lstrings.h" // contains
-#include "support/tostr.h"
+#include "support/lyxlib.h"
+#include "support/convert.h"
 
 #include <boost/bind.hpp>
+#include <boost/filesystem/operations.hpp>
 
 #include "support/std_ostream.h"
-#include "support/std_sstream.h"
+
+#include <sstream>
 
 using lyx::support::AddName;
+using lyx::support::AbsolutePath;
+using lyx::support::bformat;
 using lyx::support::ChangeExtension;
 using lyx::support::contains;
-using lyx::support::FileInfo;
+using lyx::support::copy;
+using lyx::support::FileName;
 using lyx::support::GetFileContents;
 using lyx::support::IsFileReadable;
 using lyx::support::IsLyXFilename;
+using lyx::support::latex_path;
 using lyx::support::MakeAbsPath;
 using lyx::support::MakeDisplayPath;
+using lyx::support::MakeRelPath;
 using lyx::support::OnlyFilename;
 using lyx::support::OnlyPath;
 using lyx::support::subst;
+using lyx::support::sum;
 
 using std::endl;
 using std::string;
@@ -64,6 +79,7 @@ using std::istringstream;
 using std::ostream;
 using std::ostringstream;
 
+namespace fs = boost::filesystem;
 
 extern BufferList bufferlist;
 
@@ -73,7 +89,7 @@ namespace {
 string const uniqueID()
 {
        static unsigned int seed = 1000;
-       return "file" + tostr(++seed);
+       return "file" + convert<string>(++seed);
 }
 
 } // namespace anon
@@ -81,10 +97,9 @@ string const uniqueID()
 
 InsetInclude::InsetInclude(InsetCommandParams const & p)
        : params_(p), include_label(uniqueID()),
-         preview_(new RenderMonitoredPreview),
+         preview_(new RenderMonitoredPreview(this)),
          set_label_(false)
 {
-       preview_->connect(boost::bind(&InsetInclude::statusChanged, this));
        preview_->fileChanged(boost::bind(&InsetInclude::fileChanged, this));
 }
 
@@ -93,51 +108,62 @@ InsetInclude::InsetInclude(InsetInclude const & other)
        : InsetOld(other),
          params_(other.params_),
          include_label(other.include_label),
-         preview_(new RenderMonitoredPreview),
-         set_label_(other.set_label_)
+         preview_(new RenderMonitoredPreview(this)),
+         set_label_(false)
 {
-       preview_->connect(boost::bind(&InsetInclude::statusChanged, this));
        preview_->fileChanged(boost::bind(&InsetInclude::fileChanged, this));
 }
 
 
 InsetInclude::~InsetInclude()
 {
-       InsetIncludeMailer mailer(*this);
-       mailer.hideDialog();
+       InsetIncludeMailer(*this).hideDialog();
 }
 
 
-DispatchResult
-InsetInclude::priv_dispatch(FuncRequest const & cmd, idx_type &, pos_type &)
+void InsetInclude::doDispatch(LCursor & cur, FuncRequest & cmd)
 {
        switch (cmd.action) {
 
        case LFUN_INSET_MODIFY: {
                InsetCommandParams p;
                InsetIncludeMailer::string2params(cmd.argument, p);
-               if (!p.getCmdName().empty()) {
-                       set(p, *cmd.view()->buffer());
-                       cmd.view()->updateInset(this);
-               }
-               return DispatchResult(true, true);
+               if (!p.getCmdName().empty())
+                       set(p, cur.buffer());
+               else
+                       cur.noUpdate();
+               break;
        }
 
        case LFUN_INSET_DIALOG_UPDATE:
-               InsetIncludeMailer(*this).updateDialog(cmd.view());
-               return DispatchResult(true, true);
+               InsetIncludeMailer(*this).updateDialog(&cur.bv());
+               break;
 
        case LFUN_MOUSE_RELEASE:
-               if (button_.box().contains(cmd.x, cmd.y))
-                       InsetIncludeMailer(*this).showDialog(cmd.view());
-               return DispatchResult(true, true);
+       case LFUN_INSET_DIALOG_SHOW:
+               InsetIncludeMailer(*this).showDialog(&cur.bv());
+               break;
+
+       default:
+               InsetBase::doDispatch(cur, cmd);
+               break;
+       }
+}
+
 
+bool InsetInclude::getStatus(LCursor & cur, FuncRequest const & cmd,
+               FuncStatus & flag) const
+{
+       switch (cmd.action) {
+
+       case LFUN_INSET_MODIFY:
+       case LFUN_INSET_DIALOG_UPDATE:
        case LFUN_INSET_DIALOG_SHOW:
-               InsetIncludeMailer(*this).showDialog(cmd.view());
-               return DispatchResult(true, true);
+               flag.enabled(true);
+               return true;
 
        default:
-               return DispatchResult(false);
+               return InsetBase::getStatus(cur, cmd, flag);
        }
 }
 
@@ -182,6 +208,12 @@ bool isVerbatim(InsetCommandParams const & params)
 
 
 string const masterFilename(Buffer const & buffer)
+{
+       return buffer.getMasterBuffer()->fileName();
+}
+
+
+string const parentFilename(Buffer const & buffer)
 {
        return buffer.fileName();
 }
@@ -191,7 +223,7 @@ string const includedFilename(Buffer const & buffer,
                              InsetCommandParams const & params)
 {
        return MakeAbsPath(params.getContents(),
-                          OnlyPath(masterFilename(buffer)));
+                          OnlyPath(parentFilename(buffer)));
 }
 
 
@@ -213,7 +245,7 @@ void InsetInclude::set(InsetCommandParams const & p, Buffer const & buffer)
 }
 
 
-auto_ptr<InsetBase> InsetInclude::clone() const
+auto_ptr<InsetBase> InsetInclude::doClone() const
 {
        return auto_ptr<InsetBase>(new InsetInclude(*this));
 }
@@ -228,7 +260,7 @@ void InsetInclude::write(Buffer const &, ostream & os) const
 void InsetInclude::write(ostream & os) const
 {
        os << "Include " << params_.getCommand() << '\n'
-          << "preview " << tostr(params_.preview()) << '\n';
+          << "preview " << convert<string>(params_.preview()) << '\n';
 }
 
 
@@ -278,15 +310,18 @@ bool loadIfNeeded(Buffer const & buffer, InsetCommandParams const & params)
        if (!IsLyXFilename(included_file))
                return false;
 
-       if (bufferlist.exists(included_file))
-               return true;
-
-       // the readonly flag can/will be wrong, not anymore I think.
-       FileInfo finfo(included_file);
-       if (!finfo.isOK())
-               return false;
-       return loadLyXFile(bufferlist.newBuffer(included_file),
-                          included_file);
+       Buffer * buf = bufferlist.getBuffer(included_file);
+       if (!buf) {
+               // the readonly flag can/will be wrong, not anymore I think.
+               if (!fs::exists(included_file))
+                       return false;
+               buf = bufferlist.newBuffer(included_file);
+               if (!loadLyXFile(buf, included_file))
+                       return false;
+       }
+       if (buf)
+               buf->setParentName(parentFilename(buffer));
+       return buf != 0;
 }
 
 
@@ -303,60 +338,99 @@ int InsetInclude::latex(Buffer const & buffer, ostream & os,
                return 0;
 
        string const included_file = includedFilename(buffer, params_);
+       Buffer const * const m_buffer = buffer.getMasterBuffer();
+
+       // if incfile is relative, make it relative to the master
+       // buffer directory.
+       if (!AbsolutePath(incfile)) {
+               incfile = MakeRelPath(included_file,
+                                     m_buffer->filePath());
+       }
+
+       // write it to a file (so far the complete file)
+       string const exportfile = ChangeExtension(incfile, ".tex");
+       string const mangled = FileName(ChangeExtension(included_file,
+                                                       ".tex")).mangledFilename();
+       string const writefile = MakeAbsPath(mangled, m_buffer->temppath());
+
+       if (!runparams.nice)
+               incfile = mangled;
+       lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
+       lyxerr[Debug::LATEX] << "exportfile:" << exportfile << endl;
+       lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
 
        if (loadIfNeeded(buffer, params_)) {
                Buffer * tmp = bufferlist.getBuffer(included_file);
 
-               // FIXME: this should be a GUI warning
-               if (tmp->params().textclass != buffer.params().textclass) {
-                       lyxerr << "WARNING: Included file `"
-                              << MakeDisplayPath(included_file)
-                              << "' has textclass `"
-                              << tmp->params().getLyXTextClass().name()
-                              << "' while parent file has textclass `"
-                              << buffer.params().getLyXTextClass().name()
-                              << "'." << endl;
+               if (tmp->params().textclass != m_buffer->params().textclass) {
+                       string text = bformat(_("Included file `%1$s'\n"
+                                               "has textclass `%2$s'\n"
+                                               "while parent file has textclass `%3$s'."),
+                                             MakeDisplayPath(included_file),
+                                             tmp->params().getLyXTextClass().name(),
+                                             m_buffer->params().getLyXTextClass().name());
+                       Alert::warning(_("Different textclasses"), text);
                        //return 0;
                }
 
-               // write it to a file (so far the complete file)
-               string writefile = ChangeExtension(included_file, ".tex");
+               tmp->markDepClean(m_buffer->temppath());
 
-               if (!buffer.temppath().empty() && !runparams.nice) {
-                       incfile = subst(incfile, '/','@');
-#ifdef __EMX__
-                       incfile = subst(incfile, ':', '$');
+#ifdef WITH_WARNINGS
+#warning Second argument is irrelevant!
+// since only_body is true, makeLaTeXFile will not look at second
+// argument. Should we set it to string(), or should makeLaTeXFile
+// make use of it somehow? (JMarc 20031002)
 #endif
-                       writefile = AddName(buffer.temppath(), incfile);
-               } else
-                       writefile = included_file;
-               writefile = ChangeExtension(writefile, ".tex");
-               lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
-               lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
-
-               tmp->markDepClean(buffer.temppath());
-
                tmp->makeLaTeXFile(writefile,
                                   OnlyPath(masterFilename(buffer)),
                                   runparams, false);
+       } else {
+               // Copy the file to the temp dir, so that .aux files etc.
+               // are not created in the original dir. Files included by
+               // this file will be found via input@path, see ../buffer.C.
+               unsigned long const checksum_in  = sum(included_file);
+               unsigned long const checksum_out = sum(writefile);
+
+               if (checksum_in != checksum_out) {
+                       if (!copy(included_file, writefile)) {
+                               lyxerr[Debug::LATEX]
+                                       << bformat(_("Could not copy the file\n%1$s\n"
+                                                    "into the temporary directory."),
+                                                  included_file)
+                                       << endl;
+                               return 0;
+                       }
+               }
        }
 
        if (isVerbatim(params_)) {
+               incfile = latex_path(incfile);
                os << '\\' << params_.getCmdName() << '{' << incfile << '}';
        } else if (type(params_) == INPUT) {
+               runparams.exportdata->addExternalFile("latex", writefile,
+                                                     exportfile);
+
                // \input wants file with extension (default is .tex)
                if (!IsLyXFilename(included_file)) {
+                       incfile = latex_path(incfile);
                        os << '\\' << params_.getCmdName() << '{' << incfile << '}';
                } else {
+               incfile = ChangeExtension(incfile, ".tex");
+               incfile = latex_path(incfile);
                        os << '\\' << params_.getCmdName() << '{'
-                          << ChangeExtension(incfile, ".tex")
+                          << incfile
                           <<  '}';
                }
        } else {
+               runparams.exportdata->addExternalFile("latex", writefile,
+                                                     exportfile);
+
                // \include don't want extension and demands that the
                // file really have .tex
+               incfile = ChangeExtension(incfile, string());
+               incfile = latex_path(incfile);
                os << '\\' << params_.getCmdName() << '{'
-                  << ChangeExtension(incfile, string())
+                  << incfile
                   << '}';
        }
 
@@ -384,34 +458,34 @@ int InsetInclude::linuxdoc(Buffer const & buffer, ostream & os,
 
        string const included_file = includedFilename(buffer, params_);
 
+       // write it to a file (so far the complete file)
+       string const exportfile = ChangeExtension(incfile, ".sgml");
+       string writefile = ChangeExtension(included_file, ".sgml");
+
        if (loadIfNeeded(buffer, params_)) {
                Buffer * tmp = bufferlist.getBuffer(included_file);
 
-               // write it to a file (so far the complete file)
-               string writefile = ChangeExtension(included_file, ".sgml");
-               if (!buffer.temppath().empty() && !buffer.niceFile()) {
-                       incfile = subst(incfile, '/','@');
-                       writefile = AddName(buffer.temppath(), incfile);
-               } else
-                       writefile = included_file;
-
-               if (IsLyXFilename(included_file))
-                       writefile = ChangeExtension(writefile, ".sgml");
+               writefile = MakeAbsPath(FileName(writefile).mangledFilename(),
+                                       buffer.getMasterBuffer()->temppath());
+               if (!runparams.nice)
+                       incfile = writefile;
 
                lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
+               lyxerr[Debug::LATEX] << "exportfile:" << exportfile << endl;
                lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
 
-               OutputParams runp = runparams;
-               runp.nice = buffer.niceFile();          
-               tmp->makeLinuxDocFile(writefile, runp, true);
+               tmp->makeLinuxDocFile(writefile, runparams, true);
        }
 
        if (isVerbatim(params_)) {
                os << "<![CDATA["
                   << GetFileContents(included_file)
                   << "]]>";
-       } else
+       } else {
+               runparams.exportdata->addExternalFile("linuxdoc", writefile,
+                                                     exportfile);
                os << '&' << include_label << ';';
+       }
 
        return 0;
 }
@@ -428,27 +502,31 @@ int InsetInclude::docbook(Buffer const & buffer, ostream & os,
 
        string const included_file = includedFilename(buffer, params_);
 
+       // write it to a file (so far the complete file)
+       string const exportfile = ChangeExtension(incfile, ".sgml");
+       string writefile = ChangeExtension(included_file, ".sgml");
+
        if (loadIfNeeded(buffer, params_)) {
                Buffer * tmp = bufferlist.getBuffer(included_file);
 
-               // write it to a file (so far the complete file)
-               string writefile = ChangeExtension(included_file, ".sgml");
-               if (!buffer.temppath().empty() && !buffer.niceFile()) {
-                       incfile = subst(incfile, '/','@');
-                       writefile = AddName(buffer.temppath(), incfile);
-               } else
-                       writefile = included_file;
-               if (IsLyXFilename(included_file))
-                       writefile = ChangeExtension(writefile, ".sgml");
+               string const mangled = FileName(writefile).mangledFilename();
+               writefile = MakeAbsPath(mangled,
+                                       buffer.getMasterBuffer()->temppath());
+               if (!runparams.nice)
+                       incfile = mangled;
 
                lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
+               lyxerr[Debug::LATEX] << "exportfile:" << exportfile << endl;
                lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
 
-               OutputParams runp = runparams;
-               runp.nice = buffer.niceFile();
-               tmp->makeDocBookFile(writefile, runp, true);
+               tmp->makeDocBookFile(writefile, runparams, true);
        }
 
+       runparams.exportdata->addExternalFile("docbook", writefile,
+                                             exportfile);
+       runparams.exportdata->addExternalFile("docbook-xml", writefile,
+                                             exportfile);
+
        if (isVerbatim(params_)) {
                os << "<inlinegraphic fileref=\""
                   << '&' << include_label << ';'
@@ -469,16 +547,16 @@ void InsetInclude::validate(LaTeXFeatures & features) const
 
        string const included_file = includedFilename(buffer, params_);
 
-       if (!buffer.temppath().empty() &&
-           !buffer.niceFile() &&
-           !isVerbatim(params_)) {
-               incfile = subst(incfile, '/','@');
-               writefile = AddName(buffer.temppath(), incfile);
-       } else
+       if (IsLyXFilename(included_file))
+               writefile = ChangeExtension(included_file, ".sgml");
+       else
                writefile = included_file;
 
-       if (IsLyXFilename(included_file))
-               writefile = ChangeExtension(writefile, ".sgml");
+       if (!features.nice() && !isVerbatim(params_)) {
+               incfile = FileName(writefile).mangledFilename();
+               writefile = MakeAbsPath(incfile,
+                                       buffer.getMasterBuffer()->temppath());
+       }
 
        features.includeFile(include_label, writefile);
 
@@ -492,8 +570,12 @@ void InsetInclude::validate(LaTeXFeatures & features) const
                // a file got loaded
                Buffer * const tmp = bufferlist.getBuffer(included_file);
                if (tmp) {
-                       tmp->niceFile() = buffer.niceFile();
+                       // We must temporarily change features.buffer,
+                       // otherwise it would always be the master buffer,
+                       // and nested includes would not work.
+                       features.setBuffer(*tmp);
                        tmp->validate(features);
+                       features.setBuffer(buffer);
                }
        }
 }
@@ -507,7 +589,7 @@ void InsetInclude::getLabelList(Buffer const & buffer,
                Buffer * tmp = bufferlist.getBuffer(included_file);
                tmp->setParentName("");
                tmp->getLabelList(list);
-               tmp->setParentName(masterFilename(buffer));
+               tmp->setParentName(parentFilename(buffer));
        }
 }
 
@@ -520,54 +602,70 @@ void InsetInclude::fillWithBibKeys(Buffer const & buffer,
                Buffer * tmp = bufferlist.getBuffer(included_file);
                tmp->setParentName("");
                tmp->fillWithBibKeys(keys);
-               tmp->setParentName(masterFilename(buffer));
+               tmp->setParentName(parentFilename(buffer));
        }
 }
 
 
 void InsetInclude::metrics(MetricsInfo & mi, Dimension & dim) const
 {
-       if (RenderPreview::activated() && preview_->previewReady()) {
+       BOOST_ASSERT(mi.base.bv && mi.base.bv->buffer());
+
+       bool use_preview = false;
+       if (RenderPreview::status() != LyXRC::PREVIEW_OFF) {
+               lyx::graphics::PreviewImage const * pimage =
+                       preview_->getPreviewImage(*mi.base.bv->buffer());
+               use_preview = pimage && pimage->image();
+       }
+
+       if (use_preview) {
                preview_->metrics(mi, dim);
        } else {
                if (!set_label_) {
                        set_label_ = true;
                        button_.update(getScreenLabel(*mi.base.bv->buffer()),
-                                      editable() != NOT_EDITABLE);
+                                      true);
                }
                button_.metrics(mi, dim);
        }
-       int center_indent = type(params_) == INPUT ?
-               0 : (mi.base.textwidth - dim.wid) / 2;
-       Box b(center_indent, center_indent + dim.wid, -dim.asc, dim.des);
+
+       Box b(0, dim.wid, -dim.asc, dim.des);
        button_.setBox(b);
 
-       dim.wid = mi.base.textwidth;
        dim_ = dim;
 }
 
 
 void InsetInclude::draw(PainterInfo & pi, int x, int y) const
 {
-       if (!RenderPreview::activated() || !preview_->previewReady()) {
-               button_.draw(pi, x + button_.box().x1, y);
-               return;
+       setPosCache(pi, x, y);
+
+       BOOST_ASSERT(pi.base.bv && pi.base.bv->buffer());
+
+       bool use_preview = false;
+       if (RenderPreview::status() != LyXRC::PREVIEW_OFF) {
+               lyx::graphics::PreviewImage const * pimage =
+                       preview_->getPreviewImage(*pi.base.bv->buffer());
+               use_preview = pimage && pimage->image();
        }
 
-       preview_->draw(pi, x + button_.box().x1, y);
+       if (use_preview)
+               preview_->draw(pi, x, y);
+       else
+               button_.draw(pi, x, y);
+}
+
+bool InsetInclude::display() const
+{
+       return type(params_) != INPUT;
 }
 
 
+
 //
 // preview stuff
 //
 
-void InsetInclude::statusChanged() const
-{
-       LyX::cref().updateInset(this);
-}
-
-
 void InsetInclude::fileChanged() const
 {
        Buffer const * const buffer_ptr = LyX::cref().updateInset(this);
@@ -607,7 +705,8 @@ void add_preview(RenderMonitoredPreview & renderer, InsetInclude const & inset,
                 Buffer const & buffer)
 {
        InsetCommandParams const & params = inset.params();
-       if (RenderPreview::activated() && preview_wanted(params, buffer)) {
+       if (RenderPreview::status() != LyXRC::PREVIEW_OFF &&
+           preview_wanted(params, buffer)) {
                renderer.setAbsFile(includedFilename(buffer, params));
                string const snippet = latex_string(inset, buffer);
                renderer.addPreview(snippet, buffer);
@@ -645,7 +744,6 @@ void InsetIncludeMailer::string2params(string const & in,
                                       InsetCommandParams & params)
 {
        params = InsetCommandParams();
-
        if (in.empty())
                return;
 
@@ -653,27 +751,21 @@ void InsetIncludeMailer::string2params(string const & in,
        LyXLex lex(0,0);
        lex.setStream(data);
 
-       if (lex.isOK()) {
-               lex.next();
-               string const token = lex.getString();
-               if (token != name_)
-                       return;
-       }
+       string name;
+       lex >> name;
+       if (!lex || name != name_)
+               return print_mailer_error("InsetIncludeMailer", in, 1, name_);
 
        // 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;
-       }
+       // by LyXText::readInset
+       string id;
+       lex >> id;
+       if (!lex || id != "Include")
+               return print_mailer_error("InsetIncludeMailer", in, 2, "Include");
 
-       if (lex.isOK()) {
-               InsetInclude inset(params);
-               inset.read(lex);
-               params = inset.params();
-       }
+       InsetInclude inset(params);
+       inset.read(lex);
+       params = inset.params();
 }