X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBuffer.h;h=297e63208ce126bf5110d47a62f428f3292ffd73;hb=acc5af9912533261c37795971af269f77317f14f;hp=96c0bae617eb7532c43498ddda21d496d6a8c6e6;hpb=6192345f60bd77c9223c1649956d6814d48ca26b;p=lyx.git diff --git a/src/Buffer.h b/src/Buffer.h index 96c0bae617..297e63208c 100644 --- a/src/Buffer.h +++ b/src/Buffer.h @@ -12,12 +12,16 @@ #ifndef BUFFER_H #define BUFFER_H +#include "update_flags.h" + #include "insets/InsetCode.h" #include "support/strfwd.h" #include "support/types.h" #include "support/SignalSlot.h" +#include +#include #include #include @@ -27,10 +31,13 @@ namespace lyx { class BiblioInfo; class BufferParams; class BufferSet; +class DispatchResult; class DocIterator; +class docstring_list; class ErrorItem; class ErrorList; class FuncRequest; +class FuncStatus; class Inset; class InsetRef; class InsetLabel; @@ -54,6 +61,7 @@ class TeXErrors; class TexRow; class TocBackend; class Undo; +class WordLangTuple; namespace frontend { class GuiBufferDelegate; @@ -110,22 +118,35 @@ public: timestamp_method, ///< Use timestamp, and checksum if timestamp has changed }; + /// + enum UpdateScope { + UpdateMaster, + UpdateChildOnly + }; + /// Constructor - explicit Buffer(std::string const & file, bool b = false); + explicit Buffer(std::string const & file, bool readonly = false, + Buffer const * cloned_buffer = 0); /// Destructor ~Buffer(); + /// + Buffer * clone() const; + /// + bool isClone() const; + /** High-level interface to buffer functionality. - This function parses a command string and executes it + This function parses a command string and executes it. */ - bool dispatch(std::string const & command, bool * result = 0); + void dispatch(std::string const & command, DispatchResult & result); /// Maybe we know the function already by number... - bool dispatch(FuncRequest const & func, bool * result = 0); + void dispatch(FuncRequest const & func, DispatchResult & result); - /// Load the autosaved file. - void loadAutoSaveFile(); + /// Can this function be exectued? + /// \return true if we made a decision + bool getStatus(FuncRequest const & cmd, FuncStatus & flag); /// read a new document from a string bool readString(std::string const &); @@ -137,14 +158,10 @@ public: /** Reads a file without header. \param par if != 0 insert the file. - \return \c false if file is not completely read. + \return \c true if file is not completely read. */ bool readDocument(Lexer &); - /// - void insertStringAsLines(ParagraphList & plist, - pit_type &, pos_type &, - Font const &, docstring const &, bool); /// DocIterator getParFromID(int id) const; /// do we have a paragraph with this id? @@ -161,11 +178,16 @@ public: /// Write document to stream. Returns \c false if unsuccesful. bool write(std::ostream &) const; + /// save emergency file + /// \return a status message towards the user. + docstring emergencyWrite(); /// Write file. Returns \c false if unsuccesful. bool writeFile(support::FileName const &) const; - /// Loads LyX file \c filename into buffer, * and \return success + /// Loads LyX file \c filename into buffer, * and return success bool loadLyXFile(support::FileName const & s); + /// Reloads the LyX file + bool reload(); /// Fill in the ErrorList with the TeXErrors void bufferErrors(TeXErrors const &, ErrorList &) const; @@ -209,6 +231,14 @@ public: void writeDocBookSource(odocstream & os, std::string const & filename, OutputParams const & runparams_in, bool only_body = false) const; + /// + void makeLyXHTMLFile(support::FileName const & filename, + OutputParams const & runparams_in, + bool only_body = false) const; + /// + void writeLyXHTMLSource(odocstream & os, + OutputParams const & runparams_in, + bool only_body = false) const; /// returns the main language for the buffer (document) Language const * language() const; /// get l10n translated to the buffers language @@ -241,9 +271,16 @@ public: /// void setUnnamed(bool flag = true); - /// + /// Whether or not a filename has been assigned to this buffer bool isUnnamed() const; + /// Whether or not this buffer is internal. + /// + /// An internal buffer does not contain a real document, but some auxiliary text segment. + /// It is not associated with a filename, it is never saved, thus it does not need to be + /// automatically saved, nor it needs to trigger any "do you want to save ?" question. + bool isInternal() const; + /// Mark this buffer as dirty. void markDirty(); @@ -262,7 +299,7 @@ public: */ std::string latexName(bool no_path = true) const; - /// Get thee name and type of the log. + /// Get the name and type of the log. std::string logName(LogType * type = 0) const; /// Change name of buffer. Updates "read-only" flag. @@ -282,6 +319,12 @@ public: /// \return true if \p child is a child of this \c Buffer. bool isChild(Buffer * child) const; + + /// return a vector with all children (and grandchildren) + std::vector getChildren(bool grand_children = true) const; + + /// Add all children (and grandchildren) to supplied vector + void getChildren(std::vector & children, bool grand_children = true) const; /// Is buffer read-only? bool isReadonly() const; @@ -307,14 +350,23 @@ public: */ void validate(LaTeXFeatures &) const; - /// Update the cache with all bibfiles in use (including bibfiles + /// Update the list of all bibfiles in use (including bibfiles /// of loaded child documents). - void updateBibfilesCache() const; - /// - void invalidateBibinfoCache(); - /// Return the cache with all bibfiles in use (including bibfiles + void updateBibfilesCache(UpdateScope scope = UpdateMaster) const; + /// Return the list with all bibfiles in use (including bibfiles /// of loaded child documents). - support::FileNameList const & getBibfilesCache() const; + support::FileNameList const & + getBibfilesCache(UpdateScope scope = UpdateMaster) const; + /// Information from BibTeX databases is cached in the Buffer, so + /// we do not have to read the file over and over. + /// Calling this method invalidates the cache and so requires a + /// re-read. + void invalidateBibinfoCache(); + /// Updates the cached bibliography information. + /// Note that you MUST call this method to update the cache. It will + /// not happen otherwise. (Currently, it is called at the start of + /// updateLabels() and from GuiCitation.) + void checkBibInfoCache() const; /// \return the bibliography information for this buffer's master, /// or just for it, if it isn't a child. BiblioInfo const & masterBibInfo() const; @@ -397,6 +449,10 @@ public: /// Return macro defined before the inclusion of the child MacroData const * getMacro(docstring const & name, Buffer const & child, bool global = true) const; + /// Collect user macro names at loading time + typedef std::set UserMacroSet; + UserMacroSet usermacros; + /// Replace the inset contents for insets which InsetCode is equal /// to the passed \p inset_code. void changeRefsIfUnique(docstring const & from, docstring const & to, @@ -424,13 +480,15 @@ public: Undo & undo(); /// This function is called when the buffer is changed. - void changed() const; + void changed(bool update_metrics) const; + /// + void setChild(DocIterator const & dit, Buffer * child); /// void updateTocItem(std::string const &, DocIterator const &) const; /// This function is called when the buffer structure is changed. void structureChanged() const; /// This function is called when some parsing error shows up. - void errors(std::string const & err) const; + void errors(std::string const & err, bool from_master = false) const; /// This function is called when the buffer busy status change. void setBusy(bool on) const; /// This function is called when the buffer readonly status change. @@ -442,25 +500,39 @@ public: /// void message(docstring const & msg) const; + /// void setGuiDelegate(frontend::GuiBufferDelegate * gui); + /// + bool hasGuiDelegate() const; /// void autoSave() const; + /// + void removeAutosaveFile() const; + /// + void moveAutosaveFile(support::FileName const & old) const; + /// + support::FileName getAutosaveFilename() const; /// return the format of the buffer on a string std::string bufferFormat() const; + /// return the default output format of the current backend + std::string getDefaultOutputFormat() const; /// bool doExport(std::string const & format, bool put_in_tempdir, - std::string & result_file) const; + bool includeall, std::string & result_file) const; /// - bool doExport(std::string const & format, bool put_in_tempdir) const; + bool doExport(std::string const & format, bool put_in_tempdir, + bool includeall = false) const; /// - bool preview(std::string const & format) const; + bool preview(std::string const & format, bool includeall = false) const; /// bool isExportable(std::string const & format) const; /// std::vector exportableFormats(bool only_viewable) const; + /// + bool isExportableFormat(std::string const & format) const; /// typedef std::vector > References; @@ -470,11 +542,32 @@ public: void setInsetLabel(docstring const & label, InsetLabel const * il); InsetLabel const * insetLabel(docstring const & label) const; - // FIXME: buf should should be const because updateLabels() modifies - // the contents of the paragraphs. - void updateLabels(bool childonly = false) const; - /// - void updateLabels(ParIterator & parit) const; + /// return a list of all used branches (also in children) + void getUsedBranches(std::list &, bool const from_master = false) const; + + /// sets the buffer_ member for every inset in this buffer. + // FIXME This really shouldn't be needed, but at the moment it's not + // clear how to do it just for the individual pieces we need. + void setBuffersForInsets() const; + /// Updates screen labels and some other information associated with + /// insets and paragraphs. Actually, it's more like a general "recurse + /// through the Buffer" routine, that visits all the insets and paragraphs. + void updateLabels() const { updateLabels(UpdateMaster, false); } + /// \param scope: whether to start with the master document or just + /// do this one. + /// \param output: whether we are preparing for output. + void updateLabels(UpdateScope scope, bool output) const; + /// + void updateLabels(ParIterator & parit, bool output) const; + + /// Spellcheck starting from \p from. + /// \p from initial position, will then points to the next misspelled + /// word. + /// \p to will points to the end of the next misspelled word. + /// \p word_lang will contain the found misspelled word. + /// \return progress if a new word was found. + int spellCheck(DocIterator & from, DocIterator & to, + WordLangTuple & word_lang, docstring_list & suggestions) const; private: /// search for macro in local (buffer) table or in children @@ -485,7 +578,8 @@ private: */ void updateMacros(DocIterator & it, DocIterator & scope) const; - + /// + void setLabel(ParIterator & it) const; /// void collectRelatives(BufferSet & bufs) const; @@ -499,11 +593,16 @@ private: ReadStatus readFile(Lexer &, support::FileName const & filename, bool fromString = false); + /** If we have branches that use the file suffix + feature, return the file name with suffix appended. + */ + support::FileName exportFileName() const; + /// Use the Pimpl idiom to hide the internals. class Impl; /// The pointer never changes although *pimpl_'s contents may. Impl * const d; - + /// frontend::GuiBufferDelegate * gui_; /// This function is called when the buffer structure is changed.