4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
9 * Full author contact details are available in file CREDITS.
15 #include "OutputEnums.h"
17 #include "support/unique_ptr.h"
18 #include "support/strfwd.h"
19 #include "support/types.h"
53 class ParConstIterator;
61 class GuiBufferDelegate;
62 class WorkAreaManager;
63 } // namespace frontend
69 } // namespace support
74 } // namespace graphics
78 typedef std::list<Buffer *> ListOfBuffers;
79 /// a list of Buffers we cloned
80 typedef std::set<Buffer *> CloneList;
81 typedef std::shared_ptr<CloneList> CloneList_ptr;
84 /** The buffer object.
85 * This is the buffer object. It contains all the information about
86 * a document loaded into LyX.
87 * The buffer object owns the Text (wrapped in an InsetText), which
88 * contains the individual paragraphs of the document.
91 * I am not sure if the class is complete or
92 * minimal, probably not.
93 * \author Lars Gullik Bjønnes
98 /// What type of log will \c getLogName() return?
100 latexlog, ///< LaTeX log
101 buildlog ///< Literate build log
104 /// Result of \c readFile()
114 ReadEmergencyFailure,
132 ExportNoPathToFormat,
133 ExportTexPathHasSpaces,
134 ExportConverterError,
136 // Implies ExportSuccess.
138 // The exported file exists but there was an error when opening
150 explicit Buffer(std::string const & file, bool readonly = false,
151 Buffer const * cloned_buffer = nullptr);
156 /// Clones the entire structure of which this Buffer is part,
157 /// cloning all the children, too.
158 Buffer * cloneWithChildren() const;
159 /// Just clones this single Buffer. For autosave.
160 Buffer * cloneBufferOnly() const;
162 bool isClone() const;
164 /** High-level interface to buffer functionality.
165 This function parses a command string and executes it.
167 void dispatch(std::string const & command, DispatchResult & result);
169 /// Maybe we know the function already by number...
170 void dispatch(FuncRequest const & func, DispatchResult & result);
172 /// Can this function be exectued?
173 /// \return true if we made a decision
174 bool getStatus(FuncRequest const & cmd, FuncStatus & flag);
177 DocIterator getParFromID(int id) const;
178 /// do we have a paragraph with this id?
179 bool hasParWithID(int id) const;
182 frontend::WorkAreaManager & workAreaManager() const;
185 Takes care of auto-save files and backup file if requested.
186 Returns \c true if the save is successful, \c false otherwise.
189 /// Renames and saves the buffer
190 bool saveAs(support::FileName const & fn);
192 /// Write document to stream. Returns \c false if unsuccessful.
193 bool write(std::ostream &) const;
194 /// Write file. Returns \c false if unsuccessful.
195 bool writeFile(support::FileName const &) const;
197 /// \name Functions involved in reading files/strings.
199 /// Loads the LyX file into the buffer. This function
200 /// tries to extract the file from version control if it
201 /// cannot be found. If it can be found, it will try to
202 /// read an emergency save file or an autosave file.
203 /// \sa loadThisLyXFile
204 ReadStatus loadLyXFile();
205 /// Loads the LyX file \c fn into the buffer. If you want
206 /// to check for files in a version control container,
207 /// emergency or autosave files, one should use \c loadLyXFile.
209 ReadStatus loadThisLyXFile(support::FileName const & fn);
210 /// import a new document from a string
211 bool importString(std::string const &, docstring const &, ErrorList &);
212 /// import a new file
213 bool importFile(std::string const &, support::FileName const &, ErrorList &);
214 /// read a new document from a string
215 bool readString(std::string const &);
216 /// Reloads the LyX file
218 //FIXME: The following function should be private
220 /// read the header, returns number of unknown tokens
221 int readHeader(Lexer & lex);
223 double fontScalingFactor() const;
227 typedef std::map<Buffer const *, Buffer *> BufferMap;
229 void cloneWithChildren(BufferMap &, CloneList_ptr) const;
230 /// save checksum of the given file.
231 void saveCheckSum() const;
233 ReadStatus readFile(support::FileName const & fn);
234 /// Reads a file without header.
235 /// \param par if != 0 insert the file.
236 /// \return \c true if file is not completely read.
237 bool readDocument(Lexer &);
238 /// Try to extract the file from a version control container
239 /// before reading if the file cannot be found.
240 /// \sa LyXVC::file_not_found_hook
241 ReadStatus extractFromVC();
242 /// Reads the first tag of a LyX File and
243 /// returns the file format number.
244 ReadStatus parseLyXFormat(Lexer & lex, support::FileName const & fn,
245 int & file_format) const;
246 /// Convert the LyX file to the LYX_FORMAT using
247 /// the lyx2lyx script and returns the filename
248 /// of the temporary file to be read
249 ReadStatus convertLyXFormat(support::FileName const & fn,
250 support::FileName & tmpfile, int from_format);
251 /// get appropriate name for backing up files from older versions
252 support::FileName getBackupName() const;
256 /// \name Functions involved in autosave and emergency files.
258 /// Save an autosave file to #filename.lyx#
259 bool autoSave() const;
260 /// save emergency file
261 /// \return a status message towards the user.
262 docstring emergencyWrite() const;
264 //FIXME:The following function should be private
267 void removeAutosaveFile() const;
270 /// Try to load an autosave file associated to \c fn.
271 ReadStatus loadAutosave();
272 /// Try to load an emergency file associated to \c fn.
273 ReadStatus loadEmergency();
274 /// Get the filename of the emergency file associated with the Buffer
275 support::FileName getEmergencyFileName() const;
276 /// Get the filename of the autosave file associated with the Buffer
277 support::FileName getAutosaveFileName() const;
279 void moveAutosaveFile(support::FileName const & old) const;
283 /// Fill in the ErrorList with the TeXErrors
284 void bufferErrors(TeXErrors const &, ErrorList &) const;
285 /// Fill in the Citation/Reference ErrorList from the TeXErrors
286 void bufferRefs(TeXErrors const &, ErrorList &) const;
296 /// Just a wrapper for writeLaTeXSource, first creating the ofstream.
297 ExportStatus makeLaTeXFile(support::FileName const & filename,
298 std::string const & original_path,
299 OutputParams const &,
300 OutputWhat output = FullSource) const;
301 /** Export the buffer to LaTeX.
302 If \p os is a file stream, and params().inputenc is "auto-legacy" or
303 "auto-legacy-plain", and the buffer contains text in different languages
304 with more than one encoding, then this method will change the
305 encoding associated to \p os. Therefore you must not call this
306 method with a string stream if the output is supposed to go to a
310 ofs.open("test.tex");
311 writeLaTeXSource(os, ...);
313 \endcode is NOT equivalent to \code
314 odocstringstream oss;
316 writeLaTeXSource(os, ...);
318 ofs.open("test.tex");
323 ExportStatus writeLaTeXSource(otexstream & os,
324 std::string const & original_path,
325 OutputParams const &,
326 OutputWhat output = FullSource) const;
328 ExportStatus makeDocBookFile(support::FileName const & filename,
329 OutputParams const & runparams_in,
330 OutputWhat output = FullSource) const;
332 ExportStatus writeDocBookSource(odocstream & os,
333 OutputParams const & runparams_in,
334 OutputWhat output = FullSource) const;
336 ExportStatus makeLyXHTMLFile(support::FileName const & filename,
337 OutputParams const & runparams_in) const;
339 ExportStatus writeLyXHTMLSource(odocstream & os,
340 OutputParams const & runparams_in,
341 OutputWhat output = FullSource) const;
342 /// returns the main language for the buffer (document)
343 Language const * language() const;
344 /// get l10n translated to the buffers language
345 docstring B_(std::string const & l10n) const;
349 /// return true if the main lyx file does not need saving
350 bool isClean() const;
352 bool isDepClean(std::string const & name) const;
354 /// Whether or not disk file has been externally modified. Uses a checksum
355 /// which is accurate but slow, which can be a problem when it is frequently
356 /// used, or used for a large file on a slow (network) file system.
357 bool isChecksumModified() const;
359 /// Flag set by the FileSystemWatcher.
360 /// Fast but (not so) inaccurate, can be cleared by the user.
361 bool notifiesExternalModification() const;
362 void clearExternalModification() const;
364 /// mark the main lyx file as not needing saving
365 void markClean() const;
368 void markDepClean(std::string const & name);
371 void setUnnamed(bool flag = true);
373 /// Whether or not a filename has been assigned to this buffer
374 bool isUnnamed() const;
376 /// Whether or not this buffer is internal.
378 /// An internal buffer does not contain a real document, but some auxiliary text segment.
379 /// It is not associated with a filename, it is never saved, thus it does not need to be
380 /// automatically saved, nor it needs to trigger any "do you want to save ?" question.
381 bool isInternal() const;
383 void setInternal(bool flag);
385 /// Mark this buffer as dirty.
388 /// Returns the buffer's filename. It is always an absolute path.
389 support::FileName fileName() const;
391 /// Returns the buffer's filename. It is always an absolute path.
392 std::string absFileName() const;
394 /// Returns the path where the buffer lives.
395 /// It is always an absolute path.
396 std::string filePath() const;
398 /** Contructs a file name of a referenced file (child doc, included graphics etc).
399 * Absolute names are returned as is. If the name is relative, it is
400 * interpreted relative to filePath() if the file exists, otherwise
401 * relative to the original path where the document was last saved.
402 * The original path may be different from filePath() if the document was
403 * later manually moved to a different location.
405 support::DocFileName getReferencedFileName(std::string const & fn) const;
407 /// Format a file name for LaTeX output (absolute or relative or filename only,
408 /// depending on file and context)
409 std::string const prepareFileNameForLaTeX(std::string const &,
410 std::string const &, bool nice) const;
412 /** Returns a vector of bibliography (*.bib) file paths suitable for the
413 * output in the respective BibTeX/Biblatex macro and potential individual encoding
415 std::vector<std::pair<docstring, std::string>> const prepareBibFilePaths(OutputParams const &,
416 const docstring_list & bibfilelist,
417 bool const extension = true) const;
419 /** Returns the path where a local layout file lives.
420 * An empty string is returned for standard system and user layouts.
421 * If possible, it is always relative to the buffer path.
423 std::string layoutPos() const;
425 /** Set the path to a local layout file.
426 * This must be an absolute path but, if possible, it is always
427 * stored as relative to the buffer path.
429 void setLayoutPos(std::string const & path);
431 /** A transformed version of the file name, adequate for LaTeX.
432 \param no_path optional if \c true then the path is stripped.
434 std::string latexName(bool no_path = true) const;
436 /// Get the name and type of the log.
437 std::string logName(LogType * type = nullptr) const;
439 /// Set document's parent Buffer.
440 void setParent(Buffer const *);
441 Buffer const * parent() const;
443 /** Get the document's master (or \c this if this is not a
446 Buffer const * masterBuffer() const;
448 /// \return true if \p child is a child of this \c Buffer.
449 bool isChild(Buffer * child) const;
451 /// \return true if this \c Buffer has children
452 bool hasChildren() const;
454 /// \return a list of the direct children of this Buffer.
455 /// this list has no duplicates and is in the order in which
456 /// the children appear.
457 ListOfBuffers getChildren() const;
459 /// \return a list of all descendants of this Buffer (children,
460 /// grandchildren, etc). this list has no duplicates and is in
461 /// the order in which the children appear.
462 ListOfBuffers getDescendants() const;
464 /// Collect all relative buffers, in the order in which they appear.
465 /// I.e., the "root" Buffer is first, then its first child, then any
466 /// of its children, etc. However, there are no duplicates in this
468 /// This is "stable", too, in the sense that it returns the same
469 /// thing from whichever Buffer it is called.
470 ListOfBuffers allRelatives() const;
472 /// Is buffer read-only? True if it has either the read-only flag or the
473 /// externally modified flag.
474 bool isReadonly() const;
476 /// Does the buffer have the read-only flag?
477 bool hasReadonlyFlag() const;
479 /// Set buffer read-only flag
480 void setReadonly(bool flag = true);
482 /** Validate a buffer for LaTeX.
483 This validates the buffer, and returns a struct for use by
484 #makeLaTeX# and others. Its main use is to figure out what
485 commands and packages need to be included in the LaTeX file.
486 It (should) also check that the needed constructs are there
487 (i.e. that the \refs points to coresponding \labels). It
488 should perhaps inset "error" insets to help the user correct
491 void validate(LaTeXFeatures &) const;
493 /// Bibliography information is cached in the Buffer, so we do not
494 /// have to check or read things over and over.
495 /// The cache exists only in the master buffer. When it is updated,
496 /// the children add their information to the master's cache.
497 /// Calling this method invalidates the cache and so requires a
499 void invalidateBibinfoCache() const;
500 /// Clear the bibfiles cache
501 void clearBibFileCache() const;
502 /// Updates the cached bibliography information, checking first to see
503 /// whether the cache is valid. If so, we do nothing. If not, then we
504 /// reload all the BibTeX info.
505 /// Note that this operates on the master document.
506 void reloadBibInfoCache(bool const force = false) const;
507 /// \return the bibliography information for this buffer's master,
508 /// or just for it, if it isn't a child.
509 BiblioInfo const & masterBibInfo() const;
510 /// \return this buffer's bibliography information
511 BiblioInfo const & bibInfo() const;
512 /// collect bibliography info from the various insets in this buffer.
513 void collectBibKeys(support::FileNameList &) const;
514 /// add some BiblioInfo to our cache
515 void addBiblioInfo(BiblioInfo const & bi) const;
516 /// add a single piece of bibliography info to our cache
517 void addBibTeXInfo(docstring const & key, BibTeXInfo const & bi) const;
519 void makeCitationLabels() const;
521 void invalidateCiteLabels() const;
523 bool citeLabelsValid() const;
525 void getLabelList(std::vector<docstring> &) const;
527 /// This removes the .aux and .bbl files from the temp dir.
528 void removeBiblioTempFiles() const;
531 void changeLanguage(Language const * from, Language const * to);
534 bool isMultiLingual() const;
536 std::set<Language const *> getLanguages() const;
539 BufferParams & params();
540 BufferParams const & params() const;
542 BufferParams const & masterParams() const;
544 /** The list of paragraphs.
545 This is a linked list of paragraph, this list holds the
546 whole contents of the document.
548 ParagraphList & paragraphs();
549 ParagraphList const & paragraphs() const;
551 /// LyX version control object.
553 LyXVC const & lyxvc() const;
555 /// Where to put temporary files.
556 std::string const temppath() const;
558 /// Used when typesetting to place errorboxes.
559 TexRow const & texrow() const;
563 ParIterator par_iterator_begin();
565 ParConstIterator par_iterator_begin() const;
567 ParIterator par_iterator_end();
569 ParConstIterator par_iterator_end() const;
570 /// Is document empty ?
573 // Position of the child buffer where it appears first in the master.
574 DocIterator firstChildPosition(Buffer const * child);
576 /** \returns true only when the file is fully loaded.
577 * Used to prevent the premature generation of previews
578 * and by the citation inset.
580 bool isFullyLoaded() const;
581 /// Set by buffer_funcs' newFile.
582 void setFullyLoaded(bool);
584 /// FIXME: Needed by RenderPreview.
585 graphics::PreviewLoader * loader() const;
586 /// Update the LaTeX preview snippets associated with this buffer
587 void updatePreviews() const;
588 /// Remove any previewed LaTeX snippets associated with this buffer
589 void removePreviews() const;
591 graphics::Cache & graphicsCache() const;
593 /// Our main text (inside the top InsetText)
596 /// Our top InsetText
597 Inset & inset() const;
602 /// Collect macro definitions in paragraphs
603 void updateMacros() const;
604 /// Iterate through the whole buffer and try to resolve macros
605 void updateMacroInstances(UpdateType) const;
607 /// List macro names of this buffer, the parent and the children
608 void listMacroNames(MacroNameSet & macros) const;
609 /// Collect macros of the parent and its children in front of this buffer.
610 void listParentMacros(MacroSet & macros, LaTeXFeatures & features) const;
612 /// Return macro defined before pos (or in the master buffer)
613 MacroData const * getMacro(docstring const & name, DocIterator const & pos, bool global = true) const;
614 /// Return macro defined anywhere in the buffer (or in the master buffer)
615 MacroData const * getMacro(docstring const & name, bool global = true) const;
616 /// Return macro defined before the inclusion of the child
617 MacroData const * getMacro(docstring const & name, Buffer const & child, bool global = true) const;
619 /// Collect user macro names at loading time
620 typedef std::set<docstring> UserMacroSet;
621 mutable UserMacroSet usermacros;
623 /// Replace the inset contents for insets which InsetCode is equal
624 /// to the passed \p inset_code. Handles undo.
625 void changeRefsIfUnique(docstring const & from, docstring const & to);
627 /// get source code (latex/docbook) for some paragraphs, or all paragraphs
628 /// including preamble
629 /// returns nullptr if Id to Row conversion is unsupported
630 unique_ptr<TexRow> getSourceCode(odocstream & os,
631 std::string const & format, pit_type par_begin,
632 pit_type par_end, OutputWhat output, bool master) const;
634 /// Access to error list.
635 /// This method is used only for GUI visualisation of Buffer related
636 /// errors (like parsing or LateX compilation). This method is const
637 /// because modifying the returned ErrorList does not touch the document
639 ErrorList & errorList(std::string const & type) const;
642 /// This is useful only for screen visualisation of the Buffer. This
643 /// method is const because modifying this backend does not touch
644 /// the document contents.
645 TocBackend & tocBackend() const;
650 /// This function is called when the buffer is changed.
651 void changed(bool update_metrics) const;
653 void setChild(DocIterator const & dit, Buffer * child);
655 void updateTocItem(std::string const &, DocIterator const &) const;
656 /// This function is called when the buffer structure is changed.
657 void structureChanged() const;
658 /// This function is called when some parsing error shows up.
659 void errors(std::string const & err, bool from_master = false) const;
660 /// This function is called when the buffer busy status change.
661 void setBusy(bool on) const;
662 /// Update window titles of all users.
663 void updateTitles() const;
664 /// Reset autosave timers for all users.
665 void resetAutosaveTimers() const;
667 void message(docstring const & msg) const;
670 void setGuiDelegate(frontend::GuiBufferDelegate * gui);
672 bool hasGuiDelegate() const;
675 ExportStatus doExport(std::string const & target, bool put_in_tempdir) const;
676 /// Export buffer to format \p format and open the result in a suitable viewer.
677 /// Note: This has nothing to do with preview of graphics or math formulas.
678 ExportStatus preview(std::string const & format) const;
679 /// true if there was a previous preview this session of this buffer and
680 /// there was an error on the previous preview of this buffer.
681 bool freshStartRequired() const;
683 void requireFreshStart(bool const b) const;
687 ExportStatus doExport(std::string const & target, bool put_in_tempdir,
688 std::string & result_file) const;
689 /// target is a format name optionally followed by a space
690 /// and a destination file-name
691 ExportStatus doExport(std::string const & target, bool put_in_tempdir,
692 bool includeall, std::string & result_file) const;
694 ExportStatus preview(std::string const & format, bool includeall) const;
696 void setMathFlavor(OutputParams & op) const;
700 bool isExporting() const;
702 /// A collection of InsetRef insets and their position in the buffer
703 typedef std::vector<std::pair<Inset *, ParIterator> > References;
704 /// Get all InsetRef insets and their positions associated with
705 /// the InsetLabel with the label string \p label
706 References const & references(docstring const & label) const;
707 /// Add an InsetRef at position \p it to the Insetlabel
708 /// with the label string \p label
709 void addReference(docstring const & label, Inset * inset, ParIterator it);
710 /// Clear the whole reference cache
711 void clearReferenceCache() const;
712 /// Set the InsetLabel for a given \p label string. \p active
713 /// determines whether this is an active label (see @ref activeLabel)
714 void setInsetLabel(docstring const & label, InsetLabel const * il,
716 /// \return the InsetLabel associated with this \p label string
717 /// If \p active is true we only return active labels
718 /// (see @ref activeLabel)
719 InsetLabel const * insetLabel(docstring const & label,
720 bool const active = false) const;
721 /// \return true if this \param label is an active label.
722 /// Inactive labels are currently deleted labels (in ct mode)
723 bool activeLabel(docstring const & label) const;
725 /// return a list of all used branches (also in children)
726 void getUsedBranches(std::list<docstring> &, bool const from_master = false) const;
728 /// Updates screen labels and some other information associated with
729 /// insets and paragraphs. Actually, it's more like a general "recurse
730 /// through the Buffer" routine, that visits all the insets and paragraphs.
731 void updateBuffer() const { updateBuffer(UpdateMaster, InternalUpdate); }
732 /// \param scope: whether to start with the master document or just
734 /// \param output: whether we are preparing for output.
735 void updateBuffer(UpdateScope scope, UpdateType utype) const;
737 void updateBuffer(ParIterator & parit, UpdateType utype, bool const deleted = false) const;
738 /// Forces an updateBuffer() call
739 void forceUpdate() const;
740 /// Do we need to call updateBuffer()?
741 bool needUpdate() const;
743 /// Spellcheck starting from \p from.
744 /// \p from initial position, will then points to the next misspelled
746 /// \p to will points to the end of the next misspelled word.
747 /// \p word_lang will contain the found misspelled word.
748 /// \return progress if a new word was found.
749 int spellCheck(DocIterator & from, DocIterator & to,
750 WordLangTuple & word_lang, docstring_list & suggestions) const;
752 void checkChildBuffers();
754 void checkMasterBuffer();
756 /// If the document is being saved to a new location and the named file
757 /// exists at the old location, return its updated path relative to the
758 /// new buffer path if possible, otherwise return its absolute path.
759 /// In all other cases, this is a no-op and name is returned unchanged.
760 /// If a non-empty ext is given, the existence of name.ext is checked
761 /// but the returned path will not contain this extension.
762 /// Similarly, when loading a document that was moved from the location
763 /// where it was saved, return the correct path relative to the new
765 std::string includedFilePath(std::string const & name,
766 std::string const & ext = empty_string()) const;
768 /// compute statistics between \p from and \p to
769 /// \p from initial position
770 /// \p to points to the end position
771 /// \p skipNoOutput if notes etc. should be ignored
772 void updateStatistics(DocIterator & from, DocIterator & to,
773 bool skipNoOutput = true) const;
774 /// statistics accessor functions
775 int wordCount() const;
776 int charCount(bool with_blanks) const;
779 bool areChangesPresent() const;
782 void registerBibfiles(docstring_list const & bf) const;
784 support::FileName getBibfilePath(docstring const & bibid) const;
786 /// routines for dealing with possible self-inclusion
787 void pushIncludedBuffer(Buffer const * buf) const;
788 void popIncludedBuffer() const;
789 bool isBufferIncluded(Buffer const * buf) const;
791 void clearIncludeList() const;
794 friend class MarkAsExporting;
795 /// mark the buffer as busy exporting something, or not
796 void setExportStatus(bool e) const;
799 References & getReferenceCache(docstring const & label);
800 /// Change name of buffer. Updates "read-only" flag.
801 void setFileName(support::FileName const & fname);
803 void getLanguages(std::set<Language const *> &) const;
804 /// Checks whether any of the referenced bibfiles have changed since the
805 /// last time we loaded the cache. Note that this does NOT update the
806 /// cached information.
807 void checkIfBibInfoCacheIsValid() const;
808 /// Return the list with all bibfiles in use (including bibfiles
809 /// of loaded child documents).
810 docstring_list const &
811 getBibfiles(UpdateScope scope = UpdateMaster) const;
813 void collectChildren(ListOfBuffers & children, bool grand_children) const;
816 Buffer(Buffer const &);
817 void operator=(Buffer const &);
819 /// Use the Pimpl idiom to hide the internals.
821 /// The pointer never changes although *pimpl_'s contents may.
826 /// Helper class, to guarantee that the export status
827 /// gets reset properly. To use, simply create a local variable:
828 /// MarkAsExporting mex(bufptr);
829 /// and leave the rest to us.
830 class MarkAsExporting {
832 MarkAsExporting(Buffer const * buf) : buf_(buf)
834 buf_->setExportStatus(true);
838 buf_->setExportStatus(false);
841 Buffer const * const buf_;