X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetInclude.h;h=d62c751abe785bd57754cd89f2e69cf770f36ebf;hb=8124e6c02ea1fd6779bb6c47ffe2bca2c8bd2d97;hp=b1973bd6c13a97567fe79f219700dcb7ad561f60;hpb=304f884930328612f9e1a014d79fbb4621253ecc;p=lyx.git diff --git a/src/insets/InsetInclude.h b/src/insets/InsetInclude.h index b1973bd6c1..d62c751abe 100644 --- a/src/insets/InsetInclude.h +++ b/src/insets/InsetInclude.h @@ -5,7 +5,7 @@ * Licence details can be found in the file COPYING. * * \author Lars Gullik Bjønnes - * \author Richard Heck (conversion to InsetCommand) + * \author Richard Kimberly Heck (conversion to InsetCommand) * * Full author contact details are available in file CREDITS. */ @@ -15,48 +15,40 @@ #include "InsetCommand.h" -#include "BiblioInfo.h" -#include "Counters.h" -#include "InsetCommandParams.h" -#include "RenderButton.h" +#include "support/unique_ptr.h" -#include "support/FileNameList.h" - -#include namespace lyx { class Buffer; class Dimension; +class InsetCommandParams; class InsetLabel; class LaTeXFeatures; class RenderMonitoredPreview; +namespace support { + class FileNameList; +} + /// for including tex/lyx files class InsetInclude : public InsetCommand { + // Disable assignment operator, since it is not used, and cannot be + // implemented consistently with the copy constructor, because + // include_label is const. + InsetInclude & operator=(InsetInclude const &); public: /// InsetInclude(Buffer * buf, InsetCommandParams const &); + /// ~InsetInclude(); - void setBuffer(Buffer & buffer); - bool isLabeled() const { return true; } - - /// Override these InsetButton methods if Previewing - void metrics(MetricsInfo & mi, Dimension & dim) const; - /// - void draw(PainterInfo & pi, int x, int y) const; - /// - DisplayType display() const; /// - InsetCode lyxCode() const { return INCLUDE_CODE; } - /** 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(BiblioInfo & keys, InsetIterator const & it) const; - + void setChildBuffer(Buffer * buffer); + + /// \return loaded Buffer or zero if the file loading did not proceed. + Buffer * loadIfNeeded() 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 @@ -64,33 +56,61 @@ public: * \param buffer the Buffer containing this inset. */ void updateBibfilesCache(); - /** Return the cache with all bibfiles in use of the child buffer - * (including bibfiles of grandchild documents). - * Return an empty vector if the child doc is not loaded. - * \param buffer the Buffer containing this inset. + + /// + void updateCommand(); + /// + void write(std::ostream &) const override; + + /// \name Public functions inherited from Inset class + //@{ + /// + void setBuffer(Buffer & buffer) override; + /// + bool isLabeled() const override { return true; } + /// + bool inheritFont() const override; + /// Override these InsetButton methods if Previewing + void metrics(MetricsInfo & mi, Dimension & dim) const override; + /// + void draw(PainterInfo & pi, int x, int y) const override; + /// + int rowFlags() const override; + /// + InsetCode lyxCode() const override { return INCLUDE_CODE; } + /// + docstring layoutName() const override; + /** Fills \c key + * \param keys the list of bibkeys in the child buffer. + * \param it not used here */ - support::FileNameList const & - getBibfilesCache() const; + void collectBibKeys(InsetIterator const &, support::FileNameList &) const override; /// - bool hasSettings() const { return true; } + bool hasSettings() const override { return true; } /// - int latex(odocstream &, OutputParams const &) const; + void latex(otexstream &, OutputParams const &) const override; /// - int plaintext(odocstream &, OutputParams const &) const; + int plaintext(odocstringstream & ods, OutputParams const & op, + size_t max_length = INT_MAX) const override; /// - int docbook(odocstream &, OutputParams const &) const; + void docbook(XMLStream &, OutputParams const &) const override; /// - docstring xhtml(XHTMLStream &, OutputParams const &) const; + docstring xhtml(XMLStream &, OutputParams const &) const override; /// - void validate(LaTeXFeatures &) const; + void validate(LaTeXFeatures &) const override; /// - void addPreview(DocIterator const &, graphics::PreviewLoader &) const; + void addPreview(DocIterator const &, graphics::PreviewLoader &) const override; /// - void addToToc(DocIterator const &); + void addToToc(DocIterator const & di, bool output_active, + UpdateType utype, TocBackend & backend) const override; /// - void updateCommand(); + void updateBuffer(ParIterator const &, UpdateType, bool const deleted = false) override; /// - void updateLabels(ParIterator const &); + std::string contextMenuName() const override; + //@} + + /// \name Static public methods obligated for InsetCommand derived classes + //@{ /// static ParamInfo const & findInfo(std::string const &); /// @@ -98,45 +118,61 @@ public: /// static bool isCompatibleCommand(std::string const & s); /// - docstring contextMenu(BufferView const & bv, int x, int y) const; - /// \return the child buffer if the file is a LyX doc and could be loaded - Buffer * getChildBuffer() const; + bool needsCProtection(bool const maintext = false, + bool const fragile = false) const override; + //@} + protected: - InsetInclude(InsetInclude const &); - /// - void doDispatch(Cursor & cur, FuncRequest & cmd); /// - bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const; -private: - Inset * clone() const { return new InsetInclude(*this); } + InsetInclude(InsetInclude const &); +private: /** Slot receiving a signal that the external file has changed * and the preview should be regenerated. */ void fileChanged() const; - - /// \return loaded Buffer or zero if the file loading did not proceed. - Buffer * loadIfNeeded() const; /// launch external application void editIncluded(std::string const & file); + /// + bool isChildIncluded() const; + /// check whether the included file exist + bool includedFileExist() const; + /// \return True if there is a recursive include + /// Also issues appropriate warning, etc + bool checkForRecursiveInclude(Buffer const * cbuf, bool silent = false) const; + + /// \name Private functions inherited from Inset class + //@{ + Inset * clone() const override { return new InsetInclude(*this); } + /// + void doDispatch(Cursor & cur, FuncRequest & cmd) override; + /// + bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const override; + //@} + + /// \name Private functions inherited from InsetCommand class + //@{ /// set the parameters + // FIXME:InsetCommmand::setParams is not virtual void setParams(InsetCommandParams const & params); /// get the text displayed on the button - docstring screenLabel() const; - /// holds the entity name that defines the file location (SGML) + docstring screenLabel() const override; + //@} + + /// holds the entity name that defines the file location (XML) docstring const include_label; /// The pointer never changes although *preview_'s contents may. - boost::scoped_ptr const preview_; + unique_ptr const preview_; - /// + /// mutable bool failedtoload_; /// cache - mutable bool set_label_; - mutable RenderButton button_; mutable docstring listings_label_; InsetLabel * label_; mutable Buffer * child_buffer_; + mutable bool file_exist_; + mutable bool recursion_error_; };