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 "DocIterator.h"
17 #include "support/FileName.h"
18 #include "support/limited_stack.h"
19 #include "support/types.h"
20 #include "support/docstring.h"
21 #include "support/docstream.h"
23 #include <boost/scoped_ptr.hpp>
24 #include <boost/signal.hpp>
50 class ParConstIterator;
53 class StableDocIterator;
60 /** The buffer object.
61 * This is the buffer object. It contains all the informations about
62 * a document loaded into LyX.
63 * The buffer object owns the Text (wrapped in an InsetText), which
64 * contains the individual paragraphs of the document.
67 * I am not sure if the class is complete or
68 * minimal, probably not.
69 * \author Lars Gullik Bjønnes
73 /// What type of log will \c getLogName() return?
75 latexlog, ///< LaTeX log
76 buildlog ///< Literate build log
79 /// Result of \c readFile()
81 failure, ///< The file could not be read
82 success, ///< The file could not be read
83 wrongversion ///< The version of the file does not match ours
88 \param b optional \c false by default
90 explicit Buffer(std::string const & file, bool b = false);
95 /** High-level interface to buffer functionality.
96 This function parses a command string and executes it
98 bool dispatch(std::string const & command, bool * result = 0);
100 /// Maybe we know the function already by number...
101 bool dispatch(FuncRequest const & func, bool * result = 0);
103 /// Load the autosaved file.
104 void loadAutoSaveFile();
106 /// read a new document from a string
107 bool readString(std::string const &);
109 bool readFile(support::FileName const & filename);
111 /// read the header, returns number of unknown tokens
112 int readHeader(Lexer & lex);
114 /** Reads a file without header.
115 \param par if != 0 insert the file.
116 \return \c false if file is not completely read.
118 bool readDocument(Lexer &);
121 void insertStringAsLines(ParagraphList & plist,
122 pit_type &, pos_type &,
123 Font const &, docstring const &, bool);
125 ParIterator getParFromID(int id) const;
126 /// do we have a paragraph with this id?
127 bool hasParWithID(int id) const;
129 /// This signal is emitted when the buffer is changed.
130 boost::signal<void()> changed;
131 /// This signal is emitted when the buffer structure is changed.
132 boost::signal<void()> structureChanged;
133 /// This signal is emitted when some parsing error shows up.
134 boost::signal<void(std::string)> errors;
135 /// This signal is emitted when some message shows up.
136 boost::signal<void(docstring)> message;
137 /// This signal is emitted when the buffer busy status change.
138 boost::signal<void(bool)> busy;
139 /// This signal is emitted when the buffer readonly status change.
140 boost::signal<void(bool)> readonly;
141 /// Update window titles of all users.
142 boost::signal<void()> updateTitles;
143 /// Reset autosave timers for all users.
144 boost::signal<void()> resetAutosaveTimers;
145 /// This signal is emitting if the buffer is being closed.
146 boost::signal<void()> closing;
150 Takes care of auto-save files and backup file if requested.
151 Returns \c true if the save is successful, \c false otherwise.
155 /// Write document to stream. Returns \c false if unsuccesful.
156 bool write(std::ostream &) const;
157 /// Write file. Returns \c false if unsuccesful.
158 bool writeFile(support::FileName const &) const;
160 /// Just a wrapper for writeLaTeXSource, first creating the ofstream.
161 bool makeLaTeXFile(support::FileName const & filename,
162 std::string const & original_path,
163 OutputParams const &,
164 bool output_preamble = true,
165 bool output_body = true);
166 /** Export the buffer to LaTeX.
167 If \p os is a file stream, and params().inputenc is "auto" or
168 "default", and the buffer contains text in different languages
169 with more than one encoding, then this method will change the
170 encoding associated to \p os. Therefore you must not call this
171 method with a string stream if the output is supposed to go to a
174 ofs.open("test.tex");
175 writeLaTeXSource(ofs, ...);
177 \endcode is NOT equivalent to \code
178 odocstringstream oss;
179 writeLaTeXSource(oss, ...);
181 ofs.open("test.tex");
186 void writeLaTeXSource(odocstream & os,
187 std::string const & original_path,
188 OutputParams const &,
189 bool output_preamble = true,
190 bool output_body = true);
192 void makeDocBookFile(support::FileName const & filename,
193 OutputParams const & runparams_in,
194 bool only_body = false);
196 void writeDocBookSource(odocstream & os, std::string const & filename,
197 OutputParams const & runparams_in,
198 bool only_body = false);
199 /// returns the main language for the buffer (document)
200 Language const * getLanguage() const;
201 /// get l10n translated to the buffers language
202 docstring const B_(std::string const & l10n) const;
206 /// return true if the main lyx file does not need saving
207 bool isClean() const;
209 bool isBakClean() const;
211 bool isDepClean(std::string const & name) const;
213 /// mark the main lyx file as not needing saving
214 void markClean() const;
220 void markDepClean(std::string const & name);
223 void setUnnamed(bool flag = true);
226 bool isUnnamed() const;
228 /// Mark this buffer as dirty.
231 /// Returns the buffer's filename. It is always an absolute path.
232 std::string const fileName() const;
234 /// Returns the the path where the buffer lives.
235 /// It is always an absolute path.
236 std::string const & filePath() const;
238 /** A transformed version of the file name, adequate for LaTeX.
239 \param no_path optional if \c true then the path is stripped.
241 std::string const getLatexName(bool no_path = true) const;
243 /// Get thee name and type of the log.
244 std::pair<LogType, std::string> const getLogName() const;
246 /// Change name of buffer. Updates "read-only" flag.
247 void setFileName(std::string const & newfile);
249 /// Name of the document's parent
250 void setParentName(std::string const &);
252 /** Get the document's master (or \c this if this is not a
255 Buffer const * getMasterBuffer() const;
256 /** Get the document's master (or \c this if this is not a
259 Buffer * getMasterBuffer();
261 /// Is buffer read-only?
262 bool isReadonly() const;
264 /// Set buffer read-only flag
265 void setReadonly(bool flag = true);
267 /// returns \c true if the buffer contains a LaTeX document
268 bool isLatex() const;
269 /// returns \c true if the buffer contains a DocBook document
270 bool isDocBook() const;
271 /// returns \c true if the buffer contains a Wed document
272 bool isLiterate() const;
274 /** Validate a buffer for LaTeX.
275 This validates the buffer, and returns a struct for use by
276 #makeLaTeX# and others. Its main use is to figure out what
277 commands and packages need to be included in the LaTeX file.
278 It (should) also check that the needed constructs are there
279 (i.e. that the \refs points to coresponding \labels). It
280 should perhaps inset "error" insets to help the user correct
283 void validate(LaTeXFeatures &) const;
285 /// return all bibkeys from buffer and its childs
286 void fillWithBibKeys(std::vector<std::pair<std::string, docstring> > & keys) const;
287 /// Update the cache with all bibfiles in use (including bibfiles
288 /// of loaded child documents).
289 void updateBibfilesCache();
290 /// Return the cache with all bibfiles in use (including bibfiles
291 /// of loaded child documents).
292 std::vector<support::FileName> const & getBibfilesCache() const;
294 void getLabelList(std::vector<docstring> &) const;
297 void changeLanguage(Language const * from, Language const * to);
300 bool isMultiLingual() const;
302 /// Does this mean that this is buffer local?
303 limited_stack<Undo> & undostack();
304 limited_stack<Undo> const & undostack() const;
306 /// Does this mean that this is buffer local?
307 limited_stack<Undo> & redostack();
308 limited_stack<Undo> const & redostack() const;
311 BufferParams & params();
312 BufferParams const & params() const;
314 /** The list of paragraphs.
315 This is a linked list of paragraph, this list holds the
316 whole contents of the document.
318 ParagraphList & paragraphs();
319 ParagraphList const & paragraphs() const;
321 /// LyX version control object.
323 LyXVC const & lyxvc() const;
325 /// Where to put temporary files.
326 std::string const & temppath() const;
328 /// Used when typesetting to place errorboxes.
330 TexRow const & texrow() const;
333 ParIterator par_iterator_begin();
335 ParConstIterator par_iterator_begin() const;
337 ParIterator par_iterator_end();
339 ParConstIterator par_iterator_end() const;
341 /** \returns true only when the file is fully loaded.
342 * Used to prevent the premature generation of previews
343 * and by the citation inset.
345 bool fully_loaded() const;
346 /// Set by buffer_funcs' newFile.
347 void fully_loaded(bool);
349 /// Our main text (inside the top InsetText)
352 /// Our top InsetText!
353 Inset & inset() const;
361 bool hasMacro(docstring const & name) const;
363 MacroData const & getMacro(docstring const & name) const;
365 void insertMacro(docstring const & name, MacroData const & data);
368 void saveCursor(StableDocIterator cursor, StableDocIterator anchor);
370 StableDocIterator getCursor() const { return cursor_; }
372 StableDocIterator getAnchor() const { return anchor_; }
374 void changeRefsIfUnique(docstring const & from, docstring const & to,
376 /// get source code (latex/docbook) for some paragraphs, or all paragraphs
377 /// including preamble
378 void getSourceCode(odocstream & os, pit_type par_begin, pit_type par_end, bool full_source);
380 /// errorLists_ accessors.
382 ErrorList const & errorList(std::string const & type) const;
383 ErrorList & errorList(std::string const & type);
387 TocBackend & tocBackend();
388 TocBackend const & tocBackend() const;
392 /** Inserts a file into a document
393 \return \c false if method fails.
395 ReadStatus readFile(Lexer &, support::FileName const & filename,
396 bool fromString = false);
398 /// Use the Pimpl idiom to hide the internals.
400 /// The pointer never changes although *pimpl_'s contents may.
401 boost::scoped_ptr<Impl> const pimpl_;
403 /// Save the cursor Position on Buffer switch
404 /// this would not be needed if every Buffer would have
405 /// it's BufferView, this should be FIXED in future.
406 StableDocIterator cursor_;
407 StableDocIterator anchor_;
408 /// A cache for the bibfiles (including bibfiles of loaded child
409 /// documents), needed for appropriate update of natbib labels.
410 mutable std::vector<support::FileName> bibfilesCache_;