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"
16 #include "OutputParams.h"
18 #include "support/strfwd.h"
19 #include "support/types.h"
54 class ParConstIterator;
64 class GuiBufferDelegate;
65 class WorkAreaManager;
79 typedef std::list<Buffer *> ListOfBuffers;
80 /// a list of Buffers we cloned
81 typedef std::set<Buffer *> CloneList;
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
96 class MarkAsExporting;
100 /// What type of log will \c getLogName() return?
102 latexlog, ///< LaTeX log
103 buildlog ///< Literate build log
106 /// Result of \c readFile()
116 ReadEmergencyFailure,
133 ExportNoPathToFormat,
134 ExportTexPathHasSpaces,
135 ExportConverterError,
141 /// Method to check if a file is externally modified, used by
142 /// isExternallyModified()
144 * timestamp is fast but inaccurate. For example, the granularity
145 * of timestamp on a FAT filesystem is 2 seconds. Also, various operations
146 * may touch the timestamp of a file even when its content is unchanged.
148 * checksum is accurate but slow, which can be a problem when it is
149 * frequently used, or used for a large file on a slow (network) file
152 * FIXME: replace this method with support/FileMonitor.
155 checksum_method, ///< Use file checksum
156 timestamp_method ///< Use timestamp, and checksum if timestamp has changed
166 explicit Buffer(std::string const & file, bool readonly = false,
167 Buffer const * cloned_buffer = 0);
172 /// Clones the entire structure of which this Buffer is part, starting
173 /// with the master and cloning all the children, too.
174 Buffer * cloneFromMaster() const;
175 /// Just clones this single Buffer. For autosave.
176 Buffer * cloneBufferOnly() const;
178 bool isClone() const;
180 /** High-level interface to buffer functionality.
181 This function parses a command string and executes it.
183 void dispatch(std::string const & command, DispatchResult & result);
185 /// Maybe we know the function already by number...
186 void dispatch(FuncRequest const & func, DispatchResult & result);
188 /// Can this function be exectued?
189 /// \return true if we made a decision
190 bool getStatus(FuncRequest const & cmd, FuncStatus & flag);
193 DocIterator getParFromID(int id) const;
194 /// do we have a paragraph with this id?
195 bool hasParWithID(int id) const;
198 frontend::WorkAreaManager & workAreaManager() const;
201 Takes care of auto-save files and backup file if requested.
202 Returns \c true if the save is successful, \c false otherwise.
205 /// Renames and saves the buffer
206 bool saveAs(support::FileName const & fn);
208 /// Write document to stream. Returns \c false if unsuccessful.
209 bool write(std::ostream &) const;
210 /// Write file. Returns \c false if unsuccessful.
211 bool writeFile(support::FileName const &) const;
213 /// \name Functions involved in reading files/strings.
215 /// Loads the LyX file into the buffer. This function
216 /// tries to extract the file from version control if it
217 /// cannot be found. If it can be found, it will try to
218 /// read an emergency save file or an autosave file.
219 /// \sa loadThisLyXFile
220 ReadStatus loadLyXFile();
221 /// Loads the LyX file \c fn into the buffer. If you want
222 /// to check for files in a version control container,
223 /// emergency or autosave files, one should use \c loadLyXFile.
225 ReadStatus loadThisLyXFile(support::FileName const & fn);
226 /// import a new document from a string
227 bool importString(std::string const &, docstring const &, ErrorList &);
228 /// import a new file
229 bool importFile(std::string const &, support::FileName const &, ErrorList &);
230 /// read a new document from a string
231 bool readString(std::string const &);
232 /// Reloads the LyX file
234 //FIXME: The following function should be private
236 /// read the header, returns number of unknown tokens
237 int readHeader(Lexer & lex);
239 double fontScalingFactor() const;
243 typedef std::map<Buffer const *, Buffer *> BufferMap;
245 void cloneWithChildren(BufferMap &, CloneList *) const;
246 /// save timestamp and checksum of the given file.
247 void saveCheckSum() const;
249 ReadStatus readFile(support::FileName const & fn);
250 /// Reads a file without header.
251 /// \param par if != 0 insert the file.
252 /// \return \c true if file is not completely read.
253 bool readDocument(Lexer &);
254 /// Try to extract the file from a version control container
255 /// before reading if the file cannot be found.
256 /// \sa LyXVC::file_not_found_hook
257 ReadStatus extractFromVC();
258 /// Reads the first tag of a LyX File and
259 /// returns the file format number.
260 ReadStatus parseLyXFormat(Lexer & lex, support::FileName const & fn,
261 int & file_format) const;
262 /// Convert the LyX file to the LYX_FORMAT using
263 /// the lyx2lyx script and returns the filename
264 /// of the temporary file to be read
265 ReadStatus convertLyXFormat(support::FileName const & fn,
266 support::FileName & tmpfile, int from_format);
270 /// \name Functions involved in autosave and emergency files.
272 /// Save an autosave file to #filename.lyx#
273 bool autoSave() const;
274 /// save emergency file
275 /// \return a status message towards the user.
276 docstring emergencyWrite();
278 //FIXME:The following function should be private
281 void removeAutosaveFile() const;
284 /// Try to load an autosave file associated to \c fn.
285 ReadStatus loadAutosave();
286 /// Try to load an emergency file associated to \c fn.
287 ReadStatus loadEmergency();
288 /// Get the filename of the emergency file associated with the Buffer
289 support::FileName getEmergencyFileName() const;
290 /// Get the filename of the autosave file associated with the Buffer
291 support::FileName getAutosaveFileName() const;
293 void moveAutosaveFile(support::FileName const & old) const;
297 /// Fill in the ErrorList with the TeXErrors
298 void bufferErrors(TeXErrors const &, ErrorList &) const;
308 /// Just a wrapper for writeLaTeXSource, first creating the ofstream.
309 bool makeLaTeXFile(support::FileName const & filename,
310 std::string const & original_path,
311 OutputParams const &,
312 OutputWhat output = FullSource) const;
313 /** Export the buffer to LaTeX.
314 If \p os is a file stream, and params().inputenc is "auto" or
315 "default", and the buffer contains text in different languages
316 with more than one encoding, then this method will change the
317 encoding associated to \p os. Therefore you must not call this
318 method with a string stream if the output is supposed to go to a
321 otexstream os(ofs, texrow);
322 ofs.open("test.tex");
323 writeLaTeXSource(os, ...);
325 \endcode is NOT equivalent to \code
326 odocstringstream oss;
327 otexstream os(oss, texrow);
328 writeLaTeXSource(os, ...);
330 ofs.open("test.tex");
335 void writeLaTeXSource(otexstream & os,
336 std::string const & original_path,
337 OutputParams const &,
338 OutputWhat output = FullSource) const;
340 void makeDocBookFile(support::FileName const & filename,
341 OutputParams const & runparams_in,
342 OutputWhat output = FullSource) const;
344 void writeDocBookSource(odocstream & os, std::string const & filename,
345 OutputParams const & runparams_in,
346 OutputWhat output = FullSource) const;
348 void makeLyXHTMLFile(support::FileName const & filename,
349 OutputParams const & runparams_in) const;
351 void writeLyXHTMLSource(odocstream & os,
352 OutputParams const & runparams_in,
353 OutputWhat output = FullSource) const;
354 /// returns the main language for the buffer (document)
355 Language const * language() const;
356 /// get l10n translated to the buffers language
357 docstring const B_(std::string const & l10n) const;
361 /// return true if the main lyx file does not need saving
362 bool isClean() const;
364 bool isDepClean(std::string const & name) const;
366 /// whether or not disk file has been externally modified
367 bool isExternallyModified(CheckMethod method) const;
369 /// mark the main lyx file as not needing saving
370 void markClean() const;
373 void markDepClean(std::string const & name);
376 void setUnnamed(bool flag = true);
378 /// Whether or not a filename has been assigned to this buffer
379 bool isUnnamed() const;
381 /// Whether or not this buffer is internal.
383 /// An internal buffer does not contain a real document, but some auxiliary text segment.
384 /// It is not associated with a filename, it is never saved, thus it does not need to be
385 /// automatically saved, nor it needs to trigger any "do you want to save ?" question.
386 bool isInternal() const;
388 void setInternal(bool flag);
390 /// Mark this buffer as dirty.
393 /// Returns the buffer's filename. It is always an absolute path.
394 support::FileName fileName() const;
396 /// Returns the buffer's filename. It is always an absolute path.
397 std::string absFileName() const;
399 /// Returns the path where the buffer lives.
400 /// It is always an absolute path.
401 std::string filePath() const;
403 /** A transformed version of the file name, adequate for LaTeX.
404 \param no_path optional if \c true then the path is stripped.
406 std::string latexName(bool no_path = true) const;
408 /// Get the name and type of the log.
409 std::string logName(LogType * type = 0) const;
411 /// Set document's parent Buffer.
412 void setParent(Buffer const *);
413 Buffer const * parent() const;
415 /** Get the document's master (or \c this if this is not a
418 Buffer const * masterBuffer() const;
420 /// \return true if \p child is a child of this \c Buffer.
421 bool isChild(Buffer * child) const;
423 /// \return true if this \c Buffer has children
424 bool hasChildren() const;
426 /// \return a list of the direct children of this Buffer.
427 /// this list has no duplicates and is in the order in which
428 /// the children appear.
429 ListOfBuffers getChildren() const;
431 /// \return a list of all descendents of this Buffer (children,
432 /// grandchildren, etc). this list has no duplicates and is in
433 /// the order in which the children appear.
434 ListOfBuffers getDescendents() const;
436 /// Collect all relative buffers, in the order in which they appear.
437 /// I.e., the "root" Buffer is first, then its first child, then any
438 /// of its children, etc. However, there are no duplicates in this
440 /// This is "stable", too, in the sense that it returns the same
441 /// thing from whichever Buffer it is called.
442 ListOfBuffers allRelatives() const;
444 /// Is buffer read-only?
445 bool isReadonly() const;
447 /// Set buffer read-only flag
448 void setReadonly(bool flag = true);
450 /** Validate a buffer for LaTeX.
451 This validates the buffer, and returns a struct for use by
452 #makeLaTeX# and others. Its main use is to figure out what
453 commands and packages need to be included in the LaTeX file.
454 It (should) also check that the needed constructs are there
455 (i.e. that the \refs points to coresponding \labels). It
456 should perhaps inset "error" insets to help the user correct
459 void validate(LaTeXFeatures &) const;
461 /// Reference information is cached in the Buffer, so we do not
462 /// have to check or read things over and over.
464 /// There are two caches.
466 /// One is a cache of the BibTeX files from which reference info is
467 /// being gathered. This cache is PER BUFFER, and the cache for the
468 /// master essentially includes the cache for its children. This gets
469 /// invalidated when an InsetBibtex is created, deleted, or modified.
471 /// The other is a cache of the reference information itself. This
472 /// exists only in the master buffer, and when it needs to be updated,
473 /// the children add their information to the master's cache.
475 /// Calling this method invalidates the cache and so requires a
477 void invalidateBibinfoCache() const;
478 /// This invalidates the cache of files we need to check.
479 void invalidateBibfileCache() const;
480 /// Updates the cached bibliography information, checking first to see
481 /// whether the cache is valid. If so, we do nothing. If not, then we
482 /// reload all the BibTeX info.
483 /// Note that this operates on the master document.
484 void reloadBibInfoCache() const;
485 /// \return the bibliography information for this buffer's master,
486 /// or just for it, if it isn't a child.
487 BiblioInfo const & masterBibInfo() const;
488 /// collect bibliography info from the various insets in this buffer.
489 void collectBibKeys() const;
490 /// add some BiblioInfo to our cache
491 void addBiblioInfo(BiblioInfo const & bi) const;
492 /// add a single piece of bibliography info to our cache
493 void addBibTeXInfo(docstring const & key, BibTeXInfo const & bi) const;
495 void makeCitationLabels() const;
497 bool citeLabelsValid() const;
499 void getLabelList(std::vector<docstring> &) const;
501 /// This removes the .aux and .bbl files from the temp dir.
502 void removeBiblioTempFiles() const;
505 void changeLanguage(Language const * from, Language const * to);
508 bool isMultiLingual() const;
510 std::set<Language const *> getLanguages() const;
513 BufferParams & params();
514 BufferParams const & params() const;
516 BufferParams const & masterParams() const;
518 /** The list of paragraphs.
519 This is a linked list of paragraph, this list holds the
520 whole contents of the document.
522 ParagraphList & paragraphs();
523 ParagraphList const & paragraphs() const;
525 /// LyX version control object.
527 LyXVC const & lyxvc() const;
529 /// Where to put temporary files.
530 std::string const temppath() const;
532 /// Used when typesetting to place errorboxes.
533 TexRow const & texrow() const;
537 ParIterator par_iterator_begin();
539 ParConstIterator par_iterator_begin() const;
541 ParIterator par_iterator_end();
543 ParConstIterator par_iterator_end() const;
545 // Position of the child buffer where it appears first in the master.
546 DocIterator firstChildPosition(Buffer const * child);
548 /** \returns true only when the file is fully loaded.
549 * Used to prevent the premature generation of previews
550 * and by the citation inset.
552 bool isFullyLoaded() const;
553 /// Set by buffer_funcs' newFile.
554 void setFullyLoaded(bool);
556 /// FIXME: Needed by RenderPreview.
557 graphics::PreviewLoader * loader() const;
558 /// Update the LaTeX preview snippets associated with this buffer
559 void updatePreviews() const;
560 /// Remove any previewed LaTeX snippets associated with this buffer
561 void removePreviews() const;
563 /// Our main text (inside the top InsetText)
566 /// Our top InsetText
567 Inset & inset() const;
572 /// Collect macro definitions in paragraphs
573 void updateMacros() const;
574 /// Iterate through the whole buffer and try to resolve macros
575 void updateMacroInstances(UpdateType) const;
577 /// List macro names of this buffer, the parent and the children
578 void listMacroNames(MacroNameSet & macros) const;
579 /// Collect macros of the parent and its children in front of this buffer.
580 void listParentMacros(MacroSet & macros, LaTeXFeatures & features) const;
582 /// Return macro defined before pos (or in the master buffer)
583 MacroData const * getMacro(docstring const & name, DocIterator const & pos, bool global = true) const;
584 /// Return macro defined anywhere in the buffer (or in the master buffer)
585 MacroData const * getMacro(docstring const & name, bool global = true) const;
586 /// Return macro defined before the inclusion of the child
587 MacroData const * getMacro(docstring const & name, Buffer const & child, bool global = true) const;
589 /// Collect user macro names at loading time
590 typedef std::set<docstring> UserMacroSet;
591 mutable UserMacroSet usermacros;
593 /// Replace the inset contents for insets which InsetCode is equal
594 /// to the passed \p inset_code.
595 void changeRefsIfUnique(docstring const & from, docstring const & to);
597 /// get source code (latex/docbook) for some paragraphs, or all paragraphs
598 /// including preamble
599 void getSourceCode(odocstream & os, std::string const & format,
600 pit_type par_begin, pit_type par_end, OutputWhat output,
603 /// Access to error list.
604 /// This method is used only for GUI visualisation of Buffer related
605 /// errors (like parsing or LateX compilation). This method is const
606 /// because modifying the returned ErrorList does not touch the document
608 ErrorList & errorList(std::string const & type) const;
611 /// This is useful only for screen visualisation of the Buffer. This
612 /// method is const because modifying this backend does not touch
613 /// the document contents.
614 TocBackend & tocBackend() const;
619 /// This function is called when the buffer is changed.
620 void changed(bool update_metrics) const;
622 void setChild(DocIterator const & dit, Buffer * child);
624 void updateTocItem(std::string const &, DocIterator const &) const;
625 /// This function is called when the buffer structure is changed.
626 void structureChanged() const;
627 /// This function is called when some parsing error shows up.
628 void errors(std::string const & err, bool from_master = false) const;
629 /// This function is called when the buffer busy status change.
630 void setBusy(bool on) const;
631 /// Update window titles of all users.
632 void updateTitles() const;
633 /// Reset autosave timers for all users.
634 void resetAutosaveTimers() const;
636 void message(docstring const & msg) const;
639 void setGuiDelegate(frontend::GuiBufferDelegate * gui);
641 bool hasGuiDelegate() const;
644 ExportStatus doExport(std::string const & target, bool put_in_tempdir) const;
646 ExportStatus doExport(std::string const & target, bool put_in_tempdir,
647 std::string & result_file) const;
649 ExportStatus preview(std::string const & format) const;
652 /// target is a format name optionally followed by a space
653 /// and a destination file-name
654 ExportStatus doExport(std::string const & target, bool put_in_tempdir,
655 bool includeall, std::string & result_file) const;
657 ExportStatus doExport(std::string const & target, bool put_in_tempdir,
658 bool includeall) const;
660 ExportStatus preview(std::string const & format, bool includeall = false) const;
662 void setMathFlavor(OutputParams & op) const;
666 bool isExporting() const;
669 typedef std::vector<std::pair<Inset *, ParIterator> > References;
671 References const & references(docstring const & label) const;
673 void addReference(docstring const & label, Inset * inset, ParIterator it);
675 void clearReferenceCache() const;
677 void setInsetLabel(docstring const & label, InsetLabel const * il);
679 InsetLabel const * insetLabel(docstring const & label) const;
681 /// return a list of all used branches (also in children)
682 void getUsedBranches(std::list<docstring> &, bool const from_master = false) const;
684 /// sets the buffer_ member for every inset in this buffer.
685 // FIXME This really shouldn't be needed, but at the moment it's not
686 // clear how to do it just for the individual pieces we need.
687 void setBuffersForInsets() const;
688 /// Updates screen labels and some other information associated with
689 /// insets and paragraphs. Actually, it's more like a general "recurse
690 /// through the Buffer" routine, that visits all the insets and paragraphs.
691 void updateBuffer() const { updateBuffer(UpdateMaster, InternalUpdate); }
692 /// \param scope: whether to start with the master document or just
694 /// \param output: whether we are preparing for output.
695 void updateBuffer(UpdateScope scope, UpdateType utype) const;
697 void updateBuffer(ParIterator & parit, UpdateType utype) const;
699 /// Spellcheck starting from \p from.
700 /// \p from initial position, will then points to the next misspelled
702 /// \p to will points to the end of the next misspelled word.
703 /// \p word_lang will contain the found misspelled word.
704 /// \return progress if a new word was found.
705 int spellCheck(DocIterator & from, DocIterator & to,
706 WordLangTuple & word_lang, docstring_list & suggestions) const;
708 void checkChildBuffers();
710 void checkMasterBuffer();
712 /// compute statistics between \p from and \p to
713 /// \p from initial position
714 /// \p to points to the end position
715 /// \p skipNoOutput if notes etc. should be ignored
716 void updateStatistics(DocIterator & from, DocIterator & to,
717 bool skipNoOutput = true) const;
718 /// statistics accessor functions
719 int wordCount() const;
720 int charCount(bool with_blanks) const;
723 friend class MarkAsExporting;
724 /// mark the buffer as busy exporting something, or not
725 void setExportStatus(bool e) const;
728 References & getReferenceCache(docstring const & label);
729 /// Change name of buffer. Updates "read-only" flag.
730 void setFileName(support::FileName const & fname);
732 void getLanguages(std::set<Language const *> &) const;
733 /// Checks whether any of the referenced bibfiles have changed since the
734 /// last time we loaded the cache. Note that this does NOT update the
735 /// cached information.
736 void checkIfBibInfoCacheIsValid() const;
737 /// Update the list of all bibfiles in use (including bibfiles
738 /// of loaded child documents).
739 void updateBibfilesCache(UpdateScope scope = UpdateMaster) const;
740 /// Return the list with all bibfiles in use (including bibfiles
741 /// of loaded child documents).
742 support::FileNameList const &
743 getBibfilesCache(UpdateScope scope = UpdateMaster) const;
745 void collectChildren(ListOfBuffers & children, bool grand_children) const;
748 Buffer(Buffer const &);
749 void operator=(Buffer const &);
751 /// Use the Pimpl idiom to hide the internals.
753 /// The pointer never changes although *pimpl_'s contents may.
758 /// Helper class, to guarantee that the export status
759 /// gets reset properly. To use, simply create a local variable:
760 /// MarkAsExporting mex(bufptr);
761 /// and leave the rest to us.
762 class MarkAsExporting {
764 MarkAsExporting(Buffer const * buf) : buf_(buf)
766 buf_->setExportStatus(true);
770 buf_->setExportStatus(false);
773 Buffer const * const buf_;