#ifndef BUFFER_H
#define BUFFER_H
+#include "FuncCode.h"
#include "OutputEnums.h"
#include "support/unique_ptr.h"
#include "support/strfwd.h"
#include "support/types.h"
-#include "support/FileNameList.h"
#include <map>
#include <list>
class FuncStatus;
class Inset;
class InsetLabel;
-class InsetRef;
-class Font;
-class Format;
class Lexer;
class Text;
class LyXVC;
class MacroSet;
class OutputParams;
class otexstream;
-class Paragraph;
-class ParConstIterator;
-class ParIterator;
class ParagraphList;
+class ParIterator;
+class ParConstIterator;
class TeXErrors;
class TexRow;
class TocBackend;
namespace support {
class DocFileName;
class FileName;
-class FileNamePairList;
+class FileNameList;
} // namespace support
namespace graphics {
typedef std::list<Buffer *> ListOfBuffers;
/// a list of Buffers we cloned
typedef std::set<Buffer *> CloneList;
+typedef std::shared_ptr<CloneList> CloneList_ptr;
/** The buffer object.
* \author Lars Gullik Bjønnes
*/
-class MarkAsExporting;
-
class Buffer {
public:
/// What type of log will \c getLogName() return?
// export
ExportSuccess,
ExportCancel,
+ ExportKilled,
ExportError,
ExportNoPathToFormat,
ExportTexPathHasSpaces,
/// Constructor
explicit Buffer(std::string const & file, bool readonly = false,
- Buffer const * cloned_buffer = 0);
+ Buffer const * cloned_buffer = nullptr);
/// Destructor
~Buffer();
- /// Clones the entire structure of which this Buffer is part, starting
- /// with the master and cloning all the children, too.
- Buffer * cloneFromMaster() const;
+ /// Clones the entire structure of which this Buffer is part,
+ /// cloning all the children, too.
+ Buffer * cloneWithChildren() const;
/// Just clones this single Buffer. For autosave.
Buffer * cloneBufferOnly() const;
///
bool isClone() const;
+ /// Helper method: dispatch this branch activation LFUN
+ /// Retunrs true if the function has been dispatched
+ bool branchActivationDispatch(FuncCode act, docstring const & branch);
+
/** High-level interface to buffer functionality.
This function parses a command string and executes it.
*/
/// Maybe we know the function already by number...
void dispatch(FuncRequest const & func, DispatchResult & result);
+ /// Helper method: Is this buffer activation LFUN enabled?
+ bool branchActivationEnabled(FuncCode act, docstring const & branch) const;
+
/// Can this function be exectued?
/// \return true if we made a decision
- bool getStatus(FuncRequest const & cmd, FuncStatus & flag);
+ bool getStatus(FuncRequest const & cmd, FuncStatus & flag) const;
///
DocIterator getParFromID(int id) const;
int readHeader(Lexer & lex);
double fontScalingFactor() const;
+ /// check for active synctex support:
+ /// - either the document has synchronize output enabled or
+ /// - there is a converter to dvi or pdf defined with synctex command line argument
+ /// this is the "expert mode", false positives are possible
+ bool isSyncTeXenabled() const;
private:
///
typedef std::map<Buffer const *, Buffer *> BufferMap;
///
- void cloneWithChildren(BufferMap &, CloneList *) const;
+ void cloneWithChildren(BufferMap &, CloneList_ptr) const;
/// save checksum of the given file.
void saveCheckSum() const;
/// read a new file
bool autoSave() const;
/// save emergency file
/// \return a status message towards the user.
- docstring emergencyWrite();
+ docstring emergencyWrite() const;
//FIXME:The following function should be private
//private:
public:
/// Fill in the ErrorList with the TeXErrors
void bufferErrors(TeXErrors const &, ErrorList &) const;
+ /// Fill in the Citation/Reference ErrorList from the TeXErrors
+ void bufferRefs(TeXErrors const &, ErrorList &) const;
enum OutputWhat {
FullSource,
};
/// Just a wrapper for writeLaTeXSource, first creating the ofstream.
- bool makeLaTeXFile(support::FileName const & filename,
+ ExportStatus makeLaTeXFile(support::FileName const & filename,
std::string const & original_path,
OutputParams 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
+ If \p os is a file stream, and params().inputenc is "auto-legacy" or
+ "auto-legacy-plain", and the buffer contains text in different languages
with more than one encoding, then this method will change the
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
ofs.close();
\endcode
*/
- void writeLaTeXSource(otexstream & os,
+ ExportStatus writeLaTeXSource(otexstream & os,
std::string const & original_path,
OutputParams const &,
OutputWhat output = FullSource) const;
///
- void makeDocBookFile(support::FileName const & filename,
+ ExportStatus makeDocBookFile(support::FileName const & filename,
OutputParams const & runparams_in,
OutputWhat output = FullSource) const;
///
- void writeDocBookSource(odocstream & os, std::string const & filename,
- OutputParams const & runparams_in,
- OutputWhat output = FullSource) const;
+ ExportStatus writeDocBookSource(odocstream & os,
+ OutputParams const & runparams_in,
+ OutputWhat output = FullSource) const;
///
- void makeLyXHTMLFile(support::FileName const & filename,
+ ExportStatus makeLyXHTMLFile(support::FileName const & filename,
OutputParams const & runparams_in) const;
///
- void writeLyXHTMLSource(odocstream & os,
+ ExportStatus writeLyXHTMLSource(odocstream & os,
OutputParams const & runparams_in,
OutputWhat output = FullSource) const;
/// returns the main language for the buffer (document)
Language const * language() const;
/// get l10n translated to the buffers language
- docstring const B_(std::string const & l10n) const;
+ docstring B_(std::string const & l10n) const;
///
int runChktex();
std::string const &, bool nice) const;
/** Returns a vector of bibliography (*.bib) file paths suitable for the
- * output in the respective BibTeX/Biblatex macro
+ * output in the respective BibTeX/Biblatex macro and potential individual encoding
*/
- std::vector<docstring> const prepareBibFilePaths(OutputParams const &,
- support::FileNamePairList const bibfilelist,
+ std::vector<std::pair<docstring, std::string>> const prepareBibFilePaths(OutputParams const &,
+ const docstring_list & bibfilelist,
bool const extension = true) const;
/** Returns the path where a local layout file lives.
std::string latexName(bool no_path = true) const;
/// Get the name and type of the log.
- std::string logName(LogType * type = 0) const;
+ std::string logName(LogType * type = nullptr) const;
/// Set document's parent Buffer.
void setParent(Buffer const *);
/// the children appear.
ListOfBuffers getChildren() const;
- /// \return a list of all descendents of this Buffer (children,
+ /// \return a list of all descendants of this Buffer (children,
/// grandchildren, etc). this list has no duplicates and is in
/// the order in which the children appear.
- ListOfBuffers getDescendents() const;
+ ListOfBuffers getDescendants() const;
/// Collect all relative buffers, in the order in which they appear.
/// I.e., the "root" Buffer is first, then its first child, then any
/// Calling this method invalidates the cache and so requires a
/// re-read.
void invalidateBibinfoCache() const;
+ /// Clear the bibfiles cache
+ void clearBibFileCache() const;
/// Updates the cached bibliography information, checking first to see
/// whether the cache is valid. If so, we do nothing. If not, then we
/// reload all the BibTeX info.
/// Note that this operates on the master document.
- void reloadBibInfoCache() const;
+ void reloadBibInfoCache(bool const force = false) 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 this buffer's bibliography information
+ BiblioInfo const & bibInfo() const;
/// collect bibliography info from the various insets in this buffer.
void collectBibKeys(support::FileNameList &) const;
/// add some BiblioInfo to our cache
///
void makeCitationLabels() const;
///
- bool citeLabelsValid() const;
+ void invalidateCiteLabels() const;
///
- void getLabelList(std::vector<docstring> &) const;
-
- /// This removes the .aux and .bbl files from the temp dir.
- void removeBiblioTempFiles() const;
+ bool citeLabelsValid() const;
+ /// three strings: plain label name, label as gui string, and
+ /// dereferenced label name
+ void getLabelList(std::vector<std::tuple<docstring, docstring, docstring>> &) const;
///
void changeLanguage(Language const * from, Language const * to);
ParIterator par_iterator_end();
///
ParConstIterator par_iterator_end() const;
+ /// Is document empty ?
+ bool empty() const;
// Position of the child buffer where it appears first in the master.
DocIterator firstChildPosition(Buffer const * child);
mutable UserMacroSet usermacros;
/// Replace the inset contents for insets which InsetCode is equal
- /// to the passed \p inset_code.
+ /// to the passed \p inset_code. Handles undo.
void changeRefsIfUnique(docstring const & from, docstring const & to);
/// get source code (latex/docbook) for some paragraphs, or all paragraphs
///
Undo & undo();
+ ///
+ Undo const & undo() const;
/// This function is called when the buffer is changed.
void changed(bool update_metrics) const;
void setBusy(bool on) const;
/// Update window titles of all users.
void updateTitles() const;
+ /// Schedule redraw of work areas
+ void scheduleRedrawWorkAreas() const;
/// Reset autosave timers for all users.
void resetAutosaveTimers() const;
///
ExportStatus preview(std::string const & format) const;
/// true if there was a previous preview this session of this buffer and
/// there was an error on the previous preview of this buffer.
- bool lastPreviewError() const;
+ bool freshStartRequired() const;
+ ///
+ void requireFreshStart(bool const b) const;
private:
///
ExportStatus doExport(std::string const & target, bool put_in_tempdir,
std::string & result_file) const;
+ /// This removes the .aux and .bbl files from the temp dir.
+ void removeBiblioTempFiles() const;
/// 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 isExporting() const;
- ///
+ /// A collection of InsetRef insets and their position in the buffer
typedef std::vector<std::pair<Inset *, ParIterator> > References;
- ///
+ /// Get all InsetRef insets and their positions associated with
+ /// the InsetLabel with the label string \p label
References const & references(docstring const & label) const;
- ///
+ /// Add an InsetRef at position \p it to the Insetlabel
+ /// with the label string \p label
void addReference(docstring const & label, Inset * inset, ParIterator it);
- ///
+ /// Clear the whole reference cache
void clearReferenceCache() const;
- ///
- void setInsetLabel(docstring const & label, InsetLabel const * il);
- ///
- InsetLabel const * insetLabel(docstring const & label) const;
+ /// Set the InsetLabel for a given \p label string. \p active
+ /// determines whether this is an active label (see @ref activeLabel)
+ void setInsetLabel(docstring const & label, InsetLabel const * il,
+ bool const active);
+ /// \return the InsetLabel associated with this \p label string
+ /// If \p active is true we only return active labels
+ /// (see @ref activeLabel)
+ InsetLabel const * insetLabel(docstring const & label,
+ bool const active = false) const;
+ /// \return true if this \param label is an active label.
+ /// Inactive labels are currently deleted labels (in ct mode)
+ bool activeLabel(docstring const & label) const;
/// return a list of all used branches (also in children)
void getUsedBranches(std::list<docstring> &, bool const from_master = false) 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 updateBuffer() const { updateBuffer(UpdateMaster, InternalUpdate); }
+ void updateBuffer() const;
/// \param scope: whether to start with the master document or just
/// 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;
+ void updateBuffer(ParIterator & parit, UpdateType utype, bool const deleted = false) const;
+ /// Forces an updateBuffer() call
+ void forceUpdate() const;
+ /// Do we need to call updateBuffer()?
+ bool needUpdate() const;
/// Spellcheck starting from \p from.
/// \p from initial position, will then points to the next misspelled
/// \return progress if a new word was found.
int spellCheck(DocIterator & from, DocIterator & to,
WordLangTuple & word_lang, docstring_list & suggestions) const;
+ /// Marks the whole buffer to be checked (again)
+ void requestSpellcheck();
///
void checkChildBuffers();
///
int wordCount() const;
int charCount(bool with_blanks) const;
- // this is const because it does not modify the buffer's real contents,
- // only the mutable flag.
- void setChangesPresent(bool) const;
- bool areChangesPresent() const;
- void updateChangesPresent() const;
///
- void registerBibfiles(support::FileNamePairList const & bf) const;
+ bool areChangesPresent() const;
+ ///
+ void registerBibfiles(docstring_list const & bf) const;
+ ///
+ support::FileName getBibfilePath(docstring const & bibid) const;
+ /// Return the list with all bibfiles in use (including bibfiles
+ /// of loaded child documents).
+ docstring_list const &
+ getBibfiles(UpdateScope scope = UpdateMaster) const;
+ ///
+ void scheduleBiblioTempRemoval() const { removeBiblioTemps = true; }
+ /// routines for dealing with possible self-inclusion
+ void pushIncludedBuffer(Buffer const * buf) const;
+ void popIncludedBuffer() const;
+ bool isBufferIncluded(Buffer const * buf) const;
private:
+ void clearIncludeList() const;
+ ///
friend class MarkAsExporting;
/// mark the buffer as busy exporting something, or not
void setExportStatus(bool e) const;
+ ///
+ mutable bool removeBiblioTemps = false;
///
References & getReferenceCache(docstring const & label);
/// last time we loaded the cache. Note that this does NOT update the
/// cached information.
void checkIfBibInfoCacheIsValid() const;
- /// Return the list with all bibfiles in use (including bibfiles
- /// of loaded child documents).
- support::FileNamePairList const &
- getBibfiles(UpdateScope scope = UpdateMaster) const;
///
void collectChildren(ListOfBuffers & children, bool grand_children) const;
projects / lyx.git / blobdiff