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
17 #include "support/limited_stack.h"
20 #include "bufferparams.h"
22 #include "ParagraphList.h"
24 #include "iterators.h"
25 #include "errorlist.h"
27 #include <boost/scoped_ptr.hpp>
28 #include <boost/signals/signal1.hpp>
37 class ParConstIterator;
41 /** The buffer object.
42 This is the buffer object. It contains all the informations about
43 a document loaded into LyX. I am not sure if the class is complete or
44 minimal, probably not.
45 \author Lars Gullik Bjønnes
49 /// What type of log will \c getLogName() return?
51 latexlog, ///< LaTeX log
52 buildlog ///< Literate build log
57 \param b optional \c false by default
59 explicit Buffer(string const & file, bool b = false);
64 /** High-level interface to buffer functionality.
65 This function parses a command string and executes it
67 bool dispatch(string const & command, bool * result = 0);
69 /// Maybe we know the function already by number...
70 bool dispatch(int ac, string const & argument, bool * result = 0);
73 void resizeInsets(BufferView *);
75 /// Update window titles of all users.
76 void updateTitles() const;
78 /// Reset autosave timers for all users.
79 void resetAutosaveTimers() const;
81 /** Adds the BufferView to the users list.
82 Later this func will insert the \c BufferView into a real list,
83 not just setting a pointer.
85 void addUser(BufferView * u);
87 /** Removes the #BufferView# from the users list.
88 Since we only can have one at the moment, we just reset it.
90 void delUser(BufferView *);
95 /// Load the autosaved file.
96 void loadAutoSaveFile();
98 /** Inserts a file into a document
99 \param par if != 0 insert the file.
100 \return \c false if method fails.
102 bool readFile(LyXLex &, string const &, ParagraphList::iterator pit);
104 // FIXME: it's very silly to pass a lex in here
106 bool readFile(LyXLex &, string const &);
108 /// read the header, returns number of unknown tokens
109 int readHeader(LyXLex & lex);
111 /** Reads a file without header.
112 \param par if != 0 insert the file.
113 \return \c false if file is not completely read.
115 bool readBody(LyXLex &, ParagraphList::iterator pit);
117 /// This parses a single token
118 int readParagraph(LyXLex &, string const & token,
119 ParagraphList & pars, ParagraphList::iterator & pit,
120 Paragraph::depth_type & depth);
123 void insertStringAsLines(ParagraphList::iterator &, lyx::pos_type &,
124 LyXFont const &, string const &);
126 ParIterator getParFromID(int id) const;
127 /// do we have a paragraph with this id?
128 bool hasParWithID(int id) const;
131 /// This signal is emitted when a parsing error shows up.
132 boost::signal1<void, ErrorItem> error;
133 /// This signal is emitted when some message shows up.
134 boost::signal1<void, string> message;
135 /// This signal is emmtted when the buffer busy status change.
136 boost::signal1<void, bool> busy;
139 Takes care of auto-save files and backup file if requested.
140 Returns \c true if the save is successful, \c false otherwise.
144 /// Write file. Returns \c false if unsuccesful.
145 bool writeFile(string const &) const;
148 void writeFileAscii(string const & , int);
150 void writeFileAscii(std::ostream &, int);
152 string const asciiParagraph(Paragraph const &, unsigned int linelen,
153 bool noparbreak = false) const;
154 /// Just a wrapper for the method below, first creating the ofstream.
155 void makeLaTeXFile(string const & filename,
156 string const & original_path,
157 LatexRunParams const &,
158 bool only_body = false,
159 bool only_preamble = false);
161 void makeLaTeXFile(std::ostream & os,
162 string const & original_path,
163 LatexRunParams const &,
164 bool only_body = false,
165 bool only_preamble = false);
167 void simpleDocBookOnePar(std::ostream &,
168 ParagraphList::iterator par, int & desc_on,
169 Paragraph::depth_type depth) const;
171 void simpleLinuxDocOnePar(std::ostream & os,
172 ParagraphList::iterator par,
173 Paragraph::depth_type depth) const;
175 void makeLinuxDocFile(string const & filename,
176 bool nice, bool only_body = false);
178 void makeDocBookFile(string const & filename,
179 bool nice, bool only_body = false);
180 /// returns the main language for the buffer (document)
181 Language const * getLanguage() const;
182 /// get l10n translated to the buffers language
183 string const B_(string const & l10n) const;
187 /// return true if the main lyx file does not need saving
188 bool isClean() const;
190 bool isBakClean() const;
192 bool isDepClean(string const & name) const;
194 /// mark the main lyx file as not needing saving
195 void markClean() const;
201 void markDepClean(string const & name);
204 void setUnnamed(bool flag = true);
209 /// Mark this buffer as dirty.
212 /// Returns the buffer's filename. It is always an absolute path.
213 string const & fileName() const;
215 /// Returns the the path where the buffer lives.
216 /// It is always an absolute path.
217 string const & filePath() const;
219 /** A transformed version of the file name, adequate for LaTeX.
220 \param no_path optional if \c true then the path is stripped.
222 string const getLatexName(bool no_path = true) const;
224 /// Get the name and type of the log.
225 std::pair<LogType, string> const getLogName() const;
227 /// Change name of buffer. Updates "read-only" flag.
228 void setFileName(string const & newfile);
230 /// Name of the document's parent
231 void setParentName(string const &);
233 /// Is buffer read-only?
234 bool isReadonly() const;
236 /// Set buffer read-only flag
237 void setReadonly(bool flag = true);
239 /// returns \c true if the buffer contains a LaTeX document
240 bool isLatex() const;
241 /// returns \c true if the buffer contains a LinuxDoc document
242 bool isLinuxDoc() const;
243 /// returns \c true if the buffer contains a DocBook document
244 bool isDocBook() const;
245 /** returns \c true if the buffer contains either a LinuxDoc
246 or DocBook document */
248 /// returns \c true if the buffer contains a Wed document
249 bool isLiterate() const;
251 /** Validate a buffer for LaTeX.
252 This validates the buffer, and returns a struct for use by
253 #makeLaTeX# and others. Its main use is to figure out what
254 commands and packages need to be included in the LaTeX file.
255 It (should) also check that the needed constructs are there
256 (i.e. that the \refs points to coresponding \labels). It
257 should perhaps inset "error" insets to help the user correct
260 void validate(LaTeXFeatures &) const;
262 /// return all bibkeys from buffer and its childs
263 void fillWithBibKeys(std::vector<std::pair<string, string> > & keys) const;
265 void getLabelList(std::vector<string> &) const;
267 /** This will clearly have to change later. Later we can have more
268 than one user per buffer. */
269 BufferView * getUser() const;
272 void changeLanguage(Language const * from, Language const * to);
275 void updateDocLang(Language const * nlang);
278 bool isMultiLingual();
280 /// Does this mean that this is buffer local?
281 limited_stack<Undo> undostack;
283 /// Does this mean that this is buffer local?
284 limited_stack<Undo> redostack;
289 /** The list of paragraphs.
290 This is a linked list of paragraph, this list holds the
291 whole contents of the document.
293 ParagraphList paragraphs;
295 /// LyX version control object.
298 /// Where to put temporary files.
301 /** If we are writing a nice LaTeX file or not.
302 While writing as LaTeX, tells whether we are
303 doing a 'nice' LaTeX file */
306 /// Used when typesetting to place errorboxes.
309 /// the author list for the document
310 AuthorList & authors();
313 typedef std::map<string, bool> DepClean;
315 /// need to regenerate .tex ?
319 mutable bool lyx_clean;
321 /// is autosave needed
322 mutable bool bak_clean;
324 /// is this a unnamed file (New...)
330 /// name of the file the buffer is associated with.
333 /// The path to the document file.
336 /// Format number of buffer
338 /** A list of views using this buffer.
339 Why not keep a list of the BufferViews that use this buffer?
341 At least then we don't have to do a lot of magic like:
342 #buffer->lyx_gui->bufferview->updateLayoutChoice#. Just ask each
343 of the buffers in the list of users to do a #updateLayoutChoice#.
347 boost::scoped_ptr<Messages> messages_;
350 class inset_iterator {
352 typedef std::input_iterator_tag iterator_category;
353 typedef Inset value_type;
354 typedef ptrdiff_t difference_type;
355 typedef Inset * pointer;
356 typedef Inset & reference;
357 typedef ParagraphList::iterator base_type;
362 inset_iterator(base_type p, base_type e);
364 inset_iterator(base_type p, lyx::pos_type pos, base_type e);
367 inset_iterator & operator++();
369 inset_iterator operator++(int);
371 reference operator*();
373 pointer operator->();
376 ParagraphList::iterator getPar() const;
378 lyx::pos_type getPos() const;
381 bool operator==(inset_iterator const & iter1,
382 inset_iterator const & iter2);
387 ParagraphList::iterator pit;
389 ParagraphList::iterator pend;
391 InsetList::iterator it;
394 /// return an iterator to all *top-level* insets in the buffer
395 inset_iterator inset_iterator_begin();
397 /// return the end of all *top-level* insets in the buffer
398 inset_iterator inset_iterator_end();
400 /// return a const iterator to all *top-level* insets in the buffer
401 inset_iterator inset_const_iterator_begin() const;
403 /// return the const end of all *top-level* insets in the buffer
404 inset_iterator inset_const_iterator_end() const;
407 ParIterator par_iterator_begin();
409 ParConstIterator par_iterator_begin() const;
411 ParIterator par_iterator_end();
413 ParConstIterator par_iterator_end() const;
416 Inset * getInsetFromID(int id_arg) const;
419 bool operator==(Buffer::inset_iterator const & iter1,
420 Buffer::inset_iterator const & iter2);
422 bool operator!=(Buffer::inset_iterator const & iter1,
423 Buffer::inset_iterator const & iter2);