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);
241 typedef std::map<Buffer const *, Buffer *> BufferMap;
243 void cloneWithChildren(BufferMap &, CloneList *) const;
244 /// save timestamp and checksum of the given file.
245 void saveCheckSum() const;
247 ReadStatus readFile(support::FileName const & fn);
248 /// Reads a file without header.
249 /// \param par if != 0 insert the file.
250 /// \return \c true if file is not completely read.
251 bool readDocument(Lexer &);
252 /// Try to extract the file from a version control container
253 /// before reading if the file cannot be found.
254 /// \sa LyXVC::file_not_found_hook
255 ReadStatus extractFromVC();
256 /// Reads the first tag of a LyX File and
257 /// returns the file format number.
258 ReadStatus parseLyXFormat(Lexer & lex, support::FileName const & fn,
259 int & file_format) const;
260 /// Convert the LyX file to the LYX_FORMAT using
261 /// the lyx2lyx script and returns the filename
262 /// of the temporary file to be read
263 ReadStatus convertLyXFormat(support::FileName const & fn,
264 support::FileName & tmpfile, int from_format);
268 /// \name Functions involved in autosave and emergency files.
270 /// Save an autosave file to #filename.lyx#
271 bool autoSave() const;
272 /// save emergency file
273 /// \return a status message towards the user.
274 docstring emergencyWrite();
276 //FIXME:The following function should be private
279 void removeAutosaveFile() const;
282 /// Try to load an autosave file associated to \c fn.
283 ReadStatus loadAutosave();
284 /// Try to load an emergency file associated to \c fn.
285 ReadStatus loadEmergency();
286 /// Get the filename of the emergency file associated with the Buffer
287 support::FileName getEmergencyFileName() const;
288 /// Get the filename of the autosave file associated with the Buffer
289 support::FileName getAutosaveFileName() const;
291 void moveAutosaveFile(support::FileName const & old) const;
295 /// Fill in the ErrorList with the TeXErrors
296 void bufferErrors(TeXErrors const &, ErrorList &) const;
306 /// Just a wrapper for writeLaTeXSource, first creating the ofstream.
307 bool makeLaTeXFile(support::FileName const & filename,
308 std::string const & original_path,
309 OutputParams const &,
310 OutputWhat output = FullSource) const;
311 /** Export the buffer to LaTeX.
312 If \p os is a file stream, and params().inputenc is "auto" or
313 "default", and the buffer contains text in different languages
314 with more than one encoding, then this method will change the
315 encoding associated to \p os. Therefore you must not call this
316 method with a string stream if the output is supposed to go to a
319 otexstream os(ofs, texrow);
320 ofs.open("test.tex");
321 writeLaTeXSource(os, ...);
323 \endcode is NOT equivalent to \code
324 odocstringstream oss;
325 otexstream os(oss, texrow);
326 writeLaTeXSource(os, ...);
328 ofs.open("test.tex");
333 void writeLaTeXSource(otexstream & os,
334 std::string const & original_path,
335 OutputParams const &,
336 OutputWhat output = FullSource) const;
338 void makeDocBookFile(support::FileName const & filename,
339 OutputParams const & runparams_in,
340 OutputWhat output = FullSource) const;
342 void writeDocBookSource(odocstream & os, std::string const & filename,
343 OutputParams const & runparams_in,
344 OutputWhat output = FullSource) const;
346 void makeLyXHTMLFile(support::FileName const & filename,
347 OutputParams const & runparams_in) const;
349 void writeLyXHTMLSource(odocstream & os,
350 OutputParams const & runparams_in,
351 OutputWhat output = FullSource) const;
352 /// returns the main language for the buffer (document)
353 Language const * language() const;
354 /// get l10n translated to the buffers language
355 docstring const B_(std::string const & l10n) const;
359 /// return true if the main lyx file does not need saving
360 bool isClean() const;
362 bool isDepClean(std::string const & name) const;
364 /// whether or not disk file has been externally modified
365 bool isExternallyModified(CheckMethod method) 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 /** A transformed version of the file name, adequate for LaTeX.
402 \param no_path optional if \c true then the path is stripped.
404 std::string latexName(bool no_path = true) const;
406 /// Get the name and type of the log.
407 std::string logName(LogType * type = 0) const;
409 /// Set document's parent Buffer.
410 void setParent(Buffer const *);
411 Buffer const * parent() const;
413 /** Get the document's master (or \c this if this is not a
416 Buffer const * masterBuffer() const;
418 /// \return true if \p child is a child of this \c Buffer.
419 bool isChild(Buffer * child) const;
421 /// \return true if this \c Buffer has children
422 bool hasChildren() const;
424 /// \return a list of the direct children of this Buffer.
425 /// this list has no duplicates and is in the order in which
426 /// the children appear.
427 ListOfBuffers getChildren() const;
429 /// \return a list of all descendents of this Buffer (children,
430 /// grandchildren, etc). this list has no duplicates and is in
431 /// the order in which the children appear.
432 ListOfBuffers getDescendents() const;
434 /// Collect all relative buffers, in the order in which they appear.
435 /// I.e., the "root" Buffer is first, then its first child, then any
436 /// of its children, etc. However, there are no duplicates in this
438 /// This is "stable", too, in the sense that it returns the same
439 /// thing from whichever Buffer it is called.
440 ListOfBuffers allRelatives() const;
442 /// Is buffer read-only?
443 bool isReadonly() const;
445 /// Set buffer read-only flag
446 void setReadonly(bool flag = true);
448 /** Validate a buffer for LaTeX.
449 This validates the buffer, and returns a struct for use by
450 #makeLaTeX# and others. Its main use is to figure out what
451 commands and packages need to be included in the LaTeX file.
452 It (should) also check that the needed constructs are there
453 (i.e. that the \refs points to coresponding \labels). It
454 should perhaps inset "error" insets to help the user correct
457 void validate(LaTeXFeatures &) const;
459 /// Reference information is cached in the Buffer, so we do not
460 /// have to check or read things over and over.
462 /// There are two caches.
464 /// One is a cache of the BibTeX files from which reference info is
465 /// being gathered. This cache is PER BUFFER, and the cache for the
466 /// master essentially includes the cache for its children. This gets
467 /// invalidated when an InsetBibtex is created, deleted, or modified.
469 /// The other is a cache of the reference information itself. This
470 /// exists only in the master buffer, and when it needs to be updated,
471 /// the children add their information to the master's cache.
473 /// Calling this method invalidates the cache and so requires a
475 void invalidateBibinfoCache() const;
476 /// This invalidates the cache of files we need to check.
477 void invalidateBibfileCache() const;
478 /// Updates the cached bibliography information, checking first to see
479 /// whether the cache is valid. If so, we do nothing. If not, then we
480 /// reload all the BibTeX info.
481 /// Note that this operates on the master document.
482 void reloadBibInfoCache() const;
483 /// \return the bibliography information for this buffer's master,
484 /// or just for it, if it isn't a child.
485 BiblioInfo const & masterBibInfo() const;
486 /// collect bibliography info from the various insets in this buffer.
487 void collectBibKeys() const;
488 /// add some BiblioInfo to our cache
489 void addBiblioInfo(BiblioInfo const & bi) const;
490 /// add a single piece of bibliography info to our cache
491 void addBibTeXInfo(docstring const & key, BibTeXInfo const & bi) const;
493 void makeCitationLabels() const;
495 bool citeLabelsValid() const;
497 void getLabelList(std::vector<docstring> &) const;
499 /// This removes the .aux and .bbl files from the temp dir.
500 void removeBiblioTempFiles() const;
503 void changeLanguage(Language const * from, Language const * to);
506 bool isMultiLingual() const;
508 std::set<Language const *> getLanguages() const;
511 BufferParams & params();
512 BufferParams const & params() const;
514 BufferParams const & masterParams() const;
516 /** The list of paragraphs.
517 This is a linked list of paragraph, this list holds the
518 whole contents of the document.
520 ParagraphList & paragraphs();
521 ParagraphList const & paragraphs() const;
523 /// LyX version control object.
525 LyXVC const & lyxvc() const;
527 /// Where to put temporary files.
528 std::string const temppath() const;
530 /// Used when typesetting to place errorboxes.
531 TexRow const & texrow() const;
535 ParIterator par_iterator_begin();
537 ParConstIterator par_iterator_begin() const;
539 ParIterator par_iterator_end();
541 ParConstIterator par_iterator_end() const;
543 // Position of the child buffer where it appears first in the master.
544 DocIterator firstChildPosition(Buffer const * child);
546 /** \returns true only when the file is fully loaded.
547 * Used to prevent the premature generation of previews
548 * and by the citation inset.
550 bool isFullyLoaded() const;
551 /// Set by buffer_funcs' newFile.
552 void setFullyLoaded(bool);
554 /// FIXME: Needed by RenderPreview.
555 graphics::PreviewLoader * loader() const;
556 /// Update the LaTeX preview snippets associated with this buffer
557 void updatePreviews() const;
558 /// Remove any previewed LaTeX snippets associated with this buffer
559 void removePreviews() const;
561 /// Our main text (inside the top InsetText)
564 /// Our top InsetText
565 Inset & inset() const;
570 /// Collect macro definitions in paragraphs
571 void updateMacros() const;
572 /// Iterate through the whole buffer and try to resolve macros
573 void updateMacroInstances(UpdateType) const;
575 /// List macro names of this buffer, the parent and the children
576 void listMacroNames(MacroNameSet & macros) const;
577 /// Collect macros of the parent and its children in front of this buffer.
578 void listParentMacros(MacroSet & macros, LaTeXFeatures & features) const;
580 /// Return macro defined before pos (or in the master buffer)
581 MacroData const * getMacro(docstring const & name, DocIterator const & pos, bool global = true) const;
582 /// Return macro defined anywhere in the buffer (or in the master buffer)
583 MacroData const * getMacro(docstring const & name, bool global = true) const;
584 /// Return macro defined before the inclusion of the child
585 MacroData const * getMacro(docstring const & name, Buffer const & child, bool global = true) const;
587 /// Collect user macro names at loading time
588 typedef std::set<docstring> UserMacroSet;
589 mutable UserMacroSet usermacros;
591 /// Replace the inset contents for insets which InsetCode is equal
592 /// to the passed \p inset_code.
593 void changeRefsIfUnique(docstring const & from, docstring const & to);
595 /// get source code (latex/docbook) for some paragraphs, or all paragraphs
596 /// including preamble
597 void getSourceCode(odocstream & os, std::string const format,
598 pit_type par_begin, pit_type par_end, OutputWhat output,
601 /// Access to error list.
602 /// This method is used only for GUI visualisation of Buffer related
603 /// errors (like parsing or LateX compilation). This method is const
604 /// because modifying the returned ErrorList does not touch the document
606 ErrorList & errorList(std::string const & type) const;
609 /// This is useful only for screen visualisation of the Buffer. This
610 /// method is const because modifying this backend does not touch
611 /// the document contents.
612 TocBackend & tocBackend() const;
617 /// This function is called when the buffer is changed.
618 void changed(bool update_metrics) const;
620 void setChild(DocIterator const & dit, Buffer * child);
622 void updateTocItem(std::string const &, DocIterator const &) const;
623 /// This function is called when the buffer structure is changed.
624 void structureChanged() const;
625 /// This function is called when some parsing error shows up.
626 void errors(std::string const & err, bool from_master = false) const;
627 /// This function is called when the buffer busy status change.
628 void setBusy(bool on) const;
629 /// Update window titles of all users.
630 void updateTitles() const;
631 /// Reset autosave timers for all users.
632 void resetAutosaveTimers() const;
634 void message(docstring const & msg) const;
637 void setGuiDelegate(frontend::GuiBufferDelegate * gui);
639 bool hasGuiDelegate() const;
642 ExportStatus doExport(std::string const & target, bool put_in_tempdir) const;
644 ExportStatus doExport(std::string const & target, bool put_in_tempdir,
645 std::string & result_file) const;
647 ExportStatus preview(std::string const & format) const;
650 /// target is a format name optionally followed by a space
651 /// and a destination file-name
652 ExportStatus doExport(std::string const & target, bool put_in_tempdir,
653 bool includeall, std::string & result_file) const;
655 ExportStatus doExport(std::string const & target, bool put_in_tempdir,
656 bool includeall) const;
658 ExportStatus preview(std::string const & format, bool includeall = false) const;
660 void setMathFlavor(OutputParams & op) const;
664 bool isExporting() const;
667 typedef std::vector<std::pair<Inset *, ParIterator> > References;
669 References const & references(docstring const & label) const;
671 void addReference(docstring const & label, Inset * inset, ParIterator it);
673 void clearReferenceCache() const;
675 void setInsetLabel(docstring const & label, InsetLabel const * il);
677 InsetLabel const * insetLabel(docstring const & label) const;
679 /// return a list of all used branches (also in children)
680 void getUsedBranches(std::list<docstring> &, bool const from_master = false) const;
682 /// sets the buffer_ member for every inset in this buffer.
683 // FIXME This really shouldn't be needed, but at the moment it's not
684 // clear how to do it just for the individual pieces we need.
685 void setBuffersForInsets() const;
686 /// Updates screen labels and some other information associated with
687 /// insets and paragraphs. Actually, it's more like a general "recurse
688 /// through the Buffer" routine, that visits all the insets and paragraphs.
689 void updateBuffer() const { updateBuffer(UpdateMaster, InternalUpdate); }
690 /// \param scope: whether to start with the master document or just
692 /// \param output: whether we are preparing for output.
693 void updateBuffer(UpdateScope scope, UpdateType utype) const;
695 void updateBuffer(ParIterator & parit, UpdateType utype) const;
697 /// Spellcheck starting from \p from.
698 /// \p from initial position, will then points to the next misspelled
700 /// \p to will points to the end of the next misspelled word.
701 /// \p word_lang will contain the found misspelled word.
702 /// \return progress if a new word was found.
703 int spellCheck(DocIterator & from, DocIterator & to,
704 WordLangTuple & word_lang, docstring_list & suggestions) const;
706 void checkChildBuffers();
708 void checkMasterBuffer();
710 /// compute statistics between \p from and \p to
711 /// \p from initial position
712 /// \p to points to the end position
713 /// \p skipNoOutput if notes etc. should be ignored
714 void updateStatistics(DocIterator & from, DocIterator & to,
715 bool skipNoOutput = true) const;
716 /// statistics accessor functions
717 int wordCount() const;
718 int charCount(bool with_blanks) const;
721 friend class MarkAsExporting;
722 /// mark the buffer as busy exporting something, or not
723 void setExportStatus(bool e) const;
726 References & getReferenceCache(docstring const & label);
727 /// Change name of buffer. Updates "read-only" flag.
728 void setFileName(support::FileName const & fname);
730 void getLanguages(std::set<Language const *> &) const;
731 /// Checks whether any of the referenced bibfiles have changed since the
732 /// last time we loaded the cache. Note that this does NOT update the
733 /// cached information.
734 void checkIfBibInfoCacheIsValid() const;
735 /// Update the list of all bibfiles in use (including bibfiles
736 /// of loaded child documents).
737 void updateBibfilesCache(UpdateScope scope = UpdateMaster) const;
738 /// Return the list with all bibfiles in use (including bibfiles
739 /// of loaded child documents).
740 support::FileNameList const &
741 getBibfilesCache(UpdateScope scope = UpdateMaster) const;
743 void collectChildren(ListOfBuffers & children, bool grand_children) const;
746 Buffer(Buffer const &);
747 void operator=(Buffer const &);
749 /// Use the Pimpl idiom to hide the internals.
751 /// The pointer never changes although *pimpl_'s contents may.
756 /// Helper class, to guarantee that the export status
757 /// gets reset properly. To use, simply create a local variable:
758 /// MarkAsExporting mex(bufptr);
759 /// and leave the rest to us.
760 class MarkAsExporting {
762 MarkAsExporting(Buffer const * buf) : buf_(buf)
764 buf_->setExportStatus(true);
768 buf_->setExportStatus(false);
771 Buffer const * const buf_;