2 /* This file is part of
3 * ======================================================
5 * LyX, The Document Processor
6 * Copyright 1995 Matthias Ettrich
8 * This file is Copyleft 1996
11 * ====================================================== */
18 #include "support/limited_stack.h"
21 #include "bufferparams.h"
23 #include "ParagraphList.h"
24 #include "paragraph.h"
27 #include <boost/shared_ptr.hpp>
28 #include <boost/scoped_ptr.hpp>
36 class ParConstIterator;
40 /** The buffer object.
41 This is the buffer object. It contains all the informations about
42 a document loaded into LyX. I am not sure if the class is complete or
43 minimal, probably not.
44 \author Lars Gullik Bjønnes
48 /// What type of log will \c getLogName() return?
50 latexlog, ///< LaTeX log
51 buildlog ///< Literate build log
56 \param b optional \c false by default
58 explicit Buffer(string const & file, bool b = false);
63 /** High-level interface to buffer functionality.
64 This function parses a command string and executes it
66 bool dispatch(string const & command, bool * result = 0);
68 /// Maybe we know the function already by number...
69 bool dispatch(int ac, string const & argument, bool * result = 0);
72 void resizeInsets(BufferView *);
74 /// Update window titles of all users.
75 void updateTitles() const;
77 /// Reset autosave timers for all users.
78 void resetAutosaveTimers() const;
80 /** Adds the BufferView to the users list.
81 Later this func will insert the \c BufferView into a real list,
82 not just setting a pointer.
84 void addUser(BufferView * u);
86 /** Removes the #BufferView# from the users list.
87 Since we only can have one at the moment, we just reset it.
89 void delUser(BufferView *);
94 /// Load the autosaved file.
95 void loadAutoSaveFile();
97 /** Inserts a file into a document
98 \param par if != 0 insert the file.
99 \return \c false if method fails.
101 bool readFile(LyXLex &, string const &, ParagraphList::iterator pit);
103 // FIXME: it's very silly to pass a lex in here
105 bool readFile(LyXLex &, string const &);
107 /// read the header, returns number of unknown tokens
108 int readHeader(LyXLex & lex);
110 /** Reads a file without header.
111 \param par if != 0 insert the file.
112 \return \c false if file is not completely read.
114 bool readBody(LyXLex &, ParagraphList::iterator pit);
116 /// This parses a single token
117 int readParagraph(LyXLex &, string const & token,
118 ParagraphList & pars, ParagraphList::iterator & pit,
119 Paragraph::depth_type & depth);
122 void insertStringAsLines(ParagraphList::iterator &, lyx::pos_type &,
123 LyXFont const &, string const &);
125 ParagraphList::iterator getParFromID(int id) const;
126 /// do we have a paragraph with this id?
127 bool hasParWithID(int id) const;
131 Takes care of auto-save files and backup file if requested.
132 Returns \c true if the save is successful, \c false otherwise.
136 /// Write file. Returns \c false if unsuccesful.
137 bool writeFile(string const &) const;
140 void writeFileAscii(string const & , int);
142 void writeFileAscii(std::ostream &, int);
144 string const asciiParagraph(Paragraph const &, unsigned int linelen,
145 bool noparbreak = false) const;
146 /// Just a wrapper for the method below, first creating the ofstream.
147 void makeLaTeXFile(string const & filename,
148 string const & original_path,
150 bool only_body = false,
151 bool only_preamble = false);
153 void makeLaTeXFile(std::ostream & os,
154 string const & original_path,
156 bool only_body = false,
157 bool only_preamble = false);
159 void simpleDocBookOnePar(std::ostream &,
160 ParagraphList::iterator par, int & desc_on,
161 Paragraph::depth_type depth) const;
163 void simpleLinuxDocOnePar(std::ostream & os,
164 ParagraphList::iterator par,
165 Paragraph::depth_type depth) const;
167 void makeLinuxDocFile(string const & filename,
168 bool nice, bool only_body = false);
170 void makeDocBookFile(string const & filename,
171 bool nice, bool only_body = false);
173 void sgmlError(ParagraphList::iterator par, int pos, string const & message) const;
175 /// returns the main language for the buffer (document)
176 Language const * getLanguage() const;
177 /// get l10n translated to the buffers language
178 string const B_(string const & l10n) const;
182 /// return true if the main lyx file does not need saving
183 bool isClean() const;
185 bool isBakClean() const;
187 bool isDepClean(string const & name) const;
189 /// mark the main lyx file as not needing saving
190 void markClean() const;
196 void markDepClean(string const & name);
199 void setUnnamed(bool flag = true);
204 /// Mark this buffer as dirty.
207 /// Returns the buffer's filename. It is always an absolute path.
208 string const & fileName() const;
210 /// Returns the the path where the buffer lives.
211 /// It is always an absolute path.
212 string const & filePath() const;
214 /** A transformed version of the file name, adequate for LaTeX.
215 \param no_path optional if \c true then the path is stripped.
217 string const getLatexName(bool no_path = true) const;
219 /// Get the name and type of the log.
220 std::pair<LogType, string> const getLogName() const;
222 /// Change name of buffer. Updates "read-only" flag.
223 void setFileName(string const & newfile);
225 /// Name of the document's parent
226 void setParentName(string const &);
228 /// Is buffer read-only?
229 bool isReadonly() const;
231 /// Set buffer read-only flag
232 void setReadonly(bool flag = true);
234 /// returns \c true if the buffer contains a LaTeX document
235 bool isLatex() const;
236 /// returns \c true if the buffer contains a LinuxDoc document
237 bool isLinuxDoc() const;
238 /// returns \c true if the buffer contains a DocBook document
239 bool isDocBook() const;
240 /** returns \c true if the buffer contains either a LinuxDoc
241 or DocBook document */
243 /// returns \c true if the buffer contains a Wed document
244 bool isLiterate() const;
246 /** Validate a buffer for LaTeX.
247 This validates the buffer, and returns a struct for use by
248 #makeLaTeX# and others. Its main use is to figure out what
249 commands and packages need to be included in the LaTeX file.
250 It (should) also check that the needed constructs are there
251 (i.e. that the \refs points to coresponding \labels). It
252 should perhaps inset "error" insets to help the user correct
255 void validate(LaTeXFeatures &) const;
257 /// return all bibkeys from buffer and its childs
258 void fillWithBibKeys(std::vector<std::pair<string, string> > & keys) const;
260 std::vector<string> const getLabelList() const;
262 /** This will clearly have to change later. Later we can have more
263 than one user per buffer. */
264 BufferView * getUser() const;
267 void changeLanguage(Language const * from, Language const * to);
270 void updateDocLang(Language const * nlang);
273 bool isMultiLingual();
275 /// Does this mean that this is buffer local?
276 limited_stack<boost::shared_ptr<Undo> > undostack;
278 /// Does this mean that this is buffer local?
279 limited_stack<boost::shared_ptr<Undo> > redostack;
284 /** The list of paragraphs.
285 This is a linked list of paragraph, this list holds the
286 whole contents of the document.
288 ParagraphList paragraphs;
290 /// LyX version control object.
293 /// Where to put temporary files.
296 /** If we are writing a nice LaTeX file or not.
297 While writing as LaTeX, tells whether we are
298 doing a 'nice' LaTeX file */
301 /// Used when typesetting to place errorboxes.
304 /// the author list for the document
305 AuthorList & authors();
308 typedef std::map<string, bool> DepClean;
310 /// need to regenerate .tex ?
314 mutable bool lyx_clean;
316 /// is autosave needed
317 mutable bool bak_clean;
319 /// is this a unnamed file (New...)
325 /// name of the file the buffer is associated with.
328 /// The path to the document file.
331 /// Format number of buffer
333 /** A list of views using this buffer.
334 Why not keep a list of the BufferViews that use this buffer?
336 At least then we don't have to do a lot of magic like:
337 #buffer->lyx_gui->bufferview->updateLayoutChoice#. Just ask each
338 of the buffers in the list of users to do a #updateLayoutChoice#.
342 boost::scoped_ptr<Messages> messages_;
345 class inset_iterator {
347 typedef std::input_iterator_tag iterator_category;
348 typedef Inset value_type;
349 typedef ptrdiff_t difference_type;
350 typedef Inset * pointer;
351 typedef Inset & reference;
352 typedef ParagraphList::iterator base_type;
357 inset_iterator(base_type p, base_type e);
359 inset_iterator(base_type p, lyx::pos_type pos, base_type e);
362 inset_iterator & operator++();
364 inset_iterator operator++(int);
366 reference operator*();
368 pointer operator->();
371 ParagraphList::iterator getPar() const;
373 lyx::pos_type getPos() const;
376 bool operator==(inset_iterator const & iter1,
377 inset_iterator const & iter2);
382 ParagraphList::iterator pit;
384 ParagraphList::iterator pend;
386 InsetList::iterator it;
390 inset_iterator inset_iterator_begin() {
391 return inset_iterator(paragraphs.begin(), paragraphs.end());
395 inset_iterator inset_iterator_end() {
396 return inset_iterator();
400 inset_iterator inset_const_iterator_begin() const {
401 return inset_iterator(paragraphs.begin(), paragraphs.end());
405 inset_iterator inset_const_iterator_end() const {
406 return inset_iterator();
410 ParIterator par_iterator_begin();
412 ParConstIterator par_iterator_begin() const;
414 ParIterator par_iterator_end();
416 ParConstIterator par_iterator_end() const;
419 Inset * getInsetFromID(int id_arg) const;
422 bool operator==(Buffer::inset_iterator const & iter1,
423 Buffer::inset_iterator const & iter2);
425 bool operator!=(Buffer::inset_iterator const & iter1,
426 Buffer::inset_iterator const & iter2);