X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetInclude.h;h=9ecaf42e7e0eaa97f7bef74304d02bf2a73c01f1;hb=87a7f728ca9b8b4d358cf06de980f61b67a927ac;hp=6675a4bf2550b59f99fe8945476f72575fd27a66;hpb=c3a8b3a566e9e90f9ade72acbc723232d721d0b1;p=lyx.git diff --git a/src/insets/InsetInclude.h b/src/insets/InsetInclude.h index 6675a4bf25..9ecaf42e7e 100644 --- a/src/insets/InsetInclude.h +++ b/src/insets/InsetInclude.h @@ -4,7 +4,7 @@ * This file is part of LyX, the document processor. * Licence details can be found in the file COPYING. * - * \author Lars Gullik Bjønnes + * \author Lars Gullik Bjønnes * \author Richard Heck (conversion to InsetCommand) * * Full author contact details are available in file CREDITS. @@ -13,132 +13,166 @@ #ifndef INSET_INCLUDE_H #define INSET_INCLUDE_H -#include "BiblioInfo.h" #include "InsetCommand.h" -#include "InsetCommandParams.h" + #include "RenderButton.h" -#include "MailInset.h" -#include "Counters.h" -#include "EmbeddedFiles.h" -#include +#include "support/unique_ptr.h" + namespace lyx { +class BiblioInfo; 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(InsetCommandParams const &); + InsetInclude(Buffer * buf, InsetCommandParams const &); + /// + ~InsetInclude(); + + /// + void setChildBuffer(Buffer * buffer); + /// \return the child buffer if the file is a LyX doc and could be loaded + Buffer * getChildBuffer() 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 + * automatic loading of all child documents upon loading the master. + * \param buffer the Buffer containing this inset. + */ + void updateBibfilesCache(); + + /// + void updateCommand(); + /// + void write(std::ostream &) const; + + /// \name Public functions inherited from Inset class + //@{ + /// + 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; /// - virtual DisplayType display() const; + DisplayType display() const; /// 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. - */ - void getLabelList(Buffer const & buffer, - std::vector & list) const; - /** Fills \c keys - * \param buffer the Buffer containing this inset. + /// + docstring layoutName() const; + /** Fills \c key * \param keys the list of bibkeys in the child buffer. * \param it not used here */ - 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 - * automatic loading of all child documents upon loading the master. - * \param buffer the Buffer containing this inset. - */ - void updateBibfilesCache(Buffer const & buffer); - /** 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. - */ - EmbeddedFileList const & - getBibfilesCache(Buffer const & buffer) const; + void collectBibKeys(InsetIterator const &, support::FileNameList &) const; + /// + bool hasSettings() const { return true; } /// - EDITABLE editable() const { return IS_EDITABLE; } + void latex(otexstream &, OutputParams const &) const; /// - int latex(Buffer const &, odocstream &, - OutputParams const &) const; + int plaintext(odocstringstream & ods, OutputParams const & op, + size_t max_length = INT_MAX) const; /// - int plaintext(Buffer const &, odocstream &, - OutputParams const &) const; + int docbook(odocstream &, OutputParams const &) const; /// - int docbook(Buffer const &, odocstream &, - OutputParams const &) const; + docstring xhtml(XHTMLStream &, OutputParams const &) const; /// void validate(LaTeXFeatures &) const; /// - void addPreview(graphics::PreviewLoader &) const; + void addPreview(DocIterator const &, graphics::PreviewLoader &) const; /// - void addToToc(Buffer const &, ParConstIterator const &) const; + void addToToc(DocIterator const & di, bool output_active, + UpdateType utype, TocBackend & backend) const; /// - void updateLabels(Buffer const & buffer, ParIterator const &); - /// child document can be embedded - void registerEmbeddedFiles(Buffer const &, EmbeddedFileList &) const; + void updateBuffer(ParIterator const &, UpdateType); /// - void updateEmbeddedFile(Buffer const & buf, EmbeddedFile const & file); + std::string contextMenuName() const; + //@} + + /// \name Static public methods obligated for InsetCommand derived classes + //@{ /// - static CommandInfo const * findInfo(std::string const &); + static ParamInfo const & findInfo(std::string const &); /// - static std::string defaultCommand() { return "include"; }; + static std::string defaultCommand() { return "include"; } /// static bool isCompatibleCommand(std::string const & s); + /// + bool needsCProtection(bool const maintext = false, + bool const fragile = false) const; + //@} + protected: - InsetInclude(InsetInclude const &); /// - virtual void doDispatch(Cursor & cur, FuncRequest & cmd); -private: - virtual Inset * clone() const; + 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; + /// \name Private functions inherited from Inset class + //@{ + Inset * clone() const { return new InsetInclude(*this); } + /// + void doDispatch(Cursor & cur, FuncRequest & cmd); + /// + bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const; + //@} + + /// \name Private functions inherited from InsetCommand class + //@{ /// set the parameters - void set(InsetCommandParams const & params, Buffer const &); + // FIXME:InsetCommmand::setParams is not virtual + void setParams(InsetCommandParams const & params); /// get the text displayed on the button - docstring const getScreenLabel(Buffer const &) const; + docstring screenLabel() const; + //@} + /// holds the entity name that defines the file location (SGML) 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_; }; -/// 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); - -/// -void resetParentBuffer(Buffer const * parent, InsetCommandParams const & params, - bool close_it); } // namespace lyx -#endif // INSETINCLUDE_H +#endif // INSET_INCLUDE_H