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 "insets/InsetCode.h"
17 #include "support/strfwd.h"
18 #include "support/types.h"
45 class ParConstIterator;
54 class GuiBufferDelegate;
55 class WorkAreaManager;
63 /** The buffer object.
64 * This is the buffer object. It contains all the informations about
65 * a document loaded into LyX.
66 * The buffer object owns the Text (wrapped in an InsetText), which
67 * contains the individual paragraphs of the document.
70 * I am not sure if the class is complete or
71 * minimal, probably not.
72 * \author Lars Gullik Bjønnes
76 /// What type of log will \c getLogName() return?
78 latexlog, ///< LaTeX log
79 buildlog ///< Literate build log
82 /// Result of \c readFile()
84 failure, ///< The file could not be read
85 success, ///< The file could not be read
86 wrongversion ///< The version of the file does not match ours
90 /// Method to check if a file is externally modified, used by
91 /// isExternallyModified()
93 * timestamp is fast but inaccurate. For example, the granularity
94 * of timestamp on a FAT filesystem is 2 second. Also, various operations
95 * may touch the timestamp of a file even when its content is unchanged.
97 * checksum is accurate but slow, which can be a problem when it is
98 * frequently used, or used for a large file on a slow (network) file
101 * FIXME: replace this method with support/FileMonitor.
104 checksum_method, ///< Use file checksum
105 timestamp_method, ///< Use timestamp, and checksum if timestamp has changed
110 \param b optional \c false by default
112 explicit Buffer(std::string const & file, bool b = false);
117 /** High-level interface to buffer functionality.
118 This function parses a command string and executes it
120 bool dispatch(std::string const & command, bool * result = 0);
122 /// Maybe we know the function already by number...
123 bool dispatch(FuncRequest const & func, bool * result = 0);
125 /// Load the autosaved file.
126 void loadAutoSaveFile();
128 /// read a new document from a string
129 bool readString(std::string const &);
131 bool readFile(support::FileName const & filename);
133 /// read the header, returns number of unknown tokens
134 int readHeader(Lexer & lex);
136 /** Reads a file without header.
137 \param par if != 0 insert the file.
138 \return \c false if file is not completely read.
140 bool readDocument(Lexer &);
143 void insertStringAsLines(ParagraphList & plist,
144 pit_type &, pos_type &,
145 Font const &, docstring const &, bool);
147 ParIterator getParFromID(int id) const;
148 /// do we have a paragraph with this id?
149 bool hasParWithID(int id) const;
152 frontend::WorkAreaManager & workAreaManager() const;
155 Takes care of auto-save files and backup file if requested.
156 Returns \c true if the save is successful, \c false otherwise.
160 /// Write document to stream. Returns \c false if unsuccesful.
161 bool write(std::ostream &) const;
162 /// Write file. Returns \c false if unsuccesful.
163 bool writeFile(support::FileName const &) const;
165 /// Loads LyX file \c filename into buffer, * and \return success
166 bool loadLyXFile(support::FileName const & s);
168 /// Fill in the ErrorList with the TeXErrors
169 void bufferErrors(TeXErrors const &, ErrorList &) const;
171 /// Just a wrapper for writeLaTeXSource, first creating the ofstream.
172 bool makeLaTeXFile(support::FileName const & filename,
173 std::string const & original_path,
174 OutputParams const &,
175 bool output_preamble = true,
176 bool output_body = true) const;
177 /** Export the buffer to LaTeX.
178 If \p os is a file stream, and params().inputenc is "auto" or
179 "default", and the buffer contains text in different languages
180 with more than one encoding, then this method will change the
181 encoding associated to \p os. Therefore you must not call this
182 method with a string stream if the output is supposed to go to a
185 ofs.open("test.tex");
186 writeLaTeXSource(ofs, ...);
188 \endcode is NOT equivalent to \code
189 odocstringstream oss;
190 writeLaTeXSource(oss, ...);
192 ofs.open("test.tex");
197 void writeLaTeXSource(odocstream & os,
198 std::string const & original_path,
199 OutputParams const &,
200 bool output_preamble = true,
201 bool output_body = true) const;
203 void makeDocBookFile(support::FileName const & filename,
204 OutputParams const & runparams_in,
205 bool only_body = false) const;
207 void writeDocBookSource(odocstream & os, std::string const & filename,
208 OutputParams const & runparams_in,
209 bool only_body = false) const;
210 /// returns the main language for the buffer (document)
211 Language const * language() const;
212 /// get l10n translated to the buffers language
213 docstring const B_(std::string const & l10n) const;
217 /// return true if the main lyx file does not need saving
218 bool isClean() const;
220 bool isBakClean() const;
222 bool isDepClean(std::string const & name) const;
224 /// whether or not disk file has been externally modified
225 bool isExternallyModified(CheckMethod method) const;
227 /// save timestamp and checksum of the given file.
228 void saveCheckSum(support::FileName const & file) const;
230 /// mark the main lyx file as not needing saving
231 void markClean() const;
234 void markBakClean() const;
237 void markDepClean(std::string const & name);
240 void setUnnamed(bool flag = true);
243 bool isUnnamed() const;
245 /// Mark this buffer as dirty.
248 /// Returns the buffer's filename. It is always an absolute path.
249 support::FileName fileName() const;
251 /// Returns the buffer's filename. It is always an absolute path.
252 std::string absFileName() const;
254 /// Returns the the path where the buffer lives.
255 /// It is always an absolute path.
256 std::string filePath() const;
258 /** A transformed version of the file name, adequate for LaTeX.
259 \param no_path optional if \c true then the path is stripped.
261 std::string latexName(bool no_path = true) const;
263 /// Get thee name and type of the log.
264 std::string logName(LogType * type = 0) const;
266 /// Change name of buffer. Updates "read-only" flag.
267 void setFileName(std::string const & newfile);
269 /// Set document's parent Buffer.
270 void setParent(Buffer const *);
271 Buffer const * parent();
273 /** Get the document's master (or \c this if this is not a
276 Buffer const * masterBuffer() const;
278 /// Is buffer read-only?
279 bool isReadonly() const;
281 /// Set buffer read-only flag
282 void setReadonly(bool flag = true);
284 /// returns \c true if the buffer contains a LaTeX document
285 bool isLatex() const;
286 /// returns \c true if the buffer contains a DocBook document
287 bool isDocBook() const;
288 /// returns \c true if the buffer contains a Wed document
289 bool isLiterate() const;
291 /** Validate a buffer for LaTeX.
292 This validates the buffer, and returns a struct for use by
293 #makeLaTeX# and others. Its main use is to figure out what
294 commands and packages need to be included in the LaTeX file.
295 It (should) also check that the needed constructs are there
296 (i.e. that the \refs points to coresponding \labels). It
297 should perhaps inset "error" insets to help the user correct
300 void validate(LaTeXFeatures &) const;
302 /// Update the cache with all bibfiles in use (including bibfiles
303 /// of loaded child documents).
304 void updateBibfilesCache() const;
305 /// Return the cache with all bibfiles in use (including bibfiles
306 /// of loaded child documents).
307 support::FileNameList const & getBibfilesCache() const;
309 void getLabelList(std::vector<docstring> &) const;
312 void changeLanguage(Language const * from, Language const * to);
315 bool isMultiLingual() const;
318 BufferParams & params();
319 BufferParams const & params() const;
321 /** The list of paragraphs.
322 This is a linked list of paragraph, this list holds the
323 whole contents of the document.
325 ParagraphList & paragraphs();
326 ParagraphList const & paragraphs() const;
328 /// LyX version control object.
330 LyXVC const & lyxvc() const;
332 /// Where to put temporary files.
333 std::string const temppath() const;
335 /// Used when typesetting to place errorboxes.
336 TexRow const & texrow() const;
339 ParIterator par_iterator_begin();
341 ParConstIterator par_iterator_begin() const;
343 ParIterator par_iterator_end();
345 ParConstIterator par_iterator_end() const;
347 /** \returns true only when the file is fully loaded.
348 * Used to prevent the premature generation of previews
349 * and by the citation inset.
351 bool isFullyLoaded() const;
352 /// Set by buffer_funcs' newFile.
353 void setFullyLoaded(bool);
355 /// Our main text (inside the top InsetText)
358 /// Our top InsetText
359 Inset & inset() const;
364 /// Collect macro definitions in paragraphs
365 void updateMacros() const;
366 /// Iterate through the whole buffer and try to resolve macros
367 void updateMacroInstances() const;
369 typedef std::set<docstring> MacroNameSet;
370 /// List macro names of this buffer. the parent and the children
371 void listMacroNames(MacroNameSet & macros) const;
372 /// Write out all macros somewhere defined in the parent,
373 /// its parents and its children, which are visible at the beginning
375 void writeParentMacros(odocstream & os) const;
377 /// Return macro defined before pos (or in the master buffer)
378 MacroData const * getMacro(docstring const & name, DocIterator const & pos, bool global = true) const;
379 /// Return macro defined anywhere in the buffer (or in the master buffer)
380 MacroData const * getMacro(docstring const & name, bool global = true) const;
381 /// Return macro defined before the inclusion of the child
382 MacroData const * getMacro(docstring const & name, Buffer const & child, bool global = true) const;
384 /// Replace the inset contents for insets which InsetCode is equal
385 /// to the passed \p inset_code.
386 void changeRefsIfUnique(docstring const & from, docstring const & to,
389 /// get source code (latex/docbook) for some paragraphs, or all paragraphs
390 /// including preamble
391 void getSourceCode(odocstream & os, pit_type par_begin, pit_type par_end,
394 /// Access to error list.
395 /// This method is used only for GUI visualisation of Buffer related
396 /// errors (like parsing or LateX compilation). This method is const
397 /// because modifying the returned ErrorList does not touch the document
399 ErrorList & errorList(std::string const & type) const;
402 /// This is useful only for screen visualisation of the Buffer. This
403 /// method is const because modifying this backend does not touch
404 /// the document contents.
405 TocBackend & tocBackend() const;
408 EmbeddedFiles & embeddedFiles();
409 EmbeddedFiles const & embeddedFiles() const;
414 /// This function is called when the buffer is changed.
415 void changed() const;
416 /// This function is called when the buffer structure is changed.
417 void structureChanged() const;
418 /// This function is called when some parsing error shows up.
419 void errors(std::string const & err) const;
420 /// This function is called when the buffer busy status change.
421 void setBusy(bool on) const;
422 /// This function is called when the buffer readonly status change.
423 void setReadOnly(bool on) const;
424 /// Update window titles of all users.
425 void updateTitles() const;
426 /// Reset autosave timers for all users.
427 void resetAutosaveTimers() const;
429 void message(docstring const & msg) const;
431 void setGuiDelegate(frontend::GuiBufferDelegate * gui);
434 void autoSave() const;
436 void loadChildDocuments() const;
438 void resetChildDocuments(bool close_them) const;
440 /// return the format of the buffer on a string
441 std::string bufferFormat() const;
444 bool doExport(std::string const & format, bool put_in_tempdir,
445 std::string & result_file) const;
447 bool doExport(std::string const & format, bool put_in_tempdir) const;
449 bool preview(std::string const & format) const;
451 bool isExportable(std::string const & format) const;
453 std::vector<Format const *> exportableFormats(bool only_viewable) const;
456 /// search for macro in local (buffer) table or in children
457 MacroData const * getBufferMacro(docstring const & name,
458 DocIterator const & pos) const;
459 /** Update macro table in the whole text inset
460 \param it at the start of the text inset)
462 void updateInsetMacros(DocIterator & it,
463 DocIterator & scope) const;
464 /** Update macro table for paragraphs until \c lastpit
465 \param it in some text inset
466 \param lastpit last processed paragraph
468 void updateEnvironmentMacros(DocIterator & it,
470 DocIterator & scope) const;
471 /** Update macro table for one paragraph block with
472 same layout and depth, until \c lastpit
473 \param it in some text inset
474 \param lastpit last processed paragraph
476 void updateBlockMacros(DocIterator & it,
477 DocIterator & scope) const;
480 bool readFileHelper(support::FileName const & s);
482 std::vector<std::string> backends() const;
483 /** Inserts a file into a document
484 \return \c false if method fails.
486 ReadStatus readFile(Lexer &, support::FileName const & filename,
487 bool fromString = false);
489 /// Use the Pimpl idiom to hide the internals.
491 /// The pointer never changes although *pimpl_'s contents may.
494 frontend::GuiBufferDelegate * gui_;