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 "InsetList.h"
16 #include "ParagraphList_fwd.h"
18 #include "support/limited_stack.h"
19 #include "support/types.h"
21 #include <boost/scoped_ptr.hpp>
22 #include <boost/signals/signal0.hpp>
23 #include <boost/signals/signal1.hpp>
43 class ParConstIterator;
49 /** The buffer object.
50 This is the buffer object. It contains all the informations about
51 a document loaded into LyX. I am not sure if the class is complete or
52 minimal, probably not.
53 \author Lars Gullik Bjønnes
57 /// What type of log will \c getLogName() return?
59 latexlog, ///< LaTeX log
60 buildlog ///< Literate build log
65 \param b optional \c false by default
67 explicit Buffer(std::string const & file, bool b = false);
72 /** High-level interface to buffer functionality.
73 This function parses a command string and executes it
75 bool dispatch(std::string const & command, bool * result = 0);
77 /// Maybe we know the function already by number...
78 bool dispatch(FuncRequest const & func, bool * result = 0);
80 /// Load the autosaved file.
81 void loadAutoSaveFile();
84 bool readFile(std::string const & filename);
86 bool readFile(std::string const & filename, ParagraphList::iterator pit);
88 /// read the header, returns number of unknown tokens
89 int readHeader(LyXLex & lex);
91 /** Reads a file without header.
92 \param par if != 0 insert the file.
93 \return \c false if file is not completely read.
95 bool readBody(LyXLex &, ParagraphList::iterator pit);
97 /// This parses a single token
98 int readParagraph(LyXLex &, std::string const & token,
100 ParagraphList::iterator & pit,
101 lyx::depth_type & depth);
104 void insertStringAsLines(ParagraphList::iterator &, lyx::pos_type &,
105 LyXFont const &, std::string const &);
107 ParIterator getParFromID(int id) const;
108 /// do we have a paragraph with this id?
109 bool hasParWithID(int id) const;
111 /// This signal is emitted when a parsing error shows up.
112 boost::signal1<void, ErrorItem> error;
113 /// This signal is emitted when some message shows up.
114 boost::signal1<void, std::string> message;
115 /// This signal is emitted when the buffer busy status change.
116 boost::signal1<void, bool> busy;
117 /// This signal is emitted when the buffer readonly status change.
118 boost::signal1<void, bool> readonly;
119 /// Update window titles of all users.
120 boost::signal0<void> updateTitles;
121 /// Reset autosave timers for all users.
122 boost::signal0<void> resetAutosaveTimers;
123 /// This signal is emitting if the buffer is being closed.
124 boost::signal0<void> closing;
128 Takes care of auto-save files and backup file if requested.
129 Returns \c true if the save is successful, \c false otherwise.
133 /// Write file. Returns \c false if unsuccesful.
134 bool writeFile(std::string const &) const;
137 void writeFileAscii(std::string const &, int);
139 void writeFileAscii(std::ostream &, int);
141 std::string const asciiParagraph(Paragraph const &, unsigned int linelen,
142 bool noparbreak = false) const;
143 /// Just a wrapper for the method below, first creating the ofstream.
144 void makeLaTeXFile(std::string const & filename,
145 std::string const & original_path,
146 LatexRunParams const &,
147 bool output_preamble = true,
148 bool output_body = true);
150 void makeLaTeXFile(std::ostream & os,
151 std::string const & original_path,
152 LatexRunParams const &,
153 bool output_preamble = true,
154 bool output_body = true);
156 void makeLinuxDocFile(std::string const & filename,
157 bool nice, bool only_body = false);
159 void makeDocBookFile(std::string const & filename,
160 bool nice, bool only_body = false);
161 /// returns the main language for the buffer (document)
162 Language const * getLanguage() const;
163 /// get l10n translated to the buffers language
164 std::string const B_(std::string const & l10n) const;
168 /// return true if the main lyx file does not need saving
169 bool isClean() const;
171 bool isBakClean() const;
173 bool isDepClean(std::string const & name) const;
175 /// mark the main lyx file as not needing saving
176 void markClean() const;
182 void markDepClean(std::string const & name);
185 void setUnnamed(bool flag = true);
190 /// Mark this buffer as dirty.
193 /// Returns the buffer's filename. It is always an absolute path.
194 std::string const & fileName() const;
196 /// Returns the the path where the buffer lives.
197 /// It is always an absolute path.
198 std::string const & filePath() const;
200 /** A transformed version of the file name, adequate for LaTeX.
201 \param no_path optional if \c true then the path is stripped.
203 std::string const getLatexName(bool no_path = true) const;
205 /// Get the name and type of the log.
206 std::pair<LogType, std::string> const getLogName() const;
208 /// Change name of buffer. Updates "read-only" flag.
209 void setFileName(std::string const & newfile);
211 /// Name of the document's parent
212 void setParentName(std::string const &);
214 /// Is buffer read-only?
215 bool isReadonly() const;
217 /// Set buffer read-only flag
218 void setReadonly(bool flag = true);
220 /// returns \c true if the buffer contains a LaTeX document
221 bool isLatex() const;
222 /// returns \c true if the buffer contains a LinuxDoc document
223 bool isLinuxDoc() const;
224 /// returns \c true if the buffer contains a DocBook document
225 bool isDocBook() const;
226 /** returns \c true if the buffer contains either a LinuxDoc
227 or DocBook document */
229 /// returns \c true if the buffer contains a Wed document
230 bool isLiterate() const;
232 /** Validate a buffer for LaTeX.
233 This validates the buffer, and returns a struct for use by
234 #makeLaTeX# and others. Its main use is to figure out what
235 commands and packages need to be included in the LaTeX file.
236 It (should) also check that the needed constructs are there
237 (i.e. that the \refs points to coresponding \labels). It
238 should perhaps inset "error" insets to help the user correct
241 void validate(LaTeXFeatures &) const;
243 /// return all bibkeys from buffer and its childs
244 void fillWithBibKeys(std::vector<std::pair<std::string, std::string> > & keys) const;
246 void getLabelList(std::vector<std::string> &) const;
249 void changeLanguage(Language const * from, Language const * to);
252 void updateDocLang(Language const * nlang);
255 bool isMultiLingual();
257 /// Does this mean that this is buffer local?
258 limited_stack<Undo> & undostack();
259 limited_stack<Undo> const & undostack() const;
261 /// Does this mean that this is buffer local?
262 limited_stack<Undo> & redostack();
263 limited_stack<Undo> const & redostack() const;
266 BufferParams & params();
267 BufferParams const & params() const;
269 /** The list of paragraphs.
270 This is a linked list of paragraph, this list holds the
271 whole contents of the document.
273 ParagraphList & paragraphs();
274 ParagraphList const & paragraphs() const;
276 /// LyX version control object.
278 LyXVC const & lyxvc() const;
280 /// Where to put temporary files.
281 std::string const & temppath() const;
283 /** If we are writing a nice LaTeX file or not.
284 While writing as LaTeX, tells whether we are
285 doing a 'nice' LaTeX file */
287 bool niceFile() const;
289 /// Used when typesetting to place errorboxes.
291 TexRow const & texrow() const;
293 class inset_iterator {
295 typedef std::input_iterator_tag iterator_category;
296 typedef InsetOld value_type;
297 typedef ptrdiff_t difference_type;
298 typedef InsetOld * pointer;
299 typedef InsetOld & reference;
300 typedef ParagraphList::iterator base_type;
305 inset_iterator(base_type p, base_type e);
307 inset_iterator(base_type p, lyx::pos_type pos, base_type e);
310 inset_iterator & operator++();
312 inset_iterator operator++(int);
314 reference operator*();
316 pointer operator->();
319 ParagraphList::iterator getPar() const;
321 lyx::pos_type getPos() const;
324 bool operator==(inset_iterator const & iter1,
325 inset_iterator const & iter2);
330 ParagraphList::iterator pit;
332 ParagraphList::iterator pend;
334 InsetList::iterator it;
337 /// return an iterator to all *top-level* insets in the buffer
338 inset_iterator inset_iterator_begin();
340 /// return the end of all *top-level* insets in the buffer
341 inset_iterator inset_iterator_end();
343 /// return a const iterator to all *top-level* insets in the buffer
344 inset_iterator inset_const_iterator_begin() const;
346 /// return the const end of all *top-level* insets in the buffer
347 inset_iterator inset_const_iterator_end() const;
350 ParIterator par_iterator_begin();
352 ParConstIterator par_iterator_begin() const;
354 ParIterator par_iterator_end();
356 ParConstIterator par_iterator_end() const;
359 InsetOld * getInsetFromID(int id_arg) const;
361 /** \returns true only when the file is fully loaded.
362 * Used to prevent the premature generation of previews
363 * and by the citation inset.
365 bool fully_loaded() const;
366 /// Set by buffer_funcs' newFile.
367 void fully_loaded(bool);
370 /** Inserts a file into a document
371 \param par if != 0 insert the file.
372 \return \c false if method fails.
374 bool readFile(LyXLex &, std::string const & filename,
375 ParagraphList::iterator pit);
377 bool do_writeFile(std::ostream & ofs) const;
379 /// Use the Pimpl idiom to hide the internals.
381 /// The pointer never changes although *pimpl_'s contents may.
382 boost::scoped_ptr<Impl> const pimpl_;
385 bool operator==(Buffer::inset_iterator const & iter1,
386 Buffer::inset_iterator const & iter2);
388 bool operator!=(Buffer::inset_iterator const & iter1,
389 Buffer::inset_iterator const & iter2);