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/limited_stack.h"
22 #include "support/types.h"
23 #include "support/docstring.h"
24 #include "support/docstream.h"
26 #include <boost/scoped_ptr.hpp>
27 #include <boost/signal.hpp>
53 class ParConstIterator;
58 class StableDocIterator;
61 /** The buffer object.
62 * This is the buffer object. It contains all the informations about
63 * a document loaded into LyX.
64 * The buffer object owns the LyXText (wrapped in an InsetText), which
65 * contains the individual paragraphs of the document.
68 * I am not sure if the class is complete or
69 * minimal, probably not.
70 * \author Lars Gullik Bjønnes
74 /// What type of log will \c getLogName() return?
76 latexlog, ///< LaTeX log
77 buildlog ///< Literate build log
82 \param b optional \c false by default
84 explicit Buffer(std::string const & file, bool b = false);
89 /** High-level interface to buffer functionality.
90 This function parses a command string and executes it
92 bool dispatch(std::string const & command, bool * result = 0);
94 /// Maybe we know the function already by number...
95 bool dispatch(FuncRequest const & func, bool * result = 0);
97 /// Load the autosaved file.
98 void loadAutoSaveFile();
101 bool readFile(std::string const & filename);
103 /// read the header, returns number of unknown tokens
104 int readHeader(LyXLex & lex);
106 /** Reads a file without header.
107 \param par if != 0 insert the file.
108 \return \c false if file is not completely read.
110 bool readDocument(LyXLex &);
113 void insertStringAsLines(ParagraphList & plist,
114 pit_type &, pos_type &,
115 LyXFont const &, docstring const &, bool);
117 ParIterator getParFromID(int id) const;
118 /// do we have a paragraph with this id?
119 bool hasParWithID(int id) const;
121 /// This signal is emitted when some parsing error shows up.
122 boost::signal<void(std::string)> errors;
123 /// This signal is emitted when some message shows up.
124 boost::signal<void(docstring)> message;
125 /// This signal is emitted when the buffer busy status change.
126 boost::signal<void(bool)> busy;
127 /// This signal is emitted when the buffer readonly status change.
128 boost::signal<void(bool)> readonly;
129 /// Update window titles of all users.
130 boost::signal<void()> updateTitles;
131 /// Reset autosave timers for all users.
132 boost::signal<void()> resetAutosaveTimers;
133 /// This signal is emitting if the buffer is being closed.
134 boost::signal<void()> closing;
138 Takes care of auto-save files and backup file if requested.
139 Returns \c true if the save is successful, \c false otherwise.
143 /// Write file. Returns \c false if unsuccesful.
144 bool writeFile(std::string const &) const;
146 /// Just a wrapper for the method below, first creating the ofstream.
147 void makeLaTeXFile(std::string const & filename,
148 std::string const & original_path,
149 OutputParams const &,
150 bool output_preamble = true,
151 bool output_body = true);
153 void writeLaTeXSource(odocstream & os,
154 std::string const & original_path,
155 OutputParams const &,
156 bool output_preamble = true,
157 bool output_body = true);
159 void makeDocBookFile(std::string const & filename,
160 OutputParams const & runparams_in,
161 bool only_body = false);
163 void writeDocBookSource(odocstream & os, std::string const & filename,
164 OutputParams const & runparams_in,
165 bool only_body = false);
166 /// returns the main language for the buffer (document)
167 Language const * getLanguage() const;
168 /// get l10n translated to the buffers language
169 docstring const B_(std::string const & l10n) const;
173 /// return true if the main lyx file does not need saving
174 bool isClean() const;
176 bool isBakClean() const;
178 bool isDepClean(std::string const & name) const;
180 /// mark the main lyx file as not needing saving
181 void markClean() const;
187 void markDepClean(std::string const & name);
190 void setUnnamed(bool flag = true);
193 bool isUnnamed() const;
195 /// Mark this buffer as dirty.
198 /// Returns the buffer's filename. It is always an absolute path.
199 std::string const & fileName() const;
201 /// Returns the the path where the buffer lives.
202 /// It is always an absolute path.
203 std::string const & filePath() const;
205 /** A transformed version of the file name, adequate for LaTeX.
206 \param no_path optional if \c true then the path is stripped.
208 std::string const getLatexName(bool no_path = true) const;
210 /// Get thee name and type of the log.
211 std::pair<LogType, std::string> const getLogName() const;
213 /// Change name of buffer. Updates "read-only" flag.
214 void setFileName(std::string const & newfile);
216 /// Name of the document's parent
217 void setParentName(std::string const &);
219 /** Get the document's master (or \c this if this is not a
222 Buffer const * getMasterBuffer() const;
223 /** Get the document's master (or \c this if this is not a
226 Buffer * getMasterBuffer();
228 /// Is buffer read-only?
229 bool isReadonly() const;
231 /// Set buffer read-only flag
232 void setReadonly(bool flag = true);
234 /// returns \c true if the buffer contains a LaTeX document
235 bool isLatex() const;
236 /// returns \c true if the buffer contains a DocBook document
237 bool isDocBook() const;
238 /// returns \c true if the buffer contains a Wed document
239 bool isLiterate() const;
241 /** Validate a buffer for LaTeX.
242 This validates the buffer, and returns a struct for use by
243 #makeLaTeX# and others. Its main use is to figure out what
244 commands and packages need to be included in the LaTeX file.
245 It (should) also check that the needed constructs are there
246 (i.e. that the \refs points to coresponding \labels). It
247 should perhaps inset "error" insets to help the user correct
250 void validate(LaTeXFeatures &) const;
252 /// return all bibkeys from buffer and its childs
253 void fillWithBibKeys(std::vector<std::pair<std::string, std::string> > & keys) const;
254 /// Update the cache with all bibfiles in use (including bibfiles
255 /// of loaded child documents).
256 void updateBibfilesCache();
257 /// Return the cache with all bibfiles in use (including bibfiles
258 /// of loaded child documents).
259 std::vector<std::string> const & getBibfilesCache() const;
261 void getLabelList(std::vector<docstring> &) const;
264 void changeLanguage(Language const * from, Language const * to);
267 void updateDocLang(Language const * nlang);
270 bool isMultiLingual() const;
272 /// Does this mean that this is buffer local?
273 limited_stack<Undo> & undostack();
274 limited_stack<Undo> const & undostack() const;
276 /// Does this mean that this is buffer local?
277 limited_stack<Undo> & redostack();
278 limited_stack<Undo> const & redostack() const;
281 BufferParams & params();
282 BufferParams const & params() const;
284 /** The list of paragraphs.
285 This is a linked list of paragraph, this list holds the
286 whole contents of the document.
288 ParagraphList & paragraphs();
289 ParagraphList const & paragraphs() const;
291 /// LyX version control object.
293 LyXVC const & lyxvc() const;
295 /// Where to put temporary files.
296 std::string const & temppath() const;
298 /// Used when typesetting to place errorboxes.
300 TexRow const & texrow() const;
303 ParIterator par_iterator_begin();
305 ParConstIterator par_iterator_begin() const;
307 ParIterator par_iterator_end();
309 ParConstIterator par_iterator_end() const;
311 /** \returns true only when the file is fully loaded.
312 * Used to prevent the premature generation of previews
313 * and by the citation inset.
315 bool fully_loaded() const;
316 /// Set by buffer_funcs' newFile.
317 void fully_loaded(bool);
319 /// Our main text (inside the top InsetText)
320 LyXText & text() const;
322 /// Our top InsetText!
323 InsetBase & inset() const;
331 bool hasMacro(docstring const & name) const;
333 MacroData const & getMacro(docstring const & name) const;
335 void insertMacro(docstring const & name, MacroData const & data);
338 void saveCursor(StableDocIterator cursor, StableDocIterator anchor);
340 StableDocIterator getCursor() const { return cursor_; }
342 StableDocIterator getAnchor() const { return anchor_; }
344 void changeRefsIfUnique(std::string const & from, std::string const & to, InsetBase::Code code);
345 /// get source code (latex/docbook) for some paragraphs, or all paragraphs
346 /// including preamble
347 void getSourceCode(odocstream & os, pit_type par_begin, pit_type par_end, bool full_source);
349 /// errorLists_ accessors.
351 ErrorList const & errorList(std::string const & type) const;
352 ErrorList & errorList(std::string const & type);
356 /** Inserts a file into a document
357 \return \c false if method fails.
359 bool readFile(LyXLex &, std::string const & filename);
361 bool do_writeFile(std::ostream & ofs) const;
363 /// Use the Pimpl idiom to hide the internals.
365 /// The pointer never changes although *pimpl_'s contents may.
366 boost::scoped_ptr<Impl> const pimpl_;
368 /// Save the cursor Position on Buffer switch
369 /// this would not be needed if every Buffer would have
370 /// it's BufferView, this should be FIXED in future.
371 StableDocIterator cursor_;
372 StableDocIterator anchor_;
373 /// A cache for the bibfiles (including bibfiles of loaded child
374 /// documents), needed for appropriate update of natbib labels.
375 std::vector<std::string> bibfilesCache_;
377 /// Container for all sort of Buffer dependant errors.
378 std::map<std::string, ErrorList> errorLists_;