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"
19 #include "support/SignalSlot.h"
50 class ParConstIterator;
59 class GuiBufferDelegate;
60 class WorkAreaManager;
68 /** The buffer object.
69 * This is the buffer object. It contains all the informations about
70 * a document loaded into LyX.
71 * The buffer object owns the Text (wrapped in an InsetText), which
72 * contains the individual paragraphs of the document.
75 * I am not sure if the class is complete or
76 * minimal, probably not.
77 * \author Lars Gullik Bjønnes
81 /// What type of log will \c getLogName() return?
83 latexlog, ///< LaTeX log
84 buildlog ///< Literate build log
87 /// Result of \c readFile()
89 failure, ///< The file could not be read
90 success, ///< The file could not be read
91 wrongversion ///< The version of the file does not match ours
95 /// Method to check if a file is externally modified, used by
96 /// isExternallyModified()
98 * timestamp is fast but inaccurate. For example, the granularity
99 * of timestamp on a FAT filesystem is 2 second. Also, various operations
100 * may touch the timestamp of a file even when its content is unchanged.
102 * checksum is accurate but slow, which can be a problem when it is
103 * frequently used, or used for a large file on a slow (network) file
106 * FIXME: replace this method with support/FileMonitor.
109 checksum_method, ///< Use file checksum
110 timestamp_method, ///< Use timestamp, and checksum if timestamp has changed
114 explicit Buffer(std::string const & file, bool b = false);
119 /** High-level interface to buffer functionality.
120 This function parses a command string and executes it
122 bool dispatch(std::string const & command, bool * result = 0);
124 /// Maybe we know the function already by number...
125 bool dispatch(FuncRequest const & func, bool * result = 0);
127 /// Load the autosaved file.
128 void loadAutoSaveFile();
130 /// read a new document from a string
131 bool readString(std::string const &);
133 bool readFile(support::FileName const & filename);
135 /// read the header, returns number of unknown tokens
136 int readHeader(Lexer & lex);
138 /** Reads a file without header.
139 \param par if != 0 insert the file.
140 \return \c false if file is not completely read.
142 bool readDocument(Lexer &);
145 void insertStringAsLines(ParagraphList & plist,
146 pit_type &, pos_type &,
147 Font const &, docstring const &, bool);
149 DocIterator getParFromID(int id) const;
150 /// do we have a paragraph with this id?
151 bool hasParWithID(int id) const;
154 frontend::WorkAreaManager & workAreaManager() const;
157 Takes care of auto-save files and backup file if requested.
158 Returns \c true if the save is successful, \c false otherwise.
162 /// Write document to stream. Returns \c false if unsuccesful.
163 bool write(std::ostream &) const;
164 /// Write file. Returns \c false if unsuccesful.
165 bool writeFile(support::FileName const &) const;
167 /// Loads LyX file \c filename into buffer, * and \return success
168 bool loadLyXFile(support::FileName const & s);
170 /// Fill in the ErrorList with the TeXErrors
171 void bufferErrors(TeXErrors const &, ErrorList &) const;
173 /// Just a wrapper for writeLaTeXSource, first creating the ofstream.
174 bool makeLaTeXFile(support::FileName const & filename,
175 std::string const & original_path,
176 OutputParams const &,
177 bool output_preamble = true,
178 bool output_body = true) const;
179 /** Export the buffer to LaTeX.
180 If \p os is a file stream, and params().inputenc is "auto" or
181 "default", and the buffer contains text in different languages
182 with more than one encoding, then this method will change the
183 encoding associated to \p os. Therefore you must not call this
184 method with a string stream if the output is supposed to go to a
187 ofs.open("test.tex");
188 writeLaTeXSource(ofs, ...);
190 \endcode is NOT equivalent to \code
191 odocstringstream oss;
192 writeLaTeXSource(oss, ...);
194 ofs.open("test.tex");
199 void writeLaTeXSource(odocstream & os,
200 std::string const & original_path,
201 OutputParams const &,
202 bool output_preamble = true,
203 bool output_body = true) const;
205 void makeDocBookFile(support::FileName const & filename,
206 OutputParams const & runparams_in,
207 bool only_body = false) const;
209 void writeDocBookSource(odocstream & os, std::string const & filename,
210 OutputParams const & runparams_in,
211 bool only_body = false) const;
212 /// returns the main language for the buffer (document)
213 Language const * language() const;
214 /// get l10n translated to the buffers language
215 docstring const B_(std::string const & l10n) const;
219 /// return true if the main lyx file does not need saving
220 bool isClean() const;
222 bool isBakClean() const;
224 bool isDepClean(std::string const & name) const;
226 /// whether or not disk file has been externally modified
227 bool isExternallyModified(CheckMethod method) const;
229 /// save timestamp and checksum of the given file.
230 void saveCheckSum(support::FileName const & file) const;
232 /// mark the main lyx file as not needing saving
233 void markClean() const;
236 void markBakClean() const;
239 void markDepClean(std::string const & name);
242 void setUnnamed(bool flag = true);
245 bool isUnnamed() const;
247 /// Mark this buffer as dirty.
250 /// Returns the buffer's filename. It is always an absolute path.
251 support::FileName fileName() const;
253 /// Returns the buffer's filename. It is always an absolute path.
254 std::string absFileName() const;
256 /// Returns the the path where the buffer lives.
257 /// It is always an absolute path.
258 std::string filePath() const;
260 /** A transformed version of the file name, adequate for LaTeX.
261 \param no_path optional if \c true then the path is stripped.
263 std::string latexName(bool no_path = true) const;
265 /// Get thee name and type of the log.
266 std::string logName(LogType * type = 0) const;
268 /// Change name of buffer. Updates "read-only" flag.
269 void setFileName(std::string const & newfile);
271 /// Set document's parent Buffer.
272 void setParent(Buffer const *);
273 Buffer const * parent() const;
275 // Collect all relative buffer
276 std::vector<Buffer const *> allRelatives() const;
278 /** Get the document's master (or \c this if this is not a
281 Buffer const * masterBuffer() const;
283 /// \return true if \p child is a child of this \c Buffer.
284 bool isChild(Buffer * child) const;
286 /// Is buffer read-only?
287 bool isReadonly() const;
289 /// Set buffer read-only flag
290 void setReadonly(bool flag = true);
292 /// returns \c true if the buffer contains a LaTeX document
293 bool isLatex() const;
294 /// returns \c true if the buffer contains a DocBook document
295 bool isDocBook() const;
296 /// returns \c true if the buffer contains a Wed document
297 bool isLiterate() const;
299 /** Validate a buffer for LaTeX.
300 This validates the buffer, and returns a struct for use by
301 #makeLaTeX# and others. Its main use is to figure out what
302 commands and packages need to be included in the LaTeX file.
303 It (should) also check that the needed constructs are there
304 (i.e. that the \refs points to coresponding \labels). It
305 should perhaps inset "error" insets to help the user correct
308 void validate(LaTeXFeatures &) const;
310 /// Update the cache with all bibfiles in use (including bibfiles
311 /// of loaded child documents).
312 void updateBibfilesCache() const;
314 void invalidateBibinfoCache();
315 /// Return the cache with all bibfiles in use (including bibfiles
316 /// of loaded child documents).
317 support::FileNameList const & getBibfilesCache() const;
318 /// \return the bibliography information for this buffer's master,
319 /// or just for it, if it isn't a child.
320 BiblioInfo const & masterBibInfo() const;
321 /// \return the bibliography information for this buffer ONLY.
322 BiblioInfo const & localBibInfo() const;
324 void getLabelList(std::vector<docstring> &) const;
327 void changeLanguage(Language const * from, Language const * to);
330 bool isMultiLingual() const;
333 BufferParams & params();
334 BufferParams const & params() const;
336 /** The list of paragraphs.
337 This is a linked list of paragraph, this list holds the
338 whole contents of the document.
340 ParagraphList & paragraphs();
341 ParagraphList const & paragraphs() const;
343 /// LyX version control object.
345 LyXVC const & lyxvc() const;
347 /// Where to put temporary files.
348 std::string const temppath() const;
350 /// Used when typesetting to place errorboxes.
351 TexRow const & texrow() const;
355 ParIterator par_iterator_begin();
357 ParConstIterator par_iterator_begin() const;
359 ParIterator par_iterator_end();
361 ParConstIterator par_iterator_end() const;
363 // Position of the child buffer where it appears first in the master.
364 DocIterator firstChildPosition(Buffer const * child);
366 /** \returns true only when the file is fully loaded.
367 * Used to prevent the premature generation of previews
368 * and by the citation inset.
370 bool isFullyLoaded() const;
371 /// Set by buffer_funcs' newFile.
372 void setFullyLoaded(bool);
374 /// Our main text (inside the top InsetText)
377 /// Our top InsetText
378 Inset & inset() const;
383 /// Collect macro definitions in paragraphs
384 void updateMacros() const;
385 /// Iterate through the whole buffer and try to resolve macros
386 void updateMacroInstances() const;
388 /// List macro names of this buffer, the parent and the children
389 void listMacroNames(MacroNameSet & macros) const;
390 /// Collect macros of the parent and its children in front of this buffer.
391 void listParentMacros(MacroSet & macros, LaTeXFeatures & features) const;
393 /// Return macro defined before pos (or in the master buffer)
394 MacroData const * getMacro(docstring const & name, DocIterator const & pos, bool global = true) const;
395 /// Return macro defined anywhere in the buffer (or in the master buffer)
396 MacroData const * getMacro(docstring const & name, bool global = true) const;
397 /// Return macro defined before the inclusion of the child
398 MacroData const * getMacro(docstring const & name, Buffer const & child, bool global = true) const;
400 /// Replace the inset contents for insets which InsetCode is equal
401 /// to the passed \p inset_code.
402 void changeRefsIfUnique(docstring const & from, docstring const & to,
405 /// get source code (latex/docbook) for some paragraphs, or all paragraphs
406 /// including preamble
407 void getSourceCode(odocstream & os, pit_type par_begin, pit_type par_end,
408 bool full_source) const;
410 /// Access to error list.
411 /// This method is used only for GUI visualisation of Buffer related
412 /// errors (like parsing or LateX compilation). This method is const
413 /// because modifying the returned ErrorList does not touch the document
415 ErrorList & errorList(std::string const & type) const;
418 /// This is useful only for screen visualisation of the Buffer. This
419 /// method is const because modifying this backend does not touch
420 /// the document contents.
421 TocBackend & tocBackend() const;
426 /// This function is called when the buffer is changed.
427 void changed() const;
429 void updateTocItem(std::string const &, DocIterator const &) const;
430 /// This function is called when the buffer structure is changed.
431 void structureChanged() const;
432 /// This function is called when some parsing error shows up.
433 void errors(std::string const & err) const;
434 /// This function is called when the buffer busy status change.
435 void setBusy(bool on) const;
436 /// This function is called when the buffer readonly status change.
437 void setReadOnly(bool on) const;
438 /// Update window titles of all users.
439 void updateTitles() const;
440 /// Reset autosave timers for all users.
441 void resetAutosaveTimers() const;
443 void message(docstring const & msg) const;
445 void setGuiDelegate(frontend::GuiBufferDelegate * gui);
448 void autoSave() const;
450 /// return the format of the buffer on a string
451 std::string bufferFormat() const;
454 bool doExport(std::string const & format, bool put_in_tempdir,
455 std::string & result_file) const;
457 bool doExport(std::string const & format, bool put_in_tempdir) const;
459 bool preview(std::string const & format) const;
461 bool isExportable(std::string const & format) const;
463 std::vector<Format const *> exportableFormats(bool only_viewable) const;
466 typedef std::vector<std::pair<InsetRef *, ParIterator> > References;
467 References & references(docstring const & label);
468 References const & references(docstring const & label) const;
469 void clearReferenceCache() const;
470 void setInsetLabel(docstring const & label, InsetLabel const * il);
471 InsetLabel const * insetLabel(docstring const & label) const;
473 // FIXME: buf should should be const because updateLabels() modifies
474 // the contents of the paragraphs.
475 void updateLabels(bool childonly = false) const;
477 void updateLabels(ParIterator & parit) const;
480 /// search for macro in local (buffer) table or in children
481 MacroData const * getBufferMacro(docstring const & name,
482 DocIterator const & pos) const;
483 /** Update macro table starting with position of it
484 \param it in some text inset
486 void updateMacros(DocIterator & it,
487 DocIterator & scope) const;
490 void collectRelatives(BufferSet & bufs) const;
493 bool readFileHelper(support::FileName const & s);
495 std::vector<std::string> backends() const;
496 /** Inserts a file into a document
497 \return \c false if method fails.
499 ReadStatus readFile(Lexer &, support::FileName const & filename,
500 bool fromString = false);
502 /// Use the Pimpl idiom to hide the internals.
504 /// The pointer never changes although *pimpl_'s contents may.
507 frontend::GuiBufferDelegate * gui_;
509 /// This function is called when the buffer structure is changed.
510 Signal structureChanged_;
511 /// This function is called when some parsing error shows up.
512 //Signal errors(std::string const &) = 0;
513 /// This function is called when some message shows up.
514 //Signal message(docstring const &) = 0;
515 /// This function is called when the buffer busy status change.
516 //Signal setBusy(bool) = 0;
517 /// Reset autosave timers for all users.
518 Signal resetAutosaveTimers_;