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"
25 #include <boost/scoped_ptr.hpp>
26 #include <boost/signal.hpp>
49 class ParConstIterator;
54 class StableDocIterator;
57 /** The buffer object.
58 * This is the buffer object. It contains all the informations about
59 * a document loaded into LyX.
60 * The buffer object owns the LyXText (wrapped in an InsetText), which
61 * contains the individual paragraphs of the document.
64 * I am not sure if the class is complete or
65 * minimal, probably not.
66 * \author Lars Gullik Bjønnes
70 /// What type of log will \c getLogName() return?
72 latexlog, ///< LaTeX log
73 buildlog ///< Literate build log
78 \param b optional \c false by default
80 explicit Buffer(std::string const & file, bool b = false);
85 /** High-level interface to buffer functionality.
86 This function parses a command string and executes it
88 bool dispatch(std::string const & command, bool * result = 0);
90 /// Maybe we know the function already by number...
91 bool dispatch(FuncRequest const & func, bool * result = 0);
93 /// Load the autosaved file.
94 void loadAutoSaveFile();
97 bool readFile(std::string const & filename);
99 /// read the header, returns number of unknown tokens
100 int readHeader(LyXLex & lex);
102 /** Reads a file without header.
103 \param par if != 0 insert the file.
104 \return \c false if file is not completely read.
106 bool readDocument(LyXLex &);
109 void insertStringAsLines(ParagraphList & plist,
110 lyx::pit_type &, lyx::pos_type &,
111 LyXFont const &, lyx::docstring const &, bool);
113 ParIterator getParFromID(int id) const;
114 /// do we have a paragraph with this id?
115 bool hasParWithID(int id) const;
117 /// This signal is emitted when some parsing error shows up.
118 boost::signal<void(std::string)> errors;
119 /// This signal is emitted when some message shows up.
120 boost::signal<void(lyx::docstring)> message;
121 /// This signal is emitted when the buffer busy status change.
122 boost::signal<void(bool)> busy;
123 /// This signal is emitted when the buffer readonly status change.
124 boost::signal<void(bool)> readonly;
125 /// Update window titles of all users.
126 boost::signal<void()> updateTitles;
127 /// Reset autosave timers for all users.
128 boost::signal<void()> resetAutosaveTimers;
129 /// This signal is emitting if the buffer is being closed.
130 boost::signal<void()> closing;
134 Takes care of auto-save files and backup file if requested.
135 Returns \c true if the save is successful, \c false otherwise.
139 /// Write file. Returns \c false if unsuccesful.
140 bool writeFile(std::string const &) const;
142 /// Just a wrapper for the method below, first creating the ofstream.
143 void makeLaTeXFile(std::string const & filename,
144 std::string const & original_path,
145 OutputParams const &,
146 bool output_preamble = true,
147 bool output_body = true);
149 void writeLaTeXSource(std::ostream & os,
150 std::string const & original_path,
151 OutputParams const &,
152 bool output_preamble = true,
153 bool output_body = true);
155 void makeDocBookFile(std::string const & filename,
156 OutputParams const & runparams_in,
157 bool only_body = false);
159 void writeDocBookSource(std::ostream & os, std::string const & filename,
160 OutputParams const & runparams_in,
161 bool only_body = false);
162 /// returns the main language for the buffer (document)
163 Language const * getLanguage() const;
164 /// get l10n translated to the buffers language
165 lyx::docstring const B_(std::string const & l10n) const;
169 /// return true if the main lyx file does not need saving
170 bool isClean() const;
172 bool isBakClean() const;
174 bool isDepClean(std::string const & name) const;
176 /// mark the main lyx file as not needing saving
177 void markClean() const;
183 void markDepClean(std::string const & name);
186 void setUnnamed(bool flag = true);
189 bool isUnnamed() const;
191 /// Mark this buffer as dirty.
194 /// Returns the buffer's filename. It is always an absolute path.
195 std::string const & fileName() const;
197 /// Returns the the path where the buffer lives.
198 /// It is always an absolute path.
199 std::string const & filePath() const;
201 /** A transformed version of the file name, adequate for LaTeX.
202 \param no_path optional if \c true then the path is stripped.
204 std::string const getLatexName(bool no_path = true) const;
206 /// Get the name and type of the log.
207 std::pair<LogType, std::string> const getLogName() const;
209 /// Change name of buffer. Updates "read-only" flag.
210 void setFileName(std::string const & newfile);
212 /// Name of the document's parent
213 void setParentName(std::string const &);
215 /** Get the document's master (or \c this if this is not a
218 Buffer const * getMasterBuffer() const;
219 /** Get the document's master (or \c this if this is not a
222 Buffer * getMasterBuffer();
224 /// Is buffer read-only?
225 bool isReadonly() const;
227 /// Set buffer read-only flag
228 void setReadonly(bool flag = true);
230 /// returns \c true if the buffer contains a LaTeX document
231 bool isLatex() const;
232 /// returns \c true if the buffer contains a DocBook document
233 bool isDocBook() const;
234 /// returns \c true if the buffer contains a Wed document
235 bool isLiterate() const;
237 /** Validate a buffer for LaTeX.
238 This validates the buffer, and returns a struct for use by
239 #makeLaTeX# and others. Its main use is to figure out what
240 commands and packages need to be included in the LaTeX file.
241 It (should) also check that the needed constructs are there
242 (i.e. that the \refs points to coresponding \labels). It
243 should perhaps inset "error" insets to help the user correct
246 void validate(LaTeXFeatures &) const;
248 /// return all bibkeys from buffer and its childs
249 void fillWithBibKeys(std::vector<std::pair<std::string, std::string> > & keys) const;
250 /// Update the cache with all bibfiles in use (including bibfiles
251 /// of loaded child documents).
252 void updateBibfilesCache();
253 /// Return the cache with all bibfiles in use (including bibfiles
254 /// of loaded child documents).
255 std::vector<std::string> const & getBibfilesCache() const;
257 void getLabelList(std::vector<lyx::docstring> &) const;
260 void changeLanguage(Language const * from, Language const * to);
263 void updateDocLang(Language const * nlang);
266 bool isMultiLingual() const;
268 /// Does this mean that this is buffer local?
269 limited_stack<Undo> & undostack();
270 limited_stack<Undo> const & undostack() const;
272 /// Does this mean that this is buffer local?
273 limited_stack<Undo> & redostack();
274 limited_stack<Undo> const & redostack() const;
277 BufferParams & params();
278 BufferParams const & params() const;
280 /** The list of paragraphs.
281 This is a linked list of paragraph, this list holds the
282 whole contents of the document.
284 ParagraphList & paragraphs();
285 ParagraphList const & paragraphs() const;
287 /// LyX version control object.
289 LyXVC const & lyxvc() const;
291 /// Where to put temporary files.
292 std::string const & temppath() const;
294 /// Used when typesetting to place errorboxes.
296 TexRow const & texrow() const;
299 ParIterator par_iterator_begin();
301 ParConstIterator par_iterator_begin() const;
303 ParIterator par_iterator_end();
305 ParConstIterator par_iterator_end() const;
307 /** \returns true only when the file is fully loaded.
308 * Used to prevent the premature generation of previews
309 * and by the citation inset.
311 bool fully_loaded() const;
312 /// Set by buffer_funcs' newFile.
313 void fully_loaded(bool);
315 /// Our main text (inside the top InsetText)
316 LyXText & text() const;
318 /// Our top InsetText!
319 InsetBase & inset() const;
327 bool hasMacro(std::string const & name) const;
329 MacroData const & getMacro(std::string const & name) const;
331 void insertMacro(std::string const & name, MacroData const & data);
333 void saveCursor(StableDocIterator cursor, StableDocIterator anchor);
335 StableDocIterator getCursor() const { return cursor_; }
337 StableDocIterator getAnchor() const { return anchor_; }
339 void changeRefsIfUnique(std::string const & from, std::string const & to, InsetBase::Code code);
340 /// get source code (latex/docbook) for some paragraphs, or all paragraphs
341 /// including preamble
342 void getSourceCode(std::ostream & os, lyx::pit_type par_begin, lyx::pit_type par_end, bool full_source);
344 /// errorLists_ accessors.
346 ErrorList const & errorList(std::string const & type) const;
347 ErrorList & errorList(std::string const & type);
351 /** Inserts a file into a document
352 \return \c false if method fails.
354 bool readFile(LyXLex &, std::string const & filename);
356 bool do_writeFile(std::ostream & ofs) const;
358 /// Use the Pimpl idiom to hide the internals.
360 /// The pointer never changes although *pimpl_'s contents may.
361 boost::scoped_ptr<Impl> const pimpl_;
363 /// Save the cursor Position on Buffer switch
364 /// this would not be needed if every Buffer would have
365 /// it's BufferView, this should be FIXED in future.
366 StableDocIterator cursor_;
367 StableDocIterator anchor_;
368 /// A cache for the bibfiles (including bibfiles of loaded child
369 /// documents), needed for appropriate update of natbib labels.
370 std::vector<std::string> bibfilesCache_;
372 /// Container for all sort of Buffer dependant errors.
373 std::map<std::string, ErrorList> errorLists_;