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"
49 class ParConstIterator
;
58 class GuiBufferDelegate
;
59 class WorkAreaManager
;
67 /** The buffer object.
68 * This is the buffer object. It contains all the informations about
69 * a document loaded into LyX.
70 * The buffer object owns the Text (wrapped in an InsetText), which
71 * contains the individual paragraphs of the document.
74 * I am not sure if the class is complete or
75 * minimal, probably not.
76 * \author Lars Gullik Bjønnes
80 /// What type of log will \c getLogName() return?
82 latexlog
, ///< LaTeX log
83 buildlog
///< Literate build log
86 /// Result of \c readFile()
88 failure
, ///< The file could not be read
89 success
, ///< The file could not be read
90 wrongversion
///< The version of the file does not match ours
94 /// Method to check if a file is externally modified, used by
95 /// isExternallyModified()
97 * timestamp is fast but inaccurate. For example, the granularity
98 * of timestamp on a FAT filesystem is 2 second. Also, various operations
99 * may touch the timestamp of a file even when its content is unchanged.
101 * checksum is accurate but slow, which can be a problem when it is
102 * frequently used, or used for a large file on a slow (network) file
105 * FIXME: replace this method with support/FileMonitor.
108 checksum_method
, ///< Use file checksum
109 timestamp_method
, ///< Use timestamp, and checksum if timestamp has changed
114 \param b optional \c false by default
116 explicit Buffer(std::string
const & file
, bool b
= false);
121 /** High-level interface to buffer functionality.
122 This function parses a command string and executes it
124 bool dispatch(std::string
const & command
, bool * result
= 0);
126 /// Maybe we know the function already by number...
127 bool dispatch(FuncRequest
const & func
, bool * result
= 0);
129 /// Load the autosaved file.
130 void loadAutoSaveFile();
132 /// read a new document from a string
133 bool readString(std::string
const &);
135 bool readFile(support::FileName
const & filename
);
137 /// read the header, returns number of unknown tokens
138 int readHeader(Lexer
& lex
);
140 /** Reads a file without header.
141 \param par if != 0 insert the file.
142 \return \c false if file is not completely read.
144 bool readDocument(Lexer
&);
147 void insertStringAsLines(ParagraphList
& plist
,
148 pit_type
&, pos_type
&,
149 Font
const &, docstring
const &, bool);
151 DocIterator
getParFromID(int id
) const;
152 /// do we have a paragraph with this id?
153 bool hasParWithID(int id
) const;
156 frontend::WorkAreaManager
& workAreaManager() const;
159 Takes care of auto-save files and backup file if requested.
160 Returns \c true if the save is successful, \c false otherwise.
164 /// Write document to stream. Returns \c false if unsuccesful.
165 bool write(std::ostream
&) const;
166 /// Write file. Returns \c false if unsuccesful.
167 bool writeFile(support::FileName
const &) const;
169 /// Loads LyX file \c filename into buffer, * and \return success
170 bool loadLyXFile(support::FileName
const & s
);
172 /// Fill in the ErrorList with the TeXErrors
173 void bufferErrors(TeXErrors
const &, ErrorList
&) const;
175 /// Just a wrapper for writeLaTeXSource, first creating the ofstream.
176 bool makeLaTeXFile(support::FileName
const & filename
,
177 std::string
const & original_path
,
178 OutputParams
const &,
179 bool output_preamble
= true,
180 bool output_body
= true) const;
181 /** Export the buffer to LaTeX.
182 If \p os is a file stream, and params().inputenc is "auto" or
183 "default", and the buffer contains text in different languages
184 with more than one encoding, then this method will change the
185 encoding associated to \p os. Therefore you must not call this
186 method with a string stream if the output is supposed to go to a
189 ofs.open("test.tex");
190 writeLaTeXSource(ofs, ...);
192 \endcode is NOT equivalent to \code
193 odocstringstream oss;
194 writeLaTeXSource(oss, ...);
196 ofs.open("test.tex");
201 void writeLaTeXSource(odocstream
& os
,
202 std::string
const & original_path
,
203 OutputParams
const &,
204 bool output_preamble
= true,
205 bool output_body
= true) const;
207 void makeDocBookFile(support::FileName
const & filename
,
208 OutputParams
const & runparams_in
,
209 bool only_body
= false) const;
211 void writeDocBookSource(odocstream
& os
, std::string
const & filename
,
212 OutputParams
const & runparams_in
,
213 bool only_body
= false) const;
214 /// returns the main language for the buffer (document)
215 Language
const * language() const;
216 /// get l10n translated to the buffers language
217 docstring
const B_(std::string
const & l10n
) const;
221 /// return true if the main lyx file does not need saving
222 bool isClean() const;
224 bool isBakClean() const;
226 bool isDepClean(std::string
const & name
) const;
228 /// whether or not disk file has been externally modified
229 bool isExternallyModified(CheckMethod method
) const;
231 /// save timestamp and checksum of the given file.
232 void saveCheckSum(support::FileName
const & file
) const;
234 /// mark the main lyx file as not needing saving
235 void markClean() const;
238 void markBakClean() const;
241 void markDepClean(std::string
const & name
);
244 void setUnnamed(bool flag
= true);
247 bool isUnnamed() const;
249 /// Mark this buffer as dirty.
252 /// Returns the buffer's filename. It is always an absolute path.
253 support::FileName
fileName() const;
255 /// Returns the buffer's filename. It is always an absolute path.
256 std::string
absFileName() const;
258 /// Returns the the path where the buffer lives.
259 /// It is always an absolute path.
260 std::string
filePath() const;
262 /** A transformed version of the file name, adequate for LaTeX.
263 \param no_path optional if \c true then the path is stripped.
265 std::string
latexName(bool no_path
= true) const;
267 /// Get thee name and type of the log.
268 std::string
logName(LogType
* type
= 0) const;
270 /// Change name of buffer. Updates "read-only" flag.
271 void setFileName(std::string
const & newfile
);
273 /// Set document's parent Buffer.
274 void setParent(Buffer
const *);
275 Buffer
const * parent();
277 /** Get the document's master (or \c this if this is not a
280 Buffer
const * masterBuffer() const;
282 /// \return true if \p child is a child of this \c Buffer.
283 bool isChild(Buffer
* child
) const;
285 /// Is buffer read-only?
286 bool isReadonly() const;
288 /// Set buffer read-only flag
289 void setReadonly(bool flag
= true);
291 /// returns \c true if the buffer contains a LaTeX document
292 bool isLatex() const;
293 /// returns \c true if the buffer contains a DocBook document
294 bool isDocBook() const;
295 /// returns \c true if the buffer contains a Wed document
296 bool isLiterate() const;
298 /** Validate a buffer for LaTeX.
299 This validates the buffer, and returns a struct for use by
300 #makeLaTeX# and others. Its main use is to figure out what
301 commands and packages need to be included in the LaTeX file.
302 It (should) also check that the needed constructs are there
303 (i.e. that the \refs points to coresponding \labels). It
304 should perhaps inset "error" insets to help the user correct
307 void validate(LaTeXFeatures
&) const;
309 /// Update the cache with all bibfiles in use (including bibfiles
310 /// of loaded child documents).
311 void updateBibfilesCache() const;
313 void invalidateBibinfoCache();
314 /// Return the cache with all bibfiles in use (including bibfiles
315 /// of loaded child documents).
316 support::FileNameList
const & getBibfilesCache() const;
317 /// \return the bibliography information for this buffer's master,
318 /// or just for it, if it isn't a child.
319 BiblioInfo
const & masterBibInfo() const;
320 /// \return the bibliography information for this buffer ONLY.
321 BiblioInfo
const & localBibInfo() const;
323 void getLabelList(std::vector
<docstring
> &) const;
326 void changeLanguage(Language
const * from
, Language
const * to
);
329 bool isMultiLingual() const;
332 BufferParams
& params();
333 BufferParams
const & params() const;
335 /** The list of paragraphs.
336 This is a linked list of paragraph, this list holds the
337 whole contents of the document.
339 ParagraphList
& paragraphs();
340 ParagraphList
const & paragraphs() const;
342 /// LyX version control object.
344 LyXVC
const & lyxvc() const;
346 /// Where to put temporary files.
347 std::string
const temppath() const;
349 /// Used when typesetting to place errorboxes.
350 TexRow
const & texrow() const;
353 ParIterator
par_iterator_begin();
355 ParConstIterator
par_iterator_begin() const;
357 ParIterator
par_iterator_end();
359 ParConstIterator
par_iterator_end() const;
361 /** \returns true only when the file is fully loaded.
362 * Used to prevent the premature generation of previews
363 * and by the citation inset.
365 bool isFullyLoaded() const;
366 /// Set by buffer_funcs' newFile.
367 void setFullyLoaded(bool);
369 /// Our main text (inside the top InsetText)
372 /// Our top InsetText
373 Inset
& inset() const;
378 /// Collect macro definitions in paragraphs
379 void updateMacros() const;
380 /// Iterate through the whole buffer and try to resolve macros
381 void updateMacroInstances() const;
383 /// List macro names of this buffer, the parent and the children
384 void listMacroNames(MacroNameSet
& macros
) const;
385 /// Collect macros of the parent and its children in front of this buffer.
386 void listParentMacros(MacroSet
& macros
, LaTeXFeatures
& features
) const;
388 /// Return macro defined before pos (or in the master buffer)
389 MacroData
const * getMacro(docstring
const & name
, DocIterator
const & pos
, bool global
= true) const;
390 /// Return macro defined anywhere in the buffer (or in the master buffer)
391 MacroData
const * getMacro(docstring
const & name
, bool global
= true) const;
392 /// Return macro defined before the inclusion of the child
393 MacroData
const * getMacro(docstring
const & name
, Buffer
const & child
, bool global
= true) const;
395 /// Replace the inset contents for insets which InsetCode is equal
396 /// to the passed \p inset_code.
397 void changeRefsIfUnique(docstring
const & from
, docstring
const & to
,
400 /// get source code (latex/docbook) for some paragraphs, or all paragraphs
401 /// including preamble
402 void getSourceCode(odocstream
& os
, pit_type par_begin
, pit_type par_end
,
405 /// Access to error list.
406 /// This method is used only for GUI visualisation of Buffer related
407 /// errors (like parsing or LateX compilation). This method is const
408 /// because modifying the returned ErrorList does not touch the document
410 ErrorList
& errorList(std::string
const & type
) const;
413 /// This is useful only for screen visualisation of the Buffer. This
414 /// method is const because modifying this backend does not touch
415 /// the document contents.
416 TocBackend
& tocBackend() const;
421 /// This function is called when the buffer is changed.
422 void changed() const;
423 /// This function is called when the buffer structure is changed.
424 void structureChanged() const;
425 /// This function is called when some parsing error shows up.
426 void errors(std::string
const & err
) const;
427 /// This function is called when the buffer busy status change.
428 void setBusy(bool on
) const;
429 /// This function is called when the buffer readonly status change.
430 void setReadOnly(bool on
) const;
431 /// Update window titles of all users.
432 void updateTitles() const;
433 /// Reset autosave timers for all users.
434 void resetAutosaveTimers() const;
436 void message(docstring
const & msg
) const;
438 void setGuiDelegate(frontend::GuiBufferDelegate
* gui
);
441 void autoSave() const;
443 /// return the format of the buffer on a string
444 std::string
bufferFormat() const;
447 bool doExport(std::string
const & format
, bool put_in_tempdir
,
448 std::string
& result_file
) const;
450 bool doExport(std::string
const & format
, bool put_in_tempdir
) const;
452 bool preview(std::string
const & format
) const;
454 bool isExportable(std::string
const & format
) const;
456 std::vector
<Format
const *> exportableFormats(bool only_viewable
) const;
459 typedef std::vector
<std::pair
<InsetRef
*, ParIterator
> > References
;
460 References
& references(docstring
const & label
);
461 References
const & references(docstring
const & label
) const;
462 void clearReferenceCache() const;
463 void setInsetLabel(docstring
const & label
, InsetLabel
const * il
);
464 InsetLabel
const * insetLabel(docstring
const & label
) const;
467 /// search for macro in local (buffer) table or in children
468 MacroData
const * getBufferMacro(docstring
const & name
,
469 DocIterator
const & pos
) const;
470 /** Update macro table starting with position of it
471 \param it in some text inset
473 void updateMacros(DocIterator
& it
,
474 DocIterator
& scope
) const;
477 bool readFileHelper(support::FileName
const & s
);
479 std::vector
<std::string
> backends() const;
480 /** Inserts a file into a document
481 \return \c false if method fails.
483 ReadStatus
readFile(Lexer
&, support::FileName
const & filename
,
484 bool fromString
= false);
486 /// Use the Pimpl idiom to hide the internals.
488 /// The pointer never changes although *pimpl_'s contents may.
491 frontend::GuiBufferDelegate
* gui_
;
493 /// This function is called when the buffer structure is changed.
494 Signal structureChanged_
;
495 /// This function is called when some parsing error shows up.
496 //Signal errors(std::string const &) = 0;
497 /// This function is called when some message shows up.
498 //Signal message(docstring const &) = 0;
499 /// This function is called when the buffer busy status change.
500 //Signal setBusy(bool) = 0;
501 /// Reset autosave timers for all users.
502 Signal resetAutosaveTimers_
;