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"
24 #include <boost/scoped_ptr.hpp>
25 #include <boost/signal.hpp>
48 class ParConstIterator;
53 class StableDocIterator;
56 /** The buffer object.
57 * This is the buffer object. It contains all the informations about
58 * a document loaded into LyX.
59 * The buffer object owns the LyXText (wrapped in an InsetText), which
60 * contains the individual paragraphs of the document.
63 * I am not sure if the class is complete or
64 * minimal, probably not.
65 * \author Lars Gullik Bjønnes
69 /// What type of log will \c getLogName() return?
71 latexlog, ///< LaTeX log
72 buildlog ///< Literate build log
77 \param b optional \c false by default
79 explicit Buffer(std::string const & file, bool b = false);
84 /** High-level interface to buffer functionality.
85 This function parses a command string and executes it
87 bool dispatch(std::string const & command, bool * result = 0);
89 /// Maybe we know the function already by number...
90 bool dispatch(FuncRequest const & func, bool * result = 0);
92 /// Load the autosaved file.
93 void loadAutoSaveFile();
96 bool readFile(std::string const & filename);
98 /// read the header, returns number of unknown tokens
99 int readHeader(LyXLex & lex);
101 /** Reads a file without header.
102 \param par if != 0 insert the file.
103 \return \c false if file is not completely read.
105 bool readDocument(LyXLex &);
108 void insertStringAsLines(ParagraphList & plist,
109 lyx::pit_type &, lyx::pos_type &,
110 LyXFont const &, std::string const &, bool);
112 ParIterator getParFromID(int id) const;
113 /// do we have a paragraph with this id?
114 bool hasParWithID(int id) const;
116 /// This signal is emitted when some parsing error shows up.
117 boost::signal<void(std::string)> errors;
118 /// This signal is emitted when some message shows up.
119 boost::signal<void(std::string)> message;
120 /// This signal is emitted when the buffer busy status change.
121 boost::signal<void(bool)> busy;
122 /// This signal is emitted when the buffer readonly status change.
123 boost::signal<void(bool)> readonly;
124 /// Update window titles of all users.
125 boost::signal<void()> updateTitles;
126 /// Reset autosave timers for all users.
127 boost::signal<void()> resetAutosaveTimers;
128 /// This signal is emitting if the buffer is being closed.
129 boost::signal<void()> closing;
133 Takes care of auto-save files and backup file if requested.
134 Returns \c true if the save is successful, \c false otherwise.
138 /// Write file. Returns \c false if unsuccesful.
139 bool writeFile(std::string const &) const;
142 void writeFileAscii(std::string const &, OutputParams const &);
144 void writeFileAscii(std::ostream &, OutputParams const &);
145 /// Just a wrapper for the method below, first creating the ofstream.
146 void makeLaTeXFile(std::string const & filename,
147 std::string const & original_path,
148 OutputParams const &,
149 bool output_preamble = true,
150 bool output_body = true);
152 void writeLaTeXSource(std::ostream & os,
153 std::string const & original_path,
154 OutputParams const &,
155 bool output_preamble = true,
156 bool output_body = true);
158 void makeLinuxDocFile(std::string const & filename,
159 OutputParams const & runparams_in,
160 bool only_body = false);
162 void writeLinuxDocSource(std::ostream & os, std::string const & filename,
163 OutputParams const & runparams_in,
164 bool only_body = false);
166 void makeDocBookFile(std::string const & filename,
167 OutputParams const & runparams_in,
168 bool only_body = false);
170 void writeDocBookSource(std::ostream & os, std::string const & filename,
171 OutputParams const & runparams_in,
172 bool only_body = false);
173 /// returns the main language for the buffer (document)
174 Language const * getLanguage() const;
175 /// get l10n translated to the buffers language
176 std::string const B_(std::string const & l10n) const;
180 /// return true if the main lyx file does not need saving
181 bool isClean() const;
183 bool isBakClean() const;
185 bool isDepClean(std::string const & name) const;
187 /// mark the main lyx file as not needing saving
188 void markClean() const;
194 void markDepClean(std::string const & name);
197 void setUnnamed(bool flag = true);
200 bool isUnnamed() const;
202 /// Mark this buffer as dirty.
205 /// Returns the buffer's filename. It is always an absolute path.
206 std::string const & fileName() const;
208 /// Returns the the path where the buffer lives.
209 /// It is always an absolute path.
210 std::string const & filePath() const;
212 /** A transformed version of the file name, adequate for LaTeX.
213 \param no_path optional if \c true then the path is stripped.
215 std::string const getLatexName(bool no_path = true) const;
217 /// Get the name and type of the log.
218 std::pair<LogType, std::string> const getLogName() const;
220 /// Change name of buffer. Updates "read-only" flag.
221 void setFileName(std::string const & newfile);
223 /// Name of the document's parent
224 void setParentName(std::string const &);
226 /** Get the document's master (or \c this if this is not a
229 Buffer const * getMasterBuffer() const;
230 /** Get the document's master (or \c this if this is not a
233 Buffer * getMasterBuffer();
235 /// Is buffer read-only?
236 bool isReadonly() const;
238 /// Set buffer read-only flag
239 void setReadonly(bool flag = true);
241 /// returns \c true if the buffer contains a LaTeX document
242 bool isLatex() const;
243 /// returns \c true if the buffer contains a LinuxDoc document
244 bool isLinuxDoc() const;
245 /// returns \c true if the buffer contains a DocBook document
246 bool isDocBook() const;
247 /** returns \c true if the buffer contains either a LinuxDoc
248 or DocBook document */
250 /// returns \c true if the buffer contains a Wed document
251 bool isLiterate() const;
253 /** Validate a buffer for LaTeX.
254 This validates the buffer, and returns a struct for use by
255 #makeLaTeX# and others. Its main use is to figure out what
256 commands and packages need to be included in the LaTeX file.
257 It (should) also check that the needed constructs are there
258 (i.e. that the \refs points to coresponding \labels). It
259 should perhaps inset "error" insets to help the user correct
262 void validate(LaTeXFeatures &) const;
264 /// return all bibkeys from buffer and its childs
265 void fillWithBibKeys(std::vector<std::pair<std::string, std::string> > & keys) const;
266 /// Update the cache with all bibfiles in use (including bibfiles
267 /// of loaded child documents).
268 void updateBibfilesCache();
269 /// Return the cache with all bibfiles in use (including bibfiles
270 /// of loaded child documents).
271 std::vector<std::string> const & getBibfilesCache() const;
273 void getLabelList(std::vector<std::string> &) const;
276 void changeLanguage(Language const * from, Language const * to);
279 void updateDocLang(Language const * nlang);
282 bool isMultiLingual() const;
284 /// Does this mean that this is buffer local?
285 limited_stack<Undo> & undostack();
286 limited_stack<Undo> const & undostack() const;
288 /// Does this mean that this is buffer local?
289 limited_stack<Undo> & redostack();
290 limited_stack<Undo> const & redostack() const;
293 BufferParams & params();
294 BufferParams const & params() const;
296 /** The list of paragraphs.
297 This is a linked list of paragraph, this list holds the
298 whole contents of the document.
300 ParagraphList & paragraphs();
301 ParagraphList const & paragraphs() const;
303 /// LyX version control object.
305 LyXVC const & lyxvc() const;
307 /// Where to put temporary files.
308 std::string const & temppath() const;
310 /// Used when typesetting to place errorboxes.
312 TexRow const & texrow() const;
315 ParIterator par_iterator_begin();
317 ParConstIterator par_iterator_begin() const;
319 ParIterator par_iterator_end();
321 ParConstIterator par_iterator_end() const;
323 /** \returns true only when the file is fully loaded.
324 * Used to prevent the premature generation of previews
325 * and by the citation inset.
327 bool fully_loaded() const;
328 /// Set by buffer_funcs' newFile.
329 void fully_loaded(bool);
331 /// Our main text (inside the top InsetText)
332 LyXText & text() const;
334 /// Our top InsetText!
335 InsetBase & inset() const;
343 bool hasMacro(std::string const & name) const;
345 MacroData const & getMacro(std::string const & name) const;
347 void insertMacro(std::string const & name, MacroData const & data);
349 void saveCursor(StableDocIterator cursor, StableDocIterator anchor);
351 StableDocIterator getCursor() const { return cursor_; }
353 StableDocIterator getAnchor() const { return anchor_; }
355 void changeRefsIfUnique(std::string const & from, std::string const & to);
356 /// get source code (latex/docbook/linuxdoc) for some paragraphs, or all paragraphs
357 /// including preamble
358 void getSourceCode(std::ostream & os, lyx::pit_type par_begin, lyx::pit_type par_end, bool full_source);
360 /// errorList_ accessor.
361 ErrorList const & getErrorList() const;
362 /// replace the internal errorList_
363 /** FIXME: This method is const for now because the ErrorList GUI
364 * showing mechanism is used by other classes in order to show their
365 * own processing errors (ex: Converter.C).
367 void setErrorList(ErrorList const &) const;
368 /// add an error to the errorList_
369 /** FIXME: This method is const for now because the ErrorList GUI
370 * showing mechanism is used by other classes in order to show their
371 * own processing errors (ex: Converter.C).
373 void addError(ErrorItem const &) const;
376 /** Inserts a file into a document
377 \return \c false if method fails.
379 bool readFile(LyXLex &, std::string const & filename);
381 bool do_writeFile(std::ostream & ofs) const;
383 /// Use the Pimpl idiom to hide the internals.
385 /// The pointer never changes although *pimpl_'s contents may.
386 boost::scoped_ptr<Impl> const pimpl_;
388 /// Save the cursor Position on Buffer switch
389 /// this would not be needed if every Buffer would have
390 /// it's BufferView, this should be FIXED in future.
391 StableDocIterator cursor_;
392 StableDocIterator anchor_;
393 /// A cache for the bibfiles (including bibfiles of loaded child
394 /// documents), needed for appropriate update of natbib labels.
395 std::vector<std::string> bibfilesCache_;
397 /// An error list (replaces the error insets)
398 /** FIXME: This member is mutable for now because the ErrorList GUI
399 * showing mechanism is used by other classes in order to show their
400 * own processing errors (ex: Converter.C).
402 mutable ErrorList errorList_;