X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBuffer.h;h=3ed3a95c40597c230a888752e06c3a10557e1976;hb=3b9caa3b0d4ceb5e89f170c8dfa9fe27ab28cbd6;hp=9701f319132aed6e1ed65f9d854ff1a0f1248ed1;hpb=60b1a06ac8f555fb0aea6a66783e5248ca9fdc1f;p=lyx.git diff --git a/src/Buffer.h b/src/Buffer.h index 9701f31913..3ed3a95c40 100644 --- a/src/Buffer.h +++ b/src/Buffer.h @@ -72,13 +72,19 @@ class FileName; class FileNameList; } +namespace graphics { +class PreviewLoader; +} + class Buffer; typedef std::list ListOfBuffers; +/// a list of Buffers we cloned +typedef std::set CloneList; /** The buffer object. - * This is the buffer object. It contains all the informations about + * This is the buffer object. It contains all the information about * a document loaded into LyX. * The buffer object owns the Text (wrapped in an InsetText), which * contains the individual paragraphs of the document. @@ -105,7 +111,7 @@ public: ReadWrongVersion, ReadFileNotFound, ReadVCError, - ReadAutosaveFailure, + ReadAutosaveFailure, ReadEmergencyFailure, ReadNoLyXFormat, ReadDocumentFailure, @@ -118,12 +124,24 @@ public: ReadOriginal }; + enum ExportStatus { + // export + ExportSuccess, + ExportCancel, + ExportError, + ExportNoPathToFormat, + ExportTexPathHasSpaces, + ExportConverterError, + // preview + PreviewSuccess, + PreviewError + }; /// 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 + * of timestamp on a FAT filesystem is 2 seconds. 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 @@ -150,8 +168,11 @@ public: /// Destructor ~Buffer(); - /// - Buffer * clone() const; + /// Clones the entire structure of which this Buffer is part, starting + /// with the master and cloning all the children, too. + Buffer * cloneFromMaster() const; + /// Just clones this single Buffer. For autosave. + Buffer * cloneBufferOnly() const; /// bool isClone() const; @@ -204,7 +225,8 @@ public: /// read a new document from a string bool readString(std::string const &); /// Reloads the LyX file - ReadStatus reload(); + /// \param clearUndo if false, leave alone the undo stack. + ReadStatus reload(bool clearUndo = true); //FIXME: The following function should be private //private: /// read the header, returns number of unknown tokens @@ -214,9 +236,9 @@ private: /// typedef std::map BufferMap; /// - void clone(BufferMap &) const; + void cloneWithChildren(BufferMap &, CloneList *) const; /// save timestamp and checksum of the given file. - void saveCheckSum() const; + void saveCheckSum() const; /// read a new file ReadStatus readFile(support::FileName const & fn); /// Reads a file without header. @@ -224,18 +246,17 @@ private: /// \return \c true if file is not completely read. bool readDocument(Lexer &); /// Try to extract the file from a version control container - /// before reading if the file cannot be found. This is only - /// implemented for RCS. + /// before reading if the file cannot be found. /// \sa LyXVC::file_not_found_hook ReadStatus extractFromVC(); - /// Reads the first tag of a LyX File and + /// Reads the first tag of a LyX File and /// returns the file format number. ReadStatus parseLyXFormat(Lexer & lex, support::FileName const & fn, int & file_format) const; /// Convert the LyX file to the LYX_FORMAT using /// the lyx2lyx script and returns the filename /// of the temporary file to be read - ReadStatus convertLyXFormat(support::FileName const & fn, + ReadStatus convertLyXFormat(support::FileName const & fn, support::FileName & tmpfile, int from_format); //@} @@ -243,7 +264,7 @@ public: /// \name Functions involved in autosave and emergency files. //@{ /// Save an autosave file to #filename.lyx# - bool autoSave() const; + bool autoSave() const; /// save emergency file /// \return a status message towards the user. docstring emergencyWrite(); @@ -252,11 +273,11 @@ public: //private: /// void removeAutosaveFile() const; - + private: /// Try to load an autosave file associated to \c fn. ReadStatus loadAutosave(); - /// Try to load an emergency file associated to \c fn. + /// Try to load an emergency file associated to \c fn. ReadStatus loadEmergency(); /// Get the filename of the emergency file associated with the Buffer support::FileName getEmergencyFileName() const; @@ -270,12 +291,19 @@ public: /// Fill in the ErrorList with the TeXErrors void bufferErrors(TeXErrors const &, ErrorList &) const; + enum OutputWhat { + FullSource, + OnlyBody, + IncludedFile, + OnlyPreamble, + CurrentParagraph + }; + /// 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) const; + OutputWhat output = FullSource) 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 @@ -301,24 +329,22 @@ public: void writeLaTeXSource(otexstream & os, std::string const & original_path, OutputParams const &, - bool output_preamble = true, - bool output_body = true) const; + OutputWhat output = FullSource) const; /// void makeDocBookFile(support::FileName const & filename, OutputParams const & runparams_in, - bool only_body = false) const; + OutputWhat output = FullSource) const; /// void writeDocBookSource(odocstream & os, std::string const & filename, OutputParams const & runparams_in, - bool only_body = false) const; + OutputWhat output = FullSource) const; /// void makeLyXHTMLFile(support::FileName const & filename, - OutputParams const & runparams_in, - bool only_body = false) const; + OutputParams const & runparams_in) const; /// void writeLyXHTMLSource(odocstream & os, OutputParams const & runparams_in, - bool only_body = false) const; + OutputWhat output = FullSource) const; /// returns the main language for the buffer (document) Language const * language() const; /// get l10n translated to the buffers language @@ -353,6 +379,8 @@ public: /// automatically saved, nor it needs to trigger any "do you want to save ?" question. bool isInternal() const; + void setInternal(bool flag); + /// Mark this buffer as dirty. void markDirty(); @@ -385,15 +413,15 @@ public: /// \return true if \p child is a child of this \c Buffer. bool isChild(Buffer * child) const; - + /// \return true if this \c Buffer has children bool hasChildren() const; - + /// \return a list of the direct children of this Buffer. /// this list has no duplicates and is in the order in which /// the children appear. ListOfBuffers getChildren() const; - + /// \return a list of all descendents of this Buffer (children, /// grandchildren, etc). this list has no duplicates and is in /// the order in which the children appear. @@ -425,7 +453,7 @@ public: void validate(LaTeXFeatures &) const; /// Reference information is cached in the Buffer, so we do not - /// have to check or read things over and over. + /// have to check or read things over and over. /// /// There are two caches. /// @@ -433,11 +461,11 @@ public: /// being gathered. This cache is PER BUFFER, and the cache for the /// master essentially includes the cache for its children. This gets /// invalidated when an InsetBibtex is created, deleted, or modified. - /// + /// /// The other is a cache of the reference information itself. This /// exists only in the master buffer, and when it needs to be updated, /// the children add their information to the master's cache. - + /// Calling this method invalidates the cache and so requires a /// re-read. void invalidateBibinfoCache() const; @@ -462,6 +490,9 @@ public: /// void getLabelList(std::vector &) const; + /// This removes the .aux and .bbl files from the temp dir. + void removeBiblioTempFiles() const; + /// void changeLanguage(Language const * from, Language const * to); @@ -512,6 +543,8 @@ public: /// Set by buffer_funcs' newFile. void setFullyLoaded(bool); + /// FIXME: Needed by RenderPreview. + graphics::PreviewLoader * loader() const; /// Update the LaTeX preview snippets associated with this buffer void updatePreviews() const; /// Remove any previewed LaTeX snippets associated with this buffer @@ -555,7 +588,8 @@ public: /// get source code (latex/docbook) for some paragraphs, or all paragraphs /// including preamble void getSourceCode(odocstream & os, std::string const format, - pit_type par_begin, pit_type par_end, bool full_source) const; + pit_type par_begin, pit_type par_end, OutputWhat output, + bool master) const; /// Access to error list. /// This method is used only for GUI visualisation of Buffer related @@ -597,18 +631,28 @@ public: /// bool hasGuiDelegate() const; - - /// - bool doExport(std::string const & format, bool put_in_tempdir, + ExportStatus doExport(std::string const & target, bool put_in_tempdir) const; + /// + ExportStatus doExport(std::string const & target, bool put_in_tempdir, + std::string & result_file) const; + /// + ExportStatus preview(std::string const & format) const; + +private: + /// target is a format name optionally followed by a space + /// and a destination file-name + ExportStatus doExport(std::string const & target, bool put_in_tempdir, bool includeall, std::string & result_file) const; /// - bool doExport(std::string const & format, bool put_in_tempdir, - bool includeall = false) const; + ExportStatus doExport(std::string const & target, bool put_in_tempdir, + bool includeall) const; /// - bool preview(std::string const & format, bool includeall = false) const; - /// mark the buffer as busy exporting something, or not - void setExportStatus(bool e) const; + ExportStatus preview(std::string const & format, bool includeall = false) const; + /// + void setMathFlavor(OutputParams & op) const; + +public: /// bool isExporting() const; @@ -635,7 +679,7 @@ public: /// do this one. /// \param output: whether we are preparing for output. void updateBuffer(UpdateScope scope, UpdateType utype) const; - /// + /// void updateBuffer(ParIterator & parit, UpdateType utype) const; /// Spellcheck starting from \p from. @@ -648,8 +692,25 @@ public: WordLangTuple & word_lang, docstring_list & suggestions) const; /// void checkChildBuffers(); + /// + void checkMasterBuffer(); + + /// compute statistics between \p from and \p to + /// \p from initial position + /// \p to points to the end position + /// \p skipNoOutput if notes etc. should be ignored + void updateStatistics(DocIterator & from, DocIterator & to, + bool skipNoOutput = true) const; + /// statistics accessor functions + int wordCount() const; + int charCount(bool with_blanks) const; private: + class MarkAsExporting; + friend class MarkAsExporting; + /// mark the buffer as busy exporting something, or not + void setExportStatus(bool e) const; + /// Change name of buffer. Updates "read-only" flag. void setFileName(support::FileName const & fname); /// @@ -663,12 +724,15 @@ private: void updateBibfilesCache(UpdateScope scope = UpdateMaster) const; /// Return the list with all bibfiles in use (including bibfiles /// of loaded child documents). - support::FileNameList const & + support::FileNameList const & getBibfilesCache(UpdateScope scope = UpdateMaster) const; /// void collectChildren(ListOfBuffers & children, bool grand_children) const; - + /// noncopyable + Buffer(Buffer const &); + void operator=(Buffer const &); + /// Use the Pimpl idiom to hide the internals. class Impl; /// The pointer never changes although *pimpl_'s contents may.