src/insets/InsetInclude.h

   1 // -*- C++ -*-
   2 /**
   3  * \file InsetInclude.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Lars Gullik Bjønnes
   8  * \author Richard Heck (conversion to InsetCommand)
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef INSET_INCLUDE_H
  14 #define INSET_INCLUDE_H
  15
  16 #include "InsetCommand.h"
  17
  18 #include "RenderButton.h"
  19
  20 #include <boost/scoped_ptr.hpp>
  21
  22 namespace lyx {
  23
  24 class BiblioInfo;
  25 class Buffer;
  26 class Dimension;
  27 class InsetCommandParams;
  28 class InsetLabel;
  29 class LaTeXFeatures;
  30 class RenderMonitoredPreview;
  31
  32 namespace support {
  33         class FileNameList;
  34 }
  35
  36 /// for including tex/lyx files
  37 class InsetInclude : public InsetCommand {
  38 public:
  39         ///
  40         InsetInclude(Buffer * buf, InsetCommandParams const &);
  41         ///
  42         ~InsetInclude();
  43
  44         ///
  45         void setChildBuffer(Buffer * buffer);
  46         /// \return the child buffer if the file is a LyX doc and could be loaded
  47         Buffer * getChildBuffer() const;
  48
  49         /** Update the cache with all bibfiles in use of the child buffer
  50          *  (including bibfiles of grandchild documents).
  51          *  Does nothing if the child document is not loaded to prevent
  52          *  automatic loading of all child documents upon loading the master.
  53          *  \param buffer the Buffer containing this inset.
  54          */
  55         void updateBibfilesCache();
  56
  57         /** Return the cache with all bibfiles in use of the child buffer
  58          *  (including bibfiles of grandchild documents).
  59          *  Return an empty vector if the child doc is not loaded.
  60          *  \param buffer the Buffer containing this inset.
  61          */
  62         support::FileNameList const &
  63                 getBibfilesCache() const;
  64
  65         ///
  66         void updateCommand();
  67         ///
  68         void write(std::ostream &) const;
  69
  70         /// \name Public functions inherited from Inset class
  71         //@{
  72         ///
  73         void setBuffer(Buffer & buffer);
  74         ///
  75         bool isLabeled() const { return true; }
  76         /// Override these InsetButton methods if Previewing
  77         void metrics(MetricsInfo & mi, Dimension & dim) const;
  78         ///
  79         void draw(PainterInfo & pi, int x, int y) const;
  80         ///
  81         DisplayType display() const;
  82         ///
  83         InsetCode lyxCode() const { return INCLUDE_CODE; }
  84         ///
  85         docstring layoutName() const;
  86         /** Fills \c key
  87          *  \param keys the list of bibkeys in the child buffer.
  88          *  \param it not used here
  89          */
  90         void collectBibKeys(InsetIterator const &) const;
  91         ///
  92         bool hasSettings() const { return true; }
  93         ///
  94         void latex(otexstream &, OutputParams const &) const;
  95         ///
  96         int plaintext(odocstringstream & ods, OutputParams const & op,
  97                       size_t max_length = INT_MAX) const;
  98         ///
  99         int docbook(odocstream &, OutputParams const &) const;
 100         ///
 101         docstring xhtml(XHTMLStream &, OutputParams const &) const;
 102         ///
 103         void validate(LaTeXFeatures &) const;
 104         ///
 105         void addPreview(DocIterator const &, graphics::PreviewLoader &) const;
 106         ///
 107         void addToToc(DocIterator const & di, bool output_active,
 108                                   UpdateType utype) const;
 109         ///
 110         void updateBuffer(ParIterator const &, UpdateType);
 111         ///
 112         std::string contextMenuName() const;
 113         //@}
 114
 115         /// \name Static public methods obligated for InsetCommand derived classes
 116         //@{
 117         ///
 118         static ParamInfo const & findInfo(std::string const &);
 119         ///
 120         static std::string defaultCommand() { return "include"; }
 121         ///
 122         static bool isCompatibleCommand(std::string const & s);
 123         //@}
 124
 125 protected:
 126         ///
 127         InsetInclude(InsetInclude const &);
 128
 129 private:
 130         /** Slot receiving a signal that the external file has changed
 131          *  and the preview should be regenerated.
 132          */
 133         void fileChanged() const;
 134         /// \return loaded Buffer or zero if the file loading did not proceed.
 135         Buffer * loadIfNeeded() const;
 136         /// launch external application
 137         void editIncluded(std::string const & file);
 138         ///
 139         bool isChildIncluded() const;
 140
 141         /// \name Private functions inherited from Inset class
 142         //@{
 143         Inset * clone() const { return new InsetInclude(*this); }
 144         ///
 145         void doDispatch(Cursor & cur, FuncRequest & cmd);
 146         ///
 147         bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
 148         //@}
 149
 150         /// \name Private functions inherited from InsetCommand class
 151         //@{
 152         /// set the parameters
 153         // FIXME:InsetCommmand::setParams is not virtual
 154         void setParams(InsetCommandParams const & params);
 155         /// get the text displayed on the button
 156         docstring screenLabel() const;
 157         //@}
 158
 159         /// holds the entity name that defines the file location (SGML)
 160         docstring const include_label;
 161
 162         /// The pointer never changes although *preview_'s contents may.
 163         boost::scoped_ptr<RenderMonitoredPreview> const preview_;
 164
 165         ///
 166         mutable bool failedtoload_;
 167         /// cache
 168         mutable bool set_label_;
 169         mutable RenderButton button_;
 170         mutable docstring listings_label_;
 171         InsetLabel * label_;
 172         mutable Buffer * child_buffer_;
 173 };
 174
 175
 176 } // namespace lyx
 177
 178 #endif // INSET_INCLUDE_H