X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBuffer.h;h=6cb04bb7c0b72693b0bfe5a299554fb471ccaae6;hb=86fab2cefa122a5b0c0ee4ade472e41d9a3ff1cf;hp=586c47db022d6955b1e834f6ab24a187929f9925;hpb=e0d54dd3b497b78094ea16ab0f38ccdc8c1642e2;p=lyx.git diff --git a/src/Buffer.h b/src/Buffer.h index 586c47db02..6cb04bb7c0 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,35 +12,36 @@ #ifndef BUFFER_H #define BUFFER_H -#include "ErrorList.h" -#include "InsetList.h" +#include "update_flags.h" -#include "DocIterator.h" +#include "insets/InsetCode.h" -#include "support/FileName.h" -#include "support/limited_stack.h" +#include "support/strfwd.h" #include "support/types.h" -#include "support/docstring.h" -#include "support/docstream.h" +#include "support/SignalSlot.h" -#include -#include - -#include +#include #include -#include -#include #include 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 InsetText; +class InsetRef; +class InsetLabel; class Font; +class Format; class Lexer; class LyXRC; class Text; @@ -48,16 +49,28 @@ class LyXVC; class LaTeXFeatures; class Language; class MacroData; +class MacroNameSet; +class MacroSet; class OutputParams; +class Paragraph; class ParConstIterator; class ParIterator; class ParagraphList; -class StableDocIterator; class TeXErrors; class TexRow; class TocBackend; class Undo; +class WordLangTuple; + +namespace frontend { +class GuiBufferDelegate; +class WorkAreaManager; +} +namespace support { +class FileName; +class FileNameList; +} /** The buffer object. * This is the buffer object. It contains all the informations about @@ -68,8 +81,8 @@ class Undo; * * 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: /// What type of log will \c getLogName() return? @@ -85,25 +98,48 @@ public: wrongversion ///< The version of the file does not match ours }; - /** Constructor - \param file - \param b optional \c false by default - */ + + /// 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 + * frequently used, or used for a large file on a slow (network) file + * system. + * + * FIXME: replace this method with support/FileMonitor. + */ + enum CheckMethod { + checksum_method, ///< Use file checksum + timestamp_method, ///< Use timestamp, and checksum if timestamp has changed + }; + + /// + enum UpdateScope { + UpdateMaster, + UpdateChildOnly + }; + + /// Constructor explicit Buffer(std::string const & file, bool b = false); /// Destructor ~Buffer(); /** 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 &); @@ -115,7 +151,7 @@ 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 &); @@ -124,29 +160,12 @@ public: pit_type &, pos_type &, Font const &, docstring const &, bool); /// - ParIterator getParFromID(int id) const; + DocIterator getParFromID(int id) const; /// do we have a paragraph with this id? bool hasParWithID(int id) const; - /// This signal is emitted when the buffer is changed. - boost::signal changed; - /// This signal is emitted when the buffer structure is changed. - boost::signal structureChanged; - /// This signal is emitted when some parsing error shows up. - boost::signal errors; - /// This signal is emitted when some message shows up. - boost::signal message; - /// This signal is emitted when the buffer busy status change. - boost::signal busy; - /// This signal is emitted when the buffer readonly status change. - boost::signal readonly; - /// Update window titles of all users. - boost::signal updateTitles; - /// Reset autosave timers for all users. - boost::signal resetAutosaveTimers; - /// This signal is emitting if the buffer is being closed. - boost::signal closing; - + /// + frontend::WorkAreaManager & workAreaManager() const; /** Save file. Takes care of auto-save files and backup file if requested. @@ -159,12 +178,18 @@ public: /// Write file. Returns \c false if unsuccesful. bool writeFile(support::FileName const &) const; + /// Loads LyX file \c filename into buffer, * and \return success + bool loadLyXFile(support::FileName const & s); + + /// Fill in the ErrorList with the TeXErrors + void bufferErrors(TeXErrors const &, ErrorList &) const; + /// Just a wrapper for writeLaTeXSource, first creating the ofstream. bool makeLaTeXFile(support::FileName const & filename, std::string const & original_path, OutputParams const &, bool output_preamble = true, - bool output_body = true); + bool output_body = true) const; /** Export the buffer to LaTeX. If \p os is a file stream, and params().inputenc is "auto" or "default", and the buffer contains text in different languages @@ -172,14 +197,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(); @@ -189,17 +214,25 @@ public: std::string const & original_path, OutputParams const &, bool output_preamble = true, - bool output_body = true); + bool output_body = true) const; /// void makeDocBookFile(support::FileName const & filename, OutputParams const & runparams_in, - bool only_body = false); + bool only_body = false) const; /// void writeDocBookSource(odocstream & os, std::string const & filename, OutputParams const & runparams_in, - bool only_body = false); + 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 * getLanguage() const; + Language const * language() const; /// get l10n translated to the buffers language docstring const B_(std::string const & l10n) const; @@ -212,11 +245,17 @@ public: /// bool isDepClean(std::string const & name) const; + /// whether or not disk file has been externally modified + bool isExternallyModified(CheckMethod method) const; + + /// save timestamp and checksum of the given file. + void saveCheckSum(support::FileName const & file) const; + /// mark the main lyx file as not needing saving void markClean() const; /// - void markBakClean(); + void markBakClean() const; /// void markDepClean(std::string const & name); @@ -231,34 +270,43 @@ public: void markDirty(); /// Returns the buffer's filename. It is always an absolute path. - std::string const fileName() const; + support::FileName fileName() const; + + /// Returns the buffer's filename. It is always an absolute path. + std::string absFileName() const; /// Returns the the path where the buffer lives. /// It is always an absolute path. - std::string const & filePath() const; + std::string filePath() const; /** A transformed version of the file name, adequate for LaTeX. \param no_path optional if \c true then the path is stripped. */ - std::string const getLatexName(bool no_path = true) const; + std::string latexName(bool no_path = true) const; - /// Get thee name and type of the log. - std::pair const getLogName() const; + /// Get the name and type of the log. + std::string logName(LogType * type = 0) const; /// Change name of buffer. Updates "read-only" flag. void setFileName(std::string const & newfile); - /// Name of the document's parent - void setParentName(std::string const &); + /// Set document's parent Buffer. + void setParent(Buffer const *); + 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 * getMasterBuffer() const; - /** Get the document's master (or \c this if this is not a - child document) - */ - Buffer * getMasterBuffer(); + 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() const; /// Is buffer read-only? bool isReadonly() const; @@ -284,14 +332,20 @@ public: */ void validate(LaTeXFeatures &) const; - /// return all bibkeys from buffer and its childs - void fillWithBibKeys(std::vector > & keys) const; /// Update the cache with all bibfiles in use (including bibfiles /// of loaded child documents). - void updateBibfilesCache(); + void updateBibfilesCache(UpdateScope scope = UpdateMaster) const; + /// + void invalidateBibinfoCache(); /// Return the cache with all bibfiles in use (including bibfiles /// of loaded child documents). - std::vector 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; + /// \return the bibliography information for this buffer ONLY. + BiblioInfo const & localBibInfo() const; /// void getLabelList(std::vector &) const; @@ -301,14 +355,6 @@ public: /// bool isMultiLingual() const; - /// Does this mean that this is buffer local? - limited_stack & undostack(); - limited_stack const & undostack() const; - - /// Does this mean that this is buffer local? - limited_stack & redostack(); - limited_stack const & redostack() const; - /// BufferParams & params(); BufferParams const & params() const; @@ -325,11 +371,11 @@ public: LyXVC const & lyxvc() const; /// Where to put temporary files. - std::string const & temppath() const; + std::string const temppath() const; /// Used when typesetting to place errorboxes. - TexRow & texrow(); TexRow const & texrow() const; + TexRow & texrow(); /// ParIterator par_iterator_begin(); @@ -340,79 +386,193 @@ 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. */ - bool fully_loaded() const; + bool isFullyLoaded() const; /// Set by buffer_funcs' newFile. - void fully_loaded(bool); + void setFullyLoaded(bool); /// Our main text (inside the top InsetText) Text & text() const; - /// Our top InsetText! + /// Our top InsetText Inset & inset() const; // // Macro handling // + /// Collect macro definitions in paragraphs + void updateMacros() const; + /// Iterate through the whole buffer and try to resolve macros + void updateMacroInstances() const; + + /// List macro names of this buffer, the parent and the children + void listMacroNames(MacroNameSet & macros) const; + /// Collect macros of the parent and its children in front of this buffer. + void listParentMacros(MacroSet & macros, LaTeXFeatures & features) const; + + /// Return macro defined before pos (or in the master buffer) + MacroData const * getMacro(docstring const & name, DocIterator const & pos, bool global = true) const; + /// Return macro defined anywhere in the buffer (or in the master buffer) + MacroData const * getMacro(docstring const & name, bool global = true) const; + /// Return macro defined before the inclusion of the child + MacroData const * getMacro(docstring const & name, Buffer const & child, bool global = true) const; + + /// Replace the inset contents for insets which InsetCode is equal + /// to the passed \p inset_code. + void changeRefsIfUnique(docstring const & from, docstring const & to, + InsetCode code); + + /// 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) const; + + /// Access to error list. + /// This method is used only for GUI visualisation of Buffer related + /// errors (like parsing or LateX compilation). This method is const + /// because modifying the returned ErrorList does not touch the document + /// contents. + ErrorList & errorList(std::string const & type) const; + + /// The Toc backend. + /// This is useful only for screen visualisation of the Buffer. This + /// method is const because modifying this backend does not touch + /// the document contents. + TocBackend & tocBackend() const; + + /// + Undo & undo(); + + /// This function is called when the buffer is changed. + void changed() const; /// - void buildMacros(); + 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, 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. + void setReadOnly(bool on) const; + /// Update window titles of all users. + void updateTitles() const; + /// Reset autosave timers for all users. + void resetAutosaveTimers() const; /// - bool hasMacro(docstring const & name) const; + void message(docstring const & msg) const; + /// - MacroData const & getMacro(docstring const & name) const; + void setGuiDelegate(frontend::GuiBufferDelegate * gui); /// - void insertMacro(docstring const & name, MacroData const & data); + bool hasGuiDelegate() const; /// - void saveCursor(StableDocIterator cursor, StableDocIterator anchor); + void autoSave() const; /// - StableDocIterator getCursor() const { return cursor_; } + void removeAutosaveFile() const; /// - StableDocIterator getAnchor() const { return anchor_; } + void moveAutosaveFile(support::FileName const & old) const; /// - void changeRefsIfUnique(docstring const & from, docstring const & to, - Inset::Code code); -/// 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); - - /// errorLists_ accessors. - //@{ - ErrorList const & errorList(std::string const & type) const; - ErrorList & errorList(std::string const & type); - //@} - - //@{ - TocBackend & tocBackend(); - TocBackend const & tocBackend() 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 doExport(std::string const & format, bool put_in_tempdir) const; + /// + bool preview(std::string const & format) const; + /// + bool isExportable(std::string const & format) const; + /// + std::vector exportableFormats(bool only_viewable) const; + + /// + typedef std::vector > References; + References & references(docstring const & label); + References const & references(docstring const & label) const; + void clearReferenceCache() const; + 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; + /// + void updateLabels(UpdateScope = UpdateMaster) const; + /// + void updateLabels(ParIterator & parit) 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, + DocIterator const & pos) const; + /** Update macro table starting with position of it + \param it in some text inset + */ + void updateMacros(DocIterator & it, + DocIterator & scope) const; + + /// + void collectRelatives(BufferSet & bufs) const; + + /// + bool readFileHelper(support::FileName const & s); + /// + std::vector backends() const; /** Inserts a file into a document \return \c false if method fails. */ ReadStatus readFile(Lexer &, support::FileName const & filename, - bool fromString = false); + 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. - boost::scoped_ptr const pimpl_; - - /// Save the cursor Position on Buffer switch - /// this would not be needed if every Buffer would have - /// it's BufferView, this should be FIXED in future. - StableDocIterator cursor_; - StableDocIterator anchor_; - /// A cache for the bibfiles (including bibfiles of loaded child - /// documents), needed for appropriate update of natbib labels. - mutable std::vector bibfilesCache_; - - /// Container for all sort of Buffer dependant errors. - std::map errorLists_; + Impl * const d; + + frontend::GuiBufferDelegate * gui_; + + /// This function is called when the buffer structure is changed. + Signal structureChanged_; + /// This function is called when some parsing error shows up. + //Signal errors(std::string const &) = 0; + /// This function is called when some message shows up. + //Signal message(docstring const &) = 0; + /// This function is called when the buffer busy status change. + //Signal setBusy(bool) = 0; + /// Reset autosave timers for all users. + Signal resetAutosaveTimers_; };