X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBuffer.h;h=f745aa04b8563cc2fb43eff35324156c2f5966dd;hb=1a74f3d1035cfbdb5e21947448e5af2b9ec152f0;hp=95d1386866874f118628f1d95f768a6b93072600;hpb=2193a506052002f66bd6c2929e208ba795549cf1;p=lyx.git diff --git a/src/Buffer.h b/src/Buffer.h index 95d1386866..f745aa04b8 100644 --- a/src/Buffer.h +++ b/src/Buffer.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 * * Full author contact details are available in file CREDITS. */ @@ -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 @@ -26,10 +30,14 @@ 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; @@ -53,6 +61,7 @@ class TeXErrors; class TexRow; class TocBackend; class Undo; +class WordLangTuple; namespace frontend { class GuiBufferDelegate; @@ -73,7 +82,7 @@ class FileNameList; * * I am not sure if the class is complete or * minimal, probably not. - * \author Lars Gullik Bjønnes + * \author Lars Gullik Bjønnes */ class Buffer { public: @@ -91,14 +100,14 @@ public: }; - /// Method to check if a file is externally modified, used by + /// Method to check if a file is externally modified, used by /// isExternallyModified() /** * timestamp is fast but inaccurate. For example, the granularity * of timestamp on a FAT filesystem is 2 second. Also, various operations * may touch the timestamp of a file even when its content is unchanged. * - * checksum is accurate but slow, which can be a problem when it is + * checksum is accurate but slow, which can be a problem when it is * frequently used, or used for a large file on a slow (network) file * system. * @@ -108,26 +117,33 @@ public: checksum_method, ///< Use file checksum timestamp_method, ///< Use timestamp, and checksum if timestamp has changed }; - - /** Constructor - \param file - \param b optional \c false by default - */ + + /// + enum UpdateScope { + UpdateMaster, + UpdateChildOnly + }; + + /// Constructor explicit Buffer(std::string const & file, bool b = false); /// Destructor ~Buffer(); + /// + Buffer * clone() 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 &); @@ -139,14 +155,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? @@ -163,10 +175,13 @@ 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); /// Fill in the ErrorList with the TeXErrors @@ -185,14 +200,14 @@ public: encoding associated to \p os. Therefore you must not call this method with a string stream if the output is supposed to go to a file. \code - odocfstream ofs; + ofdocstream ofs; ofs.open("test.tex"); writeLaTeXSource(ofs, ...); ofs.close(); \endcode is NOT equivalent to \code odocstringstream oss; writeLaTeXSource(oss, ...); - odocfstream ofs; + ofdocstream ofs; ofs.open("test.tex"); ofs << oss.str(); ofs.close(); @@ -211,6 +226,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 @@ -243,9 +266,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(); @@ -264,7 +294,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. @@ -272,13 +302,22 @@ public: /// Set document's parent Buffer. void setParent(Buffer const *); - Buffer const * parent(); + Buffer const * parent() const; + + // Collect all relative buffer + std::vector allRelatives() const; /** Get the document's master (or \c this if this is not a child document) */ Buffer const * masterBuffer() const; + /// \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; + /// Is buffer read-only? bool isReadonly() const; @@ -305,10 +344,13 @@ public: /// Update the cache with all bibfiles in use (including bibfiles /// of loaded child documents). - void updateBibfilesCache() const; + void updateBibfilesCache(UpdateScope scope = UpdateMaster) const; + /// + void invalidateBibinfoCache(); /// Return the cache with all bibfiles in use (including bibfiles /// of loaded child documents). - support::FileNameList const & getBibfilesCache() const; + support::FileNameList const & + getBibfilesCache(UpdateScope scope = UpdateMaster) const; /// \return the bibliography information for this buffer's master, /// or just for it, if it isn't a child. BiblioInfo const & masterBibInfo() const; @@ -343,6 +385,7 @@ public: /// Used when typesetting to place errorboxes. TexRow const & texrow() const; + TexRow & texrow(); /// ParIterator par_iterator_begin(); @@ -353,6 +396,9 @@ public: /// ParConstIterator par_iterator_end() const; + // Position of the child buffer where it appears first in the master. + DocIterator firstChildPosition(Buffer const * child); + /** \returns true only when the file is fully loaded. * Used to prevent the premature generation of previews * and by the citation inset. @@ -387,6 +433,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, @@ -395,7 +445,7 @@ public: /// get source code (latex/docbook) for some paragraphs, or all paragraphs /// including preamble void getSourceCode(odocstream & os, pit_type par_begin, pit_type par_end, - bool full_source); + bool full_source) const; /// Access to error list. /// This method is used only for GUI visualisation of Buffer related @@ -415,10 +465,12 @@ public: /// This function is called when the buffer is changed. void changed() const; + /// + 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. @@ -430,13 +482,24 @@ 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, @@ -458,6 +521,33 @@ public: void setInsetLabel(docstring const & label, InsetLabel const * il); InsetLabel const * insetLabel(docstring const & label) 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 MacroData const * getBufferMacro(docstring const & name, @@ -467,8 +557,12 @@ private: */ void updateMacros(DocIterator & it, DocIterator & scope) const; + /// + void setLabel(ParIterator & it) const; + /// + void collectRelatives(BufferSet & bufs) const; - /// + /// bool readFileHelper(support::FileName const & s); /// std::vector backends() const; @@ -478,11 +572,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.