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;
77 typedef std::list<Buffer *> ListOfBuffers;
80 /** The buffer object.
81 * This is the buffer object. It contains all the informations about
82 * a document loaded into LyX.
83 * The buffer object owns the Text (wrapped in an InsetText), which
84 * contains the individual paragraphs of the document.
87 * I am not sure if the class is complete or
88 * minimal, probably not.
89 * \author Lars Gullik Bjønnes
93 /// What type of log will \c getLogName() return?
95 latexlog, ///< LaTeX log
96 buildlog ///< Literate build log
99 /// Result of \c readFile()
109 ReadEmergencyFailure,
122 /// Method to check if a file is externally modified, used by
123 /// isExternallyModified()
125 * timestamp is fast but inaccurate. For example, the granularity
126 * of timestamp on a FAT filesystem is 2 second. Also, various operations
127 * may touch the timestamp of a file even when its content is unchanged.
129 * checksum is accurate but slow, which can be a problem when it is
130 * frequently used, or used for a large file on a slow (network) file
133 * FIXME: replace this method with support/FileMonitor.
136 checksum_method, ///< Use file checksum
137 timestamp_method ///< Use timestamp, and checksum if timestamp has changed
147 explicit Buffer(std::string const & file, bool readonly = false,
148 Buffer const * cloned_buffer = 0);
154 Buffer * clone() const;
156 bool isClone() const;
158 /** High-level interface to buffer functionality.
159 This function parses a command string and executes it.
161 void dispatch(std::string const & command, DispatchResult & result);
163 /// Maybe we know the function already by number...
164 void dispatch(FuncRequest const & func, DispatchResult & result);
166 /// Can this function be exectued?
167 /// \return true if we made a decision
168 bool getStatus(FuncRequest const & cmd, FuncStatus & flag);
171 DocIterator getParFromID(int id) const;
172 /// do we have a paragraph with this id?
173 bool hasParWithID(int id) const;
176 frontend::WorkAreaManager & workAreaManager() const;
179 Takes care of auto-save files and backup file if requested.
180 Returns \c true if the save is successful, \c false otherwise.
183 /// Renames and saves the buffer
184 bool saveAs(support::FileName const & fn);
186 /// Write document to stream. Returns \c false if unsuccessful.
187 bool write(std::ostream &) const;
188 /// Write file. Returns \c false if unsuccessful.
189 bool writeFile(support::FileName const &) const;
191 /// \name Functions involved in reading files/strings.
193 /// Loads the LyX file into the buffer. This function
194 /// tries to extract the file from version control if it
195 /// cannot be found. If it can be found, it will try to
196 /// read an emergency save file or an autosave file.
197 /// \sa loadThisLyXFile
198 ReadStatus loadLyXFile();
199 /// Loads the LyX file \c fn into the buffer. If you want
200 /// to check for files in a version control container,
201 /// emergency or autosave files, one should use \c loadLyXFile.
203 ReadStatus loadThisLyXFile(support::FileName const & fn);
204 /// read a new document from a string
205 bool readString(std::string const &);
206 /// Reloads the LyX file
208 //FIXME: The following function should be private
210 /// read the header, returns number of unknown tokens
211 int readHeader(Lexer & lex);
214 /// save timestamp and checksum of the given file.
215 void saveCheckSum() const;
217 ReadStatus readFile(support::FileName const & fn);
218 /// Reads a file without header.
219 /// \param par if != 0 insert the file.
220 /// \return \c true if file is not completely read.
221 bool readDocument(Lexer &);
222 /// Try to extract the file from a version control container
223 /// before reading if the file cannot be found. This is only
224 /// implemented for RCS.
225 /// \sa LyXVC::file_not_found_hook
226 ReadStatus extractFromVC();
227 /// Reads the first tag of a LyX File and
228 /// returns the file format number.
229 ReadStatus parseLyXFormat(Lexer & lex, support::FileName const & fn,
230 int & file_format) const;
231 /// Convert the LyX file to the LYX_FORMAT using
232 /// the lyx2lyx script and returns the filename
233 /// of the temporary file to be read
234 ReadStatus convertLyXFormat(support::FileName const & fn,
235 support::FileName & tmpfile, int from_format);
239 /// \name Functions involved in autosave and emergency files.
241 /// Save an autosave file to #filename.lyx#
242 bool autoSave() const;
243 /// save emergency file
244 /// \return a status message towards the user.
245 docstring emergencyWrite();
247 //FIXME:The following function should be private
250 void removeAutosaveFile() const;
253 /// Try to load an autosave file associated to \c fn.
254 ReadStatus loadAutosave();
255 /// Try to load an emergency file associated to \c fn.
256 ReadStatus loadEmergency();
257 /// Get the filename of the emergency file associated with the Buffer
258 support::FileName getEmergencyFileName() const;
259 /// Get the filename of the autosave file associated with the Buffer
260 support::FileName getAutosaveFileName() const;
262 void moveAutosaveFile(support::FileName const & old) const;
266 /// Fill in the ErrorList with the TeXErrors
267 void bufferErrors(TeXErrors const &, ErrorList &) const;
269 /// Just a wrapper for writeLaTeXSource, first creating the ofstream.
270 bool makeLaTeXFile(support::FileName const & filename,
271 std::string const & original_path,
272 OutputParams const &,
273 bool output_preamble = true,
274 bool output_body = true) const;
275 /** Export the buffer to LaTeX.
276 If \p os is a file stream, and params().inputenc is "auto" or
277 "default", and the buffer contains text in different languages
278 with more than one encoding, then this method will change the
279 encoding associated to \p os. Therefore you must not call this
280 method with a string stream if the output is supposed to go to a
283 otexstream os(ofs, texrow);
284 ofs.open("test.tex");
285 writeLaTeXSource(os, ...);
287 \endcode is NOT equivalent to \code
288 odocstringstream oss;
289 otexstream os(oss, texrow);
290 writeLaTeXSource(os, ...);
292 ofs.open("test.tex");
297 void writeLaTeXSource(otexstream & 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 /// Set document's parent Buffer.
374 void setParent(Buffer const *);
375 Buffer const * parent() const;
377 /** Get the document's master (or \c this if this is not a
380 Buffer const * masterBuffer() const;
382 /// \return true if \p child is a child of this \c Buffer.
383 bool isChild(Buffer * child) const;
385 /// \return true if this \c Buffer has children
386 bool hasChildren() const;
388 /// \return a list of the direct children of this Buffer.
389 /// this list has no duplicates and is in the order in which
390 /// the children appear.
391 ListOfBuffers getChildren() const;
393 /// \return a list of all descendents of this Buffer (children,
394 /// grandchildren, etc). this list has no duplicates and is in
395 /// the order in which the children appear.
396 ListOfBuffers getDescendents() const;
398 /// Collect all relative buffers, in the order in which they appear.
399 /// I.e., the "root" Buffer is first, then its first child, then any
400 /// of its children, etc. However, there are no duplicates in this
402 /// This is "stable", too, in the sense that it returns the same
403 /// thing from whichever Buffer it is called.
404 ListOfBuffers allRelatives() const;
406 /// Is buffer read-only?
407 bool isReadonly() const;
409 /// Set buffer read-only flag
410 void setReadonly(bool flag = true);
412 /** Validate a buffer for LaTeX.
413 This validates the buffer, and returns a struct for use by
414 #makeLaTeX# and others. Its main use is to figure out what
415 commands and packages need to be included in the LaTeX file.
416 It (should) also check that the needed constructs are there
417 (i.e. that the \refs points to coresponding \labels). It
418 should perhaps inset "error" insets to help the user correct
421 void validate(LaTeXFeatures &) const;
423 /// Reference information is cached in the Buffer, so we do not
424 /// have to check or read things over and over.
426 /// There are two caches.
428 /// One is a cache of the BibTeX files from which reference info is
429 /// being gathered. This cache is PER BUFFER, and the cache for the
430 /// master essentially includes the cache for its children. This gets
431 /// invalidated when an InsetBibtex is created, deleted, or modified.
433 /// The other is a cache of the reference information itself. This
434 /// exists only in the master buffer, and when it needs to be updated,
435 /// the children add their information to the master's cache.
437 /// Calling this method invalidates the cache and so requires a
439 void invalidateBibinfoCache() const;
440 /// This invalidates the cache of files we need to check.
441 void invalidateBibfileCache() const;
442 /// Updates the cached bibliography information, checking first to see
443 /// whether the cache is valid. If so, we do nothing. If not, then we
444 /// reload all the BibTeX info.
445 /// Note that this operates on the master document.
446 void reloadBibInfoCache() const;
447 /// \return the bibliography information for this buffer's master,
448 /// or just for it, if it isn't a child.
449 BiblioInfo const & masterBibInfo() const;
450 /// collect bibliography info from the various insets in this buffer.
451 void collectBibKeys() const;
452 /// add some BiblioInfo to our cache
453 void addBiblioInfo(BiblioInfo const & bi) const;
454 /// add a single piece of bibliography info to our cache
455 void addBibTeXInfo(docstring const & key, BibTeXInfo const & bi) const;
457 bool citeLabelsValid() 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 /// Update the LaTeX preview snippets associated with this buffer
512 void updatePreviews() const;
513 /// Remove any previewed LaTeX snippets associated with this buffer
514 void removePreviews() const;
516 /// Our main text (inside the top InsetText)
519 /// Our top InsetText
520 Inset & inset() const;
525 /// Collect macro definitions in paragraphs
526 void updateMacros() const;
527 /// Iterate through the whole buffer and try to resolve macros
528 void updateMacroInstances(UpdateType) const;
530 /// List macro names of this buffer, the parent and the children
531 void listMacroNames(MacroNameSet & macros) const;
532 /// Collect macros of the parent and its children in front of this buffer.
533 void listParentMacros(MacroSet & macros, LaTeXFeatures & features) const;
535 /// Return macro defined before pos (or in the master buffer)
536 MacroData const * getMacro(docstring const & name, DocIterator const & pos, bool global = true) const;
537 /// Return macro defined anywhere in the buffer (or in the master buffer)
538 MacroData const * getMacro(docstring const & name, bool global = true) const;
539 /// Return macro defined before the inclusion of the child
540 MacroData const * getMacro(docstring const & name, Buffer const & child, bool global = true) const;
542 /// Collect user macro names at loading time
543 typedef std::set<docstring> UserMacroSet;
544 mutable UserMacroSet usermacros;
546 /// Replace the inset contents for insets which InsetCode is equal
547 /// to the passed \p inset_code.
548 void changeRefsIfUnique(docstring const & from, docstring const & to,
551 /// get source code (latex/docbook) for some paragraphs, or all paragraphs
552 /// including preamble
553 void getSourceCode(odocstream & os, std::string const format,
554 pit_type par_begin, pit_type par_end, bool full_source) const;
556 /// Access to error list.
557 /// This method is used only for GUI visualisation of Buffer related
558 /// errors (like parsing or LateX compilation). This method is const
559 /// because modifying the returned ErrorList does not touch the document
561 ErrorList & errorList(std::string const & type) const;
564 /// This is useful only for screen visualisation of the Buffer. This
565 /// method is const because modifying this backend does not touch
566 /// the document contents.
567 TocBackend & tocBackend() const;
572 /// This function is called when the buffer is changed.
573 void changed(bool update_metrics) const;
575 void setChild(DocIterator const & dit, Buffer * child);
577 void updateTocItem(std::string const &, DocIterator const &) const;
578 /// This function is called when the buffer structure is changed.
579 void structureChanged() const;
580 /// This function is called when some parsing error shows up.
581 void errors(std::string const & err, bool from_master = false) const;
582 /// This function is called when the buffer busy status change.
583 void setBusy(bool on) const;
584 /// Update window titles of all users.
585 void updateTitles() const;
586 /// Reset autosave timers for all users.
587 void resetAutosaveTimers() const;
589 void message(docstring const & msg) const;
592 void setGuiDelegate(frontend::GuiBufferDelegate * gui);
594 bool hasGuiDelegate() 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;
606 /// mark the buffer as busy exporting something, or not
607 void setExportStatus(bool e) const;
609 bool isExporting() const;
612 typedef std::vector<std::pair<Inset *, ParIterator> > References;
613 References & references(docstring const & label);
614 References const & references(docstring const & label) const;
615 void clearReferenceCache() const;
616 void setInsetLabel(docstring const & label, InsetLabel const * il);
617 InsetLabel const * insetLabel(docstring const & label) const;
619 /// return a list of all used branches (also in children)
620 void getUsedBranches(std::list<docstring> &, bool const from_master = false) const;
622 /// sets the buffer_ member for every inset in this buffer.
623 // FIXME This really shouldn't be needed, but at the moment it's not
624 // clear how to do it just for the individual pieces we need.
625 void setBuffersForInsets() const;
626 /// Updates screen labels and some other information associated with
627 /// insets and paragraphs. Actually, it's more like a general "recurse
628 /// through the Buffer" routine, that visits all the insets and paragraphs.
629 void updateBuffer() const { updateBuffer(UpdateMaster, InternalUpdate); }
630 /// \param scope: whether to start with the master document or just
632 /// \param output: whether we are preparing for output.
633 void updateBuffer(UpdateScope scope, UpdateType utype) const;
635 void updateBuffer(ParIterator & parit, UpdateType utype) const;
637 /// Spellcheck starting from \p from.
638 /// \p from initial position, will then points to the next misspelled
640 /// \p to will points to the end of the next misspelled word.
641 /// \p word_lang will contain the found misspelled word.
642 /// \return progress if a new word was found.
643 int spellCheck(DocIterator & from, DocIterator & to,
644 WordLangTuple & word_lang, docstring_list & suggestions) const;
646 void checkChildBuffers();
649 /// Change name of buffer. Updates "read-only" flag.
650 void setFileName(support::FileName const & fname);
652 void getLanguages(std::set<Language const *> &) const;
653 /// Checks whether any of the referenced bibfiles have changed since the
654 /// last time we loaded the cache. Note that this does NOT update the
655 /// cached information.
656 void checkIfBibInfoCacheIsValid() const;
657 /// Update the list of all bibfiles in use (including bibfiles
658 /// of loaded child documents).
659 void updateBibfilesCache(UpdateScope scope = UpdateMaster) const;
660 /// Return the list with all bibfiles in use (including bibfiles
661 /// of loaded child documents).
662 support::FileNameList const &
663 getBibfilesCache(UpdateScope scope = UpdateMaster) const;
665 void collectChildren(ListOfBuffers & children, bool grand_children) const;
668 /// Use the Pimpl idiom to hide the internals.
670 /// The pointer never changes although *pimpl_'s contents may.