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 "support/FileName.h"
16 #include "support/limited_stack.h"
17 #include "support/types.h"
18 #include "support/docstring.h"
19 #include "support/docstream.h"
44 class ParConstIterator;
53 class GuiBufferDelegate;
54 class WorkAreaManager;
57 /** The buffer object.
58 * This is the buffer object. It contains all the informations about
59 * a document loaded into LyX.
60 * The buffer object owns the Text (wrapped in an InsetText), which
61 * contains the individual paragraphs of the document.
64 * I am not sure if the class is complete or
65 * minimal, probably not.
66 * \author Lars Gullik Bjønnes
70 /// What type of log will \c getLogName() return?
72 latexlog, ///< LaTeX log
73 buildlog ///< Literate build log
76 /// Result of \c readFile()
78 failure, ///< The file could not be read
79 success, ///< The file could not be read
80 wrongversion ///< The version of the file does not match ours
83 /// Method to check if a file is externally modified, used by
84 /// isExternallyModified()
86 * timestamp is fast but inaccurate. For example, the granularity
87 * of timestamp on a FAT filesystem is 2 second. Also, various operations
88 * may touch the timestamp of a file even when its content is unchanged.
90 * checksum is accurate but slow, which can be a problem when it is
91 * frequently used, or used for a large file on a slow (network) file
95 checksum_method, ///< Use file check sum
96 timestamp_method, ///< Use timestamp, and checksum if timestamp has changed
101 \param b optional \c false by default
103 explicit Buffer(std::string const & file, bool b = false);
108 /** High-level interface to buffer functionality.
109 This function parses a command string and executes it
111 bool dispatch(std::string const & command, bool * result = 0);
113 /// Maybe we know the function already by number...
114 bool dispatch(FuncRequest const & func, bool * result = 0);
116 /// Load the autosaved file.
117 void loadAutoSaveFile();
119 /// read a new document from a string
120 bool readString(std::string const &);
122 bool readFile(support::FileName const & filename);
124 /// read the header, returns number of unknown tokens
125 int readHeader(Lexer & lex);
127 /** Reads a file without header.
128 \param par if != 0 insert the file.
129 \return \c false if file is not completely read.
131 bool readDocument(Lexer &);
134 void insertStringAsLines(ParagraphList & plist,
135 pit_type &, pos_type &,
136 Font const &, docstring const &, bool);
138 ParIterator getParFromID(int id) const;
139 /// do we have a paragraph with this id?
140 bool hasParWithID(int id) const;
143 frontend::WorkAreaManager & workAreaManager() const;
146 Takes care of auto-save files and backup file if requested.
147 Returns \c true if the save is successful, \c false otherwise.
151 /// Write document to stream. Returns \c false if unsuccesful.
152 bool write(std::ostream &) const;
153 /// Write file. Returns \c false if unsuccesful.
154 bool writeFile(support::FileName const &) const;
156 /// Just a wrapper for writeLaTeXSource, first creating the ofstream.
157 bool makeLaTeXFile(support::FileName const & filename,
158 std::string const & original_path,
159 OutputParams const &,
160 bool output_preamble = true,
161 bool output_body = true);
162 /** Export the buffer to LaTeX.
163 If \p os is a file stream, and params().inputenc is "auto" or
164 "default", and the buffer contains text in different languages
165 with more than one encoding, then this method will change the
166 encoding associated to \p os. Therefore you must not call this
167 method with a string stream if the output is supposed to go to a
170 ofs.open("test.tex");
171 writeLaTeXSource(ofs, ...);
173 \endcode is NOT equivalent to \code
174 odocstringstream oss;
175 writeLaTeXSource(oss, ...);
177 ofs.open("test.tex");
182 void writeLaTeXSource(odocstream & os,
183 std::string const & original_path,
184 OutputParams const &,
185 bool output_preamble = true,
186 bool output_body = true);
188 void makeDocBookFile(support::FileName const & filename,
189 OutputParams const & runparams_in,
190 bool only_body = false);
192 void writeDocBookSource(odocstream & os, std::string const & filename,
193 OutputParams const & runparams_in,
194 bool only_body = false);
195 /// returns the main language for the buffer (document)
196 Language const * getLanguage() const;
197 /// get l10n translated to the buffers language
198 docstring const B_(std::string const & l10n) const;
202 /// return true if the main lyx file does not need saving
203 bool isClean() const;
205 bool isBakClean() const;
207 bool isDepClean(std::string const & name) const;
209 /// whether or not disk file has been externally modified
210 bool isExternallyModified(CheckMethod method) const;
212 /// save timestamp and checksum of the given file.
213 void saveCheckSum(std::string const & file) const;
215 /// mark the main lyx file as not needing saving
216 void markClean() const;
219 void markBakClean() const;
222 void markDepClean(std::string const & name);
225 void setUnnamed(bool flag = true);
228 bool isUnnamed() const;
230 /// Mark this buffer as dirty.
233 /// Returns the buffer's filename. It is always an absolute path.
234 std::string const fileName() const;
236 /// Returns the the path where the buffer lives.
237 /// It is always an absolute path.
238 std::string const & filePath() const;
240 /** A transformed version of the file name, adequate for LaTeX.
241 \param no_path optional if \c true then the path is stripped.
243 std::string const getLatexName(bool no_path = true) const;
245 /// Get thee name and type of the log.
246 std::pair<LogType, std::string> const getLogName() const;
248 /// Change name of buffer. Updates "read-only" flag.
249 void setFileName(std::string const & newfile);
251 /// Name of the document's parent
252 void setParentName(std::string const &);
254 /** Get the document's master (or \c this if this is not a
257 Buffer const * getMasterBuffer() const;
258 /** Get the document's master (or \c this if this is not a
261 Buffer * getMasterBuffer();
263 /// Is buffer read-only?
264 bool isReadonly() const;
266 /// Set buffer read-only flag
267 void setReadonly(bool flag = true);
269 /// returns \c true if the buffer contains a LaTeX document
270 bool isLatex() const;
271 /// returns \c true if the buffer contains a DocBook document
272 bool isDocBook() const;
273 /// returns \c true if the buffer contains a Wed document
274 bool isLiterate() const;
276 /** Validate a buffer for LaTeX.
277 This validates the buffer, and returns a struct for use by
278 #makeLaTeX# and others. Its main use is to figure out what
279 commands and packages need to be included in the LaTeX file.
280 It (should) also check that the needed constructs are there
281 (i.e. that the \refs points to coresponding \labels). It
282 should perhaps inset "error" insets to help the user correct
285 void validate(LaTeXFeatures &) const;
287 /// Update the cache with all bibfiles in use (including bibfiles
288 /// of loaded child documents).
289 void updateBibfilesCache();
290 /// Return the cache with all bibfiles in use (including bibfiles
291 /// of loaded child documents).
292 std::vector<support::FileName> const & getBibfilesCache() const;
294 void getLabelList(std::vector<docstring> &) const;
297 void changeLanguage(Language const * from, Language const * to);
300 bool isMultiLingual() const;
302 /// Does this mean that this is buffer local?
303 limited_stack<Undo> & undostack();
304 limited_stack<Undo> const & undostack() const;
306 /// Does this mean that this is buffer local?
307 limited_stack<Undo> & redostack();
308 limited_stack<Undo> const & redostack() const;
311 BufferParams & params();
312 BufferParams const & params() const;
314 /** The list of paragraphs.
315 This is a linked list of paragraph, this list holds the
316 whole contents of the document.
318 ParagraphList & paragraphs();
319 ParagraphList const & paragraphs() const;
321 /// LyX version control object.
323 LyXVC const & lyxvc() const;
325 /// Where to put temporary files.
326 std::string const & temppath() const;
328 /// Used when typesetting to place errorboxes.
330 TexRow const & texrow() const;
333 ParIterator par_iterator_begin();
335 ParConstIterator par_iterator_begin() const;
337 ParIterator par_iterator_end();
339 ParConstIterator par_iterator_end() const;
341 /** \returns true only when the file is fully loaded.
342 * Used to prevent the premature generation of previews
343 * and by the citation inset.
345 bool fully_loaded() const;
346 /// Set by buffer_funcs' newFile.
347 void fully_loaded(bool);
349 /// Our main text (inside the top InsetText)
352 /// Our top InsetText!
353 Inset & inset() const;
361 bool hasMacro(docstring const & name) const;
363 MacroData const & getMacro(docstring const & name) const;
365 void insertMacro(docstring const & name, MacroData const & data);
367 /// Replace the inset contents for insets which Inset::Code is equal
368 /// to the passed \p inset_code.
369 /// FIXME: we pass Inset::Code as an int in order to avoid the inclusion
370 /// of "Inset.h". It would be better to put Inset::Code in its own
372 void changeRefsIfUnique(docstring const & from, docstring const & to,
375 /// get source code (latex/docbook) for some paragraphs, or all paragraphs
376 /// including preamble
377 void getSourceCode(odocstream & os, pit_type par_begin, pit_type par_end, bool full_source);
379 /// errorLists_ accessors.
381 ErrorList const & errorList(std::string const & type) const;
382 ErrorList & errorList(std::string const & type);
386 TocBackend & tocBackend();
387 TocBackend const & tocBackend() const;
391 EmbeddedFiles & embeddedFiles();
392 EmbeddedFiles const & embeddedFiles() const;
395 /// This function is called when the buffer is changed.
396 void changed() const;
397 /// This function is called when the buffer structure is changed.
398 void structureChanged() const;
399 /// This function is called when an embedded file is changed
400 void embeddingChanged() const;
401 /// This function is called when some parsing error shows up.
402 void errors(std::string const & err) const;
403 /// This function is called when the buffer busy status change.
404 void busy(bool on) const;
405 /// This function is called when the buffer readonly status change.
406 void readonly(bool on) const;
407 /// Update window titles of all users.
408 void updateTitles() const;
409 /// Reset autosave timers for all users.
410 void resetAutosaveTimers() const;
412 void message(docstring const & msg) const;
414 void setGuiDelegate(frontend::GuiBufferDelegate * gui);
417 void autoSave() const;
419 bool writeAs(std::string const & newname = std::string());
424 /** Inserts a file into a document
425 \return \c false if method fails.
427 ReadStatus readFile(Lexer &, support::FileName const & filename,
428 bool fromString = false);
430 /// Use the Pimpl idiom to hide the internals.
432 /// The pointer never changes although *pimpl_'s contents may.
435 /// A cache for the bibfiles (including bibfiles of loaded child
436 /// documents), needed for appropriate update of natbib labels.
437 mutable std::vector<support::FileName> bibfilesCache_;
439 frontend::GuiBufferDelegate * gui_;