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 ReadStatus loadLyXFile(support::FileName const & fn);
193 /// read a new document from a string
194 bool readString(std::string const &);
195 /// Reloads the LyX file
197 //FIXME: The following two functions should be private
200 ReadStatus readFile(support::FileName const & fn);
201 /// read the header, returns number of unknown tokens
202 int readHeader(Lexer & lex);
205 /// Reads a file without header.
206 /// \param par if != 0 insert the file.
207 /// \return \c true if file is not completely read.
208 bool readDocument(Lexer &);
209 /// Try to extract the file from a version control container
210 /// before reading if the file cannot be found. This is only
211 /// implemented for RCS.
212 /// \sa LyXVC::file_not_found_hook
213 ReadStatus readFromVC(support::FileName const & fn);
214 /// Reads the first tag of a LyX File and
215 /// returns the file format number.
216 ReadStatus parseLyXFormat(Lexer & lex, support::FileName const & fn,
217 int & file_format) const;
218 /// Convert the LyX file to the LYX_FORMAT using
219 /// the lyx2lyx script and returns the filename
220 /// of the temporary file to be read
221 ReadStatus convertLyXFormat(support::FileName const & fn,
222 support::FileName & tmpfile, int from_format);
226 /// \name Functions involved in autosave and emergency files.
229 void autoSave() const;
230 /// save emergency file
231 /// \return a status message towards the user.
232 docstring emergencyWrite();
234 //FIXME:The following three functions should be private
237 void removeAutosaveFile() const;
239 void moveAutosaveFile(support::FileName const & old) const;
240 /// Get the filename of the autosave file associated with the Buffer
241 support::FileName getAutosaveFileName() const;
244 /// Try to read an autosave file associated to \c fn.
245 ReadStatus readAutosave(support::FileName const & fn);
246 /// Get the filename of the autosave file associated with \c fn
247 support::FileName getAutosaveFileNameFor(support::FileName const & fn)
250 /// Try to read an emergency file associated to \c fn.
251 ReadStatus readEmergency(support::FileName const & fn);
252 /// Get the filename of the emergency file associated with the Buffer
253 support::FileName getEmergencyFileName() const;
254 /// Get the filename of the emergency file associated with \c fn
255 support::FileName getEmergencyFileNameFor(support::FileName const & fn)
260 /// Fill in the ErrorList with the TeXErrors
261 void bufferErrors(TeXErrors const &, ErrorList &) const;
263 /// Just a wrapper for writeLaTeXSource, first creating the ofstream.
264 bool makeLaTeXFile(support::FileName const & filename,
265 std::string const & original_path,
266 OutputParams const &,
267 bool output_preamble = true,
268 bool output_body = true) const;
269 /** Export the buffer to LaTeX.
270 If \p os is a file stream, and params().inputenc is "auto" or
271 "default", and the buffer contains text in different languages
272 with more than one encoding, then this method will change the
273 encoding associated to \p os. Therefore you must not call this
274 method with a string stream if the output is supposed to go to a
277 ofs.open("test.tex");
278 writeLaTeXSource(ofs, ...);
280 \endcode is NOT equivalent to \code
281 odocstringstream oss;
282 writeLaTeXSource(oss, ...);
284 ofs.open("test.tex");
289 void writeLaTeXSource(odocstream & os,
290 std::string const & original_path,
291 OutputParams const &,
292 bool output_preamble = true,
293 bool output_body = true) const;
295 void makeDocBookFile(support::FileName const & filename,
296 OutputParams const & runparams_in,
297 bool only_body = false) const;
299 void writeDocBookSource(odocstream & os, std::string const & filename,
300 OutputParams const & runparams_in,
301 bool only_body = false) const;
303 void makeLyXHTMLFile(support::FileName const & filename,
304 OutputParams const & runparams_in,
305 bool only_body = false) const;
307 void writeLyXHTMLSource(odocstream & os,
308 OutputParams const & runparams_in,
309 bool only_body = false) const;
310 /// returns the main language for the buffer (document)
311 Language const * language() const;
312 /// get l10n translated to the buffers language
313 docstring const B_(std::string const & l10n) const;
317 /// return true if the main lyx file does not need saving
318 bool isClean() const;
320 bool isDepClean(std::string const & name) const;
322 /// whether or not disk file has been externally modified
323 bool isExternallyModified(CheckMethod method) const;
325 /// save timestamp and checksum of the given file.
326 void saveCheckSum(support::FileName const & file) const;
328 /// mark the main lyx file as not needing saving
329 void markClean() const;
332 void markDepClean(std::string const & name);
335 void setUnnamed(bool flag = true);
337 /// Whether or not a filename has been assigned to this buffer
338 bool isUnnamed() const;
340 /// Whether or not this buffer is internal.
342 /// An internal buffer does not contain a real document, but some auxiliary text segment.
343 /// It is not associated with a filename, it is never saved, thus it does not need to be
344 /// automatically saved, nor it needs to trigger any "do you want to save ?" question.
345 bool isInternal() const;
347 /// Mark this buffer as dirty.
350 /// Returns the buffer's filename. It is always an absolute path.
351 support::FileName fileName() const;
353 /// Returns the buffer's filename. It is always an absolute path.
354 std::string absFileName() const;
356 /// Returns the the path where the buffer lives.
357 /// It is always an absolute path.
358 std::string filePath() const;
360 /** A transformed version of the file name, adequate for LaTeX.
361 \param no_path optional if \c true then the path is stripped.
363 std::string latexName(bool no_path = true) const;
365 /// Get the name and type of the log.
366 std::string logName(LogType * type = 0) const;
368 /// Change name of buffer. Updates "read-only" flag.
369 void setFileName(std::string const & newfile);
371 /// Set document's parent Buffer.
372 void setParent(Buffer const *);
373 Buffer const * parent() const;
375 /** Get the document's master (or \c this if this is not a
378 Buffer const * masterBuffer() const;
380 /// \return true if \p child is a child of this \c Buffer.
381 bool isChild(Buffer * child) const;
383 /// \return true if this \c Buffer has children
384 bool hasChildren() const;
386 /// \return a list of the direct children of this Buffer.
387 /// this list has no duplicates and is in the order in which
388 /// the children appear.
389 ListOfBuffers getChildren() const;
391 /// \return a list of all descendents of this Buffer (children,
392 /// grandchildren, etc). this list has no duplicates and is in
393 /// the order in which the children appear.
394 ListOfBuffers getDescendents() const;
396 /// Collect all relative buffers, in the order in which they appear.
397 /// I.e., the "root" Buffer is first, then its first child, then any
398 /// of its children, etc. However, there are no duplicates in this
400 /// This is "stable", too, in the sense that it returns the same
401 /// thing from whichever Buffer it is called.
402 ListOfBuffers allRelatives() const;
404 /// Is buffer read-only?
405 bool isReadonly() const;
407 /// Set buffer read-only flag
408 void setReadonly(bool flag = true);
410 /// returns \c true if the buffer contains a LaTeX document
411 bool isLatex() const;
412 /// returns \c true if the buffer contains a DocBook document
413 bool isDocBook() const;
414 /// returns \c true if the buffer contains a Wed document
415 bool isLiterate() const;
417 /** Validate a buffer for LaTeX.
418 This validates the buffer, and returns a struct for use by
419 #makeLaTeX# and others. Its main use is to figure out what
420 commands and packages need to be included in the LaTeX file.
421 It (should) also check that the needed constructs are there
422 (i.e. that the \refs points to coresponding \labels). It
423 should perhaps inset "error" insets to help the user correct
426 void validate(LaTeXFeatures &) const;
428 /// Reference information is cached in the Buffer, so we do not
429 /// have to check or read things over and over.
431 /// There are two caches.
433 /// One is a cache of the BibTeX files from which reference info is
434 /// being gathered. This cache is PER BUFFER, and the cache for the
435 /// master essentially includes the cache for its children. This gets
436 /// invalidated when an InsetBibtex is created, deleted, or modified.
438 /// The other is a cache of the reference information itself. This
439 /// exists only in the master buffer, and when it needs to be updated,
440 /// the children add their information to the master's cache.
442 /// Calling this method invalidates the cache and so requires a
444 void invalidateBibinfoCache() const;
445 /// This invalidates the cache of files we need to check.
446 void invalidateBibfileCache() const;
447 /// Updates the cached bibliography information.
448 /// Note that you MUST call this method to update the cache. It will
449 /// not happen otherwise. (Currently, it is called at the start of
450 /// updateBuffer() and from GuiCitation.)
451 /// Note that this operates on the master document.
452 void checkBibInfoCache() const;
453 /// \return the bibliography information for this buffer's master,
454 /// or just for it, if it isn't a child.
455 BiblioInfo const & masterBibInfo() const;
457 void fillWithBibKeys(BiblioInfo & keys) const;
459 void getLabelList(std::vector<docstring> &) const;
462 void changeLanguage(Language const * from, Language const * to);
465 bool isMultiLingual() const;
467 std::set<Language const *> getLanguages() const;
470 BufferParams & params();
471 BufferParams const & params() const;
473 /** The list of paragraphs.
474 This is a linked list of paragraph, this list holds the
475 whole contents of the document.
477 ParagraphList & paragraphs();
478 ParagraphList const & paragraphs() const;
480 /// LyX version control object.
482 LyXVC const & lyxvc() const;
484 /// Where to put temporary files.
485 std::string const temppath() const;
487 /// Used when typesetting to place errorboxes.
488 TexRow const & texrow() const;
492 ParIterator par_iterator_begin();
494 ParConstIterator par_iterator_begin() const;
496 ParIterator par_iterator_end();
498 ParConstIterator par_iterator_end() const;
500 // Position of the child buffer where it appears first in the master.
501 DocIterator firstChildPosition(Buffer const * child);
503 /** \returns true only when the file is fully loaded.
504 * Used to prevent the premature generation of previews
505 * and by the citation inset.
507 bool isFullyLoaded() const;
508 /// Set by buffer_funcs' newFile.
509 void setFullyLoaded(bool);
511 /// Our main text (inside the top InsetText)
514 /// Our top InsetText
515 Inset & inset() const;
520 /// Collect macro definitions in paragraphs
521 void updateMacros() const;
522 /// Iterate through the whole buffer and try to resolve macros
523 void updateMacroInstances() const;
525 /// List macro names of this buffer, the parent and the children
526 void listMacroNames(MacroNameSet & macros) const;
527 /// Collect macros of the parent and its children in front of this buffer.
528 void listParentMacros(MacroSet & macros, LaTeXFeatures & features) const;
530 /// Return macro defined before pos (or in the master buffer)
531 MacroData const * getMacro(docstring const & name, DocIterator const & pos, bool global = true) const;
532 /// Return macro defined anywhere in the buffer (or in the master buffer)
533 MacroData const * getMacro(docstring const & name, bool global = true) const;
534 /// Return macro defined before the inclusion of the child
535 MacroData const * getMacro(docstring const & name, Buffer const & child, bool global = true) const;
537 /// Collect user macro names at loading time
538 typedef std::set<docstring> UserMacroSet;
539 UserMacroSet usermacros;
541 /// Replace the inset contents for insets which InsetCode is equal
542 /// to the passed \p inset_code.
543 void changeRefsIfUnique(docstring const & from, docstring const & to,
546 /// get source code (latex/docbook) for some paragraphs, or all paragraphs
547 /// including preamble
548 void getSourceCode(odocstream & os, pit_type par_begin, pit_type par_end,
549 bool full_source) const;
551 /// Access to error list.
552 /// This method is used only for GUI visualisation of Buffer related
553 /// errors (like parsing or LateX compilation). This method is const
554 /// because modifying the returned ErrorList does not touch the document
556 ErrorList & errorList(std::string const & type) const;
559 /// This is useful only for screen visualisation of the Buffer. This
560 /// method is const because modifying this backend does not touch
561 /// the document contents.
562 TocBackend & tocBackend() const;
567 /// This function is called when the buffer is changed.
568 void changed(bool update_metrics) const;
570 void setChild(DocIterator const & dit, Buffer * child);
572 void updateTocItem(std::string const &, DocIterator const &) const;
573 /// This function is called when the buffer structure is changed.
574 void structureChanged() const;
575 /// This function is called when some parsing error shows up.
576 void errors(std::string const & err, bool from_master = false) const;
577 /// This function is called when the buffer busy status change.
578 void setBusy(bool on) const;
579 /// Update window titles of all users.
580 void updateTitles() const;
581 /// Reset autosave timers for all users.
582 void resetAutosaveTimers() const;
584 void message(docstring const & msg) const;
587 void setGuiDelegate(frontend::GuiBufferDelegate * gui);
589 bool hasGuiDelegate() const;
593 /// return the format of the buffer on a string
594 std::string bufferFormat() const;
595 /// return the default output format of the current backend
596 std::string getDefaultOutputFormat() const;
599 bool doExport(std::string const & format, bool put_in_tempdir,
600 bool includeall, std::string & result_file) const;
602 bool doExport(std::string const & format, bool put_in_tempdir,
603 bool includeall = false) const;
605 bool preview(std::string const & format, bool includeall = false) const;
607 bool isExportable(std::string const & format) const;
609 std::vector<Format const *> exportableFormats(bool only_viewable) const;
611 bool isExportableFormat(std::string const & format) const;
612 /// mark the buffer as busy exporting something, or not
613 void setExportStatus(bool e) const;
615 bool isExporting() const;
618 typedef std::vector<std::pair<Inset *, ParIterator> > References;
619 References & references(docstring const & label);
620 References const & references(docstring const & label) const;
621 void clearReferenceCache() const;
622 void setInsetLabel(docstring const & label, InsetLabel const * il);
623 InsetLabel const * insetLabel(docstring const & label) const;
625 /// return a list of all used branches (also in children)
626 void getUsedBranches(std::list<docstring> &, bool const from_master = false) const;
628 /// sets the buffer_ member for every inset in this buffer.
629 // FIXME This really shouldn't be needed, but at the moment it's not
630 // clear how to do it just for the individual pieces we need.
631 void setBuffersForInsets() const;
632 /// Updates screen labels and some other information associated with
633 /// insets and paragraphs. Actually, it's more like a general "recurse
634 /// through the Buffer" routine, that visits all the insets and paragraphs.
635 void updateBuffer() const { updateBuffer(UpdateMaster, InternalUpdate); }
636 /// \param scope: whether to start with the master document or just
638 /// \param output: whether we are preparing for output.
639 void updateBuffer(UpdateScope scope, UpdateType utype) const;
641 void updateBuffer(ParIterator & parit, UpdateType utype) const;
643 /// Spellcheck starting from \p from.
644 /// \p from initial position, will then points to the next misspelled
646 /// \p to will points to the end of the next misspelled word.
647 /// \p word_lang will contain the found misspelled word.
648 /// \return progress if a new word was found.
649 int spellCheck(DocIterator & from, DocIterator & to,
650 WordLangTuple & word_lang, docstring_list & suggestions) const;
652 void checkChildBuffers();
656 std::vector<std::string> backends() const;
658 void getLanguages(std::set<Language const *> &) const;
659 /// Update the list of all bibfiles in use (including bibfiles
660 /// of loaded child documents).
661 void updateBibfilesCache(UpdateScope scope = UpdateMaster) const;
662 /// Return the list with all bibfiles in use (including bibfiles
663 /// of loaded child documents).
664 support::FileNameList const &
665 getBibfilesCache(UpdateScope scope = UpdateMaster) const;
667 void collectChildren(ListOfBuffers & children, bool grand_children) const;
670 /// Use the Pimpl idiom to hide the internals.
672 /// The pointer never changes although *pimpl_'s contents may.