2 /* \file buffer_funcs.h
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
7 * \author Alfredo Braunstein
9 * Full author contact details are available in file CREDITS.
12 #ifndef BUFFER_FUNCS_H
13 #define BUFFER_FUNCS_H
15 #include "lyxlayout_ptr_fwd.h"
16 #include "support/docstring.h"
23 namespace support { class FileName; }
32 * Loads a LyX file \c filename into \c Buffer
33 * and \return success status.
35 bool loadLyXFile(Buffer *, support::FileName const & filename);
37 /* Make a new file (buffer) with name \c filename based on a template
38 * named \c templatename
40 Buffer * newFile(std::string const & filename, std::string const & templatename,
41 bool isNamed = false);
43 ///return the format of the buffer on a string
44 std::string const bufferFormat(Buffer const & buffer);
46 /// Fill in the ErrorList with the TeXErrors
47 void bufferErrors(Buffer const &, TeXErrors const &, ErrorList &);
49 /// Count the number of words in the text between these two iterators
50 int countWords(DocIterator const & from, DocIterator const & to);
52 /// update labels at "iter".
54 A full updateLabels(Buffer const &) will be called if not possible.
56 void updateLabels(Buffer const & buf, ParIterator & it, bool childonly = false);
58 /// update labels between "from" and "to" if possible.
60 A full updateLabels(Buffer const &) will be called if not possible.
62 void updateLabels(Buffer const & buf,
63 ParIterator & from, ParIterator & to, bool childonly = false);
65 /// updates all counters
66 void updateLabels(Buffer const &, bool childonly = false);
69 void checkBufferStructure(Buffer &, ParIterator const &);
73 #endif // BUFFER_FUNCS_H