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 "update_flags.h"
18 #include "insets/InsetCode.h"
20 #include "support/strfwd.h"
21 #include "support/types.h"
22 #include "support/SignalSlot.h"
58 class ParConstIterator;
68 class GuiBufferDelegate;
69 class WorkAreaManager;
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 isBakClean() const;
255 bool isDepClean(std::string const & name) const;
257 /// whether or not disk file has been externally modified
258 bool isExternallyModified(CheckMethod method) const;
260 /// save timestamp and checksum of the given file.
261 void saveCheckSum(support::FileName const & file) const;
263 /// mark the main lyx file as not needing saving
264 void markClean() const;
267 void markBakClean() const;
270 void markDepClean(std::string const & name);
273 void setUnnamed(bool flag = true);
275 /// Whether or not a filename has been assigned to this buffer
276 bool isUnnamed() const;
278 /// Whether or not this buffer is internal.
280 /// An internal buffer does not contain a real document, but some auxiliary text segment.
281 /// It is not associated with a filename, it is never saved, thus it does not need to be
282 /// automatically saved, nor it needs to trigger any "do you want to save ?" question.
283 bool isInternal() const;
285 /// Mark this buffer as dirty.
288 /// Returns the buffer's filename. It is always an absolute path.
289 support::FileName fileName() const;
291 /// Returns the buffer's filename. It is always an absolute path.
292 std::string absFileName() const;
294 /// Returns the the path where the buffer lives.
295 /// It is always an absolute path.
296 std::string filePath() const;
298 /** A transformed version of the file name, adequate for LaTeX.
299 \param no_path optional if \c true then the path is stripped.
301 std::string latexName(bool no_path = true) const;
303 /// Get the name and type of the log.
304 std::string logName(LogType * type = 0) const;
306 /// Change name of buffer. Updates "read-only" flag.
307 void setFileName(std::string const & newfile);
309 /// Set document's parent Buffer.
310 void setParent(Buffer const *);
311 Buffer const * parent() const;
313 // Collect all relative buffer
314 std::vector<Buffer const *> allRelatives() const;
316 /** Get the document's master (or \c this if this is not a
319 Buffer const * masterBuffer() const;
321 /// \return true if \p child is a child of this \c Buffer.
322 bool isChild(Buffer * child) const;
324 /// return a vector with all children (and grandchildren)
325 std::vector<Buffer *> getChildren(bool grand_children = true) const;
327 /// Add all children (and grandchildren) to supplied vector
328 void getChildren(std::vector<Buffer *> & children, bool grand_children = true) const;
330 /// Is buffer read-only?
331 bool isReadonly() const;
333 /// Set buffer read-only flag
334 void setReadonly(bool flag = true);
336 /// returns \c true if the buffer contains a LaTeX document
337 bool isLatex() const;
338 /// returns \c true if the buffer contains a DocBook document
339 bool isDocBook() const;
340 /// returns \c true if the buffer contains a Wed document
341 bool isLiterate() const;
343 /** Validate a buffer for LaTeX.
344 This validates the buffer, and returns a struct for use by
345 #makeLaTeX# and others. Its main use is to figure out what
346 commands and packages need to be included in the LaTeX file.
347 It (should) also check that the needed constructs are there
348 (i.e. that the \refs points to coresponding \labels). It
349 should perhaps inset "error" insets to help the user correct
352 void validate(LaTeXFeatures &) const;
354 /// Update the list of all bibfiles in use (including bibfiles
355 /// of loaded child documents).
356 void updateBibfilesCache(UpdateScope scope = UpdateMaster) const;
357 /// Return the list with all bibfiles in use (including bibfiles
358 /// of loaded child documents).
359 support::FileNameList const &
360 getBibfilesCache(UpdateScope scope = UpdateMaster) const;
361 /// Information from BibTeX databases is cached in the Buffer, so
362 /// we do not have to read the file over and over.
363 /// Calling this method invalidates the cache and so requires a
365 void invalidateBibinfoCache();
366 /// Updates the cached bibliography information.
367 /// Note that you MUST call this method to update the cache. It will
368 /// not happen otherwise. (Currently, it is called at the start of
369 /// updateLabels() and from GuiCitation.)
370 void checkBibInfoCache() const;
371 /// \return the bibliography information for this buffer's master,
372 /// or just for it, if it isn't a child.
373 BiblioInfo const & masterBibInfo() const;
374 /// \return the bibliography information for this buffer ONLY.
375 BiblioInfo const & localBibInfo() const;
377 void getLabelList(std::vector<docstring> &) const;
380 void changeLanguage(Language const * from, Language const * to);
383 bool isMultiLingual() const;
386 BufferParams & params();
387 BufferParams const & params() const;
389 /** The list of paragraphs.
390 This is a linked list of paragraph, this list holds the
391 whole contents of the document.
393 ParagraphList & paragraphs();
394 ParagraphList const & paragraphs() const;
396 /// LyX version control object.
398 LyXVC const & lyxvc() const;
400 /// Where to put temporary files.
401 std::string const temppath() const;
403 /// Used when typesetting to place errorboxes.
404 TexRow const & texrow() const;
408 ParIterator par_iterator_begin();
410 ParConstIterator par_iterator_begin() const;
412 ParIterator par_iterator_end();
414 ParConstIterator par_iterator_end() const;
416 // Position of the child buffer where it appears first in the master.
417 DocIterator firstChildPosition(Buffer const * child);
419 /** \returns true only when the file is fully loaded.
420 * Used to prevent the premature generation of previews
421 * and by the citation inset.
423 bool isFullyLoaded() const;
424 /// Set by buffer_funcs' newFile.
425 void setFullyLoaded(bool);
427 /// Our main text (inside the top InsetText)
430 /// Our top InsetText
431 Inset & inset() const;
436 /// Collect macro definitions in paragraphs
437 void updateMacros() const;
438 /// Iterate through the whole buffer and try to resolve macros
439 void updateMacroInstances() const;
441 /// List macro names of this buffer, the parent and the children
442 void listMacroNames(MacroNameSet & macros) const;
443 /// Collect macros of the parent and its children in front of this buffer.
444 void listParentMacros(MacroSet & macros, LaTeXFeatures & features) const;
446 /// Return macro defined before pos (or in the master buffer)
447 MacroData const * getMacro(docstring const & name, DocIterator const & pos, bool global = true) const;
448 /// Return macro defined anywhere in the buffer (or in the master buffer)
449 MacroData const * getMacro(docstring const & name, bool global = true) const;
450 /// Return macro defined before the inclusion of the child
451 MacroData const * getMacro(docstring const & name, Buffer const & child, bool global = true) const;
453 /// Collect user macro names at loading time
454 typedef std::set<docstring> UserMacroSet;
455 UserMacroSet usermacros;
457 /// Replace the inset contents for insets which InsetCode is equal
458 /// to the passed \p inset_code.
459 void changeRefsIfUnique(docstring const & from, docstring const & to,
462 /// get source code (latex/docbook) for some paragraphs, or all paragraphs
463 /// including preamble
464 void getSourceCode(odocstream & os, pit_type par_begin, pit_type par_end,
465 bool full_source) const;
467 /// Access to error list.
468 /// This method is used only for GUI visualisation of Buffer related
469 /// errors (like parsing or LateX compilation). This method is const
470 /// because modifying the returned ErrorList does not touch the document
472 ErrorList & errorList(std::string const & type) const;
475 /// This is useful only for screen visualisation of the Buffer. This
476 /// method is const because modifying this backend does not touch
477 /// the document contents.
478 TocBackend & tocBackend() const;
483 /// This function is called when the buffer is changed.
484 void changed(bool update_metrics) const;
486 void setChild(DocIterator const & dit, Buffer * child);
488 void updateTocItem(std::string const &, DocIterator const &) const;
489 /// This function is called when the buffer structure is changed.
490 void structureChanged() const;
491 /// This function is called when some parsing error shows up.
492 void errors(std::string const & err, bool from_master = false) const;
493 /// This function is called when the buffer busy status change.
494 void setBusy(bool on) const;
495 /// This function is called when the buffer readonly status change.
496 void setReadOnly(bool on) const;
497 /// Update window titles of all users.
498 void updateTitles() const;
499 /// Reset autosave timers for all users.
500 void resetAutosaveTimers() const;
502 void message(docstring const & msg) const;
505 void setGuiDelegate(frontend::GuiBufferDelegate * gui);
507 bool hasGuiDelegate() const;
510 void autoSave() const;
512 void removeAutosaveFile() const;
514 void moveAutosaveFile(support::FileName const & old) const;
516 support::FileName getAutosaveFilename() const;
518 /// return the format of the buffer on a string
519 std::string bufferFormat() const;
520 /// return the default output format of the current backend
521 std::string getDefaultOutputFormat() const;
524 bool doExport(std::string const & format, bool put_in_tempdir,
525 bool includeall, std::string & result_file) const;
527 bool doExport(std::string const & format, bool put_in_tempdir,
528 bool includeall = false) const;
530 bool preview(std::string const & format, bool includeall = false) const;
532 bool isExportable(std::string const & format) const;
534 std::vector<Format const *> exportableFormats(bool only_viewable) const;
536 bool isExportableFormat(std::string const & format) const;
539 typedef std::vector<std::pair<InsetRef *, ParIterator> > References;
540 References & references(docstring const & label);
541 References const & references(docstring const & label) const;
542 void clearReferenceCache() const;
543 void setInsetLabel(docstring const & label, InsetLabel const * il);
544 InsetLabel const * insetLabel(docstring const & label) const;
546 /// return a list of all used branches (also in children)
547 void getUsedBranches(std::list<docstring> &, bool const from_master = false) const;
549 /// sets the buffer_ member for every inset in this buffer.
550 // FIXME This really shouldn't be needed, but at the moment it's not
551 // clear how to do it just for the individual pieces we need.
552 void setBuffersForInsets() const;
553 /// Updates screen labels and some other information associated with
554 /// insets and paragraphs. Actually, it's more like a general "recurse
555 /// through the Buffer" routine, that visits all the insets and paragraphs.
556 void updateLabels() const { updateLabels(UpdateMaster, InternalUpdate); }
557 /// \param scope: whether to start with the master document or just
559 /// \param output: whether we are preparing for output.
560 void updateLabels(UpdateScope scope, UpdateType utype) const;
562 void updateLabels(ParIterator & parit, UpdateType utype) const;
564 /// Spellcheck starting from \p from.
565 /// \p from initial position, will then points to the next misspelled
567 /// \p to will points to the end of the next misspelled word.
568 /// \p word_lang will contain the found misspelled word.
569 /// \return progress if a new word was found.
570 int spellCheck(DocIterator & from, DocIterator & to,
571 WordLangTuple & word_lang, docstring_list & suggestions) const;
574 /// search for macro in local (buffer) table or in children
575 MacroData const * getBufferMacro(docstring const & name,
576 DocIterator const & pos) const;
577 /** Update macro table starting with position of it
578 \param it in some text inset
580 void updateMacros(DocIterator & it,
581 DocIterator & scope) const;
583 void setLabel(ParIterator & it, UpdateType utype) const;
585 void collectRelatives(BufferSet & bufs) const;
588 bool readFileHelper(support::FileName const & s);
590 std::vector<std::string> backends() const;
591 /** Inserts a file into a document
592 \return \c false if method fails.
594 ReadStatus readFile(Lexer &, support::FileName const & filename,
595 bool fromString = false);
597 /** If we have branches that use the file suffix
598 feature, return the file name with suffix appended.
600 support::FileName exportFileName() const;
602 /// Use the Pimpl idiom to hide the internals.
604 /// The pointer never changes although *pimpl_'s contents may.
607 frontend::GuiBufferDelegate * gui_;
609 /// This function is called when the buffer structure is changed.
610 Signal structureChanged_;
611 /// This function is called when some parsing error shows up.
612 //Signal errors(std::string const &) = 0;
613 /// This function is called when some message shows up.
614 //Signal message(docstring const &) = 0;
615 /// This function is called when the buffer busy status change.
616 //Signal setBusy(bool) = 0;
617 /// Reset autosave timers for all users.
618 Signal resetAutosaveTimers_;