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"
20 #include "support/FileNameList.h"
56 class ParConstIterator;
66 class GuiBufferDelegate;
67 class WorkAreaManager;
68 } // namespace frontend
73 } // namespace support
78 } // namespace graphics
82 typedef std::list<Buffer *> ListOfBuffers;
83 /// a list of Buffers we cloned
84 typedef std::set<Buffer *> CloneList;
87 /** The buffer object.
88 * This is the buffer object. It contains all the information about
89 * a document loaded into LyX.
90 * The buffer object owns the Text (wrapped in an InsetText), which
91 * contains the individual paragraphs of the document.
94 * I am not sure if the class is complete or
95 * minimal, probably not.
96 * \author Lars Gullik Bjønnes
99 class MarkAsExporting;
103 /// What type of log will \c getLogName() return?
105 latexlog, ///< LaTeX log
106 buildlog ///< Literate build log
109 /// Result of \c readFile()
119 ReadEmergencyFailure,
137 ExportNoPathToFormat,
138 ExportTexPathHasSpaces,
139 ExportConverterError,
141 // Implies ExportSuccess.
143 // The exported file exists but there was an error when opening
155 explicit Buffer(std::string const & file, bool readonly = false,
156 Buffer const * cloned_buffer = 0);
161 /// Clones the entire structure of which this Buffer is part,
162 /// cloning all the children, too.
163 Buffer * cloneWithChildren() const;
164 /// Just clones this single Buffer. For autosave.
165 Buffer * cloneBufferOnly() const;
167 bool isClone() const;
169 /** High-level interface to buffer functionality.
170 This function parses a command string and executes it.
172 void dispatch(std::string const & command, DispatchResult & result);
174 /// Maybe we know the function already by number...
175 void dispatch(FuncRequest const & func, DispatchResult & result);
177 /// Can this function be exectued?
178 /// \return true if we made a decision
179 bool getStatus(FuncRequest const & cmd, FuncStatus & flag);
182 DocIterator getParFromID(int id) const;
183 /// do we have a paragraph with this id?
184 bool hasParWithID(int id) const;
187 frontend::WorkAreaManager & workAreaManager() const;
190 Takes care of auto-save files and backup file if requested.
191 Returns \c true if the save is successful, \c false otherwise.
194 /// Renames and saves the buffer
195 bool saveAs(support::FileName const & fn);
197 /// Write document to stream. Returns \c false if unsuccessful.
198 bool write(std::ostream &) const;
199 /// Write file. Returns \c false if unsuccessful.
200 bool writeFile(support::FileName const &) const;
202 /// \name Functions involved in reading files/strings.
204 /// Loads the LyX file into the buffer. This function
205 /// tries to extract the file from version control if it
206 /// cannot be found. If it can be found, it will try to
207 /// read an emergency save file or an autosave file.
208 /// \sa loadThisLyXFile
209 ReadStatus loadLyXFile();
210 /// Loads the LyX file \c fn into the buffer. If you want
211 /// to check for files in a version control container,
212 /// emergency or autosave files, one should use \c loadLyXFile.
214 ReadStatus loadThisLyXFile(support::FileName const & fn);
215 /// import a new document from a string
216 bool importString(std::string const &, docstring const &, ErrorList &);
217 /// import a new file
218 bool importFile(std::string const &, support::FileName const &, ErrorList &);
219 /// read a new document from a string
220 bool readString(std::string const &);
221 /// Reloads the LyX file
223 //FIXME: The following function should be private
225 /// read the header, returns number of unknown tokens
226 int readHeader(Lexer & lex);
228 double fontScalingFactor() const;
232 typedef std::map<Buffer const *, Buffer *> BufferMap;
234 void cloneWithChildren(BufferMap &, CloneList *) const;
235 /// save checksum of the given file.
236 void saveCheckSum() const;
238 ReadStatus readFile(support::FileName const & fn);
239 /// Reads a file without header.
240 /// \param par if != 0 insert the file.
241 /// \return \c true if file is not completely read.
242 bool readDocument(Lexer &);
243 /// Try to extract the file from a version control container
244 /// before reading if the file cannot be found.
245 /// \sa LyXVC::file_not_found_hook
246 ReadStatus extractFromVC();
247 /// Reads the first tag of a LyX File and
248 /// returns the file format number.
249 ReadStatus parseLyXFormat(Lexer & lex, support::FileName const & fn,
250 int & file_format) const;
251 /// Convert the LyX file to the LYX_FORMAT using
252 /// the lyx2lyx script and returns the filename
253 /// of the temporary file to be read
254 ReadStatus convertLyXFormat(support::FileName const & fn,
255 support::FileName & tmpfile, int from_format);
256 /// get appropriate name for backing up files from older versions
257 support::FileName getBackupName() const;
261 /// \name Functions involved in autosave and emergency files.
263 /// Save an autosave file to #filename.lyx#
264 bool autoSave() const;
265 /// save emergency file
266 /// \return a status message towards the user.
267 docstring emergencyWrite();
269 //FIXME:The following function should be private
272 void removeAutosaveFile() const;
275 /// Try to load an autosave file associated to \c fn.
276 ReadStatus loadAutosave();
277 /// Try to load an emergency file associated to \c fn.
278 ReadStatus loadEmergency();
279 /// Get the filename of the emergency file associated with the Buffer
280 support::FileName getEmergencyFileName() const;
281 /// Get the filename of the autosave file associated with the Buffer
282 support::FileName getAutosaveFileName() const;
284 void moveAutosaveFile(support::FileName const & old) const;
288 /// Fill in the ErrorList with the TeXErrors
289 void bufferErrors(TeXErrors const &, ErrorList &) const;
299 /// Just a wrapper for writeLaTeXSource, first creating the ofstream.
300 ExportStatus makeLaTeXFile(support::FileName const & filename,
301 std::string const & original_path,
302 OutputParams const &,
303 OutputWhat output = FullSource) const;
304 /** Export the buffer to LaTeX.
305 If \p os is a file stream, and params().inputenc is "auto-legacy" or
306 "auto-legacy-plain", and the buffer contains text in different languages
307 with more than one encoding, then this method will change the
308 encoding associated to \p os. Therefore you must not call this
309 method with a string stream if the output is supposed to go to a
313 ofs.open("test.tex");
314 writeLaTeXSource(os, ...);
316 \endcode is NOT equivalent to \code
317 odocstringstream oss;
319 writeLaTeXSource(os, ...);
321 ofs.open("test.tex");
326 ExportStatus writeLaTeXSource(otexstream & os,
327 std::string const & original_path,
328 OutputParams const &,
329 OutputWhat output = FullSource) const;
331 ExportStatus makeDocBookFile(support::FileName const & filename,
332 OutputParams const & runparams_in,
333 OutputWhat output = FullSource) const;
335 ExportStatus writeDocBookSource(odocstream & os, std::string const & filename,
336 OutputParams const & runparams_in,
337 OutputWhat output = FullSource) const;
339 ExportStatus makeLyXHTMLFile(support::FileName const & filename,
340 OutputParams const & runparams_in) const;
342 ExportStatus writeLyXHTMLSource(odocstream & os,
343 OutputParams const & runparams_in,
344 OutputWhat output = FullSource) const;
345 /// returns the main language for the buffer (document)
346 Language const * language() const;
347 /// get l10n translated to the buffers language
348 docstring const B_(std::string const & l10n) const;
352 /// return true if the main lyx file does not need saving
353 bool isClean() const;
355 bool isDepClean(std::string const & name) const;
357 /// Whether or not disk file has been externally modified. Uses a checksum
358 /// which is accurate but slow, which can be a problem when it is frequently
359 /// used, or used for a large file on a slow (network) file system.
360 bool isChecksumModified() const;
362 /// Flag set by the FileSystemWatcher.
363 /// Fast but (not so) inaccurate, can be cleared by the user.
364 bool notifiesExternalModification() const;
365 void clearExternalModification() const;
367 /// mark the main lyx file as not needing saving
368 void markClean() const;
371 void markDepClean(std::string const & name);
374 void setUnnamed(bool flag = true);
376 /// Whether or not a filename has been assigned to this buffer
377 bool isUnnamed() const;
379 /// Whether or not this buffer is internal.
381 /// An internal buffer does not contain a real document, but some auxiliary text segment.
382 /// It is not associated with a filename, it is never saved, thus it does not need to be
383 /// automatically saved, nor it needs to trigger any "do you want to save ?" question.
384 bool isInternal() const;
386 void setInternal(bool flag);
388 /// Mark this buffer as dirty.
391 /// Returns the buffer's filename. It is always an absolute path.
392 support::FileName fileName() const;
394 /// Returns the buffer's filename. It is always an absolute path.
395 std::string absFileName() const;
397 /// Returns the path where the buffer lives.
398 /// It is always an absolute path.
399 std::string filePath() const;
401 /** Contructs a file name of a referenced file (child doc, included graphics etc).
402 * Absolute names are returned as is. If the name is relative, it is
403 * interpreted relative to filePath() if the file exists, otherwise
404 * relative to the original path where the document was last saved.
405 * The original path may be different from filePath() if the document was
406 * later manually moved to a different location.
408 support::DocFileName getReferencedFileName(std::string const & fn) const;
410 /// Format a file name for LaTeX output (absolute or relative or filename only,
411 /// depending on file and context)
412 std::string const prepareFileNameForLaTeX(std::string const &,
413 std::string const &, bool nice) const;
415 /** Returns a vector of bibliography (*.bib) file paths suitable for the
416 * output in the respective BibTeX/Biblatex macro and potential individual encoding
418 std::vector<std::pair<docstring, std::string>> const prepareBibFilePaths(OutputParams const &,
419 const docstring_list & bibfilelist,
420 bool const extension = true) const;
422 /** Returns the path where a local layout file lives.
423 * An empty string is returned for standard system and user layouts.
424 * If possible, it is always relative to the buffer path.
426 std::string layoutPos() const;
428 /** Set the path to a local layout file.
429 * This must be an absolute path but, if possible, it is always
430 * stored as relative to the buffer path.
432 void setLayoutPos(std::string const & path);
434 /** A transformed version of the file name, adequate for LaTeX.
435 \param no_path optional if \c true then the path is stripped.
437 std::string latexName(bool no_path = true) const;
439 /// Get the name and type of the log.
440 std::string logName(LogType * type = 0) const;
442 /// Set document's parent Buffer.
443 void setParent(Buffer const *);
444 Buffer const * parent() const;
446 /** Get the document's master (or \c this if this is not a
449 Buffer const * masterBuffer() const;
451 /// \return true if \p child is a child of this \c Buffer.
452 bool isChild(Buffer * child) const;
454 /// \return true if this \c Buffer has children
455 bool hasChildren() const;
457 /// \return a list of the direct children of this Buffer.
458 /// this list has no duplicates and is in the order in which
459 /// the children appear.
460 ListOfBuffers getChildren() const;
462 /// \return a list of all descendents of this Buffer (children,
463 /// grandchildren, etc). this list has no duplicates and is in
464 /// the order in which the children appear.
465 ListOfBuffers getDescendents() const;
467 /// Collect all relative buffers, in the order in which they appear.
468 /// I.e., the "root" Buffer is first, then its first child, then any
469 /// of its children, etc. However, there are no duplicates in this
471 /// This is "stable", too, in the sense that it returns the same
472 /// thing from whichever Buffer it is called.
473 ListOfBuffers allRelatives() const;
475 /// Is buffer read-only? True if it has either the read-only flag or the
476 /// externally modified flag.
477 bool isReadonly() const;
479 /// Does the buffer have the read-only flag?
480 bool hasReadonlyFlag() const;
482 /// Set buffer read-only flag
483 void setReadonly(bool flag = true);
485 /** Validate a buffer for LaTeX.
486 This validates the buffer, and returns a struct for use by
487 #makeLaTeX# and others. Its main use is to figure out what
488 commands and packages need to be included in the LaTeX file.
489 It (should) also check that the needed constructs are there
490 (i.e. that the \refs points to coresponding \labels). It
491 should perhaps inset "error" insets to help the user correct
494 void validate(LaTeXFeatures &) const;
496 /// Bibliography information is cached in the Buffer, so we do not
497 /// have to check or read things over and over.
498 /// The cache exists only in the master buffer. When it is updated,
499 /// the children add their information to the master's cache.
500 /// Calling this method invalidates the cache and so requires a
502 void invalidateBibinfoCache() const;
503 /// Clear the bibfiles cache
504 void clearBibFileCache() const;
505 /// Updates the cached bibliography information, checking first to see
506 /// whether the cache is valid. If so, we do nothing. If not, then we
507 /// reload all the BibTeX info.
508 /// Note that this operates on the master document.
509 void reloadBibInfoCache(bool const force = false) const;
510 /// \return the bibliography information for this buffer's master,
511 /// or just for it, if it isn't a child.
512 BiblioInfo const & masterBibInfo() const;
513 /// \return this buffer's bibliography information
514 BiblioInfo const & bibInfo() const;
515 /// collect bibliography info from the various insets in this buffer.
516 void collectBibKeys(support::FileNameList &) const;
517 /// add some BiblioInfo to our cache
518 void addBiblioInfo(BiblioInfo const & bi) const;
519 /// add a single piece of bibliography info to our cache
520 void addBibTeXInfo(docstring const & key, BibTeXInfo const & bi) const;
522 void makeCitationLabels() const;
524 void invalidateCiteLabels() const;
526 bool citeLabelsValid() const;
528 void getLabelList(std::vector<docstring> &) const;
530 /// This removes the .aux and .bbl files from the temp dir.
531 void removeBiblioTempFiles() const;
534 void changeLanguage(Language const * from, Language const * to);
537 bool isMultiLingual() const;
539 std::set<Language const *> getLanguages() const;
542 BufferParams & params();
543 BufferParams const & params() const;
545 BufferParams const & masterParams() const;
547 /** The list of paragraphs.
548 This is a linked list of paragraph, this list holds the
549 whole contents of the document.
551 ParagraphList & paragraphs();
552 ParagraphList const & paragraphs() const;
554 /// LyX version control object.
556 LyXVC const & lyxvc() const;
558 /// Where to put temporary files.
559 std::string const temppath() const;
561 /// Used when typesetting to place errorboxes.
562 TexRow const & texrow() const;
566 ParIterator par_iterator_begin();
568 ParConstIterator par_iterator_begin() const;
570 ParIterator par_iterator_end();
572 ParConstIterator par_iterator_end() const;
574 // Position of the child buffer where it appears first in the master.
575 DocIterator firstChildPosition(Buffer const * child);
577 /** \returns true only when the file is fully loaded.
578 * Used to prevent the premature generation of previews
579 * and by the citation inset.
581 bool isFullyLoaded() const;
582 /// Set by buffer_funcs' newFile.
583 void setFullyLoaded(bool);
585 /// FIXME: Needed by RenderPreview.
586 graphics::PreviewLoader * loader() const;
587 /// Update the LaTeX preview snippets associated with this buffer
588 void updatePreviews() const;
589 /// Remove any previewed LaTeX snippets associated with this buffer
590 void removePreviews() const;
592 graphics::Cache & graphicsCache() const;
594 /// Our main text (inside the top InsetText)
597 /// Our top InsetText
598 Inset & inset() const;
603 /// Collect macro definitions in paragraphs
604 void updateMacros() const;
605 /// Iterate through the whole buffer and try to resolve macros
606 void updateMacroInstances(UpdateType) const;
608 /// List macro names of this buffer, the parent and the children
609 void listMacroNames(MacroNameSet & macros) const;
610 /// Collect macros of the parent and its children in front of this buffer.
611 void listParentMacros(MacroSet & macros, LaTeXFeatures & features) const;
613 /// Return macro defined before pos (or in the master buffer)
614 MacroData const * getMacro(docstring const & name, DocIterator const & pos, bool global = true) const;
615 /// Return macro defined anywhere in the buffer (or in the master buffer)
616 MacroData const * getMacro(docstring const & name, bool global = true) const;
617 /// Return macro defined before the inclusion of the child
618 MacroData const * getMacro(docstring const & name, Buffer const & child, bool global = true) const;
620 /// Collect user macro names at loading time
621 typedef std::set<docstring> UserMacroSet;
622 mutable UserMacroSet usermacros;
624 /// Replace the inset contents for insets which InsetCode is equal
625 /// to the passed \p inset_code.
626 void changeRefsIfUnique(docstring const & from, docstring const & to);
628 /// get source code (latex/docbook) for some paragraphs, or all paragraphs
629 /// including preamble
630 /// returns nullptr if Id to Row conversion is unsupported
631 unique_ptr<TexRow> getSourceCode(odocstream & os,
632 std::string const & format, pit_type par_begin,
633 pit_type par_end, OutputWhat output, bool master) const;
635 /// Access to error list.
636 /// This method is used only for GUI visualisation of Buffer related
637 /// errors (like parsing or LateX compilation). This method is const
638 /// because modifying the returned ErrorList does not touch the document
640 ErrorList & errorList(std::string const & type) const;
643 /// This is useful only for screen visualisation of the Buffer. This
644 /// method is const because modifying this backend does not touch
645 /// the document contents.
646 TocBackend & tocBackend() const;
651 /// This function is called when the buffer is changed.
652 void changed(bool update_metrics) const;
654 void setChild(DocIterator const & dit, Buffer * child);
656 void updateTocItem(std::string const &, DocIterator const &) const;
657 /// This function is called when the buffer structure is changed.
658 void structureChanged() const;
659 /// This function is called when some parsing error shows up.
660 void errors(std::string const & err, bool from_master = false) const;
661 /// This function is called when the buffer busy status change.
662 void setBusy(bool on) const;
663 /// Update window titles of all users.
664 void updateTitles() const;
665 /// Reset autosave timers for all users.
666 void resetAutosaveTimers() const;
668 void message(docstring const & msg) const;
671 void setGuiDelegate(frontend::GuiBufferDelegate * gui);
673 bool hasGuiDelegate() const;
676 ExportStatus doExport(std::string const & target, bool put_in_tempdir) const;
677 /// Export buffer to format \p format and open the result in a suitable viewer.
678 /// Note: This has nothing to do with preview of graphics or math formulas.
679 ExportStatus preview(std::string const & format) const;
680 /// true if there was a previous preview this session of this buffer and
681 /// there was an error on the previous preview of this buffer.
682 bool lastPreviewError() const;
686 ExportStatus doExport(std::string const & target, bool put_in_tempdir,
687 std::string & result_file) const;
688 /// target is a format name optionally followed by a space
689 /// and a destination file-name
690 ExportStatus doExport(std::string const & target, bool put_in_tempdir,
691 bool includeall, std::string & result_file) const;
693 ExportStatus preview(std::string const & format, bool includeall) const;
695 void setMathFlavor(OutputParams & op) const;
699 bool isExporting() const;
701 /// A collection of InsetRef insets and their position in the buffer
702 typedef std::vector<std::pair<Inset *, ParIterator> > References;
703 /// Get all InsetRef insets and their positions associated with
704 /// the InsetLabel with the label string \p label
705 References const & references(docstring const & label) const;
706 /// Add an InsetRef at position \p it to the Insetlabel
707 /// with the label string \p label
708 void addReference(docstring const & label, Inset * inset, ParIterator it);
709 /// Clear the whole reference cache
710 void clearReferenceCache() const;
711 /// Set the InsetLabel for a given \p label string. \p active
712 /// determines whether this is an active label (see @ref activeLabel)
713 void setInsetLabel(docstring const & label, InsetLabel const * il,
715 /// \return the InsetLabel associated with this \p label string
716 /// If \p active is true we only return active labels
717 /// (see @ref activeLabel)
718 InsetLabel const * insetLabel(docstring const & label,
719 bool const active = false) const;
720 /// \return true if this \param label is an active label.
721 /// Inactive labels are currently deleted labels (in ct mode)
722 bool activeLabel(docstring const & label) const;
724 /// return a list of all used branches (also in children)
725 void getUsedBranches(std::list<docstring> &, bool const from_master = false) const;
727 /// Updates screen labels and some other information associated with
728 /// insets and paragraphs. Actually, it's more like a general "recurse
729 /// through the Buffer" routine, that visits all the insets and paragraphs.
730 void updateBuffer() const { updateBuffer(UpdateMaster, InternalUpdate); }
731 /// \param scope: whether to start with the master document or just
733 /// \param output: whether we are preparing for output.
734 void updateBuffer(UpdateScope scope, UpdateType utype) const;
736 void updateBuffer(ParIterator & parit, UpdateType utype) const;
738 /// Spellcheck starting from \p from.
739 /// \p from initial position, will then points to the next misspelled
741 /// \p to will points to the end of the next misspelled word.
742 /// \p word_lang will contain the found misspelled word.
743 /// \return progress if a new word was found.
744 int spellCheck(DocIterator & from, DocIterator & to,
745 WordLangTuple & word_lang, docstring_list & suggestions) const;
747 void checkChildBuffers();
749 void checkMasterBuffer();
751 /// If the document is being saved to a new location and the named file
752 /// exists at the old location, return its updated path relative to the
753 /// new buffer path if possible, otherwise return its absolute path.
754 /// In all other cases, this is a no-op and name is returned unchanged.
755 /// If a non-empty ext is given, the existence of name.ext is checked
756 /// but the returned path will not contain this extension.
757 /// Similarly, when loading a document that was moved from the location
758 /// where it was saved, return the correct path relative to the new
760 std::string includedFilePath(std::string const & name,
761 std::string const & ext = empty_string()) const;
763 /// compute statistics between \p from and \p to
764 /// \p from initial position
765 /// \p to points to the end position
766 /// \p skipNoOutput if notes etc. should be ignored
767 void updateStatistics(DocIterator & from, DocIterator & to,
768 bool skipNoOutput = true) const;
769 /// statistics accessor functions
770 int wordCount() const;
771 int charCount(bool with_blanks) const;
773 // this is const because it does not modify the buffer's real contents,
774 // only the mutable flag.
775 void setChangesPresent(bool) const;
776 bool areChangesPresent() const;
777 void updateChangesPresent() const;
779 void registerBibfiles(docstring_list const & bf) const;
781 support::FileName getBibfilePath(docstring const & bibid) const;
784 friend class MarkAsExporting;
785 /// mark the buffer as busy exporting something, or not
786 void setExportStatus(bool e) const;
789 References & getReferenceCache(docstring const & label);
790 /// Change name of buffer. Updates "read-only" flag.
791 void setFileName(support::FileName const & fname);
793 void getLanguages(std::set<Language const *> &) const;
794 /// Checks whether any of the referenced bibfiles have changed since the
795 /// last time we loaded the cache. Note that this does NOT update the
796 /// cached information.
797 void checkIfBibInfoCacheIsValid() const;
798 /// Return the list with all bibfiles in use (including bibfiles
799 /// of loaded child documents).
800 docstring_list const &
801 getBibfiles(UpdateScope scope = UpdateMaster) const;
803 void collectChildren(ListOfBuffers & children, bool grand_children) const;
806 Buffer(Buffer const &);
807 void operator=(Buffer const &);
809 /// Use the Pimpl idiom to hide the internals.
811 /// The pointer never changes although *pimpl_'s contents may.
816 /// Helper class, to guarantee that the export status
817 /// gets reset properly. To use, simply create a local variable:
818 /// MarkAsExporting mex(bufptr);
819 /// and leave the rest to us.
820 class MarkAsExporting {
822 MarkAsExporting(Buffer const * buf) : buf_(buf)
824 buf_->setExportStatus(true);
828 buf_->setExportStatus(false);
831 Buffer const * const buf_;