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 "update_flags.h"
17 #include "insets/InsetCode.h"
19 #include "support/strfwd.h"
20 #include "support/types.h"
21 #include "support/SignalSlot.h"
56 class ParConstIterator;
66 class GuiBufferDelegate;
67 class WorkAreaManager;
75 /** The buffer object.
76 * This is the buffer object. It contains all the informations about
77 * a document loaded into LyX.
78 * The buffer object owns the Text (wrapped in an InsetText), which
79 * contains the individual paragraphs of the document.
82 * I am not sure if the class is complete or
83 * minimal, probably not.
84 * \author Lars Gullik Bjønnes
88 /// What type of log will \c getLogName() return?
90 latexlog, ///< LaTeX log
91 buildlog ///< Literate build log
94 /// Result of \c readFile()
96 failure, ///< The file could not be read
97 success, ///< The file could not be read
98 wrongversion ///< The version of the file does not match ours
102 /// Method to check if a file is externally modified, used by
103 /// isExternallyModified()
105 * timestamp is fast but inaccurate. For example, the granularity
106 * of timestamp on a FAT filesystem is 2 second. Also, various operations
107 * may touch the timestamp of a file even when its content is unchanged.
109 * checksum is accurate but slow, which can be a problem when it is
110 * frequently used, or used for a large file on a slow (network) file
113 * FIXME: replace this method with support/FileMonitor.
116 checksum_method, ///< Use file checksum
117 timestamp_method, ///< Use timestamp, and checksum if timestamp has changed
127 explicit Buffer(std::string const & file, bool b = false);
132 /** High-level interface to buffer functionality.
133 This function parses a command string and executes it.
135 void dispatch(std::string const & command, DispatchResult & result);
137 /// Maybe we know the function already by number...
138 void dispatch(FuncRequest const & func, DispatchResult & result);
140 /// Can this function be exectued?
141 /// \return true if we made a decision
142 bool getStatus(FuncRequest const & cmd, FuncStatus & flag);
144 /// read a new document from a string
145 bool readString(std::string const &);
147 bool readFile(support::FileName const & filename);
149 /// read the header, returns number of unknown tokens
150 int readHeader(Lexer & lex);
152 /** Reads a file without header.
153 \param par if != 0 insert the file.
154 \return \c true if file is not completely read.
156 bool readDocument(Lexer &);
159 DocIterator getParFromID(int id) const;
160 /// do we have a paragraph with this id?
161 bool hasParWithID(int id) const;
164 frontend::WorkAreaManager & workAreaManager() const;
167 Takes care of auto-save files and backup file if requested.
168 Returns \c true if the save is successful, \c false otherwise.
172 /// Write document to stream. Returns \c false if unsuccesful.
173 bool write(std::ostream &) const;
174 /// save emergency file
175 /// \return a status message towards the user.
176 docstring emergencyWrite();
177 /// Write file. Returns \c false if unsuccesful.
178 bool writeFile(support::FileName const &) const;
180 /// Loads LyX file \c filename into buffer, * and \return success
181 bool loadLyXFile(support::FileName const & s);
183 /// Fill in the ErrorList with the TeXErrors
184 void bufferErrors(TeXErrors const &, ErrorList &) const;
186 /// Just a wrapper for writeLaTeXSource, first creating the ofstream.
187 bool makeLaTeXFile(support::FileName const & filename,
188 std::string const & original_path,
189 OutputParams const &,
190 bool output_preamble = true,
191 bool output_body = true) const;
192 /** Export the buffer to LaTeX.
193 If \p os is a file stream, and params().inputenc is "auto" or
194 "default", and the buffer contains text in different languages
195 with more than one encoding, then this method will change the
196 encoding associated to \p os. Therefore you must not call this
197 method with a string stream if the output is supposed to go to a
200 ofs.open("test.tex");
201 writeLaTeXSource(ofs, ...);
203 \endcode is NOT equivalent to \code
204 odocstringstream oss;
205 writeLaTeXSource(oss, ...);
207 ofs.open("test.tex");
212 void writeLaTeXSource(odocstream & os,
213 std::string const & original_path,
214 OutputParams const &,
215 bool output_preamble = true,
216 bool output_body = true) const;
218 void makeDocBookFile(support::FileName const & filename,
219 OutputParams const & runparams_in,
220 bool only_body = false) const;
222 void writeDocBookSource(odocstream & os, std::string const & filename,
223 OutputParams const & runparams_in,
224 bool only_body = false) const;
226 void makeLyXHTMLFile(support::FileName const & filename,
227 OutputParams const & runparams_in,
228 bool only_body = false) const;
230 void writeLyXHTMLSource(odocstream & os,
231 OutputParams const & runparams_in,
232 bool only_body = false) const;
233 /// returns the main language for the buffer (document)
234 Language const * language() const;
235 /// get l10n translated to the buffers language
236 docstring const B_(std::string const & l10n) const;
240 /// return true if the main lyx file does not need saving
241 bool isClean() const;
243 bool isBakClean() const;
245 bool isDepClean(std::string const & name) const;
247 /// whether or not disk file has been externally modified
248 bool isExternallyModified(CheckMethod method) const;
250 /// save timestamp and checksum of the given file.
251 void saveCheckSum(support::FileName const & file) const;
253 /// mark the main lyx file as not needing saving
254 void markClean() const;
257 void markBakClean() const;
260 void markDepClean(std::string const & name);
263 void setUnnamed(bool flag = true);
265 /// Whether or not a filename has been assigned to this buffer
266 bool isUnnamed() const;
268 /// Whether or not this buffer is internal.
270 /// An internal buffer does not contain a real document, but some auxiliary text segment.
271 /// It is not associated with a filename, it is never saved, thus it does not need to be
272 /// automatically saved, nor it needs to trigger any "do you want to save ?" question.
273 bool isInternal() const;
275 /// Mark this buffer as dirty.
278 /// Returns the buffer's filename. It is always an absolute path.
279 support::FileName fileName() const;
281 /// Returns the buffer's filename. It is always an absolute path.
282 std::string absFileName() const;
284 /// Returns the the path where the buffer lives.
285 /// It is always an absolute path.
286 std::string filePath() const;
288 /** A transformed version of the file name, adequate for LaTeX.
289 \param no_path optional if \c true then the path is stripped.
291 std::string latexName(bool no_path = true) const;
293 /// Get the name and type of the log.
294 std::string logName(LogType * type = 0) const;
296 /// Change name of buffer. Updates "read-only" flag.
297 void setFileName(std::string const & newfile);
299 /// Set document's parent Buffer.
300 void setParent(Buffer const *);
301 Buffer const * parent() const;
303 // Collect all relative buffer
304 std::vector<Buffer const *> allRelatives() const;
306 /** Get the document's master (or \c this if this is not a
309 Buffer const * masterBuffer() const;
311 /// \return true if \p child is a child of this \c Buffer.
312 bool isChild(Buffer * child) const;
314 /// return a vector with all children (and grandchildren)
315 std::vector<Buffer *> getChildren(bool grand_children = true) const;
317 /// Is buffer read-only?
318 bool isReadonly() const;
320 /// Set buffer read-only flag
321 void setReadonly(bool flag = true);
323 /// returns \c true if the buffer contains a LaTeX document
324 bool isLatex() const;
325 /// returns \c true if the buffer contains a DocBook document
326 bool isDocBook() const;
327 /// returns \c true if the buffer contains a Wed document
328 bool isLiterate() const;
330 /** Validate a buffer for LaTeX.
331 This validates the buffer, and returns a struct for use by
332 #makeLaTeX# and others. Its main use is to figure out what
333 commands and packages need to be included in the LaTeX file.
334 It (should) also check that the needed constructs are there
335 (i.e. that the \refs points to coresponding \labels). It
336 should perhaps inset "error" insets to help the user correct
339 void validate(LaTeXFeatures &) const;
341 /// Update the cache with all bibfiles in use (including bibfiles
342 /// of loaded child documents).
343 void updateBibfilesCache(UpdateScope scope = UpdateMaster) const;
345 void invalidateBibinfoCache();
346 /// Return the cache with all bibfiles in use (including bibfiles
347 /// of loaded child documents).
348 support::FileNameList const &
349 getBibfilesCache(UpdateScope scope = UpdateMaster) const;
350 /// \return the bibliography information for this buffer's master,
351 /// or just for it, if it isn't a child.
352 BiblioInfo const & masterBibInfo() const;
353 /// \return the bibliography information for this buffer ONLY.
354 BiblioInfo const & localBibInfo() const;
356 void getLabelList(std::vector<docstring> &) const;
359 void changeLanguage(Language const * from, Language const * to);
362 bool isMultiLingual() const;
365 BufferParams & params();
366 BufferParams const & params() const;
368 /** The list of paragraphs.
369 This is a linked list of paragraph, this list holds the
370 whole contents of the document.
372 ParagraphList & paragraphs();
373 ParagraphList const & paragraphs() const;
375 /// LyX version control object.
377 LyXVC const & lyxvc() const;
379 /// Where to put temporary files.
380 std::string const temppath() const;
382 /// Used when typesetting to place errorboxes.
383 TexRow const & texrow() const;
387 ParIterator par_iterator_begin();
389 ParConstIterator par_iterator_begin() const;
391 ParIterator par_iterator_end();
393 ParConstIterator par_iterator_end() const;
395 // Position of the child buffer where it appears first in the master.
396 DocIterator firstChildPosition(Buffer const * child);
398 /** \returns true only when the file is fully loaded.
399 * Used to prevent the premature generation of previews
400 * and by the citation inset.
402 bool isFullyLoaded() const;
403 /// Set by buffer_funcs' newFile.
404 void setFullyLoaded(bool);
406 /// Our main text (inside the top InsetText)
409 /// Our top InsetText
410 Inset & inset() const;
415 /// Collect macro definitions in paragraphs
416 void updateMacros() const;
417 /// Iterate through the whole buffer and try to resolve macros
418 void updateMacroInstances() const;
420 /// List macro names of this buffer, the parent and the children
421 void listMacroNames(MacroNameSet & macros) const;
422 /// Collect macros of the parent and its children in front of this buffer.
423 void listParentMacros(MacroSet & macros, LaTeXFeatures & features) const;
425 /// Return macro defined before pos (or in the master buffer)
426 MacroData const * getMacro(docstring const & name, DocIterator const & pos, bool global = true) const;
427 /// Return macro defined anywhere in the buffer (or in the master buffer)
428 MacroData const * getMacro(docstring const & name, bool global = true) const;
429 /// Return macro defined before the inclusion of the child
430 MacroData const * getMacro(docstring const & name, Buffer const & child, bool global = true) const;
432 /// Replace the inset contents for insets which InsetCode is equal
433 /// to the passed \p inset_code.
434 void changeRefsIfUnique(docstring const & from, docstring const & to,
437 /// get source code (latex/docbook) for some paragraphs, or all paragraphs
438 /// including preamble
439 void getSourceCode(odocstream & os, pit_type par_begin, pit_type par_end,
440 bool full_source) const;
442 /// Access to error list.
443 /// This method is used only for GUI visualisation of Buffer related
444 /// errors (like parsing or LateX compilation). This method is const
445 /// because modifying the returned ErrorList does not touch the document
447 ErrorList & errorList(std::string const & type) const;
450 /// This is useful only for screen visualisation of the Buffer. This
451 /// method is const because modifying this backend does not touch
452 /// the document contents.
453 TocBackend & tocBackend() const;
458 /// This function is called when the buffer is changed.
459 void changed() const;
461 void updateTocItem(std::string const &, DocIterator const &) const;
462 /// This function is called when the buffer structure is changed.
463 void structureChanged() const;
464 /// This function is called when some parsing error shows up.
465 void errors(std::string const & err, bool from_master = false) const;
466 /// This function is called when the buffer busy status change.
467 void setBusy(bool on) const;
468 /// This function is called when the buffer readonly status change.
469 void setReadOnly(bool on) const;
470 /// Update window titles of all users.
471 void updateTitles() const;
472 /// Reset autosave timers for all users.
473 void resetAutosaveTimers() const;
475 void message(docstring const & msg) const;
478 void setGuiDelegate(frontend::GuiBufferDelegate * gui);
480 bool hasGuiDelegate() const;
483 void autoSave() const;
485 void removeAutosaveFile() const;
487 void moveAutosaveFile(support::FileName const & old) const;
489 support::FileName getAutosaveFilename() const;
491 /// return the format of the buffer on a string
492 std::string bufferFormat() const;
493 /// return the default output format of the current backend
494 std::string getDefaultOutputFormat() const;
497 bool doExport(std::string const & format, bool put_in_tempdir,
498 std::string & result_file) const;
500 bool doExport(std::string const & format, bool put_in_tempdir) const;
502 bool preview(std::string const & format) const;
504 bool isExportable(std::string const & format) const;
506 std::vector<Format const *> exportableFormats(bool only_viewable) const;
509 typedef std::vector<std::pair<InsetRef *, ParIterator> > References;
510 References & references(docstring const & label);
511 References const & references(docstring const & label) const;
512 void clearReferenceCache() const;
513 void setInsetLabel(docstring const & label, InsetLabel const * il);
514 InsetLabel const * insetLabel(docstring const & label) const;
516 /// return a list of all used branches (also in children)
517 void getUsedBranches(std::list<docstring> &, bool const from_master = false) const;
519 /// sets the buffer_ member for every inset in this buffer.
520 // FIXME This really shouldn't be needed, but at the moment it's not
521 // clear how to do it just for the individual pieces we need.
522 void setBuffersForInsets() const;
524 void updateLabels(UpdateScope = UpdateMaster) const;
526 void updateLabels(ParIterator & parit) const;
528 /// Spellcheck starting from \p from.
529 /// \p from initial position, will then points to the next misspelled
531 /// \p to will points to the end of the next misspelled word.
532 /// \p word_lang will contain the found misspelled word.
533 /// \return progress if a new word was found.
534 int spellCheck(DocIterator & from, DocIterator & to,
535 WordLangTuple & word_lang, docstring_list & suggestions) const;
538 /// search for macro in local (buffer) table or in children
539 MacroData const * getBufferMacro(docstring const & name,
540 DocIterator const & pos) const;
541 /** Update macro table starting with position of it
542 \param it in some text inset
544 void updateMacros(DocIterator & it,
545 DocIterator & scope) const;
548 void collectRelatives(BufferSet & bufs) const;
551 bool readFileHelper(support::FileName const & s);
553 std::vector<std::string> backends() const;
554 /** Inserts a file into a document
555 \return \c false if method fails.
557 ReadStatus readFile(Lexer &, support::FileName const & filename,
558 bool fromString = false);
560 /** If we have branches that use the file suffix
561 feature, return the file name with suffix appended.
563 support::FileName exportFileName() const;
565 /// Use the Pimpl idiom to hide the internals.
567 /// The pointer never changes although *pimpl_'s contents may.
570 frontend::GuiBufferDelegate * gui_;
572 /// This function is called when the buffer structure is changed.
573 Signal structureChanged_;
574 /// This function is called when some parsing error shows up.
575 //Signal errors(std::string const &) = 0;
576 /// This function is called when some message shows up.
577 //Signal message(docstring const &) = 0;
578 /// This function is called when the buffer busy status change.
579 //Signal setBusy(bool) = 0;
580 /// Reset autosave timers for all users.
581 Signal resetAutosaveTimers_;