This should be the last of the commits refactoring the InsetLayout code.

[lyx.git] / src / insets / InsetInclude.h

diff --git a/src/insets/InsetInclude.h b/src/insets/InsetInclude.h
index 1f79e2f4163806208dcac25c12ebea0ff6fe516f..6675a4bf2550b59f99fe8945476f72575fd27a66 100644 (file)
--- a/src/insets/InsetInclude.h
+++ b/src/insets/InsetInclude.h
@@ -5,6 +5,7 @@
  * Licence details can be found in the file COPYING.
  *
  * \author Lars Gullik Bjønnes
+ * \author Richard Heck (conversion to InsetCommand)
  *
  * Full author contact details are available in file CREDITS.
  */
@@ -12,12 +13,13 @@
 #ifndef INSET_INCLUDE_H
 #define INSET_INCLUDE_H
 
-#include "Inset.h"
+#include "BiblioInfo.h"
+#include "InsetCommand.h"
 #include "InsetCommandParams.h"
 #include "RenderButton.h"
 #include "MailInset.h"
-
-#include "support/FileName.h"
+#include "Counters.h"
+#include "EmbeddedFiles.h"
 
 #include <boost/scoped_ptr.hpp>
 
@@ -28,26 +30,20 @@ class Dimension;
 class LaTeXFeatures;
 class RenderMonitoredPreview;
 
-
 /// for including tex/lyx files
-class InsetInclude : public InsetOld {
+class InsetInclude : public InsetCommand {
 public:
        ///
        InsetInclude(InsetCommandParams const &);
-       ~InsetInclude();
 
        /// Override these InsetButton methods if Previewing
-       bool metrics(MetricsInfo & mi, Dimension & dim) const;
+       void metrics(MetricsInfo & mi, Dimension & dim) const;
        ///
        void draw(PainterInfo & pi, int x, int y) const;
        ///
-       virtual bool display() const;
-
-       /// get the parameters
-       InsetCommandParams const & params() const;
-
+       virtual DisplayType display() const;
        ///
-       InsetBase::Code lyxCode() const { return InsetBase::INCLUDE_CODE; }
+       InsetCode lyxCode() const { return INCLUDE_CODE; }
        /** Fills \c list
         *  \param buffer the Buffer containing this inset.
         *  \param list the list of labels in the child buffer.
@@ -57,9 +53,11 @@ public:
        /** Fills \c keys
         *  \param buffer the Buffer containing this inset.
         *  \param keys the list of bibkeys in the child buffer.
+        *  \param it not used here
         */
-       void fillWithBibKeys(Buffer const & buffer,
-               std::vector<std::pair<std::string, docstring> > & keys) const;
+       virtual void fillWithBibKeys(Buffer const & buffer,
+               BiblioInfo & keys, InsetIterator const & it) const;
+       
        /** Update the cache with all bibfiles in use of the child buffer
         *  (including bibfiles of grandchild documents).
         *  Does nothing if the child document is not loaded to prevent
@@ -72,58 +70,53 @@ public:
         *  Return an empty vector if the child doc is not loaded.
         *  \param buffer the Buffer containing this inset.
         */
-       std::vector<support::FileName> const &
-       getBibfilesCache(Buffer const & buffer) const;
+       EmbeddedFileList const &
+               getBibfilesCache(Buffer const & buffer) const;
        ///
        EDITABLE editable() const { return IS_EDITABLE; }
        ///
-       void write(Buffer const &, std::ostream &) const;
-       ///
-       void read(Buffer const &, Lexer &);
-       ///
        int latex(Buffer const &, odocstream &,
-                 OutputParams const &) const;
+                 OutputParams const &) const;
        ///
        int plaintext(Buffer const &, odocstream &,
-                     OutputParams const &) const;
+                     OutputParams const &) const;
        ///
        int docbook(Buffer const &, odocstream &,
-                   OutputParams const &) const;
+                   OutputParams const &) const;
        ///
        void validate(LaTeXFeatures &) const;
        ///
        void addPreview(graphics::PreviewLoader &) const;
        ///
-       void addToToc(TocList &, Buffer const &) const;
+       void addToToc(Buffer const &, ParConstIterator const &) const;
+       ///
+       void updateLabels(Buffer const & buffer, ParIterator const &);
+       /// child document can be embedded
+       void registerEmbeddedFiles(Buffer const &, EmbeddedFileList &) const;
        ///
-       void updateLabels(Buffer const & buffer) const;
+       void updateEmbeddedFile(Buffer const & buf, EmbeddedFile const & file);
        ///
-       bool getStatus(LCursor &, FuncRequest const &, FuncStatus &) const;
+       static CommandInfo const * findInfo(std::string const &);
+       ///
+       static std::string defaultCommand() { return "include"; };
+       ///
+       static bool isCompatibleCommand(std::string const & s);
 protected:
        InsetInclude(InsetInclude const &);
        ///
-       virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
+       virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
 private:
-       virtual std::auto_ptr<InsetBase> doClone() const;
+       virtual Inset * clone() const;
 
        /** Slot receiving a signal that the external file has changed
         *  and the preview should be regenerated.
         */
        void fileChanged() const;
 
-       friend class InsetIncludeMailer;
-
        /// set the parameters
        void set(InsetCommandParams const & params, Buffer const &);
        /// get the text displayed on the button
        docstring const getScreenLabel(Buffer const &) const;
-       ///
-       void write(std::ostream &) const;
-       ///
-       void read(Lexer &);
-
-       /// the parameters
-       InsetCommandParams params_;
        /// holds the entity name that defines the file location (SGML)
        docstring const include_label;
 
@@ -133,30 +126,18 @@ private:
        /// cache
        mutable bool set_label_;
        mutable RenderButton button_;
+       mutable docstring listings_label_;
 };
 
+/// return the child buffer if the file is a LyX doc and is loaded
+Buffer * getChildBuffer(Buffer const & buffer, InsetCommandParams const & params);
+       
+/// return loaded Buffer or zero if the file loading did not proceed.
+Buffer * loadIfNeeded(Buffer const & parent, InsetCommandParams const & params);
 
-class InsetIncludeMailer : public MailInset {
-public:
-       ///
-       InsetIncludeMailer(InsetInclude & inset);
-       ///
-       virtual InsetBase & inset() const { return inset_; }
-       ///
-       virtual std::string const & name() const { return name_; }
-       ///
-       virtual std::string const inset2string(Buffer const &) const;
-       ///
-       static void string2params(std::string const &, InsetCommandParams &);
-       ///
-       static std::string const params2string(InsetCommandParams const &);
-private:
-       ///
-       static std::string const name_;
-       ///
-       InsetInclude & inset_;
-};
-
+///
+void resetParentBuffer(Buffer const * parent, InsetCommandParams const & params,
+       bool close_it);
 
 } // namespace lyx