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 "errorlist.h"
16 #include "InsetList.h"
18 #include "dociterator.h"
19 #include "ParagraphList_fwd.h"
21 #include "support/filename.h"
22 #include "support/limited_stack.h"
23 #include "support/types.h"
24 #include "support/docstring.h"
25 #include "support/docstream.h"
27 #include <boost/scoped_ptr.hpp>
28 #include <boost/signal.hpp>
53 class ParConstIterator;
59 class StableDocIterator;
62 /** The buffer object.
63 * This is the buffer object. It contains all the informations about
64 * a document loaded into LyX.
65 * The buffer object owns the LyXText (wrapped in an InsetText), which
66 * contains the individual paragraphs of the document.
69 * I am not sure if the class is complete or
70 * minimal, probably not.
71 * \author Lars Gullik Bjønnes
75 /// What type of log will \c getLogName() return?
77 latexlog, ///< LaTeX log
78 buildlog ///< Literate build log
81 /// Result of \c readFile()
83 failure, ///< The file could not be read
84 success, ///< The file could not be read
85 wrongversion ///< The version of the file does not match ours
90 \param b optional \c false by default
92 explicit Buffer(std::string const & file, bool b = false);
97 /** High-level interface to buffer functionality.
98 This function parses a command string and executes it
100 bool dispatch(std::string const & command, bool * result = 0);
102 /// Maybe we know the function already by number...
103 bool dispatch(FuncRequest const & func, bool * result = 0);
105 /// Load the autosaved file.
106 void loadAutoSaveFile();
108 /// read a new document from a string
109 bool readString(std::string const &);
111 bool readFile(support::FileName const & filename);
113 /// read the header, returns number of unknown tokens
114 int readHeader(LyXLex & lex);
116 /** Reads a file without header.
117 \param par if != 0 insert the file.
118 \return \c false if file is not completely read.
120 bool readDocument(LyXLex &);
123 void insertStringAsLines(ParagraphList & plist,
124 pit_type &, pos_type &,
125 LyXFont const &, docstring const &, bool);
127 ParIterator getParFromID(int id) const;
128 /// do we have a paragraph with this id?
129 bool hasParWithID(int id) const;
131 /// This signal is emitted when the buffer is changed.
132 boost::signal<void()> changed;
133 /// This signal is emitted when the buffer structure is changed.
134 boost::signal<void()> structureChanged;
135 /// This signal is emitted when some parsing error shows up.
136 boost::signal<void(std::string)> errors;
137 /// This signal is emitted when some message shows up.
138 boost::signal<void(docstring)> message;
139 /// This signal is emitted when the buffer busy status change.
140 boost::signal<void(bool)> busy;
141 /// This signal is emitted when the buffer readonly status change.
142 boost::signal<void(bool)> readonly;
143 /// Update window titles of all users.
144 boost::signal<void()> updateTitles;
145 /// Reset autosave timers for all users.
146 boost::signal<void()> resetAutosaveTimers;
147 /// This signal is emitting if the buffer is being closed.
148 boost::signal<void()> closing;
152 Takes care of auto-save files and backup file if requested.
153 Returns \c true if the save is successful, \c false otherwise.
157 /// Write document to stream. Returns \c false if unsuccesful.
158 bool write(std::ostream &) const;
159 /// Write file. Returns \c false if unsuccesful.
160 bool writeFile(support::FileName const &) const;
162 /// Just a wrapper for writeLaTeXSource, first creating the ofstream.
163 bool makeLaTeXFile(support::FileName const & filename,
164 std::string const & original_path,
165 OutputParams const &,
166 bool output_preamble = true,
167 bool output_body = true);
168 /** Export the buffer to LaTeX.
169 If \p os is a file stream, and params().inputenc is "auto" or
170 "default", and the buffer contains text in different languages
171 with more than one encoding, then this method will change the
172 encoding associated to \p os. Therefore you must not call this
173 method with a string stream if the output is supposed to go to a
176 ofs.open("test.tex");
177 writeLaTeXSource(ofs, ...);
179 \endcode is NOT equivalent to \code
180 odocstringstream oss;
181 writeLaTeXSource(oss, ...);
183 ofs.open("test.tex");
188 void writeLaTeXSource(odocstream & os,
189 std::string const & original_path,
190 OutputParams const &,
191 bool output_preamble = true,
192 bool output_body = true);
194 void makeDocBookFile(support::FileName const & filename,
195 OutputParams const & runparams_in,
196 bool only_body = false);
198 void writeDocBookSource(odocstream & os, std::string const & filename,
199 OutputParams const & runparams_in,
200 bool only_body = false);
201 /// returns the main language for the buffer (document)
202 Language const * getLanguage() const;
203 /// get l10n translated to the buffers language
204 docstring const B_(std::string const & l10n) const;
208 /// return true if the main lyx file does not need saving
209 bool isClean() const;
211 bool isBakClean() const;
213 bool isDepClean(std::string const & name) const;
215 /// mark the main lyx file as not needing saving
216 void markClean() 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 /// return all bibkeys from buffer and its childs
288 void fillWithBibKeys(std::vector<std::pair<std::string, docstring> > & keys) const;
289 /// Update the cache with all bibfiles in use (including bibfiles
290 /// of loaded child documents).
291 void updateBibfilesCache();
292 /// Return the cache with all bibfiles in use (including bibfiles
293 /// of loaded child documents).
294 std::vector<support::FileName> const & getBibfilesCache() const;
296 void getLabelList(std::vector<docstring> &) const;
299 void changeLanguage(Language const * from, Language const * to);
302 bool isMultiLingual() const;
304 /// Does this mean that this is buffer local?
305 limited_stack<Undo> & undostack();
306 limited_stack<Undo> const & undostack() const;
308 /// Does this mean that this is buffer local?
309 limited_stack<Undo> & redostack();
310 limited_stack<Undo> const & redostack() const;
313 BufferParams & params();
314 BufferParams const & params() const;
316 /** The list of paragraphs.
317 This is a linked list of paragraph, this list holds the
318 whole contents of the document.
320 ParagraphList & paragraphs();
321 ParagraphList const & paragraphs() const;
323 /// LyX version control object.
325 LyXVC const & lyxvc() const;
327 /// Where to put temporary files.
328 std::string const & temppath() const;
330 /// Used when typesetting to place errorboxes.
332 TexRow const & texrow() const;
335 ParIterator par_iterator_begin();
337 ParConstIterator par_iterator_begin() const;
339 ParIterator par_iterator_end();
341 ParConstIterator par_iterator_end() const;
343 /** \returns true only when the file is fully loaded.
344 * Used to prevent the premature generation of previews
345 * and by the citation inset.
347 bool fully_loaded() const;
348 /// Set by buffer_funcs' newFile.
349 void fully_loaded(bool);
351 /// Our main text (inside the top InsetText)
352 LyXText & text() const;
354 /// Our top InsetText!
355 InsetBase & inset() const;
363 bool hasMacro(docstring const & name) const;
365 MacroData const & getMacro(docstring const & name) const;
367 void insertMacro(docstring const & name, MacroData const & data);
370 void saveCursor(StableDocIterator cursor, StableDocIterator anchor);
372 StableDocIterator getCursor() const { return cursor_; }
374 StableDocIterator getAnchor() const { return anchor_; }
376 void changeRefsIfUnique(docstring const & from, docstring const & to,
377 InsetBase::Code code);
378 /// get source code (latex/docbook) for some paragraphs, or all paragraphs
379 /// including preamble
380 void getSourceCode(odocstream & os, pit_type par_begin, pit_type par_end, bool full_source);
382 /// errorLists_ accessors.
384 ErrorList const & errorList(std::string const & type) const;
385 ErrorList & errorList(std::string const & type);
389 TocBackend & tocBackend();
390 TocBackend const & tocBackend() const;
394 /** Inserts a file into a document
395 \return \c false if method fails.
397 ReadStatus readFile(LyXLex &, support::FileName const & filename,
398 bool fromString = false);
400 /// Use the Pimpl idiom to hide the internals.
402 /// The pointer never changes although *pimpl_'s contents may.
403 boost::scoped_ptr<Impl> const pimpl_;
405 /// Save the cursor Position on Buffer switch
406 /// this would not be needed if every Buffer would have
407 /// it's BufferView, this should be FIXED in future.
408 StableDocIterator cursor_;
409 StableDocIterator anchor_;
410 /// A cache for the bibfiles (including bibfiles of loaded child
411 /// documents), needed for appropriate update of natbib labels.
412 mutable std::vector<support::FileName> bibfilesCache_;
414 /// Container for all sort of Buffer dependant errors.
415 std::map<std::string, ErrorList> errorLists_;