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 "insets/InsetCode.h"
20 #include "support/strfwd.h"
21 #include "support/types.h"
56 class ParConstIterator;
66 class GuiBufferDelegate;
67 class WorkAreaManager;
81 typedef std::list<Buffer *> ListOfBuffers;
82 /// a list of Buffers we cloned
83 typedef std::set<Buffer *> CloneList;
86 /** The buffer object.
87 * This is the buffer object. It contains all the informations about
88 * a document loaded into LyX.
89 * The buffer object owns the Text (wrapped in an InsetText), which
90 * contains the individual paragraphs of the document.
93 * I am not sure if the class is complete or
94 * minimal, probably not.
95 * \author Lars Gullik Bjønnes
99 /// What type of log will \c getLogName() return?
101 latexlog, ///< LaTeX log
102 buildlog ///< Literate build log
105 /// Result of \c readFile()
115 ReadEmergencyFailure,
132 ExportNoPathToFormat,
133 ExportTexPathHasSpaces,
134 ExportConverterError,
140 /// Method to check if a file is externally modified, used by
141 /// isExternallyModified()
143 * timestamp is fast but inaccurate. For example, the granularity
144 * of timestamp on a FAT filesystem is 2 second. Also, various operations
145 * may touch the timestamp of a file even when its content is unchanged.
147 * checksum is accurate but slow, which can be a problem when it is
148 * frequently used, or used for a large file on a slow (network) file
151 * FIXME: replace this method with support/FileMonitor.
154 checksum_method, ///< Use file checksum
155 timestamp_method ///< Use timestamp, and checksum if timestamp has changed
165 explicit Buffer(std::string const & file, bool readonly = false,
166 Buffer const * cloned_buffer = 0);
171 /// Clones the entire structure of which this Buffer is part, starting
172 /// with the master and cloning all the children, too.
173 Buffer * cloneFromMaster() const;
174 /// Just clones this single Buffer. For autosave.
175 Buffer * cloneBufferOnly() const;
177 bool isClone() const;
179 /** High-level interface to buffer functionality.
180 This function parses a command string and executes it.
182 void dispatch(std::string const & command, DispatchResult & result);
184 /// Maybe we know the function already by number...
185 void dispatch(FuncRequest const & func, DispatchResult & result);
187 /// Can this function be exectued?
188 /// \return true if we made a decision
189 bool getStatus(FuncRequest const & cmd, FuncStatus & flag);
192 DocIterator getParFromID(int id) const;
193 /// do we have a paragraph with this id?
194 bool hasParWithID(int id) const;
197 frontend::WorkAreaManager & workAreaManager() const;
200 Takes care of auto-save files and backup file if requested.
201 Returns \c true if the save is successful, \c false otherwise.
204 /// Renames and saves the buffer
205 bool saveAs(support::FileName const & fn);
207 /// Write document to stream. Returns \c false if unsuccessful.
208 bool write(std::ostream &) const;
209 /// Write file. Returns \c false if unsuccessful.
210 bool writeFile(support::FileName const &) const;
212 /// \name Functions involved in reading files/strings.
214 /// Loads the LyX file into the buffer. This function
215 /// tries to extract the file from version control if it
216 /// cannot be found. If it can be found, it will try to
217 /// read an emergency save file or an autosave file.
218 /// \sa loadThisLyXFile
219 ReadStatus loadLyXFile();
220 /// Loads the LyX file \c fn into the buffer. If you want
221 /// to check for files in a version control container,
222 /// emergency or autosave files, one should use \c loadLyXFile.
224 ReadStatus loadThisLyXFile(support::FileName const & fn);
225 /// read a new document from a string
226 bool readString(std::string const &);
227 /// Reloads the LyX file
228 /// \param clearUndo if false, leave alone the undo stack.
229 ReadStatus reload(bool clearUndo = true);
230 //FIXME: The following function should be private
232 /// read the header, returns number of unknown tokens
233 int readHeader(Lexer & lex);
237 typedef std::map<Buffer const *, Buffer *> BufferMap;
239 void cloneWithChildren(BufferMap &, CloneList *) const;
240 /// save timestamp and checksum of the given file.
241 void saveCheckSum() const;
243 ReadStatus readFile(support::FileName const & fn);
244 /// Reads a file without header.
245 /// \param par if != 0 insert the file.
246 /// \return \c true if file is not completely read.
247 bool readDocument(Lexer &);
248 /// Try to extract the file from a version control container
249 /// before reading if the file cannot be found. This is only
250 /// implemented for RCS.
251 /// \sa LyXVC::file_not_found_hook
252 ReadStatus extractFromVC();
253 /// Reads the first tag of a LyX File and
254 /// returns the file format number.
255 ReadStatus parseLyXFormat(Lexer & lex, support::FileName const & fn,
256 int & file_format) const;
257 /// Convert the LyX file to the LYX_FORMAT using
258 /// the lyx2lyx script and returns the filename
259 /// of the temporary file to be read
260 ReadStatus convertLyXFormat(support::FileName const & fn,
261 support::FileName & tmpfile, int from_format);
265 /// \name Functions involved in autosave and emergency files.
267 /// Save an autosave file to #filename.lyx#
268 bool autoSave() const;
269 /// save emergency file
270 /// \return a status message towards the user.
271 docstring emergencyWrite();
273 //FIXME:The following function should be private
276 void removeAutosaveFile() const;
279 /// Try to load an autosave file associated to \c fn.
280 ReadStatus loadAutosave();
281 /// Try to load an emergency file associated to \c fn.
282 ReadStatus loadEmergency();
283 /// Get the filename of the emergency file associated with the Buffer
284 support::FileName getEmergencyFileName() const;
285 /// Get the filename of the autosave file associated with the Buffer
286 support::FileName getAutosaveFileName() const;
288 void moveAutosaveFile(support::FileName const & old) const;
292 /// Fill in the ErrorList with the TeXErrors
293 void bufferErrors(TeXErrors const &, ErrorList &) const;
303 /// Just a wrapper for writeLaTeXSource, first creating the ofstream.
304 bool makeLaTeXFile(support::FileName const & filename,
305 std::string const & original_path,
306 OutputParams const &,
307 OutputWhat output = FullSource) const;
308 /** Export the buffer to LaTeX.
309 If \p os is a file stream, and params().inputenc is "auto" or
310 "default", and the buffer contains text in different languages
311 with more than one encoding, then this method will change the
312 encoding associated to \p os. Therefore you must not call this
313 method with a string stream if the output is supposed to go to a
316 otexstream os(ofs, texrow);
317 ofs.open("test.tex");
318 writeLaTeXSource(os, ...);
320 \endcode is NOT equivalent to \code
321 odocstringstream oss;
322 otexstream os(oss, texrow);
323 writeLaTeXSource(os, ...);
325 ofs.open("test.tex");
330 void writeLaTeXSource(otexstream & os,
331 std::string const & original_path,
332 OutputParams const &,
333 OutputWhat output = FullSource) const;
335 void makeDocBookFile(support::FileName const & filename,
336 OutputParams const & runparams_in,
337 OutputWhat output = FullSource) const;
339 void writeDocBookSource(odocstream & os, std::string const & filename,
340 OutputParams const & runparams_in,
341 OutputWhat output = FullSource) const;
343 void makeLyXHTMLFile(support::FileName const & filename,
344 OutputParams const & runparams_in) const;
346 void writeLyXHTMLSource(odocstream & os,
347 OutputParams const & runparams_in,
348 OutputWhat output = FullSource) const;
349 /// returns the main language for the buffer (document)
350 Language const * language() const;
351 /// get l10n translated to the buffers language
352 docstring const B_(std::string const & l10n) const;
356 /// return true if the main lyx file does not need saving
357 bool isClean() const;
359 bool isDepClean(std::string const & name) const;
361 /// whether or not disk file has been externally modified
362 bool isExternallyModified(CheckMethod method) 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 the path where the buffer lives.
395 /// It is always an absolute path.
396 std::string filePath() const;
398 /** A transformed version of the file name, adequate for LaTeX.
399 \param no_path optional if \c true then the path is stripped.
401 std::string latexName(bool no_path = true) const;
403 /// Get the name and type of the log.
404 std::string logName(LogType * type = 0) const;
406 /// Set document's parent Buffer.
407 void setParent(Buffer const *);
408 Buffer const * parent() const;
410 /** Get the document's master (or \c this if this is not a
413 Buffer const * masterBuffer() const;
415 /// \return true if \p child is a child of this \c Buffer.
416 bool isChild(Buffer * child) const;
418 /// \return true if this \c Buffer has children
419 bool hasChildren() const;
421 /// \return a list of the direct children of this Buffer.
422 /// this list has no duplicates and is in the order in which
423 /// the children appear.
424 ListOfBuffers getChildren() const;
426 /// \return a list of all descendents of this Buffer (children,
427 /// grandchildren, etc). this list has no duplicates and is in
428 /// the order in which the children appear.
429 ListOfBuffers getDescendents() const;
431 /// Collect all relative buffers, in the order in which they appear.
432 /// I.e., the "root" Buffer is first, then its first child, then any
433 /// of its children, etc. However, there are no duplicates in this
435 /// This is "stable", too, in the sense that it returns the same
436 /// thing from whichever Buffer it is called.
437 ListOfBuffers allRelatives() const;
439 /// Is buffer read-only?
440 bool isReadonly() const;
442 /// Set buffer read-only flag
443 void setReadonly(bool flag = true);
445 /** Validate a buffer for LaTeX.
446 This validates the buffer, and returns a struct for use by
447 #makeLaTeX# and others. Its main use is to figure out what
448 commands and packages need to be included in the LaTeX file.
449 It (should) also check that the needed constructs are there
450 (i.e. that the \refs points to coresponding \labels). It
451 should perhaps inset "error" insets to help the user correct
454 void validate(LaTeXFeatures &) const;
456 /// Reference information is cached in the Buffer, so we do not
457 /// have to check or read things over and over.
459 /// There are two caches.
461 /// One is a cache of the BibTeX files from which reference info is
462 /// being gathered. This cache is PER BUFFER, and the cache for the
463 /// master essentially includes the cache for its children. This gets
464 /// invalidated when an InsetBibtex is created, deleted, or modified.
466 /// The other is a cache of the reference information itself. This
467 /// exists only in the master buffer, and when it needs to be updated,
468 /// the children add their information to the master's cache.
470 /// Calling this method invalidates the cache and so requires a
472 void invalidateBibinfoCache() const;
473 /// This invalidates the cache of files we need to check.
474 void invalidateBibfileCache() const;
475 /// Updates the cached bibliography information, checking first to see
476 /// whether the cache is valid. If so, we do nothing. If not, then we
477 /// reload all the BibTeX info.
478 /// Note that this operates on the master document.
479 void reloadBibInfoCache() const;
480 /// \return the bibliography information for this buffer's master,
481 /// or just for it, if it isn't a child.
482 BiblioInfo const & masterBibInfo() const;
483 /// collect bibliography info from the various insets in this buffer.
484 void collectBibKeys() const;
485 /// add some BiblioInfo to our cache
486 void addBiblioInfo(BiblioInfo const & bi) const;
487 /// add a single piece of bibliography info to our cache
488 void addBibTeXInfo(docstring const & key, BibTeXInfo const & bi) const;
490 bool citeLabelsValid() const;
492 void getLabelList(std::vector<docstring> &) const;
494 /// This removes the .aux and .bbl files from the temp dir.
495 void removeBiblioTempFiles() const;
498 void changeLanguage(Language const * from, Language const * to);
501 bool isMultiLingual() const;
503 std::set<Language const *> getLanguages() const;
506 BufferParams & params();
507 BufferParams const & params() const;
509 /** The list of paragraphs.
510 This is a linked list of paragraph, this list holds the
511 whole contents of the document.
513 ParagraphList & paragraphs();
514 ParagraphList const & paragraphs() const;
516 /// LyX version control object.
518 LyXVC const & lyxvc() const;
520 /// Where to put temporary files.
521 std::string const temppath() const;
523 /// Used when typesetting to place errorboxes.
524 TexRow const & texrow() const;
528 ParIterator par_iterator_begin();
530 ParConstIterator par_iterator_begin() const;
532 ParIterator par_iterator_end();
534 ParConstIterator par_iterator_end() const;
536 // Position of the child buffer where it appears first in the master.
537 DocIterator firstChildPosition(Buffer const * child);
539 /** \returns true only when the file is fully loaded.
540 * Used to prevent the premature generation of previews
541 * and by the citation inset.
543 bool isFullyLoaded() const;
544 /// Set by buffer_funcs' newFile.
545 void setFullyLoaded(bool);
547 /// FIXME: Needed by RenderPreview.
548 graphics::PreviewLoader * loader() const;
549 /// Update the LaTeX preview snippets associated with this buffer
550 void updatePreviews() const;
551 /// Remove any previewed LaTeX snippets associated with this buffer
552 void removePreviews() const;
554 /// Our main text (inside the top InsetText)
557 /// Our top InsetText
558 Inset & inset() const;
563 /// Collect macro definitions in paragraphs
564 void updateMacros() const;
565 /// Iterate through the whole buffer and try to resolve macros
566 void updateMacroInstances(UpdateType) const;
568 /// List macro names of this buffer, the parent and the children
569 void listMacroNames(MacroNameSet & macros) const;
570 /// Collect macros of the parent and its children in front of this buffer.
571 void listParentMacros(MacroSet & macros, LaTeXFeatures & features) const;
573 /// Return macro defined before pos (or in the master buffer)
574 MacroData const * getMacro(docstring const & name, DocIterator const & pos, bool global = true) const;
575 /// Return macro defined anywhere in the buffer (or in the master buffer)
576 MacroData const * getMacro(docstring const & name, bool global = true) const;
577 /// Return macro defined before the inclusion of the child
578 MacroData const * getMacro(docstring const & name, Buffer const & child, bool global = true) const;
580 /// Collect user macro names at loading time
581 typedef std::set<docstring> UserMacroSet;
582 mutable UserMacroSet usermacros;
584 /// Replace the inset contents for insets which InsetCode is equal
585 /// to the passed \p inset_code.
586 void changeRefsIfUnique(docstring const & from, docstring const & to,
589 /// get source code (latex/docbook) for some paragraphs, or all paragraphs
590 /// including preamble
591 void getSourceCode(odocstream & os, std::string const format,
592 pit_type par_begin, pit_type par_end, OutputWhat output) const;
594 /// Access to error list.
595 /// This method is used only for GUI visualisation of Buffer related
596 /// errors (like parsing or LateX compilation). This method is const
597 /// because modifying the returned ErrorList does not touch the document
599 ErrorList & errorList(std::string const & type) const;
602 /// This is useful only for screen visualisation of the Buffer. This
603 /// method is const because modifying this backend does not touch
604 /// the document contents.
605 TocBackend & tocBackend() const;
610 /// This function is called when the buffer is changed.
611 void changed(bool update_metrics) const;
613 void setChild(DocIterator const & dit, Buffer * child);
615 void updateTocItem(std::string const &, DocIterator const &) const;
616 /// This function is called when the buffer structure is changed.
617 void structureChanged() const;
618 /// This function is called when some parsing error shows up.
619 void errors(std::string const & err, bool from_master = false) const;
620 /// This function is called when the buffer busy status change.
621 void setBusy(bool on) const;
622 /// Update window titles of all users.
623 void updateTitles() const;
624 /// Reset autosave timers for all users.
625 void resetAutosaveTimers() const;
627 void message(docstring const & msg) const;
630 void setGuiDelegate(frontend::GuiBufferDelegate * gui);
632 bool hasGuiDelegate() const;
635 ExportStatus doExport(std::string const & target, bool put_in_tempdir) const;
637 ExportStatus doExport(std::string const & target, bool put_in_tempdir,
638 std::string & result_file) const;
640 ExportStatus preview(std::string const & format) const;
643 /// target is a format name optionally followed by a space
644 /// and a destination file-name
645 ExportStatus doExport(std::string const & target, bool put_in_tempdir,
646 bool includeall, std::string & result_file) const;
648 ExportStatus doExport(std::string const & target, bool put_in_tempdir,
649 bool includeall) const;
651 ExportStatus preview(std::string const & format, bool includeall = false) const;
653 void setMathFlavor(OutputParams & op) const;
657 bool isExporting() const;
660 typedef std::vector<std::pair<Inset *, ParIterator> > References;
661 References & references(docstring const & label);
662 References const & references(docstring const & label) const;
663 void clearReferenceCache() const;
664 void setInsetLabel(docstring const & label, InsetLabel const * il);
665 InsetLabel const * insetLabel(docstring const & label) const;
667 /// return a list of all used branches (also in children)
668 void getUsedBranches(std::list<docstring> &, bool const from_master = false) const;
670 /// sets the buffer_ member for every inset in this buffer.
671 // FIXME This really shouldn't be needed, but at the moment it's not
672 // clear how to do it just for the individual pieces we need.
673 void setBuffersForInsets() const;
674 /// Updates screen labels and some other information associated with
675 /// insets and paragraphs. Actually, it's more like a general "recurse
676 /// through the Buffer" routine, that visits all the insets and paragraphs.
677 void updateBuffer() const { updateBuffer(UpdateMaster, InternalUpdate); }
678 /// \param scope: whether to start with the master document or just
680 /// \param output: whether we are preparing for output.
681 void updateBuffer(UpdateScope scope, UpdateType utype) const;
683 void updateBuffer(ParIterator & parit, UpdateType utype) const;
685 /// Spellcheck starting from \p from.
686 /// \p from initial position, will then points to the next misspelled
688 /// \p to will points to the end of the next misspelled word.
689 /// \p word_lang will contain the found misspelled word.
690 /// \return progress if a new word was found.
691 int spellCheck(DocIterator & from, DocIterator & to,
692 WordLangTuple & word_lang, docstring_list & suggestions) const;
694 void checkChildBuffers();
696 void checkMasterBuffer();
698 /// compute statistics between \p from and \p to
699 /// \p from initial position
700 /// \p to points to the end position
701 /// \p skipNoOutput if notes etc. should be ignored
702 void updateStatistics(DocIterator & from, DocIterator & to,
703 bool skipNoOutput = true) const;
704 /// statistics accessor functions
705 int wordCount() const;
706 int charCount(bool with_blanks) const;
709 class MarkAsExporting;
710 friend class MarkAsExporting;
711 /// mark the buffer as busy exporting something, or not
712 void setExportStatus(bool e) const;
714 /// Change name of buffer. Updates "read-only" flag.
715 void setFileName(support::FileName const & fname);
717 void getLanguages(std::set<Language const *> &) const;
718 /// Checks whether any of the referenced bibfiles have changed since the
719 /// last time we loaded the cache. Note that this does NOT update the
720 /// cached information.
721 void checkIfBibInfoCacheIsValid() const;
722 /// Update the list of all bibfiles in use (including bibfiles
723 /// of loaded child documents).
724 void updateBibfilesCache(UpdateScope scope = UpdateMaster) const;
725 /// Return the list with all bibfiles in use (including bibfiles
726 /// of loaded child documents).
727 support::FileNameList const &
728 getBibfilesCache(UpdateScope scope = UpdateMaster) const;
730 void collectChildren(ListOfBuffers & children, bool grand_children) const;
733 Buffer(Buffer const &);
734 void operator=(Buffer const &);
736 /// Use the Pimpl idiom to hide the internals.
738 /// The pointer never changes although *pimpl_'s contents may.