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::vector<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()
98 failure, ///< The file could not be read
99 success, ///< The file could not be read
100 wrongversion ///< The version of the file does not match ours
104 /// Method to check if a file is externally modified, used by
105 /// isExternallyModified()
107 * timestamp is fast but inaccurate. For example, the granularity
108 * of timestamp on a FAT filesystem is 2 second. Also, various operations
109 * may touch the timestamp of a file even when its content is unchanged.
111 * checksum is accurate but slow, which can be a problem when it is
112 * frequently used, or used for a large file on a slow (network) file
115 * FIXME: replace this method with support/FileMonitor.
118 checksum_method, ///< Use file checksum
119 timestamp_method, ///< Use timestamp, and checksum if timestamp has changed
129 explicit Buffer(std::string const & file, bool readonly = false,
130 Buffer const * cloned_buffer = 0);
136 Buffer * clone() const;
138 bool isClone() const;
140 /** High-level interface to buffer functionality.
141 This function parses a command string and executes it.
143 void dispatch(std::string const & command, DispatchResult & result);
145 /// Maybe we know the function already by number...
146 void dispatch(FuncRequest const & func, DispatchResult & result);
148 /// Can this function be exectued?
149 /// \return true if we made a decision
150 bool getStatus(FuncRequest const & cmd, FuncStatus & flag);
152 /// read a new document from a string
153 bool readString(std::string const &);
155 bool readFile(support::FileName const & filename);
157 /// read the header, returns number of unknown tokens
158 int readHeader(Lexer & lex);
160 /** Reads a file without header.
161 \param par if != 0 insert the file.
162 \return \c true if file is not completely read.
164 bool readDocument(Lexer &);
167 DocIterator getParFromID(int id) const;
168 /// do we have a paragraph with this id?
169 bool hasParWithID(int id) const;
172 frontend::WorkAreaManager & workAreaManager() const;
175 Takes care of auto-save files and backup file if requested.
176 Returns \c true if the save is successful, \c false otherwise.
180 /// Write document to stream. Returns \c false if unsuccesful.
181 bool write(std::ostream &) const;
182 /// save emergency file
183 /// \return a status message towards the user.
184 docstring emergencyWrite();
185 /// Write file. Returns \c false if unsuccesful.
186 bool writeFile(support::FileName const &) const;
188 /// Loads LyX file \c filename into buffer, * and return success
189 bool loadLyXFile(support::FileName const & s);
190 /// Reloads the LyX file
193 /// Fill in the ErrorList with the TeXErrors
194 void bufferErrors(TeXErrors const &, ErrorList &) const;
196 /// Just a wrapper for writeLaTeXSource, first creating the ofstream.
197 bool makeLaTeXFile(support::FileName const & filename,
198 std::string const & original_path,
199 OutputParams const &,
200 bool output_preamble = true,
201 bool output_body = true) const;
202 /** Export the buffer to LaTeX.
203 If \p os is a file stream, and params().inputenc is "auto" or
204 "default", and the buffer contains text in different languages
205 with more than one encoding, then this method will change the
206 encoding associated to \p os. Therefore you must not call this
207 method with a string stream if the output is supposed to go to a
210 ofs.open("test.tex");
211 writeLaTeXSource(ofs, ...);
213 \endcode is NOT equivalent to \code
214 odocstringstream oss;
215 writeLaTeXSource(oss, ...);
217 ofs.open("test.tex");
222 void writeLaTeXSource(odocstream & os,
223 std::string const & original_path,
224 OutputParams const &,
225 bool output_preamble = true,
226 bool output_body = true) const;
228 void makeDocBookFile(support::FileName const & filename,
229 OutputParams const & runparams_in,
230 bool only_body = false) const;
232 void writeDocBookSource(odocstream & os, std::string const & filename,
233 OutputParams const & runparams_in,
234 bool only_body = false) const;
236 void makeLyXHTMLFile(support::FileName const & filename,
237 OutputParams const & runparams_in,
238 bool only_body = false) const;
240 void writeLyXHTMLSource(odocstream & os,
241 OutputParams const & runparams_in,
242 bool only_body = false) const;
243 /// returns the main language for the buffer (document)
244 Language const * language() const;
245 /// get l10n translated to the buffers language
246 docstring const B_(std::string const & l10n) const;
250 /// return true if the main lyx file does not need saving
251 bool isClean() const;
253 bool isDepClean(std::string const & name) const;
255 /// whether or not disk file has been externally modified
256 bool isExternallyModified(CheckMethod method) const;
258 /// save timestamp and checksum of the given file.
259 void saveCheckSum(support::FileName const & file) const;
261 /// mark the main lyx file as not needing saving
262 void markClean() const;
265 void markDepClean(std::string const & name);
268 void setUnnamed(bool flag = true);
270 /// Whether or not a filename has been assigned to this buffer
271 bool isUnnamed() const;
273 /// Whether or not this buffer is internal.
275 /// An internal buffer does not contain a real document, but some auxiliary text segment.
276 /// It is not associated with a filename, it is never saved, thus it does not need to be
277 /// automatically saved, nor it needs to trigger any "do you want to save ?" question.
278 bool isInternal() const;
280 /// Mark this buffer as dirty.
283 /// Returns the buffer's filename. It is always an absolute path.
284 support::FileName fileName() const;
286 /// Returns the buffer's filename. It is always an absolute path.
287 std::string absFileName() const;
289 /// Returns the the path where the buffer lives.
290 /// It is always an absolute path.
291 std::string filePath() const;
293 /** A transformed version of the file name, adequate for LaTeX.
294 \param no_path optional if \c true then the path is stripped.
296 std::string latexName(bool no_path = true) const;
298 /// Get the name and type of the log.
299 std::string logName(LogType * type = 0) const;
301 /// Change name of buffer. Updates "read-only" flag.
302 void setFileName(std::string const & newfile);
304 /// Set document's parent Buffer.
305 void setParent(Buffer const *);
306 Buffer const * parent() const;
308 /// Collect all relative buffers
309 ListOfBuffers allRelatives() const;
311 /** Get the document's master (or \c this if this is not a
314 Buffer const * masterBuffer() const;
316 /// \return true if \p child is a child of this \c Buffer.
317 bool isChild(Buffer * child) const;
319 /// \return true if this \c Buffer has children
320 bool hasChildren() const;
322 /// return a vector of all children (and grandchildren)
323 ListOfBuffers getChildren(bool grand_children = true) const;
325 /// Add all children (and grandchildren) to supplied vector
326 void getChildren(ListOfBuffers & children, bool grand_children = true) const;
328 /// Is buffer read-only?
329 bool isReadonly() const;
331 /// Set buffer read-only flag
332 void setReadonly(bool flag = true);
334 /// returns \c true if the buffer contains a LaTeX document
335 bool isLatex() const;
336 /// returns \c true if the buffer contains a DocBook document
337 bool isDocBook() const;
338 /// returns \c true if the buffer contains a Wed document
339 bool isLiterate() const;
341 /** Validate a buffer for LaTeX.
342 This validates the buffer, and returns a struct for use by
343 #makeLaTeX# and others. Its main use is to figure out what
344 commands and packages need to be included in the LaTeX file.
345 It (should) also check that the needed constructs are there
346 (i.e. that the \refs points to coresponding \labels). It
347 should perhaps inset "error" insets to help the user correct
350 void validate(LaTeXFeatures &) const;
352 /// Reference information is cached in the Buffer, so we do not
353 /// have to check or read things over and over.
355 /// There are two caches.
357 /// One is a cache of the BibTeX files from which reference info is
358 /// being gathered. This cache is PER BUFFER, and the cache for the
359 /// master essentially includes the cache for its children. This gets
360 /// invalidated when an InsetBibtex is created, deleted, or modified.
362 /// The other is a cache of the reference information itself. This
363 /// exists only in the master buffer, and when it needs to be updated,
364 /// the children add their information to the master's cache.
366 /// Calling this method invalidates the cache and so requires a
368 void invalidateBibinfoCache() const;
369 /// This invalidates the cache of files we need to check.
370 void invalidateBibfileCache() const;
371 /// Updates the cached bibliography information.
372 /// Note that you MUST call this method to update the cache. It will
373 /// not happen otherwise. (Currently, it is called at the start of
374 /// updateBuffer() and from GuiCitation.)
375 /// Note that this operates on the master document.
376 void checkBibInfoCache() const;
377 /// \return the bibliography information for this buffer's master,
378 /// or just for it, if it isn't a child.
379 BiblioInfo const & masterBibInfo() const;
381 void fillWithBibKeys(BiblioInfo & keys) const;
383 void getLabelList(std::vector<docstring> &) const;
386 void changeLanguage(Language const * from, Language const * to);
389 bool isMultiLingual() const;
391 std::set<Language const *> getLanguages() const;
394 BufferParams & params();
395 BufferParams const & params() const;
397 /** The list of paragraphs.
398 This is a linked list of paragraph, this list holds the
399 whole contents of the document.
401 ParagraphList & paragraphs();
402 ParagraphList const & paragraphs() const;
404 /// LyX version control object.
406 LyXVC const & lyxvc() const;
408 /// Where to put temporary files.
409 std::string const temppath() const;
411 /// Used when typesetting to place errorboxes.
412 TexRow const & texrow() const;
416 ParIterator par_iterator_begin();
418 ParConstIterator par_iterator_begin() const;
420 ParIterator par_iterator_end();
422 ParConstIterator par_iterator_end() const;
424 // Position of the child buffer where it appears first in the master.
425 DocIterator firstChildPosition(Buffer const * child);
427 /** \returns true only when the file is fully loaded.
428 * Used to prevent the premature generation of previews
429 * and by the citation inset.
431 bool isFullyLoaded() const;
432 /// Set by buffer_funcs' newFile.
433 void setFullyLoaded(bool);
435 /// Our main text (inside the top InsetText)
438 /// Our top InsetText
439 Inset & inset() const;
444 /// Collect macro definitions in paragraphs
445 void updateMacros() const;
446 /// Iterate through the whole buffer and try to resolve macros
447 void updateMacroInstances() const;
449 /// List macro names of this buffer, the parent and the children
450 void listMacroNames(MacroNameSet & macros) const;
451 /// Collect macros of the parent and its children in front of this buffer.
452 void listParentMacros(MacroSet & macros, LaTeXFeatures & features) const;
454 /// Return macro defined before pos (or in the master buffer)
455 MacroData const * getMacro(docstring const & name, DocIterator const & pos, bool global = true) const;
456 /// Return macro defined anywhere in the buffer (or in the master buffer)
457 MacroData const * getMacro(docstring const & name, bool global = true) const;
458 /// Return macro defined before the inclusion of the child
459 MacroData const * getMacro(docstring const & name, Buffer const & child, bool global = true) const;
461 /// Collect user macro names at loading time
462 typedef std::set<docstring> UserMacroSet;
463 UserMacroSet usermacros;
465 /// Replace the inset contents for insets which InsetCode is equal
466 /// to the passed \p inset_code.
467 void changeRefsIfUnique(docstring const & from, docstring const & to,
470 /// get source code (latex/docbook) for some paragraphs, or all paragraphs
471 /// including preamble
472 void getSourceCode(odocstream & os, pit_type par_begin, pit_type par_end,
473 bool full_source) const;
475 /// Access to error list.
476 /// This method is used only for GUI visualisation of Buffer related
477 /// errors (like parsing or LateX compilation). This method is const
478 /// because modifying the returned ErrorList does not touch the document
480 ErrorList & errorList(std::string const & type) const;
483 /// This is useful only for screen visualisation of the Buffer. This
484 /// method is const because modifying this backend does not touch
485 /// the document contents.
486 TocBackend & tocBackend() const;
491 /// This function is called when the buffer is changed.
492 void changed(bool update_metrics) const;
494 void setChild(DocIterator const & dit, Buffer * child);
496 void updateTocItem(std::string const &, DocIterator const &) const;
497 /// This function is called when the buffer structure is changed.
498 void structureChanged() const;
499 /// This function is called when some parsing error shows up.
500 void errors(std::string const & err, bool from_master = false) const;
501 /// This function is called when the buffer busy status change.
502 void setBusy(bool on) const;
503 /// Update window titles of all users.
504 void updateTitles() const;
505 /// Reset autosave timers for all users.
506 void resetAutosaveTimers() const;
508 void message(docstring const & msg) const;
511 void setGuiDelegate(frontend::GuiBufferDelegate * gui);
513 bool hasGuiDelegate() const;
516 void autoSave() const;
518 void removeAutosaveFile() const;
520 void moveAutosaveFile(support::FileName const & old) const;
522 support::FileName getAutosaveFileName() const;
524 /// return the format of the buffer on a string
525 std::string bufferFormat() const;
526 /// return the default output format of the current backend
527 std::string getDefaultOutputFormat() const;
530 bool doExport(std::string const & format, bool put_in_tempdir,
531 bool includeall, std::string & result_file) const;
533 bool doExport(std::string const & format, bool put_in_tempdir,
534 bool includeall = false) const;
536 bool preview(std::string const & format, bool includeall = false) const;
538 bool isExportable(std::string const & format) const;
540 std::vector<Format const *> exportableFormats(bool only_viewable) const;
542 bool isExportableFormat(std::string const & format) const;
543 /// mark the buffer as busy exporting something, or not
544 void setExportStatus(bool e) const;
546 bool isExporting() const;
549 typedef std::vector<std::pair<Inset *, ParIterator> > References;
550 References & references(docstring const & label);
551 References const & references(docstring const & label) const;
552 void clearReferenceCache() const;
553 void setInsetLabel(docstring const & label, InsetLabel const * il);
554 InsetLabel const * insetLabel(docstring const & label) const;
556 /// return a list of all used branches (also in children)
557 void getUsedBranches(std::list<docstring> &, bool const from_master = false) const;
559 /// sets the buffer_ member for every inset in this buffer.
560 // FIXME This really shouldn't be needed, but at the moment it's not
561 // clear how to do it just for the individual pieces we need.
562 void setBuffersForInsets() const;
563 /// Updates screen labels and some other information associated with
564 /// insets and paragraphs. Actually, it's more like a general "recurse
565 /// through the Buffer" routine, that visits all the insets and paragraphs.
566 void updateBuffer() const { updateBuffer(UpdateMaster, InternalUpdate); }
567 /// \param scope: whether to start with the master document or just
569 /// \param output: whether we are preparing for output.
570 void updateBuffer(UpdateScope scope, UpdateType utype) const;
572 void updateBuffer(ParIterator & parit, UpdateType utype) const;
574 /// Spellcheck starting from \p from.
575 /// \p from initial position, will then points to the next misspelled
577 /// \p to will points to the end of the next misspelled word.
578 /// \p word_lang will contain the found misspelled word.
579 /// \return progress if a new word was found.
580 int spellCheck(DocIterator & from, DocIterator & to,
581 WordLangTuple & word_lang, docstring_list & suggestions) const;
583 void checkChildBuffers();
587 bool readFileHelper(support::FileName const & s);
589 std::vector<std::string> backends() const;
590 /** Inserts a file into a document
591 \return \c false if method fails.
593 ReadStatus readFile(Lexer &, support::FileName const & filename,
594 bool fromString = false);
596 void getLanguages(std::set<Language const *> &) const;
597 /// Update the list of all bibfiles in use (including bibfiles
598 /// of loaded child documents).
599 void updateBibfilesCache(UpdateScope scope = UpdateMaster) const;
600 /// Return the list with all bibfiles in use (including bibfiles
601 /// of loaded child documents).
602 support::FileNameList const &
603 getBibfilesCache(UpdateScope scope = UpdateMaster) const;
605 /// Use the Pimpl idiom to hide the internals.
607 /// The pointer never changes although *pimpl_'s contents may.