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 class FileNamePairList;
74 } // namespace support
79 } // namespace graphics
83 typedef std::list<Buffer *> ListOfBuffers;
84 /// a list of Buffers we cloned
85 typedef std::set<Buffer *> CloneList;
88 /** The buffer object.
89 * This is the buffer object. It contains all the information about
90 * a document loaded into LyX.
91 * The buffer object owns the Text (wrapped in an InsetText), which
92 * contains the individual paragraphs of the document.
95 * I am not sure if the class is complete or
96 * minimal, probably not.
97 * \author Lars Gullik Bjønnes
100 class MarkAsExporting;
104 /// What type of log will \c getLogName() return?
106 latexlog, ///< LaTeX log
107 buildlog ///< Literate build log
110 /// Result of \c readFile()
120 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, starting
162 /// with the master and cloning all the children, too.
163 Buffer * cloneFromMaster() 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 bool 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" or
306 "default", 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 void writeLaTeXSource(otexstream & os,
327 std::string const & original_path,
328 OutputParams const &,
329 OutputWhat output = FullSource) const;
331 void makeDocBookFile(support::FileName const & filename,
332 OutputParams const & runparams_in,
333 OutputWhat output = FullSource) const;
335 void writeDocBookSource(odocstream & os, std::string const & filename,
336 OutputParams const & runparams_in,
337 OutputWhat output = FullSource) const;
339 void makeLyXHTMLFile(support::FileName const & filename,
340 OutputParams const & runparams_in) const;
342 void 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
418 std::vector<docstring> const prepareBibFilePaths(OutputParams const &,
419 support::FileNamePairList const 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 /// Updates the cached bibliography information, checking first to see
504 /// whether the cache is valid. If so, we do nothing. If not, then we
505 /// reload all the BibTeX info.
506 /// Note that this operates on the master document.
507 void reloadBibInfoCache() const;
508 /// \return the bibliography information for this buffer's master,
509 /// or just for it, if it isn't a child.
510 BiblioInfo const & masterBibInfo() const;
511 /// \return this buffer's bibliography information
512 BiblioInfo const & bibInfo() const;
513 /// collect bibliography info from the various insets in this buffer.
514 void collectBibKeys(support::FileNameList &) const;
515 /// add some BiblioInfo to our cache
516 void addBiblioInfo(BiblioInfo const & bi) const;
517 /// add a single piece of bibliography info to our cache
518 void addBibTeXInfo(docstring const & key, BibTeXInfo const & bi) const;
520 void makeCitationLabels() const;
522 void invalidateCiteLabels() const;
524 bool citeLabelsValid() const;
526 void getLabelList(std::vector<docstring> &) const;
528 /// This removes the .aux and .bbl files from the temp dir.
529 void removeBiblioTempFiles() const;
532 void changeLanguage(Language const * from, Language const * to);
535 bool isMultiLingual() const;
537 std::set<Language const *> getLanguages() const;
540 BufferParams & params();
541 BufferParams const & params() const;
543 BufferParams const & masterParams() const;
545 /** The list of paragraphs.
546 This is a linked list of paragraph, this list holds the
547 whole contents of the document.
549 ParagraphList & paragraphs();
550 ParagraphList const & paragraphs() const;
552 /// LyX version control object.
554 LyXVC const & lyxvc() const;
556 /// Where to put temporary files.
557 std::string const temppath() const;
559 /// Used when typesetting to place errorboxes.
560 TexRow const & texrow() const;
564 ParIterator par_iterator_begin();
566 ParConstIterator par_iterator_begin() const;
568 ParIterator par_iterator_end();
570 ParConstIterator par_iterator_end() const;
572 // Position of the child buffer where it appears first in the master.
573 DocIterator firstChildPosition(Buffer const * child);
575 /** \returns true only when the file is fully loaded.
576 * Used to prevent the premature generation of previews
577 * and by the citation inset.
579 bool isFullyLoaded() const;
580 /// Set by buffer_funcs' newFile.
581 void setFullyLoaded(bool);
583 /// FIXME: Needed by RenderPreview.
584 graphics::PreviewLoader * loader() const;
585 /// Update the LaTeX preview snippets associated with this buffer
586 void updatePreviews() const;
587 /// Remove any previewed LaTeX snippets associated with this buffer
588 void removePreviews() const;
590 graphics::Cache & graphicsCache() const;
592 /// Our main text (inside the top InsetText)
595 /// Our top InsetText
596 Inset & inset() const;
601 /// Collect macro definitions in paragraphs
602 void updateMacros() const;
603 /// Iterate through the whole buffer and try to resolve macros
604 void updateMacroInstances(UpdateType) const;
606 /// List macro names of this buffer, the parent and the children
607 void listMacroNames(MacroNameSet & macros) const;
608 /// Collect macros of the parent and its children in front of this buffer.
609 void listParentMacros(MacroSet & macros, LaTeXFeatures & features) const;
611 /// Return macro defined before pos (or in the master buffer)
612 MacroData const * getMacro(docstring const & name, DocIterator const & pos, bool global = true) const;
613 /// Return macro defined anywhere in the buffer (or in the master buffer)
614 MacroData const * getMacro(docstring const & name, bool global = true) const;
615 /// Return macro defined before the inclusion of the child
616 MacroData const * getMacro(docstring const & name, Buffer const & child, bool global = true) const;
618 /// Collect user macro names at loading time
619 typedef std::set<docstring> UserMacroSet;
620 mutable UserMacroSet usermacros;
622 /// Replace the inset contents for insets which InsetCode is equal
623 /// to the passed \p inset_code.
624 void changeRefsIfUnique(docstring const & from, docstring const & to);
626 /// get source code (latex/docbook) for some paragraphs, or all paragraphs
627 /// including preamble
628 /// returns nullptr if Id to Row conversion is unsupported
629 unique_ptr<TexRow> getSourceCode(odocstream & os,
630 std::string const & format, pit_type par_begin,
631 pit_type par_end, OutputWhat output, bool master) const;
633 /// Access to error list.
634 /// This method is used only for GUI visualisation of Buffer related
635 /// errors (like parsing or LateX compilation). This method is const
636 /// because modifying the returned ErrorList does not touch the document
638 ErrorList & errorList(std::string const & type) const;
641 /// This is useful only for screen visualisation of the Buffer. This
642 /// method is const because modifying this backend does not touch
643 /// the document contents.
644 TocBackend & tocBackend() const;
649 /// This function is called when the buffer is changed.
650 void changed(bool update_metrics) const;
652 void setChild(DocIterator const & dit, Buffer * child);
654 void updateTocItem(std::string const &, DocIterator const &) const;
655 /// This function is called when the buffer structure is changed.
656 void structureChanged() const;
657 /// This function is called when some parsing error shows up.
658 void errors(std::string const & err, bool from_master = false) const;
659 /// This function is called when the buffer busy status change.
660 void setBusy(bool on) const;
661 /// Update window titles of all users.
662 void updateTitles() const;
663 /// Reset autosave timers for all users.
664 void resetAutosaveTimers() const;
666 void message(docstring const & msg) const;
669 void setGuiDelegate(frontend::GuiBufferDelegate * gui);
671 bool hasGuiDelegate() const;
674 ExportStatus doExport(std::string const & target, bool put_in_tempdir) const;
675 /// Export buffer to format \p format and open the result in a suitable viewer.
676 /// Note: This has nothing to do with preview of graphics or math formulas.
677 ExportStatus preview(std::string const & format) const;
678 /// true if there was a previous preview this session of this buffer and
679 /// there was an error on the previous preview of this buffer.
680 bool lastPreviewError() const;
684 ExportStatus doExport(std::string const & target, bool put_in_tempdir,
685 std::string & result_file) const;
686 /// target is a format name optionally followed by a space
687 /// and a destination file-name
688 ExportStatus doExport(std::string const & target, bool put_in_tempdir,
689 bool includeall, std::string & result_file) const;
691 ExportStatus preview(std::string const & format, bool includeall) const;
693 void setMathFlavor(OutputParams & op) const;
697 bool isExporting() const;
700 typedef std::vector<std::pair<Inset *, ParIterator> > References;
702 References const & references(docstring const & label) const;
704 void addReference(docstring const & label, Inset * inset, ParIterator it);
706 void clearReferenceCache() const;
708 void setInsetLabel(docstring const & label, InsetLabel const * il);
710 InsetLabel const * insetLabel(docstring const & label) const;
712 /// return a list of all used branches (also in children)
713 void getUsedBranches(std::list<docstring> &, bool const from_master = false) const;
715 /// Updates screen labels and some other information associated with
716 /// insets and paragraphs. Actually, it's more like a general "recurse
717 /// through the Buffer" routine, that visits all the insets and paragraphs.
718 void updateBuffer() const { updateBuffer(UpdateMaster, InternalUpdate); }
719 /// \param scope: whether to start with the master document or just
721 /// \param output: whether we are preparing for output.
722 void updateBuffer(UpdateScope scope, UpdateType utype) const;
724 void updateBuffer(ParIterator & parit, UpdateType utype) const;
726 /// Spellcheck starting from \p from.
727 /// \p from initial position, will then points to the next misspelled
729 /// \p to will points to the end of the next misspelled word.
730 /// \p word_lang will contain the found misspelled word.
731 /// \return progress if a new word was found.
732 int spellCheck(DocIterator & from, DocIterator & to,
733 WordLangTuple & word_lang, docstring_list & suggestions) const;
735 void checkChildBuffers();
737 void checkMasterBuffer();
739 /// If the document is being saved to a new location and the named file
740 /// exists at the old location, return its updated path relative to the
741 /// new buffer path if possible, otherwise return its absolute path.
742 /// In all other cases, this is a no-op and name is returned unchanged.
743 /// If a non-empty ext is given, the existence of name.ext is checked
744 /// but the returned path will not contain this extension.
745 /// Similarly, when loading a document that was moved from the location
746 /// where it was saved, return the correct path relative to the new
748 std::string includedFilePath(std::string const & name,
749 std::string const & ext = empty_string()) const;
751 /// compute statistics between \p from and \p to
752 /// \p from initial position
753 /// \p to points to the end position
754 /// \p skipNoOutput if notes etc. should be ignored
755 void updateStatistics(DocIterator & from, DocIterator & to,
756 bool skipNoOutput = true) const;
757 /// statistics accessor functions
758 int wordCount() const;
759 int charCount(bool with_blanks) const;
761 // this is const because it does not modify the buffer's real contents,
762 // only the mutable flag.
763 void setChangesPresent(bool) const;
764 bool areChangesPresent() const;
765 void updateChangesPresent() const;
767 void registerBibfiles(support::FileNamePairList const & bf) const;
770 friend class MarkAsExporting;
771 /// mark the buffer as busy exporting something, or not
772 void setExportStatus(bool e) const;
775 References & getReferenceCache(docstring const & label);
776 /// Change name of buffer. Updates "read-only" flag.
777 void setFileName(support::FileName const & fname);
779 void getLanguages(std::set<Language const *> &) const;
780 /// Checks whether any of the referenced bibfiles have changed since the
781 /// last time we loaded the cache. Note that this does NOT update the
782 /// cached information.
783 void checkIfBibInfoCacheIsValid() const;
784 /// Return the list with all bibfiles in use (including bibfiles
785 /// of loaded child documents).
786 support::FileNamePairList const &
787 getBibfiles(UpdateScope scope = UpdateMaster) const;
789 void collectChildren(ListOfBuffers & children, bool grand_children) const;
792 Buffer(Buffer const &);
793 void operator=(Buffer const &);
795 /// Use the Pimpl idiom to hide the internals.
797 /// The pointer never changes although *pimpl_'s contents may.
802 /// Helper class, to guarantee that the export status
803 /// gets reset properly. To use, simply create a local variable:
804 /// MarkAsExporting mex(bufptr);
805 /// and leave the rest to us.
806 class MarkAsExporting {
808 MarkAsExporting(Buffer const * buf) : buf_(buf)
810 buf_->setExportStatus(true);
814 buf_->setExportStatus(false);
817 Buffer const * const buf_;