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"
57 class ParConstIterator;
67 class GuiBufferDelegate;
68 class WorkAreaManager;
76 /** The buffer object.
77 * This is the buffer object. It contains all the informations about
78 * a document loaded into LyX.
79 * The buffer object owns the Text (wrapped in an InsetText), which
80 * contains the individual paragraphs of the document.
83 * I am not sure if the class is complete or
84 * minimal, probably not.
85 * \author Lars Gullik Bjønnes
89 /// What type of log will \c getLogName() return?
91 latexlog, ///< LaTeX log
92 buildlog ///< Literate build log
95 /// Result of \c readFile()
97 failure, ///< The file could not be read
98 success, ///< The file could not be read
99 wrongversion ///< The version of the file does not match ours
103 /// Method to check if a file is externally modified, used by
104 /// isExternallyModified()
106 * timestamp is fast but inaccurate. For example, the granularity
107 * of timestamp on a FAT filesystem is 2 second. Also, various operations
108 * may touch the timestamp of a file even when its content is unchanged.
110 * checksum is accurate but slow, which can be a problem when it is
111 * frequently used, or used for a large file on a slow (network) file
114 * FIXME: replace this method with support/FileMonitor.
117 checksum_method, ///< Use file checksum
118 timestamp_method, ///< Use timestamp, and checksum if timestamp has changed
128 explicit Buffer(std::string const & file, bool readonly = false,
129 Buffer const * cloned_buffer = 0);
135 Buffer * clone() const;
137 bool isClone() const;
139 /** High-level interface to buffer functionality.
140 This function parses a command string and executes it.
142 void dispatch(std::string const & command, DispatchResult & result);
144 /// Maybe we know the function already by number...
145 void dispatch(FuncRequest const & func, DispatchResult & result);
147 /// Can this function be exectued?
148 /// \return true if we made a decision
149 bool getStatus(FuncRequest const & cmd, FuncStatus & flag);
151 /// read a new document from a string
152 bool readString(std::string const &);
154 bool readFile(support::FileName const & filename);
156 /// read the header, returns number of unknown tokens
157 int readHeader(Lexer & lex);
159 /** Reads a file without header.
160 \param par if != 0 insert the file.
161 \return \c true if file is not completely read.
163 bool readDocument(Lexer &);
166 DocIterator getParFromID(int id) const;
167 /// do we have a paragraph with this id?
168 bool hasParWithID(int id) const;
171 frontend::WorkAreaManager & workAreaManager() const;
174 Takes care of auto-save files and backup file if requested.
175 Returns \c true if the save is successful, \c false otherwise.
179 /// Write document to stream. Returns \c false if unsuccesful.
180 bool write(std::ostream &) const;
181 /// save emergency file
182 /// \return a status message towards the user.
183 docstring emergencyWrite();
184 /// Write file. Returns \c false if unsuccesful.
185 bool writeFile(support::FileName const &) const;
187 /// Loads LyX file \c filename into buffer, * and return success
188 bool loadLyXFile(support::FileName const & s);
189 /// Reloads the LyX file
192 /// Fill in the ErrorList with the TeXErrors
193 void bufferErrors(TeXErrors const &, ErrorList &) const;
195 /// Just a wrapper for writeLaTeXSource, first creating the ofstream.
196 bool makeLaTeXFile(support::FileName const & filename,
197 std::string const & original_path,
198 OutputParams const &,
199 bool output_preamble = true,
200 bool output_body = true) const;
201 /** Export the buffer to LaTeX.
202 If \p os is a file stream, and params().inputenc is "auto" or
203 "default", and the buffer contains text in different languages
204 with more than one encoding, then this method will change the
205 encoding associated to \p os. Therefore you must not call this
206 method with a string stream if the output is supposed to go to a
209 ofs.open("test.tex");
210 writeLaTeXSource(ofs, ...);
212 \endcode is NOT equivalent to \code
213 odocstringstream oss;
214 writeLaTeXSource(oss, ...);
216 ofs.open("test.tex");
221 void writeLaTeXSource(odocstream & os,
222 std::string const & original_path,
223 OutputParams const &,
224 bool output_preamble = true,
225 bool output_body = true) const;
227 void makeDocBookFile(support::FileName const & filename,
228 OutputParams const & runparams_in,
229 bool only_body = false) const;
231 void writeDocBookSource(odocstream & os, std::string const & filename,
232 OutputParams const & runparams_in,
233 bool only_body = false) const;
235 void makeLyXHTMLFile(support::FileName const & filename,
236 OutputParams const & runparams_in,
237 bool only_body = false) const;
239 void writeLyXHTMLSource(odocstream & os,
240 OutputParams const & runparams_in,
241 bool only_body = false) const;
242 /// returns the main language for the buffer (document)
243 Language const * language() const;
244 /// get l10n translated to the buffers language
245 docstring const B_(std::string const & l10n) const;
249 /// return true if the main lyx file does not need saving
250 bool isClean() const;
252 bool isDepClean(std::string const & name) const;
254 /// whether or not disk file has been externally modified
255 bool isExternallyModified(CheckMethod method) const;
257 /// save timestamp and checksum of the given file.
258 void saveCheckSum(support::FileName const & file) const;
260 /// mark the main lyx file as not needing saving
261 void markClean() const;
264 void markDepClean(std::string const & name);
267 void setUnnamed(bool flag = true);
269 /// Whether or not a filename has been assigned to this buffer
270 bool isUnnamed() const;
272 /// Whether or not this buffer is internal.
274 /// An internal buffer does not contain a real document, but some auxiliary text segment.
275 /// It is not associated with a filename, it is never saved, thus it does not need to be
276 /// automatically saved, nor it needs to trigger any "do you want to save ?" question.
277 bool isInternal() const;
279 /// Mark this buffer as dirty.
282 /// Returns the buffer's filename. It is always an absolute path.
283 support::FileName fileName() const;
285 /// Returns the buffer's filename. It is always an absolute path.
286 std::string absFileName() const;
288 /// Returns the the path where the buffer lives.
289 /// It is always an absolute path.
290 std::string filePath() const;
292 /** A transformed version of the file name, adequate for LaTeX.
293 \param no_path optional if \c true then the path is stripped.
295 std::string latexName(bool no_path = true) const;
297 /// Get the name and type of the log.
298 std::string logName(LogType * type = 0) const;
300 /// Change name of buffer. Updates "read-only" flag.
301 void setFileName(std::string const & newfile);
303 /// Set document's parent Buffer.
304 void setParent(Buffer const *);
305 Buffer const * parent() const;
307 // Collect all relative buffer
308 std::vector<Buffer const *> allRelatives() const;
310 /** Get the document's master (or \c this if this is not a
313 Buffer const * masterBuffer() const;
315 /// \return true if \p child is a child of this \c Buffer.
316 bool isChild(Buffer * child) const;
318 /// return a vector with all children (and grandchildren)
319 std::vector<Buffer *> getChildren(bool grand_children = true) const;
321 /// Add all children (and grandchildren) to supplied vector
322 void getChildren(std::vector<Buffer *> & children, bool grand_children = true) const;
324 /// Is buffer read-only?
325 bool isReadonly() const;
327 /// Set buffer read-only flag
328 void setReadonly(bool flag = true);
330 /// returns \c true if the buffer contains a LaTeX document
331 bool isLatex() const;
332 /// returns \c true if the buffer contains a DocBook document
333 bool isDocBook() const;
334 /// returns \c true if the buffer contains a Wed document
335 bool isLiterate() const;
337 /** Validate a buffer for LaTeX.
338 This validates the buffer, and returns a struct for use by
339 #makeLaTeX# and others. Its main use is to figure out what
340 commands and packages need to be included in the LaTeX file.
341 It (should) also check that the needed constructs are there
342 (i.e. that the \refs points to coresponding \labels). It
343 should perhaps inset "error" insets to help the user correct
346 void validate(LaTeXFeatures &) const;
348 /// Update the list of all bibfiles in use (including bibfiles
349 /// of loaded child documents).
350 void updateBibfilesCache(UpdateScope scope = UpdateMaster) const;
351 /// Return the list with all bibfiles in use (including bibfiles
352 /// of loaded child documents).
353 support::FileNameList const &
354 getBibfilesCache(UpdateScope scope = UpdateMaster) const;
355 /// Information from BibTeX databases is cached in the Buffer, so
356 /// we do not have to read the file over and over.
357 /// Calling this method invalidates the cache and so requires a
359 void invalidateBibinfoCache();
360 /// Updates the cached bibliography information.
361 /// Note that you MUST call this method to update the cache. It will
362 /// not happen otherwise. (Currently, it is called at the start of
363 /// updateLabels() and from GuiCitation.)
364 void checkBibInfoCache() const;
365 /// \return the bibliography information for this buffer's master,
366 /// or just for it, if it isn't a child.
367 BiblioInfo const & masterBibInfo() const;
368 /// \return the bibliography information for this buffer ONLY.
369 BiblioInfo const & localBibInfo() const;
371 void getLabelList(std::vector<docstring> &) const;
374 void changeLanguage(Language const * from, Language const * to);
377 bool isMultiLingual() const;
380 BufferParams & params();
381 BufferParams const & params() const;
383 /** The list of paragraphs.
384 This is a linked list of paragraph, this list holds the
385 whole contents of the document.
387 ParagraphList & paragraphs();
388 ParagraphList const & paragraphs() const;
390 /// LyX version control object.
392 LyXVC const & lyxvc() const;
394 /// Where to put temporary files.
395 std::string const temppath() const;
397 /// Used when typesetting to place errorboxes.
398 TexRow const & texrow() const;
402 ParIterator par_iterator_begin();
404 ParConstIterator par_iterator_begin() const;
406 ParIterator par_iterator_end();
408 ParConstIterator par_iterator_end() const;
410 // Position of the child buffer where it appears first in the master.
411 DocIterator firstChildPosition(Buffer const * child);
413 /** \returns true only when the file is fully loaded.
414 * Used to prevent the premature generation of previews
415 * and by the citation inset.
417 bool isFullyLoaded() const;
418 /// Set by buffer_funcs' newFile.
419 void setFullyLoaded(bool);
421 /// Our main text (inside the top InsetText)
424 /// Our top InsetText
425 Inset & inset() const;
430 /// Collect macro definitions in paragraphs
431 void updateMacros() const;
432 /// Iterate through the whole buffer and try to resolve macros
433 void updateMacroInstances() const;
435 /// List macro names of this buffer, the parent and the children
436 void listMacroNames(MacroNameSet & macros) const;
437 /// Collect macros of the parent and its children in front of this buffer.
438 void listParentMacros(MacroSet & macros, LaTeXFeatures & features) const;
440 /// Return macro defined before pos (or in the master buffer)
441 MacroData const * getMacro(docstring const & name, DocIterator const & pos, bool global = true) const;
442 /// Return macro defined anywhere in the buffer (or in the master buffer)
443 MacroData const * getMacro(docstring const & name, bool global = true) const;
444 /// Return macro defined before the inclusion of the child
445 MacroData const * getMacro(docstring const & name, Buffer const & child, bool global = true) const;
447 /// Collect user macro names at loading time
448 typedef std::set<docstring> UserMacroSet;
449 UserMacroSet usermacros;
451 /// Replace the inset contents for insets which InsetCode is equal
452 /// to the passed \p inset_code.
453 void changeRefsIfUnique(docstring const & from, docstring const & to,
456 /// get source code (latex/docbook) for some paragraphs, or all paragraphs
457 /// including preamble
458 void getSourceCode(odocstream & os, pit_type par_begin, pit_type par_end,
459 bool full_source) const;
461 /// Access to error list.
462 /// This method is used only for GUI visualisation of Buffer related
463 /// errors (like parsing or LateX compilation). This method is const
464 /// because modifying the returned ErrorList does not touch the document
466 ErrorList & errorList(std::string const & type) const;
469 /// This is useful only for screen visualisation of the Buffer. This
470 /// method is const because modifying this backend does not touch
471 /// the document contents.
472 TocBackend & tocBackend() const;
477 /// This function is called when the buffer is changed.
478 void changed(bool update_metrics) const;
480 void setChild(DocIterator const & dit, Buffer * child);
482 void updateTocItem(std::string const &, DocIterator const &) const;
483 /// This function is called when the buffer structure is changed.
484 void structureChanged() const;
485 /// This function is called when some parsing error shows up.
486 void errors(std::string const & err, bool from_master = false) const;
487 /// This function is called when the buffer busy status change.
488 void setBusy(bool on) const;
489 /// Update window titles of all users.
490 void updateTitles() const;
491 /// Reset autosave timers for all users.
492 void resetAutosaveTimers() const;
494 void message(docstring const & msg) const;
497 void setGuiDelegate(frontend::GuiBufferDelegate * gui);
499 bool hasGuiDelegate() const;
502 void autoSave() const;
504 void removeAutosaveFile() const;
506 void moveAutosaveFile(support::FileName const & old) const;
508 support::FileName getAutosaveFilename() const;
510 /// return the format of the buffer on a string
511 std::string bufferFormat() const;
512 /// return the default output format of the current backend
513 std::string getDefaultOutputFormat() const;
516 bool doExport(std::string const & format, bool put_in_tempdir,
517 bool includeall, std::string & result_file) const;
519 bool doExport(std::string const & format, bool put_in_tempdir,
520 bool includeall = false) const;
522 bool preview(std::string const & format, bool includeall = false) const;
524 bool isExportable(std::string const & format) const;
526 std::vector<Format const *> exportableFormats(bool only_viewable) const;
528 bool isExportableFormat(std::string const & format) const;
531 typedef std::vector<std::pair<InsetRef *, ParIterator> > References;
532 References & references(docstring const & label);
533 References const & references(docstring const & label) const;
534 void clearReferenceCache() const;
535 void setInsetLabel(docstring const & label, InsetLabel const * il);
536 InsetLabel const * insetLabel(docstring const & label) const;
538 /// return a list of all used branches (also in children)
539 void getUsedBranches(std::list<docstring> &, bool const from_master = false) const;
541 /// sets the buffer_ member for every inset in this buffer.
542 // FIXME This really shouldn't be needed, but at the moment it's not
543 // clear how to do it just for the individual pieces we need.
544 void setBuffersForInsets() const;
545 /// Updates screen labels and some other information associated with
546 /// insets and paragraphs. Actually, it's more like a general "recurse
547 /// through the Buffer" routine, that visits all the insets and paragraphs.
548 void updateLabels() const { updateLabels(UpdateMaster, InternalUpdate); }
549 /// \param scope: whether to start with the master document or just
551 /// \param output: whether we are preparing for output.
552 void updateLabels(UpdateScope scope, UpdateType utype) const;
554 void updateLabels(ParIterator & parit, UpdateType utype) const;
556 /// Spellcheck starting from \p from.
557 /// \p from initial position, will then points to the next misspelled
559 /// \p to will points to the end of the next misspelled word.
560 /// \p word_lang will contain the found misspelled word.
561 /// \return progress if a new word was found.
562 int spellCheck(DocIterator & from, DocIterator & to,
563 WordLangTuple & word_lang, docstring_list & suggestions) const;
567 bool readFileHelper(support::FileName const & s);
569 std::vector<std::string> backends() const;
570 /** Inserts a file into a document
571 \return \c false if method fails.
573 ReadStatus readFile(Lexer &, support::FileName const & filename,
574 bool fromString = false);
576 /// Use the Pimpl idiom to hide the internals.
578 /// The pointer never changes although *pimpl_'s contents may.