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 "insets/InsetCode.h"
19 #include "support/strfwd.h"
20 #include "support/types.h"
53 class ParConstIterator;
63 class GuiBufferDelegate;
64 class WorkAreaManager;
74 typedef std::list<Buffer *> ListOfBuffers;
77 /** The buffer object.
78 * This is the buffer object. It contains all the informations about
79 * a document loaded into LyX.
80 * The buffer object owns the Text (wrapped in an InsetText), which
81 * contains the individual paragraphs of the document.
84 * I am not sure if the class is complete or
85 * minimal, probably not.
86 * \author Lars Gullik Bjønnes
90 /// What type of log will \c getLogName() return?
92 latexlog, ///< LaTeX log
93 buildlog ///< Literate build log
96 /// Result of \c readFile()
106 ReadEmergencyFailure,
119 /// Method to check if a file is externally modified, used by
120 /// isExternallyModified()
122 * timestamp is fast but inaccurate. For example, the granularity
123 * of timestamp on a FAT filesystem is 2 second. Also, various operations
124 * may touch the timestamp of a file even when its content is unchanged.
126 * checksum is accurate but slow, which can be a problem when it is
127 * frequently used, or used for a large file on a slow (network) file
130 * FIXME: replace this method with support/FileMonitor.
133 checksum_method, ///< Use file checksum
134 timestamp_method, ///< Use timestamp, and checksum if timestamp has changed
144 explicit Buffer(std::string const & file, bool readonly = false,
145 Buffer const * cloned_buffer = 0);
151 Buffer * clone() const;
153 bool isClone() const;
155 /** High-level interface to buffer functionality.
156 This function parses a command string and executes it.
158 void dispatch(std::string const & command, DispatchResult & result);
160 /// Maybe we know the function already by number...
161 void dispatch(FuncRequest const & func, DispatchResult & result);
163 /// Can this function be exectued?
164 /// \return true if we made a decision
165 bool getStatus(FuncRequest const & cmd, FuncStatus & flag);
168 DocIterator getParFromID(int id) const;
169 /// do we have a paragraph with this id?
170 bool hasParWithID(int id) const;
173 frontend::WorkAreaManager & workAreaManager() const;
176 Takes care of auto-save files and backup file if requested.
177 Returns \c true if the save is successful, \c false otherwise.
181 /// Write document to stream. Returns \c false if unsuccesful.
182 bool write(std::ostream &) const;
183 /// Write file. Returns \c false if unsuccesful.
184 bool writeFile(support::FileName const &) const;
186 /// \name Functions involved in reading files/strings.
188 /// Loads a LyX file \c fn into the buffer. This function
189 /// tries to extract the file from version control if it
190 /// cannot be found. If it can be found, it will try to
191 /// read an emergency save file or an autosave file.
192 /// \sa loadThisLyXFile
193 ReadStatus loadLyXFile(support::FileName const & fn);
194 /// Loads a LyX file \c fn into the buffer. If you want
195 /// to check for files in a version control container,
196 /// emergency or autosave files, one should use \c loadLyXFile.
198 ReadStatus loadThisLyXFile(support::FileName const & fn);
199 /// read a new document from a string
200 bool readString(std::string const &);
201 /// Reloads the LyX file
203 //FIXME: The following two functions should be private
205 /// read the header, returns number of unknown tokens
206 int readHeader(Lexer & lex);
207 /// save timestamp and checksum of the given file.
208 void saveCheckSum() const;
212 ReadStatus readFile(support::FileName const & fn);
213 /// Reads a file without header.
214 /// \param par if != 0 insert the file.
215 /// \return \c true if file is not completely read.
216 bool readDocument(Lexer &);
217 /// Try to extract the file from a version control container
218 /// before reading if the file cannot be found. This is only
219 /// implemented for RCS.
220 /// \sa LyXVC::file_not_found_hook
221 ReadStatus extractFromVC(support::FileName const & fn);
222 /// Reads the first tag of a LyX File and
223 /// returns the file format number.
224 ReadStatus parseLyXFormat(Lexer & lex, support::FileName const & fn,
225 int & file_format) const;
226 /// Convert the LyX file to the LYX_FORMAT using
227 /// the lyx2lyx script and returns the filename
228 /// of the temporary file to be read
229 ReadStatus convertLyXFormat(support::FileName const & fn,
230 support::FileName & tmpfile, int from_format);
234 /// \name Functions involved in autosave and emergency files.
237 void autoSave() const;
238 /// save emergency file
239 /// \return a status message towards the user.
240 docstring emergencyWrite();
242 //FIXME:The following three functions should be private
245 void removeAutosaveFile() const;
247 void moveAutosaveFile(support::FileName const & old) const;
248 /// Get the filename of the autosave file associated with the Buffer
249 support::FileName getAutosaveFileName() const;
252 /// Try to load an autosave file associated to \c fn.
253 ReadStatus loadAutosave(support::FileName const & fn);
254 /// Get the filename of the autosave file associated with \c fn
255 support::FileName getAutosaveFileNameFor(support::FileName const & fn)
258 /// Try to load an emergency file associated to \c fn.
259 ReadStatus loadEmergency(support::FileName const & fn);
260 /// Get the filename of the emergency file associated with the Buffer
261 support::FileName getEmergencyFileName() const;
262 /// Get the filename of the emergency file associated with \c fn
263 support::FileName getEmergencyFileNameFor(support::FileName const & fn)
268 /// Fill in the ErrorList with the TeXErrors
269 void bufferErrors(TeXErrors const &, ErrorList &) const;
271 /// Just a wrapper for writeLaTeXSource, first creating the ofstream.
272 bool makeLaTeXFile(support::FileName const & filename,
273 std::string const & original_path,
274 OutputParams const &,
275 bool output_preamble = true,
276 bool output_body = true) const;
277 /** Export the buffer to LaTeX.
278 If \p os is a file stream, and params().inputenc is "auto" or
279 "default", and the buffer contains text in different languages
280 with more than one encoding, then this method will change the
281 encoding associated to \p os. Therefore you must not call this
282 method with a string stream if the output is supposed to go to a
285 ofs.open("test.tex");
286 writeLaTeXSource(ofs, ...);
288 \endcode is NOT equivalent to \code
289 odocstringstream oss;
290 writeLaTeXSource(oss, ...);
292 ofs.open("test.tex");
297 void writeLaTeXSource(odocstream & os,
298 std::string const & original_path,
299 OutputParams const &,
300 bool output_preamble = true,
301 bool output_body = true) const;
303 void makeDocBookFile(support::FileName const & filename,
304 OutputParams const & runparams_in,
305 bool only_body = false) const;
307 void writeDocBookSource(odocstream & os, std::string const & filename,
308 OutputParams const & runparams_in,
309 bool only_body = false) const;
311 void makeLyXHTMLFile(support::FileName const & filename,
312 OutputParams const & runparams_in,
313 bool only_body = false) const;
315 void writeLyXHTMLSource(odocstream & os,
316 OutputParams const & runparams_in,
317 bool only_body = false) const;
318 /// returns the main language for the buffer (document)
319 Language const * language() const;
320 /// get l10n translated to the buffers language
321 docstring const B_(std::string const & l10n) const;
325 /// return true if the main lyx file does not need saving
326 bool isClean() const;
328 bool isDepClean(std::string const & name) const;
330 /// whether or not disk file has been externally modified
331 bool isExternallyModified(CheckMethod method) const;
333 /// mark the main lyx file as not needing saving
334 void markClean() const;
337 void markDepClean(std::string const & name);
340 void setUnnamed(bool flag = true);
342 /// Whether or not a filename has been assigned to this buffer
343 bool isUnnamed() const;
345 /// Whether or not this buffer is internal.
347 /// An internal buffer does not contain a real document, but some auxiliary text segment.
348 /// It is not associated with a filename, it is never saved, thus it does not need to be
349 /// automatically saved, nor it needs to trigger any "do you want to save ?" question.
350 bool isInternal() const;
352 /// Mark this buffer as dirty.
355 /// Returns the buffer's filename. It is always an absolute path.
356 support::FileName fileName() const;
358 /// Returns the buffer's filename. It is always an absolute path.
359 std::string absFileName() const;
361 /// Returns the the path where the buffer lives.
362 /// It is always an absolute path.
363 std::string filePath() const;
365 /** A transformed version of the file name, adequate for LaTeX.
366 \param no_path optional if \c true then the path is stripped.
368 std::string latexName(bool no_path = true) const;
370 /// Get the name and type of the log.
371 std::string logName(LogType * type = 0) const;
373 /// Change name of buffer. Updates "read-only" flag.
374 void setFileName(std::string const & newfile);
376 /// Set document's parent Buffer.
377 void setParent(Buffer const *);
378 Buffer const * parent() const;
380 /** Get the document's master (or \c this if this is not a
383 Buffer const * masterBuffer() const;
385 /// \return true if \p child is a child of this \c Buffer.
386 bool isChild(Buffer * child) const;
388 /// \return true if this \c Buffer has children
389 bool hasChildren() const;
391 /// \return a list of the direct children of this Buffer.
392 /// this list has no duplicates and is in the order in which
393 /// the children appear.
394 ListOfBuffers getChildren() const;
396 /// \return a list of all descendents of this Buffer (children,
397 /// grandchildren, etc). this list has no duplicates and is in
398 /// the order in which the children appear.
399 ListOfBuffers getDescendents() const;
401 /// Collect all relative buffers, in the order in which they appear.
402 /// I.e., the "root" Buffer is first, then its first child, then any
403 /// of its children, etc. However, there are no duplicates in this
405 /// This is "stable", too, in the sense that it returns the same
406 /// thing from whichever Buffer it is called.
407 ListOfBuffers allRelatives() const;
409 /// Is buffer read-only?
410 bool isReadonly() const;
412 /// Set buffer read-only flag
413 void setReadonly(bool flag = true);
415 /// returns \c true if the buffer contains a LaTeX document
416 bool isLatex() const;
417 /// returns \c true if the buffer contains a DocBook document
418 bool isDocBook() const;
419 /// returns \c true if the buffer contains a Wed document
420 bool isLiterate() const;
422 /** Validate a buffer for LaTeX.
423 This validates the buffer, and returns a struct for use by
424 #makeLaTeX# and others. Its main use is to figure out what
425 commands and packages need to be included in the LaTeX file.
426 It (should) also check that the needed constructs are there
427 (i.e. that the \refs points to coresponding \labels). It
428 should perhaps inset "error" insets to help the user correct
431 void validate(LaTeXFeatures &) const;
433 /// Reference information is cached in the Buffer, so we do not
434 /// have to check or read things over and over.
436 /// There are two caches.
438 /// One is a cache of the BibTeX files from which reference info is
439 /// being gathered. This cache is PER BUFFER, and the cache for the
440 /// master essentially includes the cache for its children. This gets
441 /// invalidated when an InsetBibtex is created, deleted, or modified.
443 /// The other is a cache of the reference information itself. This
444 /// exists only in the master buffer, and when it needs to be updated,
445 /// the children add their information to the master's cache.
447 /// Calling this method invalidates the cache and so requires a
449 void invalidateBibinfoCache() const;
450 /// This invalidates the cache of files we need to check.
451 void invalidateBibfileCache() const;
452 /// Updates the cached bibliography information.
453 /// Note that you MUST call this method to update the cache. It will
454 /// not happen otherwise. (Currently, it is called at the start of
455 /// updateBuffer() and from GuiCitation.)
456 /// Note that this operates on the master document.
457 void checkBibInfoCache() const;
458 /// \return the bibliography information for this buffer's master,
459 /// or just for it, if it isn't a child.
460 BiblioInfo const & masterBibInfo() const;
462 void fillWithBibKeys(BiblioInfo & keys) const;
464 void getLabelList(std::vector<docstring> &) const;
467 void changeLanguage(Language const * from, Language const * to);
470 bool isMultiLingual() const;
472 std::set<Language const *> getLanguages() const;
475 BufferParams & params();
476 BufferParams const & params() const;
478 /** The list of paragraphs.
479 This is a linked list of paragraph, this list holds the
480 whole contents of the document.
482 ParagraphList & paragraphs();
483 ParagraphList const & paragraphs() const;
485 /// LyX version control object.
487 LyXVC const & lyxvc() const;
489 /// Where to put temporary files.
490 std::string const temppath() const;
492 /// Used when typesetting to place errorboxes.
493 TexRow const & texrow() const;
497 ParIterator par_iterator_begin();
499 ParConstIterator par_iterator_begin() const;
501 ParIterator par_iterator_end();
503 ParConstIterator par_iterator_end() const;
505 // Position of the child buffer where it appears first in the master.
506 DocIterator firstChildPosition(Buffer const * child);
508 /** \returns true only when the file is fully loaded.
509 * Used to prevent the premature generation of previews
510 * and by the citation inset.
512 bool isFullyLoaded() const;
513 /// Set by buffer_funcs' newFile.
514 void setFullyLoaded(bool);
516 /// Update the LaTeX preview snippets associated with this buffer
517 void updatePreviews() const;
518 /// Remove any previewed LaTeX snippets associated with this buffer
519 void removePreviews() const;
521 /// Our main text (inside the top InsetText)
524 /// Our top InsetText
525 Inset & inset() const;
530 /// Collect macro definitions in paragraphs
531 void updateMacros() const;
532 /// Iterate through the whole buffer and try to resolve macros
533 void updateMacroInstances() const;
535 /// List macro names of this buffer, the parent and the children
536 void listMacroNames(MacroNameSet & macros) const;
537 /// Collect macros of the parent and its children in front of this buffer.
538 void listParentMacros(MacroSet & macros, LaTeXFeatures & features) const;
540 /// Return macro defined before pos (or in the master buffer)
541 MacroData const * getMacro(docstring const & name, DocIterator const & pos, bool global = true) const;
542 /// Return macro defined anywhere in the buffer (or in the master buffer)
543 MacroData const * getMacro(docstring const & name, bool global = true) const;
544 /// Return macro defined before the inclusion of the child
545 MacroData const * getMacro(docstring const & name, Buffer const & child, bool global = true) const;
547 /// Collect user macro names at loading time
548 typedef std::set<docstring> UserMacroSet;
549 UserMacroSet usermacros;
551 /// Replace the inset contents for insets which InsetCode is equal
552 /// to the passed \p inset_code.
553 void changeRefsIfUnique(docstring const & from, docstring const & to,
556 /// get source code (latex/docbook) for some paragraphs, or all paragraphs
557 /// including preamble
558 void getSourceCode(odocstream & os, pit_type par_begin, pit_type par_end,
559 bool full_source) const;
561 /// Access to error list.
562 /// This method is used only for GUI visualisation of Buffer related
563 /// errors (like parsing or LateX compilation). This method is const
564 /// because modifying the returned ErrorList does not touch the document
566 ErrorList & errorList(std::string const & type) const;
569 /// This is useful only for screen visualisation of the Buffer. This
570 /// method is const because modifying this backend does not touch
571 /// the document contents.
572 TocBackend & tocBackend() const;
577 /// This function is called when the buffer is changed.
578 void changed(bool update_metrics) const;
580 void setChild(DocIterator const & dit, Buffer * child);
582 void updateTocItem(std::string const &, DocIterator const &) const;
583 /// This function is called when the buffer structure is changed.
584 void structureChanged() const;
585 /// This function is called when some parsing error shows up.
586 void errors(std::string const & err, bool from_master = false) const;
587 /// This function is called when the buffer busy status change.
588 void setBusy(bool on) const;
589 /// Update window titles of all users.
590 void updateTitles() const;
591 /// Reset autosave timers for all users.
592 void resetAutosaveTimers() const;
594 void message(docstring const & msg) const;
597 void setGuiDelegate(frontend::GuiBufferDelegate * gui);
599 bool hasGuiDelegate() const;
603 /// return the format of the buffer on a string
604 std::string bufferFormat() const;
605 /// return the default output format of the current backend
606 std::string getDefaultOutputFormat() const;
609 bool doExport(std::string const & format, bool put_in_tempdir,
610 bool includeall, std::string & result_file) const;
612 bool doExport(std::string const & format, bool put_in_tempdir,
613 bool includeall = false) const;
615 bool preview(std::string const & format, bool includeall = false) const;
617 bool isExportable(std::string const & format) const;
619 std::vector<Format const *> exportableFormats(bool only_viewable) const;
621 bool isExportableFormat(std::string const & format) const;
622 /// mark the buffer as busy exporting something, or not
623 void setExportStatus(bool e) const;
625 bool isExporting() const;
628 typedef std::vector<std::pair<Inset *, ParIterator> > References;
629 References & references(docstring const & label);
630 References const & references(docstring const & label) const;
631 void clearReferenceCache() const;
632 void setInsetLabel(docstring const & label, InsetLabel const * il);
633 InsetLabel const * insetLabel(docstring const & label) const;
635 /// return a list of all used branches (also in children)
636 void getUsedBranches(std::list<docstring> &, bool const from_master = false) const;
638 /// sets the buffer_ member for every inset in this buffer.
639 // FIXME This really shouldn't be needed, but at the moment it's not
640 // clear how to do it just for the individual pieces we need.
641 void setBuffersForInsets() const;
642 /// Updates screen labels and some other information associated with
643 /// insets and paragraphs. Actually, it's more like a general "recurse
644 /// through the Buffer" routine, that visits all the insets and paragraphs.
645 void updateBuffer() const { updateBuffer(UpdateMaster, InternalUpdate); }
646 /// \param scope: whether to start with the master document or just
648 /// \param output: whether we are preparing for output.
649 void updateBuffer(UpdateScope scope, UpdateType utype) const;
651 void updateBuffer(ParIterator & parit, UpdateType utype) const;
653 /// Spellcheck starting from \p from.
654 /// \p from initial position, will then points to the next misspelled
656 /// \p to will points to the end of the next misspelled word.
657 /// \p word_lang will contain the found misspelled word.
658 /// \return progress if a new word was found.
659 int spellCheck(DocIterator & from, DocIterator & to,
660 WordLangTuple & word_lang, docstring_list & suggestions) const;
662 void checkChildBuffers();
666 std::vector<std::string> backends() const;
668 void getLanguages(std::set<Language const *> &) const;
669 /// Update the list of all bibfiles in use (including bibfiles
670 /// of loaded child documents).
671 void updateBibfilesCache(UpdateScope scope = UpdateMaster) const;
672 /// Return the list with all bibfiles in use (including bibfiles
673 /// of loaded child documents).
674 support::FileNameList const &
675 getBibfilesCache(UpdateScope scope = UpdateMaster) const;
677 void collectChildren(ListOfBuffers & children, bool grand_children) const;
680 /// Use the Pimpl idiom to hide the internals.
682 /// The pointer never changes although *pimpl_'s contents may.